@jsenv/plugin-commonjs 0.1.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/plugin-commonjs",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -8,17 +8,16 @@
     "directory": "packages/jsenv-plugin-commonjs"
   },
   "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
+    "access": "public"
   },
   "type": "module",
   "main": "./main.js",
   "dependencies": {
-    "@jsenv/filesystem": "4.0.10",
-    "@jsenv/log": "2.0.1",
+    "@jsenv/filesystem": "4.1.0",
+    "@jsenv/log": "3.0.2",
     "@jsenv/url-meta": "7.0.0",
     "@jsenv/urls": "1.2.6",
-    "@rollup/plugin-commonjs": "22.0.0",
+    "@rollup/plugin-commonjs": "22.0.1",
     "@rollup/plugin-json": "4.1.0",
     "@rollup/plugin-node-resolve": "13.3.0",
     "@rollup/plugin-replace": "4.0.0",
@@ -30,4 +29,4 @@
     "rollup-plugin-polyfill-node": "0.9.0",
     "vm2": "3.9.9"
   }
-}
+}

package/scripts/test.mjs

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

package/src/compile_cache/compiled_file_cache.js

@@ -27,15 +27,20 @@ export const reuseOrCreateCompiledFile = async ({
     throw new TypeError(`compile must be a function, got ${compile}`)
   }
 
+  const getCacheValidity = () => {
+    const cacheValidity = validateCompileCache({
+      logger,
+      compiledFileUrl,
+      compileCacheStrategy,
+      compileCacheAssetsValidation,
+    })
+    return cacheValidity
+  }
+
   return startAsap(
     async () => {
       logger.debug(`check cache for ${compiledFileUrl}`)
-      const cacheValidity = validateCompileCache({
-        logger,
-        compiledFileUrl,
-        compileCacheStrategy,
-        compileCacheAssetsValidation,
-      })
+      const cacheValidity = getCacheValidity()
       if (cacheValidity.isValid) {
         logger.debug(`${UNICODE.OK} found a valid cache`)
         const compileInfo = cacheValidity.compileInfo.data
@@ -55,14 +60,8 @@ export const reuseOrCreateCompiledFile = async ({
             sourcemap = assetValidity.data.sourcemap
           }
         })
-        updateCompileCache({
-          logger,
-          compiledFileUrl,
-          content,
-          assets,
-          compileResultStatus: "cached",
-        })
         return {
+          isValid: () => getCacheValidity().isValid,
           content,
           sourcemap,
         }
@@ -96,6 +95,7 @@ export const reuseOrCreateCompiledFile = async ({
         compileResultStatus: compileInfoIsValid ? "updated" : "created",
       })
       return {
+        isValid: () => getCacheValidity().isValid,
         content,
         sourcemap,
       }

package/src/compile_cache/update_compile_cache.js

@@ -70,15 +70,15 @@ ${filesRemoved.join(`\n`)}`)
       // was used at some point to ensure the compiled file matches browser etag
       // etag: bufferToEtag(Buffer.from(content)),
       assetInfos,
-      createdMs: Number(Date.now()),
-      lastModifiedMs: Number(Date.now()),
+      createdMs: Date.now(),
+      lastModifiedMs: Date.now(),
     }
   } else if (isUpdated) {
     latestCompileInfo = {
       // was used at some point to ensure the compiled file matches browser etag
       // etag: bufferToEtag(Buffer.from(content)),
       assetInfos,
-      lastModifiedMs: Number(Date.now()),
+      lastModifiedMs: Date.now(),
     }
   }
   logger.debug(

package/src/jsenv_plugin_commonjs.js

@@ -8,16 +8,19 @@ export const jsenvPluginCommonJs = ({
   logLevel,
   include,
 }) => {
-  const associations = URL_META.resolveAssociations(
-    {
-      commonjs: include,
-    },
-    "file://",
-  )
+  let associations
 
   return {
     name,
     appliesDuring: "*",
+    init: ({ rootDirectoryUrl }) => {
+      associations = URL_META.resolveAssociations(
+        {
+          commonjs: include,
+        },
+        rootDirectoryUrl,
+      )
+    },
     redirectUrl: {
       js_import_export: (reference) => {
         const { commonjs } = URL_META.applyAssociations({
@@ -45,7 +48,7 @@ export const jsenvPluginCommonJs = ({
       if (!originalUrlInfo) {
         return null
       }
-      const { content, sourcemap } = await commonJsToJsModule({
+      const { content, sourcemap, isValid } = await commonJsToJsModule({
         logLevel,
         rootDirectoryUrl: context.rootDirectoryUrl,
         sourceFileUrl: originalUrlInfo.url,
@@ -55,6 +58,9 @@ export const jsenvPluginCommonJs = ({
             : "production",
         ...urlInfo.data.commonjs,
       })
+      if (isValid) {
+        urlInfo.isValid = isValid
+      }
       return {
         content,
         contentType: "text/javascript",

package/tests/cjs_cache/cjs_cache.manual_test.mjs

@@ -0,0 +1,17 @@
+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,
+  htmlSupervisor: false,
+})

package/tests/cjs_cache/cjs_cache.test.mjs

@@ -0,0 +1,79 @@
+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,
+  htmlSupervisor: 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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,9 @@
+{
+  "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;"
+}