@jsenv/test 1.8.1 → 2.0.0

package/dist/jsenv_test.js

@@ -1,3 +1,4 @@
+import os from "node:os";
 import { chmod, stat, lstat, readdir, promises, unlink, openSync, closeSync, rmdir, readFile as readFile$1, writeFile as writeFile$1, writeFileSync as writeFileSync$1, mkdirSync, readFileSync, readdirSync, existsSync } from "node:fs";
 import process$1, { memoryUsage } from "node:process";
 import v8, { takeCoverage } from "node:v8";
@@ -6,7 +7,6 @@ import { URL_META, filterV8Coverage } from "./js/v8_coverage.js";
 import { pathToFileURL, fileURLToPath } from "node:url";
 import crypto from "node:crypto";
 import { dirname } from "node:path";
-import os from "node:os";
 import tty from "node:tty";
 import stringWidth from "string-width";
 import { readGitHubWorkflowEnv, startGithubCheckRun } from "@jsenv/github-check-run";
@@ -4636,7 +4636,7 @@ const ensureGlobalGc = () => {
  * @param {Object} testPlanParameters.testPlan Object associating files with runtimes where they will be executed
  * @param {boolean} [testPlanParameters.logShortForCompletedExecutions=false] Abbreviate completed execution information to shorten terminal output
  * @param {boolean} [testPlanParameters.logMergeForCompletedExecutions=false] Merge completed execution logs to shorten terminal output
- * @param {number} [testPlanParameters.maxExecutionsInParallel=1] Maximum amount of execution in parallel
+ * @param {boolean|number} [testPlanParameters.concurrency=false] Maximum amount of execution running at the same time
  * @param {number} [testPlanParameters.defaultMsAllocatedPerExecution=30000] Milliseconds after which execution is aborted and considered as failed by timeout
  * @param {boolean} [testPlanParameters.failFast=false] Fails immediatly when a test execution fails
  * @param {number} [testPlanParameters.cooldownBetweenExecutions=0] Millisecond to wait between each execution
@@ -4663,7 +4663,7 @@ const executeTestPlan = async ({
   webServer,
   testPlan,
   updateProcessExitCode = true,
-  maxExecutionsInParallel = 1,
+  concurrency = false,
   defaultMsAllocatedPerExecution = 30_000,
   failFast = false,
   // keepRunning: false to ensure runtime is stopped once executed
@@ -4930,6 +4930,10 @@ To fix this warning:
         }
       }
     }
+
+    if (typeof concurrency !== "boolean" && typeof concurrency !== "number") {
+      throw new TypeError(`concurrency must be a boolean or a number`);
+    }
   }
 
   logger.debug(
@@ -4968,6 +4972,25 @@ To fix this warning:
         }
       }
     }
+    if (cooldownBetweenExecutions) {
+      if (cooldownBetweenExecutions < 0) {
+        cooldownBetweenExecutions = 0;
+      }
+      if (cooldownBetweenExecutions === Infinity) {
+        cooldownBetweenExecutions = 0;
+      }
+    }
+    if (concurrency === true) {
+      const availableCpus = os.cpus().length;
+      concurrency =
+        availableCpus > 2
+          ? // One CPU is used to run this code so we do availableCpus - 1
+            availableCpus - 1
+          : 1;
+    }
+    if (concurrency === false) {
+      concurrency = 1;
+    }
   }
 
   testPlan = {
@@ -5107,7 +5130,7 @@ To fix this warning:
     const executionLogsEnabled = logger.levels.info;
     const executionSpinner =
       logRefresh &&
-      maxExecutionsInParallel === 1 &&
+      concurrency === 1 &&
       !debugLogsEnabled &&
       executionLogsEnabled &&
       process.stdout.isTTY &&
@@ -5130,9 +5153,9 @@ To fix this warning:
 
     const callWhenPreviousExecutionAreDone = createCallOrderer();
 
-    await executeInParallel({
+    await executeConcurrently({
       multipleExecutionsOperation,
-      maxExecutionsInParallel,
+      concurrency,
       cooldownBetweenExecutions,
       executionSteps,
       start: async (paramsFromStep) => {
@@ -5405,57 +5428,50 @@ const canOverwriteLogGetter = ({
   return true;
 };
 
-const executeInParallel = async ({
+const executeConcurrently = async ({
   multipleExecutionsOperation,
-  maxExecutionsInParallel,
+  concurrency,
   cooldownBetweenExecutions,
   executionSteps,
   start,
 }) => {
-  const executionResults = [];
   let progressionIndex = 0;
-  let remainingExecutionCount = executionSteps.length;
+  let remainingExecutionToStart = executionSteps.length;
 
-  const nextChunk = async () => {
-    if (multipleExecutionsOperation.signal.aborted) {
+  const startNext = async () => {
+    if (remainingExecutionToStart === 0) {
       return;
     }
-    const outputPromiseArray = [];
-    let previousExecPromise = Promise.resolve();
-    while (
-      remainingExecutionCount > 0 &&
-      outputPromiseArray.length < maxExecutionsInParallel
-    ) {
-      remainingExecutionCount--;
-      const outputPromise = executeOne(progressionIndex, previousExecPromise);
-      previousExecPromise = outputPromise;
-      progressionIndex++;
-      outputPromiseArray.push(outputPromise);
-    }
-    if (outputPromiseArray.length) {
-      await Promise.all(outputPromiseArray);
-      if (remainingExecutionCount > 0) {
-        await nextChunk();
-      }
-    }
-  };
-
-  const executeOne = async (index, previousExecPromise) => {
-    const input = executionSteps[index];
-    const output = await start(input, previousExecPromise);
-    if (!multipleExecutionsOperation.signal.aborted) {
-      executionResults[index] = output;
+    remainingExecutionToStart--;
+    const input = executionSteps[progressionIndex];
+    progressionIndex++;
+    await start(input);
+    if (multipleExecutionsOperation.signal.aborted) {
+      return;
     }
     if (cooldownBetweenExecutions) {
-      await new Promise((resolve) =>
-        setTimeout(resolve, cooldownBetweenExecutions),
-      );
+      await new Promise((resolve) => {
+        const timeoutId = setTimeout(() => {
+          removeClearTimeoutOnAbort();
+          resolve();
+        }, cooldownBetweenExecutions);
+        const removeClearTimeoutOnAbort =
+          multipleExecutionsOperation.signal.addAbortCallback(() => {
+            clearTimeout(timeoutId);
+          });
+      });
+      if (multipleExecutionsOperation.signal.aborted) {
+        return;
+      }
     }
+    await startNext();
   };
 
-  await nextChunk();
-
-  return executionResults;
+  const promises = [];
+  while (concurrency--) {
+    promises.push(startNext());
+  }
+  await Promise.all(promises);
 };
 
 const memoize = (compute) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/test",
-  "version": "1.8.1",
+  "version": "2.0.0",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/execution/execute_test_plan.js

@@ -1,3 +1,4 @@
+import os from "node:os";
 import { existsSync } from "node:fs";
 import { memoryUsage } from "node:process";
 import { takeCoverage } from "node:v8";
@@ -48,7 +49,7 @@ import { ensureGlobalGc } from "./gc.js";
  * @param {Object} testPlanParameters.testPlan Object associating files with runtimes where they will be executed
  * @param {boolean} [testPlanParameters.logShortForCompletedExecutions=false] Abbreviate completed execution information to shorten terminal output
  * @param {boolean} [testPlanParameters.logMergeForCompletedExecutions=false] Merge completed execution logs to shorten terminal output
- * @param {number} [testPlanParameters.maxExecutionsInParallel=1] Maximum amount of execution in parallel
+ * @param {boolean|number} [testPlanParameters.concurrency=false] Maximum amount of execution running at the same time
  * @param {number} [testPlanParameters.defaultMsAllocatedPerExecution=30000] Milliseconds after which execution is aborted and considered as failed by timeout
  * @param {boolean} [testPlanParameters.failFast=false] Fails immediatly when a test execution fails
  * @param {number} [testPlanParameters.cooldownBetweenExecutions=0] Millisecond to wait between each execution
@@ -75,7 +76,7 @@ export const executeTestPlan = async ({
   webServer,
   testPlan,
   updateProcessExitCode = true,
-  maxExecutionsInParallel = 1,
+  concurrency = false,
   defaultMsAllocatedPerExecution = 30_000,
   failFast = false,
   // keepRunning: false to ensure runtime is stopped once executed
@@ -342,6 +343,10 @@ To fix this warning:
         }
       }
     }
+
+    if (typeof concurrency !== "boolean" && typeof concurrency !== "number") {
+      throw new TypeError(`concurrency must be a boolean or a number`);
+    }
   }
 
   logger.debug(
@@ -380,6 +385,25 @@ To fix this warning:
         }
       }
     }
+    if (cooldownBetweenExecutions) {
+      if (cooldownBetweenExecutions < 0) {
+        cooldownBetweenExecutions = 0;
+      }
+      if (cooldownBetweenExecutions === Infinity) {
+        cooldownBetweenExecutions = 0;
+      }
+    }
+    if (concurrency === true) {
+      const availableCpus = os.cpus().length;
+      concurrency =
+        availableCpus > 2
+          ? // One CPU is used to run this code so we do availableCpus - 1
+            availableCpus - 1
+          : 1;
+    }
+    if (concurrency === false) {
+      concurrency = 1;
+    }
   }
 
   testPlan = {
@@ -519,7 +543,7 @@ To fix this warning:
     const executionLogsEnabled = logger.levels.info;
     const executionSpinner =
       logRefresh &&
-      maxExecutionsInParallel === 1 &&
+      concurrency === 1 &&
       !debugLogsEnabled &&
       executionLogsEnabled &&
       process.stdout.isTTY &&
@@ -542,9 +566,9 @@ To fix this warning:
 
     const callWhenPreviousExecutionAreDone = createCallOrderer();
 
-    await executeInParallel({
+    await executeConcurrently({
       multipleExecutionsOperation,
-      maxExecutionsInParallel,
+      concurrency,
       cooldownBetweenExecutions,
       executionSteps,
       start: async (paramsFromStep) => {
@@ -817,55 +841,48 @@ const canOverwriteLogGetter = ({
   return true;
 };
 
-const executeInParallel = async ({
+const executeConcurrently = async ({
   multipleExecutionsOperation,
-  maxExecutionsInParallel,
+  concurrency,
   cooldownBetweenExecutions,
   executionSteps,
   start,
 }) => {
-  const executionResults = [];
   let progressionIndex = 0;
-  let remainingExecutionCount = executionSteps.length;
+  let remainingExecutionToStart = executionSteps.length;
 
-  const nextChunk = async () => {
-    if (multipleExecutionsOperation.signal.aborted) {
+  const startNext = async () => {
+    if (remainingExecutionToStart === 0) {
       return;
     }
-    const outputPromiseArray = [];
-    let previousExecPromise = Promise.resolve();
-    while (
-      remainingExecutionCount > 0 &&
-      outputPromiseArray.length < maxExecutionsInParallel
-    ) {
-      remainingExecutionCount--;
-      const outputPromise = executeOne(progressionIndex, previousExecPromise);
-      previousExecPromise = outputPromise;
-      progressionIndex++;
-      outputPromiseArray.push(outputPromise);
-    }
-    if (outputPromiseArray.length) {
-      await Promise.all(outputPromiseArray);
-      if (remainingExecutionCount > 0) {
-        await nextChunk();
-      }
-    }
-  };
-
-  const executeOne = async (index, previousExecPromise) => {
-    const input = executionSteps[index];
-    const output = await start(input, previousExecPromise);
-    if (!multipleExecutionsOperation.signal.aborted) {
-      executionResults[index] = output;
+    remainingExecutionToStart--;
+    const input = executionSteps[progressionIndex];
+    progressionIndex++;
+    await start(input);
+    if (multipleExecutionsOperation.signal.aborted) {
+      return;
     }
     if (cooldownBetweenExecutions) {
-      await new Promise((resolve) =>
-        setTimeout(resolve, cooldownBetweenExecutions),
-      );
+      await new Promise((resolve) => {
+        const timeoutId = setTimeout(() => {
+          removeClearTimeoutOnAbort();
+          resolve();
+        }, cooldownBetweenExecutions);
+        const removeClearTimeoutOnAbort =
+          multipleExecutionsOperation.signal.addAbortCallback(() => {
+            clearTimeout(timeoutId);
+          });
+      });
+      if (multipleExecutionsOperation.signal.aborted) {
+        return;
+      }
     }
+    await startNext();
   };
 
-  await nextChunk();
-
-  return executionResults;
+  const promises = [];
+  while (concurrency--) {
+    promises.push(startNext());
+  }
+  await Promise.all(promises);
 };