@crxjs/vite-plugin 2.0.0-beta.11 → 2.0.0-beta.13

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { simple } from 'acorn-walk';
 import { createHash } from 'crypto';
-import debug$2 from 'debug';
+import debug$3 from 'debug';
 import v8 from 'v8';
 import { posix } from 'path';
 import { Subject, filter, ReplaySubject, switchMap, of, startWith, map, mergeMap, firstValueFrom, takeUntil, first, toArray, retry, concatWith, Subscription, buffer } from 'rxjs';
@@ -24,8 +24,10 @@ const pluginOptionsProvider = (options) => {
     name: pluginName$1,
     api: {
       crx: {
+        // during testing this can be null, we don't provide options through the test config
         options
       }
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
     }
   };
 };
@@ -58,7 +60,7 @@ function isCrxPlugin(p) {
 
 var workerHmrClient = "const ownOrigin = new URL(chrome.runtime.getURL(\"/\")).origin;\nself.addEventListener(\"fetch\", (fetchEvent) => {\n  const url = new URL(fetchEvent.request.url);\n  if (url.origin === ownOrigin) {\n    fetchEvent.respondWith(sendToServer(url));\n  }\n});\nasync function sendToServer(url) {\n  url.protocol = \"http:\";\n  url.host = \"localhost\";\n  url.port = __SERVER_PORT__;\n  url.searchParams.set(\"t\", Date.now().toString());\n  const response = await fetch(url.href.replace(/=$|=(?=&)/g, \"\"));\n  return new Response(response.body, {\n    headers: {\n      \"Content-Type\": response.headers.get(\"Content-Type\") ?? \"text/javascript\"\n    }\n  });\n}\nconst ports = /* @__PURE__ */ new Set();\nchrome.runtime.onConnect.addListener((port) => {\n  if (port.name === \"@crx/client\") {\n    ports.add(port);\n    port.onDisconnect.addListener((port2) => ports.delete(port2));\n    port.onMessage.addListener((message) => {\n    });\n    port.postMessage({ data: JSON.stringify({ type: \"connected\" }) });\n  }\n});\nfunction notifyContentScripts(payload) {\n  const data = JSON.stringify(payload);\n  for (const port of ports)\n    port.postMessage({ data });\n}\nconsole.log(\"[vite] connecting...\");\nconst socketProtocol = __HMR_PROTOCOL__ || (location.protocol === \"https:\" ? \"wss\" : \"ws\");\nconst socketHost = `${__HMR_HOSTNAME__ || location.hostname}:${__HMR_PORT__}`;\nconst socket = new WebSocket(`${socketProtocol}://${socketHost}`, \"vite-hmr\");\nconst base = __BASE__ || \"/\";\nsocket.addEventListener(\"message\", async ({ data }) => {\n  handleSocketMessage(JSON.parse(data));\n});\nfunction isCrxHmrPayload(x) {\n  return x.type === \"custom\" && x.event.startsWith(\"crx:\");\n}\nfunction handleSocketMessage(payload) {\n  if (isCrxHmrPayload(payload)) {\n    handleCrxHmrPayload(payload);\n  } else if (payload.type === \"connected\") {\n    console.log(`[vite] connected.`);\n    const interval = setInterval(() => socket.send(\"ping\"), __HMR_TIMEOUT__);\n    socket.addEventListener(\"close\", () => clearInterval(interval));\n  }\n}\nfunction handleCrxHmrPayload(payload) {\n  notifyContentScripts(payload);\n  switch (payload.event) {\n    case \"crx:runtime-reload\":\n      console.log(\"[crx] runtime reload\");\n      chrome.runtime.reload();\n      break;\n  }\n}\nasync function waitForSuccessfulPing(ms = 1e3) {\n  while (true) {\n    try {\n      await fetch(`${base}__vite_ping`);\n      break;\n    } catch (e) {\n      await new Promise((resolve) => setTimeout(resolve, ms));\n    }\n  }\n}\nsocket.addEventListener(\"close\", async ({ wasClean }) => {\n  if (wasClean)\n    return;\n  console.log(`[vite] server connection lost. polling for restart...`);\n  await waitForSuccessfulPing();\n  handleCrxHmrPayload({\n    type: \"custom\",\n    event: \"crx:runtime-reload\"\n  });\n});\n";
 
-const _debug = (id) => debug$2("crx").extend(id);
+const _debug = (id) => debug$3("crx").extend(id);
 const structuredClone = (obj) => {
   return v8.deserialize(v8.serialize(obj));
 };
@@ -204,7 +206,7 @@ function formatFileData(script) {
   return script;
 }
 function getFileName({ type, id }) {
-  let fileName = id.replace(/t=\d+&/, "").replace(/^\//, "").replace(/\?/g, "__").replace(/&/g, "_").replace(/=/g, "--");
+  let fileName = id.replace(/t=\d+&/, "").replace(/\?t=\d+$/, "").replace(/^\//, "").replace(/\?/g, "__").replace(/&/g, "_").replace(/=/g, "--");
   if (fileName.includes("node_modules/")) {
     fileName = `vendor/${fileName.split("node_modules/").pop().replace(/\//g, "-")}`;
   } else if (fileName.startsWith("@")) {
@@ -292,6 +294,7 @@ const pluginBackground = () => {
     },
     {
       name: "crx:background-loader-file",
+      // this should happen after other plugins; the loader file is an implementation detail
       enforce: "post",
       configResolved(_config) {
         config = _config;
@@ -318,6 +321,7 @@ const pluginBackground = () => {
         }
         const refId = this.emitFile({
           type: "asset",
+          // fileName b/c service worker must be at root of crx
           fileName: getFileName({ type: "loader", id: "service-worker" }),
           source: loader
         });
@@ -426,6 +430,7 @@ function prepAsset(fileName, { id, source }) {
 }
 function prepScript(fileName, script) {
   return ($) => $.pipe(
+    // get script contents from dev server
     mergeMap(async ({ server }) => {
       const target = getOutputPath(server, fileName);
       const viteUrl = getViteUrl(script);
@@ -435,7 +440,9 @@ function prepScript(fileName, script) {
       const { code, deps = [], dynamicDeps = [] } = transformResult;
       return { target, code, deps: [...deps, ...dynamicDeps].flat(), server };
     }),
+    // retry in case of dependency rebundle
     retry({ count: 10, delay: 100 }),
+    // patch content scripts
     mergeMap(async ({ target, server, ...rest }) => {
       const plugins = server.config.plugins;
       let { code, deps } = rest;
@@ -451,10 +458,14 @@ function prepScript(fileName, script) {
       const [imports] = lexer.parse(code, fileName);
       const depSet = new Set(deps);
       const magic = new MagicString(code);
+      const now = Date.now();
       for (const i of imports)
         if (i.n) {
           depSet.add(i.n);
-          const fileName2 = getFileName({ type: "module", id: i.n });
+          let fileName2 = getFileName({ type: "module", id: i.n });
+          if (!fileName2.startsWith("vendor")) {
+            fileName2 = `${fileName2}?t=${now}`;
+          }
           const fullImport = code.substring(i.s, i.e);
           magic.overwrite(i.s, i.e, fullImport.replace(i.n, `/${fileName2}`));
         }
@@ -466,7 +477,7 @@ async function allFilesReady() {
   await firstValueFrom(allFilesReady$);
 }
 
-const { outputFile } = fsx;
+const { outputFile, remove } = fsx;
 _debug("file-writer");
 async function start({
   server
@@ -487,6 +498,8 @@ async function start({
     dir: outDir,
     format: "es"
   };
+  if (server.config.build.emptyOutDir)
+    await remove(server.config.build.outDir);
   fileWriterEvent$.next({ type: "build_start" });
   const build = await rollup(inputOptions);
   await build.write(outputOptions);
@@ -527,8 +540,11 @@ function update(_id) {
 async function write(fileId) {
   const start2 = performance.now();
   const deps = await firstValueFrom(
+    // wait for start event
     start$.pipe(
+      // prepare either asset or script contents
       prepFileData(fileId),
+      // output file and add dependencies to file writer
       mergeMap(async ({ target, source, deps: deps2 }) => {
         const files = deps2.map((id) => {
           const r = [add({ id, type: "module" })];
@@ -544,6 +560,7 @@ async function write(fileId) {
           await outputFile(target, source, { encoding: "utf8" });
         return files;
       }),
+      // abort write operation on close event
       takeUntil(close$),
       concatWith(of([]))
     )
@@ -816,6 +833,12 @@ const pluginDynamicContentScripts = () => {
     {
       name: "crx:dynamic-content-scripts-build",
       apply: "build",
+      /**
+       * Replace dynamic script placeholders during build.
+       *
+       * Can't use `renderChunk` b/c pre plugin crx:content-scripts uses
+       * `generateBundle` to emit loaders. Must come after "enforce: pre".
+       */
       generateBundle(options, bundle) {
         for (const chunk of Object.values(bundle))
           if (chunk.type === "chunk") {
@@ -982,11 +1005,13 @@ const pluginFileWriterPublic = () => {
   };
 };
 
-_debug("file-writer").extend("hmr");
-const isCrxHMRPayload = (p) => p.type === "custom" && p.event.startsWith("crx:");
+const debug$2 = _debug("file-writer").extend("hmr");
+const isCustomPayload = (p) => {
+  return p.type === "custom";
+};
 const hmrPayload$ = new Subject();
 const crxHMRPayload$ = hmrPayload$.pipe(
-  filter((p) => !isCrxHMRPayload(p)),
+  filter((p) => !isCustomPayload(p)),
   buffer(allFilesReady$),
   mergeMap((pps) => {
     let fullReload;
@@ -1045,6 +1070,7 @@ const crxHMRPayload$ = hmrPayload$.pipe(
     }
   }),
   map((data) => {
+    debug$2(`hmr payload`, data);
     return {
       type: "custom",
       event: "crx:content-script-payload",
@@ -1084,6 +1110,7 @@ const pluginHMR = () => {
       name: "crx:hmr",
       apply: "serve",
       enforce: "pre",
+      // server hmr host should be localhost
       async config({ server = {}, ...config2 }) {
         if (server.hmr === false)
           return;
@@ -1093,6 +1120,7 @@ const pluginHMR = () => {
         server.hmr.host = "localhost";
         return { server, ...config2 };
       },
+      // server should ignore outdir
       configResolved(_config) {
         config = _config;
         const { watch = {} } = config.server;
@@ -1130,6 +1158,7 @@ const pluginHMR = () => {
       closeBundle() {
         subs.unsubscribe();
       },
+      // background changes require a full extension reload
       handleHotUpdate({ modules, server }) {
         const { root } = server.config;
         const relFiles = /* @__PURE__ */ new Set();
@@ -1157,6 +1186,7 @@ const pluginHMR = () => {
       name: "crx:hmr",
       apply: "serve",
       enforce: "post",
+      // get final output manifest for handleHotUpdate 👆
       async transformCrxManifest(manifest) {
         inputManifestFiles = await manifestFiles(manifest, { cwd: config.root });
         return null;
@@ -1247,6 +1277,7 @@ const pluginHtmlInlineScripts = () => {
   };
   const postPlugin = {
     name: "crx:html-auditor-post",
+    // this hook isn't audited b/c we add it after we set up the auditors
     transformIndexHtml(html, ctx) {
       const key = toKey(ctx);
       const p = pages.get(key);
@@ -1591,6 +1622,7 @@ Public dir: "${config.publicDir}"`
               this.emitFile({
                 type: "asset",
                 fileName: f,
+                // TODO: cache source buffer
                 source: await readFile(filename)
               });
             }
@@ -1703,8 +1735,11 @@ const pluginWebAccessibleResources = () => {
           ...rest
         })).filter(({ resources }) => resources.length);
         manifest.web_accessible_resources.push({
+          // change the extension origin on every reload
           use_dynamic_url: true,
+          // all web origins can access
           matches: ["<all_urls>"],
+          // all resources are web accessible
           resources: ["**/*", "*"]
         });
         return manifest;
@@ -1834,6 +1869,7 @@ const pluginWebAccessibleResources = () => {
 };
 
 const crx = (options) => {
+  contentScripts.clear();
   return [
     pluginOptionsProvider(options),
     pluginBackground(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crxjs/vite-plugin",
-  "version": "2.0.0-beta.11",
+  "version": "2.0.0-beta.13",
   "description": "Build Chrome Extensions with this Vite plugin.",
   "keywords": [
     "rollup-plugin",
@@ -101,7 +101,7 @@
     "@vitejs/plugin-react": "^2.1.0",
     "@vitejs/plugin-vue": "3.2.0",
     "chokidar": "^3.5.3",
-    "esbuild": "0.15.16",
+    "esbuild": "0.17.4",
     "esbuild-runner": "2.2.2",
     "eslint": "8.26.0",
     "eslint-plugin-react": "^7.29.4",
@@ -116,8 +116,8 @@
     "svelte": "^3.48.0",
     "typescript": "^4.6.4",
     "vite": "^3.1.7",
-    "vite-plugin-inspect": "0.7.5",
-    "vitest": "0.24.3",
+    "vite-plugin-inspect": "0.7.14",
+    "vitest": "0.28.5",
     "vue": "3.2.41"
   }
 }