@dxos/client-services 0.8.4-main.a4bbb77 → 0.8.4-main.abd8ff62ef

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

@@ -5,6 +5,7 @@
 import { describe, expect, onTestFinished, test } from 'vitest';
 
 import { Trigger, chain } from '@dxos/async';
+import { Context } from '@dxos/context';
 import { raise } from '@dxos/debug';
 import { AlreadyJoinedError } from '@dxos/protocols';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
@@ -24,26 +25,26 @@ describe('services/space-invitations-protocol', () => {
   test('genesis', async () => {
     const [peer] = await chain<ServiceContext>([createIdentity, closeAfterTest])(createPeers(1));
 
-    const space = await peer.dataSpaceManager!.createSpace();
+    const space = await peer.dataSpaceManager!.createSpace(new Context());
     expect(peer.dataSpaceManager!.spaces.has(space.key)).to.be.true;
 
-    await space.close();
+    await space.close(new Context());
   });
 
   test('genesis & ready', async () => {
     const [peer] = await chain<ServiceContext>([createIdentity, closeAfterTest])(createPeers(1));
 
-    const space = await peer.dataSpaceManager!.createSpace();
+    const space = await peer.dataSpaceManager!.createSpace(new Context());
     expect(peer.dataSpaceManager!.spaces.has(space.key)).to.be.true;
 
     await peer.dataSpaceManager?.waitUntilSpaceReady(space.key);
-    await space.close();
+    await space.close(new Context());
   });
 
   test('invitation with no auth', async () => {
     const [host, guest] = await chain<ServiceContext>([createIdentity, closeAfterTest])(createPeers(2));
 
-    const space1 = await host.dataSpaceManager!.createSpace();
+    const space1 = await host.dataSpaceManager!.createSpace(new Context());
     const spaceKey = space1.key;
 
     await Promise.all(performInvitation({ host, guest, options: { kind: Invitation.Kind.SPACE, spaceKey } }));
@@ -59,15 +60,15 @@ describe('services/space-invitations-protocol', () => {
 
       await space2.inner.controlPipeline.state.waitUntilTimeframe(space1.inner.controlPipeline.state.timeframe);
 
-      await space1.close();
-      await space2.close();
+      await space1.close(new Context());
+      await space2.close(new Context());
     }
   });
 
   test('invitation when already joined', async () => {
     const [host, guest] = await chain<ServiceContext>([createIdentity, closeAfterTest])(createPeers(2));
 
-    const space1 = await host.dataSpaceManager!.createSpace();
+    const space1 = await host.dataSpaceManager!.createSpace(new Context());
     const spaceKey = space1.key;
 
     await Promise.all(performInvitation({ host, guest, options: { kind: Invitation.Kind.SPACE, spaceKey } }));
@@ -96,7 +97,7 @@ describe('services/space-invitations-protocol', () => {
 
     let attempt = 0;
 
-    const space1 = await host.dataSpaceManager!.createSpace();
+    const space1 = await host.dataSpaceManager!.createSpace(new Context());
 
     const [{ invitation: invitation1, error: error1 }, { invitation: invitation2, error: error2 }] = await Promise.all(
       performInvitation({
@@ -143,8 +144,8 @@ describe('services/space-invitations-protocol', () => {
 
       await space2.inner.controlPipeline.state.waitUntilTimeframe(space1.inner.controlPipeline.state.timeframe);
 
-      await space1.close();
-      await space2.close();
+      await space1.close(new Context());
+      await space2.close(new Context());
     }
 
     expect(
@@ -154,14 +155,14 @@ describe('services/space-invitations-protocol', () => {
 
   test('timeout', async () => {
     const [host, guest] = await chain<ServiceContext>([createIdentity, closeAfterTest])(createPeers(2));
-    const space = await host.dataSpaceManager!.createSpace();
+    const space = await host.dataSpaceManager!.createSpace(new Context());
     const hostInvitation = await createInvitation(host, {
       kind: Invitation.Kind.SPACE,
       spaceKey: space.key,
       timeout: 100,
     });
     const invitation = hostInvitation.get();
-    await host.close();
+    await host.close(Context.default());
 
     const guestTimeout = new Trigger();
     const guestInvitation = await acceptInvitation(guest, invitation);
@@ -180,7 +181,7 @@ describe('services/space-invitations-protocol', () => {
     const hostConnected = new Trigger<Invitation>();
     const guestConnected = new Trigger<Invitation>();
 
-    const space1 = await host.dataSpaceManager!.createSpace();
+    const space1 = await host.dataSpaceManager!.createSpace(new Context());
 
     const invitationPromises = performInvitation({
       host,
@@ -213,7 +214,7 @@ describe('services/space-invitations-protocol', () => {
     expect(invitation1?.state).to.eq(Invitation.State.CANCELLED);
     expect(error).to.exist;
 
-    await space1.close();
+    await space1.close(new Context());
   });
 
   // TODO(burdon): Flaky.
@@ -223,7 +224,7 @@ describe('services/space-invitations-protocol', () => {
   //     createPeers(GUEST_COUNT + 1)
   //   );
 
-  //   const hostSpace = await host.dataSpaceManager!.createSpace();
+  //   const hostSpace = await host.dataSpaceManager!.createSpace(new Context());
   //   const swarmKey = PublicKey.random();
   //   const hostObservable = await host.spaceInvitations!.createInvitation(hostSpace, {
   //     swarmKey,

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

@@ -2,6 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
+import { type Context } from '@dxos/context';
 import {
   createCancelDelegatedSpaceInvitationCredential,
   createDelegatedSpaceInvitationCredential,
@@ -12,13 +13,7 @@ import { invariant } from '@dxos/invariant';
 import { type Keyring } from '@dxos/keyring';
 import { type PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
-import {
-  AlreadyJoinedError,
-  type ApiError,
-  AuthorizationError,
-  InvalidInvitationError,
-  SpaceNotFoundError,
-} from '@dxos/protocols';
+import { AlreadyJoinedError, AuthorizationError, InvalidInvitationError, SpaceNotFoundError } from '@dxos/protocols';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
 import { type ProfileDocument, SpaceMember } from '@dxos/protocols/proto/dxos/halo/credentials';
 import {
@@ -28,7 +23,6 @@ import {
 } from '@dxos/protocols/proto/dxos/halo/invitations';
 
 import { type DataSpaceManager, type SigningContext } from '../spaces';
-
 import { type InvitationProtocol } from './invitation-protocol';
 import { computeExpirationTime } from './utils';
 
@@ -48,16 +42,16 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
     };
   }
 
-  checkCanInviteNewMembers(): ApiError | undefined {
+  checkCanInviteNewMembers(): Error | undefined {
     if (this._spaceKey == null) {
-      return new InvalidInvitationError('No spaceKey was provided for a space invitation.');
+      return new InvalidInvitationError({ message: 'No spaceKey was provided for a space invitation.' });
     }
     const space = this._spaceManager.spaces.get(this._spaceKey);
     if (space == null) {
       return new SpaceNotFoundError(this._spaceKey);
     }
     if (!space?.inner.spaceState.hasMembershipManagementPermission(this._signingContext.identityKey)) {
-      return new AuthorizationError('No member management permission.');
+      return new AuthorizationError({ message: 'No member management permission.' });
     }
     return undefined;
   }
@@ -148,10 +142,10 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
 
   checkInvitation(invitation: Partial<Invitation>): InvalidInvitationError | AlreadyJoinedError | undefined {
     if (invitation.spaceKey == null) {
-      return new InvalidInvitationError('No spaceKey was provided for a space invitation.');
+      return new InvalidInvitationError({ message: 'No spaceKey was provided for a space invitation.' });
     }
     if (this._spaceManager.spaces.has(invitation.spaceKey)) {
-      return new AlreadyJoinedError('Already joined space.');
+      return new AlreadyJoinedError({ message: 'Already joined space.' });
     }
   }
 
@@ -176,7 +170,7 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
     };
   }
 
-  async accept(response: AdmissionResponse): Promise<Partial<Invitation>> {
+  async accept(ctx: Context, response: AdmissionResponse): Promise<Partial<Invitation>> {
     invariant(response.space);
     const { credential, controlTimeframe, dataTimeframe } = response.space;
     const assertion = getCredentialAssertion(credential);
@@ -184,15 +178,16 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
     invariant(credential.subject.id.equals(this._signingContext.identityKey));
 
     if (this._spaceManager.spaces.has(assertion.spaceKey)) {
-      throw new AlreadyJoinedError('Already joined space.');
+      throw new AlreadyJoinedError({ message: 'Already joined space.' });
     }
 
     // Create local space.
-    await this._spaceManager.acceptSpace({
+    await this._spaceManager.acceptSpace(ctx, {
       spaceKey: assertion.spaceKey,
       genesisFeedKey: assertion.genesisFeedKey,
       controlTimeframe,
       dataTimeframe,
+      tags: assertion.tags,
     });
 
     await this._signingContext.recordCredential(credential);

package/src/packlets/locks/index.ts

@@ -3,4 +3,4 @@
 //
 
 export type * from './resource-lock';
-export * from './node';
+export * from '#locks-platform';

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

@@ -5,13 +5,7 @@
 import { Event } from '@dxos/async';
 import { Stream } from '@dxos/codec-protobuf/stream';
 import { PublicKey } from '@dxos/keys';
-import {
-  type LogLevel,
-  type LogProcessor,
-  type LogEntry as NaturalLogEntry,
-  getContextFromEntry,
-  log,
-} from '@dxos/log';
+import { type LogLevel, type LogProcessor, type LogEntry as NaturalLogEntry, log } from '@dxos/log';
 import {
   type ControlMetricsRequest,
   type ControlMetricsResponse,
@@ -22,10 +16,14 @@ import {
   type QueryMetricsRequest,
   type QueryMetricsResponse,
 } from '@dxos/protocols/proto/dxos/client/services';
-import { getDebugName, jsonify, numericalValues, tracer } from '@dxos/util';
+import { numericalValues, tracer } from '@dxos/util';
 
 /**
  * Logging service used to spy on logs of the host.
+ *
+ * @deprecated This was created so that logs from the shared worker (WorkerClientServices) could be
+ * seen in the main window console without opening the shared worker DevTools. Shared worker client
+ * services is deprecated; dedicated worker logs already show in the main window console.
  */
 export class LoggingServiceImpl implements LoggingService {
   private readonly _logs = new Event<NaturalLogEntry>();
@@ -37,7 +35,7 @@ export class LoggingServiceImpl implements LoggingService {
   }
 
   async close(): Promise<void> {
-    const index = log.runtimeConfig.processors.findIndex((processor) => processor === this._logProcessor);
+    const index = log.runtimeConfig.processors.findIndex((processor: LogProcessor) => processor === this._logProcessor);
     log.runtimeConfig.processors.splice(index, 1);
   }
 
@@ -110,19 +108,25 @@ export class LoggingServiceImpl implements LoggingService {
           return;
         }
 
+        const { filename, line, context: scopeName } = entry.computedMeta;
+        const recordContext: Record<string, any> = { ...entry.computedContext };
+        if (entry.computedError !== undefined) {
+          recordContext.error = entry.computedError;
+        }
+
         const record: LogEntry = {
-          ...entry,
-          message: entry.message ?? (entry.error ? (entry.error.message ?? String(entry.error)) : ''),
-          context: jsonify(getContextFromEntry(entry)),
-          timestamp: new Date(),
+          level: entry.level,
+          message: entry.message ?? entry.computedError ?? '',
+          context: recordContext,
+          timestamp: new Date(entry.timestamp),
           meta: {
             // TODO(dmaretskyi): Fix proto.
-            file: entry.meta?.F ?? '',
-            line: entry.meta?.L ?? 0,
+            file: filename ?? '',
+            line: line ?? 0,
             scope: {
               hostSessionId: this._sessionId,
               uptimeSeconds: (Date.now() - this._started) / 1000,
-              name: getDebugName(entry.meta?.S),
+              name: scopeName ?? '',
             },
           },
         };

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

@@ -10,7 +10,6 @@ import { ConnectionState, type NetworkService } from '@dxos/protocols/proto/dxos
 
 import { type ServiceContext } from '../services';
 import { createServiceContext } from '../testing';
-
 import { NetworkServiceImpl } from './network-service';
 
 describe('NetworkService', () => {

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

@@ -2,7 +2,9 @@
 // Copyright 2022 DXOS.org
 //
 
+import { type RequestOptions } from '@dxos/codec-protobuf';
 import { Stream } from '@dxos/codec-protobuf/stream';
+import { Context } from '@dxos/context';
 import { type EdgeConnection } from '@dxos/edge-client';
 import { type SignalManager } from '@dxos/messaging';
 import { type SwarmNetworkManager } from '@dxos/network-manager';
@@ -47,16 +49,16 @@ export class NetworkServiceImpl implements NetworkService {
     await this.networkManager.setConnectionState(request.swarm);
   }
 
-  async joinSwarm(request: JoinRequest): Promise<void> {
-    return this.signalManager.join(request);
+  async joinSwarm(request: JoinRequest, options?: RequestOptions): Promise<void> {
+    return this.signalManager.join(options?.ctx ?? Context.default(), request);
   }
 
-  async leaveSwarm(request: LeaveRequest): Promise<void> {
-    return this.signalManager.leave(request);
+  async leaveSwarm(request: LeaveRequest, options?: RequestOptions): Promise<void> {
+    return this.signalManager.leave(options?.ctx ?? Context.default(), request);
   }
 
-  async querySwarm(request: QueryRequest): Promise<SwarmResponse> {
-    return this.signalManager.query(request);
+  async querySwarm(request: QueryRequest, options?: RequestOptions): Promise<SwarmResponse> {
+    return this.signalManager.query(options?.ctx ?? Context.default(), request);
   }
 
   subscribeSwarmState(request: SubscribeSwarmStateRequest): Stream<SwarmResponse> {
@@ -69,8 +71,8 @@ export class NetworkServiceImpl implements NetworkService {
     });
   }
 
-  async sendMessage(message: Message): Promise<void> {
-    return this.signalManager.sendMessage(message);
+  async sendMessage(message: Message, options?: RequestOptions): Promise<void> {
+    return this.signalManager.sendMessage(options?.ctx ?? Context.default(), message);
   }
 
   subscribeMessages(peer: Peer): Stream<Message> {

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

@@ -3,7 +3,7 @@
 //
 
 import { type ClientServices } from '@dxos/client-protocol';
-import { type Any, type ServiceHandler, Stream } from '@dxos/codec-protobuf';
+import { type Any, type RequestOptions, type ServiceHandler, Stream } from '@dxos/codec-protobuf';
 import { raise } from '@dxos/debug';
 import { RpcPeer, type RpcPeerOptions, type ServiceBundle, parseMethodName } from '@dxos/rpc';
 import { MapCounter, trace } from '@dxos/tracing';
@@ -11,17 +11,19 @@ import { type MaybePromise } from '@dxos/util';
 
 import { type ServiceRegistry } from './service-registry';
 
-export type ClientRpcServerParams = {
+export type ClientRpcServerProps = {
   serviceRegistry: ServiceRegistry<ClientServices>;
   handleCall?: (
     method: string,
     params: Any,
-    handler: (method: string, params: Any) => MaybePromise<Any>,
+    handler: (method: string, params: Any, options?: RequestOptions) => MaybePromise<Any>,
+    options?: RequestOptions,
   ) => Promise<Any>;
   handleStream?: (
     method: string,
     params: Any,
-    handler: (method: string, params: Any) => Stream<Any>,
+    handler: (method: string, params: Any, options?: RequestOptions) => Stream<Any>,
+    options?: RequestOptions,
   ) => MaybePromise<Stream<Any>>;
 } & Omit<RpcPeerOptions, 'callHandler' | 'streamHandler'>;
 
@@ -30,8 +32,8 @@ export class ClientRpcServer {
   private readonly _serviceRegistry: ServiceRegistry<ClientServices>;
   private readonly _rpcPeer: RpcPeer;
   private readonly _handlerCache = new Map<string, ServiceHandler<any>>();
-  private readonly _handleCall: ClientRpcServerParams['handleCall'];
-  private readonly _handleStream: ClientRpcServerParams['handleStream'];
+  private readonly _handleCall: ClientRpcServerProps['handleCall'];
+  private readonly _handleStream: ClientRpcServerProps['handleStream'];
 
   @trace.metricsCounter()
   private readonly _callMetrics = new MapCounter();
@@ -41,7 +43,7 @@ export class ClientRpcServer {
     return Object.keys(this._serviceRegistry.services);
   }
 
-  constructor(params: ClientRpcServerParams) {
+  constructor(params: ClientRpcServerProps) {
     const { serviceRegistry, handleCall, handleStream, ...rpcOptions } = params;
     this._handleCall = handleCall;
     this._handleStream = handleStream;
@@ -49,32 +51,33 @@ export class ClientRpcServer {
     this._serviceRegistry = serviceRegistry;
     this._rpcPeer = new RpcPeer({
       ...rpcOptions,
-      callHandler: (method, params) => {
+      callHandler: (method, params, options) => {
         const [serviceName, methodName] = parseMethodName(method);
-        const handler = (method: string, params: Any) => this._getServiceHandler(serviceName).call(method, params);
+        const handler = (method: string, params: Any, handlerOptions?: RequestOptions) =>
+          this._getServiceHandler(serviceName).call(method, params, handlerOptions);
 
         this._callMetrics.inc(`${serviceName}.${methodName} request`);
 
         if (this._handleCall) {
-          return this._handleCall(methodName, params, handler);
+          return this._handleCall(methodName, params, handler, options);
         } else {
-          return handler(methodName, params);
+          return handler(methodName, params, options);
         }
       },
-      streamHandler: (method, params) => {
+      streamHandler: (method, params, options) => {
         const [serviceName, methodName] = parseMethodName(method);
-        const handler = (method: string, params: Any) =>
-          this._getServiceHandler(serviceName).callStream(method, params);
+        const handler = (method: string, params: Any, handlerOptions?: RequestOptions) =>
+          this._getServiceHandler(serviceName).callStream(method, params, handlerOptions);
 
         this._callMetrics.inc(`${serviceName}.${methodName} request stream`);
 
         if (this._handleStream) {
-          return Stream.map(Stream.unwrapPromise(this._handleStream(methodName, params, handler)), (data) => {
+          return Stream.map(Stream.unwrapPromise(this._handleStream(methodName, params, handler, options)), (data) => {
             this._callMetrics.inc(`${serviceName}.${methodName} response stream`);
             return data;
           });
         } else {
-          return handler(methodName, params);
+          return handler(methodName, params, options);
         }
       },
     });