test_runner: support typescript in run

Author: avivkeller

doc/api/test.md

@@ -1246,6 +1246,9 @@ added:
   - v18.9.0
   - v16.19.0
 changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/55126
+    description: Added typescript options.
   - version: REPLACEME
     pr-url: https://github.com/nodejs/node/pull/53937
     description: Added coverage options.
@@ -1316,6 +1319,11 @@ changes:
     fail after.
     If unspecified, subtests inherit this value from their parent.
     **Default:** `Infinity`.
+  * `typescript` {string} Configures the type of typescript support, if any. If set to `'transform'`,
+    each test file is run with [`--experimental-transform-types`][]. If set to `'strip'`,
+    each test file is run with [`--experimental-strip-types`][]. If set to `'none'`, type-stripping
+    does not occur.
+    **Default:** `'none'`.
   * `watch` {boolean} Whether to run in watch mode or not. **Default:** `false`.
   * `shard` {Object} Running tests in a specific shard. **Default:** `undefined`.
     * `index` {number} is a positive integer between 1 and `<total>`
@@ -3562,9 +3570,11 @@ added:
 Can be used to abort test subtasks when the test has been aborted.
 
 [TAP]: https://testanything.org/
+[`--experimental-strip-types`]: cli.md#--experimental-strip-types
 [`--experimental-test-coverage`]: cli.md#--experimental-test-coverage
 [`--experimental-test-module-mocks`]: cli.md#--experimental-test-module-mocks
 [`--experimental-test-snapshots`]: cli.md#--experimental-test-snapshots
+[`--experimental-transform-types`]: cli.md#--experimental-transform-types
 [`--import`]: cli.md#--importmodule
 [`--test-concurrency`]: cli.md#--test-concurrency
 [`--test-coverage-include`]: cli.md#--test-coverage-include

lib/internal/test_runner/runner.js

@@ -82,7 +82,7 @@ const {
 const {
   convertStringToRegExp,
   countCompletedTest,
-  kDefaultPattern,
+  getDefaultPattern,
   parseCommandLine,
 } = require('internal/test_runner/utils');
 const { Glob } = require('internal/fs/glob');
@@ -105,20 +105,20 @@ const kCanceledTests = new SafeSet()
 
 let kResistStopPropagation;
 
-function createTestFileList(patterns, cwd) {
-  const hasUserSuppliedPattern = patterns != null;
-  if (!patterns || patterns.length === 0) {
-    patterns = [kDefaultPattern];
+function createTestFileList({ globPatterns, cwd, typescript }) {
+  const hasUserSuppliedPattern = globPatterns != null;
+  if (!globPatterns || globPatterns.length === 0) {
+    globPatterns = [getDefaultPattern(typescript)];
   }
-  const glob = new Glob(patterns, {
+  const glob = new Glob(globPatterns, {
     __proto__: null,
     cwd,
     exclude: (name) => name === 'node_modules',
   });
   const results = glob.globSync();
 
   if (hasUserSuppliedPattern && results.length === 0 && ArrayPrototypeEvery(glob.matchers, (m) => !m.hasMagic())) {
-    console.error(`Could not find '${ArrayPrototypeJoin(patterns, ', ')}'`);
+    console.error(`Could not find '${ArrayPrototypeJoin(globPatterns, ', ')}'`);
     process.exit(kGenericUserError);
   }
 
@@ -130,7 +130,7 @@ function filterExecArgv(arg, i, arr) {
   !ArrayPrototypeSome(kFilterArgValues, (p) => arg === p || (i > 0 && arr[i - 1] === p) || StringPrototypeStartsWith(arg, `${p}=`));
 }
 
-function getRunArgs(path, { forceExit, inspectPort, testNamePatterns, testSkipPatterns, only }) {
+function getRunArgs(path, { forceExit, inspectPort, testNamePatterns, testSkipPatterns, typescript, only }) {
   const argv = ArrayPrototypeFilter(process.execArgv, filterExecArgv);
   if (forceExit === true) {
     ArrayPrototypePush(argv, '--test-force-exit');
@@ -147,6 +147,9 @@ function getRunArgs(path, { forceExit, inspectPort, testNamePatterns, testSkipPa
   if (only === true) {
     ArrayPrototypePush(argv, '--test-only');
   }
+  if (typescript !== 'none') {
+    ArrayPrototypePush(argv, `--experimental-${typescript}-types`);
+  }
 
   if (path === kIsolatedProcessName) {
     ArrayPrototypePush(argv, '--test', ...ArrayPrototypeSlice(process.argv, 1));
@@ -473,7 +476,7 @@ function watchFiles(testFiles, opts) {
   // Watch for changes in current filtered files
   watcher.on('changed', ({ owners, eventType }) => {
     if (!opts.hasFiles && (eventType === 'rename' || eventType === 'change')) {
-      const updatedTestFiles = createTestFileList(opts.globPatterns, opts.cwd);
+      const updatedTestFiles = createTestFileList(opts);
       const newFileName = ArrayPrototypeFind(updatedTestFiles, (x) => !ArrayPrototypeIncludes(testFiles, x));
       const previousFileName = ArrayPrototypeFind(testFiles, (x) => !ArrayPrototypeIncludes(updatedTestFiles, x));
 
@@ -540,6 +543,7 @@ function run(options = kEmptyObject) {
     forceExit,
     inspectPort,
     isolation = 'process',
+    typescript = 'none',
     watch,
     setup,
     only,
@@ -626,6 +630,7 @@ function run(options = kEmptyObject) {
     });
   }
   validateOneOf(isolation, 'options.isolation', ['process', 'none']);
+  validateOneOf(typescript, 'options.typescript', ['strip', 'transform', 'none']);
   validateBoolean(coverage, 'options.coverage');
   if (coverageExcludeGlobs != null) {
     if (!ArrayIsArray(coverageExcludeGlobs)) {
@@ -662,12 +667,6 @@ function run(options = kEmptyObject) {
   // This const should be replaced by a run option in the future.
   const cwd = process.cwd();
 
-  let testFiles = files ?? createTestFileList(globPatterns, cwd);
-
-  if (shard) {
-    testFiles = ArrayPrototypeFilter(testFiles, (_, index) => index % shard.total === shard.index - 1);
-  }
-
   let teardown;
   let postRun;
   let filesWatcher;
@@ -685,8 +684,15 @@ function run(options = kEmptyObject) {
     forceExit,
     cwd,
     isolation,
+    typescript,
   };
 
+  let testFiles = files ?? createTestFileList(opts);
+
+  if (shard) {
+    testFiles = ArrayPrototypeFilter(testFiles, (_, index) => index % shard.total === shard.index - 1);
+  }
+
   if (isolation === 'process') {
     if (process.env.NODE_TEST_CONTEXT !== undefined) {
       process.emitWarning('node:test run() is being called recursively within a test file. skipping running files.');

lib/internal/test_runner/utils.js

@@ -53,9 +53,15 @@ const coverageColors = {
 const kMultipleCallbackInvocations = 'multipleCallbackInvocations';
 const kRegExpPattern = /^\/(.*)\/([a-z]*)$/;
 
-const kPatterns = ['test', 'test/**/*', 'test-*', '*[._-]test'];
-const kDefaultPattern = `**/{${ArrayPrototypeJoin(kPatterns, ',')}}.?(c|m)js`;
-
+const kPatterns = ArrayPrototypeJoin(['test', 'test/**/*', 'test-*', '*[._-]test'], ',');
+const kJavaScriptExtensions = ArrayPrototypeJoin(['js', 'mjs', 'cjs'], ',');
+const kTypeScriptExtensions = ArrayPrototypeJoin(['ts', 'mts', 'cts'], ',');
+const kDefaultJavaScriptPattern = `**/{${kPatterns}}.{${kJavaScriptExtensions}}`;
+const kDefaultTypeScriptPattern = `**/{${kPatterns}}.{${kJavaScriptExtensions}${kTypeScriptExtensions}}`;
+
+function getDefaultPattern(typescript) {
+  return typescript ? kDefaultTypeScriptPattern : kDefaultJavaScriptPattern;
+}
 
 function createDeferredCallback() {
   let calledCount = 0;
@@ -595,7 +601,7 @@ module.exports = {
   countCompletedTest,
   createDeferredCallback,
   isTestFailureError,
-  kDefaultPattern,
+  getDefaultPattern,
   parseCommandLine,
   reporterScope,
   shouldColorizeTestFiles,

test/fixtures/test-runner/run-typescript/run-tests.js

@@ -0,0 +1,6 @@
+const { tap } = require('node:test/reporters');
+const { run } = require('node:test');
+
+run({ typescript: process.argv[2], files: process.argv[3] ? [process.argv[3]] : undefined })
+ .compose(tap)
+ .pipe(process.stdout);

test/fixtures/test-runner/run-typescript/strip.ts

@@ -0,0 +1,4 @@
+import { test } from 'node:test';
+
+// 'as string' is stripped
+test('strip.ts' as string);

test/fixtures/test-runner/run-typescript/test.ts

@@ -0,0 +1,3 @@
+import { test } from 'node:test';
+
+test('test.ts');

test/fixtures/test-runner/run-typescript/transform.ts

@@ -0,0 +1,7 @@
+import { test } from 'node:test';
+
+enum ENUM {
+    VALUE = 'transform.ts'
+}
+
+test(ENUM.VALUE);

test/parallel/test-runner-run.mjs

@@ -514,6 +514,85 @@ describe('require(\'node:test\').run', { concurrency: true }, () => {
     for await (const _ of stream);
     assert.match(stderr, /Warning: node:test run\(\) is being called recursively/);
   });
+
+  describe('TypeScript support', () => {
+    const tsCwd = fixtures.path('test-runner/run-typescript');
+    it('throws for invalid values', () => {
+      [Symbol(), {}, 0, 1, '1', Promise.resolve([])].forEach((typescript) => {
+        assert.throws(() => run({ typescript }), {
+          code: 'ERR_INVALID_ARG_VALUE',
+          message: /The property 'options\.typescript' must be one of: 'strip', 'transform', 'none'/
+        });
+      });
+    });
+
+    it(`'none' does nothing`, () => {
+      it('finds TypeScript files', async () => {
+        const spawned = await common.spawnPromisified(process.execPath,
+                                                      ['run-tests.js', 'none'], { cwd: tsCwd });
+
+        assert.doesNotMatch(spawned.stdout, /ok 1 - test\.ts/);
+        assert.strictEqual(spawned.stderr, '');
+        assert.strictEqual(spawned.signal, null);
+        assert.strictEqual(spawned.code, 0);
+      });
+    });
+
+    describe(`'strip'`, () => {
+      it('finds TypeScript files', async () => {
+        const spawned = await common.spawnPromisified(process.execPath,
+                                                      ['run-tests.js', 'strip'], { cwd: tsCwd });
+
+        assert.match(spawned.stdout, /ok 1 - test\.ts/);
+        assert.strictEqual(spawned.stderr, '');
+        assert.strictEqual(spawned.signal, null);
+        assert.strictEqual(spawned.code, 0);
+      });
+
+      it('strips TypeScript files', async () => {
+        const spawned = await common.spawnPromisified(process.execPath,
+                                                      ['run-tests.js', 'strip', 'strip.ts'], { cwd: tsCwd });
+
+        assert.match(spawned.stdout, /ok 1 - strip\.ts/);
+        assert.strictEqual(spawned.stderr, '');
+        assert.strictEqual(spawned.signal, null);
+        assert.strictEqual(spawned.code, 0);
+      });
+
+      it('does not transform TypeScript files', async () => {
+        const spawned = await common.spawnPromisified(process.execPath,
+                                                      ['run-tests.js', 'strip', 'transform.ts'], { cwd: tsCwd });
+
+        assert.match(spawned.stdout, /TypeScript enum is not supported in strip-only mode/);
+        assert.match(spawned.stdout, /not ok 1 - transform\.ts/);
+        assert.strictEqual(spawned.stderr, '');
+        assert.strictEqual(spawned.signal, null);
+        assert.strictEqual(spawned.code, 0);
+      });
+    });
+
+    describe(`'transform'`, () => {
+      it('finds TypeScript files', async () => {
+        const spawned = await common.spawnPromisified(process.execPath,
+                                                      ['run-tests.js', 'transform'], { cwd: tsCwd });
+
+        assert.match(spawned.stdout, /ok 1 - test\.ts/);
+        assert.strictEqual(spawned.stderr, '');
+        assert.strictEqual(spawned.signal, null);
+        assert.strictEqual(spawned.code, 0);
+      });
+
+      it('transforms TypeScript files', async () => {
+        const spawned = await common.spawnPromisified(process.execPath,
+                                                      ['run-tests.js', 'transform', 'transform.ts'], { cwd: tsCwd });
+
+        assert.match(spawned.stdout, /ok 1 - transform\.ts/);
+        assert.strictEqual(spawned.stderr, '');
+        assert.strictEqual(spawned.signal, null);
+        assert.strictEqual(spawned.code, 0);
+      });
+    });
+  });
 });
 
 describe('forceExit', () => {