fix(Windows): adapt for Node.js breaking change (#210)

* ci: enable windows workflow

* ci: use bin/index.ts directly

* fix: adaptation for Node.js breaking change on Windows

* fix: adaptation for Node.js breaking change on Windows

* ci: adaptation for Node.js breaking change on Windows

* ci: fix c8 comments

* ci: fix c8 comments

package.json

@@ -4,8 +4,7 @@
   "description": "🐷 Poku makes testing easy for Node.js, Bun & Deno at the same time.",
   "main": "./lib/index.js",
   "scripts": {
-    "test": "npx poku --parallel --debug test/unit,test/integration,test/e2e",
-    "pretest:c8": "npm run build",
+    "test": "tsx src/bin/index.ts --parallel --debug test/unit,test/integration,test/e2e",
     "test:c8": "c8 npm run test",
     "test:ci": "tsx ./test/ci.test.ts",
     "test:node": "FILTER='node-' npm run test:ci",

src/bin/index.ts

@@ -1,12 +1,12 @@
 #! /usr/bin/env node
 
+/* c8 ignore start */
 import { escapeRegExp } from '../modules/list-files.js';
 import { getArg, getLastParam, hasArg } from '../helpers/get-arg.js';
 import { poku } from '../index.js';
 import { platformIsValid } from '../helpers/get-runtime.js';
 import { format } from '../helpers/format.js';
 
-/* c8 ignore start */
 const dirs =
   (hasArg('include')
     ? getArg('include')?.split(',')
@@ -22,7 +22,6 @@ if (hasArg('log-success'))
   console.log(
     `The flag ${format.bold('--log-success')} is deprecated. Use ${format.bold('--debug')} instead.`
   );
-/* c8 ignore end */
 
 poku(dirs, {
   platform: platformIsValid(platform) ? platform : undefined,
@@ -32,3 +31,4 @@ poku(dirs, {
   quiet,
   debug,
 });
+/* c8 ignore stop */

src/helpers/find-file.ts

@@ -30,4 +30,4 @@ export const findFile = (error: Error) => {
 
   return file;
 };
-/* c8 ignore end */
+/* c8 ignore stop */

src/helpers/pad.ts

@@ -21,4 +21,4 @@ export const padStart = (
 
   return fullPadString + str;
 };
-/* c8 ignore end */
+/* c8 ignore stop */

src/modules/assert-promise.ts

@@ -277,16 +277,15 @@ async function doesNotReject(
   );
 }
 
+/* c8 ignore start */
 const match = async (
   value: string,
   regExp: RegExp,
   message?: ParseAssertionOptions['message']
 ): Promise<void> => {
-  /* c8 ignore start */
   if (typeof nodeVersion === 'number' && nodeVersion < 12) {
     throw new Error('match is available from Node.js 12 or higher');
   }
-  /* c8 ignore stop */
 
   await parseAssertion(() => nodeAssert?.match(value, regExp), {
     message,
@@ -295,17 +294,17 @@ const match = async (
     defaultMessage: 'Value should match regExp',
   });
 };
+/* c8 ignore stop */
 
+/* c8 ignore start */
 const doesNotMatch = async (
   value: string,
   regExp: RegExp,
   message?: ParseAssertionOptions['message']
 ): Promise<void> => {
-  /* c8 ignore start */
   if (typeof nodeVersion === 'number' && nodeVersion < 12) {
     throw new Error('doesNotMatch is available from Node.js 12 or higher');
   }
-  /* c8 ignore stop */
 
   await parseAssertion(() => nodeAssert.doesNotMatch(value, regExp), {
     message,
@@ -314,6 +313,7 @@ const doesNotMatch = async (
     defaultMessage: 'Value should not match regExp',
   });
 };
+/* c8 ignore stop */
 
 export const assertPromise = Object.assign(
   (value: unknown, message?: ParseAssertionOptions['message']) =>

src/modules/assert.ts

@@ -269,16 +269,15 @@ async function doesNotReject(
   );
 }
 
+/* c8 ignore start */
 const match = (
   value: string,
   regExp: RegExp,
   message?: ParseAssertionOptions['message']
 ): void => {
-  /* c8 ignore start */
   if (typeof nodeVersion === 'number' && nodeVersion < 12) {
     throw new Error('match is available from Node.js 12 or higher');
   }
-  /* c8 ignore stop */
 
   parseAssertion(() => nodeAssert?.match(value, regExp), {
     message,
@@ -287,17 +286,17 @@ const match = (
     defaultMessage: 'Value should match regExp',
   });
 };
+/* c8 ignore stop */
 
+/* c8 ignore start */
 const doesNotMatch = (
   value: string,
   regExp: RegExp,
   message?: ParseAssertionOptions['message']
 ): void => {
-  /* c8 ignore start */
   if (typeof nodeVersion === 'number' && nodeVersion < 12) {
     throw new Error('doesNotMatch is available from Node.js 12 or higher');
   }
-  /* c8 ignore stop */
 
   parseAssertion(() => nodeAssert.doesNotMatch(value, regExp), {
     message,
@@ -306,6 +305,7 @@ const doesNotMatch = (
     defaultMessage: 'Value should not match regExp',
   });
 };
+/* c8 ignore stop */
 
 export const assert = Object.assign(
   (value: unknown, message?: ParseAssertionOptions['message']) =>

src/modules/create-service.ts

@@ -22,7 +22,7 @@ const killWindowsProcess = (PID: number) =>
 process.once('SIGINT', () => {
   secureEnds();
 });
-/* c8 ignore end */
+/* c8 ignore stop */
 
 const backgroundProcess = (
   runtime: string,
@@ -35,10 +35,13 @@ const backgroundProcess = (
 
     const service = spawn(runtime, args, {
       stdio: ['inherit', 'pipe', 'pipe'],
-      shell: false,
+      /* c8 ignore next */
+      shell: isWindows,
       cwd: options?.cwd ? sanitizePath(path.normalize(options.cwd)) : undefined,
       env: process.env,
+      /* c8 ignore next */
       detached: !isWindows,
+      /* c8 ignore next */
       windowsHide: isWindows,
       timeout: options?.timeout,
     });
@@ -69,7 +72,7 @@ const backgroundProcess = (
     };
 
     runningProcesses[PID] = end;
-    /* c8 ignore end */
+    /* c8 ignore stop */
 
     service.stdout.on('data', (data: Buffer) => {
       if (!isResolved && typeof options?.startAfter !== 'number') {
@@ -187,7 +190,7 @@ export const startScript = async (
     throw new Error(
       `${format.bold('startScript')} currently doesn't works for Bun and Deno.${EOL}See: https://github.com/wellwelwel/poku/issues/143`
     );
-  /* c8 ignore end */
+  /* c8 ignore stop */
 
   return await backgroundProcess(runtime, runtimeArgs, script, {
     ...options,

src/modules/exit.ts

@@ -1,3 +1,5 @@
+/* c8 ignore start */
+
 import process from 'node:process';
 import { hr } from '../helpers/hr.js';
 import { Code } from '../@types/code.js';
@@ -38,3 +40,5 @@ process.on('uncaughtException', (err) => {
   console.log('uncaughtException', err);
   process.exit(1);
 });
+
+/* c8 ignore stop */

src/services/run-test-file.ts

@@ -2,23 +2,27 @@ import process from 'node:process';
 import path from 'node:path';
 import { EOL } from 'node:os';
 import { spawn } from 'node:child_process';
-import { runner } from '../helpers/runner.js';
+import { isWindows, runner } from '../helpers/runner.js';
 import { indentation } from '../helpers/indentation.js';
 import { format } from '../helpers/format.js';
 import { Configs } from '../@types/poku.js';
 import { isDebug, isQuiet } from '../helpers/logs.js';
 import { removeConsecutiveRepeats } from '../helpers/remove-repeats.js';
 import { beforeEach, afterEach } from './each.js';
 
+/* c8 ignore start */
 export type FileResults = {
   success: string[];
   fail: string[];
 };
+/* c8 ignore stop */
 
+/* c8 ignore start */
 export const fileResults: FileResults = {
   success: [],
   fail: [],
 };
+/* c8 ignore stop */
 
 export const runTestFile = (
   filePath: string,
@@ -98,7 +102,8 @@ export const runTestFile = (
     // Export spawn helper is not an option
     const child = spawn(runtime, runtimeArguments, {
       stdio: ['inherit', 'pipe', 'pipe'],
-      shell: false,
+      /* c8 ignore next */
+      shell: isWindows,
       env: {
         ...process.env,
         FILE: configs?.parallel ? fileRelative : '',

test/helpers/capture-cli.test.ts

@@ -1,6 +1,6 @@
 import process from 'node:process';
 import { spawn } from 'node:child_process';
-import { runner } from '../../src/helpers/runner.js';
+import { isWindows, runner } from '../../src/helpers/runner.js';
 
 // `/_.ts`: Simulate TypeScript file for Deno
 const currentFile = typeof __filename === 'string' ? __filename : '/_.ts';
@@ -16,7 +16,7 @@ export const executeCLI = (args: string[]): Promise<string> =>
     const runtimeArguments = [...runtimeOptions, ...args];
 
     const childProcess = spawn(runtime, runtimeArguments, {
-      shell: false,
+      shell: isWindows,
     });
 
     let output: string = '';

test/helpers/check-node.test.ts

@@ -1,5 +1,6 @@
 import { spawn } from 'node:child_process';
 import path from 'node:path';
+import { isWindows } from '../../src/helpers/runner.js';
 
 export const executeDockerCompose = (serviceName: string): Promise<number> => {
   const cwd = path.resolve('./test/docker');
@@ -25,6 +26,7 @@ export const executeDockerCompose = (serviceName: string): Promise<number> => {
           const logsProcess = spawn(command, ['logs', '-f', serviceName], {
             cwd,
             stdio: 'inherit',
+            shell: isWindows,
           });
 
           logsProcess.on('close', () => resolve(1));