@hydranium/data-server 1.0.0-next.23 → 1.0.0-next.232
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.
- package/README.md +25 -9
- package/lib/data-server.d.ts +410 -285
- package/lib/data-server.d.ts.map +1 -1
- package/lib/data-server.js +656 -485
- package/lib/data-server.js.map +1 -1
- package/lib/messages/index.d.ts +18 -0
- package/lib/messages/index.d.ts.map +1 -0
- package/lib/messages/index.js +18 -0
- package/lib/messages/index.js.map +1 -0
- package/lib/node/node-diagnostics-provider.d.ts.map +1 -1
- package/lib/node/node-diagnostics-provider.js +2 -1
- package/lib/node/node-diagnostics-provider.js.map +1 -1
- package/lib/testing/data-server-harness.d.ts +31 -14
- package/lib/testing/data-server-harness.d.ts.map +1 -1
- package/lib/testing/data-server-harness.js +8 -3
- package/lib/testing/data-server-harness.js.map +1 -1
- package/lib/testing/index.d.ts +1 -0
- package/lib/testing/index.d.ts.map +1 -1
- package/lib/testing/index.js.map +1 -1
- package/package.json +35 -39
- package/src/data-server.ts +812 -526
- package/src/messages/index.ts +26 -0
- package/src/node/node-diagnostics-provider.ts +2 -8
- package/src/testing/data-server-harness.ts +55 -26
- package/src/testing/index.ts +5 -2
package/lib/data-server.js
CHANGED
|
@@ -6,11 +6,43 @@
|
|
|
6
6
|
*
|
|
7
7
|
* SPDX-License-Identifier: MIT
|
|
8
8
|
********************************************************************************/
|
|
9
|
-
import { createRpcProxy, DisposableCollection, isDocumentSource, isElementSource, isSyntheticSource, ReferenceSource } from '@hydranium/protocol';
|
|
9
|
+
import { createRpcProxy, defineMessage, DisposableCollection, HYDRANIUM_ERROR_CODES, isDocumentSource, isElementSource, isResponseError, isSyntheticSource, messageData, messageError, ReferenceSource, SessionClosedError, TIMED_OUT, TransferDocument, UNKNOWN_CLIENT_ID, textHash } from '@hydranium/protocol';
|
|
10
10
|
import { DATA_SERVER_DIAGNOSTICS_METHODS, DATA_SERVER_PROTOCOL_METHODS, DATA_SERVER_WIRE_PREFIX } from '@hydranium/protocol/data';
|
|
11
|
-
import {
|
|
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
|
-
*
|
|
23
|
-
*
|
|
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
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
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
|
-
/**
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
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
|
|
98
|
-
* `
|
|
99
|
-
* dispatches
|
|
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,28 @@ 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
|
-
/**
|
|
128
|
-
|
|
129
|
-
/**
|
|
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();
|
|
149
|
+
/** This connection's {@link DataServerUriWatchRecord} per canonical URI; see there for when a record lives. */
|
|
150
|
+
uriWatchRecords = new Map();
|
|
144
151
|
/**
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
* URI's change). The same mechanism `AstDocumentManager.onUpdate` uses on
|
|
150
|
-
* the LSP side, so reason fidelity stays consistent between heads.
|
|
152
|
+
* The live client sessions this connection registered, by client id. A
|
|
153
|
+
* document request carrying one of these ids acts as that session; one
|
|
154
|
+
* carrying any other id fails. A session leaves once it ends, so a
|
|
155
|
+
* connection that registers many over its life does not accumulate them.
|
|
151
156
|
*/
|
|
152
|
-
|
|
157
|
+
clientSessions = new Map();
|
|
153
158
|
/**
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
* `
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
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();
|
|
159
|
+
* Typed client proxy — sends `data-server/on*` notifications back over the same wire.
|
|
160
|
+
* The proxy sends any `on[A-Z]*` name other than `onDidOpenConnection` and
|
|
161
|
+
* `onDidCloseConnection`, for which it returns its own events, so a subclass
|
|
162
|
+
* with notifications of its own narrows only the type:
|
|
163
|
+
* `declare protected readonly clientProxy: TheirClient`.
|
|
164
|
+
*/
|
|
165
|
+
clientProxy;
|
|
166
|
+
disposables = new DisposableCollection();
|
|
203
167
|
tracer;
|
|
204
168
|
/** The in-flight interactive profile capture, held between {@link startProfiling} and {@link stopProfiling}. */
|
|
205
169
|
activeProfile;
|
|
@@ -211,11 +175,8 @@ export class DataServer {
|
|
|
211
175
|
encoder;
|
|
212
176
|
/**
|
|
213
177
|
* In-process workspace facade — the lifecycle delegate `get` / `update` / `save` go through.
|
|
214
|
-
*
|
|
215
|
-
*
|
|
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`.
|
|
178
|
+
* Its documents carry the AST-layer {@link AstDiagnostic}, never the wire `TDiagnostic`:
|
|
179
|
+
* {@link encoder} converts one into the other on the way out.
|
|
219
180
|
*/
|
|
220
181
|
modelService;
|
|
221
182
|
constructor(connection, services, options = {}) {
|
|
@@ -224,8 +185,7 @@ export class DataServer {
|
|
|
224
185
|
this.options = this.resolveOptions(options);
|
|
225
186
|
this.tracer = this.services.Tracer.for(options.logName ?? 'DataServer').trace('instantiated');
|
|
226
187
|
// DI-bound: adopters rebind `services.model.TransferEncoder` /
|
|
227
|
-
// `services.model.ModelService` with their own subclasses.
|
|
228
|
-
// framework upper bounds; the casts below narrow to this instance's generics.
|
|
188
|
+
// `services.model.ModelService` with their own subclasses.
|
|
229
189
|
const { TransferEncoder: encoder, ModelService: modelService } = this.services.model;
|
|
230
190
|
if (!encoder || !modelService) {
|
|
231
191
|
throw new Error('DataServer requires `services.model.TransferEncoder` and `services.model.ModelService` to be bound. ' +
|
|
@@ -248,35 +208,42 @@ export class DataServer {
|
|
|
248
208
|
methodNamespace: this.options.methodNamespace,
|
|
249
209
|
localTarget: this,
|
|
250
210
|
localMethods: registeredMethods,
|
|
251
|
-
latency: this.latency
|
|
211
|
+
latency: this.latency,
|
|
212
|
+
// Bound at the chokepoint rather than per handler, so an adopter's
|
|
213
|
+
// `additionalMethods` are rendered on the same terms as the
|
|
214
|
+
// framework's own rejections.
|
|
215
|
+
renderErrorMessage: error => this.services.MessageRenderer.renderError(error)
|
|
252
216
|
});
|
|
253
|
-
this.disposables.push(this.
|
|
254
|
-
|
|
255
|
-
}));
|
|
256
|
-
this.subscribeToDocumentBuilder();
|
|
217
|
+
this.disposables.push(this.modelService.onModelDeleted(event => this.dispatchDeleteEvent(event)));
|
|
218
|
+
this.subscribeToModelUpdates();
|
|
257
219
|
this.subscribeToTextDocumentSaves();
|
|
258
|
-
this.
|
|
220
|
+
this.subscribeToDirtyChanges();
|
|
221
|
+
this.subscribeToModelReleases();
|
|
259
222
|
this.subscribeToProjectManager();
|
|
260
223
|
// Self-register teardown so an adopter that keeps no reference to the
|
|
261
224
|
// server still releases per-connection state, with no lifecycle hook of
|
|
262
|
-
// its own.
|
|
263
|
-
|
|
225
|
+
// its own. The client did not close anything itself, so its sessions end
|
|
226
|
+
// as lost and each document it was the last to have open waits out the
|
|
227
|
+
// store's release grace. See `dispose`.
|
|
228
|
+
this.disposables.push(connection.onClose(() => this.dispose('lost')));
|
|
264
229
|
}
|
|
265
230
|
/**
|
|
266
231
|
* Release everything the constructor wired up — the bound protocol
|
|
267
|
-
* handlers and every listener — and clear
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
*
|
|
272
|
-
* this server's and so outlives the connection unless released here.
|
|
232
|
+
* handlers and every listener — and clear {@link uriWatchRecords}, so a
|
|
233
|
+
* long-lived shared services bundle does not retain per-connection memory
|
|
234
|
+
* after the connection closes. Also ends every session this connection registered, which closes
|
|
235
|
+
* every document it has open: the SHARED store's state rather than this
|
|
236
|
+
* server's, which outlives the connection unless released here.
|
|
273
237
|
*
|
|
274
|
-
* Idempotent: subsequent calls are no-ops.
|
|
275
|
-
*
|
|
276
|
-
*
|
|
277
|
-
*
|
|
238
|
+
* Idempotent: subsequent calls are no-ops. Runs by itself when the
|
|
239
|
+
* connection closes, so adopters who don't hold a reference still get
|
|
240
|
+
* per-connection cleanup; adopters that DO hold a reference may call
|
|
241
|
+
* `dispose()` directly for early teardown. The sessions end with `cause`:
|
|
242
|
+
* `'closed'` releases every document whose last open they close at once,
|
|
243
|
+
* and `'lost'`, the connection's own close, lets each wait out the release
|
|
244
|
+
* grace.
|
|
278
245
|
*/
|
|
279
|
-
dispose() {
|
|
246
|
+
dispose(cause = 'closed') {
|
|
280
247
|
this.disposed = true;
|
|
281
248
|
// Release an in-flight interactive capture so the process-wide inspector
|
|
282
249
|
// singleton is not left active after the connection closes.
|
|
@@ -285,98 +252,132 @@ export class DataServer {
|
|
|
285
252
|
this.activeProfile = undefined;
|
|
286
253
|
void capture.stop({}).catch(() => undefined);
|
|
287
254
|
}
|
|
288
|
-
// AFTER `disposables.dispose()`, deliberately:
|
|
289
|
-
//
|
|
290
|
-
//
|
|
255
|
+
// AFTER `disposables.dispose()`, deliberately: ending a session releases
|
|
256
|
+
// each document it was the last to hold, and this server's own
|
|
257
|
+
// `onModelReleased` subscription would otherwise mark a release broadcast
|
|
258
|
+
// for a connection that is already gone.
|
|
291
259
|
this.disposables.dispose();
|
|
292
|
-
this.
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
this.
|
|
260
|
+
for (const [clientId, session] of this.clientSessions) {
|
|
261
|
+
this.endSession(clientId, session, cause);
|
|
262
|
+
}
|
|
263
|
+
this.uriWatchRecords.clear();
|
|
296
264
|
}
|
|
297
265
|
// ============================================================
|
|
298
|
-
// DataServerProtocol implementation
|
|
266
|
+
// DataServerProtocol implementation
|
|
299
267
|
// ============================================================
|
|
300
268
|
//
|
|
301
|
-
//
|
|
302
|
-
//
|
|
303
|
-
// the wire boundary via
|
|
304
|
-
//
|
|
305
|
-
//
|
|
306
|
-
//
|
|
307
|
-
async
|
|
308
|
-
//
|
|
309
|
-
//
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
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) };
|
|
269
|
+
// Reads go to `ModelService`; a request that opens or writes a document
|
|
270
|
+
// goes to the session this connection registered under its `clientId`.
|
|
271
|
+
// Each answer is encoded on the wire boundary via
|
|
272
|
+
// `encoder.astDocumentToTransferDocument`. To change how documents are
|
|
273
|
+
// read, override on the ModelService subclass; to change how they are
|
|
274
|
+
// written, on the session class the bound `ClientSessionFactory` builds.
|
|
275
|
+
async createSession(args) {
|
|
276
|
+
// After teardown nothing would ever end a session registered now, and its
|
|
277
|
+
// id would stay taken for the life of the process.
|
|
278
|
+
if (this.disposed) {
|
|
279
|
+
throw new SessionClosedError(args.clientId);
|
|
280
|
+
}
|
|
281
|
+
const session = this.modelService.createSession(args.label, args.clientId, { resumeToken: args.resumeToken });
|
|
282
|
+
this.clientSessions.set(args.clientId, session);
|
|
283
|
+
// A session also ends without closeSession, as when a client registers
|
|
284
|
+
// again on another connection, and its watches and entry here would
|
|
285
|
+
// otherwise outlive it.
|
|
286
|
+
session.onDidDispose(cause => {
|
|
287
|
+
// A session class may report its end late, once a replacement holds
|
|
288
|
+
// the id here; the replacement's entry and watches stay.
|
|
289
|
+
if (this.clientSessions.get(args.clientId) !== session) {
|
|
290
|
+
return;
|
|
291
|
+
}
|
|
292
|
+
this.dropWatches(args.clientId);
|
|
293
|
+
this.clientSessions.delete(args.clientId);
|
|
294
|
+
this.tracer.debug(`Forget session ${args.clientId}: it ended as ${cause}`);
|
|
295
|
+
});
|
|
333
296
|
}
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
297
|
+
/** End a session this connection registered. */
|
|
298
|
+
async closeSession(args) {
|
|
299
|
+
const session = this.clientSessions.get(args.clientId);
|
|
300
|
+
if (session) {
|
|
301
|
+
this.endSession(args.clientId, session);
|
|
302
|
+
}
|
|
303
|
+
}
|
|
304
|
+
/** End `session`, registered here under `clientId`, with `cause`, and drop its watches on this connection. */
|
|
305
|
+
endSession(clientId, session, cause = 'closed') {
|
|
306
|
+
this.dropWatches(clientId);
|
|
307
|
+
session.dispose(cause);
|
|
308
|
+
}
|
|
309
|
+
dropWatches(clientId) {
|
|
310
|
+
for (const [uri, record] of this.uriWatchRecords) {
|
|
311
|
+
if (record.watchers.delete(clientId)) {
|
|
312
|
+
this.pruneUriWatchRecord(uri);
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
async createModelDocument(args) {
|
|
317
|
+
const session = this.requireSession(args.clientId);
|
|
318
|
+
await session.create(args.uri, args.text);
|
|
319
|
+
return this.openedSnapshot(args.uri, () => session.close(args.uri));
|
|
320
|
+
}
|
|
321
|
+
async updateModelDocuments(args) {
|
|
322
|
+
const astDocuments = await this.requireSession(args.clientId).updateAll({
|
|
323
|
+
updates: args.updates.map(update => this.toSessionWrite(update))
|
|
324
|
+
});
|
|
325
|
+
return astDocuments.map(astDocument => this.encodeDocument(astDocument));
|
|
341
326
|
}
|
|
342
327
|
/**
|
|
343
|
-
*
|
|
344
|
-
*
|
|
328
|
+
* The session write a wire write request carries. Only the fields a session
|
|
329
|
+
* takes: a field an adopter adds to a request reaches the session only
|
|
330
|
+
* through an override of this.
|
|
345
331
|
*/
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
332
|
+
toSessionWrite(request) {
|
|
333
|
+
return { uri: request.uri, model: request.model, baseVersion: request.baseVersion };
|
|
334
|
+
}
|
|
335
|
+
/**
|
|
336
|
+
* The session this connection registered under `clientId`, which every
|
|
337
|
+
* document request acts as. An id that is not one fails with the
|
|
338
|
+
* closed-session code: opening or writing under it would leave an open that
|
|
339
|
+
* no session end ever closes.
|
|
340
|
+
*/
|
|
341
|
+
requireSession(clientId) {
|
|
342
|
+
const session = this.clientSessions.get(clientId);
|
|
343
|
+
if (!session) {
|
|
344
|
+
throw new SessionClosedError(clientId, 'The client session is not registered on this connection.');
|
|
354
345
|
}
|
|
346
|
+
return session;
|
|
347
|
+
}
|
|
348
|
+
async openModelDocument(args) {
|
|
349
|
+
const session = this.requireSession(args.clientId);
|
|
350
|
+
const wasOpen = this.services.workspace.TextDocuments.isOpenInClient(args.uri, args.clientId);
|
|
351
|
+
await session.open(args.uri, args.options);
|
|
352
|
+
// A repeat open keeps the earlier one, which is still in use.
|
|
353
|
+
return this.openedSnapshot(args.uri, wasOpen ? undefined : () => session.close(args.uri));
|
|
355
354
|
}
|
|
356
355
|
/**
|
|
357
|
-
*
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
*/
|
|
371
|
-
closeOpenDocuments() {
|
|
372
|
-
const held = [...this.openedDocuments];
|
|
373
|
-
this.openedDocuments.clear();
|
|
374
|
-
for (const [uri, clientIds] of held) {
|
|
375
|
-
for (const clientId of clientIds) {
|
|
376
|
-
void Promise.resolve(this.modelService.close({ uri, clientId })).catch(() => undefined);
|
|
377
|
-
}
|
|
356
|
+
* The snapshot a session's open or create answers with. When the read
|
|
357
|
+
* fails, `rollback` undoes the open this call made before the failure is
|
|
358
|
+
* rethrown: the caller sees no open, so nothing on its side would ever close
|
|
359
|
+
* it.
|
|
360
|
+
*/
|
|
361
|
+
async openedSnapshot(uri, rollback) {
|
|
362
|
+
try {
|
|
363
|
+
return await this.getModelDocument({ uri });
|
|
364
|
+
}
|
|
365
|
+
catch (error) {
|
|
366
|
+
// The open's failure is the one the caller needs, not the cleanup's.
|
|
367
|
+
await rollback?.().catch(() => undefined);
|
|
368
|
+
throw error;
|
|
378
369
|
}
|
|
379
370
|
}
|
|
371
|
+
async closeModelDocument(args) {
|
|
372
|
+
// Through the handle, so a close under an ended session fails as that
|
|
373
|
+
// session's calls do, and a session class's own close is honoured.
|
|
374
|
+
const session = this.requireSession(args.clientId);
|
|
375
|
+
// Closing also releases the watch for (uri, clientId) — a forgotten
|
|
376
|
+
// unwatch would otherwise leak phase-event dispatch until the connection
|
|
377
|
+
// closes. Idempotent: a close without a prior watch is a no-op.
|
|
378
|
+
await this.unwatchModelDocument({ uri: args.uri, clientId: args.clientId });
|
|
379
|
+
await session.close(args.uri);
|
|
380
|
+
}
|
|
380
381
|
async getModelDocument(args) {
|
|
381
382
|
// Smart dispatch: a warm document (already in LangiumDocuments) is
|
|
382
383
|
// returned at its settle phase without a redundant build; a cold URI
|
|
@@ -389,72 +390,95 @@ export class DataServer {
|
|
|
389
390
|
// unsubscribed caller that needs diagnostics inline passes
|
|
390
391
|
// `includeDiagnostics: true` to settle at `Validated` instead.
|
|
391
392
|
const state = args.includeDiagnostics ? DocumentState.Validated : undefined;
|
|
392
|
-
|
|
393
|
-
|
|
393
|
+
try {
|
|
394
|
+
return this.encodeDocument(await this.modelService.ensureDocumentState(args.uri, state));
|
|
395
|
+
}
|
|
396
|
+
catch (error) {
|
|
397
|
+
// The protocol answers a read of a URI with no document with an
|
|
398
|
+
// envelope that has no model.
|
|
399
|
+
if (this.isMissingDocument(error, args.uri)) {
|
|
400
|
+
return this.envelope(UriUtils.toUri(args.uri));
|
|
401
|
+
}
|
|
402
|
+
throw error;
|
|
403
|
+
}
|
|
394
404
|
}
|
|
395
405
|
async updateModelDocument(args) {
|
|
396
|
-
const astDocument = await this.
|
|
397
|
-
return this.
|
|
406
|
+
const astDocument = await this.requireSession(args.clientId).update(this.toSessionWrite(args));
|
|
407
|
+
return this.encodeDocument(astDocument);
|
|
398
408
|
}
|
|
399
409
|
async saveModelDocument(args) {
|
|
400
|
-
const astDocument = await this.
|
|
401
|
-
return this.
|
|
410
|
+
const astDocument = await this.requireSession(args.clientId).save(this.toSessionWrite(args));
|
|
411
|
+
return { ...this.encodeDocument(astDocument), persisted: astDocument.persisted };
|
|
412
|
+
}
|
|
413
|
+
async persistModelDocument(args) {
|
|
414
|
+
const version = await this.requireSession(args.clientId).persist({ uri: args.uri, baseVersion: args.baseVersion });
|
|
415
|
+
const astDocument = await this.modelService.ensureDocumentState(args.uri, this.services.workspace.DocumentBuilder.finalBuildState());
|
|
416
|
+
return { ...this.encodeDocument(astDocument), persisted: { version } };
|
|
402
417
|
}
|
|
403
418
|
/**
|
|
404
419
|
* Record a watch for `(uri, clientId)`. Subsequent phase events on `uri`
|
|
405
420
|
* fan out to the wired `clientProxy.onDocumentUpdated`. The
|
|
406
421
|
* bidirectional pattern means the event channel is the client
|
|
407
422
|
* notification surface, not a returned handle — this method only
|
|
408
|
-
* registers the
|
|
423
|
+
* registers the watcher in {@link uriWatchRecords}.
|
|
409
424
|
*
|
|
410
|
-
* Also baselines the
|
|
411
|
-
* {@link
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
416
|
-
* redundant phase notification for that same state.
|
|
425
|
+
* Also baselines the URI's emission fingerprint (see
|
|
426
|
+
* {@link dispatchPhaseEvent}) to the document's current state when the
|
|
427
|
+
* first watcher for the URI registers. This guarantees that any phase event firing immediately after
|
|
428
|
+
* the watch with no observable change is suppressed — watchers obtain
|
|
429
|
+
* initial state via `getModelDocument` (or {@link openModelDocument}) and
|
|
430
|
+
* do not need a redundant phase notification for that same state.
|
|
417
431
|
*/
|
|
418
432
|
async watchModelDocument(args) {
|
|
419
433
|
const uri = this.canonicalKey(args.uri);
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
if (document) {
|
|
429
|
-
this.lastEmittedFingerprint.set(uri, this.computeDocumentFingerprint(document));
|
|
434
|
+
const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set() };
|
|
435
|
+
this.uriWatchRecords.set(uri, record);
|
|
436
|
+
record.watchers.add(args.clientId);
|
|
437
|
+
if (record.fingerprint === undefined) {
|
|
438
|
+
const document = this.modelService.getDocument(args.uri);
|
|
439
|
+
if (document && !this.services.workspace.ModelLedger.isPlaceholder(document.parseResult.value)) {
|
|
440
|
+
record.fingerprint = this.computeDocumentFingerprint(document.parseResult.value, this.encoder.toTransferDocument(document));
|
|
441
|
+
record.fingerprintVersion = this.services.workspace.ModelLedger.versionOf(document.parseResult.value);
|
|
430
442
|
}
|
|
431
443
|
}
|
|
432
444
|
}
|
|
433
445
|
/**
|
|
434
446
|
* Remove a watch for `(uri, clientId)` previously created by
|
|
435
447
|
* {@link watchModelDocument}. Idempotent — unwatching twice is a no-op.
|
|
436
|
-
* Dispatch for `uri` stops once no watchers remain,
|
|
437
|
-
*
|
|
438
|
-
* re-baselines against the then-current document state rather than a
|
|
439
|
-
* stale snapshot from the previous watch.
|
|
448
|
+
* Dispatch for `uri` stops once no watchers remain, and the emission
|
|
449
|
+
* fingerprint goes with the last watcher (see {@link pruneUriWatchRecord}).
|
|
440
450
|
*/
|
|
441
451
|
async unwatchModelDocument(args) {
|
|
442
452
|
const uri = this.canonicalKey(args.uri);
|
|
443
|
-
|
|
444
|
-
|
|
453
|
+
if (this.uriWatchRecords.get(uri)?.watchers.delete(args.clientId)) {
|
|
454
|
+
this.pruneUriWatchRecord(uri);
|
|
455
|
+
}
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
* Drop what `uri` no longer needs: the
|
|
459
|
+
* {@link DataServerUriWatchRecord.fingerprint} once no client watches it,
|
|
460
|
+
* and the whole record once it holds no
|
|
461
|
+
* {@link DataServerUriWatchRecord.releaseBroadcastPending} mark either.
|
|
462
|
+
* Every path that removes a watcher or consumes a mark ends here.
|
|
463
|
+
*/
|
|
464
|
+
pruneUriWatchRecord(uri) {
|
|
465
|
+
const record = this.uriWatchRecords.get(uri);
|
|
466
|
+
if (!record || record.watchers.size > 0) {
|
|
445
467
|
return;
|
|
446
468
|
}
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
469
|
+
if (record.releaseBroadcastPending) {
|
|
470
|
+
record.fingerprint = undefined;
|
|
471
|
+
record.fingerprintVersion = undefined;
|
|
472
|
+
}
|
|
473
|
+
else {
|
|
474
|
+
this.uriWatchRecords.delete(uri);
|
|
451
475
|
}
|
|
452
476
|
}
|
|
453
477
|
/**
|
|
454
|
-
* Canonicalise a URI string for use as a
|
|
455
|
-
*
|
|
456
|
-
*
|
|
457
|
-
*
|
|
478
|
+
* Canonicalise a URI string for use as a {@link uriWatchRecords} key, via the
|
|
479
|
+
* shared `DocumentUriPolicy`. Callers may send non-canonical URIs
|
|
480
|
+
* (drive-letter casing, percent-encoding differences, or a symlink path)
|
|
481
|
+
* over the wire; the dispatch side keys by
|
|
458
482
|
* `document.uri.toString()` from `LangiumDocuments`, so writer keys must
|
|
459
483
|
* canonicalise to the same form or events silently fail to deliver.
|
|
460
484
|
* Routing through the seam (rather than a bare `UriUtils.normalize`)
|
|
@@ -464,6 +488,7 @@ export class DataServer {
|
|
|
464
488
|
* LSP head resolves.
|
|
465
489
|
*
|
|
466
490
|
* Adopters can still override for head-specific URI policy by subclassing.
|
|
491
|
+
* The result keys watches only; a document is looked up by its own URI.
|
|
467
492
|
*/
|
|
468
493
|
canonicalKey(uri) {
|
|
469
494
|
return this.services.workspace.DocumentUriPolicy.canonicalUri(uri);
|
|
@@ -498,26 +523,56 @@ export class DataServer {
|
|
|
498
523
|
// Resolve the language's reference services from each request's source
|
|
499
524
|
// (see resolveReferenceServices) and delegate.
|
|
500
525
|
// ============================================================
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
526
|
+
/**
|
|
527
|
+
* Settle the build before a reference question is answered from the index.
|
|
528
|
+
*
|
|
529
|
+
* A query issued right after a model update otherwise races the rebuild and
|
|
530
|
+
* reads an index missing the symbols it asks about. The cost is not confined
|
|
531
|
+
* to this call: a scope built inside that window is cached, and the build's
|
|
532
|
+
* remaining documents link against it.
|
|
533
|
+
*
|
|
534
|
+
* Waits the source document specifically, but ONLY when one is loaded at
|
|
535
|
+
* that URI: a synthetic source can address a URI with no document (a
|
|
536
|
+
* directory URI, typically), where a per-URI `waitUntil` throws "No document
|
|
537
|
+
* found". Falls back to a global settle, matching the id-based
|
|
538
|
+
* `ElementSource` path.
|
|
539
|
+
*
|
|
540
|
+
* Bounded by {@link DataServerOptions.referenceSettleTimeoutMs}.
|
|
541
|
+
*/
|
|
542
|
+
async awaitReferencesLinked(source) {
|
|
543
|
+
const uri = isDocumentSource(source) || isSyntheticSource(source) ? UriUtils.toUri(source.uri) : undefined;
|
|
510
544
|
const waitUri = uri && this.services.workspace.LangiumDocuments.hasDocument(uri) ? uri : undefined;
|
|
511
|
-
|
|
545
|
+
const stopwatch = this.services.Clock.stopwatch();
|
|
546
|
+
const linked = this.services.workspace.DocumentBuilder.waitUntil(DocumentState.Linked, waitUri);
|
|
547
|
+
if ((await this.services.Clock.raceTimer(linked, this.options.referenceSettleTimeoutMs)) !== TIMED_OUT) {
|
|
548
|
+
return;
|
|
549
|
+
}
|
|
550
|
+
const elapsedMs = Math.round(stopwatch.elapsedMs);
|
|
551
|
+
// A per-URI wait resolves off a document-phase notification, so a
|
|
552
|
+
// missed one strands a wait on a document that HAS reached the
|
|
553
|
+
// phase. Re-read before failing; the workspace-wide wait has no
|
|
554
|
+
// equivalent reading and can only reject.
|
|
555
|
+
const document = waitUri ? this.services.workspace.LangiumDocuments.getDocument(waitUri) : undefined;
|
|
556
|
+
if (waitUri && document && document.state >= DocumentState.Linked) {
|
|
557
|
+
this.tracer
|
|
558
|
+
.withUri(waitUri.toString())
|
|
559
|
+
.warn(`Missed the 'Linked' notification after ${elapsedMs}ms; the document already reached it`);
|
|
560
|
+
return;
|
|
561
|
+
}
|
|
562
|
+
throw referenceSettleTimeoutError(elapsedMs);
|
|
563
|
+
}
|
|
564
|
+
async findReferenceCandidates(ctx) {
|
|
565
|
+
await this.awaitReferencesLinked(ctx.source);
|
|
512
566
|
return this.resolveReferenceServices(ctx.source).CandidateProvider.find(ctx);
|
|
513
567
|
}
|
|
514
568
|
async resolveReference(ref) {
|
|
569
|
+
await this.awaitReferencesLinked(ref.source);
|
|
515
570
|
const resolved = this.resolveReferenceServices(ref.source).CandidateProvider.resolveCandidate(ref);
|
|
516
571
|
if (!resolved) {
|
|
517
572
|
return undefined;
|
|
518
573
|
}
|
|
519
|
-
|
|
520
|
-
return { ...resolved.candidate, element };
|
|
574
|
+
// `TElement` is the caller's claim about the target's type; nothing checks it.
|
|
575
|
+
return { ...resolved.candidate, element: this.encoder.toTransfer(resolved.node) };
|
|
521
576
|
}
|
|
522
577
|
async findNextName(args) {
|
|
523
578
|
const uri = UriUtils.toUri(args.uri);
|
|
@@ -526,15 +581,32 @@ export class DataServer {
|
|
|
526
581
|
// synthetic source — and the create-element flow driving this method is
|
|
527
582
|
// the one that produces directory URIs, on which a bare
|
|
528
583
|
// `getServices(uri)` throws while `findReferenceCandidates` succeeds.
|
|
529
|
-
const
|
|
584
|
+
const source = ReferenceSource.synthetic(args.uri, args.type, args.language);
|
|
585
|
+
// Mid-rebuild the names of documents not yet re-indexed are absent from
|
|
586
|
+
// the taken set, and the caller PERSISTS what it is handed. Nothing
|
|
587
|
+
// reserves the answer either, so a name is free of the collisions the
|
|
588
|
+
// index knows about and of nothing else — two callers racing get the same
|
|
589
|
+
// proposal, which only uniqueness at the write can catch.
|
|
590
|
+
await this.awaitReferencesLinked(source);
|
|
591
|
+
const nameProvider = this.resolveReferenceServices(source).NameProvider;
|
|
530
592
|
const tier = args.tier ?? 'project';
|
|
531
593
|
if (tier === 'public') {
|
|
532
594
|
return nameProvider.findNextProjectQualifiedName(args.type, args.proposal);
|
|
533
595
|
}
|
|
534
596
|
if (tier === 'local') {
|
|
535
|
-
// Document-scoped uniqueness: the document root is the container.
|
|
536
|
-
|
|
537
|
-
|
|
597
|
+
// Document-scoped uniqueness: the document root is the container. A
|
|
598
|
+
// URI with no document has nothing to collide with, like a document
|
|
599
|
+
// with no root.
|
|
600
|
+
try {
|
|
601
|
+
const document = await this.modelService.ensureDocumentState(args.uri);
|
|
602
|
+
return document.root ? nameProvider.findNextName(args.type, args.proposal, document.root) : args.proposal;
|
|
603
|
+
}
|
|
604
|
+
catch (error) {
|
|
605
|
+
if (this.isMissingDocument(error, args.uri)) {
|
|
606
|
+
return args.proposal;
|
|
607
|
+
}
|
|
608
|
+
throw error;
|
|
609
|
+
}
|
|
538
610
|
}
|
|
539
611
|
const project = this.services.workspace.ProjectManager.getProject(uri);
|
|
540
612
|
if (!project) {
|
|
@@ -567,66 +639,30 @@ export class DataServer {
|
|
|
567
639
|
return language.references;
|
|
568
640
|
}
|
|
569
641
|
/**
|
|
570
|
-
* Pick the language that owns a reference source
|
|
642
|
+
* Pick the language that owns a reference source: the registry's
|
|
643
|
+
* `getLanguageFor` over the source's declared language, URI and AST type,
|
|
644
|
+
* with an {@link isElementSource} routed by the document that holds the
|
|
645
|
+
* element (see {@link findElementDocumentUri}) before its type, and
|
|
646
|
+
* {@link fallbackReferenceLanguage}, adopter policy, last.
|
|
571
647
|
*
|
|
572
|
-
*
|
|
573
|
-
*
|
|
574
|
-
*
|
|
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.
|
|
648
|
+
* An unregistered declared language falls through rather than failing: the
|
|
649
|
+
* id crosses the wire, so a client built against a head with one more
|
|
650
|
+
* grammar would otherwise lose queries the other signals answer.
|
|
587
651
|
*/
|
|
588
652
|
resolveReferenceLanguage(source) {
|
|
589
653
|
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
654
|
if (isElementSource(source)) {
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
}
|
|
655
|
+
// The index lookup runs only once the cheaper signals abstained.
|
|
656
|
+
return (registry.getLanguageFor({}) ??
|
|
657
|
+
registry.getLanguageFor({ target: this.findElementDocumentUri(source), type: source.type }) ??
|
|
658
|
+
this.fallbackReferenceLanguage(source));
|
|
608
659
|
}
|
|
609
|
-
const
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
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;
|
|
660
|
+
const hint = isSyntheticSource(source)
|
|
661
|
+
? { languageId: source.language, target: source.uri, type: source.type }
|
|
662
|
+
: isDocumentSource(source)
|
|
663
|
+
? { target: source.uri }
|
|
664
|
+
: {};
|
|
665
|
+
return registry.getLanguageFor(hint) ?? this.fallbackReferenceLanguage(source);
|
|
630
666
|
}
|
|
631
667
|
/**
|
|
632
668
|
* Locate the document that holds the element an {@link ElementSource}
|
|
@@ -635,15 +671,14 @@ export class DataServer {
|
|
|
635
671
|
* disambiguates names that repeat across types (honouring grammar
|
|
636
672
|
* subtyping through `AstReflection.isSubtype`).
|
|
637
673
|
*
|
|
638
|
-
* Only reached
|
|
639
|
-
*
|
|
640
|
-
* step 2.
|
|
674
|
+
* Only reached in a multi-language workspace, once the declared language
|
|
675
|
+
* and the URI have abstained.
|
|
641
676
|
*
|
|
642
677
|
* Abstains when the name matches elements in more than one DOCUMENT — the
|
|
643
678
|
* index spans every language and is filled in build order, so "the
|
|
644
|
-
* first match" would be file-watch order rather than an answer.
|
|
645
|
-
* then falls through to the type
|
|
646
|
-
*
|
|
679
|
+
* first match" would be file-watch order rather than an answer. Routing
|
|
680
|
+
* then falls through to the element's type, which abstains on ties in the
|
|
681
|
+
* same way, and finally to adopter policy.
|
|
647
682
|
*/
|
|
648
683
|
findElementDocumentUri(source) {
|
|
649
684
|
const matches = this.services.workspace.IndexManager.getElementsByName(source.name, source.type);
|
|
@@ -675,55 +710,134 @@ export class DataServer {
|
|
|
675
710
|
// ============================================================
|
|
676
711
|
// Internal plumbing
|
|
677
712
|
// ============================================================
|
|
713
|
+
/**
|
|
714
|
+
* Whether `error`, from waiting on `uri`'s document, means that `uri` has
|
|
715
|
+
* no document: a URI with neither a file nor text builds nothing, and
|
|
716
|
+
* Langium's wait after the build rejects for want of one, with a
|
|
717
|
+
* `ServerCancelled` response error. Any other failure, such as a read
|
|
718
|
+
* that fails before a document is registered, a cancelled wait or a
|
|
719
|
+
* `ReentrantWriteLockError`, is the caller's to see.
|
|
720
|
+
*/
|
|
721
|
+
isMissingDocument(error, uri) {
|
|
722
|
+
return isResponseError(error) && error.code === SERVER_CANCELLED && this.modelService.getDocument(uri) === undefined;
|
|
723
|
+
}
|
|
678
724
|
/**
|
|
679
725
|
* Build a {@link TransferDocument} envelope from the current document state,
|
|
680
726
|
* delegating root + diagnostic encoding to {@link encoder} (see
|
|
681
|
-
* `TransferEncoder.toTransferDocument` for the walk).
|
|
682
|
-
*
|
|
683
|
-
*
|
|
684
|
-
|
|
685
|
-
|
|
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) {
|
|
727
|
+
* `TransferEncoder.toTransferDocument` for the walk). `fingerprint` is the
|
|
728
|
+
* caller's {@link computeDocumentFingerprint} of that same state, which
|
|
729
|
+
* spares hashing it twice.
|
|
730
|
+
*/
|
|
731
|
+
envelope(uri, fingerprint) {
|
|
691
732
|
// Resolve through the model service's canonicalizing gateway rather than
|
|
692
733
|
// reaching into `LangiumDocuments` directly, so a divergent (symlink) URI
|
|
693
734
|
// still finds the document the build keys by its real path — and so the
|
|
694
735
|
// data-server never has to remember to canonicalize this lookup itself.
|
|
695
736
|
const document = this.modelService.getDocument(uri.toString());
|
|
696
|
-
if (!document) {
|
|
737
|
+
if (!document || this.services.workspace.ModelLedger.isPlaceholder(document.parseResult.value)) {
|
|
697
738
|
// No document — a shaped envelope rather than a throw, so the caller
|
|
698
|
-
// decides policy at its own layer; `
|
|
739
|
+
// decides policy at its own layer; `model` is optional on the envelope
|
|
699
740
|
// so the compiler forces that decision. Adopters preferring to throw
|
|
700
|
-
// override `envelope`.
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
741
|
+
// override `envelope`. The builder's unparsed placeholder is no
|
|
742
|
+
// document either: its root parses no text.
|
|
743
|
+
return TransferDocument.absent(uri.toString());
|
|
744
|
+
}
|
|
745
|
+
const encoded = this.encoder.toTransferDocument(document);
|
|
746
|
+
return this.withServerState(encoded, fingerprint ?? this.computeDocumentFingerprint(document.parseResult.value, encoded));
|
|
747
|
+
}
|
|
748
|
+
/**
|
|
749
|
+
* The transfer document a request answers with for `astDocument`, its model
|
|
750
|
+
* hashed and the text stamped on it by {@link withServerState}. Every
|
|
751
|
+
* document a request answers with goes through here, so none goes out
|
|
752
|
+
* without them.
|
|
753
|
+
*/
|
|
754
|
+
encodeDocument(astDocument) {
|
|
755
|
+
const encoded = this.encoder.astDocumentToTransferDocument(astDocument);
|
|
756
|
+
return this.withServerState(encoded, this.computeDocumentFingerprint(astDocument.root, encoded));
|
|
757
|
+
}
|
|
758
|
+
/**
|
|
759
|
+
* `encoded` with `hash` on its model and the text the server holds for it:
|
|
760
|
+
* the store's while it holds the document, the build's otherwise. The text
|
|
761
|
+
* is read when the document is sent rather than kept with the build: a save
|
|
762
|
+
* changes `text.dirty` without a rebuild, and the store's text moves on before
|
|
763
|
+
* the build that follows it.
|
|
764
|
+
*/
|
|
765
|
+
withServerState(encoded, hash) {
|
|
766
|
+
const text = this.services.workspace.TextDocuments.textState(encoded.uri) ?? this.builtTextState(encoded.uri);
|
|
767
|
+
if (text && text.version > encoded.model.version) {
|
|
768
|
+
this.tracer.withUri(encoded.uri).debug(`Send a model behind its text: model v${encoded.model.version} / text v${text.version}`);
|
|
707
769
|
}
|
|
708
|
-
return
|
|
770
|
+
return {
|
|
771
|
+
uri: encoded.uri,
|
|
772
|
+
// The encoder returns the structural base; `TTransfer` is the adopter's
|
|
773
|
+
// declaration of the roots its languages produce, and nothing checks it.
|
|
774
|
+
model: { ...encoded.model, hash },
|
|
775
|
+
...(text ? { text } : {})
|
|
776
|
+
};
|
|
709
777
|
}
|
|
710
778
|
/**
|
|
711
|
-
*
|
|
712
|
-
*
|
|
713
|
-
* single listener (rather than one per subscription) keeps the cost flat
|
|
714
|
-
* regardless of subscriber count.
|
|
779
|
+
* The text a build read for a document the store never held, which is
|
|
780
|
+
* clean: the store holds every text a client gave it.
|
|
715
781
|
*/
|
|
716
|
-
|
|
717
|
-
|
|
782
|
+
builtTextState(uri) {
|
|
783
|
+
const textDocument = this.modelService.getDocument(uri)?.textDocument;
|
|
784
|
+
return textDocument && { version: textDocument.version, hash: textHash(textDocument.getText()), dirty: false };
|
|
718
785
|
}
|
|
719
786
|
/**
|
|
720
|
-
*
|
|
721
|
-
*
|
|
722
|
-
*
|
|
723
|
-
|
|
724
|
-
|
|
787
|
+
* Follow every document at the configured
|
|
788
|
+
* {@link DataServerOptions.subscriptionPhase}, once per connection rather
|
|
789
|
+
* than once per watch, so the cost stays flat in the number of watches.
|
|
790
|
+
*/
|
|
791
|
+
subscribeToModelUpdates() {
|
|
792
|
+
const phase = this.options.subscriptionPhase;
|
|
793
|
+
this.disposables.push(this.modelService.onModelUpdated(event => this.dispatchPhaseEvent(event), { phase }));
|
|
794
|
+
// One message per build rather than one per document.
|
|
795
|
+
this.disposables.push(this.modelService.onModelsBuilt(event => this.dispatchBuiltEvent(event.uris), { phase }));
|
|
796
|
+
}
|
|
797
|
+
/**
|
|
798
|
+
* Report the documents that reached {@link DataServerOptions.subscriptionPhase}
|
|
799
|
+
* and that NOBODY on this
|
|
800
|
+
* connection is watching — the ones a client was not told about through
|
|
801
|
+
* {@link dispatchPhaseEvent}, which is gated per URI.
|
|
802
|
+
*
|
|
803
|
+
* **The gap this closes is the one no other source can observe.** A document
|
|
804
|
+
* the client watches, it hears about already. A file changed on disk, the
|
|
805
|
+
* host's own filesystem watcher reports — and on a browser host, where the
|
|
806
|
+
* workspace lives behind this head, an external change cannot happen at all.
|
|
807
|
+
* What is left, and what nothing outside the server can see, is a document
|
|
808
|
+
* rebuilt because something it DEPENDS ON changed: its file never changed, so
|
|
809
|
+
* a filesystem watcher is silent by construction, and it has no subscriber, so
|
|
810
|
+
* the update channel is silent by design. A consumer displaying data derived
|
|
811
|
+
* from that document — a tree label, a decorator — otherwise goes stale with
|
|
812
|
+
* no signal from any source, and repairs itself the moment someone opens the
|
|
813
|
+
* file to investigate, which is what makes it expensive to diagnose later.
|
|
725
814
|
*
|
|
726
|
-
*
|
|
815
|
+
* Payload-free on purpose: URIs only, so a client re-reads what it displays
|
|
816
|
+
* rather than being handed transfer documents it did not ask for. That is the
|
|
817
|
+
* property the watcher gate protects, and it is preserved here by
|
|
818
|
+
* carrying no document rather than by gating the message.
|
|
819
|
+
*
|
|
820
|
+
* Quiet in the common case. Editing a document that an editor has open leaves
|
|
821
|
+
* that URI watched and therefore out of this set, so a build with no
|
|
822
|
+
* dependents produces nothing at all, and workspace initialisation produces
|
|
823
|
+
* nothing because it does not build to this phase. The ceiling is a
|
|
824
|
+
* whole-workspace rebuild at the subscription phase: one message, URIs only.
|
|
825
|
+
*/
|
|
826
|
+
dispatchBuiltEvent(built) {
|
|
827
|
+
const uris = built.map(uri => this.canonicalKey(uri)).filter(uri => !this.uriWatchRecords.get(uri)?.watchers.size);
|
|
828
|
+
if (uris.length === 0) {
|
|
829
|
+
return;
|
|
830
|
+
}
|
|
831
|
+
this.tracer.debug(`Emit onDocumentsBuilt: ${uris.length} unwatched document(s)`);
|
|
832
|
+
this.clientProxy.onDocumentsBuilt({ uris });
|
|
833
|
+
}
|
|
834
|
+
/**
|
|
835
|
+
* Follow every save so a single `onDocumentSaved` wire notification fires
|
|
836
|
+
* for ANY save of a subscribed URI — regardless of whether the save
|
|
837
|
+
* originated from the data-server's RPC `saveModelDocument`, the LSP head's
|
|
838
|
+
* text-editor save, or any other client.
|
|
839
|
+
*
|
|
840
|
+
* Architectural symmetry with {@link subscribeToModelUpdates}: every
|
|
727
841
|
* subscribed client sees every state change to documents they care about,
|
|
728
842
|
* regardless of which client triggered it. Firing `onDocumentSaved` only
|
|
729
843
|
* from the data-server's own RPC path is a bug, not an optimisation: an
|
|
@@ -731,37 +845,107 @@ export class DataServer {
|
|
|
731
845
|
* clients, which never clear their dirty state.
|
|
732
846
|
*/
|
|
733
847
|
subscribeToTextDocumentSaves() {
|
|
734
|
-
this.disposables.push(this.
|
|
848
|
+
this.disposables.push(this.modelService.onModelSaved(event => this.dispatchSaveEvent(event)));
|
|
849
|
+
}
|
|
850
|
+
/** Relay each change of a document's dirty state; see {@link dispatchDirtyEvent}. */
|
|
851
|
+
subscribeToDirtyChanges() {
|
|
852
|
+
this.disposables.push(this.modelService.onDirtyChanged(event => this.dispatchDirtyEvent(event)));
|
|
735
853
|
}
|
|
736
854
|
/**
|
|
737
|
-
*
|
|
738
|
-
* {@link
|
|
739
|
-
*
|
|
740
|
-
* hold, so a `false` answer means this close was the last one.
|
|
855
|
+
* Send a dirty flip to the connection, gated on the URI's watchers as
|
|
856
|
+
* {@link dispatchSaveEvent} is: the answer at any one moment travels on
|
|
857
|
+
* every document sent, so a client that watches nothing reads it there.
|
|
741
858
|
*/
|
|
742
|
-
|
|
743
|
-
const
|
|
744
|
-
this.
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
859
|
+
dispatchDirtyEvent(event) {
|
|
860
|
+
const uri = this.canonicalKey(event.uri);
|
|
861
|
+
if (this.uriWatchRecords.get(uri)?.watchers.size) {
|
|
862
|
+
this.clientProxy.onDocumentDirtyChanged({ uri, text: event.text });
|
|
863
|
+
}
|
|
864
|
+
}
|
|
865
|
+
/**
|
|
866
|
+
* Mark each document the store releases, so {@link dispatchPhaseEvent}
|
|
867
|
+
* broadcasts the build that follows even without a watcher. By default
|
|
868
|
+
* that build reverts the document to its disk content, discarding unsaved
|
|
869
|
+
* in-session edits, and the last close typically also
|
|
870
|
+
* removed the last watcher: without the broadcast, a consumer that only
|
|
871
|
+
* ever fetches via `getModelDocument` keeps showing the discarded state.
|
|
872
|
+
* The broadcast is de-duplicated against the fingerprint while a watcher
|
|
873
|
+
* holds one, so a close whose disk state equals the last emitted state
|
|
874
|
+
* stays silent; with no watcher there is no fingerprint, and every release
|
|
875
|
+
* build is sent. The first build after the release consumes the mark, and
|
|
876
|
+
* goes out as the release unless it is stamped past the version a client
|
|
877
|
+
* opened the document at again: a client's write or an integrity repair
|
|
878
|
+
* that rides it keeps its author.
|
|
879
|
+
*
|
|
880
|
+
* A release, not the close itself: a document whose last client lost its
|
|
881
|
+
* connection is released only once the release grace runs out, or when
|
|
882
|
+
* another client opens it meanwhile, and not at all when a client lost
|
|
883
|
+
* from it opens it again within its own grace.
|
|
884
|
+
*/
|
|
885
|
+
subscribeToModelReleases() {
|
|
886
|
+
this.disposables.push(this.modelService.onModelReleased(event => {
|
|
887
|
+
const uri = this.canonicalKey(event.uri);
|
|
888
|
+
const record = this.uriWatchRecords.get(uri) ?? { watchers: new Set() };
|
|
889
|
+
record.releaseBroadcastPending = true;
|
|
890
|
+
this.uriWatchRecords.set(uri, record);
|
|
891
|
+
this.tracer.withUri(uri).debug('Release marked: the first build after it is broadcast, watched or not');
|
|
748
892
|
}));
|
|
749
893
|
}
|
|
750
|
-
/**
|
|
894
|
+
/**
|
|
895
|
+
* Fan out a deletion for each removed URI, to EVERY client on the connection
|
|
896
|
+
* rather than only to the ones watching that URI.
|
|
897
|
+
*
|
|
898
|
+
* **Deliberately ungated, where {@link dispatchPhaseEvent} and
|
|
899
|
+
* {@link dispatchSaveEvent} are gated.** Those two carry a built document and
|
|
900
|
+
* fire on every build, so the watcher gate is what keeps bandwidth
|
|
901
|
+
* proportional to what a client asked for. A deletion is neither: it is one
|
|
902
|
+
* URI, it is rare, and it reports the workspace's STRUCTURE rather than a
|
|
903
|
+
* document's content. Gating it forces any consumer that displays the
|
|
904
|
+
* workspace — a model tree, a file decorator — to learn about disappearances
|
|
905
|
+
* from a filesystem watcher instead, which a client hosted in a browser has
|
|
906
|
+
* no way to run: its workspace lives behind the head. A client that does not
|
|
907
|
+
* care filters on the URI, which costs it a comparison.
|
|
908
|
+
*
|
|
909
|
+
* The precedent is the release broadcast (see
|
|
910
|
+
* {@link subscribeToModelReleases}), where the same judgement was already made
|
|
911
|
+
* in the other direction: a transition that matters enough is delivered
|
|
912
|
+
* without a subscription.
|
|
913
|
+
*
|
|
914
|
+
* A deletion is announced before the build that follows it, so this goes
|
|
915
|
+
* out ahead of the `'rebuilt'` events for the dependents whose references
|
|
916
|
+
* the deletion just broke.
|
|
917
|
+
*
|
|
918
|
+
* The URI's fingerprint and release mark are dropped: they describe a
|
|
919
|
+
* document that no longer exists. A kept fingerprint is adopted as the
|
|
920
|
+
* baseline and suppresses the first emit after the file returns with its
|
|
921
|
+
* previous content.
|
|
922
|
+
*
|
|
923
|
+
* The watchers SURVIVE: a recreated file resumes delivering to them with no
|
|
924
|
+
* re-subscription, and a client that answers the deletion by closing
|
|
925
|
+
* releases the watch through `closeModelDocument` anyway.
|
|
926
|
+
*/
|
|
927
|
+
dispatchDeleteEvent(event) {
|
|
928
|
+
const uri = this.canonicalKey(event.uri);
|
|
929
|
+
const record = this.uriWatchRecords.get(uri);
|
|
930
|
+
if (record) {
|
|
931
|
+
record.fingerprint = undefined;
|
|
932
|
+
record.fingerprintVersion = undefined;
|
|
933
|
+
record.releaseBroadcastPending = undefined;
|
|
934
|
+
record.sentVersion = undefined;
|
|
935
|
+
this.pruneUriWatchRecord(uri);
|
|
936
|
+
}
|
|
937
|
+
this.clientProxy.onDocumentDeleted({ uri });
|
|
938
|
+
}
|
|
939
|
+
/** Fan out a save event for the document's URI, gated on the URI's watchers. */
|
|
751
940
|
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
941
|
const uri = this.canonicalKey(event.document.uri);
|
|
758
|
-
if (!this.
|
|
942
|
+
if (!this.uriWatchRecords.get(uri)?.watchers.size) {
|
|
759
943
|
return;
|
|
760
944
|
}
|
|
761
|
-
const response = this.envelope(UriUtils.toUri(uri));
|
|
945
|
+
const response = this.envelope(UriUtils.toUri(event.document.uri));
|
|
762
946
|
const wireEvent = {
|
|
763
947
|
document: response,
|
|
764
|
-
sourceClientId: event.
|
|
948
|
+
sourceClientId: event.sourceClientId
|
|
765
949
|
};
|
|
766
950
|
this.clientProxy.onDocumentSaved(wireEvent);
|
|
767
951
|
}
|
|
@@ -774,107 +958,106 @@ export class DataServer {
|
|
|
774
958
|
* out to multiple local subscribers with an `Emitter<T>` — the
|
|
775
959
|
* framework deliberately does NOT promise multi-listener semantics.
|
|
776
960
|
*
|
|
777
|
-
*
|
|
778
|
-
*
|
|
779
|
-
*
|
|
780
|
-
*
|
|
781
|
-
*
|
|
782
|
-
*
|
|
783
|
-
*
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
961
|
+
* An event for a URI no client watches is NOT sent over the wire, so
|
|
962
|
+
* bandwidth scales with watched URIs rather than with phase events; a
|
|
963
|
+
* pending release mark is the exception (see
|
|
964
|
+
* {@link subscribeToModelReleases}).
|
|
965
|
+
*
|
|
966
|
+
* An event for a rebuild with no observable change since the last emit is
|
|
967
|
+
* suppressed against the URI's fingerprint and the version it was taken at;
|
|
968
|
+
* a new version with the same fingerprint goes out with the same
|
|
969
|
+
* `model.hash`, so a watcher still learns the version. Such rebuilds are routine: a
|
|
970
|
+
* second client attaching to an open document makes
|
|
971
|
+
* `HydraniumTextDocuments.refreshContent` fire `onDidChangeContent` purely
|
|
972
|
+
* to re-trigger the build, and Langium rebuilds a document when a
|
|
973
|
+
* dependency changes even if its diagnostics come out the same. Sent at a
|
|
974
|
+
* version this head has not sent, they reach watchers as `'changed'`, and a
|
|
975
|
+
* watcher that reads `'changed'` as another client's write and resets its
|
|
976
|
+
* root to the server view loses the user's edits. The first {@link watchModelDocument} baselines the
|
|
977
|
+
* fingerprint, so the first event after a watch is de-duplicated against
|
|
978
|
+
* the state the watcher just fetched; it goes with the last watcher, so the
|
|
979
|
+
* next first watch re-baselines rather than adopting a stale digest. A
|
|
980
|
+
* digest keeps its memory constant in document size; see
|
|
981
|
+
* {@link computeDocumentFingerprint} for the inputs.
|
|
982
|
+
*/
|
|
983
|
+
dispatchPhaseEvent(event) {
|
|
984
|
+
const uri = this.canonicalKey(event.document.uri);
|
|
985
|
+
const record = this.uriWatchRecords.get(uri);
|
|
986
|
+
const afterRelease = record?.releaseBroadcastPending === true;
|
|
987
|
+
if (!record || (record.watchers.size === 0 && !afterRelease)) {
|
|
792
988
|
return;
|
|
793
989
|
}
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
990
|
+
if (afterRelease) {
|
|
991
|
+
// Consumed even when watchers exist — the regular dispatch below
|
|
992
|
+
// serves them, and the mark's attribution is more precise than the
|
|
993
|
+
// post-close unknown client the manager's attribution would yield.
|
|
994
|
+
// With no watcher the record goes now, so the fingerprint written
|
|
995
|
+
// below lands on a detached record and the next first watch
|
|
996
|
+
// re-baselines instead of adopting it.
|
|
997
|
+
record.releaseBroadcastPending = undefined;
|
|
998
|
+
this.pruneUriWatchRecord(uri);
|
|
999
|
+
}
|
|
1000
|
+
// The encoder reads the built document, which the event's holds for this
|
|
1001
|
+
// synchronous run.
|
|
1002
|
+
const document = this.modelService.getDocument(event.document.uri);
|
|
1003
|
+
if (!document) {
|
|
801
1004
|
return;
|
|
802
1005
|
}
|
|
803
|
-
const fingerprint = this.computeDocumentFingerprint(document);
|
|
804
|
-
|
|
1006
|
+
const fingerprint = this.computeDocumentFingerprint(document.parseResult.value, this.encoder.toTransferDocument(document));
|
|
1007
|
+
const stamped = this.services.workspace.ModelLedger.versionOf(document.parseResult.value);
|
|
1008
|
+
if (record.fingerprint === fingerprint && record.fingerprintVersion === stamped) {
|
|
805
1009
|
// A rebuild that produced no observable change since the last emit —
|
|
806
1010
|
// suppressed so RPC subscribers don't see a no-op broadcast. Logged at
|
|
807
1011
|
// debug so a *needed* re-broadcast wrongly suppressed by this dedup
|
|
808
1012
|
// (the failure mode the fingerprint strategy must avoid) is visible.
|
|
809
|
-
this.tracer.withUri(uri).debug(`Suppress onDocumentUpdated v${
|
|
1013
|
+
this.tracer.withUri(uri).debug(`Suppress onDocumentUpdated v${stamped}: fingerprint and version unchanged`);
|
|
810
1014
|
return;
|
|
811
1015
|
}
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
1016
|
+
record.fingerprint = fingerprint;
|
|
1017
|
+
record.fingerprintVersion = stamped;
|
|
1018
|
+
// The event's attribution, so this head names the same client as the
|
|
1019
|
+
// in-process heads do for one build, except for a version this head
|
|
1020
|
+
// already sent; see `DataServerUriWatchRecord.sentVersion`.
|
|
1021
|
+
const version = this.modelService.isOpen(event.document.uri) ? document.textDocument.version : undefined;
|
|
1022
|
+
const { reason, sourceClientId } = version !== undefined && record.sentVersion === version
|
|
1023
|
+
? { reason: 'rebuilt', sourceClientId: UNKNOWN_CLIENT_ID }
|
|
1024
|
+
: event;
|
|
1025
|
+
record.sentVersion = version;
|
|
1026
|
+
// The stamp, not the live version: a write after the build's parse moves
|
|
1027
|
+
// only the latter. At the opened version too, which a reopen with the
|
|
1028
|
+
// released text keeps.
|
|
1029
|
+
const openedVersion = afterRelease ? this.modelService.openedVersion(event.document.uri) : undefined;
|
|
1030
|
+
const releaseBuild = afterRelease && (openedVersion === undefined || stamped <= openedVersion);
|
|
1031
|
+
const wireEvent = {
|
|
1032
|
+
document: this.envelope(document.uri, fingerprint),
|
|
1033
|
+
sourceClientId: releaseBuild ? DOCUMENT_RELEASE_CLIENT_ID : sourceClientId,
|
|
1034
|
+
reason
|
|
817
1035
|
};
|
|
1036
|
+
const mark = afterRelease ? `, release mark: opened v${openedVersion ?? '-'}, attributed ${sourceClientId}` : '';
|
|
818
1037
|
this.tracer
|
|
819
1038
|
.withUri(uri)
|
|
820
|
-
.debug(`Emit onDocumentUpdated v${
|
|
821
|
-
this.clientProxy.onDocumentUpdated(
|
|
1039
|
+
.debug(`Emit onDocumentUpdated v${stamped} (reason=${wireEvent.reason}, sourceClientId=${wireEvent.sourceClientId}${mark})`);
|
|
1040
|
+
this.clientProxy.onDocumentUpdated(wireEvent);
|
|
822
1041
|
}
|
|
823
1042
|
/**
|
|
824
|
-
* Fingerprint of the
|
|
825
|
-
* `onDocumentUpdated` emissions
|
|
826
|
-
*
|
|
827
|
-
* {@link
|
|
1043
|
+
* Fingerprint of the snapshot `root` and its encoding `encoded`, used to
|
|
1044
|
+
* de-dup `onDocumentUpdated` emissions and sent as every document's
|
|
1045
|
+
* `model.hash`, so it must not depend on the version or on live state. The
|
|
1046
|
+
* {@link FingerprintStrategy} option selects what is hashed (default
|
|
1047
|
+
* `'transfer-document'` — see the type).
|
|
828
1048
|
*
|
|
829
|
-
*
|
|
830
|
-
*
|
|
831
|
-
*
|
|
832
|
-
* `envelope` share a single encode walk.
|
|
1049
|
+
* {@link TransferEncoder.toTransferDocument} is cached per build, so within
|
|
1050
|
+
* one phase event the fingerprint and the subsequently-emitted `envelope`
|
|
1051
|
+
* share a single encode walk.
|
|
833
1052
|
*
|
|
834
1053
|
* Wrapped in {@link Tracer.time} against {@link FINGERPRINT_LOG_AFTER_MS}.
|
|
835
1054
|
*/
|
|
836
|
-
computeDocumentFingerprint(
|
|
837
|
-
return this.tracer
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
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';
|
|
1055
|
+
computeDocumentFingerprint(root, encoded) {
|
|
1056
|
+
return this.tracer
|
|
1057
|
+
.withUri(encoded.uri)
|
|
1058
|
+
.time('Compute fingerprint', () => this.options.fingerprintStrategy === 'text-diagnostics'
|
|
1059
|
+
? textDiagnosticsFingerprint(this.services.workspace.ModelLedger.textOf(root), encoded.model)
|
|
1060
|
+
: transferDocumentFingerprint(encoded.model), 'debug', { logAfterMs: FINGERPRINT_LOG_AFTER_MS });
|
|
878
1061
|
}
|
|
879
1062
|
/**
|
|
880
1063
|
* Subscribe to the project tier's change channel and re-fan registry
|
|
@@ -917,19 +1100,6 @@ export class DataServer {
|
|
|
917
1100
|
this.clientProxy.onProjectsChanged({ project: entry.snapshot, reason: 'removed' });
|
|
918
1101
|
}
|
|
919
1102
|
}
|
|
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
1103
|
// --- Diagnostics (DataServerDiagnosticsProtocol) ---------------------------
|
|
934
1104
|
// Computed in THIS process: the data-server child holds the model store, so
|
|
935
1105
|
// these snapshots reflect the heap that actually carries the workspace
|
|
@@ -967,7 +1137,7 @@ export class DataServer {
|
|
|
967
1137
|
}
|
|
968
1138
|
async stopProfiling(args) {
|
|
969
1139
|
if (!this.activeProfile) {
|
|
970
|
-
throw
|
|
1140
|
+
throw noActiveProfileError();
|
|
971
1141
|
}
|
|
972
1142
|
const capture = this.activeProfile;
|
|
973
1143
|
this.activeProfile = undefined;
|
|
@@ -996,7 +1166,8 @@ export class DataServer {
|
|
|
996
1166
|
methodNamespace: partial.methodNamespace ?? DATA_SERVER_WIRE_PREFIX,
|
|
997
1167
|
additionalMethods,
|
|
998
1168
|
excludedMethods: partial.excludedMethods ?? [],
|
|
999
|
-
diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics()
|
|
1169
|
+
diagnostics: partial.diagnostics ?? defaultDataServerDiagnostics(),
|
|
1170
|
+
referenceSettleTimeoutMs: partial.referenceSettleTimeoutMs ?? DataServer.DEFAULT_OPTIONS.referenceSettleTimeoutMs
|
|
1000
1171
|
};
|
|
1001
1172
|
}
|
|
1002
1173
|
}
|