Support remapping into runfiles tree when requested

Author: sbarfurth

packages/angular/build/src/tools/esbuild/application-code-bundle.ts

@@ -616,8 +616,20 @@ function getEsBuildCommonOptions(options: NormalizedApplicationBuildOptions): Bu
   ) {
     const bindir = process.env.BAZEL_BINDIR;
     const execroot = process.env.JS_BINARY__EXECROOT;
+
+    let runfiles: string | undefined;
+    // If requested, remap paths to the runfiles tree in the sandbox instead of the bindir
+    // directly. This allows `js_binary` and `js_test` rules to invoke the Angular CLI against
+    // their runfiles.
+    if (
+      process.env.BAZEL_SANDBOX_PLUGIN_REMAP_TO_RUNFILES === '1' ||
+      process.env.BAZEL_SANDBOX_PLUGIN_REMAP_TO_RUNFILES === 'true'
+    ) {
+      runfiles = process.env.JS_BINARY__RUNFILES;
+    }
+
     if (bindir && execroot) {
-      plugins.push(createBazelSandboxPlugin({ bindir, execroot }));
+      plugins.push(createBazelSandboxPlugin({ bindir, execroot, runfiles }));
     }
   }
 

packages/angular/build/src/tools/esbuild/sandbox-plugin-bazel.ts

@@ -12,19 +12,23 @@
 
 import type { OnResolveResult, Plugin, PluginBuild, ResolveOptions } from 'esbuild';
 import { stat } from 'node:fs/promises';
-import { join } from 'node:path';
+import path, { join } from 'node:path';
 
 export interface CreateBazelSandboxPluginOptions {
   bindir: string;
   execroot: string;
+  runfiles?: string;
 }
 
-// Under Bazel, esbuild will follow symlinks out of the sandbox when the sandbox is enabled. See https://github.com/aspect-build/rules_esbuild/issues/58.
-// This plugin using a separate resolver to detect if the the resolution has left the execroot (which is the root of the sandbox
-// when sandboxing is enabled) and patches the resolution back into the sandbox.
+// Under Bazel, esbuild will follow symlinks out of the sandbox when the sandbox
+// is enabled. See https://github.com/aspect-build/rules_esbuild/issues/58. This
+// plugin using a separate resolver to detect if the the resolution has left the
+// execroot (which is the root of the sandbox when sandboxing is enabled) and
+// patches the resolution back into the sandbox.
 export function createBazelSandboxPlugin({
   bindir,
   execroot,
+  runfiles,
 }: CreateBazelSandboxPluginOptions): Plugin {
   return {
     name: 'bazel-sandbox',
@@ -40,7 +44,14 @@ export function createBazelSandboxPlugin({
         }
         otherOptions.pluginData.executedSandboxPlugin = true;
 
-        return await resolveInExecroot({ build, bindir, execroot, importPath, otherOptions });
+        return await resolveInExecroot({
+          build,
+          bindir,
+          execroot,
+          runfiles,
+          importPath,
+          otherOptions,
+        });
       });
     },
   };
@@ -50,14 +61,31 @@ interface ResolveInExecrootOptions {
   build: PluginBuild;
   bindir: string;
   execroot: string;
+  runfiles?: string;
   importPath: string;
   otherOptions: ResolveOptions;
 }
 
+const EXTERNAL_PREFIX = 'external/';
+
+function removeExternalPathPrefix(filePath: string): string {
+  // Normalize to relative path without leading slash.
+  if (filePath.startsWith('/')) {
+    filePath = filePath.substring(1);
+  }
+  // Remove the EXTERNAL_PREFIX if present.
+  if (filePath.startsWith(EXTERNAL_PREFIX)) {
+    filePath = filePath.substring(EXTERNAL_PREFIX.length);
+  }
+
+  return filePath;
+}
+
 async function resolveInExecroot({
   build,
   bindir,
   execroot,
+  runfiles,
   importPath,
   otherOptions,
 }: ResolveInExecrootOptions): Promise<OnResolveResult> {
@@ -73,20 +101,53 @@ async function resolveInExecroot({
     !result.path.startsWith('/') &&
     !result.path.startsWith('\\')
   ) {
-    // Not a relative or absolute path. Likely a module resolution that is marked "external"
+    // Not a relative or absolute path. Likely a module resolution that is
+    // marked "external"
     return result;
   }
 
-  // If esbuild attempts to leave the execroot, map the path back into the execroot.
+  // If esbuild attempts to leave the execroot, map the path back into the
+  // execroot.
   if (!result.path.startsWith(execroot)) {
     // If it tried to leave bazel-bin, error out completely.
     if (!result.path.includes(bindir)) {
       throw new Error(
         `Error: esbuild resolved a path outside of BAZEL_BINDIR (${bindir}): ${result.path}`,
       );
     }
-    // Otherwise remap the bindir-relative path
-    const correctedPath = join(execroot, result.path.substring(result.path.indexOf(bindir)));
+    // Get the path under the bindir for the file. This allows us to map into
+    // the execroot or the runfiles directory (if present).
+    // Example:
+    //   bindir             = bazel-out/<arch>/bin
+    //   result.path        = <base>/execroot/bazel-out/<arch>/bin/external/repo+/path/file.ts
+    //   binDirRelativePath = external/repo+/path/file.ts
+    const binDirRelativePath = result.path.substring(
+      result.path.indexOf(bindir) + bindir.length + 1,
+    );
+    // We usually remap into the bindir. However, when sources are provided
+    // as `data` (runfiles), they will be in the runfiles root instead. The
+    // runfiles path is absolute and under the bindir, so we don't need to
+    // join anything to it. The execroot does not include the bindir, so there
+    // we add it again after previously removing it from the result path.
+    const remapBase = runfiles ?? path.join(execroot, bindir);
+    // The path relative to the remapBase also differs between runfiles and
+    // bindir, but only if the file is in an external repository. External
+    // repositories appear under `external/repo+` in the bindir, whereas they
+    // are directly under `repo+` in the runfiles tree. This difference needs
+    // to be accounted for by removing a potential `external/` prefix when
+    // mapping into runfiles.
+    const remapBaseRelativePath = runfiles
+      ? removeExternalPathPrefix(binDirRelativePath)
+      : binDirRelativePath;
+    // Join the paths back together. The results will look slightly different
+    // between runfiles and bindir, but this is intentional.
+    // Source path:
+    //   <bin>/external/repo+/path/file.ts
+    // Example in bindir:
+    //   <sandbox-bin>/external/repo+/path/file.ts
+    // Example in runfiles:
+    //   <sandbox-bin>/path/bin.runfiles/repo+/path/file.ts
+    const correctedPath = join(remapBase, remapBaseRelativePath);
     if (process.env.JS_BINARY__LOG_DEBUG) {
       // eslint-disable-next-line no-console
       console.error(
@@ -95,12 +156,14 @@ async function resolveInExecroot({
     }
     result.path = correctedPath;
 
-    // Fall back to `.js` file if resolved `.ts` file does not exist in the changed path.
+    // Fall back to `.js` file if resolved `.ts` file does not exist in the
+    // changed path.
     //
-    // It's possible that a `.ts` file exists outside the sandbox and esbuild resolves it. It's not
-    // guaranteed that the sandbox also contains the same file. One example might be that the build
-    // depend on a compiled version of the file and the sandbox will only contain the corresponding
-    // `.js` and `.d.ts` files.
+    // It's possible that a `.ts` file exists outside the sandbox and esbuild
+    // resolves it. It is not guaranteed that the sandbox also contains the same
+    // file. One example might be that the build depends on a compiled version
+    // of the file and the sandbox will only contain the corresponding `.js` and
+    // `.d.ts` files.
     if (result.path.endsWith('.ts')) {
       try {
         await stat(result.path);