@jsenv/plugin-commonjs 1.2.0 → 1.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/plugin-commonjs",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -11,22 +11,33 @@
     "access": "public"
   },
   "type": "module",
-  "main": "./main.js",
+  "exports": {
+    ".": {
+      "import": "./src/main.js"
+    },
+    "./*": "./*"
+  },
+  "files": [
+    "/src/"
+  ],
+  "scripts": {
+    "test": "node --conditions=development ./scripts/test.mjs"
+  },
   "dependencies": {
     "@jsenv/filesystem": "4.1.9",
     "@jsenv/log": "3.3.3",
     "@jsenv/url-meta": "7.0.2",
     "@jsenv/urls": "1.2.8",
-    "@rollup/plugin-commonjs": "24.0.0",
+    "@rollup/plugin-commonjs": "24.0.1",
     "@rollup/plugin-json": "6.0.0",
     "@rollup/plugin-node-resolve": "15.0.1",
     "@rollup/plugin-replace": "5.0.2",
     "cjs-module-lexer": "1.2.2",
     "is-valid-identifier": "2.0.2",
     "resolve": "1.22.1",
-    "rollup": "3.8.0",
+    "rollup": "3.10.1",
     "rollup-plugin-node-globals": "1.4.0",
-    "rollup-plugin-polyfill-node": "0.11.0",
+    "rollup-plugin-polyfill-node": "0.12.0",
     "vm2": "3.9.13"
   },
   "devDependencies": {

package/src/cjs_to_esm_raw.js

@@ -74,6 +74,7 @@ export const commonJsToJsModuleRaw = async ({
   })
 
   const { default: commonjs } = await import("@rollup/plugin-commonjs")
+  // https://github.com/rollup/plugins/tree/master/packages/commonjs
   const commonJsRollupPlugin = commonjs({
     extensions: [".js", ".cjs"],
     // esmExternals: true,
@@ -89,7 +90,6 @@ export const commonJsToJsModuleRaw = async ({
   const commonJsNamedExportsRollupPlugin = rollupPluginCommonJsNamedExports({
     logger,
   })
-
   const { default: rollupPluginNodePolyfills } = await import(
     "rollup-plugin-polyfill-node"
   )

package/src/main.js

@@ -0,0 +1,2 @@
+export { jsenvPluginCommonJs } from "./jsenv_plugin_commonjs.js"
+export { commonJsToJsModule } from "./cjs_to_esm.js"

package/src/rollup_plugin_commonjs_named_exports.js

@@ -2,63 +2,71 @@
 
 import { readFileSync } from "node:fs"
 import { fileURLToPath, pathToFileURL } from "node:url"
+import path from "node:path"
 import { VM as VM2 } from "vm2"
 import resolve from "resolve"
 import isValidIdentifier from "is-valid-identifier"
 import { init, parse } from "cjs-module-lexer"
 
+const importWrapper = {
+  wrap: (specifier) => {
+    return `cjs_scan:${specifier}`
+  },
+  unwrap: (specifier) => {
+    return specifier.slice("cjs_scan:".length)
+  },
+  isWrapped: (specifier) => {
+    return specifier.startsWith("cjs_scan:")
+  },
+}
+
 export const rollupPluginCommonJsNamedExports = ({ logger }) => {
-  const inputSummaries = {}
-  const cjsScannedNamedExports = {}
+  const scanResults = {}
 
   return {
+    name: "scan_cjs_named_exports",
     async buildStart({ input }) {
       await init()
-
       Object.keys(input).forEach((key) => {
         const inputFilePath = input[key]
-        const inputFileUrl = pathToFileURL(inputFilePath)
-        inputSummaries[inputFileUrl] = {
+        const namedCjs =
+          detectStaticExports({ logger, filePath: inputFilePath }) ||
+          detectExportsUsingSandboxedRuntime({
+            logger,
+            filePath: inputFilePath,
+          })
+        scanResults[inputFilePath] = {
           all: true,
           default: true,
           namespace: true,
           named: [],
+          namedCjs,
         }
-
-        const cjsExports =
-          detectStaticExports({ logger, fileUrl: inputFileUrl }) ||
-          detectExportsUsingSandboxedRuntime({ logger, fileUrl: inputFileUrl })
-
-        if (cjsExports && cjsExports.length) {
-          cjsScannedNamedExports[inputFileUrl] = cjsExports
-        }
-        input[key] = `jsenv:${inputFileUrl}`
+        input[key] = importWrapper.wrap(inputFilePath)
       })
     },
-    resolveId(source) {
-      if (source.startsWith("jsenv:")) {
-        return source
+    resolveId(specifier) {
+      if (importWrapper.isWrapped(specifier)) {
+        return specifier
       }
-
       return null
     },
     load(id) {
-      if (!id.startsWith("jsenv:")) {
+      if (!importWrapper.isWrapped(id)) {
         return null
       }
-
-      const inputFileUrl = id.substring("jsenv:".length)
-      const inputSummary = inputSummaries[inputFileUrl]
-      let uniqueNamedExports = inputSummary.named
-      const scannedNamedExports = cjsScannedNamedExports[inputFileUrl]
-      if (scannedNamedExports) {
-        uniqueNamedExports = scannedNamedExports || []
-        inputSummary.default = true
+      const inputFilePath = importWrapper.unwrap(id)
+      const scanResult = scanResults[inputFilePath]
+      let uniqueNamedExports = scanResult.named
+      const namedCjs = scanResult.namedCjs
+      if (namedCjs.length) {
+        uniqueNamedExports = namedCjs
+        scanResult.default = true
       }
       const codeForExports = generateCodeForExports({
         uniqueNamedExports,
-        inputSummary,
-        inputFileUrl,
+        scanResult,
+        inputFilePath,
       })
       return codeForExports
     },
@@ -71,15 +79,15 @@ export const rollupPluginCommonJsNamedExports = ({ logger }) => {
  * same CJS export scanner that Node.js uses internally. Very fast, but only works on some modules,
  * depending on how they were build/written/compiled.
  */
-const detectStaticExports = ({ logger, fileUrl, visited = new Set() }) => {
+const detectStaticExports = ({ logger, filePath, visited = new Set() }) => {
   const isMainEntrypoint = visited.size === 0
   // Prevent infinite loops via circular dependencies.
-  if (visited.has(fileUrl)) {
+  if (visited.has(filePath)) {
     return []
   }
-  visited.add(fileUrl)
+  visited.add(filePath)
 
-  const fileContents = readFileSync(new URL(fileUrl), "utf8")
+  const fileContents = readFileSync(filePath, "utf8")
   try {
     const { exports, reexports } = parse(fileContents)
     // If re-exports were detected (`exports.foo = require(...)`) then resolve them here.
@@ -87,12 +95,11 @@ const detectStaticExports = ({ logger, fileUrl, visited = new Set() }) => {
     if (reexports.length > 0) {
       reexports.forEach((reexport) => {
         const reExportedFilePath = resolve.sync(reexport, {
-          basedir: fileURLToPath(new URL("./", fileUrl)),
+          basedir: fileURLToPath(new URL("./", pathToFileURL(filePath))),
         })
-        const reExportedFileUrl = pathToFileURL(reExportedFilePath)
         const staticExports = detectStaticExports({
           logger,
-          fileUrl: reExportedFileUrl,
+          filePath: reExportedFilePath,
           visited,
         })
         if (staticExports) {
@@ -105,14 +112,14 @@ const detectStaticExports = ({ logger, fileUrl, visited = new Set() }) => {
     ).filter(isValidNamedExport)
 
     if (isMainEntrypoint && resolvedExports.length === 0) {
-      return undefined
+      return []
     }
 
     return resolvedExports
   } catch (err) {
     // Safe to ignore, this is usually due to the file not being CJS.
-    logger.debug(`detectStaticExports ${fileUrl}: ${err.message}`)
-    return undefined
+    logger.debug(`detectStaticExports ${filePath}: ${err.message}`)
+    return []
   }
 }
 
@@ -122,22 +129,22 @@ const detectStaticExports = ({ logger, fileUrl, visited = new Set() }) => {
  * Uses VM2 to run safely sandbox untrusted code (no access no Node.js primitives, just JS).
  * If nothing was detected, return undefined.
  */
-const detectExportsUsingSandboxedRuntime = ({ logger, fileUrl }) => {
+const detectExportsUsingSandboxedRuntime = ({ logger, filePath }) => {
   try {
-    const fileContents = readFileSync(new URL(fileUrl), "utf8")
+    const fileContents = readFileSync(filePath, "utf8")
     const vm = new VM2({ wasm: false, fixAsync: false })
     const codeToRun = wrapCodeToRunInVm(fileContents)
     const vmResult = vm.run(codeToRun)
     const exportsResult = Object.keys(vmResult)
     logger.debug(
-      `detectExportsUsingSandboxedRuntime success ${fileUrl}: ${exportsResult}`,
+      `detectExportsUsingSandboxedRuntime success ${filePath}: ${exportsResult}`,
     )
     return exportsResult.filter((identifier) => isValidIdentifier(identifier))
   } catch (err) {
     logger.debug(
-      `detectExportsUsingSandboxedRuntime error ${fileUrl}: ${err.message}`,
+      `detectExportsUsingSandboxedRuntime error ${filePath}: ${err.message}`,
     )
-    return undefined
+    return []
   }
 }
 
@@ -153,20 +160,16 @@ module.exports;`
 
 const generateCodeForExports = ({
   uniqueNamedExports,
-  inputSummary,
-  inputFileUrl,
+  scanResult,
+  inputFilePath,
 }) => {
-  const from =
-    process.platform === "win32"
-      ? inputFileUrl.slice("file:///".length)
-      : inputFileUrl.slice("file://".length)
+  const from = inputFilePath.split(path.win32.sep).join(path.posix.sep)
   const lines = [
-    ...(inputSummary.namespace ? [stringifyNamespaceReExport({ from })] : []),
-    ...(inputSummary.default ? [stringifyDefaultReExport({ from })] : []),
-    stringifyNamedReExports({
-      namedExports: uniqueNamedExports,
-      from,
-    }),
+    ...(scanResult.namespace ? [stringifyNamespaceReExport({ from })] : []),
+    ...(scanResult.default ? [stringifyDefaultReExport({ from })] : []),
+    ...(uniqueNamedExports.length
+      ? [stringifyNamedReExports({ namedExports: uniqueNamedExports, from })]
+      : []),
   ]
   return lines.join(`
 `)

package/main.js

@@ -1,2 +0,0 @@
-export { jsenvPluginCommonJs } from "./src/jsenv_plugin_commonjs.js"
-export { commonJsToJsModule } from "./src/cjs_to_esm.js"

package/scripts/test.mjs

@@ -1,14 +0,0 @@
-import { executeTestPlan, nodeWorkerThread } from "@jsenv/core"
-
-await executeTestPlan({
-  rootDirectoryUrl: new URL("../", import.meta.url),
-  testPlan: {
-    "tests/**/*.test.mjs": {
-      node: {
-        runtime: nodeWorkerThread,
-      },
-    },
-  },
-  failFast: process.argv.includes("--workspace"),
-  completedExecutionLogMerging: process.argv.includes("--workspace"),
-})

package/tests/cjs_cache/cjs_cache.manual_test.mjs

@@ -1,17 +0,0 @@
-import { startDevServer } from "@jsenv/core"
-import { jsenvPluginCommonJs } from "@jsenv/plugin-commonjs"
-
-await startDevServer({
-  logLevel: "info",
-  rootDirectoryUrl: new URL("./client/", import.meta.url),
-  port: 5432,
-  plugins: [
-    jsenvPluginCommonJs({
-      include: {
-        "./file.cjs": true,
-      },
-    }),
-  ],
-  clientAutoreload: false,
-  supervisor: false,
-})

package/tests/cjs_cache/cjs_cache.test.mjs

@@ -1,79 +0,0 @@
-import { writeFileSync, readFileSync } from "node:fs"
-import { chromium } from "playwright"
-import { assert } from "@jsenv/assert"
-import { ensureEmptyDirectory } from "@jsenv/filesystem"
-import { startDevServer } from "@jsenv/core"
-import { launchBrowserPage } from "@jsenv/core/tests/launch_browser_page.js"
-
-import { jsenvPluginCommonJs } from "@jsenv/plugin-commonjs"
-
-const debug = false // true to have browser UI + keep it open after test
-await ensureEmptyDirectory(
-  new URL("./client/.jsenv/cjs_to_esm", import.meta.url),
-)
-const cjsFileUrl = new URL("./client/dep.cjs", import.meta.url)
-const cjsFileContent = {
-  beforeTest: readFileSync(cjsFileUrl),
-  update: (content) => writeFileSync(cjsFileUrl, content),
-  restore: () => writeFileSync(cjsFileUrl, cjsFileContent.beforeTest),
-}
-const devServer = await startDevServer({
-  logLevel: "warn",
-  rootDirectoryUrl: new URL("./client/", import.meta.url),
-  keepProcessAlive: false,
-  plugins: [
-    jsenvPluginCommonJs({
-      include: {
-        "./file.cjs": true,
-      },
-    }),
-  ],
-  clientAutoreload: false,
-  supervisor: false,
-})
-const browser = await chromium.launch({
-  headless: !debug,
-})
-try {
-  const page = await launchBrowserPage(browser)
-  await page.goto(`${devServer.origin}/main.html`)
-
-  const getResult = async () => {
-    const result = await page.evaluate(
-      /* eslint-disable no-undef */
-      () => {
-        return window.resultPromise
-      },
-      /* eslint-enable no-undef */
-    )
-    return result
-  }
-
-  {
-    const actual = {
-      result: await getResult(),
-    }
-    const expected = {
-      result: 42,
-    }
-    assert({ actual, expected })
-  }
-
-  // now update the package content + version and see if reloading the page updates the result
-  {
-    cjsFileContent.update(`module.exports = 43`)
-    await page.reload()
-    const actual = {
-      result: await getResult(),
-    }
-    const expected = {
-      result: 43,
-    }
-    assert({ actual, expected })
-  }
-} finally {
-  if (!debug) {
-    browser.close()
-  }
-  cjsFileContent.restore()
-}

package/tests/cjs_cache/client/.jsenv/chrome@102.00/@fs/Users/d.maillard/dev/jsenv/jsenv-core/node_modules/@jsenv/uneval/index.js

@@ -1,3 +0,0 @@
-export { uneval } from "/@fs/Users/d.maillard/dev/jsenv/jsenv-core/node_modules/@jsenv/uneval/src/uneval.js?v=1.6.0"
-
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjpudWxsLCJzb3VyY2VzIjpbImZpbGU6Ly8vVXNlcnMvZC5tYWlsbGFyZC9kZXYvanNlbnYvanNlbnYtY29yZS9ub2RlX21vZHVsZXMvQGpzZW52L3VuZXZhbC9pbmRleC5qcyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsNkZBQWlCOyJ9

package/tests/cjs_cache/client/.jsenv/chrome@102.00/@fs/Users/d.maillard/dev/jsenv/jsenv-core/node_modules/@jsenv/uneval/index.js.map

@@ -1,9 +0,0 @@
-{
-  "version": 3,
-  "file": null,
-  "sources": [
-    "file:///Users/d.maillard/dev/jsenv/jsenv-core/node_modules/@jsenv/uneval/index.js"
-  ],
-  "names": [],
-  "mappings": "AAAA,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,6FAAiB;"
-}