Skip to content

feat: lazy initialize runfiles #3839

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
jbedard merged 4 commits into from
Jun 26, 2025
Merged

feat: lazy initialize runfiles #3839

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f1503da
feat: lazy initialize runfiles
Jun 24, 2025
6618a12
fix: only resolve initialization if it doesn't throw
Jun 24, 2025
5d733c8
updates
Jun 24, 2025
857967c
chore: pr feedback
Jun 24, 2025
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
15 changes: 12 additions & 3 deletions packages/runfiles/runfiles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ export class Runfiles {
*/
repoMappings: RepoMappings|undefined;

private _runfilesResolutionError = false;

constructor(private _env = process.env) {
// If Bazel sets a variable pointing to a runfiles manifest,
// we'll always use it.
Expand All @@ -39,8 +41,7 @@ export class Runfiles {
this.runfilesDir = path.resolve(_env['RUNFILES']!);
this.repoMappings = this.parseRepoMapping(this.runfilesDir);
} else {
throw new Error(
'Every node program run under Bazel must have a $RUNFILES_DIR, $RUNFILES or $RUNFILES_MANIFEST_FILE environment variable');
this._runfilesResolutionError = true;
}
// Under --noenable_runfiles (in particular on Windows)
// Bazel sets RUNFILES_MANIFEST_ONLY=1.
Expand All @@ -65,6 +66,13 @@ export class Runfiles {
}
}

private _assertRunfilesResolved() {
if (this._runfilesResolutionError) {
throw new Error(
'Every node program run under Bazel must have a $RUNFILES_DIR, $RUNFILES or $RUNFILES_MANIFEST_FILE environment variable');
}
}

/** Resolves the given path from the runfile manifest. */
private _resolveFromManifest(searchPath: string): string|undefined {
if (!this.manifest) return undefined;
Expand Down Expand Up @@ -100,7 +108,6 @@ export class Runfiles {
return result;
}


/**
* The runfiles manifest maps from short_path
* https://docs.bazel.build/versions/main/skylark/lib/File.html#short_path
Expand Down Expand Up @@ -152,6 +159,8 @@ export class Runfiles {

/** Resolves the given module path. */
resolve(modulePath: string, sourceRepo?: string): string {
this._assertRunfilesResolved();

// Normalize path by converting to forward slashes and removing all trailing
// forward slashes
modulePath = modulePath.replace(/\\/g, '/').replace(/\/+$/g, '')
Expand Down