@dxos/client-services 0.1.30-next.7c60cd3 → 0.1.30

package/src/packlets/tests/shared-worker.test.ts

@@ -0,0 +1,93 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import chai, { expect } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+
+import { sleep } from '@dxos/async';
+import { Client, ClientServicesProxy, fromIFrame } from '@dxos/client';
+import { Config } from '@dxos/config';
+import { createLinkedPorts } from '@dxos/rpc';
+import { describe, test, afterTest } from '@dxos/test';
+import { MaybePromise } from '@dxos/util';
+
+import { TestBuilder } from '../testing';
+import { IFrameProxyRuntime, WorkerRuntime } from '../vault';
+
+chai.use(chaiAsPromised);
+
+const setup = (getConfig: () => MaybePromise<Config>) => {
+  const workerRuntime = new WorkerRuntime(getConfig);
+
+  const systemPorts = createLinkedPorts();
+  const workerProxyPorts = createLinkedPorts();
+  const proxyWindowPorts = createLinkedPorts();
+  const shellPorts = createLinkedPorts();
+  void workerRuntime.createSession({
+    systemPort: systemPorts[1],
+    appPort: workerProxyPorts[1],
+    shellPort: shellPorts[1]
+  });
+  const clientProxy = new IFrameProxyRuntime({
+    systemPort: systemPorts[0],
+    windowAppPort: proxyWindowPorts[0],
+    workerAppPort: workerProxyPorts[0],
+    shellPort: shellPorts[0]
+  });
+  const client = new Client({
+    services: new ClientServicesProxy(proxyWindowPorts[1])
+  });
+
+  return { workerRuntime, clientProxy, client };
+};
+
+describe('Shared worker', () => {
+  test('client connects to the worker', async () => {
+    const { workerRuntime, clientProxy, client } = setup(() => new Config({}));
+
+    await Promise.all([workerRuntime.start(), clientProxy.open('*'), client.initialize()]);
+
+    await client.halo.createIdentity();
+  });
+
+  test('initialization errors get propagated to the client', async () => {
+    const { workerRuntime, clientProxy, client } = setup(async () => {
+      await sleep(1);
+      throw new Error('Test error');
+    });
+
+    const promise = Promise.all([
+      workerRuntime.start().catch(() => {}), // This error should be propagated to client.initialize() call.
+      clientProxy.open('*')
+    ]);
+
+    await expect(client.initialize()).to.be.rejectedWith('Test error');
+
+    await promise;
+  });
+
+  test('host can be initialized after client', async () => {
+    const { workerRuntime, clientProxy, client } = setup(async () => {
+      await sleep(5);
+      return new Config({});
+    });
+
+    await Promise.all([workerRuntime.start(), clientProxy.open('*'), client.initialize()]);
+
+    await client.halo.createIdentity();
+  });
+
+  // TODO(burdon): Browser-only.
+  test.skip('creates client with remote iframe', async () => {
+    const testBuilder = new TestBuilder();
+
+    const client = new Client({
+      services: fromIFrame(testBuilder.config)
+    });
+
+    await client.initialize();
+    afterTest(() => client.destroy());
+    expect(client.initialized).to.be.true;
+  });
+});

package/src/packlets/tests/spaces-invitations.test.ts

@@ -0,0 +1,64 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+import { expect } from 'chai';
+
+import { Trigger } from '@dxos/async';
+import { Client, Invitation } from '@dxos/client';
+import { raise } from '@dxos/debug';
+import { log } from '@dxos/log';
+import { describe, test, afterTest } from '@dxos/test';
+
+import { TestBuilder, testSpace } from '../testing';
+
+describe('Spaces/invitations', () => {
+  test('creates a space and invites a peer', async () => {
+    const testBuilder = new TestBuilder();
+
+    const client1 = new Client({ services: testBuilder.createLocal() });
+    const client2 = new Client({ services: testBuilder.createLocal() });
+    await client1.initialize();
+    await client2.initialize();
+    await client1.halo.createIdentity({ displayName: 'Peer 1' });
+    await client2.halo.createIdentity({ displayName: 'Peer 2' });
+
+    log('initialized');
+
+    afterTest(() => Promise.all([client1.destroy()]));
+    afterTest(() => Promise.all([client2.destroy()]));
+
+    const success1 = new Trigger<Invitation>();
+    const success2 = new Trigger<Invitation>();
+
+    const space1 = await client1.echo.createSpace();
+    log('createSpace', { key: space1.key });
+    const observable1 = space1.createInvitation({ type: Invitation.Type.INTERACTIVE_TESTING });
+
+    observable1.subscribe({
+      onConnecting: (invitation) => {
+        const observable2 = client2.echo.acceptInvitation(invitation);
+        observable2.subscribe({
+          onSuccess: (invitation: Invitation) => {
+            success2.wake(invitation);
+          },
+          onError: (err: Error) => raise(err)
+        });
+      },
+      onSuccess: (invitation) => {
+        log('onSuccess');
+        success1.wake(invitation);
+      },
+      onError: (err) => raise(err)
+    });
+
+    const [invitation1, invitation2] = await Promise.all([success1.wait(), success2.wait()]);
+    expect(invitation1.spaceKey).to.deep.eq(invitation2.spaceKey);
+    expect(invitation1.state).to.eq(Invitation.State.SUCCESS);
+
+    {
+      const space = client2.echo.getSpace(invitation2.spaceKey!)!;
+      await testSpace(space.internal.db);
+    }
+  });
+});

package/src/packlets/tests/spaces.test.ts

@@ -0,0 +1,136 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+import { expect } from 'chai';
+
+import { asyncTimeout, Trigger } from '@dxos/async';
+import { Client, Invitation } from '@dxos/client';
+import { Config } from '@dxos/config';
+import { raise } from '@dxos/debug';
+import { log } from '@dxos/log';
+import { createStorage, StorageType } from '@dxos/random-access-storage';
+import { describe, test, afterTest } from '@dxos/test';
+
+import { TestBuilder, testSpace } from '../testing';
+
+describe('Spaces', () => {
+  test('creates a space', async () => {
+    const testBuilder = new TestBuilder();
+
+    const client = new Client({ services: testBuilder.createLocal() });
+    afterTest(() => client.destroy());
+
+    await client.initialize();
+    await client.halo.createIdentity({ displayName: 'test-user' });
+
+    // TODO(burdon): Extend basic queries.
+    const space = await client.echo.createSpace();
+    await testSpace(space.internal.db);
+
+    expect(space.getMembers()).to.be.length(1);
+  });
+
+  test('creates a space re-opens the client', async () => {
+    const testBuilder = new TestBuilder(new Config({ version: 1 }));
+    testBuilder.storage = createStorage({ type: StorageType.RAM });
+
+    const client = new Client({ services: testBuilder.createLocal() });
+    await client.initialize();
+    await client.halo.createIdentity({ displayName: 'test-user' });
+
+    let itemId: string;
+    {
+      // TODO(burdon): API (client.echo/client.halo).
+      const space = await client.echo.createSpace();
+      const {
+        objectsUpdated: [item]
+      } = await testSpace(space.internal.db);
+      itemId = item.id;
+      expect(space.getMembers()).to.be.length(1);
+    }
+
+    await client.destroy();
+
+    log.break();
+
+    await client.initialize();
+
+    {
+      const result = client.echo.getSpaces();
+      expect(result).to.have.length(1);
+      const space = result[0];
+
+      const item = space.internal.db._itemManager.getItem(itemId)!;
+      expect(item).to.exist;
+    }
+
+    await client.destroy();
+  });
+
+  test('post and listen to messages', async () => {
+    const testBuilder = new TestBuilder();
+
+    const client1 = new Client({ services: testBuilder.createLocal() });
+    const client2 = new Client({ services: testBuilder.createLocal() });
+    await client1.initialize();
+    await client2.initialize();
+    await client1.halo.createIdentity({ displayName: 'Peer 1' });
+    await client2.halo.createIdentity({ displayName: 'Peer 2' });
+
+    log('initialized');
+
+    afterTest(() => Promise.all([client1.destroy()]));
+    afterTest(() => Promise.all([client2.destroy()]));
+
+    const success1 = new Trigger<Invitation>();
+    const success2 = new Trigger<Invitation>();
+
+    const space1 = await client1.echo.createSpace();
+    log('createSpace', { key: space1.key });
+    const observable1 = space1.createInvitation({ type: Invitation.Type.INTERACTIVE_TESTING });
+
+    observable1.subscribe({
+      onConnecting: (invitation) => {
+        const observable2 = client2.echo.acceptInvitation(invitation);
+        observable2.subscribe({
+          onSuccess: (invitation: Invitation) => {
+            success2.wake(invitation);
+          },
+          onError: (err: Error) => raise(err)
+        });
+      },
+      onSuccess: (invitation) => {
+        log('onSuccess');
+        success1.wake(invitation);
+      },
+      onError: (err) => raise(err)
+    });
+
+    const [_, invitation2] = await Promise.all([success1.wait(), success2.wait()]);
+
+    const space2 = client2.echo.getSpace(invitation2.spaceKey!)!;
+
+    const hello = new Trigger();
+    {
+      space2.listen('hello', (message) => {
+        expect(message.channelId).to.include('hello');
+        expect(message.payload).to.deep.contain({ data: 'Hello, world!' });
+        hello.wake();
+      });
+      await space1.postMessage('hello', { data: 'Hello, world!' });
+    }
+
+    const goodbye = new Trigger();
+    {
+      space2.listen('goodbye', (message) => {
+        expect(message.channelId).to.include('goodbye');
+        expect(message.payload).to.deep.contain({ data: 'Goodbye' });
+        goodbye.wake();
+      });
+      await space1.postMessage('goodbye', { data: 'Goodbye' });
+    }
+
+    await asyncTimeout(Promise.all([hello.wait(), goodbye.wait()]), 200);
+  });
+});

package/src/packlets/tests/text.test.ts

@@ -0,0 +1,206 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as fc from 'fast-check';
+import { ModelRunSetup } from 'fast-check';
+import waitForExpect from 'wait-for-expect';
+
+import { Client, Document, Text } from '@dxos/client';
+import { PublicKey } from '@dxos/keys';
+import { log } from '@dxos/log';
+import { describe, test } from '@dxos/test';
+import { Doc } from '@dxos/text-model';
+import { ComplexMap, ComplexSet, range } from '@dxos/util';
+
+import { joinCommonSpace, TestBuilder } from '../testing';
+
+// log.config({ filter: 'text.test:debug,error' });
+
+const testBuilder = new TestBuilder();
+const initialContent = 'Hello, world!';
+
+type Model = {
+  text: string;
+  peers: ComplexSet<PublicKey>;
+};
+
+type Real = {
+  spaceKey: PublicKey;
+  peers: ComplexMap<PublicKey, Client>;
+};
+
+const assertState = async (model: Model, real: Real) => {
+  // Wait for replication.
+  await waitForExpect(() => {
+    for (const [peerId, peer] of real.peers.entries()) {
+      const space = peer.echo.getSpace(real.spaceKey);
+      if (space) {
+        if (!model.peers.has(peerId)) {
+          throw new Error(`Expected peer to not be in space: ${peerId.truncate()}`);
+        }
+
+        const [document] = space.db.query((obj) => !!obj.content).objects;
+        const text = (document.content.doc as Doc).getText('utf8');
+        if (text.toString() !== model.text) {
+          throw new Error(
+            `Text mismatch for peer ${peerId.truncate()}: ${JSON.stringify({ expected: model.text, actual: text })}`
+          );
+        }
+      } else if (model.peers.has(peerId)) {
+        throw new Error(`Expected peer to be in space: ${peerId.truncate()}`);
+      }
+    }
+  }, 1000);
+};
+
+class CreatePeerCommand implements fc.AsyncCommand<Model, Real> {
+  constructor(readonly peerId: PublicKey) {}
+
+  check(model: Model) {
+    return model.peers.size === 0 || !model.peers.has(this.peerId);
+  }
+
+  async run(model: Model, real: Real) {
+    log.debug('run', { command: this.toString() });
+    model.peers.add(this.peerId);
+
+    // TODO(wittjosiah): Too many steps to creat client.
+    const services = testBuilder.createClientServicesHost();
+    await services.open();
+    const [client, server] = testBuilder.createClientServer(services);
+    void server.open();
+    await client.initialize();
+    await client.halo.createIdentity();
+    if (real.peers.size === 0) {
+      const space = await client.echo.createSpace();
+      const content = new Text();
+      content.doc?.getText('utf8').insert(0, initialContent);
+      await space.db.add(new Document({ content }));
+      real.spaceKey = space.key;
+    } else {
+      const host = Array.from(real.peers.values())[0];
+      await joinCommonSpace([host!, client], real.spaceKey);
+    }
+    real.peers.set(this.peerId, client);
+
+    await assertState(model, real);
+  }
+
+  toString() {
+    return `CreatePeer(peer=${this.peerId.truncate()})`;
+  }
+}
+
+// TODO(wittjosiah)
+// class OfflineMemberCommand implements fc.AsyncCommand<Model, Real> {
+//   constructor(readonly peer: Client) {}
+// }
+
+// TODO(wittjosiah)
+// class OnlineMemberCommand implements fc.AsyncCommand<Model, Real> {
+//   constructor(readonly peer: Client) {}
+// }
+
+class InsertTextCommand implements fc.AsyncCommand<Model, Real> {
+  constructor(readonly peerId: PublicKey, readonly index: number, readonly text: string) {}
+
+  check(model: Model) {
+    return model.peers.has(this.peerId) && model.text.length >= this.index;
+  }
+
+  async run(model: Model, real: Real) {
+    log.debug('run', { command: this.toString() });
+    model.text = model.text.slice(0, this.index) + this.text + model.text.slice(this.index);
+
+    const peer = real.peers.get(this.peerId);
+    const space = peer!.echo.getSpace(real.spaceKey)!;
+    const [document] = space.db.query((obj) => !!obj.content).objects;
+    const text = (document.content.doc as Doc).getText('utf8');
+    text.insert(this.index, this.text);
+
+    await assertState(model, real);
+  }
+
+  toString() {
+    const text = this.text.length > 10 ? `${this.text.slice(0, 10)}...` : this.text;
+    return `InsertText(peer=${this.peerId.truncate()}, index=${this.index}, text=${text})`;
+  }
+}
+
+class RemoveTextCommand implements fc.AsyncCommand<Model, Real> {
+  constructor(readonly peerId: PublicKey, readonly index: number, readonly length: number) {}
+
+  check(model: Model) {
+    return model.peers.has(this.peerId) && model.text.length > this.index + this.length;
+  }
+
+  async run(model: Model, real: Real) {
+    log.debug('run', { command: this.toString() });
+    model.text = model.text.slice(0, this.index) + model.text.slice(this.index + this.length);
+
+    const peer = real.peers.get(this.peerId);
+    const space = peer!.echo.getSpace(real.spaceKey)!;
+    const [document] = space.db.query((obj) => !!obj.content).objects;
+    const text = (document.content.doc as Doc).getText('utf8');
+    text.delete(this.index, this.length);
+
+    await assertState(model, real);
+  }
+
+  toString() {
+    return `RemoveText(peer=${this.peerId.truncate()}, index=${this.index}, length=${this.length})`;
+  }
+}
+
+describe('Client text replication', () => {
+  test('property-based tests', async () => {
+    // TODO(wittjosiah): Increasing to 5 causes failures.
+    const peerIds = range(3).map(() => PublicKey.random());
+    const peerId = fc.constantFrom(...peerIds);
+
+    const allCommands = [
+      peerId.map((peerId) => new CreatePeerCommand(peerId)),
+      fc
+        .tuple(peerId, fc.integer({ min: 0, max: 100 }), fc.unicodeString())
+        .map(([peerId, index, text]) => new InsertTextCommand(peerId, index, text)),
+      fc
+        .tuple(peerId, fc.integer({ min: 0, max: 100 }), fc.integer({ min: 1, max: 10 }))
+        .map(([peerId, index, length]) => new RemoveTextCommand(peerId, index, length))
+    ];
+    const commands = fc.commands(allCommands, { size: 'medium' });
+
+    const model = fc.asyncProperty(commands, async (commands) => {
+      const peers = new ComplexMap<PublicKey, Client>(PublicKey.hash);
+      const setup: ModelRunSetup<Model, Real> = () => ({
+        model: {
+          text: initialContent,
+          peers: new ComplexSet<PublicKey>(PublicKey.hash)
+        },
+        real: {
+          spaceKey: PublicKey.random(),
+          peers
+        }
+      });
+
+      await fc.asyncModelRun(setup, commands);
+
+      await Promise.all(Array.from(peers.values()).map((peer) => peer.destroy()));
+    });
+
+    const examples: [commands: Iterable<fc.AsyncCommand<Model, Real, boolean>>][] = [
+      [
+        [
+          new CreatePeerCommand(peerIds[0]),
+          new CreatePeerCommand(peerIds[1]),
+          new RemoveTextCommand(peerIds[0], 7, 5),
+          new InsertTextCommand(peerIds[1], 7, 'DXOS')
+        ]
+      ]
+    ];
+
+    await fc.assert(model, { examples });
+  })
+    .onlyEnvironments('node')
+    .timeout(300_000);
+});

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

@@ -7,10 +7,11 @@ import { Config } from '@dxos/config';
 import { log, logInfo } from '@dxos/log';
 import { MemorySignalManager, MemorySignalManagerContext, WebsocketSignalManager } from '@dxos/messaging';
 import { createWebRTCTransportFactory, NetworkManager } from '@dxos/network-manager';
-import { createProtoRpcPeer, ProtoRpcPeer, RpcPort } from '@dxos/rpc';
+import { RpcPort } from '@dxos/rpc';
 import { getAsyncValue, Provider } from '@dxos/util';
 
-import { clientServiceBundle, ClientServices, LocalClientServices } from '../services';
+import { LocalClientServices } from '../services';
+import { ClientRpcServer, ClientRpcServerParams } from '../services/client-rpc-server';
 import { ShellRuntime, ShellRuntimeImpl } from './shell-runtime';
 
 const LOCK_KEY = 'DXOS_RESOURCE_LOCK';
@@ -31,9 +32,6 @@ export class IFrameHostRuntime {
   private readonly _configProvider: Config | Provider<Promise<Config>>;
   private readonly _transportFactory = createWebRTCTransportFactory();
   private readonly _ready = new Trigger<Error | undefined>();
-  private readonly _getService: <Service>(
-    find: (services: Partial<ClientServices>) => Service | undefined
-  ) => Promise<Service>;
 
   private readonly _appPort: RpcPort;
   private readonly _shellPort?: RpcPort;
@@ -41,7 +39,7 @@ export class IFrameHostRuntime {
 
   // TODO(dmaretskyi):  Replace with host and figure out how to return services provider here.
   private _clientServices!: LocalClientServices;
-  private _clientRpc!: ProtoRpcPeer<ClientServices>;
+  private _clientRpc!: ClientRpcServer;
   private _shellRuntime?: ShellRuntimeImpl;
 
   @logInfo
@@ -52,20 +50,6 @@ export class IFrameHostRuntime {
     this._appPort = appPort;
     this._shellPort = shellPort;
 
-    this._getService = async (find) => {
-      const error = await this._ready.wait();
-      if (error) {
-        throw error;
-      }
-
-      const service = await find(this._clientServices.services);
-      if (!service) {
-        throw new Error('Service not found');
-      }
-
-      return service;
-    };
-
     if (this._shellPort) {
       this._shellRuntime = new ShellRuntimeImpl(this._shellPort);
     }
@@ -96,21 +80,29 @@ export class IFrameHostRuntime {
         })
       });
 
-      this._clientRpc = createProtoRpcPeer({
-        exposed: clientServiceBundle,
-        handlers: {
-          DataService: async () => await this._getService((services) => services.DataService),
-          DeviceInvitationsService: async () => await this._getService((services) => services.DeviceInvitationsService),
-          DevicesService: async () => await this._getService((services) => services.DevicesService),
-          DevtoolsHost: async () => await this._getService((services) => services.DevtoolsHost),
-          NetworkService: async () => await this._getService((services) => services.NetworkService),
-          IdentityService: async () => await this._getService((services) => services.IdentityService),
-          SpaceInvitationsService: async () => await this._getService((services) => services.SpaceInvitationsService),
-          SpacesService: async () => await this._getService((services) => services.SpacesService),
-          SystemService: async () => await this._getService((services) => services.SystemService),
-          TracingService: async () => await this._getService((services) => services.TracingService)
+      const middleware: Pick<ClientRpcServerParams, 'handleCall' | 'handleStream'> = {
+        handleCall: async (method, params, handler) => {
+          const error = await this._ready.wait({ timeout: 3_000 });
+          if (error) {
+            throw error;
+          }
+
+          return handler(method, params);
         },
-        port: this._appPort
+        handleStream: async (method, params, handler) => {
+          const error = await this._ready.wait({ timeout: 3_000 });
+          if (error) {
+            throw error;
+          }
+
+          return handler(method, params);
+        }
+      };
+
+      this._clientRpc = new ClientRpcServer({
+        serviceRegistry: this._clientServices.host.serviceRegistry,
+        port: this._appPort,
+        ...middleware
       });
 
       await Promise.all([this._clientServices.open(), this._clientRpc.open(), this._shellRuntime?.open()]);

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

@@ -2,11 +2,11 @@
 // Copyright 2022 DXOS.org
 //
 
+import { iframeServiceBundle, workerServiceBundle, WorkerServiceBundle } from '@dxos/client';
 import { WebRTCTransportService } from '@dxos/network-manager';
 import { BridgeService } from '@dxos/protocols/proto/dxos/mesh/bridge';
 import { createProtoRpcPeer, ProtoRpcPeer, RpcPort } from '@dxos/rpc';
 
-import { iframeServiceBundle, WorkerServiceBundle, workerServiceBundle } from './services';
 import { ShellRuntime, ShellRuntimeImpl } from './shell-runtime';
 
 // NOTE: Keep as RpcPorts to avoid dependency on @dxos/rpc-tunnel so we don't depend on browser-specific apis.

package/src/packlets/vault/index.ts

@@ -4,8 +4,6 @@
 
 export * from './iframe-host-runtime';
 export * from './iframe-proxy-runtime';
-export * from './services';
-export * from './shell-controller';
 export * from './shell-runtime';
 export * from './vault-resource-lock';
 export * from './worker-runtime';

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

@@ -5,12 +5,11 @@
 import assert from 'node:assert';
 
 import { Event } from '@dxos/async';
+import { appServiceBundle, AppServiceBundle, shellServiceBundle } from '@dxos/client';
 import { PublicKey } from '@dxos/keys';
 import { AppContextRequest, LayoutRequest, ShellLayout } from '@dxos/protocols/proto/dxos/iframe';
 import { createProtoRpcPeer, ProtoRpcPeer, RpcPort } from '@dxos/rpc';
 
-import { AppServiceBundle, appServiceBundle, shellServiceBundle } from './services';
-
 export interface ShellRuntime {
   layoutUpdate: Event<LayoutRequest>;
   layout: ShellLayout;

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

@@ -36,14 +36,16 @@ export class WorkerRuntime {
   // prettier-ignore
   constructor(
     private readonly _configProvider: () => MaybePromise<Config>
-  ) { }
+  ) {
+    this._clientServices = new ClientServicesHost();
+  }
 
   async start() {
     log('starting...');
     try {
       this._config = await this._configProvider();
       const signalServer = this._config.get('runtime.services.signal.server');
-      this._clientServices = new ClientServicesHost({
+      this._clientServices.initialize({
         config: this._config,
         networkManager: new NetworkManager({
           log: true,
@@ -73,19 +75,7 @@ export class WorkerRuntime {
    */
   async createSession({ appPort, systemPort, shellPort }: CreateSessionParams) {
     const session = new WorkerSession({
-      getService: async (find) => {
-        const error = await this._ready.wait();
-        if (error) {
-          throw error;
-        }
-
-        const service = find(this._clientServices.services);
-        if (!service) {
-          throw new Error('Service not found');
-        }
-
-        return service;
-      },
+      serviceHost: this._clientServices,
       appPort,
       systemPort,
       shellPort,