Skip to content

fix: Error when upgrading pnpm to latest in devEngines.packageManager #880

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.

Sign up for GitHub

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
thiagobarbosa wants to merge 1 commit into
base: main
Choose a base branch
from
+43 −6
Open

fix: Error when upgrading pnpm to latest in devEngines.packageManager #880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions sources/specUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,11 +124,6 @@ export async function setLocalPackageManager(cwd: string, info: PreparedPackageM
const lookup = await loadSpec(cwd);

const range = `range` in lookup && lookup.range;
if (range) {
if (info.locator.name !== range.name || !semverSatisfies(info.locator.reference, range.range)) {
warnOrThrow(`The requested version of ${info.locator.name}@${info.locator.reference} does not match the devEngines specification (${range.name}@${range.range})`, range.onFail);
}
}

const content = lookup.type !== `NoProject`
? await fs.promises.readFile(lookup.target, `utf8`)
Expand All @@ -137,7 +132,18 @@ export async function setLocalPackageManager(cwd: string, info: PreparedPackageM
const {data, indent} = nodeUtils.readPackageJson(content);

const previousPackageManager = data.packageManager ?? (range ? `${range.name}@${range.range}` : `unknown`);
data.packageManager = `${info.locator.name}@${info.locator.reference}`;

// When the project relies solely on an exact `devEngines.packageManager`
// version (i.e. there's no `packageManager` field), update that field in
// place rather than adding a conflicting `packageManager` entry (see #874).
if (range && data.packageManager == null && range.name === info.locator.name && semverValid(range.range)) {
data.devEngines.packageManager.version = info.locator.reference;
} else {
if (range && (info.locator.name !== range.name || !semverSatisfies(info.locator.reference, range.range)))
warnOrThrow(`The requested version of ${info.locator.name}@${info.locator.reference} does not match the devEngines specification (${range.name}@${range.range})`, range.onFail);

data.packageManager = `${info.locator.name}@${info.locator.reference}`;
}

const newContent = nodeUtils.normalizeLineEndings(content, `${JSON.stringify(data, null, indent)}\n`);
await fs.promises.writeFile(lookup.target, newContent, `utf8`);
Expand Down
31 changes: 31 additions & 0 deletions tests/Use.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,37 @@ describe(`UseCommand`, () => {
});
});

it(`with an exact version in 'devEngines.packageManager' and no 'packageManager' field`, async () => {
await xfs.mktempPromise(async cwd => {
process.env.NO_COLOR = `1`;
await xfs.writeJsonPromise(ppath.join(cwd, `package.json`), {
devEngines: {packageManager: {name: `yarn`, version: `2.1.0`}},
license: `MIT`,
});

// Should update the pinned devEngines version rather than error out
// when the requested version doesn't match the current one (#874):
await expect(runCli(cwd, [`use`, `[email protected]`])).resolves.toMatchObject({
exitCode: 0,
stderr: ``,
stdout: expect.stringMatching(/^Installing yarn@2\.4\.3 in the project\.\.\.\n\n/),
});

const data = await xfs.readJsonPromise(ppath.join(cwd, `package.json`));
expect(data).toMatchObject({
devEngines: {packageManager: {name: `yarn`, version: `2.4.3+sha512.8dd9fedc5451829619e526c56f42609ad88ae4776d9d3f9456d578ac085115c0c2f0fb02bb7d57fd2e1b6e1ac96efba35e80a20a056668f61c96934f67694fd0`}},
});
// The `packageManager` field should not be added:
expect(data).not.toHaveProperty(`packageManager`);

await expect(runCli(cwd, [`yarn`, `--version`])).resolves.toMatchObject({
exitCode: 0,
stdout: `2.4.3\n`,
stderr: ``,
});
});
});

it(`with 'devEngines.packageManager' and 'packageManager' fields`, async () => {
await xfs.mktempPromise(async cwd => {
process.env.NO_COLOR = `1`;
Expand Down