module: move test reporter loading

Move the logic for handling --test-reporter out of the
general module loader and into the test_runner subsystem.

Backport-PR-URL: #46361
PR-URL: #45923
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jacob Smith <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>

Author: GeoffreyBooth

doc/api/test.md

@@ -470,7 +470,7 @@ The following built-reporters are supported:
   The `spec` reporter outputs the test results in a human-readable format.
 
 * `dot`
-  The `dot` reporter outputs the test results in a comact format,
+  The `dot` reporter outputs the test results in a compact format,
   where each passing test is represented by a `.`,
   and each failing test is represented by a `X`.
 
@@ -591,6 +591,9 @@ module.exports = async function * customReporter(source) {
 };
 ```
 
+The value provided to `--test-reporter` should be a string like one used in an
+`import()` in JavaScript code, or a value provided for [`--import`][].
+
 ### Multiple reporters
 
 The [`--test-reporter`][] flag can be specified multiple times to report test
@@ -1581,6 +1584,7 @@ added:
   aborted.
 
 [TAP]: https://testanything.org/
+[`--import`]: cli.md#--importmodule
 [`--test-name-pattern`]: cli.md#--test-name-pattern
 [`--test-only`]: cli.md#--test-only
 [`--test-reporter-destination`]: cli.md#--test-reporter-destination

lib/internal/modules/run_main.js

@@ -1,8 +1,11 @@
 'use strict';
 
+const {
+  StringPrototypeEndsWith,
+} = primordials;
+
 const { getOptionValue } = require('internal/options');
 const path = require('path');
-const { shouldUseESMLoader } = require('internal/modules/utils');
 
 function resolveMainPath(main) {
   // Note extension resolution for the main entry point can be deprecated in a
@@ -20,6 +23,29 @@ function resolveMainPath(main) {
   return mainPath;
 }
 
+function shouldUseESMLoader(mainPath) {
+  /**
+   * @type {string[]} userLoaders A list of custom loaders registered by the user
+   * (or an empty list when none have been registered).
+   */
+  const userLoaders = getOptionValue('--experimental-loader');
+  /**
+   * @type {string[]} userImports A list of preloaded modules registered by the user
+   * (or an empty list when none have been registered).
+   */
+  const userImports = getOptionValue('--import');
+  if (userLoaders.length > 0 || userImports.length > 0)
+    return true;
+  const { readPackageScope } = require('internal/modules/cjs/loader');
+  // Determine the module format of the main
+  if (mainPath && StringPrototypeEndsWith(mainPath, '.mjs'))
+    return true;
+  if (!mainPath || StringPrototypeEndsWith(mainPath, '.cjs'))
+    return false;
+  const pkg = readPackageScope(mainPath);
+  return pkg && pkg.data.type === 'module';
+}
+
 function runMainESM(mainPath) {
   const { loadESM } = require('internal/process/esm_loader');
   const { pathToFileURL } = require('internal/url');

lib/internal/modules/utils.js

@@ -9,9 +9,9 @@ const {
 } = primordials;
 const { basename } = require('path');
 const { createWriteStream } = require('fs');
+const { pathToFileURL } = require('internal/url');
 const { createDeferredPromise } = require('internal/util');
 const { getOptionValue } = require('internal/options');
-const { requireOrImport } = require('internal/modules/utils');
 
 const {
   codes: {
@@ -103,7 +103,17 @@ const kDefaultDestination = 'stdout';
 async function getReportersMap(reporters, destinations) {
   return SafePromiseAllReturnArrayLike(reporters, async (name, i) => {
     const destination = kBuiltinDestinations.get(destinations[i]) ?? createWriteStream(destinations[i]);
-    let reporter = await requireOrImport(kBuiltinReporters.get(name) ?? name);
+
+    // Load the test reporter passed to --test-reporter
+    const reporterSpecifier = kBuiltinReporters.get(name) ?? name;
+    let parentURL;
+    try {
+      parentURL = pathToFileURL(process.cwd() + '/').href;
+    } catch {
+      parentURL = 'file:///';
+    }
+    const { esmLoader } = require('internal/process/esm_loader');
+    let reporter = await esmLoader.import(reporterSpecifier, parentURL, { __proto__: null });
 
     if (reporter?.default) {
       reporter = reporter.default;

lib/internal/test_runner/utils.js

@@ -53,7 +53,6 @@ const expectedModules = new Set([
   'NativeModule internal/idna',
   'NativeModule internal/linkedlist',
   'NativeModule internal/modules/cjs/loader',
-  'NativeModule internal/modules/utils',
   'NativeModule internal/modules/esm/utils',
   'NativeModule internal/modules/helpers',
   'NativeModule internal/modules/package_json_reader',

test/fixtures/test-runner/node_modules/reporter-cjs/index.js

@@ -86,10 +86,32 @@ describe('node:test reporters', { concurrency: true }, () => {
     it(`should support a '${ext}' file as a custom reporter`, async () => {
       const filename = `custom.${ext}`;
       const child = spawnSync(process.execPath,
-                              ['--test', '--test-reporter', fixtures.path('test-runner/custom_reporters/', filename),
+                              ['--test', '--test-reporter', fixtures.fileURL('test-runner/custom_reporters/', filename),
                                testFile]);
       assert.strictEqual(child.stderr.toString(), '');
       assert.strictEqual(child.stdout.toString(), `${filename} {"test:start":5,"test:pass":2,"test:fail":3,"test:plan":3,"test:diagnostic":7}`);
     });
   });
+
+  it('should support a custom reporter from node_modules', async () => {
+    const child = spawnSync(process.execPath,
+                            ['--test', '--test-reporter', 'reporter-cjs', 'reporters.js'],
+                            { cwd: fixtures.path('test-runner') });
+    assert.strictEqual(child.stderr.toString(), '');
+    assert.match(
+      child.stdout.toString(),
+      /^package: reporter-cjs{"test:start":5,"test:pass":2,"test:fail":3,"test:plan":3,"test:diagnostic":\d+}$/,
+    );
+  });
+
+  it('should support a custom ESM reporter from node_modules', async () => {
+    const child = spawnSync(process.execPath,
+                            ['--test', '--test-reporter', 'reporter-esm', 'reporters.js'],
+                            { cwd: fixtures.path('test-runner') });
+    assert.strictEqual(child.stderr.toString(), '');
+    assert.match(
+      child.stdout.toString(),
+      /^package: reporter-esm{"test:start":5,"test:pass":2,"test:fail":3,"test:plan":3,"test:diagnostic":\d+}$/,
+    );
+  });
 });