[automerge] Upgrade to 1.x

jamesgpearce · jamesgpearce · commit 6893959b49f2 · 2024-01-21T15:36:08.000-04:00
diff --git a/jest.config.js b/jest.config.js
@@ -1,8 +1,8 @@
 const esmModules = [
-  'automerge-repo',
   'cbor-x',
   'electric-sql',
   'wa-sqlite',
+  '@automerge/automerge-repo',
   '@sqlite\\.org/sqlite-wasm',
   '@vlcn\\.io/crsqlite-wasm',
   '@vlcn\\.io/wa-sqlite',
diff --git a/package.json b/package.json
@@ -215,6 +215,7 @@
   },
   "devDependencies": {
     "@automerge/automerge": "^2.1.10",
+    "@automerge/automerge-repo": "^1.0.19",
     "@babel/cli": "^7.23.4",
     "@babel/core": "^7.23.7",
     "@babel/preset-env": "^7.23.8",
@@ -241,7 +242,6 @@
     "@typescript-eslint/parser": "^6.19.0",
     "@vlcn.io/crsqlite-wasm": "^0.16.0",
     "asciichart": "^1.5.25",
-    "automerge-repo": "^0.1.0",
     "babel-eslint": "^10.1.0",
     "babel-jest": "^29.7.0",
     "babel-plugin-transform-import-meta": "^2.2.1",
@@ -291,9 +291,9 @@
     "yjs": "^13.6.10"
   },
   "peerDependencies": {
+    "@automerge/automerge-repo": "^1.0.19",
     "@sqlite.org/sqlite-wasm": "^3.44.2-build3",
     "@vlcn.io/crsqlite-wasm": "^0.16.0",
-    "automerge-repo": "^0.1.0",
     "electric-sql": "^0.8.2",
     "partykit": "^0.0.72",
     "partysocket": "^0.0.20",
@@ -304,13 +304,13 @@
     "yjs": "^13.6.10"
   },
   "peerDependenciesMeta": {
-    "@sqlite.org/sqlite-wasm": {
+    "@automerge/automerge-repo": {
       "optional": true
     },
-    "@vlcn.io/crsqlite-wasm": {
+    "@sqlite.org/sqlite-wasm": {
       "optional": true
     },
-    "automerge-repo": {
+    "@vlcn.io/crsqlite-wasm": {
       "optional": true
     },
     "electric-sql": {
diff --git a/site/guides/10_releases.md b/site/guides/10_releases.md
@@ -335,7 +335,7 @@ const automergePersister = createAutomergePersister(store, docHandler);
 
 await automergePersister.save();
 // Store will be saved to the document.
-console.log(docHandler.doc);
+console.log(await docHandler.doc());
 // -> {tinybase: {t: {pets: {fido: {species: 'dog'}}}, v: {}}}
 automergePersister.destroy();
 
diff --git a/src/persisters/persister-automerge.ts b/src/persisters/persister-automerge.ts
@@ -14,7 +14,7 @@ import {
   objSize,
 } from '../common/obj';
 import {ifNotUndefined, isUndefined} from '../common/other';
-import {DocHandle} from 'automerge-repo';
+import {DocHandle} from '@automerge/automerge-repo';
 import {Id} from '../types/common';
 import {PersisterListener} from '../types/persisters';
 import {TINYBASE} from '../common/strings';
@@ -135,18 +135,20 @@ export const createAutomergePersister = ((
   docObjName = TINYBASE,
   onIgnoredError?: (error: any) => void,
 ): AutomergePersister => {
-  docHandle.change((doc) => (doc[docObjName] = {}));
+  docHandle.change((doc: any) => (doc[docObjName] = {}));
 
-  const getPersisted = async (): Promise<[Tables, Values] | undefined> =>
-    objSize(docHandle.doc[docObjName]) == 2
-      ? getDocContent(docHandle.doc, docObjName)
+  const getPersisted = async (): Promise<[Tables, Values] | undefined> => {
+    const doc = await docHandle.doc();
+    return objSize(doc[docObjName]) == 2
+      ? getDocContent(doc, docObjName)
       : undefined;
+  };
 
   const setPersisted = async (
     getContent: () => [Tables, Values],
     getTransactionChanges?: GetTransactionChanges,
   ): Promise<void> =>
-    docHandle.change((doc) =>
+    docHandle.change((doc: any) =>
       setTransactionChangesToDoc(
         doc,
         docObjName,
diff --git a/src/types/docs/persisters/persister-automerge.js b/src/types/docs/persisters/persister-automerge.js
@@ -70,7 +70,7 @@
  * await persister.save();
  * // Store will be saved to the document.
  *
- * console.log(docHandler.doc);
+ * console.log(await docHandler.doc());
  * // -> {tinybase: {t: {pets: {fido: {species: 'dog'}}}, v: {}}}
  *
  * persister.destroy();
@@ -86,7 +86,7 @@
  *   network: [new BroadcastChannelNetworkAdapter()],
  * });
  * const docHandler1 = repo1.create();
- * await docHandler1.value();
+ * await docHandler1.doc();
  * const store1 = createStore();
  * const persister1 = createAutomergePersister(store1, docHandler1);
  * await persister1.startAutoLoad();
@@ -97,7 +97,7 @@
  *   network: [new BroadcastChannelNetworkAdapter()],
  * });
  * const docHandler2 = repo2.find(docHandler1.documentId);
- * await docHandler2.value();
+ * await docHandler2.doc();
  * const store2 = createStore();
  * const persister2 = createAutomergePersister(store2, docHandler2);
  * await persister2.startAutoLoad();
@@ -106,9 +106,9 @@
  * // A function that waits briefly and then for the documents to synchronize
  * // with each other, merely for the purposes of sequentiality in this example.
  * const syncDocsWait = async () => {
- *   await new Promise((resolve) => setTimeout(() => resolve(0), 10));
- *   await docHandler1.value();
- *   await docHandler2.value();
+ *   await new Promise((resolve) => setTimeout(() => resolve(0), 100));
+ *   await docHandler1.doc();
+ *   await docHandler2.doc();
  * };
  *
  * // Wait for the documents to synchronize in their initial state.
diff --git a/src/types/persisters/persister-automerge.d.ts b/src/types/persisters/persister-automerge.d.ts
@@ -1,6 +1,6 @@
 /// persister-automerge
 
-import {DocHandle} from 'automerge-repo';
+import {DocHandle} from '@automerge/automerge-repo';
 import {Persister} from '../persisters';
 import {Store} from '../store';
 
diff --git a/src/types/with-schemas/persisters/persister-automerge.d.ts b/src/types/with-schemas/persisters/persister-automerge.d.ts
@@ -1,7 +1,7 @@
 /// persister-automerge
 
 import {OptionalSchemas, Store} from '../store';
-import {DocHandle} from 'automerge-repo';
+import {DocHandle} from '@automerge/automerge-repo';
 import {Persister} from '../persisters';
 
 /// AutomergePersister
diff --git a/test/unit/common/automerge-adaptor.ts b/test/unit/common/automerge-adaptor.ts
@@ -1,99 +1,71 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-import {ChannelId, NetworkAdapter, PeerId} from 'automerge-repo';
+import {Message, NetworkAdapter, PeerId} from '@automerge/automerge-repo';
 
-type NetworkEvent = {
-  senderId: PeerId;
-  targetId?: PeerId;
-  type: string;
-  channelId?: ChannelId;
-  message?: any;
-  broadcast?: boolean;
-};
+type ArriveMessage = {type: 'arrive'; senderId: PeerId; targetId: never};
+type WelcomeMessage = {type: 'welcome'; senderId: PeerId; targetId: PeerId};
+type BroadcastChannelMessage = ArriveMessage | WelcomeMessage | Message;
 
 const adaptors: Set<AutomergeTestNetworkAdapter> = new Set();
 
-const sendEvent = (event: NetworkEvent) =>
-  adaptors.forEach((adaptor) => adaptor.receiveEvent(event));
+const broadcast = (message: BroadcastChannelMessage): void =>
+  adaptors.forEach((adaptor) => adaptor.receiveMessage(message));
 
 export const resetNetwork = () => adaptors.clear();
 
 export class AutomergeTestNetworkAdapter extends NetworkAdapter {
   connect(peerId: PeerId) {
     this.peerId = peerId;
     adaptors.add(this);
+    broadcast({type: 'arrive', senderId: peerId} as ArriveMessage);
+    this.emit('ready', {network: this});
   }
 
-  receiveEvent({
-    senderId,
-    targetId,
-    type,
-    channelId,
-    message,
-    broadcast,
-  }: NetworkEvent) {
-    if (targetId && targetId !== this.peerId && !broadcast) {
+  receiveMessage(message: BroadcastChannelMessage) {
+    const peerId: PeerId = this.peerId!;
+    const {targetId, senderId, type} = message;
+    if (targetId && targetId !== peerId) {
       return;
     }
     switch (type) {
       case 'arrive':
-        sendEvent({
+        broadcast({
           senderId: this.peerId!,
           targetId: senderId,
           type: 'welcome',
         });
-        this.announceConnection(channelId!, senderId);
+        this.emit('peer-candidate', {peerId: senderId});
         break;
       case 'welcome':
-        this.announceConnection(channelId!, senderId);
-        break;
-      case 'message':
-        this.emit('message', {
-          senderId,
-          targetId: targetId!,
-          channelId: channelId!,
-          message: new Uint8Array(message),
-          broadcast: broadcast!,
-        });
+        this.emit('peer-candidate', {peerId: senderId});
         break;
       default:
-        throw new Error('unhandled message from network');
+        if (!('data' in message)) {
+          this.emit('message', message);
+        } else {
+          this.emit('message', {
+            ...message,
+            data: new Uint8Array(message.data),
+          });
+        }
+        break;
     }
   }
 
-  announceConnection(channelId: ChannelId, peerId: PeerId) {
-    this.emit('peer-candidate', {peerId, channelId});
-  }
-
-  sendMessage(
-    peerId: PeerId,
-    channelId: ChannelId,
-    uint8message: Uint8Array,
-    broadcast: boolean,
-  ) {
-    const message = uint8message.buffer.slice(
-      uint8message.byteOffset,
-      uint8message.byteOffset + uint8message.byteLength,
-    );
-    sendEvent({
-      senderId: this.peerId!,
-      targetId: peerId,
-      type: 'message',
-      channelId,
-      message,
-      broadcast,
-    });
-  }
-
-  join(joinChannelId: ChannelId) {
-    sendEvent({
-      senderId: this.peerId!,
-      channelId: joinChannelId,
-      type: 'arrive',
-      broadcast: true,
-    });
+  send(message: BroadcastChannelMessage) {
+    if ('data' in message) {
+      broadcast({
+        ...message,
+        data: message.data.buffer.slice(
+          message.data.byteOffset,
+          message.data.byteOffset + message.data.byteLength,
+        ) as any,
+      });
+    } else {
+      broadcast(message);
+    }
   }
 
-  leave() {
+  disconnect() {
     adaptors.delete(this);
   }
 }
diff --git a/test/unit/documentation.test.ts b/test/unit/documentation.test.ts
@@ -1,5 +1,5 @@
 import 'fake-indexeddb/auto';
-import * as AutomergeRepo from 'automerge-repo';
+import * as AutomergeRepo from '@automerge/automerge-repo';
 import * as React from 'react';
 import * as ReactDOMClient from 'react-dom/client';
 import * as ReactDOMTestUtils from 'react-dom/test-utils';
diff --git a/test/unit/persisters/persister-automerge.test.ts b/test/unit/persisters/persister-automerge.test.ts
@@ -2,7 +2,7 @@ import {
   AutomergeTestNetworkAdapter,
   resetNetwork,
 } from '../common/automerge-adaptor';
-import {DocHandle, Repo} from 'automerge-repo';
+import {DocHandle, Repo} from '@automerge/automerge-repo';
 import {Persister, Store, createStore} from 'tinybase/debug';
 import {createAutomergePersister} from 'tinybase/debug/persisters/persister-automerge';
 import {pause} from '../common/other';
@@ -24,33 +24,33 @@ test('custom name', async () => {
   const docHandler = repo1.create();
   const persister = createAutomergePersister(store1, docHandler, 'test');
   await persister.save();
-  expect(docHandler.doc).toEqual({test: {t: {}, v: {}}});
+  expect(await docHandler.doc()).toEqual({test: {t: {}, v: {}}});
 });
 
 describe('Save to empty doc', () => {
   test('nothing', async () => {
     await persister1.save();
-    expect(docHandler1.doc).toEqual({tinybase: {t: {}, v: {}}});
+    expect(await docHandler1.doc()).toEqual({tinybase: {t: {}, v: {}}});
   });
 
   test('tables', async () => {
     store1.setTables({t1: {r1: {c1: 1}}});
     await persister1.save();
-    expect(docHandler1.doc).toEqual({
+    expect(await docHandler1.doc()).toEqual({
       tinybase: {t: {t1: {r1: {c1: 1}}}, v: {}},
     });
   });
 
   test('values', async () => {
     store1.setValues({v1: 1});
     await persister1.save();
-    expect(docHandler1.doc).toEqual({tinybase: {t: {}, v: {v1: 1}}});
+    expect(await docHandler1.doc()).toEqual({tinybase: {t: {}, v: {v1: 1}}});
   });
 
   test('both', async () => {
     store1.setTables({t1: {r1: {c1: 1}}}).setValues({v1: 1});
     await persister1.save();
-    expect(docHandler1.doc).toEqual({
+    expect(await docHandler1.doc()).toEqual({
       tinybase: {t: {t1: {r1: {c1: 1}}}, v: {v1: 1}},
     });
   });
@@ -185,8 +185,8 @@ describe('Two stores, two docs', () => {
 
   const syncDocs = async () => {
     await pause();
-    await docHandler1.value();
-    await docHandler2.value();
+    await docHandler1.doc();
+    await docHandler2.doc();
     await pause();
   };
 
@@ -203,6 +203,7 @@ describe('Two stores, two docs', () => {
   test('manual', async () => {
     store1.setTables({t1: {r1: {c1: 1}}}).setValues({v1: 1});
     await persister1.save();
+
     await syncDocs();
     await persister2.load();
     expect(store2.getContent()).toEqual([{t1: {r1: {c1: 1}}}, {v1: 1}]);
diff --git a/test/unit/persisters/persisters.test.ts b/test/unit/persisters/persisters.test.ts
@@ -2,7 +2,7 @@
 
 import 'fake-indexeddb/auto';
 import {DbSchema, ElectricClient} from 'electric-sql/client/model';
-import {DocHandle, Repo} from 'automerge-repo';
+import {DocHandle, Repo} from '@automerge/automerge-repo';
 import {
   Id,
   Persister,
@@ -507,7 +507,7 @@ const mockAutomerge: Persistable<DocHandle<any>> = {
   getLocationMethod: ['getDocHandle', (location) => location],
   getPersister: createAutomergePersister,
   get: async (docHandle: DocHandle<any>): Promise<[Tables, Values] | void> => {
-    const docContent = docHandle.doc['tinybase'];
+    const docContent = (await docHandle.doc())['tinybase'];
     if (Object.keys(docContent).length > 0) {
       return [docContent['t'], docContent['v']] as [Tables, Values];
     }
