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.

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

Jump to bottom

fix: remove unsafe remove of install folder #372

Merged
merged 3 commits into from
Feb 11, 2024
Merged

fix: remove unsafe remove of install folder #372

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8f8736
fix: remove unsafe remove of install folder
merceyz Feb 3, 2024
c8b5791
test: update to use folderUtils
merceyz Feb 10, 2024
48fa7a0
perf: skip `existsSync` check
merceyz Feb 11, 2024
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: 1 addition & 1 deletion sources/Engine.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import {SupportedPackageManagers, SupportedPackageManagerSet} from './types';
export type PreparedPackageManagerInfo = Awaited<ReturnType<Engine[`ensurePackageManager`]>>;

export function getLastKnownGoodFile(flag = `r`) {
return fs.promises.open(path.join(folderUtils.getInstallFolder(), `lastKnownGood.json`), flag);
return fs.promises.open(path.join(folderUtils.getCorepackHomeFolder(), `lastKnownGood.json`), flag);
}

export async function getJSONFileContent(fh: FileHandle) {
Expand Down
14 changes: 2 additions & 12 deletions sources/corepackUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,9 @@ export async function installVersion(installTarget: string, locator: Locator, {s
const {version, build} = locatorReference;

const installFolder = path.join(installTarget, locator.name, version);
const corepackFile = path.join(installFolder, `.corepack`);

// Older versions of Corepack didn't generate the `.corepack` file; in
// that case we just download the package manager anew.
if (fs.existsSync(corepackFile)) {
if (fs.existsSync(installFolder)) {
const corepackFile = path.join(installFolder, `.corepack`);
const corepackContent = await fs.promises.readFile(corepackFile, `utf8`);
const corepackData = JSON.parse(corepackContent);
merceyz marked this conversation as resolved.
Show resolved Hide resolved

Expand Down Expand Up @@ -172,14 +170,6 @@ export async function installVersion(installTarget: string, locator: Locator, {s
hash: serializedHash,
}));

// The target folder may exist if a previous version of Corepack installed
// it but didn't create the `.corepack` file. In this case we need to
// remove it first.
await fs.promises.rm(installFolder, {
recursive: true,
force: true,
});

await fs.promises.mkdir(path.dirname(installFolder), {recursive: true});
try {
await fs.promises.rename(tmpFolder, installFolder);
Expand Down
14 changes: 13 additions & 1 deletion sources/folderUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ import process from 'process';

import type {NodeError} from './nodeUtils';

export function getInstallFolder() {
/**
* If the install folder structure changes then increment this number.
*/
const INSTALL_FOLDER_VERSION = 1;

export function getCorepackHomeFolder() {
return (
process.env.COREPACK_HOME ??
join(
Expand All @@ -18,6 +23,13 @@ export function getInstallFolder() {
);
}

export function getInstallFolder() {
return join(
getCorepackHomeFolder(),
`v${INSTALL_FOLDER_VERSION}`,
);
}
Comment on lines +26 to +31
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is going to invalidate all cache from existing installation, without removing it from disk, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, we should add some clean-up in a follow-up PR.


export function getTemporaryFolder(target: string = tmpdir()) {
mkdirSync(target, {recursive: true});

Expand Down
16 changes: 7 additions & 9 deletions tests/main.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,13 @@ import {Filename, ppath, xfs, npath, PortablePath} from '@yarnpkg/fslib';
import process from 'node:process';

import config from '../config.json';
import * as folderUtils from '../sources/folderUtils';

import {runCli} from './_runCli';

let corepackHome!: PortablePath;

beforeEach(async () => {
corepackHome = await xfs.mktempPromise();

process.env.COREPACK_HOME = npath.fromPortablePath(corepackHome);
process.env.COREPACK_HOME = npath.fromPortablePath(await xfs.mktempPromise());
process.env.COREPACK_DEFAULT_TO_LATEST = `0`;
});

Expand Down Expand Up @@ -101,7 +99,7 @@ for (const [name, version] of testedPackageManagers) {
}

it(`should update the Known Good Release only when the major matches`, async () => {
await xfs.writeJsonPromise(ppath.join(corepackHome, `lastKnownGood.json`), {
await xfs.writeJsonPromise(ppath.join(npath.toPortablePath(folderUtils.getCorepackHomeFolder()), `lastKnownGood.json`), {
yarn: `1.0.0`,
});

Expand Down Expand Up @@ -645,7 +643,7 @@ it(`should not override the package manager exit code`, async () => {
packageManager: `[email protected]`,
});

const yarnFolder = ppath.join(corepackHome, `yarn/2.2.2`);
const yarnFolder = ppath.join(npath.toPortablePath(folderUtils.getInstallFolder()), `yarn/2.2.2`);
await xfs.mkdirPromise(yarnFolder, {recursive: true});
await xfs.writeJsonPromise(ppath.join(yarnFolder, `.corepack`), {});

Expand All @@ -670,7 +668,7 @@ it(`should not preserve the process.exitCode when a package manager throws`, asy
packageManager: `[email protected]`,
});

const yarnFolder = ppath.join(corepackHome, `yarn/2.2.2`);
const yarnFolder = ppath.join(npath.toPortablePath(folderUtils.getInstallFolder()), `yarn/2.2.2`);
await xfs.mkdirPromise(yarnFolder, {recursive: true});
await xfs.writeJsonPromise(ppath.join(yarnFolder, `.corepack`), {});

Expand All @@ -693,7 +691,7 @@ it(`should not set the exit code after successfully launching the package manage
packageManager: `[email protected]`,
});

const yarnFolder = ppath.join(corepackHome, `yarn/2.2.2`);
const yarnFolder = ppath.join(npath.toPortablePath(folderUtils.getInstallFolder()), `yarn/2.2.2`);
await xfs.mkdirPromise(yarnFolder, {recursive: true});
await xfs.writeJsonPromise(ppath.join(yarnFolder, `.corepack`), {});

Expand All @@ -719,7 +717,7 @@ it(`should support package managers in ESM format`, async () => {
packageManager: `[email protected]`,
});

const yarnFolder = ppath.join(corepackHome, `yarn/2.2.2`);
const yarnFolder = ppath.join(npath.toPortablePath(folderUtils.getInstallFolder()), `yarn/2.2.2`);
await xfs.mkdirPromise(yarnFolder, {recursive: true});
await xfs.writeJsonPromise(ppath.join(yarnFolder, `.corepack`), {});

Expand Down