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

perf(run): improve yarn run performance #2577

Merged
merged 2 commits into from
Mar 8, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
54 changes: 54 additions & 0 deletions .pnp.cjs

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

Binary file not shown.
Binary file not shown.
Binary file not shown.
30 changes: 30 additions & 0 deletions .yarn/versions/1f394246.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
releases:
"@yarnpkg/cli": patch
"@yarnpkg/core": patch
"@yarnpkg/plugin-essentials": patch

declined:
- "@yarnpkg/plugin-compat"
- "@yarnpkg/plugin-constraints"
- "@yarnpkg/plugin-dlx"
- "@yarnpkg/plugin-exec"
- "@yarnpkg/plugin-file"
- "@yarnpkg/plugin-git"
- "@yarnpkg/plugin-github"
- "@yarnpkg/plugin-http"
- "@yarnpkg/plugin-init"
- "@yarnpkg/plugin-interactive-tools"
- "@yarnpkg/plugin-link"
- "@yarnpkg/plugin-node-modules"
- "@yarnpkg/plugin-npm"
- "@yarnpkg/plugin-npm-cli"
- "@yarnpkg/plugin-pack"
- "@yarnpkg/plugin-patch"
- "@yarnpkg/plugin-pnp"
- "@yarnpkg/plugin-stage"
- "@yarnpkg/plugin-typescript"
- "@yarnpkg/plugin-version"
- "@yarnpkg/plugin-workspace-tools"
- "@yarnpkg/builder"
- "@yarnpkg/doctor"
- "@yarnpkg/pnpify"
1 change: 1 addition & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ module.exports = {
`@babel/plugin-transform-modules-commonjs`,
`@babel/plugin-proposal-optional-chaining`,
`@babel/plugin-proposal-nullish-coalescing-operator`,
`@babel/plugin-proposal-logical-assignment-operators`,
[`@babel/plugin-proposal-decorators`, {legacy: true}],
[`@babel/plugin-proposal-class-properties`, {loose: true}],
],
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"@babel/plugin-proposal-class-properties": "^7.10.1",
"@babel/plugin-proposal-decorators": "^7.10.1",
"@babel/plugin-proposal-dynamic-import": "^7.10.1",
"@babel/plugin-proposal-logical-assignment-operators": "^7.13.8",
"@babel/plugin-proposal-nullish-coalescing-operator": "^7.10.1",
"@babel/plugin-proposal-optional-chaining": "^7.10.1",
"@babel/plugin-transform-modules-commonjs": "^7.10.1",
Expand Down
10 changes: 9 additions & 1 deletion packages/plugin-essentials/sources/commands/run.ts
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,15 @@ export default class RunCommand extends BaseCommand {
}
}

return await scriptUtils.executePackageAccessibleBinary(effectiveLocator, this.scriptName, this.args, {cwd: this.context.cwd, project, stdin: this.context.stdin, stdout: this.context.stdout, stderr: this.context.stderr, nodeArgs});
return await scriptUtils.executePackageAccessibleBinary(effectiveLocator, this.scriptName, this.args, {
cwd: this.context.cwd,
project,
stdin: this.context.stdin,
stdout: this.context.stdout,
stderr: this.context.stderr,
nodeArgs,
packageAccessibleBinaries: binaries,
});
}

// When it fails, we try to check whether it's a global script (ie we look
Expand Down
76 changes: 57 additions & 19 deletions packages/yarnpkg-core/sources/scriptUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,15 @@ export async function makeScriptEnv({project, locator, binFolder, lifecycleScrip

// Register some binaries that must be made available in all subprocesses
// spawned by Yarn (we thus ensure that they always use the right version)
await makePathWrapper(binFolder, `node` as Filename, process.execPath);

if (YarnVersion !== null) {
await makePathWrapper(binFolder, `run` as Filename, process.execPath, [process.argv[1], `run`]);
await makePathWrapper(binFolder, `yarn` as Filename, process.execPath, [process.argv[1]]);
await makePathWrapper(binFolder, `yarnpkg` as Filename, process.execPath, [process.argv[1]]);
await makePathWrapper(binFolder, `node-gyp` as Filename, process.execPath, [process.argv[1], `run`, `--top-level`, `node-gyp`]);
}
await Promise.all([
makePathWrapper(binFolder, `node` as Filename, process.execPath),
...YarnVersion !== null ? [
makePathWrapper(binFolder, `run` as Filename, process.execPath, [process.argv[1], `run`]),
makePathWrapper(binFolder, `yarn` as Filename, process.execPath, [process.argv[1]]),
makePathWrapper(binFolder, `yarnpkg` as Filename, process.execPath, [process.argv[1]]),
makePathWrapper(binFolder, `node-gyp` as Filename, process.execPath, [process.argv[1], `run`, `--top-level`, `node-gyp`]),
] : [],
]);

if (project) {
scriptEnv.INIT_CWD = npath.fromPortablePath(project.configuration.startingCwd);
Expand Down Expand Up @@ -299,6 +300,11 @@ type HasPackageScriptOption = {
};

export async function hasPackageScript(locator: Locator, scriptName: string, {project}: HasPackageScriptOption) {
// We can avoid using the linkers if the locator is a workspace
const workspace = project.tryWorkspaceByLocator(locator);
if (workspace !== null)
return hasWorkspaceScript(workspace, scriptName);

const pkg = project.storedPackages.get(locator.locatorHash);
if (!pkg)
throw new Error(`Package for ${structUtils.prettyLocator(project.configuration, locator)} not found in the project`);
Expand Down Expand Up @@ -361,7 +367,24 @@ export async function executePackageShellcode(locator: Locator, command: string,
});
}

async function initializeWorkspaceEnvironment(workspace: Workspace, {binFolder, cwd, lifecycleScript}: {binFolder: PortablePath, cwd?: PortablePath | undefined, lifecycleScript?: string}) {
const env = await makeScriptEnv({project: workspace.project, locator: workspace.anchoredLocator, binFolder, lifecycleScript});

await Promise.all(
Array.from(await getWorkspaceAccessibleBinaries(workspace), ([binaryName, [, binaryPath]]) =>
makePathWrapper(binFolder, toFilename(binaryName), process.execPath, [binaryPath])
)
);

return {manifest: workspace.manifest, binFolder, env, cwd: cwd ?? workspace.cwd};
}

async function initializePackageEnvironment(locator: Locator, {project, binFolder, cwd, lifecycleScript}: {project: Project, binFolder: PortablePath, cwd?: PortablePath | undefined, lifecycleScript?: string}) {
// We can avoid using the linkers if the locator is a workspace
const workspace = project.tryWorkspaceByLocator(locator);
if (workspace !== null)
return initializeWorkspaceEnvironment(workspace, {binFolder, cwd, lifecycleScript});

const pkg = project.storedPackages.get(locator.locatorHash);
if (!pkg)
throw new Error(`Package for ${structUtils.prettyLocator(project.configuration, locator)} not found in the project`);
Expand Down Expand Up @@ -457,16 +480,19 @@ type GetPackageAccessibleBinariesOptions = {
project: Project,
};

type Binary = [Locator, NativePath];
type PackageAccessibleBinaries = Map<string, Binary>;

/**
* Return the binaries that can be accessed by the specified package
*
* @param locator The queried package
* @param project The project owning the package
*/

export async function getPackageAccessibleBinaries(locator: Locator, {project}: GetPackageAccessibleBinariesOptions) {
export async function getPackageAccessibleBinaries(locator: Locator, {project}: GetPackageAccessibleBinariesOptions): Promise<PackageAccessibleBinaries> {
const configuration = project.configuration;
const binaries: Map<string, [Locator, NativePath]> = new Map();
const binaries: PackageAccessibleBinaries = new Map();

const pkg = project.storedPackages.get(locator.locatorHash);
if (!pkg)
Expand All @@ -487,17 +513,17 @@ export async function getPackageAccessibleBinaries(locator: Locator, {project}:
visibleLocators.add(resolution);
}

for (const locatorHash of visibleLocators) {
const dependenciesWithBinaries = await Promise.all(Array.from(visibleLocators, async locatorHash => {
const dependency = project.storedPackages.get(locatorHash);
if (!dependency)
throw new Error(`Assertion failed: The package (${locatorHash}) should have been registered`);

if (dependency.bin.size === 0)
continue;
return miscUtils.mapAndFilter.skip;

const linker = linkers.find(linker => linker.supportsPackage(dependency, linkerOptions));
if (!linker)
continue;
return miscUtils.mapAndFilter.skip;

let packageLocation: PortablePath | null = null;
try {
Expand All @@ -506,12 +532,22 @@ export async function getPackageAccessibleBinaries(locator: Locator, {project}:
// Some packages may not be installed when they are incompatible
// with the current system.
if (err.code === `LOCATOR_NOT_INSTALLED`) {
continue;
return miscUtils.mapAndFilter.skip;
} else {
throw err;
}
}

return {dependency, packageLocation};
}));

// The order in which binaries overwrite each other must be stable
for (const candidate of dependenciesWithBinaries) {
if (candidate === miscUtils.mapAndFilter.skip)
continue;

const {dependency, packageLocation} = candidate;

for (const [name, target] of dependency.bin) {
binaries.set(name, [dependency, npath.fromPortablePath(ppath.resolve(packageLocation, target))]);
}
Expand All @@ -537,6 +573,7 @@ type ExecutePackageAccessibleBinaryOptions = {
stdin: Readable | null,
stdout: Writable,
stderr: Writable,
packageAccessibleBinaries?: PackageAccessibleBinaries,
arcanis marked this conversation as resolved.
Show resolved Hide resolved
};

/**
Expand All @@ -551,8 +588,8 @@ type ExecutePackageAccessibleBinaryOptions = {
* @param args The arguments to pass to the file
*/

export async function executePackageAccessibleBinary(locator: Locator, binaryName: string, args: Array<string>, {cwd, project, stdin, stdout, stderr, nodeArgs = []}: ExecutePackageAccessibleBinaryOptions) {
const packageAccessibleBinaries = await getPackageAccessibleBinaries(locator, {project});
export async function executePackageAccessibleBinary(locator: Locator, binaryName: string, args: Array<string>, {cwd, project, stdin, stdout, stderr, nodeArgs = [], packageAccessibleBinaries}: ExecutePackageAccessibleBinaryOptions) {
packageAccessibleBinaries ??= await getPackageAccessibleBinaries(locator, {project});

const binary = packageAccessibleBinaries.get(binaryName);
if (!binary)
Expand All @@ -563,7 +600,7 @@ export async function executePackageAccessibleBinary(locator: Locator, binaryNam
const env = await makeScriptEnv({project, locator, binFolder});

await Promise.all(
Array.from(packageAccessibleBinaries, ([binaryName, [, binaryPath]]) =>
Array.from(packageAccessibleBinaries!, ([binaryName, [, binaryPath]]) =>
makePathWrapper(env.BERRY_BIN_FOLDER as PortablePath, toFilename(binaryName), process.execPath, [binaryPath])
)
);
Expand All @@ -584,6 +621,7 @@ type ExecuteWorkspaceAccessibleBinaryOptions = {
stdin: Readable | null,
stdout: Writable,
stderr: Writable,
packageAccessibleBinaries?: PackageAccessibleBinaries,
arcanis marked this conversation as resolved.
Show resolved Hide resolved
};

/**
Expand All @@ -594,6 +632,6 @@ type ExecuteWorkspaceAccessibleBinaryOptions = {
* @param args The arguments to pass to the file
*/

export async function executeWorkspaceAccessibleBinary(workspace: Workspace, binaryName: string, args: Array<string>, {cwd, stdin, stdout, stderr}: ExecuteWorkspaceAccessibleBinaryOptions) {
return await executePackageAccessibleBinary(workspace.anchoredLocator, binaryName, args, {project: workspace.project, cwd, stdin, stdout, stderr});
export async function executeWorkspaceAccessibleBinary(workspace: Workspace, binaryName: string, args: Array<string>, {cwd, stdin, stdout, stderr, packageAccessibleBinaries}: ExecuteWorkspaceAccessibleBinaryOptions) {
return await executePackageAccessibleBinary(workspace.anchoredLocator, binaryName, args, {project: workspace.project, cwd, stdin, stdout, stderr, packageAccessibleBinaries});
}
Loading