@inkandswitch/patchwork-bootloader 0.2.5 → 0.2.7

package/dist/site.d.ts

@@ -2,37 +2,36 @@
  * High-level browser-app boot sequence for a Patchwork site.
  *
  * Layers on top of {@link setupServiceWorker} (the package default export) to
- * construct the Repo, wire up the service-worker port, load plugins via the
+ * construct the Repo, wire up the automerge-worker port, load plugins via the
  * ModuleWatcher, resolve the user's account document, and hand control to the
  * configured root tool.
  *
  * This entry point pulls in DOM- and plugin-layer dependencies (patchwork
  * elements, plugins, filesystem) and is intended for use only from a browser
  * site's `main.ts`. Non-UI consumers should import the package default (which
- * only does SW registration and port handoff).
+ * only does SW registration and the automerge-worker handoff).
  */
 import { type DocHandle, Repo, type AutomergeUrl, type StorageId } from "@automerge/vanillajs/slim";
+import { type AutomergeRepoKeyhive } from "@automerge/automerge-repo-keyhive";
 import { ModuleWatcher } from "@inkandswitch/patchwork-filesystem";
 import { type AccountDoc } from "@inkandswitch/patchwork-plugins";
 import * as plugins from "@inkandswitch/patchwork-plugins";
 import type { ServiceWorkerRepoChannelListener } from "./types.js";
-import { SwLogReader } from "./sw-logger.js";
 declare global {
     interface Window {
         accountDocHandle: DocHandle<AccountDoc>;
         Automerge: typeof import("@automerge/automerge");
         AutomergeRepo: typeof import("@automerge/automerge-repo");
         repo: Repo;
+        hive?: AutomergeRepoKeyhive;
+        getRepoChannel: () => MessagePort;
         patchwork: {
             repo: Repo;
             packages: ModuleWatcher;
             plugins: typeof plugins;
             accountDocHandle: DocHandle<AccountDoc>;
             sw: {
-                printLogs: (n?: number) => Promise<void>;
-                tailLogs: (n?: number) => ReturnType<typeof SwLogReader.tail>;
-                exportLogs: () => Promise<string>;
-                clearLogs: () => Promise<void>;
+                connectClassicSync: (server?: string) => Promise<void>;
                 subscribeToRepoChannel: (listener: ServiceWorkerRepoChannelListener) => Promise<() => void>;
             };
         };
@@ -72,6 +71,12 @@ export interface SiteConfig {
      * Ink & Switch's production Subduction storage.
      */
     remoteStorageIds?: StorageId[];
+    /**
+     * When true, initialize keyhive for access control.
+     * The Repo will use keyhive's network adapter, peerId, and idFactory
+     * instead of a sharePolicy.
+     */
+    keyhive?: boolean;
 }
 export interface BootResult {
     repo: Repo;

package/dist/site.js

@@ -2,28 +2,29 @@
  * High-level browser-app boot sequence for a Patchwork site.
  *
  * Layers on top of {@link setupServiceWorker} (the package default export) to
- * construct the Repo, wire up the service-worker port, load plugins via the
+ * construct the Repo, wire up the automerge-worker port, load plugins via the
  * ModuleWatcher, resolve the user's account document, and hand control to the
  * configured root tool.
  *
  * This entry point pulls in DOM- and plugin-layer dependencies (patchwork
  * elements, plugins, filesystem) and is intended for use only from a browser
  * site's `main.ts`. Non-UI consumers should import the package default (which
- * only does SW registration and port handoff).
+ * only does SW registration and the automerge-worker handoff).
  */
 import { IndexedDBStorageAdapter, initializeWasm, isValidAutomergeUrl, isValidDocumentId, MessageChannelNetworkAdapter, parseAutomergeUrl, Repo, stringifyAutomergeUrl, } from "@automerge/vanillajs/slim";
 import * as Automerge from "@automerge/automerge/slim";
 import * as AutomergeRepo from "@automerge/automerge-repo/slim";
+import { initKeyhiveWasm, initializeAutomergeRepoKeyhive, } from "@automerge/automerge-repo-keyhive";
 // eslint-disable-next-line
 // @ts-ignore — initSync is a wasm-bindgen runtime helper not in the .d.ts
 import { initSync as initSubductionSync } from "@automerge/automerge-subduction/slim";
+const siteName = typeof __SITE_NAME__ !== "undefined" ? __SITE_NAME__ : "tiny-patchwork";
 import { ModuleWatcher } from "@inkandswitch/patchwork-filesystem";
 import { openDocument, registerPatchworkViewElement, } from "@inkandswitch/patchwork-elements";
-import { registerFallbackProviderElement, registerRepoProviderElement, } from "@inkandswitch/patchwork-providers";
+import { registerRepoProviderElement } from "@inkandswitch/patchwork-providers";
 import { getRegistry, registerPlugins, resolveAccountHandle, unregisterPlugins, } from "@inkandswitch/patchwork-plugins";
 import * as plugins from "@inkandswitch/patchwork-plugins";
 import setupServiceWorker from "./setup.js";
-import { SwLogReader } from "./sw-logger.js";
 import debug from "debug";
 const log = debug("patchwork:bootloader:site");
 const DEFAULT_REMOTE_STORAGE_ID = "3760df37-a4c6-4f66-9ecd-732039a9385d";
@@ -48,51 +49,72 @@ export async function bootPatchworkSite(config) {
     log(`booting`, config);
     await initializeWasm(automergeWasm);
     initSubductionSync(subductionWasm);
-    const repo = new Repo({
-        storage: new IndexedDBStorageAdapter(),
-        async sharePolicy(peerId) {
-            return peerId.includes("service-worker");
-        },
-        enableRemoteHeadsGossiping: true,
-        peerId: `${config.titleSuffix}-tab-${crypto.randomUUID()}`,
-    });
-    repo.subscribeToRemotes(config.remoteStorageIds ?? [DEFAULT_REMOTE_STORAGE_ID]);
     const sw = await setupServiceWorker();
     if (!sw)
         throw new Error("Failed to set up service worker");
-    let activeServiceWorkerPort;
-    const connectServiceWorkerPort = async (port) => {
-        const previousPort = activeServiceWorkerPort;
-        activeServiceWorkerPort = port;
-        const net = new MessageChannelNetworkAdapter(port);
-        repo.networkSubsystem.addNetworkAdapter(net);
-        await net.whenReady();
-        previousPort?.close();
-    };
-    await sw.subscribeToRepoChannel(connectServiceWorkerPort);
-    installDevConsoleGlobals(repo);
+    let hive;
+    // Get the initial automerge-worker port via subscribeToRepoChannel,
+    // then pass it to keyhive init which wraps it in its own network adapter.
+    let resolvePort;
+    const portPromise = new Promise((r) => {
+        resolvePort = r;
+    });
+    await sw.subscribeToRepoChannel(resolvePort);
+    const workerPort = await portPromise;
+    if (config.keyhive) {
+        initKeyhiveWasm();
+        hive = await initializeAutomergeRepoKeyhive({
+            storage: new IndexedDBStorageAdapter(`${siteName}-keyhive`),
+            peerIdSuffix: siteName + Math.random().toString(36).slice(2),
+            networkAdapter: new MessageChannelNetworkAdapter(workerPort),
+            automaticArchiveIngestion: true,
+            cachingMode: "periodic",
+            onlyShareWithHardcodedServerPeerId: false,
+        });
+    }
+    const repo = hive
+        ? new Repo({
+            storage: new IndexedDBStorageAdapter(),
+            enableRemoteHeadsGossiping: true,
+            network: [hive.networkAdapter],
+            peerId: hive.peerId,
+            idFactory: hive.idFactory,
+        })
+        : new Repo({
+            network: [new MessageChannelNetworkAdapter(workerPort)],
+            storage: new IndexedDBStorageAdapter(),
+            async sharePolicy(peerId) {
+                return peerId.includes("automerge-worker");
+            },
+            enableRemoteHeadsGossiping: true,
+            peerId: `${config.titleSuffix}-tab-${crypto.randomUUID()}`,
+        });
+    repo.subscribeToRemotes(config.remoteStorageIds ?? [DEFAULT_REMOTE_STORAGE_ID]);
+    await repo.networkSubsystem.whenReady();
+    if (hive) {
+        hive.networkAdapter.syncKeyhive?.();
+    }
+    installDevConsoleGlobals(repo, hive, sw.getRepoChannel);
     registerRepoProviderElement(repo);
-    registerFallbackProviderElement();
     const rootElement = document.getElementById(config.rootElementId ?? "root");
     if (!rootElement) {
         throw new Error(`bootPatchworkSite: no element with id="${config.rootElementId ?? "root"}"`);
     }
     const repoProvider = document.createElement("repo-provider");
-    const fallbackProvider = document.createElement("fallback-provider");
-    rootElement.parentElement.insertBefore(fallbackProvider, rootElement);
-    fallbackProvider.appendChild(repoProvider);
+    rootElement.parentElement.insertBefore(repoProvider, rootElement);
     repoProvider.appendChild(rootElement);
-    // Registers `<patchwork-view>` and the `<patchwork-view-legacy>` it
-    // delegates to in one go.
-    registerPatchworkViewElement();
+    registerPatchworkViewElement(hive ? { hive } : {});
     // The watcher is started with the site's default-tools bundle alone so that
     // `resolveAccountHandle` below has something to await on (the `account`
     // datatype lives in that bundle today). The user's own module-settings URL
     // is added lazily once it appears on the account doc — see below.
     const moduleWatcher = new ModuleWatcher(repo, { system: defaultModulesUrl }, onModuleLoaded, unregisterPlugins);
-    const accountDocHandle = await resolveAccountHandle(repo, {
+    const accountDocHandle = (await resolveAccountHandle(repo, {
         storageKey: config.accountStorageKey,
-    });
+        hive,
+    }));
+    // TODO: something we (Orion & pvh) changed in the types made this necessary
+    //       fix this before merging to main!
     window.accountDocHandle = accountDocHandle;
     wireModuleSettingsWhenReady(accountDocHandle, moduleWatcher);
     primeRootElement(rootElement, accountDocHandle);
@@ -103,7 +125,7 @@ export async function bootPatchworkSite(config) {
         plugins,
         accountDocHandle,
         sw: {
-            ...buildSwLogApi(),
+            connectClassicSync: sw.connectClassicSync,
             subscribeToRepoChannel: sw.subscribeToRepoChannel,
         },
     };
@@ -131,10 +153,14 @@ function resolveDefaultModulesUrl(builtin) {
     console.warn(`ignoring invalid defaultToolsUrl in localStorage: ${override}; using built-in default`);
     return builtin;
 }
-function installDevConsoleGlobals(repo) {
+function installDevConsoleGlobals(repo, hive, getRepoChannel) {
     window.repo = repo;
     window.Automerge = Automerge;
     window.AutomergeRepo = AutomergeRepo;
+    if (hive) {
+        window.hive = hive;
+    }
+    window.getRepoChannel = getRepoChannel;
 }
 function onModuleLoaded(name, mod) {
     if (Array.isArray(mod.plugins)) {
@@ -196,24 +222,6 @@ function logToolRegistryWhenLoaded(moduleWatcher) {
         console.error("doneLoading rejected:", err);
     });
 }
-function buildSwLogApi() {
-    return {
-        printLogs: async (n = 200) => {
-            const entries = await SwLogReader.tail(n);
-            for (const e of entries) {
-                const prefix = `[${e.ts}] [${e.level}]`;
-                if (e.data !== undefined)
-                    log(prefix, e.msg, e.data);
-                else
-                    log(prefix, e.msg);
-            }
-            log(`--- ${entries.length} entries ---`);
-        },
-        tailLogs: (n = 200) => SwLogReader.tail(n),
-        exportLogs: () => SwLogReader.exportAll(),
-        clearLogs: () => SwLogReader.clear(),
-    };
-}
 const LOADING_STYLE_ID = "pw-bootloader-loading-styles";
 const LOADING_ELEMENT_ID = "pw-bootloader-loading";
 function showLoadingAnimation() {

package/dist/sync-config.d.ts

@@ -0,0 +1,8 @@
+/** localStorage key: optional override for the classic sync WebSocket URL. */
+export declare const CLASSIC_SYNC_SERVER_KEY = "patchworkClassicSyncServer";
+export declare const DEFAULT_CLASSIC_SYNC_SERVER = "wss://sync3.automerge.org";
+export declare function readClassicSyncServer(storage?: Pick<Storage, "getItem">): string;
+export type ConnectClassicSyncMessage = {
+    type: "connect-classic-sync";
+    server: string;
+};

package/dist/sync-config.js

@@ -0,0 +1,13 @@
+/** localStorage key: optional override for the classic sync WebSocket URL. */
+export const CLASSIC_SYNC_SERVER_KEY = "patchworkClassicSyncServer";
+export const DEFAULT_CLASSIC_SYNC_SERVER = "wss://sync3.automerge.org";
+export function readClassicSyncServer(storage = globalThis.localStorage) {
+    const override = storage.getItem(CLASSIC_SYNC_SERVER_KEY)?.trim();
+    if (!override)
+        return DEFAULT_CLASSIC_SYNC_SERVER;
+    if (!/^wss?:\/\//.test(override)) {
+        console.warn(`ignoring invalid ${CLASSIC_SYNC_SERVER_KEY} in localStorage: ${override}; using ${DEFAULT_CLASSIC_SYNC_SERVER}`);
+        return DEFAULT_CLASSIC_SYNC_SERVER;
+    }
+    return override;
+}

package/dist/types.d.ts

@@ -1,11 +1,101 @@
+/**
+ * The BroadcastChannel the service worker and the automerge shared worker
+ * use to hand requests off to each other. Broadcast (rather than a
+ * MessagePort handed from one to the other) so the two never need to be
+ * reintroduced when either of them restarts — and so tabs can listen in.
+ */
+export declare const HANDOFF_CHANNEL = "@patchwork/handoff";
+/**
+ * The special URL to resolve, plus enough of the {@link Request} the service
+ * worker is holding that the automerge worker can construct one that
+ * `cache.match`es it.
+ *
+ * Stale workers on either side of the channel can outlive a deploy, so the
+ * shape can only ever change additively: `url` must stay the http request
+ * URL old automerge workers decode the special URL out of, and new meaning
+ * goes in new fields old receivers ignore.
+ */
+export interface HandoffRequest {
+    /**
+     * The URL of the request the service worker is holding (the encoded
+     * `https://…/automerge%3Aabc/…` form) — the cache key.
+     */
+    url: string;
+    /** the decoded special URL, e.g. `automerge:abc/some/path` */
+    handoffURL: string;
+    /**
+     * @deprecated A briefly-deployed shape put the special URL in `url` and
+     * the cache key here. Only read, never sent.
+     */
+    cacheKey?: string;
+    headers: Record<string, string>;
+    method: string;
+    destination: RequestDestination;
+    referrer: string;
+}
+/**
+ * Service worker → automerge worker: please resolve this request and put
+ * the response in my cache.
+ */
+export interface HandoffRequestMessage {
+    id: string;
+    type: "request";
+    /** the current name of the service worker cache */
+    cachename: string;
+    request: HandoffRequest;
+}
+/**
+ * Automerge worker → service worker: the response is stored in the cache
+ * under the request you're holding. Serve `cache.match`.
+ */
+export interface HandoffCachedMessage {
+    id: string;
+    type: "cached";
+}
+/**
+ * An inline response for things that shouldn't be cached: errors, redirects
+ * &c.
+ */
+export interface HandoffResponse {
+    body?: string | Uint8Array<ArrayBuffer>;
+    /** defaults to 200 */
+    status?: number;
+    headers?: Record<string, string>;
+}
+/**
+ * Automerge worker → service worker: don't cache anything, serve this
+ * response directly.
+ */
+export interface HandoffResponseMessage {
+    id: string;
+    type: "response";
+    response: HandoffResponse;
+}
+export type HandoffReplyMessage = HandoffCachedMessage | HandoffResponseMessage;
+/**
+ * Automerge worker → world: broadcast once on startup so the service worker
+ * can re-send any handoff requests that raced the worker's boot.
+ */
+export interface HandoffOnlineMessage {
+    type: "online";
+}
 export type SetupServiceWorkerOptions = {
     /**
      * The public path to the service worker file.
      * Defaults to `/service-worker.js`
      */
     path?: string;
+    /**
+     * The public path to the automerge shared worker file.
+     * Defaults to `/automerge-worker.js`
+     */
+    workerPath?: string;
 };
 export type ServiceWorkerRepoChannelListener = (port: MessagePort) => void | Promise<void>;
 export type SetupServiceWorkerResult = {
+    /** Open a classic Automerge sync WebSocket from the automerge worker. */
+    connectClassicSync: (server?: string) => Promise<void>;
     subscribeToRepoChannel: (listener: ServiceWorkerRepoChannelListener) => Promise<() => void>;
+    /** Open a fresh repo sync port to the automerge worker (dev console). */
+    getRepoChannel: () => MessagePort;
 };

package/dist/types.js

@@ -1 +1,7 @@
-export {};
+/**
+ * The BroadcastChannel the service worker and the automerge shared worker
+ * use to hand requests off to each other. Broadcast (rather than a
+ * MessagePort handed from one to the other) so the two never need to be
+ * reintroduced when either of them restarts — and so tabs can listen in.
+ */
+export const HANDOFF_CHANNEL = "@patchwork/handoff";

package/dist/vite/importmap-plugin.js

@@ -30,12 +30,18 @@ export function importmap(options) {
                     preserveSignature: "strict",
                 });
             }
-            // Emit automerge wasm so the service worker can fetch it
-            const wasmPath = require.resolve("@automerge/automerge/automerge.wasm");
+            // Emit automerge, keyhive, and subduction wasm so the service worker can fetch them
+            const automergeWasmPath = require.resolve("@automerge/automerge/automerge.wasm");
             this.emitFile({
                 type: "asset",
                 fileName: "automerge.wasm",
-                source: readFileSync(wasmPath),
+                source: readFileSync(automergeWasmPath),
+            });
+            const keyhiveWasmPath = require.resolve("@keyhive/keyhive/keyhive_wasm.wasm");
+            this.emitFile({
+                type: "asset",
+                fileName: "keyhive_wasm.wasm",
+                source: readFileSync(keyhiveWasmPath),
             });
             // Emit subduction wasm so the service worker can fetch it
             const subdWasmPath = require.resolve("@automerge/automerge-subduction/wasm");

package/dist/vite/service-worker-plugin.js

@@ -1,20 +1,36 @@
 import { builtins } from "./importmap-plugin.js";
+// The service worker and the automerge shared worker are emitted as their
+// own chunks. Their heavy imports are marked external and resolved to
+// /packages/... URLs (both workers are created with type:"module", so the
+// browser fetches those as regular network requests).
+const workers = [
+    {
+        specifier: "@inkandswitch/patchwork-bootloader/service-worker",
+        fileName: "service-worker.js",
+    },
+    {
+        specifier: "@inkandswitch/patchwork-bootloader/automerge-worker",
+        fileName: "automerge-worker.js",
+    },
+];
 export function serviceworker() {
-    let swEntryId;
+    const entryIds = new Set();
     return {
         name: "@patchwork/service-worker",
         enforce: "pre",
         async buildStart() {
-            const resolved = await this.resolve("@inkandswitch/patchwork-bootloader/service-worker");
-            swEntryId = resolved.id;
-            this.emitFile({
-                type: "chunk",
-                id: resolved.id,
-                fileName: "service-worker.js",
-            });
+            for (const { specifier, fileName } of workers) {
+                const resolved = await this.resolve(specifier);
+                entryIds.add(resolved.id);
+                this.emitFile({
+                    type: "chunk",
+                    id: resolved.id,
+                    fileName,
+                });
+            }
         },
         resolveId(source, importer) {
-            if (importer && swEntryId && importer === swEntryId && source in builtins) {
+            if (importer && entryIds.has(importer) && source in builtins) {
                 return { id: builtins[source], external: true };
             }
         },

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@inkandswitch/patchwork-bootloader",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "author": "chee",
   "type": "module",
   "license": "MIT",
   "devDependencies": {
-    "@automerge/automerge-repo-keyhive": "0.2.0-alpha.1d",
+    "@automerge/automerge-repo-keyhive": "0.3.0-alpha.sub.1c",
     "esbuild": "^0.23.1",
-    "rollup": "^4.53.3"
+    "rollup": "^4.61.1"
   },
   "exports": {
     ".": {
@@ -26,6 +26,10 @@
       "import": "./dist/service-worker.js",
       "types": "./dist/service-worker.d.ts"
     },
+    "./automerge-worker": {
+      "import": "./dist/automerge-worker.js",
+      "types": "./dist/automerge-worker.d.ts"
+    },
     "./site": {
       "import": "./dist/site.js",
       "types": "./dist/site.d.ts"
@@ -33,35 +37,32 @@
     "./types": {
       "import": "./dist/types.js",
       "types": "./dist/types.d.ts"
-    },
-    "./sw-logger": {
-      "import": "./dist/sw-logger.js",
-      "types": "./dist/sw-logger.d.ts"
     }
   },
   "dependencies": {
     "@automerge/automerge": "3.3.0-fragments.1",
-    "@automerge/automerge-repo": "2.6.0-subduction.23",
-    "@automerge/automerge-subduction": "0.12.1",
-    "@automerge/automerge-repo-network-messagechannel": "2.6.0-subduction.23",
-    "@automerge/automerge-repo-network-websocket": "2.6.0-subduction.23",
-    "@automerge/automerge-repo-storage-indexeddb": "2.6.0-subduction.23",
-    "@automerge/vanillajs": "2.6.0-subduction.23",
-    "@types/debug": "^4.1.12",
+    "@automerge/automerge-repo": "2.6.0-subduction.29",
+    "@automerge/automerge-repo-network-messagechannel": "2.6.0-subduction.29",
+    "@automerge/automerge-repo-network-websocket": "2.6.0-subduction.29",
+    "@automerge/automerge-repo-storage-indexeddb": "2.6.0-subduction.29",
+    "@automerge/automerge-subduction": "0.15.0",
+    "@automerge/vanillajs": "2.6.0-subduction.29",
+    "@keyhive/keyhive": "0.0.0-alpha.56",
+    "@types/debug": "^4.1.13",
     "debug": "^4.4.3",
     "resolve.exports": "^2.0.3",
     "service-worker-types": "npm:@types/serviceworker@^0.0.153",
     "tinyargs": "^0.1.4",
-    "@inkandswitch/patchwork-elements": "^0.2.0",
+    "@inkandswitch/patchwork-elements": "^1.0.0",
     "@inkandswitch/patchwork-filesystem": "^0.0.8",
     "@inkandswitch/patchwork-plugins": "^0.0.11",
-    "@inkandswitch/patchwork-providers": "^0.1.2"
+    "@inkandswitch/patchwork-providers": "^0.2.2"
   },
   "peerDependencies": {
     "@automerge/automerge": "3.3.0-fragments.1",
-    "@automerge/automerge-repo": "2.6.0-subduction.23",
-    "@automerge/automerge-repo-keyhive": "0.2.0-alpha.1d",
-    "@automerge/vanillajs": "2.6.0-subduction.23"
+    "@automerge/automerge-repo": "2.6.0-subduction.29",
+    "@automerge/automerge-repo-keyhive": "0.3.0-alpha.sub.1c",
+    "@automerge/vanillajs": "2.6.0-subduction.29"
   },
   "scripts": {
     "build": "tsc",