@jsenv/test 1.0.0

package/dist/controllable_child_process.mjs

@@ -0,0 +1,129 @@
+import { uneval, executeUsingDynamicImport } from "./js/execute_using_dynamic_import.js";
+import "node:fs";
+import "node:inspector";
+import "node:perf_hooks";
+
+const ACTIONS_AVAILABLE = {
+  "execute-using-dynamic-import": executeUsingDynamicImport,
+  "execute-using-require": async ({
+    fileUrl
+  }) => {
+    const {
+      createRequire
+    } = await import("node:module");
+    const {
+      fileURLToPath
+    } = await import("node: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({
+    jsenv: true,
+    type,
+    data
+  });
+};
+const onceParentMessage = (type, callback) => {
+  const listener = message => {
+    if (message && message.jsenv && message.type === type) {
+      removeListener(); // commenting this line keep this process alive
+      callback(message.data);
+    }
+  };
+  const removeListener = () => {
+    process.removeListener("message", listener);
+  };
+  process.on("message", listener);
+  return removeListener;
+};
+const removeActionRequestListener = onceParentMessage(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;
+  }
+
+  // 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");
+});

package/dist/controllable_worker_thread.mjs

@@ -0,0 +1,91 @@
+import { parentPort } from "node:worker_threads";
+import { uneval, executeUsingDynamicImport } from "./js/execute_using_dynamic_import.js";
+import "node:fs";
+import "node:inspector";
+import "node:perf_hooks";
+
+const ACTIONS_AVAILABLE = {
+  "execute-using-dynamic-import": executeUsingDynamicImport
+};
+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) => {
+  // 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.
+  parentPort.postMessage({
+    jsenv: true,
+    type,
+    data
+  });
+};
+const onceParentMessage = (type, callback) => {
+  const listener = message => {
+    if (message && message.jsenv && message.type === type) {
+      removeListener(); // commenting this line keep this worker alive
+      callback(message.data);
+    }
+  };
+  const removeListener = () => {
+    parentPort.removeListener("message", listener);
+  };
+  parentPort.on("message", listener);
+  return removeListener;
+};
+const removeActionRequestListener = onceParentMessage(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 (failed) {
+    sendActionFailed(value);
+  } else {
+    sendActionCompleted(value);
+  }
+  if (actionParams.exitAfterAction) {
+    removeActionRequestListener();
+  }
+});
+setTimeout(() => {
+  sendToParent("ready");
+});