@jsenv/core 34.2.2 → 35.0.0

package/src/execute/runtimes/node/kill_process_tree.js

@@ -1,76 +0,0 @@
-import { requireFromJsenv } from "@jsenv/core/src/require_from_jsenv.js"
-
-// see also https://github.com/sindresorhus/execa/issues/96
-export const killProcessTree = async (
-  processId,
-  { signal, timeout = 2000 },
-) => {
-  const pidtree = requireFromJsenv("pidtree")
-
-  let descendantProcessIds
-  try {
-    descendantProcessIds = await pidtree(processId)
-  } catch (e) {
-    if (e.message === "No matching pid found") {
-      descendantProcessIds = []
-    } else {
-      throw e
-    }
-  }
-  descendantProcessIds.forEach((descendantProcessId) => {
-    try {
-      process.kill(descendantProcessId, signal)
-    } catch (error) {
-      // ignore
-    }
-  })
-
-  try {
-    process.kill(processId, signal)
-  } catch (e) {
-    if (e.code !== "ESRCH") {
-      throw e
-    }
-  }
-
-  let remainingIds = [...descendantProcessIds, processId]
-
-  const updateRemainingIds = () => {
-    remainingIds = remainingIds.filter((remainingId) => {
-      try {
-        process.kill(remainingId, 0)
-        return true
-      } catch (e) {
-        return false
-      }
-    })
-  }
-
-  let timeSpentWaiting = 0
-
-  const check = async () => {
-    updateRemainingIds()
-    if (remainingIds.length === 0) {
-      return
-    }
-
-    if (timeSpentWaiting > timeout) {
-      const timeoutError = new Error(
-        `timed out waiting for ${
-          remainingIds.length
-        } process to exit (${remainingIds.join(" ")})`,
-      )
-      timeoutError.code = "TIMEOUT"
-      throw timeoutError
-    }
-
-    await new Promise((resolve) => setTimeout(resolve, 400))
-    timeSpentWaiting += 400
-    await check()
-  }
-
-  await new Promise((resolve) => {
-    setTimeout(resolve, 0)
-  })
-  await check()
-}

package/src/execute/runtimes/node/node_child_process.js

@@ -1,348 +0,0 @@
-import { fork } from "node:child_process"
-import { fileURLToPath } from "node:url"
-import {
-  Abort,
-  raceCallbacks,
-  createCallbackListNotifiedOnce,
-} from "@jsenv/abort"
-import { createDetailedMessage } from "@jsenv/log"
-import { memoize } from "@jsenv/utils/src/memoize/memoize.js"
-
-import { createChildExecOptions } from "./child_exec_options.js"
-import { ExecOptions } from "./exec_options.js"
-import { killProcessTree } from "./kill_process_tree.js"
-import { EXIT_CODES } from "./exit_codes.js"
-
-const CONTROLLABLE_CHILD_PROCESS_URL = new URL(
-  "./controllable_child_process.mjs?entry_point",
-  import.meta.url,
-).href
-
-export const nodeChildProcess = {
-  type: "node",
-  name: "node_child_process",
-  version: process.version.slice(1),
-}
-
-nodeChildProcess.run = async ({
-  signal = new AbortController().signal,
-  logger,
-  logProcessCommand = false,
-  rootDirectoryUrl,
-  fileRelativeUrl,
-
-  keepRunning,
-  gracefulStopAllocatedMs = 4000,
-  stopSignal,
-  onConsole,
-
-  coverageEnabled = false,
-  coverageConfig,
-  coverageMethodForNodeJs,
-  coverageFileUrl,
-  collectPerformance,
-
-  env,
-  debugPort,
-  debugMode,
-  debugModeInheritBreak,
-  inheritProcessEnv = true,
-  commandLineOptions = [],
-  stdin = "pipe",
-  stdout = "pipe",
-  stderr = "pipe",
-}) => {
-  if (env !== undefined && typeof env !== "object") {
-    throw new TypeError(`env must be an object, got ${env}`)
-  }
-  env = {
-    ...env,
-    JSENV: true,
-  }
-  if (coverageMethodForNodeJs !== "NODE_V8_COVERAGE") {
-    env.NODE_V8_COVERAGE = ""
-  }
-  commandLineOptions = [
-    "--experimental-import-meta-resolve",
-    ...commandLineOptions,
-  ]
-
-  const cleanupCallbackList = createCallbackListNotifiedOnce()
-  const cleanup = async (reason) => {
-    await cleanupCallbackList.notify({ reason })
-  }
-
-  const childExecOptions = await createChildExecOptions({
-    signal,
-    debugPort,
-    debugMode,
-    debugModeInheritBreak,
-  })
-  const execArgv = ExecOptions.toExecArgv({
-    ...childExecOptions,
-    ...ExecOptions.fromExecArgv(commandLineOptions),
-  })
-  const envForChildProcess = {
-    ...(inheritProcessEnv ? process.env : {}),
-    ...env,
-  }
-  logger[logProcessCommand ? "info" : "debug"](
-    `${process.argv[0]} ${execArgv.join(" ")} ${fileURLToPath(
-      CONTROLLABLE_CHILD_PROCESS_URL,
-    )}`,
-  )
-  const childProcess = fork(fileURLToPath(CONTROLLABLE_CHILD_PROCESS_URL), {
-    execArgv,
-    // silent: true
-    stdio: ["pipe", "pipe", "pipe", "ipc"],
-    env: envForChildProcess,
-  })
-  logger.debug(
-    createDetailedMessage(`child process forked (pid ${childProcess.pid})`, {
-      "custom env": JSON.stringify(env, null, "  "),
-    }),
-  )
-  // if we pass stream, pipe them https://github.com/sindresorhus/execa/issues/81
-  if (typeof stdin === "object") {
-    stdin.pipe(childProcess.stdin)
-  }
-  if (typeof stdout === "object") {
-    childProcess.stdout.pipe(stdout)
-  }
-  if (typeof stderr === "object") {
-    childProcess.stderr.pipe(stderr)
-  }
-  const childProcessReadyPromise = new Promise((resolve) => {
-    onceChildProcessMessage(childProcess, "ready", resolve)
-  })
-  const removeOutputListener = installChildProcessOutputListener(
-    childProcess,
-    ({ type, text }) => {
-      onConsole({ type, text })
-    },
-  )
-  const stop = memoize(async ({ gracefulStopAllocatedMs } = {}) => {
-    // all libraries are facing problem on windows when trying
-    // to kill a process spawning other processes.
-    // "killProcessTree" is theorically correct but sometimes keep process handing forever.
-    // Inside GitHub workflow the whole Virtual machine gets unresponsive and ends up being killed
-    // There is no satisfying solution to this problem so we stick to the basic
-    // childProcess.kill()
-    if (process.platform === "win32") {
-      childProcess.kill()
-      return
-    }
-    if (gracefulStopAllocatedMs) {
-      try {
-        await killProcessTree(childProcess.pid, {
-          signal: GRACEFUL_STOP_SIGNAL,
-          timeout: gracefulStopAllocatedMs,
-        })
-        return
-      } catch (e) {
-        if (e.code === "TIMEOUT") {
-          logger.debug(
-            `kill with SIGTERM because gracefulStop still pending after ${gracefulStopAllocatedMs}ms`,
-          )
-          await killProcessTree(childProcess.pid, {
-            signal: GRACEFUL_STOP_FAILED_SIGNAL,
-          })
-          return
-        }
-        throw e
-      }
-    }
-    await killProcessTree(childProcess.pid, { signal: STOP_SIGNAL })
-    return
-  })
-
-  const actionOperation = Abort.startOperation()
-  actionOperation.addAbortSignal(signal)
-  const winnerPromise = new Promise((resolve) => {
-    raceCallbacks(
-      {
-        aborted: (cb) => {
-          return actionOperation.addAbortCallback(cb)
-        },
-        // https://nodejs.org/api/child_process.html#child_process_event_disconnect
-        // disconnect: (cb) => {
-        //   return onceProcessEvent(childProcess, "disconnect", cb)
-        // },
-        // https://nodejs.org/api/child_process.html#child_process_event_error
-        error: (cb) => {
-          return onceChildProcessEvent(childProcess, "error", cb)
-        },
-        exit: (cb) => {
-          return onceChildProcessEvent(childProcess, "exit", (code, signal) => {
-            cb({ code, signal })
-          })
-        },
-        response: (cb) => {
-          return onceChildProcessMessage(childProcess, "action-result", cb)
-        },
-      },
-      resolve,
-    )
-  })
-  const result = {
-    status: "executing",
-    errors: [],
-    namespace: null,
-  }
-
-  const writeResult = async () => {
-    actionOperation.throwIfAborted()
-    await childProcessReadyPromise
-    actionOperation.throwIfAborted()
-    await sendToChildProcess(childProcess, {
-      type: "action",
-      data: {
-        actionType: "execute-using-dynamic-import",
-        actionParams: {
-          rootDirectoryUrl,
-          fileUrl: new URL(fileRelativeUrl, rootDirectoryUrl).href,
-          collectPerformance,
-          coverageEnabled,
-          coverageConfig,
-          coverageMethodForNodeJs,
-          coverageFileUrl,
-          exitAfterAction: true,
-        },
-      },
-    })
-    const winner = await winnerPromise
-    if (winner.name === "aborted") {
-      result.status = "aborted"
-      return
-    }
-    if (winner.name === "error") {
-      const error = winner.data
-      removeOutputListener()
-      result.status = "failed"
-      result.errors.push(error)
-      return
-    }
-    if (winner.name === "exit") {
-      const { code } = winner.data
-      await cleanup("process exit")
-      if (code === 12) {
-        result.status = "failed"
-        result.errors.push(
-          new Error(
-            `node process exited with 12 (the forked child process wanted to use a non-available port for debug)`,
-          ),
-        )
-        return
-      }
-      if (
-        code === null ||
-        code === 0 ||
-        code === EXIT_CODES.SIGINT ||
-        code === EXIT_CODES.SIGTERM ||
-        code === EXIT_CODES.SIGABORT
-      ) {
-        result.status = "failed"
-        result.errors.push(new Error(`node process exited during execution`))
-        return
-      }
-      // process.exit(1) in child process or process.exitCode = 1 + process.exit()
-      // means there was an error even if we don't know exactly what.
-      result.status = "failed"
-      result.errors.push(
-        new Error(`node process exited with code ${code} during execution`),
-      )
-      return
-    }
-    const { status, value } = winner.data
-    if (status === "action-failed") {
-      result.status = "failed"
-      result.errors.push(value)
-      return
-    }
-    const { namespace, performance, coverage } = value
-    result.status = "completed"
-    result.namespace = namespace
-    result.performance = performance
-    result.coverage = coverage
-  }
-
-  try {
-    await writeResult()
-  } catch (e) {
-    result.status = "failed"
-    result.errors.push(e)
-  }
-  if (keepRunning) {
-    stopSignal.notify = stop
-  } else {
-    await stop({
-      gracefulStopAllocatedMs,
-    })
-  }
-  await actionOperation.end()
-  return result
-}
-
-// http://man7.org/linux/man-pages/man7/signal.7.html
-// https:// github.com/nodejs/node/blob/1d9511127c419ec116b3ddf5fc7a59e8f0f1c1e4/lib/internal/child_process.js#L472
-const GRACEFUL_STOP_SIGNAL = "SIGTERM"
-const STOP_SIGNAL = "SIGKILL"
-// it would be more correct if GRACEFUL_STOP_FAILED_SIGNAL was SIGHUP instead of SIGKILL.
-// but I'm not sure and it changes nothing so just use SIGKILL
-const GRACEFUL_STOP_FAILED_SIGNAL = "SIGKILL"
-
-const sendToChildProcess = async (childProcess, { type, data }) => {
-  return new Promise((resolve, reject) => {
-    childProcess.send(
-      {
-        jsenv: true,
-        type,
-        data,
-      },
-      (error) => {
-        if (error) {
-          reject(error)
-        } else {
-          resolve()
-        }
-      },
-    )
-  })
-}
-
-const installChildProcessOutputListener = (childProcess, callback) => {
-  // beware that we may receive ansi output here, should not be a problem but keep that in mind
-  const stdoutDataCallback = (chunk) => {
-    callback({ type: "log", text: String(chunk) })
-  }
-  childProcess.stdout.on("data", stdoutDataCallback)
-  const stdErrorDataCallback = (chunk) => {
-    callback({ type: "error", text: String(chunk) })
-  }
-  childProcess.stderr.on("data", stdErrorDataCallback)
-  return () => {
-    childProcess.stdout.removeListener("data", stdoutDataCallback)
-    childProcess.stderr.removeListener("data", stdoutDataCallback)
-  }
-}
-
-const onceChildProcessMessage = (childProcess, type, callback) => {
-  const onmessage = (message) => {
-    if (message && message.jsenv && message.type === type) {
-      childProcess.removeListener("message", onmessage)
-      // eslint-disable-next-line no-eval
-      callback(message.data ? eval(`(${message.data})`) : "")
-    }
-  }
-  childProcess.on("message", onmessage)
-  return () => {
-    childProcess.removeListener("message", onmessage)
-  }
-}
-
-const onceChildProcessEvent = (childProcess, type, callback) => {
-  childProcess.once(type, callback)
-  return () => {
-    childProcess.removeListener(type, callback)
-  }
-}

package/src/execute/runtimes/node/node_execution_performance.js

@@ -1,67 +0,0 @@
-import { PerformanceObserver, performance } from "node:perf_hooks"
-
-export 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
-}