@automerge/automerge-repo 2.0.0-alpha.4 → 2.0.0-alpha.5

package/dist/Repo.d.ts

@@ -5,6 +5,7 @@ import { NetworkSubsystem } from "./network/NetworkSubsystem.js";
 import { StorageAdapterInterface } from "./storage/StorageAdapterInterface.js";
 import { StorageSubsystem } from "./storage/StorageSubsystem.js";
 import { StorageId } from "./storage/types.js";
+import { CollectionSynchronizer } from "./synchronizer/CollectionSynchronizer.js";
 import type { AnyDocumentId, DocumentId, PeerId } from "./types.js";
 /** A Repo is a collection of documents with networking, syncing, and storage capabilities. */
 /** The `Repo` is the main entry point of this library
@@ -23,6 +24,8 @@ export declare class Repo extends EventEmitter<RepoEvents> {
     /** The debounce rate is adjustable on the repo. */
     /** @hidden */
     saveDebounceRate: number;
+    /** @hidden */
+    synchronizer: CollectionSynchronizer;
     /** By default, we share generously with all peers. */
     /** @hidden */
     sharePolicy: SharePolicy;

package/dist/Repo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAM5C,OAAO,EAAE,SAAS,EAAiC,MAAM,gBAAgB,CAAA;AAIzE,OAAO,EACL,uBAAuB,EACvB,KAAK,YAAY,EAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAG9C,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAMnE,8FAA8F;AAC9F;;;;;;GAMG;AACH,qBAAa,IAAK,SAAQ,YAAY,CAAC,UAAU,CAAC;;IAGhD,cAAc;IACd,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc;IACd,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAEnC,mDAAmD;IACnD,cAAc;IACd,gBAAgB,SAAM;IAMtB,sDAAsD;IACtD,cAAc;IACd,WAAW,EAAE,WAAW,CAAmB;IAE3C,8GAA8G;IAC9G,cAAc;IACd,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAK;gBAK3C,EACV,OAAO,EACP,OAAY,EACZ,MAAuB,EACvB,WAAW,EACX,WAAmC,EACnC,0BAAkC,GACnC,GAAE,UAAe;IAwPlB,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIzD;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAuBzC;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAuBnC;;;OAGG;IACH,IAAI,CAAC,CAAC;IACJ,sDAAsD;IACtD,EAAE,EAAE,aAAa,GAChB,SAAS,CAAC,CAAC,CAAC;IA+Cf,MAAM;IACJ,oDAAoD;IACpD,EAAE,EAAE,aAAa;IAWnB;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAShE;;;OAGG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU;IAY5B,kBAAkB,YAAa,SAAS,EAAE,UASzC;IAED,SAAS,QAAa,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAMnD;IAED;;;;;OAKG;IACG,KAAK,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBpD,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAOzB,OAAO,IAAI;QAAE,SAAS,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,CAAA;KAAE;CAGjD;AAED,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;8DAC0D;IAC1D,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB,gDAAgD;IAChD,OAAO,CAAC,EAAE,uBAAuB,CAAA;IAEjC,iEAAiE;IACjE,OAAO,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;CACrC;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,6BAA6B;IAC7B,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,4FAA4F;IAC5F,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;CAC7D;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAA;CACvB"}
+{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAM5C,OAAO,EAAE,SAAS,EAAiC,MAAM,gBAAgB,CAAA;AAIzE,OAAO,EACL,uBAAuB,EACvB,KAAK,YAAY,EAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAA;AAEjF,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAMnE,8FAA8F;AAC9F;;;;;;GAMG;AACH,qBAAa,IAAK,SAAQ,YAAY,CAAC,UAAU,CAAC;;IAGhD,cAAc;IACd,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc;IACd,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAEnC,mDAAmD;IACnD,cAAc;IACd,gBAAgB,SAAM;IAItB,cAAc;IACd,YAAY,EAAE,sBAAsB,CAAA;IAEpC,sDAAsD;IACtD,cAAc;IACd,WAAW,EAAE,WAAW,CAAmB;IAE3C,8GAA8G;IAC9G,cAAc;IACd,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAK;gBAK3C,EACV,OAAO,EACP,OAAY,EACZ,MAAuB,EACvB,WAAW,EACX,WAAmC,EACnC,0BAAkC,GACnC,GAAE,UAAe;IAuPlB,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIzD;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAuBzC;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAuBnC;;;OAGG;IACH,IAAI,CAAC,CAAC;IACJ,sDAAsD;IACtD,EAAE,EAAE,aAAa,GAChB,SAAS,CAAC,CAAC,CAAC;IA+Cf,MAAM;IACJ,oDAAoD;IACpD,EAAE,EAAE,aAAa;IAWnB;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAShE;;;OAGG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU;IAY5B,kBAAkB,YAAa,SAAS,EAAE,UASzC;IAED,SAAS,QAAa,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAMnD;IAED;;;;;OAKG;IACG,KAAK,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBpD,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAOzB,OAAO,IAAI;QAAE,SAAS,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,CAAA;KAAE;CAGjD;AAED,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;8DAC0D;IAC1D,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB,gDAAgD;IAChD,OAAO,CAAC,EAAE,uBAAuB,CAAA;IAEjC,iEAAiE;IACjE,OAAO,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;CACrC;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,6BAA6B;IAC7B,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,4FAA4F;IAC5F,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;CAC7D;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAA;CACvB"}

package/dist/Repo.js

@@ -30,7 +30,8 @@ export class Repo extends EventEmitter {
     /** @hidden */
     saveDebounceRate = 100;
     #handleCache = {};
-    #synchronizer;
+    /** @hidden */
+    synchronizer;
     /** By default, we share generously with all peers. */
     /** @hidden */
     sharePolicy = async () => true;
@@ -44,26 +45,6 @@ export class Repo extends EventEmitter {
         this.#remoteHeadsGossipingEnabled = enableRemoteHeadsGossiping;
         this.#log = debug(`automerge-repo:repo`);
         this.sharePolicy = sharePolicy ?? this.sharePolicy;
-        // DOC COLLECTION
-        // The `document` event is fired by the DocCollection any time we create a new document or look
-        // up a document by ID. We listen for it in order to wire up storage and network synchronization.
-        this.on("document", async ({ handle }) => {
-            if (storageSubsystem) {
-                // Save when the document changes, but no more often than saveDebounceRate.
-                const saveFn = ({ handle, doc, }) => {
-                    void storageSubsystem.saveDoc(handle.documentId, doc);
-                };
-                handle.on("heads-changed", throttle(saveFn, this.saveDebounceRate));
-            }
-            handle.on("unavailable", () => {
-                this.#log("document unavailable", { documentId: handle.documentId });
-                this.emit("unavailable-document", {
-                    documentId: handle.documentId,
-                });
-            });
-            // Register the document with the synchronizer. This advertises our interest in the document.
-            this.#synchronizer.addDocument(handle.documentId);
-        });
         this.on("delete-document", ({ documentId }) => {
             // TODO Pass the delete on to the network
             // synchronizer.removeDocument(documentId)
@@ -75,14 +56,14 @@ export class Repo extends EventEmitter {
         });
         // SYNCHRONIZER
         // The synchronizer uses the network subsystem to keep documents in sync with peers.
-        this.#synchronizer = new CollectionSynchronizer(this);
+        this.synchronizer = new CollectionSynchronizer(this);
         // When the synchronizer emits messages, send them to peers
-        this.#synchronizer.on("message", message => {
+        this.synchronizer.on("message", message => {
             this.#log(`sending ${message.type} message to ${message.targetId}`);
             networkSubsystem.send(message);
         });
         if (this.#remoteHeadsGossipingEnabled) {
-            this.#synchronizer.on("open-doc", ({ peerId, documentId }) => {
+            this.synchronizer.on("open-doc", ({ peerId, documentId }) => {
                 this.#remoteHeadsSubscriptions.subscribePeerToDoc(peerId, documentId);
             });
         }
@@ -113,18 +94,18 @@ export class Repo extends EventEmitter {
                 .catch(err => {
                 console.log("error in share policy", { err });
             });
-            this.#synchronizer.addPeer(peerId);
+            this.synchronizer.addPeer(peerId);
         });
         // When a peer disconnects, remove it from the synchronizer
         networkSubsystem.on("peer-disconnected", ({ peerId }) => {
-            this.#synchronizer.removePeer(peerId);
+            this.synchronizer.removePeer(peerId);
             this.#remoteHeadsSubscriptions.removePeer(peerId);
         });
         // Handle incoming messages
         networkSubsystem.on("message", async (msg) => {
             this.#receiveMessage(msg);
         });
-        this.#synchronizer.on("sync-state", message => {
+        this.synchronizer.on("sync-state", message => {
             this.#saveSyncState(message);
             const handle = this.#handleCache[message.documentId];
             const { storageId } = this.peerMetadataByPeerId[message.peerId] || {};
@@ -172,6 +153,28 @@ export class Repo extends EventEmitter {
             });
         }
     }
+    // The `document` event is fired by the DocCollection any time we create a new document or look
+    // up a document by ID. We listen for it in order to wire up storage and network synchronization.
+    #registerHandleWithSubsystems(handle) {
+        const { storageSubsystem } = this;
+        if (storageSubsystem) {
+            // Save when the document changes, but no more often than saveDebounceRate.
+            const saveFn = ({ handle, doc }) => {
+                void storageSubsystem.saveDoc(handle.documentId, doc);
+            };
+            handle.on("heads-changed", throttle(saveFn, this.saveDebounceRate));
+        }
+        handle.on("unavailable", () => {
+            this.#log("document unavailable", { documentId: handle.documentId });
+            this.emit("unavailable-document", {
+                documentId: handle.documentId,
+            });
+        });
+        // Register the document with the synchronizer. This advertises our interest in the document.
+        this.synchronizer.addDocument(handle.documentId);
+        // Preserve the old event in case anyone was using it.
+        this.emit("document", { handle });
+    }
     #receiveMessage(message) {
         switch (message.type) {
             case "remote-subscription-change":
@@ -188,7 +191,7 @@ export class Repo extends EventEmitter {
             case "request":
             case "ephemeral":
             case "doc-unavailable":
-                this.#synchronizer.receiveMessage(message).catch(err => {
+                this.synchronizer.receiveMessage(message).catch(err => {
                     console.log("error receiving message", { err });
                 });
         }
@@ -229,7 +232,7 @@ export class Repo extends EventEmitter {
     }
     /** Returns a list of all connected peer ids */
     get peers() {
-        return this.#synchronizer.peers;
+        return this.synchronizer.peers;
     }
     getStorageIdOfPeer(peerId) {
         return this.peerMetadataByPeerId[peerId]?.storageId;
@@ -245,7 +248,7 @@ export class Repo extends EventEmitter {
         const handle = this.#getHandle({
             documentId,
         });
-        this.emit("document", { handle });
+        this.#registerHandleWithSubsystems(handle);
         handle.update(() => {
             let nextDoc;
             if (initialValue) {
@@ -314,31 +317,29 @@ export class Repo extends EventEmitter {
         const handle = this.#getHandle({
             documentId,
         });
-        // Try to load from disk before telling anyone else about it
-        if (this.storageSubsystem) {
-            void this.storageSubsystem.loadDoc(handle.documentId).then(loadedDoc => {
-                if (loadedDoc) {
-                    // uhhhh, sorry if you're reading this because we were lying to the type system
-                    handle.update(() => loadedDoc);
-                    handle.doneLoading();
-                }
-                else {
-                    this.networkSubsystem
-                        .whenReady()
-                        .then(() => {
-                        handle.request();
-                    })
-                        .catch(err => {
-                        this.#log("error waiting for network", { err });
-                    });
-                    this.emit("document", { handle });
-                }
-            });
-        }
-        else {
-            handle.request();
-            this.emit("document", { handle });
-        }
+        // Loading & network is going to be asynchronous no matter what,
+        // but we want to return the handle immediately.
+        const attemptLoad = this.storageSubsystem
+            ? this.storageSubsystem.loadDoc(handle.documentId)
+            : Promise.resolve(null);
+        attemptLoad
+            .then(async (loadedDoc) => {
+            if (loadedDoc) {
+                // uhhhh, sorry if you're reading this because we were lying to the type system
+                handle.update(() => loadedDoc);
+                handle.doneLoading();
+            }
+            else {
+                // we want to wait for the network subsystem to be ready before
+                // we request the document. this prevents entering unavailable during initialization.
+                await this.networkSubsystem.whenReady();
+                handle.request();
+            }
+            this.#registerHandleWithSubsystems(handle);
+        })
+            .catch(err => {
+            this.#log("error waiting for network", { err });
+        });
         return handle;
     }
     delete(
@@ -422,6 +423,6 @@ export class Repo extends EventEmitter {
         return this.flush();
     }
     metrics() {
-        return { documents: this.#synchronizer.metrics() };
+        return { documents: this.synchronizer.metrics() };
     }
 }

package/dist/synchronizer/CollectionSynchronizer.d.ts

@@ -1,11 +1,15 @@
 import { Repo } from "../Repo.js";
 import { DocMessage } from "../network/messages.js";
 import { DocumentId, PeerId } from "../types.js";
+import { DocSynchronizer } from "./DocSynchronizer.js";
 import { Synchronizer } from "./Synchronizer.js";
 /** A CollectionSynchronizer is responsible for synchronizing a DocCollection with peers. */
 export declare class CollectionSynchronizer extends Synchronizer {
     #private;
     private repo;
+    /** A map of documentIds to their synchronizers */
+    /** @hidden */
+    docSynchronizers: Record<DocumentId, DocSynchronizer>;
     constructor(repo: Repo);
     /**
      * When we receive a sync message for a document we haven't got in memory, we

package/dist/synchronizer/CollectionSynchronizer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CollectionSynchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/CollectionSynchronizer.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAIhD,4FAA4F;AAC5F,qBAAa,sBAAuB,SAAQ,YAAY;;IAU1C,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,IAAI;IAqD9B;;;OAGG;IACG,cAAc,CAAC,OAAO,EAAE,UAAU;IAyBxC;;OAEG;IACH,WAAW,CAAC,UAAU,EAAE,UAAU;IAalC,cAAc,CAAC,UAAU,EAAE,UAAU;IAIrC,2DAA2D;IAC3D,OAAO,CAAC,MAAM,EAAE,MAAM;IAgBtB,uDAAuD;IACvD,UAAU,CAAC,MAAM,EAAE,MAAM;IASzB,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,OAAO,IAAI;QACT,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,KAAK,EAAE,MAAM,EAAE,CAAA;YACf,IAAI,EAAE;gBAAE,MAAM,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAA;aAAE,CAAA;SAC7C,CAAA;KACF;CASF"}
+{"version":3,"file":"CollectionSynchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/CollectionSynchronizer.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAIhD,4FAA4F;AAC5F,qBAAa,sBAAuB,SAAQ,YAAY;;IAW1C,OAAO,CAAC,IAAI;IAPxB,kDAAkD;IAClD,cAAc;IACd,gBAAgB,EAAE,MAAM,CAAC,UAAU,EAAE,eAAe,CAAC,CAAK;gBAKtC,IAAI,EAAE,IAAI;IAqD9B;;;OAGG;IACG,cAAc,CAAC,OAAO,EAAE,UAAU;IAyBxC;;OAEG;IACH,WAAW,CAAC,UAAU,EAAE,UAAU;IAalC,cAAc,CAAC,UAAU,EAAE,UAAU;IAIrC,2DAA2D;IAC3D,OAAO,CAAC,MAAM,EAAE,MAAM;IAgBtB,uDAAuD;IACvD,UAAU,CAAC,MAAM,EAAE,MAAM;IASzB,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,OAAO,IAAI;QACT,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,KAAK,EAAE,MAAM,EAAE,CAAA;YACf,IAAI,EAAE;gBAAE,MAAM,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAA;aAAE,CAAA;SAC7C,CAAA;KACF;CASF"}

package/dist/synchronizer/CollectionSynchronizer.js

@@ -9,7 +9,8 @@ export class CollectionSynchronizer extends Synchronizer {
     /** The set of peers we are connected with */
     #peers = new Set();
     /** A map of documentIds to their synchronizers */
-    #docSynchronizers = {};
+    /** @hidden */
+    docSynchronizers = {};
     /** Used to determine if the document is know to the Collection and a synchronizer exists or is being set up */
     #docSetUp = {};
     constructor(repo) {
@@ -18,11 +19,11 @@ export class CollectionSynchronizer extends Synchronizer {
     }
     /** Returns a synchronizer for the given document, creating one if it doesn't already exist.  */
     #fetchDocSynchronizer(documentId) {
-        if (!this.#docSynchronizers[documentId]) {
+        if (!this.docSynchronizers[documentId]) {
             const handle = this.repo.find(stringifyAutomergeUrl({ documentId }));
-            this.#docSynchronizers[documentId] = this.#initDocSynchronizer(handle);
+            this.docSynchronizers[documentId] = this.#initDocSynchronizer(handle);
         }
-        return this.#docSynchronizers[documentId];
+        return this.docSynchronizers[documentId];
     }
     /** Creates a new docSynchronizer and sets it up to propagate messages */
     #initDocSynchronizer(handle) {
@@ -98,7 +99,7 @@ export class CollectionSynchronizer extends Synchronizer {
             return;
         }
         this.#peers.add(peerId);
-        for (const docSynchronizer of Object.values(this.#docSynchronizers)) {
+        for (const docSynchronizer of Object.values(this.docSynchronizers)) {
             const { documentId } = docSynchronizer;
             void this.repo.sharePolicy(peerId, documentId).then(okToShare => {
                 if (okToShare)
@@ -110,7 +111,7 @@ export class CollectionSynchronizer extends Synchronizer {
     removePeer(peerId) {
         log(`removing peer ${peerId}`);
         this.#peers.delete(peerId);
-        for (const docSynchronizer of Object.values(this.#docSynchronizers)) {
+        for (const docSynchronizer of Object.values(this.docSynchronizers)) {
             docSynchronizer.endSync(peerId);
         }
     }
@@ -119,7 +120,7 @@ export class CollectionSynchronizer extends Synchronizer {
         return Array.from(this.#peers);
     }
     metrics() {
-        return Object.fromEntries(Object.entries(this.#docSynchronizers).map(([documentId, synchronizer]) => {
+        return Object.fromEntries(Object.entries(this.docSynchronizers).map(([documentId, synchronizer]) => {
             return [documentId, synchronizer.metrics()];
         }));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo",
-  "version": "2.0.0-alpha.4",
+  "version": "2.0.0-alpha.5",
   "description": "A repository object to manage a collection of automerge documents",
   "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -60,5 +60,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "40057e1c8c7833b65ee392a69d4d7b3820fe6060"
+  "gitHead": "9f10cdceb172f92cdf2dc1be361a940dfd3c5858"
 }

package/src/Repo.ts

@@ -49,7 +49,8 @@ export class Repo extends EventEmitter<RepoEvents> {
 
   #handleCache: Record<DocumentId, DocHandle<any>> = {}
 
-  #synchronizer: CollectionSynchronizer
+  /** @hidden */
+  synchronizer: CollectionSynchronizer
 
   /** By default, we share generously with all peers. */
   /** @hidden */
@@ -75,33 +76,6 @@ export class Repo extends EventEmitter<RepoEvents> {
     this.#log = debug(`automerge-repo:repo`)
     this.sharePolicy = sharePolicy ?? this.sharePolicy
 
-    // DOC COLLECTION
-
-    // The `document` event is fired by the DocCollection any time we create a new document or look
-    // up a document by ID. We listen for it in order to wire up storage and network synchronization.
-    this.on("document", async ({ handle }) => {
-      if (storageSubsystem) {
-        // Save when the document changes, but no more often than saveDebounceRate.
-        const saveFn = ({
-          handle,
-          doc,
-        }: DocHandleEncodedChangePayload<any>) => {
-          void storageSubsystem.saveDoc(handle.documentId, doc)
-        }
-        handle.on("heads-changed", throttle(saveFn, this.saveDebounceRate))
-      }
-
-      handle.on("unavailable", () => {
-        this.#log("document unavailable", { documentId: handle.documentId })
-        this.emit("unavailable-document", {
-          documentId: handle.documentId,
-        })
-      })
-
-      // Register the document with the synchronizer. This advertises our interest in the document.
-      this.#synchronizer.addDocument(handle.documentId)
-    })
-
     this.on("delete-document", ({ documentId }) => {
       // TODO Pass the delete on to the network
       // synchronizer.removeDocument(documentId)
@@ -115,16 +89,16 @@ export class Repo extends EventEmitter<RepoEvents> {
 
     // SYNCHRONIZER
     // The synchronizer uses the network subsystem to keep documents in sync with peers.
-    this.#synchronizer = new CollectionSynchronizer(this)
+    this.synchronizer = new CollectionSynchronizer(this)
 
     // When the synchronizer emits messages, send them to peers
-    this.#synchronizer.on("message", message => {
+    this.synchronizer.on("message", message => {
       this.#log(`sending ${message.type} message to ${message.targetId}`)
       networkSubsystem.send(message)
     })
 
     if (this.#remoteHeadsGossipingEnabled) {
-      this.#synchronizer.on("open-doc", ({ peerId, documentId }) => {
+      this.synchronizer.on("open-doc", ({ peerId, documentId }) => {
         this.#remoteHeadsSubscriptions.subscribePeerToDoc(peerId, documentId)
       })
     }
@@ -167,12 +141,12 @@ export class Repo extends EventEmitter<RepoEvents> {
           console.log("error in share policy", { err })
         })
 
-      this.#synchronizer.addPeer(peerId)
+      this.synchronizer.addPeer(peerId)
     })
 
     // When a peer disconnects, remove it from the synchronizer
     networkSubsystem.on("peer-disconnected", ({ peerId }) => {
-      this.#synchronizer.removePeer(peerId)
+      this.synchronizer.removePeer(peerId)
       this.#remoteHeadsSubscriptions.removePeer(peerId)
     })
 
@@ -181,7 +155,7 @@ export class Repo extends EventEmitter<RepoEvents> {
       this.#receiveMessage(msg)
     })
 
-    this.#synchronizer.on("sync-state", message => {
+    this.synchronizer.on("sync-state", message => {
       this.#saveSyncState(message)
 
       const handle = this.#handleCache[message.documentId]
@@ -243,6 +217,32 @@ export class Repo extends EventEmitter<RepoEvents> {
     }
   }
 
+  // The `document` event is fired by the DocCollection any time we create a new document or look
+  // up a document by ID. We listen for it in order to wire up storage and network synchronization.
+  #registerHandleWithSubsystems(handle: DocHandle<any>) {
+    const { storageSubsystem } = this
+    if (storageSubsystem) {
+      // Save when the document changes, but no more often than saveDebounceRate.
+      const saveFn = ({ handle, doc }: DocHandleEncodedChangePayload<any>) => {
+        void storageSubsystem.saveDoc(handle.documentId, doc)
+      }
+      handle.on("heads-changed", throttle(saveFn, this.saveDebounceRate))
+    }
+
+    handle.on("unavailable", () => {
+      this.#log("document unavailable", { documentId: handle.documentId })
+      this.emit("unavailable-document", {
+        documentId: handle.documentId,
+      })
+    })
+
+    // Register the document with the synchronizer. This advertises our interest in the document.
+    this.synchronizer.addDocument(handle.documentId)
+
+    // Preserve the old event in case anyone was using it.
+    this.emit("document", { handle })
+  }
+
   #receiveMessage(message: RepoMessage) {
     switch (message.type) {
       case "remote-subscription-change":
@@ -259,7 +259,7 @@ export class Repo extends EventEmitter<RepoEvents> {
       case "request":
       case "ephemeral":
       case "doc-unavailable":
-        this.#synchronizer.receiveMessage(message).catch(err => {
+        this.synchronizer.receiveMessage(message).catch(err => {
           console.log("error receiving message", { err })
         })
     }
@@ -324,7 +324,7 @@ export class Repo extends EventEmitter<RepoEvents> {
 
   /** Returns a list of all connected peer ids */
   get peers(): PeerId[] {
-    return this.#synchronizer.peers
+    return this.synchronizer.peers
   }
 
   getStorageIdOfPeer(peerId: PeerId): StorageId | undefined {
@@ -343,7 +343,7 @@ export class Repo extends EventEmitter<RepoEvents> {
       documentId,
     }) as DocHandle<T>
 
-    this.emit("document", { handle })
+    this.#registerHandleWithSubsystems(handle)
 
     handle.update(() => {
       let nextDoc: Automerge.Doc<T>
@@ -425,29 +425,29 @@ export class Repo extends EventEmitter<RepoEvents> {
       documentId,
     }) as DocHandle<T>
 
-    // Try to load from disk before telling anyone else about it
-    if (this.storageSubsystem) {
-      void this.storageSubsystem.loadDoc(handle.documentId).then(loadedDoc => {
+    // Loading & network is going to be asynchronous no matter what,
+    // but we want to return the handle immediately.
+    const attemptLoad = this.storageSubsystem
+      ? this.storageSubsystem.loadDoc(handle.documentId)
+      : Promise.resolve(null)
+
+    attemptLoad
+      .then(async loadedDoc => {
         if (loadedDoc) {
           // uhhhh, sorry if you're reading this because we were lying to the type system
           handle.update(() => loadedDoc as Automerge.Doc<T>)
           handle.doneLoading()
         } else {
-          this.networkSubsystem
-            .whenReady()
-            .then(() => {
-              handle.request()
-            })
-            .catch(err => {
-              this.#log("error waiting for network", { err })
-            })
-          this.emit("document", { handle })
+          // we want to wait for the network subsystem to be ready before
+          // we request the document. this prevents entering unavailable during initialization.
+          await this.networkSubsystem.whenReady()
+          handle.request()
         }
+        this.#registerHandleWithSubsystems(handle)
+      })
+      .catch(err => {
+        this.#log("error waiting for network", { err })
       })
-    } else {
-      handle.request()
-      this.emit("document", { handle })
-    }
     return handle
   }
 
@@ -547,7 +547,7 @@ export class Repo extends EventEmitter<RepoEvents> {
   }
 
   metrics(): { documents: { [key: string]: any } } {
-    return { documents: this.#synchronizer.metrics() }
+    return { documents: this.synchronizer.metrics() }
   }
 }
 

package/src/synchronizer/CollectionSynchronizer.ts

@@ -15,7 +15,8 @@ export class CollectionSynchronizer extends Synchronizer {
   #peers: Set<PeerId> = new Set()
 
   /** A map of documentIds to their synchronizers */
-  #docSynchronizers: Record<DocumentId, DocSynchronizer> = {}
+  /** @hidden */
+  docSynchronizers: Record<DocumentId, DocSynchronizer> = {}
 
   /** Used to determine if the document is know to the Collection and a synchronizer exists or is being set up */
   #docSetUp: Record<DocumentId, boolean> = {}
@@ -26,11 +27,11 @@ export class CollectionSynchronizer extends Synchronizer {
 
   /** Returns a synchronizer for the given document, creating one if it doesn't already exist.  */
   #fetchDocSynchronizer(documentId: DocumentId) {
-    if (!this.#docSynchronizers[documentId]) {
+    if (!this.docSynchronizers[documentId]) {
       const handle = this.repo.find(stringifyAutomergeUrl({ documentId }))
-      this.#docSynchronizers[documentId] = this.#initDocSynchronizer(handle)
+      this.docSynchronizers[documentId] = this.#initDocSynchronizer(handle)
     }
-    return this.#docSynchronizers[documentId]
+    return this.docSynchronizers[documentId]
   }
 
   /** Creates a new docSynchronizer and sets it up to propagate messages */
@@ -131,7 +132,7 @@ export class CollectionSynchronizer extends Synchronizer {
     }
 
     this.#peers.add(peerId)
-    for (const docSynchronizer of Object.values(this.#docSynchronizers)) {
+    for (const docSynchronizer of Object.values(this.docSynchronizers)) {
       const { documentId } = docSynchronizer
       void this.repo.sharePolicy(peerId, documentId).then(okToShare => {
         if (okToShare) docSynchronizer.beginSync([peerId])
@@ -144,7 +145,7 @@ export class CollectionSynchronizer extends Synchronizer {
     log(`removing peer ${peerId}`)
     this.#peers.delete(peerId)
 
-    for (const docSynchronizer of Object.values(this.#docSynchronizers)) {
+    for (const docSynchronizer of Object.values(this.docSynchronizers)) {
       docSynchronizer.endSync(peerId)
     }
   }
@@ -161,7 +162,7 @@ export class CollectionSynchronizer extends Synchronizer {
     }
   } {
     return Object.fromEntries(
-      Object.entries(this.#docSynchronizers).map(
+      Object.entries(this.docSynchronizers).map(
         ([documentId, synchronizer]) => {
           return [documentId, synchronizer.metrics()]
         }

package/test/Repo.test.ts

@@ -832,6 +832,46 @@ describe("Repo", () => {
       teardown()
     })
 
+    it("synchronizes changes from bobRepo to charlieRepo when loading from storage", async () => {
+      const { bobRepo, bobStorage, charlieRepo, aliceHandle, teardown } =
+        await setup()
+
+      // We create a repo that uses bobStorage to put a document into its imaginary disk
+      // without it knowing about it
+      const bobRepo2 = new Repo({
+        storage: bobStorage,
+      })
+      const inStorageHandle = bobRepo2.create<TestDoc>({
+        foo: "foundOnFakeDisk",
+      })
+      await bobRepo2.flush()
+
+      console.log("loading from disk", inStorageHandle.url)
+      // Now, let's load it on the original bob repo (which shares a "disk")
+      const bobFoundIt = bobRepo.find<TestDoc>(inStorageHandle.url)
+      await bobFoundIt.whenReady()
+
+      // Before checking if it syncs, make sure we have it!
+      // (This behaviour is mostly test-validation, we are already testing load/save elsewhere.)
+      assert.deepStrictEqual(await bobFoundIt.doc(), { foo: "foundOnFakeDisk" })
+
+      // We should have a docSynchronizer and its peers should be alice and charlie
+      assert.strictEqual(
+        bobRepo.synchronizer.docSynchronizers[bobFoundIt.documentId]?.hasPeer(
+          "alice" as PeerId
+        ),
+        true
+      )
+      assert.strictEqual(
+        bobRepo.synchronizer.docSynchronizers[bobFoundIt.documentId]?.hasPeer(
+          "charlie" as PeerId
+        ),
+        true
+      )
+
+      teardown()
+    })
+
     it("charlieRepo doesn't have a document it's not supposed to have", async () => {
       const { aliceRepo, bobRepo, charlieRepo, notForCharlie, teardown } =
         await setup()