@hydranium/data-server 1.0.0-next.32 → 1.0.0-next.321

package/src/messages/index.ts

@@ -16,4 +16,11 @@
  * code is the contract, and renaming one is a breaking change.
  */
 
-export { NO_ACTIVE_PROFILE, NO_ACTIVE_PROFILE_CODE, noActiveProfileError } from '../data-server.js';
+export {
+   NO_ACTIVE_PROFILE,
+   NO_ACTIVE_PROFILE_CODE,
+   noActiveProfileError,
+   REFERENCE_SETTLE_TIMEOUT,
+   REFERENCE_SETTLE_TIMEOUT_CODE,
+   referenceSettleTimeoutError
+} from '../data-server.js';

package/src/node/node-diagnostics-provider.ts

@@ -8,14 +8,8 @@
  ********************************************************************************/
 
 import type { ServerSharedServices } from '@hydranium/core';
-import {
-   formatPodMemory,
-   formatProfileReport,
-   formatServerState,
-   ProfileCapture,
-   recordServerSummaryEntry,
-   writeHeapSnapshotToDir
-} from '@hydranium/core/node';
+import { formatProfileReport, formatServerState, ProfileCapture, recordServerSummaryEntry } from '@hydranium/core/node';
+import { formatPodMemory, writeHeapSnapshotToDir } from '@hydranium/protocol/node';
 import type { DumpServerStateArgs, StartProfilingArgs, StopProfilingArgs, WriteServerHeapSnapshotArgs } from '@hydranium/protocol';
 import type { DataServerDiagnosticsProvider, DataServerProfileCapture } from '../diagnostics-provider.js';
 

package/src/testing/data-server-harness.ts

@@ -14,10 +14,13 @@ import {
    type DataClientProtocol,
    type DataServerProtocol,
    type ProjectsChangedEvent,
+   type TransferDocumentDeletedEvent,
+   type TransferDocumentDirtyChangedEvent,
    type TransferDocumentSavedEvent,
+   type TransferDocumentsBuiltEvent,
    type TransferDocumentUpdatedEvent
 } from '@hydranium/protocol/data';
-import { type Harness, makeCapturingDataClient } from '@hydranium/protocol/testing';
+import { type AdditionalClientMethod, type Harness, makeCapturingDataClient } from '@hydranium/protocol/testing';
 import { makeDuplexConnectionPair, type DuplexConnectionPair } from '@hydranium/protocol/testing/node';
 import type { MessageConnection } from 'vscode-jsonrpc/node';
 
@@ -29,16 +32,17 @@ import type { MessageConnection } from 'vscode-jsonrpc/node';
  * (the "server side" of the duplex pair). The factory is invoked once,
  * synchronously, after the pair is wired.
  *
- * `client` lets tests override individual handlers on the captured
- * {@link DataClientProtocol}. Unspecified handlers default to pushing
- * incoming events into the {@link DataServerHarness} bundle's `events` /
- * `saves` / `projectsChanges` arrays — the typical assertion target.
+ * `client` lets tests override individual handlers on the captured client.
+ * Unspecified handlers default to pushing incoming events into the
+ * {@link DataServerHarness} bundle's `events` / `saves` / `projectsChanges`
+ * arrays — the typical assertion target.
  */
 export interface MakeDataServerHarnessOptions<
    TServer,
    TTransfer extends TransferElement,
    TDiagnostic extends TransferDiagnostic = TransferDiagnostic,
-   TProject extends Project = Project
+   TProject extends Project = Project,
+   TClient extends DataClientProtocol<TTransfer, TDiagnostic, TProject> = DataClientProtocol<TTransfer, TDiagnostic, TProject>
 > {
    /**
     * Construct the `DataServer` (or subclass) under test against
@@ -47,12 +51,19 @@ export interface MakeDataServerHarnessOptions<
     */
    server: (channel: MessageConnection) => TServer;
    /**
-    * Override per-method handlers on the captured {@link DataClientProtocol}.
-    * Each overridden handler REPLACES the default (which pushes into the
-    * bundle's capture arrays); test code wanting to BOTH capture AND
-    * react should push to the array manually inside the override.
+    * Override per-method handlers on the captured client. An additional
+    * method's override needs the method in `additionalClientMethods`, or the
+    * harness throws. Each overridden handler REPLACES the default (which
+    * pushes into the bundle's capture arrays); test code wanting to BOTH
+    * capture AND react should push to the array manually inside the override.
     */
-   client?: Partial<DataClientProtocol<TTransfer, TDiagnostic, TProject>>;
+   client?: Partial<TClient>;
+   /**
+    * Notification methods `TClient` adds to {@link DataClientProtocol}. Each is
+    * bound and captured into `additionalNotifications`; one left out reaches no
+    * handler.
+    */
+   additionalClientMethods?: readonly AdditionalClientMethod<TClient>[];
    /**
     * Wire namespace the proxy addresses the server under. Defaults to
     * {@link DATA_SERVER_WIRE_PREFIX}. Override when the `DataServer`
@@ -78,7 +89,8 @@ export interface DataServerHarness<
    TServer,
    TTransfer extends TransferElement,
    TDiagnostic extends TransferDiagnostic = TransferDiagnostic,
-   TProject extends Project = Project
+   TProject extends Project = Project,
+   TClient extends DataClientProtocol<TTransfer, TDiagnostic, TProject> = DataClientProtocol<TTransfer, TDiagnostic, TProject>
 > extends Harness {
    readonly server: TServer;
    readonly proxy: DataServerProtocol<TTransfer, TDiagnostic, TProject>;
@@ -87,8 +99,18 @@ export interface DataServerHarness<
    readonly events: ReadonlyArray<TransferDocumentUpdatedEvent<TTransfer, TDiagnostic>>;
    /** Captured `onDocumentSaved` events. */
    readonly saves: ReadonlyArray<TransferDocumentSavedEvent<TTransfer, TDiagnostic>>;
+   /** Captured `onDocumentDirtyChanged` events. */
+   readonly dirtyChanges: ReadonlyArray<TransferDocumentDirtyChangedEvent>;
+   /** Captured `onDocumentDeleted` events. */
+   readonly deletions: ReadonlyArray<TransferDocumentDeletedEvent>;
+   /** Captured `onDocumentsBuilt` events, one per build that had unwatched documents. */
+   readonly builds: ReadonlyArray<TransferDocumentsBuiltEvent>;
    /** Captured `onProjectsChanged` events. */
    readonly projectsChanges: ReadonlyArray<ProjectsChangedEvent<TProject>>;
+   /** Captured events of each `additionalClientMethods` entry, keyed by method. */
+   readonly additionalNotifications: {
+      readonly [K in AdditionalClientMethod<TClient>]: TClient[K] extends (event: infer TEvent) => void ? ReadonlyArray<TEvent> : never;
+   };
    /** Dispose the underlying duplex pair. Idempotent. */
    dispose(): void;
 }
@@ -107,15 +129,17 @@ export function makeDataServerHarness<
    TServer,
    TTransfer extends TransferElement,
    TDiagnostic extends TransferDiagnostic = TransferDiagnostic,
-   TProject extends Project = Project
+   TProject extends Project = Project,
+   TClient extends DataClientProtocol<TTransfer, TDiagnostic, TProject> = DataClientProtocol<TTransfer, TDiagnostic, TProject>
 >(
-   options: MakeDataServerHarnessOptions<TServer, TTransfer, TDiagnostic, TProject>
-): DataServerHarness<TServer, TTransfer, TDiagnostic, TProject> {
+   options: MakeDataServerHarnessOptions<TServer, TTransfer, TDiagnostic, TProject, TClient>
+): DataServerHarness<TServer, TTransfer, TDiagnostic, TProject, TClient> {
    const pair = makeDuplexConnectionPair();
    const server = options.server(pair.left);
+   const additionalClientMethods = options.additionalClientMethods ?? [];
 
    // The capture half is the shared client double, not a local copy: the same
-   // recording semantics (all three channels, an override replacing rather than
+   // recording semantics (every channel, an override replacing rather than
    // supplementing) then hold for a client-side suite that stands the double up
    // without a server, so an assertion learnt against one reads the same in the
    // other.
@@ -123,17 +147,18 @@ export function makeDataServerHarness<
       client: localClient,
       updates: events,
       saves,
-      projectsChanges
-   } = makeCapturingDataClient<TTransfer, TDiagnostic, TProject>(options.client);
+      dirtyChanges,
+      deletions,
+      builds,
+      projectsChanges,
+      additionalNotifications
+   } = makeCapturingDataClient<TTransfer, TDiagnostic, TProject, TClient>(options.client, additionalClientMethods);
 
-   const proxy = createRpcProxy<DataServerProtocol<TTransfer, TDiagnostic, TProject>, DataClientProtocol<TTransfer, TDiagnostic, TProject>>(
-      pair.right,
-      {
-         methodNamespace: options.methodNamespace ?? DATA_SERVER_WIRE_PREFIX,
-         localTarget: localClient,
-         localMethods: DATA_CLIENT_PROTOCOL_METHODS
-      }
-   );
+   const proxy = createRpcProxy<DataServerProtocol<TTransfer, TDiagnostic, TProject>, TClient>(pair.right, {
+      methodNamespace: options.methodNamespace ?? DATA_SERVER_WIRE_PREFIX,
+      localTarget: localClient,
+      localMethods: [...DATA_CLIENT_PROTOCOL_METHODS, ...additionalClientMethods]
+   });
 
    return {
       server,
@@ -141,7 +166,11 @@ export function makeDataServerHarness<
       pair,
       events,
       saves,
+      dirtyChanges,
+      deletions,
+      builds,
       projectsChanges,
+      additionalNotifications,
       dispose: () => pair.dispose()
    };
 }

package/src/testing/index.ts

@@ -12,8 +12,11 @@
 // real wire. The duplex `MessageConnection` pair lives in
 // `@hydranium/protocol/testing`, which owns the transport; only its TYPE is
 // re-exported here, because `DataServerHarness.pair` names it in a public
-// signature. A test that wires its own server rather than using the harness
-// calls `makeDuplexConnectionPair` from `@hydranium/protocol/testing` directly.
+// signature; `AdditionalClientMethod` is re-exported for the same reason, as
+// the harness options name it. A test that wires its own server rather than
+// using the harness calls `makeDuplexConnectionPair` from
+// `@hydranium/protocol/testing` directly.
 
+export type { AdditionalClientMethod } from '@hydranium/protocol/testing';
 export type { DuplexConnectionPair } from '@hydranium/protocol/testing/node';
 export * from './data-server-harness.js';