@hydranium/data-server 1.0.0-next.4 → 1.0.0-next.400

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.
Files changed (35) hide show
  1. package/README.md +57 -73
  2. package/lib/browser/index.d.ts +10 -0
  3. package/lib/browser/index.d.ts.map +1 -0
  4. package/lib/browser/index.js +15 -0
  5. package/lib/browser/index.js.map +1 -0
  6. package/lib/browser/start-data-server-in-worker.d.ts +23 -0
  7. package/lib/browser/start-data-server-in-worker.d.ts.map +1 -0
  8. package/lib/browser/start-data-server-in-worker.js +29 -0
  9. package/lib/browser/start-data-server-in-worker.js.map +1 -0
  10. package/lib/data-server.d.ts +475 -290
  11. package/lib/data-server.d.ts.map +1 -1
  12. package/lib/data-server.js +813 -501
  13. package/lib/data-server.js.map +1 -1
  14. package/lib/messages/index.d.ts +18 -0
  15. package/lib/messages/index.d.ts.map +1 -0
  16. package/lib/messages/index.js +18 -0
  17. package/lib/messages/index.js.map +1 -0
  18. package/lib/node/node-diagnostics-provider.d.ts.map +1 -1
  19. package/lib/node/node-diagnostics-provider.js +3 -2
  20. package/lib/node/node-diagnostics-provider.js.map +1 -1
  21. package/lib/testing/data-server-harness.d.ts +31 -14
  22. package/lib/testing/data-server-harness.d.ts.map +1 -1
  23. package/lib/testing/data-server-harness.js +8 -3
  24. package/lib/testing/data-server-harness.js.map +1 -1
  25. package/lib/testing/index.d.ts +1 -0
  26. package/lib/testing/index.d.ts.map +1 -1
  27. package/lib/testing/index.js.map +1 -1
  28. package/package.json +39 -38
  29. package/src/browser/index.ts +15 -0
  30. package/src/browser/start-data-server-in-worker.ts +35 -0
  31. package/src/data-server.ts +994 -541
  32. package/src/messages/index.ts +26 -0
  33. package/src/node/node-diagnostics-provider.ts +3 -9
  34. package/src/testing/data-server-harness.ts +55 -26
  35. package/src/testing/index.ts +5 -2
@@ -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 { asModelVersion, createRpcProxy, defineMessage, describeErrorWithStack, DisposableCollection, HYDRANIUM_ERROR_CODES, isDocumentSource, isElementSource, isResponseError, ConflictError, isModelVersion, isSyntheticSource, messageData, messageError, ReferenceSource, SessionClosedError, TIMED_OUT, TransferDocument, UNKNOWN_CLIENT_ID, STALE_BASE_VERSION_SAVE, STALE_BASE_VERSION_UPDATE, 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 { DOCUMENT_RELEASE_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,30 @@ import { DocumentState, UriUtils } from '@hydranium/langium';
19
51
  */
20
52
  const FINGERPRINT_SEPARATOR = '\0';
21
53
  /**
22
- * Portable, non-cryptographic 64-bit fingerprint hash (cyrb53), returning a
23
- * 16-char hex digest.
24
- *
25
- * **A cryptographic hash via `node:crypto` is the wrong trade**: the
26
- * fingerprint only needs a stable signal that `(text, diagnostics)` changed
27
- * between emissions, and a `node:*` import would cost
28
- * `@hydranium/data-server` its browser-portability. Parts are fed
29
- * incrementally, char by char, so multi-MB document text is never
30
- * concatenated into one string.
54
+ * `LSPErrorCodes.ServerCancelled`, with which Langium's document wait rejects
55
+ * for a URI that has no document; `vscode-languageserver-protocol` is not a
56
+ * dependency of this package.
31
57
  */
32
- function fingerprintHash(parts) {
33
- let h1 = 0xdeadbeef;
34
- let h2 = 0x41c6ce57;
35
- for (const part of parts) {
36
- for (let i = 0; i < part.length; i++) {
37
- const ch = part.charCodeAt(i);
38
- h1 = Math.imul(h1 ^ ch, 2654435761);
39
- h2 = Math.imul(h2 ^ ch, 1597334677);
40
- }
41
- }
42
- h1 = Math.imul(h1 ^ (h1 >>> 16), 2246822507);
43
- h1 ^= Math.imul(h2 ^ (h2 >>> 13), 3266489909);
44
- h2 = Math.imul(h2 ^ (h2 >>> 16), 2246822507);
45
- h2 ^= Math.imul(h1 ^ (h1 >>> 13), 3266489909);
46
- const high = (h2 >>> 0).toString(16).padStart(8, '0');
47
- const low = (h1 >>> 0).toString(16).padStart(8, '0');
48
- return high + low;
49
- }
50
- /** Hash a document's raw text + diagnostics — the `'text-diagnostics'` strategy. */
51
- function textDiagnosticsFingerprint(document) {
52
- return fingerprintHash([document.textDocument.getText(), FINGERPRINT_SEPARATOR, JSON.stringify(document.diagnostics ?? [])]);
58
+ const SERVER_CANCELLED = -32802;
59
+ /**
60
+ * Hash `text`, the text the model was parsed from, + `model`'s diagnostics — the `'text-diagnostics'` strategy.
61
+ * The text comes from the root's ledger record or CST, as the document's own may have moved on,
62
+ * and a repair in place leaves the CST on the unrepaired text;
63
+ * a root built without a CST hashes as `'transfer-document'`.
64
+ * Absent diagnostics must hash apart from `[]`, as in {@link transferDocumentFingerprint}.
65
+ */
66
+ function textDiagnosticsFingerprint(text, model) {
67
+ return text === undefined
68
+ ? transferDocumentFingerprint(model)
69
+ : textHash([text, FINGERPRINT_SEPARATOR, JSON.stringify(model.diagnostics ?? null)]);
53
70
  }
54
- /** Hash an encoded transfer document's root + diagnostics — the `'transfer-document'` strategy. */
55
- function transferDocumentFingerprint(transferDocument) {
56
- // null, not undefined: `JSON.stringify(undefined)` yields undefined rather
57
- // than a string, putting a non-string into the hash inputs.
58
- return fingerprintHash([
59
- JSON.stringify(transferDocument.root ?? null),
60
- FINGERPRINT_SEPARATOR,
61
- JSON.stringify(transferDocument.diagnostics)
62
- ]);
71
+ /**
72
+ * Hash an encoded model's root + diagnostics — the `'transfer-document'` strategy.
73
+ * Absent diagnostics must hash apart from `[]`: a client skipping a render on an
74
+ * equal hash would otherwise miss a validation that found nothing.
75
+ */
76
+ function transferDocumentFingerprint(model) {
77
+ return textHash([JSON.stringify(model.root), FINGERPRINT_SEPARATOR, JSON.stringify(model.diagnostics ?? null)]);
63
78
  }
64
79
  /**
65
80
  * `logAfterMs` threshold passed to {@link Tracer.time} around
@@ -90,13 +105,19 @@ const FINGERPRINT_LOG_AFTER_MS = 5;
90
105
  * adopters subclass ONLY when they need to decorate wire returns or
91
106
  * notifications. The usual adoption path is DI rebinds alone.
92
107
  *
108
+ * **`TTransfer` is not checked.** It declares the union of the transfer roots
109
+ * the workspace's languages produce. Which root a document has is known only
110
+ * at runtime, from its language, so a `TTransfer` missing a language compiles.
111
+ *
93
112
  * Lifecycle: the constructor registers framework request handlers (plus
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 follows documents
117
+ * through `ModelService`'s events: at the configured phase, `onModelUpdated`
118
+ * dispatches per-document `clientProxy.onDocumentUpdated` for watched URIs and
119
+ * `onModelsBuilt` a single `clientProxy.onDocumentsBuilt` naming the batch's
120
+ * 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,40 @@ 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.
132
- *
133
- * Kept because the document store releases a client's hold only from an
134
- * explicit close, and a client that dies without closing would otherwise keep
135
- * the document open forever — resident, and with its last-close revert
136
- * suppressed. The store has no notion of which connection a clientId reached
137
- * it over, so the connection-scoped set has to live here; teaching it a client
138
- * identity is the more robust and much larger alternative.
139
- */
140
- openedDocuments = new Map();
141
- /** Typed client proxy — sends `data-server/on*` notifications back over the same wire. */
142
- clientProxy;
143
- disposables = new DisposableCollection();
152
+ * Per client id, the key each URI it watched resolved to when it watched.
153
+ * An unwatch looks the key up here: once a file is gone, a symlink to it
154
+ * no longer resolves to the key the watch is under.
155
+ */
156
+ watchKeys = new Map();
144
157
  /**
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.
158
+ * The position of the last update or deletion event sent, which each
159
+ * such event carries, and a watch's answer carries as of the moment it
160
+ * took whether its document exists: an event past it was sent after.
151
161
  */
152
- lastBuildUpdate;
162
+ eventSequence = 0;
153
163
  /**
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();
164
+ * The live client sessions this connection registered, by client id. A
165
+ * document request carrying one of these ids acts as that session; one
166
+ * carrying any other id fails. A session leaves once it ends, so a
167
+ * connection that registers many over its life does not accumulate them.
168
+ */
169
+ clientSessions = new Map();
170
+ /**
171
+ * Typed client proxy — sends `data-server/on*` notifications back over the same wire.
172
+ * The proxy sends any `on[A-Z]*` name other than `onDidOpenConnection` and
173
+ * `onDidCloseConnection`, for which it returns its own events, so a subclass
174
+ * with notifications of its own narrows only the type:
175
+ * `declare protected readonly clientProxy: TheirClient`.
176
+ */
177
+ clientProxy;
178
+ disposables = new DisposableCollection();
203
179
  tracer;
204
180
  /** The in-flight interactive profile capture, held between {@link startProfiling} and {@link stopProfiling}. */
205
181
  activeProfile;
@@ -211,11 +187,8 @@ export class DataServer {
211
187
  encoder;
212
188
  /**
213
189
  * 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`.
190
+ * Its documents carry the AST-layer {@link AstDiagnostic}, never the wire `TDiagnostic`:
191
+ * {@link encoder} converts one into the other on the way out.
219
192
  */
220
193
  modelService;
221
194
  constructor(connection, services, options = {}) {
@@ -224,8 +197,7 @@ export class DataServer {
224
197
  this.options = this.resolveOptions(options);
225
198
  this.tracer = this.services.Tracer.for(options.logName ?? 'DataServer').trace('instantiated');
226
199
  // 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.
200
+ // `services.model.ModelService` with their own subclasses.
229
201
  const { TransferEncoder: encoder, ModelService: modelService } = this.services.model;
230
202
  if (!encoder || !modelService) {
231
203
  throw new Error('DataServer requires `services.model.TransferEncoder` and `services.model.ModelService` to be bound. ' +
@@ -248,35 +220,42 @@ export class DataServer {
248
220
  methodNamespace: this.options.methodNamespace,
249
221
  localTarget: this,
250
222
  localMethods: registeredMethods,
251
- latency: this.latency
223
+ latency: this.latency,
224
+ // Bound at the chokepoint rather than per handler, so an adopter's
225
+ // `additionalMethods` are rendered on the same terms as the
226
+ // framework's own rejections.
227
+ renderErrorMessage: error => this.services.MessageRenderer.renderError(error)
252
228
  });
253
- this.disposables.push(this.services.workspace.DocumentBuilder.onUpdate((changed, deleted) => {
254
- this.lastBuildUpdate = { changed, deleted };
255
- }));
256
- this.subscribeToDocumentBuilder();
229
+ this.disposables.push(this.modelService.onModelDeleted(event => this.dispatchDeleteEvent(event)));
230
+ this.subscribeToModelUpdates();
257
231
  this.subscribeToTextDocumentSaves();
258
- this.subscribeToTextDocumentCloses();
232
+ this.subscribeToDirtyChanges();
233
+ this.subscribeToModelReleases();
259
234
  this.subscribeToProjectManager();
260
235
  // Self-register teardown so an adopter that keeps no reference to the
261
236
  // server still releases per-connection state, with no lifecycle hook of
262
- // its own. See `dispose`.
263
- this.disposables.push(connection.onClose(() => this.dispose()));
237
+ // its own. The client did not close anything itself, so its sessions end
238
+ // as lost and each document it was the last to have open waits out the
239
+ // store's release grace. See `dispose`.
240
+ this.disposables.push(connection.onClose(() => this.dispose('lost')));
264
241
  }
265
242
  /**
266
243
  * 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.
244
+ * handlers and every listener — and clear {@link uriWatchRecords}, so a
245
+ * long-lived shared services bundle does not retain per-connection memory
246
+ * after the connection closes. Also ends every session this connection registered, which closes
247
+ * every document it has open: the SHARED store's state rather than this
248
+ * server's, which outlives the connection unless released here.
273
249
  *
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.
250
+ * Idempotent: subsequent calls are no-ops. Runs by itself when the
251
+ * connection closes, so adopters who don't hold a reference still get
252
+ * per-connection cleanup; adopters that DO hold a reference may call
253
+ * `dispose()` directly for early teardown. The sessions end with `cause`:
254
+ * `'closed'` releases every document whose last open they close at once,
255
+ * and `'lost'`, the connection's own close, lets each wait out the release
256
+ * grace.
278
257
  */
279
- dispose() {
258
+ dispose(cause = 'closed') {
280
259
  this.disposed = true;
281
260
  // Release an in-flight interactive capture so the process-wide inspector
282
261
  // singleton is not left active after the connection closes.
@@ -285,98 +264,163 @@ export class DataServer {
285
264
  this.activeProfile = undefined;
286
265
  void capture.stop({}).catch(() => undefined);
287
266
  }
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.
267
+ // AFTER `disposables.dispose()`, deliberately: ending a session releases
268
+ // each document it was the last to hold, and this server's own
269
+ // `onModelReleased` subscription would otherwise mark a release broadcast
270
+ // for a connection that is already gone.
291
271
  this.disposables.dispose();
292
- this.closeOpenDocuments();
293
- this.subscriptions.clear();
294
- this.lastEmittedFingerprint.clear();
295
- this.pendingRevertBroadcasts.clear();
272
+ for (const [clientId, session] of this.clientSessions) {
273
+ this.endSession(clientId, session, cause);
274
+ }
275
+ this.uriWatchRecords.clear();
276
+ this.watchKeys.clear();
296
277
  }
297
278
  // ============================================================
298
- // DataServerProtocol implementation — delegates to ModelService.
279
+ // DataServerProtocol implementation
299
280
  // ============================================================
300
281
  //
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) };
282
+ // Reads go to `ModelService`; a request that opens or writes a document
283
+ // goes to the session this connection registered under its `clientId`.
284
+ // Each answer is encoded on the wire boundary via
285
+ // `encoder.astDocumentToTransferDocument`. To change how documents are
286
+ // read, override on the ModelService subclass; to change how they are
287
+ // written, on the session class the bound `ClientSessionFactory` builds.
288
+ async createSession(args) {
289
+ // After teardown nothing would ever end a session registered now, and its
290
+ // id would stay taken for the life of the process.
291
+ if (this.disposed) {
292
+ throw new SessionClosedError(args.clientId);
293
+ }
294
+ const session = this.modelService.createSession(args.label, args.clientId, { resumeToken: args.resumeToken });
295
+ this.clientSessions.set(args.clientId, session);
296
+ // A session also ends without closeSession, as when a client registers
297
+ // again on another connection, and its watches and entry here would
298
+ // otherwise outlive it.
299
+ session.onDidDispose(cause => {
300
+ // A session class may report its end late, once a replacement holds
301
+ // the id here; the replacement's entry and watches stay.
302
+ if (this.clientSessions.get(args.clientId) !== session) {
303
+ return;
304
+ }
305
+ this.dropWatches(args.clientId);
306
+ this.clientSessions.delete(args.clientId);
307
+ this.tracer.debug(`Forget session ${args.clientId}: it ended as ${cause}`);
308
+ });
309
+ return { epoch: this.epoch };
333
310
  }
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);
311
+ /**
312
+ * The epoch this server numbers versions in, which every registration and
313
+ * document names: the text store's, so every connection to the server
314
+ * answers the same one.
315
+ */
316
+ get epoch() {
317
+ return this.services.workspace.TextDocuments.epoch;
341
318
  }
342
319
  /**
343
- * Drop the recorded hold for `(uri, clientId)` so {@link dispose} does not
344
- * close it a second time. Idempotent.
320
+ * Refuse a write whose base version is numbered in another epoch, as a
321
+ * restarted server's predecessor numbered it. Versions start afresh with
322
+ * each epoch, so the session's gate would take the version for text the
323
+ * writer never saw. Checked once the session is found, before the open
324
+ * check and every other check of its documents.
345
325
  */
346
- forgetOpenDocument(uri, clientId) {
347
- const holders = this.openedDocuments.get(uri);
348
- if (!holders) {
349
- return;
326
+ assertEpoch(uri, gate, message = STALE_BASE_VERSION_UPDATE) {
327
+ if (isModelVersion(gate.baseVersion) && gate.baseEpoch !== this.epoch) {
328
+ this.tracer.withUri(uri).debug(`Conflict: base v${gate.baseVersion} is numbered in epoch ${gate.baseEpoch}, not ${this.epoch}`);
329
+ throw new ConflictError(uri, gate.baseVersion, this.services.workspace.TextDocuments.version(uri), message);
350
330
  }
351
- holders.delete(clientId);
352
- if (holders.size === 0) {
353
- this.openedDocuments.delete(uri);
331
+ }
332
+ /** End a session this connection registered. */
333
+ async closeSession(args) {
334
+ const session = this.clientSessions.get(args.clientId);
335
+ if (session) {
336
+ this.endSession(args.clientId, session);
354
337
  }
355
338
  }
356
- /**
357
- * Close every document still open over this connection, for the clients that
358
- * opened it here.
359
- *
360
- * The document store releases a per-URI hold only from an explicit close, so
361
- * without this a client that dies mid-session keeps its documents open for the
362
- * lifetime of the process: `isOpenInAnyClient` stays true, the document stays
363
- * resident, and the last-close revert never runs. A long-lived multi-client
364
- * head is the configuration where a dead client is normal rather than
365
- * exceptional, so the leak accumulates there.
366
- *
367
- * Runs from {@link dispose}, which is synchronous, so each close is fired and
368
- * its failure swallowed — a teardown must not reject, and a URI whose close
369
- * fails is no worse off than it was before this drain existed.
370
- */
371
- closeOpenDocuments() {
372
- const held = [...this.openedDocuments];
373
- this.openedDocuments.clear();
374
- for (const [uri, clientIds] of held) {
375
- for (const clientId of clientIds) {
376
- void Promise.resolve(this.modelService.close({ uri, clientId })).catch(() => undefined);
339
+ /** End `session`, registered here under `clientId`, with `cause`, and drop its watches on this connection. */
340
+ endSession(clientId, session, cause = 'closed') {
341
+ this.dropWatches(clientId);
342
+ session.dispose(cause);
343
+ }
344
+ dropWatches(clientId) {
345
+ this.watchKeys.delete(clientId);
346
+ for (const [uri, record] of this.uriWatchRecords) {
347
+ if (record.watchers.delete(clientId)) {
348
+ this.pruneUriWatchRecord(uri);
377
349
  }
378
350
  }
379
351
  }
352
+ async createModelDocument(args) {
353
+ const session = this.requireSession(args.clientId);
354
+ const version = await session.create(args.uri, args.text);
355
+ const snapshot = await this.openedSnapshot(args.uri, () => session.close(args.uri));
356
+ return { ...snapshot, created: { version: asModelVersion(version) } };
357
+ }
358
+ async updateModelDocuments(args) {
359
+ const session = this.requireSession(args.clientId);
360
+ // Every one before any applies, so a set stays all or none.
361
+ args.updates.forEach(update => this.assertEpoch(update.uri, update));
362
+ const astDocuments = await session.updateAll({
363
+ updates: args.updates.map(update => this.toSessionWrite(update)),
364
+ write: args.write
365
+ });
366
+ // A page that reads unsaved work from its editor sees the writes only once their text reaches it.
367
+ await Promise.all(args.updates.map(update => this.modelService.settleLanguageClient(update.uri)));
368
+ return astDocuments.map(astDocument => ({ ...this.encodeDocument(astDocument), written: astDocument.written }));
369
+ }
370
+ /**
371
+ * The session write a wire write request carries. Only the fields a session
372
+ * takes: a field an adopter adds to a request reaches the session only
373
+ * through an override of this.
374
+ */
375
+ toSessionWrite(request) {
376
+ return { uri: request.uri, model: request.model, baseVersion: request.baseVersion, restore: request.restore, write: request.write };
377
+ }
378
+ /**
379
+ * The session this connection registered under `clientId`, which every
380
+ * document request acts as. An id that is not one fails with the
381
+ * closed-session code: opening or writing under it would leave an open that
382
+ * no session end ever closes.
383
+ */
384
+ requireSession(clientId) {
385
+ const session = this.clientSessions.get(clientId);
386
+ if (!session) {
387
+ throw new SessionClosedError(clientId, 'The client session is not registered on this connection.');
388
+ }
389
+ return session;
390
+ }
391
+ async openModelDocument(args) {
392
+ const session = this.requireSession(args.clientId);
393
+ const wasOpen = this.services.workspace.TextDocuments.isOpenInClient(args.uri, args.clientId);
394
+ await session.open(args.uri, args.options);
395
+ // A repeat open keeps the earlier one, which is still in use.
396
+ return this.openedSnapshot(args.uri, wasOpen ? undefined : () => session.close(args.uri));
397
+ }
398
+ /**
399
+ * The snapshot a session's open or create answers with. When the read
400
+ * fails, `rollback` undoes the open this call made before the failure is
401
+ * rethrown: the caller sees no open, so nothing on its side would ever close
402
+ * it.
403
+ */
404
+ async openedSnapshot(uri, rollback) {
405
+ try {
406
+ return await this.getModelDocument({ uri });
407
+ }
408
+ catch (error) {
409
+ // The open's failure is the one the caller needs, not the cleanup's.
410
+ await rollback?.().catch(() => undefined);
411
+ throw error;
412
+ }
413
+ }
414
+ async closeModelDocument(args) {
415
+ // Through the handle, so a close under an ended session fails as that
416
+ // session's calls do, and a session class's own close is honoured.
417
+ const session = this.requireSession(args.clientId);
418
+ // Closing also releases the watch for (uri, clientId) — a forgotten
419
+ // unwatch would otherwise leak phase-event dispatch until the connection
420
+ // closes. Idempotent: a close without a prior watch is a no-op.
421
+ await this.unwatchModelDocument({ uri: args.uri, clientId: args.clientId });
422
+ await session.close(args.uri);
423
+ }
380
424
  async getModelDocument(args) {
381
425
  // Smart dispatch: a warm document (already in LangiumDocuments) is
382
426
  // returned at its settle phase without a redundant build; a cold URI
@@ -389,72 +433,149 @@ export class DataServer {
389
433
  // unsubscribed caller that needs diagnostics inline passes
390
434
  // `includeDiagnostics: true` to settle at `Validated` instead.
391
435
  const state = args.includeDiagnostics ? DocumentState.Validated : undefined;
392
- const astDocument = await this.modelService.ensureDocumentState(args.uri, state);
393
- return this.encoder.astDocumentToTransferDocument(astDocument);
436
+ try {
437
+ return this.encodeDocument(await this.modelService.ensureDocumentState(args.uri, state));
438
+ }
439
+ catch (error) {
440
+ // The protocol answers a read of a URI with no document with an
441
+ // envelope that has no model.
442
+ if (this.isMissingDocument(error, args.uri)) {
443
+ return this.envelope(UriUtils.toUri(args.uri));
444
+ }
445
+ throw error;
446
+ }
394
447
  }
395
448
  async updateModelDocument(args) {
396
- const astDocument = await this.modelService.update(args);
397
- return this.encoder.astDocumentToTransferDocument(astDocument);
449
+ const session = this.requireSession(args.clientId);
450
+ this.assertEpoch(args.uri, args);
451
+ const astDocument = await session.update(this.toSessionWrite(args));
452
+ // A page that reads unsaved work from its editor sees the write only once the text reaches it.
453
+ await this.modelService.settleLanguageClient(args.uri);
454
+ return { ...this.encodeDocument(astDocument), written: astDocument.written };
398
455
  }
399
456
  async saveModelDocument(args) {
400
- const astDocument = await this.modelService.save(args);
401
- return this.encoder.astDocumentToTransferDocument(astDocument);
457
+ const session = this.requireSession(args.clientId);
458
+ this.assertEpoch(args.uri, args, STALE_BASE_VERSION_SAVE);
459
+ const astDocument = await session.save(this.toSessionWrite(args));
460
+ await this.modelService.settleLanguageClient(args.uri);
461
+ return { ...this.encodeDocument(astDocument), persisted: astDocument.persisted };
462
+ }
463
+ async persistModelDocument(args) {
464
+ const session = this.requireSession(args.clientId);
465
+ this.assertEpoch(args.uri, args, STALE_BASE_VERSION_SAVE);
466
+ const version = await session.persist({ uri: args.uri, baseVersion: args.baseVersion });
467
+ await this.modelService.settleLanguageClient(args.uri);
468
+ const astDocument = await this.modelService.ensureDocumentState(args.uri, this.services.workspace.DocumentBuilder.finalBuildState());
469
+ return { ...this.encodeDocument(astDocument), persisted: { version } };
402
470
  }
403
471
  /**
404
- * Record a watch for `(uri, clientId)`. Subsequent phase events on `uri`
405
- * fan out to the wired `clientProxy.onDocumentUpdated`. The
406
- * bidirectional pattern means the event channel is the client
407
- * notification surface, not a returned handle — this method only
408
- * registers the URI in the dispatch table.
472
+ * Delete the document through the session, then release the session's
473
+ * watch of it, as {@link closeModelDocument} does. Released only after the
474
+ * delete: one that fails leaves the session its open and its watch. Other
475
+ * sessions' watches survive, as for any deletion.
476
+ */
477
+ async deleteModelDocument(args) {
478
+ const session = this.requireSession(args.clientId);
479
+ this.assertEpoch(args.uri, args);
480
+ // Keyed before the delete: once the file is gone, a symlink to it no
481
+ // longer resolves to the key the watch is under.
482
+ const uri = this.canonicalKey(args.uri);
483
+ await session.delete({ uri: args.uri, baseVersion: args.baseVersion });
484
+ await this.unwatchModelDocument({ uri, clientId: args.clientId });
485
+ }
486
+ /**
487
+ * Record a watch for `(uri, clientId)` in {@link uriWatchRecords}.
488
+ * Subsequent phase events on `uri` fan out to the wired
489
+ * `clientProxy.onDocumentUpdated`. The bidirectional pattern means the
490
+ * event channel is the client notification surface, not a returned
491
+ * handle.
492
+ *
493
+ * Also baselines the URI's emission fingerprint (see
494
+ * {@link dispatchPhaseEvent}) to the document's current state when the
495
+ * first watcher for the URI registers. This guarantees that any phase event firing immediately after
496
+ * the watch with no observable change is suppressed — watchers obtain
497
+ * initial state via `getModelDocument` (or {@link openModelDocument}) and
498
+ * do not need a redundant phase notification for that same state.
409
499
  *
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.
500
+ * Answers once the document is loaded as a read loads it, with the key
501
+ * events name it by and whether a document exists, taken after the watch
502
+ * is in place and the load, so an event sent while it loads is older.
417
503
  */
418
504
  async watchModelDocument(args) {
419
505
  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)) {
427
- const document = this.services.workspace.LangiumDocuments.getDocument(UriUtils.toUri(uri));
428
- if (document) {
429
- this.lastEmittedFingerprint.set(uri, this.computeDocumentFingerprint(document));
506
+ const keys = this.watchKeys.get(args.clientId) ?? new Map();
507
+ this.watchKeys.set(args.clientId, keys.set(args.uri, uri));
508
+ const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set() };
509
+ this.uriWatchRecords.set(uri, record);
510
+ record.watchers.add(args.clientId);
511
+ if (record.fingerprint === undefined) {
512
+ const document = this.modelService.getDocument(args.uri);
513
+ if (document && !this.services.workspace.ModelLedger.isPlaceholder(document.parseResult.value)) {
514
+ record.fingerprint = this.computeDocumentFingerprint(document.parseResult.value, this.encoder.toTransferDocument(document));
515
+ record.fingerprintVersion = this.services.workspace.ModelLedger.versionOf(document.parseResult.value);
430
516
  }
431
517
  }
518
+ // As for a read, only a missing document counts as none. A file briefly
519
+ // unreadable leaves the builder's placeholder, and is there all the same.
520
+ // Whether it exists, the text held and the position of the last event
521
+ // sent are read in one synchronous run, so an event sent after is past
522
+ // the position and moves the text past the state answered.
523
+ const answer = (exists) => {
524
+ const text = exists ? this.serverTextState(args.uri) : undefined;
525
+ return { uri, epoch: this.epoch, exists, sequence: this.eventSequence, ...(text ? { text } : {}) };
526
+ };
527
+ return this.modelService.ensureDocumentState(args.uri).then(() => answer(this.modelService.getDocument(args.uri) !== undefined), (error) => answer(!this.isMissingDocument(error, args.uri)));
432
528
  }
433
529
  /**
434
530
  * Remove a watch for `(uri, clientId)` previously created by
435
531
  * {@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.
532
+ * Dispatch for `uri` stops once no watchers remain, and the emission
533
+ * fingerprint goes with the last watcher (see {@link pruneUriWatchRecord}).
534
+ *
535
+ * A URI the client watched is unwatched under the key it resolved to then,
536
+ * from {@link watchKeys}, which still holds once its file is gone.
440
537
  */
441
538
  async unwatchModelDocument(args) {
442
- const uri = this.canonicalKey(args.uri);
443
- const subscribers = this.subscriptions.get(uri);
444
- if (!subscribers) {
539
+ const keys = this.watchKeys.get(args.clientId);
540
+ const uri = keys?.get(args.uri) ?? this.canonicalKey(args.uri);
541
+ // Every spelling the client watched it under was this one watch.
542
+ keys?.forEach((key, spelling) => {
543
+ if (key === uri) {
544
+ keys.delete(spelling);
545
+ }
546
+ });
547
+ if (keys?.size === 0) {
548
+ this.watchKeys.delete(args.clientId);
549
+ }
550
+ if (this.uriWatchRecords.get(uri)?.watchers.delete(args.clientId)) {
551
+ this.pruneUriWatchRecord(uri);
552
+ }
553
+ }
554
+ /**
555
+ * Drop what `uri` no longer needs: the
556
+ * {@link DataServerUriWatchRecord.fingerprint} once no client watches it,
557
+ * and the whole record once it holds no
558
+ * {@link DataServerUriWatchRecord.releaseBroadcastPending} mark either.
559
+ * Every path that removes a watcher or consumes a mark ends here.
560
+ */
561
+ pruneUriWatchRecord(uri) {
562
+ const record = this.uriWatchRecords.get(uri);
563
+ if (!record || record.watchers.size > 0) {
445
564
  return;
446
565
  }
447
- subscribers.delete(args.clientId);
448
- if (subscribers.size === 0) {
449
- this.subscriptions.delete(uri);
450
- this.lastEmittedFingerprint.delete(uri);
566
+ if (record.releaseBroadcastPending) {
567
+ record.fingerprint = undefined;
568
+ record.fingerprintVersion = undefined;
569
+ }
570
+ else {
571
+ this.uriWatchRecords.delete(uri);
451
572
  }
452
573
  }
453
574
  /**
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
575
+ * Canonicalise a URI string for use as a {@link uriWatchRecords} key, via the
576
+ * shared `DocumentUriPolicy`. Callers may send non-canonical URIs
577
+ * (drive-letter casing, percent-encoding differences, or a symlink path)
578
+ * over the wire; the dispatch side keys by
458
579
  * `document.uri.toString()` from `LangiumDocuments`, so writer keys must
459
580
  * canonicalise to the same form or events silently fail to deliver.
460
581
  * Routing through the seam (rather than a bare `UriUtils.normalize`)
@@ -464,24 +585,22 @@ export class DataServer {
464
585
  * LSP head resolves.
465
586
  *
466
587
  * Adopters can still override for head-specific URI policy by subclassing.
588
+ * The result keys watches only; a document is looked up by its own URI.
467
589
  */
468
590
  canonicalKey(uri) {
469
591
  return this.services.workspace.DocumentUriPolicy.canonicalUri(uri);
470
592
  }
471
593
  async getProjects() {
472
- // Pass-through: `ProjectManager<TProject>` already produces `TProject`
473
- // (the shared services are parameterised over the same generic).
474
594
  // The framework reads `id` for registry identity and `dependencies`
475
595
  // for the visibility closure; every other field rides on the
476
596
  // JSON-RPC envelope as adopter-defined wire metadata.
477
- return this.services.workspace.ProjectManager.getProjects();
597
+ return this.services.workspace.ProjectManager.getProjects().map(project => this.encodeProject(project));
478
598
  }
479
599
  async getProjectForUri(args) {
480
- // Pass-through: `ProjectManager.getProject(uri)` already returns the
481
- // adopter's `TProject` shape. Membership logic belongs to the adopter's
482
- // `ProjectManager`; the data-server forwards the URI without
483
- // interpretation.
484
- return this.services.workspace.ProjectManager.getProject(UriUtils.toUri(args.uri));
600
+ // Membership logic belongs to the adopter's `ProjectManager`; the
601
+ // data-server forwards the URI without interpretation.
602
+ const project = this.services.workspace.ProjectManager.getProject(UriUtils.toUri(args.uri));
603
+ return project && this.encodeProject(project);
485
604
  }
486
605
  /**
487
606
  * Resolve once the data-server is ready to serve requests. Delegates
@@ -498,26 +617,56 @@ export class DataServer {
498
617
  // Resolve the language's reference services from each request's source
499
618
  // (see resolveReferenceServices) and delegate.
500
619
  // ============================================================
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;
620
+ /**
621
+ * Settle the build before a reference question is answered from the index.
622
+ *
623
+ * A query issued right after a model update otherwise races the rebuild and
624
+ * reads an index missing the symbols it asks about. The cost is not confined
625
+ * to this call: a scope built inside that window is cached, and the build's
626
+ * remaining documents link against it.
627
+ *
628
+ * Waits the source document specifically, but ONLY when one is loaded at
629
+ * that URI: a synthetic source can address a URI with no document (a
630
+ * directory URI, typically), where a per-URI `waitUntil` throws "No document
631
+ * found". Falls back to a global settle, matching the id-based
632
+ * `ElementSource` path.
633
+ *
634
+ * Bounded by {@link DataServerOptions.referenceSettleTimeoutMs}.
635
+ */
636
+ async awaitReferencesLinked(source) {
637
+ const uri = isDocumentSource(source) || isSyntheticSource(source) ? UriUtils.toUri(source.uri) : undefined;
510
638
  const waitUri = uri && this.services.workspace.LangiumDocuments.hasDocument(uri) ? uri : undefined;
511
- await this.services.workspace.DocumentBuilder.waitUntil(DocumentState.Linked, waitUri);
639
+ const stopwatch = this.services.Clock.stopwatch();
640
+ const linked = this.services.workspace.DocumentBuilder.waitUntil(DocumentState.Linked, waitUri);
641
+ if ((await this.services.Clock.raceTimer(linked, this.options.referenceSettleTimeoutMs)) !== TIMED_OUT) {
642
+ return;
643
+ }
644
+ const elapsedMs = Math.round(stopwatch.elapsedMs);
645
+ // A per-URI wait resolves off a document-phase notification, so a
646
+ // missed one strands a wait on a document that HAS reached the
647
+ // phase. Re-read before failing; the workspace-wide wait has no
648
+ // equivalent reading and can only reject.
649
+ const document = waitUri ? this.services.workspace.LangiumDocuments.getDocument(waitUri) : undefined;
650
+ if (waitUri && document && document.state >= DocumentState.Linked) {
651
+ this.tracer
652
+ .withUri(waitUri.toString())
653
+ .warn(`Missed the 'Linked' notification after ${elapsedMs}ms; the document already reached it`);
654
+ return;
655
+ }
656
+ throw referenceSettleTimeoutError(elapsedMs);
657
+ }
658
+ async findReferenceCandidates(ctx) {
659
+ await this.awaitReferencesLinked(ctx.source);
512
660
  return this.resolveReferenceServices(ctx.source).CandidateProvider.find(ctx);
513
661
  }
514
662
  async resolveReference(ref) {
663
+ await this.awaitReferencesLinked(ref.source);
515
664
  const resolved = this.resolveReferenceServices(ref.source).CandidateProvider.resolveCandidate(ref);
516
665
  if (!resolved) {
517
666
  return undefined;
518
667
  }
519
- const element = this.encoder.toTransfer(resolved.node);
520
- return { ...resolved.candidate, element };
668
+ // `TElement` is the caller's claim about the target's type; nothing checks it.
669
+ return { ...resolved.candidate, element: this.encoder.toTransfer(resolved.node) };
521
670
  }
522
671
  async findNextName(args) {
523
672
  const uri = UriUtils.toUri(args.uri);
@@ -526,15 +675,32 @@ export class DataServer {
526
675
  // synthetic source — and the create-element flow driving this method is
527
676
  // the one that produces directory URIs, on which a bare
528
677
  // `getServices(uri)` throws while `findReferenceCandidates` succeeds.
529
- const nameProvider = this.resolveReferenceServices(ReferenceSource.synthetic(args.uri, args.type)).NameProvider;
678
+ const source = ReferenceSource.synthetic(args.uri, args.type, args.language);
679
+ // Mid-rebuild the names of documents not yet re-indexed are absent from
680
+ // the taken set, and the caller PERSISTS what it is handed. Nothing
681
+ // reserves the answer either, so a name is free of the collisions the
682
+ // index knows about and of nothing else — two callers racing get the same
683
+ // proposal, which only uniqueness at the write can catch.
684
+ await this.awaitReferencesLinked(source);
685
+ const nameProvider = this.resolveReferenceServices(source).NameProvider;
530
686
  const tier = args.tier ?? 'project';
531
687
  if (tier === 'public') {
532
688
  return nameProvider.findNextProjectQualifiedName(args.type, args.proposal);
533
689
  }
534
690
  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;
691
+ // Document-scoped uniqueness: the document root is the container. A
692
+ // URI with no document has nothing to collide with, like a document
693
+ // with no root.
694
+ try {
695
+ const document = await this.modelService.ensureDocumentState(args.uri);
696
+ return document.root ? nameProvider.findNextName(args.type, args.proposal, document.root) : args.proposal;
697
+ }
698
+ catch (error) {
699
+ if (this.isMissingDocument(error, args.uri)) {
700
+ return args.proposal;
701
+ }
702
+ throw error;
703
+ }
538
704
  }
539
705
  const project = this.services.workspace.ProjectManager.getProject(uri);
540
706
  if (!project) {
@@ -567,66 +733,30 @@ export class DataServer {
567
733
  return language.references;
568
734
  }
569
735
  /**
570
- * Pick the language that owns a reference source, in order:
736
+ * Pick the language that owns a reference source: the registry's
737
+ * `getLanguageFor` over the source's declared language, URI and AST type,
738
+ * with an {@link isElementSource} routed by the document that holds the
739
+ * element (see {@link findElementDocumentUri}) before its type, and
740
+ * {@link fallbackReferenceLanguage}, adopter policy, last.
571
741
  *
572
- * 1. A URI-bearing source ({@link isDocumentSource}/{@link isSyntheticSource})
573
- * whose URI resolves to a registered language routes by URI.
574
- * 2. A single-language workspace always routes to that one language — so
575
- * single-language adopters never reach the steps below, and never pay
576
- * for them.
577
- * 3. An {@link isElementSource} source carries no URI, so in a
578
- * multi-language workspace it is routed via the document that holds the
579
- * element (see {@link findElementDocumentUri}).
580
- * 4. A source carrying an AST type is routed by that type when exactly one
581
- * registered grammar can produce it (see
582
- * {@link resolveReferenceLanguageByType}, over the registry's own type
583
- * index). This is what resolves a create-element flow's synthetic source
584
- * on a bare directory URI without asking the adopter.
585
- * 5. Anything still unresolved falls to {@link fallbackReferenceLanguage},
586
- * which is adopter policy.
742
+ * An unregistered declared language falls through rather than failing: the
743
+ * id crosses the wire, so a client built against a head with one more
744
+ * grammar would otherwise lose queries the other signals answer.
587
745
  */
588
746
  resolveReferenceLanguage(source) {
589
747
  const registry = this.services.ServiceRegistry;
590
- // `getServicesFor` (non-throwing, one ladder walk) gates the URI lookup:
591
- // an extensionless / unregistered URI falls through to the steps below
592
- // rather than throwing "no services for the extension ''".
593
- const uri = isDocumentSource(source) || isSyntheticSource(source) ? UriUtils.toUri(source.uri) : undefined;
594
- const byUri = uri && registry.getServicesFor(uri);
595
- if (byUri) {
596
- return byUri;
597
- }
598
- const all = registry.all;
599
- if (all.length === 1) {
600
- return all[0];
601
- }
602
748
  if (isElementSource(source)) {
603
- const documentUri = this.findElementDocumentUri(source);
604
- const byDocument = documentUri && registry.getServicesFor(documentUri);
605
- if (byDocument) {
606
- return byDocument;
607
- }
749
+ // The index lookup runs only once the cheaper signals abstained.
750
+ return (registry.getLanguageFor({}) ??
751
+ registry.getLanguageFor({ target: this.findElementDocumentUri(source), type: source.type }) ??
752
+ this.fallbackReferenceLanguage(source));
608
753
  }
609
- const byType = this.resolveReferenceLanguageByType(source);
610
- return byType ?? this.fallbackReferenceLanguage(source);
611
- }
612
- /**
613
- * Route a reference source by the AST type it carries — a
614
- * {@link isSyntheticSource}'s `type` (the transient node being created) or an
615
- * {@link isElementSource}'s optional narrowing `type`.
616
- *
617
- * Answers only when EXACTLY ONE registered grammar can produce the type.
618
- * Several can when the type comes from a grammar both import, and then the
619
- * type genuinely does not identify a language — that is a fall-through to
620
- * adopter policy, not a coin toss. Note this asks which grammar can *produce*
621
- * the type, not which mentions it: a grammar that merely cross-references a
622
- * type can never hold a node of it.
623
- */
624
- resolveReferenceLanguageByType(source) {
625
- const type = isSyntheticSource(source) ? source.type : isElementSource(source) ? source.type : undefined;
626
- // The registry owns the type index — it is the one place that knows when
627
- // the registered set changed, so unlike a private memo here it cannot go
628
- // stale on a language registered after the first lookup.
629
- return type ? this.services.ServiceRegistry.soleServicesByType(type) : undefined;
754
+ const hint = isSyntheticSource(source)
755
+ ? { languageId: source.language, target: source.uri, type: source.type }
756
+ : isDocumentSource(source)
757
+ ? { target: source.uri }
758
+ : {};
759
+ return registry.getLanguageFor(hint) ?? this.fallbackReferenceLanguage(source);
630
760
  }
631
761
  /**
632
762
  * Locate the document that holds the element an {@link ElementSource}
@@ -635,15 +765,14 @@ export class DataServer {
635
765
  * disambiguates names that repeat across types (honouring grammar
636
766
  * subtyping through `AstReflection.isSubtype`).
637
767
  *
638
- * Only reached on the multi-language, name-based path (step 3 of
639
- * {@link resolveReferenceLanguage}); single-language adopters return at
640
- * step 2.
768
+ * Only reached in a multi-language workspace, once the declared language
769
+ * and the URI have abstained.
641
770
  *
642
771
  * Abstains when the name matches elements in more than one DOCUMENT — the
643
772
  * index spans every language and is filled in build order, so "the
644
- * first match" would be file-watch order rather than an answer. Step 3
645
- * then falls through to the type-based step 4, which abstains on ties
646
- * in the same way, and finally to adopter policy.
773
+ * first match" would be file-watch order rather than an answer. Routing
774
+ * then falls through to the element's type, which abstains on ties in the
775
+ * same way, and finally to adopter policy.
647
776
  */
648
777
  findElementDocumentUri(source) {
649
778
  const matches = this.services.workspace.IndexManager.getElementsByName(source.name, source.type);
@@ -675,55 +804,166 @@ export class DataServer {
675
804
  // ============================================================
676
805
  // Internal plumbing
677
806
  // ============================================================
807
+ /**
808
+ * Whether `error`, from waiting on `uri`'s document, means that `uri` has
809
+ * no document: a URI with neither a file nor text builds nothing, and
810
+ * Langium's wait after the build rejects for want of one, with a
811
+ * `ServerCancelled` response error. Any other failure, such as a read
812
+ * that fails before a document is registered, a cancelled wait or a
813
+ * `ReentrantWriteLockError`, is the caller's to see.
814
+ */
815
+ isMissingDocument(error, uri) {
816
+ return isResponseError(error) && error.code === SERVER_CANCELLED && this.modelService.getDocument(uri) === undefined;
817
+ }
678
818
  /**
679
819
  * Build a {@link TransferDocument} envelope from the current document state,
680
820
  * delegating root + diagnostic encoding to {@link encoder} (see
681
- * `TransferEncoder.toTransferDocument` for the walk).
682
- *
683
- * The encoder field's generic-map binding is widened to
684
- * `Record<string, TransferElement>` at the framework-default level, and an
685
- * adopter supplying a typed-overlay encoder narrows the runtime shape to
686
- * its wire types. The cast on the return is where that invariant — the
687
- * adopter's `TTransfer` matches its encoder's overlay — is asserted, at a
688
- * single boundary point rather than spread across the callers.
689
- */
690
- envelope(uri) {
821
+ * `TransferEncoder.toTransferDocument` for the walk). `fingerprint` is the
822
+ * caller's {@link computeDocumentFingerprint} of that same state, which
823
+ * spares hashing it twice.
824
+ */
825
+ envelope(uri, fingerprint) {
691
826
  // Resolve through the model service's canonicalizing gateway rather than
692
827
  // reaching into `LangiumDocuments` directly, so a divergent (symlink) URI
693
828
  // still finds the document the build keys by its real path — and so the
694
829
  // data-server never has to remember to canonicalize this lookup itself.
695
830
  const document = this.modelService.getDocument(uri.toString());
696
- if (!document) {
831
+ if (!document || this.services.workspace.ModelLedger.isPlaceholder(document.parseResult.value)) {
697
832
  // No document — a shaped envelope rather than a throw, so the caller
698
- // decides policy at its own layer; `root` is optional on the envelope
833
+ // decides policy at its own layer; `model` is optional on the envelope
699
834
  // so the compiler forces that decision. Adopters preferring to throw
700
- // override `envelope`.
701
- return {
702
- uri: uri.toString(),
703
- version: 0,
704
- root: undefined,
705
- diagnostics: []
706
- };
835
+ // override `envelope`. The builder's unparsed placeholder is no
836
+ // document either: its root parses no text.
837
+ return TransferDocument.absent(uri.toString(), this.epoch);
838
+ }
839
+ const encoded = this.encoder.toTransferDocument(document);
840
+ return this.withServerState(encoded, fingerprint ?? this.computeDocumentFingerprint(document.parseResult.value, encoded));
841
+ }
842
+ /**
843
+ * The transfer document a request answers with for `astDocument`, its model
844
+ * hashed and the text stamped on it by {@link withServerState}. Every
845
+ * document a request answers with goes through here, so none goes out
846
+ * without them.
847
+ */
848
+ encodeDocument(astDocument) {
849
+ const encoded = this.encoder.astDocumentToTransferDocument(astDocument);
850
+ return this.withServerState(encoded, this.computeDocumentFingerprint(astDocument.root, encoded));
851
+ }
852
+ /**
853
+ * The project a client receives for `project`, unchanged by default. Every
854
+ * project a request answers with or a change notification carries goes
855
+ * through here, so a field derived for clients cannot miss one path. The
856
+ * result crosses as JSON, so a value a client reads goes in a data field,
857
+ * not a getter.
858
+ */
859
+ encodeProject(project) {
860
+ return project;
861
+ }
862
+ /**
863
+ * `encoded` with `hash` on its model and the text the server holds for it:
864
+ * the store's while it holds the document, the build's otherwise. The text
865
+ * is read when the document is sent rather than kept with the build: a save
866
+ * changes `text.dirty` without a rebuild, and the store's text moves on before
867
+ * the build that follows it.
868
+ */
869
+ withServerState(encoded, hash) {
870
+ const text = this.serverTextState(encoded.uri);
871
+ if (text && text.version > encoded.model.version) {
872
+ this.tracer.withUri(encoded.uri).debug(`Send a model behind its text: model v${encoded.model.version} / text v${text.version}`);
707
873
  }
708
- return this.encoder.toTransferDocument(document);
874
+ return {
875
+ uri: encoded.uri,
876
+ epoch: this.epoch,
877
+ heldWrites: this.heldWrites(encoded.uri, encoded.model.version),
878
+ // The encoder returns the structural base; `TTransfer` is the adopter's
879
+ // declaration of the roots its languages produce, and nothing checks it.
880
+ model: { ...encoded.model, hash },
881
+ ...(text ? { text } : {})
882
+ };
883
+ }
884
+ /** Per session registered on this connection, the highest of its numbered writes of `uri` that `version` holds. */
885
+ heldWrites(uri, version) {
886
+ const held = [];
887
+ for (const [clientId, session] of this.clientSessions) {
888
+ const write = session.heldWrite(uri, version);
889
+ if (write !== undefined) {
890
+ held.push([clientId, write]);
891
+ }
892
+ }
893
+ // Built from entries, so a session named `__proto__` is kept as a key.
894
+ return Object.fromEntries(held);
895
+ }
896
+ /**
897
+ * The text the server holds for `uri`, as every envelope and a watch's
898
+ * answer carry it: the store's while it holds the document, the build's
899
+ * otherwise, and none for a document it has neither of.
900
+ */
901
+ serverTextState(uri) {
902
+ return this.services.workspace.TextDocuments.textState(uri) ?? this.builtTextState(uri);
903
+ }
904
+ /**
905
+ * The text a build read for a document the store never held, which is
906
+ * clean: the store holds every text a client gave it.
907
+ */
908
+ builtTextState(uri) {
909
+ const textDocument = this.modelService.getDocument(uri)?.textDocument;
910
+ return textDocument && { version: textDocument.version, hash: textHash(textDocument.getText()), dirty: false };
709
911
  }
710
912
  /**
711
- * Subscribe one listener at the configured {@link DataServerOptions.subscriptionPhase}.
712
- * The listener dispatches subscription events for every matching URI. A
713
- * single listener (rather than one per subscription) keeps the cost flat
714
- * regardless of subscriber count.
913
+ * Follow every document at the configured
914
+ * {@link DataServerOptions.subscriptionPhase}, once per connection rather
915
+ * than once per watch, so the cost stays flat in the number of watches.
715
916
  */
716
- subscribeToDocumentBuilder() {
717
- this.disposables.push(this.services.workspace.DocumentBuilder.onDocumentPhase(this.options.subscriptionPhase, (document, cancelToken) => this.dispatchPhaseEvent(document, cancelToken)));
917
+ subscribeToModelUpdates() {
918
+ const phase = this.options.subscriptionPhase;
919
+ this.disposables.push(this.modelService.onModelUpdated(event => this.dispatchPhaseEvent(event), { phase }));
920
+ // One message per build rather than one per document.
921
+ this.disposables.push(this.modelService.onModelsBuilt(event => this.dispatchBuiltEvent(event.uris), { phase }));
922
+ }
923
+ /**
924
+ * Report the documents that reached {@link DataServerOptions.subscriptionPhase}
925
+ * and that NOBODY on this
926
+ * connection is watching — the ones a client was not told about through
927
+ * {@link dispatchPhaseEvent}, which is gated per URI.
928
+ *
929
+ * **The gap this closes is the one no other source can observe.** A document
930
+ * the client watches, it hears about already. A file changed on disk, the
931
+ * host's own filesystem watcher reports — and on a browser host, where the
932
+ * workspace lives behind this head, an external change cannot happen at all.
933
+ * What is left, and what nothing outside the server can see, is a document
934
+ * rebuilt because something it DEPENDS ON changed: its file never changed, so
935
+ * a filesystem watcher is silent by construction, and it has no subscriber, so
936
+ * the update channel is silent by design. A consumer displaying data derived
937
+ * from that document — a tree label, a decorator — otherwise goes stale with
938
+ * no signal from any source, and repairs itself the moment someone opens the
939
+ * file to investigate, which is what makes it expensive to diagnose later.
940
+ *
941
+ * Payload-free on purpose: URIs only, so a client re-reads what it displays
942
+ * rather than being handed transfer documents it did not ask for. That is the
943
+ * property the watcher gate protects, and it is preserved here by
944
+ * carrying no document rather than by gating the message.
945
+ *
946
+ * Quiet in the common case. Editing a document that an editor has open leaves
947
+ * that URI watched and therefore out of this set, so a build with no
948
+ * dependents produces nothing at all, and workspace initialisation produces
949
+ * nothing because it does not build to this phase. The ceiling is a
950
+ * whole-workspace rebuild at the subscription phase: one message, URIs only.
951
+ */
952
+ dispatchBuiltEvent(built) {
953
+ const uris = built.map(uri => this.canonicalKey(uri)).filter(uri => !this.uriWatchRecords.get(uri)?.watchers.size);
954
+ if (uris.length === 0) {
955
+ return;
956
+ }
957
+ this.tracer.debug(`Emit onDocumentsBuilt: ${uris.length} unwatched document(s)`);
958
+ this.clientProxy.onDocumentsBuilt({ uris });
718
959
  }
719
960
  /**
720
- * Subscribe to the universal save event on `HydraniumTextDocuments` so a
721
- * single `onDocumentSaved` wire notification fires for ANY save of a
722
- * subscribed URI — regardless of whether the save originated from the
723
- * data-server's RPC `saveModelDocument`, the LSP head's text-editor save,
724
- * or any other client writing through `notifyDidSaveTextDocument`.
961
+ * Follow every save so a single `onDocumentSaved` wire notification fires
962
+ * for ANY save of a subscribed URI — regardless of whether the save
963
+ * originated from the data-server's RPC `saveModelDocument`, the LSP head's
964
+ * text-editor save, or any other client.
725
965
  *
726
- * Architectural symmetry with {@link subscribeToDocumentBuilder}: every
966
+ * Architectural symmetry with {@link subscribeToModelUpdates}: every
727
967
  * subscribed client sees every state change to documents they care about,
728
968
  * regardless of which client triggered it. Firing `onDocumentSaved` only
729
969
  * from the data-server's own RPC path is a bug, not an optimisation: an
@@ -731,37 +971,108 @@ export class DataServer {
731
971
  * clients, which never clear their dirty state.
732
972
  */
733
973
  subscribeToTextDocumentSaves() {
734
- this.disposables.push(this.services.workspace.TextDocuments.onDidSave(event => this.dispatchSaveEvent(event)));
974
+ this.disposables.push(this.modelService.onModelSaved(event => this.dispatchSaveEvent(event)));
975
+ }
976
+ /** Relay each change of a document's dirty state; see {@link dispatchDirtyEvent}. */
977
+ subscribeToDirtyChanges() {
978
+ this.disposables.push(this.modelService.onDirtyChanged(event => this.dispatchDirtyEvent(event)));
735
979
  }
736
980
  /**
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.
981
+ * Send a dirty flip to the connection, gated on the URI's watchers as
982
+ * {@link dispatchSaveEvent} is: the answer at any one moment travels on
983
+ * every document sent, so a client that watches nothing reads it there.
741
984
  */
742
- 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
- }
985
+ dispatchDirtyEvent(event) {
986
+ const uri = this.canonicalKey(event.uri);
987
+ if (this.uriWatchRecords.get(uri)?.watchers.size) {
988
+ this.clientProxy.onDocumentDirtyChanged({ uri, text: event.text });
989
+ }
990
+ }
991
+ /**
992
+ * Mark each document the store releases, so {@link dispatchPhaseEvent}
993
+ * broadcasts the build that follows even without a watcher. By default
994
+ * that build reverts the document to its disk content, discarding unsaved
995
+ * in-session edits, and the last close typically also
996
+ * removed the last watcher: without the broadcast, a consumer that only
997
+ * ever fetches via `getModelDocument` keeps showing the discarded state.
998
+ * The broadcast is de-duplicated against the fingerprint while a watcher
999
+ * holds one, so a close whose disk state equals the last emitted state
1000
+ * stays silent; with no watcher there is no fingerprint, and every release
1001
+ * build is sent. The first build after the release consumes the mark, and
1002
+ * goes out as the release unless it is stamped past the version a client
1003
+ * opened the document at again: a client's write or an integrity repair
1004
+ * that rides it keeps its author.
1005
+ *
1006
+ * A release, not the close itself: a document whose last client lost its
1007
+ * connection is released only once the release grace runs out, or when
1008
+ * another client opens it meanwhile, and not at all when a client lost
1009
+ * from it opens it again within its own grace.
1010
+ */
1011
+ subscribeToModelReleases() {
1012
+ this.disposables.push(this.modelService.onModelReleased(event => {
1013
+ const uri = this.canonicalKey(event.uri);
1014
+ const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set() };
1015
+ record.releaseBroadcastPending = true;
1016
+ this.uriWatchRecords.set(uri, record);
1017
+ this.tracer.withUri(uri).debug('Release marked: the first build after it is broadcast, watched or not');
748
1018
  }));
749
1019
  }
750
- /** Fan out a save event for the document's URI, gated by the subscription map. */
1020
+ /**
1021
+ * Fan out a deletion for each removed URI, to EVERY client on the connection
1022
+ * rather than only to the ones watching that URI.
1023
+ *
1024
+ * **Deliberately ungated, where {@link dispatchPhaseEvent} and
1025
+ * {@link dispatchSaveEvent} are gated.** Those two carry a built document and
1026
+ * fire on every build, so the watcher gate is what keeps bandwidth
1027
+ * proportional to what a client asked for. A deletion is neither: it is one
1028
+ * URI, it is rare, and it reports the workspace's STRUCTURE rather than a
1029
+ * document's content. Gating it forces any consumer that displays the
1030
+ * workspace — a model tree, a file decorator — to learn about disappearances
1031
+ * from a filesystem watcher instead, which a client hosted in a browser has
1032
+ * no way to run: its workspace lives behind the head. A client that does not
1033
+ * care filters on the URI, which costs it a comparison.
1034
+ *
1035
+ * The precedent is the release broadcast (see
1036
+ * {@link subscribeToModelReleases}), where the same judgement was already made
1037
+ * in the other direction: a transition that matters enough is delivered
1038
+ * without a subscription.
1039
+ *
1040
+ * A deletion is announced before the build that follows it, so this goes
1041
+ * out ahead of the `'rebuilt'` events for the dependents whose references
1042
+ * the deletion just broke.
1043
+ *
1044
+ * The URI's fingerprint and release mark are dropped: they describe a
1045
+ * document that no longer exists. A kept fingerprint is adopted as the
1046
+ * baseline and suppresses the first emit after the file returns with its
1047
+ * previous content.
1048
+ *
1049
+ * The watchers SURVIVE: a recreated file resumes delivering to them with no
1050
+ * re-subscription, and a client that answers the deletion by closing
1051
+ * releases the watch through `closeModelDocument` anyway. A session that
1052
+ * deleted the document has its own released by {@link deleteModelDocument}.
1053
+ */
1054
+ dispatchDeleteEvent(event) {
1055
+ const uri = this.canonicalKey(event.uri);
1056
+ const record = this.uriWatchRecords.get(uri);
1057
+ if (record) {
1058
+ record.fingerprint = undefined;
1059
+ record.fingerprintVersion = undefined;
1060
+ record.releaseBroadcastPending = undefined;
1061
+ record.sentVersion = undefined;
1062
+ this.pruneUriWatchRecord(uri);
1063
+ }
1064
+ this.clientProxy.onDocumentDeleted({ uri, sourceClientId: event.sourceClientId, sequence: ++this.eventSequence });
1065
+ }
1066
+ /** Fan out a save event for the document's URI, gated on the URI's watchers. */
751
1067
  dispatchSaveEvent(event) {
752
- // 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
754
- // CANONICAL identity R. Canonicalize before both the gate and the envelope so
755
- // a save of a symlinked file isn't silently dropped (and the envelope resolves
756
- // the R-keyed document rather than missing into an empty one).
757
1068
  const uri = this.canonicalKey(event.document.uri);
758
- if (!this.subscriptions.has(uri)) {
1069
+ if (!this.uriWatchRecords.get(uri)?.watchers.size) {
759
1070
  return;
760
1071
  }
761
- const response = this.envelope(UriUtils.toUri(uri));
1072
+ const response = this.envelope(UriUtils.toUri(event.document.uri));
762
1073
  const wireEvent = {
763
1074
  document: response,
764
- sourceClientId: event.clientId
1075
+ sourceClientId: event.sourceClientId
765
1076
  };
766
1077
  this.clientProxy.onDocumentSaved(wireEvent);
767
1078
  }
@@ -774,107 +1085,107 @@ export class DataServer {
774
1085
  * out to multiple local subscribers with an `Emitter<T>` — the
775
1086
  * framework deliberately does NOT promise multi-listener semantics.
776
1087
  *
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.
784
- */
785
- dispatchPhaseEvent(document, cancelToken) {
786
- if (cancelToken.isCancellationRequested) {
787
- // Build preempted by a concurrent write lock (or other cancel source) —
788
- // the subscription event is stale by the time it would fire. Skip
789
- // emission so RPC subscribers don't surface intermediate states.
790
- // A pending revert mark is deliberately NOT consumed here: the
791
- // follow-up build re-fires this phase and broadcasts then.
1088
+ * An event for a URI no client watches is NOT sent over the wire, so
1089
+ * bandwidth scales with watched URIs rather than with phase events; a
1090
+ * pending release mark is the exception (see
1091
+ * {@link subscribeToModelReleases}).
1092
+ *
1093
+ * An event for a rebuild with no observable change since the last emit is
1094
+ * suppressed against the URI's fingerprint and the version it was taken at;
1095
+ * a new version with the same fingerprint goes out with the same
1096
+ * `model.hash`, so a watcher still learns the version. Such rebuilds are routine: a
1097
+ * second client attaching to an open document makes
1098
+ * `HydraniumTextDocuments.refreshContent` fire `onDidChangeContent` purely
1099
+ * to re-trigger the build, and Langium rebuilds a document when a
1100
+ * dependency changes even if its diagnostics come out the same. Sent at a
1101
+ * version this head has not sent, they reach watchers as `'changed'`, and a
1102
+ * watcher that reads `'changed'` as another client's write and resets its
1103
+ * root to the server view loses the user's edits. The first {@link watchModelDocument} baselines the
1104
+ * fingerprint, so the first event after a watch is de-duplicated against
1105
+ * the state the watcher just fetched; it goes with the last watcher, so the
1106
+ * next first watch re-baselines rather than adopting a stale digest. A
1107
+ * digest keeps its memory constant in document size; see
1108
+ * {@link computeDocumentFingerprint} for the inputs.
1109
+ */
1110
+ dispatchPhaseEvent(event) {
1111
+ const uri = this.canonicalKey(event.document.uri);
1112
+ const record = this.uriWatchRecords.get(uri);
1113
+ const afterRelease = record?.releaseBroadcastPending === true;
1114
+ if (!record || (record.watchers.size === 0 && !afterRelease)) {
792
1115
  return;
793
1116
  }
794
- 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) {
1117
+ if (afterRelease) {
1118
+ // Consumed even when watchers exist — the regular dispatch below
1119
+ // serves them, and the mark's attribution is more precise than the
1120
+ // post-close unknown client the manager's attribution would yield.
1121
+ // With no watcher the record goes now, so the fingerprint written
1122
+ // below lands on a detached record and the next first watch
1123
+ // re-baselines instead of adopting it.
1124
+ record.releaseBroadcastPending = undefined;
1125
+ this.pruneUriWatchRecord(uri);
1126
+ }
1127
+ // The encoder reads the built document, which the event's holds for this
1128
+ // synchronous run.
1129
+ const document = this.modelService.getDocument(event.document.uri);
1130
+ if (!document) {
801
1131
  return;
802
1132
  }
803
- const fingerprint = this.computeDocumentFingerprint(document);
804
- if (this.lastEmittedFingerprint.get(uri) === fingerprint) {
1133
+ const fingerprint = this.computeDocumentFingerprint(document.parseResult.value, this.encoder.toTransferDocument(document));
1134
+ const stamped = this.services.workspace.ModelLedger.versionOf(document.parseResult.value);
1135
+ if (record.fingerprint === fingerprint && record.fingerprintVersion === stamped) {
805
1136
  // A rebuild that produced no observable change since the last emit —
806
1137
  // suppressed so RPC subscribers don't see a no-op broadcast. Logged at
807
1138
  // debug so a *needed* re-broadcast wrongly suppressed by this dedup
808
1139
  // (the failure mode the fingerprint strategy must avoid) is visible.
809
- this.tracer.withUri(uri).debug(`Suppress onDocumentUpdated v${document.textDocument.version}: fingerprint unchanged`);
1140
+ this.tracer.withUri(uri).debug(`Suppress onDocumentUpdated v${stamped}: fingerprint and version unchanged`);
810
1141
  return;
811
1142
  }
812
- this.lastEmittedFingerprint.set(uri, fingerprint);
813
- const event = {
814
- document: this.envelope(document.uri),
815
- sourceClientId: revertedOnClose ? REVERT_ON_CLOSE_CLIENT_ID : this.resolveSourceClientId(document),
816
- reason: this.resolveUpdateReason(document.uri)
1143
+ record.fingerprint = fingerprint;
1144
+ record.fingerprintVersion = stamped;
1145
+ // The event's attribution, so this head names the same client as the
1146
+ // in-process heads do for one build, except for a version this head
1147
+ // already sent; see `DataServerUriWatchRecord.sentVersion`.
1148
+ const version = this.modelService.isOpen(event.document.uri) ? document.textDocument.version : undefined;
1149
+ const { reason, sourceClientId } = version !== undefined && record.sentVersion === version
1150
+ ? { reason: 'rebuilt', sourceClientId: UNKNOWN_CLIENT_ID }
1151
+ : event;
1152
+ record.sentVersion = version;
1153
+ // The stamp, not the live version: a write after the build's parse moves
1154
+ // only the latter. At the opened version too, which a reopen with the
1155
+ // released text keeps.
1156
+ const openedVersion = afterRelease ? this.modelService.openedVersion(event.document.uri) : undefined;
1157
+ const releaseBuild = afterRelease && (openedVersion === undefined || stamped <= openedVersion);
1158
+ const wireEvent = {
1159
+ document: this.envelope(document.uri, fingerprint),
1160
+ sourceClientId: releaseBuild ? DOCUMENT_RELEASE_CLIENT_ID : sourceClientId,
1161
+ reason,
1162
+ sequence: ++this.eventSequence
817
1163
  };
1164
+ const mark = afterRelease ? `, release mark: opened v${openedVersion ?? '-'}, attributed ${sourceClientId}` : '';
818
1165
  this.tracer
819
1166
  .withUri(uri)
820
- .debug(`Emit onDocumentUpdated v${event.document.version} (reason=${event.reason}, sourceClientId=${event.sourceClientId})`);
821
- this.clientProxy.onDocumentUpdated(event);
1167
+ .debug(`Emit onDocumentUpdated v${stamped} (reason=${wireEvent.reason}, sourceClientId=${wireEvent.sourceClientId}${mark})`);
1168
+ this.clientProxy.onDocumentUpdated(wireEvent);
822
1169
  }
823
1170
  /**
824
- * Fingerprint of the document's observable state, used to de-dup
825
- * `onDocumentUpdated` emissions. The {@link FingerprintStrategy} option
826
- * selects what is hashed (default `'transfer-document'` — see the type), and
827
- * {@link additionalFingerprintInputs} folds in any extra adopter signal.
1171
+ * Fingerprint of the snapshot `root` and its encoding `encoded`, used to
1172
+ * de-dup `onDocumentUpdated` emissions and sent as every document's
1173
+ * `model.hash`, so it must not depend on the version or on live state. The
1174
+ * {@link FingerprintStrategy} option selects what is hashed (default
1175
+ * `'transfer-document'` — see the type).
828
1176
  *
829
- * The default `'transfer-document'` strategy goes through the encoder's
830
- * {@link TransferEncoder.toTransferDocument}, which is cached per build —
831
- * so within one phase event the fingerprint and the subsequently-emitted
832
- * `envelope` share a single encode walk.
1177
+ * {@link TransferEncoder.toTransferDocument} is cached per build, so within
1178
+ * one phase event the fingerprint and the subsequently-emitted `envelope`
1179
+ * share a single encode walk.
833
1180
  *
834
1181
  * Wrapped in {@link Tracer.time} against {@link FINGERPRINT_LOG_AFTER_MS}.
835
1182
  */
836
- computeDocumentFingerprint(document) {
837
- return this.tracer.withUri(document.uri.toString()).time('Compute fingerprint', () => {
838
- const base = this.options.fingerprintStrategy === 'text-diagnostics'
839
- ? textDiagnosticsFingerprint(document)
840
- : transferDocumentFingerprint(this.encoder.toTransferDocument(document));
841
- const extra = this.additionalFingerprintInputs(document);
842
- return extra.length === 0 ? base : fingerprintHash([base, FINGERPRINT_SEPARATOR, ...extra.map(value => JSON.stringify(value))]);
843
- }, 'debug', { logAfterMs: FINGERPRINT_LOG_AFTER_MS });
844
- }
845
- /**
846
- * Extra inputs folded into {@link computeDocumentFingerprint} alongside the
847
- * chosen {@link FingerprintStrategy}. Default: none. Override to contribute a
848
- * signal that lives outside the document's text / root / diagnostics — each
849
- * entry need only be stable across equivalent emissions and
850
- * JSON-serialisable.
851
- */
852
- additionalFingerprintInputs(_document) {
853
- return [];
854
- }
855
- /**
856
- * Discriminate the reason for a phase-event-driven update notification.
857
- * Uses the most recent `DocumentBuilder.onUpdate` snapshot:
858
- * - URI in the `deleted` list → `'deleted'`
859
- * - URI in the `changed` list → `'changed'` (the URI was passed to
860
- * `documentBuilder.update(changed, deleted)`, which spans `didChange`
861
- * text-document events and programmatic `update([uri], [])` calls).
862
- * - Otherwise → `'rebuilt'` (cascade re-derivation: this URI was rebuilt
863
- * because something it depends on changed; its own text wasn't flagged).
864
- *
865
- * `'saved'` is NOT emitted from this code path — saves take the dedicated
866
- * `DataClientProtocol.onDocumentSaved` channel; adopters that want a
867
- * unified update stream synthesise `'saved'` in their bridge layer.
868
- */
869
- resolveUpdateReason(uri) {
870
- const last = this.lastBuildUpdate;
871
- if (last?.deleted.some(deleted => UriUtils.equals(deleted, uri))) {
872
- return 'deleted';
873
- }
874
- if (last?.changed.some(changed => UriUtils.equals(changed, uri))) {
875
- return 'changed';
876
- }
877
- return 'rebuilt';
1183
+ computeDocumentFingerprint(root, encoded) {
1184
+ return this.tracer
1185
+ .withUri(encoded.uri)
1186
+ .time('Compute fingerprint', () => this.options.fingerprintStrategy === 'text-diagnostics'
1187
+ ? textDiagnosticsFingerprint(this.services.workspace.ModelLedger.textOf(root), encoded.model)
1188
+ : transferDocumentFingerprint(encoded.model), 'debug', { logAfterMs: FINGERPRINT_LOG_AFTER_MS });
878
1189
  }
879
1190
  /**
880
1191
  * Subscribe to the project tier's change channel and re-fan registry
@@ -898,38 +1209,38 @@ export class DataServer {
898
1209
  /**
899
1210
  * Fan one internal {@link ProjectChangeEvent} out to per-project wire
900
1211
  * notifications. Each `removed` entry pairs the id with the pre-removal
901
- * snapshot needed for the `'removed'` wire payload.
1212
+ * snapshot needed for the `'removed'` wire payload. A project whose
1213
+ * {@link encodeProject} throws is logged and skipped, so the rest of the
1214
+ * batch still reaches the client.
902
1215
  */
903
1216
  dispatchProjectChangeEvent(event) {
1217
+ const send = (project, reason) => {
1218
+ let encoded;
1219
+ try {
1220
+ encoded = this.encodeProject(project);
1221
+ }
1222
+ catch (error) {
1223
+ this.tracer.error(`Project ${project.id} not sent as ${reason}: encodeProject threw: ${describeErrorWithStack(error)}`);
1224
+ return;
1225
+ }
1226
+ this.clientProxy.onProjectsChanged({ project: encoded, reason });
1227
+ };
904
1228
  for (const id of event.added) {
905
1229
  const project = this.services.workspace.ProjectManager.getProjectById(id);
906
1230
  if (project) {
907
- this.clientProxy.onProjectsChanged({ project, reason: 'added' });
1231
+ send(project, 'added');
908
1232
  }
909
1233
  }
910
1234
  for (const id of event.updated) {
911
1235
  const project = this.services.workspace.ProjectManager.getProjectById(id);
912
1236
  if (project) {
913
- this.clientProxy.onProjectsChanged({ project, reason: 'updated' });
1237
+ send(project, 'updated');
914
1238
  }
915
1239
  }
916
1240
  for (const entry of event.removed) {
917
- this.clientProxy.onProjectsChanged({ project: entry.snapshot, reason: 'removed' });
1241
+ send(entry.snapshot, 'removed');
918
1242
  }
919
1243
  }
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
1244
  // --- Diagnostics (DataServerDiagnosticsProtocol) ---------------------------
934
1245
  // Computed in THIS process: the data-server child holds the model store, so
935
1246
  // these snapshots reflect the heap that actually carries the workspace
@@ -967,7 +1278,7 @@ export class DataServer {
967
1278
  }
968
1279
  async stopProfiling(args) {
969
1280
  if (!this.activeProfile) {
970
- throw new Error('No profiling capture is active; call startProfiling first.');
1281
+ throw noActiveProfileError();
971
1282
  }
972
1283
  const capture = this.activeProfile;
973
1284
  this.activeProfile = undefined;
@@ -987,7 +1298,7 @@ export class DataServer {
987
1298
  const builtIn = [...DATA_SERVER_PROTOCOL_METHODS, ...DATA_SERVER_DIAGNOSTICS_METHODS];
988
1299
  const overlap = additionalMethods.filter(name => builtIn.includes(name));
989
1300
  if (overlap.length > 0) {
990
- throw new Error(`DataServer.additionalMethods overlaps with built-in data-server methods: ${overlap.join(', ')}. ` +
1301
+ throw new Error(`DataServerOptions.additionalMethods overlaps with built-in data-server methods: ${overlap.join(', ')}. ` +
991
1302
  'Adopter protocols must not redeclare framework method names; rename the adopter method or remove it from additionalMethods.');
992
1303
  }
993
1304
  return {
@@ -996,7 +1307,8 @@ export class DataServer {
996
1307
  methodNamespace: partial.methodNamespace ?? DATA_SERVER_WIRE_PREFIX,
997
1308
  additionalMethods,
998
1309
  excludedMethods: partial.excludedMethods ?? [],
999
- diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics()
1310
+ diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics(),
1311
+ referenceSettleTimeoutMs: partial.referenceSettleTimeoutMs ?? DataServer.DEFAULT_OPTIONS.referenceSettleTimeoutMs
1000
1312
  };
1001
1313
  }
1002
1314
  }