@dxos/echo-db 2.33.5-dev.0d84e06f → 2.33.5-dev.33d2877e

package/src/halo/party-opener.ts

@@ -4,6 +4,7 @@
 
 import debug from 'debug';
 
+import { KeyType } from '@dxos/credentials';
 import { SubscriptionGroup, Unsubscribe } from '@dxos/util';
 
 import { PartyManager } from '../parties';
@@ -25,7 +26,8 @@ export const autoPartyOpener = (preferences: Preferences, partyManager: PartyMan
     for (const partyDesc of values) {
       if (!partyManager.parties.some(x => x.key === partyDesc.partyKey)) {
         log(`Auto-opening new Party from HALO: ${partyDesc.partyKey.toHex()} hints=${JSON.stringify(partyDesc.keyHints)}`);
-        await partyManager.addParty(partyDesc.partyKey, partyDesc.keyHints);
+        const feedHints = partyDesc.keyHints.filter(hint => hint.type === KeyType.FEED).map(hint => hint.publicKey!);
+        await partyManager.addParty(partyDesc.partyKey, feedHints);
       }
     }
   }));

package/src/invitations/greeting-initiator.ts

@@ -20,7 +20,8 @@ import {
   SecretProvider,
   WithTypeUrl,
   ERR_GREET_CONNECTED_TO_SWARM_TIMEOUT,
-  SignedMessage
+  SignedMessage,
+  NotarizeResponse
 } from '@dxos/credentials';
 import { keyToString, PublicKey } from '@dxos/crypto';
 import { FullyConnectedTopology, NetworkManager } from '@dxos/network-manager';
@@ -111,7 +112,7 @@ export class GreetingInitiator {
   /**
    * Called after connecting to initiate greeting protocol exchange.
    */
-  async redeemInvitation (secretProvider: SecretProvider) {
+  async redeemInvitation (secretProvider: SecretProvider): Promise<{ partyKey: PublicKey, hints: PublicKey[] }> {
     assert(this._state === GreetingState.CONNECTED);
     const { swarmKey } = this._invitationDescriptor;
 
@@ -150,7 +151,7 @@ export class GreetingInitiator {
     const credentialMessages = await this._getMessagesToNotarize(PublicKey.from(partyKey), nonce);
 
     // Send the signed payload to the greeting responder.
-    const notarizeResponse = await this._greeterPlugin.send(responderPeerId,
+    const notarizeResponse: NotarizeResponse = await this._greeterPlugin.send(responderPeerId,
       createGreetingNotarizeMessage(secret, credentialMessages as WithTypeUrl<Message>[]));
 
     //
@@ -171,7 +172,7 @@ export class GreetingInitiator {
     this._state = GreetingState.SUCCEEDED;
     return {
       partyKey,
-      hints: notarizeResponse.hints
+      hints: notarizeResponse.feedHints ?? []
     };
   }
 

package/src/parties/data-party.test.ts

@@ -5,7 +5,7 @@
 import expect from 'expect';
 import { it as test } from 'mocha';
 
-import { createKeyAdmitMessage, createPartyGenesisMessage, defaultSecretProvider, KeyHint, Keyring, KeyType, codec as haloCodec } from '@dxos/credentials';
+import { createKeyAdmitMessage, createPartyGenesisMessage, defaultSecretProvider, Keyring, KeyType, codec as haloCodec } from '@dxos/credentials';
 import { PublicKey } from '@dxos/crypto';
 import { codec } from '@dxos/echo-protocol';
 import { FeedStore } from '@dxos/feed-store';
@@ -22,7 +22,7 @@ import { SnapshotStore } from '../snapshots';
 import { DataParty } from './data-party';
 
 describe('DataParty', () => {
-  const createParty = async (identity: IdentityCredentials, partyKey: PublicKey, hints: KeyHint[]) => {
+  const createParty = async (identity: IdentityCredentials, partyKey: PublicKey, feedHints: PublicKey[]) => {
 
     const storage = createStorage('', StorageType.RAM);
     const snapshotStore = new SnapshotStore(storage.directory('snapshots'));
@@ -40,7 +40,7 @@ describe('DataParty', () => {
       identity.createCredentialsSigner(),
       identity.preferences,
       networkManager,
-      hints
+      feedHints
     );
   };
 
@@ -88,6 +88,7 @@ describe('DataParty', () => {
       feed.key,
       partyKey
     ));
+    await party.processor.feedAdded.waitForCount(1);
 
     const authenticator = createAuthenticator(party.processor, identity.createCredentialsSigner(), party.credentialsWriter);
     const credentialsProvider = createCredentialsProvider(identity.createCredentialsSigner(), party.key, feed.key);
@@ -112,6 +113,8 @@ describe('DataParty', () => {
       feed.key,
       partyKey
     ));
+    await party.processor.feedAdded.waitForCount(1);
+
     const authenticator = createAuthenticator(party.processor, identityA.createCredentialsSigner(), party.credentialsWriter);
 
     const identityB = await deriveTestDeviceCredentials(identityA);
@@ -145,9 +148,7 @@ describe('DataParty', () => {
     ));
 
     const identityB = await deriveTestDeviceCredentials(identityA);
-    const partyB = await createParty(identityB, partyKey.publicKey, [
-      { type: KeyType.FEED, publicKey: feedA.key }
-    ]);
+    const partyB = await createParty(identityB, partyKey.publicKey, [feedA.key]);
     await partyB.open();
 
     await partyA.database.createItem({ type: 'test:item-a' });

package/src/parties/data-party.ts

@@ -5,7 +5,6 @@
 import assert from 'assert';
 
 import { synchronized, Event } from '@dxos/async';
-import { KeyHint } from '@dxos/credentials';
 import { PublicKey } from '@dxos/crypto';
 import { timed } from '@dxos/debug';
 import { PartyKey, PartySnapshot, Timeframe } from '@dxos/echo-protocol';
@@ -57,8 +56,8 @@ export class DataParty {
     // TODO(dmaretskyi): Pull this out to a higher level. Should preferences be part of client API instead?
     private readonly _profilePreferences: Preferences | undefined,
     private readonly _networkManager: NetworkManager,
-    private readonly _hints: KeyHint[] = [],
-    _initialTimeframe?: Timeframe,
+    private readonly _feedHints: PublicKey[] = [],
+    private readonly _initialTimeframe?: Timeframe,
     _options: PartyOptions = {}
   ) {
     this._partyCore = new PartyCore(
@@ -67,7 +66,6 @@ export class DataParty {
       modelFactory,
       snapshotStore,
       this._credentialsSigner.getIdentityKey().publicKey,
-      _initialTimeframe,
       _options
     );
 
@@ -152,7 +150,10 @@ export class DataParty {
       return this;
     }
 
-    await this._partyCore.open(this._hints);
+    await this._partyCore.open({
+      feedHints: this._feedHints,
+      initialTimeframe: this._initialTimeframe
+    });
 
     this._invitationManager = new InvitationFactory(
       this._partyCore.processor,

package/src/parties/party-factory.ts

@@ -9,7 +9,6 @@ import {
   createEnvelopeMessage,
   createFeedAdmitMessage,
   createPartyGenesisMessage,
-  KeyHint,
   KeyType,
   SecretProvider,
   wrapMessage
@@ -111,7 +110,7 @@ export class PartyFactory {
    * @param partyKey
    * @param hints
    */
-  async constructParty (partyKey: PartyKey, hints: KeyHint[] = [], initialTimeframe?: Timeframe) {
+  async constructParty (partyKey: PartyKey, feedHints: PublicKey[] = [], initialTimeframe?: Timeframe) {
     const identity = this._identityProvider() ?? raise(new IdentityNotInitializedError());
 
     // TODO(marik-d): Support read-only parties if this feed doesn't exist?
@@ -128,7 +127,7 @@ export class PartyFactory {
       identity.createCredentialsSigner(),
       identity.preferences,
       this._networkManager,
-      hints,
+      feedHints,
       initialTimeframe,
       this._options
     );

package/src/parties/party-manager.test.ts

@@ -140,10 +140,7 @@ describe('Party manager', () => {
     const feedStream = createWritableFeedStream(feed);
     feedStream.write(createPartyGenesisMessage(keyring, partyKey, feedKey.publicKey, identityKey));
 
-    await partyManager.addParty(partyKey.publicKey, [{
-      type: KeyType.FEED,
-      publicKey: PublicKey.from(feed.key)
-    }]);
+    await partyManager.addParty(partyKey.publicKey, [PublicKey.from(feed.key)]);
 
     await update;
   });

package/src/parties/party-manager.ts

@@ -157,11 +157,9 @@ export class PartyManager {
 
   /**
    * Construct a party object and start replicating with the remote peer that created that party.
-   * @param partyKey
-   * @param hints
    */
   @synchronized
-  async addParty (partyKey: PartyKey, hints: KeyHint[] = []) {
+  async addParty (partyKey: PartyKey, feedHints: PublicKey[] = []) {
     assert(this._open, 'PartyManager is not open.');
 
     /*
@@ -174,8 +172,8 @@ export class PartyManager {
       return this._parties.get(partyKey);
     }
 
-    log(`Adding party partyKey=${partyKey.toHex()} hints=${hints.length}`);
-    const party = await this._partyFactory.constructParty(partyKey, hints);
+    log(`Adding party partyKey=${partyKey.toHex()} hints=${feedHints.length}`);
+    const party = await this._partyFactory.constructParty(partyKey, feedHints);
     await party.open();
     await this._metadataStore.addParty(party.key);
     this._setParty(party);

package/src/pipeline/metadata-store.ts

@@ -90,7 +90,7 @@ export class MetadataStore {
    */
   async clear (): Promise<void> {
     log('Clearing all echo metadata...');
-    await this._directory.destroy();
+    await this._directory.delete();
   }
 
   /**

package/src/pipeline/party-core.test.ts

@@ -161,7 +161,7 @@ describe('PartyCore', () => {
 
     const feedOpened = feedStore.feedOpenedEvent.waitForCount(1);
 
-    await party.open([{ type: KeyType.FEED, publicKey: otherFeedKey }]);
+    await party.open({ feedHints: [otherFeedKey] });
     afterTest(async () => party.close());
 
     await feedOpened;
@@ -281,10 +281,9 @@ describe('PartyCore', () => {
       [peer1.partyKey]
     ));
 
-    await party2.open([{
-      publicKey: peer1.feedKey,
-      type: KeyType.FEED
-    }]);
+    await party2.open({
+      feedHints: [peer1.feedKey]
+    });
     afterTest(async () => party2.close());
 
     createTestProtocolPair(

package/src/pipeline/party-core.ts

@@ -5,7 +5,7 @@
 import assert from 'assert';
 
 import { synchronized } from '@dxos/async';
-import { KeyHint, KeyType, Message as HaloMessage } from '@dxos/credentials';
+import { KeyType, Message as HaloMessage } from '@dxos/credentials';
 import { PublicKey } from '@dxos/crypto';
 import { timed } from '@dxos/debug';
 import { createFeedWriter, DatabaseSnapshot, FeedWriter, PartyKey, PartySnapshot, Timeframe } from '@dxos/echo-protocol';
@@ -28,6 +28,22 @@ export interface PartyOptions {
   snapshotInterval?: number;
 }
 
+export interface OpenOptions {
+  /**
+   * Keys of initial feeds needed to bootstrap the party.
+   */
+  feedHints?: PublicKey[]
+  /**
+   * Timeframe to start processing feed messages from.
+   */
+  initialTimeframe?: Timeframe
+  /**
+   * Timeframe which must be reached until further processing.
+   * PartyCore.open will block until this timeframe is reached.
+   */
+  targetTimeframe?: Timeframe
+}
+
 /**
  * Encapsulates core components needed by a party:
  * - ECHO database with item-manager & item-demuxer.
@@ -55,7 +71,6 @@ export class PartyCore {
     private readonly _modelFactory: ModelFactory,
     private readonly _snapshotStore: SnapshotStore,
     private readonly _memberKey: PublicKey,
-    private readonly _initialTimeframe?: Timeframe,
     private readonly _options: PartyOptions = {}
   ) { }
 
@@ -108,12 +123,17 @@ export class PartyCore {
    */
   @synchronized
   @timed(1_000)
-  async open (keyHints: KeyHint[] = []) {
+  async open (options: OpenOptions = {}) {
+    const {
+      feedHints = [],
+      initialTimeframe
+    } = options;
+
     if (this.isOpen) {
       return this;
     }
 
-    this._timeframeClock = new TimeframeClock(this._initialTimeframe);
+    this._timeframeClock = new TimeframeClock(initialTimeframe);
 
     // Open all feeds known from metadata and open or create a writable feed to the party.
     await this._feedProvider.openKnownFeeds();
@@ -128,12 +148,8 @@ export class PartyCore {
       void this._feedProvider.createOrOpenReadOnlyFeed(feed);
     }));
 
-    // Hint at our own writable feed.
-    // TODO(dmaretskyi): Does not seem like it should be required, but without it replication between devices (B -> A) breaks.
-    await this._partyProcessor.takeHints([{ type: KeyType.FEED, publicKey: writableFeed.key }]);
-
-    if (keyHints.length > 0) {
-      await this._partyProcessor.takeHints(keyHints);
+    if (feedHints.length > 0) {
+      await this._partyProcessor.takeHints(feedHints.map(publicKey => ({ publicKey, type: KeyType.FEED })));
     }
 
     //
@@ -142,7 +158,7 @@ export class PartyCore {
 
     const iterator = await this._feedProvider.createIterator(
       createMessageSelector(this._partyProcessor, this._timeframeClock),
-      this._initialTimeframe
+      initialTimeframe
     );
 
     this._pipeline = new Pipeline(

package/src/snapshots/snapshot-store.ts

@@ -59,6 +59,6 @@ export class SnapshotStore {
    */
   async clear () {
     log('Clearing all snapshots..');
-    await this._directory.destroy();
+    await this._directory.delete();
   }
 }