-
Notifications
You must be signed in to change notification settings - Fork 33
fix(cli): bundled workspace packaging for release-runtime #128
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
stoicneko
wants to merge
2
commits into
happier-dev:dev
Choose a base branch
from
stoicneko:fix/cli-bundle-release-runtime
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| /** | ||
| * Canonical list of workspace packages that are bundled into the CLI npm package. | ||
| * | ||
| * This module is the single source of truth consumed by both the build step | ||
| * (`buildSharedDeps.mjs`) and the bundle step (`bundleWorkspaceDeps.mjs`). | ||
| * Adding or removing a package here automatically keeps both steps in sync. | ||
| */ | ||
|
|
||
| import { resolve } from 'node:path'; | ||
|
|
||
| /** | ||
| * Frozen array of all workspace packages that must be compiled and bundled | ||
| * during `yarn prepack`. Each entry is itself frozen to prevent accidental | ||
| * mutation that could desync the derived exports. | ||
| * | ||
| * @type {ReadonlyArray<{dirName: string, packageName: string}>} | ||
| */ | ||
| export const bundledWorkspacePackages = Object.freeze([ | ||
| Object.freeze({ dirName: 'agents', packageName: '@happier-dev/agents' }), | ||
| Object.freeze({ dirName: 'cli-common', packageName: '@happier-dev/cli-common' }), | ||
| Object.freeze({ dirName: 'protocol', packageName: '@happier-dev/protocol' }), | ||
| Object.freeze({ dirName: 'release-runtime', packageName: '@happier-dev/release-runtime' }), | ||
| ]); | ||
|
|
||
| /** | ||
| * Frozen array of directory names derived from {@link bundledWorkspacePackages}. | ||
| * Matches the subdirectory names under `packages/` in the monorepo root. | ||
| * | ||
| * @type {ReadonlyArray<string>} | ||
| */ | ||
| export const bundledWorkspaceDirNames = Object.freeze( | ||
| bundledWorkspacePackages.map(({ dirName }) => dirName), | ||
| ); | ||
|
|
||
| /** | ||
| * Frozen array of npm package names derived from {@link bundledWorkspacePackages}. | ||
| * Must stay in sync with the `bundledDependencies` field in `apps/cli/package.json`. | ||
| * | ||
| * @type {ReadonlyArray<string>} | ||
| */ | ||
| export const bundledWorkspacePackageNames = Object.freeze( | ||
| bundledWorkspacePackages.map(({ packageName }) => packageName), | ||
| ); | ||
|
|
||
| /** | ||
| * Creates the bundle descriptor objects used by `bundleWorkspaceDeps.mjs`. | ||
| * Each descriptor maps a workspace package to its source directory (in the | ||
| * monorepo) and the destination directory under `apps/cli/node_modules`. | ||
| * | ||
| * @param {{ repoRoot: string, happyCliDir: string }} opts | ||
| * @returns {Array<{ packageName: string, srcDir: string, destDir: string }>} | ||
| */ | ||
| export function createBundledWorkspaceBundles({ repoRoot, happyCliDir }) { | ||
| return bundledWorkspacePackages.map(({ dirName, packageName }) => ({ | ||
| packageName, | ||
| srcDir: resolve(repoRoot, 'packages', dirName), | ||
| destDir: resolve(happyCliDir, 'node_modules', '@happier-dev', dirName), | ||
| })); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tautological assertion — re-export compared to itself
bundledWorkspaceDirsinbuildSharedDeps.mjsis defined as:…a direct re-export of
bundledWorkspaceDirNames. So when the test imports both and spreads them, it is comparing the same underlying frozen array to itself —deepEqual([...x], [...x])— which will always pass regardless of what valuexholds.The intent of the assertion appears to be guarding against a future divergence where
buildSharedDeps.mjsmight overridebundledWorkspaceDirswith a manually maintained subset. That guard is real and useful, but the assertion can only protect against that if the two symbols are independently defined. Consider adding a comment to the assertion explaining its forward-looking intent, or alternatively move the assertion's value closer to what it actually tests — that themain()loop inbuildSharedDepscompiles every entry in the canonical list: