@hydranium/data-server 1.0.0-next.19 → 1.0.0-next.193

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.
@@ -6,11 +6,43 @@
6
6
  *
7
7
  * SPDX-License-Identifier: MIT
8
8
  ********************************************************************************/
9
- import { createRpcProxy, DisposableCollection, isDocumentSource, isElementSource, isSyntheticSource, ReferenceSource } from '@hydranium/protocol';
9
+ import { createRpcProxy, defineMessage, DisposableCollection, HYDRANIUM_ERROR_CODES, isDocumentSource, isElementSource, isSyntheticSource, messageData, messageError, ReferenceSource, SessionClosedError, TIMED_OUT, TransferDocument, UNKNOWN_CLIENT_ID, textHash } from '@hydranium/protocol';
10
10
  import { DATA_SERVER_DIAGNOSTICS_METHODS, DATA_SERVER_PROTOCOL_METHODS, DATA_SERVER_WIRE_PREFIX } from '@hydranium/protocol/data';
11
- import { REVERT_ON_CLOSE_CLIENT_ID, UNKNOWN_CLIENT_ID } from '@hydranium/core';
11
+ import { REVERT_ON_CLOSE_CLIENT_ID } from '@hydranium/core';
12
12
  import { defaultDataServerDiagnostics } from './default-diagnostics.js';
13
+ /**
14
+ * Raised when a profiling command arrives with no capture running.
15
+ *
16
+ * A `ResponseError` rather than a plain `Error` so the identity survives to the
17
+ * response boundary, which is where the message is rendered. An unwrapped throw
18
+ * reaches the client as a generic internal error instead: no code for a caller
19
+ * to switch on, and nothing for the boundary to render from.
20
+ */
21
+ export const NO_ACTIVE_PROFILE = defineMessage('hydranium/data-server/no-active-profile', 'No profiling capture is active; call startProfiling first.');
22
+ /**
23
+ * The JSON-RPC code, unrelated to the catalogue code above: this one is numeric,
24
+ * survives reconstruction and is what a caller switches on.
25
+ */
26
+ export const NO_ACTIVE_PROFILE_CODE = HYDRANIUM_ERROR_CODES.noActiveProfile;
27
+ export const noActiveProfileError = () => messageError(NO_ACTIVE_PROFILE_CODE, NO_ACTIVE_PROFILE);
28
+ /**
29
+ * Raised when a reference question's wait for the build exceeds
30
+ * {@link DataServerOptions.referenceSettleTimeoutMs}.
31
+ *
32
+ * A `ResponseError` because a class name does not cross RPC: without the code a
33
+ * wire client cannot tell a wedged build from a reference that resolves to
34
+ * nothing, which is the distinction the wait exists to keep.
35
+ */
36
+ export const REFERENCE_SETTLE_TIMEOUT = defineMessage('hydranium/data-server/reference-settle-timeout', 'The model is still being processed; try again in a moment.');
37
+ /** See {@link NO_ACTIVE_PROFILE_CODE} for why this is separate from the catalogue code. */
38
+ export const REFERENCE_SETTLE_TIMEOUT_CODE = HYDRANIUM_ERROR_CODES.referenceSettleTimeout;
39
+ /** The wait's length rides in `data` as `elapsedMs`, for the code that reacts rather than the reader. */
40
+ export const referenceSettleTimeoutError = (elapsedMs) => new ResponseError(REFERENCE_SETTLE_TIMEOUT_CODE, REFERENCE_SETTLE_TIMEOUT.format(), {
41
+ elapsedMs,
42
+ ...messageData(REFERENCE_SETTLE_TIMEOUT)
43
+ });
13
44
  import { DocumentState, UriUtils } from '@hydranium/langium';
45
+ import { ResponseError } from 'vscode-jsonrpc';
14
46
  /**
15
47
  * Domain separator between text and diagnostics inputs of
16
48
  * {@link DataServer.computeDocumentFingerprint}'s hash. A single NUL byte is
@@ -19,47 +51,31 @@ import { DocumentState, UriUtils } from '@hydranium/langium';
19
51
  */
20
52
  const FINGERPRINT_SEPARATOR = '\0';
21
53
  /**
22
- * Portable, non-cryptographic 64-bit fingerprint hash (cyrb53), returning a
23
- * 16-char hex digest.
24
- *
25
- * **A cryptographic hash via `node:crypto` is the wrong trade**: the
26
- * fingerprint only needs a stable signal that `(text, diagnostics)` changed
27
- * between emissions, and a `node:*` import would cost
28
- * `@hydranium/data-server` its browser-portability. Parts are fed
29
- * incrementally, char by char, so multi-MB document text is never
30
- * concatenated into one string.
54
+ * `LSPErrorCodes.ServerCancelled`, with which Langium's document wait rejects
55
+ * for a URI that has no document; `vscode-languageserver-protocol` is not a
56
+ * dependency of this package.
31
57
  */
32
- function fingerprintHash(parts) {
33
- let h1 = 0xdeadbeef;
34
- let h2 = 0x41c6ce57;
35
- for (const part of parts) {
36
- for (let i = 0; i < part.length; i++) {
37
- const ch = part.charCodeAt(i);
38
- h1 = Math.imul(h1 ^ ch, 2654435761);
39
- h2 = Math.imul(h2 ^ ch, 1597334677);
40
- }
41
- }
42
- h1 = Math.imul(h1 ^ (h1 >>> 16), 2246822507);
43
- h1 ^= Math.imul(h2 ^ (h2 >>> 13), 3266489909);
44
- h2 = Math.imul(h2 ^ (h2 >>> 16), 2246822507);
45
- h2 ^= Math.imul(h1 ^ (h1 >>> 13), 3266489909);
46
- const high = (h2 >>> 0).toString(16).padStart(8, '0');
47
- const low = (h1 >>> 0).toString(16).padStart(8, '0');
48
- return high + low;
49
- }
50
- /** Hash a document's raw text + diagnostics — the `'text-diagnostics'` strategy. */
51
- function textDiagnosticsFingerprint(document) {
52
- return fingerprintHash([document.textDocument.getText(), FINGERPRINT_SEPARATOR, JSON.stringify(document.diagnostics ?? [])]);
58
+ const SERVER_CANCELLED = -32802;
59
+ const resumableByModelService = new WeakMap();
60
+ /**
61
+ * Hash `text`, the text the model was parsed from, + `model`'s diagnostics — the `'text-diagnostics'` strategy.
62
+ * The text comes from the root's ledger record or CST, as the document's own may have moved on,
63
+ * and a repair in place leaves the CST on the unrepaired text;
64
+ * a root built without a CST hashes as `'transfer-document'`.
65
+ * Absent diagnostics must hash apart from `[]`, as in {@link transferDocumentFingerprint}.
66
+ */
67
+ function textDiagnosticsFingerprint(text, model) {
68
+ return text === undefined
69
+ ? transferDocumentFingerprint(model)
70
+ : textHash([text, FINGERPRINT_SEPARATOR, JSON.stringify(model.diagnostics ?? null)]);
53
71
  }
54
- /** Hash an encoded transfer document's root + diagnostics — the `'transfer-document'` strategy. */
55
- function transferDocumentFingerprint(transferDocument) {
56
- // null, not undefined: `JSON.stringify(undefined)` yields undefined rather
57
- // than a string, putting a non-string into the hash inputs.
58
- return fingerprintHash([
59
- JSON.stringify(transferDocument.root ?? null),
60
- FINGERPRINT_SEPARATOR,
61
- JSON.stringify(transferDocument.diagnostics)
62
- ]);
72
+ /**
73
+ * Hash an encoded model's root + diagnostics — the `'transfer-document'` strategy.
74
+ * Absent diagnostics must hash apart from `[]`: a client skipping a render on an
75
+ * equal hash would otherwise miss a validation that found nothing.
76
+ */
77
+ function transferDocumentFingerprint(model) {
78
+ return textHash([JSON.stringify(model.root), FINGERPRINT_SEPARATOR, JSON.stringify(model.diagnostics ?? null)]);
63
79
  }
64
80
  /**
65
81
  * `logAfterMs` threshold passed to {@link Tracer.time} around
@@ -90,13 +106,19 @@ const FINGERPRINT_LOG_AFTER_MS = 5;
90
106
  * adopters subclass ONLY when they need to decorate wire returns or
91
107
  * notifications. The usual adoption path is DI rebinds alone.
92
108
  *
109
+ * **`TTransfer` is not checked.** It declares the union of the transfer roots
110
+ * the workspace's languages produce. Which root a document has is known only
111
+ * at runtime, from its language, so a `TTransfer` missing a language compiles.
112
+ *
93
113
  * Lifecycle: the constructor registers framework request handlers (plus
94
114
  * any names supplied via {@link DataServerOptions.additionalMethods}) and
95
115
  * builds the {@link DataClientProtocol} notification proxy on the same
96
116
  * connection in one {@link createRpcProxy} call (binding `this` as its
97
- * `localTarget`) under the configured namespace, and subscribes one
98
- * `DocumentBuilder.onDocumentPhase` listener per configured phase that
99
- * dispatches subscription events via `clientProxy.onDocumentUpdated`.
117
+ * `localTarget`) under the configured namespace, and subscribes two listeners
118
+ * at the configured phase: a `DocumentBuilder.onDocumentPhase` one dispatching
119
+ * per-document `clientProxy.onDocumentUpdated` for watched URIs, and a
120
+ * `DocumentBuilder.onBuildPhase` one dispatching a single
121
+ * `clientProxy.onDocumentsBuilt` naming the batch's unwatched documents.
100
122
  *
101
123
  * The data-server requires the full {@link ServerSharedServices}
102
124
  * shape — `HydraniumTextDocuments` for client-attributed updates,
@@ -121,85 +143,25 @@ export class DataServer {
121
143
  * extending rather than restate a value the framework may change.
122
144
  */
123
145
  static DEFAULT_OPTIONS = {
124
- subscriptionPhase: DocumentState.Validated
146
+ subscriptionPhase: DocumentState.Validated,
147
+ referenceSettleTimeoutMs: 60_000
125
148
  };
126
149
  options;
127
- /** Subscription bookkeeping: URI → set of clientIds that subscribed for that URI. */
128
- subscriptions = new Map();
150
+ /** This connection's {@link DataServerUriWatchRecord} per canonical URI; see there for when a record lives. */
151
+ uriWatchRecords = new Map();
129
152
  /**
130
- * Open-document bookkeeping: URI → set of clientIds that opened it over THIS
131
- * connection.
153
+ * The client sessions this connection registered, by client id. A document
154
+ * request carrying one of these ids acts as that session; one carrying any
155
+ * other id fails.
132
156
  *
133
- * Kept because the document store releases a client's hold only from an
134
- * explicit close, and a client that dies without closing would otherwise keep
135
- * the document open forever — resident, and with its last-close revert
136
- * suppressed. The store has no notion of which connection a clientId reached
137
- * it over, so the connection-scoped set has to live here; teaching it a client
138
- * identity is the more robust and much larger alternative.
139
- */
140
- openedDocuments = new Map();
157
+ * Entries stay after {@link dispose} has ended their sessions, so a request
158
+ * still running from before the connection closed reaches the ended handle
159
+ * and fails with the session's own error.
160
+ */
161
+ clientSessions = new Map();
141
162
  /** Typed client proxy — sends `data-server/on*` notifications back over the same wire. */
142
163
  clientProxy;
143
164
  disposables = new DisposableCollection();
144
- /**
145
- * Snapshot of the most recent `DocumentBuilder.onUpdate` event. Drives
146
- * `reason` discrimination on outbound `onDocumentUpdated` notifications:
147
- * a URI in the `changed` list emits `'changed'`, in `deleted` emits
148
- * `'deleted'`, otherwise `'rebuilt'` (cascade rebuild from a dependent
149
- * URI's change). The same mechanism `AstDocumentManager.onUpdate` uses on
150
- * the LSP side, so reason fidelity stays consistent between heads.
151
- */
152
- lastBuildUpdate;
153
- /**
154
- * Per-URI hash of the last emitted (text + diagnostics) state,
155
- * used by {@link dispatchPhaseEvent} to suppress duplicate
156
- * `onDocumentUpdated` notifications for rebuilds that produce no
157
- * observable change since the last emit.
158
- *
159
- * Two scenarios routinely produce such rebuilds:
160
- * 1. **Refresh-triggered rebuilds.** When a second client attaches to a
161
- * document already open in another client,
162
- * `HydraniumTextDocuments.refreshContent` fires `onDidChangeContent`
163
- * purely to re-trigger the build pipeline — the text and diagnostics
164
- * are identical to the prior emit.
165
- * 2. **Cascade rebuilds with no diagnostic delta.** Langium rebuilds a
166
- * document when a dependency changes; if the rebuild produces the
167
- * same diagnostics, there is nothing new to communicate to subscribers.
168
- *
169
- * Without this filter, both scenarios reach subscribers as wire-side
170
- * `'changed'` events. A subscriber that interprets `'changed'` as
171
- * "another client wrote new content" and resets its in-memory root to
172
- * the server view then misreads the spurious event as a concurrent
173
- * third-party write and loses the user's edits.
174
- *
175
- * Initialised on {@link watchModelDocument} to the current
176
- * document fingerprint so the FIRST phase event after a fresh
177
- * subscription is also de-duplicated against the state subscribers
178
- * obtained via `getModelDocument` — they do not need a redundant phase
179
- * notification for the state they just fetched.
180
- *
181
- * Cleared in {@link unwatchModelDocument} when the last
182
- * subscriber for a URI leaves so memory does not accumulate.
183
- *
184
- * Stored as a cyrb53 hex digest (16 chars per URI) rather than the raw
185
- * text + diagnostics serialisation so the memory cost is constant in
186
- * document size. See {@link computeDocumentFingerprint} for the inputs.
187
- */
188
- lastEmittedFingerprint = new Map();
189
- /**
190
- * URIs whose LAST client just closed. The update handler rebuilds such a
191
- * document from its disk content (discarding unsaved in-session edits),
192
- * but {@link dispatchPhaseEvent} gates on the subscription map — and the
193
- * last close typically also removed the last watcher, so consumers that
194
- * only ever fetch via `getModelDocument` would keep showing the
195
- * discarded state forever. Marked on the last-close transition (see
196
- * {@link subscribeToTextDocumentCloses}) and consumed by
197
- * {@link dispatchPhaseEvent}, which broadcasts the following rebuild's
198
- * phase event even without a subscription — de-duplicated against
199
- * {@link lastEmittedFingerprint} where an entry survives, so a close
200
- * whose disk state equals the last emitted state stays silent.
201
- */
202
- pendingRevertBroadcasts = new Set();
203
165
  tracer;
204
166
  /** The in-flight interactive profile capture, held between {@link startProfiling} and {@link stopProfiling}. */
205
167
  activeProfile;
@@ -211,11 +173,8 @@ export class DataServer {
211
173
  encoder;
212
174
  /**
213
175
  * In-process workspace facade — the lifecycle delegate `get` / `update` / `save` go through.
214
- * The facade's AstDocument diagnostic shape is intentionally typed `unknown` here: adopters
215
- * carry LSP-shape diagnostics in their AstDocument (e.g. an adopter's LSP-shape diagnostic type)
216
- * while the wire shape stays `TDiagnostic extends TransferDiagnostic`. The encoder's
217
- * `astDocumentToTransferDocument` accepts both shapes (wire-shape or LSP-shape) and projects
218
- * to wire shape on the return — see `TransferEncoder.astDocumentToTransferDocument`.
176
+ * Its documents carry the AST-layer {@link AstDiagnostic}, never the wire `TDiagnostic`:
177
+ * {@link encoder} converts one into the other on the way out.
219
178
  */
220
179
  modelService;
221
180
  constructor(connection, services, options = {}) {
@@ -224,8 +183,7 @@ export class DataServer {
224
183
  this.options = this.resolveOptions(options);
225
184
  this.tracer = this.services.Tracer.for(options.logName ?? 'DataServer').trace('instantiated');
226
185
  // DI-bound: adopters rebind `services.model.TransferEncoder` /
227
- // `services.model.ModelService` with their own subclasses. Slot types use the
228
- // framework upper bounds; the casts below narrow to this instance's generics.
186
+ // `services.model.ModelService` with their own subclasses.
229
187
  const { TransferEncoder: encoder, ModelService: modelService } = this.services.model;
230
188
  if (!encoder || !modelService) {
231
189
  throw new Error('DataServer requires `services.model.TransferEncoder` and `services.model.ModelService` to be bound. ' +
@@ -248,35 +206,42 @@ export class DataServer {
248
206
  methodNamespace: this.options.methodNamespace,
249
207
  localTarget: this,
250
208
  localMethods: registeredMethods,
251
- latency: this.latency
209
+ latency: this.latency,
210
+ // Bound at the chokepoint rather than per handler, so an adopter's
211
+ // `additionalMethods` are rendered on the same terms as the
212
+ // framework's own rejections.
213
+ renderErrorMessage: error => this.services.MessageRenderer.renderError(error)
252
214
  });
253
- this.disposables.push(this.services.workspace.DocumentBuilder.onUpdate((changed, deleted) => {
254
- this.lastBuildUpdate = { changed, deleted };
255
- }));
215
+ this.disposables.push(this.services.workspace.DocumentBuilder.onUpdate((_changed, deleted) => this.dispatchDeleteEvents(deleted)));
256
216
  this.subscribeToDocumentBuilder();
257
217
  this.subscribeToTextDocumentSaves();
218
+ this.subscribeToDirtyChanges();
258
219
  this.subscribeToTextDocumentCloses();
259
220
  this.subscribeToProjectManager();
260
221
  // Self-register teardown so an adopter that keeps no reference to the
261
222
  // server still releases per-connection state, with no lifecycle hook of
262
- // its own. See `dispose`.
263
- this.disposables.push(connection.onClose(() => this.dispose()));
223
+ // its own. The client did not close anything itself, so its sessions end
224
+ // as lost and each document it was the last to have open waits out the
225
+ // store's revert grace. See `dispose`.
226
+ this.disposables.push(connection.onClose(() => this.dispose('lost')));
264
227
  }
265
228
  /**
266
229
  * Release everything the constructor wired up — the bound protocol
267
- * handlers and every listener — and clear the subscription map and the
268
- * per-URI emission-fingerprint cache, so a long-lived shared services
269
- * bundle does not retain per-connection memory after the connection
270
- * closes. Also closes every document still open over this connection (see
271
- * {@link closeOpenDocuments}), which is the SHARED store's state rather than
272
- * this server's and so outlives the connection unless released here.
230
+ * handlers and every listener — and clear {@link uriWatchRecords}, so a
231
+ * long-lived shared services bundle does not retain per-connection memory
232
+ * after the connection closes. Also ends every session this connection registered, which closes
233
+ * every document it has open: the SHARED store's state rather than this
234
+ * server's, which outlives the connection unless released here.
273
235
  *
274
- * Idempotent: subsequent calls are no-ops. Self-fires on
275
- * `connection.onClose` so adopters who don't hold a reference still
276
- * get per-connection cleanup; adopters that DO hold a reference may
277
- * call `dispose()` directly for early teardown.
236
+ * Idempotent: subsequent calls are no-ops. Runs by itself when the
237
+ * connection closes, so adopters who don't hold a reference still get
238
+ * per-connection cleanup; adopters that DO hold a reference may call
239
+ * `dispose()` directly for early teardown. The sessions end with `cause`:
240
+ * `'closed'` reverts every document whose last open they close at once,
241
+ * and `'lost'`, the connection's own close, lets each wait out the revert
242
+ * grace.
278
243
  */
279
- dispose() {
244
+ dispose(cause = 'closed') {
280
245
  this.disposed = true;
281
246
  // Release an in-flight interactive capture so the process-wide inspector
282
247
  // singleton is not left active after the connection closes.
@@ -285,97 +250,155 @@ export class DataServer {
285
250
  this.activeProfile = undefined;
286
251
  void capture.stop({}).catch(() => undefined);
287
252
  }
288
- // AFTER `disposables.dispose()`, deliberately: closing a document fires
289
- // `onDidClose`, and this server's own close listener would otherwise mark a
290
- // revert broadcast for a connection that is already gone.
253
+ // AFTER `disposables.dispose()`, deliberately: ending a session releases
254
+ // each document it was the last to hold, and this server's own
255
+ // `onDidCloseLastOpen` listener would otherwise mark a revert broadcast
256
+ // for a connection that is already gone.
291
257
  this.disposables.dispose();
292
- this.closeOpenDocuments();
293
- this.subscriptions.clear();
294
- this.lastEmittedFingerprint.clear();
295
- this.pendingRevertBroadcasts.clear();
258
+ for (const [clientId, session] of this.clientSessions) {
259
+ this.endSession(clientId, session, cause);
260
+ }
261
+ this.uriWatchRecords.clear();
296
262
  }
297
263
  // ============================================================
298
- // DataServerProtocol implementation — delegates to ModelService.
264
+ // DataServerProtocol implementation
299
265
  // ============================================================
300
266
  //
301
- // The lifecycle methods (`get` / `update` / `save` / `ready`) forward
302
- // straight to `ModelService` and encode the returned `AstDocument` on
303
- // the wire boundary via `encoder.astDocumentToTransferDocument`.
304
- // Adopters customising lifecycle behaviour (normalisation, supersession,
305
- // settled-phase choice, etc.) override on the ModelService subclass —
306
- // no override on DataServer is needed.
307
- async openModelDocument(args) {
308
- // Register the editor session (idempotent — `ModelService.open` refreshes
309
- // an already-open document rather than re-opening), then return the built
310
- // state at the configured target phase. The one-shot snapshot; subsequent
311
- // build-phase events arrive via `watchModelDocument`.
312
- await this.modelService.open(args);
313
- // Record the hold so `dispose` can release it for a client that never
314
- // closes. Keyed by the URI as given, because that is what `close` takes.
315
- let holders = this.openedDocuments.get(args.uri);
316
- if (!holders) {
317
- holders = new Set();
318
- this.openedDocuments.set(args.uri, holders);
319
- }
320
- holders.add(args.clientId);
321
- const document = await this.getModelDocument({ uri: args.uri });
322
- // Project the authoritative client-facing version onto the open snapshot.
323
- // `getModelDocument` encodes the freshly-built AST snapshot, whose version
324
- // is the `LangiumDocument`'s own `textDocument.version`. That lags the
325
- // multi-client synced version whenever the open seeded the synced document
326
- // with a caller-supplied version id — and the synced version is what
327
- // `ModelService.update`'s optimistic-concurrency gate compares
328
- // `baseVersion` against, so reporting the snapshot's would make the
329
- // caller's first tagged write self-conflict. A genuine concurrent edit
330
- // still trips the gate and is reconciled by the caller's replay rather
331
- // than predicted here.
332
- return { ...document, version: this.services.workspace.TextDocuments.version(args.uri) };
333
- }
334
- async closeModelDocument(args) {
335
- // Closing a session also releases its watch for (uri, clientId) — a
336
- // forgotten unwatch would otherwise leak phase-event dispatch until the
337
- // connection closes. Idempotent: a close without a prior watch is a no-op.
338
- await this.unwatchModelDocument({ uri: args.uri, clientId: args.clientId });
339
- this.forgetOpenDocument(args.uri, args.clientId);
340
- await this.modelService.close(args);
267
+ // Reads go to `ModelService`; a request that opens or writes a document
268
+ // goes to the session this connection registered under its `clientId`.
269
+ // Each answer is encoded on the wire boundary via
270
+ // `encoder.astDocumentToTransferDocument`. To change how documents are
271
+ // read, override on the ModelService subclass; to change how they are
272
+ // written, on the session class the bound `ClientSessionFactory` builds.
273
+ async createSession(args) {
274
+ // After teardown nothing would ever end a session registered now, and its
275
+ // id would stay taken for the life of the process.
276
+ if (this.disposed) {
277
+ throw new SessionClosedError(args.clientId);
278
+ }
279
+ const resumable = this.resumableSessions();
280
+ const previous = resumable.get(args.clientId);
281
+ if (previous && args.resumeToken !== undefined && previous.token === args.resumeToken) {
282
+ previous.end();
283
+ }
284
+ const session = this.modelService.createSession(args.label, args.clientId);
285
+ this.clientSessions.set(args.clientId, session);
286
+ if (args.resumeToken !== undefined) {
287
+ // Taken over by a client registering again after its connection
288
+ // dropped, so the old session ends as lost: the documents it was the
289
+ // last to have open wait out the grace, and the new session's opens
290
+ // find their unsaved text.
291
+ resumable.set(args.clientId, { token: args.resumeToken, end: () => this.endSession(args.clientId, session, 'lost') });
292
+ }
341
293
  }
342
294
  /**
343
- * Drop the recorded hold for `(uri, clientId)` so {@link dispose} does not
344
- * close it a second time. Idempotent.
295
+ * End a session this connection registered. The ended handle stays in
296
+ * {@link clientSessions}, as it does after {@link dispose}, so a request for
297
+ * the id still arriving fails with the ended session's own error.
345
298
  */
346
- forgetOpenDocument(uri, clientId) {
347
- const holders = this.openedDocuments.get(uri);
348
- if (!holders) {
349
- return;
299
+ async closeSession(args) {
300
+ const session = this.clientSessions.get(args.clientId);
301
+ if (session) {
302
+ this.endSession(args.clientId, session);
350
303
  }
351
- holders.delete(clientId);
352
- if (holders.size === 0) {
353
- this.openedDocuments.delete(uri);
304
+ }
305
+ /** End `session`, registered here under `clientId`, with `cause`, and drop its watches on this connection. */
306
+ endSession(clientId, session, cause = 'closed') {
307
+ for (const [uri, record] of this.uriWatchRecords) {
308
+ if (record.watchers.delete(clientId)) {
309
+ this.pruneUriWatchRecord(uri);
310
+ }
354
311
  }
312
+ session.dispose(cause);
355
313
  }
356
314
  /**
357
- * Close every document still open over this connection, for the clients that
358
- * opened it here.
359
- *
360
- * The document store releases a per-URI hold only from an explicit close, so
361
- * without this a client that dies mid-session keeps its documents open for the
362
- * lifetime of the process: `isOpenInAnyClient` stays true, the document stays
363
- * resident, and the last-close revert never runs. A long-lived multi-client
364
- * head is the configuration where a dead client is normal rather than
365
- * exceptional, so the leak accumulates there.
315
+ * The resumable sessions of this services tree, by client id, across all of
316
+ * its data connections: a client resumes on another connection than the one
317
+ * that registered it. An entry leaves when its session ends, by any path, so
318
+ * it keeps no ended connection alive.
366
319
  *
367
- * Runs from {@link dispose}, which is synchronous, so each close is fired and
368
- * its failure swallowed — a teardown must not reject, and a URI whose close
369
- * fails is no worse off than it was before this drain existed.
370
- */
371
- closeOpenDocuments() {
372
- const held = [...this.openedDocuments];
373
- this.openedDocuments.clear();
374
- for (const [uri, clientIds] of held) {
375
- for (const clientId of clientIds) {
376
- void Promise.resolve(this.modelService.close({ uri, clientId })).catch(() => undefined);
377
- }
320
+ * A takeover by resume token ends the old session even when its connection
321
+ * is still alive, so two clients that shared an id and its token would end
322
+ * each other's sessions. And the token is a guard against colliding with a
323
+ * session the server has not yet seen end, not a secret: the wire carries no
324
+ * authentication, and a peer that learns the token can end the session.
325
+ */
326
+ resumableSessions() {
327
+ let sessions = resumableByModelService.get(this.modelService);
328
+ if (!sessions) {
329
+ const created = new Map();
330
+ // Subscribed once per services tree, and never disposed: it lives as
331
+ // long as the text store it listens to.
332
+ this.services.workspace.TextDocuments.onDidCloseSession(event => created.delete(event.clientId));
333
+ resumableByModelService.set(this.modelService, created);
334
+ sessions = created;
335
+ }
336
+ return sessions;
337
+ }
338
+ async createModelDocument(args) {
339
+ const session = this.requireSession(args.clientId);
340
+ await session.create(args.uri, args.text);
341
+ return this.openedSnapshot(args.uri, () => session.close(args.uri));
342
+ }
343
+ async updateModelDocuments(args) {
344
+ const astDocuments = await this.requireSession(args.clientId).updateAll({
345
+ updates: args.updates.map(update => this.toSessionWrite(update))
346
+ });
347
+ return astDocuments.map(astDocument => this.encodeDocument(astDocument));
348
+ }
349
+ /**
350
+ * The session write a wire write request carries. Only the fields a session
351
+ * takes: a field an adopter adds to a request reaches the session only
352
+ * through an override of this.
353
+ */
354
+ toSessionWrite(request) {
355
+ return { uri: request.uri, model: request.model, baseVersion: request.baseVersion };
356
+ }
357
+ /**
358
+ * The session this connection registered under `clientId`, which every
359
+ * document request acts as. An id that is not one fails with the
360
+ * closed-session code: opening or writing under it would leave an open that
361
+ * no session end ever closes.
362
+ */
363
+ requireSession(clientId) {
364
+ const session = this.clientSessions.get(clientId);
365
+ if (!session) {
366
+ throw new SessionClosedError(clientId, 'The client session was never registered on this connection.');
378
367
  }
368
+ return session;
369
+ }
370
+ async openModelDocument(args) {
371
+ const session = this.requireSession(args.clientId);
372
+ const wasOpen = this.services.workspace.TextDocuments.isOpenInClient(args.uri, args.clientId);
373
+ await session.open(args.uri, args.options);
374
+ // A repeat open keeps the earlier one, which is still in use.
375
+ return this.openedSnapshot(args.uri, wasOpen ? undefined : () => session.close(args.uri));
376
+ }
377
+ /**
378
+ * The snapshot a session's open or create answers with. When the read
379
+ * fails, `rollback` undoes the open this call made before the failure is
380
+ * rethrown: the caller sees no open, so nothing on its side would ever close
381
+ * it.
382
+ */
383
+ async openedSnapshot(uri, rollback) {
384
+ try {
385
+ return await this.getModelDocument({ uri });
386
+ }
387
+ catch (error) {
388
+ // The open's failure is the one the caller needs, not the cleanup's.
389
+ await rollback?.().catch(() => undefined);
390
+ throw error;
391
+ }
392
+ }
393
+ async closeModelDocument(args) {
394
+ // Through the handle, so a close under an ended session fails as that
395
+ // session's calls do, and a session class's own close is honoured.
396
+ const session = this.requireSession(args.clientId);
397
+ // Closing also releases the watch for (uri, clientId) — a forgotten
398
+ // unwatch would otherwise leak phase-event dispatch until the connection
399
+ // closes. Idempotent: a close without a prior watch is a no-op.
400
+ await this.unwatchModelDocument({ uri: args.uri, clientId: args.clientId });
401
+ await session.close(args.uri);
379
402
  }
380
403
  async getModelDocument(args) {
381
404
  // Smart dispatch: a warm document (already in LangiumDocuments) is
@@ -389,72 +412,94 @@ export class DataServer {
389
412
  // unsubscribed caller that needs diagnostics inline passes
390
413
  // `includeDiagnostics: true` to settle at `Validated` instead.
391
414
  const state = args.includeDiagnostics ? DocumentState.Validated : undefined;
392
- const astDocument = await this.modelService.ensureDocumentState(args.uri, state);
393
- return this.encoder.astDocumentToTransferDocument(astDocument);
415
+ try {
416
+ return this.encodeDocument(await this.modelService.ensureDocumentState(args.uri, state));
417
+ }
418
+ catch (error) {
419
+ // The protocol answers a read of a URI with no document with an
420
+ // envelope that has no model.
421
+ if (this.isMissingDocument(error, args.uri)) {
422
+ return this.envelope(UriUtils.toUri(args.uri));
423
+ }
424
+ throw error;
425
+ }
394
426
  }
395
427
  async updateModelDocument(args) {
396
- const astDocument = await this.modelService.update(args);
397
- return this.encoder.astDocumentToTransferDocument(astDocument);
428
+ const astDocument = await this.requireSession(args.clientId).update(this.toSessionWrite(args));
429
+ return this.encodeDocument(astDocument);
398
430
  }
399
431
  async saveModelDocument(args) {
400
- const astDocument = await this.modelService.save(args);
401
- return this.encoder.astDocumentToTransferDocument(astDocument);
432
+ const astDocument = await this.requireSession(args.clientId).save(this.toSessionWrite(args));
433
+ return { ...this.encodeDocument(astDocument), persisted: astDocument.persisted };
434
+ }
435
+ async persistModelDocument(args) {
436
+ const astDocument = await this.requireSession(args.clientId).persist({ uri: args.uri, baseVersion: args.baseVersion });
437
+ return { ...this.encodeDocument(astDocument), persisted: astDocument.persisted };
402
438
  }
403
439
  /**
404
440
  * Record a watch for `(uri, clientId)`. Subsequent phase events on `uri`
405
441
  * fan out to the wired `clientProxy.onDocumentUpdated`. The
406
442
  * bidirectional pattern means the event channel is the client
407
443
  * notification surface, not a returned handle — this method only
408
- * registers the URI in the dispatch table.
444
+ * registers the watcher in {@link uriWatchRecords}.
409
445
  *
410
- * Also baselines the per-URI emission fingerprint (see
411
- * {@link lastEmittedFingerprint}) to the document's current state when
412
- * the first watcher for the URI registers. This guarantees that any
413
- * phase event firing immediately after the watch with no observable
414
- * change is suppressed — watchers obtain initial state via
415
- * `getModelDocument` (or {@link openModelDocument}) and do not need a
416
- * redundant phase notification for that same state.
446
+ * Also baselines the URI's emission fingerprint (see
447
+ * {@link dispatchPhaseEvent}) to the document's current state when the
448
+ * first watcher for the URI registers. This guarantees that any phase event firing immediately after
449
+ * the watch with no observable change is suppressed — watchers obtain
450
+ * initial state via `getModelDocument` (or {@link openModelDocument}) and
451
+ * do not need a redundant phase notification for that same state.
417
452
  */
418
453
  async watchModelDocument(args) {
419
454
  const uri = this.canonicalKey(args.uri);
420
- let subscribers = this.subscriptions.get(uri);
421
- if (!subscribers) {
422
- subscribers = new Set();
423
- this.subscriptions.set(uri, subscribers);
424
- }
425
- subscribers.add(args.clientId);
426
- if (!this.lastEmittedFingerprint.has(uri)) {
455
+ const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set() };
456
+ this.uriWatchRecords.set(uri, record);
457
+ record.watchers.add(args.clientId);
458
+ if (record.fingerprint === undefined) {
427
459
  const document = this.services.workspace.LangiumDocuments.getDocument(UriUtils.toUri(uri));
428
- if (document) {
429
- this.lastEmittedFingerprint.set(uri, this.computeDocumentFingerprint(document));
460
+ if (document && !this.services.workspace.ModelLedger.isPlaceholder(document.parseResult.value)) {
461
+ record.fingerprint = this.computeDocumentFingerprint(document.parseResult.value, this.encoder.toTransferDocument(document));
462
+ record.fingerprintVersion = this.services.workspace.ModelLedger.versionOf(document.parseResult.value);
430
463
  }
431
464
  }
432
465
  }
433
466
  /**
434
467
  * Remove a watch for `(uri, clientId)` previously created by
435
468
  * {@link watchModelDocument}. Idempotent — unwatching twice is a no-op.
436
- * Dispatch for `uri` stops once no watchers remain, at which point the
437
- * per-URI emission fingerprint is also cleared so the next first-watch
438
- * re-baselines against the then-current document state rather than a
439
- * stale snapshot from the previous watch.
469
+ * Dispatch for `uri` stops once no watchers remain, and the emission
470
+ * fingerprint goes with the last watcher (see {@link pruneUriWatchRecord}).
440
471
  */
441
472
  async unwatchModelDocument(args) {
442
473
  const uri = this.canonicalKey(args.uri);
443
- const subscribers = this.subscriptions.get(uri);
444
- if (!subscribers) {
474
+ if (this.uriWatchRecords.get(uri)?.watchers.delete(args.clientId)) {
475
+ this.pruneUriWatchRecord(uri);
476
+ }
477
+ }
478
+ /**
479
+ * Drop what `uri` no longer needs: the
480
+ * {@link DataServerUriWatchRecord.fingerprint} once no client watches it,
481
+ * and the whole record once it holds no
482
+ * {@link DataServerUriWatchRecord.revertPending} mark either. Every path
483
+ * that removes a watcher or consumes a mark ends here.
484
+ */
485
+ pruneUriWatchRecord(uri) {
486
+ const record = this.uriWatchRecords.get(uri);
487
+ if (!record || record.watchers.size > 0) {
445
488
  return;
446
489
  }
447
- subscribers.delete(args.clientId);
448
- if (subscribers.size === 0) {
449
- this.subscriptions.delete(uri);
450
- this.lastEmittedFingerprint.delete(uri);
490
+ if (record.revertPending) {
491
+ record.fingerprint = undefined;
492
+ record.fingerprintVersion = undefined;
493
+ }
494
+ else {
495
+ this.uriWatchRecords.delete(uri);
451
496
  }
452
497
  }
453
498
  /**
454
- * Canonicalise a URI string for use as a subscription / fingerprint
455
- * map key, via the shared `DocumentUriPolicy`. Callers may send
456
- * non-canonical URIs (drive-letter casing, percent-encoding differences,
457
- * or a symlink path) over the wire; the dispatch side keys by
499
+ * Canonicalise a URI string for use as a {@link uriWatchRecords} key, via the
500
+ * shared `DocumentUriPolicy`. Callers may send non-canonical URIs
501
+ * (drive-letter casing, percent-encoding differences, or a symlink path)
502
+ * over the wire; the dispatch side keys by
458
503
  * `document.uri.toString()` from `LangiumDocuments`, so writer keys must
459
504
  * canonicalise to the same form or events silently fail to deliver.
460
505
  * Routing through the seam (rather than a bare `UriUtils.normalize`)
@@ -498,26 +543,56 @@ export class DataServer {
498
543
  // Resolve the language's reference services from each request's source
499
544
  // (see resolveReferenceServices) and delegate.
500
545
  // ============================================================
501
- async findReferenceCandidates(ctx) {
502
- // Candidates are derived from resolved cross-references, so the relevant document(s) must
503
- // have finished the Linked phase — otherwise a query issued right after a model update races
504
- // the asynchronous rebuild and returns stale candidates. Wait the source document
505
- // specifically, but ONLY when a document is actually loaded at that URI: a synthetic source
506
- // can address a URI with no document (a directory URI, typically), and a per-URI `waitUntil`
507
- // there throws "No document found". Fall back to a global Linked settle, matching the
508
- // id-based ElementSource (no URI) path.
509
- const uri = isDocumentSource(ctx.source) || isSyntheticSource(ctx.source) ? UriUtils.toUri(ctx.source.uri) : undefined;
546
+ /**
547
+ * Settle the build before a reference question is answered from the index.
548
+ *
549
+ * A query issued right after a model update otherwise races the rebuild and
550
+ * reads an index missing the symbols it asks about. The cost is not confined
551
+ * to this call: a scope built inside that window is cached, and the build's
552
+ * remaining documents link against it.
553
+ *
554
+ * Waits the source document specifically, but ONLY when one is loaded at
555
+ * that URI: a synthetic source can address a URI with no document (a
556
+ * directory URI, typically), where a per-URI `waitUntil` throws "No document
557
+ * found". Falls back to a global settle, matching the id-based
558
+ * `ElementSource` path.
559
+ *
560
+ * Bounded by {@link DataServerOptions.referenceSettleTimeoutMs}.
561
+ */
562
+ async awaitReferencesLinked(source) {
563
+ const uri = isDocumentSource(source) || isSyntheticSource(source) ? UriUtils.toUri(source.uri) : undefined;
510
564
  const waitUri = uri && this.services.workspace.LangiumDocuments.hasDocument(uri) ? uri : undefined;
511
- await this.services.workspace.DocumentBuilder.waitUntil(DocumentState.Linked, waitUri);
565
+ const stopwatch = this.services.Clock.stopwatch();
566
+ const linked = this.services.workspace.DocumentBuilder.waitUntil(DocumentState.Linked, waitUri);
567
+ if ((await this.services.Clock.raceTimer(linked, this.options.referenceSettleTimeoutMs)) !== TIMED_OUT) {
568
+ return;
569
+ }
570
+ const elapsedMs = Math.round(stopwatch.elapsedMs);
571
+ // A per-URI wait resolves off a document-phase notification, so a
572
+ // missed one strands a wait on a document that HAS reached the
573
+ // phase. Re-read before failing; the workspace-wide wait has no
574
+ // equivalent reading and can only reject.
575
+ const document = waitUri ? this.services.workspace.LangiumDocuments.getDocument(waitUri) : undefined;
576
+ if (waitUri && document && document.state >= DocumentState.Linked) {
577
+ this.tracer
578
+ .withUri(waitUri.toString())
579
+ .warn(`Missed the 'Linked' notification after ${elapsedMs}ms; the document already reached it`);
580
+ return;
581
+ }
582
+ throw referenceSettleTimeoutError(elapsedMs);
583
+ }
584
+ async findReferenceCandidates(ctx) {
585
+ await this.awaitReferencesLinked(ctx.source);
512
586
  return this.resolveReferenceServices(ctx.source).CandidateProvider.find(ctx);
513
587
  }
514
588
  async resolveReference(ref) {
589
+ await this.awaitReferencesLinked(ref.source);
515
590
  const resolved = this.resolveReferenceServices(ref.source).CandidateProvider.resolveCandidate(ref);
516
591
  if (!resolved) {
517
592
  return undefined;
518
593
  }
519
- const element = this.encoder.toTransfer(resolved.node);
520
- return { ...resolved.candidate, element };
594
+ // The caller's claim about the target's type; see `ReferenceServerProtocol.resolveReference`.
595
+ return { ...resolved.candidate, element: this.encoder.toTransfer(resolved.node) };
521
596
  }
522
597
  async findNextName(args) {
523
598
  const uri = UriUtils.toUri(args.uri);
@@ -526,15 +601,32 @@ export class DataServer {
526
601
  // synthetic source — and the create-element flow driving this method is
527
602
  // the one that produces directory URIs, on which a bare
528
603
  // `getServices(uri)` throws while `findReferenceCandidates` succeeds.
529
- const nameProvider = this.resolveReferenceServices(ReferenceSource.synthetic(args.uri, args.type)).NameProvider;
604
+ const source = ReferenceSource.synthetic(args.uri, args.type, args.language);
605
+ // Mid-rebuild the names of documents not yet re-indexed are absent from
606
+ // the taken set, and the caller PERSISTS what it is handed. Nothing
607
+ // reserves the answer either, so a name is free of the collisions the
608
+ // index knows about and of nothing else — two callers racing get the same
609
+ // proposal, which only uniqueness at the write can catch.
610
+ await this.awaitReferencesLinked(source);
611
+ const nameProvider = this.resolveReferenceServices(source).NameProvider;
530
612
  const tier = args.tier ?? 'project';
531
613
  if (tier === 'public') {
532
614
  return nameProvider.findNextProjectQualifiedName(args.type, args.proposal);
533
615
  }
534
616
  if (tier === 'local') {
535
- // Document-scoped uniqueness: the document root is the container.
536
- const document = await this.modelService.ensureDocumentState(args.uri);
537
- return document.root ? nameProvider.findNextName(args.type, args.proposal, document.root) : args.proposal;
617
+ // Document-scoped uniqueness: the document root is the container. A
618
+ // URI with no document has nothing to collide with, like a document
619
+ // with no root.
620
+ try {
621
+ const document = await this.modelService.ensureDocumentState(args.uri);
622
+ return document.root ? nameProvider.findNextName(args.type, args.proposal, document.root) : args.proposal;
623
+ }
624
+ catch (error) {
625
+ if (this.isMissingDocument(error, args.uri)) {
626
+ return args.proposal;
627
+ }
628
+ throw error;
629
+ }
538
630
  }
539
631
  const project = this.services.workspace.ProjectManager.getProject(uri);
540
632
  if (!project) {
@@ -569,6 +661,9 @@ export class DataServer {
569
661
  /**
570
662
  * Pick the language that owns a reference source, in order:
571
663
  *
664
+ * 0. A {@link isSyntheticSource} naming its own `language` routes there.
665
+ * First because every step below infers, and an inference must not
666
+ * override a caller that has said which grammar it means.
572
667
  * 1. A URI-bearing source ({@link isDocumentSource}/{@link isSyntheticSource})
573
668
  * whose URI resolves to a registered language routes by URI.
574
669
  * 2. A single-language workspace always routes to that one language — so
@@ -587,6 +682,15 @@ export class DataServer {
587
682
  */
588
683
  resolveReferenceLanguage(source) {
589
684
  const registry = this.services.ServiceRegistry;
685
+ if (isSyntheticSource(source) && source.language !== undefined) {
686
+ const declared = registry.getServicesById(source.language);
687
+ if (declared) {
688
+ return declared;
689
+ }
690
+ // Falling through on an UNREGISTERED id rather than failing: the id
691
+ // crosses the wire, so a client built against a head with one more
692
+ // grammar would otherwise lose queries the steps below can answer.
693
+ }
590
694
  // `getServicesFor` (non-throwing, one ladder walk) gates the URI lookup:
591
695
  // an extensionless / unregistered URI falls through to the steps below
592
696
  // rather than throwing "no services for the extension ''".
@@ -675,37 +779,78 @@ export class DataServer {
675
779
  // ============================================================
676
780
  // Internal plumbing
677
781
  // ============================================================
782
+ /**
783
+ * Whether `error`, from waiting on `uri`'s document, means that `uri` has
784
+ * no document: a URI with neither a file nor text builds nothing, and
785
+ * Langium's wait after the build rejects for want of one, with a
786
+ * `ServerCancelled` response error. Any other failure, such as a read
787
+ * that fails before a document is registered, a cancelled wait or a
788
+ * `ReentrantWriteLockError`, is the caller's to see.
789
+ */
790
+ isMissingDocument(error, uri) {
791
+ return error instanceof ResponseError && error.code === SERVER_CANCELLED && this.modelService.getDocument(uri) === undefined;
792
+ }
678
793
  /**
679
794
  * Build a {@link TransferDocument} envelope from the current document state,
680
795
  * delegating root + diagnostic encoding to {@link encoder} (see
681
- * `TransferEncoder.toTransferDocument` for the walk).
682
- *
683
- * The encoder field's generic-map binding is widened to
684
- * `Record<string, TransferElement>` at the framework-default level, and an
685
- * adopter supplying a typed-overlay encoder narrows the runtime shape to
686
- * its wire types. The cast on the return is where that invariant — the
687
- * adopter's `TTransfer` matches its encoder's overlay — is asserted, at a
688
- * single boundary point rather than spread across the callers.
689
- */
690
- envelope(uri) {
796
+ * `TransferEncoder.toTransferDocument` for the walk). `fingerprint` is the
797
+ * caller's {@link computeDocumentFingerprint} of that same state, which
798
+ * spares hashing it twice.
799
+ */
800
+ envelope(uri, fingerprint) {
691
801
  // Resolve through the model service's canonicalizing gateway rather than
692
802
  // reaching into `LangiumDocuments` directly, so a divergent (symlink) URI
693
803
  // still finds the document the build keys by its real path — and so the
694
804
  // data-server never has to remember to canonicalize this lookup itself.
695
805
  const document = this.modelService.getDocument(uri.toString());
696
- if (!document) {
806
+ if (!document || this.services.workspace.ModelLedger.isPlaceholder(document.parseResult.value)) {
697
807
  // No document — a shaped envelope rather than a throw, so the caller
698
- // decides policy at its own layer; `root` is optional on the envelope
808
+ // decides policy at its own layer; `model` is optional on the envelope
699
809
  // so the compiler forces that decision. Adopters preferring to throw
700
- // override `envelope`.
701
- return {
702
- uri: uri.toString(),
703
- version: 0,
704
- root: undefined,
705
- diagnostics: []
706
- };
810
+ // override `envelope`. The builder's unparsed placeholder is no
811
+ // document either: its root parses no text.
812
+ return TransferDocument.absent(uri.toString());
707
813
  }
708
- return this.encoder.toTransferDocument(document);
814
+ const encoded = this.encoder.toTransferDocument(document);
815
+ return this.withServerState(encoded, fingerprint ?? this.computeDocumentFingerprint(document.parseResult.value, encoded));
816
+ }
817
+ /**
818
+ * The transfer document a request answers with for `astDocument`, its model
819
+ * hashed and the text stamped on it by {@link withServerState}. Every
820
+ * document a request answers with goes through here, so none goes out
821
+ * without them.
822
+ */
823
+ encodeDocument(astDocument) {
824
+ const encoded = this.encoder.astDocumentToTransferDocument(astDocument);
825
+ return this.withServerState(encoded, this.computeDocumentFingerprint(astDocument.root, encoded));
826
+ }
827
+ /**
828
+ * `encoded` with `hash` on its model and the text the server holds for it:
829
+ * the store's while it holds the document, the build's otherwise. The text
830
+ * is read when the document is sent rather than kept with the build: a save
831
+ * changes `text.dirty` without a rebuild, and the store's text moves on before
832
+ * the build that follows it.
833
+ */
834
+ withServerState(encoded, hash) {
835
+ const text = this.services.workspace.TextDocuments.textState(encoded.uri) ?? this.builtTextState(encoded.uri);
836
+ if (text && text.version > encoded.model.version) {
837
+ this.tracer.withUri(encoded.uri).debug(`Send a model behind its text: model v${encoded.model.version} / text v${text.version}`);
838
+ }
839
+ return {
840
+ uri: encoded.uri,
841
+ // The encoder returns the structural base; `TTransfer` is the adopter's
842
+ // declaration of the roots its languages produce, and nothing checks it.
843
+ model: { ...encoded.model, hash },
844
+ ...(text ? { text } : {})
845
+ };
846
+ }
847
+ /**
848
+ * The text a build read for a document the store never held, which is
849
+ * clean: the store holds every text a client gave it.
850
+ */
851
+ builtTextState(uri) {
852
+ const textDocument = this.modelService.getDocument(uri)?.textDocument;
853
+ return textDocument && { version: textDocument.version, hash: textHash(textDocument.getText()), dirty: false };
709
854
  }
710
855
  /**
711
856
  * Subscribe one listener at the configured {@link DataServerOptions.subscriptionPhase}.
@@ -715,6 +860,56 @@ export class DataServer {
715
860
  */
716
861
  subscribeToDocumentBuilder() {
717
862
  this.disposables.push(this.services.workspace.DocumentBuilder.onDocumentPhase(this.options.subscriptionPhase, (document, cancelToken) => this.dispatchPhaseEvent(document, cancelToken)));
863
+ // The BUILD-phase hook, not the per-document one: this notification is one
864
+ // message per build rather than one per document, and Langium hands the
865
+ // whole batch over here. It also does not fire for a cancelled build,
866
+ // which is what the per-document dispatch has to check by hand.
867
+ this.disposables.push(this.services.workspace.DocumentBuilder.onBuildPhase(this.options.subscriptionPhase, built => this.dispatchBuiltEvent(built)));
868
+ }
869
+ /**
870
+ * Report the documents that reached {@link DataServerOptions.subscriptionPhase}
871
+ * and that NOBODY on this
872
+ * connection is watching — the ones a client was not told about through
873
+ * {@link dispatchPhaseEvent}, which is gated per URI.
874
+ *
875
+ * **The gap this closes is the one no other source can observe.** A document
876
+ * the client watches, it hears about already. A file changed on disk, the
877
+ * host's own filesystem watcher reports — and on a browser host, where the
878
+ * workspace lives behind this head, an external change cannot happen at all.
879
+ * What is left, and what nothing outside the server can see, is a document
880
+ * rebuilt because something it DEPENDS ON changed: its file never changed, so
881
+ * a filesystem watcher is silent by construction, and it has no subscriber, so
882
+ * the update channel is silent by design. A consumer displaying data derived
883
+ * from that document — a tree label, a decorator — otherwise goes stale with
884
+ * no signal from any source, and repairs itself the moment someone opens the
885
+ * file to investigate, which is what makes it expensive to diagnose later.
886
+ *
887
+ * Payload-free on purpose: URIs only, so a client re-reads what it displays
888
+ * rather than being handed transfer documents it did not ask for. That is the
889
+ * property the watcher gate protects, and it is preserved here by
890
+ * carrying no document rather than by gating the message.
891
+ *
892
+ * Quiet in the common case. Editing a document that an editor has open leaves
893
+ * that URI watched and therefore out of this set, so a build with no
894
+ * dependents produces nothing at all, and workspace initialisation produces
895
+ * nothing because it does not build to this phase. The ceiling is a
896
+ * whole-workspace rebuild at the subscription phase: one message, URIs only.
897
+ *
898
+ * The URI is canonicalised for the same reason {@link uriWatchRecords} is keyed
899
+ * that way, and is untested for the same reason as its twin in
900
+ * {@link dispatchDeleteEvents}: the builder reports URIs out of its own
901
+ * store, so a non-canonical one cannot be produced without a fixture
902
+ * asserting a shape the real system never emits.
903
+ */
904
+ dispatchBuiltEvent(built) {
905
+ const uris = built
906
+ .map(document => this.canonicalKey(document.uri.toString()))
907
+ .filter(uri => !this.uriWatchRecords.get(uri)?.watchers.size);
908
+ if (uris.length === 0) {
909
+ return;
910
+ }
911
+ this.tracer.debug(`Emit onDocumentsBuilt: ${uris.length} unwatched document(s)`);
912
+ this.clientProxy.onDocumentsBuilt({ uris });
718
913
  }
719
914
  /**
720
915
  * Subscribe to the universal save event on `HydraniumTextDocuments` so a
@@ -733,29 +928,108 @@ export class DataServer {
733
928
  subscribeToTextDocumentSaves() {
734
929
  this.disposables.push(this.services.workspace.TextDocuments.onDidSave(event => this.dispatchSaveEvent(event)));
735
930
  }
931
+ /** Relay each change of a document's dirty state; see {@link dispatchDirtyEvent}. */
932
+ subscribeToDirtyChanges() {
933
+ this.disposables.push(this.services.workspace.TextDocuments.onDidChangeDirty(event => this.dispatchDirtyEvent(event)));
934
+ }
736
935
  /**
737
- * Mark the last-close transition per URI (see
738
- * {@link pendingRevertBroadcasts}). The listener consults
739
- * `isOpenInAnyClient` AFTER the store decremented the closing client's
740
- * hold, so a `false` answer means this close was the last one.
936
+ * Send a dirty flip to the connection, gated on the URI's watchers as
937
+ * {@link dispatchSaveEvent} is: the answer at any one moment travels on
938
+ * every document sent, so a client that watches nothing reads it there.
939
+ */
940
+ dispatchDirtyEvent(event) {
941
+ const uri = this.canonicalKey(event.uri);
942
+ if (this.uriWatchRecords.get(uri)?.watchers.size) {
943
+ this.clientProxy.onDocumentDirtyChanged({ uri, text: event.text });
944
+ }
945
+ }
946
+ /**
947
+ * Mark each document the store releases after its last close, so
948
+ * {@link dispatchPhaseEvent} broadcasts the following rebuild even without
949
+ * a watcher. The store rebuilds such a document from its disk content,
950
+ * discarding unsaved in-session edits, and the last close typically also
951
+ * removed the last watcher: without the broadcast, a consumer that only
952
+ * ever fetches via `getModelDocument` keeps showing the discarded state.
953
+ * The broadcast is de-duplicated against the fingerprint while a watcher
954
+ * holds one, so a close whose disk state equals the last emitted state
955
+ * stays silent; with no watcher there is no fingerprint, and every revert
956
+ * is sent.
957
+ *
958
+ * A release, not the close itself: a document whose last client lost its
959
+ * connection is released only once the revert grace runs out, or when
960
+ * another client opens it meanwhile, and not at all when a client lost
961
+ * from it opens it again within its own grace.
741
962
  */
742
963
  subscribeToTextDocumentCloses() {
743
- const textDocuments = this.services.workspace.TextDocuments;
744
- this.disposables.push(textDocuments.onDidClose(event => {
745
- if (!textDocuments.isOpenInAnyClient(event.document.uri)) {
746
- this.pendingRevertBroadcasts.add(this.canonicalKey(event.document.uri));
747
- }
964
+ this.disposables.push(this.services.workspace.TextDocuments.onDidCloseLastOpen(event => {
965
+ const uri = this.canonicalKey(event.uri);
966
+ const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set() };
967
+ record.revertPending = true;
968
+ this.uriWatchRecords.set(uri, record);
748
969
  }));
749
970
  }
750
- /** Fan out a save event for the document's URI, gated by the subscription map. */
971
+ /**
972
+ * Fan out a deletion for each removed URI, to EVERY client on the connection
973
+ * rather than only to the ones watching that URI.
974
+ *
975
+ * **Deliberately ungated, where {@link dispatchPhaseEvent} and
976
+ * {@link dispatchSaveEvent} are gated.** Those two carry a built document and
977
+ * fire on every build, so the watcher gate is what keeps bandwidth
978
+ * proportional to what a client asked for. A deletion is neither: it is one
979
+ * URI, it is rare, and it reports the workspace's STRUCTURE rather than a
980
+ * document's content. Gating it forces any consumer that displays the
981
+ * workspace — a model tree, a file decorator — to learn about disappearances
982
+ * from a filesystem watcher instead, which a client hosted in a browser has
983
+ * no way to run: its workspace lives behind the head. A client that does not
984
+ * care filters on the URI, which costs it a comparison.
985
+ *
986
+ * The precedent is the last-close revert broadcast (see
987
+ * {@link subscribeToTextDocumentCloses}), where the same judgement was already made
988
+ * in the other direction: a transition that matters enough is delivered
989
+ * without a subscription.
990
+ *
991
+ * Runs from the `DocumentBuilder.onUpdate` listener rather than from a phase
992
+ * listener, which is the only place a deletion is observable: `update`
993
+ * removes the document before deriving the rebuild set, so it is never built.
994
+ * That ordering also puts this notification ahead of the `'rebuilt'` events
995
+ * for the dependents whose references the deletion just broke.
996
+ *
997
+ * The `deleted` list arrives already expanded to concrete document URIs —
998
+ * `deleteDocuments` resolves a directory URI to the documents beneath it — so
999
+ * no caller has to handle a directory here.
1000
+ *
1001
+ * The URI's fingerprint and revert mark are dropped: they describe a
1002
+ * document that no longer exists. A kept fingerprint is adopted as the
1003
+ * baseline and suppresses the first emit after the file returns with its
1004
+ * previous content.
1005
+ *
1006
+ * The watchers SURVIVE: a recreated file resumes delivering to them with no
1007
+ * re-subscription, and a client that answers the deletion by closing
1008
+ * releases the watch through `closeModelDocument` anyway.
1009
+ */
1010
+ dispatchDeleteEvents(deleted) {
1011
+ for (const removed of deleted) {
1012
+ const uri = this.canonicalKey(removed.toString());
1013
+ const record = this.uriWatchRecords.get(uri);
1014
+ if (record) {
1015
+ record.fingerprint = undefined;
1016
+ record.fingerprintVersion = undefined;
1017
+ record.revertPending = undefined;
1018
+ record.sentVersion = undefined;
1019
+ this.pruneUriWatchRecord(uri);
1020
+ }
1021
+ this.clientProxy.onDocumentDeleted({ uri });
1022
+ }
1023
+ }
1024
+ /** Fan out a save event for the document's URI, gated on the URI's watchers. */
751
1025
  dispatchSaveEvent(event) {
752
1026
  // The save event arrives under the CLIENT URI the text store keys by (e.g. a
753
- // symlink path S); the subscription map and `dispatchPhaseEvent` key by the
1027
+ // symlink path S); `uriWatchRecords` and `dispatchPhaseEvent` key by the
754
1028
  // CANONICAL identity R. Canonicalize before both the gate and the envelope so
755
1029
  // a save of a symlinked file isn't silently dropped (and the envelope resolves
756
1030
  // the R-keyed document rather than missing into an empty one).
757
1031
  const uri = this.canonicalKey(event.document.uri);
758
- if (!this.subscriptions.has(uri)) {
1032
+ if (!this.uriWatchRecords.get(uri)?.watchers.size) {
759
1033
  return;
760
1034
  }
761
1035
  const response = this.envelope(UriUtils.toUri(uri));
@@ -774,13 +1048,27 @@ export class DataServer {
774
1048
  * out to multiple local subscribers with an `Emitter<T>` — the
775
1049
  * framework deliberately does NOT promise multi-listener semantics.
776
1050
  *
777
- * The dispatch is guarded by two filters:
778
- * 1. **Subscription map**: events for URIs no subscriber registered for
779
- * are NOT sent over the wire (bandwidth scales with subscribed URIs,
780
- * not phase events).
781
- * 2. **Emission fingerprint**: events for rebuilds that produce no
782
- * observable change since the last emit are suppressed. See
783
- * {@link lastEmittedFingerprint} for the rationale.
1051
+ * An event for a URI no client watches is NOT sent over the wire, so
1052
+ * bandwidth scales with watched URIs rather than with phase events; a
1053
+ * pending revert mark is the exception (see
1054
+ * {@link subscribeToTextDocumentCloses}).
1055
+ *
1056
+ * An event for a rebuild with no observable change since the last emit is
1057
+ * suppressed against the URI's fingerprint and the version it was taken at;
1058
+ * a new version with the same fingerprint goes out with the same
1059
+ * `model.hash`, so a watcher still learns the version. Such rebuilds are routine: a
1060
+ * second client attaching to an open document makes
1061
+ * `HydraniumTextDocuments.refreshContent` fire `onDidChangeContent` purely
1062
+ * to re-trigger the build, and Langium rebuilds a document when a
1063
+ * dependency changes even if its diagnostics come out the same. Sent at a
1064
+ * version this head has not sent, they reach watchers as `'changed'`, and a
1065
+ * watcher that reads `'changed'` as another client's write and resets its
1066
+ * root to the server view loses the user's edits. The first {@link watchModelDocument} baselines the
1067
+ * fingerprint, so the first event after a watch is de-duplicated against
1068
+ * the state the watcher just fetched; it goes with the last watcher, so the
1069
+ * next first watch re-baselines rather than adopting a stale digest. A
1070
+ * digest keeps its memory constant in document size; see
1071
+ * {@link computeDocumentFingerprint} for the inputs.
784
1072
  */
785
1073
  dispatchPhaseEvent(document, cancelToken) {
786
1074
  if (cancelToken.isCancellationRequested) {
@@ -792,89 +1080,68 @@ export class DataServer {
792
1080
  return;
793
1081
  }
794
1082
  const uri = document.uri.toString();
795
- // Consume the last-close mark even when subscriptions exist — the
796
- // regular dispatch below serves those watchers, and the mark's author
797
- // attribution is more precise than the post-close `UNKNOWN_CLIENT_ID`
798
- // the author lookup would yield.
799
- const revertedOnClose = this.pendingRevertBroadcasts.delete(uri);
800
- if (!this.subscriptions.has(uri) && !revertedOnClose) {
1083
+ const record = this.uriWatchRecords.get(uri);
1084
+ const revertedOnClose = record?.revertPending === true;
1085
+ if (!record || (record.watchers.size === 0 && !revertedOnClose)) {
801
1086
  return;
802
1087
  }
803
- const fingerprint = this.computeDocumentFingerprint(document);
804
- if (this.lastEmittedFingerprint.get(uri) === fingerprint) {
1088
+ if (revertedOnClose) {
1089
+ // Consumed even when watchers exist — the regular dispatch below
1090
+ // serves them, and the mark's attribution is more precise than the
1091
+ // post-close unknown client the manager's attribution would yield.
1092
+ // With no watcher the record goes now, so the fingerprint written
1093
+ // below lands on a detached record and the next first watch
1094
+ // re-baselines instead of adopting it.
1095
+ record.revertPending = undefined;
1096
+ this.pruneUriWatchRecord(uri);
1097
+ }
1098
+ const fingerprint = this.computeDocumentFingerprint(document.parseResult.value, this.encoder.toTransferDocument(document));
1099
+ const stamped = this.services.workspace.ModelLedger.versionOf(document.parseResult.value);
1100
+ if (record.fingerprint === fingerprint && record.fingerprintVersion === stamped) {
805
1101
  // A rebuild that produced no observable change since the last emit —
806
1102
  // suppressed so RPC subscribers don't see a no-op broadcast. Logged at
807
1103
  // debug so a *needed* re-broadcast wrongly suppressed by this dedup
808
1104
  // (the failure mode the fingerprint strategy must avoid) is visible.
809
- this.tracer.withUri(uri).debug(`Suppress onDocumentUpdated v${document.textDocument.version}: fingerprint unchanged`);
1105
+ this.tracer.withUri(uri).debug(`Suppress onDocumentUpdated v${stamped}: fingerprint and version unchanged`);
810
1106
  return;
811
1107
  }
812
- this.lastEmittedFingerprint.set(uri, fingerprint);
1108
+ record.fingerprint = fingerprint;
1109
+ record.fingerprintVersion = stamped;
1110
+ // The manager's attribution, so this head names the same client as the
1111
+ // in-process heads do for one build, except for a version this head
1112
+ // already sent; see `DataServerUriWatchRecord.sentVersion`.
1113
+ const version = this.services.workspace.AstDocumentManager.isOpen(uri) ? document.textDocument.version : undefined;
1114
+ const { reason, sourceClientId } = version !== undefined && record.sentVersion === version
1115
+ ? { reason: 'rebuilt', sourceClientId: UNKNOWN_CLIENT_ID }
1116
+ : this.services.workspace.AstDocumentManager.attributeUpdate(document);
1117
+ record.sentVersion = version;
813
1118
  const event = {
814
- document: this.envelope(document.uri),
815
- sourceClientId: revertedOnClose ? REVERT_ON_CLOSE_CLIENT_ID : this.resolveSourceClientId(document),
816
- reason: this.resolveUpdateReason(document.uri)
1119
+ document: this.envelope(document.uri, fingerprint),
1120
+ sourceClientId: revertedOnClose ? REVERT_ON_CLOSE_CLIENT_ID : sourceClientId,
1121
+ reason
817
1122
  };
818
- this.tracer
819
- .withUri(uri)
820
- .debug(`Emit onDocumentUpdated v${event.document.version} (reason=${event.reason}, sourceClientId=${event.sourceClientId})`);
1123
+ this.tracer.withUri(uri).debug(`Emit onDocumentUpdated v${stamped} (reason=${event.reason}, sourceClientId=${event.sourceClientId})`);
821
1124
  this.clientProxy.onDocumentUpdated(event);
822
1125
  }
823
1126
  /**
824
- * Fingerprint of the document's observable state, used to de-dup
825
- * `onDocumentUpdated` emissions. The {@link FingerprintStrategy} option
826
- * selects what is hashed (default `'transfer-document'` — see the type), and
827
- * {@link additionalFingerprintInputs} folds in any extra adopter signal.
1127
+ * Fingerprint of the snapshot `root` and its encoding `encoded`, used to
1128
+ * de-dup `onDocumentUpdated` emissions and sent as every document's
1129
+ * `model.hash`, so it must not depend on the version or on live state. The
1130
+ * {@link FingerprintStrategy} option selects what is hashed (default
1131
+ * `'transfer-document'` — see the type).
828
1132
  *
829
- * The default `'transfer-document'` strategy goes through the encoder's
830
- * {@link TransferEncoder.toTransferDocument}, which is cached per build —
831
- * so within one phase event the fingerprint and the subsequently-emitted
832
- * `envelope` share a single encode walk.
1133
+ * {@link TransferEncoder.toTransferDocument} is cached per build, so within
1134
+ * one phase event the fingerprint and the subsequently-emitted `envelope`
1135
+ * share a single encode walk.
833
1136
  *
834
1137
  * Wrapped in {@link Tracer.time} against {@link FINGERPRINT_LOG_AFTER_MS}.
835
1138
  */
836
- computeDocumentFingerprint(document) {
837
- return this.tracer.withUri(document.uri.toString()).time('Compute fingerprint', () => {
838
- const base = this.options.fingerprintStrategy === 'text-diagnostics'
839
- ? textDiagnosticsFingerprint(document)
840
- : transferDocumentFingerprint(this.encoder.toTransferDocument(document));
841
- const extra = this.additionalFingerprintInputs(document);
842
- return extra.length === 0 ? base : fingerprintHash([base, FINGERPRINT_SEPARATOR, ...extra.map(value => JSON.stringify(value))]);
843
- }, 'debug', { logAfterMs: FINGERPRINT_LOG_AFTER_MS });
844
- }
845
- /**
846
- * Extra inputs folded into {@link computeDocumentFingerprint} alongside the
847
- * chosen {@link FingerprintStrategy}. Default: none. Override to contribute a
848
- * signal that lives outside the document's text / root / diagnostics — each
849
- * entry need only be stable across equivalent emissions and
850
- * JSON-serialisable.
851
- */
852
- additionalFingerprintInputs(_document) {
853
- return [];
854
- }
855
- /**
856
- * Discriminate the reason for a phase-event-driven update notification.
857
- * Uses the most recent `DocumentBuilder.onUpdate` snapshot:
858
- * - URI in the `deleted` list → `'deleted'`
859
- * - URI in the `changed` list → `'changed'` (the URI was passed to
860
- * `documentBuilder.update(changed, deleted)`, which spans `didChange`
861
- * text-document events and programmatic `update([uri], [])` calls).
862
- * - Otherwise → `'rebuilt'` (cascade re-derivation: this URI was rebuilt
863
- * because something it depends on changed; its own text wasn't flagged).
864
- *
865
- * `'saved'` is NOT emitted from this code path — saves take the dedicated
866
- * `DataClientProtocol.onDocumentSaved` channel; adopters that want a
867
- * unified update stream synthesise `'saved'` in their bridge layer.
868
- */
869
- resolveUpdateReason(uri) {
870
- const last = this.lastBuildUpdate;
871
- if (last?.deleted.some(deleted => UriUtils.equals(deleted, uri))) {
872
- return 'deleted';
873
- }
874
- if (last?.changed.some(changed => UriUtils.equals(changed, uri))) {
875
- return 'changed';
876
- }
877
- return 'rebuilt';
1139
+ computeDocumentFingerprint(root, encoded) {
1140
+ return this.tracer
1141
+ .withUri(encoded.uri)
1142
+ .time('Compute fingerprint', () => this.options.fingerprintStrategy === 'text-diagnostics'
1143
+ ? textDiagnosticsFingerprint(this.services.workspace.ModelLedger.textOf(root), encoded.model)
1144
+ : transferDocumentFingerprint(encoded.model), 'debug', { logAfterMs: FINGERPRINT_LOG_AFTER_MS });
878
1145
  }
879
1146
  /**
880
1147
  * Subscribe to the project tier's change channel and re-fan registry
@@ -917,19 +1184,6 @@ export class DataServer {
917
1184
  this.clientProxy.onProjectsChanged({ project: entry.snapshot, reason: 'removed' });
918
1185
  }
919
1186
  }
920
- /**
921
- * Resolve the wire-level `sourceClientId` for `document`'s events — the client
922
- * that authored its current version, from the version-author history on
923
- * `HydraniumTextDocuments`. The protocol-level counterpart of the internal
924
- * `AstDocumentManager.getAuthor`: a framework-internal rebuild has no author,
925
- * so this surfaces the {@link UNKNOWN_CLIENT_ID} presentation default. Adopters
926
- * that rebuild through non-text-document channels override to derive a
927
- * source id of their own.
928
- */
929
- resolveSourceClientId(document) {
930
- const author = this.services.workspace.TextDocuments.getAuthor(document.textDocument.uri, document.textDocument.version);
931
- return author ?? UNKNOWN_CLIENT_ID;
932
- }
933
1187
  // --- Diagnostics (DataServerDiagnosticsProtocol) ---------------------------
934
1188
  // Computed in THIS process: the data-server child holds the model store, so
935
1189
  // these snapshots reflect the heap that actually carries the workspace
@@ -967,7 +1221,7 @@ export class DataServer {
967
1221
  }
968
1222
  async stopProfiling(args) {
969
1223
  if (!this.activeProfile) {
970
- throw new Error('No profiling capture is active; call startProfiling first.');
1224
+ throw noActiveProfileError();
971
1225
  }
972
1226
  const capture = this.activeProfile;
973
1227
  this.activeProfile = undefined;
@@ -996,7 +1250,8 @@ export class DataServer {
996
1250
  methodNamespace: partial.methodNamespace ?? DATA_SERVER_WIRE_PREFIX,
997
1251
  additionalMethods,
998
1252
  excludedMethods: partial.excludedMethods ?? [],
999
- diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics()
1253
+ diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics(),
1254
+ referenceSettleTimeoutMs: partial.referenceSettleTimeoutMs ?? DataServer.DEFAULT_OPTIONS.referenceSettleTimeoutMs
1000
1255
  };
1001
1256
  }
1002
1257
  }