@inkandswitch/patchwork-bootloader 0.5.4 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @inkandswitch/patchwork-bootloader
 
+## 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/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.0",
   "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"
@@ -68,10 +72,10 @@
     "service-worker-types": "npm:@types/serviceworker@^0.0.153",
     "solid-js": "^1.9.13",
     "tinyargs": "^0.1.4",
-    "@inkandswitch/patchwork-elements": "^6.0.0",
     "@inkandswitch/patchwork-filesystem": "^0.2.5",
-    "@inkandswitch/patchwork-plugins": "^1.1.0",
-    "@inkandswitch/patchwork-providers": "^0.5.0"
+    "@inkandswitch/patchwork-providers": "^0.5.0",
+    "@inkandswitch/patchwork-plugins": "^1.2.0",
+    "@inkandswitch/patchwork-elements": "^6.0.0"
   },
   "peerDependencies": {
     "@automerge/automerge": "3.3.2",

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/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`;