Skip to content

[rush-resolver-cache] Improve performance of scan for nested package.json files #5311

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

Merged
dmichon-msft merged 1 commit into from
Aug 20, 2025
Merged

[rush-resolver-cache] Improve performance of scan for nested package.json files #5311

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
10 changes: 10 additions & 0 deletions common/changes/@microsoft/rush/tune-resolver-cache_2025-08-20-01-41.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@microsoft/rush",
"comment": "[resolver-cache-plugin] Improve performance of scan for nested package.json files in external packages.",
"type": "none"
}
],
"packageName": "@microsoft/rush"
}
45 changes: 27 additions & 18 deletions rush-plugins/rush-resolver-cache-plugin/src/afterInstallAsync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ function getPlatformInfo(): IPlatformInfo {
};
}

const END_TOKEN: string = '/package.json":';

/**
* Plugin entry point for after install.
* @param rushSession - The Rush Session
Expand All @@ -59,10 +61,6 @@ export async function afterInstallAsync(
const rushRoot: string = `${rushConfiguration.rushJsonFolder}/`;

const lockFilePath: string = subspace.getCommittedShrinkwrapFilePath(variant);
const workspaceRoot: string = subspace.getSubspaceTempFolderPath();

const projectByImporterPath: LookupByPath<RushConfigurationProject> =
rushConfiguration.getProjectLookupForRoot(workspaceRoot);

const pnpmStoreDir: string = `${rushConfiguration.pnpmOptions.pnpmStorePath}/v3/files/`;

Expand All @@ -76,6 +74,11 @@ export async function afterInstallAsync(
throw new Error(`Failed to load shrinkwrap file: ${lockFilePath}`);
}

const workspaceRoot: string = subspace.getSubspaceTempFolderPath();

const projectByImporterPath: LookupByPath<RushConfigurationProject> =
rushConfiguration.getProjectLookupForRoot(workspaceRoot);

const cacheFilePath: string = `${workspaceRoot}/resolver-cache.json`;

terminal.writeLine(`Resolver cache will be written at ${cacheFilePath}`);
Expand All @@ -96,7 +99,7 @@ export async function afterInstallAsync(
if (descriptionFileHash === undefined) {
// Assume this package has no nested package json files for now.
terminal.writeDebugLine(
`Package at ${descriptionFileRoot} does not having a file list. Assuming no nested "package.json" files.`
`Package at ${descriptionFileRoot} does not have a file list. Assuming no nested "package.json" files.`
);
return;
}
Expand All @@ -115,23 +118,27 @@ export async function afterInstallAsync(

try {
const indexContent: string = await FileSystem.readFileAsync(indexPath);
const { files } = JSON.parse(indexContent);

const filteredFiles: string[] = Object.keys(files).filter((file) => file.endsWith('/package.json'));
if (filteredFiles.length > 0) {
const nestedPackageDirs: string[] = filteredFiles.map((x) =>
x.slice(0, /* -'/package.json'.length */ -13)
);

if (nestedPackageDirs.length > 0) {
// eslint-disable-next-line require-atomic-updates
context.nestedPackageDirs = nestedPackageDirs;
}
let endIndex: number = indexContent.lastIndexOf(END_TOKEN);
if (endIndex > 0) {
const nestedPackageDirs: string[] = [];
// eslint-disable-next-line require-atomic-updates
context.nestedPackageDirs = nestedPackageDirs;
do {
const startIndex: number = indexContent.lastIndexOf('"', endIndex);
if (startIndex < 0) {
throw new Error(
`Malformed index file at ${indexPath}: missing starting quote for nested package.json path`
);
}
const nestedPath: string = indexContent.slice(startIndex + 1, endIndex);
nestedPackageDirs.push(nestedPath);
endIndex = indexContent.lastIndexOf(END_TOKEN, startIndex - 1);
} while (endIndex > 0);
}
} catch (error) {
if (!context.optional) {
throw new Error(
`Error reading index file for: "${context.descriptionFileRoot}" (${descriptionFileHash})`
`Error reading index file for: "${context.descriptionFileRoot}" (${descriptionFileHash}): ${error.toString()}`
);
} else {
terminal.writeLine(`Trimming missing optional dependency at: ${descriptionFileRoot}`);
Expand Down Expand Up @@ -163,4 +170,6 @@ export async function afterInstallAsync(
await FileSystem.writeFileAsync(cacheFilePath, serialized, {
ensureFolderExists: true
});

terminal.writeLine(`Resolver cache written.`);
}
Loading