Skip to content
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

Prefer using exclusively Corepack when possible #4254

Merged
merged 12 commits into from
Mar 29, 2022
23 changes: 23 additions & 0 deletions .yarn/versions/2847fa24.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
releases:
"@yarnpkg/cli": major
"@yarnpkg/plugin-essentials": major

declined:
- "@yarnpkg/plugin-compat"
- "@yarnpkg/plugin-constraints"
- "@yarnpkg/plugin-dlx"
- "@yarnpkg/plugin-init"
- "@yarnpkg/plugin-interactive-tools"
- "@yarnpkg/plugin-nm"
- "@yarnpkg/plugin-npm-cli"
- "@yarnpkg/plugin-pack"
- "@yarnpkg/plugin-patch"
- "@yarnpkg/plugin-pnp"
- "@yarnpkg/plugin-pnpm"
- "@yarnpkg/plugin-stage"
- "@yarnpkg/plugin-typescript"
- "@yarnpkg/plugin-version"
- "@yarnpkg/plugin-workspace-tools"
- "@yarnpkg/builder"
- "@yarnpkg/core"
- "@yarnpkg/doctor"
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ interface RunDriverOptions extends Record<string, any> {
cwd?: PortablePath;
projectFolder?: PortablePath;
registryUrl: string;
env?: Record<string, string>;
env?: Record<string, string | undefined>;
}

export type PackageRunDriver = (
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
import {xfs, ppath, PortablePath, Filename} from '@yarnpkg/fslib';

const yarnrcRegexp = /^yarnPath:/;

describe(`Commands`, () => {
describe(`set version`, () => {
test(
`it shouldn't set yarnPath if corepack is enabled and the version is semver`,
makeTemporaryEnv({}, {
env: {COREPACK_ROOT: `/path/to/corepack`},
}, async ({path, run, source}) => {
await run(`set`, `version`, `3.0.0`);
await check(path, {corepackVersion: `3.0.0`, usePath: false});
}),
);

test(
`it should set yarnPath if corepack is disabled, even when the version is semver`,
makeTemporaryEnv({}, {
env: {COREPACK_ROOT: undefined},
}, async ({path, run, source}) => {
await run(`set`, `version`, `3.0.0`);
await check(path, {corepackVersion: `3.0.0`, usePath: true});
}),
);

test(
`it should always set yarnPath if one already exists`,
makeTemporaryEnv({}, {
env: {COREPACK_ROOT: `/path/to/corepack`},
}, async ({path, run, source}) => {
// To force yarnPath to be set; followed by a sanity check
await run(`set`, `version`, `3.0.0`, {env: {COREPACK_ROOT: undefined}});
await check(path, {corepackVersion: `3.0.0`, usePath: true});

await run(`set`, `version`, `3.0.0`);
await check(path, {corepackVersion: `3.0.0`, usePath: true});
}),
);

test(
`it should always set yarnPath if --yarn-path is set`,
makeTemporaryEnv({}, {
env: {COREPACK_ROOT: `/path/to/corepack`},
}, async ({path, run, source}) => {
await run(`set`, `version`, `3.0.0`, `--yarn-path`);
await check(path, {corepackVersion: `3.0.0`, usePath: true});
}),
);

test(
`it should never set yarnPath if --no-yarn-path is set`,
makeTemporaryEnv({}, {
env: {COREPACK_ROOT: undefined},
}, async ({path, run, source}) => {
await run(`set`, `version`, `3.0.0`, `--no-yarn-path`);
await check(path, {corepackVersion: `3.0.0`, usePath: false});
}),
);

test(
`it should prevent using --no-yarn-path with arbitrary files`,
makeTemporaryEnv({}, {
env: {COREPACK_ROOT: undefined},
}, async ({path, run, source}) => {
const yarnIndirection = ppath.join(path, `custom-yarn.cjs` as Filename);
await xfs.writeFilePromise(yarnIndirection, ``);

await expect(run(`set`, `version`, yarnIndirection, `--no-yarn-path`)).rejects.toThrow();
}),
);

test(
`it should set yarnPath if the version is an arbitrary file`,
makeTemporaryEnv({}, {
env: {COREPACK_ROOT: undefined},
}, async ({path, run, source}) => {
const yarnIndirection = ppath.join(path, `custom-yarn.cjs` as Filename);
await xfs.writeFilePromise(yarnIndirection, ``);

await run(`set`, `version`, yarnIndirection);
await check(path, {corepackVersion: /[0-9]+\./, usePath: true});
}),
);
});
});

async function check(path: PortablePath, checks: {corepackVersion: string | RegExp, usePath: boolean}) {
const releasesPath = ppath.join(path, `.yarn/releases` as PortablePath);
const yarnrcPath = ppath.join(path, Filename.rc);
const manifestPath = ppath.join(path, Filename.manifest);

let releases: Array<string> | null;
try {
releases = await xfs.readdirPromise(releasesPath);
} catch (err) {
if (err.code === `ENOENT`) {
releases = null;
} else {
throw err;
}
}

let yarnrcFile;
try {
yarnrcFile = await xfs.readFilePromise(yarnrcPath, `utf8`);
} catch (err) {
if (err.code === `ENOENT`) {
yarnrcFile = ``;
} else {
throw err;
}
}

if (checks.usePath)
expect(releases).toHaveLength(1);
else
expect(releases).toEqual(null);

if (checks.usePath)
expect(yarnrcFile).toMatch(yarnrcRegexp);
else
expect(yarnrcFile).not.toMatch(yarnrcRegexp);

await expect(xfs.readJsonPromise(manifestPath)).resolves.toMatchObject({
packageManager: checks.corepackVersion instanceof RegExp
? expect.stringMatching(`yarn@${checks.corepackVersion.source}`)
: `yarn@${checks.corepackVersion}`,
});
}
Loading