@hydranium/data-server 1.0.0-next.15 → 1.0.0-next.155

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,11 @@ 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,
43
+ textHash
33
44
  } from '@hydranium/protocol';
34
45
  import {
35
46
  DATA_SERVER_DIAGNOSTICS_METHODS,
@@ -42,29 +53,84 @@ import {
42
53
  type StartProfilingArgs,
43
54
  type StopProfilingArgs,
44
55
  type WriteServerHeapSnapshotArgs,
56
+ type CloseSessionArgs,
57
+ type CreateModelDocumentArgs,
58
+ type CreateSessionArgs,
45
59
  type GetModelDocumentArgs,
46
60
  type GetProjectForUriArgs,
47
61
  type TransferSaveDocumentArgs,
48
62
  type WatchModelDocumentArgs,
49
63
  type TransferDocumentSavedEvent,
50
64
  type TransferDocumentUpdatedEvent,
51
- type TransferUpdateDocumentArgs
65
+ type TransferUpdateDocumentArgs,
66
+ type TransferUpdateDocumentsArgs
52
67
  } from '@hydranium/protocol/data';
53
- import { REVERT_ON_CLOSE_CLIENT_ID, UNKNOWN_CLIENT_ID } from '@hydranium/core';
68
+ import { REVERT_ON_CLOSE_CLIENT_ID, ReentrantWriteLockError } from '@hydranium/core';
54
69
  import { defaultDataServerDiagnostics } from './default-diagnostics.js';
70
+
71
+ /**
72
+ * Raised when a profiling command arrives with no capture running.
73
+ *
74
+ * A `ResponseError` rather than a plain `Error` so the identity survives to the
75
+ * response boundary, which is where the message is rendered. An unwrapped throw
76
+ * reaches the client as a generic internal error instead: no code for a caller
77
+ * to switch on, and nothing for the boundary to render from.
78
+ */
79
+ export const NO_ACTIVE_PROFILE = defineMessage(
80
+ 'hydranium/data-server/no-active-profile',
81
+ 'No profiling capture is active; call startProfiling first.'
82
+ );
83
+
84
+ /**
85
+ * The JSON-RPC code, unrelated to the catalogue code above: this one is numeric,
86
+ * survives reconstruction and is what a caller switches on.
87
+ */
88
+ export const NO_ACTIVE_PROFILE_CODE = HYDRANIUM_ERROR_CODES.noActiveProfile;
89
+
90
+ export const noActiveProfileError = (): HydraniumResponseError => messageError(NO_ACTIVE_PROFILE_CODE, NO_ACTIVE_PROFILE);
91
+
92
+ /**
93
+ * Raised when a reference question's wait for the build exceeds
94
+ * {@link DataServerOptions.referenceSettleTimeoutMs}.
95
+ *
96
+ * A `ResponseError` because a class name does not cross RPC: without the code a
97
+ * wire client cannot tell a wedged build from a reference that resolves to
98
+ * nothing, which is the distinction the wait exists to keep.
99
+ */
100
+ export const REFERENCE_SETTLE_TIMEOUT = defineMessage(
101
+ 'hydranium/data-server/reference-settle-timeout',
102
+ 'The model is still being processed; try again in a moment.'
103
+ );
104
+
105
+ /** See {@link NO_ACTIVE_PROFILE_CODE} for why this is separate from the catalogue code. */
106
+ export const REFERENCE_SETTLE_TIMEOUT_CODE = HYDRANIUM_ERROR_CODES.referenceSettleTimeout;
107
+
108
+ /** The wait's length rides in `data` as `elapsedMs`, for the code that reacts rather than the reader. */
109
+ export const referenceSettleTimeoutError = (elapsedMs: number): ResponseError<HydraniumMessageData & { readonly elapsedMs: number }> =>
110
+ new ResponseError(REFERENCE_SETTLE_TIMEOUT_CODE, REFERENCE_SETTLE_TIMEOUT.format(), {
111
+ elapsedMs,
112
+ ...messageData(REFERENCE_SETTLE_TIMEOUT)
113
+ });
114
+
55
115
  import type { DataServerDiagnosticsProvider, DataServerProfileCapture } from './diagnostics-provider.js';
56
116
  import type {
117
+ ClientSession,
118
+ ClientSessionWriteArgs,
57
119
  ClientTextDocumentChangeEvent,
120
+ DocumentDirtyChangedEvent,
58
121
  HydraniumLanguageServices,
59
122
  LogNameOptions,
123
+ AstDiagnostic,
124
+ AstDocument,
60
125
  ModelService,
61
126
  ProjectChangeEvent,
62
127
  ServerSharedServices,
128
+ SessionEndCause,
63
129
  TransferEncoder
64
130
  } from '@hydranium/core';
65
131
  import type { TextDocument } from 'vscode-languageserver-textdocument';
66
132
  import { type AstNode, DocumentState, type LangiumDocument, UriUtils, type URI } from '@hydranium/langium';
67
- import type { CancellationToken, MessageConnection } from 'vscode-jsonrpc';
133
+ import { type CancellationToken, type MessageConnection, ResponseError } from 'vscode-jsonrpc';
68
134
 
69
135
  /**
70
136
  * Domain separator between text and diagnostics inputs of
@@ -75,35 +141,17 @@ import type { CancellationToken, MessageConnection } from 'vscode-jsonrpc';
75
141
  const FINGERPRINT_SEPARATOR = '\0';
76
142
 
77
143
  /**
78
- * Portable, non-cryptographic 64-bit fingerprint hash (cyrb53), returning a
79
- * 16-char hex digest.
80
- *
81
- * **A cryptographic hash via `node:crypto` is the wrong trade**: the
82
- * fingerprint only needs a stable signal that `(text, diagnostics)` changed
83
- * between emissions, and a `node:*` import would cost
84
- * `@hydranium/data-server` its browser-portability. Parts are fed
85
- * incrementally, char by char, so multi-MB document text is never
86
- * concatenated into one string.
144
+ * A session a data connection registered with a resume token, and how to end
145
+ * it from another connection. See {@link DataServer.resumableSessions}.
87
146
  */
88
- function fingerprintHash(parts: readonly string[]): string {
89
- let h1 = 0xdeadbeef;
90
- let h2 = 0x41c6ce57;
91
- for (const part of parts) {
92
- for (let i = 0; i < part.length; i++) {
93
- const ch = part.charCodeAt(i);
94
- h1 = Math.imul(h1 ^ ch, 2654435761);
95
- h2 = Math.imul(h2 ^ ch, 1597334677);
96
- }
97
- }
98
- h1 = Math.imul(h1 ^ (h1 >>> 16), 2246822507);
99
- h1 ^= Math.imul(h2 ^ (h2 >>> 13), 3266489909);
100
- h2 = Math.imul(h2 ^ (h2 >>> 16), 2246822507);
101
- h2 ^= Math.imul(h1 ^ (h1 >>> 13), 3266489909);
102
- const high = (h2 >>> 0).toString(16).padStart(8, '0');
103
- const low = (h1 >>> 0).toString(16).padStart(8, '0');
104
- return high + low;
147
+ export interface ResumableSession {
148
+ readonly token: string;
149
+ /** End the session as its connection closing would. */
150
+ readonly end: () => void;
105
151
  }
106
152
 
153
+ const resumableByModelService = new WeakMap<object, Map<string, ResumableSession>>();
154
+
107
155
  /**
108
156
  * Which observable state {@link DataServer.computeDocumentFingerprint} hashes to
109
157
  * de-dup `onDocumentUpdated` emissions.
@@ -123,18 +171,14 @@ export type FingerprintStrategy = 'transfer-document' | 'text-diagnostics';
123
171
 
124
172
  /** Hash a document's raw text + diagnostics — the `'text-diagnostics'` strategy. */
125
173
  function textDiagnosticsFingerprint(document: LangiumDocument): string {
126
- return fingerprintHash([document.textDocument.getText(), FINGERPRINT_SEPARATOR, JSON.stringify(document.diagnostics ?? [])]);
174
+ return textHash([document.textDocument.getText(), FINGERPRINT_SEPARATOR, JSON.stringify(document.diagnostics ?? [])]);
127
175
  }
128
176
 
129
177
  /** Hash an encoded transfer document's root + diagnostics — the `'transfer-document'` strategy. */
130
178
  function transferDocumentFingerprint(transferDocument: Pick<TransferDocument<TransferElement, unknown>, 'root' | 'diagnostics'>): string {
131
179
  // null, not undefined: `JSON.stringify(undefined)` yields undefined rather
132
180
  // than a string, putting a non-string into the hash inputs.
133
- return fingerprintHash([
134
- JSON.stringify(transferDocument.root ?? null),
135
- FINGERPRINT_SEPARATOR,
136
- JSON.stringify(transferDocument.diagnostics)
137
- ]);
181
+ return textHash([JSON.stringify(transferDocument.root ?? null), FINGERPRINT_SEPARATOR, JSON.stringify(transferDocument.diagnostics)]);
138
182
  }
139
183
  /**
140
184
  * `logAfterMs` threshold passed to {@link Tracer.time} around
@@ -155,12 +199,13 @@ export interface DataServerOptions extends LogNameOptions {
155
199
  * (`DataClientProtocol.onDocumentUpdated`).
156
200
  *
157
201
  * **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.
202
+ * response phase. A read (`getModelDocument`) settles at the
203
+ * integrity-settled landmark (`IntegrityService.SettledState`), or at
204
+ * `Validated` when {@link GetModelDocumentArgs.includeDiagnostics} is set.
205
+ * A write (`updateModelDocument` / `updateModelDocuments` /
206
+ * `saveModelDocument`) answers once its document is validated, as a
207
+ * session's write does. This option controls only the async notification
208
+ * phase.
164
209
  *
165
210
  * Default: `DocumentState.Validated` — validation is the last builder
166
211
  * phase and produces the full diagnostic set, so subscription events fired
@@ -201,6 +246,22 @@ export interface DataServerOptions extends LogNameOptions {
201
246
  */
202
247
  readonly fingerprintStrategy?: FingerprintStrategy;
203
248
 
249
+ /**
250
+ * How long a reference question waits for the build to reach `Linked` before
251
+ * failing with {@link REFERENCE_SETTLE_TIMEOUT_CODE}. Bounded because the
252
+ * wait resolves off a build-phase notification, so a build cancelled below
253
+ * `Linked` with nothing after it leaves the request unanswered for the life
254
+ * of the server.
255
+ *
256
+ * Expiry rejects rather than reading the index anyway: the unsettled index
257
+ * is what the wait keeps the caller away from, so falling through to it on a
258
+ * slow build reinstates the fault — and on a name proposal persists it.
259
+ *
260
+ * Default {@link DataServer.DEFAULT_OPTIONS}, sized for a cold workspace
261
+ * still reaching `Linked` for the first time.
262
+ */
263
+ readonly referenceSettleTimeoutMs?: number;
264
+
204
265
  /**
205
266
  * Wire-method namespace for both inbound request handlers and the
206
267
  * outbound notification client proxy. Defaults to
@@ -258,15 +319,20 @@ export interface DataServerOptions extends LogNameOptions {
258
319
  * When supplied, every inbound data-server RPC is timed into this collector
259
320
  * (via the `createRpcProxy` binding) and exposed through
260
321
  * {@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).
322
+ * LSP connection can pass the SAME collector through `lspLatencyOptions` to
323
+ * that connection, so one report covers both heads. Absent by default (no
324
+ * timing overhead).
264
325
  */
265
326
  readonly latency?: LatencyCollector;
266
327
  }
267
328
 
268
- /** Fully-resolved variant — every field set, used internally after merging defaults. */
269
- interface ResolvedDataServerOptions {
329
+ /**
330
+ * Fully-resolved variant of {@link DataServerOptions} — every field set, after
331
+ * merging defaults. Returned by the `protected`
332
+ * {@link DataServer.resolveOptions} and held on {@link DataServer.options}, so
333
+ * an adopter changing how defaults resolve has to name it.
334
+ */
335
+ export interface ResolvedDataServerOptions {
270
336
  readonly subscriptionPhase: DocumentState;
271
337
  readonly fingerprintStrategy: FingerprintStrategy;
272
338
  readonly methodNamespace: string;
@@ -274,6 +340,34 @@ interface ResolvedDataServerOptions {
274
340
  readonly excludedMethods: readonly string[];
275
341
  /** Always resolved — to the caller's, or to the platform default. */
276
342
  readonly diagnostics: DataServerDiagnosticsProvider;
343
+ readonly referenceSettleTimeoutMs: number;
344
+ }
345
+
346
+ /**
347
+ * What a {@link DataServer} keeps per canonical URI, in the `protected`
348
+ * {@link DataServer.uriWatchRecords}. A record lives while it has a watcher
349
+ * or a revert mark; {@link DataServer.pruneUriWatchRecord} enforces that on
350
+ * every path that removes either, so a record with no watcher has a revert
351
+ * pending. Test the size of {@link DataServerUriWatchRecord.watchers}, not the
352
+ * record's presence, for "watched".
353
+ */
354
+ export interface DataServerUriWatchRecord {
355
+ /** The client ids watching the URI; save, dirty and phase events go out only while it is non-empty, a pending revert aside. */
356
+ readonly watchers: Set<string>;
357
+ /** 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. */
358
+ fingerprint?: string;
359
+ /** Set by {@link DataServer.subscribeToTextDocumentCloses}; the next phase event broadcasts even without a watcher. */
360
+ revertPending?: boolean;
361
+ /**
362
+ * The version of an open document the last event sent was built at. The
363
+ * version sent again goes out as `'rebuilt'` from no client: the manager
364
+ * counts a version delivered only once its `Validated` listeners ran, so a
365
+ * build cancelled after the subscription phase would send it as a change
366
+ * twice. Only while the store has the document open: without it, a
367
+ * document can keep one version through changes of its file, so its events
368
+ * keep the manager's attribution.
369
+ */
370
+ sentVersion?: number;
277
371
  }
278
372
 
279
373
  /**
@@ -301,9 +395,11 @@ interface ResolvedDataServerOptions {
301
395
  * any names supplied via {@link DataServerOptions.additionalMethods}) and
302
396
  * builds the {@link DataClientProtocol} notification proxy on the same
303
397
  * 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`.
398
+ * `localTarget`) under the configured namespace, and subscribes two listeners
399
+ * at the configured phase: a `DocumentBuilder.onDocumentPhase` one dispatching
400
+ * per-document `clientProxy.onDocumentUpdated` for watched URIs, and a
401
+ * `DocumentBuilder.onBuildPhase` one dispatching a single
402
+ * `clientProxy.onDocumentsBuilt` naming the batch's unwatched documents.
307
403
  *
308
404
  * The data-server requires the full {@link ServerSharedServices}
309
405
  * shape — `HydraniumTextDocuments` for client-attributed updates,
@@ -331,87 +427,27 @@ export class DataServer<
331
427
  * Framework defaults, exposed so an adopter can spread them when
332
428
  * extending rather than restate a value the framework may change.
333
429
  */
334
- static readonly DEFAULT_OPTIONS: Required<Pick<DataServerOptions, 'subscriptionPhase'>> = {
335
- subscriptionPhase: DocumentState.Validated
430
+ static readonly DEFAULT_OPTIONS: Required<Pick<DataServerOptions, 'subscriptionPhase' | 'referenceSettleTimeoutMs'>> = {
431
+ subscriptionPhase: DocumentState.Validated,
432
+ referenceSettleTimeoutMs: 60_000
336
433
  };
337
434
 
338
435
  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>>();
436
+ /** This connection's {@link DataServerUriWatchRecord} per canonical URI; see there for when a record lives. */
437
+ protected readonly uriWatchRecords = new Map<string, DataServerUriWatchRecord>();
341
438
  /**
342
- * Open-document bookkeeping: URI → set of clientIds that opened it over THIS
343
- * connection.
439
+ * The client sessions this connection registered, by client id. A document
440
+ * request carrying one of these ids acts as that session; one carrying any
441
+ * other id fails.
344
442
  *
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.
443
+ * Entries stay after {@link dispose} has ended their sessions, so a request
444
+ * still running from before the connection closed reaches the ended handle
445
+ * and fails with the session's own error.
351
446
  */
352
- protected readonly openedDocuments = new Map<string, Set<string>>();
447
+ protected readonly clientSessions = new Map<string, ClientSession<AstNode, AstDiagnostic, TTransfer>>();
353
448
  /** Typed client proxy — sends `data-server/on*` notifications back over the same wire. */
354
449
  protected readonly clientProxy: DataClientProtocol<TTransfer, TDiagnostic, TProject>;
355
450
  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
451
  protected readonly tracer: Tracer;
416
452
  /** The in-flight interactive profile capture, held between {@link startProfiling} and {@link stopProfiling}. */
417
453
  protected activeProfile?: DataServerProfileCapture;
@@ -420,27 +456,23 @@ export class DataServer<
420
456
  /** Per-method RPC latency collector, when the head opted in via {@link DataServerOptions.latency}. */
421
457
  protected readonly latency?: LatencyCollector;
422
458
  /** Encoder pulled from DI. Adopters rebind `services.model.TransferEncoder` to a typed-overlay subclass. */
423
- protected readonly encoder: TransferEncoder<unknown, TDiagnostic>;
459
+ protected readonly encoder: TransferEncoder<TDiagnostic>;
424
460
  /**
425
461
  * 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`.
462
+ * Its documents carry the AST-layer {@link AstDiagnostic}, never the wire `TDiagnostic`:
463
+ * {@link encoder} converts one into the other on the way out.
431
464
  */
432
- protected readonly modelService: ModelService<AstNode, unknown, TTransfer>;
465
+ protected readonly modelService: ModelService<AstNode, AstDiagnostic, TTransfer>;
433
466
 
434
467
  constructor(
435
468
  protected readonly connection: MessageConnection,
436
- protected readonly services: ServerSharedServices<TProject>,
469
+ protected readonly services: ServerSharedServices<TProject, TDiagnostic>,
437
470
  options: DataServerOptions = {}
438
471
  ) {
439
472
  this.options = this.resolveOptions(options);
440
473
  this.tracer = this.services.Tracer.for(options.logName ?? 'DataServer').trace('instantiated');
441
474
  // 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.
475
+ // `services.model.ModelService` with their own subclasses.
444
476
  const { TransferEncoder: encoder, ModelService: modelService } = this.services.model;
445
477
  if (!encoder || !modelService) {
446
478
  throw new Error(
@@ -448,8 +480,8 @@ export class DataServer<
448
480
  'Did you compose `createServerSharedModule(ctx)` into your shared module?'
449
481
  );
450
482
  }
451
- this.encoder = encoder as TransferEncoder<unknown, TDiagnostic>;
452
- this.modelService = modelService as ModelService<AstNode, unknown, TTransfer>;
483
+ this.encoder = encoder;
484
+ this.modelService = modelService;
453
485
  const excluded = new Set<string>(this.options.excludedMethods);
454
486
  const registeredMethods = [
455
487
  ...DATA_SERVER_PROTOCOL_METHODS,
@@ -465,38 +497,43 @@ export class DataServer<
465
497
  methodNamespace: this.options.methodNamespace,
466
498
  localTarget: this,
467
499
  localMethods: registeredMethods as readonly (keyof this & string)[],
468
- latency: this.latency
500
+ latency: this.latency,
501
+ // Bound at the chokepoint rather than per handler, so an adopter's
502
+ // `additionalMethods` are rendered on the same terms as the
503
+ // framework's own rejections.
504
+ renderErrorMessage: error => this.services.MessageRenderer.renderError(error)
469
505
  });
470
- this.disposables.push(
471
- this.services.workspace.DocumentBuilder.onUpdate((changed, deleted) => {
472
- this.lastBuildUpdate = { changed, deleted };
473
- })
474
- );
506
+ this.disposables.push(this.services.workspace.DocumentBuilder.onUpdate((_changed, deleted) => this.dispatchDeleteEvents(deleted)));
475
507
  this.subscribeToDocumentBuilder();
476
508
  this.subscribeToTextDocumentSaves();
509
+ this.subscribeToDirtyChanges();
477
510
  this.subscribeToTextDocumentCloses();
478
511
  this.subscribeToProjectManager();
479
512
  // Self-register teardown so an adopter that keeps no reference to the
480
513
  // server still releases per-connection state, with no lifecycle hook of
481
- // its own. See `dispose`.
482
- this.disposables.push(connection.onClose(() => this.dispose()));
514
+ // its own. The client did not close anything itself, so its sessions end
515
+ // as lost and each document it was the last to have open waits out the
516
+ // store's revert grace. See `dispose`.
517
+ this.disposables.push(connection.onClose(() => this.dispose('lost')));
483
518
  }
484
519
 
485
520
  /**
486
521
  * 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.
522
+ * handlers and every listener — and clear {@link uriWatchRecords}, so a
523
+ * long-lived shared services bundle does not retain per-connection memory
524
+ * after the connection closes. Also ends every session this connection registered, which closes
525
+ * every document it has open: the SHARED store's state rather than this
526
+ * server's, which outlives the connection unless released here.
493
527
  *
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.
528
+ * Idempotent: subsequent calls are no-ops. Runs by itself when the
529
+ * connection closes, so adopters who don't hold a reference still get
530
+ * per-connection cleanup; adopters that DO hold a reference may call
531
+ * `dispose()` directly for early teardown. The sessions end with `cause`:
532
+ * `'closed'` reverts every document whose last open they close at once,
533
+ * and `'lost'`, the connection's own close, lets each wait out the revert
534
+ * grace.
498
535
  */
499
- dispose(): void {
536
+ dispose(cause: SessionEndCause = 'closed'): void {
500
537
  this.disposed = true;
501
538
  // Release an in-flight interactive capture so the process-wide inspector
502
539
  // singleton is not left active after the connection closes.
@@ -505,102 +542,180 @@ export class DataServer<
505
542
  this.activeProfile = undefined;
506
543
  void capture.stop({}).catch(() => undefined);
507
544
  }
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.
545
+ // AFTER `disposables.dispose()`, deliberately: ending a session releases
546
+ // each document it was the last to hold, and this server's own
547
+ // `onDidCloseLastOpen` listener would otherwise mark a revert broadcast
548
+ // for a connection that is already gone.
511
549
  this.disposables.dispose();
512
- this.closeOpenDocuments();
513
- this.subscriptions.clear();
514
- this.lastEmittedFingerprint.clear();
515
- this.pendingRevertBroadcasts.clear();
550
+ for (const [clientId, session] of this.clientSessions) {
551
+ this.endSession(clientId, session, cause);
552
+ }
553
+ this.uriWatchRecords.clear();
516
554
  }
517
555
 
518
556
  // ============================================================
519
- // DataServerProtocol implementation — delegates to ModelService.
557
+ // DataServerProtocol implementation
520
558
  // ============================================================
521
559
  //
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);
560
+ // Reads go to `ModelService`; a request that opens or writes a document
561
+ // goes to the session this connection registered under its `clientId`.
562
+ // Each answer is encoded on the wire boundary via
563
+ // `encoder.astDocumentToTransferDocument`. To change how documents are
564
+ // read, override on the ModelService subclass; to change how they are
565
+ // written, on the session class the bound `ClientSessionFactory` builds.
566
+
567
+ async createSession(args: CreateSessionArgs): Promise<void> {
568
+ // After teardown nothing would ever end a session registered now, and its
569
+ // id would stay taken for the life of the process.
570
+ if (this.disposed) {
571
+ throw new SessionClosedError(args.clientId);
572
+ }
573
+ const resumable = this.resumableSessions();
574
+ const previous = resumable.get(args.clientId);
575
+ if (previous && args.resumeToken !== undefined && previous.token === args.resumeToken) {
576
+ previous.end();
577
+ }
578
+ const session = this.modelService.createSession(args.label, args.clientId);
579
+ this.clientSessions.set(args.clientId, session);
580
+ if (args.resumeToken !== undefined) {
581
+ // Taken over by a client registering again after its connection
582
+ // dropped, so the old session ends as lost: the documents it was the
583
+ // last to have open wait out the grace, and the new session's opens
584
+ // find their unsaved text.
585
+ resumable.set(args.clientId, { token: args.resumeToken, end: () => this.endSession(args.clientId, session, 'lost') });
541
586
  }
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
587
  }
556
588
 
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);
589
+ /**
590
+ * End a session this connection registered. The ended handle stays in
591
+ * {@link clientSessions}, as it does after {@link dispose}, so a request for
592
+ * the id still arriving fails with the ended session's own error.
593
+ */
594
+ async closeSession(args: CloseSessionArgs): Promise<void> {
595
+ const session = this.clientSessions.get(args.clientId);
596
+ if (session) {
597
+ this.endSession(args.clientId, session);
598
+ }
599
+ }
600
+
601
+ /** End `session`, registered here under `clientId`, with `cause`, and drop its watches on this connection. */
602
+ protected endSession(
603
+ clientId: string,
604
+ session: ClientSession<AstNode, AstDiagnostic, TTransfer>,
605
+ cause: SessionEndCause = 'closed'
606
+ ): void {
607
+ for (const [uri, record] of this.uriWatchRecords) {
608
+ if (record.watchers.delete(clientId)) {
609
+ this.pruneUriWatchRecord(uri);
610
+ }
611
+ }
612
+ session.dispose(cause);
564
613
  }
565
614
 
566
615
  /**
567
- * Drop the recorded hold for `(uri, clientId)` so {@link dispose} does not
568
- * close it a second time. Idempotent.
616
+ * The resumable sessions of this services tree, by client id, across all of
617
+ * its data connections: a client resumes on another connection than the one
618
+ * that registered it. An entry leaves when its session ends, by any path, so
619
+ * it keeps no ended connection alive.
620
+ *
621
+ * A takeover by resume token ends the old session even when its connection
622
+ * is still alive, so two clients that shared an id and its token would end
623
+ * each other's sessions. And the token is a guard against colliding with a
624
+ * session the server has not yet seen end, not a secret: the wire carries no
625
+ * authentication, and a peer that learns the token can end the session.
569
626
  */
570
- protected forgetOpenDocument(uri: string, clientId: string): void {
571
- const holders = this.openedDocuments.get(uri);
572
- if (!holders) {
573
- return;
627
+ protected resumableSessions(): Map<string, ResumableSession> {
628
+ let sessions = resumableByModelService.get(this.modelService);
629
+ if (!sessions) {
630
+ const created = new Map<string, ResumableSession>();
631
+ // Subscribed once per services tree, and never disposed: it lives as
632
+ // long as the text store it listens to.
633
+ this.services.workspace.TextDocuments.onDidCloseSession(event => created.delete(event.clientId));
634
+ resumableByModelService.set(this.modelService, created);
635
+ sessions = created;
574
636
  }
575
- holders.delete(clientId);
576
- if (holders.size === 0) {
577
- this.openedDocuments.delete(uri);
637
+ return sessions;
638
+ }
639
+
640
+ async createModelDocument(args: CreateModelDocumentArgs): Promise<TransferDocument<TTransfer, TDiagnostic>> {
641
+ const session = this.requireSession(args.clientId);
642
+ await session.create(args.uri, args.text);
643
+ return this.openedSnapshot(args.uri, () => session.close(args.uri));
644
+ }
645
+
646
+ async updateModelDocuments(args: TransferUpdateDocumentsArgs<TTransfer>): Promise<TransferDocument<TTransfer, TDiagnostic>[]> {
647
+ const astDocuments = await this.requireSession(args.clientId).updateAll({
648
+ updates: args.updates.map(update => this.toSessionWrite(update))
649
+ });
650
+ return astDocuments.map(astDocument => this.encodeDocument(astDocument));
651
+ }
652
+
653
+ /**
654
+ * The session write a wire write request carries. Only the fields a session
655
+ * takes: a field an adopter adds to a request reaches the session only
656
+ * through an override of this.
657
+ */
658
+ protected toSessionWrite(request: Omit<TransferUpdateDocumentArgs<TTransfer>, 'clientId'>): ClientSessionWriteArgs<TTransfer> {
659
+ return { uri: request.uri, model: request.model, basedOn: request.basedOn };
660
+ }
661
+
662
+ /**
663
+ * The session this connection registered under `clientId`, which every
664
+ * document request acts as. An id that is not one fails with the
665
+ * closed-session code: opening or writing under it would leave an open that
666
+ * no session end ever closes.
667
+ */
668
+ protected requireSession(clientId: string): ClientSession<AstNode, AstDiagnostic, TTransfer> {
669
+ const session = this.clientSessions.get(clientId);
670
+ if (!session) {
671
+ throw new SessionClosedError(clientId, 'The client session was never registered on this connection.');
578
672
  }
673
+ return session;
674
+ }
675
+
676
+ async openModelDocument(args: Pick<OpenModelArgs, 'uri' | 'clientId' | 'options'>): Promise<TransferDocument<TTransfer, TDiagnostic>> {
677
+ const session = this.requireSession(args.clientId);
678
+ const wasOpen = this.services.workspace.TextDocuments.isOpenInClient(args.uri, args.clientId);
679
+ await session.open(args.uri, args.options);
680
+ // A repeat open keeps the earlier one, which is still in use.
681
+ return this.openedSnapshot(args.uri, wasOpen ? undefined : () => session.close(args.uri));
579
682
  }
580
683
 
581
684
  /**
582
- * Close every document still open over this connection, for the clients that
583
- * opened it here.
584
- *
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.
685
+ * The snapshot a session's open or create answers with. When the read
686
+ * fails, `rollback` undoes the open this call made before the failure is
687
+ * rethrown: the caller sees no open, so nothing on its side would ever close
688
+ * it.
591
689
  *
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.
690
+ * Versioned with the store's shared version rather than the snapshot's own:
691
+ * the built document's `textDocument.version` lags the store's whenever the
692
+ * store assigned the version, and the store's is what a write's `basedOn` is
693
+ * compared against, so reporting the snapshot's would make the caller's
694
+ * first based-on write conflict with itself.
595
695
  */
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
- }
696
+ protected async openedSnapshot(uri: string, rollback?: () => Promise<void>): Promise<TransferDocument<TTransfer, TDiagnostic>> {
697
+ let document: TransferDocument<TTransfer, TDiagnostic>;
698
+ try {
699
+ document = await this.getModelDocument({ uri });
700
+ } catch (error: unknown) {
701
+ // The open's failure is the one the caller needs, not the cleanup's.
702
+ await rollback?.().catch(() => undefined);
703
+ throw error;
603
704
  }
705
+ // Stamped again with the version, in one step: a write landing after the
706
+ // read would otherwise pair its version with the read's text hash.
707
+ return this.withServerState({ ...document, version: asSnapshotVersion(this.services.workspace.TextDocuments.version(uri)) });
708
+ }
709
+
710
+ async closeModelDocument(args: CloseModelArgs): Promise<void> {
711
+ // Through the handle, so a close under an ended session fails as that
712
+ // session's calls do, and a session class's own close is honoured.
713
+ const session = this.requireSession(args.clientId);
714
+ // Closing also releases the watch for (uri, clientId) — a forgotten
715
+ // unwatch would otherwise leak phase-event dispatch until the connection
716
+ // closes. Idempotent: a close without a prior watch is a no-op.
717
+ await this.unwatchModelDocument({ uri: args.uri, clientId: args.clientId });
718
+ await session.close(args.uri);
604
719
  }
605
720
 
606
721
  async getModelDocument(args: GetModelDocumentArgs): Promise<TransferDocument<TTransfer, TDiagnostic>> {
@@ -615,18 +730,26 @@ export class DataServer<
615
730
  // unsubscribed caller that needs diagnostics inline passes
616
731
  // `includeDiagnostics: true` to settle at `Validated` instead.
617
732
  const state = args.includeDiagnostics ? DocumentState.Validated : undefined;
618
- const astDocument = await this.modelService.ensureDocumentState(args.uri, state);
619
- return this.encoder.astDocumentToTransferDocument(astDocument as never) as unknown as TransferDocument<TTransfer, TDiagnostic>;
733
+ try {
734
+ return this.encodeDocument(await this.modelService.ensureDocumentState(args.uri, state));
735
+ } catch (error: unknown) {
736
+ // The protocol answers a read of a URI with no document with an
737
+ // envelope that has no root.
738
+ if (this.isMissingDocument(error, args.uri)) {
739
+ return this.envelope(UriUtils.toUri(args.uri));
740
+ }
741
+ throw error;
742
+ }
620
743
  }
621
744
 
622
745
  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>;
746
+ const astDocument = await this.requireSession(args.clientId).update(this.toSessionWrite(args));
747
+ return this.encodeDocument(astDocument);
625
748
  }
626
749
 
627
750
  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>;
751
+ const astDocument = await this.requireSession(args.clientId).save(this.toSessionWrite(args));
752
+ return this.encodeDocument(astDocument);
630
753
  }
631
754
 
632
755
  /**
@@ -634,28 +757,24 @@ export class DataServer<
634
757
  * fan out to the wired `clientProxy.onDocumentUpdated`. The
635
758
  * bidirectional pattern means the event channel is the client
636
759
  * notification surface, not a returned handle — this method only
637
- * registers the URI in the dispatch table.
760
+ * registers the watcher in {@link uriWatchRecords}.
638
761
  *
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.
762
+ * Also baselines the URI's emission fingerprint (see
763
+ * {@link dispatchPhaseEvent}) to the document's current state when the
764
+ * first watcher for the URI registers. This guarantees that any phase event firing immediately after
765
+ * the watch with no observable change is suppressed — watchers obtain
766
+ * initial state via `getModelDocument` (or {@link openModelDocument}) and
767
+ * do not need a redundant phase notification for that same state.
646
768
  */
647
769
  async watchModelDocument(args: WatchModelDocumentArgs): Promise<void> {
648
770
  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)) {
771
+ const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set<string>() };
772
+ this.uriWatchRecords.set(uri, record);
773
+ record.watchers.add(args.clientId);
774
+ if (record.fingerprint === undefined) {
656
775
  const document = this.services.workspace.LangiumDocuments.getDocument(UriUtils.toUri(uri));
657
776
  if (document) {
658
- this.lastEmittedFingerprint.set(uri, this.computeDocumentFingerprint(document));
777
+ record.fingerprint = this.computeDocumentFingerprint(document);
659
778
  }
660
779
  }
661
780
  }
@@ -663,29 +782,40 @@ export class DataServer<
663
782
  /**
664
783
  * Remove a watch for `(uri, clientId)` previously created by
665
784
  * {@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.
785
+ * Dispatch for `uri` stops once no watchers remain, and the emission
786
+ * fingerprint goes with the last watcher (see {@link pruneUriWatchRecord}).
670
787
  */
671
788
  async unwatchModelDocument(args: WatchModelDocumentArgs): Promise<void> {
672
789
  const uri = this.canonicalKey(args.uri);
673
- const subscribers = this.subscriptions.get(uri);
674
- if (!subscribers) {
790
+ if (this.uriWatchRecords.get(uri)?.watchers.delete(args.clientId)) {
791
+ this.pruneUriWatchRecord(uri);
792
+ }
793
+ }
794
+
795
+ /**
796
+ * Drop what `uri` no longer needs: the
797
+ * {@link DataServerUriWatchRecord.fingerprint} once no client watches it,
798
+ * and the whole record once it holds no
799
+ * {@link DataServerUriWatchRecord.revertPending} mark either. Every path
800
+ * that removes a watcher or consumes a mark ends here.
801
+ */
802
+ protected pruneUriWatchRecord(uri: string): void {
803
+ const record = this.uriWatchRecords.get(uri);
804
+ if (!record || record.watchers.size > 0) {
675
805
  return;
676
806
  }
677
- subscribers.delete(args.clientId);
678
- if (subscribers.size === 0) {
679
- this.subscriptions.delete(uri);
680
- this.lastEmittedFingerprint.delete(uri);
807
+ if (record.revertPending) {
808
+ record.fingerprint = undefined;
809
+ } else {
810
+ this.uriWatchRecords.delete(uri);
681
811
  }
682
812
  }
683
813
 
684
814
  /**
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
815
+ * Canonicalise a URI string for use as a {@link uriWatchRecords} key, via the
816
+ * shared `DocumentUriPolicy`. Callers may send non-canonical URIs
817
+ * (drive-letter casing, percent-encoding differences, or a symlink path)
818
+ * over the wire; the dispatch side keys by
689
819
  * `document.uri.toString()` from `LangiumDocuments`, so writer keys must
690
820
  * canonicalise to the same form or events silently fail to deliver.
691
821
  * Routing through the seam (rather than a bare `UriUtils.normalize`)
@@ -734,26 +864,57 @@ export class DataServer<
734
864
  // (see resolveReferenceServices) and delegate.
735
865
  // ============================================================
736
866
 
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;
867
+ /**
868
+ * Settle the build before a reference question is answered from the index.
869
+ *
870
+ * A query issued right after a model update otherwise races the rebuild and
871
+ * reads an index missing the symbols it asks about. The cost is not confined
872
+ * to this call: a scope built inside that window is cached, and the build's
873
+ * remaining documents link against it.
874
+ *
875
+ * Waits the source document specifically, but ONLY when one is loaded at
876
+ * that URI: a synthetic source can address a URI with no document (a
877
+ * directory URI, typically), where a per-URI `waitUntil` throws "No document
878
+ * found". Falls back to a global settle, matching the id-based
879
+ * `ElementSource` path.
880
+ *
881
+ * Bounded by {@link DataServerOptions.referenceSettleTimeoutMs}.
882
+ */
883
+ protected async awaitReferencesLinked(source: ReferenceSource): Promise<void> {
884
+ const uri = isDocumentSource(source) || isSyntheticSource(source) ? UriUtils.toUri(source.uri) : undefined;
746
885
  const waitUri = uri && this.services.workspace.LangiumDocuments.hasDocument(uri) ? uri : undefined;
747
- await this.services.workspace.DocumentBuilder.waitUntil(DocumentState.Linked, waitUri);
886
+ const stopwatch = this.services.Clock.stopwatch();
887
+ const linked = this.services.workspace.DocumentBuilder.waitUntil(DocumentState.Linked, waitUri);
888
+ if ((await this.services.Clock.raceTimer(linked, this.options.referenceSettleTimeoutMs)) !== TIMED_OUT) {
889
+ return;
890
+ }
891
+ const elapsedMs = Math.round(stopwatch.elapsedMs);
892
+ // A per-URI wait resolves off a document-phase notification, so a
893
+ // missed one strands a wait on a document that HAS reached the
894
+ // phase. Re-read before failing; the workspace-wide wait has no
895
+ // equivalent reading and can only reject.
896
+ const document = waitUri ? this.services.workspace.LangiumDocuments.getDocument(waitUri) : undefined;
897
+ if (waitUri && document && document.state >= DocumentState.Linked) {
898
+ this.tracer
899
+ .withUri(waitUri.toString())
900
+ .warn(`Missed the 'Linked' notification after ${elapsedMs}ms; the document already reached it`);
901
+ return;
902
+ }
903
+ throw referenceSettleTimeoutError(elapsedMs);
904
+ }
905
+
906
+ async findReferenceCandidates(ctx: ReferenceContext): Promise<ReferenceCandidate[]> {
907
+ await this.awaitReferencesLinked(ctx.source);
748
908
  return this.resolveReferenceServices(ctx.source).CandidateProvider.find(ctx);
749
909
  }
750
910
 
751
911
  async resolveReference(ref: ReferenceRequest): Promise<ReferenceTarget<TTransfer> | undefined> {
912
+ await this.awaitReferencesLinked(ref.source);
752
913
  const resolved = this.resolveReferenceServices(ref.source).CandidateProvider.resolveCandidate(ref);
753
914
  if (!resolved) {
754
915
  return undefined;
755
916
  }
756
- const element = this.encoder.toTransfer(resolved.node) as unknown as TTransfer;
917
+ const element = this.encoder.toTransfer(resolved.node) as TTransfer;
757
918
  return { ...resolved.candidate, element };
758
919
  }
759
920
 
@@ -764,15 +925,31 @@ export class DataServer<
764
925
  // synthetic source — and the create-element flow driving this method is
765
926
  // the one that produces directory URIs, on which a bare
766
927
  // `getServices(uri)` throws while `findReferenceCandidates` succeeds.
767
- const nameProvider = this.resolveReferenceServices(ReferenceSource.synthetic(args.uri, args.type)).NameProvider;
928
+ const source = ReferenceSource.synthetic(args.uri, args.type, args.language);
929
+ // Mid-rebuild the names of documents not yet re-indexed are absent from
930
+ // the taken set, and the caller PERSISTS what it is handed. Nothing
931
+ // reserves the answer either, so a name is free of the collisions the
932
+ // index knows about and of nothing else — two callers racing get the same
933
+ // proposal, which only uniqueness at the write can catch.
934
+ await this.awaitReferencesLinked(source);
935
+ const nameProvider = this.resolveReferenceServices(source).NameProvider;
768
936
  const tier = args.tier ?? 'project';
769
937
  if (tier === 'public') {
770
938
  return nameProvider.findNextProjectQualifiedName(args.type, args.proposal);
771
939
  }
772
940
  if (tier === 'local') {
773
- // Document-scoped uniqueness: the document root is the container.
774
- const document = await this.modelService.ensureDocumentState(args.uri);
775
- return document.root ? nameProvider.findNextName(args.type, args.proposal, document.root as AstNode) : args.proposal;
941
+ // Document-scoped uniqueness: the document root is the container. A
942
+ // URI with no document has nothing to collide with, like a document
943
+ // with no root.
944
+ try {
945
+ const document = await this.modelService.ensureDocumentState(args.uri);
946
+ return document.root ? nameProvider.findNextName(args.type, args.proposal, document.root) : args.proposal;
947
+ } catch (error: unknown) {
948
+ if (this.isMissingDocument(error, args.uri)) {
949
+ return args.proposal;
950
+ }
951
+ throw error;
952
+ }
776
953
  }
777
954
  const project = this.services.workspace.ProjectManager.getProject(uri);
778
955
  if (!project) {
@@ -811,6 +988,9 @@ export class DataServer<
811
988
  /**
812
989
  * Pick the language that owns a reference source, in order:
813
990
  *
991
+ * 0. A {@link isSyntheticSource} naming its own `language` routes there.
992
+ * First because every step below infers, and an inference must not
993
+ * override a caller that has said which grammar it means.
814
994
  * 1. A URI-bearing source ({@link isDocumentSource}/{@link isSyntheticSource})
815
995
  * whose URI resolves to a registered language routes by URI.
816
996
  * 2. A single-language workspace always routes to that one language — so
@@ -829,6 +1009,15 @@ export class DataServer<
829
1009
  */
830
1010
  protected resolveReferenceLanguage(source: ReferenceSource): HydraniumLanguageServices | undefined {
831
1011
  const registry = this.services.ServiceRegistry;
1012
+ if (isSyntheticSource(source) && source.language !== undefined) {
1013
+ const declared = registry.getServicesById(source.language);
1014
+ if (declared) {
1015
+ return declared;
1016
+ }
1017
+ // Falling through on an UNREGISTERED id rather than failing: the id
1018
+ // crosses the wire, so a client built against a head with one more
1019
+ // grammar would otherwise lose queries the steps below can answer.
1020
+ }
832
1021
  // `getServicesFor` (non-throwing, one ladder walk) gates the URI lookup:
833
1022
  // an extensionless / unregistered URI falls through to the steps below
834
1023
  // rather than throwing "no services for the extension ''".
@@ -839,7 +1028,7 @@ export class DataServer<
839
1028
  }
840
1029
  const all = registry.all;
841
1030
  if (all.length === 1) {
842
- return all[0] as HydraniumLanguageServices;
1031
+ return all[0];
843
1032
  }
844
1033
  if (isElementSource(source)) {
845
1034
  const documentUri = this.findElementDocumentUri(source);
@@ -922,6 +1111,17 @@ export class DataServer<
922
1111
  // Internal plumbing
923
1112
  // ============================================================
924
1113
 
1114
+ /**
1115
+ * Whether `error`, from waiting on `uri`'s document, means that `uri` has
1116
+ * no document: a URI with neither a file nor text builds nothing, and the
1117
+ * wait after the build rejects for want of one. A
1118
+ * `ReentrantWriteLockError` never counts, since it names a call from
1119
+ * inside a write-lock holder, whose remedy its caller needs.
1120
+ */
1121
+ protected isMissingDocument(error: unknown, uri: string): boolean {
1122
+ return !(error instanceof ReentrantWriteLockError) && this.modelService.getDocument(uri) === undefined;
1123
+ }
1124
+
925
1125
  /**
926
1126
  * Build a {@link TransferDocument} envelope from the current document state,
927
1127
  * delegating root + diagnostic encoding to {@link encoder} (see
@@ -945,14 +1145,38 @@ export class DataServer<
945
1145
  // decides policy at its own layer; `root` is optional on the envelope
946
1146
  // so the compiler forces that decision. Adopters preferring to throw
947
1147
  // override `envelope`.
948
- return {
949
- uri: uri.toString(),
950
- version: 0,
951
- root: undefined,
952
- diagnostics: [] as TDiagnostic[]
953
- };
1148
+ return TransferDocument.absent<TTransfer, TDiagnostic>(uri.toString());
954
1149
  }
955
- return this.encoder.toTransferDocument<AstNode>(document) as unknown as TransferDocument<TTransfer, TDiagnostic>;
1150
+ return this.withServerState(this.encoder.toTransferDocument(document) as TransferDocument<TTransfer, TDiagnostic>);
1151
+ }
1152
+
1153
+ /**
1154
+ * The transfer document a request answers with for `astDocument`, the
1155
+ * store's current `dirty` and `textHash` stamped on it by
1156
+ * {@link withServerState}. Every document a request answers with goes
1157
+ * through here, so none goes out without the stamp.
1158
+ */
1159
+ protected encodeDocument(astDocument: AstDocument<AstNode, AstDiagnostic>): TransferDocument<TTransfer, TDiagnostic> {
1160
+ return this.withServerState(this.encoder.astDocumentToTransferDocument(astDocument) as TransferDocument<TTransfer, TDiagnostic>);
1161
+ }
1162
+
1163
+ /**
1164
+ * `document` with the store's current {@link TransferDocument.dirty} and
1165
+ * the {@link TransferDocument.textHash} of the text the server holds for
1166
+ * it: the store's text while a client has it open, the build's otherwise.
1167
+ * Both are read when the document is sent rather than kept with the build:
1168
+ * a save changes `dirty` without a rebuild, and the store's text moves on
1169
+ * before the build that follows it.
1170
+ */
1171
+ protected withServerState(document: TransferDocument<TTransfer, TDiagnostic>): TransferDocument<TTransfer, TDiagnostic> {
1172
+ const text = (
1173
+ this.services.workspace.TextDocuments.get(document.uri) ?? this.modelService.getDocument(document.uri)?.textDocument
1174
+ )?.getText();
1175
+ return {
1176
+ ...document,
1177
+ dirty: this.services.workspace.TextDocuments.isDirty(document.uri),
1178
+ ...(text === undefined ? {} : { textHash: textHash(text) })
1179
+ };
956
1180
  }
957
1181
 
958
1182
  /**
@@ -967,6 +1191,59 @@ export class DataServer<
967
1191
  this.dispatchPhaseEvent(document, cancelToken)
968
1192
  )
969
1193
  );
1194
+ // The BUILD-phase hook, not the per-document one: this notification is one
1195
+ // message per build rather than one per document, and Langium hands the
1196
+ // whole batch over here. It also does not fire for a cancelled build,
1197
+ // which is what the per-document dispatch has to check by hand.
1198
+ this.disposables.push(
1199
+ this.services.workspace.DocumentBuilder.onBuildPhase(this.options.subscriptionPhase, built => this.dispatchBuiltEvent(built))
1200
+ );
1201
+ }
1202
+
1203
+ /**
1204
+ * Report the documents that reached {@link DataServerOptions.subscriptionPhase}
1205
+ * and that NOBODY on this
1206
+ * connection is watching — the ones a client was not told about through
1207
+ * {@link dispatchPhaseEvent}, which is gated per URI.
1208
+ *
1209
+ * **The gap this closes is the one no other source can observe.** A document
1210
+ * the client watches, it hears about already. A file changed on disk, the
1211
+ * host's own filesystem watcher reports — and on a browser host, where the
1212
+ * workspace lives behind this head, an external change cannot happen at all.
1213
+ * What is left, and what nothing outside the server can see, is a document
1214
+ * rebuilt because something it DEPENDS ON changed: its file never changed, so
1215
+ * a filesystem watcher is silent by construction, and it has no subscriber, so
1216
+ * the update channel is silent by design. A consumer displaying data derived
1217
+ * from that document — a tree label, a decorator — otherwise goes stale with
1218
+ * no signal from any source, and repairs itself the moment someone opens the
1219
+ * file to investigate, which is what makes it expensive to diagnose later.
1220
+ *
1221
+ * Payload-free on purpose: URIs only, so a client re-reads what it displays
1222
+ * rather than being handed transfer documents it did not ask for. That is the
1223
+ * property the watcher gate protects, and it is preserved here by
1224
+ * carrying no document rather than by gating the message.
1225
+ *
1226
+ * Quiet in the common case. Editing a document that an editor has open leaves
1227
+ * that URI watched and therefore out of this set, so a build with no
1228
+ * dependents produces nothing at all, and workspace initialisation produces
1229
+ * nothing because it does not build to this phase. The ceiling is a
1230
+ * whole-workspace rebuild at the subscription phase: one message, URIs only.
1231
+ *
1232
+ * The URI is canonicalised for the same reason {@link uriWatchRecords} is keyed
1233
+ * that way, and is untested for the same reason as its twin in
1234
+ * {@link dispatchDeleteEvents}: the builder reports URIs out of its own
1235
+ * store, so a non-canonical one cannot be produced without a fixture
1236
+ * asserting a shape the real system never emits.
1237
+ */
1238
+ protected dispatchBuiltEvent(built: readonly LangiumDocument[]): void {
1239
+ const uris = built
1240
+ .map(document => this.canonicalKey(document.uri.toString()))
1241
+ .filter(uri => !this.uriWatchRecords.get(uri)?.watchers.size);
1242
+ if (uris.length === 0) {
1243
+ return;
1244
+ }
1245
+ this.tracer.debug(`Emit onDocumentsBuilt: ${uris.length} unwatched document(s)`);
1246
+ this.clientProxy.onDocumentsBuilt({ uris });
970
1247
  }
971
1248
 
972
1249
  /**
@@ -987,32 +1264,113 @@ export class DataServer<
987
1264
  this.disposables.push(this.services.workspace.TextDocuments.onDidSave(event => this.dispatchSaveEvent(event)));
988
1265
  }
989
1266
 
1267
+ /** Relay each change of a document's dirty state; see {@link dispatchDirtyEvent}. */
1268
+ protected subscribeToDirtyChanges(): void {
1269
+ this.disposables.push(this.services.workspace.TextDocuments.onDidChangeDirty(event => this.dispatchDirtyEvent(event)));
1270
+ }
1271
+
990
1272
  /**
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.
1273
+ * Send a dirty flip to the connection, gated on the URI's watchers as
1274
+ * {@link dispatchSaveEvent} is: the answer at any one moment travels on
1275
+ * every document sent, so a client that watches nothing reads it there.
1276
+ */
1277
+ protected dispatchDirtyEvent(event: DocumentDirtyChangedEvent): void {
1278
+ const uri = this.canonicalKey(event.uri);
1279
+ if (this.uriWatchRecords.get(uri)?.watchers.size) {
1280
+ this.clientProxy.onDocumentDirtyChanged({ uri, dirty: event.dirty });
1281
+ }
1282
+ }
1283
+
1284
+ /**
1285
+ * Mark each document the store releases after its last close, so
1286
+ * {@link dispatchPhaseEvent} broadcasts the following rebuild even without
1287
+ * a watcher. The store rebuilds such a document from its disk content,
1288
+ * discarding unsaved in-session edits, and the last close typically also
1289
+ * removed the last watcher: without the broadcast, a consumer that only
1290
+ * ever fetches via `getModelDocument` keeps showing the discarded state.
1291
+ * The broadcast is de-duplicated against the fingerprint while a watcher
1292
+ * holds one, so a close whose disk state equals the last emitted state
1293
+ * stays silent; with no watcher there is no fingerprint, and every revert
1294
+ * is sent.
1295
+ *
1296
+ * A release, not the close itself: a document whose last client lost its
1297
+ * connection is released only once the revert grace runs out, or when
1298
+ * another client opens it meanwhile, and not at all when a client lost
1299
+ * from it opens it again within its own grace.
995
1300
  */
996
1301
  protected subscribeToTextDocumentCloses(): void {
997
- const textDocuments = this.services.workspace.TextDocuments;
998
1302
  this.disposables.push(
999
- textDocuments.onDidClose(event => {
1000
- if (!textDocuments.isOpenInAnyClient(event.document.uri)) {
1001
- this.pendingRevertBroadcasts.add(this.canonicalKey(event.document.uri));
1002
- }
1303
+ this.services.workspace.TextDocuments.onDidCloseLastOpen(event => {
1304
+ const uri = this.canonicalKey(event.uri);
1305
+ const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set<string>() };
1306
+ record.revertPending = true;
1307
+ this.uriWatchRecords.set(uri, record);
1003
1308
  })
1004
1309
  );
1005
1310
  }
1006
1311
 
1007
- /** Fan out a save event for the document's URI, gated by the subscription map. */
1312
+ /**
1313
+ * Fan out a deletion for each removed URI, to EVERY client on the connection
1314
+ * rather than only to the ones watching that URI.
1315
+ *
1316
+ * **Deliberately ungated, where {@link dispatchPhaseEvent} and
1317
+ * {@link dispatchSaveEvent} are gated.** Those two carry a built document and
1318
+ * fire on every build, so the watcher gate is what keeps bandwidth
1319
+ * proportional to what a client asked for. A deletion is neither: it is one
1320
+ * URI, it is rare, and it reports the workspace's STRUCTURE rather than a
1321
+ * document's content. Gating it forces any consumer that displays the
1322
+ * workspace — a model tree, a file decorator — to learn about disappearances
1323
+ * from a filesystem watcher instead, which a client hosted in a browser has
1324
+ * no way to run: its workspace lives behind the head. A client that does not
1325
+ * care filters on the URI, which costs it a comparison.
1326
+ *
1327
+ * The precedent is the last-close revert broadcast (see
1328
+ * {@link subscribeToTextDocumentCloses}), where the same judgement was already made
1329
+ * in the other direction: a transition that matters enough is delivered
1330
+ * without a subscription.
1331
+ *
1332
+ * Runs from the `DocumentBuilder.onUpdate` listener rather than from a phase
1333
+ * listener, which is the only place a deletion is observable: `update`
1334
+ * removes the document before deriving the rebuild set, so it is never built.
1335
+ * That ordering also puts this notification ahead of the `'rebuilt'` events
1336
+ * for the dependents whose references the deletion just broke.
1337
+ *
1338
+ * The `deleted` list arrives already expanded to concrete document URIs —
1339
+ * `deleteDocuments` resolves a directory URI to the documents beneath it — so
1340
+ * no caller has to handle a directory here.
1341
+ *
1342
+ * The URI's fingerprint and revert mark are dropped: they describe a
1343
+ * document that no longer exists. A kept fingerprint is adopted as the
1344
+ * baseline and suppresses the first emit after the file returns with its
1345
+ * previous content.
1346
+ *
1347
+ * The watchers SURVIVE: a recreated file resumes delivering to them with no
1348
+ * re-subscription, and a client that answers the deletion by closing
1349
+ * releases the watch through `closeModelDocument` anyway.
1350
+ */
1351
+ protected dispatchDeleteEvents(deleted: readonly URI[]): void {
1352
+ for (const removed of deleted) {
1353
+ const uri = this.canonicalKey(removed.toString());
1354
+ const record = this.uriWatchRecords.get(uri);
1355
+ if (record) {
1356
+ record.fingerprint = undefined;
1357
+ record.revertPending = undefined;
1358
+ record.sentVersion = undefined;
1359
+ this.pruneUriWatchRecord(uri);
1360
+ }
1361
+ this.clientProxy.onDocumentDeleted({ uri });
1362
+ }
1363
+ }
1364
+
1365
+ /** Fan out a save event for the document's URI, gated on the URI's watchers. */
1008
1366
  protected dispatchSaveEvent(event: ClientTextDocumentChangeEvent<TextDocument>): void {
1009
1367
  // 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
1368
+ // symlink path S); `uriWatchRecords` and `dispatchPhaseEvent` key by the
1011
1369
  // CANONICAL identity R. Canonicalize before both the gate and the envelope so
1012
1370
  // a save of a symlinked file isn't silently dropped (and the envelope resolves
1013
1371
  // the R-keyed document rather than missing into an empty one).
1014
1372
  const uri = this.canonicalKey(event.document.uri);
1015
- if (!this.subscriptions.has(uri)) {
1373
+ if (!this.uriWatchRecords.get(uri)?.watchers.size) {
1016
1374
  return;
1017
1375
  }
1018
1376
  const response = this.envelope(UriUtils.toUri(uri));
@@ -1032,13 +1390,25 @@ export class DataServer<
1032
1390
  * out to multiple local subscribers with an `Emitter<T>` — the
1033
1391
  * framework deliberately does NOT promise multi-listener semantics.
1034
1392
  *
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.
1393
+ * An event for a URI no client watches is NOT sent over the wire, so
1394
+ * bandwidth scales with watched URIs rather than with phase events; a
1395
+ * pending revert mark is the exception (see
1396
+ * {@link subscribeToTextDocumentCloses}).
1397
+ *
1398
+ * An event for a rebuild with no observable change since the last emit is
1399
+ * suppressed against the URI's fingerprint. Such rebuilds are routine: a
1400
+ * second client attaching to an open document makes
1401
+ * `HydraniumTextDocuments.refreshContent` fire `onDidChangeContent` purely
1402
+ * to re-trigger the build, and Langium rebuilds a document when a
1403
+ * dependency changes even if its diagnostics come out the same. Sent at a
1404
+ * version this head has not sent, they reach watchers as `'changed'`, and a
1405
+ * watcher that reads `'changed'` as another client's write and resets its
1406
+ * root to the server view loses the user's edits. The first {@link watchModelDocument} baselines the
1407
+ * fingerprint, so the first event after a watch is de-duplicated against
1408
+ * the state the watcher just fetched; it goes with the last watcher, so the
1409
+ * next first watch re-baselines rather than adopting a stale digest. A
1410
+ * digest keeps its memory constant in document size; see
1411
+ * {@link computeDocumentFingerprint} for the inputs.
1042
1412
  */
1043
1413
  protected dispatchPhaseEvent(document: LangiumDocument, cancelToken: CancellationToken): void {
1044
1414
  if (cancelToken.isCancellationRequested) {
@@ -1050,16 +1420,23 @@ export class DataServer<
1050
1420
  return;
1051
1421
  }
1052
1422
  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) {
1423
+ const record = this.uriWatchRecords.get(uri);
1424
+ const revertedOnClose = record?.revertPending === true;
1425
+ if (!record || (record.watchers.size === 0 && !revertedOnClose)) {
1059
1426
  return;
1060
1427
  }
1428
+ if (revertedOnClose) {
1429
+ // Consumed even when watchers exist — the regular dispatch below
1430
+ // serves them, and the mark's attribution is more precise than the
1431
+ // post-close unknown client the manager's attribution would yield.
1432
+ // With no watcher the record goes now, so the fingerprint written
1433
+ // below lands on a detached record and the next first watch
1434
+ // re-baselines instead of adopting it.
1435
+ record.revertPending = undefined;
1436
+ this.pruneUriWatchRecord(uri);
1437
+ }
1061
1438
  const fingerprint = this.computeDocumentFingerprint(document);
1062
- if (this.lastEmittedFingerprint.get(uri) === fingerprint) {
1439
+ if (record.fingerprint === fingerprint) {
1063
1440
  // A rebuild that produced no observable change since the last emit —
1064
1441
  // suppressed so RPC subscribers don't see a no-op broadcast. Logged at
1065
1442
  // debug so a *needed* re-broadcast wrongly suppressed by this dedup
@@ -1067,11 +1444,20 @@ export class DataServer<
1067
1444
  this.tracer.withUri(uri).debug(`Suppress onDocumentUpdated v${document.textDocument.version}: fingerprint unchanged`);
1068
1445
  return;
1069
1446
  }
1070
- this.lastEmittedFingerprint.set(uri, fingerprint);
1447
+ record.fingerprint = fingerprint;
1448
+ // The manager's attribution, so this head names the same client as the
1449
+ // in-process heads do for one build, except for a version this head
1450
+ // already sent; see `DataServerUriWatchRecord.sentVersion`.
1451
+ const version = this.services.workspace.AstDocumentManager.isOpen(uri) ? document.textDocument.version : undefined;
1452
+ const { reason, sourceClientId } =
1453
+ version !== undefined && record.sentVersion === version
1454
+ ? { reason: 'rebuilt' as const, sourceClientId: UNKNOWN_CLIENT_ID }
1455
+ : this.services.workspace.AstDocumentManager.attributeUpdate(document);
1456
+ record.sentVersion = version;
1071
1457
  const event: TransferDocumentUpdatedEvent<TTransfer, TDiagnostic> = {
1072
1458
  document: this.envelope(document.uri),
1073
- sourceClientId: revertedOnClose ? REVERT_ON_CLOSE_CLIENT_ID : this.resolveSourceClientId(document),
1074
- reason: this.resolveUpdateReason(document.uri)
1459
+ sourceClientId: revertedOnClose ? REVERT_ON_CLOSE_CLIENT_ID : sourceClientId,
1460
+ reason
1075
1461
  };
1076
1462
  this.tracer
1077
1463
  .withUri(uri)
@@ -1101,7 +1487,7 @@ export class DataServer<
1101
1487
  ? textDiagnosticsFingerprint(document)
1102
1488
  : transferDocumentFingerprint(this.encoder.toTransferDocument(document));
1103
1489
  const extra = this.additionalFingerprintInputs(document);
1104
- return extra.length === 0 ? base : fingerprintHash([base, FINGERPRINT_SEPARATOR, ...extra.map(value => JSON.stringify(value))]);
1490
+ return extra.length === 0 ? base : textHash([base, FINGERPRINT_SEPARATOR, ...extra.map(value => JSON.stringify(value))]);
1105
1491
  },
1106
1492
  'debug',
1107
1493
  { logAfterMs: FINGERPRINT_LOG_AFTER_MS }
@@ -1119,31 +1505,6 @@ export class DataServer<
1119
1505
  return [];
1120
1506
  }
1121
1507
 
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
1508
  /**
1148
1509
  * Subscribe to the project tier's change channel and re-fan registry
1149
1510
  * diffs into per-project wire notifications. The internal
@@ -1187,20 +1548,6 @@ export class DataServer<
1187
1548
  }
1188
1549
  }
1189
1550
 
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
1551
  // --- Diagnostics (DataServerDiagnosticsProtocol) ---------------------------
1205
1552
  // Computed in THIS process: the data-server child holds the model store, so
1206
1553
  // these snapshots reflect the heap that actually carries the workspace
@@ -1243,7 +1590,7 @@ export class DataServer<
1243
1590
 
1244
1591
  async stopProfiling(args: StopProfilingArgs): Promise<string> {
1245
1592
  if (!this.activeProfile) {
1246
- throw new Error('No profiling capture is active; call startProfiling first.');
1593
+ throw noActiveProfileError();
1247
1594
  }
1248
1595
  const capture = this.activeProfile;
1249
1596
  this.activeProfile = undefined;
@@ -1262,7 +1609,7 @@ export class DataServer<
1262
1609
  /** Resolve a partial options object into a fully-defaulted form. */
1263
1610
  protected resolveOptions(partial: DataServerOptions): ResolvedDataServerOptions {
1264
1611
  const additionalMethods = partial.additionalMethods ?? [];
1265
- const builtIn = [...DATA_SERVER_PROTOCOL_METHODS, ...DATA_SERVER_DIAGNOSTICS_METHODS] as readonly string[];
1612
+ const builtIn: readonly string[] = [...DATA_SERVER_PROTOCOL_METHODS, ...DATA_SERVER_DIAGNOSTICS_METHODS];
1266
1613
  const overlap = additionalMethods.filter(name => builtIn.includes(name));
1267
1614
  if (overlap.length > 0) {
1268
1615
  throw new Error(
@@ -1276,7 +1623,8 @@ export class DataServer<
1276
1623
  methodNamespace: partial.methodNamespace ?? DATA_SERVER_WIRE_PREFIX,
1277
1624
  additionalMethods,
1278
1625
  excludedMethods: partial.excludedMethods ?? [],
1279
- diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics()
1626
+ diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics(),
1627
+ referenceSettleTimeoutMs: partial.referenceSettleTimeoutMs ?? DataServer.DEFAULT_OPTIONS.referenceSettleTimeoutMs
1280
1628
  };
1281
1629
  }
1282
1630
  }