@jsenv/core 27.8.1 → 28.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/core",
-  "version": "27.8.1",
+  "version": "28.0.0",
   "description": "Tool to develop, test and build js projects",
   "license": "MIT",
   "author": {
@@ -73,7 +73,7 @@
     "@jsenv/integrity": "0.0.1",
     "@jsenv/log": "3.1.0",
     "@jsenv/node-esm-resolution": "0.1.0",
-    "@jsenv/server": "13.1.0",
+    "@jsenv/server": "14.0.0",
     "@jsenv/sourcemap": "1.0.4",
     "@jsenv/uneval": "1.6.0",
     "@jsenv/url-meta": "7.0.0",

package/src/build/start_build_server.js

@@ -41,7 +41,7 @@ export const startBuildServer = async ({
   certificate,
   privateKey,
   acceptAnyIp,
-  host,
+  hostname,
   port = 9779,
   services = [],
   keepProcessAlive = true,
@@ -163,7 +163,7 @@ export const startBuildServer = async ({
     certificate,
     privateKey,
     acceptAnyIp,
-    host,
+    hostname,
     port,
     serverTiming: true,
     requestWaitingMs: 60_000,

package/src/dev/start_dev_server.js

@@ -22,7 +22,7 @@ export const startDevServer = async ({
   http2 = false,
   certificate,
   privateKey,
-  host,
+  hostname,
   port = 3456,
   acceptAnyIp,
   keepProcessAlive = true,
@@ -150,7 +150,7 @@ export const startDevServer = async ({
     http2,
     certificate,
     privateKey,
-    host,
+    hostname,
     port,
     services,
 

package/src/execute/execute.js

@@ -1,9 +1,8 @@
 import { Abort, raceProcessTeardownEvents } from "@jsenv/abort"
-
 import { assertAndNormalizeDirectoryUrl } from "@jsenv/filesystem"
 import { createLogger } from "@jsenv/log"
 
-import { startOmegaServer } from "@jsenv/core/src/omega/omega_server.js"
+import { pingServer } from "../ping_server.js"
 import { run } from "./run.js"
 
 export const execute = async ({
@@ -11,12 +10,13 @@ export const execute = async ({
   handleSIGINT = true,
   logLevel,
   rootDirectoryUrl,
+  devServerOrigin,
 
   fileRelativeUrl,
   allocatedMs,
   mirrorConsole = true,
   keepRunning = false,
-  services,
+
   collectConsole,
   collectCoverage,
   coverageTempDirectoryUrl,
@@ -24,21 +24,6 @@ export const execute = async ({
   runtime,
   runtimeParams,
 
-  scenarios = { dev: true },
-  plugins = [],
-  nodeEsmResolution,
-  fileSystemMagicResolution,
-  transpilation,
-  htmlSupervisor = true,
-  sourcemaps = "inline",
-  writeGeneratedFiles = false,
-
-  port,
-  protocol,
-  http2,
-  certificate,
-  privateKey,
-
   ignoreError = false,
 }) => {
   const logger = createLogger({ logLevel })
@@ -59,44 +44,21 @@ export const execute = async ({
   let resultTransformer = (result) => result
   runtimeParams = {
     rootDirectoryUrl,
+    devServerOrigin,
     fileRelativeUrl,
     ...runtimeParams,
   }
-  if (runtime.needsServer) {
-    const server = await startOmegaServer({
-      signal: executeOperation.signal,
-      logLevel: "warn",
-      keepProcessAlive: false,
-      services,
-      port,
-      protocol,
-      http2,
-      certificate,
-      privateKey,
-
-      rootDirectoryUrl,
-      scenarios,
-      runtimeCompat: { [runtime.name]: runtime.version },
-
-      plugins,
-
-      htmlSupervisor,
-      nodeEsmResolution,
-      fileSystemMagicResolution,
-      transpilation,
-      sourcemaps,
-      writeGeneratedFiles,
-    })
-    executeOperation.addEndCallback(async () => {
-      await server.stop("execution done")
-    })
-    runtimeParams = {
-      ...runtimeParams,
-      server,
+  if (runtime.type === "browser") {
+    if (!devServerOrigin) {
+      throw new TypeError(
+        `devServerOrigin is required when running tests on browser(s)`,
+      )
     }
-    resultTransformer = (result) => {
-      result.server = server
-      return result
+    const devServerStarted = await pingServer(devServerOrigin)
+    if (!devServerStarted) {
+      throw new Error(
+        `dev server not started at ${devServerOrigin}. It is required to run tests`,
+      )
     }
   }
 

package/src/execute/runtimes/browsers/from_playwright.js

@@ -27,7 +27,6 @@ export const createRuntimeFromPlaywright = ({
     type: "browser",
     name: browserName,
     version: browserVersion,
-    needsServer: true,
   }
   let browserAndContextPromise
   runtime.run = async ({
@@ -35,7 +34,7 @@ export const createRuntimeFromPlaywright = ({
     logger,
     rootDirectoryUrl,
     fileRelativeUrl,
-    server,
+    devServerOrigin,
 
     // measurePerformance,
     collectPerformance,
@@ -98,7 +97,19 @@ export const createRuntimeFromPlaywright = ({
       }
       await disconnected
     }
-    const page = await browserContext.newPage()
+    const coverageInHeaders =
+      coverageEnabled &&
+      (!coveragePlaywrightAPIAvailable ||
+        coverageMethodForBrowsers !== "playwright_api")
+    const page = await browserContext.newPage({
+      extraHTTPHeaders: {
+        ...(coverageInHeaders
+          ? {
+              "x-coverage-istanbul": JSON.stringify(coverageConfig),
+            }
+          : {}),
+      },
+    })
     const closePage = async () => {
       try {
         await page.close()
@@ -128,7 +139,7 @@ export const createRuntimeFromPlaywright = ({
             (v8CoveragesWithWebUrl) => {
               const fsUrl = moveUrl({
                 url: v8CoveragesWithWebUrl.url,
-                from: `${server.origin}/`,
+                from: `${devServerOrigin}/`,
                 to: rootDirectoryUrl,
                 preferAbsolute: true,
               })
@@ -202,7 +213,7 @@ export const createRuntimeFromPlaywright = ({
       })
     }
 
-    const fileClientUrl = new URL(fileRelativeUrl, `${server.origin}/`).href
+    const fileClientUrl = new URL(fileRelativeUrl, `${devServerOrigin}/`).href
 
     // https://github.com/GoogleChrome/puppeteer/blob/v1.4.0/docs/api.md#event-console
     const removeConsoleListener = registerEvent({
@@ -302,7 +313,7 @@ export const createRuntimeFromPlaywright = ({
                 const { exceptionSource } = returnValue
                 const error = evalException(exceptionSource, {
                   rootDirectoryUrl,
-                  server,
+                  devServerOrigin,
                   transformErrorHook,
                 })
                 cb({
@@ -525,13 +536,13 @@ const registerEvent = ({ object, eventType, callback }) => {
 
 const evalException = (
   exceptionSource,
-  { rootDirectoryUrl, server, transformErrorHook },
+  { rootDirectoryUrl, devServerOrigin, transformErrorHook },
 ) => {
   const script = new Script(exceptionSource, { filename: "" })
   const error = script.runInThisContext()
   if (error && error instanceof Error) {
     const remoteRootRegexp = new RegExp(
-      escapeRegexpSpecialChars(`${server.origin}/`),
+      escapeRegexpSpecialChars(`${devServerOrigin}/`),
       "g",
     )
     error.stack = error.stack.replace(remoteRootRegexp, rootDirectoryUrl)

package/src/main.js

@@ -21,6 +21,9 @@ export { nodeWorkerThread } from "./execute/runtimes/node/node_worker_thread.js"
 export { build } from "./build/build.js"
 export { startBuildServer } from "./build/start_build_server.js"
 
+// helpers
+export { pingServer } from "./ping_server.js"
+
 // advanced
 export { execute } from "./execute/execute.js"
 export { jsenvPluginInjectGlobals } from "./plugins/inject_globals/jsenv_plugin_inject_globals.js"

package/src/omega/omega_server.js

@@ -18,7 +18,7 @@ export const startOmegaServer = async ({
   privateKey,
   certificate,
   acceptAnyIp,
-  host,
+  hostname,
   port = 0,
   keepProcessAlive = false,
   onStop = () => {},
@@ -62,7 +62,7 @@ export const startOmegaServer = async ({
     certificate,
     privateKey,
     acceptAnyIp,
-    host,
+    hostname,
     port,
     requestWaitingMs: 60_1000,
     services: [

package/src/ping_server.js

@@ -0,0 +1,30 @@
+import { createServer } from "node:net"
+
+export const pingServer = async (url) => {
+  const server = createServer()
+  const { hostname, port } = new URL(url)
+
+  try {
+    await new Promise((resolve, reject) => {
+      server.on("error", reject)
+      server.on("listening", () => {
+        resolve()
+      })
+      server.listen(port, hostname)
+    })
+  } catch (error) {
+    if (error && error.code === "EADDRINUSE") {
+      return true
+    }
+    if (error && error.code === "EACCES") {
+      return true
+    }
+    throw error
+  }
+  await new Promise((resolve, reject) => {
+    server.on("error", reject)
+    server.on("close", resolve)
+    server.close()
+  })
+  return false
+}

package/src/plugins/import_meta_scenarios/jsenv_plugin_import_meta_scenarios.js

@@ -28,7 +28,7 @@ export const jsenvPluginImportMetaScenarios = () => {
           babelPlugins: [babelPluginMetadataImportMetaScenarios],
           urlInfo,
         })
-        const { dev = [], test = [], build = [] } = metadata.importMetaScenarios
+        const { dev = [], build = [] } = metadata.importMetaScenarios
         const replacements = []
         const replace = (path, value) => {
           replacements.push({ path, value })
@@ -38,9 +38,6 @@ export const jsenvPluginImportMetaScenarios = () => {
           dev.forEach((path) => {
             replace(path, "undefined")
           })
-          test.forEach((path) => {
-            replace(path, context.scenarios.test ? "true" : "undefined")
-          })
           build.forEach((path) => {
             replace(path, "true")
           })
@@ -52,11 +49,6 @@ export const jsenvPluginImportMetaScenarios = () => {
           dev.forEach((path) => {
             replace(path, "true")
           })
-          if (context.scenarios.test) {
-            test.forEach((path) => {
-              replace(path, "true")
-            })
-          }
         }
         const magicSource = createMagicSource(urlInfo.content)
         replacements.forEach(({ path, value }) => {

package/src/plugins/transpilation/babel/jsenv_plugin_babel.js

@@ -1,5 +1,6 @@
 import { applyBabelPlugins } from "@jsenv/ast"
 
+import { babelPluginInstrument } from "@jsenv/core/src/test/coverage/babel_plugin_instrument.js"
 import { RUNTIME_COMPAT } from "@jsenv/core/src/omega/compat/runtime_compat.js"
 import { getBaseBabelPluginStructure } from "./helpers/babel_plugin_structure.js"
 import { babelPluginBabelHelpersAsJsenvImports } from "./helpers/babel_plugin_babel_helpers_as_jsenv_imports.js"
@@ -54,6 +55,18 @@ export const jsenvPluginBabel = ({
       isJsModule,
       getImportSpecifier,
     })
+    if (context.scenarios.dev) {
+      const requestHeaders = context.request.headers
+      if (requestHeaders["x-coverage-instanbul"]) {
+        babelPluginStructure["transform-instrument"] = [
+          babelPluginInstrument,
+          {
+            rootDirectoryUrl: context.rootDirectoryUrl,
+            coverageConfig: JSON.parse(requestHeaders["x-coverage-instanbul"]),
+          },
+        ]
+      }
+    }
     if (getCustomBabelPlugins) {
       Object.assign(babelPluginStructure, getCustomBabelPlugins(context))
     }

package/src/test/execute_plan.js

@@ -14,11 +14,10 @@ import {
 import { Abort, raceProcessTeardownEvents } from "@jsenv/abort"
 import { ensureEmptyDirectory, writeFileSync } from "@jsenv/filesystem"
 
-import { babelPluginInstrument } from "./coverage/babel_plugin_instrument.js"
 import { reportToCoverage } from "./coverage/report_to_coverage.js"
-import { startOmegaServer } from "@jsenv/core/src/omega/omega_server.js"
 import { run } from "@jsenv/core/src/execute/run.js"
 
+import { pingServer } from "../ping_server.js"
 import { ensureGlobalGc } from "./gc.js"
 import { generateExecutionSteps } from "./execution_steps.js"
 import { createExecutionLog, createSummaryLog } from "./logs_file_execution.js"
@@ -37,10 +36,10 @@ export const executePlan = async (
     logFileRelativeUrl,
     completedExecutionLogMerging,
     completedExecutionLogAbbreviation,
-
     rootDirectoryUrl,
+    devServerOrigin,
+
     keepRunning,
-    services,
     defaultMsAllocatedPerExecution,
     maxExecutionsInParallel,
     failFast,
@@ -55,20 +54,6 @@ export const executePlan = async (
     coverageV8ConflictWarning,
     coverageTempDirectoryRelativeUrl,
 
-    scenarios,
-    sourcemaps,
-    plugins,
-    nodeEsmResolution,
-    fileSystemMagicResolution,
-    transpilation,
-    writeGeneratedFiles,
-
-    protocol,
-    privateKey,
-    certificate,
-    host,
-    port,
-
     beforeExecutionCallback = () => {},
     afterExecutionCallback = () => {},
   } = {},
@@ -88,7 +73,7 @@ export const executePlan = async (
       const { runtime } = executionConfig
       if (runtime) {
         runtimes[runtime.name] = runtime.version
-        if (runtime.needsServer) {
+        if (runtime.type === "browser") {
           someNeedsServer = true
         }
         if (runtime.type === "node") {
@@ -189,6 +174,7 @@ export const executePlan = async (
 
     let runtimeParams = {
       rootDirectoryUrl,
+      devServerOrigin,
       coverageEnabled,
       coverageConfig,
       coverageMethodForBrowsers,
@@ -196,55 +182,16 @@ export const executePlan = async (
       stopAfterAllSignal,
     }
     if (someNeedsServer) {
-      const server = await startOmegaServer({
-        signal: multipleExecutionsOperation.signal,
-        logLevel: "warn",
-        keepProcessAlive: false,
-        port,
-        host,
-        protocol,
-        certificate,
-        privateKey,
-        services,
-
-        rootDirectoryUrl,
-        scenarios,
-        runtimeCompat: runtimes,
-
-        plugins,
-        htmlSupervisor: true,
-        nodeEsmResolution,
-        fileSystemMagicResolution,
-        transpilation: {
-          ...transpilation,
-          getCustomBabelPlugins: ({ clientRuntimeCompat }) => {
-            if (
-              coverageEnabled &&
-              (coverageMethodForBrowsers !== "playwright_api" ||
-                Object.keys(clientRuntimeCompat)[0] !== "chrome")
-            ) {
-              return {
-                "transform-instrument": [
-                  babelPluginInstrument,
-                  {
-                    rootDirectoryUrl,
-                    coverageConfig,
-                  },
-                ],
-              }
-            }
-            return {}
-          },
-        },
-        sourcemaps,
-        writeGeneratedFiles,
-      })
-      multipleExecutionsOperation.addEndCallback(async () => {
-        await server.stop()
-      })
-      runtimeParams = {
-        ...runtimeParams,
-        server,
+      if (!devServerOrigin) {
+        throw new TypeError(
+          `devServerOrigin is required when running tests on browser(s)`,
+        )
+      }
+      const devServerStarted = await pingServer(devServerOrigin)
+      if (!devServerStarted) {
+        throw new Error(
+          `dev server not started at ${devServerOrigin}. It is required to run tests`,
+        )
       }
     }
 

package/src/test/execute_test_plan.js

@@ -17,9 +17,10 @@ import { generateCoverageTextLog } from "./coverage/coverage_reporter_text_log.j
 import { executePlan } from "./execute_plan.js"
 
 /**
- * Execute a list of files and log how it goes
+ * Execute a list of files and log how it goes.
  * @param {Object} testPlanParameters
  * @param {string|url} testPlanParameters.rootDirectoryUrl Root directory of the project
+ * @param {string|url} [testPlanParameters.serverOrigin=undefined] Jsenv dev server origin; required when executing test on browsers
  * @param {Object} testPlanParameters.testPlan Object associating patterns leading to files to runtimes where they should be executed
  * @param {boolean} [testPlanParameters.completedExecutionLogAbbreviation=false] Abbreviate completed execution information to shorten terminal output
  * @param {boolean} [testPlanParameters.completedExecutionLogMerging=false] Merge completed execution logs to shorten terminal output
@@ -45,6 +46,7 @@ export const executeTestPlan = async ({
   completedExecutionLogAbbreviation = false,
   completedExecutionLogMerging = false,
   rootDirectoryUrl,
+  devServerOrigin,
 
   testPlan,
   updateProcessExitCode = true,
@@ -79,18 +81,6 @@ export const executeTestPlan = async ({
   coverageReportTextLog = true,
   coverageReportJsonFile = process.env.CI ? null : "./.coverage/coverage.json",
   coverageReportHtmlDirectory = process.env.CI ? "./.coverage/" : null,
-
-  sourcemaps = "inline",
-  plugins = [],
-  nodeEsmResolution,
-  fileSystemMagicResolution,
-  writeGeneratedFiles = false,
-
-  protocol,
-  privateKey,
-  certificate,
-  host,
-  port,
 }) => {
   const logger = createLogger({ logLevel })
   rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
@@ -150,6 +140,7 @@ export const executeTestPlan = async ({
     completedExecutionLogMerging,
     completedExecutionLogAbbreviation,
     rootDirectoryUrl,
+    devServerOrigin,
 
     maxExecutionsInParallel,
     defaultMsAllocatedPerExecution,
@@ -165,19 +156,6 @@ export const executeTestPlan = async ({
     coverageMethodForNodeJs,
     coverageV8ConflictWarning,
     coverageTempDirectoryRelativeUrl,
-
-    scenarios: { dev: true, test: true },
-    sourcemaps,
-    plugins,
-    nodeEsmResolution,
-    fileSystemMagicResolution,
-    writeGeneratedFiles,
-
-    protocol,
-    privateKey,
-    certificate,
-    host,
-    port,
   })
   if (
     updateProcessExitCode &&