@jsenv/core 23.9.0 → 24.0.0

package/readme.md

@@ -72,8 +72,8 @@ npm install --save-dev @jsenv/core
 ```js
 import {
   executeTestPlan,
-  chromiumRuntimeTab,
-  firefoxRuntimeTab,
+  chromiumTabRuntime,
+  firefoxTabRuntime,
 } from "@jsenv/core"
 
 executeTestPlan({
@@ -81,10 +81,10 @@ executeTestPlan({
   testPlan: {
     "./animals.test.html": {
       chromium: {
-        runtime: chromiumRuntimeTab,
+        runtime: chromiumTabRuntime,
       },
       firefox: {
-        runtime: firefoxRuntimeTab,
+        runtime: firefoxTabRuntime,
       },
     },
   },
@@ -140,16 +140,16 @@ npm install --save-dev @jsenv/core
 2 - Create `start_dev_server.mjs`
 
 ```js
-import { startExploring } from "@jsenv/core"
+import { startDevServer } from "@jsenv/core"
 
-startExploring({
+startDevServer({
   projectDirectoryUrl: new URL("./", import.meta.url),
   explorableConfig: {
     source: {
       "**/*.html": true,
     },
   },
-  compileServerPort: 3456,
+  port: 3456,
 })
 ```
 
@@ -173,7 +173,7 @@ Browser navigates to `main.html` and execute the file. Hello world is displayed
 
 ![dev server hello world screenshot](./docs/demo_exploring_hello_world.png)
 
-To read more about jsenv dev server, also called exploring server, check [jsenv dev server documentation](./docs/exploring/readme.md#jsenv-dev-server).
+To read more about jsenv dev server, check [jsenv dev server documentation](./docs/dev_server/readme.md#jsenv-dev-server).
 
 # Build overview
 

package/src/buildProject.js

@@ -81,11 +81,11 @@ export const buildProject = async ({
   serviceWorkerFinalizer,
 
   env = {},
-  compileServerProtocol,
-  compileServerPrivateKey,
-  compileServerCertificate,
-  compileServerIp,
-  compileServerPort,
+  protocol,
+  privateKey,
+  certificate,
+  ip,
+  port,
   jsenvDirectoryRelativeUrl,
   jsenvDirectoryClean,
 
@@ -150,7 +150,7 @@ export const buildProject = async ({
 
   const compileServer = await startCompileServer({
     signal: buildOperation.signal,
-    compileServerLogLevel,
+    logLevel: compileServerLogLevel,
 
     projectDirectoryUrl,
     jsenvDirectoryRelativeUrl,
@@ -164,18 +164,18 @@ export const buildProject = async ({
     moduleOutFormat: "esmodule", // rollup or jsenv rollup plugin will transform into the right format
     importMetaFormat: "esmodule", // rollup or jsenv rollup plugin will transform into the right format
 
-    compileServerProtocol,
-    compileServerPrivateKey,
-    compileServerCertificate,
-    compileServerIp,
-    compileServerPort,
+    protocol,
+    privateKey,
+    certificate,
+    ip,
+    port,
     env,
     babelPluginMap,
     transformTopLevelAwait,
     customCompilers,
     runtimeSupport,
 
-    compileServerCanReadFromFileSystem: filesystemCache,
+    compileServerCanReadFromFilesystem: filesystemCache,
     compileServerCanWriteOnFilesystem: filesystemCache,
     // keep source html untouched
     // here we don't need to inline importmap

package/src/{startExploring.js → dev_server.js}

@@ -3,6 +3,7 @@ import {
   collectFiles,
   urlToRelativeUrl,
 } from "@jsenv/filesystem"
+import { setupRoutes } from "@jsenv/server"
 
 import { jsenvCoreDirectoryUrl } from "./internal/jsenvCoreDirectoryUrl.js"
 import {
@@ -25,12 +26,24 @@ import {
 } from "./internal/jsenvInternalFiles.js"
 import { jsenvRuntimeSupportDuringDev } from "./jsenvRuntimeSupportDuringDev.js"
 
-export const startExploring = async ({
+export const startDevServer = async ({
   signal = new AbortController().signal,
   handleSIGINT = true,
+  port,
+  ip,
+  protocol,
+  http2,
+  certificate,
+  privateKey,
+  plugins,
+  customServices,
 
-  explorableConfig = jsenvExplorableConfig,
   projectDirectoryUrl,
+  explorableConfig = jsenvExplorableConfig,
+  mainFileRelativeUrl = urlToRelativeUrl(
+    jsenvExploringIndexHtmlFileInfo.url,
+    projectDirectoryUrl,
+  ),
   jsenvDirectoryRelativeUrl,
   outDirectoryName = "dev",
   jsenvToolbar = true,
@@ -40,14 +53,9 @@ export const startExploring = async ({
 
   babelPluginMap,
   runtimeSupportDuringDev = jsenvRuntimeSupportDuringDev,
-  compileServerLogLevel,
+  logLevel,
   compileServerCanReadFromFilesystem,
   compileServerCanWriteOnFilesystem,
-  compileServerPort,
-  compileServerProtocol,
-  compileServerHttp2,
-  compileServerCertificate,
-  compileServerPrivateKey,
   sourcemapMethod,
   customCompilers,
   livereloadWatchConfig,
@@ -65,6 +73,7 @@ export const startExploring = async ({
   const redirectFiles = createRedirectFilesService({
     projectDirectoryUrl,
     outDirectoryRelativeUrl,
+    mainFileRelativeUrl,
   })
   const serveExploringData = createExploringDataService({
     projectDirectoryUrl,
@@ -82,28 +91,31 @@ export const startExploring = async ({
     signal,
     handleSIGINT,
     keepProcessAlive,
+    logLevel,
+    port,
+    ip,
+    protocol,
+    http2,
+    certificate,
+    privateKey,
+    plugins,
+    customServices: {
+      ...customServices,
+      "jsenv:redirector": redirectFiles,
+      "jsenv:exploring-data": serveExploringData,
+      "jsenv:explorables": serveExplorableListAsJson,
+    },
 
     projectDirectoryUrl,
     livereloadSSE: livereloading,
     jsenvToolbarInjection: jsenvToolbar,
-    customServices: {
-      "service:exploring-redirect": (request) => redirectFiles(request),
-      "service:exploring-data": (request) => serveExploringData(request),
-      "service:explorables": (request) => serveExplorableListAsJson(request),
-    },
-    customCompilers,
     jsenvDirectoryRelativeUrl,
     outDirectoryName,
     inlineImportMapIntoHTML,
 
-    compileServerLogLevel,
     compileServerCanReadFromFilesystem,
     compileServerCanWriteOnFilesystem,
-    compileServerPort,
-    compileServerProtocol,
-    compileServerHttp2,
-    compileServerCertificate,
-    compileServerPrivateKey,
+    customCompilers,
     sourcemapMethod,
     babelPluginMap,
     runtimeSupport: runtimeSupportDuringDev,
@@ -114,7 +126,10 @@ export const startExploring = async ({
   return compileServer
 }
 
-const createRedirectFilesService = ({ projectDirectoryUrl }) => {
+const createRedirectFilesService = ({
+  projectDirectoryUrl,
+  mainFileRelativeUrl,
+}) => {
   const jsenvExploringRedirectorHtmlRelativeUrlForProject = urlToRelativeUrl(
     jsenvExploringRedirectorHtmlFileInfo.url,
     projectDirectoryUrl,
@@ -145,18 +160,28 @@ const createRedirectFilesService = ({ projectDirectoryUrl }) => {
     pathForServer: `/${jsenvToolbarJsBuildRelativeUrlForProject}.map`,
   }
 
-  return (request) => {
-    // exploring redirection
-    if (request.ressource === "/") {
-      const jsenvExploringRedirectorHtmlServerUrl = `${request.origin}/${jsenvExploringRedirectorHtmlRelativeUrlForProject}`
+  return setupRoutes({
+    "/": (request) => {
+      const redirectTarget = mainFileRelativeUrl
+      const jsenvExploringRedirectorHtmlServerUrl = `${request.origin}/${jsenvExploringRedirectorHtmlRelativeUrlForProject}?redirect=${redirectTarget}`
       return {
         status: 307,
         headers: {
           location: jsenvExploringRedirectorHtmlServerUrl,
         },
       }
-    }
-    if (request.ressource === "/.jsenv/exploring.redirector.js") {
+    },
+    "/.jsenv/redirect/:rest*": (request) => {
+      const redirectTarget = request.ressource.slice("/.jsenv/redirect/".length)
+      const jsenvExploringRedirectorHtmlServerUrl = `${request.origin}/${jsenvExploringRedirectorHtmlRelativeUrlForProject}?redirect=${redirectTarget}`
+      return {
+        status: 307,
+        headers: {
+          location: jsenvExploringRedirectorHtmlServerUrl,
+        },
+      }
+    },
+    "/.jsenv/exploring.redirector.js": (request) => {
       const jsenvExploringRedirectorBuildServerUrl = `${request.origin}/${jsenvExploringRedirectorJsBuildRelativeUrlForProject}`
       return {
         status: 307,
@@ -164,10 +189,8 @@ const createRedirectFilesService = ({ projectDirectoryUrl }) => {
           location: jsenvExploringRedirectorBuildServerUrl,
         },
       }
-    }
-
-    // exploring index
-    if (request.ressource === "/.jsenv/exploring.index.js") {
+    },
+    "/.jsenv/exploring.index.js": (request) => {
       const jsenvExploringJsBuildServerUrl = `${request.origin}/${jsenvExploringJsBuildRelativeUrlForProject}`
       return {
         status: 307,
@@ -175,18 +198,16 @@ const createRedirectFilesService = ({ projectDirectoryUrl }) => {
           location: jsenvExploringJsBuildServerUrl,
         },
       }
-    }
-    if (request.ressource === jsenvExploringIndexSourcemapInfo.pathForBrowser) {
+    },
+    [jsenvExploringIndexSourcemapInfo.pathForBrowser]: (request) => {
       return {
         status: 307,
         headers: {
           location: `${request.origin}${jsenvExploringIndexSourcemapInfo.pathForServer}`,
         },
       }
-    }
-
-    // toolbar
-    if (request.ressource === "/.jsenv/toolbar.main.js") {
+    },
+    "/.jsenv/toolbar.main.js": (request) => {
       const jsenvToolbarJsBuildServerUrl = `${request.origin}/${jsenvToolbarJsBuildRelativeUrlForProject}`
       return {
         status: 307,
@@ -194,18 +215,16 @@ const createRedirectFilesService = ({ projectDirectoryUrl }) => {
           location: jsenvToolbarJsBuildServerUrl,
         },
       }
-    }
-    if (request.ressource === jsenvToolbarSourcemapInfo.pathForBrowser) {
+    },
+    [jsenvToolbarSourcemapInfo.pathForBrowser]: (request) => {
       return {
         status: 307,
         headers: {
           location: `${request.origin}${jsenvToolbarSourcemapInfo.pathForServer}`,
         },
       }
-    }
-
-    return null
-  }
+    },
+  })
 }
 
 const createExploringDataService = ({

package/src/execute.js

@@ -39,11 +39,11 @@ export const execute = async ({
   gracefulStopAllocatedMs,
   ignoreError = false,
 
-  compileServerProtocol,
-  compileServerPrivateKey,
-  compileServerCertificate,
-  compileServerIp,
-  compileServerPort,
+  protocol,
+  privateKey,
+  certificate,
+  ip,
+  port,
   babelPluginMap,
   customCompilers,
   compileServerCanReadFromFilesystem,
@@ -94,7 +94,7 @@ export const execute = async ({
       stop,
     } = await startCompileServer({
       signal: executeOperation.signal,
-      compileServerLogLevel,
+      logLevel: compileServerLogLevel,
 
       projectDirectoryUrl,
       jsenvDirectoryRelativeUrl,
@@ -103,11 +103,11 @@ export const execute = async ({
 
       importDefaultExtension,
 
-      compileServerProtocol,
-      compileServerPrivateKey,
-      compileServerCertificate,
-      compileServerIp,
-      compileServerPort,
+      protocol,
+      privateKey,
+      certificate,
+      ip,
+      port,
       babelPluginMap,
       customCompilers,
       runtimeSupport: normalizeRuntimeSupport({

package/src/executeTestPlan.js

@@ -62,11 +62,11 @@ export const executeTestPlan = async ({
   // skip full means file with 100% coverage won't appear in coverage reports (log and html)
   coverageSkipFull = false,
 
-  compileServerProtocol,
-  compileServerPrivateKey,
-  compileServerCertificate,
-  compileServerIp,
-  compileServerPort,
+  protocol,
+  privateKey,
+  certificate,
+  ip,
+  port,
   compileServerCanReadFromFilesystem,
   compileServerCanWriteOnFilesystem,
   babelPluginMap,
@@ -133,6 +133,7 @@ export const executeTestPlan = async ({
     handleSIGINT,
 
     logger,
+    logLevel,
     compileServerLogLevel,
     launchAndExecuteLogLevel,
 
@@ -157,11 +158,11 @@ export const executeTestPlan = async ({
     coverageTempDirectoryRelativeUrl,
 
     jsenvDirectoryClean,
-    compileServerProtocol,
-    compileServerPrivateKey,
-    compileServerCertificate,
-    compileServerIp,
-    compileServerPort,
+    protocol,
+    privateKey,
+    certificate,
+    ip,
+    port,
     compileServerCanReadFromFilesystem,
     compileServerCanWriteOnFilesystem,
     babelPluginMap,

package/src/internal/compiling/compile-directory/getOrGenerateCompiledFile.js

@@ -1,7 +1,7 @@
-import { urlToFileSystemPath } from "@jsenv/filesystem"
+import { urlToFileSystemPath, readFile } from "@jsenv/filesystem"
 import { createDetailedMessage } from "@jsenv/logger"
 import { timeStart, timeFunction } from "@jsenv/server"
-import { readFileContent } from "./fs-optimized-for-cache.js"
+
 import { validateCache } from "./validateCache.js"
 import { getMetaJsonFileUrl } from "./compile-asset.js"
 import { createLockRegistry } from "./createLockRegistry.js"
@@ -17,7 +17,6 @@ export const getOrGenerateCompiledFile = async ({
   compileCacheStrategy,
   compileCacheSourcesValidation,
   compileCacheAssetsValidation,
-  fileContentFallback,
   request,
   compile,
 }) => {
@@ -65,7 +64,6 @@ export const getOrGenerateCompiledFile = async ({
           originalFileUrl,
           compiledFileUrl,
           compile,
-          fileContentFallback,
           compileCacheStrategy,
           compileCacheSourcesValidation,
           compileCacheAssetsValidation,
@@ -94,7 +92,6 @@ const computeCompileReport = async ({
   originalFileUrl,
   compiledFileUrl,
   compile,
-  fileContentFallback,
   compileCacheStrategy,
   compileCacheSourcesValidation,
   compileCacheAssetsValidation,
@@ -136,7 +133,6 @@ const computeCompileReport = async ({
       callCompile({
         logger,
         originalFileUrl,
-        fileContentFallback,
         compile,
       }),
     )
@@ -174,22 +170,11 @@ const computeCompileReport = async ({
   }
 }
 
-const callCompile = async ({
-  logger,
-  originalFileUrl,
-  fileContentFallback,
-  compile,
-}) => {
+const callCompile = async ({ logger, originalFileUrl, compile }) => {
   logger.debug(`compile ${originalFileUrl}`)
 
-  const codeBeforeCompile =
-    compile.length === 0
-      ? ""
-      : await getCodeToCompile({ originalFileUrl, fileContentFallback })
-
   const compileReturnValue = await compile({
-    code: codeBeforeCompile,
-    map: undefined,
+    code: await readFile(originalFileUrl),
   })
   if (typeof compileReturnValue !== "object" || compileReturnValue === null) {
     throw new TypeError(
@@ -229,24 +214,6 @@ const callCompile = async ({
   }
 }
 
-const getCodeToCompile = async ({ originalFileUrl, fileContentFallback }) => {
-  let fileContent
-  if (fileContentFallback) {
-    try {
-      fileContent = await readFileContent(originalFileUrl)
-    } catch (e) {
-      if (e.code === "ENOENT") {
-        fileContent = await fileContentFallback()
-      } else {
-        throw e
-      }
-    }
-  } else {
-    fileContent = await readFileContent(originalFileUrl)
-  }
-  return fileContent
-}
-
 const startAsap = async (fn, { logger, compiledFileUrl }) => {
   const metaJsonFileUrl = getMetaJsonFileUrl(compiledFileUrl)
   const metaJsonFilePath = urlToFileSystemPath(metaJsonFileUrl)

package/src/internal/compiling/compileFile.js

@@ -16,7 +16,6 @@ export const compileFile = async ({
   projectDirectoryUrl,
   originalFileUrl,
   compiledFileUrl,
-  fileContentFallback,
   projectFileRequestedCallback = () => {},
   request,
   pushResponse,
@@ -44,7 +43,6 @@ export const compileFile = async ({
         projectDirectoryUrl,
         originalFileUrl,
         compiledFileUrl,
-        fileContentFallback,
         request,
         compileCacheStrategy,
         compileCacheSourcesValidation,

package/src/internal/compiling/createCompiledFileService.js

@@ -1,4 +1,4 @@
-import { redirectRequest, fetchFileSystem } from "@jsenv/server"
+import { fetchFileSystem } from "@jsenv/server"
 import {
   resolveUrl,
   resolveDirectoryUrl,
@@ -80,7 +80,7 @@ export const createCompiledFileService = ({
     projectDirectoryUrl,
   )
 
-  return (request, { pushResponse }) => {
+  return (request, { pushResponse, redirectRequest }) => {
     const { origin, ressource } = request
     // we use "ressourceToPathname" to remove eventual query param from the url
     // Without this a pattern like "**/*.js" would not match "file.js?t=1"
@@ -167,12 +167,11 @@ export const createCompiledFileService = ({
       projectFileRequestedCallback,
       request,
       pushResponse,
-      compile: ({ code, map }) => {
+      compile: ({ code }) => {
         return compiler({
           logger,
 
           code,
-          map,
           url: originalFileUrl,
           compiledUrl: compiledFileUrl,
           projectDirectoryUrl,

package/src/internal/compiling/startCompileServer.js

@@ -4,7 +4,7 @@ import {
   startServer,
   fetchFileSystem,
   createSSERoom,
-  composeServicesWithTiming,
+  composeServices,
   urlToContentType,
   pluginServerTiming,
   pluginRequestWaitingCheck,
@@ -50,7 +50,15 @@ import { createTransformHtmlSourceFileService } from "./html_source_file_service
 export const startCompileServer = async ({
   signal = new AbortController().signal,
   handleSIGINT,
-  compileServerLogLevel,
+  logLevel,
+  protocol = "http",
+  http2 = protocol === "https",
+  privateKey,
+  certificate,
+  ip = "0.0.0.0",
+  port = 0,
+  keepProcessAlive = false,
+  onStop = () => {},
 
   projectDirectoryUrl,
 
@@ -82,16 +90,6 @@ export const startCompileServer = async ({
   babelConfigFileUrl,
   customCompilers = {},
 
-  // options related to the server itself
-  compileServerProtocol = "http",
-  compileServerHttp2 = compileServerProtocol === "https",
-  compileServerPrivateKey,
-  compileServerCertificate,
-  compileServerIp = "0.0.0.0",
-  compileServerPort = 0,
-  keepProcessAlive = false,
-  onStop = () => {},
-
   // remaining options
   runtimeSupport,
 
@@ -103,6 +101,7 @@ export const startCompileServer = async ({
   },
   livereloadLogLevel = "info",
   customServices = {},
+  plugins,
   livereloadSSE = false,
   transformHtmlSourceFiles = true,
   jsenvToolbarInjection = false,
@@ -133,7 +132,7 @@ export const startCompileServer = async ({
     projectDirectoryUrl,
   )
 
-  const logger = createLogger({ logLevel: compileServerLogLevel })
+  const logger = createLogger({ logLevel })
 
   const browser = isBrowserPartOfSupportedRuntimes(runtimeSupport)
   const babelPluginMapFromFile = await loadBabelPluginMapFromFile({
@@ -239,13 +238,14 @@ export const startCompileServer = async ({
       trackMainAndDependencies: sseSetup.trackMainAndDependencies,
     })
     customServices = {
-      "service:sse": serveSSEForLivereload,
       ...customServices,
+      "service:sse": serveSSEForLivereload,
     }
   } else {
     const roomWhenLivereloadIsDisabled = createSSERoom()
     roomWhenLivereloadIsDisabled.open()
     customServices = {
+      ...customServices,
       "service:sse": (request) => {
         const { accept } = request.headers
         if (!accept || !accept.includes("text/event-stream")) {
@@ -253,7 +253,6 @@ export const startCompileServer = async ({
         }
         return roomWhenLivereloadIsDisabled.join(request)
       },
-      ...customServices,
     }
   }
 
@@ -349,15 +348,16 @@ export const startCompileServer = async ({
     sendServerInternalErrorDetails: true,
     keepProcessAlive,
 
-    logLevel: compileServerLogLevel,
+    logLevel,
 
-    protocol: compileServerProtocol,
-    http2: compileServerHttp2,
-    serverCertificate: compileServerCertificate,
-    serverCertificatePrivateKey: compileServerPrivateKey,
-    ip: compileServerIp,
-    port: compileServerPort,
+    protocol,
+    http2,
+    certificate,
+    privateKey,
+    ip,
+    port,
     plugins: {
+      ...plugins,
       ...pluginCORS({
         accessControlAllowRequestOrigin: true,
         accessControlAllowRequestMethod: true,
@@ -368,12 +368,12 @@ export const startCompileServer = async ({
         ],
         accessControlAllowCredentials: true,
       }),
-      ...pluginServerTiming,
+      ...pluginServerTiming(),
       ...pluginRequestWaitingCheck({
         requestWaitingMs: 60 * 1000,
       }),
     },
-    requestToResponse: composeServicesWithTiming({
+    requestToResponse: composeServices({
       ...customServices,
       ...jsenvServices,
     }),
@@ -745,7 +745,7 @@ const setupServerSentEventsForLivereload = ({
     const { referer } = request.headers
     if (referer) {
       const { origin } = request
-      // referer is likely the exploringServer
+      // referer is likely the dev server
       if (referer !== origin && !urlIsInsideOf(referer, origin)) {
         return {
           dependency: false,