Skip to content

Commit

Permalink
c# hore: cache lockfile data
Browse files Browse the repository at this point in the history 
enable some parallelization
  • Loading branch information
@L-Qun
L-Qun committed Jun 13, 2024
1 parent 7b85ca7 commit ec9a99c
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 75 deletions.
171 changes: 97 additions & 74 deletions apps/lockfile-explorer/src/cli/lint/actions/LintAction.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { RushConfiguration, type RushConfigurationProject, type Subspace } from
import path from 'path';
import yaml from 'js-yaml';
import semver from 'semver';
import { Async, FileSystem, JsonFile, JsonSchema } from '@rushstack/node-core-library';
import { AlreadyReportedError, Async, FileSystem, JsonFile, JsonSchema } from '@rushstack/node-core-library';

import lockfileLintSchema from '../../../schemas/lockfile-lint.schema.json';
import { LOCKFILE_EXPLORER_FOLDERNAME, LOCKFILE_LINT_JSON_FILENAME } from '../../../constants/common';
Expand All @@ -31,14 +31,28 @@ export interface ILockfileLint {

export class LintAction extends CommandLineAction {
private readonly _terminal: ITerminal;
private readonly _rushConfiguration: RushConfiguration;

private _checkedProjects: Set<RushConfigurationProject>;
private _docMap: Map<string, Lockfile | LockfileV6>;

public constructor(parser: LintCommandLineParser) {
super({
actionName: 'lint',
summary: 'Check if the specified package has a inconsistent package versions in target project',
documentation: 'Check if the specified package has a inconsistent package versions in target project'
});

const rushConfiguration: RushConfiguration | undefined = RushConfiguration.tryLoadFromDefaultLocation();
if (!rushConfiguration) {
throw new Error(
'The "lockfile-explorer check" must be executed in a folder that is under a Rush workspace folder'
);
}
this._rushConfiguration = rushConfiguration;
this._terminal = parser.globalTerminal;
this._checkedProjects = new Set();
this._docMap = new Map();
}

private async _checkVersionCompatibilityAsync(
Expand All @@ -55,27 +69,27 @@ export class LintAction extends CommandLineAction {
throw new Error(`ERROR: Detected inconsistent version numbers in package '${name}': '${version}'!`);
}

for (const [dependencyPackageName, dependencyPackageVersion] of Object.entries(
packages[dependencyPath].dependencies ?? {}
)) {
await this._checkVersionCompatibilityAsync(
shrinkwrapFileMajorVersion,
packages,
splicePackageWithVersion(
shrinkwrapFileMajorVersion,
dependencyPackageName,
dependencyPackageVersion
),
requiredVersions,
checkedDependencyPaths
);
}
await Promise.all(
Object.entries(packages[dependencyPath].dependencies ?? {}).map(
async ([dependencyPackageName, dependencyPackageVersion]) => {
await this._checkVersionCompatibilityAsync(
shrinkwrapFileMajorVersion,
packages,
splicePackageWithVersion(
shrinkwrapFileMajorVersion,
dependencyPackageName,
dependencyPackageVersion
),
requiredVersions,
checkedDependencyPaths
);
}
)
);
}
}

private async _searchAndValidateDependenciesAsync(
rushConfiguration: RushConfiguration,
checkedProjects: Set<RushConfigurationProject>,
project: RushConfigurationProject,
requiredVersions: Record<string, string>
): Promise<void> {
Expand All @@ -84,78 +98,79 @@ export class LintAction extends CommandLineAction {
const projectFolder: string = project.projectFolder;
const subspace: Subspace = project.subspace;
const shrinkwrapFilename: string = subspace.getCommittedShrinkwrapFilename();
const pnpmLockfileText: string = await FileSystem.readFileAsync(shrinkwrapFilename);
const doc = yaml.load(pnpmLockfileText) as Lockfile | LockfileV6;
let doc: Lockfile | LockfileV6;
if (this._docMap.has(shrinkwrapFilename)) {
doc = this._docMap.get(shrinkwrapFilename)!;
} else {
const pnpmLockfileText: string = await FileSystem.readFileAsync(shrinkwrapFilename);
doc = yaml.load(pnpmLockfileText) as Lockfile | LockfileV6;
this._docMap.set(shrinkwrapFilename, doc);
}
const { importers, lockfileVersion, packages } = doc;
const shrinkwrapFileMajorVersion: number = getShrinkwrapFileMajorVersion(lockfileVersion);
const checkedDependencyPaths: Set<string> = new Set<string>();
for (const [relativePath, { dependencies }] of Object.entries(importers)) {
if (path.resolve(projectFolder, relativePath) === projectFolder) {
const dependenciesEntries = Object.entries(dependencies ?? {});
for (const [dependencyName, dependencyValue] of dependenciesEntries) {
const fullDependencyPath = `/${dependencyName}${shrinkwrapFileMajorVersion === 6 ? '@' : '/'}${
typeof dependencyValue === 'string'
? dependencyValue
: (
dependencyValue as {
version: string;
specifier: string;
}
).version
}`;
if (fullDependencyPath.includes('link:')) {
const dependencyProject: RushConfigurationProject | undefined =
rushConfiguration.getProjectByName(dependencyName);
if (dependencyProject && !checkedProjects.has(dependencyProject)) {
checkedProjects.add(project);
await this._searchAndValidateDependenciesAsync(
rushConfiguration,
checkedProjects,
dependencyProject,
requiredVersions
);
}
} else {
await this._checkVersionCompatibilityAsync(

await Promise.all(
Object.entries(importers).map(async ([relativePath, { dependencies }]) => {
if (path.resolve(projectFolder, relativePath) === projectFolder) {
const dependenciesEntries = Object.entries(dependencies ?? {});
for (const [dependencyName, dependencyValue] of dependenciesEntries) {
const fullDependencyPath = splicePackageWithVersion(
shrinkwrapFileMajorVersion,
packages,
fullDependencyPath,
requiredVersions,
checkedDependencyPaths
dependencyName,
typeof dependencyValue === 'string'
? dependencyValue
: (
dependencyValue as {
version: string;
specifier: string;
}
).version
);
if (fullDependencyPath.includes('link:')) {
const dependencyProject: RushConfigurationProject | undefined =
this._rushConfiguration.getProjectByName(dependencyName);
if (dependencyProject && !this._checkedProjects?.has(dependencyProject)) {
this._checkedProjects!.add(project);
await this._searchAndValidateDependenciesAsync(dependencyProject, requiredVersions);
}
} else {
await this._checkVersionCompatibilityAsync(
shrinkwrapFileMajorVersion,
packages,
fullDependencyPath,
requiredVersions,
checkedDependencyPaths
);
}
}
}
}
}
})
);
}

private async _performVersionRestrictionCheckAsync(
rushConfiguration: RushConfiguration,
requiredVersions: Record<string, string>,
projectName: string
): Promise<void> {
const project: RushConfigurationProject | undefined = rushConfiguration?.getProjectByName(projectName);
if (!project) {
throw new Error(`Specified project "${projectName}" does not exist in ${LOCKFILE_LINT_JSON_FILENAME}`);
): Promise<string | void> {
try {
const project: RushConfigurationProject | undefined =
this._rushConfiguration?.getProjectByName(projectName);
if (!project) {
throw new Error(
`Specified project "${projectName}" does not exist in ${LOCKFILE_LINT_JSON_FILENAME}`
);
}
this._checkedProjects.add(project);
await this._searchAndValidateDependenciesAsync(project, requiredVersions);
} catch (e) {
return e.message;
}
const checkedProjects: Set<RushConfigurationProject> = new Set<RushConfigurationProject>([project]);
await this._searchAndValidateDependenciesAsync(
rushConfiguration,
checkedProjects,
project,
requiredVersions
);
}

protected async onExecute(): Promise<void> {
const rushConfiguration: RushConfiguration | undefined = RushConfiguration.tryLoadFromDefaultLocation();
if (!rushConfiguration) {
throw new Error(
'The "lockfile-explorer check" must be executed in a folder that is under a Rush workspace folder'
);
}
const lintingFile: string = path.resolve(
rushConfiguration.commonFolder,
this._rushConfiguration.commonFolder,
'config',
LOCKFILE_EXPLORER_FOLDERNAME,
LOCKFILE_LINT_JSON_FILENAME
Expand All @@ -164,12 +179,16 @@ export class LintAction extends CommandLineAction {
lintingFile,
JsonSchema.fromLoadedObject(lockfileLintSchema)
);
const errorMessageList: string[] = [];
await Async.forEachAsync(
rules,
async ({ requiredVersions, project, rule }) => {
switch (rule) {
case 'restrict-versions': {
await this._performVersionRestrictionCheckAsync(rushConfiguration, requiredVersions, project);
const errorMessage = await this._performVersionRestrictionCheckAsync(requiredVersions, project);
if (errorMessage) {
errorMessageList.push(errorMessage);
}
break;
}

Expand All @@ -180,6 +199,10 @@ export class LintAction extends CommandLineAction {
},
{ concurrency: 50 }
);
if (errorMessageList.length > 0) {
this._terminal.writeError(errorMessageList.join('\n'));
throw new AlreadyReportedError();
}
this._terminal.writeLine(Colorize.green('Check passed!'));
}
}
3 changes: 2 additions & 1 deletion apps/lockfile-explorer/src/test/__snapshots__/help.test.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ Optional arguments:
`;
exports[`CLI Tool Tests should display help for "lockfile-lint --help" 1`] = `
"usage: lockfile-lint [-h] <command> ...
"The experiment \\"phasedCommands\\" has graduated to a standard feature. Remove this experiment from \\"/workspaces/rushstack/common/config/rush/experiments.json\\".
usage: lockfile-lint [-h] <command> ...
lockfile-lint is a tool for linting lockfiles.
Expand Down

0 comments on commit ec9a99c

Please sign in to comment.