@dxos/client-services 0.1.52 → 0.1.53-main.00be1a9

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

@@ -33,7 +33,7 @@ export class LoggingServiceImpl implements LoggingService {
 
         // Prevent logging feedback loop from logging service.
         if (
-          entry.meta?.file.includes('logging-service') ||
+          entry.meta?.F.includes('logging-service') ||
           (entry.context &&
             Object.values(entry.context).some((value) => typeof value === 'string' && value.includes('LoggingService')))
         ) {
@@ -50,8 +50,8 @@ export class LoggingServiceImpl implements LoggingService {
           timestamp: new Date(),
           meta: {
             // TODO(dmaretskyi): Fix proto.
-            file: entry.meta?.file ?? '',
-            line: entry.meta?.line ?? 0,
+            file: entry.meta?.F ?? '',
+            line: entry.meta?.L ?? 0,
           },
         };
 
@@ -94,7 +94,7 @@ const shouldLog = (entry: NaturalLogEntry, request: QueryLogsRequest): boolean =
   if (request.filters === undefined) {
     return options === QueryLogsRequest.MatchingOptions.INCLUSIVE;
   } else {
-    return request.filters.some((filter) => matchFilter(filter, entry.level, entry.meta?.file ?? '', options));
+    return request.filters.some((filter) => matchFilter(filter, entry.level, entry.meta?.F ?? '', options));
   }
 };
 

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

@@ -36,7 +36,7 @@ describe('services/ServiceContext', () => {
     await device2.dataSpaceManager!.waitUntilSpaceReady(space1!.key);
     const space2 = await device2.dataSpaceManager!.spaces.get(space1.key);
     await syncItemsLocal(space1.dataPipeline, space2!.dataPipeline);
-  });
+  }).tag('flaky');
 
   test('joined space is synchronized on device invitations', async () => {
     const networkContext = new MemorySignalManagerContext();

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

@@ -2,7 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-import assert from 'node:assert';
+import invariant from 'tiny-invariant';
 
 import { Trigger } from '@dxos/async';
 import { CredentialConsumer, getCredentialAssertion } from '@dxos/credentials';
@@ -161,7 +161,7 @@ export class ServiceContext {
 
   getInvitationHandler(invitation: Partial<Invitation> & Pick<Invitation, 'kind'>): InvitationProtocol {
     const factory = this._handlerFactories.get(invitation.kind);
-    assert(factory, `Unknown invitation kind: ${invitation.kind}`);
+    invariant(factory, `Unknown invitation kind: ${invitation.kind}`);
     return factory(invitation);
   }
 
@@ -205,7 +205,7 @@ export class ServiceContext {
     await this.dataSpaceManager.open();
 
     this._handlerFactories.set(Invitation.Kind.SPACE, (invitation) => {
-      assert(this.dataSpaceManager, 'dataSpaceManager not initialized yet');
+      invariant(this.dataSpaceManager, 'dataSpaceManager not initialized yet');
       return new SpaceInvitationProtocol(this.dataSpaceManager, signingContext, this.keyring, invitation.spaceKey);
     });
     this.initialized.wake();

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

@@ -2,11 +2,12 @@
 // Copyright 2021 DXOS.org
 //
 
-import assert from 'node:assert';
+import invariant from 'tiny-invariant';
 
-import { Event } from '@dxos/async';
-import { clientServiceBundle, ClientServices, createDefaultModelFactory } from '@dxos/client-protocol';
+import { Event, synchronized } from '@dxos/async';
+import { clientServiceBundle, ClientServices } from '@dxos/client-protocol';
 import { Config } from '@dxos/config';
+import { DocumentModel } from '@dxos/document-model';
 import { DataServiceImpl } from '@dxos/echo-pipeline';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
@@ -16,6 +17,7 @@ import { createWebRTCTransportFactory, NetworkManager, TransportFactory } from '
 import { trace } from '@dxos/protocols';
 import { SystemStatus } from '@dxos/protocols/proto/dxos/client/services';
 import { Storage } from '@dxos/random-access-storage';
+import { TextModel } from '@dxos/text-model';
 
 import { DevicesServiceImpl } from '../devices';
 import { DevtoolsServiceImpl, DevtoolsHostEvents } from '../devtools';
@@ -30,6 +32,11 @@ import { SystemServiceImpl } from '../system';
 import { ServiceContext } from './service-context';
 import { ServiceRegistry } from './service-registry';
 
+// TODO(burdon): Factor out to spaces.
+export const createDefaultModelFactory = () => {
+  return new ModelFactory().registerModel(DocumentModel).registerModel(TextModel);
+};
+
 export type ClientServicesHostParams = {
   /**
    * Can be omitted if `initialize` is later called.
@@ -150,10 +157,10 @@ export class ClientServicesHost {
    * Can only be called once.
    */
   initialize({ config, ...options }: InitializeOptions) {
-    assert(!this._open, 'service host is open');
+    invariant(!this._open, 'service host is open');
 
     if (config) {
-      assert(!this._config, 'config already set');
+      invariant(!this._config, 'config already set');
 
       this._config = config;
       if (!this._storage) {
@@ -170,7 +177,7 @@ export class ClientServicesHost {
     } = options;
     this._signalManager = signalManager;
 
-    assert(!this._networkManager, 'network manager already set');
+    invariant(!this._networkManager, 'network manager already set');
     this._networkManager = new NetworkManager({
       log: connectionLog,
       transportFactory,
@@ -178,6 +185,7 @@ export class ClientServicesHost {
     });
   }
 
+  @synchronized
   async open() {
     if (this._open) {
       return;
@@ -186,10 +194,10 @@ export class ClientServicesHost {
     const traceId = PublicKey.random().toHex();
     log.trace('dxos.sdk.client-services-host.open', trace.begin({ id: traceId }));
 
-    assert(this._config, 'config not set');
-    assert(this._storage, 'storage not set');
-    assert(this._signalManager, 'signal manager not set');
-    assert(this._networkManager, 'network manager not set');
+    invariant(this._config, 'config not set');
+    invariant(this._storage, 'storage not set');
+    invariant(this._signalManager, 'signal manager not set');
+    invariant(this._networkManager, 'network manager not set');
 
     this._opening = true;
     log('opening...', { lockKey: this._resourceLock?.lockKey });
@@ -251,6 +259,7 @@ export class ClientServicesHost {
     log.trace('dxos.sdk.client-services-host.open', trace.end({ id: traceId }));
   }
 
+  @synchronized
   async close() {
     if (!this._open) {
       return;

package/src/packlets/spaces/data-space-manager.ts

@@ -2,7 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-import assert from 'node:assert';
+import invariant from 'tiny-invariant';
 
 import { Event, synchronized, trackLeaks } from '@dxos/async';
 import { cancelWithContext, Context } from '@dxos/context';
@@ -112,7 +112,7 @@ export class DataSpaceManager {
    */
   @synchronized
   async createSpace() {
-    assert(this._isOpen, 'Not open.');
+    invariant(this._isOpen, 'Not open.');
     const spaceKey = await this._keyring.createKey();
     const controlFeedKey = await this._keyring.createKey();
     const dataFeedKey = await this._keyring.createKey();
@@ -130,7 +130,7 @@ export class DataSpaceManager {
     await this._metadataStore.addSpace(metadata);
 
     const memberCredential = credentials[1];
-    assert(getCredentialAssertion(memberCredential)['@type'] === 'dxos.halo.credentials.SpaceMember');
+    invariant(getCredentialAssertion(memberCredential)['@type'] === 'dxos.halo.credentials.SpaceMember');
     await this._signingContext.recordCredential(memberCredential);
 
     await space.initializeDataPipeline();
@@ -143,8 +143,8 @@ export class DataSpaceManager {
   @synchronized
   async acceptSpace(opts: AcceptSpaceOptions): Promise<DataSpace> {
     log('accept space', { opts });
-    assert(this._isOpen, 'Not open.');
-    assert(!this._spaces.has(opts.spaceKey), 'Space already exists.');
+    invariant(this._isOpen, 'Not open.');
+    invariant(!this._spaces.has(opts.spaceKey), 'Space already exists.');
 
     const metadata: SpaceMetadata = {
       key: opts.spaceKey,
@@ -155,7 +155,6 @@ export class DataSpaceManager {
 
     const space = await this._constructSpace(metadata);
     await this._metadataStore.addSpace(metadata);
-
     space.initializeDataPipelineAsync();
 
     this.updated.emit();

package/src/packlets/spaces/notarization-plugin.ts

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import assert from 'node:assert';
+import invariant from 'tiny-invariant';
 
 import { DeferredTask, Event, scheduleTask, sleep, TimeoutError, Trigger } from '@dxos/async';
 import { Context, rejectOnDispose } from '@dxos/context';
@@ -85,7 +85,7 @@ export class NotarizationPlugin implements CredentialProcessor {
     successDelay = DEFAULT_SUCCESS_DELAY,
   }: NotarizeParams) {
     log('notarize', { credentials });
-    assert(
+    invariant(
       credentials.every((credential) => credential.id),
       'Credentials must have an id',
     );
@@ -175,7 +175,7 @@ export class NotarizationPlugin implements CredentialProcessor {
   }
 
   setWriter(writer: FeedWriter<Credential>) {
-    assert(!this._writer, 'Writer already set.');
+    invariant(!this._writer, 'Writer already set.');
     this._writer = writer;
   }
 
@@ -194,7 +194,7 @@ export class NotarizationPlugin implements CredentialProcessor {
       throw new Error(WRITER_NOT_SET_ERROR_CODE);
     }
     for (const credential of request.credentials ?? []) {
-      assert(credential.id, 'Credential must have an id');
+      invariant(credential.id, 'Credential must have an id');
       if (this._processedCredentials.has(credential.id)) {
         continue;
       }

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

@@ -2,7 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-import { EventSubscriptions, scheduleTask } from '@dxos/async';
+import { EventSubscriptions, UpdateScheduler, scheduleTask } from '@dxos/async';
 import { Stream } from '@dxos/codec-protobuf';
 import { raise, todo } from '@dxos/debug';
 import { DataServiceSubscriptions, SpaceManager, SpaceNotFoundError } from '@dxos/echo-pipeline';
@@ -28,8 +28,6 @@ import { IdentityManager } from '../identity';
 import { DataSpace } from './data-space';
 import { DataSpaceManager } from './data-space-manager';
 
-const TIMEFRAME_UPDATE_DEBOUNCE_TIME = 500;
-
 export class SpacesServiceImpl implements SpacesService {
   constructor(
     private readonly _identityManager: IdentityManager,
@@ -45,7 +43,7 @@ export class SpacesServiceImpl implements SpacesService {
 
     const dataSpaceManager = await this._getDataSpaceManager();
     const space = await dataSpaceManager.createSpace();
-    return this._transformSpace(space);
+    return this._serializeSpace(space);
   }
 
   async updateSpace(request: UpdateSpaceRequest) {
@@ -54,12 +52,16 @@ export class SpacesServiceImpl implements SpacesService {
 
   querySpaces(): Stream<QuerySpacesResponse> {
     return new Stream<QuerySpacesResponse>(({ next, ctx }) => {
-      const onUpdate = async () => {
-        const dataSpaceManager = await this._getDataSpaceManager();
-        const spaces = Array.from(dataSpaceManager.spaces.values()).map((space) => this._transformSpace(space));
-        log('update', { spaces });
-        next({ spaces });
-      };
+      const scheduler = new UpdateScheduler(
+        ctx,
+        async () => {
+          const dataSpaceManager = await this._getDataSpaceManager();
+          const spaces = Array.from(dataSpaceManager.spaces.values()).map((space) => this._serializeSpace(space));
+          log('update', { spaces });
+          next({ spaces });
+        },
+        { maxFrequency: 2 },
+      );
 
       scheduleTask(ctx, async () => {
         const dataSpaceManager = await this._getDataSpaceManager();
@@ -72,31 +74,25 @@ export class SpacesServiceImpl implements SpacesService {
           subscriptions.clear();
 
           for (const space of dataSpaceManager.spaces.values()) {
-            subscriptions.add(space.stateUpdate.on(ctx, onUpdate));
-            subscriptions.add(space.presence.updated.on(ctx, onUpdate));
-            subscriptions.add(space.dataPipeline.onNewEpoch.on(ctx, onUpdate));
+            subscriptions.add(space.stateUpdate.on(ctx, () => scheduler.trigger()));
+            subscriptions.add(space.presence.updated.on(ctx, () => scheduler.trigger()));
+            subscriptions.add(space.dataPipeline.onNewEpoch.on(ctx, () => scheduler.trigger()));
 
             // Pipeline progress.
-            space.inner.controlPipeline.state.timeframeUpdate
-              .debounce(TIMEFRAME_UPDATE_DEBOUNCE_TIME)
-              .on(ctx, onUpdate);
+            space.inner.controlPipeline.state.timeframeUpdate.on(ctx, () => scheduler.trigger());
             if (space.dataPipeline.pipelineState) {
-              subscriptions.add(
-                space.dataPipeline.pipelineState.timeframeUpdate
-                  .debounce(TIMEFRAME_UPDATE_DEBOUNCE_TIME)
-                  .on(ctx, onUpdate),
-              );
+              subscriptions.add(space.dataPipeline.pipelineState.timeframeUpdate.on(ctx, () => scheduler.trigger()));
             }
           }
         };
 
         dataSpaceManager.updated.on(ctx, () => {
           subscribeSpaces();
-          void onUpdate();
+          scheduler.trigger();
         });
         subscribeSpaces();
 
-        void onUpdate();
+        scheduler.trigger();
       });
 
       if (!this._identityManager.identity) {
@@ -151,7 +147,7 @@ export class SpacesServiceImpl implements SpacesService {
     await space.createEpoch();
   }
 
-  private _transformSpace(space: DataSpace): Space {
+  private _serializeSpace(space: DataSpace): Space {
     return {
       spaceKey: space.key,
       state: space.state,

package/src/packlets/testing/invitation-utils.ts

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import assert from 'node:assert';
+import invariant from 'tiny-invariant';
 
 import { Trigger } from '@dxos/async';
 import { AuthenticatingInvitationObservable, CancellableInvitationObservable } from '@dxos/client-protocol';
@@ -82,7 +82,7 @@ export const performInvitation = ({
                   if (hooks?.guest?.onConnecting?.(guestObservable)) {
                     break;
                   }
-                  assert(hostInvitation.swarmKey!.equals(guestInvitation.swarmKey!));
+                  invariant(hostInvitation.swarmKey!.equals(guestInvitation.swarmKey!));
                   break;
                 }
 

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

@@ -2,7 +2,6 @@
 // Copyright 2022 DXOS.org
 //
 
-import { createDefaultModelFactory } from '@dxos/client-protocol';
 import { Config } from '@dxos/config';
 import { Context } from '@dxos/context';
 import { createCredentialSignerWithChain, CredentialGenerator } from '@dxos/credentials';
@@ -15,7 +14,7 @@ import { MemoryTransportFactory, NetworkManager } from '@dxos/network-manager';
 import { createStorage, Storage, StorageType } from '@dxos/random-access-storage';
 import { BlobStore } from '@dxos/teleport-extension-object-sync';
 
-import { ClientServicesHost, ServiceContext } from '../services';
+import { ClientServicesHost, createDefaultModelFactory, ServiceContext } from '../services';
 import { SigningContext } from '../spaces';
 
 //

package/src/packlets/vault/iframe-host-runtime.ts

@@ -3,7 +3,7 @@
 //
 
 import { Trigger } from '@dxos/async';
-import { PROXY_CONNECTION_TIMEOUT } from '@dxos/client-protocol';
+import { PROXY_CONNECTION_TIMEOUT, ShellRuntime } from '@dxos/client-protocol';
 import { Config } from '@dxos/config';
 import { log, logInfo } from '@dxos/log';
 import { MemorySignalManager, MemorySignalManagerContext, WebsocketSignalManager } from '@dxos/messaging';
@@ -13,7 +13,7 @@ import { getAsyncValue, MaybePromise, Provider } from '@dxos/util';
 
 import { ClientServicesHost } from '../services';
 import { ClientRpcServer, ClientRpcServerParams } from '../services/client-rpc-server';
-import { ShellRuntime, ShellRuntimeImpl } from './shell-runtime';
+import { ShellRuntimeImpl } from './shell-runtime';
 
 const LOCK_KEY = 'DXOS_RESOURCE_LOCK';
 

package/src/packlets/vault/iframe-proxy-runtime.ts

@@ -3,7 +3,7 @@
 //
 
 import { Trigger } from '@dxos/async';
-import { iframeServiceBundle, workerServiceBundle, WorkerServiceBundle } from '@dxos/client-protocol';
+import { iframeServiceBundle, ShellRuntime, workerServiceBundle, WorkerServiceBundle } from '@dxos/client-protocol';
 import { Config } from '@dxos/config';
 import { RemoteServiceConnectionError } from '@dxos/errors';
 import { log } from '@dxos/log';
@@ -12,7 +12,7 @@ import { BridgeService } from '@dxos/protocols/proto/dxos/mesh/bridge';
 import { createProtoRpcPeer, ProtoRpcPeer, RpcPort } from '@dxos/rpc';
 import { getAsyncValue, MaybePromise, Provider } from '@dxos/util';
 
-import { ShellRuntime, ShellRuntimeImpl } from './shell-runtime';
+import { ShellRuntimeImpl } from './shell-runtime';
 
 // NOTE: Keep as RpcPorts to avoid dependency on @dxos/rpc-tunnel so we don't depend on browser-specific apis.
 export type IFrameProxyRuntimeParams = {

package/src/packlets/vault/shell-runtime.ts

@@ -2,23 +2,14 @@
 // Copyright 2023 DXOS.org
 //
 
-import assert from 'node:assert';
+import invariant from 'tiny-invariant';
 
 import { Event } from '@dxos/async';
-import { appServiceBundle, AppServiceBundle, shellServiceBundle } from '@dxos/client-protocol';
+import { appServiceBundle, AppServiceBundle, ShellRuntime, shellServiceBundle } from '@dxos/client-protocol';
 import { PublicKey } from '@dxos/keys';
 import { AppContextRequest, LayoutRequest, ShellLayout } from '@dxos/protocols/proto/dxos/iframe';
 import { createProtoRpcPeer, ProtoRpcPeer, RpcPort } from '@dxos/rpc';
 
-export interface ShellRuntime {
-  layoutUpdate: Event<LayoutRequest>;
-  layout: ShellLayout;
-  invitationCode?: string;
-  spaceKey?: PublicKey;
-  setLayout: (layout: ShellLayout, options?: Omit<LayoutRequest, 'layout'>) => void;
-  setAppContext: (context: AppContextRequest) => Promise<void>;
-}
-
 /**
  * Endpoint that handles shell services.
  */
@@ -51,7 +42,7 @@ export class ShellRuntimeImpl implements ShellRuntime {
   }
 
   async setAppContext(context: AppContextRequest) {
-    assert(this._appRpc, 'runtime not open');
+    invariant(this._appRpc, 'runtime not open');
 
     await this._appRpc.rpc.AppService.setContext(context);
   }
@@ -81,40 +72,3 @@ export class ShellRuntimeImpl implements ShellRuntime {
     this._appRpc = undefined;
   }
 }
-
-export class MemoryShellRuntime implements ShellRuntime {
-  readonly layoutUpdate = new Event<LayoutRequest>();
-  readonly contextUpdate = new Event<AppContextRequest>();
-  private _layout: ShellLayout;
-  private _invitationCode?: string;
-  private _spaceKey?: PublicKey;
-
-  constructor({ layout, invitationCode, spaceKey }: Partial<LayoutRequest> & Partial<AppContextRequest> = {}) {
-    this._layout = layout ?? ShellLayout.DEFAULT;
-    this._invitationCode = invitationCode;
-    this._spaceKey = spaceKey;
-  }
-
-  get layout() {
-    return this._layout;
-  }
-
-  get invitationCode() {
-    return this._invitationCode;
-  }
-
-  get spaceKey() {
-    return this._spaceKey;
-  }
-
-  setLayout(layout: ShellLayout, options: Omit<LayoutRequest, 'layout'> = {}) {
-    this._layout = layout;
-    this._invitationCode = options.invitationCode;
-    this._spaceKey = options.spaceKey;
-    this.layoutUpdate.emit({ layout, ...options });
-  }
-
-  async setAppContext(context: AppContextRequest) {
-    this.contextUpdate.emit(context);
-  }
-}

package/src/packlets/vault/worker-session.ts

@@ -2,7 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-import assert from 'node:assert';
+import invariant from 'tiny-invariant';
 
 import { asyncTimeout, Trigger } from '@dxos/async';
 import {
@@ -48,7 +48,7 @@ export class WorkerSession {
   public bridgeService?: BridgeService;
 
   constructor({ serviceHost, systemPort, appPort, shellPort, readySignal }: WorkerSessionParams) {
-    assert(serviceHost);
+    invariant(serviceHost);
     this._serviceHost = serviceHost;
 
     const middleware: Pick<ClientRpcServerParams, 'handleCall' | 'handleStream'> = {