Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,8 @@ The `name` can be used to try just one scenario using the `ember try:one` comman

If you include `packageManager: 'yarn'` in your `ember-try` config, all npm scenarios will use `yarn` for install with the `--no-lockfile` option. At cleanup, your dependencies will be restored to their prior state.

pnpm 11 and later do not read the `pnpm` field in `package.json`. With these versions, `ember-try` writes the scenario `pnpm.overrides` to the `overrides` setting in `pnpm-workspace.yaml`, and restores that file at cleanup.

##### Pnpm

If you include `packageManager: 'pnpm'` in your `ember-try` config, all npm scenarios will use `pnpm` for install with the `--no-lockfile` options. At cleanup, your dependencies will be restored to their prior state.
Expand Down
92 changes: 90 additions & 2 deletions lib/dependency-manager-adapters/pnpm.js
Original file line number Diff line number Diff line change
@@ -1,18 +1,106 @@
'use strict';

const fs = require('fs-extra');
const path = require('node:path');
const semver = require('semver');
const YAML = require('yaml');
const { LOCKFILE } = require('../utils/package-managers');
const { BaseAdapter } = require('./base');

const WORKSPACE_YAML = 'pnpm-workspace.yaml';

module.exports = class PnpmAdapter extends BaseAdapter {
defaultInstallOptions = ['--no-lockfile', '--ignore-scripts'];
lockfile = LOCKFILE.pnpm;
name = 'pnpm';
overridesKey = 'pnpm.overrides';

pnpmVersion = null;
workspaceOverrides = null;

async setup() {
await this._throwOnResolutionMode();
await super.setup();
await this.backup.addFile(WORKSPACE_YAML);
}

async applyDependencySet(dependencySet) {
await super.applyDependencySet(dependencySet);

if (this.workspaceOverrides !== null) {
this._writeWorkspaceOverrides(this.workspaceOverrides);
}
}

async cleanup() {
if (this.workspaceOverrides !== null) {
if (fs.existsSync(this.backup.pathForFile(WORKSPACE_YAML))) {
await this.backup.restoreFile(WORKSPACE_YAML);
} else {
await fs.remove(path.join(this.cwd, WORKSPACE_YAML));
}
}

await super.cleanup();
}

_packageJSONForDependencySet(packageJSON, dependencySet) {
if (!this._readsWorkspaceSettings()) {
return super._packageJSONForDependencySet(packageJSON, dependencySet);
}

// pnpm 11 and later ignore the `pnpm` field in package.json
const originalPnpmField = packageJSON.pnpm;

packageJSON.pnpm = { overrides: { ...this._readWorkspaceOverrides() } };

const result = super._packageJSONForDependencySet(packageJSON, dependencySet);

this.workspaceOverrides = result.pnpm.overrides;

if (originalPnpmField === undefined) {
delete result.pnpm;
} else {
result.pnpm = originalPnpmField;
}

return result;
}

_readsWorkspaceSettings() {
return this.pnpmVersion !== null && semver.satisfies(this.pnpmVersion, '>=11.0.0');
}

_readWorkspaceDocument() {
const backupFile = this.backup.pathForFile(WORKSPACE_YAML);

if (fs.existsSync(backupFile)) {
return YAML.parseDocument(fs.readFileSync(backupFile, 'utf-8'));
}

return new YAML.Document({});
}

_readWorkspaceOverrides() {
return this._readWorkspaceDocument().toJS()?.overrides ?? {};
}

_writeWorkspaceOverrides(overrides) {
const hasOverrides = Object.keys(overrides).length > 0;

if (!hasOverrides && !fs.existsSync(this.backup.pathForFile(WORKSPACE_YAML))) {
return;
}

const document = this._readWorkspaceDocument();

if (!hasOverrides) {
document.delete('overrides');
} else {
document.set('overrides', overrides);
}

fs.writeFileSync(path.join(this.cwd, WORKSPACE_YAML), document.toString());
}

/**
Expand All @@ -24,10 +112,10 @@ module.exports = class PnpmAdapter extends BaseAdapter {
* @returns Promise<void>
*/
async _throwOnResolutionMode() {
let version = await this._getPnpmVersion();
this.pnpmVersion = await this._getPnpmVersion();
let resolutionMode = await this._getResolutionMode();

if (this._isResolutionModeWrong(version, resolutionMode)) {
if (this._isResolutionModeWrong(this.pnpmVersion, resolutionMode)) {
throw new Error(
'You are using an old version of pnpm that uses wrong resolution mode that violates ember-try expectations. Please either upgrade pnpm or set `resolution-mode` to `highest` in `.npmrc`.',
);
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@
"rimraf": "^3.0.2",
"semver": "^7.6.3",
"temp-dir": "^2.0.0",
"walk-sync": "^2.2.0"
"walk-sync": "^2.2.0",
"yaml": "^2.9.1"
},
"devDependencies": {
"@babel/core": "^7.26.0",
Expand Down
10 changes: 10 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

162 changes: 162 additions & 0 deletions test/dependency-manager-adapters/pnpm-adapter-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,168 @@ describe('pnpm Adapter', () => {
});
});

describe('pnpm 11 and later', () => {
function mockRunForVersion(version, onInstall = () => {}) {
return generateMockRun(
[
{
command: 'pnpm install --no-lockfile --ignore-scripts',
async callback() {
onInstall();
},
},
{
command: 'pnpm --version',
async callback() {
return { stdout: `${version}\n` };
},
},
{
command: 'pnpm config get resolution-mode',
async callback() {
return { stdout: '\n' };
},
},
],
{ allowPassthrough: false },
);
}

it('writes overrides to a new `pnpm-workspace.yaml` and removes it on cleanup', async () => {
await fs.outputJson('package.json', {
devDependencies: { 'ember-cli-babel': '7.0.0' },
});

let steps = [];
let adapter = new PnpmAdapter({
cwd: tmpdir,
run: mockRunForVersion('11.0.0', () => {
steps.push(`install, workspace yaml: ${fs.existsSync('pnpm-workspace.yaml')}`);
}),
});

await adapter.setup();
await adapter.changeToDependencySet({
devDependencies: { 'ember-cli-babel': '8.0.0' },
pnpm: { overrides: { 'ember-cli-babel': '8.0.0' } },
});

expect(await fs.readJson('package.json')).to.deep.equal({
devDependencies: { 'ember-cli-babel': '8.0.0' },
});
expect(await fs.readFile('pnpm-workspace.yaml', 'utf-8')).to.equal(
'overrides:\n ember-cli-babel: 8.0.0\n',
);

await adapter.cleanup();

expect(steps).to.deep.equal([
'install, workspace yaml: true',
'install, workspace yaml: false',
]);
expect(await fs.readJson('package.json')).to.deep.equal({
devDependencies: { 'ember-cli-babel': '7.0.0' },
});
});

it('merges overrides into an existing `pnpm-workspace.yaml` and restores it on cleanup', async () => {
let originalYAML = [
'# keep this comment',
'allowBuilds:',
' core-js: false',
'overrides:',
' lodash: 4.0.0',
' ember-cli-babel: 7.0.0',
'',
].join('\n');

await fs.outputJson('package.json', {
devDependencies: { 'ember-cli-babel': '7.0.0' },
});
await fs.outputFile('pnpm-workspace.yaml', originalYAML);

let adapter = new PnpmAdapter({ cwd: tmpdir, run: mockRunForVersion('12.18.0') });

await adapter.setup();
await adapter.changeToDependencySet({
devDependencies: { 'ember-cli-babel': '8.0.0' },
pnpm: { overrides: { 'ember-cli-babel': null, 'ember-cli-htmlbars': '7.0.0' } },
});

expect(await fs.readFile('pnpm-workspace.yaml', 'utf-8')).to.equal(
[
'# keep this comment',
'allowBuilds:',
' core-js: false',
'overrides:',
' lodash: 4.0.0',
' ember-cli-htmlbars: 7.0.0',
'',
].join('\n'),
);

await adapter.cleanup();

expect(await fs.readFile('pnpm-workspace.yaml', 'utf-8')).to.equal(originalYAML);
});

it('adds the override for a tarball version to `pnpm-workspace.yaml`', async () => {
await fs.outputJson('package.json', {
devDependencies: { 'ember-source': '5.12.0' },
});

let adapter = new PnpmAdapter({ cwd: tmpdir, run: mockRunForVersion('11.0.0') });
let tarball = 'https://s3.amazonaws.com/builds.emberjs.com/release/ember-source.tgz';

await adapter.setup();
await adapter.changeToDependencySet({
devDependencies: { 'ember-source': tarball },
});

expect(await fs.readJson('package.json')).to.deep.equal({
devDependencies: { 'ember-source': tarball },
});
expect(await fs.readFile('pnpm-workspace.yaml', 'utf-8')).to.equal(
'overrides:\n ember-source: $ember-source\n',
);
});

it('does not create `pnpm-workspace.yaml` without overrides', async () => {
await fs.outputJson('package.json', {
devDependencies: { 'ember-cli-babel': '7.0.0' },
});

let adapter = new PnpmAdapter({ cwd: tmpdir, run: mockRunForVersion('11.0.0') });

await adapter.setup();
await adapter.changeToDependencySet({
devDependencies: { 'ember-cli-babel': '8.0.0' },
});

expect(fs.existsSync('pnpm-workspace.yaml')).to.be.false;
});

it('keeps overrides in `package.json` on pnpm 10', async () => {
await fs.outputJson('package.json', {
devDependencies: { 'ember-cli-babel': '7.0.0' },
});

let adapter = new PnpmAdapter({ cwd: tmpdir, run: mockRunForVersion('10.34.9') });

await adapter.setup();
await adapter.changeToDependencySet({
devDependencies: { 'ember-cli-babel': '8.0.0' },
pnpm: { overrides: { 'ember-cli-babel': '8.0.0' } },
});

expect(await fs.readJson('package.json')).to.deep.equal({
devDependencies: { 'ember-cli-babel': '8.0.0' },
pnpm: { overrides: { 'ember-cli-babel': '8.0.0' } },
});
expect(fs.existsSync('pnpm-workspace.yaml')).to.be.false;
});
});

describe('#_packageJSONForDependencySet', () => {
it('changes specified dependency versions', () => {
let adapter = new PnpmAdapter({ cwd: tmpdir });
Expand Down
Loading