@dxos/client-services 0.1.56-main.83e9b8a → 0.1.56-main.a25bb93

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

@@ -6,18 +6,22 @@ import { Event } from '@dxos/async';
 import { Stream } from '@dxos/codec-protobuf';
 import { Config } from '@dxos/config';
 import {
+  GetDiagnosticsRequest,
   SystemService,
   SystemStatus,
   UpdateStatusRequest,
   QueryStatusRequest,
   QueryStatusResponse,
 } from '@dxos/protocols/proto/dxos/client/services';
-import { MaybePromise } from '@dxos/util';
+import { jsonKeyReplacer, MaybePromise } from '@dxos/util';
+
+import { Diagnostics } from '../services';
 
 export type SystemServiceOptions = {
   config?: Config;
   statusUpdate: Event<void>;
   getCurrentStatus: () => SystemStatus;
+  getDiagnostics: () => Promise<Partial<Diagnostics>>;
   onUpdateStatus: (status: SystemStatus) => MaybePromise<void>;
   onReset: () => MaybePromise<void>;
 };
@@ -28,11 +32,20 @@ export class SystemServiceImpl implements SystemService {
   private readonly _getCurrentStatus: SystemServiceOptions['getCurrentStatus'];
   private readonly _onUpdateStatus: SystemServiceOptions['onUpdateStatus'];
   private readonly _onReset: SystemServiceOptions['onReset'];
+  private readonly _getDiagnostics: SystemServiceOptions['getDiagnostics'];
 
-  constructor({ config, statusUpdate, onUpdateStatus, getCurrentStatus, onReset }: SystemServiceOptions) {
+  constructor({
+    config,
+    statusUpdate,
+    getDiagnostics,
+    onUpdateStatus,
+    getCurrentStatus,
+    onReset,
+  }: SystemServiceOptions) {
     this._config = config;
     this._statusUpdate = statusUpdate;
     this._getCurrentStatus = getCurrentStatus;
+    this._getDiagnostics = getDiagnostics;
     this._onUpdateStatus = onUpdateStatus;
     this._onReset = onReset;
   }
@@ -41,6 +54,25 @@ export class SystemServiceImpl implements SystemService {
     return this._config?.values ?? {};
   }
 
+  /**
+   * NOTE: Since this is serialized as a JSON object, we allow the option to serialize keys.
+   */
+  async getDiagnostics({ keys }: GetDiagnosticsRequest = {}) {
+    const diagnostics = await this._getDiagnostics();
+    return {
+      timestamp: new Date(),
+      diagnostics: JSON.parse(
+        JSON.stringify(
+          diagnostics,
+          jsonKeyReplacer({
+            truncate: keys === GetDiagnosticsRequest.KEY_OPTION.TRUNCATE,
+            humanize: keys === GetDiagnosticsRequest.KEY_OPTION.HUMANIZE,
+          }),
+        ),
+      ),
+    };
+  }
+
   async updateStatus({ status }: UpdateStatusRequest) {
     await this._onUpdateStatus(status);
   }

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

@@ -2,10 +2,9 @@
 // Copyright 2023 DXOS.org
 //
 
-import invariant from 'tiny-invariant';
-
 import { Trigger } from '@dxos/async';
 import { AuthenticatingInvitationObservable, CancellableInvitationObservable } from '@dxos/client-protocol';
+import { invariant } from '@dxos/invariant';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
 
 import { ServiceContext } from '../services';

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

@@ -2,10 +2,9 @@
 // Copyright 2023 DXOS.org
 //
 
-import invariant from 'tiny-invariant';
-
 import { Event } from '@dxos/async';
 import { appServiceBundle, AppServiceBundle, ShellRuntime, shellServiceBundle } from '@dxos/client-protocol';
+import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 import { AppContextRequest, LayoutRequest, ShellLayout } from '@dxos/protocols/proto/dxos/iframe';
 import { createProtoRpcPeer, ProtoRpcPeer, RpcPort } from '@dxos/rpc';

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

@@ -2,8 +2,6 @@
 // Copyright 2022 DXOS.org
 //
 
-import invariant from 'tiny-invariant';
-
 import { asyncTimeout, Trigger } from '@dxos/async';
 import {
   iframeServiceBundle,
@@ -11,6 +9,7 @@ import {
   PROXY_CONNECTION_TIMEOUT,
   workerServiceBundle,
 } from '@dxos/client-protocol';
+import { invariant } from '@dxos/invariant';
 import { log, logInfo } from '@dxos/log';
 import { BridgeService } from '@dxos/protocols/proto/dxos/mesh/bridge';
 import { createProtoRpcPeer, ProtoRpcPeer, RpcPort } from '@dxos/rpc';
@@ -74,6 +73,7 @@ export class WorkerSession {
       port: appPort,
       ...middleware,
     });
+
     this._shellClientRpc = new ClientRpcServer({
       serviceRegistry: this._serviceHost.serviceRegistry,
       port: shellPort,
@@ -103,7 +103,7 @@ export class WorkerSession {
         },
       },
       port: systemPort,
-      timeout: 1000, // With low timeout heartbeat may fail if the tab's thread is saturated.
+      timeout: 1_000, // With low timeout heartbeat may fail if the tab's thread is saturated.
     });
 
     this.bridgeService = this._iframeRpc.rpc.BridgeService;
@@ -113,10 +113,14 @@ export class WorkerSession {
     log.info('opening...');
     await Promise.all([this._clientRpc.open(), this._iframeRpc.open(), this._maybeOpenShell()]);
 
+    // Wait until the worker's RPC service has started.
     await this._startTrigger.wait({ timeout: PROXY_CONNECTION_TIMEOUT });
+
+    // TODO(burdon): Comment required.
     if (this.lockKey) {
       void this._afterLockReleases(this.lockKey, () => this.close());
     }
+
     log.info('opened');
   }
 

package/src/version.ts

@@ -0,0 +1 @@
+export const DXOS_VERSION = "0.1.56-main.a25bb93";