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

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