@jsenv/core 25.3.0 → 25.4.3

package/src/internal/compiling/js-compilation-service/transformJs.js

@@ -1,6 +1,20 @@
-import { urlToRelativeUrl } from "@jsenv/filesystem"
+import { urlToRelativeUrl, urlToFileSystemPath } from "@jsenv/filesystem"
 
-import { jsenvTransform } from "./jsenvTransform.js"
+import { require } from "@jsenv/core/src/internal/require.js"
+import { createParseError } from "@jsenv/core/src/internal/compiling/babel_parse_error.js"
+import { babelPluginTransformImportMeta } from "@jsenv/core/src/internal/compiling/babel_plugin_transform_import_meta.js"
+import {
+  getMinimalBabelPluginMap,
+  babelPluginsFromBabelPluginMap,
+} from "@jsenv/core/src/internal/compiling/babel_plugins.js"
+import { babelPluginProxyExternalImports } from "@jsenv/core/src/internal/compiling/babel_plugin_proxy_external_imports.js"
+import { babelPluginImportMetadata } from "@jsenv/core/src/internal/compiling/babel_plugin_import_metadata.js"
+
+import { ansiToHTML } from "./ansiToHTML.js"
+import { babelPluginRegeneratorRuntimeAsJsenvImport } from "./babel_plugin_regenerator_runtime_as_jsenv_import.js"
+import { babelPluginBabelHelpersAsJsenvImports } from "./babel_plugin_babel_helpers_as_jsenv_imports.js"
+import { babelPluginSystemJsPrepend } from "./babel_plugin_systemjs_prepend.js"
+import { babelHelperNameFromUrl } from "./babelHelper.js"
 
 export const transformJs = async ({
   projectDirectoryUrl,
@@ -17,6 +31,7 @@ export const transformJs = async ({
   sourcemapEnabled = true,
 
   map,
+  ast,
   code,
 }) => {
   if (typeof projectDirectoryUrl !== "string") {
@@ -40,29 +55,142 @@ export const transformJs = async ({
       `babelHelpersInjectionAsImport can be enabled only when "moduleOutFormat" is "esmodule"`,
     )
   }
+  const relativeUrl = url.startsWith(projectDirectoryUrl)
+    ? urlToRelativeUrl(url, projectDirectoryUrl)
+    : undefined
 
-  const transformResult = await jsenvTransform({
-    url,
-    relativeUrl: url.startsWith(projectDirectoryUrl)
-      ? urlToRelativeUrl(url, projectDirectoryUrl)
-      : undefined,
-    projectDirectoryUrl,
-    jsenvRemoteDirectory,
+  const inputPath = computeInputPath(url)
+  // https://babeljs.io/docs/en/options
+  const options = {
+    filename: inputPath,
+    filenameRelative: relativeUrl,
+    inputSourceMap: map,
+    configFile: false,
+    babelrc: false, // trust only these options, do not read any babelrc config file
+    ast: true,
+    sourceMaps: sourcemapEnabled,
+    sourceFileName: inputPath,
+    // https://babeljs.io/docs/en/options#parseropts
+    parserOpts: {
+      allowAwaitOutsideFunction:
+        topLevelAwait === undefined ||
+        topLevelAwait === "return" ||
+        topLevelAwait === "simple" ||
+        topLevelAwait === "ignore",
+    },
+    generatorOpts: {
+      compact: false,
+    },
+  }
+  const babelHelperName = babelHelperNameFromUrl(url)
+  // to prevent typeof circular dependency
+  if (babelHelperName === "typeof") {
+    const babelPluginMapWithoutTransformTypeOf = { ...babelPluginMap }
+    delete babelPluginMapWithoutTransformTypeOf["transform-typeof-symbol"]
+    babelPluginMap = babelPluginMapWithoutTransformTypeOf
+  }
+  if (transformGenerator) {
+    babelPluginMap = {
+      ...babelPluginMap,
+      "regenerator-runtime-as-jsenv-import": [
+        babelPluginRegeneratorRuntimeAsJsenvImport,
+      ],
+    }
+  }
+  babelPluginMap = {
+    ...getMinimalBabelPluginMap(),
+    "transform-import-meta": [
+      babelPluginTransformImportMeta,
+      { importMetaFormat },
+    ],
+    ...babelPluginMap,
+    ...(babelHelpersInjectionAsImport
+      ? {
+          "babel-helpers-as-jsenv-imports": [
+            babelPluginBabelHelpersAsJsenvImports,
+          ],
+        }
+      : {}),
+    ...(jsenvRemoteDirectory
+      ? {
+          "proxy-external-imports": [
+            babelPluginProxyExternalImports,
+            { jsenvRemoteDirectory },
+          ],
+        }
+      : {}),
+    "import-metadata": [babelPluginImportMetadata],
+  }
+  if (moduleOutFormat === "systemjs") {
+    const transformModulesSystemJs = require("@babel/plugin-transform-modules-systemjs")
+    const proposalDynamicImport = require("@babel/plugin-proposal-dynamic-import")
+    babelPluginMap = {
+      ...babelPluginMap,
+      "proposal-dynamic-import": [proposalDynamicImport],
+      "transform-modules-systemjs": [transformModulesSystemJs],
+    }
+  }
+  if (prependSystemJs) {
+    babelPluginMap = {
+      ...babelPluginMap,
+      "systemjs-prepend": [babelPluginSystemJsPrepend],
+    }
+  }
+
+  const asyncToPromise = babelPluginMap["transform-async-to-promises"]
+  if (topLevelAwait && asyncToPromise) {
+    asyncToPromise.options.topLevelAwait = topLevelAwait
+  }
+  const babelTransformReturnValue = await babelTransform({
+    ast,
     code,
-    map,
+    options: {
+      ...options,
+      plugins: babelPluginsFromBabelPluginMap(babelPluginMap),
+    },
+  })
+  code = babelTransformReturnValue.code
+  map = babelTransformReturnValue.map
+  ast = babelTransformReturnValue.ast
+  const { metadata } = babelTransformReturnValue
+  return { code, map, metadata, ast }
+}
+
+const computeInputPath = (url) => {
+  if (url.startsWith("file://")) {
+    return urlToFileSystemPath(url)
+  }
+  return url
+}
 
-    babelPluginMap,
-    moduleOutFormat,
-    importMetaFormat,
+const babelTransform = async ({ ast, code, options }) => {
+  const { transformAsync, transformFromAstAsync } = await import("@babel/core")
 
-    babelHelpersInjectionAsImport,
-    prependSystemJs,
-    topLevelAwait,
-    transformGenerator,
-    sourcemapEnabled,
-  })
-  code = transformResult.code
-  map = transformResult.map
-  const { metadata } = transformResult
-  return { code, map, metadata }
+  try {
+    if (ast) {
+      const result = await transformFromAstAsync(ast, code, options)
+      return result
+    }
+    return await transformAsync(code, options)
+  } catch (error) {
+    if (error && error.code === "BABEL_PARSE_ERROR") {
+      const message = error.message
+      const messageWithoutAnsi = message.replace(ansiRegex, "")
+      throw createParseError({
+        cause: error,
+        message: messageWithoutAnsi,
+        messageHTML: ansiToHTML(message),
+        filename: options.filename,
+        lineNumber: error.loc.line,
+        columnNumber: error.loc.column,
+      })
+    }
+    throw error
+  }
 }
+
+const pattern = [
+  "[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)",
+  "(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))",
+].join("|")
+const ansiRegex = new RegExp(pattern, "g")

package/src/internal/compiling/jsenvCompilerForHtml.js

@@ -36,7 +36,7 @@ import {
   visitHtmlAst,
   addHtmlNodeAttribute,
 } from "./compileHtml.js"
-import { generateCompilationAssetUrl } from "./compile-directory/compile-asset.js"
+import { generateCompilationAssetUrl } from "./jsenv_directory/compile_asset.js"
 
 export const compileHtml = async ({
   // cancellationToken,
@@ -46,12 +46,11 @@ export const compileHtml = async ({
   projectDirectoryUrl,
   jsenvRemoteDirectory,
   compileServerOrigin,
-  outDirectoryRelativeUrl,
+  jsenvDirectoryRelativeUrl,
 
+  compileProfile,
   compileId,
   babelPluginMap,
-  moduleOutFormat,
-  importMetaFormat,
   topLevelAwait,
   jsenvScriptInjection = true,
   jsenvEventSourceClientInjection,
@@ -61,7 +60,7 @@ export const compileHtml = async ({
   sourcemapMethod,
   code,
 }) => {
-  const compileDirectoryUrl = `${projectDirectoryUrl}${outDirectoryRelativeUrl}${compileId}/`
+  const compileDirectoryUrl = `${projectDirectoryUrl}${jsenvDirectoryRelativeUrl}${compileId}/`
   const browserRuntimeBuildUrlRelativeToProject = urlToRelativeUrl(
     BROWSER_RUNTIME_BUILD_URL,
     projectDirectoryUrl,
@@ -133,21 +132,23 @@ export const compileHtml = async ({
       specifier,
     })
   }
-  if (moduleOutFormat !== "esmodule") {
+  if (compileProfile.moduleOutFormat !== "esmodule") {
     const ressourceHints = collectRessourceHints(htmlAst)
     await visitRessourceHints({
       ressourceHints,
       addHtmlMutation,
     })
   }
-  await visitImportmapScript({
-    htmlAst,
+  await visitImportmapScripts({
     logger,
     url,
     compiledUrl,
     projectDirectoryUrl,
     compileDirectoryUrl,
-    moduleOutFormat,
+
+    compileProfile,
+
+    htmlAst,
     scripts,
     addHtmlMutation,
     addHtmlSourceFile,
@@ -161,9 +162,8 @@ export const compileHtml = async ({
     url,
     compiledUrl,
 
+    compileProfile,
     babelPluginMap,
-    moduleOutFormat,
-    importMetaFormat,
     topLevelAwait,
     sourcemapMethod,
 
@@ -245,14 +245,16 @@ const visitRessourceHints = async ({ ressourceHints, addHtmlMutation }) => {
   )
 }
 
-const visitImportmapScript = async ({
-  htmlAst,
+const visitImportmapScripts = async ({
   logger,
   url,
   compiledUrl,
   projectDirectoryUrl,
   compileDirectoryUrl,
-  moduleOutFormat,
+
+  compileProfile,
+
+  htmlAst,
   scripts,
   addHtmlMutation,
   addHtmlSourceFile,
@@ -263,14 +265,15 @@ const visitImportmapScript = async ({
     const type = typeAttribute ? typeAttribute.value : "application/javascript"
     return type === "importmap"
   })
+  const jsenvImportmap = getDefaultImportmap(compiledUrl, {
+    projectDirectoryUrl,
+    compileDirectoryUrl,
+  })
+
   // in case there is no importmap, force the presence
   // so that '@jsenv/core/' are still remapped
   if (importmapScripts.length === 0) {
-    const defaultImportMap = getDefaultImportmap(compiledUrl, {
-      projectDirectoryUrl,
-      compileDirectoryUrl,
-    })
-    const defaultImportMapAsText = JSON.stringify(defaultImportMap, null, "  ")
+    const defaultImportMapAsText = JSON.stringify(jsenvImportmap, null, "  ")
     onHtmlImportmapInfo({
       url: compiledUrl,
       text: defaultImportMapAsText,
@@ -280,7 +283,7 @@ const visitImportmapScript = async ({
         scriptInjections: [
           {
             type:
-              moduleOutFormat === "systemjs"
+              compileProfile.moduleOutFormat === "systemjs"
                 ? "systemjs-importmap"
                 : "importmap",
             text: defaultImportMapAsText,
@@ -322,6 +325,7 @@ const visitImportmapScript = async ({
       )
       importmap = {}
     }
+    importmap = composeTwoImportMaps(jsenvImportmap, importmap)
     const importmapAsText = JSON.stringify(importmap, null, "  ")
     onHtmlImportmapInfo({
       url: importmapUrl,
@@ -330,7 +334,7 @@ const visitImportmapScript = async ({
     addHtmlMutation(() => {
       removeHtmlNodeAttribute(firstImportmapScript, srcAttribute)
       setHtmlNodeText(firstImportmapScript, importmapAsText)
-      if (moduleOutFormat === "systemjs") {
+      if (compileProfile.moduleOutFormat === "systemjs") {
         const typeAttribute = getHtmlNodeAttributeByName(
           firstImportmapScript,
           "type",
@@ -341,10 +345,6 @@ const visitImportmapScript = async ({
     return
   }
 
-  const jsenvImportmap = getDefaultImportmap(compiledUrl, {
-    projectDirectoryUrl,
-    compileDirectoryUrl,
-  })
   const htmlImportmap = JSON.parse(
     getHtmlNodeTextNode(firstImportmapScript).value,
   )
@@ -357,7 +357,7 @@ const visitImportmapScript = async ({
   addHtmlMutation(() => {
     removeHtmlNodeAttribute(firstImportmapScript, srcAttribute)
     setHtmlNodeText(firstImportmapScript, importmapAsText)
-    if (moduleOutFormat === "systemjs") {
+    if (compileProfile.moduleOutFormat === "systemjs") {
       const typeAttribute = getHtmlNodeAttributeByName(
         firstImportmapScript,
         "type",
@@ -371,14 +371,13 @@ const visitImportmapScript = async ({
 const visitScripts = async ({
   logger,
   projectDirectoryUrl,
-  compileServerOrigin,
   jsenvRemoteDirectory,
+  compileServerOrigin,
   url,
   compiledUrl,
 
+  compileProfile,
   babelPluginMap,
-  moduleOutFormat,
-  importMetaFormat,
   topLevelAwait,
   sourcemapMethod,
 
@@ -398,7 +397,7 @@ const visitScripts = async ({
     if (type === "module") {
       if (src) {
         addHtmlMutation(() => {
-          if (moduleOutFormat === "systemjs") {
+          if (compileProfile.moduleOutFormat === "systemjs") {
             removeHtmlNodeAttribute(script, typeAttribute)
           }
           if (integrityAttribute) {
@@ -406,7 +405,7 @@ const visitScripts = async ({
           }
           removeHtmlNodeAttribute(script, srcAttribute)
           const jsenvMethod =
-            moduleOutFormat === "systemjs"
+            compileProfile.moduleOutFormat === "systemjs"
               ? "executeFileUsingSystemJs"
               : "executeFileUsingDynamicImport"
           let specifier
@@ -442,9 +441,8 @@ const visitScripts = async ({
           compiledUrl: scriptCompiledUrl,
 
           type: "module",
+          compileProfile,
           babelPluginMap,
-          moduleOutFormat,
-          importMetaFormat,
           topLevelAwait,
 
           sourcemapMethod,
@@ -453,12 +451,12 @@ const visitScripts = async ({
       })
       const specifier = `./${urlToRelativeUrl(scriptCompiledUrl, compiledUrl)}`
       addHtmlMutation(() => {
-        if (moduleOutFormat === "systemjs") {
+        if (compileProfile.moduleOutFormat === "systemjs") {
           removeHtmlNodeAttribute(script, typeAttribute)
         }
         removeHtmlNodeAttribute(script, srcAttribute)
         const jsenvMethod =
-          moduleOutFormat === "systemjs"
+          compileProfile.moduleOutFormat === "systemjs"
             ? "executeFileUsingSystemJs"
             : "executeFileUsingDynamicImport"
         setHtmlNodeText(
@@ -531,9 +529,8 @@ const visitScripts = async ({
             compiledUrl: scriptCompiledUrl,
 
             type: "classic",
+            compileProfile,
             babelPluginMap,
-            moduleOutFormat,
-            importMetaFormat,
             topLevelAwait,
 
             sourcemapMethod,
@@ -566,9 +563,8 @@ const visitScripts = async ({
           compiledUrl: scriptCompiledUrl,
 
           type: "classic",
+          compileProfile,
           babelPluginMap,
-          moduleOutFormat,
-          importMetaFormat,
           topLevelAwait,
 
           code: textNode.value,
@@ -591,9 +587,8 @@ const transformHtmlScript = async ({
   compiledUrl,
 
   type,
+  compileProfile,
   babelPluginMap,
-  moduleOutFormat,
-  importMetaFormat,
   topLevelAwait,
 
   code,
@@ -608,8 +603,8 @@ const transformHtmlScript = async ({
       compiledUrl,
 
       babelPluginMap,
-      moduleOutFormat: type === "module" ? moduleOutFormat : "global",
-      importMetaFormat,
+      moduleOutFormat:
+        type === "module" ? compileProfile.moduleOutFormat : "global",
       topLevelAwait: type === "module" ? topLevelAwait : false,
       babelHelpersInjectionAsImport: type === "module" ? undefined : false,
 

package/src/internal/compiling/jsenvCompilerForImportmap.js

@@ -7,12 +7,12 @@ export const compileImportmap = async ({
   url,
   compiledUrl,
   projectDirectoryUrl,
-  outDirectoryRelativeUrl,
+  jsenvDirectoryRelativeUrl,
   compileId,
 }) => {
   const jsenvImportmap = getDefaultImportmap(compiledUrl, {
     projectDirectoryUrl,
-    compileDirectoryUrl: `${projectDirectoryUrl}${outDirectoryRelativeUrl}${compileId}/`,
+    compileDirectoryUrl: `${projectDirectoryUrl}${jsenvDirectoryRelativeUrl}${compileId}/`,
   })
   const projectImportmap = JSON.parse(code)
   const importmap = composeTwoImportMaps(jsenvImportmap, projectImportmap)

package/src/internal/compiling/jsenvCompilerForJavaScript.js

@@ -9,11 +9,10 @@ export const compileJavascript = async ({
   url,
   compiledUrl,
 
+  compileProfile,
   babelPluginMap,
   workerUrls,
   serviceWorkerUrls,
-  moduleOutFormat,
-  importMetaFormat,
   topLevelAwait,
   prependSystemJs,
 
@@ -33,8 +32,7 @@ export const compileJavascript = async ({
     compiledUrl,
 
     babelPluginMap,
-    moduleOutFormat,
-    importMetaFormat,
+    moduleOutFormat: compileProfile.moduleOutFormat,
     topLevelAwait,
     prependSystemJs,
 

package/src/internal/compiling/jsenv_directory/comparison_utils.js

@@ -0,0 +1,24 @@
+export const sameValueInTwoObjects = (object, secondObject) => {
+  const objectKeys = Object.keys(object)
+  const secondObjectKeys = Object.keys(secondObject)
+  if (!sameValuesInTwoArrays(objectKeys, secondObjectKeys)) {
+    return false
+  }
+  return objectKeys.every((key) => {
+    const objectKeyValue = object[key]
+    const secondObjectKeyValue = secondObject[key]
+    if (
+      typeof objectKeyValue === "object" &&
+      objectKeyValue !== null &&
+      typeof secondObjectKeyValue === "object" &&
+      secondObjectKeyValue !== null
+    ) {
+      return sameValueInTwoObjects(objectKeyValue, secondObjectKeyValue)
+    }
+    return objectKeyValue === secondObjectKeyValue
+  })
+}
+
+export const sameValuesInTwoArrays = (array, secondArray) => {
+  return array.every((value) => secondArray.includes(value))
+}

package/src/internal/compiling/jsenv_directory/compile_context.js

@@ -0,0 +1,68 @@
+import { resolveUrl, readFile } from "@jsenv/filesystem"
+
+import {
+  TOOLBAR_INJECTOR_BUILD_URL,
+  EVENT_SOURCE_CLIENT_BUILD_URL,
+  BROWSER_RUNTIME_BUILD_URL,
+} from "@jsenv/core/dist/build_manifest.js"
+import { jsenvCoreDirectoryUrl } from "@jsenv/core/src/internal/jsenvCoreDirectoryUrl.js"
+
+import {
+  sameValuesInTwoArrays,
+  sameValueInTwoObjects,
+} from "./comparison_utils.js"
+
+const COMPARERS = {
+  preservedUrls: sameValueInTwoObjects,
+  workers: sameValuesInTwoArrays,
+  serviceWorkers: sameValuesInTwoArrays,
+  replaceProcessEnvNodeEnv: (a, b) => a === b,
+  inlineImportMapIntoHTML: (a, b) => a === b,
+
+  jsenvCorePackageVersion: (a, b) => a === b,
+  TOOLBAR_INJECTOR_BUILD_URL: (a, b) => a === b,
+  EVENT_SOURCE_CLIENT_BUILD_URL: (a, b) => a === b,
+  BROWSER_RUNTIME_BUILD_URL: (a, b) => a === b,
+}
+
+export const compareCompileContexts = (
+  compileContext,
+  secondCompileContext,
+) => {
+  return Object.keys(COMPARERS).every((key) => {
+    return COMPARERS[key](compileContext[key], secondCompileContext[key])
+  })
+}
+
+export const createCompileContext = async ({
+  preservedUrls,
+  workers,
+  serviceWorkers,
+  replaceProcessEnvNodeEnv,
+  inlineImportMapIntoHTML,
+}) => {
+  return {
+    preservedUrls,
+    workers,
+    serviceWorkers,
+    replaceProcessEnvNodeEnv,
+    inlineImportMapIntoHTML,
+
+    // when "jsenvCorePackageVersion" is different, it means compile logic may have changed
+    jsenvCorePackageVersion: await readJsenvCoreVersionFromPackageFile(),
+    TOOLBAR_INJECTOR_BUILD_URL,
+    EVENT_SOURCE_CLIENT_BUILD_URL,
+    BROWSER_RUNTIME_BUILD_URL,
+  }
+}
+
+const readJsenvCoreVersionFromPackageFile = async () => {
+  const jsenvCorePackageFileUrl = resolveUrl(
+    "./package.json",
+    jsenvCoreDirectoryUrl,
+  )
+  const jsenvCoreVersion = await readFile(jsenvCorePackageFileUrl, {
+    as: "json",
+  }).version
+  return jsenvCoreVersion
+}