@inkandswitch/patchwork 0.7.0 → 0.7.2

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @inkandswitch/patchwork
 
+## 0.7.2
+
+### Patch Changes
+
+- e1374ad: Serve the `/packages/…` builtin URLs in dev. Import maps don't apply to worker
+  scripts, so code that starts one — `@automerge/automerge-repo`'s shared
+  subduction websocket worker, for instance — asks for the `/packages/…` path the
+  build emits. Nothing served those in dev, and the worker failed to fetch; the
+  dev server now redirects them to the same optimized dep the page's import map
+  points at.
+- e1374ad: Say what's actually wrong when a `static` package declares a directory that
+  isn't there. The package resolved fine — its `"patchwork": {"static": …}` field
+  is what's wrong — and "static source not found" named neither the field nor the
+  path it pointed at. The error now quotes the declaration, gives the full path
+  that's missing, and says that a package publishing its static tree as the root
+  of its own tarball shouldn't set the field at all.
+
+## 0.7.1
+
+### Patch Changes
+
+- 8b9206d: Don't copy `static` sources or write `build-info.json` when a dev server shuts
+  down. `closeBundle` runs then too, so stopping `vite` was filling `dist/` with
+  a copy of every static source.
+
 ## 0.7.0
 
 ### Minor Changes

package/dist/vite/build-info-plugin.js

@@ -42,13 +42,17 @@ export function buildInfoPlugin(options = {}) {
         return null;
     let root;
     let outDir;
+    let serve = false;
     return {
         name: "@patchwork/build-info",
         configResolved(config) {
             root = config.root;
             outDir = join(config.root, config.build.outDir);
+            serve = config.command === "serve";
         },
         async closeBundle() {
+            if (serve)
+                return;
             const sources = resolveStatic(options, root).map((source) => source.packageDirectory
                 ? { from: source.from, ...describe(source.packageDirectory) }
                 : { from: source.from, revision: revision(source.path) });

package/dist/vite/dev-plugin.js

@@ -14,6 +14,7 @@ const stylesheets = {
     [PATCHWORK_CSS]: fileURLToPath(import.meta.resolve("@inkandswitch/patchwork/global.css")),
     [BOOTLOADER_CSS]: fileURLToPath(import.meta.resolve("@inkandswitch/patchwork-bootloader/global.css")),
 };
+const builtinPaths = new Map(Object.entries(builtins).map(([id, fileName]) => [fileName, id]));
 /**
  * Workers are `type: "module"` scripts the browser fetches directly, so import
  * maps don't apply to them and their heavy imports have to resolve to real
@@ -92,6 +93,17 @@ export function devPlugin(options = {}) {
                     }
                     return;
                 }
+                // A worker script is fetched by URL, and import maps don't apply to
+                // those, so code that starts one reaches for the /packages/… path the
+                // build emits. In dev those are the optimized deps the page's import
+                // map points at — same module, one URL over.
+                const builtin = builtinPaths.get(pathname);
+                if (builtin) {
+                    response.statusCode = 302;
+                    response.setHeader("Location", `/@id/${encodeURI(devDependencyId(builtin))}`);
+                    response.end();
+                    return;
+                }
                 const binary = wasm.get(pathname);
                 if (binary) {
                     try {

package/dist/vite/static-plugin.d.ts

@@ -7,7 +7,8 @@ import type { PatchworkVitePluginOptions } from "./patchwork-plugin.js";
  * `from` is either a package specifier or a path relative to the site root. A
  * package says where its static tree lives with a `"patchwork": {"static":
  * "static-dist"}` field in its own package.json; without one, the whole
- * package directory is mounted.
+ * package directory is mounted — which is what a package that publishes its
+ * static tree as the root of its own tarball wants.
  */
 export interface PatchworkStaticSource {
     from: string;

package/dist/vite/static-plugin.js

@@ -34,17 +34,28 @@ function packageDirectory(name, root) {
         throw new Error(`[patchwork] can't find the package "${name}" — a static source has to be a dependency of the site`);
     }
 }
+/** A package's static tree: the directory it declares, or its root. */
+function staticDirectory(name, directory) {
+    const declared = JSON.parse(readFileSync(join(directory, "package.json"), "utf8")).patchwork?.static;
+    if (!declared)
+        return directory;
+    const path = join(directory, declared);
+    if (!existsSync(path)) {
+        throw new Error(`[patchwork] ${name} declares "patchwork": {"static": ${JSON.stringify(declared)}}, but ${path} doesn't exist. ` +
+            `The field is a path inside the installed package — a package that publishes its static tree as the tarball's own root shouldn't set it at all.`);
+    }
+    return path;
+}
 export function resolveStatic(options, root) {
     return (options.static ?? []).map((source) => {
         const entry = typeof source === "string" ? { from: source } : source;
         const isPath = entry.from.startsWith(".") || isAbsolute(entry.from);
         const directory = isPath ? undefined : packageDirectory(entry.from, root);
         const path = directory
-            ? join(directory, JSON.parse(readFileSync(join(directory, "package.json"), "utf8"))
-                .patchwork?.static ?? ".")
+            ? staticDirectory(entry.from, directory)
             : resolve(root, entry.from);
         if (!existsSync(path)) {
-            throw new Error(`[patchwork] static source not found: ${entry.from}`);
+            throw new Error(`[patchwork] static source not found: ${entry.from} (${path})`);
         }
         const file = statSync(path).isFile();
         const to = entry.to ?? "/";
@@ -112,6 +123,7 @@ export function staticPlugin(options = {}) {
     let root;
     let outDir;
     let base = "/";
+    let serve = false;
     let logger;
     return {
         name: "@patchwork/static",
@@ -120,9 +132,13 @@ export function staticPlugin(options = {}) {
             root = config.root;
             outDir = resolve(config.root, config.build.outDir);
             base = config.base;
+            serve = config.command === "serve";
             logger = config.logger;
         },
         async closeBundle() {
+            // also called when a dev server shuts down, which has nothing to copy
+            if (serve)
+                return;
             for (const source of sources) {
                 const paths = source.file ? [""] : await files(source.path);
                 const kept = [];

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+https://github.com/inkandswitch/patchwork-system.git",
     "directory": "core/patchwork"
   },
-  "version": "0.7.0",
+  "version": "0.7.2",
   "author": "Ink & Switch",
   "type": "module",
   "license": "MIT",
@@ -44,10 +44,10 @@
     "sharp": "^0.35.3",
     "vite-plugin-wasm": "^3.6.0",
     "@inkandswitch/patchwork-bootloader": "^0.6.2",
+    "@inkandswitch/patchwork-elements": "^6.0.0",
     "@inkandswitch/patchwork-filesystem": "^0.2.5",
-    "@inkandswitch/patchwork-plugins": "^1.2.0",
     "@inkandswitch/patchwork-providers": "^0.5.0",
-    "@inkandswitch/patchwork-elements": "^6.0.0"
+    "@inkandswitch/patchwork-plugins": "^1.2.0"
   },
   "devDependencies": {
     "rollup": "^4.61.1",

package/src/vite/build-info-plugin.ts

@@ -49,13 +49,16 @@ export function buildInfoPlugin(
   if (!options.buildInfo) return null;
   let root: string;
   let outDir: string;
+  let serve = false;
   return {
     name: "@patchwork/build-info",
     configResolved(config) {
       root = config.root;
       outDir = join(config.root, config.build.outDir);
+      serve = config.command === "serve";
     },
     async closeBundle() {
+      if (serve) return;
       const sources = resolveStatic(options, root).map((source) =>
         source.packageDirectory
           ? { from: source.from, ...describe(source.packageDirectory) }

package/src/vite/dev-plugin.ts

@@ -23,6 +23,10 @@ const stylesheets: Record<string, string> = {
   ),
 };
 
+const builtinPaths = new Map(
+  Object.entries(builtins).map(([id, fileName]) => [fileName, id])
+);
+
 /**
  * Workers are `type: "module"` scripts the browser fetches directly, so import
  * maps don't apply to them and their heavy imports have to resolve to real
@@ -117,6 +121,21 @@ export function devPlugin(options: PatchworkVitePluginOptions = {}): Plugin {
           return;
         }
 
+        // A worker script is fetched by URL, and import maps don't apply to
+        // those, so code that starts one reaches for the /packages/… path the
+        // build emits. In dev those are the optimized deps the page's import
+        // map points at — same module, one URL over.
+        const builtin = builtinPaths.get(pathname);
+        if (builtin) {
+          response.statusCode = 302;
+          response.setHeader(
+            "Location",
+            `/@id/${encodeURI(devDependencyId(builtin))}`
+          );
+          response.end();
+          return;
+        }
+
         const binary = wasm.get(pathname);
         if (binary) {
           try {

package/src/vite/static-plugin.ts

@@ -22,7 +22,8 @@ import type { PatchworkVitePluginOptions } from "./patchwork-plugin.js";
  * `from` is either a package specifier or a path relative to the site root. A
  * package says where its static tree lives with a `"patchwork": {"static":
  * "static-dist"}` field in its own package.json; without one, the whole
- * package directory is mounted.
+ * package directory is mounted — which is what a package that publishes its
+ * static tree as the root of its own tarball wants.
  */
 export interface PatchworkStaticSource {
   from: string;
@@ -87,6 +88,22 @@ function packageDirectory(name: string, root: string) {
   }
 }
 
+/** A package's static tree: the directory it declares, or its root. */
+function staticDirectory(name: string, directory: string) {
+  const declared = JSON.parse(
+    readFileSync(join(directory, "package.json"), "utf8")
+  ).patchwork?.static;
+  if (!declared) return directory;
+  const path = join(directory, declared);
+  if (!existsSync(path)) {
+    throw new Error(
+      `[patchwork] ${name} declares "patchwork": {"static": ${JSON.stringify(declared)}}, but ${path} doesn't exist. ` +
+        `The field is a path inside the installed package — a package that publishes its static tree as the tarball's own root shouldn't set it at all.`
+    );
+  }
+  return path;
+}
+
 export function resolveStatic(
   options: PatchworkVitePluginOptions,
   root: string
@@ -96,14 +113,12 @@ export function resolveStatic(
     const isPath = entry.from.startsWith(".") || isAbsolute(entry.from);
     const directory = isPath ? undefined : packageDirectory(entry.from, root);
     const path = directory
-      ? join(
-          directory,
-          JSON.parse(readFileSync(join(directory, "package.json"), "utf8"))
-            .patchwork?.static ?? "."
-        )
+      ? staticDirectory(entry.from, directory)
       : resolve(root, entry.from);
     if (!existsSync(path)) {
-      throw new Error(`[patchwork] static source not found: ${entry.from}`);
+      throw new Error(
+        `[patchwork] static source not found: ${entry.from} (${path})`
+      );
     }
     const file = statSync(path).isFile();
     const to = entry.to ?? "/";
@@ -170,6 +185,7 @@ export function staticPlugin(
   let root: string;
   let outDir: string;
   let base = "/";
+  let serve = false;
   let logger: Logger;
   return {
     name: "@patchwork/static",
@@ -178,9 +194,12 @@ export function staticPlugin(
       root = config.root;
       outDir = resolve(config.root, config.build.outDir);
       base = config.base;
+      serve = config.command === "serve";
       logger = config.logger;
     },
     async closeBundle() {
+      // also called when a dev server shuts down, which has nothing to copy
+      if (serve) return;
       for (const source of sources) {
         const paths = source.file ? [""] : await files(source.path);
         const kept: string[] = [];