@jsenv/core 31.2.0 → 32.0.0

package/src/dev/file_service.js

@@ -1,13 +1,12 @@
 import { readFileSync } from "node:fs"
-import {
-  fetchFileSystem,
-  serveDirectory,
-  composeTwoResponses,
-} from "@jsenv/server"
-import { registerDirectoryLifecycle, bufferToEtag } from "@jsenv/filesystem"
-import { urlIsInsideOf, moveUrl, asUrlWithoutSearch } from "@jsenv/urls"
+import { serveDirectory, composeTwoResponses } from "@jsenv/server"
+import { bufferToEtag } from "@jsenv/filesystem"
+import { moveUrl, asUrlWithoutSearch } from "@jsenv/urls"
 import { URL_META } from "@jsenv/url-meta"
 
+import { determineJsenvInternalDirectoryUrl } from "../jsenv_internal_directory.js"
+import { watchSourceFiles } from "../watch_source_files.js"
+import { explorerHtmlFileUrl } from "@jsenv/core/src/plugins/explorer/jsenv_plugin_explorer.js"
 import { createUrlGraph } from "@jsenv/core/src/kitchen/url_graph.js"
 import { createKitchen } from "@jsenv/core/src/kitchen/kitchen.js"
 import { RUNTIME_COMPAT } from "@jsenv/core/src/kitchen/compat/runtime_compat.js"
@@ -22,7 +21,9 @@ export const createFileService = ({
   serverEventsDispatcher,
   contextCache,
 
-  rootDirectoryUrl,
+  sourceDirectoryUrl,
+  sourceMainFilePath,
+  sourceFilesConfig,
   runtimeCompat,
 
   plugins,
@@ -32,8 +33,6 @@ export const createFileService = ({
   supervisor,
   transpilation,
   clientAutoreload,
-  clientFiles,
-  clientMainFileUrl,
   cooldownBetweenFileEvents,
   explorer,
   cacheControl,
@@ -43,45 +42,22 @@ export const createFileService = ({
   sourcemapsSourcesContent,
   writeGeneratedFiles,
 }) => {
-  const jsenvDirectoryUrl = new URL(".jsenv/", rootDirectoryUrl).href
-
   const clientFileChangeCallbackList = []
   const clientFilesPruneCallbackList = []
-  const clientFilePatterns = {
-    ...clientFiles,
-    ".jsenv/": false,
-  }
-
-  const onFileChange = (url) => {
-    clientFileChangeCallbackList.forEach((callback) => {
-      callback(url)
-    })
-  }
-  const stopWatchingClientFiles = registerDirectoryLifecycle(rootDirectoryUrl, {
-    watchPatterns: clientFilePatterns,
-    cooldownBetweenFileEvents,
-    keepProcessAlive: false,
-    recursive: true,
-    added: ({ relativeUrl }) => {
-      onFileChange({
-        url: new URL(relativeUrl, rootDirectoryUrl).href,
-        event: "added",
+  const stopWatchingSourceFiles = watchSourceFiles(
+    sourceDirectoryUrl,
+    (fileInfo) => {
+      clientFileChangeCallbackList.forEach((callback) => {
+        callback(fileInfo)
       })
     },
-    updated: ({ relativeUrl }) => {
-      onFileChange({
-        url: new URL(relativeUrl, rootDirectoryUrl).href,
-        event: "modified",
-      })
+    {
+      sourceFilesConfig,
+      keepProcessAlive: false,
+      cooldownBetweenFileEvents,
     },
-    removed: ({ relativeUrl }) => {
-      onFileChange({
-        url: new URL(relativeUrl, rootDirectoryUrl).href,
-        event: "removed",
-      })
-    },
-  })
-  serverStopCallbacks.push(stopWatchingClientFiles)
+  )
+  serverStopCallbacks.push(stopWatchingSourceFiles)
 
   const getOrCreateContext = (request) => {
     const { runtimeName, runtimeVersion } = parseUserAgentHeader(
@@ -93,8 +69,8 @@ export const createFileService = ({
       return existingContext
     }
     const watchAssociations = URL_META.resolveAssociations(
-      { watch: clientFilePatterns },
-      rootDirectoryUrl,
+      { watch: stopWatchingSourceFiles.watchPatterns },
+      sourceDirectoryUrl,
     )
     const urlGraph = createUrlGraph()
     clientFileChangeCallbackList.push(({ url }) => {
@@ -114,10 +90,22 @@ export const createFileService = ({
       })
     })
     const clientRuntimeCompat = { [runtimeName]: runtimeVersion }
+    const jsenvInternalDirectoryUrl =
+      determineJsenvInternalDirectoryUrl(sourceDirectoryUrl)
+
+    let mainFileUrl
+    if (sourceMainFilePath === undefined) {
+      mainFileUrl = explorer
+        ? String(explorerHtmlFileUrl)
+        : String(new URL("./index.html", sourceDirectoryUrl))
+    } else {
+      mainFileUrl = String(new URL(sourceMainFilePath, sourceDirectoryUrl))
+    }
     const kitchen = createKitchen({
       signal,
       logLevel,
-      rootDirectoryUrl,
+      rootDirectoryUrl: sourceDirectoryUrl,
+      jsenvInternalDirectoryUrl,
       urlGraph,
       dev: true,
       runtimeCompat,
@@ -132,7 +120,8 @@ export const createFileService = ({
       plugins: [
         ...plugins,
         ...getCorePlugins({
-          rootDirectoryUrl,
+          rootDirectoryUrl: sourceDirectoryUrl,
+          mainFileUrl,
           runtimeCompat,
 
           urlAnalysis,
@@ -141,7 +130,6 @@ export const createFileService = ({
           supervisor,
           transpilation,
 
-          clientMainFileUrl,
           clientAutoreload,
           clientFileChangeCallbackList,
           clientFilesPruneCallbackList,
@@ -156,7 +144,10 @@ export const createFileService = ({
       sourcemapsSourcesProtocol,
       sourcemapsSourcesContent,
       writeGeneratedFiles,
-      outDirectoryUrl: `${rootDirectoryUrl}.jsenv/${runtimeName}@${runtimeVersion}/`,
+      outDirectoryUrl: new URL(
+        `${runtimeName}@${runtimeVersion}/`,
+        jsenvInternalDirectoryUrl,
+      ),
     })
     urlGraph.createUrlInfoCallbackRef.current = (urlInfo) => {
       const { watch } = URL_META.applyAssociations({
@@ -231,7 +222,7 @@ export const createFileService = ({
       if (serverEventNames.length > 0) {
         Object.keys(allServerEvents).forEach((serverEventName) => {
           allServerEvents[serverEventName]({
-            rootDirectoryUrl,
+            rootDirectoryUrl: sourceDirectoryUrl,
             urlGraph,
             dev: true,
             sendServerEvent: (data) => {
@@ -250,7 +241,7 @@ export const createFileService = ({
     }
 
     const context = {
-      rootDirectoryUrl,
+      rootDirectoryUrl: sourceDirectoryUrl,
       dev: true,
       runtimeName,
       runtimeVersion,
@@ -262,14 +253,6 @@ export const createFileService = ({
   }
 
   return async (request) => {
-    // serve file inside ".jsenv" directory
-    const requestFileUrl = new URL(request.resource.slice(1), rootDirectoryUrl)
-      .href
-    if (urlIsInsideOf(requestFileUrl, jsenvDirectoryUrl)) {
-      return fetchFileSystem(requestFileUrl, {
-        headers: request.headers,
-      })
-    }
     const { urlGraph, kitchen } = getOrCreateContext(request)
     const responseFromPlugin =
       await kitchen.pluginController.callAsyncHooksUntil(
@@ -281,14 +264,14 @@ export const createFileService = ({
       return responseFromPlugin
     }
     let reference
-    const parentUrl = inferParentFromRequest(request, rootDirectoryUrl)
+    const parentUrl = inferParentFromRequest(request, sourceDirectoryUrl)
     if (parentUrl) {
       reference = urlGraph.inferReference(request.resource, parentUrl)
     }
     if (!reference) {
       const entryPoint = kitchen.injectReference({
-        trace: { message: parentUrl || rootDirectoryUrl },
-        parentUrl: parentUrl || rootDirectoryUrl,
+        trace: { message: parentUrl || sourceDirectoryUrl },
+        parentUrl: parentUrl || sourceDirectoryUrl,
         type: "http_request",
         specifier: request.resource,
       })
@@ -424,7 +407,7 @@ export const createFileService = ({
             accept: "text/html",
           },
           canReadDirectory: true,
-          rootDirectoryUrl,
+          rootDirectoryUrl: sourceDirectoryUrl,
         })
       }
       if (code === "NOT_ALLOWED") {
@@ -452,7 +435,7 @@ export const createFileService = ({
   }
 }
 
-const inferParentFromRequest = (request, rootDirectoryUrl) => {
+const inferParentFromRequest = (request, sourceDirectoryUrl) => {
   const { referer } = request.headers
   if (!referer) {
     return null
@@ -468,7 +451,7 @@ const inferParentFromRequest = (request, rootDirectoryUrl) => {
   return moveUrl({
     url: referer,
     from: `${request.origin}/`,
-    to: rootDirectoryUrl,
+    to: sourceDirectoryUrl,
     preferAbsolute: true,
   })
 }

package/src/dev/start_dev_server.js

@@ -1,11 +1,6 @@
-import { parentPort } from "node:worker_threads"
-import {
-  validateDirectoryUrl,
-  registerDirectoryLifecycle,
-} from "@jsenv/filesystem"
+import { assertAndNormalizeDirectoryUrl } from "@jsenv/filesystem"
 import { Abort, raceProcessTeardownEvents } from "@jsenv/abort"
 import { createLogger, createTaskLog } from "@jsenv/log"
-import { getCallerPosition } from "@jsenv/urls"
 import {
   jsenvAccessControlAllowedHeaders,
   startServer,
@@ -16,7 +11,6 @@ import { convertFileSystemErrorToResponseProperties } from "@jsenv/server/src/in
 
 import { createServerEventsDispatcher } from "@jsenv/core/src/plugins/server_events/server_events_dispatcher.js"
 import { defaultRuntimeCompat } from "@jsenv/core/src/build/build.js"
-import { createReloadableWorker } from "@jsenv/core/src/helpers/worker_reload.js"
 import { createFileService } from "./file_service.js"
 
 /**
@@ -24,39 +18,30 @@ import { createFileService } from "./file_service.js"
  * - cook source files according to jsenv plugins
  * - inject code to autoreload the browser when a file is modified
  * @param {Object} devServerParameters
- * @param {string|url} devServerParameters.rootDirectoryUrl Root directory of the project
+ * @param {string|url} devServerParameters.sourceDirectoryUrl Root directory of the project
  * @return {Object} A dev server object
  */
 export const startDevServer = async ({
-  signal = new AbortController().signal,
-  handleSIGINT = true,
-  logLevel = "info",
-  serverLogLevel = "warn",
+  sourceDirectoryUrl,
+  sourceMainFilePath,
+  port = 3456,
+  hostname,
+  acceptAnyIp,
   https,
   // it's better to use http1 by default because it allows to get statusText in devtools
   // which gives valuable information when there is errors
   http2 = false,
-  hostname,
-  port = 3456,
-  acceptAnyIp,
-  keepProcessAlive = true,
+  logLevel = process.env.IMPORTED_BY_TEST_PLAN ? "warn" : "info",
+  serverLogLevel = "warn",
   services = [],
+
+  signal = new AbortController().signal,
+  handleSIGINT = true,
+  keepProcessAlive = true,
   onStop = () => {},
 
-  rootDirectoryUrl,
-  clientFiles = {
-    "./src/": true,
-    "./tests/": true,
-    "./package.json": true,
-  },
-  devServerFiles = {
-    "./package.json": true,
-    "./jsenv.config.mjs": true,
-  },
+  sourceFilesConfig,
   clientAutoreload = true,
-  clientMainFileUrl,
-  devServerAutoreload = false,
-  devServerMainFile = getCallerPosition().url,
   cooldownBetweenFileEvents,
 
   // runtimeCompat is the runtimeCompat for the build
@@ -90,13 +75,10 @@ export const startDevServer = async ({
         `${unexpectedParamNames.join(",")}: there is no such param`,
       )
     }
-    const rootDirectoryUrlValidation = validateDirectoryUrl(rootDirectoryUrl)
-    if (!rootDirectoryUrlValidation.valid) {
-      throw new TypeError(
-        `rootDirectoryUrl ${rootDirectoryUrlValidation.message}, got ${rootDirectoryUrl}`,
-      )
-    }
-    rootDirectoryUrl = rootDirectoryUrlValidation.value
+    sourceDirectoryUrl = assertAndNormalizeDirectoryUrl(
+      sourceDirectoryUrl,
+      "sourceDirectoryUrl",
+    )
   }
 
   const logger = createLogger({ logLevel })
@@ -112,58 +94,6 @@ export const startDevServer = async ({
       )
     })
   }
-
-  let reloadableWorker
-  if (devServerAutoreload) {
-    reloadableWorker = createReloadableWorker(devServerMainFile)
-    if (reloadableWorker.isPrimary) {
-      const devServerFileChangeCallback = ({ relativeUrl, event }) => {
-        const url = new URL(relativeUrl, rootDirectoryUrl).href
-        logger.info(`file ${event} ${url} -> restarting server...`)
-        reloadableWorker.reload()
-      }
-      const stopWatchingDevServerFiles = registerDirectoryLifecycle(
-        rootDirectoryUrl,
-        {
-          watchPatterns: {
-            ...devServerFiles.include,
-            [devServerMainFile]: true,
-            ".jsenv/": false,
-          },
-          cooldownBetweenFileEvents,
-          keepProcessAlive: false,
-          recursive: true,
-          added: ({ relativeUrl }) => {
-            devServerFileChangeCallback({ relativeUrl, event: "added" })
-          },
-          updated: ({ relativeUrl }) => {
-            devServerFileChangeCallback({ relativeUrl, event: "modified" })
-          },
-          removed: ({ relativeUrl }) => {
-            devServerFileChangeCallback({ relativeUrl, event: "removed" })
-          },
-        },
-      )
-      operation.addAbortCallback(() => {
-        stopWatchingDevServerFiles()
-        reloadableWorker.terminate()
-      })
-
-      const worker = await reloadableWorker.load()
-      const messagePromise = new Promise((resolve) => {
-        worker.once("message", resolve)
-      })
-      const origin = await messagePromise
-      return {
-        origin,
-        stop: () => {
-          stopWatchingDevServerFiles()
-          reloadableWorker.terminate()
-        },
-      }
-    }
-  }
-
   const startDevServerTask = createTaskLog("start dev server", {
     disabled: !logger.levels.info,
   })
@@ -201,6 +131,28 @@ export const startDevServer = async ({
         accessControlAllowCredentials: true,
         timingAllowOrigin: true,
       }),
+      {
+        handleRequest: (request) => {
+          if (request.pathname === "/__server_params__.json") {
+            const json = JSON.stringify({
+              sourceDirectoryUrl,
+            })
+            return {
+              status: 200,
+              headers: {
+                "content-type": "application/json",
+                "content-length": Buffer.byteLength(json),
+              },
+              body: json,
+            }
+          }
+          if (request.pathname === "/__stop__") {
+            server.stop()
+            return { status: 200 }
+          }
+          return null
+        },
+      },
       ...services,
       {
         name: "jsenv:omega_file_service",
@@ -211,7 +163,9 @@ export const startDevServer = async ({
           serverEventsDispatcher,
           contextCache,
 
-          rootDirectoryUrl,
+          sourceDirectoryUrl,
+          sourceMainFilePath,
+          sourceFilesConfig,
           runtimeCompat,
 
           plugins,
@@ -221,8 +175,6 @@ export const startDevServer = async ({
           supervisor,
           transpilation,
           clientAutoreload,
-          clientFiles,
-          clientMainFileUrl,
           cooldownBetweenFileEvents,
           explorer,
           cacheControl,
@@ -298,9 +250,6 @@ export const startDevServer = async ({
     logger.info(`- ${server.origins[key]}`)
   })
   logger.info(``)
-  if (reloadableWorker && reloadableWorker.isWorker) {
-    parentPort.postMessage(server.origin)
-  }
   return {
     origin: server.origin,
     stop: () => {

package/src/execute/execute.js

@@ -39,7 +39,10 @@ export const execute = async ({
   ignoreError = false,
 }) => {
   const logger = createLogger({ logLevel })
-  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
+  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(
+    rootDirectoryUrl,
+    "rootDirectoryUrl",
+  )
   const executeOperation = Abort.startOperation()
   executeOperation.addAbortSignal(signal)
   if (handleSIGINT) {

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

@@ -99,7 +99,6 @@ nodeChildProcess.run = async ({
   })
   logger.debug(
     createDetailedMessage(`child process forked (pid ${childProcess.pid})`, {
-      "execArgv": execArgv.join(`\n`),
       "custom env": JSON.stringify(env, null, "  "),
     }),
   )

package/src/jsenv_internal_directory.js

@@ -0,0 +1,18 @@
+import { basename } from "node:path"
+
+import { lookupPackageDirectory } from "./lookup_package_directory.js"
+
+export const determineJsenvInternalDirectoryUrl = (currentUrl) => {
+  const packageDirectoryUrl = lookupPackageDirectory(currentUrl)
+  if (packageDirectoryUrl) {
+    return `${packageDirectoryUrl}.jsenv/${getDirectoryName(
+      packageDirectoryUrl,
+    )}/`
+  }
+  return `${currentUrl}.jsenv/`
+}
+
+const getDirectoryName = (directoryUrl) => {
+  const { pathname } = new URL(directoryUrl)
+  return basename(pathname)
+}

package/src/kitchen/kitchen.js

@@ -28,6 +28,7 @@ export const createKitchen = ({
   logLevel,
 
   rootDirectoryUrl,
+  jsenvInternalDirectoryUrl,
   urlGraph,
   dev = false,
   build = false,
@@ -50,6 +51,7 @@ export const createKitchen = ({
     signal,
     logger,
     rootDirectoryUrl,
+    jsenvInternalDirectoryUrl,
     urlGraph,
     dev,
     build,

package/src/lookup_package_directory.js

@@ -0,0 +1,34 @@
+import { existsSync } from "node:fs"
+
+export const lookupPackageDirectory = (currentUrl) => {
+  if (currentUrl === "file:///") {
+    return null
+  }
+  const packageJsonFileUrl = `${currentUrl}package.json`
+  if (existsSync(new URL(packageJsonFileUrl))) {
+    return currentUrl
+  }
+  return lookupPackageDirectory(getParentUrl(currentUrl))
+}
+
+const getParentUrl = (url) => {
+  if (url.startsWith("file://")) {
+    // With node.js new URL('../', 'file:///C:/').href
+    // returns "file:///C:/" instead of "file:///"
+    const resource = url.slice("file://".length)
+    const slashLastIndex = resource.lastIndexOf("/")
+    if (slashLastIndex === -1) {
+      return url
+    }
+    const lastCharIndex = resource.length - 1
+    if (slashLastIndex === lastCharIndex) {
+      const slashBeforeLastIndex = resource.lastIndexOf("/", slashLastIndex - 1)
+      if (slashBeforeLastIndex === -1) {
+        return url
+      }
+      return `file://${resource.slice(0, slashBeforeLastIndex + 1)}`
+    }
+    return `file://${resource.slice(0, slashLastIndex + 1)}`
+  }
+  return new URL(url.endsWith("/") ? "../" : "./", url).href
+}

package/src/plugins/explorer/jsenv_plugin_explorer.js

@@ -11,13 +11,14 @@ export const explorerHtmlFileUrl = new URL(
 export const jsenvPluginExplorer = ({
   groups = {
     src: {
-      "./src/**/*.html": true,
+      "./**/*.html": true,
+      "./**/*.test.html": false,
     },
     tests: {
-      "./tests/**/*.test.html": true,
+      "./**/*.test.html": true,
     },
   },
-  clientMainFileUrl,
+  mainFileUrl,
 }) => {
   const faviconClientFileUrl = new URL("./client/jsenv.png", import.meta.url)
 
@@ -26,7 +27,7 @@ export const jsenvPluginExplorer = ({
     appliesDuring: "dev",
     transformUrlContent: {
       html: async (urlInfo, context) => {
-        if (urlInfo.url !== clientMainFileUrl) {
+        if (urlInfo.url !== mainFileUrl) {
           return null
         }
         let html = urlInfo.content

package/src/plugins/plugins.js

@@ -16,15 +16,13 @@ import { jsenvPluginImportMetaHot } from "./import_meta_hot/jsenv_plugin_import_
 import { jsenvPluginAutoreload } from "./autoreload/jsenv_plugin_autoreload.js"
 import { jsenvPluginCacheControl } from "./cache_control/jsenv_plugin_cache_control.js"
 // dev only
-import {
-  explorerHtmlFileUrl,
-  jsenvPluginExplorer,
-} from "./explorer/jsenv_plugin_explorer.js"
+import { jsenvPluginExplorer } from "./explorer/jsenv_plugin_explorer.js"
 // other
 import { jsenvPluginRibbon } from "./ribbon/jsenv_plugin_ribbon.js"
 
 export const getCorePlugins = ({
   rootDirectoryUrl,
+  mainFileUrl,
   runtimeCompat,
 
   urlAnalysis = {},
@@ -34,7 +32,6 @@ export const getCorePlugins = ({
   supervisor,
   transpilation = true,
 
-  clientMainFileUrl,
   clientAutoreload = false,
   clientFileChangeCallbackList,
   clientFilesPruneCallbackList,
@@ -58,13 +55,6 @@ export const getCorePlugins = ({
   if (clientAutoreload === true) {
     clientAutoreload = {}
   }
-  if (clientMainFileUrl === undefined) {
-    clientMainFileUrl = explorer
-      ? String(explorerHtmlFileUrl)
-      : String(new URL("./index.html", rootDirectoryUrl))
-  } else {
-    clientMainFileUrl = String(clientMainFileUrl)
-  }
 
   if (ribbon === true) {
     ribbon = {}
@@ -85,7 +75,7 @@ export const getCorePlugins = ({
     jsenvPluginHttpUrls(),
     jsenvPluginUrlResolution({
       runtimeCompat,
-      clientMainFileUrl,
+      mainFileUrl,
       urlResolution,
     }),
     jsenvPluginUrlVersion(),
@@ -106,9 +96,7 @@ export const getCorePlugins = ({
         ]
       : []),
     ...(cacheControl ? [jsenvPluginCacheControl(cacheControl)] : []),
-    ...(explorer
-      ? [jsenvPluginExplorer({ ...explorer, clientMainFileUrl })]
-      : []),
+    ...(explorer ? [jsenvPluginExplorer({ ...explorer, mainFileUrl })] : []),
     ...(ribbon ? [jsenvPluginRibbon({ rootDirectoryUrl, ...ribbon })] : []),
   ]
 }

package/src/plugins/url_resolution/jsenv_plugin_url_resolution.js

@@ -32,7 +32,7 @@ import { createNodeEsmResolver } from "./node_esm_resolver.js"
 
 export const jsenvPluginUrlResolution = ({
   runtimeCompat,
-  clientMainFileUrl,
+  mainFileUrl,
   urlResolution,
 }) => {
   const resolveUrlUsingWebResolution = (reference) => {
@@ -97,7 +97,7 @@ export const jsenvPluginUrlResolution = ({
     appliesDuring: "*",
     resolveUrl: (reference, context) => {
       if (reference.specifier === "/") {
-        return String(clientMainFileUrl)
+        return String(mainFileUrl)
       }
       if (reference.specifier[0] === "/") {
         return new URL(reference.specifier.slice(1), context.rootDirectoryUrl)

package/src/test/coverage/v8_coverage_node_directory.js

@@ -33,8 +33,10 @@ export const readNodeV8CoverageDirectory = async ({
     operation.throwIfAborted()
     const dirContent = await tryReadDirectory()
 
-    const coverageDirectoryUrl =
-      assertAndNormalizeDirectoryUrl(NODE_V8_COVERAGE)
+    const coverageDirectoryUrl = assertAndNormalizeDirectoryUrl(
+      NODE_V8_COVERAGE,
+      "NODE_V8_COVERAGE",
+    )
 
     await dirContent.reduce(async (previous, dirEntry) => {
       operation.throwIfAborted()