@dxos/echo-pipeline 0.6.13 → 0.6.14-main.2b6a0f3

package/src/space/space-protocol.browser.test.ts

@@ -2,15 +2,11 @@
 // Copyright 2022 DXOS.org
 //
 
-// @dxos/test platform=browser
-
-import expect from 'expect';
-import waitForExpect from 'wait-for-expect';
+import { describe, expect, test, onTestFinished } from 'vitest';
 
 import { Keyring } from '@dxos/keyring';
 import { PublicKey } from '@dxos/keys';
 import { createStorage } from '@dxos/random-access-storage';
-import { describe, test, afterTest } from '@dxos/test';
 import { Timeframe } from '@dxos/timeframe';
 
 import { TestFeedBuilder, TestAgentBuilder, WebsocketNetworkManagerProvider } from '../testing';
@@ -23,7 +19,9 @@ const SIGNAL_URL = `ws://localhost:${port}/.well-known/dx/signal`;
 describe('space/space-protocol', () => {
   test('two peers discover each other', async () => {
     const builder = new TestAgentBuilder();
-    afterTest(async () => await builder.close());
+    onTestFinished(async () => {
+      await builder.close();
+    });
     const topic = PublicKey.random();
 
     const peer1 = await builder.createPeer();
@@ -39,18 +37,22 @@ describe('space/space-protocol', () => {
     await protocol1.start();
     await protocol2.start();
 
-    afterTest(() => protocol1.stop());
-    afterTest(() => protocol2.stop());
+    onTestFinished(() => protocol1.stop());
+    onTestFinished(() => protocol2.stop());
 
-    await waitForExpect(() => {
-      expect(presence1.getPeersOnline().some(({ identityKey }) => identityKey.equals(peer2.identityKey))).toBeTruthy();
-      expect(presence2.getPeersOnline().some(({ identityKey }) => identityKey.equals(peer1.identityKey))).toBeTruthy();
-    });
+    await expect
+      .poll(() => presence1.getPeersOnline().some(({ identityKey }) => identityKey.equals(peer2.identityKey)))
+      .toBeTruthy();
+    await expect
+      .poll(() => presence2.getPeersOnline().some(({ identityKey }) => identityKey.equals(peer1.identityKey)))
+      .toBeTruthy();
   });
 
   test('replicates a feed', async () => {
     const builder = new TestAgentBuilder();
-    afterTest(async () => await builder.close());
+    onTestFinished(async () => {
+      await builder.close();
+    });
     const topic = PublicKey.random();
 
     const peer1 = await builder.createPeer();
@@ -62,8 +64,8 @@ describe('space/space-protocol', () => {
     await protocol1.start();
     await protocol2.start();
 
-    afterTest(() => protocol1.stop());
-    afterTest(() => protocol2.stop());
+    onTestFinished(() => protocol1.stop());
+    onTestFinished(() => protocol2.stop());
 
     const builder1 = new TestFeedBuilder();
     const feedStore1 = builder1.createFeedStore();
@@ -79,24 +81,23 @@ describe('space/space-protocol', () => {
     await protocol2.addFeed(feed2);
 
     await feed1.append({ timeframe: new Timeframe() });
-    await waitForExpect(() => {
-      expect(feed2.properties.length).toEqual(1);
-    });
+    await expect.poll(() => feed2.properties.length).toEqual(1);
 
     await feed1.append({ timeframe: new Timeframe() });
-    await waitForExpect(() => {
-      expect(feed2.properties.length).toEqual(2);
-    });
+    await expect.poll(() => feed2.properties.length).toEqual(2);
 
     await builder.close();
   });
 
-  test('replicates a feed through a webrtc connection', async () => {
+  // TODO: Some storage drivers may break when there are multiple storage instances.
+  test.skip('replicates a feed through a webrtc connection', async () => {
     const builder = new TestAgentBuilder({
       storage: createStorage(),
       networkManagerProvider: WebsocketNetworkManagerProvider(SIGNAL_URL),
     });
-    afterTest(async () => await builder.close());
+    onTestFinished(async () => {
+      await builder.close();
+    });
 
     const keyring = new Keyring();
     const topic = await keyring.createKey();
@@ -110,8 +111,8 @@ describe('space/space-protocol', () => {
     await protocol1.start();
     await protocol2.start();
 
-    afterTest(() => protocol1.stop());
-    afterTest(() => protocol2.stop());
+    onTestFinished(() => protocol1.stop());
+    onTestFinished(() => protocol2.stop());
 
     const feedKey = await peer1.keyring.createKey();
 
@@ -122,17 +123,11 @@ describe('space/space-protocol', () => {
     await protocol2.addFeed(feed2);
 
     await feed1.append({ timeframe: new Timeframe() });
-    await waitForExpect(() => {
-      expect(feed2.properties.length).toEqual(1);
-    });
+    await expect.poll(() => feed2.properties.length).toEqual(1);
 
     await feed1.append({ timeframe: new Timeframe() });
-    await waitForExpect(() => {
-      expect(feed2.properties.length).toEqual(2);
-    });
+    await expect.poll(() => feed2.properties.length).toEqual(2);
 
     await builder.close();
-  })
-    .skipEnvironments('webkit')
-    .tag('flaky'); // Some storage drivers may break when there are multiple storage instances.
+  });
 });

package/src/space/space-protocol.test.ts

@@ -2,15 +2,13 @@
 // Copyright 2022 DXOS.org
 //
 
-import expect from 'expect';
-import waitForExpect from 'wait-for-expect';
+import { describe, expect, test, onTestFinished } from 'vitest';
 
 import { PublicKey } from '@dxos/keys';
 import { MemorySignalManager, MemorySignalManagerContext } from '@dxos/messaging';
 import { MemoryTransportFactory, SwarmNetworkManager } from '@dxos/network-manager';
 import { StorageType, createStorage } from '@dxos/random-access-storage';
 import { BlobStore } from '@dxos/teleport-extension-object-sync';
-import { describe, test, afterTest } from '@dxos/test';
 import { Timeframe } from '@dxos/timeframe';
 
 import { AuthStatus, MOCK_AUTH_PROVIDER, MOCK_AUTH_VERIFIER, SpaceProtocol } from './space-protocol';
@@ -19,7 +17,9 @@ import { TestAgentBuilder, TestFeedBuilder } from '../testing';
 describe('space/space-protocol', () => {
   test('two peers discover each other via presence', async () => {
     const builder = new TestAgentBuilder();
-    afterTest(async () => await builder.close());
+    onTestFinished(async () => {
+      await builder.close();
+    });
     const topic = PublicKey.random();
 
     const peer1 = await builder.createPeer();
@@ -35,15 +35,21 @@ describe('space/space-protocol', () => {
     const protocol2 = peer2.createSpaceProtocol(topic, gossip2);
 
     await protocol1.start();
-    afterTest(() => protocol1.stop());
+    onTestFinished(() => protocol1.stop());
 
     await protocol2.start();
-    afterTest(() => protocol2.stop());
-
-    await waitForExpect(() => {
-      expect(presence1.getPeersOnline().some(({ identityKey }) => identityKey.equals(peer2.identityKey))).toBeTruthy();
-      expect(presence2.getPeersOnline().some(({ identityKey }) => identityKey.equals(peer1.identityKey))).toBeTruthy();
-    }, 1_000);
+    onTestFinished(() => protocol2.stop());
+
+    await expect
+      .poll(() => presence1.getPeersOnline().some(({ identityKey }) => identityKey.equals(peer2.identityKey)), {
+        timeout: 1_000,
+      })
+      .toBeTruthy();
+    await expect
+      .poll(() => presence2.getPeersOnline().some(({ identityKey }) => identityKey.equals(peer1.identityKey)), {
+        timeout: 1_000,
+      })
+      .toBeTruthy();
   });
 
   test('failing authentication', async () => {
@@ -62,6 +68,10 @@ describe('space/space-protocol', () => {
       networkManager: new SwarmNetworkManager({
         signalManager: new MemorySignalManager(signalContext),
         transportFactory: MemoryTransportFactory,
+        peerInfo: {
+          peerKey: peerId1.toHex(),
+          identityKey: peerId1.toHex(),
+        },
       }),
     });
 
@@ -77,23 +87,27 @@ describe('space/space-protocol', () => {
       networkManager: new SwarmNetworkManager({
         signalManager: new MemorySignalManager(signalContext),
         transportFactory: MemoryTransportFactory,
+        peerInfo: {
+          peerKey: peerId2.toHex(),
+          identityKey: peerId2.toHex(),
+        },
       }),
     });
 
     await protocol1.start();
-    afterTest(() => protocol1.stop());
+    onTestFinished(() => protocol1.stop());
 
     await protocol2.start();
-    afterTest(() => protocol2.stop());
+    onTestFinished(() => protocol2.stop());
 
-    await waitForExpect(() => {
-      expect(protocol1.sessions.get(peerId2)?.authStatus).toEqual(AuthStatus.FAILURE);
-    });
+    await expect.poll(() => protocol1.sessions.get(peerId2)?.authStatus).toEqual(AuthStatus.FAILURE);
   });
 
   test('replicates a feed', async () => {
     const builder = new TestAgentBuilder();
-    afterTest(async () => await builder.close());
+    onTestFinished(async () => {
+      await builder.close();
+    });
 
     const topic = PublicKey.random();
 
@@ -106,8 +120,8 @@ describe('space/space-protocol', () => {
     await protocol1.start();
     await protocol2.start();
 
-    afterTest(() => protocol1.stop());
-    afterTest(() => protocol2.stop());
+    onTestFinished(() => protocol1.stop());
+    onTestFinished(() => protocol2.stop());
 
     //
     // Create feeds.
@@ -131,16 +145,12 @@ describe('space/space-protocol', () => {
 
     // TODO(burdon): Append batch of messages.
     await feed1.append({ timeframe: new Timeframe() });
-    await waitForExpect(() => {
-      // Received message appended before replication.
-      expect(feed2.properties.length).toEqual(1);
-    });
+    // Received message appended before replication.
+    await expect.poll(() => feed2.properties.length).toEqual(1);
 
     // TODO(burdon): Append batch of messages.
     await feed1.append({ timeframe: new Timeframe() });
-    await waitForExpect(() => {
-      // Received message appended after replication.
-      expect(feed2.properties.length).toEqual(2);
-    });
+    // Received message appended after replication.
+    await expect.poll(() => feed2.properties.length).toEqual(2);
   });
 });

package/src/space/space-protocol.ts

@@ -150,10 +150,6 @@ export class SpaceProtocol {
     const topic = await this._topic;
     this._connection = await this._networkManager.joinSwarm({
       protocolProvider: this._createProtocolProvider(credentials),
-      peerInfo: {
-        peerKey: this._swarmIdentity.peerKey.toHex(),
-        identityKey: this._swarmIdentity.identityKey.toHex(),
-      },
       topic,
       topology: this._topology,
       label: `swarm ${topic.truncate()} for space ${this._spaceKey.truncate()}`,

package/src/space/space.test.ts

@@ -2,11 +2,10 @@
 // Copyright 2022 DXOS.org
 //
 
-import expect from 'expect';
+import { onTestFinished, describe, expect, test } from 'vitest';
 
 import { Context } from '@dxos/context';
 import { CredentialGenerator } from '@dxos/credentials';
-import { afterTest, describe, test } from '@dxos/test';
 
 import { TestAgentBuilder } from '../testing';
 
@@ -16,13 +15,17 @@ const run = <T>(cb: () => Promise<T>): Promise<T> => cb();
 describe('space/space', () => {
   test('creates a database with object model', async () => {
     const builder = new TestAgentBuilder();
-    afterTest(async () => await builder.close());
+    onTestFinished(async () => {
+      await builder.close();
+    });
     const agent = await builder.createPeer();
     const space = await agent.createSpace();
 
     await space.open(Context.default());
     expect(space.isOpen).toBeTruthy();
-    afterTest(() => space.close());
+    onTestFinished(async () => {
+      await space.close();
+    });
 
     await agent.spaceGenesis(space);
 
@@ -34,7 +37,9 @@ describe('space/space', () => {
 
   test('two spaces replicating', async () => {
     const builder = new TestAgentBuilder();
-    afterTest(async () => await builder.close());
+    onTestFinished(async () => {
+      await builder.close();
+    });
 
     //
     // Agent 1
@@ -44,8 +49,11 @@ describe('space/space', () => {
       const space = await agent.createSpace(agent.identityKey);
 
       await space.open(Context.default());
+      await space.startProtocol();
       expect(space.isOpen).toBeTruthy();
-      afterTest(() => space.close());
+      onTestFinished(async () => {
+        await space.close();
+      });
 
       await agent.spaceGenesis(space);
 
@@ -63,8 +71,11 @@ describe('space/space', () => {
       const space = await agent.createSpace(agent.identityKey, space1.key, space1.genesisFeedKey, undefined, true);
 
       await space.open(Context.default());
+      await space.startProtocol();
       expect(space.isOpen).toBeTruthy();
-      afterTest(() => space.close());
+      onTestFinished(async () => {
+        await space.close();
+      });
 
       return [agent, space];
     });
@@ -110,13 +121,17 @@ describe('space/space', () => {
 
   test('open & close', async () => {
     const builder = new TestAgentBuilder();
-    afterTest(async () => await builder.close());
+    onTestFinished(async () => {
+      await builder.close();
+    });
     const agent = await builder.createPeer();
     const space1 = await agent.createSpace();
 
     await space1.open(Context.default());
     expect(space1.isOpen).toBeTruthy();
-    afterTest(() => space1.close());
+    onTestFinished(async () => {
+      await space1.close();
+    });
 
     await agent.spaceGenesis(space1);
 
@@ -134,13 +149,17 @@ describe('space/space', () => {
 
   test('re-open', async () => {
     const builder = new TestAgentBuilder();
-    afterTest(async () => await builder.close());
+    onTestFinished(async () => {
+      await builder.close();
+    });
     const agent = await builder.createPeer();
     const space = await agent.createSpace();
 
     {
       await space.open(Context.default());
-      afterTest(() => space.close());
+      onTestFinished(async () => {
+        await space.close();
+      });
       expect(space.isOpen).toBeTruthy();
 
       await agent.spaceGenesis(space);

package/src/space/space.ts

@@ -176,12 +176,17 @@ export class Space extends Resource {
 
     // Order is important.
     await this._controlPipeline.start();
-    await this.protocol.start();
-    await this.protocol.addFeed(await this._feedProvider(this._genesisFeedKey));
 
     log('opened');
   }
 
+  @synchronized
+  public async startProtocol() {
+    invariant(this.isOpen);
+    await this.protocol.start();
+    await this.protocol.addFeed(await this._feedProvider(this._genesisFeedKey));
+  }
+
   @synchronized
   protected override async _close() {
     log('closing...', { key: this._key });

package/src/testing/test-agent-builder.ts

@@ -8,7 +8,7 @@ import { type FeedStore } from '@dxos/feed-store';
 import { type Keyring } from '@dxos/keyring';
 import { PublicKey } from '@dxos/keys';
 import { MemorySignalManager, MemorySignalManagerContext, WebsocketSignalManager } from '@dxos/messaging';
-import { MemoryTransportFactory, SwarmNetworkManager, createSimplePeerTransportFactory } from '@dxos/network-manager';
+import { MemoryTransportFactory, SwarmNetworkManager, createRtcTransportFactory } from '@dxos/network-manager';
 import type { FeedMessage } from '@dxos/protocols/proto/dxos/echo/feed';
 import { type SpaceMetadata } from '@dxos/protocols/proto/dxos/echo/metadata';
 import { AdmittedFeed } from '@dxos/protocols/proto/dxos/halo/credentials';
@@ -36,7 +36,7 @@ export const WebsocketNetworkManagerProvider =
   () =>
     new SwarmNetworkManager({
       signalManager: new WebsocketSignalManager([{ server: signalUrl }]),
-      transportFactory: createSimplePeerTransportFactory(),
+      transportFactory: createRtcTransportFactory(),
     });
 
 export type TestAgentBuilderOptions = {
@@ -127,11 +127,23 @@ export class TestAgent {
     return this._spaces.get(spaceKey);
   }
 
+  private _networkManager?: SwarmNetworkManager;
+  get networkManager() {
+    if (this._networkManager) {
+      return this._networkManager;
+    }
+
+    this._networkManager = this._networkManagerProvider();
+    this._networkManager.setPeerInfo({ peerKey: this.deviceKey.toHex(), identityKey: this.identityKey.toHex() });
+
+    return this._networkManager;
+  }
+
   private _spaceManager?: SpaceManager;
   get spaceManager() {
     return (this._spaceManager ??= new SpaceManager({
       feedStore: this.feedStore,
-      networkManager: this._networkManagerProvider(),
+      networkManager: this.networkManager,
       metadataStore: this.metadataStore,
       blobStore: this.blobStore,
     }));
@@ -205,7 +217,7 @@ export class TestAgent {
         credentialProvider: MOCK_AUTH_PROVIDER,
         credentialAuthenticator: MOCK_AUTH_VERIFIER,
       },
-      networkManager: this._networkManagerProvider(),
+      networkManager: this.networkManager,
       blobStore: this.blobStore,
       onSessionAuth: (session) => {
         session.addExtension(

package/src/testing/test-replicator.ts

@@ -3,10 +3,10 @@
 //
 
 import { sleep, synchronized } from '@dxos/async';
-import { type Message } from '@dxos/automerge/automerge-repo';
 import { type Context, LifecycleState, Resource } from '@dxos/context';
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
+import type { AutomergeProtocolMessage } from '@dxos/protocols';
 import { AutomergeReplicator, type AutomergeReplicatorFactory } from '@dxos/teleport-extension-automerge-replicator';
 
 import type {
@@ -159,8 +159,8 @@ export class TestReplicatorConnection implements ReplicatorConnection {
 
   constructor(
     public readonly peerId: string,
-    public readonly readable: ReadableStream<Message>,
-    public readonly writable: WritableStream<Message>,
+    public readonly readable: ReadableStream<AutomergeProtocolMessage>,
+    public readonly writable: WritableStream<AutomergeProtocolMessage>,
   ) {}
 
   async shouldAdvertise(params: ShouldAdvertiseParams): Promise<boolean> {