@dxos/client-services 0.1.41 → 0.1.45-next.45667d4

package/src/packlets/invitations/invitations-service.ts

@@ -5,14 +5,14 @@
 import assert from 'node:assert';
 
 import { Event } from '@dxos/async';
-import { AuthenticatingInvitationObservable, CancellableInvitationObservable } from '@dxos/client';
+import { AuthenticatingInvitationObservable, CancellableInvitationObservable } from '@dxos/client-protocol';
 import { Stream } from '@dxos/codec-protobuf';
 import { log } from '@dxos/log';
 import {
   AuthenticationRequest,
   Invitation,
   InvitationsService,
-  QueryInvitationsResponse
+  QueryInvitationsResponse,
 } from '@dxos/protocols/proto/dxos/client/services';
 
 import { InvitationProtocol } from './invitation-protocol';
@@ -31,7 +31,7 @@ export class InvitationsServiceImpl implements InvitationsService {
 
   constructor(
     private readonly _invitationsHandler: InvitationsHandler,
-    private readonly _getHandler: (invitation: Invitation) => InvitationProtocol
+    private readonly _getHandler: (invitation: Invitation) => InvitationProtocol,
   ) {}
 
   // TODO(burdon): Guest/host label.
@@ -65,7 +65,7 @@ export class InvitationsServiceImpl implements InvitationsService {
         () => {
           close();
           this._createInvitations.delete(invitation.get().invitationId);
-        }
+        },
       );
     });
   }
@@ -94,7 +94,7 @@ export class InvitationsServiceImpl implements InvitationsService {
         () => {
           close();
           this._acceptInvitations.delete(invitation.get().invitationId);
-        }
+        },
       );
     });
   }
@@ -135,7 +135,7 @@ export class InvitationsServiceImpl implements InvitationsService {
         next({
           action: QueryInvitationsResponse.Action.ADDED,
           type: QueryInvitationsResponse.Type.CREATED,
-          invitations: [invitation]
+          invitations: [invitation],
         });
       });
 
@@ -143,7 +143,7 @@ export class InvitationsServiceImpl implements InvitationsService {
         next({
           action: QueryInvitationsResponse.Action.ADDED,
           type: QueryInvitationsResponse.Type.ACCEPTED,
-          invitations: [invitation]
+          invitations: [invitation],
         });
       });
 
@@ -152,7 +152,7 @@ export class InvitationsServiceImpl implements InvitationsService {
         next({
           action: QueryInvitationsResponse.Action.REMOVED,
           type: QueryInvitationsResponse.Type.CREATED,
-          invitations: [invitation]
+          invitations: [invitation],
         });
       });
 
@@ -160,7 +160,7 @@ export class InvitationsServiceImpl implements InvitationsService {
         next({
           action: QueryInvitationsResponse.Action.REMOVED,
           type: QueryInvitationsResponse.Type.ACCEPTED,
-          invitations: [invitation]
+          invitations: [invitation],
         });
       });
 
@@ -168,13 +168,13 @@ export class InvitationsServiceImpl implements InvitationsService {
       next({
         action: QueryInvitationsResponse.Action.ADDED,
         type: QueryInvitationsResponse.Type.CREATED,
-        invitations: Array.from(this._createInvitations.values()).map((invitation) => invitation.get())
+        invitations: Array.from(this._createInvitations.values()).map((invitation) => invitation.get()),
       });
 
       next({
         action: QueryInvitationsResponse.Action.ADDED,
         type: QueryInvitationsResponse.Type.ACCEPTED,
-        invitations: Array.from(this._acceptInvitations.values()).map((invitation) => invitation.get())
+        invitations: Array.from(this._acceptInvitations.values()).map((invitation) => invitation.get()),
       });
     });
   }

package/src/packlets/invitations/space-invitation-protocol.test.ts

@@ -94,10 +94,10 @@ describe('services/space-invitations-protocol', () => {
               }
 
               return false;
-            }
-          }
-        }
-      })
+            },
+          },
+        },
+      }),
     );
 
     expect(attempt).to.eq(1);
@@ -121,7 +121,7 @@ describe('services/space-invitations-protocol', () => {
     }
 
     expect(
-      guest.identityManager.identity?.space.spaceState.getCredentialsOfType('dxos.halo.credentials.SpaceMember').length
+      guest.identityManager.identity?.space.spaceState.getCredentialsOfType('dxos.halo.credentials.SpaceMember').length,
     ).to.equal(2); // own halo + newly joined space.
   });
 
@@ -146,14 +146,14 @@ describe('services/space-invitations-protocol', () => {
             void invitation.cancel();
             return true;
           },
-          onSuccess: () => raise(new Error('invitation success'))
+          onSuccess: () => raise(new Error('invitation success')),
         },
         guest: {
           onConnecting: (invitation) => {
             guestConnected.wake(invitation.get());
-          }
-        }
-      }
+          },
+        },
+      },
     });
 
     const { swarmKey: swarmKey1 } = await hostConnected.wait();

package/src/packlets/invitations/space-invitation-protocol.ts

@@ -5,7 +5,6 @@
 import assert from 'node:assert';
 
 import { createAdmissionCredentials, getCredentialAssertion } from '@dxos/credentials';
-import { SigningContext } from '@dxos/echo-pipeline';
 import { writeMessages } from '@dxos/feed-store';
 import { Keyring } from '@dxos/keyring';
 import { PublicKey } from '@dxos/keys';
@@ -15,7 +14,7 @@ import { FeedMessage } from '@dxos/protocols/proto/dxos/echo/feed';
 import { ProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
 import { AdmissionRequest, AdmissionResponse, IntroductionRequest } from '@dxos/protocols/proto/dxos/halo/invitations';
 
-import { DataSpaceManager } from '../spaces';
+import { DataSpaceManager, SigningContext } from '../spaces';
 import { InvitationProtocol } from './invitation-protocol';
 
 export class SpaceInvitationProtocol implements InvitationProtocol {
@@ -23,20 +22,20 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
     private readonly _spaceManager: DataSpaceManager,
     private readonly _signingContext: SigningContext,
     private readonly _keyring: Keyring,
-    private readonly _spaceKey?: PublicKey
+    private readonly _spaceKey?: PublicKey,
   ) {}
 
   toJSON(): object {
     return {
       deviceKey: this._signingContext.deviceKey,
-      spaceKey: this._spaceKey
+      spaceKey: this._spaceKey,
     };
   }
 
   getInvitationContext(): Partial<Invitation> & Pick<Invitation, 'kind'> {
     return {
       kind: Invitation.Kind.SPACE,
-      spaceKey: this._spaceKey
+      spaceKey: this._spaceKey,
     };
   }
 
@@ -55,7 +54,7 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
       identityKey,
       space.key,
       space.inner.genesisFeedKey,
-      guestProfile
+      guestProfile,
     );
 
     // TODO(dmaretskyi): Refactor.
@@ -69,14 +68,14 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
       space: {
         credential: spaceMemberCredential,
         controlTimeframe: space.inner.controlPipeline.state.timeframe,
-        dataTimeframe: space.dataPipeline.pipelineState?.timeframe
-      }
+        dataTimeframe: space.dataPipeline.pipelineState?.timeframe,
+      },
     };
   }
 
   createIntroduction(): IntroductionRequest {
     return {
-      profile: this._signingContext.profile
+      profile: this._signingContext.profile,
     };
   }
 
@@ -90,8 +89,8 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
         identityKey: this._signingContext.identityKey,
         deviceKey: this._signingContext.deviceKey,
         controlFeedKey,
-        dataFeedKey
-      }
+        dataFeedKey,
+      },
     };
   }
 
@@ -107,7 +106,7 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
       spaceKey: assertion.spaceKey,
       genesisFeedKey: assertion.genesisFeedKey,
       controlTimeframe,
-      dataTimeframe
+      dataTimeframe,
     });
 
     await this._signingContext.recordCredential(credential);

package/src/packlets/logging/logging-service.ts

@@ -56,19 +56,24 @@ export class LoggingServiceImpl implements LoggingService {
 /**
  * Recursively converts an object into a JSON-compatible object.
  */
-const jsonify = (value: any): any => {
+const jsonify = (value: any, handles = new WeakSet<any>()): any => {
   if (typeof value === 'function') {
     return null;
   } else if (typeof value === 'object' && value !== null) {
+    if (handles.has(value)) {
+      return null;
+    }
+    handles.add(value);
+
     if (Array.isArray(value)) {
-      return value.map(jsonify);
+      return value.map((x) => jsonify(x, handles));
     } else {
       if (typeof value.toJSON === 'function') {
         return value.toJSON();
       }
       const res: any = {};
       for (const key of Object.keys(value)) {
-        res[key] = jsonify(value[key]);
+        res[key] = jsonify(value[key], handles);
       }
       return res;
     }

package/src/packlets/network/network-service.test.ts

@@ -19,7 +19,7 @@ describe('NetworkService', () => {
   beforeEach(async () => {
     serviceContext = createServiceContext();
     await serviceContext.open();
-    networkService = new NetworkServiceImpl(serviceContext.networkManager);
+    networkService = new NetworkServiceImpl(serviceContext.networkManager, serviceContext.signalManager);
   });
 
   afterEach(async () => {
@@ -27,25 +27,25 @@ describe('NetworkService', () => {
   });
 
   test('setNetworkOptions changes network status', async () => {
-    await networkService.setNetworkOptions({
-      state: ConnectionState.OFFLINE
+    await networkService.updateConfig({
+      swarm: ConnectionState.OFFLINE,
     });
 
     expect(serviceContext.networkManager.connectionState).to.equal(ConnectionState.OFFLINE);
   });
 
   test('subscribeToNetworkStatus returns current network status', async () => {
-    const query = networkService.subscribeToNetworkStatus();
+    const query = networkService.queryStatus();
     let result = new Trigger<ConnectionState | undefined>();
-    query.subscribe(({ state }) => {
-      result.wake(state);
+    query.subscribe(({ swarm }) => {
+      result.wake(swarm);
     });
     afterTest(() => query.close());
     expect(await result.wait()).to.equal(ConnectionState.ONLINE);
 
     result = new Trigger<ConnectionState | undefined>();
-    await networkService.setNetworkOptions({
-      state: ConnectionState.OFFLINE
+    await networkService.updateConfig({
+      swarm: ConnectionState.OFFLINE,
     });
     expect(await result.wait()).to.equal(ConnectionState.OFFLINE);
   });

package/src/packlets/network/network-service.ts

@@ -3,22 +3,34 @@
 //
 
 import { Stream } from '@dxos/codec-protobuf';
+import { SignalManager } from '@dxos/messaging';
 import { NetworkManager } from '@dxos/network-manager';
-import { NetworkService, NetworkStatus, SetNetworkOptionsRequest } from '@dxos/protocols/proto/dxos/client/services';
+import { NetworkService, NetworkStatus, UpdateConfigRequest } from '@dxos/protocols/proto/dxos/client/services';
 
 export class NetworkServiceImpl implements NetworkService {
-  constructor(private readonly networkManager: NetworkManager) {}
+  constructor(private readonly networkManager: NetworkManager, private readonly signalManager: SignalManager) {}
 
-  subscribeToNetworkStatus() {
+  queryStatus() {
     return new Stream<NetworkStatus>(({ next }) => {
-      const unsubscribe = this.networkManager.connectionStateChanged.on((state) => next({ state }));
-      next({ state: this.networkManager.connectionState });
+      const update = () => {
+        next({
+          swarm: this.networkManager.connectionState,
+          signaling: this.signalManager.getStatus().map(({ host, state }) => ({ server: host, state })),
+        });
+      };
 
-      return unsubscribe;
+      const unsubscribeSwarm = this.networkManager.connectionStateChanged.on(() => update());
+      const unsubscribeSignal = this.signalManager.statusChanged.on(() => update());
+      update();
+
+      return () => {
+        unsubscribeSwarm();
+        unsubscribeSignal();
+      };
     });
   }
 
-  async setNetworkOptions(request: SetNetworkOptionsRequest) {
-    await this.networkManager.setConnectionState(request.state);
+  async updateConfig(request: UpdateConfigRequest) {
+    await this.networkManager.setConnectionState(request.swarm);
   }
 }

package/src/packlets/services/client-rpc-server.ts

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { ClientServices } from '@dxos/client';
+import { ClientServices } from '@dxos/client-protocol';
 import { Any, ServiceHandler, Stream } from '@dxos/codec-protobuf';
 import { raise } from '@dxos/debug';
 import { parseMethodName, RpcPeer, RpcPeerOptions } from '@dxos/rpc';
@@ -15,12 +15,12 @@ export type ClientRpcServerParams = {
   handleCall?: (
     method: string,
     params: Any,
-    handler: (method: string, params: Any) => MaybePromise<Any>
+    handler: (method: string, params: Any) => MaybePromise<Any>,
   ) => Promise<Any>;
   handleStream?: (
     method: string,
     params: Any,
-    handler: (method: string, params: Any) => Stream<Any>
+    handler: (method: string, params: Any) => Stream<Any>,
   ) => MaybePromise<Stream<Any>>;
 } & Omit<RpcPeerOptions, 'callHandler' | 'streamHandler'>;
 
@@ -59,7 +59,7 @@ export class ClientRpcServer {
         } else {
           return handler(methodName, params);
         }
-      }
+      },
     });
   }
 
@@ -75,7 +75,7 @@ export class ClientRpcServer {
     if (!this._handlerCache.has(serviceName)) {
       const [key, descriptor] =
         Object.entries(this._serviceRegistry.descriptors).find(
-          ([key, descriptor]) => descriptor.name === serviceName
+          ([key, descriptor]) => descriptor.name === serviceName,
         ) ?? raise(new Error(`Service not available: ${serviceName}`));
 
       const service = this._serviceRegistry.services[key as keyof ClientServices];

package/src/packlets/services/index.ts

@@ -6,4 +6,3 @@ export * from './local-client-services';
 export * from './service-context';
 export * from './service-host';
 export * from './service-registry';
-export * from './utils';

package/src/packlets/services/local-client-services.ts

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { ClientServices, ClientServicesProvider } from '@dxos/client';
+import { ClientServices, ClientServicesProvider } from '@dxos/client-protocol';
 import { ServiceBundle } from '@dxos/rpc';
 
 import { ClientServicesHost, ClientServicesHostParams } from './service-host';

package/src/packlets/services/service-context.test.ts

@@ -2,8 +2,8 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Invitation } from '@dxos/client';
 import { MemorySignalManagerContext } from '@dxos/messaging';
+import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
 import { describe, test } from '@dxos/test';
 
 import { createServiceContext, syncItemsLocal } from '../testing';
@@ -53,8 +53,8 @@ describe('services/ServiceContext', () => {
       performInvitation({
         host: identity2,
         guest: device1,
-        options: { kind: Invitation.Kind.SPACE, spaceKey: space1.key }
-      })
+        options: { kind: Invitation.Kind.SPACE, spaceKey: space1.key },
+      }),
     );
 
     await device2.dataSpaceManager!.waitUntilSpaceReady(space1!.key);

package/src/packlets/services/service-context.ts

@@ -5,24 +5,24 @@
 import assert from 'node:assert';
 
 import { Trigger } from '@dxos/async';
-import { Invitation } from '@dxos/client';
 import { CredentialConsumer, getCredentialAssertion } from '@dxos/credentials';
 import { failUndefined } from '@dxos/debug';
 import {
   valueEncoding,
   MetadataStore,
   SpaceManager,
-  SigningContext,
   DataServiceSubscriptions,
-  SnapshotStore
+  SnapshotStore,
 } from '@dxos/echo-pipeline';
 import { FeedFactory, FeedStore } from '@dxos/feed-store';
 import { Keyring } from '@dxos/keyring';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
+import { SignalManager } from '@dxos/messaging';
 import { ModelFactory } from '@dxos/model-factory';
 import { NetworkManager } from '@dxos/network-manager';
 import { trace } from '@dxos/protocols';
+import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
 import type { FeedMessage } from '@dxos/protocols/proto/dxos/echo/feed';
 import { Credential } from '@dxos/protocols/proto/dxos/halo/credentials';
 import { Storage } from '@dxos/random-access-storage';
@@ -32,9 +32,9 @@ import {
   DeviceInvitationProtocol,
   InvitationsHandler,
   InvitationProtocol,
-  SpaceInvitationProtocol
+  SpaceInvitationProtocol,
 } from '../invitations';
-import { DataSpaceManager } from '../spaces';
+import { DataSpaceManager, SigningContext } from '../spaces';
 
 /**
  * Shared backend for all client services.
@@ -67,9 +67,9 @@ export class ServiceContext {
   constructor(
     public readonly storage: Storage,
     public readonly networkManager: NetworkManager,
+    public readonly signalManager: SignalManager,
     public readonly modelFactory: ModelFactory
   ) {
-    networkManager._traceParent = this._instanceId;
     // TODO(burdon): Move strings to constants.
     this.metadataStore = new MetadataStore(storage.createDirectory('metadata'));
     this.snapshotStore = new SnapshotStore(storage.createDirectory('snapshots'));
@@ -87,9 +87,11 @@ export class ServiceContext {
 
     this.spaceManager = new SpaceManager({
       feedStore: this.feedStore,
-      networkManager: this.networkManager
+      networkManager: this.networkManager,
+      metadataStore: this.metadataStore,
+      modelFactory: this.modelFactory,
+      snapshotStore: this.snapshotStore,
     });
-    this.spaceManager._traceParent = this._instanceId;
 
     this.identityManager = new IdentityManager(
       this.metadataStore,
@@ -97,24 +99,27 @@ export class ServiceContext {
       this.feedStore,
       this.spaceManager
     );
-    this.identityManager._traceParent = this._instanceId;
 
     this.invitations = new InvitationsHandler(this.networkManager);
-    this.invitations._traceParent = this._instanceId;
 
     // TODO(burdon): _initialize called in multiple places.
     // TODO(burdon): Call _initialize on success.
-    this._handlerFactories.set(Invitation.Kind.DEVICE, () => new DeviceInvitationProtocol(
-      this.keyring,
-      () => this.identityManager.identity ?? failUndefined(),
-      this._acceptIdentity.bind(this)
-    ));
+    this._handlerFactories.set(
+      Invitation.Kind.DEVICE,
+      () =>
+        new DeviceInvitationProtocol(
+          this.keyring,
+          () => this.identityManager.identity ?? failUndefined(),
+          this._acceptIdentity.bind(this)
+        )
+    );
   }
 
   async open() {
-    log.trace('dxos.sdk.service-context', trace.begin({ id: this._instanceId }));
+    log.trace('dxos.sdk.service-context.open', trace.begin({ id: this._instanceId }));
 
     log('opening...');
+    await this.signalManager.open();
     await this.networkManager.open();
     await this.spaceManager.open();
     await this.identityManager.open();
@@ -122,6 +127,7 @@ export class ServiceContext {
       await this._initialize();
     }
     log('opened');
+    log.trace('dxos.sdk.service-context.open', trace.end({ id: this._instanceId }));
   }
 
   async close() {
@@ -132,10 +138,9 @@ export class ServiceContext {
     await this.spaceManager.close();
     await this.feedStore.close();
     await this.networkManager.close();
+    await this.signalManager.close();
     this.dataServiceSubscriptions.clear();
     log('closed');
-
-    log.trace('dxos.sdk.service-context', trace.end({ id: this._instanceId }));
   }
 
   async createIdentity(params: CreateIdentityOptions = {}) {
@@ -169,7 +174,7 @@ export class ServiceContext {
       profile: identity.profileDocument,
       recordCredential: async (credential) => {
         await identity.controlPipeline.writer.write({ credential: { credential } });
-      }
+      },
     };
 
     this.dataSpaceManager = new DataSpaceManager(
@@ -178,11 +183,8 @@ export class ServiceContext {
       this.dataServiceSubscriptions,
       this.keyring,
       signingContext,
-      this.modelFactory,
       this.feedStore,
-      this.snapshotStore
     );
-    this.dataSpaceManager._traceParent = this._instanceId;
     await this.dataSpaceManager.open();
 
     this._handlerFactories.set(Invitation.Kind.SPACE, (invitation) => {
@@ -214,12 +216,12 @@ export class ServiceContext {
           log('accepting space recorded in halo', { details: assertion });
           await this.dataSpaceManager.acceptSpace({
             spaceKey: assertion.spaceKey,
-            genesisFeedKey: assertion.genesisFeedKey
+            genesisFeedKey: assertion.genesisFeedKey,
           });
         } catch (err) {
           log.catch(err);
         }
-      }
+      },
     });
     await this._deviceSpaceSync.open();
   }

package/src/packlets/services/service-host.test.ts

@@ -43,7 +43,7 @@ describe('ClientServicesHost', () => {
 
     const testCredential = await createMockCredential({
       signer: host._serviceContext.keyring,
-      issuer: host._serviceContext.identityManager.identity!.deviceKey
+      issuer: host._serviceContext.identityManager.identity!.deviceKey,
     });
 
     // Test if Identity exposes haloSpace key.
@@ -56,7 +56,7 @@ describe('ClientServicesHost', () => {
 
     await host.services.SpacesService?.writeCredentials({
       spaceKey: await haloSpace.wait(),
-      credentials: [testCredential]
+      credentials: [testCredential],
     });
 
     const credentials = host.services.SpacesService!.queryCredentials({ spaceKey: await haloSpace.wait() });
@@ -80,21 +80,21 @@ describe('ClientServicesHost', () => {
 
     const testCredential = await createMockCredential({
       signer: host._serviceContext.keyring,
-      issuer: host._serviceContext.identityManager.identity!.deviceKey
+      issuer: host._serviceContext.identityManager.identity!.deviceKey,
     });
 
     const nonce = new Uint8Array([0, 0, 0, 0]);
 
     const presentation = await host.services.IdentityService!.signPresentation({
       presentation: {
-        credentials: [testCredential]
+        credentials: [testCredential],
       },
-      nonce
+      nonce,
     });
 
     expect(presentation.proofs?.[0].nonce).to.deep.equal(nonce);
     expect(await verifyPresentation(presentation)).to.deep.equal({
-      kind: 'pass'
+      kind: 'pass',
     });
   });
 });