move spawnAsPromised to test/common as spawnPromisified

Author: JakobJingleheimer

test/common/index.js

@@ -24,7 +24,7 @@
 const process = global.process;  // Some tests tamper with the process global.
 
 const assert = require('assert');
-const { exec, execSync, spawnSync } = require('child_process');
+const { exec, execSync, spawnSync, spawn: spawnAsync } = require('child_process');
 const fs = require('fs');
 // Do not require 'os' until needed so that test-os-checked-function can
 // monkey patch it. If 'os' is required here, that test will fail.
@@ -842,6 +842,36 @@ function requireNoPackageJSONAbove(dir = __dirname) {
   }
 }
 
+function spawnPromisified(...args) {
+  let stderr = '';
+  let stdout = '';
+
+  const child = spawnAsync(...args);
+  child.stderr.setEncoding('utf8');
+  child.stderr.on('data', (data) => { stderr += data; });
+  child.stdout.setEncoding('utf8');
+  child.stdout.on('data', (data) => { stdout += data; });
+
+  return new Promise((resolve, reject) => {
+    child.on('close', (code, signal) => {
+      resolve({
+        code,
+        signal,
+        stderr,
+        stdout,
+      });
+    });
+    child.on('error', (code, signal) => {
+      reject({
+        code,
+        signal,
+        stderr,
+        stdout,
+      });
+    });
+  });
+}
+
 const common = {
   allowGlobals,
   buildType,
@@ -891,6 +921,7 @@ const common = {
   skipIfEslintMissing,
   skipIfInspectorDisabled,
   skipIfWorker,
+  spawnPromisified,
 
   get enoughTestMem() {
     return require('os').totalmem() > 0x70000000; /* 1.75 Gb */

test/common/index.mjs

@@ -48,7 +48,8 @@ const {
   getArrayBufferViews,
   getBufferSources,
   getTTYfd,
-  runWithInvalidFD
+  runWithInvalidFD,
+  spawnPromisified,
 } = common;
 
 export {
@@ -97,5 +98,6 @@ export {
   getBufferSources,
   getTTYfd,
   runWithInvalidFD,
-  createRequire
+  createRequire,
+  spawnPromisified,
 };

test/es-module/helper.spawnAsPromised.mjs

@@ -1,6 +1,6 @@
 'use strict';
 
-const { mustCall } = require('../common');
+const { spawnPromisified } = require('../common');
 const fixtures = require('../common/fixtures.js');
 const assert = require('node:assert');
 const path = require('node:path');
@@ -14,58 +14,55 @@ const pjson = path.resolve(
   fixtures.path('/es-modules/package-type-module/package.json')
 );
 
-(async () => {
-  const { default: spawn } = await import('./helper.spawnAsPromised.mjs');
 
-  describe('CJS ↔︎ ESM interop warnings', { concurrency: true }, () => {
+describe('CJS ↔︎ ESM interop warnings', { concurrency: true }, () => {
 
-    it(async () => {
-      const required = path.resolve(
-        fixtures.path('/es-modules/package-type-module/cjs.js')
-      );
-      const basename = 'cjs.js';
-      const { code, signal, stderr } = await spawn(execPath, [requiringCjsAsEsm]);
+  it(async () => {
+    const required = path.resolve(
+      fixtures.path('/es-modules/package-type-module/cjs.js')
+    );
+    const basename = 'cjs.js';
+    const { code, signal, stderr } = await spawnPromisified(execPath, [requiringCjsAsEsm]);
 
-      assert.ok(
-        stderr.replaceAll('\r', '').includes(
-          `Error [ERR_REQUIRE_ESM]: require() of ES Module ${required} from ${requiringCjsAsEsm} not supported.\n`
-        )
-      );
-      assert.ok(
-        stderr.replaceAll('\r', '').includes(
-          `Instead rename ${basename} to end in .cjs, change the requiring ` +
-          'code to use dynamic import() which is available in all CommonJS ' +
-          `modules, or change "type": "module" to "type": "commonjs" in ${pjson} to ` +
-          'treat all .js files as CommonJS (using .mjs for all ES modules ' +
-          'instead).\n'
-        )
-      );
+    assert.ok(
+      stderr.replaceAll('\r', '').includes(
+        `Error [ERR_REQUIRE_ESM]: require() of ES Module ${required} from ${requiringCjsAsEsm} not supported.\n`
+      )
+    );
+    assert.ok(
+      stderr.replaceAll('\r', '').includes(
+        `Instead rename ${basename} to end in .cjs, change the requiring ` +
+        'code to use dynamic import() which is available in all CommonJS ' +
+        `modules, or change "type": "module" to "type": "commonjs" in ${pjson} to ` +
+        'treat all .js files as CommonJS (using .mjs for all ES modules ' +
+        'instead).\n'
+      )
+    );
 
-      assert.strictEqual(code, 1);
-      assert.strictEqual(signal, null);
-    });
+    assert.strictEqual(code, 1);
+    assert.strictEqual(signal, null);
+  });
 
-    it(async () => {
-      const required = path.resolve(
-        fixtures.path('/es-modules/package-type-module/esm.js')
-      );
-      const basename = 'esm.js';
-      const { code, signal, stderr } = await spawn(execPath, [requiringEsm]);
+  it(async () => {
+    const required = path.resolve(
+      fixtures.path('/es-modules/package-type-module/esm.js')
+    );
+    const basename = 'esm.js';
+    const { code, signal, stderr } = await spawnPromisified(execPath, [requiringEsm]);
 
-      assert.ok(
-        stderr.replace(/\r/g, '').includes(
-          `Error [ERR_REQUIRE_ESM]: require() of ES Module ${required} from ${requiringEsm} not supported.\n`
-        )
-      );
-      assert.ok(
-        stderr.replace(/\r/g, '').includes(
-          `Instead change the require of ${basename} in ${requiringEsm} to` +
-          ' a dynamic import() which is available in all CommonJS modules.\n'
-        )
-      );
+    assert.ok(
+      stderr.replace(/\r/g, '').includes(
+        `Error [ERR_REQUIRE_ESM]: require() of ES Module ${required} from ${requiringEsm} not supported.\n`
+      )
+    );
+    assert.ok(
+      stderr.replace(/\r/g, '').includes(
+        `Instead change the require of ${basename} in ${requiringEsm} to` +
+        ' a dynamic import() which is available in all CommonJS modules.\n'
+      )
+    );
 
-      assert.strictEqual(code, 1);
-      assert.strictEqual(signal, null);
-    });
+    assert.strictEqual(code, 1);
+    assert.strictEqual(signal, null);
   });
-})().then(mustCall());
+});

test/es-module/test-cjs-esm-warn.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { mustCall } = require('../common');
+const { spawnPromisified } = require('../common');
 const fixtures = require('../common/fixtures.js');
 const assert = require('node:assert');
 const { execPath } = require('node:process');
@@ -9,16 +9,12 @@ const { describe, it } = require('node:test');
 
 const entry = fixtures.path('/es-modules/builtin-imports-case.mjs');
 
-(async () => {
-  const { default: spawn } = await import('./helper.spawnAsPromised.mjs');
+describe('ESM: importing builtins & CJS', () => {
+  it('should work', async () => {
+    const { code, signal, stdout } = await spawnPromisified(execPath, [entry]);
 
-  describe('ESM: importing builtins & CJS', () => {
-    it('should work', async () => {
-      const { code, signal, stdout } = await spawn(execPath, [entry]);
-
-      assert.strictEqual(code, 0);
-      assert.strictEqual(signal, null);
-      assert.strictEqual(stdout, 'ok\n');
-    });
+    assert.strictEqual(code, 0);
+    assert.strictEqual(signal, null);
+    assert.strictEqual(stdout, 'ok\n');
   });
-})().then(mustCall());
+});

test/es-module/test-esm-cjs-builtins.js

@@ -1,33 +1,29 @@
 'use strict';
 
-const { mustCall } = require('../common');
+const { spawnPromisified } = require('../common');
 const fixtures = require('../common/fixtures.js');
 const assert = require('node:assert');
 const { execPath } = require('node:process');
 const { describe, it } = require('node:test');
 
 
-(async () => {
-  const { default: spawn } = await import('./helper.spawnAsPromised.mjs');
+describe('ESM: importing CJS', { concurrency: true }, () => {
+  it('should support valid CJS exports', async () => {
+    const validEntry = fixtures.path('/es-modules/cjs-exports.mjs');
+    const { code, signal, stdout } = await spawnPromisified(execPath, [validEntry]);
 
-  describe('ESM: importing CJS', { concurrency: true }, () => {
-    it('should support valid CJS exports', async () => {
-      const validEntry = fixtures.path('/es-modules/cjs-exports.mjs');
-      const { code, signal, stdout } = await spawn(execPath, [validEntry]);
-
-      assert.strictEqual(code, 0);
-      assert.strictEqual(signal, null);
-      assert.strictEqual(stdout, 'ok\n');
-    });
+    assert.strictEqual(code, 0);
+    assert.strictEqual(signal, null);
+    assert.strictEqual(stdout, 'ok\n');
+  });
 
-    it('should eror on invalid CJS exports', async () => {
-      const invalidEntry = fixtures.path('/es-modules/cjs-exports-invalid.mjs');
-      const { code, signal, stderr } = await spawn(execPath, [invalidEntry]);
+  it('should eror on invalid CJS exports', async () => {
+    const invalidEntry = fixtures.path('/es-modules/cjs-exports-invalid.mjs');
+    const { code, signal, stderr } = await spawnPromisified(execPath, [invalidEntry]);
 
-      assert.strictEqual(code, 1);
-      assert.strictEqual(signal, null);
-      assert.ok(stderr.includes('Warning: To load an ES module'));
-      assert.ok(stderr.includes('Unexpected token \'export\''));
-    });
+    assert.strictEqual(code, 1);
+    assert.strictEqual(signal, null);
+    assert.ok(stderr.includes('Warning: To load an ES module'));
+    assert.ok(stderr.includes('Unexpected token \'export\''));
   });
-})().then(mustCall());
+});

test/es-module/test-esm-cjs-exports.js

@@ -1,11 +1,9 @@
-import '../common/index.mjs';
+import { spawnPromisified } from '../common/index.mjs';
 import * as fixtures from '../common/fixtures.mjs';
 import assert from 'node:assert';
 import { execPath } from 'node:process';
 import { describe, it } from 'node:test';
 
-import spawn from './helper.spawnAsPromised.mjs';
-
 
 // Expect note to be included in the error output
 const expectedNote = 'To load an ES module, ' +
@@ -21,7 +19,7 @@ const mustNotIncludeMessage = {
   includeNote: false,
 };
 
-describe('ESM: ', { concurrently: true }, () => {
+describe('ESM: Errors for unexpected exports', { concurrently: true }, () => {
   for (
     const { errorNeedle, filePath, getMessage, includeNote }
     of [
@@ -82,7 +80,7 @@ describe('ESM: ', { concurrently: true }, () => {
     ]
   ) {
     it(`should ${includeNote ? '' : 'NOT'} include note`, async () => {
-      const { code, stderr } = await spawn(execPath, [filePath]);
+      const { code, stderr } = await spawnPromisified(execPath, [filePath]);
 
       assert.strictEqual(code, 1);
 

test/es-module/test-esm-cjs-load-error-note.mjs

@@ -1,24 +1,20 @@
 'use strict';
 
-const { mustCall } = require('../common');
+const { spawnPromisified } = require('../common');
 const fixtures = require('../common/fixtures.js');
 const assert = require('node:assert');
 const { execPath } = require('node:process');
 const { describe, it } = require('node:test');
 
 
-(async () => {
-  const { default: spawn } = await import('./helper.spawnAsPromised.mjs');
+describe('ESM: importing CJS', () => {
+  it('should work', async () => {
+    const { code, signal, stdout } = await spawnPromisified(execPath, [
+      fixtures.path('/es-modules/cjs.js'),
+    ]);
 
-  describe('ESM: importing CJS', () => {
-    it('should work', async () => {
-      const { code, signal, stdout } = await spawn(execPath, [
-        fixtures.path('/es-modules/cjs.js'),
-      ]);
-
-      assert.strictEqual(code, 0);
-      assert.strictEqual(signal, null);
-      assert.strictEqual(stdout, 'executed\n');
-    });
+    assert.strictEqual(code, 0);
+    assert.strictEqual(signal, null);
+    assert.strictEqual(stdout, 'executed\n');
   });
-})().then(mustCall());
+});

test/es-module/test-esm-cjs-main.js

@@ -1,22 +1,18 @@
 'use strict';
 
-const { mustCall } = require('../common');
+const { spawnPromisified } = require('../common');
 const fixtures = require('../common/fixtures.js');
 const assert = require('node:assert');
 const { execPath } = require('node:process');
 const { describe, it } = require('node:test');
 
 
-(async () => {
-  const { default: spawn } = await import('./helper.spawnAsPromised.mjs');
+describe('ESM: importing an encoded path', () => {
+  it('should throw', async () => {
+    const { code } = await spawnPromisified(execPath, [
+      fixtures.path('es-module-url/native.mjs'),
+    ]);
 
-  describe('ESM: importing an encoded path', () => {
-    it('should throw', async () => {
-      const { code } = await spawn(execPath, [
-        fixtures.path('es-module-url/native.mjs'),
-      ]);
-
-      assert.strictEqual(code, 1);
-    });
+    assert.strictEqual(code, 1);
   });
-})().then(mustCall());
+});