@hydranium/data-server 1.0.0-next.18 → 1.0.0-next.181

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, asSnapshotVersion, 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,21 @@ 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
- }
58
+ const SERVER_CANCELLED = -32802;
59
+ const resumableByModelService = new WeakMap();
50
60
  /** Hash a document's raw text + diagnostics — the `'text-diagnostics'` strategy. */
51
61
  function textDiagnosticsFingerprint(document) {
52
- return fingerprintHash([document.textDocument.getText(), FINGERPRINT_SEPARATOR, JSON.stringify(document.diagnostics ?? [])]);
62
+ return textHash([document.textDocument.getText(), FINGERPRINT_SEPARATOR, JSON.stringify(document.diagnostics ?? [])]);
53
63
  }
54
64
  /** Hash an encoded transfer document's root + diagnostics — the `'transfer-document'` strategy. */
55
65
  function transferDocumentFingerprint(transferDocument) {
56
66
  // null, not undefined: `JSON.stringify(undefined)` yields undefined rather
57
67
  // 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
- ]);
68
+ return textHash([JSON.stringify(transferDocument.root ?? null), FINGERPRINT_SEPARATOR, JSON.stringify(transferDocument.diagnostics)]);
63
69
  }
64
70
  /**
65
71
  * `logAfterMs` threshold passed to {@link Tracer.time} around
@@ -94,9 +100,11 @@ const FINGERPRINT_LOG_AFTER_MS = 5;
94
100
  * any names supplied via {@link DataServerOptions.additionalMethods}) and
95
101
  * builds the {@link DataClientProtocol} notification proxy on the same
96
102
  * 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`.
103
+ * `localTarget`) under the configured namespace, and subscribes two listeners
104
+ * at the configured phase: a `DocumentBuilder.onDocumentPhase` one dispatching
105
+ * per-document `clientProxy.onDocumentUpdated` for watched URIs, and a
106
+ * `DocumentBuilder.onBuildPhase` one dispatching a single
107
+ * `clientProxy.onDocumentsBuilt` naming the batch's unwatched documents.
100
108
  *
101
109
  * The data-server requires the full {@link ServerSharedServices}
102
110
  * shape — `HydraniumTextDocuments` for client-attributed updates,
@@ -121,85 +129,25 @@ export class DataServer {
121
129
  * extending rather than restate a value the framework may change.
122
130
  */
123
131
  static DEFAULT_OPTIONS = {
124
- subscriptionPhase: DocumentState.Validated
132
+ subscriptionPhase: DocumentState.Validated,
133
+ referenceSettleTimeoutMs: 60_000
125
134
  };
126
135
  options;
127
- /** Subscription bookkeeping: URI → set of clientIds that subscribed for that URI. */
128
- subscriptions = new Map();
136
+ /** This connection's {@link DataServerUriWatchRecord} per canonical URI; see there for when a record lives. */
137
+ uriWatchRecords = new Map();
129
138
  /**
130
- * Open-document bookkeeping: URI → set of clientIds that opened it over THIS
131
- * connection.
139
+ * The client sessions this connection registered, by client id. A document
140
+ * request carrying one of these ids acts as that session; one carrying any
141
+ * other id fails.
132
142
  *
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.
143
+ * Entries stay after {@link dispose} has ended their sessions, so a request
144
+ * still running from before the connection closed reaches the ended handle
145
+ * and fails with the session's own error.
139
146
  */
140
- openedDocuments = new Map();
147
+ clientSessions = new Map();
141
148
  /** Typed client proxy — sends `data-server/on*` notifications back over the same wire. */
142
149
  clientProxy;
143
150
  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
151
  tracer;
204
152
  /** The in-flight interactive profile capture, held between {@link startProfiling} and {@link stopProfiling}. */
205
153
  activeProfile;
@@ -211,11 +159,8 @@ export class DataServer {
211
159
  encoder;
212
160
  /**
213
161
  * 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`.
162
+ * Its documents carry the AST-layer {@link AstDiagnostic}, never the wire `TDiagnostic`:
163
+ * {@link encoder} converts one into the other on the way out.
219
164
  */
220
165
  modelService;
221
166
  constructor(connection, services, options = {}) {
@@ -224,8 +169,7 @@ export class DataServer {
224
169
  this.options = this.resolveOptions(options);
225
170
  this.tracer = this.services.Tracer.for(options.logName ?? 'DataServer').trace('instantiated');
226
171
  // 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.
172
+ // `services.model.ModelService` with their own subclasses.
229
173
  const { TransferEncoder: encoder, ModelService: modelService } = this.services.model;
230
174
  if (!encoder || !modelService) {
231
175
  throw new Error('DataServer requires `services.model.TransferEncoder` and `services.model.ModelService` to be bound. ' +
@@ -248,35 +192,42 @@ export class DataServer {
248
192
  methodNamespace: this.options.methodNamespace,
249
193
  localTarget: this,
250
194
  localMethods: registeredMethods,
251
- latency: this.latency
195
+ latency: this.latency,
196
+ // Bound at the chokepoint rather than per handler, so an adopter's
197
+ // `additionalMethods` are rendered on the same terms as the
198
+ // framework's own rejections.
199
+ renderErrorMessage: error => this.services.MessageRenderer.renderError(error)
252
200
  });
253
- this.disposables.push(this.services.workspace.DocumentBuilder.onUpdate((changed, deleted) => {
254
- this.lastBuildUpdate = { changed, deleted };
255
- }));
201
+ this.disposables.push(this.services.workspace.DocumentBuilder.onUpdate((_changed, deleted) => this.dispatchDeleteEvents(deleted)));
256
202
  this.subscribeToDocumentBuilder();
257
203
  this.subscribeToTextDocumentSaves();
204
+ this.subscribeToDirtyChanges();
258
205
  this.subscribeToTextDocumentCloses();
259
206
  this.subscribeToProjectManager();
260
207
  // Self-register teardown so an adopter that keeps no reference to the
261
208
  // server still releases per-connection state, with no lifecycle hook of
262
- // its own. See `dispose`.
263
- this.disposables.push(connection.onClose(() => this.dispose()));
209
+ // its own. The client did not close anything itself, so its sessions end
210
+ // as lost and each document it was the last to have open waits out the
211
+ // store's revert grace. See `dispose`.
212
+ this.disposables.push(connection.onClose(() => this.dispose('lost')));
264
213
  }
265
214
  /**
266
215
  * 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.
273
- *
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.
278
- */
279
- dispose() {
216
+ * handlers and every listener — and clear {@link uriWatchRecords}, so a
217
+ * long-lived shared services bundle does not retain per-connection memory
218
+ * after the connection closes. Also ends every session this connection registered, which closes
219
+ * every document it has open: the SHARED store's state rather than this
220
+ * server's, which outlives the connection unless released here.
221
+ *
222
+ * Idempotent: subsequent calls are no-ops. Runs by itself when the
223
+ * connection closes, so adopters who don't hold a reference still get
224
+ * per-connection cleanup; adopters that DO hold a reference may call
225
+ * `dispose()` directly for early teardown. The sessions end with `cause`:
226
+ * `'closed'` reverts every document whose last open they close at once,
227
+ * and `'lost'`, the connection's own close, lets each wait out the revert
228
+ * grace.
229
+ */
230
+ dispose(cause = 'closed') {
280
231
  this.disposed = true;
281
232
  // Release an in-flight interactive capture so the process-wide inspector
282
233
  // singleton is not left active after the connection closes.
@@ -285,97 +236,165 @@ export class DataServer {
285
236
  this.activeProfile = undefined;
286
237
  void capture.stop({}).catch(() => undefined);
287
238
  }
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.
239
+ // AFTER `disposables.dispose()`, deliberately: ending a session releases
240
+ // each document it was the last to hold, and this server's own
241
+ // `onDidCloseLastOpen` listener would otherwise mark a revert broadcast
242
+ // for a connection that is already gone.
291
243
  this.disposables.dispose();
292
- this.closeOpenDocuments();
293
- this.subscriptions.clear();
294
- this.lastEmittedFingerprint.clear();
295
- this.pendingRevertBroadcasts.clear();
244
+ for (const [clientId, session] of this.clientSessions) {
245
+ this.endSession(clientId, session, cause);
246
+ }
247
+ this.uriWatchRecords.clear();
296
248
  }
297
249
  // ============================================================
298
- // DataServerProtocol implementation — delegates to ModelService.
250
+ // DataServerProtocol implementation
299
251
  // ============================================================
300
252
  //
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);
253
+ // Reads go to `ModelService`; a request that opens or writes a document
254
+ // goes to the session this connection registered under its `clientId`.
255
+ // Each answer is encoded on the wire boundary via
256
+ // `encoder.astDocumentToTransferDocument`. To change how documents are
257
+ // read, override on the ModelService subclass; to change how they are
258
+ // written, on the session class the bound `ClientSessionFactory` builds.
259
+ async createSession(args) {
260
+ // After teardown nothing would ever end a session registered now, and its
261
+ // id would stay taken for the life of the process.
262
+ if (this.disposed) {
263
+ throw new SessionClosedError(args.clientId);
264
+ }
265
+ const resumable = this.resumableSessions();
266
+ const previous = resumable.get(args.clientId);
267
+ if (previous && args.resumeToken !== undefined && previous.token === args.resumeToken) {
268
+ previous.end();
269
+ }
270
+ const session = this.modelService.createSession(args.label, args.clientId);
271
+ this.clientSessions.set(args.clientId, session);
272
+ if (args.resumeToken !== undefined) {
273
+ // Taken over by a client registering again after its connection
274
+ // dropped, so the old session ends as lost: the documents it was the
275
+ // last to have open wait out the grace, and the new session's opens
276
+ // find their unsaved text.
277
+ resumable.set(args.clientId, { token: args.resumeToken, end: () => this.endSession(args.clientId, session, 'lost') });
278
+ }
341
279
  }
342
280
  /**
343
- * Drop the recorded hold for `(uri, clientId)` so {@link dispose} does not
344
- * close it a second time. Idempotent.
281
+ * End a session this connection registered. The ended handle stays in
282
+ * {@link clientSessions}, as it does after {@link dispose}, so a request for
283
+ * the id still arriving fails with the ended session's own error.
345
284
  */
346
- forgetOpenDocument(uri, clientId) {
347
- const holders = this.openedDocuments.get(uri);
348
- if (!holders) {
349
- return;
285
+ async closeSession(args) {
286
+ const session = this.clientSessions.get(args.clientId);
287
+ if (session) {
288
+ this.endSession(args.clientId, session);
350
289
  }
351
- holders.delete(clientId);
352
- if (holders.size === 0) {
353
- this.openedDocuments.delete(uri);
290
+ }
291
+ /** End `session`, registered here under `clientId`, with `cause`, and drop its watches on this connection. */
292
+ endSession(clientId, session, cause = 'closed') {
293
+ for (const [uri, record] of this.uriWatchRecords) {
294
+ if (record.watchers.delete(clientId)) {
295
+ this.pruneUriWatchRecord(uri);
296
+ }
354
297
  }
298
+ session.dispose(cause);
355
299
  }
356
300
  /**
357
- * Close every document still open over this connection, for the clients that
358
- * opened it here.
301
+ * The resumable sessions of this services tree, by client id, across all of
302
+ * its data connections: a client resumes on another connection than the one
303
+ * that registered it. An entry leaves when its session ends, by any path, so
304
+ * it keeps no ended connection alive.
359
305
  *
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.
306
+ * A takeover by resume token ends the old session even when its connection
307
+ * is still alive, so two clients that shared an id and its token would end
308
+ * each other's sessions. And the token is a guard against colliding with a
309
+ * session the server has not yet seen end, not a secret: the wire carries no
310
+ * authentication, and a peer that learns the token can end the session.
311
+ */
312
+ resumableSessions() {
313
+ let sessions = resumableByModelService.get(this.modelService);
314
+ if (!sessions) {
315
+ const created = new Map();
316
+ // Subscribed once per services tree, and never disposed: it lives as
317
+ // long as the text store it listens to.
318
+ this.services.workspace.TextDocuments.onDidCloseSession(event => created.delete(event.clientId));
319
+ resumableByModelService.set(this.modelService, created);
320
+ sessions = created;
321
+ }
322
+ return sessions;
323
+ }
324
+ async createModelDocument(args) {
325
+ const session = this.requireSession(args.clientId);
326
+ await session.create(args.uri, args.text);
327
+ return this.openedSnapshot(args.uri, () => session.close(args.uri));
328
+ }
329
+ async updateModelDocuments(args) {
330
+ const astDocuments = await this.requireSession(args.clientId).updateAll({
331
+ updates: args.updates.map(update => this.toSessionWrite(update))
332
+ });
333
+ return astDocuments.map(astDocument => this.encodeDocument(astDocument));
334
+ }
335
+ /**
336
+ * The session write a wire write request carries. Only the fields a session
337
+ * takes: a field an adopter adds to a request reaches the session only
338
+ * through an override of this.
339
+ */
340
+ toSessionWrite(request) {
341
+ return { uri: request.uri, model: request.model, basedOn: request.basedOn };
342
+ }
343
+ /**
344
+ * The session this connection registered under `clientId`, which every
345
+ * document request acts as. An id that is not one fails with the
346
+ * closed-session code: opening or writing under it would leave an open that
347
+ * no session end ever closes.
348
+ */
349
+ requireSession(clientId) {
350
+ const session = this.clientSessions.get(clientId);
351
+ if (!session) {
352
+ throw new SessionClosedError(clientId, 'The client session was never registered on this connection.');
353
+ }
354
+ return session;
355
+ }
356
+ async openModelDocument(args) {
357
+ const session = this.requireSession(args.clientId);
358
+ const wasOpen = this.services.workspace.TextDocuments.isOpenInClient(args.uri, args.clientId);
359
+ await session.open(args.uri, args.options);
360
+ // A repeat open keeps the earlier one, which is still in use.
361
+ return this.openedSnapshot(args.uri, wasOpen ? undefined : () => session.close(args.uri));
362
+ }
363
+ /**
364
+ * The snapshot a session's open or create answers with. When the read
365
+ * fails, `rollback` undoes the open this call made before the failure is
366
+ * rethrown: the caller sees no open, so nothing on its side would ever close
367
+ * it.
366
368
  *
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.
369
+ * Versioned with the store's shared version rather than the snapshot's own:
370
+ * the built document's `textDocument.version` lags the store's whenever the
371
+ * store assigned the version, and the store's is what a write's `basedOn` is
372
+ * compared against, so reporting the snapshot's would make the caller's
373
+ * first based-on write conflict with itself.
370
374
  */
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
- }
375
+ async openedSnapshot(uri, rollback) {
376
+ let document;
377
+ try {
378
+ document = await this.getModelDocument({ uri });
378
379
  }
380
+ catch (error) {
381
+ // The open's failure is the one the caller needs, not the cleanup's.
382
+ await rollback?.().catch(() => undefined);
383
+ throw error;
384
+ }
385
+ // Stamped again with the version, in one step: a write landing after the
386
+ // read would otherwise pair its version with the read's text hash.
387
+ return this.withServerState({ ...document, version: asSnapshotVersion(this.services.workspace.TextDocuments.version(uri)) });
388
+ }
389
+ async closeModelDocument(args) {
390
+ // Through the handle, so a close under an ended session fails as that
391
+ // session's calls do, and a session class's own close is honoured.
392
+ const session = this.requireSession(args.clientId);
393
+ // Closing also releases the watch for (uri, clientId) — a forgotten
394
+ // unwatch would otherwise leak phase-event dispatch until the connection
395
+ // closes. Idempotent: a close without a prior watch is a no-op.
396
+ await this.unwatchModelDocument({ uri: args.uri, clientId: args.clientId });
397
+ await session.close(args.uri);
379
398
  }
380
399
  async getModelDocument(args) {
381
400
  // Smart dispatch: a warm document (already in LangiumDocuments) is
@@ -389,72 +408,88 @@ export class DataServer {
389
408
  // unsubscribed caller that needs diagnostics inline passes
390
409
  // `includeDiagnostics: true` to settle at `Validated` instead.
391
410
  const state = args.includeDiagnostics ? DocumentState.Validated : undefined;
392
- const astDocument = await this.modelService.ensureDocumentState(args.uri, state);
393
- return this.encoder.astDocumentToTransferDocument(astDocument);
411
+ try {
412
+ return this.encodeDocument(await this.modelService.ensureDocumentState(args.uri, state));
413
+ }
414
+ catch (error) {
415
+ // The protocol answers a read of a URI with no document with an
416
+ // envelope that has no root.
417
+ if (this.isMissingDocument(error, args.uri)) {
418
+ return this.envelope(UriUtils.toUri(args.uri));
419
+ }
420
+ throw error;
421
+ }
394
422
  }
395
423
  async updateModelDocument(args) {
396
- const astDocument = await this.modelService.update(args);
397
- return this.encoder.astDocumentToTransferDocument(astDocument);
424
+ const astDocument = await this.requireSession(args.clientId).update(this.toSessionWrite(args));
425
+ return this.encodeDocument(astDocument);
398
426
  }
399
427
  async saveModelDocument(args) {
400
- const astDocument = await this.modelService.save(args);
401
- return this.encoder.astDocumentToTransferDocument(astDocument);
428
+ const astDocument = await this.requireSession(args.clientId).save(this.toSessionWrite(args));
429
+ return this.encodeDocument(astDocument);
402
430
  }
403
431
  /**
404
432
  * Record a watch for `(uri, clientId)`. Subsequent phase events on `uri`
405
433
  * fan out to the wired `clientProxy.onDocumentUpdated`. The
406
434
  * bidirectional pattern means the event channel is the client
407
435
  * notification surface, not a returned handle — this method only
408
- * registers the URI in the dispatch table.
436
+ * registers the watcher in {@link uriWatchRecords}.
409
437
  *
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.
438
+ * Also baselines the URI's emission fingerprint (see
439
+ * {@link dispatchPhaseEvent}) to the document's current state when the
440
+ * first watcher for the URI registers. This guarantees that any phase event firing immediately after
441
+ * the watch with no observable change is suppressed — watchers obtain
442
+ * initial state via `getModelDocument` (or {@link openModelDocument}) and
443
+ * do not need a redundant phase notification for that same state.
417
444
  */
418
445
  async watchModelDocument(args) {
419
446
  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)) {
447
+ const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set() };
448
+ this.uriWatchRecords.set(uri, record);
449
+ record.watchers.add(args.clientId);
450
+ if (record.fingerprint === undefined) {
427
451
  const document = this.services.workspace.LangiumDocuments.getDocument(UriUtils.toUri(uri));
428
452
  if (document) {
429
- this.lastEmittedFingerprint.set(uri, this.computeDocumentFingerprint(document));
453
+ record.fingerprint = this.computeDocumentFingerprint(document);
430
454
  }
431
455
  }
432
456
  }
433
457
  /**
434
458
  * Remove a watch for `(uri, clientId)` previously created by
435
459
  * {@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.
460
+ * Dispatch for `uri` stops once no watchers remain, and the emission
461
+ * fingerprint goes with the last watcher (see {@link pruneUriWatchRecord}).
440
462
  */
441
463
  async unwatchModelDocument(args) {
442
464
  const uri = this.canonicalKey(args.uri);
443
- const subscribers = this.subscriptions.get(uri);
444
- if (!subscribers) {
465
+ if (this.uriWatchRecords.get(uri)?.watchers.delete(args.clientId)) {
466
+ this.pruneUriWatchRecord(uri);
467
+ }
468
+ }
469
+ /**
470
+ * Drop what `uri` no longer needs: the
471
+ * {@link DataServerUriWatchRecord.fingerprint} once no client watches it,
472
+ * and the whole record once it holds no
473
+ * {@link DataServerUriWatchRecord.revertPending} mark either. Every path
474
+ * that removes a watcher or consumes a mark ends here.
475
+ */
476
+ pruneUriWatchRecord(uri) {
477
+ const record = this.uriWatchRecords.get(uri);
478
+ if (!record || record.watchers.size > 0) {
445
479
  return;
446
480
  }
447
- subscribers.delete(args.clientId);
448
- if (subscribers.size === 0) {
449
- this.subscriptions.delete(uri);
450
- this.lastEmittedFingerprint.delete(uri);
481
+ if (record.revertPending) {
482
+ record.fingerprint = undefined;
483
+ }
484
+ else {
485
+ this.uriWatchRecords.delete(uri);
451
486
  }
452
487
  }
453
488
  /**
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
489
+ * Canonicalise a URI string for use as a {@link uriWatchRecords} key, via the
490
+ * shared `DocumentUriPolicy`. Callers may send non-canonical URIs
491
+ * (drive-letter casing, percent-encoding differences, or a symlink path)
492
+ * over the wire; the dispatch side keys by
458
493
  * `document.uri.toString()` from `LangiumDocuments`, so writer keys must
459
494
  * canonicalise to the same form or events silently fail to deliver.
460
495
  * Routing through the seam (rather than a bare `UriUtils.normalize`)
@@ -498,20 +533,50 @@ export class DataServer {
498
533
  // Resolve the language's reference services from each request's source
499
534
  // (see resolveReferenceServices) and delegate.
500
535
  // ============================================================
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;
536
+ /**
537
+ * Settle the build before a reference question is answered from the index.
538
+ *
539
+ * A query issued right after a model update otherwise races the rebuild and
540
+ * reads an index missing the symbols it asks about. The cost is not confined
541
+ * to this call: a scope built inside that window is cached, and the build's
542
+ * remaining documents link against it.
543
+ *
544
+ * Waits the source document specifically, but ONLY when one is loaded at
545
+ * that URI: a synthetic source can address a URI with no document (a
546
+ * directory URI, typically), where a per-URI `waitUntil` throws "No document
547
+ * found". Falls back to a global settle, matching the id-based
548
+ * `ElementSource` path.
549
+ *
550
+ * Bounded by {@link DataServerOptions.referenceSettleTimeoutMs}.
551
+ */
552
+ async awaitReferencesLinked(source) {
553
+ const uri = isDocumentSource(source) || isSyntheticSource(source) ? UriUtils.toUri(source.uri) : undefined;
510
554
  const waitUri = uri && this.services.workspace.LangiumDocuments.hasDocument(uri) ? uri : undefined;
511
- await this.services.workspace.DocumentBuilder.waitUntil(DocumentState.Linked, waitUri);
555
+ const stopwatch = this.services.Clock.stopwatch();
556
+ const linked = this.services.workspace.DocumentBuilder.waitUntil(DocumentState.Linked, waitUri);
557
+ if ((await this.services.Clock.raceTimer(linked, this.options.referenceSettleTimeoutMs)) !== TIMED_OUT) {
558
+ return;
559
+ }
560
+ const elapsedMs = Math.round(stopwatch.elapsedMs);
561
+ // A per-URI wait resolves off a document-phase notification, so a
562
+ // missed one strands a wait on a document that HAS reached the
563
+ // phase. Re-read before failing; the workspace-wide wait has no
564
+ // equivalent reading and can only reject.
565
+ const document = waitUri ? this.services.workspace.LangiumDocuments.getDocument(waitUri) : undefined;
566
+ if (waitUri && document && document.state >= DocumentState.Linked) {
567
+ this.tracer
568
+ .withUri(waitUri.toString())
569
+ .warn(`Missed the 'Linked' notification after ${elapsedMs}ms; the document already reached it`);
570
+ return;
571
+ }
572
+ throw referenceSettleTimeoutError(elapsedMs);
573
+ }
574
+ async findReferenceCandidates(ctx) {
575
+ await this.awaitReferencesLinked(ctx.source);
512
576
  return this.resolveReferenceServices(ctx.source).CandidateProvider.find(ctx);
513
577
  }
514
578
  async resolveReference(ref) {
579
+ await this.awaitReferencesLinked(ref.source);
515
580
  const resolved = this.resolveReferenceServices(ref.source).CandidateProvider.resolveCandidate(ref);
516
581
  if (!resolved) {
517
582
  return undefined;
@@ -526,15 +591,32 @@ export class DataServer {
526
591
  // synthetic source — and the create-element flow driving this method is
527
592
  // the one that produces directory URIs, on which a bare
528
593
  // `getServices(uri)` throws while `findReferenceCandidates` succeeds.
529
- const nameProvider = this.resolveReferenceServices(ReferenceSource.synthetic(args.uri, args.type)).NameProvider;
594
+ const source = ReferenceSource.synthetic(args.uri, args.type, args.language);
595
+ // Mid-rebuild the names of documents not yet re-indexed are absent from
596
+ // the taken set, and the caller PERSISTS what it is handed. Nothing
597
+ // reserves the answer either, so a name is free of the collisions the
598
+ // index knows about and of nothing else — two callers racing get the same
599
+ // proposal, which only uniqueness at the write can catch.
600
+ await this.awaitReferencesLinked(source);
601
+ const nameProvider = this.resolveReferenceServices(source).NameProvider;
530
602
  const tier = args.tier ?? 'project';
531
603
  if (tier === 'public') {
532
604
  return nameProvider.findNextProjectQualifiedName(args.type, args.proposal);
533
605
  }
534
606
  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;
607
+ // Document-scoped uniqueness: the document root is the container. A
608
+ // URI with no document has nothing to collide with, like a document
609
+ // with no root.
610
+ try {
611
+ const document = await this.modelService.ensureDocumentState(args.uri);
612
+ return document.root ? nameProvider.findNextName(args.type, args.proposal, document.root) : args.proposal;
613
+ }
614
+ catch (error) {
615
+ if (this.isMissingDocument(error, args.uri)) {
616
+ return args.proposal;
617
+ }
618
+ throw error;
619
+ }
538
620
  }
539
621
  const project = this.services.workspace.ProjectManager.getProject(uri);
540
622
  if (!project) {
@@ -569,6 +651,9 @@ export class DataServer {
569
651
  /**
570
652
  * Pick the language that owns a reference source, in order:
571
653
  *
654
+ * 0. A {@link isSyntheticSource} naming its own `language` routes there.
655
+ * First because every step below infers, and an inference must not
656
+ * override a caller that has said which grammar it means.
572
657
  * 1. A URI-bearing source ({@link isDocumentSource}/{@link isSyntheticSource})
573
658
  * whose URI resolves to a registered language routes by URI.
574
659
  * 2. A single-language workspace always routes to that one language — so
@@ -587,6 +672,15 @@ export class DataServer {
587
672
  */
588
673
  resolveReferenceLanguage(source) {
589
674
  const registry = this.services.ServiceRegistry;
675
+ if (isSyntheticSource(source) && source.language !== undefined) {
676
+ const declared = registry.getServicesById(source.language);
677
+ if (declared) {
678
+ return declared;
679
+ }
680
+ // Falling through on an UNREGISTERED id rather than failing: the id
681
+ // crosses the wire, so a client built against a head with one more
682
+ // grammar would otherwise lose queries the steps below can answer.
683
+ }
590
684
  // `getServicesFor` (non-throwing, one ladder walk) gates the URI lookup:
591
685
  // an extensionless / unregistered URI falls through to the steps below
592
686
  // rather than throwing "no services for the extension ''".
@@ -675,6 +769,17 @@ export class DataServer {
675
769
  // ============================================================
676
770
  // Internal plumbing
677
771
  // ============================================================
772
+ /**
773
+ * Whether `error`, from waiting on `uri`'s document, means that `uri` has
774
+ * no document: a URI with neither a file nor text builds nothing, and
775
+ * Langium's wait after the build rejects for want of one, with a
776
+ * `ServerCancelled` response error. Any other failure, such as a read
777
+ * that fails before a document is registered, a cancelled wait or a
778
+ * `ReentrantWriteLockError`, is the caller's to see.
779
+ */
780
+ isMissingDocument(error, uri) {
781
+ return error instanceof ResponseError && error.code === SERVER_CANCELLED && this.modelService.getDocument(uri) === undefined;
782
+ }
678
783
  /**
679
784
  * Build a {@link TransferDocument} envelope from the current document state,
680
785
  * delegating root + diagnostic encoding to {@link encoder} (see
@@ -698,14 +803,34 @@ export class DataServer {
698
803
  // decides policy at its own layer; `root` is optional on the envelope
699
804
  // so the compiler forces that decision. Adopters preferring to throw
700
805
  // override `envelope`.
701
- return {
702
- uri: uri.toString(),
703
- version: 0,
704
- root: undefined,
705
- diagnostics: []
706
- };
806
+ return TransferDocument.absent(uri.toString());
707
807
  }
708
- return this.encoder.toTransferDocument(document);
808
+ return this.withServerState(this.encoder.toTransferDocument(document));
809
+ }
810
+ /**
811
+ * The transfer document a request answers with for `astDocument`, the
812
+ * store's current `dirty` and `textHash` stamped on it by
813
+ * {@link withServerState}. Every document a request answers with goes
814
+ * through here, so none goes out without the stamp.
815
+ */
816
+ encodeDocument(astDocument) {
817
+ return this.withServerState(this.encoder.astDocumentToTransferDocument(astDocument));
818
+ }
819
+ /**
820
+ * `document` with the store's current {@link TransferDocument.dirty} and
821
+ * the {@link TransferDocument.textHash} of the text the server holds for
822
+ * it: the store's text while a client has it open, the build's otherwise.
823
+ * Both are read when the document is sent rather than kept with the build:
824
+ * a save changes `dirty` without a rebuild, and the store's text moves on
825
+ * before the build that follows it.
826
+ */
827
+ withServerState(document) {
828
+ const text = (this.services.workspace.TextDocuments.get(document.uri) ?? this.modelService.getDocument(document.uri)?.textDocument)?.getText();
829
+ return {
830
+ ...document,
831
+ dirty: this.services.workspace.TextDocuments.isDirty(document.uri),
832
+ ...(text === undefined ? {} : { textHash: textHash(text) })
833
+ };
709
834
  }
710
835
  /**
711
836
  * Subscribe one listener at the configured {@link DataServerOptions.subscriptionPhase}.
@@ -715,6 +840,56 @@ export class DataServer {
715
840
  */
716
841
  subscribeToDocumentBuilder() {
717
842
  this.disposables.push(this.services.workspace.DocumentBuilder.onDocumentPhase(this.options.subscriptionPhase, (document, cancelToken) => this.dispatchPhaseEvent(document, cancelToken)));
843
+ // The BUILD-phase hook, not the per-document one: this notification is one
844
+ // message per build rather than one per document, and Langium hands the
845
+ // whole batch over here. It also does not fire for a cancelled build,
846
+ // which is what the per-document dispatch has to check by hand.
847
+ this.disposables.push(this.services.workspace.DocumentBuilder.onBuildPhase(this.options.subscriptionPhase, built => this.dispatchBuiltEvent(built)));
848
+ }
849
+ /**
850
+ * Report the documents that reached {@link DataServerOptions.subscriptionPhase}
851
+ * and that NOBODY on this
852
+ * connection is watching — the ones a client was not told about through
853
+ * {@link dispatchPhaseEvent}, which is gated per URI.
854
+ *
855
+ * **The gap this closes is the one no other source can observe.** A document
856
+ * the client watches, it hears about already. A file changed on disk, the
857
+ * host's own filesystem watcher reports — and on a browser host, where the
858
+ * workspace lives behind this head, an external change cannot happen at all.
859
+ * What is left, and what nothing outside the server can see, is a document
860
+ * rebuilt because something it DEPENDS ON changed: its file never changed, so
861
+ * a filesystem watcher is silent by construction, and it has no subscriber, so
862
+ * the update channel is silent by design. A consumer displaying data derived
863
+ * from that document — a tree label, a decorator — otherwise goes stale with
864
+ * no signal from any source, and repairs itself the moment someone opens the
865
+ * file to investigate, which is what makes it expensive to diagnose later.
866
+ *
867
+ * Payload-free on purpose: URIs only, so a client re-reads what it displays
868
+ * rather than being handed transfer documents it did not ask for. That is the
869
+ * property the watcher gate protects, and it is preserved here by
870
+ * carrying no document rather than by gating the message.
871
+ *
872
+ * Quiet in the common case. Editing a document that an editor has open leaves
873
+ * that URI watched and therefore out of this set, so a build with no
874
+ * dependents produces nothing at all, and workspace initialisation produces
875
+ * nothing because it does not build to this phase. The ceiling is a
876
+ * whole-workspace rebuild at the subscription phase: one message, URIs only.
877
+ *
878
+ * The URI is canonicalised for the same reason {@link uriWatchRecords} is keyed
879
+ * that way, and is untested for the same reason as its twin in
880
+ * {@link dispatchDeleteEvents}: the builder reports URIs out of its own
881
+ * store, so a non-canonical one cannot be produced without a fixture
882
+ * asserting a shape the real system never emits.
883
+ */
884
+ dispatchBuiltEvent(built) {
885
+ const uris = built
886
+ .map(document => this.canonicalKey(document.uri.toString()))
887
+ .filter(uri => !this.uriWatchRecords.get(uri)?.watchers.size);
888
+ if (uris.length === 0) {
889
+ return;
890
+ }
891
+ this.tracer.debug(`Emit onDocumentsBuilt: ${uris.length} unwatched document(s)`);
892
+ this.clientProxy.onDocumentsBuilt({ uris });
718
893
  }
719
894
  /**
720
895
  * Subscribe to the universal save event on `HydraniumTextDocuments` so a
@@ -733,29 +908,107 @@ export class DataServer {
733
908
  subscribeToTextDocumentSaves() {
734
909
  this.disposables.push(this.services.workspace.TextDocuments.onDidSave(event => this.dispatchSaveEvent(event)));
735
910
  }
911
+ /** Relay each change of a document's dirty state; see {@link dispatchDirtyEvent}. */
912
+ subscribeToDirtyChanges() {
913
+ this.disposables.push(this.services.workspace.TextDocuments.onDidChangeDirty(event => this.dispatchDirtyEvent(event)));
914
+ }
915
+ /**
916
+ * Send a dirty flip to the connection, gated on the URI's watchers as
917
+ * {@link dispatchSaveEvent} is: the answer at any one moment travels on
918
+ * every document sent, so a client that watches nothing reads it there.
919
+ */
920
+ dispatchDirtyEvent(event) {
921
+ const uri = this.canonicalKey(event.uri);
922
+ if (this.uriWatchRecords.get(uri)?.watchers.size) {
923
+ this.clientProxy.onDocumentDirtyChanged({ uri, dirty: event.dirty });
924
+ }
925
+ }
736
926
  /**
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.
927
+ * Mark each document the store releases after its last close, so
928
+ * {@link dispatchPhaseEvent} broadcasts the following rebuild even without
929
+ * a watcher. The store rebuilds such a document from its disk content,
930
+ * discarding unsaved in-session edits, and the last close typically also
931
+ * removed the last watcher: without the broadcast, a consumer that only
932
+ * ever fetches via `getModelDocument` keeps showing the discarded state.
933
+ * The broadcast is de-duplicated against the fingerprint while a watcher
934
+ * holds one, so a close whose disk state equals the last emitted state
935
+ * stays silent; with no watcher there is no fingerprint, and every revert
936
+ * is sent.
937
+ *
938
+ * A release, not the close itself: a document whose last client lost its
939
+ * connection is released only once the revert grace runs out, or when
940
+ * another client opens it meanwhile, and not at all when a client lost
941
+ * from it opens it again within its own grace.
741
942
  */
742
943
  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
- }
944
+ this.disposables.push(this.services.workspace.TextDocuments.onDidCloseLastOpen(event => {
945
+ const uri = this.canonicalKey(event.uri);
946
+ const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set() };
947
+ record.revertPending = true;
948
+ this.uriWatchRecords.set(uri, record);
748
949
  }));
749
950
  }
750
- /** Fan out a save event for the document's URI, gated by the subscription map. */
951
+ /**
952
+ * Fan out a deletion for each removed URI, to EVERY client on the connection
953
+ * rather than only to the ones watching that URI.
954
+ *
955
+ * **Deliberately ungated, where {@link dispatchPhaseEvent} and
956
+ * {@link dispatchSaveEvent} are gated.** Those two carry a built document and
957
+ * fire on every build, so the watcher gate is what keeps bandwidth
958
+ * proportional to what a client asked for. A deletion is neither: it is one
959
+ * URI, it is rare, and it reports the workspace's STRUCTURE rather than a
960
+ * document's content. Gating it forces any consumer that displays the
961
+ * workspace — a model tree, a file decorator — to learn about disappearances
962
+ * from a filesystem watcher instead, which a client hosted in a browser has
963
+ * no way to run: its workspace lives behind the head. A client that does not
964
+ * care filters on the URI, which costs it a comparison.
965
+ *
966
+ * The precedent is the last-close revert broadcast (see
967
+ * {@link subscribeToTextDocumentCloses}), where the same judgement was already made
968
+ * in the other direction: a transition that matters enough is delivered
969
+ * without a subscription.
970
+ *
971
+ * Runs from the `DocumentBuilder.onUpdate` listener rather than from a phase
972
+ * listener, which is the only place a deletion is observable: `update`
973
+ * removes the document before deriving the rebuild set, so it is never built.
974
+ * That ordering also puts this notification ahead of the `'rebuilt'` events
975
+ * for the dependents whose references the deletion just broke.
976
+ *
977
+ * The `deleted` list arrives already expanded to concrete document URIs —
978
+ * `deleteDocuments` resolves a directory URI to the documents beneath it — so
979
+ * no caller has to handle a directory here.
980
+ *
981
+ * The URI's fingerprint and revert mark are dropped: they describe a
982
+ * document that no longer exists. A kept fingerprint is adopted as the
983
+ * baseline and suppresses the first emit after the file returns with its
984
+ * previous content.
985
+ *
986
+ * The watchers SURVIVE: a recreated file resumes delivering to them with no
987
+ * re-subscription, and a client that answers the deletion by closing
988
+ * releases the watch through `closeModelDocument` anyway.
989
+ */
990
+ dispatchDeleteEvents(deleted) {
991
+ for (const removed of deleted) {
992
+ const uri = this.canonicalKey(removed.toString());
993
+ const record = this.uriWatchRecords.get(uri);
994
+ if (record) {
995
+ record.fingerprint = undefined;
996
+ record.revertPending = undefined;
997
+ record.sentVersion = undefined;
998
+ this.pruneUriWatchRecord(uri);
999
+ }
1000
+ this.clientProxy.onDocumentDeleted({ uri });
1001
+ }
1002
+ }
1003
+ /** Fan out a save event for the document's URI, gated on the URI's watchers. */
751
1004
  dispatchSaveEvent(event) {
752
1005
  // 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
1006
+ // symlink path S); `uriWatchRecords` and `dispatchPhaseEvent` key by the
754
1007
  // CANONICAL identity R. Canonicalize before both the gate and the envelope so
755
1008
  // a save of a symlinked file isn't silently dropped (and the envelope resolves
756
1009
  // the R-keyed document rather than missing into an empty one).
757
1010
  const uri = this.canonicalKey(event.document.uri);
758
- if (!this.subscriptions.has(uri)) {
1011
+ if (!this.uriWatchRecords.get(uri)?.watchers.size) {
759
1012
  return;
760
1013
  }
761
1014
  const response = this.envelope(UriUtils.toUri(uri));
@@ -774,13 +1027,25 @@ export class DataServer {
774
1027
  * out to multiple local subscribers with an `Emitter<T>` — the
775
1028
  * framework deliberately does NOT promise multi-listener semantics.
776
1029
  *
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.
1030
+ * An event for a URI no client watches is NOT sent over the wire, so
1031
+ * bandwidth scales with watched URIs rather than with phase events; a
1032
+ * pending revert mark is the exception (see
1033
+ * {@link subscribeToTextDocumentCloses}).
1034
+ *
1035
+ * An event for a rebuild with no observable change since the last emit is
1036
+ * suppressed against the URI's fingerprint. Such rebuilds are routine: a
1037
+ * second client attaching to an open document makes
1038
+ * `HydraniumTextDocuments.refreshContent` fire `onDidChangeContent` purely
1039
+ * to re-trigger the build, and Langium rebuilds a document when a
1040
+ * dependency changes even if its diagnostics come out the same. Sent at a
1041
+ * version this head has not sent, they reach watchers as `'changed'`, and a
1042
+ * watcher that reads `'changed'` as another client's write and resets its
1043
+ * root to the server view loses the user's edits. The first {@link watchModelDocument} baselines the
1044
+ * fingerprint, so the first event after a watch is de-duplicated against
1045
+ * the state the watcher just fetched; it goes with the last watcher, so the
1046
+ * next first watch re-baselines rather than adopting a stale digest. A
1047
+ * digest keeps its memory constant in document size; see
1048
+ * {@link computeDocumentFingerprint} for the inputs.
784
1049
  */
785
1050
  dispatchPhaseEvent(document, cancelToken) {
786
1051
  if (cancelToken.isCancellationRequested) {
@@ -792,16 +1057,23 @@ export class DataServer {
792
1057
  return;
793
1058
  }
794
1059
  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) {
1060
+ const record = this.uriWatchRecords.get(uri);
1061
+ const revertedOnClose = record?.revertPending === true;
1062
+ if (!record || (record.watchers.size === 0 && !revertedOnClose)) {
801
1063
  return;
802
1064
  }
1065
+ if (revertedOnClose) {
1066
+ // Consumed even when watchers exist — the regular dispatch below
1067
+ // serves them, and the mark's attribution is more precise than the
1068
+ // post-close unknown client the manager's attribution would yield.
1069
+ // With no watcher the record goes now, so the fingerprint written
1070
+ // below lands on a detached record and the next first watch
1071
+ // re-baselines instead of adopting it.
1072
+ record.revertPending = undefined;
1073
+ this.pruneUriWatchRecord(uri);
1074
+ }
803
1075
  const fingerprint = this.computeDocumentFingerprint(document);
804
- if (this.lastEmittedFingerprint.get(uri) === fingerprint) {
1076
+ if (record.fingerprint === fingerprint) {
805
1077
  // A rebuild that produced no observable change since the last emit —
806
1078
  // suppressed so RPC subscribers don't see a no-op broadcast. Logged at
807
1079
  // debug so a *needed* re-broadcast wrongly suppressed by this dedup
@@ -809,11 +1081,19 @@ export class DataServer {
809
1081
  this.tracer.withUri(uri).debug(`Suppress onDocumentUpdated v${document.textDocument.version}: fingerprint unchanged`);
810
1082
  return;
811
1083
  }
812
- this.lastEmittedFingerprint.set(uri, fingerprint);
1084
+ record.fingerprint = fingerprint;
1085
+ // The manager's attribution, so this head names the same client as the
1086
+ // in-process heads do for one build, except for a version this head
1087
+ // already sent; see `DataServerUriWatchRecord.sentVersion`.
1088
+ const version = this.services.workspace.AstDocumentManager.isOpen(uri) ? document.textDocument.version : undefined;
1089
+ const { reason, sourceClientId } = version !== undefined && record.sentVersion === version
1090
+ ? { reason: 'rebuilt', sourceClientId: UNKNOWN_CLIENT_ID }
1091
+ : this.services.workspace.AstDocumentManager.attributeUpdate(document);
1092
+ record.sentVersion = version;
813
1093
  const event = {
814
1094
  document: this.envelope(document.uri),
815
- sourceClientId: revertedOnClose ? REVERT_ON_CLOSE_CLIENT_ID : this.resolveSourceClientId(document),
816
- reason: this.resolveUpdateReason(document.uri)
1095
+ sourceClientId: revertedOnClose ? REVERT_ON_CLOSE_CLIENT_ID : sourceClientId,
1096
+ reason
817
1097
  };
818
1098
  this.tracer
819
1099
  .withUri(uri)
@@ -839,7 +1119,7 @@ export class DataServer {
839
1119
  ? textDiagnosticsFingerprint(document)
840
1120
  : transferDocumentFingerprint(this.encoder.toTransferDocument(document));
841
1121
  const extra = this.additionalFingerprintInputs(document);
842
- return extra.length === 0 ? base : fingerprintHash([base, FINGERPRINT_SEPARATOR, ...extra.map(value => JSON.stringify(value))]);
1122
+ return extra.length === 0 ? base : textHash([base, FINGERPRINT_SEPARATOR, ...extra.map(value => JSON.stringify(value))]);
843
1123
  }, 'debug', { logAfterMs: FINGERPRINT_LOG_AFTER_MS });
844
1124
  }
845
1125
  /**
@@ -852,30 +1132,6 @@ export class DataServer {
852
1132
  additionalFingerprintInputs(_document) {
853
1133
  return [];
854
1134
  }
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';
878
- }
879
1135
  /**
880
1136
  * Subscribe to the project tier's change channel and re-fan registry
881
1137
  * diffs into per-project wire notifications. The internal
@@ -917,19 +1173,6 @@ export class DataServer {
917
1173
  this.clientProxy.onProjectsChanged({ project: entry.snapshot, reason: 'removed' });
918
1174
  }
919
1175
  }
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
1176
  // --- Diagnostics (DataServerDiagnosticsProtocol) ---------------------------
934
1177
  // Computed in THIS process: the data-server child holds the model store, so
935
1178
  // these snapshots reflect the heap that actually carries the workspace
@@ -967,7 +1210,7 @@ export class DataServer {
967
1210
  }
968
1211
  async stopProfiling(args) {
969
1212
  if (!this.activeProfile) {
970
- throw new Error('No profiling capture is active; call startProfiling first.');
1213
+ throw noActiveProfileError();
971
1214
  }
972
1215
  const capture = this.activeProfile;
973
1216
  this.activeProfile = undefined;
@@ -996,7 +1239,8 @@ export class DataServer {
996
1239
  methodNamespace: partial.methodNamespace ?? DATA_SERVER_WIRE_PREFIX,
997
1240
  additionalMethods,
998
1241
  excludedMethods: partial.excludedMethods ?? [],
999
- diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics()
1242
+ diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics(),
1243
+ referenceSettleTimeoutMs: partial.referenceSettleTimeoutMs ?? DataServer.DEFAULT_OPTIONS.referenceSettleTimeoutMs
1000
1244
  };
1001
1245
  }
1002
1246
  }