refactor(bazel): simplify api-golden rule after windows changes

Now that for Windows contributors, we also can assume a proper sandbox
and node modules directory, we no longer need to leverage our
`rules_nodejs` tricks/hack.

Very soon we'll be able to remove the full `interop_module_mappings.ts`
file given our `rules_js` migration. Yay!

Author: devversion

bazel/api-golden/BUILD.bazel

@@ -12,8 +12,7 @@ ts_project(
     srcs = [
         "find_entry_points.ts",
         "index_npm_packages.ts",
-        "module_mappings.ts",
-        "patch-host.ts",
+        "interop_module_mappings.ts",
         "path-normalize.ts",
         "test_api_report.ts",
     ],

bazel/api-golden/index.bzl

@@ -2,27 +2,20 @@ load("@bazel_skylib//rules:write_file.bzl", "write_file")
 load("@build_bazel_rules_nodejs//:index.bzl", "pkg_npm")
 load("//bazel/api-golden:index_rjs.bzl", _rjs_api_golden_test_npm_package = "api_golden_test_npm_package")
 
-nodejs_test_args = [
-    # Needed so that node doesn't walk back to the source directory.
-    # From there, the relative imports would point to .ts files.
-    "--node_options=--preserve-symlinks",
-    "--nobazel_run_linker",
-]
-
 default_strip_export_pattern = "^ɵ(?!ɵdefineInjectable|ɵinject|ɵInjectableDef)"
 
-def extract_module_names_from_npm_targets(type_targets):
+def extract_names_from_npm_targets(type_targets):
     types = {}
 
     for type_target in type_targets:
         type_label = Label(type_target)
         type_package = type_label.package
 
-        if type_label.workspace_name != "npm":
+        if type_label.workspace_name != "npm" or not type_package.startswith("@types/"):
             fail("Expected type targets to be part of the `@npm` workspace." +
                  "e.g. `@npm//@types/nodes`.")
 
-        types[type_target] = type_package
+        types[type_target] = type_package[len("@types/"):]
 
     return types
 
@@ -60,7 +53,8 @@ def api_golden_test(
         data = [":%s_synthetic_package" % name] + data,
         npm_package = "%s/%s_synthetic_package" % (native.package_name(), name),
         strip_export_pattern = strip_export_pattern,
-        types = extract_module_names_from_npm_targets(types),
+        types = extract_names_from_npm_targets(types),
+        interop_mode = True,
         **kwargs
     )
 
@@ -79,7 +73,8 @@ def api_golden_test_npm_package(
         npm_package = fixup_path_for_rules_js(npm_package),
         data = data,
         strip_export_pattern = strip_export_pattern,
-        types = extract_module_names_from_npm_targets(types),
+        types = extract_names_from_npm_targets(types),
+        interop_mode = True,
         **kwargs
     )
 

bazel/api-golden/index_npm_packages.ts

@@ -31,7 +31,7 @@ async function main(
   npmPackageDir: string,
   approveGolden: boolean,
   stripExportPattern: RegExp,
-  typePackageNames: string[],
+  typeNames: string[],
 ) {
   // TODO(ESM) This can be replaced with an actual ESM import when `ts_library` is
   // guaranteed to be ESM-only and supports the `mts` extension.
@@ -57,7 +57,7 @@ async function main(
     const actual = await testApiGolden(
       typesEntryPointPath,
       stripExportPattern,
-      typePackageNames,
+      typeNames,
       packageJsonPath,
       moduleName,
     );
@@ -101,14 +101,14 @@ async function main(
   const npmPackageDir = path.resolve(args[1]);
   const approveGolden = args[2] === 'true';
   const stripExportPattern = new RegExp(args[3]);
-  const typePackageNames = args.slice(4);
+  const typeNames = args.slice(4);
 
   // For approving, point to the real directory outside of the bazel-out.
   if (approveGolden) {
     goldenDir = path.join(process.env.BUILD_WORKSPACE_DIRECTORY!, args[0]);
   }
 
-  main(goldenDir, npmPackageDir, approveGolden, stripExportPattern, typePackageNames).catch((e) => {
+  main(goldenDir, npmPackageDir, approveGolden, stripExportPattern, typeNames).catch((e) => {
     console.error(e);
     process.exit(1);
   });

bazel/api-golden/index_rjs.bzl

@@ -13,6 +13,7 @@ def api_golden_test_npm_package(
         data = [],
         strip_export_pattern = default_strip_export_pattern,
         types = {},
+        interop_mode = False,
         **kwargs):
     """Builds an API report for all entry-points within the given NPM package and compares it.
 
@@ -23,6 +24,7 @@ def api_golden_test_npm_package(
       data: Runtime dependenices needed for the rule (e.g. the tree artifact of the NPM package)
       strip_export_pattern: An optional regular expression to filter out exports from the golden.
       types: Optional list of type targets to make available in the API report generation.
+      interop_mode: Whether we are compiling in `rules_nodejs` interop mode.
       **kwargs: Other arguments passed to `js_binary`/`js_test` (depending on approval mode)
     """
 
@@ -42,6 +44,7 @@ def api_golden_test_npm_package(
         data = data,
         entry_point = "@devinfra//bazel/api-golden:index_npm_packages.js",
         args = [golden_dir, npm_package, "false", quoted_export_pattern] + type_names,
+        env = {"RJS_MODE": "true" if not interop_mode else "false"},
         **kwargs
     )
 
@@ -51,5 +54,6 @@ def api_golden_test_npm_package(
         data = data,
         entry_point = "@devinfra//bazel/api-golden:index_npm_packages.js",
         args = [golden_dir, npm_package, "true", quoted_export_pattern] + type_names,
+        env = {"RJS_MODE": "true" if not interop_mode else "false"},
         **kwargs
     )

bazel/api-golden/module_mappings.ts renamed to bazel/api-golden/interop_module_mappings.ts

@@ -16,10 +16,11 @@ const scopedTypesPackageRegex = /^@types\/([^_\/]+)__(.+)/;
  * Resolves type modules and returns corresponding path mappings and a
  * list of referenced files.
  */
-export async function resolveTypePackages(typePackageNames: string[]): Promise<{
+export async function resolveTypePackages(typeNames: string[]): Promise<{
   paths: Record<string, string[]>;
   typeFiles: string[];
 }> {
+  const typePackageNames = typeNames.map((t) => `@types/${t}`);
   const typeFiles = [];
   const paths: Record<string, string[]> = {};
 

bazel/api-golden/patch-host.ts

@@ -21,8 +21,7 @@ import os from 'os';
 
 import {AstModule} from '@microsoft/api-extractor/lib/analyzer/AstModule';
 import {ExportAnalyzer} from '@microsoft/api-extractor/lib/analyzer/ExportAnalyzer';
-import {resolveTypePackages} from './module_mappings.js';
-import {patchHostToSkipNodeModules} from './patch-host.js';
+import {resolveTypePackages} from './interop_module_mappings.js';
 
 /**
  * Original definition of the `ExportAnalyzer#fetchAstModuleExportInfo` method.
@@ -51,30 +50,31 @@ const _origFetchAstModuleExportInfo = ExportAnalyzer.prototype.fetchAstModuleExp
 export async function testApiGolden(
   indexFilePath: string,
   stripExportPattern: RegExp,
-  typePackageNames: string[],
+  typeNames: string[],
   packageJsonPath: string,
   customPackageName: string,
 ): Promise<string | null> {
   const tempDir =
     process.env.TEST_TMPDIR ?? fs.mkdtempSync(path.join(os.tmpdir(), 'api-golden-rule'));
-  const {paths, typeFiles} = await resolveTypePackages(typePackageNames);
+  const rjsMode = process.env['RJS_MODE'] === 'true';
+
+  let resolvedTypePackages: Awaited<ReturnType<typeof resolveTypePackages>> | null = null;
+  if (!rjsMode) {
+    resolvedTypePackages = await resolveTypePackages(typeNames);
+  }
 
   const configObject: IConfigFile = {
     compiler: {
-      overrideTsconfig:
-        // We disable automatic `@types` resolution as this throws-off API reports when the API
-        // test is run outside sandbox. Instead we expect a list of  hard-coded types that should
-        // be added.This works in non-sandbox and Windows. Note that we include the type files
-        // directly in the compilation, and additionally set up path mappings. This allows
-        // for global type definitions and module-scoped types to work.
-        {
-          files: [indexFilePath, ...typeFiles],
-          compilerOptions: {
-            paths,
-            types: [],
-            lib: ['esnext', 'dom'],
-          },
+      overrideTsconfig: {
+        // In interop/compat mode, the linker is not available and there is no `node_modules`
+        // directory, so we need to manually wire up global types.
+        files: [indexFilePath, ...(resolvedTypePackages?.typeFiles ?? [])],
+        compilerOptions: {
+          paths: resolvedTypePackages?.paths ?? {},
+          types: rjsMode ? typeNames : [],
+          lib: ['esnext', 'dom'],
         },
+      },
     },
     projectFolder: path.dirname(packageJsonPath),
     mainEntryPointFilePath: indexFilePath,
@@ -116,8 +116,6 @@ export async function testApiGolden(
     configObjectFullPath: undefined,
   });
 
-  patchHostToSkipNodeModules();
-
   // This patches the `ExportAnalyzer` of `api-extractor` so that we can filter out
   // exports that match a specified pattern. Ideally this would not be needed as the
   // TSDoc JSDoc annotations could be used to filter out exports from the API report,