@jsenv/core 27.0.0-alpha.5 → 27.0.0-alpha.50

package/src/plugins/autoreload/dev_sse/jsenv_plugin_dev_sse_server.js

@@ -0,0 +1,204 @@
+import { urlToRelativeUrl } from "@jsenv/filesystem"
+import { createCallbackList } from "@jsenv/abort"
+
+import { createSSEService } from "@jsenv/utils/event_source/sse_service.js"
+
+export const jsenvPluginDevSSEServer = ({
+  rootDirectoryUrl,
+  urlGraph,
+  clientFileChangeCallbackList,
+  clientFilesPruneCallbackList,
+}) => {
+  const serverEventCallbackList = createCallbackList()
+  const sseService = createSSEService({ serverEventCallbackList })
+
+  const notifyDeclined = ({ cause, reason, declinedBy }) => {
+    serverEventCallbackList.notify({
+      type: "reload",
+      data: JSON.stringify({
+        cause,
+        type: "full",
+        typeReason: reason,
+        declinedBy,
+      }),
+    })
+  }
+  const notifyAccepted = ({ cause, reason, instructions }) => {
+    serverEventCallbackList.notify({
+      type: "reload",
+      data: JSON.stringify({
+        cause,
+        type: "hot",
+        typeReason: reason,
+        hotInstructions: instructions,
+      }),
+    })
+  }
+  const propagateUpdate = (firstUrlInfo) => {
+    const urlInfos = urlGraph.urlInfos
+    const iterate = (urlInfo, trace) => {
+      if (urlInfo.data.hotAcceptSelf) {
+        return {
+          accepted: true,
+          reason:
+            urlInfo === firstUrlInfo
+              ? `file accepts hot reload`
+              : `a dependent file accepts hot reload`,
+          instructions: [
+            {
+              type: urlInfo.type,
+              boundary: urlToRelativeUrl(urlInfo.url, rootDirectoryUrl),
+              acceptedBy: urlToRelativeUrl(urlInfo.url, rootDirectoryUrl),
+            },
+          ],
+        }
+      }
+      const { dependents } = urlInfo
+      const instructions = []
+      for (const dependentUrl of dependents) {
+        const dependentUrlInfo = urlInfos[dependentUrl]
+        if (dependentUrlInfo.data.hotDecline) {
+          return {
+            declined: true,
+            reason: `a dependent file declines hot reload`,
+            declinedBy: dependentUrl,
+          }
+        }
+        const { hotAcceptDependencies = [] } = dependentUrlInfo.data
+        if (hotAcceptDependencies.includes(urlInfo.url)) {
+          instructions.push({
+            type: dependentUrlInfo.type,
+            boundary: urlToRelativeUrl(dependentUrl, rootDirectoryUrl),
+            acceptedBy: urlToRelativeUrl(urlInfo.url, rootDirectoryUrl),
+          })
+          continue
+        }
+        if (trace.includes(dependentUrl)) {
+          return {
+            declined: true,
+            reason: "circular dependency",
+            declinedBy: urlToRelativeUrl(dependentUrl, rootDirectoryUrl),
+          }
+        }
+        const dependentPropagationResult = iterate(dependentUrlInfo, [
+          ...trace,
+          dependentUrl,
+        ])
+        if (dependentPropagationResult.accepted) {
+          instructions.push(...dependentPropagationResult.instructions)
+          continue
+        }
+        if (
+          // declined explicitely by an other file, it must decline the whole update
+          dependentPropagationResult.declinedBy
+        ) {
+          return dependentPropagationResult
+        }
+        // declined by absence of boundary, we can keep searching
+        continue
+      }
+      if (instructions.length === 0) {
+        return {
+          declined: true,
+          reason: `there is no file accepting hot reload while propagating update`,
+        }
+      }
+      return {
+        accepted: true,
+        reason: `${instructions.length} dependent file(s) accepts hot reload`,
+        instructions,
+      }
+    }
+    const trace = []
+    return iterate(firstUrlInfo, trace)
+  }
+  clientFileChangeCallbackList.push(({ url, event }) => {
+    const urlInfo = urlGraph.urlInfos[url]
+    // file not part of dependency graph
+    if (!urlInfo) {
+      return
+    }
+    const relativeUrl = urlToRelativeUrl(url, rootDirectoryUrl)
+    const hotUpdate = propagateUpdate(urlInfo)
+    if (hotUpdate.declined) {
+      notifyDeclined({
+        cause: `${relativeUrl} ${event}`,
+        reason: hotUpdate.reason,
+        declinedBy: hotUpdate.declinedBy,
+      })
+    } else {
+      notifyAccepted({
+        cause: `${relativeUrl} ${event}`,
+        reason: hotUpdate.reason,
+        instructions: hotUpdate.instructions,
+      })
+    }
+  })
+  clientFilesPruneCallbackList.push(({ prunedUrlInfos, firstUrlInfo }) => {
+    const mainHotUpdate = propagateUpdate(firstUrlInfo)
+    const cause = `following files are no longer referenced: ${prunedUrlInfos.map(
+      (prunedUrlInfo) => urlToRelativeUrl(prunedUrlInfo.url, rootDirectoryUrl),
+    )}`
+    // now check if we can hot update the main ressource
+    // then if we can hot update all dependencies
+    if (mainHotUpdate.declined) {
+      notifyDeclined({
+        cause,
+        reason: mainHotUpdate.reason,
+        declinedBy: mainHotUpdate.declinedBy,
+      })
+      return
+    }
+    // main can hot update
+    let i = 0
+    const instructions = []
+    while (i < prunedUrlInfos.length) {
+      const prunedUrlInfo = prunedUrlInfos[i++]
+      if (prunedUrlInfo.data.hotDecline) {
+        notifyDeclined({
+          cause,
+          reason: `a pruned file declines hot reload`,
+          declinedBy: urlToRelativeUrl(prunedUrlInfo.url, rootDirectoryUrl),
+        })
+        return
+      }
+      instructions.push({
+        type: "prune",
+        boundary: urlToRelativeUrl(prunedUrlInfo.url, rootDirectoryUrl),
+        acceptedBy: urlToRelativeUrl(firstUrlInfo.url, rootDirectoryUrl),
+      })
+    }
+    notifyAccepted({
+      cause,
+      reason: mainHotUpdate.reason,
+      instructions,
+    })
+  })
+
+  return {
+    name: "jsenv:sse_server",
+    appliesDuring: { dev: true },
+    serve: (request) => {
+      if (request.ressource === "/__graph__") {
+        const graphJson = JSON.stringify(urlGraph.toJSON(rootDirectoryUrl))
+        return {
+          status: 200,
+          headers: {
+            "content-type": "application/json",
+            "content-length": Buffer.byteLength(graphJson),
+          },
+          body: graphJson,
+        }
+      }
+      const { accept } = request.headers
+      if (accept && accept.includes("text/event-stream")) {
+        const room = sseService.getOrCreateSSERoom(request)
+        return room.join(request)
+      }
+      return null
+    },
+    destroy: () => {
+      sseService.destroy()
+    },
+  }
+}

package/src/plugins/autoreload/jsenv_plugin_autoreload.js

@@ -0,0 +1,27 @@
+import { jsenvPluginHmr } from "./jsenv_plugin_hmr.js"
+import { jsenvPluginDevSSEClient } from "./dev_sse/jsenv_plugin_dev_sse_client.js"
+import { jsenvPluginDevSSEServer } from "./dev_sse/jsenv_plugin_dev_sse_server.js"
+
+export const jsenvPluginAutoreload = ({
+  rootDirectoryUrl,
+  urlGraph,
+  scenario,
+  clientFileChangeCallbackList,
+  clientFilesPruneCallbackList,
+}) => {
+  if (scenario === "build") {
+    return []
+  }
+  return [
+    jsenvPluginHmr(),
+    jsenvPluginDevSSEClient({
+      rootDirectoryUrl,
+    }),
+    jsenvPluginDevSSEServer({
+      rootDirectoryUrl,
+      urlGraph,
+      clientFileChangeCallbackList,
+      clientFilesPruneCallbackList,
+    }),
+  ]
+}

package/src/plugins/autoreload/jsenv_plugin_hmr.js

@@ -0,0 +1,35 @@
+export const jsenvPluginHmr = () => {
+  return {
+    name: "jsenv:hmr",
+    appliesDuring: { dev: true },
+    normalizeUrl: (reference) => {
+      const urlObject = new URL(reference.url)
+      if (!urlObject.searchParams.has("hmr")) {
+        reference.data.hmr = false
+        return null
+      }
+      reference.data.hmr = true
+      // "hmr" search param goal is to mark url as enabling hmr:
+      // this goal is achieved when we reach this part of the code
+      // We get rid of this params so that urlGraph and other parts of the code
+      // recognize the url (it is not considered as a different url)
+      urlObject.searchParams.delete("hmr")
+      urlObject.searchParams.delete("v")
+      return urlObject.href
+    },
+    transformUrlSearchParams: (reference, context) => {
+      const parentUrlInfo = context.urlGraph.getUrlInfo(reference.parentUrl)
+      if (!parentUrlInfo || !parentUrlInfo.data.hmr) {
+        return null
+      }
+      const urlInfo = context.urlGraph.getUrlInfo(reference.url)
+      if (!urlInfo.modifiedTimestamp) {
+        return null
+      }
+      return {
+        hmr: "",
+        v: urlInfo.modifiedTimestamp,
+      }
+    },
+  }
+}

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

@@ -0,0 +1,21 @@
+import { bundleWithParcel } from "@jsenv/utils/css_ast/parcel_css.js"
+
+export const bundleCss = async ({ cssUrlInfos, context }) => {
+  const bundledCssUrlInfos = {}
+  cssUrlInfos.forEach((cssUrlInfo) => {
+    const { code, map } = bundleWithParcel(cssUrlInfo, context)
+    const content = String(code)
+    const sourcemap = map
+    // here we need to replace css urls to ensure
+    // all urls targets the correct stuff
+    bundledCssUrlInfos[cssUrlInfo.url] = {
+      data: {
+        generatedBy: "parcel",
+      },
+      contentType: "text/css",
+      content,
+      sourcemap,
+    }
+  })
+  return bundledCssUrlInfos
+}

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/{build/plugins/bundle_js_module/jsenv_plugin_bundle_js_module.js → plugins/bundling/js_module/bundle_js_module.js}

@@ -1,43 +1,41 @@
-import { isFileSystemPath, urlToRelativeUrl } from "@jsenv/filesystem"
+import {
+  isFileSystemPath,
+  normalizeStructuredMetaMap,
+  urlToMeta,
+} from "@jsenv/filesystem"
+import { createDetailedMessage } from "@jsenv/logger"
 
 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"
 
-export const jsenvPluginBundleJsModule = () => {
-  return {
-    name: "jsenv:bundle_js_module",
-    appliesDuring: {
-      build: true,
-    },
-    bundle: {
-      js_module: async (
-        jsModuleUrlInfos,
-        {
-          signal,
-          logger,
-          rootDirectoryUrl,
-          buildDirectoryUrl,
-          urlGraph,
-          runtimeSupport,
-          sourcemaps,
-        },
-      ) => {
-        const { jsModuleBundleUrlInfos } = await buildWithRollup({
-          signal,
-          logger,
-          rootDirectoryUrl,
-          buildDirectoryUrl,
-          urlGraph,
-          jsModuleUrlInfos,
+export const bundleJsModule = async ({
+  jsModuleUrlInfos,
+  context,
+  options,
+}) => {
+  const {
+    signal,
+    logger,
+    rootDirectoryUrl,
+    buildDirectoryUrl,
+    urlGraph,
+    runtimeCompat,
+    sourcemaps,
+  } = context
+  const { jsModuleBundleUrlInfos } = await buildWithRollup({
+    signal,
+    logger,
+    rootDirectoryUrl,
+    buildDirectoryUrl,
+    urlGraph,
+    jsModuleUrlInfos,
 
-          runtimeSupport,
-          sourcemaps,
-        })
-        return jsModuleBundleUrlInfos
-      },
-    },
-  }
+    runtimeCompat,
+    sourcemaps,
+    options,
+  })
+  return jsModuleBundleUrlInfos
 }
 
 export const buildWithRollup = async ({
@@ -48,36 +46,48 @@ export const buildWithRollup = async ({
   urlGraph,
   jsModuleUrlInfos,
 
-  runtimeSupport,
+  runtimeCompat,
   sourcemaps,
+  options,
 }) => {
   const resultRef = { current: null }
-  await applyRollupPlugins({
-    rollupPlugins: [
-      rollupPluginJsenv({
-        signal,
-        logger,
-        rootDirectoryUrl,
-        buildDirectoryUrl,
-        urlGraph,
-        jsModuleUrlInfos,
+  try {
+    await applyRollupPlugins({
+      rollupPlugins: [
+        rollupPluginJsenv({
+          signal,
+          logger,
+          rootDirectoryUrl,
+          buildDirectoryUrl,
+          urlGraph,
+          jsModuleUrlInfos,
 
-        runtimeSupport,
-        sourcemaps,
-        resultRef,
-      }),
-    ],
-    inputOptions: {
-      input: [],
-      onwarn: (warning) => {
-        if (warning.code === "CIRCULAR_DEPENDENCY") {
-          return
-        }
-        logger.warn(String(warning))
+          runtimeCompat,
+          sourcemaps,
+          options,
+          resultRef,
+        }),
+      ],
+      inputOptions: {
+        input: [],
+        onwarn: (warning) => {
+          if (warning.code === "CIRCULAR_DEPENDENCY") {
+            return
+          }
+          logger.warn(String(warning))
+        },
       },
-    },
-  })
-  return resultRef.current
+    })
+    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 = ({
@@ -87,6 +97,7 @@ const rollupPluginJsenv = ({
   urlGraph,
   jsModuleUrlInfos,
   sourcemaps,
+  options,
 
   resultRef,
 }) => {
@@ -99,6 +110,21 @@ const rollupPluginJsenv = ({
       ...chunk,
     })
   }
+  let importCanBeBundled = () => true
+  if (options.include) {
+    const bundleIncludeConfig = normalizeStructuredMetaMap(
+      {
+        bundle: options.include,
+      },
+      rootDirectoryUrl,
+    )
+    importCanBeBundled = (url) => {
+      return urlToMeta({
+        url,
+        structuredMetaMap: bundleIncludeConfig,
+      }).bundle
+    }
+  }
   const urlImporters = {}
 
   return {
@@ -119,6 +145,7 @@ const rollupPluginJsenv = ({
           implicitlyLoadedAfterOneOf: previousNonEntryPointModuleId
             ? [previousNonEntryPointModuleId]
             : null,
+          preserveSignature: "allow-extension",
         })
         previousNonEntryPointModuleId = id
       })
@@ -131,24 +158,25 @@ const rollupPluginJsenv = ({
         const rollupFileInfo = rollupResult[fileName]
         // there is 3 types of file: "placeholder", "asset", "chunk"
         if (rollupFileInfo.type === "chunk") {
-          const { facadeModuleId } = rollupFileInfo
-          let url
-          if (facadeModuleId) {
-            url = fileUrlConverter.asFileUrl(facadeModuleId)
-          } else {
-            const { sources } = rollupFileInfo.map
-            const sourcePath = sources[sources.length - 1]
-            url = fileUrlConverter.asFileUrl(sourcePath)
-          }
           const jsModuleBundleUrlInfo = {
-            // buildRelativeUrl: rollupFileInfo.fileName,
             data: {
               generatedBy: "rollup",
+              bundleRelativeUrl: rollupFileInfo.fileName,
+              usesImport:
+                rollupFileInfo.imports.length > 0 ||
+                rollupFileInfo.dynamicImports.length > 0,
+              usesExport: rollupFileInfo.exports.length > 0,
             },
-            contentType: "application/javascript",
+            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
         }
       })
@@ -170,14 +198,23 @@ const rollupPluginJsenv = ({
           return `[name].js`
         },
         chunkFileNames: (chunkInfo) => {
-          // preserves relative path parts:
-          // the goal is to mantain the original relative path (relative to the root directory)
-          // so that later in the build process, when resolving these urls, we are able to
-          // re-resolve the specifier againt the original parent url and find the original url
-          const { facadeModuleId } = chunkInfo
-          const fileUrl = fileUrlConverter.asFileUrl(facadeModuleId)
-          const relativePath = urlToRelativeUrl(fileUrl, rootDirectoryUrl)
-          return relativePath
+          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}`
         },
         // https://rollupjs.org/guide/en/#outputpaths
         // paths: (id) => {
@@ -195,7 +232,10 @@ const rollupPluginJsenv = ({
         urlImporters[url] = importer
       }
       if (!url.startsWith("file:")) {
-        return { url, external: true }
+        return { id: url, external: true }
+      }
+      if (!importCanBeBundled(url)) {
+        return { id: url, external: true }
       }
       const filePath = fileUrlConverter.asFilePath(url)
       return filePath
@@ -223,3 +263,34 @@ const rollupPluginJsenv = ({
     },
   }
 }
+
+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,
+    },
+  }
+}