@dxos/echo-db 2.33.5-dev.0a40e013 → 2.33.5-dev.61c93034

package/src/api/selection/selection.test.ts

@@ -24,9 +24,7 @@ const modelFactory = new ModelFactory().registerModel(ObjectModel);
 
 const createModel = (id: ItemID) => modelFactory.createModel(ObjectModel.meta.type, id, {}, PublicKey.random());
 
-const createItem = (id: ItemID, type: ItemType, parent?: Item<any>) => {
-  return new Item(null as any, id, type, createModel(id), undefined, parent);
-};
+const createItem = (id: ItemID, type: ItemType, parent?: Item<any>) => new Item(null as any, id, type, createModel(id), undefined, parent);
 
 const createLink = (id: ItemID, type: ItemType, source: Item<any>, target: Item<any>) => {
   const link = new Link(null as any, id, type, createModel(id), {
@@ -262,17 +260,11 @@ describe('Selection', () => {
     test('complex reducer', () => {
       const query = createReducer({ numItems: 0, numLinks: 0 })
         .filter({ type: ITEM_ORG })
-        .call((items: Item[], { numItems, ...rest }) => {
-          return { ...rest, numItems: numItems + items.length, stage: 'a' };
-        })
+        .call((items: Item[], { numItems, ...rest }) => ({ ...rest, numItems: numItems + items.length, stage: 'a' }))
         .children({ type: ITEM_PROJECT })
-        .call((items: Item[], { numItems, ...rest }) => {
-          return { ...rest, numItems: numItems + items.length, stage: 'b' };
-        })
+        .call((items: Item[], { numItems, ...rest }) => ({ ...rest, numItems: numItems + items.length, stage: 'b' }))
         .links({ type: LINK_MEMBER })
-        .call((links: Link[], { numLinks, ...rest }) => {
-          return { ...rest, numLinks: numLinks + links.length, stage: 'c' };
-        })
+        .call((links: Link[], { numLinks, ...rest }) => ({ ...rest, numLinks: numLinks + links.length, stage: 'c' }))
         .target()
         .exec();
 

package/src/api/selection/selection.ts

@@ -57,13 +57,7 @@ export const createSelection = <R>(
  * @param update
  * @param value Initial reducer value.
  */
-export const createItemSelection = <R>(
-  root: Item<any>,
-  update: Event<Entity[]>,
-  value: R
-): Selection<Item<any>, R> => {
-  return new Selection(() => [[root], value], update, root, value !== undefined);
-};
+export const createItemSelection = <R>(root: Item<any>, update: Event<Entity[]>, value: R): Selection<Item<any>, R> => new Selection(() => [[root], value], update, root, value !== undefined);
 
 /**
  * Selections are used to construct database subscriptions.

package/src/database/item-demuxer.ts

@@ -185,7 +185,7 @@ export class ItemDemuxer {
  * Sort based on parents.
  * @param items
  */
-export function sortItemsTopologically (items: ItemSnapshot[]): ItemSnapshot[] {
+export const sortItemsTopologically = (items: ItemSnapshot[]): ItemSnapshot[] => {
   const snapshots: ItemSnapshot[] = [];
   const seenIds = new Set<ItemID>();
 
@@ -204,4 +204,4 @@ export function sortItemsTopologically (items: ItemSnapshot[]): ItemSnapshot[] {
   }
 
   return snapshots;
-}
+};

package/src/database/item-manager.ts

@@ -375,7 +375,7 @@ export class ItemManager {
 /**
  * Returns a new event that groups all of the updates emitted during single tick into a single event emission.
  */
-function debounceEntityUpdateEvent (event: Event<Entity<any>>): Event<Entity<any>[]> {
+const debounceEntityUpdateEvent = (event: Event<Entity<any>>): Event<Entity<any>[]> => {
   const debouncedEvent = new Event<Entity<any>[]>();
 
   let firing = false;
@@ -395,4 +395,4 @@ function debounceEntityUpdateEvent (event: Event<Entity<any>>): Event<Entity<any
   }));
 
   return debouncedEvent;
-}
+};

package/src/database/testing.ts

@@ -15,7 +15,7 @@ import { FeedDatabaseBackend, RemoteDatabaseBackend } from './database-backend';
 
 export const createInMemoryDatabase = async (modelFactory: ModelFactory) => {
   const feed = new MockFeedWriter<EchoEnvelope>();
-  const inboundStream = new Readable({ read () {}, objectMode: true });
+  const inboundStream = new Readable({ read: () => {}, objectMode: true });
   feed.written.on(([data, meta]) => inboundStream.push({ data, meta: { ...meta, memberKey: PublicKey.random(), timeframe: new Timeframe([[meta.feedKey, meta.seq]]) } }));
 
   const database = new Database(

package/src/halo/identity.ts

@@ -102,7 +102,7 @@ export class Identity implements IdentityCredentials {
 
 export type IdentityProvider = () => Identity | undefined;
 
-function getDeviceKeyChainFromHalo (halo: HaloParty, deviceKey: KeyRecord) {
+const getDeviceKeyChainFromHalo = (halo: HaloParty, deviceKey: KeyRecord) => {
   try {
     return Keyring.buildKeyChain(
       deviceKey.publicKey,
@@ -113,4 +113,4 @@ function getDeviceKeyChainFromHalo (halo: HaloParty, deviceKey: KeyRecord) {
     log('Unable to locate device KeyChain:', err);
     throw err;
   }
-}
+};

package/src/halo/party-opener.ts

@@ -14,7 +14,7 @@ const log = debug('dxos:echo-db:party-opener');
 /**
  * Automatically adds, opens, and clothes parties from HALO preferences.
  */
-export function autoPartyOpener (preferences: Preferences, partyManager: PartyManager): Unsubscribe {
+export const autoPartyOpener = (preferences: Preferences, partyManager: PartyManager): Unsubscribe => {
   const subs = new SubscriptionGroup();
 
   subs.push(preferences.subscribeToJoinedPartyList(async values => {
@@ -46,4 +46,4 @@ export function autoPartyOpener (preferences: Preferences, partyManager: PartyMa
   }));
 
   return () => subs.unsubscribe();
-}
+};

package/src/halo/preferences.ts

@@ -159,16 +159,13 @@ export class Preferences {
   subscribeToJoinedPartyList (callback: (parties: JoinedParty[]) => void): () => void {
     const database = this._getDatabase() ?? raise(new IdentityNotInitializedError());
 
-    const converter = (partyDesc: Item<any>) => {
-      // TODO(burdon): Define type.
-      return {
-        partyKey: PublicKey.from(partyDesc.model.get('publicKey')),
-        keyHints: Object.values(partyDesc.model.get('hints')).map((hint: any) => ({
-          ...hint,
-          publicKey: PublicKey.from(hint.publicKey)
-        } as KeyHint))
-      };
-    };
+    const converter = (partyDesc: Item<any>) => ({
+      partyKey: PublicKey.from(partyDesc.model.get('publicKey')),
+      keyHints: Object.values(partyDesc.model.get('hints')).map((hint: any) => ({
+        ...hint,
+        publicKey: PublicKey.from(hint.publicKey)
+      } as KeyHint))
+    });
 
     const result = database.select({ type: HALO_PARTY_DESCRIPTOR_TYPE }).exec();
 

package/src/invitations/greeting-protocol-provider.ts

@@ -14,12 +14,8 @@ import { protocolFactory } from '@dxos/network-manager';
  */
 // TODO(burdon): When closed?
 // TODO(dboreham): Write a test to check resources are released (no resource leaks).
-export const greetingProtocolProvider = (rendezvousKey: any, peerId: Buffer | Uint8Array, protocolPlugins: any[]) => {
-  return protocolFactory({
-    getTopics: () => {
-      return [rendezvousKey];
-    },
-    session: { peerId: keyToString(peerId) },
-    plugins: protocolPlugins
-  });
-};
+export const greetingProtocolProvider = (rendezvousKey: any, peerId: Buffer | Uint8Array, protocolPlugins: any[]) => protocolFactory({
+  getTopics: () => [rendezvousKey],
+  session: { peerId: keyToString(peerId) },
+  plugins: protocolPlugins
+});

package/src/invitations/greeting-responder.ts

@@ -243,19 +243,15 @@ export class GreetingResponder {
   _gatherHints (): KeyHint[] {
     assert(this._state === GreetingState.SUCCEEDED);
 
-    const memberKeys = this._partyProcessor.memberKeys.map(publicKey => {
-      return {
-        publicKey,
-        type: KeyType.UNKNOWN
-      };
-    });
-
-    const memberFeeds = this._partyProcessor.feedKeys.map(publicKey => {
-      return {
-        publicKey,
-        type: KeyType.FEED
-      };
-    });
+    const memberKeys = this._partyProcessor.memberKeys.map((publicKey) => ({
+      publicKey,
+      type: KeyType.UNKNOWN
+    }));
+
+    const memberFeeds = this._partyProcessor.feedKeys.map((publicKey) => ({
+      publicKey,
+      type: KeyType.FEED
+    }));
 
     return [...memberKeys, ...memberFeeds];
   }

package/src/invitations/offline-invitation-claimer.ts

@@ -170,19 +170,17 @@ export class OfflineInvitationClaimer {
 
   // The secretProvider should provide an `Auth` message signed directly by the Identity key.
   static createSecretProvider (credentials: CredentialsSigner): SecretProvider {
-    return async (info?: SecretInfo) => {
-      return Buffer.from(codec.encode(
-        /* The signed portion of the Auth message includes the ID and authNonce provided
+    return async (info?: SecretInfo) => Buffer.from(codec.encode(
+      /* The signed portion of the Auth message includes the ID and authNonce provided
          * by the `info` object. These values will be validated on the other end.
          */
-        createAuthMessage(
-          credentials.signer,
+      createAuthMessage(
+        credentials.signer,
           info!.id.value,
           credentials.getIdentityKey(),
           credentials.getDeviceSigningKeys(),
           undefined,
           info!.authNonce.value)
-      ));
-    };
+    ));
   }
 }

package/src/pipeline/message-selector.ts

@@ -23,47 +23,41 @@ const log = debug('dxos:echo-db:message-selector');
  * @param partyProcessor
  * @param timeframeClock
  */
-export function createMessageSelector (
-  partyProcessor: PartyProcessor,
-  timeframeClock: TimeframeClock
-): MessageSelector {
-  // TODO(telackey): Add KeyAdmit checks.
-  return candidates => {
-    // Check ECHO message candidates first since they are less expensive than HALO cancidates.
-    for (let i = 0; i < candidates.length; i++) {
-      const { data: { echo } } = candidates[i];
-      const feedKey = PublicKey.from(candidates[i].key);
-      if (!echo) {
-        continue;
-      }
+export const createMessageSelector = (partyProcessor: PartyProcessor, timeframeClock: TimeframeClock): MessageSelector => candidates => {
+  // Check ECHO message candidates first since they are less expensive than HALO cancidates.
+  for (let i = 0; i < candidates.length; i++) {
+    const { data: { echo } } = candidates[i];
+    const feedKey = PublicKey.from(candidates[i].key);
+    if (!echo) {
+      continue;
+    }
 
-      assert(echo.timeframe);
-      if (partyProcessor.isFeedAdmitted(feedKey) && !timeframeClock.hasGaps(echo.timeframe)) {
-        return i;
-      }
+    assert(echo.timeframe);
+    if (partyProcessor.isFeedAdmitted(feedKey) && !timeframeClock.hasGaps(echo.timeframe)) {
+      return i;
+    }
+  }
+
+  // Check HALO message candidates.
+  for (let i = 0; i < candidates.length; i++) {
+    const { data: { halo } } = candidates[i];
+    const feedKey = PublicKey.from(candidates[i].key);
+    if (!halo) {
+      continue;
     }
 
-    // Check HALO message candidates.
-    for (let i = 0; i < candidates.length; i++) {
-      const { data: { halo } } = candidates[i];
-      const feedKey = PublicKey.from(candidates[i].key);
-      if (!halo) {
-        continue;
-      }
+    if (partyProcessor.isFeedAdmitted(feedKey)) {
+      return i;
+    }
 
-      if (partyProcessor.isFeedAdmitted(feedKey)) {
+    if (partyProcessor.genesisRequired) {
+      // TODO(telackey): Add check that this is for the right Party.
+      if (getPartyCredentialMessageType(halo) === PartyCredential.Type.PARTY_GENESIS) {
         return i;
       }
-
-      if (partyProcessor.genesisRequired) {
-        // TODO(telackey): Add check that this is for the right Party.
-        if (getPartyCredentialMessageType(halo) === PartyCredential.Type.PARTY_GENESIS) {
-          return i;
-        }
-      }
     }
+  }
 
-    // Not ready for this message yet.
-    log('Skipping...');
-  };
-}
+  // Not ready for this message yet.
+  log('Skipping...');
+};

package/src/protocol/auth-plugin.ts

@@ -9,6 +9,4 @@ import { Replicator } from '@dxos/protocol-plugin-replicator';
 /**
  * Creates authenticator network-protocol plugin that guards access to the replicator.
  */
-export function createAuthPlugin (authenticator: Authenticator, peerId: PublicKey) {
-  return new AuthPlugin(peerId.asBuffer(), authenticator, [Replicator.extension]);
-}
+export const createAuthPlugin = (authenticator: Authenticator, peerId: PublicKey) => new AuthPlugin(peerId.asBuffer(), authenticator, [Replicator.extension]);

package/src/protocol/authenticator.ts

@@ -12,19 +12,17 @@ import { CredentialsSigner } from './credentials-signer';
 
 const log = debug('dxos:echo-db:authenticator');
 
-export function createAuthenticator (partyProcessor: PartyProcessor, credentialsSigner: CredentialsSigner): Authenticator {
-  return new PartyAuthenticator(partyProcessor.state, async auth => {
-    if (auth.feedAdmit && auth.feedKey && !partyProcessor.isFeedAdmitted(auth.feedKey)) {
-      log(`Admitting feed of authenticated member: ${auth.feedKey}`);
-      await partyProcessor.writeHaloMessage(createEnvelopeMessage(
-        credentialsSigner.signer,
-        partyProcessor.partyKey,
-        auth.feedAdmit,
-        [credentialsSigner.getDeviceSigningKeys()]
-      ));
-    }
-  });
-}
+export const createAuthenticator = (partyProcessor: PartyProcessor, credentialsSigner: CredentialsSigner): Authenticator => new PartyAuthenticator(partyProcessor.state, async auth => {
+  if (auth.feedAdmit && auth.feedKey && !partyProcessor.isFeedAdmitted(auth.feedKey)) {
+    log(`Admitting feed of authenticated member: ${auth.feedKey}`);
+    await partyProcessor.writeHaloMessage(createEnvelopeMessage(
+      credentialsSigner.signer,
+      partyProcessor.partyKey,
+      auth.feedAdmit,
+      [credentialsSigner.getDeviceSigningKeys()]
+    ));
+  }
+});
 
 export interface CredentialsProvider {
   /**
@@ -33,24 +31,22 @@ export interface CredentialsProvider {
   get (): Buffer
 }
 
-export function createCredentialsProvider (credentialsSigner: CredentialsSigner, partyKey: PartyKey, feedKey: FeedKey): CredentialsProvider {
-  return {
-    get: () => {
-      const authMessage = createAuthMessage(
+export const createCredentialsProvider = (credentialsSigner: CredentialsSigner, partyKey: PartyKey, feedKey: FeedKey): CredentialsProvider => ({
+  get: () => {
+    const authMessage = createAuthMessage(
+      credentialsSigner.signer,
+      partyKey,
+      credentialsSigner.getIdentityKey(),
+      credentialsSigner.getDeviceSigningKeys(),
+      feedKey,
+      undefined,
+      createFeedAdmitMessage(
         credentialsSigner.signer,
         partyKey,
-        credentialsSigner.getIdentityKey(),
-        credentialsSigner.getDeviceSigningKeys(),
         feedKey,
-        undefined,
-        createFeedAdmitMessage(
-          credentialsSigner.signer,
-          partyKey,
-          feedKey,
-          [feedKey, credentialsSigner.getDeviceSigningKeys()]
-        )
-      );
-      return Buffer.from(codec.encode(authMessage));
-    }
-  };
-}
+        [feedKey, credentialsSigner.getDeviceSigningKeys()]
+      )
+    );
+    return Buffer.from(codec.encode(authMessage));
+  }
+});

package/src/protocol/halo-recovery-plugin.ts

@@ -12,9 +12,7 @@ import { HaloRecoveryInitiator, InvitationFactory } from '../invitations';
  * Plugin is intended to be used in HALO party swarm.
  *
  */
-export function createHaloRecoveryPlugin (identityKey: PublicKey, invitationFactory: InvitationFactory, peerId: PublicKey) {
-  return new GreetingCommandPlugin(
-    peerId.asBuffer(),
-    HaloRecoveryInitiator.createHaloInvitationClaimHandler(identityKey, invitationFactory)
-  );
-}
+export const createHaloRecoveryPlugin = (identityKey: PublicKey, invitationFactory: InvitationFactory, peerId: PublicKey) => new GreetingCommandPlugin(
+  peerId.asBuffer(),
+  HaloRecoveryInitiator.createHaloInvitationClaimHandler(identityKey, invitationFactory)
+);

package/src/protocol/identity-credentials.ts

@@ -25,7 +25,7 @@ export interface IdentityCredentials {
 
 export type IdentityCredentialsProvider = () => IdentityCredentials | undefined
 
-export async function createTestIdentityCredentials (keyring: Keyring): Promise<IdentityCredentials> {
+export const createTestIdentityCredentials = async (keyring: Keyring): Promise<IdentityCredentials> => {
   const identityKey = await keyring.createKeyRecord({ type: KeyType.IDENTITY });
   const deviceKey = await keyring.createKeyRecord({ type: KeyType.DEVICE });
   const feedKey = await keyring.createKeyRecord({ type: KeyType.FEED });
@@ -53,9 +53,9 @@ export async function createTestIdentityCredentials (keyring: Keyring): Promise<
     preferences: undefined,
     contacts: undefined
   };
-}
+};
 
-export async function deriveTestDeviceCredentials (identity: IdentityCredentials): Promise<IdentityCredentials> {
+export const deriveTestDeviceCredentials = async (identity: IdentityCredentials): Promise<IdentityCredentials> => {
   const deviceKey = await identity.keyring.createKeyRecord({ type: KeyType.DEVICE });
   const keyAdmit = createKeyAdmitMessage(identity.keyring, identity.identityKey.publicKey, deviceKey, [identity.identityKey]);
 
@@ -75,4 +75,4 @@ export async function deriveTestDeviceCredentials (identity: IdentityCredentials
       deviceKeyChain
     )
   };
-}
+};

package/src/protocol/offline-invitation-plugin.ts

@@ -11,9 +11,7 @@ import { InvitationFactory, OfflineInvitationClaimer } from '../invitations';
  * Creates network protocol plugin that allows peers to claim offline invitations.
  * Plugin is intended to be used in data-party swarms.
  */
-export function createOfflineInvitationPlugin (invitationFactory: InvitationFactory, peerId: PublicKey) {
-  return new GreetingCommandPlugin(
-    peerId.asBuffer(),
-    OfflineInvitationClaimer.createOfflineInvitationClaimHandler(invitationFactory)
-  );
-}
+export const createOfflineInvitationPlugin = (invitationFactory: InvitationFactory, peerId: PublicKey) => new GreetingCommandPlugin(
+  peerId.asBuffer(),
+  OfflineInvitationClaimer.createOfflineInvitationClaimHandler(invitationFactory)
+);

package/src/protocol/replicator-plugin.ts

@@ -22,12 +22,10 @@ export const createReplicatorPlugin = (feedProvider: PartyFeedProvider) =>
       return feeds.map((feed) => ({ discoveryKey: feed.feed.discoveryKey }));
     },
 
-    subscribe: (addFeedToReplicatedSet: (feed: any) => void) => {
-      return feedProvider.feedOpened.on(async (feed) => {
-        log(`Adding feed: ${feed.key.toHex()}`);
-        addFeedToReplicatedSet({ discoveryKey: feed.feed.discoveryKey });
-      });
-    },
+    subscribe: (addFeedToReplicatedSet: (feed: any) => void) => feedProvider.feedOpened.on(async (feed) => {
+      log(`Adding feed: ${feed.key.toHex()}`);
+      addFeedToReplicatedSet({ discoveryKey: feed.feed.discoveryKey });
+    }),
 
     replicate: async (remoteFeeds, info) => {
       // We can ignore remoteFeeds entirely, since the set of feeds we want to replicate is dictated by the Party.

package/src/snapshots/snapshot-generator.ts

@@ -10,20 +10,16 @@ import { SnapshotStore } from './snapshot-store';
 
 const log = debug('dxos:snapshot-generator');
 
-export function createAutomaticSnapshots (
-  party: PartyCore, clock: TimeframeClock, store: SnapshotStore, interval: number
-) {
-  return clock.update.on(async timeframe => {
-    const totalMessages = timeframe.totalMessages();
-    if (totalMessages > 0 && totalMessages % interval === 0) {
-      log(`Saving snapshot of ${party.key.humanize()}...`);
-      try {
-        const snapshot = party.createSnapshot();
-        await store.save(snapshot);
-      } catch (err: any) {
-        console.error('Failed to save snapshot');
-        console.error(err);
-      }
+export const createAutomaticSnapshots = (party: PartyCore, clock: TimeframeClock, store: SnapshotStore, interval: number) => clock.update.on(async timeframe => {
+  const totalMessages = timeframe.totalMessages();
+  if (totalMessages > 0 && totalMessages % interval === 0) {
+    log(`Saving snapshot of ${party.key.humanize()}...`);
+    try {
+      const snapshot = party.createSnapshot();
+      await store.save(snapshot);
+    } catch (err: any) {
+      console.error('Failed to save snapshot');
+      console.error(err);
     }
-  });
-}
+  }
+});

package/src/testing/testing-factories.ts

@@ -22,10 +22,10 @@ export type TestPeer = Awaited<ReturnType<typeof createTestInstance>>;
 
 export type WithTestMeta<T> = T & { testMeta: TestPeer }
 
-function addTestMeta<T> (obj: T, meta: TestPeer): WithTestMeta<T> {
+const addTestMeta = <T>(obj: T, meta: TestPeer): WithTestMeta<T> => {
   (obj as any).testMeta = meta;
   return obj as any;
-}
+};
 
 /**
  * Creates a number of test ECHO instances and a party that's shared between all of them.