@jsenv/core 27.1.0 → 27.2.2

package/src/test/execute_test_plan.js

@@ -28,7 +28,7 @@ import { executePlan } from "./execute_plan.js"
  * @param {boolean} [testPlanParameters.failFast=false] Fails immediatly when a test execution fails
  * @param {number} [testPlanParameters.cooldownBetweenExecutions=0] Millisecond to wait between each execution
  * @param {boolean} [testPlanParameters.logMemoryHeapUsage=false] Add memory heap usage during logs
- * @param {boolean} [testPlanParameters.coverage=false] Controls if coverage is collected during files executions
+ * @param {boolean} [testPlanParameters.coverageEnabled=false] Controls if coverage is collected during files executions
  * @param {boolean} [testPlanParameters.coverageV8ConflictWarning=true] Warn when coverage from 2 executions cannot be merged
  * @return {Object} An object containing the result of all file executions
  */
@@ -60,23 +60,24 @@ export const executeTestPlan = async ({
   cooldownBetweenExecutions = 0,
   gcBetweenExecutions = logMemoryHeapUsage,
 
-  coverage = process.argv.includes("--cover") ||
+  coverageEnabled = process.argv.includes("--cover") ||
     process.argv.includes("--coverage"),
-  coverageTempDirectoryRelativeUrl = "./.coverage/tmp/",
   coverageConfig = {
     "./src/": true,
   },
   coverageIncludeMissing = true,
   coverageAndExecutionAllowed = false,
-  coverageForceIstanbul = false,
+  coverageMethodForNodeJs = "NODE_V8_COVERAGE", // "Profiler" also accepted
+  coverageMethodForBrowsers = "playwright_api", // "istanbul" also accepted
   coverageV8ConflictWarning = true,
-  coverageReportTextLog = true,
-  coverageReportJsonFile = process.env.CI ? null : "./.coverage/coverage.json",
-  coverageReportHtmlDirectory = process.env.CI ? "./.coverage/" : null,
+  coverageTempDirectoryRelativeUrl = "./.coverage/tmp/",
   // skip empty means empty files won't appear in the coverage reports (json and html)
   coverageReportSkipEmpty = false,
   // skip full means file with 100% coverage won't appear in coverage reports (json and html)
   coverageReportSkipFull = false,
+  coverageReportTextLog = true,
+  coverageReportJsonFile = process.env.CI ? null : "./.coverage/coverage.json",
+  coverageReportHtmlDirectory = process.env.CI ? "./.coverage/" : null,
 
   sourcemaps = "inline",
   plugins = [],
@@ -95,7 +96,7 @@ export const executeTestPlan = async ({
   if (typeof testPlan !== "object") {
     throw new Error(`testPlan must be an object, got ${testPlan}`)
   }
-  if (coverage) {
+  if (coverageEnabled) {
     if (typeof coverageConfig !== "object") {
       throw new TypeError(
         `coverageConfig must be an object, got ${coverageConfig}`,
@@ -156,10 +157,11 @@ export const executeTestPlan = async ({
     cooldownBetweenExecutions,
     gcBetweenExecutions,
 
-    coverage,
+    coverageEnabled,
     coverageConfig,
     coverageIncludeMissing,
-    coverageForceIstanbul,
+    coverageMethodForBrowsers,
+    coverageMethodForNodeJs,
     coverageV8ConflictWarning,
     coverageTempDirectoryRelativeUrl,
 
@@ -189,7 +191,7 @@ export const executeTestPlan = async ({
     // keep this one first because it does ensureEmptyDirectory
     // and in case coverage json file gets written in the same directory
     // it must be done before
-    if (coverage && coverageReportHtmlDirectory) {
+    if (coverageEnabled && coverageReportHtmlDirectory) {
       const coverageHtmlDirectoryUrl = resolveDirectoryUrl(
         coverageReportHtmlDirectory,
         rootDirectoryUrl,
@@ -216,7 +218,7 @@ export const executeTestPlan = async ({
         }),
       )
     }
-    if (coverage && coverageReportJsonFile) {
+    if (coverageEnabled && coverageReportJsonFile) {
       const coverageJsonFileUrl = new URL(
         coverageReportJsonFile,
         rootDirectoryUrl,
@@ -229,7 +231,7 @@ export const executeTestPlan = async ({
         }),
       )
     }
-    if (coverage && coverageReportTextLog) {
+    if (coverageEnabled && coverageReportTextLog) {
       promises.push(
         generateCoverageTextLog(result.planCoverage, {
           coverageReportSkipEmpty,

package/dist/js/controllable_file.mjs

@@ -1,227 +0,0 @@
-import v8 from "node:v8";
-import { u as uneval } from "./uneval.js";
-import { performance, PerformanceObserver } from "node:perf_hooks";
-
-const startObservingPerformances = () => {
-  const measureEntries = []; // https://nodejs.org/dist/latest-v16.x/docs/api/perf_hooks.html
-
-  const perfObserver = new PerformanceObserver(( // https://nodejs.org/dist/latest-v16.x/docs/api/perf_hooks.html#perf_hooks_class_performanceobserverentrylist
-  list) => {
-    const perfMeasureEntries = list.getEntriesByType("measure");
-    measureEntries.push(...perfMeasureEntries);
-  });
-  perfObserver.observe({
-    entryTypes: ["measure"]
-  });
-  return async () => {
-    // wait for node to call the performance observer
-    await new Promise(resolve => {
-      setTimeout(resolve);
-    });
-    performance.clearMarks();
-    perfObserver.disconnect();
-    return { ...readNodePerformance(),
-      measures: measuresFromMeasureEntries(measureEntries)
-    };
-  };
-};
-
-const readNodePerformance = () => {
-  const nodePerformance = {
-    nodeTiming: asPlainObject(performance.nodeTiming),
-    timeOrigin: performance.timeOrigin,
-    eventLoopUtilization: performance.eventLoopUtilization()
-  };
-  return nodePerformance;
-}; // remove getters that cannot be stringified
-
-
-const asPlainObject = objectWithGetters => {
-  const objectWithoutGetters = {};
-  Object.keys(objectWithGetters).forEach(key => {
-    objectWithoutGetters[key] = objectWithGetters[key];
-  });
-  return objectWithoutGetters;
-};
-
-const measuresFromMeasureEntries = measureEntries => {
-  const measures = {}; // Sort to ensure measures order is predictable
-  // It seems to be already predictable on Node 16+ but
-  // it's not the case on Node 14.
-
-  measureEntries.sort((a, b) => {
-    return a.startTime - b.startTime;
-  });
-  measureEntries.forEach(( // https://nodejs.org/dist/latest-v16.x/docs/api/perf_hooks.html#perf_hooks_class_performanceentry
-  perfMeasureEntry) => {
-    measures[perfMeasureEntry.name] = perfMeasureEntry.duration;
-  });
-  return measures;
-};
-
-const ACTIONS_AVAILABLE = {
-  "execute-using-dynamic-import": async ({
-    fileUrl,
-    collectPerformance
-  }) => {
-    const getNamespace = async () => {
-      const namespace = await import(fileUrl);
-      const namespaceResolved = {};
-      await Promise.all([...Object.keys(namespace).map(async key => {
-        const value = await namespace[key];
-        namespaceResolved[key] = value;
-      })]);
-      return namespaceResolved;
-    };
-
-    if (collectPerformance) {
-      const getPerformance = startObservingPerformances();
-      const namespace = await getNamespace();
-      const performance = await getPerformance();
-      return {
-        namespace,
-        performance
-      };
-    }
-
-    const namespace = await getNamespace();
-    return {
-      namespace
-    };
-  },
-  "execute-using-require": async ({
-    fileUrl
-  }) => {
-    const {
-      createRequire
-    } = await import("module");
-    const {
-      fileURLToPath
-    } = await import("url");
-    const filePath = fileURLToPath(fileUrl);
-
-    const require = createRequire(fileUrl); // eslint-disable-next-line import/no-dynamic-require
-
-
-    const namespace = require(filePath);
-
-    const namespaceResolved = {};
-    await Promise.all([...Object.keys(namespace).map(async key => {
-      const value = await namespace[key];
-      namespaceResolved[key] = value;
-    })]);
-    return namespaceResolved;
-  }
-};
-const ACTION_REQUEST_EVENT_NAME = "action";
-const ACTION_RESPONSE_EVENT_NAME = "action-result";
-const ACTION_RESPONSE_STATUS_FAILED = "action-failed";
-const ACTION_RESPONSE_STATUS_COMPLETED = "action-completed";
-
-const sendActionFailed = error => {
-  if (error.hasOwnProperty("toString")) {
-    delete error.toString;
-  }
-
-  sendToParent(ACTION_RESPONSE_EVENT_NAME, // process.send algorithm does not send non enumerable values
-  // so use @jsenv/uneval
-  uneval({
-    status: ACTION_RESPONSE_STATUS_FAILED,
-    value: error
-  }, {
-    ignoreSymbols: true
-  }));
-};
-
-const sendActionCompleted = value => {
-  sendToParent(ACTION_RESPONSE_EVENT_NAME, // here we use JSON.stringify because we should not
-  // have non enumerable value (unlike there is on Error objects)
-  // otherwise uneval is quite slow to turn a giant object
-  // into a string (and value can be giant when using coverage)
-  JSON.stringify({
-    status: ACTION_RESPONSE_STATUS_COMPLETED,
-    value
-  }));
-};
-
-const sendToParent = (type, data) => {
-  // https://nodejs.org/api/process.html#process_process_connected
-  // not connected anymore, cannot communicate with parent
-  if (!process.connected) {
-    return;
-  } // this can keep process alive longer than expected
-  // when source is a long string.
-  // It means node process may stay alive longer than expected
-  // the time to send the data to the parent.
-
-
-  process.send({
-    type,
-    data
-  });
-};
-
-const onceProcessMessage = (type, callback) => {
-  const listener = event => {
-    if (event.type === type) {
-      // commenting line below keep this process alive
-      removeListener(); // eslint-disable-next-line no-eval
-
-      callback(eval(`(${event.data})`));
-    }
-  };
-
-  const removeListener = () => {
-    process.removeListener("message", listener);
-  };
-
-  process.on("message", listener);
-  return removeListener;
-};
-
-const removeActionRequestListener = onceProcessMessage(ACTION_REQUEST_EVENT_NAME, async ({
-  actionType,
-  actionParams
-}) => {
-  const action = ACTIONS_AVAILABLE[actionType];
-
-  if (!action) {
-    sendActionFailed(new Error(`unknown action ${actionType}`));
-    return;
-  }
-
-  let value;
-  let failed = false;
-
-  try {
-    value = await action(actionParams);
-  } catch (e) {
-    failed = true;
-    value = e;
-  }
-
-  if (process.env.NODE_V8_COVERAGE) {
-    v8.takeCoverage(); // if (actionParams.stopCoverageAfterExecution) {
-    //   v8.stopCoverage()
-    // }
-  } // setTimeout(() => {}, 100)
-
-
-  if (failed) {
-    sendActionFailed(value);
-  } else {
-    sendActionCompleted(value);
-  } // removeActionRequestListener()
-
-
-  if (actionParams.exitAfterAction) {
-    removeActionRequestListener(); // for some reason this fixes v8 coverage directory sometimes empty on Ubuntu
-    // process.exit()
-  }
-}); // remove listener to process.on('message')
-// which is sufficient to let child process die
-// assuming nothing else keeps it alive
-// process.once("SIGTERM", removeActionRequestListener)
-// process.once("SIGINT", removeActionRequestListener)
-
-setTimeout(() => sendToParent("ready"));