@jsenv/core 27.0.0-alpha.8 → 27.0.0-alpha.80

package/src/plugins/bundling/css/bundle_css.js

@@ -0,0 +1,140 @@
+/*
+ * Each @import found in css is replaced by the file content
+ * - There is no need to worry about urls (such as background-image: url())
+ *   because they are absolute (file://*) and will be made relative again by jsenv build
+ * - The sourcemap are not generated but ideally they should be
+ *   It can be quite challenging, see "bundle_sourcemap.js"
+ */
+
+import { applyPostCss } from "@jsenv/utils/css_ast/apply_post_css.js"
+import { postCssPluginUrlVisitor } from "@jsenv/utils/css_ast/postcss_plugin_url_visitor.js"
+import { createMagicSource } from "@jsenv/utils/sourcemap/magic_source.js"
+import { sortByDependencies } from "@jsenv/utils/graph/sort_by_dependencies.js"
+
+// Do not use until https://github.com/parcel-bundler/parcel-css/issues/181
+export const bundleCss = async ({ cssUrlInfos, context }) => {
+  const bundledCssUrlInfos = {}
+  const cssBundleInfos = await performCssBundling({
+    cssEntryUrlInfos: cssUrlInfos,
+    context,
+  })
+  cssUrlInfos.forEach((cssUrlInfo) => {
+    bundledCssUrlInfos[cssUrlInfo.url] = {
+      data: {
+        generatedBy: "parcel",
+      },
+      contentType: "text/css",
+      content: cssBundleInfos[cssUrlInfo.url].bundleContent,
+    }
+  })
+  return bundledCssUrlInfos
+}
+
+const performCssBundling = async ({ cssEntryUrlInfos, context }) => {
+  const cssBundleInfos = await loadCssUrls({
+    cssEntryUrlInfos,
+    context,
+  })
+  const cssUrlsSorted = sortByDependencies(cssBundleInfos)
+  cssUrlsSorted.forEach((cssUrl) => {
+    const cssBundleInfo = cssBundleInfos[cssUrl]
+    const magicSource = createMagicSource(cssBundleInfo.content)
+    cssBundleInfo.cssUrls.forEach((cssUrl) => {
+      if (cssUrl.type === "@import") {
+        magicSource.replace({
+          start: cssUrl.atRuleStart,
+          end: cssUrl.atRuleEnd,
+          replacement: cssBundleInfos[cssUrl.url].bundleContent,
+        })
+      }
+    })
+    const { content } = magicSource.toContentAndSourcemap()
+    cssBundleInfo.bundleContent = content.trim()
+  })
+  return cssBundleInfos
+}
+
+const parseCssUrls = async ({ css, url }) => {
+  const cssUrls = []
+  await applyPostCss({
+    sourcemaps: false,
+    plugins: [
+      postCssPluginUrlVisitor({
+        urlVisitor: ({
+          type,
+          specifier,
+          specifierStart,
+          specifierEnd,
+          atRuleStart,
+          atRuleEnd,
+        }) => {
+          cssUrls.push({
+            type,
+            url: new URL(specifier, url).href,
+            specifierStart,
+            specifierEnd,
+            atRuleStart,
+            atRuleEnd,
+          })
+        },
+      }),
+    ],
+    url,
+    content: css,
+  })
+
+  return cssUrls
+}
+
+const loadCssUrls = async ({ cssEntryUrlInfos, context }) => {
+  const cssBundleInfos = {}
+  const promises = []
+  const promiseMap = new Map()
+
+  const load = (cssUrlInfo) => {
+    const promiseFromData = promiseMap.get(cssUrlInfo.url)
+    if (promiseFromData) return promiseFromData
+    const promise = _load(cssUrlInfo)
+    promises.push(promise)
+    promiseMap.set(cssUrlInfo.url, promise)
+    return promise
+  }
+
+  const _load = async (cssUrlInfo) => {
+    const cssUrls = await parseCssUrls({
+      css: cssUrlInfo.content,
+      url: cssUrlInfo.url,
+    })
+    const cssBundleInfo = {
+      content: cssUrlInfo.content,
+      cssUrls,
+      dependencies: [],
+    }
+    cssBundleInfos[cssUrlInfo.url] = cssBundleInfo
+    cssUrls.forEach((cssUrl) => {
+      if (cssUrl.type === "@import") {
+        cssBundleInfo.dependencies.push(cssUrl.url)
+        const importedCssUrlInfo = context.urlGraph.getUrlInfo(cssUrl.url)
+        load(importedCssUrlInfo)
+      }
+    })
+  }
+
+  cssEntryUrlInfos.forEach((cssEntryUrlInfo) => {
+    load(cssEntryUrlInfo)
+  })
+
+  const waitAll = async () => {
+    if (promises.length === 0) {
+      return
+    }
+    const promisesToWait = promises.slice()
+    promises.length = 0
+    await Promise.all(promisesToWait)
+    await waitAll()
+  }
+  await waitAll()
+  promiseMap.clear()
+
+  return cssBundleInfos
+}

package/src/plugins/bundling/js_classic_workers/bundle_js_classic_workers.js

@@ -0,0 +1,13 @@
+/*
+ * TODO:
+ * for each js_classic where subtype is a worker
+ * take the url info and find importScripts calls
+ * and replace them with the corresponding url info file content
+ * we'll ikely need to save the importScripts node location to be able to do that
+ */
+
+// import { createMagicSource } from "@jsenv/utils/sourcemap/magic_source.js"
+
+export const bundleJsClassicWorkers = () => {
+  return {}
+}

package/src/plugins/bundling/js_module/bundle_js_module.js

@@ -0,0 +1,343 @@
+import { pathToFileURL } from "node:url"
+
+import { URL_META } from "@jsenv/url-meta"
+import { isFileSystemPath } from "@jsenv/urls"
+import { createDetailedMessage } from "@jsenv/log"
+import { babelHelperNameFromUrl } from "@jsenv/babel-plugins"
+import { applyRollupPlugins } from "@jsenv/utils/js_ast/apply_rollup_plugins.js"
+import { sourcemapConverter } from "@jsenv/utils/sourcemap/sourcemap_converter.js"
+import { fileUrlConverter } from "@jsenv/core/src/omega/file_url_converter.js"
+
+const globalThisClientFileUrl = new URL(
+  "../../transpilation/babel/global_this/client/global_this.js",
+  import.meta.url,
+).href
+const newStylesheetClientFileUrl = new URL(
+  "../../transpilation/babel/new_stylesheet/client/new_stylesheet.js",
+  import.meta.url,
+).href
+const regeneratorRuntimeClientFileUrl = new URL(
+  "../../transpilation/babel/regenerator_runtime/client/regenerator_runtime.js",
+  import.meta.url,
+).href
+
+export const bundleJsModule = async ({
+  jsModuleUrlInfos,
+  context,
+  options,
+}) => {
+  const {
+    signal,
+    logger,
+    rootDirectoryUrl,
+    buildDirectoryUrl,
+    urlGraph,
+    runtimeCompat,
+    sourcemaps,
+  } = context
+  const { babelHelpersChunk = true, include } = options
+  const { jsModuleBundleUrlInfos } = await buildWithRollup({
+    signal,
+    logger,
+    rootDirectoryUrl,
+    buildDirectoryUrl,
+    urlGraph,
+    jsModuleUrlInfos,
+
+    runtimeCompat,
+    sourcemaps,
+
+    include,
+    babelHelpersChunk,
+  })
+  return jsModuleBundleUrlInfos
+}
+
+export const buildWithRollup = async ({
+  signal,
+  logger,
+  rootDirectoryUrl,
+  buildDirectoryUrl,
+  urlGraph,
+  jsModuleUrlInfos,
+
+  runtimeCompat,
+  sourcemaps,
+
+  include,
+  babelHelpersChunk,
+}) => {
+  const resultRef = { current: null }
+  try {
+    await applyRollupPlugins({
+      rollupPlugins: [
+        rollupPluginJsenv({
+          signal,
+          logger,
+          rootDirectoryUrl,
+          buildDirectoryUrl,
+          urlGraph,
+          jsModuleUrlInfos,
+
+          runtimeCompat,
+          sourcemaps,
+          include,
+          babelHelpersChunk,
+          resultRef,
+        }),
+      ],
+      inputOptions: {
+        input: [],
+        onwarn: (warning) => {
+          if (warning.code === "CIRCULAR_DEPENDENCY") {
+            return
+          }
+          if (
+            warning.code === "THIS_IS_UNDEFINED" &&
+            pathToFileURL(warning.id).href === globalThisClientFileUrl
+          ) {
+            return
+          }
+          if (warning.code === "EVAL") {
+            // ideally we should disable only for jsenv files
+            return
+          }
+          logger.warn(String(warning))
+        },
+      },
+    })
+    return resultRef.current
+  } catch (e) {
+    if (e.code === "MISSING_EXPORT") {
+      const detailedMessage = createDetailedMessage(e.message, {
+        frame: e.frame,
+      })
+      throw new Error(detailedMessage, { cause: e })
+    }
+    throw e
+  }
+}
+
+const rollupPluginJsenv = ({
+  // logger,
+  rootDirectoryUrl,
+  buildDirectoryUrl,
+  urlGraph,
+  jsModuleUrlInfos,
+  sourcemaps,
+
+  include,
+  babelHelpersChunk,
+
+  resultRef,
+}) => {
+  let _rollupEmitFile = () => {
+    throw new Error("not implemented")
+  }
+  const emitChunk = (chunk) => {
+    return _rollupEmitFile({
+      type: "chunk",
+      ...chunk,
+    })
+  }
+  let importCanBeBundled = () => true
+  if (include) {
+    const associations = URL_META.resolveAssociations(
+      { bundle: include },
+      rootDirectoryUrl,
+    )
+    importCanBeBundled = (url) => {
+      return URL_META.applyAssociations({ url, associations }).bundle
+    }
+  }
+  const urlImporters = {}
+
+  return {
+    name: "jsenv",
+    async buildStart() {
+      _rollupEmitFile = (...args) => this.emitFile(...args)
+      let previousNonEntryPointModuleId
+      jsModuleUrlInfos.forEach((jsModuleUrlInfo) => {
+        const id = jsModuleUrlInfo.url
+        if (jsModuleUrlInfo.data.isEntryPoint) {
+          emitChunk({
+            id,
+          })
+          return
+        }
+        emitChunk({
+          id,
+          implicitlyLoadedAfterOneOf: previousNonEntryPointModuleId
+            ? [previousNonEntryPointModuleId]
+            : null,
+          // preserveSignature: "allow-extension",
+        })
+        previousNonEntryPointModuleId = id
+      })
+    },
+    async generateBundle(outputOptions, rollupResult) {
+      _rollupEmitFile = (...args) => this.emitFile(...args)
+
+      const jsModuleBundleUrlInfos = {}
+      Object.keys(rollupResult).forEach((fileName) => {
+        const rollupFileInfo = rollupResult[fileName]
+        // there is 3 types of file: "placeholder", "asset", "chunk"
+        if (rollupFileInfo.type === "chunk") {
+          const jsModuleBundleUrlInfo = {
+            data: {
+              generatedBy: "rollup",
+              bundleRelativeUrl: rollupFileInfo.fileName,
+              usesImport:
+                rollupFileInfo.imports.length > 0 ||
+                rollupFileInfo.dynamicImports.length > 0,
+              usesExport: rollupFileInfo.exports.length > 0,
+            },
+            contentType: "text/javascript",
+            content: rollupFileInfo.code,
+            sourcemap: rollupFileInfo.map,
+          }
+          let url
+          if (rollupFileInfo.facadeModuleId) {
+            url = fileUrlConverter.asFileUrl(rollupFileInfo.facadeModuleId)
+          } else {
+            url = new URL(rollupFileInfo.fileName, buildDirectoryUrl).href
+          }
+          jsModuleBundleUrlInfos[url] = jsModuleBundleUrlInfo
+        }
+      })
+      resultRef.current = {
+        jsModuleBundleUrlInfos,
+      }
+    },
+    outputOptions: (outputOptions) => {
+      // const sourcemapFile = buildDirectoryUrl
+      Object.assign(outputOptions, {
+        format: "esm",
+        dir: fileUrlConverter.asFilePath(buildDirectoryUrl),
+        sourcemap: sourcemaps === "file" || sourcemaps === "inline",
+        // sourcemapFile,
+        sourcemapPathTransform: (relativePath) => {
+          return new URL(relativePath, buildDirectoryUrl).href
+        },
+        entryFileNames: () => {
+          return `[name].js`
+        },
+        chunkFileNames: (chunkInfo) => {
+          const insideJs = willBeInsideJsDirectory({
+            chunkInfo,
+            fileUrlConverter,
+            jsModuleUrlInfos,
+          })
+          let nameFromUrlInfo
+          if (chunkInfo.facadeModuleId) {
+            const url = fileUrlConverter.asFileUrl(chunkInfo.facadeModuleId)
+            const urlInfo = jsModuleUrlInfos.find(
+              (jsModuleUrlInfo) => jsModuleUrlInfo.url === url,
+            )
+            if (urlInfo) {
+              nameFromUrlInfo = urlInfo.filename
+            }
+          }
+          const name = nameFromUrlInfo || `${chunkInfo.name}.js`
+          return insideJs ? `js/${name}` : `${name}`
+        },
+        manualChunks: (id) => {
+          if (babelHelpersChunk) {
+            const fileUrl = fileUrlConverter.asFileUrl(id)
+            if (
+              fileUrl.endsWith(
+                "babel-plugin-transform-async-to-promises/helpers.mjs",
+              )
+            ) {
+              return "babel_helpers"
+            }
+            if (babelHelperNameFromUrl(fileUrl)) {
+              return "babel_helpers"
+            }
+            if (fileUrl === globalThisClientFileUrl) {
+              return "babel_helpers"
+            }
+            if (fileUrl === newStylesheetClientFileUrl) {
+              return "babel_helpers"
+            }
+            if (fileUrl === regeneratorRuntimeClientFileUrl) {
+              return "babel_helpers"
+            }
+          }
+          return null
+        },
+        // https://rollupjs.org/guide/en/#outputpaths
+        // paths: (id) => {
+        //   return id
+        // },
+      })
+    },
+    resolveId: (specifier, importer = rootDirectoryUrl) => {
+      if (isFileSystemPath(importer)) {
+        importer = fileUrlConverter.asFileUrl(importer)
+      }
+      const url = new URL(specifier, importer).href
+      const existingImporter = urlImporters[url]
+      if (!existingImporter) {
+        urlImporters[url] = importer
+      }
+      if (!url.startsWith("file:")) {
+        return { id: url, external: true }
+      }
+      if (!importCanBeBundled(url)) {
+        return { id: url, external: true }
+      }
+      const urlInfo = urlGraph.getUrlInfo(url)
+      if (!urlInfo) {
+        // happen when excluded by urlAnalysis.include
+        return { id: url, external: true }
+      }
+      if (!urlInfo.shouldHandle) {
+        return { id: url, external: true }
+      }
+      const filePath = fileUrlConverter.asFilePath(url)
+      return filePath
+    },
+    async load(rollupId) {
+      const fileUrl = fileUrlConverter.asFileUrl(rollupId)
+      const urlInfo = urlGraph.getUrlInfo(fileUrl)
+      return {
+        code: urlInfo.content,
+        map: urlInfo.sourcemap
+          ? sourcemapConverter.toFilePaths(urlInfo.sourcemap)
+          : null,
+      }
+    },
+  }
+}
+
+const willBeInsideJsDirectory = ({
+  chunkInfo,
+  fileUrlConverter,
+  jsModuleUrlInfos,
+}) => {
+  // if the chunk is generated dynamically by rollup
+  // for an entry point jsenv will put that file inside js/ directory
+  // if it's generated dynamically for a file already in js/ directory
+  // both will be inside the js/ directory
+  if (!chunkInfo.facadeModuleId) {
+    // generated by rollup
+    return true
+  }
+  const url = fileUrlConverter.asFileUrl(chunkInfo.facadeModuleId)
+  const jsModuleUrlInfo = jsModuleUrlInfos.find(
+    (jsModuleUrlInfo) => jsModuleUrlInfo.url === url,
+  )
+  if (!jsModuleUrlInfo) {
+    // generated by rollup
+    return true
+  }
+  if (
+    !jsModuleUrlInfo.data.isEntryPoint &&
+    !jsModuleUrlInfo.data.isWebWorkerEntryPoint
+  ) {
+    // not an entry point, jsenv will put it inside js/ directory
+    return true
+  }
+  return false
+}

package/src/plugins/bundling/jsenv_plugin_bundling.js

@@ -0,0 +1,54 @@
+import { bundleCss } from "./css/bundle_css.js"
+import { bundleJsClassicWorkers } from "./js_classic_workers/bundle_js_classic_workers.js"
+import { bundleJsModule } from "./js_module/bundle_js_module.js"
+
+export const jsenvPluginBundling = (bundling) => {
+  if (typeof bundling === "boolean") {
+    bundling = {
+      css: bundling,
+      js_classic_workers: bundling,
+      js_module: bundling,
+    }
+  } else if (typeof bundling !== "object") {
+    throw new Error(`bundling must be a boolean or an object, got ${bundling}`)
+  }
+  Object.keys(bundling).forEach((key) => {
+    if (bundling[key] === true) bundling[key] = {}
+  })
+
+  return {
+    name: "jsenv:bundling",
+    appliesDuring: {
+      build: true,
+    },
+    bundle: {
+      css: bundling.css
+        ? (cssUrlInfos, context) => {
+            return bundleCss({
+              cssUrlInfos,
+              context,
+              options: bundling.css,
+            })
+          }
+        : undefined,
+      js_classic: bundling.js_classic
+        ? (jsClassicUrlInfos, context) => {
+            return bundleJsClassicWorkers({
+              jsClassicUrlInfos,
+              context,
+              options: bundling.js_classic_workers,
+            })
+          }
+        : undefined,
+      js_module: bundling.js_module
+        ? (jsModuleUrlInfos, context) => {
+            return bundleJsModule({
+              jsModuleUrlInfos,
+              context,
+              options: bundling.js_module,
+            })
+          }
+        : undefined,
+    },
+  }
+}

package/src/plugins/cache_control/jsenv_plugin_cache_control.js

@@ -0,0 +1,34 @@
+export const jsenvPluginCacheControl = () => {
+  return {
+    name: "jsenv:cache_control",
+    appliesDuring: {
+      dev: true,
+      test: true,
+    },
+    augmentResponse: ({ reference }, context) => {
+      if (context.scenario === "test") {
+        // During dev, all files are put into browser cache for 1 hour because:
+        // 1: Browser cache is a temporary directory created by playwright
+        // 2: We assume source files won't be modified while tests are running
+        return {
+          headers: {
+            "cache-control": `private,max-age=3600,immutable`,
+          },
+        }
+      }
+      if (
+        reference.searchParams.has("v") &&
+        !reference.searchParams.has("hmr")
+      ) {
+        return {
+          headers: {
+            "cache-control": `private,max-age=${SECONDS_IN_30_DAYS},immutable`,
+          },
+        }
+      }
+      return null
+    },
+  }
+}
+
+const SECONDS_IN_30_DAYS = 60 * 60 * 24 * 30

package/src/{omega/core_plugins → plugins}/commonjs_globals/jsenv_plugin_commonjs_globals.js

@@ -11,50 +11,63 @@ import { applyBabelPlugins } from "@jsenv/utils/js_ast/apply_babel_plugins.js"
 import { createMagicSource } from "@jsenv/utils/sourcemap/magic_source.js"
 
 export const jsenvPluginCommonJsGlobals = () => {
+  const transformCommonJsGlobals = async (urlInfo, { scenario }) => {
+    if (
+      !urlInfo.content.includes("process.env.NODE_ENV") &&
+      !urlInfo.content.includes("__filename") &&
+      !urlInfo.content.includes("__dirname")
+    ) {
+      return null
+    }
+    const isJsModule = urlInfo.type === "js_module"
+    const replaceMap = {
+      "process.env.NODE_ENV": `("${
+        scenario === "dev" || scenario === "test" ? "development" : "production"
+      }")`,
+      "global": "globalThis",
+      "__filename": isJsModule
+        ? `import.meta.url.slice('file:///'.length)`
+        : `document.currentScript.src`,
+      "__dirname": isJsModule
+        ? `import.meta.url.slice('file:///'.length).replace(/[\\\/\\\\][^\\\/\\\\]*$/, '')`
+        : `new URL('./', document.currentScript.src).href`,
+    }
+    const { metadata } = await applyBabelPlugins({
+      babelPlugins: [
+        [
+          babelPluginMetadataExpressionPaths,
+          {
+            replaceMap,
+            allowConflictingReplacements: true,
+          },
+        ],
+      ],
+      urlInfo,
+    })
+    const { expressionPaths } = metadata
+    const keys = Object.keys(expressionPaths)
+    if (keys.length === 0) {
+      return null
+    }
+    const magicSource = createMagicSource(urlInfo.content)
+    keys.forEach((key) => {
+      expressionPaths[key].forEach((path) => {
+        magicSource.replace({
+          start: path.node.start,
+          end: path.node.end,
+          replacement: replaceMap[key],
+        })
+      })
+    })
+    return magicSource.toContentAndSourcemap()
+  }
+
   return {
     name: "jsenv:commonjs_globals",
     appliesDuring: "*",
-    transform: {
-      js_module: async ({ url, generatedUrl, content }, { scenario }) => {
-        const replaceMap = {
-          "process.env.NODE_ENV": `("${
-            scenario === "dev" || scenario === "test" ? "dev" : "prod"
-          }")`,
-          "global": "globalThis",
-          "__filename": `import.meta.url.slice('file:///'.length)`,
-          "__dirname": `import.meta.url.slice('file:///'.length).replace(/[\\\/\\\\][^\\\/\\\\]*$/, '')`,
-        }
-        const { metadata } = await applyBabelPlugins({
-          babelPlugins: [
-            [
-              babelPluginMetadataExpressionPaths,
-              {
-                replaceMap,
-                allowConflictingReplacements: true,
-              },
-            ],
-          ],
-          url,
-          generatedUrl,
-          content,
-        })
-        const { expressionPaths } = metadata
-        const keys = Object.keys(expressionPaths)
-        if (keys.length === 0) {
-          return null
-        }
-        const magicSource = createMagicSource(content)
-        keys.forEach((key) => {
-          expressionPaths[key].forEach((path) => {
-            magicSource.replace({
-              start: path.node.start,
-              end: path.node.end,
-              replacement: replaceMap[key],
-            })
-          })
-        })
-        return magicSource.toContentAndSourcemap()
-      },
+    transformUrlContent: {
+      js_classic: transformCommonJsGlobals,
+      js_module: transformCommonJsGlobals,
     },
   }
 }