@hydranium/data-server 1.0.0-next.14 → 1.0.0-next.140

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,12 +9,20 @@
9
9
 
10
10
  import {
11
11
  createRpcProxy,
12
+ defineMessage,
12
13
  DisposableCollection,
14
+ HYDRANIUM_ERROR_CODES,
13
15
  isDocumentSource,
14
16
  isElementSource,
15
17
  isSyntheticSource,
18
+ messageData,
19
+ messageError,
16
20
  ReferenceSource,
21
+ SessionClosedError,
22
+ TIMED_OUT,
17
23
  type CloseModelArgs,
24
+ type HydraniumMessageData,
25
+ type HydraniumResponseError,
18
26
  type Disposable,
19
27
  type ElementSource,
20
28
  type FindNextNameArgs,
@@ -28,8 +36,10 @@ import {
28
36
  type ReferenceTarget,
29
37
  type Tracer,
30
38
  type TransferDiagnostic,
31
- type TransferDocument,
32
- type TransferElement
39
+ TransferDocument,
40
+ type TransferElement,
41
+ UNKNOWN_CLIENT_ID,
42
+ asSnapshotVersion
33
43
  } from '@hydranium/protocol';
34
44
  import {
35
45
  DATA_SERVER_DIAGNOSTICS_METHODS,
@@ -42,29 +52,84 @@ import {
42
52
  type StartProfilingArgs,
43
53
  type StopProfilingArgs,
44
54
  type WriteServerHeapSnapshotArgs,
55
+ type CloseSessionArgs,
56
+ type CreateModelDocumentArgs,
57
+ type CreateSessionArgs,
45
58
  type GetModelDocumentArgs,
46
59
  type GetProjectForUriArgs,
47
60
  type TransferSaveDocumentArgs,
48
61
  type WatchModelDocumentArgs,
49
62
  type TransferDocumentSavedEvent,
50
63
  type TransferDocumentUpdatedEvent,
51
- type TransferUpdateDocumentArgs
64
+ type TransferUpdateDocumentArgs,
65
+ type TransferUpdateDocumentsArgs
52
66
  } from '@hydranium/protocol/data';
53
- import { REVERT_ON_CLOSE_CLIENT_ID, UNKNOWN_CLIENT_ID } from '@hydranium/core';
67
+ import { REVERT_ON_CLOSE_CLIENT_ID } from '@hydranium/core';
54
68
  import { defaultDataServerDiagnostics } from './default-diagnostics.js';
69
+
70
+ /**
71
+ * Raised when a profiling command arrives with no capture running.
72
+ *
73
+ * A `ResponseError` rather than a plain `Error` so the identity survives to the
74
+ * response boundary, which is where the message is rendered. An unwrapped throw
75
+ * reaches the client as a generic internal error instead: no code for a caller
76
+ * to switch on, and nothing for the boundary to render from.
77
+ */
78
+ export const NO_ACTIVE_PROFILE = defineMessage(
79
+ 'hydranium/data-server/no-active-profile',
80
+ 'No profiling capture is active; call startProfiling first.'
81
+ );
82
+
83
+ /**
84
+ * The JSON-RPC code, unrelated to the catalogue code above: this one is numeric,
85
+ * survives reconstruction and is what a caller switches on.
86
+ */
87
+ export const NO_ACTIVE_PROFILE_CODE = HYDRANIUM_ERROR_CODES.noActiveProfile;
88
+
89
+ export const noActiveProfileError = (): HydraniumResponseError => messageError(NO_ACTIVE_PROFILE_CODE, NO_ACTIVE_PROFILE);
90
+
91
+ /**
92
+ * Raised when a reference question's wait for the build exceeds
93
+ * {@link DataServerOptions.referenceSettleTimeoutMs}.
94
+ *
95
+ * A `ResponseError` because a class name does not cross RPC: without the code a
96
+ * wire client cannot tell a wedged build from a reference that resolves to
97
+ * nothing, which is the distinction the wait exists to keep.
98
+ */
99
+ export const REFERENCE_SETTLE_TIMEOUT = defineMessage(
100
+ 'hydranium/data-server/reference-settle-timeout',
101
+ 'The model is still being processed; try again in a moment.'
102
+ );
103
+
104
+ /** See {@link NO_ACTIVE_PROFILE_CODE} for why this is separate from the catalogue code. */
105
+ export const REFERENCE_SETTLE_TIMEOUT_CODE = HYDRANIUM_ERROR_CODES.referenceSettleTimeout;
106
+
107
+ /** The wait's length rides in `data` as `elapsedMs`, for the code that reacts rather than the reader. */
108
+ export const referenceSettleTimeoutError = (elapsedMs: number): ResponseError<HydraniumMessageData & { readonly elapsedMs: number }> =>
109
+ new ResponseError(REFERENCE_SETTLE_TIMEOUT_CODE, REFERENCE_SETTLE_TIMEOUT.format(), {
110
+ elapsedMs,
111
+ ...messageData(REFERENCE_SETTLE_TIMEOUT)
112
+ });
113
+
55
114
  import type { DataServerDiagnosticsProvider, DataServerProfileCapture } from './diagnostics-provider.js';
56
115
  import type {
116
+ ClientSession,
117
+ ClientSessionWriteArgs,
57
118
  ClientTextDocumentChangeEvent,
119
+ DocumentDirtyChangedEvent,
58
120
  HydraniumLanguageServices,
59
121
  LogNameOptions,
122
+ AstDiagnostic,
123
+ AstDocument,
60
124
  ModelService,
61
125
  ProjectChangeEvent,
62
126
  ServerSharedServices,
127
+ SessionEndCause,
63
128
  TransferEncoder
64
129
  } from '@hydranium/core';
65
130
  import type { TextDocument } from 'vscode-languageserver-textdocument';
66
131
  import { type AstNode, DocumentState, type LangiumDocument, UriUtils, type URI } from '@hydranium/langium';
67
- import type { CancellationToken, MessageConnection } from 'vscode-jsonrpc';
132
+ import { type CancellationToken, type MessageConnection, ResponseError } from 'vscode-jsonrpc';
68
133
 
69
134
  /**
70
135
  * Domain separator between text and diagnostics inputs of
@@ -104,6 +169,18 @@ function fingerprintHash(parts: readonly string[]): string {
104
169
  return high + low;
105
170
  }
106
171
 
172
+ /**
173
+ * A session a data connection registered with a resume token, and how to end
174
+ * it from another connection. See {@link DataServer.resumableSessions}.
175
+ */
176
+ export interface ResumableSession {
177
+ readonly token: string;
178
+ /** End the session as its connection closing would. */
179
+ readonly end: () => void;
180
+ }
181
+
182
+ const resumableByModelService = new WeakMap<object, Map<string, ResumableSession>>();
183
+
107
184
  /**
108
185
  * Which observable state {@link DataServer.computeDocumentFingerprint} hashes to
109
186
  * de-dup `onDocumentUpdated` emissions.
@@ -155,12 +232,13 @@ export interface DataServerOptions extends LogNameOptions {
155
232
  * (`DataClientProtocol.onDocumentUpdated`).
156
233
  *
157
234
  * **Subscription dispatch only** — distinct from the synchronous RPC
158
- * response phase. The lifecycle reads/writes (`getModelDocument` /
159
- * `updateModelDocument` / `saveModelDocument`) settle at the
160
- * integrity-settled landmark (`IntegrityService.SettledState`); a
161
- * read additionally upgrades to `Validated` per call when
162
- * {@link GetModelDocumentArgs.includeDiagnostics} is set. This option
163
- * controls only the async notification phase.
235
+ * response phase. A read (`getModelDocument`) settles at the
236
+ * integrity-settled landmark (`IntegrityService.SettledState`), or at
237
+ * `Validated` when {@link GetModelDocumentArgs.includeDiagnostics} is set.
238
+ * A write (`updateModelDocument` / `updateModelDocuments` /
239
+ * `saveModelDocument`) answers once its document is validated, as a
240
+ * session's write does. This option controls only the async notification
241
+ * phase.
164
242
  *
165
243
  * Default: `DocumentState.Validated` — validation is the last builder
166
244
  * phase and produces the full diagnostic set, so subscription events fired
@@ -201,6 +279,22 @@ export interface DataServerOptions extends LogNameOptions {
201
279
  */
202
280
  readonly fingerprintStrategy?: FingerprintStrategy;
203
281
 
282
+ /**
283
+ * How long a reference question waits for the build to reach `Linked` before
284
+ * failing with {@link REFERENCE_SETTLE_TIMEOUT_CODE}. Bounded because the
285
+ * wait resolves off a build-phase notification, so a build cancelled below
286
+ * `Linked` with nothing after it leaves the request unanswered for the life
287
+ * of the server.
288
+ *
289
+ * Expiry rejects rather than reading the index anyway: the unsettled index
290
+ * is what the wait keeps the caller away from, so falling through to it on a
291
+ * slow build reinstates the fault — and on a name proposal persists it.
292
+ *
293
+ * Default {@link DataServer.DEFAULT_OPTIONS}, sized for a cold workspace
294
+ * still reaching `Linked` for the first time.
295
+ */
296
+ readonly referenceSettleTimeoutMs?: number;
297
+
204
298
  /**
205
299
  * Wire-method namespace for both inbound request handlers and the
206
300
  * outbound notification client proxy. Defaults to
@@ -258,15 +352,20 @@ export interface DataServerOptions extends LogNameOptions {
258
352
  * When supplied, every inbound data-server RPC is timed into this collector
259
353
  * (via the `createRpcProxy` binding) and exposed through
260
354
  * {@link DataServerDiagnosticsProtocol.getLatency}. A head that also runs an
261
- * LSP connection can pass the SAME collector to
262
- * `instrumentLspConnection(connection, latency)` so one report covers both
263
- * heads. Absent by default (no timing overhead).
355
+ * LSP connection can pass the SAME collector through `lspLatencyOptions` to
356
+ * that connection, so one report covers both heads. Absent by default (no
357
+ * timing overhead).
264
358
  */
265
359
  readonly latency?: LatencyCollector;
266
360
  }
267
361
 
268
- /** Fully-resolved variant — every field set, used internally after merging defaults. */
269
- interface ResolvedDataServerOptions {
362
+ /**
363
+ * Fully-resolved variant of {@link DataServerOptions} — every field set, after
364
+ * merging defaults. Returned by the `protected`
365
+ * {@link DataServer.resolveOptions} and held on {@link DataServer.options}, so
366
+ * an adopter changing how defaults resolve has to name it.
367
+ */
368
+ export interface ResolvedDataServerOptions {
270
369
  readonly subscriptionPhase: DocumentState;
271
370
  readonly fingerprintStrategy: FingerprintStrategy;
272
371
  readonly methodNamespace: string;
@@ -274,6 +373,34 @@ interface ResolvedDataServerOptions {
274
373
  readonly excludedMethods: readonly string[];
275
374
  /** Always resolved — to the caller's, or to the platform default. */
276
375
  readonly diagnostics: DataServerDiagnosticsProvider;
376
+ readonly referenceSettleTimeoutMs: number;
377
+ }
378
+
379
+ /**
380
+ * What a {@link DataServer} keeps per canonical URI, in the `protected`
381
+ * {@link DataServer.uriWatchRecords}. A record lives while it has a watcher
382
+ * or a revert mark; {@link DataServer.pruneUriWatchRecord} enforces that on
383
+ * every path that removes either, so a record with no watcher has a revert
384
+ * pending. Test the size of {@link DataServerUriWatchRecord.watchers}, not the
385
+ * record's presence, for "watched".
386
+ */
387
+ export interface DataServerUriWatchRecord {
388
+ /** The client ids watching the URI; save, dirty and phase events go out only while it is non-empty, a pending revert aside. */
389
+ readonly watchers: Set<string>;
390
+ /** Digest of the last emitted state, or of the state a first watch found; see {@link DataServer.dispatchPhaseEvent} for why it de-duplicates, {@link DataServer.computeDocumentFingerprint} for its inputs. */
391
+ fingerprint?: string;
392
+ /** Set by {@link DataServer.subscribeToTextDocumentCloses}; the next phase event broadcasts even without a watcher. */
393
+ revertPending?: boolean;
394
+ /**
395
+ * The version of an open document the last event sent was built at. The
396
+ * version sent again goes out as `'rebuilt'` from no client: the manager
397
+ * counts a version delivered only once its `Validated` listeners ran, so a
398
+ * build cancelled after the subscription phase would send it as a change
399
+ * twice. Only while the store has the document open: without it, a
400
+ * document can keep one version through changes of its file, so its events
401
+ * keep the manager's attribution.
402
+ */
403
+ sentVersion?: number;
277
404
  }
278
405
 
279
406
  /**
@@ -301,9 +428,11 @@ interface ResolvedDataServerOptions {
301
428
  * any names supplied via {@link DataServerOptions.additionalMethods}) and
302
429
  * builds the {@link DataClientProtocol} notification proxy on the same
303
430
  * connection in one {@link createRpcProxy} call (binding `this` as its
304
- * `localTarget`) under the configured namespace, and subscribes one
305
- * `DocumentBuilder.onDocumentPhase` listener per configured phase that
306
- * dispatches subscription events via `clientProxy.onDocumentUpdated`.
431
+ * `localTarget`) under the configured namespace, and subscribes two listeners
432
+ * at the configured phase: a `DocumentBuilder.onDocumentPhase` one dispatching
433
+ * per-document `clientProxy.onDocumentUpdated` for watched URIs, and a
434
+ * `DocumentBuilder.onBuildPhase` one dispatching a single
435
+ * `clientProxy.onDocumentsBuilt` naming the batch's unwatched documents.
307
436
  *
308
437
  * The data-server requires the full {@link ServerSharedServices}
309
438
  * shape — `HydraniumTextDocuments` for client-attributed updates,
@@ -331,87 +460,27 @@ export class DataServer<
331
460
  * Framework defaults, exposed so an adopter can spread them when
332
461
  * extending rather than restate a value the framework may change.
333
462
  */
334
- static readonly DEFAULT_OPTIONS: Required<Pick<DataServerOptions, 'subscriptionPhase'>> = {
335
- subscriptionPhase: DocumentState.Validated
463
+ static readonly DEFAULT_OPTIONS: Required<Pick<DataServerOptions, 'subscriptionPhase' | 'referenceSettleTimeoutMs'>> = {
464
+ subscriptionPhase: DocumentState.Validated,
465
+ referenceSettleTimeoutMs: 60_000
336
466
  };
337
467
 
338
468
  protected readonly options: ResolvedDataServerOptions;
339
- /** Subscription bookkeeping: URI → set of clientIds that subscribed for that URI. */
340
- protected readonly subscriptions = new Map<string, Set<string>>();
469
+ /** This connection's {@link DataServerUriWatchRecord} per canonical URI; see there for when a record lives. */
470
+ protected readonly uriWatchRecords = new Map<string, DataServerUriWatchRecord>();
341
471
  /**
342
- * Open-document bookkeeping: URI → set of clientIds that opened it over THIS
343
- * connection.
472
+ * The client sessions this connection registered, by client id. A document
473
+ * request carrying one of these ids acts as that session; one carrying any
474
+ * other id fails.
344
475
  *
345
- * Kept because the document store releases a client's hold only from an
346
- * explicit close, and a client that dies without closing would otherwise keep
347
- * the document open forever — resident, and with its last-close revert
348
- * suppressed. The store has no notion of which connection a clientId reached
349
- * it over, so the connection-scoped set has to live here; teaching it a client
350
- * identity is the more robust and much larger alternative.
476
+ * Entries stay after {@link dispose} has ended their sessions, so a request
477
+ * still running from before the connection closed reaches the ended handle
478
+ * and fails with the session's own error.
351
479
  */
352
- protected readonly openedDocuments = new Map<string, Set<string>>();
480
+ protected readonly clientSessions = new Map<string, ClientSession<AstNode, AstDiagnostic, TTransfer>>();
353
481
  /** Typed client proxy — sends `data-server/on*` notifications back over the same wire. */
354
482
  protected readonly clientProxy: DataClientProtocol<TTransfer, TDiagnostic, TProject>;
355
483
  protected readonly disposables = new DisposableCollection();
356
- /**
357
- * Snapshot of the most recent `DocumentBuilder.onUpdate` event. Drives
358
- * `reason` discrimination on outbound `onDocumentUpdated` notifications:
359
- * a URI in the `changed` list emits `'changed'`, in `deleted` emits
360
- * `'deleted'`, otherwise `'rebuilt'` (cascade rebuild from a dependent
361
- * URI's change). The same mechanism `AstDocumentManager.onUpdate` uses on
362
- * the LSP side, so reason fidelity stays consistent between heads.
363
- */
364
- protected lastBuildUpdate?: { changed: readonly URI[]; deleted: readonly URI[] };
365
- /**
366
- * Per-URI hash of the last emitted (text + diagnostics) state,
367
- * used by {@link dispatchPhaseEvent} to suppress duplicate
368
- * `onDocumentUpdated` notifications for rebuilds that produce no
369
- * observable change since the last emit.
370
- *
371
- * Two scenarios routinely produce such rebuilds:
372
- * 1. **Refresh-triggered rebuilds.** When a second client attaches to a
373
- * document already open in another client,
374
- * `HydraniumTextDocuments.refreshContent` fires `onDidChangeContent`
375
- * purely to re-trigger the build pipeline — the text and diagnostics
376
- * are identical to the prior emit.
377
- * 2. **Cascade rebuilds with no diagnostic delta.** Langium rebuilds a
378
- * document when a dependency changes; if the rebuild produces the
379
- * same diagnostics, there is nothing new to communicate to subscribers.
380
- *
381
- * Without this filter, both scenarios reach subscribers as wire-side
382
- * `'changed'` events. A subscriber that interprets `'changed'` as
383
- * "another client wrote new content" and resets its in-memory root to
384
- * the server view then misreads the spurious event as a concurrent
385
- * third-party write and loses the user's edits.
386
- *
387
- * Initialised on {@link watchModelDocument} to the current
388
- * document fingerprint so the FIRST phase event after a fresh
389
- * subscription is also de-duplicated against the state subscribers
390
- * obtained via `getModelDocument` — they do not need a redundant phase
391
- * notification for the state they just fetched.
392
- *
393
- * Cleared in {@link unwatchModelDocument} when the last
394
- * subscriber for a URI leaves so memory does not accumulate.
395
- *
396
- * Stored as a cyrb53 hex digest (16 chars per URI) rather than the raw
397
- * text + diagnostics serialisation so the memory cost is constant in
398
- * document size. See {@link computeDocumentFingerprint} for the inputs.
399
- */
400
- protected readonly lastEmittedFingerprint = new Map<string, string>();
401
- /**
402
- * URIs whose LAST client just closed. The update handler rebuilds such a
403
- * document from its disk content (discarding unsaved in-session edits),
404
- * but {@link dispatchPhaseEvent} gates on the subscription map — and the
405
- * last close typically also removed the last watcher, so consumers that
406
- * only ever fetch via `getModelDocument` would keep showing the
407
- * discarded state forever. Marked on the last-close transition (see
408
- * {@link subscribeToTextDocumentCloses}) and consumed by
409
- * {@link dispatchPhaseEvent}, which broadcasts the following rebuild's
410
- * phase event even without a subscription — de-duplicated against
411
- * {@link lastEmittedFingerprint} where an entry survives, so a close
412
- * whose disk state equals the last emitted state stays silent.
413
- */
414
- protected readonly pendingRevertBroadcasts = new Set<string>();
415
484
  protected readonly tracer: Tracer;
416
485
  /** The in-flight interactive profile capture, held between {@link startProfiling} and {@link stopProfiling}. */
417
486
  protected activeProfile?: DataServerProfileCapture;
@@ -420,27 +489,23 @@ export class DataServer<
420
489
  /** Per-method RPC latency collector, when the head opted in via {@link DataServerOptions.latency}. */
421
490
  protected readonly latency?: LatencyCollector;
422
491
  /** Encoder pulled from DI. Adopters rebind `services.model.TransferEncoder` to a typed-overlay subclass. */
423
- protected readonly encoder: TransferEncoder<unknown, TDiagnostic>;
492
+ protected readonly encoder: TransferEncoder<TDiagnostic>;
424
493
  /**
425
494
  * In-process workspace facade — the lifecycle delegate `get` / `update` / `save` go through.
426
- * The facade's AstDocument diagnostic shape is intentionally typed `unknown` here: adopters
427
- * carry LSP-shape diagnostics in their AstDocument (e.g. an adopter's LSP-shape diagnostic type)
428
- * while the wire shape stays `TDiagnostic extends TransferDiagnostic`. The encoder's
429
- * `astDocumentToTransferDocument` accepts both shapes (wire-shape or LSP-shape) and projects
430
- * to wire shape on the return — see `TransferEncoder.astDocumentToTransferDocument`.
495
+ * Its documents carry the AST-layer {@link AstDiagnostic}, never the wire `TDiagnostic`:
496
+ * {@link encoder} converts one into the other on the way out.
431
497
  */
432
- protected readonly modelService: ModelService<AstNode, unknown, TTransfer>;
498
+ protected readonly modelService: ModelService<AstNode, AstDiagnostic, TTransfer>;
433
499
 
434
500
  constructor(
435
501
  protected readonly connection: MessageConnection,
436
- protected readonly services: ServerSharedServices<TProject>,
502
+ protected readonly services: ServerSharedServices<TProject, TDiagnostic>,
437
503
  options: DataServerOptions = {}
438
504
  ) {
439
505
  this.options = this.resolveOptions(options);
440
506
  this.tracer = this.services.Tracer.for(options.logName ?? 'DataServer').trace('instantiated');
441
507
  // DI-bound: adopters rebind `services.model.TransferEncoder` /
442
- // `services.model.ModelService` with their own subclasses. Slot types use the
443
- // framework upper bounds; the casts below narrow to this instance's generics.
508
+ // `services.model.ModelService` with their own subclasses.
444
509
  const { TransferEncoder: encoder, ModelService: modelService } = this.services.model;
445
510
  if (!encoder || !modelService) {
446
511
  throw new Error(
@@ -448,8 +513,8 @@ export class DataServer<
448
513
  'Did you compose `createServerSharedModule(ctx)` into your shared module?'
449
514
  );
450
515
  }
451
- this.encoder = encoder as TransferEncoder<unknown, TDiagnostic>;
452
- this.modelService = modelService as ModelService<AstNode, unknown, TTransfer>;
516
+ this.encoder = encoder;
517
+ this.modelService = modelService;
453
518
  const excluded = new Set<string>(this.options.excludedMethods);
454
519
  const registeredMethods = [
455
520
  ...DATA_SERVER_PROTOCOL_METHODS,
@@ -465,38 +530,43 @@ export class DataServer<
465
530
  methodNamespace: this.options.methodNamespace,
466
531
  localTarget: this,
467
532
  localMethods: registeredMethods as readonly (keyof this & string)[],
468
- latency: this.latency
533
+ latency: this.latency,
534
+ // Bound at the chokepoint rather than per handler, so an adopter's
535
+ // `additionalMethods` are rendered on the same terms as the
536
+ // framework's own rejections.
537
+ renderErrorMessage: error => this.services.MessageRenderer.renderError(error)
469
538
  });
470
- this.disposables.push(
471
- this.services.workspace.DocumentBuilder.onUpdate((changed, deleted) => {
472
- this.lastBuildUpdate = { changed, deleted };
473
- })
474
- );
539
+ this.disposables.push(this.services.workspace.DocumentBuilder.onUpdate((_changed, deleted) => this.dispatchDeleteEvents(deleted)));
475
540
  this.subscribeToDocumentBuilder();
476
541
  this.subscribeToTextDocumentSaves();
542
+ this.subscribeToDirtyChanges();
477
543
  this.subscribeToTextDocumentCloses();
478
544
  this.subscribeToProjectManager();
479
545
  // Self-register teardown so an adopter that keeps no reference to the
480
546
  // server still releases per-connection state, with no lifecycle hook of
481
- // its own. See `dispose`.
482
- this.disposables.push(connection.onClose(() => this.dispose()));
547
+ // its own. The client did not close anything itself, so its sessions end
548
+ // as lost and each document it was the last to have open waits out the
549
+ // store's revert grace. See `dispose`.
550
+ this.disposables.push(connection.onClose(() => this.dispose('lost')));
483
551
  }
484
552
 
485
553
  /**
486
554
  * Release everything the constructor wired up — the bound protocol
487
- * handlers and every listener — and clear the subscription map and the
488
- * per-URI emission-fingerprint cache, so a long-lived shared services
489
- * bundle does not retain per-connection memory after the connection
490
- * closes. Also closes every document still open over this connection (see
491
- * {@link closeOpenDocuments}), which is the SHARED store's state rather than
492
- * this server's and so outlives the connection unless released here.
555
+ * handlers and every listener — and clear {@link uriWatchRecords}, so a
556
+ * long-lived shared services bundle does not retain per-connection memory
557
+ * after the connection closes. Also ends every session this connection registered, which closes
558
+ * every document it has open: the SHARED store's state rather than this
559
+ * server's, which outlives the connection unless released here.
493
560
  *
494
- * Idempotent: subsequent calls are no-ops. Self-fires on
495
- * `connection.onClose` so adopters who don't hold a reference still
496
- * get per-connection cleanup; adopters that DO hold a reference may
497
- * call `dispose()` directly for early teardown.
561
+ * Idempotent: subsequent calls are no-ops. Runs by itself when the
562
+ * connection closes, so adopters who don't hold a reference still get
563
+ * per-connection cleanup; adopters that DO hold a reference may call
564
+ * `dispose()` directly for early teardown. The sessions end with `cause`:
565
+ * `'closed'` reverts every document whose last open they close at once,
566
+ * and `'lost'`, the connection's own close, lets each wait out the revert
567
+ * grace.
498
568
  */
499
- dispose(): void {
569
+ dispose(cause: SessionEndCause = 'closed'): void {
500
570
  this.disposed = true;
501
571
  // Release an in-flight interactive capture so the process-wide inspector
502
572
  // singleton is not left active after the connection closes.
@@ -505,102 +575,178 @@ export class DataServer<
505
575
  this.activeProfile = undefined;
506
576
  void capture.stop({}).catch(() => undefined);
507
577
  }
508
- // AFTER `disposables.dispose()`, deliberately: closing a document fires
509
- // `onDidClose`, and this server's own close listener would otherwise mark a
510
- // revert broadcast for a connection that is already gone.
578
+ // AFTER `disposables.dispose()`, deliberately: ending a session releases
579
+ // each document it was the last to hold, and this server's own
580
+ // `onDidCloseLastOpen` listener would otherwise mark a revert broadcast
581
+ // for a connection that is already gone.
511
582
  this.disposables.dispose();
512
- this.closeOpenDocuments();
513
- this.subscriptions.clear();
514
- this.lastEmittedFingerprint.clear();
515
- this.pendingRevertBroadcasts.clear();
583
+ for (const [clientId, session] of this.clientSessions) {
584
+ this.endSession(clientId, session, cause);
585
+ }
586
+ this.uriWatchRecords.clear();
516
587
  }
517
588
 
518
589
  // ============================================================
519
- // DataServerProtocol implementation — delegates to ModelService.
590
+ // DataServerProtocol implementation
520
591
  // ============================================================
521
592
  //
522
- // The lifecycle methods (`get` / `update` / `save` / `ready`) forward
523
- // straight to `ModelService` and encode the returned `AstDocument` on
524
- // the wire boundary via `encoder.astDocumentToTransferDocument`.
525
- // Adopters customising lifecycle behaviour (normalisation, supersession,
526
- // settled-phase choice, etc.) override on the ModelService subclass —
527
- // no override on DataServer is needed.
528
-
529
- async openModelDocument(args: OpenModelArgs): Promise<TransferDocument<TTransfer, TDiagnostic>> {
530
- // Register the editor session (idempotent — `ModelService.open` refreshes
531
- // an already-open document rather than re-opening), then return the built
532
- // state at the configured target phase. The one-shot snapshot; subsequent
533
- // build-phase events arrive via `watchModelDocument`.
534
- await this.modelService.open(args);
535
- // Record the hold so `dispose` can release it for a client that never
536
- // closes. Keyed by the URI as given, because that is what `close` takes.
537
- let holders = this.openedDocuments.get(args.uri);
538
- if (!holders) {
539
- holders = new Set<string>();
540
- this.openedDocuments.set(args.uri, holders);
593
+ // Reads go to `ModelService`; a request that opens or writes a document
594
+ // goes to the session this connection registered under its `clientId`.
595
+ // Each answer is encoded on the wire boundary via
596
+ // `encoder.astDocumentToTransferDocument`. To change how documents are
597
+ // read, override on the ModelService subclass; to change how they are
598
+ // written, on the session class the bound `ClientSessionFactory` builds.
599
+
600
+ async createSession(args: CreateSessionArgs): Promise<void> {
601
+ // After teardown nothing would ever end a session registered now, and its
602
+ // id would stay taken for the life of the process.
603
+ if (this.disposed) {
604
+ throw new SessionClosedError(args.clientId);
605
+ }
606
+ const resumable = this.resumableSessions();
607
+ const previous = resumable.get(args.clientId);
608
+ if (previous && args.resumeToken !== undefined && previous.token === args.resumeToken) {
609
+ previous.end();
610
+ }
611
+ const session = this.modelService.createSession(args.label, args.clientId);
612
+ this.clientSessions.set(args.clientId, session);
613
+ if (args.resumeToken !== undefined) {
614
+ // Taken over by a client registering again after its connection
615
+ // dropped, so the old session ends as lost: the documents it was the
616
+ // last to have open wait out the grace, and the new session's opens
617
+ // find their unsaved text.
618
+ resumable.set(args.clientId, { token: args.resumeToken, end: () => this.endSession(args.clientId, session, 'lost') });
541
619
  }
542
- holders.add(args.clientId);
543
- const document = await this.getModelDocument({ uri: args.uri });
544
- // Project the authoritative client-facing version onto the open snapshot.
545
- // `getModelDocument` encodes the freshly-built AST snapshot, whose version
546
- // is the `LangiumDocument`'s own `textDocument.version`. That lags the
547
- // multi-client synced version whenever the open seeded the synced document
548
- // with a caller-supplied version id — and the synced version is what
549
- // `ModelService.update`'s optimistic-concurrency gate compares
550
- // `baseVersion` against, so reporting the snapshot's would make the
551
- // caller's first tagged write self-conflict. A genuine concurrent edit
552
- // still trips the gate and is reconciled by the caller's replay rather
553
- // than predicted here.
554
- return { ...document, version: this.services.workspace.TextDocuments.version(args.uri) };
555
620
  }
556
621
 
557
- async closeModelDocument(args: CloseModelArgs): Promise<void> {
558
- // Closing a session also releases its watch for (uri, clientId) — a
559
- // forgotten unwatch would otherwise leak phase-event dispatch until the
560
- // connection closes. Idempotent: a close without a prior watch is a no-op.
561
- await this.unwatchModelDocument({ uri: args.uri, clientId: args.clientId });
562
- this.forgetOpenDocument(args.uri, args.clientId);
563
- await this.modelService.close(args);
622
+ /**
623
+ * End a session this connection registered. The ended handle stays in
624
+ * {@link clientSessions}, as it does after {@link dispose}, so a request for
625
+ * the id still arriving fails with the ended session's own error.
626
+ */
627
+ async closeSession(args: CloseSessionArgs): Promise<void> {
628
+ const session = this.clientSessions.get(args.clientId);
629
+ if (session) {
630
+ this.endSession(args.clientId, session);
631
+ }
632
+ }
633
+
634
+ /** End `session`, registered here under `clientId`, with `cause`, and drop its watches on this connection. */
635
+ protected endSession(
636
+ clientId: string,
637
+ session: ClientSession<AstNode, AstDiagnostic, TTransfer>,
638
+ cause: SessionEndCause = 'closed'
639
+ ): void {
640
+ for (const [uri, record] of this.uriWatchRecords) {
641
+ if (record.watchers.delete(clientId)) {
642
+ this.pruneUriWatchRecord(uri);
643
+ }
644
+ }
645
+ session.dispose(cause);
564
646
  }
565
647
 
566
648
  /**
567
- * Drop the recorded hold for `(uri, clientId)` so {@link dispose} does not
568
- * close it a second time. Idempotent.
649
+ * The resumable sessions of this services tree, by client id, across all of
650
+ * its data connections: a client resumes on another connection than the one
651
+ * that registered it. An entry leaves when its session ends, by any path, so
652
+ * it keeps no ended connection alive.
653
+ *
654
+ * A takeover by resume token ends the old session even when its connection
655
+ * is still alive, so two clients that shared an id and its token would end
656
+ * each other's sessions. And the token is a guard against colliding with a
657
+ * session the server has not yet seen end, not a secret: the wire carries no
658
+ * authentication, and a peer that learns the token can end the session.
569
659
  */
570
- protected forgetOpenDocument(uri: string, clientId: string): void {
571
- const holders = this.openedDocuments.get(uri);
572
- if (!holders) {
573
- return;
660
+ protected resumableSessions(): Map<string, ResumableSession> {
661
+ let sessions = resumableByModelService.get(this.modelService);
662
+ if (!sessions) {
663
+ const created = new Map<string, ResumableSession>();
664
+ // Subscribed once per services tree, and never disposed: it lives as
665
+ // long as the text store it listens to.
666
+ this.services.workspace.TextDocuments.onDidCloseSession(event => created.delete(event.clientId));
667
+ resumableByModelService.set(this.modelService, created);
668
+ sessions = created;
574
669
  }
575
- holders.delete(clientId);
576
- if (holders.size === 0) {
577
- this.openedDocuments.delete(uri);
670
+ return sessions;
671
+ }
672
+
673
+ async createModelDocument(args: CreateModelDocumentArgs): Promise<TransferDocument<TTransfer, TDiagnostic>> {
674
+ const session = this.requireSession(args.clientId);
675
+ await session.create(args.uri, args.text);
676
+ return this.openedSnapshot(args.uri, () => session.close(args.uri));
677
+ }
678
+
679
+ async updateModelDocuments(args: TransferUpdateDocumentsArgs<TTransfer>): Promise<TransferDocument<TTransfer, TDiagnostic>[]> {
680
+ const astDocuments = await this.requireSession(args.clientId).updateAll({
681
+ updates: args.updates.map(update => this.toSessionWrite(update))
682
+ });
683
+ return astDocuments.map(astDocument => this.encodeDocument(astDocument));
684
+ }
685
+
686
+ /**
687
+ * The session write a wire write request carries. Only the fields a session
688
+ * takes: a field an adopter adds to a request reaches the session only
689
+ * through an override of this.
690
+ */
691
+ protected toSessionWrite(request: Omit<TransferUpdateDocumentArgs<TTransfer>, 'clientId'>): ClientSessionWriteArgs<TTransfer> {
692
+ return { uri: request.uri, model: request.model, basedOn: request.basedOn };
693
+ }
694
+
695
+ /**
696
+ * The session this connection registered under `clientId`, which every
697
+ * document request acts as. An id that is not one fails with the
698
+ * closed-session code: opening or writing under it would leave an open that
699
+ * no session end ever closes.
700
+ */
701
+ protected requireSession(clientId: string): ClientSession<AstNode, AstDiagnostic, TTransfer> {
702
+ const session = this.clientSessions.get(clientId);
703
+ if (!session) {
704
+ throw new SessionClosedError(clientId, 'The client session was never registered on this connection.');
578
705
  }
706
+ return session;
707
+ }
708
+
709
+ async openModelDocument(args: Pick<OpenModelArgs, 'uri' | 'clientId' | 'options'>): Promise<TransferDocument<TTransfer, TDiagnostic>> {
710
+ const session = this.requireSession(args.clientId);
711
+ const wasOpen = this.services.workspace.TextDocuments.isOpenInClient(args.uri, args.clientId);
712
+ await session.open(args.uri, args.options);
713
+ // A repeat open keeps the earlier one, which is still in use.
714
+ return this.openedSnapshot(args.uri, wasOpen ? undefined : () => session.close(args.uri));
579
715
  }
580
716
 
581
717
  /**
582
- * Close every document still open over this connection, for the clients that
583
- * opened it here.
718
+ * The snapshot a session's open or create answers with. When the read
719
+ * fails, `rollback` undoes the open this call made before the failure is
720
+ * rethrown: the caller sees no open, so nothing on its side would ever close
721
+ * it.
584
722
  *
585
- * The document store releases a per-URI hold only from an explicit close, so
586
- * without this a client that dies mid-session keeps its documents open for the
587
- * lifetime of the process: `isOpenInAnyClient` stays true, the document stays
588
- * resident, and the last-close revert never runs. A long-lived multi-client
589
- * head is the configuration where a dead client is normal rather than
590
- * exceptional, so the leak accumulates there.
591
- *
592
- * Runs from {@link dispose}, which is synchronous, so each close is fired and
593
- * its failure swallowed — a teardown must not reject, and a URI whose close
594
- * fails is no worse off than it was before this drain existed.
723
+ * Versioned with the store's shared version rather than the snapshot's own:
724
+ * the built document's `textDocument.version` lags the store's whenever the
725
+ * store assigned the version, and the store's is what a write's `basedOn` is
726
+ * compared against, so reporting the snapshot's would make the caller's
727
+ * first based-on write conflict with itself.
595
728
  */
596
- protected closeOpenDocuments(): void {
597
- const held = [...this.openedDocuments];
598
- this.openedDocuments.clear();
599
- for (const [uri, clientIds] of held) {
600
- for (const clientId of clientIds) {
601
- void Promise.resolve(this.modelService.close({ uri, clientId })).catch(() => undefined);
602
- }
729
+ protected async openedSnapshot(uri: string, rollback?: () => Promise<void>): Promise<TransferDocument<TTransfer, TDiagnostic>> {
730
+ let document: TransferDocument<TTransfer, TDiagnostic>;
731
+ try {
732
+ document = await this.getModelDocument({ uri });
733
+ } catch (error: unknown) {
734
+ // The open's failure is the one the caller needs, not the cleanup's.
735
+ await rollback?.().catch(() => undefined);
736
+ throw error;
603
737
  }
738
+ return { ...document, version: asSnapshotVersion(this.services.workspace.TextDocuments.version(uri)) };
739
+ }
740
+
741
+ async closeModelDocument(args: CloseModelArgs): Promise<void> {
742
+ // Through the handle, so a close under an ended session fails as that
743
+ // session's calls do, and a session class's own close is honoured.
744
+ const session = this.requireSession(args.clientId);
745
+ // Closing also releases the watch for (uri, clientId) — a forgotten
746
+ // unwatch would otherwise leak phase-event dispatch until the connection
747
+ // closes. Idempotent: a close without a prior watch is a no-op.
748
+ await this.unwatchModelDocument({ uri: args.uri, clientId: args.clientId });
749
+ await session.close(args.uri);
604
750
  }
605
751
 
606
752
  async getModelDocument(args: GetModelDocumentArgs): Promise<TransferDocument<TTransfer, TDiagnostic>> {
@@ -616,17 +762,17 @@ export class DataServer<
616
762
  // `includeDiagnostics: true` to settle at `Validated` instead.
617
763
  const state = args.includeDiagnostics ? DocumentState.Validated : undefined;
618
764
  const astDocument = await this.modelService.ensureDocumentState(args.uri, state);
619
- return this.encoder.astDocumentToTransferDocument(astDocument as never) as unknown as TransferDocument<TTransfer, TDiagnostic>;
765
+ return this.encodeDocument(astDocument);
620
766
  }
621
767
 
622
768
  async updateModelDocument(args: TransferUpdateDocumentArgs<TTransfer>): Promise<TransferDocument<TTransfer, TDiagnostic>> {
623
- const astDocument = await this.modelService.update(args);
624
- return this.encoder.astDocumentToTransferDocument(astDocument as never) as unknown as TransferDocument<TTransfer, TDiagnostic>;
769
+ const astDocument = await this.requireSession(args.clientId).update(this.toSessionWrite(args));
770
+ return this.encodeDocument(astDocument);
625
771
  }
626
772
 
627
773
  async saveModelDocument(args: TransferSaveDocumentArgs<TTransfer>): Promise<TransferDocument<TTransfer, TDiagnostic>> {
628
- const astDocument = await this.modelService.save(args);
629
- return this.encoder.astDocumentToTransferDocument(astDocument as never) as unknown as TransferDocument<TTransfer, TDiagnostic>;
774
+ const astDocument = await this.requireSession(args.clientId).save(this.toSessionWrite(args));
775
+ return this.encodeDocument(astDocument);
630
776
  }
631
777
 
632
778
  /**
@@ -634,28 +780,24 @@ export class DataServer<
634
780
  * fan out to the wired `clientProxy.onDocumentUpdated`. The
635
781
  * bidirectional pattern means the event channel is the client
636
782
  * notification surface, not a returned handle — this method only
637
- * registers the URI in the dispatch table.
783
+ * registers the watcher in {@link uriWatchRecords}.
638
784
  *
639
- * Also baselines the per-URI emission fingerprint (see
640
- * {@link lastEmittedFingerprint}) to the document's current state when
641
- * the first watcher for the URI registers. This guarantees that any
642
- * phase event firing immediately after the watch with no observable
643
- * change is suppressed — watchers obtain initial state via
644
- * `getModelDocument` (or {@link openModelDocument}) and do not need a
645
- * redundant phase notification for that same state.
785
+ * Also baselines the URI's emission fingerprint (see
786
+ * {@link dispatchPhaseEvent}) to the document's current state when the
787
+ * first watcher for the URI registers. This guarantees that any phase event firing immediately after
788
+ * the watch with no observable change is suppressed — watchers obtain
789
+ * initial state via `getModelDocument` (or {@link openModelDocument}) and
790
+ * do not need a redundant phase notification for that same state.
646
791
  */
647
792
  async watchModelDocument(args: WatchModelDocumentArgs): Promise<void> {
648
793
  const uri = this.canonicalKey(args.uri);
649
- let subscribers = this.subscriptions.get(uri);
650
- if (!subscribers) {
651
- subscribers = new Set();
652
- this.subscriptions.set(uri, subscribers);
653
- }
654
- subscribers.add(args.clientId);
655
- if (!this.lastEmittedFingerprint.has(uri)) {
794
+ const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set<string>() };
795
+ this.uriWatchRecords.set(uri, record);
796
+ record.watchers.add(args.clientId);
797
+ if (record.fingerprint === undefined) {
656
798
  const document = this.services.workspace.LangiumDocuments.getDocument(UriUtils.toUri(uri));
657
799
  if (document) {
658
- this.lastEmittedFingerprint.set(uri, this.computeDocumentFingerprint(document));
800
+ record.fingerprint = this.computeDocumentFingerprint(document);
659
801
  }
660
802
  }
661
803
  }
@@ -663,29 +805,40 @@ export class DataServer<
663
805
  /**
664
806
  * Remove a watch for `(uri, clientId)` previously created by
665
807
  * {@link watchModelDocument}. Idempotent — unwatching twice is a no-op.
666
- * Dispatch for `uri` stops once no watchers remain, at which point the
667
- * per-URI emission fingerprint is also cleared so the next first-watch
668
- * re-baselines against the then-current document state rather than a
669
- * stale snapshot from the previous watch.
808
+ * Dispatch for `uri` stops once no watchers remain, and the emission
809
+ * fingerprint goes with the last watcher (see {@link pruneUriWatchRecord}).
670
810
  */
671
811
  async unwatchModelDocument(args: WatchModelDocumentArgs): Promise<void> {
672
812
  const uri = this.canonicalKey(args.uri);
673
- const subscribers = this.subscriptions.get(uri);
674
- if (!subscribers) {
813
+ if (this.uriWatchRecords.get(uri)?.watchers.delete(args.clientId)) {
814
+ this.pruneUriWatchRecord(uri);
815
+ }
816
+ }
817
+
818
+ /**
819
+ * Drop what `uri` no longer needs: the
820
+ * {@link DataServerUriWatchRecord.fingerprint} once no client watches it,
821
+ * and the whole record once it holds no
822
+ * {@link DataServerUriWatchRecord.revertPending} mark either. Every path
823
+ * that removes a watcher or consumes a mark ends here.
824
+ */
825
+ protected pruneUriWatchRecord(uri: string): void {
826
+ const record = this.uriWatchRecords.get(uri);
827
+ if (!record || record.watchers.size > 0) {
675
828
  return;
676
829
  }
677
- subscribers.delete(args.clientId);
678
- if (subscribers.size === 0) {
679
- this.subscriptions.delete(uri);
680
- this.lastEmittedFingerprint.delete(uri);
830
+ if (record.revertPending) {
831
+ record.fingerprint = undefined;
832
+ } else {
833
+ this.uriWatchRecords.delete(uri);
681
834
  }
682
835
  }
683
836
 
684
837
  /**
685
- * Canonicalise a URI string for use as a subscription / fingerprint
686
- * map key, via the shared `DocumentUriPolicy`. Callers may send
687
- * non-canonical URIs (drive-letter casing, percent-encoding differences,
688
- * or a symlink path) over the wire; the dispatch side keys by
838
+ * Canonicalise a URI string for use as a {@link uriWatchRecords} key, via the
839
+ * shared `DocumentUriPolicy`. Callers may send non-canonical URIs
840
+ * (drive-letter casing, percent-encoding differences, or a symlink path)
841
+ * over the wire; the dispatch side keys by
689
842
  * `document.uri.toString()` from `LangiumDocuments`, so writer keys must
690
843
  * canonicalise to the same form or events silently fail to deliver.
691
844
  * Routing through the seam (rather than a bare `UriUtils.normalize`)
@@ -734,26 +887,57 @@ export class DataServer<
734
887
  // (see resolveReferenceServices) and delegate.
735
888
  // ============================================================
736
889
 
737
- async findReferenceCandidates(ctx: ReferenceContext): Promise<ReferenceCandidate[]> {
738
- // Candidates are derived from resolved cross-references, so the relevant document(s) must
739
- // have finished the Linked phase — otherwise a query issued right after a model update races
740
- // the asynchronous rebuild and returns stale candidates. Wait the source document
741
- // specifically, but ONLY when a document is actually loaded at that URI: a synthetic source
742
- // can address a URI with no document (a directory URI, typically), and a per-URI `waitUntil`
743
- // there throws "No document found". Fall back to a global Linked settle, matching the
744
- // id-based ElementSource (no URI) path.
745
- const uri = isDocumentSource(ctx.source) || isSyntheticSource(ctx.source) ? UriUtils.toUri(ctx.source.uri) : undefined;
890
+ /**
891
+ * Settle the build before a reference question is answered from the index.
892
+ *
893
+ * A query issued right after a model update otherwise races the rebuild and
894
+ * reads an index missing the symbols it asks about. The cost is not confined
895
+ * to this call: a scope built inside that window is cached, and the build's
896
+ * remaining documents link against it.
897
+ *
898
+ * Waits the source document specifically, but ONLY when one is loaded at
899
+ * that URI: a synthetic source can address a URI with no document (a
900
+ * directory URI, typically), where a per-URI `waitUntil` throws "No document
901
+ * found". Falls back to a global settle, matching the id-based
902
+ * `ElementSource` path.
903
+ *
904
+ * Bounded by {@link DataServerOptions.referenceSettleTimeoutMs}.
905
+ */
906
+ protected async awaitReferencesLinked(source: ReferenceSource): Promise<void> {
907
+ const uri = isDocumentSource(source) || isSyntheticSource(source) ? UriUtils.toUri(source.uri) : undefined;
746
908
  const waitUri = uri && this.services.workspace.LangiumDocuments.hasDocument(uri) ? uri : undefined;
747
- await this.services.workspace.DocumentBuilder.waitUntil(DocumentState.Linked, waitUri);
909
+ const stopwatch = this.services.Clock.stopwatch();
910
+ const linked = this.services.workspace.DocumentBuilder.waitUntil(DocumentState.Linked, waitUri);
911
+ if ((await this.services.Clock.raceTimer(linked, this.options.referenceSettleTimeoutMs)) !== TIMED_OUT) {
912
+ return;
913
+ }
914
+ const elapsedMs = Math.round(stopwatch.elapsedMs);
915
+ // A per-URI wait resolves off a document-phase notification, so a
916
+ // missed one strands a wait on a document that HAS reached the
917
+ // phase. Re-read before failing; the workspace-wide wait has no
918
+ // equivalent reading and can only reject.
919
+ const document = waitUri ? this.services.workspace.LangiumDocuments.getDocument(waitUri) : undefined;
920
+ if (waitUri && document && document.state >= DocumentState.Linked) {
921
+ this.tracer
922
+ .withUri(waitUri.toString())
923
+ .warn(`Missed the 'Linked' notification after ${elapsedMs}ms; the document already reached it`);
924
+ return;
925
+ }
926
+ throw referenceSettleTimeoutError(elapsedMs);
927
+ }
928
+
929
+ async findReferenceCandidates(ctx: ReferenceContext): Promise<ReferenceCandidate[]> {
930
+ await this.awaitReferencesLinked(ctx.source);
748
931
  return this.resolveReferenceServices(ctx.source).CandidateProvider.find(ctx);
749
932
  }
750
933
 
751
934
  async resolveReference(ref: ReferenceRequest): Promise<ReferenceTarget<TTransfer> | undefined> {
935
+ await this.awaitReferencesLinked(ref.source);
752
936
  const resolved = this.resolveReferenceServices(ref.source).CandidateProvider.resolveCandidate(ref);
753
937
  if (!resolved) {
754
938
  return undefined;
755
939
  }
756
- const element = this.encoder.toTransfer(resolved.node) as unknown as TTransfer;
940
+ const element = this.encoder.toTransfer(resolved.node) as TTransfer;
757
941
  return { ...resolved.candidate, element };
758
942
  }
759
943
 
@@ -764,7 +948,14 @@ export class DataServer<
764
948
  // synthetic source — and the create-element flow driving this method is
765
949
  // the one that produces directory URIs, on which a bare
766
950
  // `getServices(uri)` throws while `findReferenceCandidates` succeeds.
767
- const nameProvider = this.resolveReferenceServices(ReferenceSource.synthetic(args.uri, args.type)).NameProvider;
951
+ const source = ReferenceSource.synthetic(args.uri, args.type, args.language);
952
+ // Mid-rebuild the names of documents not yet re-indexed are absent from
953
+ // the taken set, and the caller PERSISTS what it is handed. Nothing
954
+ // reserves the answer either, so a name is free of the collisions the
955
+ // index knows about and of nothing else — two callers racing get the same
956
+ // proposal, which only uniqueness at the write can catch.
957
+ await this.awaitReferencesLinked(source);
958
+ const nameProvider = this.resolveReferenceServices(source).NameProvider;
768
959
  const tier = args.tier ?? 'project';
769
960
  if (tier === 'public') {
770
961
  return nameProvider.findNextProjectQualifiedName(args.type, args.proposal);
@@ -772,7 +963,7 @@ export class DataServer<
772
963
  if (tier === 'local') {
773
964
  // Document-scoped uniqueness: the document root is the container.
774
965
  const document = await this.modelService.ensureDocumentState(args.uri);
775
- return document.root ? nameProvider.findNextName(args.type, args.proposal, document.root as AstNode) : args.proposal;
966
+ return document.root ? nameProvider.findNextName(args.type, args.proposal, document.root) : args.proposal;
776
967
  }
777
968
  const project = this.services.workspace.ProjectManager.getProject(uri);
778
969
  if (!project) {
@@ -811,6 +1002,9 @@ export class DataServer<
811
1002
  /**
812
1003
  * Pick the language that owns a reference source, in order:
813
1004
  *
1005
+ * 0. A {@link isSyntheticSource} naming its own `language` routes there.
1006
+ * First because every step below infers, and an inference must not
1007
+ * override a caller that has said which grammar it means.
814
1008
  * 1. A URI-bearing source ({@link isDocumentSource}/{@link isSyntheticSource})
815
1009
  * whose URI resolves to a registered language routes by URI.
816
1010
  * 2. A single-language workspace always routes to that one language — so
@@ -829,6 +1023,15 @@ export class DataServer<
829
1023
  */
830
1024
  protected resolveReferenceLanguage(source: ReferenceSource): HydraniumLanguageServices | undefined {
831
1025
  const registry = this.services.ServiceRegistry;
1026
+ if (isSyntheticSource(source) && source.language !== undefined) {
1027
+ const declared = registry.getServicesById(source.language);
1028
+ if (declared) {
1029
+ return declared;
1030
+ }
1031
+ // Falling through on an UNREGISTERED id rather than failing: the id
1032
+ // crosses the wire, so a client built against a head with one more
1033
+ // grammar would otherwise lose queries the steps below can answer.
1034
+ }
832
1035
  // `getServicesFor` (non-throwing, one ladder walk) gates the URI lookup:
833
1036
  // an extensionless / unregistered URI falls through to the steps below
834
1037
  // rather than throwing "no services for the extension ''".
@@ -839,7 +1042,7 @@ export class DataServer<
839
1042
  }
840
1043
  const all = registry.all;
841
1044
  if (all.length === 1) {
842
- return all[0] as HydraniumLanguageServices;
1045
+ return all[0];
843
1046
  }
844
1047
  if (isElementSource(source)) {
845
1048
  const documentUri = this.findElementDocumentUri(source);
@@ -945,14 +1148,28 @@ export class DataServer<
945
1148
  // decides policy at its own layer; `root` is optional on the envelope
946
1149
  // so the compiler forces that decision. Adopters preferring to throw
947
1150
  // override `envelope`.
948
- return {
949
- uri: uri.toString(),
950
- version: 0,
951
- root: undefined,
952
- diagnostics: [] as TDiagnostic[]
953
- };
1151
+ return TransferDocument.absent<TTransfer, TDiagnostic>(uri.toString());
954
1152
  }
955
- return this.encoder.toTransferDocument<AstNode>(document) as unknown as TransferDocument<TTransfer, TDiagnostic>;
1153
+ return this.withDirtyState(this.encoder.toTransferDocument(document) as TransferDocument<TTransfer, TDiagnostic>);
1154
+ }
1155
+
1156
+ /**
1157
+ * The transfer document a request answers with for `astDocument`, the
1158
+ * store's current `dirty` stamped on it by {@link withDirtyState}. Every
1159
+ * document a request answers with goes through here, so none goes out
1160
+ * without the stamp.
1161
+ */
1162
+ protected encodeDocument(astDocument: AstDocument<AstNode, AstDiagnostic>): TransferDocument<TTransfer, TDiagnostic> {
1163
+ return this.withDirtyState(this.encoder.astDocumentToTransferDocument(astDocument) as TransferDocument<TTransfer, TDiagnostic>);
1164
+ }
1165
+
1166
+ /**
1167
+ * `document` with the store's current {@link TransferDocument.dirty}. Read
1168
+ * when the document is sent rather than kept with the build: a save changes
1169
+ * the answer without a rebuild.
1170
+ */
1171
+ protected withDirtyState(document: TransferDocument<TTransfer, TDiagnostic>): TransferDocument<TTransfer, TDiagnostic> {
1172
+ return { ...document, dirty: this.services.workspace.TextDocuments.isDirty(document.uri) };
956
1173
  }
957
1174
 
958
1175
  /**
@@ -967,6 +1184,59 @@ export class DataServer<
967
1184
  this.dispatchPhaseEvent(document, cancelToken)
968
1185
  )
969
1186
  );
1187
+ // The BUILD-phase hook, not the per-document one: this notification is one
1188
+ // message per build rather than one per document, and Langium hands the
1189
+ // whole batch over here. It also does not fire for a cancelled build,
1190
+ // which is what the per-document dispatch has to check by hand.
1191
+ this.disposables.push(
1192
+ this.services.workspace.DocumentBuilder.onBuildPhase(this.options.subscriptionPhase, built => this.dispatchBuiltEvent(built))
1193
+ );
1194
+ }
1195
+
1196
+ /**
1197
+ * Report the documents that reached {@link DataServerOptions.subscriptionPhase}
1198
+ * and that NOBODY on this
1199
+ * connection is watching — the ones a client was not told about through
1200
+ * {@link dispatchPhaseEvent}, which is gated per URI.
1201
+ *
1202
+ * **The gap this closes is the one no other source can observe.** A document
1203
+ * the client watches, it hears about already. A file changed on disk, the
1204
+ * host's own filesystem watcher reports — and on a browser host, where the
1205
+ * workspace lives behind this head, an external change cannot happen at all.
1206
+ * What is left, and what nothing outside the server can see, is a document
1207
+ * rebuilt because something it DEPENDS ON changed: its file never changed, so
1208
+ * a filesystem watcher is silent by construction, and it has no subscriber, so
1209
+ * the update channel is silent by design. A consumer displaying data derived
1210
+ * from that document — a tree label, a decorator — otherwise goes stale with
1211
+ * no signal from any source, and repairs itself the moment someone opens the
1212
+ * file to investigate, which is what makes it expensive to diagnose later.
1213
+ *
1214
+ * Payload-free on purpose: URIs only, so a client re-reads what it displays
1215
+ * rather than being handed transfer documents it did not ask for. That is the
1216
+ * property the watcher gate protects, and it is preserved here by
1217
+ * carrying no document rather than by gating the message.
1218
+ *
1219
+ * Quiet in the common case. Editing a document that an editor has open leaves
1220
+ * that URI watched and therefore out of this set, so a build with no
1221
+ * dependents produces nothing at all, and workspace initialisation produces
1222
+ * nothing because it does not build to this phase. The ceiling is a
1223
+ * whole-workspace rebuild at the subscription phase: one message, URIs only.
1224
+ *
1225
+ * The URI is canonicalised for the same reason {@link uriWatchRecords} is keyed
1226
+ * that way, and is untested for the same reason as its twin in
1227
+ * {@link dispatchDeleteEvents}: the builder reports URIs out of its own
1228
+ * store, so a non-canonical one cannot be produced without a fixture
1229
+ * asserting a shape the real system never emits.
1230
+ */
1231
+ protected dispatchBuiltEvent(built: readonly LangiumDocument[]): void {
1232
+ const uris = built
1233
+ .map(document => this.canonicalKey(document.uri.toString()))
1234
+ .filter(uri => !this.uriWatchRecords.get(uri)?.watchers.size);
1235
+ if (uris.length === 0) {
1236
+ return;
1237
+ }
1238
+ this.tracer.debug(`Emit onDocumentsBuilt: ${uris.length} unwatched document(s)`);
1239
+ this.clientProxy.onDocumentsBuilt({ uris });
970
1240
  }
971
1241
 
972
1242
  /**
@@ -987,32 +1257,113 @@ export class DataServer<
987
1257
  this.disposables.push(this.services.workspace.TextDocuments.onDidSave(event => this.dispatchSaveEvent(event)));
988
1258
  }
989
1259
 
1260
+ /** Relay each change of a document's dirty state; see {@link dispatchDirtyEvent}. */
1261
+ protected subscribeToDirtyChanges(): void {
1262
+ this.disposables.push(this.services.workspace.TextDocuments.onDidChangeDirty(event => this.dispatchDirtyEvent(event)));
1263
+ }
1264
+
1265
+ /**
1266
+ * Send a dirty flip to the connection, gated on the URI's watchers as
1267
+ * {@link dispatchSaveEvent} is: the answer at any one moment travels on
1268
+ * every document sent, so a client that watches nothing reads it there.
1269
+ */
1270
+ protected dispatchDirtyEvent(event: DocumentDirtyChangedEvent): void {
1271
+ const uri = this.canonicalKey(event.uri);
1272
+ if (this.uriWatchRecords.get(uri)?.watchers.size) {
1273
+ this.clientProxy.onDocumentDirtyChanged({ uri, dirty: event.dirty });
1274
+ }
1275
+ }
1276
+
990
1277
  /**
991
- * Mark the last-close transition per URI (see
992
- * {@link pendingRevertBroadcasts}). The listener consults
993
- * `isOpenInAnyClient` AFTER the store decremented the closing client's
994
- * hold, so a `false` answer means this close was the last one.
1278
+ * Mark each document the store releases after its last close, so
1279
+ * {@link dispatchPhaseEvent} broadcasts the following rebuild even without
1280
+ * a watcher. The store rebuilds such a document from its disk content,
1281
+ * discarding unsaved in-session edits, and the last close typically also
1282
+ * removed the last watcher: without the broadcast, a consumer that only
1283
+ * ever fetches via `getModelDocument` keeps showing the discarded state.
1284
+ * The broadcast is de-duplicated against the fingerprint while a watcher
1285
+ * holds one, so a close whose disk state equals the last emitted state
1286
+ * stays silent; with no watcher there is no fingerprint, and every revert
1287
+ * is sent.
1288
+ *
1289
+ * A release, not the close itself: a document whose last client lost its
1290
+ * connection is released only once the revert grace runs out, or when
1291
+ * another client opens it meanwhile, and not at all when a client lost
1292
+ * from it opens it again within its own grace.
995
1293
  */
996
1294
  protected subscribeToTextDocumentCloses(): void {
997
- const textDocuments = this.services.workspace.TextDocuments;
998
1295
  this.disposables.push(
999
- textDocuments.onDidClose(event => {
1000
- if (!textDocuments.isOpenInAnyClient(event.document.uri)) {
1001
- this.pendingRevertBroadcasts.add(this.canonicalKey(event.document.uri));
1002
- }
1296
+ this.services.workspace.TextDocuments.onDidCloseLastOpen(event => {
1297
+ const uri = this.canonicalKey(event.uri);
1298
+ const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set<string>() };
1299
+ record.revertPending = true;
1300
+ this.uriWatchRecords.set(uri, record);
1003
1301
  })
1004
1302
  );
1005
1303
  }
1006
1304
 
1007
- /** Fan out a save event for the document's URI, gated by the subscription map. */
1305
+ /**
1306
+ * Fan out a deletion for each removed URI, to EVERY client on the connection
1307
+ * rather than only to the ones watching that URI.
1308
+ *
1309
+ * **Deliberately ungated, where {@link dispatchPhaseEvent} and
1310
+ * {@link dispatchSaveEvent} are gated.** Those two carry a built document and
1311
+ * fire on every build, so the watcher gate is what keeps bandwidth
1312
+ * proportional to what a client asked for. A deletion is neither: it is one
1313
+ * URI, it is rare, and it reports the workspace's STRUCTURE rather than a
1314
+ * document's content. Gating it forces any consumer that displays the
1315
+ * workspace — a model tree, a file decorator — to learn about disappearances
1316
+ * from a filesystem watcher instead, which a client hosted in a browser has
1317
+ * no way to run: its workspace lives behind the head. A client that does not
1318
+ * care filters on the URI, which costs it a comparison.
1319
+ *
1320
+ * The precedent is the last-close revert broadcast (see
1321
+ * {@link subscribeToTextDocumentCloses}), where the same judgement was already made
1322
+ * in the other direction: a transition that matters enough is delivered
1323
+ * without a subscription.
1324
+ *
1325
+ * Runs from the `DocumentBuilder.onUpdate` listener rather than from a phase
1326
+ * listener, which is the only place a deletion is observable: `update`
1327
+ * removes the document before deriving the rebuild set, so it is never built.
1328
+ * That ordering also puts this notification ahead of the `'rebuilt'` events
1329
+ * for the dependents whose references the deletion just broke.
1330
+ *
1331
+ * The `deleted` list arrives already expanded to concrete document URIs —
1332
+ * `deleteDocuments` resolves a directory URI to the documents beneath it — so
1333
+ * no caller has to handle a directory here.
1334
+ *
1335
+ * The URI's fingerprint and revert mark are dropped: they describe a
1336
+ * document that no longer exists. A kept fingerprint is adopted as the
1337
+ * baseline and suppresses the first emit after the file returns with its
1338
+ * previous content.
1339
+ *
1340
+ * The watchers SURVIVE: a recreated file resumes delivering to them with no
1341
+ * re-subscription, and a client that answers the deletion by closing
1342
+ * releases the watch through `closeModelDocument` anyway.
1343
+ */
1344
+ protected dispatchDeleteEvents(deleted: readonly URI[]): void {
1345
+ for (const removed of deleted) {
1346
+ const uri = this.canonicalKey(removed.toString());
1347
+ const record = this.uriWatchRecords.get(uri);
1348
+ if (record) {
1349
+ record.fingerprint = undefined;
1350
+ record.revertPending = undefined;
1351
+ record.sentVersion = undefined;
1352
+ this.pruneUriWatchRecord(uri);
1353
+ }
1354
+ this.clientProxy.onDocumentDeleted({ uri });
1355
+ }
1356
+ }
1357
+
1358
+ /** Fan out a save event for the document's URI, gated on the URI's watchers. */
1008
1359
  protected dispatchSaveEvent(event: ClientTextDocumentChangeEvent<TextDocument>): void {
1009
1360
  // The save event arrives under the CLIENT URI the text store keys by (e.g. a
1010
- // symlink path S); the subscription map and `dispatchPhaseEvent` key by the
1361
+ // symlink path S); `uriWatchRecords` and `dispatchPhaseEvent` key by the
1011
1362
  // CANONICAL identity R. Canonicalize before both the gate and the envelope so
1012
1363
  // a save of a symlinked file isn't silently dropped (and the envelope resolves
1013
1364
  // the R-keyed document rather than missing into an empty one).
1014
1365
  const uri = this.canonicalKey(event.document.uri);
1015
- if (!this.subscriptions.has(uri)) {
1366
+ if (!this.uriWatchRecords.get(uri)?.watchers.size) {
1016
1367
  return;
1017
1368
  }
1018
1369
  const response = this.envelope(UriUtils.toUri(uri));
@@ -1032,13 +1383,25 @@ export class DataServer<
1032
1383
  * out to multiple local subscribers with an `Emitter<T>` — the
1033
1384
  * framework deliberately does NOT promise multi-listener semantics.
1034
1385
  *
1035
- * The dispatch is guarded by two filters:
1036
- * 1. **Subscription map**: events for URIs no subscriber registered for
1037
- * are NOT sent over the wire (bandwidth scales with subscribed URIs,
1038
- * not phase events).
1039
- * 2. **Emission fingerprint**: events for rebuilds that produce no
1040
- * observable change since the last emit are suppressed. See
1041
- * {@link lastEmittedFingerprint} for the rationale.
1386
+ * An event for a URI no client watches is NOT sent over the wire, so
1387
+ * bandwidth scales with watched URIs rather than with phase events; a
1388
+ * pending revert mark is the exception (see
1389
+ * {@link subscribeToTextDocumentCloses}).
1390
+ *
1391
+ * An event for a rebuild with no observable change since the last emit is
1392
+ * suppressed against the URI's fingerprint. Such rebuilds are routine: a
1393
+ * second client attaching to an open document makes
1394
+ * `HydraniumTextDocuments.refreshContent` fire `onDidChangeContent` purely
1395
+ * to re-trigger the build, and Langium rebuilds a document when a
1396
+ * dependency changes even if its diagnostics come out the same. Sent at a
1397
+ * version this head has not sent, they reach watchers as `'changed'`, and a
1398
+ * watcher that reads `'changed'` as another client's write and resets its
1399
+ * root to the server view loses the user's edits. The first {@link watchModelDocument} baselines the
1400
+ * fingerprint, so the first event after a watch is de-duplicated against
1401
+ * the state the watcher just fetched; it goes with the last watcher, so the
1402
+ * next first watch re-baselines rather than adopting a stale digest. A
1403
+ * cyrb53 digest keeps its memory constant in document size; see
1404
+ * {@link computeDocumentFingerprint} for the inputs.
1042
1405
  */
1043
1406
  protected dispatchPhaseEvent(document: LangiumDocument, cancelToken: CancellationToken): void {
1044
1407
  if (cancelToken.isCancellationRequested) {
@@ -1050,16 +1413,23 @@ export class DataServer<
1050
1413
  return;
1051
1414
  }
1052
1415
  const uri = document.uri.toString();
1053
- // Consume the last-close mark even when subscriptions exist — the
1054
- // regular dispatch below serves those watchers, and the mark's author
1055
- // attribution is more precise than the post-close `UNKNOWN_CLIENT_ID`
1056
- // the author lookup would yield.
1057
- const revertedOnClose = this.pendingRevertBroadcasts.delete(uri);
1058
- if (!this.subscriptions.has(uri) && !revertedOnClose) {
1416
+ const record = this.uriWatchRecords.get(uri);
1417
+ const revertedOnClose = record?.revertPending === true;
1418
+ if (!record || (record.watchers.size === 0 && !revertedOnClose)) {
1059
1419
  return;
1060
1420
  }
1421
+ if (revertedOnClose) {
1422
+ // Consumed even when watchers exist — the regular dispatch below
1423
+ // serves them, and the mark's attribution is more precise than the
1424
+ // post-close unknown client the manager's attribution would yield.
1425
+ // With no watcher the record goes now, so the fingerprint written
1426
+ // below lands on a detached record and the next first watch
1427
+ // re-baselines instead of adopting it.
1428
+ record.revertPending = undefined;
1429
+ this.pruneUriWatchRecord(uri);
1430
+ }
1061
1431
  const fingerprint = this.computeDocumentFingerprint(document);
1062
- if (this.lastEmittedFingerprint.get(uri) === fingerprint) {
1432
+ if (record.fingerprint === fingerprint) {
1063
1433
  // A rebuild that produced no observable change since the last emit —
1064
1434
  // suppressed so RPC subscribers don't see a no-op broadcast. Logged at
1065
1435
  // debug so a *needed* re-broadcast wrongly suppressed by this dedup
@@ -1067,11 +1437,20 @@ export class DataServer<
1067
1437
  this.tracer.withUri(uri).debug(`Suppress onDocumentUpdated v${document.textDocument.version}: fingerprint unchanged`);
1068
1438
  return;
1069
1439
  }
1070
- this.lastEmittedFingerprint.set(uri, fingerprint);
1440
+ record.fingerprint = fingerprint;
1441
+ // The manager's attribution, so this head names the same client as the
1442
+ // in-process heads do for one build, except for a version this head
1443
+ // already sent; see `DataServerUriWatchRecord.sentVersion`.
1444
+ const version = this.services.workspace.AstDocumentManager.isOpen(uri) ? document.textDocument.version : undefined;
1445
+ const { reason, sourceClientId } =
1446
+ version !== undefined && record.sentVersion === version
1447
+ ? { reason: 'rebuilt' as const, sourceClientId: UNKNOWN_CLIENT_ID }
1448
+ : this.services.workspace.AstDocumentManager.attributeUpdate(document);
1449
+ record.sentVersion = version;
1071
1450
  const event: TransferDocumentUpdatedEvent<TTransfer, TDiagnostic> = {
1072
1451
  document: this.envelope(document.uri),
1073
- sourceClientId: revertedOnClose ? REVERT_ON_CLOSE_CLIENT_ID : this.resolveSourceClientId(document),
1074
- reason: this.resolveUpdateReason(document.uri)
1452
+ sourceClientId: revertedOnClose ? REVERT_ON_CLOSE_CLIENT_ID : sourceClientId,
1453
+ reason
1075
1454
  };
1076
1455
  this.tracer
1077
1456
  .withUri(uri)
@@ -1119,31 +1498,6 @@ export class DataServer<
1119
1498
  return [];
1120
1499
  }
1121
1500
 
1122
- /**
1123
- * Discriminate the reason for a phase-event-driven update notification.
1124
- * Uses the most recent `DocumentBuilder.onUpdate` snapshot:
1125
- * - URI in the `deleted` list → `'deleted'`
1126
- * - URI in the `changed` list → `'changed'` (the URI was passed to
1127
- * `documentBuilder.update(changed, deleted)`, which spans `didChange`
1128
- * text-document events and programmatic `update([uri], [])` calls).
1129
- * - Otherwise → `'rebuilt'` (cascade re-derivation: this URI was rebuilt
1130
- * because something it depends on changed; its own text wasn't flagged).
1131
- *
1132
- * `'saved'` is NOT emitted from this code path — saves take the dedicated
1133
- * `DataClientProtocol.onDocumentSaved` channel; adopters that want a
1134
- * unified update stream synthesise `'saved'` in their bridge layer.
1135
- */
1136
- protected resolveUpdateReason(uri: URI): TransferDocumentUpdatedEvent<TTransfer, TDiagnostic>['reason'] {
1137
- const last = this.lastBuildUpdate;
1138
- if (last?.deleted.some(deleted => UriUtils.equals(deleted, uri))) {
1139
- return 'deleted';
1140
- }
1141
- if (last?.changed.some(changed => UriUtils.equals(changed, uri))) {
1142
- return 'changed';
1143
- }
1144
- return 'rebuilt';
1145
- }
1146
-
1147
1501
  /**
1148
1502
  * Subscribe to the project tier's change channel and re-fan registry
1149
1503
  * diffs into per-project wire notifications. The internal
@@ -1187,20 +1541,6 @@ export class DataServer<
1187
1541
  }
1188
1542
  }
1189
1543
 
1190
- /**
1191
- * Resolve the wire-level `sourceClientId` for `document`'s events — the client
1192
- * that authored its current version, from the version-author history on
1193
- * `HydraniumTextDocuments`. The protocol-level counterpart of the internal
1194
- * `AstDocumentManager.getAuthor`: a framework-internal rebuild has no author,
1195
- * so this surfaces the {@link UNKNOWN_CLIENT_ID} presentation default. Adopters
1196
- * that rebuild through non-text-document channels override to derive a
1197
- * source id of their own.
1198
- */
1199
- protected resolveSourceClientId(document: LangiumDocument): string {
1200
- const author = this.services.workspace.TextDocuments.getAuthor(document.textDocument.uri, document.textDocument.version);
1201
- return author ?? UNKNOWN_CLIENT_ID;
1202
- }
1203
-
1204
1544
  // --- Diagnostics (DataServerDiagnosticsProtocol) ---------------------------
1205
1545
  // Computed in THIS process: the data-server child holds the model store, so
1206
1546
  // these snapshots reflect the heap that actually carries the workspace
@@ -1243,7 +1583,7 @@ export class DataServer<
1243
1583
 
1244
1584
  async stopProfiling(args: StopProfilingArgs): Promise<string> {
1245
1585
  if (!this.activeProfile) {
1246
- throw new Error('No profiling capture is active; call startProfiling first.');
1586
+ throw noActiveProfileError();
1247
1587
  }
1248
1588
  const capture = this.activeProfile;
1249
1589
  this.activeProfile = undefined;
@@ -1262,7 +1602,7 @@ export class DataServer<
1262
1602
  /** Resolve a partial options object into a fully-defaulted form. */
1263
1603
  protected resolveOptions(partial: DataServerOptions): ResolvedDataServerOptions {
1264
1604
  const additionalMethods = partial.additionalMethods ?? [];
1265
- const builtIn = [...DATA_SERVER_PROTOCOL_METHODS, ...DATA_SERVER_DIAGNOSTICS_METHODS] as readonly string[];
1605
+ const builtIn: readonly string[] = [...DATA_SERVER_PROTOCOL_METHODS, ...DATA_SERVER_DIAGNOSTICS_METHODS];
1266
1606
  const overlap = additionalMethods.filter(name => builtIn.includes(name));
1267
1607
  if (overlap.length > 0) {
1268
1608
  throw new Error(
@@ -1276,7 +1616,8 @@ export class DataServer<
1276
1616
  methodNamespace: partial.methodNamespace ?? DATA_SERVER_WIRE_PREFIX,
1277
1617
  additionalMethods,
1278
1618
  excludedMethods: partial.excludedMethods ?? [],
1279
- diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics()
1619
+ diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics(),
1620
+ referenceSettleTimeoutMs: partial.referenceSettleTimeoutMs ?? DataServer.DEFAULT_OPTIONS.referenceSettleTimeoutMs
1280
1621
  };
1281
1622
  }
1282
1623
  }