@dxos/client-services 0.10.0 → 0.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client-services",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "DXOS client services implementation",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -19,8 +19,8 @@
         "default": "./src/packlets/locks/node.ts"
       },
       "types": "./dist/types/src/packlets/locks/node.d.ts",
-      "browser": "./dist/lib/browser/packlets/locks/browser.mjs",
-      "default": "./dist/lib/node-esm/packlets/locks/node.mjs"
+      "browser": "./dist/lib/packlets/locks/browser.mjs",
+      "default": "./dist/lib/packlets/locks/node.mjs"
     },
     "#diagnostics-broadcast": {
       "source": {
@@ -28,22 +28,20 @@
         "default": "./src/packlets/diagnostics/diagnostics-broadcast.ts"
       },
       "types": "./dist/types/src/packlets/diagnostics/diagnostics-broadcast.d.ts",
-      "browser": "./dist/lib/browser/packlets/diagnostics/browser-diagnostics-broadcast.mjs",
-      "default": "./dist/lib/node-esm/packlets/diagnostics/diagnostics-broadcast.mjs"
+      "browser": "./dist/lib/packlets/diagnostics/browser-diagnostics-broadcast.mjs",
+      "default": "./dist/lib/packlets/diagnostics/diagnostics-broadcast.mjs"
     }
   },
   "exports": {
     ".": {
       "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
-      "browser": "./dist/lib/browser/index.mjs",
-      "node": "./dist/lib/node-esm/index.mjs"
+      "import": "./dist/lib/index.mjs"
     },
     "./testing": {
       "source": "./src/testing/index.ts",
       "types": "./dist/types/src/testing/index.d.ts",
-      "browser": "./dist/lib/browser/testing/index.mjs",
-      "node": "./dist/lib/node-esm/testing/index.mjs"
+      "import": "./dist/lib/testing.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -53,56 +51,62 @@
   ],
   "dependencies": {
     "@automerge/automerge": "3.3.0-fragments.2",
-    "@automerge/automerge-repo": "2.6.0-subduction.37",
+    "@automerge/automerge-repo": "2.6.0-subduction.40",
     "@effect/experimental": "0.60.0",
+    "@effect/rpc": "0.75.1",
     "@effect/sql": "0.51.1",
     "@obsidize/tar-browserify": "^5.2.0",
     "cbor-x": "^1.5.4",
+    "crc-32": "^1.2.2",
     "effect": "3.21.4",
     "platform": "^1.3.6",
-    "@dxos/async": "0.10.0",
-    "@dxos/client-protocol": "0.10.0",
-    "@dxos/config": "0.10.0",
-    "@dxos/codec-protobuf": "0.10.0",
-    "@dxos/context": "0.10.0",
-    "@dxos/credentials": "0.10.0",
-    "@dxos/crypto": "0.10.0",
-    "@dxos/debug": "0.10.0",
-    "@dxos/echo": "0.10.0",
-    "@dxos/echo-client": "0.10.0",
-    "@dxos/echo-host": "0.10.0",
-    "@dxos/echo-protocol": "0.10.0",
-    "@dxos/edge-client": "0.10.0",
-    "@dxos/effect": "0.10.0",
-    "@dxos/feed": "0.10.0",
-    "@dxos/feed-store": "0.10.0",
-    "@dxos/invariant": "0.10.0",
-    "@dxos/keys": "0.10.0",
-    "@dxos/keyring": "0.10.0",
-    "@dxos/kv-store": "0.10.0",
-    "@dxos/lock-file": "0.10.0",
-    "@dxos/messaging": "0.10.0",
-    "@dxos/network-manager": "0.10.0",
-    "@dxos/log": "0.10.0",
-    "@dxos/node-std": "0.10.0",
-    "@dxos/protocols": "0.10.0",
-    "@dxos/random-access-storage": "0.10.0",
-    "@dxos/rpc": "0.10.0",
-    "@dxos/sql-sqlite": "0.10.0",
-    "@dxos/teleport": "0.10.0",
-    "@dxos/teleport-extension-gossip": "0.10.0",
-    "@dxos/teleport-extension-object-sync": "0.10.0",
-    "@dxos/tracing": "0.10.0",
-    "@dxos/timeframe": "0.10.0",
-    "@dxos/util": "0.10.0",
-    "@dxos/websocket-rpc": "0.10.0"
+    "@dxos/async": "0.11.0",
+    "@dxos/client-protocol": "0.11.0",
+    "@dxos/codec-protobuf": "0.11.0",
+    "@dxos/context": "0.11.0",
+    "@dxos/credentials": "0.11.0",
+    "@dxos/crypto": "0.11.0",
+    "@dxos/debug": "0.11.0",
+    "@dxos/config": "0.11.0",
+    "@dxos/echo": "0.11.0",
+    "@dxos/echo-client": "0.11.0",
+    "@dxos/echo-host": "0.11.0",
+    "@dxos/echo-protocol": "0.11.0",
+    "@dxos/feed": "0.11.0",
+    "@dxos/effect": "0.11.0",
+    "@dxos/edge-client": "0.11.0",
+    "@dxos/feed-store": "0.11.0",
+    "@dxos/hypercore": "0.11.0",
+    "@dxos/invariant": "0.11.0",
+    "@dxos/keys": "0.11.0",
+    "@dxos/keyring": "0.11.0",
+    "@dxos/kv-store": "0.11.0",
+    "@dxos/lock-file": "0.11.0",
+    "@dxos/log": "0.11.0",
+    "@dxos/messaging": "0.11.0",
+    "@dxos/network-manager": "0.11.0",
+    "@dxos/node-std": "0.11.0",
+    "@dxos/protocols": "0.11.0",
+    "@dxos/random-access-storage": "0.11.0",
+    "@dxos/rpc": "0.11.0",
+    "@dxos/sql-sqlite": "0.11.0",
+    "@dxos/teleport": "0.11.0",
+    "@dxos/teleport-extension-gossip": "0.11.0",
+    "@dxos/teleport-extension-object-sync": "0.11.0",
+    "@dxos/teleport-extension-replicator": "0.11.0",
+    "@dxos/timeframe": "0.11.0",
+    "@dxos/tracing": "0.11.0",
+    "@dxos/util": "0.11.0",
+    "@dxos/websocket-rpc": "0.11.0"
   },
   "devDependencies": {
+    "@effect/platform-browser": "0.76.0",
+    "@effect/vitest": "0.29.0",
     "@types/platform": "^1.3.4",
     "@types/readable-stream": "^2.3.9",
+    "fast-check": "^3.19.0",
     "get-port-please": "^3.1.1",
-    "@dxos/signal": "0.10.0",
-    "@dxos/test-utils": "0.10.0"
+    "@dxos/test-utils": "0.11.0"
   },
   "publishConfig": {
     "access": "public"

package/src/index.ts

@@ -7,7 +7,9 @@ export * from './packlets/diagnostics';
 export * from './packlets/identity';
 export * from './packlets/invitations';
 export * from './packlets/locks';
+export * from './packlets/metadata';
 export * from './packlets/services';
+export * from './packlets/space';
 export * from './packlets/space-export';
 export * from './packlets/spaces';
 export * from './packlets/storage';

package/src/packlets/agents/edge-agent-manager.ts

@@ -2,10 +2,15 @@
 // Copyright 2024 DXOS.org
 //
 
+import * as EffectContext from 'effect/Context';
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+import * as Option from 'effect/Option';
+
 import { DeferredTask, Event, scheduleTask, synchronized } from '@dxos/async';
 import { Context } from '@dxos/context';
 import { Resource } from '@dxos/context';
-import { type EdgeHttpClient } from '@dxos/edge-client';
+import { type EdgeHttpClient, EdgeHttpClientService } from '@dxos/edge-client';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
@@ -14,15 +19,22 @@ import { SpaceState } from '@dxos/protocols/proto/dxos/client/services';
 import { type Runtime } from '@dxos/protocols/proto/dxos/config';
 import { EdgeReplicationSetting } from '@dxos/protocols/proto/dxos/echo/metadata';
 
-import { type Identity } from '../identity';
-import { type DataSpaceManager } from '../spaces';
-
+import { type Identity, type IdentityProvider, IdentityProviderService } from '../identity';
+import { type DataSpaceManager, DataSpaceManagerService } from '../spaces';
 const AGENT_STATUS_QUERY_RETRY_INTERVAL = 5000;
 const AGENT_STATUS_QUERY_RETRY_JITTER = 1000;
 const AGENT_FEED_ADDED_CHECK_INTERVAL_MS = 3000;
 
 export type EdgeAgentManagerConfig = {};
 
+/**
+ * Effect service tag for {@link EdgeAgentManager}.
+ */
+export class EdgeAgentManagerService extends EffectContext.Tag('@dxos/client-services/EdgeAgentManager')<
+  EdgeAgentManagerService,
+  EdgeAgentManager
+>() {}
+
 export class EdgeAgentManager extends Resource {
   public agentStatusChanged = new Event<EdgeAgentStatus>();
 
@@ -37,11 +49,15 @@ export class EdgeAgentManager extends Resource {
     private readonly _edgeFeatures: Runtime.Client.EdgeFeatures | undefined,
     private readonly _edgeHttpClient: EdgeHttpClient | undefined,
     private readonly _dataSpaceManager: DataSpaceManager,
-    private readonly _identity: Identity,
+    private readonly _identityProvider: IdentityProvider,
   ) {
     super();
   }
 
+  private get identity(): Identity {
+    return this._identityProvider();
+  }
+
   public get agentStatus(): EdgeAgentStatus | undefined {
     return this._agentStatus;
   }
@@ -57,20 +73,20 @@ export class EdgeAgentManager extends Resource {
     invariant(this._edgeFeatures?.agents);
 
     const response = await this._edgeHttpClient.createAgent(ctx, {
-      identityDid: this._identity.did,
-      haloSpaceId: this._identity.haloSpaceId,
-      haloSpaceKey: this._identity.haloSpaceKey.toHex(),
+      identityDid: this.identity.did,
+      haloSpaceId: this.identity.haloSpaceId,
+      haloSpaceKey: this.identity.haloSpaceKey.toHex(),
     });
 
     const deviceKey = PublicKey.fromHex(response.deviceKey);
 
-    if (await this._identity.authorizedDeviceKeys.has(deviceKey)) {
+    if (await this.identity.authorizedDeviceKeys.has(deviceKey)) {
       log.info('agent was already added to HALO, ignoring response', { response });
       this._updateStatus(EdgeAgentStatus.ACTIVE, deviceKey);
       return;
     }
 
-    await this._identity.admitDevice({
+    await this.identity.admitDevice({
       deviceKey,
       controlFeedKey: PublicKey.fromHex(response.feedKey),
       // TODO: agents don't have data feed, should be removed
@@ -91,7 +107,7 @@ export class EdgeAgentManager extends Resource {
       return;
     }
 
-    this._lastKnownDeviceCount = this._identity.authorizedDeviceKeys.size;
+    this._lastKnownDeviceCount = this.identity.authorizedDeviceKeys.size;
     this._fetchAgentStatusTask = new DeferredTask(this._ctx, async () => {
       await this._fetchAgentStatus(this._ctx);
     });
@@ -103,12 +119,12 @@ export class EdgeAgentManager extends Resource {
       }
     });
 
-    this._identity.stateUpdate.on(this._ctx, () => {
-      const maybeAgentWasCreated = this._identity.authorizedDeviceKeys.size > this._lastKnownDeviceCount;
+    this.identity.stateUpdate.on(this._ctx, () => {
+      const maybeAgentWasCreated = this.identity.authorizedDeviceKeys.size > this._lastKnownDeviceCount;
       if (this.agentExists || !maybeAgentWasCreated) {
         return;
       }
-      this._lastKnownDeviceCount = this._identity.authorizedDeviceKeys.size;
+      this._lastKnownDeviceCount = this.identity.authorizedDeviceKeys.size;
       this._fetchAgentStatusTask?.schedule();
     });
   }
@@ -123,7 +139,7 @@ export class EdgeAgentManager extends Resource {
     try {
       log('fetching agent status');
       const { agent } = await this._edgeHttpClient.getAgentStatus(ctx, {
-        ownerIdentityDid: this._identity.did,
+        ownerIdentityDid: this.identity.did,
       });
       const wasAgentCreatedDuringQuery = this._agentStatus === EdgeAgentStatus.ACTIVE;
       if (!wasAgentCreatedDuringQuery) {
@@ -184,3 +200,28 @@ export class EdgeAgentManager extends Resource {
     log.verbose('agent status update', { status });
   }
 }
+
+export type EdgeAgentManagerLayerOptions = {
+  edgeFeatures?: Runtime.Client.EdgeFeatures;
+};
+
+/**
+ * Effect Layer constructing a dormant {@link EdgeAgentManager}.
+ */
+export const EdgeAgentManagerLayer = (
+  options: EdgeAgentManagerLayerOptions = {},
+): Layer.Layer<EdgeAgentManagerService, never, DataSpaceManagerService | IdentityProviderService> =>
+  Layer.effect(
+    EdgeAgentManagerService,
+    Effect.gen(function* () {
+      const dataSpaceManager = yield* DataSpaceManagerService;
+      const identityProvider = yield* IdentityProviderService;
+      const edgeHttpClient = yield* Effect.serviceOption(EdgeHttpClientService);
+      return new EdgeAgentManager(
+        options.edgeFeatures,
+        Option.getOrUndefined(edgeHttpClient),
+        dataSpaceManager,
+        identityProvider,
+      );
+    }),
+  );

package/src/packlets/agents/edge-agent-service.ts

@@ -2,32 +2,34 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type RequestOptions } from '@dxos/codec-protobuf';
-import { Stream } from '@dxos/codec-protobuf/stream';
+import * as Effect from 'effect/Effect';
+import * as EffectStream from 'effect/Stream';
+
 import { Context } from '@dxos/context';
 import { type EdgeConnection } from '@dxos/edge-client';
 import { EdgeAgentStatus } from '@dxos/protocols';
 import {
-  type EdgeAgentService,
   EdgeStatus,
   QueryAgentStatusResponse,
   type QueryEdgeStatusResponse,
 } from '@dxos/protocols/proto/dxos/client/services';
+import { type EdgeAgentService } from '@dxos/protocols/rpc';
 
 import { type EdgeAgentManager } from './edge-agent-manager';
 
 // TODO(wittjosiah): This service is not currently exposed on the client api, it must be called directly.
-export class EdgeAgentServiceImpl implements EdgeAgentService {
-  constructor(
+export class EdgeAgentServiceImpl implements EdgeAgentService.Handlers {
+  'constructor'(
     private readonly _agentManagerProvider: () => Promise<EdgeAgentManager>,
     private readonly _edgeConnection?: EdgeConnection,
   ) {}
 
   // TODO(mykola): Reconcile with NetworkService.queryStatus.
-  queryEdgeStatus(): Stream<QueryEdgeStatusResponse> {
-    return new Stream(({ ctx, next }) => {
+  ['EdgeAgentService.queryEdgeStatus'](): EffectStream.Stream<QueryEdgeStatusResponse, Error> {
+    return EffectStream.async<QueryEdgeStatusResponse, Error>((emit) => {
+      const ctx = Context.default();
       const update = () => {
-        next({
+        void emit.single({
           status: this._edgeConnection?.status ?? {
             state: EdgeStatus.ConnectionState.NOT_CONNECTED,
             rtt: 0,
@@ -42,22 +44,30 @@ export class EdgeAgentServiceImpl implements EdgeAgentService {
 
       this._edgeConnection?.statusChanged.on(ctx, update);
       update();
+
+      return Effect.promise(() => ctx.dispose());
     });
   }
 
-  async createAgent(_request: void, options?: RequestOptions): Promise<void> {
-    return (await this._agentManagerProvider()).createAgent(options?.ctx ?? Context.default());
+  ['EdgeAgentService.createAgent'](): Effect.Effect<void, Error> {
+    return Effect.tryPromise({
+      try: async () => (await this._agentManagerProvider()).createAgent(Context.default()),
+      catch: (error) => error as Error,
+    });
   }
 
-  queryAgentStatus(): Stream<QueryAgentStatusResponse> {
-    return new Stream(({ ctx, next }) => {
-      next({ status: QueryAgentStatusResponse.AgentStatus.UNKNOWN });
+  ['EdgeAgentService.queryAgentStatus'](): EffectStream.Stream<QueryAgentStatusResponse, Error> {
+    return EffectStream.async<QueryAgentStatusResponse, Error>((emit) => {
+      const ctx = Context.default();
+      void emit.single({ status: QueryAgentStatusResponse.AgentStatus.UNKNOWN });
       void this._agentManagerProvider().then((agentManager) => {
-        next({ status: mapStatus(agentManager.agentStatus) });
+        void emit.single({ status: mapStatus(agentManager.agentStatus) });
         agentManager.agentStatusChanged.on(ctx, (newStatus) => {
-          next({ status: mapStatus(newStatus) });
+          void emit.single({ status: mapStatus(newStatus) });
         });
       });
+
+      return Effect.promise(() => ctx.dispose());
     });
   }
 }

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

@@ -2,12 +2,15 @@
 // Copyright 2023 DXOS.org
 //
 
+import * as Runtime from 'effect/Runtime';
 import { afterEach, beforeEach, describe, expect, onTestFinished, test } from 'vitest';
 
 import { Trigger } from '@dxos/async';
 import { Context } from '@dxos/context';
+import { EffectEx } from '@dxos/effect';
 import { log } from '@dxos/log';
-import { type Device, type DevicesService } from '@dxos/protocols/proto/dxos/client/services';
+import { subscribeStream } from '@dxos/protocols';
+import { type Device } from '@dxos/protocols/proto/dxos/client/services';
 
 import { type ServiceContext } from '../services';
 import { createServiceContext } from '../testing';
@@ -15,7 +18,7 @@ import { DevicesServiceImpl } from './devices-service';
 
 describe('DevicesService', () => {
   let serviceContext: ServiceContext;
-  let devicesService: DevicesService;
+  let devicesService: DevicesServiceImpl;
 
   beforeEach(async () => {
     serviceContext = await createServiceContext();
@@ -29,38 +32,36 @@ describe('DevicesService', () => {
 
   describe('updateDevice', () => {
     test.skip('updates device profile', async () => {
-      const query = devicesService.queryDevices();
-      const device = await devicesService.updateDevice({ label: 'test-device' });
+      const stream = devicesService['DevicesService.queryDevices']();
+      const device = await EffectEx.runPromise(devicesService['DevicesService.updateDevice']({ label: 'test-device' }));
       const result = new Trigger<Device[] | undefined>();
-      query.subscribe(({ devices }) => {
-        result.wake(devices);
+      const cleanup = subscribeStream(Runtime.defaultRuntime, stream, {
+        onData: ({ devices }) => result.wake(devices),
       });
-      onTestFinished(() => query.close());
+      onTestFinished(cleanup);
       expect(device.profile?.label).to.equal('test-device');
     });
   });
 
   describe('queryDevices', () => {
     test('returns empty list if no identity is available', async () => {
-      const query = devicesService.queryDevices();
+      const stream = devicesService['DevicesService.queryDevices']();
       const result = new Trigger<Device[] | undefined>();
-      query.subscribe(
-        ({ devices }) => {
-          result.wake(devices);
-        },
-        (err) => log.catch(err),
-      );
-      onTestFinished(() => query.close().catch((err) => log.catch(err)));
+      const cleanup = subscribeStream(Runtime.defaultRuntime, stream, {
+        onData: ({ devices }) => result.wake(devices),
+        onError: (err) => log.catch(err),
+      });
+      onTestFinished(cleanup);
       expect(await result.wait()).to.be.length(0);
     });
 
     test('updates when identity is created', async () => {
-      const query = devicesService.queryDevices();
+      const stream = devicesService['DevicesService.queryDevices']();
       let result = new Trigger<Device[] | undefined>();
-      query.subscribe(({ devices }) => {
-        result.wake(devices);
+      const cleanup = subscribeStream(Runtime.defaultRuntime, stream, {
+        onData: ({ devices }) => result.wake(devices),
       });
-      onTestFinished(() => query.close());
+      onTestFinished(cleanup);
       expect(await result.wait()).to.be.length(0);
 
       result = new Trigger<Device[] | undefined>();

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

@@ -2,41 +2,41 @@
 // Copyright 2022 DXOS.org
 //
 
+import * as Effect from 'effect/Effect';
+import * as EffectStream from 'effect/Stream';
+
 import { SubscriptionList } from '@dxos/async';
-import { Stream } from '@dxos/codec-protobuf/stream';
 import { type EdgeConnection } from '@dxos/edge-client';
 import { invariant } from '@dxos/invariant';
-import {
-  Device,
-  DeviceKind,
-  type DevicesService,
-  EdgeStatus,
-  type QueryDevicesResponse,
-} from '@dxos/protocols/proto/dxos/client/services';
+import { Device, DeviceKind, EdgeStatus, type QueryDevicesResponse } from '@dxos/protocols/proto/dxos/client/services';
 import { type DeviceProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
+import { type DevicesService } from '@dxos/protocols/rpc';
 
 import { type IdentityManager } from '../identity';
 
-export class DevicesServiceImpl implements DevicesService {
-  constructor(
+export class DevicesServiceImpl implements DevicesService.Handlers {
+  'constructor'(
     private readonly _identityManager: IdentityManager,
     private readonly _edgeConnection?: EdgeConnection,
   ) {}
 
-  async updateDevice(profile: DeviceProfileDocument): Promise<Device> {
-    return this._identityManager.updateDeviceProfile(profile);
+  ['DevicesService.updateDevice'](request: DeviceProfileDocument): Effect.Effect<Device, Error> {
+    return Effect.tryPromise({
+      try: async () => this._identityManager.updateDeviceProfile(request),
+      catch: (error) => error as Error,
+    });
   }
 
-  queryDevices(): Stream<QueryDevicesResponse> {
-    return new Stream(({ next }) => {
+  ['DevicesService.queryDevices'](): EffectStream.Stream<QueryDevicesResponse, Error> {
+    return EffectStream.async<QueryDevicesResponse, Error>((emit) => {
       const update = () => {
         const deviceKeys = this._identityManager.identity?.authorizedDeviceKeys;
         if (!deviceKeys) {
-          next({ devices: [] });
+          void emit.single({ devices: [] });
         } else {
           invariant(this._identityManager.identity?.presence, 'presence not present');
           const peers = this._identityManager.identity.presence.getPeersOnline();
-          next({
+          void emit.single({
             devices: Array.from(deviceKeys.entries()).map(([key, profile]) => {
               const isMe = this._identityManager.identity?.deviceKey.equals(key);
               let presence;
@@ -104,7 +104,7 @@ export class DevicesServiceImpl implements DevicesService {
 
       update();
 
-      return () => subscriptions.clear();
+      return Effect.sync(() => subscriptions.clear());
     });
   }
 }