@automerge/automerge-repo 1.0.0-alpha.3 → 1.0.0-alpha.5

package/test/Repo.test.ts

@@ -8,7 +8,7 @@ import {
   DocumentId,
   PeerId,
   SharePolicy,
-} from "../src"
+} from "../src/index.js"
 import { eventPromise } from "../src/helpers/eventPromise.js"
 import { pause, rejectOnTimeout } from "../src/helpers/pause.js"
 import { Repo } from "../src/Repo.js"
@@ -16,19 +16,24 @@ import { DummyNetworkAdapter } from "./helpers/DummyNetworkAdapter.js"
 import { DummyStorageAdapter } from "./helpers/DummyStorageAdapter.js"
 import { getRandomItem } from "./helpers/getRandomItem.js"
 import { TestDoc } from "./types.js"
-import { generateAutomergeUrl, stringifyAutomergeUrl } from "../src/DocUrl"
-import { READY } from "../src/DocHandle"
+import { generateAutomergeUrl, stringifyAutomergeUrl } from "../src/DocUrl.js"
+import { READY, AWAITING_NETWORK } from "../src/DocHandle.js"
+import {
+  generateLargeObject,
+  LargeObject,
+} from "./helpers/generate-large-object.js"
 
 describe("Repo", () => {
   describe("single repo", () => {
-    const setup = () => {
+    const setup = (networkReady = true) => {
       const storageAdapter = new DummyStorageAdapter()
+      const networkAdapter = new DummyNetworkAdapter(networkReady)
 
       const repo = new Repo({
         storage: storageAdapter,
-        network: [new DummyNetworkAdapter()],
+        network: [networkAdapter],
       })
-      return { repo, storageAdapter }
+      return { repo, storageAdapter, networkAdapter }
     }
 
     it("can instantiate a Repo", () => {
@@ -83,6 +88,22 @@ describe("Repo", () => {
       await eventPromise(handle, "unavailable")
     })
 
+    it("doesn't mark a document as unavailable until network adapters are ready", async () => {
+      const { repo, networkAdapter } = setup(false)
+      const url = generateAutomergeUrl()
+      const handle = repo.find<TestDoc>(url)
+
+      let wasUnavailable = false
+      handle.on("unavailable", () => {
+        wasUnavailable = true
+      })
+      await pause(50)
+      assert.equal(wasUnavailable, false)
+
+      networkAdapter.emit("ready", { network: networkAdapter })
+      await eventPromise(handle, "unavailable")
+    })
+
     it("can find a created document", async () => {
       const { repo } = setup()
       const handle = repo.create<TestDoc>()
@@ -100,6 +121,20 @@ describe("Repo", () => {
       assert.equal(v?.foo, "bar")
     })
 
+    it("saves the document when creating it", async () => {
+      const { repo, storageAdapter } = setup()
+      const handle = repo.create<TestDoc>()
+
+      const repo2 = new Repo({
+        storage: storageAdapter,
+        network: [],
+      })
+
+      const bobHandle = repo2.find<TestDoc>(handle.url)
+      await bobHandle.whenReady()
+      assert.equal(bobHandle.isReady(), true)
+    })
+
     it("saves the document when changed and can find it again", async () => {
       const { repo, storageAdapter } = setup()
       const handle = repo.create<TestDoc>()
@@ -129,6 +164,7 @@ describe("Repo", () => {
       handle.change(d => {
         d.foo = "bar"
       })
+      // we now have a snapshot and an incremental change in storage
       assert.equal(handle.isReady(), true)
       await handle.doc()
       repo.delete(handle.documentId)
@@ -241,6 +277,21 @@ describe("Repo", () => {
         assert(storage.keys().length !== 0)
       }
     })
+
+    it("doesn't create multiple snapshots in storage when a series of large changes are made in succession", async () => {
+      const { repo, storageAdapter } = setup()
+      const handle = repo.create<{ objects: LargeObject[] }>()
+
+      for (let i = 0; i < 5; i++) {
+        handle.change(d => {
+          d.objects = []
+          d.objects.push(generateLargeObject(100))
+        })
+      }
+
+      const storageKeyTypes = storageAdapter.keys().map(k => k.split(".")[1])
+      assert(storageKeyTypes.filter(k => k === "snapshot").length === 1)
+    })
   })
 
   describe("sync", async () => {
@@ -297,17 +348,28 @@ describe("Repo", () => {
         bobCharlieChannel.port1.close()
       }
 
+      function doConnectAlice() {
+        aliceRepo.networkSubsystem.addNetworkAdapter(
+          new MessageChannelNetworkAdapter(aliceToBob)
+        )
+        //bobRepo.networkSubsystem.addNetworkAdapter(new MessageChannelNetworkAdapter(bobToAlice))
+      }
+
+      if (connectAlice) {
+        doConnectAlice()
+      }
+
       return {
         teardown,
         aliceRepo,
         bobRepo,
         charlieRepo,
-        aliceNetworkAdapter,
+        connectAliceToBob: doConnectAlice,
       }
     }
 
     const setup = async (connectAlice = true) => {
-      const { teardown, aliceRepo, bobRepo, charlieRepo, aliceNetworkAdapter } =
+      const { teardown, aliceRepo, bobRepo, charlieRepo, connectAliceToBob } =
         setupRepos(connectAlice)
 
       const aliceHandle = aliceRepo.create<TestDoc>()
@@ -345,7 +407,7 @@ describe("Repo", () => {
         notForCharlie,
         notForBob,
         teardown,
-        aliceNetworkAdapter,
+        connectAliceToBob,
       }
     }
 
@@ -443,7 +505,7 @@ describe("Repo", () => {
         notForCharlie,
         aliceRepo,
         teardown,
-        aliceNetworkAdapter,
+        connectAliceToBob,
       } = await setup(false)
 
       const url = stringifyAutomergeUrl({ documentId: notForCharlie })
@@ -452,7 +514,7 @@ describe("Repo", () => {
 
       await eventPromise(handle, "unavailable")
 
-      aliceRepo.networkSubsystem.addNetworkAdapter(aliceNetworkAdapter)
+      connectAliceToBob()
 
       await eventPromise(aliceRepo.networkSubsystem, "peer")
 
@@ -538,9 +600,9 @@ describe("Repo", () => {
         const doc =
           Math.random() < 0.5
             ? // heads, create a new doc
-            repo.create<TestDoc>()
+              repo.create<TestDoc>()
             : // tails, pick a random doc
-            (getRandomItem(docs) as DocHandle<TestDoc>)
+              (getRandomItem(docs) as DocHandle<TestDoc>)
 
         // make sure the doc is ready
         if (!doc.isReady()) {

package/test/StorageSubsystem.test.ts

@@ -4,13 +4,12 @@ import path from "path"
 
 import assert from "assert"
 
-import A from "@automerge/automerge"
+import * as A from "@automerge/automerge/next"
 
 import { DummyStorageAdapter } from "./helpers/DummyStorageAdapter.js"
 import { NodeFSStorageAdapter } from "@automerge/automerge-repo-storage-nodefs"
 
-import { StorageSubsystem } from "../src"
-import { TestDoc } from "./types.js"
+import { StorageSubsystem } from "../src/index.js"
 import { generateAutomergeUrl, parseAutomergeUrl } from "../src/DocUrl.js"
 
 const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "automerge-repo-tests"))

package/test/helpers/DummyNetworkAdapter.ts

@@ -1,8 +1,16 @@
-import { NetworkAdapter } from "../../src"
+import { NetworkAdapter } from "../../src/index.js"
 
 export class DummyNetworkAdapter extends NetworkAdapter {
-  send() {}
-  connect(_: string) {}
-  join() {}
-  leave() {}
+  #startReady = true
+  constructor(startReady: boolean) {
+    super()
+    this.#startReady = startReady
+  }
+  send() { }
+  connect(_: string) {
+    if (this.#startReady) {
+      this.emit("ready", { network: this })
+    }
+  }
+  disconnect() { }
 }

package/test/helpers/DummyStorageAdapter.ts

@@ -1,4 +1,4 @@
-import { StorageAdapter, type StorageKey } from "../../src"
+import { StorageAdapter, type StorageKey } from "../../src/index.js"
 
 export class DummyStorageAdapter implements StorageAdapter {
   #data: Record<string, Uint8Array> = {}

package/test/helpers/generate-large-object.ts

@@ -0,0 +1,13 @@
+export type LargeObject = { [key: string]: number }
+
+export function generateLargeObject(size: number): LargeObject {
+  const largeObject: LargeObject = {}
+
+  for (let i = 0; i < size; i++) {
+    const key = `key${i}`
+    const value = Math.random()
+    largeObject[key] = value
+  }
+
+  return largeObject
+}

package/tsconfig.json

@@ -2,8 +2,8 @@
   "compilerOptions": {
     "target": "ESNext",
     "jsx": "react",
-    "module": "ESNext",
-    "moduleResolution": "node",
+    "module": "NodeNext",
+    "moduleResolution": "Node16",
     "declaration": true,
     "declarationMap": true,
     "outDir": "./dist",