@inkandswitch/patchwork-bootloader 0.5.4 → 0.6.1

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @inkandswitch/patchwork-bootloader
 
+## 0.6.1
+
+### Patch Changes
+
+- 846cfac: Update the pinned `@automerge/*` versions to `2.6.0-subduction.47`. These are exact pins in `dependencies` and `peerDependencies`, so both packages need to ship the new version together — installing a `.46` and a `.47` package side by side loads two copies of automerge-repo, and document handles from one are not recognised by the other.
+- 61a152a: Make `vite dev` work without a site hand-rolling the dev server.
+
+  The build emits the service worker, the automerge shared worker, the module-loader worker, and three wasm binaries. None of them existed in serve mode, so every one 404'd and dev only worked if a site served a previous production build's `dist/` behind vite. The plugin now serves all of them itself:
+
+  - The three worker entries are bundled on demand with esbuild and rebuilt per request, so they always reflect the source on disk. Their heavy imports resolve to the dev server's optimized-dep URLs, mirroring how the build rewrites them to `/packages/...` — import maps don't apply to `type: "module"` workers, so the URLs have to be real either way.
+  - `automerge.wasm`, `keyhive_wasm.wasm`, and `subduction.wasm` are served from the bootloader's own node_modules. `@inkandswitch/patchwork-bootloader/externals` gains `wasmAssets()`, which `emitWasmAssets` now uses too.
+  - `global.css` 404'd in dev: the generated `index.html` links it by bare specifier, which only the build resolves. Both patchwork's and the bootloader's stylesheets are now served under root-absolute paths, and the link points at them.
+  - `@patchwork/service-worker` called `emitFile` from `buildStart` unconditionally, which throws in serve mode — it logged "This plugin is likely not vite-compatible" three times on every dev-server start. It now skips emission when serving.
+  - Dep pre-bundling runs esbuild outside the plugin pipeline that applies `define`, so in dev the page fell back to the default storage prefix while the workers used the configured one — the two would have opened different IndexedDB databases. The defines are now passed to the optimizer as well.
+
+  Sites no longer need to filter `@patchwork/service-worker` out of the plugin list, serve stylesheets themselves, or keep a built `dist/` around for `vite dev`.
+
+## 0.6.0
+
+### Minor Changes
+
+- 98be594: Namespace IndexedDB and peer ids with a new build-time `storagePrefix` option.
+
+  The tab and the shared automerge worker are separate bundles that must open the same databases. Both now read the name from one place, `@inkandswitch/patchwork-bootloader/storage`, resolved from the `__STORAGE_PREFIX__` define the vite plugin emits unconditionally.
+
+  Previously each side resolved `__SITE_NAME__` itself with a different fallback — `"patchwork.inkandswitch.com"` in the worker, `"patchwork"` in the tab — so a site that never set `siteName` had its tab and worker on two different keyhive databases, and one that passed `setup({name})` split them the same way, since a runtime option never reaches the worker.
+
+  - `storagePrefix` defaults to `"patchwork"` and is settable only in the build config. Sites sharing an origin must use distinct prefixes. It is deliberately not derived from any display name: changing it points a site at empty storage, so a rebrand must not be able to change it by accident.
+  - Sites that relied on `siteName` to namespace their storage must now set `storagePrefix` explicitly to that same value to keep their existing databases.
+  - `createRepo` in `@inkandswitch/patchwork` no longer takes a site name argument.
+
 ## 0.5.4
 
 ### Patch Changes

package/dist/automerge-worker.js

@@ -19,10 +19,8 @@ import { MessageChannelNetworkAdapter } from "@automerge/automerge-repo-network-
 import { WebSocketWorkerClientAdapter } from "@automerge/automerge-repo-network-websocket";
 import { initializeAutomergeRepoKeyhiveRustWithRepo, initKeyhiveWasm, } from "@automerge/automerge-repo-keyhive";
 import { DEFAULT_CLASSIC_SYNC_SERVER } from "./sync-config.js";
+import { keyhiveStorageName, storagePrefix } from "./storage.js";
 import { HANDOFF_CHANNEL, SYNCSTATE_CHANNEL, } from "./types.js";
-const siteName = typeof __SITE_NAME__ !== "undefined"
-    ? __SITE_NAME__
-    : "patchwork.inkandswitch.com";
 const syncServer = typeof __SYNC_SERVER__ !== "undefined"
     ? __SYNC_SERVER__
     : { url: "wss://subduction.sync.inkandswitch.com" };
@@ -210,8 +208,8 @@ async function buildKeyhiveRepo(keyhiveSyncServer) {
     initKeyhiveWasm();
     const { hive, repo } = await initializeAutomergeRepoKeyhiveRustWithRepo({
         createRepo: (config) => new Repo(config),
-        storage: new IndexedDBWorkerStorageAdapter(`${siteName}-keyhive`),
-        peerIdSuffix: `${siteName}-worker` + Math.random().toString(36).slice(2),
+        storage: new IndexedDBWorkerStorageAdapter(keyhiveStorageName),
+        peerIdSuffix: `${storagePrefix}-worker` + Math.random().toString(36).slice(2),
         automaticArchiveIngestion: true,
         cachingMode: "periodic",
         // ARK selects the relay via `syncServer`, which pairs the contact card with

package/dist/externals.d.ts

@@ -12,5 +12,14 @@ export { default } from "./externals-list.js";
  * up at bundle time. rollup applies the browser conditions vite configured.
  */
 export declare function resolveExternal(this: import("rollup").PluginContext, name: string): Promise<string>;
+/**
+ * automerge/keyhive/subduction's wasm binaries, by the file name the service
+ * worker fetches them under. Resolved from this package's node_modules for the
+ * same reason as {@link resolveExternal}.
+ */
+export declare function wasmAssets(): {
+    fileName: string;
+    path: string;
+}[];
 /** Emits automerge/keyhive/subduction's wasm binaries as build assets, so the service worker can fetch them. */
 export declare function emitWasmAssets(this: import("rollup").PluginContext): void;

package/dist/externals.js

@@ -29,24 +29,34 @@ export async function resolveExternal(name) {
     }
     return resolved.id;
 }
+/**
+ * automerge/keyhive/subduction's wasm binaries, by the file name the service
+ * worker fetches them under. Resolved from this package's node_modules for the
+ * same reason as {@link resolveExternal}.
+ */
+export function wasmAssets() {
+    return [
+        {
+            fileName: "automerge.wasm",
+            path: require.resolve("@automerge/automerge/automerge.wasm"),
+        },
+        {
+            fileName: "keyhive_wasm.wasm",
+            path: require.resolve("@keyhive/keyhive/keyhive_wasm.wasm"),
+        },
+        {
+            fileName: "subduction.wasm",
+            path: require.resolve("@automerge/automerge-subduction/wasm"),
+        },
+    ];
+}
 /** Emits automerge/keyhive/subduction's wasm binaries as build assets, so the service worker can fetch them. */
 export function emitWasmAssets() {
-    const automergeWasmPath = require.resolve("@automerge/automerge/automerge.wasm");
-    this.emitFile({
-        type: "asset",
-        fileName: "automerge.wasm",
-        source: readFileSync(automergeWasmPath),
-    });
-    const keyhiveWasmPath = require.resolve("@keyhive/keyhive/keyhive_wasm.wasm");
-    this.emitFile({
-        type: "asset",
-        fileName: "keyhive_wasm.wasm",
-        source: readFileSync(keyhiveWasmPath),
-    });
-    const subdWasmPath = require.resolve("@automerge/automerge-subduction/wasm");
-    this.emitFile({
-        type: "asset",
-        fileName: "subduction.wasm",
-        source: readFileSync(subdWasmPath),
-    });
+    for (const { fileName, path } of wasmAssets()) {
+        this.emitFile({
+            type: "asset",
+            fileName,
+            source: readFileSync(path),
+        });
+    }
 }

package/dist/storage.d.ts

@@ -0,0 +1,8 @@
+export declare const DEFAULT_STORAGE_PREFIX = "patchwork";
+/**
+ * Namespace for this site's IndexedDB databases and peer ids. The tab and the
+ * shared automerge worker are separate bundles that must open the same
+ * databases, and this module is the single place either of them gets the name.
+ */
+export declare const storagePrefix: string;
+export declare const keyhiveStorageName: string;

package/dist/storage.js

@@ -0,0 +1,10 @@
+export const DEFAULT_STORAGE_PREFIX = "patchwork";
+/**
+ * Namespace for this site's IndexedDB databases and peer ids. The tab and the
+ * shared automerge worker are separate bundles that must open the same
+ * databases, and this module is the single place either of them gets the name.
+ */
+export const storagePrefix = typeof __STORAGE_PREFIX__ !== "undefined"
+    ? __STORAGE_PREFIX__
+    : DEFAULT_STORAGE_PREFIX;
+export const keyhiveStorageName = `${storagePrefix}-keyhive`;

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+https://github.com/inkandswitch/patchwork-system.git",
     "directory": "core/bootloader"
   },
-  "version": "0.5.4",
+  "version": "0.6.1",
   "author": "chee",
   "type": "module",
   "license": "MIT",
@@ -26,6 +26,10 @@
       "import": "./dist/externals-list.js",
       "types": "./dist/externals-list.d.ts"
     },
+    "./storage": {
+      "import": "./dist/storage.js",
+      "types": "./dist/storage.d.ts"
+    },
     "./service-worker": {
       "import": "./dist/service-worker.js",
       "types": "./dist/service-worker.d.ts"
@@ -50,13 +54,13 @@
   },
   "dependencies": {
     "@automerge/automerge": "3.3.2",
-    "@automerge/automerge-repo": "2.6.0-subduction.46",
+    "@automerge/automerge-repo": "2.6.0-subduction.47",
     "@automerge/automerge-repo-keyhive": "0.3.0-alpha.sub.8b",
-    "@automerge/automerge-repo-network-messagechannel": "2.6.0-subduction.46",
-    "@automerge/automerge-repo-network-websocket": "2.6.0-subduction.46",
-    "@automerge/automerge-repo-storage-indexeddb": "2.6.0-subduction.46",
+    "@automerge/automerge-repo-network-messagechannel": "2.6.0-subduction.47",
+    "@automerge/automerge-repo-network-websocket": "2.6.0-subduction.47",
+    "@automerge/automerge-repo-storage-indexeddb": "2.6.0-subduction.47",
     "@automerge/automerge-subduction": "0.16.0",
-    "@automerge/vanillajs": "2.6.0-subduction.46",
+    "@automerge/vanillajs": "2.6.0-subduction.47",
     "@codemirror/commands": "^6.10.4",
     "@codemirror/language": "^6.12.4",
     "@codemirror/state": "^6.7.1",
@@ -70,14 +74,14 @@
     "tinyargs": "^0.1.4",
     "@inkandswitch/patchwork-elements": "^6.0.0",
     "@inkandswitch/patchwork-filesystem": "^0.2.5",
-    "@inkandswitch/patchwork-plugins": "^1.1.0",
+    "@inkandswitch/patchwork-plugins": "^1.2.0",
     "@inkandswitch/patchwork-providers": "^0.5.0"
   },
   "peerDependencies": {
     "@automerge/automerge": "3.3.2",
-    "@automerge/automerge-repo": "2.6.0-subduction.46",
+    "@automerge/automerge-repo": "2.6.0-subduction.47",
     "@automerge/automerge-repo-keyhive": "0.3.0-alpha.sub.8b",
-    "@automerge/vanillajs": "2.6.0-subduction.46"
+    "@automerge/vanillajs": "2.6.0-subduction.47"
   },
   "peerDependenciesMeta": {
     "@automerge/automerge": {

package/src/automerge-worker.ts

@@ -38,6 +38,7 @@ import {
 } from "@automerge/automerge-repo-keyhive";
 
 import { DEFAULT_CLASSIC_SYNC_SERVER } from "./sync-config.js";
+import { keyhiveStorageName, storagePrefix } from "./storage.js";
 import {
   HANDOFF_CHANNEL,
   SYNCSTATE_CHANNEL,
@@ -52,16 +53,11 @@ import {
   type SyncStateRequestMessage,
 } from "./types.js";
 
-declare const __SITE_NAME__: string;
 declare const __SYNC_SERVER__: {
   url: string;
   keyhive?: SyncServerSelection;
 };
 
-const siteName =
-  typeof __SITE_NAME__ !== "undefined"
-    ? __SITE_NAME__
-    : "patchwork.inkandswitch.com";
 const syncServer =
   typeof __SYNC_SERVER__ !== "undefined"
     ? __SYNC_SERVER__
@@ -288,8 +284,9 @@ async function buildKeyhiveRepo(
   initKeyhiveWasm();
   const { hive, repo } = await initializeAutomergeRepoKeyhiveRustWithRepo({
     createRepo: (config) => new Repo(config),
-    storage: new IndexedDBWorkerStorageAdapter(`${siteName}-keyhive`),
-    peerIdSuffix: `${siteName}-worker` + Math.random().toString(36).slice(2),
+    storage: new IndexedDBWorkerStorageAdapter(keyhiveStorageName),
+    peerIdSuffix:
+      `${storagePrefix}-worker` + Math.random().toString(36).slice(2),
     automaticArchiveIngestion: true,
     cachingMode: "periodic",
     // ARK selects the relay via `syncServer`, which pairs the contact card with

package/src/externals.ts

@@ -39,30 +39,35 @@ export async function resolveExternal(
   return resolved.id;
 }
 
+/**
+ * automerge/keyhive/subduction's wasm binaries, by the file name the service
+ * worker fetches them under. Resolved from this package's node_modules for the
+ * same reason as {@link resolveExternal}.
+ */
+export function wasmAssets(): { fileName: string; path: string }[] {
+  return [
+    {
+      fileName: "automerge.wasm",
+      path: require.resolve("@automerge/automerge/automerge.wasm"),
+    },
+    {
+      fileName: "keyhive_wasm.wasm",
+      path: require.resolve("@keyhive/keyhive/keyhive_wasm.wasm"),
+    },
+    {
+      fileName: "subduction.wasm",
+      path: require.resolve("@automerge/automerge-subduction/wasm"),
+    },
+  ];
+}
+
 /** Emits automerge/keyhive/subduction's wasm binaries as build assets, so the service worker can fetch them. */
 export function emitWasmAssets(this: import("rollup").PluginContext): void {
-  const automergeWasmPath = require.resolve(
-    "@automerge/automerge/automerge.wasm"
-  );
-  this.emitFile({
-    type: "asset",
-    fileName: "automerge.wasm",
-    source: readFileSync(automergeWasmPath),
-  });
-
-  const keyhiveWasmPath = require.resolve(
-    "@keyhive/keyhive/keyhive_wasm.wasm"
-  );
-  this.emitFile({
-    type: "asset",
-    fileName: "keyhive_wasm.wasm",
-    source: readFileSync(keyhiveWasmPath),
-  });
-
-  const subdWasmPath = require.resolve("@automerge/automerge-subduction/wasm");
-  this.emitFile({
-    type: "asset",
-    fileName: "subduction.wasm",
-    source: readFileSync(subdWasmPath),
-  });
+  for (const { fileName, path } of wasmAssets()) {
+    this.emitFile({
+      type: "asset",
+      fileName,
+      source: readFileSync(path),
+    });
+  }
 }

package/src/storage.ts

@@ -0,0 +1,15 @@
+declare const __STORAGE_PREFIX__: string;
+
+export const DEFAULT_STORAGE_PREFIX = "patchwork";
+
+/**
+ * Namespace for this site's IndexedDB databases and peer ids. The tab and the
+ * shared automerge worker are separate bundles that must open the same
+ * databases, and this module is the single place either of them gets the name.
+ */
+export const storagePrefix =
+  typeof __STORAGE_PREFIX__ !== "undefined"
+    ? __STORAGE_PREFIX__
+    : DEFAULT_STORAGE_PREFIX;
+
+export const keyhiveStorageName = `${storagePrefix}-keyhive`;