@hydranium/core 1.0.0-next.204 → 1.0.0-next.206
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/lib/documents/ast-document-manager.js +4 -4
- package/lib/documents/ast-document-manager.js.map +1 -1
- package/lib/documents/client-ids.d.ts +1 -1
- package/lib/documents/client-ids.d.ts.map +1 -1
- package/lib/documents/client-ids.js +1 -1
- package/lib/documents/client-ids.js.map +1 -1
- package/lib/documents/client-session-registry.d.ts +24 -17
- package/lib/documents/client-session-registry.d.ts.map +1 -1
- package/lib/documents/client-session-registry.js +49 -29
- package/lib/documents/client-session-registry.js.map +1 -1
- package/lib/documents/dirty-state-tracker.d.ts +79 -0
- package/lib/documents/dirty-state-tracker.d.ts.map +1 -0
- package/lib/documents/dirty-state-tracker.js +69 -0
- package/lib/documents/dirty-state-tracker.js.map +1 -0
- package/lib/documents/document-release-handler.d.ts +174 -0
- package/lib/documents/document-release-handler.d.ts.map +1 -0
- package/lib/documents/document-release-handler.js +270 -0
- package/lib/documents/document-release-handler.js.map +1 -0
- package/lib/documents/document-release-scheduler.d.ts +67 -0
- package/lib/documents/document-release-scheduler.d.ts.map +1 -0
- package/lib/documents/document-release-scheduler.js +80 -0
- package/lib/documents/document-release-scheduler.js.map +1 -0
- package/lib/documents/hydranium-text-documents.d.ts +130 -455
- package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
- package/lib/documents/hydranium-text-documents.js +362 -835
- package/lib/documents/hydranium-text-documents.js.map +1 -1
- package/lib/documents/index.d.ts +5 -1
- package/lib/documents/index.d.ts.map +1 -1
- package/lib/documents/index.js +5 -1
- package/lib/documents/index.js.map +1 -1
- package/lib/documents/language-client-shadow.d.ts +221 -0
- package/lib/documents/language-client-shadow.d.ts.map +1 -0
- package/lib/documents/language-client-shadow.js +288 -0
- package/lib/documents/language-client-shadow.js.map +1 -0
- package/lib/documents/text-ledger.d.ts +64 -0
- package/lib/documents/text-ledger.d.ts.map +1 -0
- package/lib/documents/text-ledger.js +63 -0
- package/lib/documents/text-ledger.js.map +1 -0
- package/lib/langium/document-builder/document-builder.d.ts +8 -7
- package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
- package/lib/langium/document-builder/document-builder.js +8 -7
- package/lib/langium/document-builder/document-builder.js.map +1 -1
- package/lib/langium/integrity/integrity-service.d.ts +1 -1
- package/lib/langium/integrity/integrity-service.js +4 -4
- package/lib/langium/integrity/integrity-service.js.map +1 -1
- package/lib/langium/model-service/client-session.d.ts +4 -4
- package/lib/langium/model-service/client-session.js +2 -2
- package/lib/langium/model-service/client-session.js.map +1 -1
- package/lib/langium/model-service/model-events.d.ts +8 -11
- package/lib/langium/model-service/model-events.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.d.ts +12 -4
- package/lib/langium/model-service/model-service.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.js +1 -1
- package/lib/langium/model-service/model-service.js.map +1 -1
- package/lib/langium/module.d.ts +7 -0
- package/lib/langium/module.d.ts.map +1 -1
- package/lib/langium/module.js +3 -1
- package/lib/langium/module.js.map +1 -1
- package/lib/langium/workspace/file-not-found.d.ts +7 -1
- package/lib/langium/workspace/file-not-found.d.ts.map +1 -1
- package/lib/langium/workspace/file-not-found.js +14 -3
- package/lib/langium/workspace/file-not-found.js.map +1 -1
- package/lib/lsp/hydranium-document-update-handler.d.ts +6 -6
- package/lib/lsp/hydranium-document-update-handler.js +10 -10
- package/lib/lsp/hydranium-document-update-handler.js.map +1 -1
- package/lib/testing/make-test-services.d.ts +3 -0
- package/lib/testing/make-test-services.d.ts.map +1 -1
- package/lib/testing/make-test-services.js +5 -2
- package/lib/testing/make-test-services.js.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.d.ts +9 -6
- package/lib/testing/stub-hydranium-text-documents.d.ts.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.js +19 -11
- package/lib/testing/stub-hydranium-text-documents.js.map +1 -1
- package/package.json +5 -5
- package/src/documents/ast-document-manager.ts +4 -4
- package/src/documents/client-ids.ts +1 -1
- package/src/documents/client-session-registry.ts +55 -34
- package/src/documents/dirty-state-tracker.ts +130 -0
- package/src/documents/document-release-handler.ts +351 -0
- package/src/documents/document-release-scheduler.ts +121 -0
- package/src/documents/hydranium-text-documents.ts +395 -1034
- package/src/documents/index.ts +5 -1
- package/src/documents/language-client-shadow.ts +463 -0
- package/src/documents/text-ledger.ts +112 -0
- package/src/langium/document-builder/document-builder.ts +8 -7
- package/src/langium/integrity/integrity-service.ts +4 -4
- package/src/langium/model-service/client-session.ts +6 -6
- package/src/langium/model-service/model-events.ts +12 -11
- package/src/langium/model-service/model-service.ts +13 -4
- package/src/langium/module.ts +9 -1
- package/src/langium/workspace/file-not-found.ts +15 -3
- package/src/lsp/hydranium-document-update-handler.ts +10 -10
- package/src/testing/make-test-services.ts +7 -2
- package/src/testing/stub-hydranium-text-documents.ts +34 -21
- package/lib/documents/language-client-text-shadow.d.ts +0 -133
- package/lib/documents/language-client-text-shadow.d.ts.map +0 -1
- package/lib/documents/language-client-text-shadow.js +0 -201
- package/lib/documents/language-client-text-shadow.js.map +0 -1
- package/src/documents/language-client-text-shadow.ts +0 -223
|
@@ -19,15 +19,17 @@
|
|
|
19
19
|
// eslint-disable-next-line @typescript-eslint/no-restricted-imports
|
|
20
20
|
import { NormalizedTextDocuments } from '@hydranium/langium/lsp';
|
|
21
21
|
import { UriUtils } from '@hydranium/langium';
|
|
22
|
-
import { Emitter, OptionalVersionedTextDocumentIdentifier,
|
|
22
|
+
import { Emitter, OptionalVersionedTextDocumentIdentifier, TextDocumentEdit, TextDocumentSyncKind } from 'vscode-languageserver';
|
|
23
23
|
import { TextDocument } from 'vscode-languageserver-textdocument';
|
|
24
|
-
import { asLanguageClientUri, DisposableCollection,
|
|
25
|
-
import { HYDRANIUM_BUILD_REASONS } from '../langium/document-builder/document-builder.js';
|
|
26
|
-
import { isConnectionGoneError } from '../util/connection-liveness.js';
|
|
24
|
+
import { asLanguageClientUri, DisposableCollection, STALE_VERSION, UNRECORDED_VERSION } from '@hydranium/protocol';
|
|
27
25
|
import { LANGUAGE_CLIENT_ID } from './client-ids.js';
|
|
28
26
|
import { INTEGRITY_CLIENT_ID } from '../langium/integrity/integrity-rule.js';
|
|
29
27
|
import { ClientSessionRegistry } from './client-session-registry.js';
|
|
30
|
-
import {
|
|
28
|
+
import { DefaultLanguageClientShadow } from './language-client-shadow.js';
|
|
29
|
+
import { DefaultTextLedger } from './text-ledger.js';
|
|
30
|
+
import { isDocumentReleaseSkippedError } from './document-release-handler.js';
|
|
31
|
+
import { DefaultDocumentReleaseScheduler } from './document-release-scheduler.js';
|
|
32
|
+
import { DefaultDirtyStateTracker } from './dirty-state-tracker.js';
|
|
31
33
|
/**
|
|
32
34
|
* The LSP spec's "version is intentionally unknown" for an
|
|
33
35
|
* {@link OptionalVersionedTextDocumentIdentifier} is `null`, but
|
|
@@ -37,168 +39,122 @@ import { isFullReplace, LanguageClientTextShadow } from './language-client-text-
|
|
|
37
39
|
*/
|
|
38
40
|
const UNKNOWN_CLIENT_VERSION = null;
|
|
39
41
|
/**
|
|
40
|
-
* The default of {@link HydraniumTextDocumentsOptions.
|
|
42
|
+
* The default of {@link HydraniumTextDocumentsOptions.releaseGraceMs}: long
|
|
41
43
|
* enough for a client whose connection dropped to register again and reopen
|
|
42
44
|
* its documents, which a data client does as soon as it has a connection.
|
|
43
45
|
*/
|
|
44
|
-
const
|
|
46
|
+
const DEFAULT_RELEASE_GRACE_MS = 10_000;
|
|
45
47
|
/**
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*/
|
|
51
|
-
const PENDING_ECHO_CAP = 32;
|
|
52
|
-
/**
|
|
53
|
-
* Whether `err` reports that the file of `target` does not exist, as a Node
|
|
54
|
-
* file system and the framework's providers do: code `ENOENT`, with `target`'s
|
|
55
|
-
* path. A missing file of another document is a different failure.
|
|
56
|
-
*/
|
|
57
|
-
function isFileNotFound(err, target) {
|
|
58
|
-
if (typeof err !== 'object' || err === null || !('code' in err) || err.code !== 'ENOENT') {
|
|
59
|
-
return false;
|
|
60
|
-
}
|
|
61
|
-
return !('path' in err) || err.path === target.fsPath;
|
|
62
|
-
}
|
|
63
|
-
/**
|
|
64
|
-
* Multi-client text-document tracking on top of Langium's `NormalizedTextDocuments`.
|
|
48
|
+
* The one text store every head writes to, on top of Langium's
|
|
49
|
+
* `NormalizedTextDocuments`, and the LSP text-sync endpoint: every
|
|
50
|
+
* `textDocument/*` notification and every `workspace/applyEdit` push goes
|
|
51
|
+
* through here.
|
|
65
52
|
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
* - Pending-content staging used by the integrity service to thread corrections
|
|
85
|
-
* through `workspace/applyEdit` cycles for currently-closed documents.
|
|
86
|
-
* - `didOpen` notifications arriving over the LSP connection wait on the
|
|
87
|
-
* workspace-ready promise, so a client's first open cannot race workspace
|
|
88
|
-
* discovery. Direct {@link notifyDidOpenTextDocument} calls (the non-LSP
|
|
89
|
-
* heads) do not pass that gate — their caller owns the ordering.
|
|
53
|
+
* Each open, change, close and save is one synchronous transition over the
|
|
54
|
+
* held document and the collaborators its `create…` methods build. A
|
|
55
|
+
* collaborator that defers its part lets a listener of the transition's event
|
|
56
|
+
* read state from before it. A document no client holds any more is
|
|
57
|
+
* released to the `DocumentReleaseHandler` slot, after
|
|
58
|
+
* {@link HydraniumTextDocumentsOptions.releaseGraceMs} when its last client's
|
|
59
|
+
* connection was lost.
|
|
60
|
+
*
|
|
61
|
+
* Client-declared version ids feed only the per-client staleness guard and
|
|
62
|
+
* never a running shared sequence: the two count different things, and
|
|
63
|
+
* splicing them lets versions drift past base-version gate holders. A URI
|
|
64
|
+
* with no ledger record and no built root starts at its opener's declared id:
|
|
65
|
+
* no version was handed out for it.
|
|
66
|
+
*
|
|
67
|
+
* `didOpen` notifications arriving over the LSP connection wait on the
|
|
68
|
+
* workspace-ready promise, so a client's first open cannot race workspace
|
|
69
|
+
* discovery. Direct {@link notifyDidOpenTextDocument} calls (the non-LSP
|
|
70
|
+
* heads) do not pass that gate — their caller owns the ordering.
|
|
90
71
|
*/
|
|
91
72
|
export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
92
73
|
services;
|
|
74
|
+
options;
|
|
75
|
+
/** Content staged by integrity rules for a document no client holds, consumed by its first open. */
|
|
76
|
+
__pendingContent = new Map();
|
|
93
77
|
/**
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
* {@link __sessions}.
|
|
98
|
-
*/
|
|
99
|
-
__documents = new Map();
|
|
100
|
-
/**
|
|
101
|
-
* Which client has which document open, and which client ids are registered
|
|
102
|
-
* sessions. Every open-state predicate on this class reads it, so an open
|
|
78
|
+
* Which client has which document open, which client ids are registered
|
|
79
|
+
* sessions, and each client's declared version, the staleness guard's
|
|
80
|
+
* baseline. Every open-state predicate on this class reads it, so an open
|
|
103
81
|
* recorded anywhere else is invisible to the last-close transition.
|
|
104
82
|
*/
|
|
105
83
|
__sessions = new ClientSessionRegistry();
|
|
106
|
-
/**
|
|
107
|
-
* Per-URI shared-version continuity across close/reopen cycles
|
|
108
|
-
* ({@link VersionSequence}), kept for every document a build or a client
|
|
109
|
-
* gave the store, and consulted by the next first-client open. A URI
|
|
110
|
-
* with none, and no root that records a version, starts at its opener's
|
|
111
|
-
* declared version.
|
|
112
|
-
* DELIBERATELY outside {@link DocumentTrackingRecord}: that record is deleted on last close, while the version sequence must
|
|
113
|
-
* survive it — the shared version is a server-owned, monotonic,
|
|
114
|
-
* advances-iff-content-changes counter that never resets while the server
|
|
115
|
-
* lives. That invariant is what makes an optimistic base-version gate
|
|
116
|
-
* sound: "version unchanged ⇔ content unchanged", with no false conflicts
|
|
117
|
-
* from close/reopen version resets and no false passes from a reopened
|
|
118
|
-
* sequence coincidentally landing on a stale writer's number.
|
|
119
|
-
*
|
|
120
|
-
* Never pruned, not even when the file is deleted: a recreated file
|
|
121
|
-
* restarting at `0` would let a write based on the deleted text pass. Two
|
|
122
|
-
* small values per URI ever built, however often it changes.
|
|
123
|
-
*/
|
|
124
|
-
__versionSequences = new Map();
|
|
125
|
-
/**
|
|
126
|
-
* Released documents last announced dirty. Their clean flip waits for the
|
|
127
|
-
* revert, so it carries the reverted text's version; a first open before the
|
|
128
|
-
* revert takes the entry over, and its own dirty answer decides the flip.
|
|
129
|
-
* Each release enters a token of its own, so the revert of an earlier
|
|
130
|
-
* release cannot announce a later one clean before that one's revert.
|
|
131
|
-
*/
|
|
132
|
-
__releasedDirty = new Map();
|
|
133
|
-
/** Per held document, the {@link textHash} of its text at the version it was taken. */
|
|
134
|
-
__textHashes = new WeakMap();
|
|
135
|
-
/**
|
|
136
|
-
* Texts pushed to the LSP textual language client via
|
|
137
|
-
* {@link applyEditToLanguageClient} whose echoes have not come back yet
|
|
138
|
-
* ({@link PendingLanguageClientPush}), keyed like the shadow by language-client URI.
|
|
139
|
-
* Outbound pushes and inbound echoes are uncorrelated on the wire; this
|
|
140
|
-
* FIFO is the explicit correlation, and it is what
|
|
141
|
-
* {@link classifyLanguageClientChange} reconstructs against.
|
|
142
|
-
*
|
|
143
|
-
* **Each entry keeps the client's PRE-push text, not only a hash of the
|
|
144
|
-
* post-push one.** A hash alone can classify a full-text echo, whose
|
|
145
|
-
* application is a no-op either way — and that is all it ever classified,
|
|
146
|
-
* because a conforming client echoes INCREMENTAL ranges keyed to its
|
|
147
|
-
* previous buffer. Those ranges cannot be applied to the synced text (which
|
|
148
|
-
* the authored write already advanced) and cannot be reconstructed without
|
|
149
|
-
* the baseline: the line they insert lands twice, validates cleanly, and
|
|
150
|
-
* compounds on every later edit.
|
|
151
|
-
*
|
|
152
|
-
* Lifecycle: entries are consumed by the matching echo (together with any
|
|
153
|
-
* older entries it supersedes), and the whole queue drops when the client
|
|
154
|
-
* stops being a pure mirror — a divergent change, an `applyEdit`
|
|
155
|
-
* failure/rejection (shadow invalidation), a close, or an explicit
|
|
156
|
-
* shadow (re)baseline. {@link PENDING_ECHO_CAP} bounds the queue against
|
|
157
|
-
* a pathological echo that never arrives; the memory cost until then is
|
|
158
|
-
* one pre-push text per in-flight push, for milliseconds.
|
|
159
|
-
*/
|
|
160
|
-
__pendingPushes = new Map();
|
|
161
|
-
/**
|
|
162
|
-
* Tracked text content per URI for the LSP textual language client (Monaco / VS Code).
|
|
163
|
-
* Owned here so {@link applyEditToLanguageClient} can compute minimal `workspace/applyEdit`
|
|
164
|
-
* diffs instead of full-document replaces (5–20 s → <500 ms on 20-30 KB YAML diagrams).
|
|
165
|
-
*
|
|
166
|
-
* Auto-tracked from the multi-client text-document events: open / change / close of
|
|
167
|
-
* the language client (re)baseline or invalidate the shadow. Other client ids
|
|
168
|
-
* (form editor, GLSP, integrity) do NOT touch the shadow — only what Monaco believes
|
|
169
|
-
* it has matters for the diff.
|
|
170
|
-
*
|
|
171
|
-
* Apply-verify safety net is built in: if the diff doesn't reconstruct `newText`
|
|
172
|
-
* exactly, {@link LanguageClientTextShadow.computeEdits} falls back to a full-range
|
|
173
|
-
* replace and invokes the `onFallback` callback — a diff regression becomes log
|
|
174
|
-
* noise, not a 0-byte save.
|
|
175
|
-
*
|
|
176
|
-
* Assigned in the constructor body so the `onFallback` callback can capture
|
|
177
|
-
* `this.logger` after the parameter-property assignment has run (field
|
|
178
|
-
* initializers fire BEFORE parameter-property assignment in TS).
|
|
179
|
-
*/
|
|
180
|
-
__shadow;
|
|
181
84
|
tracer;
|
|
182
85
|
configuration;
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
86
|
+
__textLedger;
|
|
87
|
+
__languageClientShadow;
|
|
88
|
+
__dirtyStateTracker;
|
|
89
|
+
__documentReleaseScheduler;
|
|
90
|
+
documentReleasedEmitter = new Emitter();
|
|
186
91
|
languageClientSavedEmitter = new Emitter();
|
|
187
|
-
dirtyChangedEmitter = new Emitter();
|
|
188
92
|
constructor(services, options = {}) {
|
|
189
93
|
const configuration = options.configuration ?? TextDocument;
|
|
190
94
|
super(configuration);
|
|
191
95
|
this.services = services;
|
|
96
|
+
this.options = options;
|
|
192
97
|
this.configuration = configuration;
|
|
193
98
|
this.tracer = services.Tracer.for(options.logName ?? 'TextDocuments').trace('instantiated');
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
99
|
+
}
|
|
100
|
+
// Each collaborator is built on first use, after every constructor has run,
|
|
101
|
+
// so a create method may read its subclass's fields and the other collaborators.
|
|
102
|
+
get textLedger() {
|
|
103
|
+
return (this.__textLedger ??= this.createTextLedger());
|
|
104
|
+
}
|
|
105
|
+
get languageClientShadow() {
|
|
106
|
+
return (this.__languageClientShadow ??= this.createLanguageClientShadow());
|
|
107
|
+
}
|
|
108
|
+
get dirtyStateTracker() {
|
|
109
|
+
return (this.__dirtyStateTracker ??= this.createDirtyStateTracker());
|
|
110
|
+
}
|
|
111
|
+
get documentReleaseScheduler() {
|
|
112
|
+
return (this.__documentReleaseScheduler ??= this.createDocumentReleaseScheduler());
|
|
113
|
+
}
|
|
114
|
+
createTextLedger() {
|
|
115
|
+
return new DefaultTextLedger();
|
|
116
|
+
}
|
|
117
|
+
createLanguageClientShadow() {
|
|
118
|
+
return new DefaultLanguageClientShadow(this, this.tracer);
|
|
119
|
+
}
|
|
120
|
+
createDirtyStateTracker() {
|
|
121
|
+
return new DefaultDirtyStateTracker(this.textLedger);
|
|
122
|
+
}
|
|
123
|
+
createDocumentReleaseScheduler() {
|
|
124
|
+
return new DefaultDocumentReleaseScheduler(this.services.Clock, this.options.releaseGraceMs ?? DEFAULT_RELEASE_GRACE_MS);
|
|
125
|
+
}
|
|
126
|
+
/** Hold `document` as the text of `key`, a new version authored by `author`. */
|
|
127
|
+
commitText(key, document, author) {
|
|
128
|
+
this.__syncedDocuments.set(key, document);
|
|
129
|
+
this.setAuthor(key, document.version, author);
|
|
130
|
+
this.dirtyStateTracker.refreshDirty(key, document);
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Apply `changes` to `document`, the held text of `key`, and hold the
|
|
134
|
+
* result. The version steps only when the text changes, which is what a
|
|
135
|
+
* base-version gate relies on: unchanged text keeps its version and its
|
|
136
|
+
* author. The new text is known only once the changes are applied, so they
|
|
137
|
+
* go in at a tentative step that an identical result rolls back.
|
|
138
|
+
*/
|
|
139
|
+
commitChange(key, document, changes, author) {
|
|
140
|
+
const previousText = document.getText();
|
|
141
|
+
const version = document.version;
|
|
142
|
+
let next = this.update(document, changes, version + 1);
|
|
143
|
+
const changed = next.getText() !== previousText;
|
|
144
|
+
if (changed) {
|
|
145
|
+
this.commitText(key, next, author);
|
|
146
|
+
}
|
|
147
|
+
else {
|
|
148
|
+
// An empty-changes update only re-stamps the version.
|
|
149
|
+
next = this.update(next, [], version);
|
|
150
|
+
this.__syncedDocuments.set(key, next);
|
|
151
|
+
}
|
|
152
|
+
return { document: next, changed };
|
|
153
|
+
}
|
|
154
|
+
// The configuration's factories. Every document the store makes or changes
|
|
155
|
+
// goes through them, so an override sees each call: the store's own writes,
|
|
156
|
+
// callers outside the didOpen/didChange flow, and the shadow's throwaway
|
|
157
|
+
// probes, at version 0 under a client URI.
|
|
202
158
|
create(uri, languageId, version, content) {
|
|
203
159
|
return this.configuration.create(uri, languageId, version, content);
|
|
204
160
|
}
|
|
@@ -283,19 +239,18 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
283
239
|
const uri = this.documentKey(td.uri);
|
|
284
240
|
let document = this.__syncedDocuments.get(uri);
|
|
285
241
|
if (document !== undefined) {
|
|
286
|
-
//
|
|
287
|
-
//
|
|
288
|
-
//
|
|
289
|
-
//
|
|
290
|
-
//
|
|
291
|
-
//
|
|
292
|
-
//
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
const lastSeen = languageClientDocument?.declaredVersion ?? record.clientVersions.get(clientId) ?? document.version;
|
|
242
|
+
// Client version ids are the client's own, so compared against what
|
|
243
|
+
// that client declared, never against the shared version: an authored
|
|
244
|
+
// write advances that without the client knowing, and gating on it
|
|
245
|
+
// drops real edits. The editor is checked per URI, since each is its
|
|
246
|
+
// own buffer; its client-wide entry is only the fallback for a URI it
|
|
247
|
+
// never opened, and may name another URI's buffer. A client with no
|
|
248
|
+
// baseline falls back to the shared version.
|
|
249
|
+
const clientUri = this.toLanguageClientUri(td.uri);
|
|
250
|
+
const editor = clientId === LANGUAGE_CLIENT_ID;
|
|
251
|
+
const lastSeen = (editor ? this.languageClientShadow.declaredVersion(uri, clientUri) : undefined) ??
|
|
252
|
+
this.__sessions.clientVersionOf(uri, clientId) ??
|
|
253
|
+
document.version;
|
|
299
254
|
if (lastSeen >= td.version) {
|
|
300
255
|
// Distinguish "already at this version" (common: an echo from the client that triggered
|
|
301
256
|
// the update) from "incoming version older than ours" (stale race).
|
|
@@ -303,71 +258,42 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
303
258
|
this.logUri(uri, `Ignore update by ${this.formatClientId(clientId)}: ${reason}`, 'debug');
|
|
304
259
|
return;
|
|
305
260
|
}
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
//
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
// The client is reporting a text we pushed it, so the synced
|
|
320
|
-
// document is ALREADY there and the changes must not be applied a
|
|
321
|
-
// second time. Nothing is minted and no rebuild fires. The
|
|
322
|
-
// per-client baseline advanced above (the client's ids keep
|
|
323
|
-
// counting); the shadow is deliberately NOT touched — it
|
|
324
|
-
// optimistically tracks the NEWEST pushed text, and dragging it
|
|
325
|
-
// back would make the next outbound diff wrong against what the
|
|
326
|
-
// client actually holds.
|
|
261
|
+
this.__sessions.setClientVersion(uri, clientId, td.version);
|
|
262
|
+
// An editor change is keyed to the buffer the editor holds, which is
|
|
263
|
+
// the synced text only while the two agree — an authored write
|
|
264
|
+
// advances the synced text without the editor knowing, and a push in
|
|
265
|
+
// flight moves the editor without the store knowing.
|
|
266
|
+
const verdict = editor
|
|
267
|
+
? this.languageClientShadow.acceptChange(uri, clientUri, td.version, document, changes)
|
|
268
|
+
: { kind: 'direct' };
|
|
269
|
+
if (verdict.kind === 'echo') {
|
|
270
|
+
// The synced document is already there, so the changes must not be
|
|
271
|
+
// applied a second time: nothing is minted and no rebuild fires. The
|
|
272
|
+
// shadow keeps the newest pushed text, which is what the next
|
|
273
|
+
// outbound diff has to be keyed to.
|
|
327
274
|
this.logUri(uri, `Skip rebuild: echo of a server-authored push (client version ${td.version})`, 'debug');
|
|
328
275
|
return;
|
|
329
276
|
}
|
|
330
|
-
if (
|
|
277
|
+
if (verdict.kind === 'unreconstructable') {
|
|
331
278
|
this.tracer.with(uri).warn(`Drop change: no known client buffer for its ranges (client version ${td.version})`);
|
|
332
279
|
return;
|
|
333
280
|
}
|
|
334
|
-
//
|
|
335
|
-
//
|
|
336
|
-
// only known after applying the (possibly incremental) changes, so
|
|
337
|
-
// apply at a tentative +1 and roll the version back on an identical
|
|
338
|
-
// result (an empty-changes update only re-stamps the version).
|
|
339
|
-
//
|
|
340
|
-
// A divergent change is applied as its RECONSTRUCTED text rather than
|
|
341
|
-
// as its own ranges: those ranges address the client's own buffer, so
|
|
281
|
+
// A divergent change is applied as its reconstructed text rather than
|
|
282
|
+
// as its own ranges: those ranges address the editor's own buffer, so
|
|
342
283
|
// applying them here would splice the wrong lines.
|
|
343
|
-
const
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
if (changed) {
|
|
352
|
-
this.setAuthor(uri, document.version, clientId);
|
|
353
|
-
this.refreshDirty(uri);
|
|
354
|
-
}
|
|
355
|
-
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
356
|
-
// Monaco just told us about its new content; record it so the next outbound
|
|
357
|
-
// applyEditToLanguageClient diffs against the right baseline. Keyed by the
|
|
358
|
-
// language-client URI (what Monaco holds), not the canonical document key.
|
|
359
|
-
this.__shadow.set(this.toLanguageClientUri(td.uri), document.getText());
|
|
360
|
-
// Content-identical echo: the language client is echoing text we already had
|
|
361
|
-
// (e.g. Monaco re-emitting a server-pushed applyEditToLanguageClient). The model is
|
|
362
|
-
// unchanged, so skip the rebuild. The per-client baseline + shadow still advanced
|
|
363
|
-
// above so future staleness checks and diffs are correct. Restricted to the
|
|
364
|
-
// language client: a ModelService-authored change is never skipped.
|
|
365
|
-
if (!changed) {
|
|
284
|
+
const committed = this.commitChange(uri, document, verdict.kind === 'direct' ? changes : [{ text: verdict.text }], clientId);
|
|
285
|
+
document = committed.document;
|
|
286
|
+
if (editor) {
|
|
287
|
+
this.languageClientShadow.setClientText(clientUri, document.getText());
|
|
288
|
+
// Content-identical echo: the editor is echoing text we already had.
|
|
289
|
+
// The model is unchanged, so skip the rebuild. Restricted to the
|
|
290
|
+
// editor: a ModelService-authored change is never skipped.
|
|
291
|
+
if (!committed.changed) {
|
|
366
292
|
this.logUri(uri, `Skip rebuild: content unchanged (echo at client version ${td.version})`, 'debug');
|
|
367
293
|
return;
|
|
368
294
|
}
|
|
369
295
|
}
|
|
370
|
-
this.log(document.uri, `Update to version ${document.version} by ${this.formatClientId(clientId)}${changed ? '' : ' (content unchanged)'}`);
|
|
296
|
+
this.log(document.uri, `Update to version ${document.version} by ${this.formatClientId(clientId)}${committed.changed ? '' : ' (content unchanged)'}`);
|
|
371
297
|
this.__onDidChangeContent.fire(Object.freeze({ document, clientId }));
|
|
372
298
|
}
|
|
373
299
|
}
|
|
@@ -390,60 +316,49 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
390
316
|
*/
|
|
391
317
|
applyContentChange(uri, text, clientId) {
|
|
392
318
|
const key = this.documentKey(uri);
|
|
393
|
-
|
|
394
|
-
if (
|
|
319
|
+
const synced = this.__syncedDocuments.get(key);
|
|
320
|
+
if (synced === undefined) {
|
|
395
321
|
throw new Error(`Document ${uri} is not open for content changes`);
|
|
396
322
|
}
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
document = this.configuration.update(document, [{ text }], document.version + 1);
|
|
400
|
-
this.__syncedDocuments.set(key, document);
|
|
401
|
-
this.setAuthor(key, document.version, clientId);
|
|
402
|
-
this.refreshDirty(key);
|
|
403
|
-
}
|
|
323
|
+
// Unchanged text calls no update: a configuration may return a new document for one.
|
|
324
|
+
const { document, changed } = synced.getText() === text ? { document: synced, changed: false } : this.commitChange(key, synced, [{ text }], clientId);
|
|
404
325
|
this.log(document.uri, `Update to version ${document.version} by ${this.formatClientId(clientId)}${changed ? '' : ' (content unchanged)'}`);
|
|
405
326
|
this.__onDidChangeContent.fire(Object.freeze({ document, clientId }));
|
|
406
327
|
return document.version;
|
|
407
328
|
}
|
|
408
329
|
/**
|
|
409
330
|
* Close `clientId`'s open of the document. When it was the last open, the
|
|
410
|
-
* document is released
|
|
411
|
-
* close, after {@link HydraniumTextDocumentsOptions.
|
|
331
|
+
* document is released, at once or, for a `'lost'`
|
|
332
|
+
* close, after {@link HydraniumTextDocumentsOptions.releaseGraceMs}.
|
|
412
333
|
*/
|
|
413
334
|
notifyDidCloseTextDocument(event, clientId = LANGUAGE_CLIENT_ID, cause = 'closed') {
|
|
414
335
|
const uri = this.documentKey(event.textDocument.uri);
|
|
415
336
|
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
416
|
-
const
|
|
417
|
-
|
|
418
|
-
if (
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
337
|
+
const clientUri = this.toLanguageClientUri(event.textDocument.uri);
|
|
338
|
+
// A close under a URI the editor never opened the document under ends its hold.
|
|
339
|
+
if (this.languageClientShadow.isOpen(uri, clientUri)) {
|
|
340
|
+
this.languageClientShadow.removeOpen(uri, clientUri);
|
|
341
|
+
}
|
|
342
|
+
else {
|
|
343
|
+
this.languageClientShadow.removeAllOpens(uri);
|
|
344
|
+
}
|
|
345
|
+
// Another URI still holds the document, so only this one's buffer goes.
|
|
346
|
+
if (this.languageClientShadow.isOpen(uri)) {
|
|
422
347
|
return;
|
|
423
348
|
}
|
|
424
349
|
}
|
|
425
350
|
if (!this.__sessions.removeOpen(uri, clientId)) {
|
|
426
351
|
return;
|
|
427
352
|
}
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
if (record && cause === 'lost') {
|
|
431
|
-
(record.lostClients ??= new Map()).set(clientId, this.services.Clock.stopwatch());
|
|
353
|
+
if (cause === 'lost') {
|
|
354
|
+
this.documentReleaseScheduler.recordLoss(uri, clientId);
|
|
432
355
|
}
|
|
433
356
|
const syncedDocument = this.__syncedDocuments.get(uri);
|
|
434
357
|
if (syncedDocument !== undefined) {
|
|
435
358
|
this.log(syncedDocument.uri, `Closed synced document: ${syncedDocument.version} by ${this.formatClientId(clientId)}`);
|
|
436
359
|
this.__onDidClose.fire(Object.freeze({ document: syncedDocument, clientId }));
|
|
437
|
-
if (
|
|
438
|
-
|
|
439
|
-
// it held. (If this was the last client the whole record is deleted on
|
|
440
|
-
// release.)
|
|
441
|
-
const droppedUri = this.toLanguageClientUri(event.textDocument.uri);
|
|
442
|
-
this.__shadow.invalidate(droppedUri);
|
|
443
|
-
this.__pendingPushes.delete(droppedUri);
|
|
444
|
-
}
|
|
445
|
-
if (!this.__sessions.isOpen(uri)) {
|
|
446
|
-
if (cause === 'lost' && this.revertGraceMs > 0) {
|
|
360
|
+
if (!this.isOpenInAnyClient(uri)) {
|
|
361
|
+
if (cause === 'lost') {
|
|
447
362
|
this.deferRelease(uri);
|
|
448
363
|
}
|
|
449
364
|
else {
|
|
@@ -453,55 +368,34 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
453
368
|
}
|
|
454
369
|
}
|
|
455
370
|
/**
|
|
456
|
-
* Keep the document, text and all, for the
|
|
371
|
+
* Keep the document, text and all, for the release grace, then release it.
|
|
457
372
|
* The document stays in the store meanwhile, so a lost client that opens it
|
|
458
373
|
* again within its own grace attaches to it and finds its unsaved text
|
|
459
|
-
* rather than reading disk; see {@link
|
|
374
|
+
* rather than reading disk; see {@link resolveDeferredRelease} for any other
|
|
460
375
|
* open.
|
|
461
376
|
*/
|
|
462
377
|
deferRelease(uri) {
|
|
463
|
-
this.
|
|
464
|
-
|
|
465
|
-
this.__sessions.cancelRevert(uri);
|
|
466
|
-
if (!this.__sessions.isOpen(uri)) {
|
|
378
|
+
this.documentReleaseScheduler.defer(uri, () => {
|
|
379
|
+
if (!this.isOpenInAnyClient(uri)) {
|
|
467
380
|
this.releaseDocument(uri);
|
|
468
381
|
}
|
|
469
|
-
}
|
|
470
|
-
this.
|
|
471
|
-
|
|
472
|
-
/**
|
|
473
|
-
* Resolve the pending revert of `uri` for an open by `clientId`. An open by a
|
|
474
|
-
* client lost from the document within its grace cancels the revert, and
|
|
475
|
-
* the client finds its unsaved text. Any other open releases the document
|
|
476
|
-
* first, so it opens as a first open does: cancelling for every open hands
|
|
477
|
-
* a lost client's unsaved text to whoever opens next, a reloaded page or an
|
|
478
|
-
* editor, with nothing marking it unsaved.
|
|
479
|
-
*/
|
|
480
|
-
resolvePendingRevert(uri, clientId) {
|
|
481
|
-
const record = this.__documents.get(uri);
|
|
482
|
-
if (record) {
|
|
483
|
-
this.pruneLostClients(record);
|
|
484
|
-
}
|
|
485
|
-
const returning = record?.lostClients?.delete(clientId) ?? false;
|
|
486
|
-
if (!this.__sessions.isRevertPending(uri)) {
|
|
487
|
-
return;
|
|
488
|
-
}
|
|
489
|
-
this.__sessions.cancelRevert(uri);
|
|
490
|
-
if (!returning) {
|
|
491
|
-
this.releaseDocument(uri);
|
|
382
|
+
});
|
|
383
|
+
if (this.documentReleaseScheduler.isDeferred(uri)) {
|
|
384
|
+
this.log(uri, `No client left; release deferred for ${this.documentReleaseScheduler.graceMs} ms (connection lost)`);
|
|
492
385
|
}
|
|
493
386
|
}
|
|
494
|
-
/**
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
record.lostClients?.delete(clientId);
|
|
499
|
-
}
|
|
387
|
+
/** Resolve a deferred release of `uri` for an open by `clientId`: a release the scheduler decides on runs now. */
|
|
388
|
+
resolveDeferredRelease(uri, clientId) {
|
|
389
|
+
if (this.documentReleaseScheduler.resolveOpen(uri, clientId) === 'release') {
|
|
390
|
+
this.releaseDocument(uri);
|
|
500
391
|
}
|
|
501
392
|
}
|
|
502
393
|
/**
|
|
503
|
-
* Drop the document no client has open any more,
|
|
504
|
-
* {@link
|
|
394
|
+
* Drop the document no client has open any more, announce it on
|
|
395
|
+
* {@link onDidReleaseDocument}, then hand it to the
|
|
396
|
+
* `DocumentReleaseHandler` slot: its listeners, such as the update
|
|
397
|
+
* handler dropping a change it still holds back, act before any build the
|
|
398
|
+
* handler runs.
|
|
505
399
|
*/
|
|
506
400
|
releaseDocument(uri) {
|
|
507
401
|
const syncedDocument = this.__syncedDocuments.get(uri);
|
|
@@ -509,175 +403,71 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
509
403
|
return;
|
|
510
404
|
}
|
|
511
405
|
this.log(syncedDocument.uri, `Remove synced document: ${syncedDocument.version} (no client left)`);
|
|
512
|
-
//
|
|
513
|
-
//
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
this.
|
|
517
|
-
version: syncedDocument.version,
|
|
518
|
-
contentHash: this.heldTextHash(syncedDocument)
|
|
519
|
-
});
|
|
520
|
-
if (this.__documents.get(uri)?.dirty === true) {
|
|
521
|
-
this.__releasedDirty.set(uri, {});
|
|
522
|
-
}
|
|
406
|
+
// The next open continues the sequence instead of restarting at the
|
|
407
|
+
// reopening client's declared id.
|
|
408
|
+
this.textLedger.record(uri, syncedDocument);
|
|
409
|
+
this.textLedger.clearAuthors(uri);
|
|
410
|
+
const cleanAnnouncement = this.dirtyStateTracker.release(uri);
|
|
523
411
|
this.__syncedDocuments.delete(uri);
|
|
524
|
-
|
|
525
|
-
//
|
|
526
|
-
this.
|
|
527
|
-
this.
|
|
412
|
+
this.__sessions.forgetClientVersions(uri);
|
|
413
|
+
// A stage is for a first open; one released unconsumed is stale.
|
|
414
|
+
this.__pendingContent.delete(uri);
|
|
415
|
+
this.documentReleaseScheduler.clearLosses(uri);
|
|
416
|
+
this.documentReleasedEmitter.fire(Object.freeze({ uri }));
|
|
417
|
+
this.handOverRelease(this.toReleasedDocument(uri), cleanAnnouncement);
|
|
528
418
|
}
|
|
529
419
|
/**
|
|
530
|
-
*
|
|
531
|
-
*
|
|
532
|
-
*
|
|
533
|
-
*
|
|
534
|
-
*
|
|
535
|
-
* buffer, a file never saved, or one deleted meanwhile — is removed
|
|
536
|
-
* from the workspace. A `virtual:` document survives, since the framework's
|
|
537
|
-
* provider for that scheme serves it from the index, whatever provider the
|
|
538
|
-
* host passes as `context.fileSystemProvider`; an edited one therefore keeps
|
|
539
|
-
* its last client's text, and keeping it read-only is the client's job.
|
|
540
|
-
*
|
|
541
|
-
* The answer is read in the document's disk queue, so the rebuild follows
|
|
542
|
-
* any save still queued rather than reverting past it; a file that goes
|
|
543
|
-
* after that read is removed when its rebuild finds none.
|
|
544
|
-
*
|
|
545
|
-
* Whether to revert at all is decided inside the write lock, as its holder:
|
|
546
|
-
* decided before waiting for the lock, a client that opens or re-creates the
|
|
547
|
-
* document meanwhile would have its text rebuilt over, or the document
|
|
548
|
-
* removed. A document some client has open again, or that waits out a new
|
|
549
|
-
* grace, is left to that client.
|
|
550
|
-
*
|
|
551
|
-
* A document released dirty is announced clean, so a watcher is never left
|
|
552
|
-
* holding it dirty: once the revert has parsed the file, even if it is then
|
|
553
|
-
* cancelled, or else once the build it requests in its place has parsed it,
|
|
554
|
-
* as the announcement names the store's text. One the revert or that build
|
|
555
|
-
* removed, or that build failed, is announced without text. A reopen before
|
|
556
|
-
* that takes the announcement over.
|
|
420
|
+
* Call the `DocumentReleaseHandler` slot, and announce a document released
|
|
421
|
+
* dirty clean once the promise it returns settles, which is after the
|
|
422
|
+
* release event. A failure is logged rather than thrown: the store has let
|
|
423
|
+
* go of the document by now, and a throw would abort the transition that
|
|
424
|
+
* released it, a session's close of its other documents included.
|
|
557
425
|
*/
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
const target = UriUtils.toUri(uri);
|
|
561
|
-
const reopened = () => this.isOpenInAnyClient(uri) || this.__syncedDocuments.has(uri);
|
|
562
|
-
const releasedDirty = this.__releasedDirty.get(uri);
|
|
563
|
-
const owesFlip = () => releasedDirty !== undefined && this.__releasedDirty.get(uri) === releasedDirty;
|
|
564
|
-
const announceClean = (withText = true) => {
|
|
565
|
-
if (owesFlip()) {
|
|
566
|
-
this.__releasedDirty.delete(uri);
|
|
567
|
-
// The sequence of a removed document still names the discarded text.
|
|
568
|
-
const text = !withText || workspace.LangiumDocuments.getDocument(target) === undefined ? undefined : this.textState(uri);
|
|
569
|
-
this.dirtyChangedEmitter.fire(Object.freeze(text ? { uri, text } : { uri }));
|
|
570
|
-
}
|
|
571
|
-
};
|
|
572
|
-
let parsedFromFile = false;
|
|
573
|
-
let parses;
|
|
574
|
-
let onDisk;
|
|
575
|
-
let cancelled = false;
|
|
576
|
-
let stopWaiting;
|
|
577
|
-
// Without it, a revert stopped short leaves the root on the released text.
|
|
578
|
-
const buildInstead = () => {
|
|
579
|
-
void workspace.VersionSyncService.requestRecoveryBuild(target, {
|
|
580
|
-
deleted: onDisk === false,
|
|
581
|
-
reason: HYDRANIUM_BUILD_REASONS.didClose,
|
|
582
|
-
// The update handler dropped the change it held back at the release.
|
|
583
|
-
ignoreDeferred: true,
|
|
584
|
-
stillNeeded: () => !reopened()
|
|
585
|
-
}).then(built => {
|
|
586
|
-
if (!built) {
|
|
587
|
-
this.tracer.with(uri).error('Build after a revert that stopped short failed; the store keeps the released text');
|
|
588
|
-
// No parse or removal is coming.
|
|
589
|
-
stopWaiting?.();
|
|
590
|
-
announceClean(false);
|
|
591
|
-
}
|
|
592
|
-
});
|
|
593
|
-
};
|
|
426
|
+
handOverRelease(released, cleanAnnouncement) {
|
|
427
|
+
let settled;
|
|
594
428
|
try {
|
|
595
|
-
// Read
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
return;
|
|
602
|
-
}
|
|
603
|
-
await workspace.WorkspaceLock.write(async (token) => {
|
|
604
|
-
if (reopened()) {
|
|
605
|
-
return;
|
|
606
|
-
}
|
|
607
|
-
// Observed rather than awaited: a build cancelled after its parse
|
|
608
|
-
// returns early, and the build it yields to does not parse again.
|
|
609
|
-
parses = workspace.VersionSyncService.onDidRecordModel(document => {
|
|
610
|
-
parsedFromFile ||= this.documentKey(document.uri.toString()) === uri;
|
|
611
|
-
});
|
|
612
|
-
workspace.DocumentBuilder.markNextReason(HYDRANIUM_BUILD_REASONS.didClose);
|
|
613
|
-
// Cleared once the build ends: a cancelled one throws, and the lock resolves.
|
|
614
|
-
cancelled = true;
|
|
615
|
-
try {
|
|
616
|
-
await (onDisk
|
|
617
|
-
? workspace.DocumentBuilder.update([target], [], token)
|
|
618
|
-
: workspace.DocumentBuilder.update([], [target], token));
|
|
619
|
-
}
|
|
620
|
-
catch (err) {
|
|
621
|
-
if (!onDisk || !isFileNotFound(err, target)) {
|
|
622
|
-
throw err;
|
|
623
|
-
}
|
|
624
|
-
// The file went after its existence was read.
|
|
625
|
-
this.tracer.with(uri).debug('Revert found no file; removing the document instead');
|
|
626
|
-
workspace.DocumentBuilder.markNextReason(HYDRANIUM_BUILD_REASONS.didClose);
|
|
627
|
-
await workspace.DocumentBuilder.update([], [target], token);
|
|
628
|
-
}
|
|
629
|
-
cancelled = false;
|
|
630
|
-
});
|
|
631
|
-
// Cancelled before its parse: the write that cancelled it may build nothing.
|
|
632
|
-
if (cancelled && !parsedFromFile && !reopened() && workspace.LangiumDocuments.getDocument(target) !== undefined) {
|
|
633
|
-
buildInstead();
|
|
634
|
-
}
|
|
429
|
+
// Read here: a lazily built slot whose factory throws throws on this read.
|
|
430
|
+
const handler = this.services.workspace.DocumentReleaseHandler;
|
|
431
|
+
settled =
|
|
432
|
+
handler === undefined
|
|
433
|
+
? Promise.reject(new Error('no workspace.DocumentReleaseHandler bound'))
|
|
434
|
+
: Promise.resolve(handler.didReleaseDocument(released));
|
|
635
435
|
}
|
|
636
436
|
catch (err) {
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
437
|
+
settled = Promise.reject(err);
|
|
438
|
+
}
|
|
439
|
+
// Names the text the build holds at the settle, so it follows anything a
|
|
440
|
+
// release listener did meanwhile: none when its build failed or it no
|
|
441
|
+
// longer has the document, since a removal leaves the record on the
|
|
442
|
+
// discarded text.
|
|
443
|
+
const announceClean = (built) => {
|
|
444
|
+
if (cleanAnnouncement?.isOwed()) {
|
|
445
|
+
const inBuild = built && this.services.workspace.LangiumDocuments.getDocument(UriUtils.toUri(released.uri)) !== undefined;
|
|
446
|
+
cleanAnnouncement.announce(inBuild ? this.textState(released.uri) : undefined);
|
|
643
447
|
}
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
//
|
|
647
|
-
//
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
buildInstead();
|
|
448
|
+
};
|
|
449
|
+
settled.then(() => announceClean(true), (err) => {
|
|
450
|
+
// A release skipped at teardown, its peer or its workspace gone, is
|
|
451
|
+
// routine, not a fault to investigate.
|
|
452
|
+
if (isDocumentReleaseSkippedError(err)) {
|
|
453
|
+
this.tracer.with(released.uri).debug(err.message);
|
|
651
454
|
}
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
announceClean();
|
|
455
|
+
else {
|
|
456
|
+
this.tracer
|
|
457
|
+
.with(released.uri)
|
|
458
|
+
.error(`Release handler failed. ${err instanceof Error ? (err.stack ?? err.message) : String(err)}`);
|
|
657
459
|
}
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
const parsed = workspace.VersionSyncService.onDidRecordModel(document => {
|
|
670
|
-
if (this.documentKey(document.uri.toString()) === uri) {
|
|
671
|
-
done();
|
|
672
|
-
}
|
|
673
|
-
});
|
|
674
|
-
const deleted = workspace.DocumentBuilder.onUpdate((_changed, deletedUris) => {
|
|
675
|
-
if (deletedUris.some(deletedUri => this.documentKey(deletedUri.toString()) === uri)) {
|
|
676
|
-
done();
|
|
677
|
-
}
|
|
678
|
-
});
|
|
679
|
-
}
|
|
680
|
-
}
|
|
460
|
+
// Left unsettled, a watcher keeps the document dirty though the store answers clean.
|
|
461
|
+
announceClean(false);
|
|
462
|
+
});
|
|
463
|
+
}
|
|
464
|
+
/** `uri` as the `DocumentReleaseHandler` slot receives it. */
|
|
465
|
+
toReleasedDocument(uri) {
|
|
466
|
+
return {
|
|
467
|
+
uri,
|
|
468
|
+
isFor: other => this.documentKey(other) === uri,
|
|
469
|
+
isReclaimed: () => this.isOpenInAnyClient(uri) || this.__syncedDocuments.has(uri)
|
|
470
|
+
};
|
|
681
471
|
}
|
|
682
472
|
notifyWillSaveTextDocument(event) {
|
|
683
473
|
const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
|
|
@@ -728,7 +518,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
728
518
|
}
|
|
729
519
|
// What the file holds, not what the editor meant to write: an editor
|
|
730
520
|
// that saved older text leaves the document dirty.
|
|
731
|
-
this.
|
|
521
|
+
this.setDiskBaseline(uri, onDisk);
|
|
732
522
|
// An editor that saves and then closes releases the document while the
|
|
733
523
|
// read is under way; its save is still a save of the text it held.
|
|
734
524
|
const document = this.__syncedDocuments.get(this.documentKey(uri)) ?? syncedDocument;
|
|
@@ -748,7 +538,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
748
538
|
const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
|
|
749
539
|
if (syncedDocument !== undefined) {
|
|
750
540
|
if (event.text !== undefined) {
|
|
751
|
-
this.
|
|
541
|
+
this.setDiskBaseline(syncedDocument.uri, event.text);
|
|
752
542
|
}
|
|
753
543
|
this.announceSave(syncedDocument, clientId);
|
|
754
544
|
}
|
|
@@ -761,86 +551,45 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
761
551
|
notifyDidOpenTextDocument(event, clientId = LANGUAGE_CLIENT_ID) {
|
|
762
552
|
const td = event.textDocument;
|
|
763
553
|
const uri = this.documentKey(td.uri);
|
|
764
|
-
|
|
554
|
+
// Before the deferred release is resolved: refused after it, the open
|
|
555
|
+
// would leave a document whose grace it ended with no holder and no timer.
|
|
556
|
+
// A repeat open stays a no-op.
|
|
557
|
+
if (!this.__sessions.isOpenIn(uri, clientId)) {
|
|
558
|
+
this.__sessions.assertCanOpen(clientId);
|
|
559
|
+
}
|
|
560
|
+
this.resolveDeferredRelease(uri, clientId);
|
|
561
|
+
let document = this.__syncedDocuments.get(uri);
|
|
562
|
+
// The client's declared text, never the synced document: staged
|
|
563
|
+
// content this open consumes leaves the two different, and a baseline
|
|
564
|
+
// asserting the client already holds it suppresses the one sync that
|
|
565
|
+
// would deliver it. On an attach, another client may already have
|
|
566
|
+
// changed the synced text, so the baseline is equality-only; a refresh
|
|
567
|
+
// pushing the full text would dirty the file on open.
|
|
568
|
+
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
569
|
+
this.languageClientShadow.addOpen(uri, this.toLanguageClientUri(td.uri), td.version, td.text, document === undefined);
|
|
570
|
+
}
|
|
765
571
|
if (this.isOpenInClient(uri, clientId)) {
|
|
766
|
-
//
|
|
767
|
-
//
|
|
768
|
-
//
|
|
769
|
-
// edits reach this tab too — but do NOT re-fire open/rebuild; the document
|
|
770
|
-
// is already live.
|
|
771
|
-
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
772
|
-
const clientFacing = this.toLanguageClientUri(td.uri);
|
|
773
|
-
const record = this.__documents.get(uri);
|
|
774
|
-
if (record && !record.languageClientDocuments?.has(clientFacing)) {
|
|
775
|
-
(record.languageClientDocuments ??= new Map()).set(clientFacing, { declaredVersion: td.version });
|
|
776
|
-
// This tab's own buffer, NOT the synced text: a second tab is a second
|
|
777
|
-
// client model, read from disk, so a server-authored write already
|
|
778
|
-
// applied to the first tab leaves it BEHIND the synced document. Keying
|
|
779
|
-
// a diff to the synced text here addresses lines this tab does not have
|
|
780
|
-
// and drops content it does.
|
|
781
|
-
this.__shadow.setOpenedText(clientFacing, td.text);
|
|
782
|
-
}
|
|
783
|
-
}
|
|
572
|
+
// A repeat open, or the editor's second URI for the file, e.g. a
|
|
573
|
+
// symlink and its real path: the shadow records it so pushes reach it,
|
|
574
|
+
// and nothing re-fires.
|
|
784
575
|
return;
|
|
785
576
|
}
|
|
786
|
-
let document = this.__syncedDocuments.get(uri);
|
|
787
577
|
const existingClients = this.__sessions.clientsOf(uri);
|
|
788
578
|
this.__sessions.addOpen(uri, clientId);
|
|
789
|
-
|
|
790
|
-
// Baseline the per-client staleness guard at the version id the client
|
|
791
|
-
// declared for its own buffer (client-owned per LSP).
|
|
792
|
-
record.clientVersions.set(clientId, td.version);
|
|
793
|
-
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
794
|
-
// Remember the URI Monaco opened under (may differ from the canonical key)
|
|
795
|
-
// so outbound applyEditToLanguageClient can address the URI it actually holds.
|
|
796
|
-
// A fresh state, since a reopened buffer numbers its versions afresh.
|
|
797
|
-
(record.languageClientDocuments ??= new Map()).set(this.toLanguageClientUri(td.uri), { declaredVersion: td.version });
|
|
798
|
-
}
|
|
579
|
+
this.__sessions.setClientVersion(uri, clientId, td.version);
|
|
799
580
|
if (!document) {
|
|
800
581
|
// Use integrity-staged content if available, otherwise the client-provided (disk) text.
|
|
801
582
|
const pendingText = this.consumePendingContent(uri);
|
|
802
583
|
const text = pendingText ?? td.text;
|
|
803
584
|
const source = pendingText ? ', source=pending' : '';
|
|
804
|
-
|
|
805
|
-
// sequence — same version when the content is unchanged since the
|
|
806
|
-
// last close (so watchers' base versions stay valid), one
|
|
807
|
-
// step when it changed (so no stale pointer can coincidentally pass
|
|
808
|
-
// the optimistic gate). An open with no sequence yet seeds it from the built root.
|
|
809
|
-
const sequence = this.__versionSequences.get(uri);
|
|
810
|
-
const version = sequence === undefined
|
|
811
|
-
? this.firstOpenVersion(uri, text, td.version)
|
|
812
|
-
: sequence.contentHash === textHash(text)
|
|
813
|
-
? sequence.version
|
|
814
|
-
: sequence.version + 1;
|
|
585
|
+
const version = this.textLedger.openingVersion(uri, text) ?? this.builtRootOpeningVersion(uri, text) ?? td.version;
|
|
815
586
|
this.log(uri, `Open document: Version ${version} by ${this.formatClientId(clientId)} [first client${source}]`);
|
|
816
|
-
document = this.
|
|
817
|
-
this.
|
|
818
|
-
this.setAuthor(uri, version, clientId);
|
|
587
|
+
document = this.create(uri, td.languageId, version, text);
|
|
588
|
+
this.commitText(uri, document, clientId);
|
|
819
589
|
// The opener's text, not the staged content: a session's open read
|
|
820
590
|
// it from the file, and an editor opened its buffer from there. An
|
|
821
591
|
// editor that opens a buffer it never saved is taken as clean.
|
|
822
|
-
|
|
823
|
-
if (this.__releasedDirty.delete(uri)) {
|
|
824
|
-
record.dirty = true;
|
|
825
|
-
}
|
|
826
|
-
this.refreshDirty(uri);
|
|
827
|
-
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
828
|
-
// Baseline the shadow to what Monaco just opened so the next outbound
|
|
829
|
-
// applyEditToLanguageClient diffs against the right starting point. Keyed by the
|
|
830
|
-
// language-client URI (what Monaco holds), not the canonical document key.
|
|
831
|
-
//
|
|
832
|
-
// The CLIENT's declared text, never the synced document: staged content
|
|
833
|
-
// consumed above leaves the two different, and a baseline asserting the
|
|
834
|
-
// client already holds the staged text suppresses the one sync that would
|
|
835
|
-
// deliver it. Skipped entirely when a push is already outstanding for this
|
|
836
|
-
// URI — an `applyEdit` to a closed file has the client open from disk and
|
|
837
|
-
// apply afterwards, so that shadow records what it is about to hold and
|
|
838
|
-
// disk text would key the next diff to a buffer nobody has.
|
|
839
|
-
const clientFacing = this.toLanguageClientUri(td.uri);
|
|
840
|
-
if (!this.__shadow.isTracked(clientFacing)) {
|
|
841
|
-
this.__shadow.set(clientFacing, td.text);
|
|
842
|
-
}
|
|
843
|
-
}
|
|
592
|
+
this.dirtyStateTracker.track(uri, document, td.text);
|
|
844
593
|
const toFire = Object.freeze({ document, clientId });
|
|
845
594
|
this.__onDidOpen.fire(toFire);
|
|
846
595
|
this.__onDidChangeContent.fire(toFire);
|
|
@@ -848,14 +597,6 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
848
597
|
else {
|
|
849
598
|
// An additional client attaches to a document already open by another client.
|
|
850
599
|
this.logClientJoined(uri, clientId, document.version, existingClients);
|
|
851
|
-
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
852
|
-
// Monaco's own buffer, which on this path is NOT the synced text — another
|
|
853
|
-
// client opened the document and may already have changed it. Recorded as
|
|
854
|
-
// an equality-only baseline (never a diff one, see `setOpenedText`) so the
|
|
855
|
-
// refresh below does not push a full replace of content Monaco already
|
|
856
|
-
// holds, which would dirty the file on open.
|
|
857
|
-
this.__shadow.setOpenedText(this.toLanguageClientUri(td.uri), td.text);
|
|
858
|
-
}
|
|
859
600
|
this.refreshContent(uri, clientId);
|
|
860
601
|
}
|
|
861
602
|
}
|
|
@@ -869,52 +610,31 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
869
610
|
* and refreshing per attach turns each into a Langium rebuild and dependent
|
|
870
611
|
* relink cascade.
|
|
871
612
|
*
|
|
872
|
-
* The staleness guard baselines at the SYNCED version, not a declared buffer
|
|
873
|
-
* version, because a client arriving this way holds no buffer of its own.
|
|
874
|
-
* Unifying the two routes therefore rebaselines a textual client's guard to a
|
|
875
|
-
* version it never declared.
|
|
876
|
-
*
|
|
877
613
|
* Returns whether a hold was added — `false` when `uri` is not open,
|
|
878
|
-
* `clientId` already holds it, or the document was waiting out the
|
|
614
|
+
* `clientId` already holds it, or the document was waiting out the release
|
|
879
615
|
* grace for other clients and was released instead (see
|
|
880
|
-
* {@link
|
|
616
|
+
* {@link resolveDeferredRelease}); the caller then opens it anew.
|
|
881
617
|
*/
|
|
882
618
|
attachClient(uri, clientId) {
|
|
883
619
|
const key = this.documentKey(uri);
|
|
884
620
|
if (!this.__syncedDocuments.has(key) || this.isOpenInClient(key, clientId)) {
|
|
885
621
|
return false;
|
|
886
622
|
}
|
|
887
|
-
|
|
623
|
+
// Before the deferred release is resolved, as for an open.
|
|
624
|
+
this.__sessions.assertCanOpen(clientId);
|
|
625
|
+
this.resolveDeferredRelease(key, clientId);
|
|
888
626
|
const document = this.__syncedDocuments.get(key);
|
|
889
627
|
if (!document) {
|
|
890
628
|
return false;
|
|
891
629
|
}
|
|
892
630
|
const existingClients = this.__sessions.clientsOf(key);
|
|
893
631
|
this.__sessions.addOpen(key, clientId);
|
|
894
|
-
|
|
895
|
-
|
|
632
|
+
// A client arriving this way holds no buffer of its own, so its guard
|
|
633
|
+
// starts at the synced version.
|
|
634
|
+
this.__sessions.setClientVersion(key, clientId, document.version);
|
|
896
635
|
this.logClientJoined(key, clientId, document.version, existingClients);
|
|
897
636
|
return true;
|
|
898
637
|
}
|
|
899
|
-
/**
|
|
900
|
-
* The built root's recorded version, one on when `text` differs from the root's;
|
|
901
|
-
* `declared` when the root records no store version. Seeded from `declared`, a write based
|
|
902
|
-
* on the root passes the gate over other text, and the same text looks newer than its model.
|
|
903
|
-
* A built root has no sequence only under a `LangiumDocuments` that does not reconcile at registration.
|
|
904
|
-
*/
|
|
905
|
-
firstOpenVersion(uri, text, declared) {
|
|
906
|
-
const built = this.services.workspace.LangiumDocuments.getDocument(UriUtils.toUri(uri));
|
|
907
|
-
if (built === undefined) {
|
|
908
|
-
return declared;
|
|
909
|
-
}
|
|
910
|
-
const ledger = this.services.workspace.ModelLedger;
|
|
911
|
-
const root = built.parseResult.value;
|
|
912
|
-
const recorded = ledger.versionOf(root);
|
|
913
|
-
if (recorded === UNRECORDED_VERSION || recorded === STALE_VERSION) {
|
|
914
|
-
return declared;
|
|
915
|
-
}
|
|
916
|
-
return (ledger.textOf(root) ?? built.textDocument.getText()) === text ? recorded : recorded + 1;
|
|
917
|
-
}
|
|
918
638
|
logClientJoined(uri, clientId, version, existingClients) {
|
|
919
639
|
this.log(uri, `Attach client: ${this.formatClientId(clientId)} joined existing document (version ${version}, ` +
|
|
920
640
|
`now open in: ${[...existingClients, clientId].map(id => this.formatClientId(id)).join(', ')})`);
|
|
@@ -935,7 +655,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
935
655
|
* two URIs for one physical file (a symlink path and its real path) into a
|
|
936
656
|
* single registration — dedup at the editor layer, not just in
|
|
937
657
|
* `LangiumDocuments`. The URI the client opened under is preserved separately
|
|
938
|
-
* for egress addressing
|
|
658
|
+
* for egress addressing, by the {@link LanguageClientShadow}. The
|
|
939
659
|
* policy is always bound (the framework defaults it to
|
|
940
660
|
* `DefaultDocumentUriPolicy`, where canonical ≡ syntactic normalize).
|
|
941
661
|
*/
|
|
@@ -953,17 +673,8 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
953
673
|
toLanguageClientUri(uri) {
|
|
954
674
|
return asLanguageClientUri(UriUtils.normalize(uri));
|
|
955
675
|
}
|
|
956
|
-
/** Get-or-create the per-URI tracking record. `uri` must already be a {@link documentKey}. */
|
|
957
|
-
trackingFor(uri) {
|
|
958
|
-
let record = this.__documents.get(uri);
|
|
959
|
-
if (!record) {
|
|
960
|
-
record = { versionAuthors: [], clientVersions: new Map() };
|
|
961
|
-
this.__documents.set(uri, record);
|
|
962
|
-
}
|
|
963
|
-
return record;
|
|
964
|
-
}
|
|
965
676
|
setAuthor(uri, version, author) {
|
|
966
|
-
this.
|
|
677
|
+
this.textLedger.setAuthor(this.documentKey(uri), version, author);
|
|
967
678
|
}
|
|
968
679
|
/**
|
|
969
680
|
* Resolve the synced `TextDocument` for `uri`. The store keys documents by
|
|
@@ -994,7 +705,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
994
705
|
* content unchanged.
|
|
995
706
|
*/
|
|
996
707
|
version(uri) {
|
|
997
|
-
return this.get(uri)?.version ?? this.
|
|
708
|
+
return this.get(uri)?.version ?? this.textLedger.recordOf(this.documentKey(uri))?.version ?? 0;
|
|
998
709
|
}
|
|
999
710
|
/**
|
|
1000
711
|
* The text the store holds for `uri`: an open document's, or for a closed
|
|
@@ -1005,28 +716,36 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1005
716
|
textState(uri) {
|
|
1006
717
|
const document = this.get(uri);
|
|
1007
718
|
if (document) {
|
|
1008
|
-
return { version: document.version, hash: this.
|
|
719
|
+
return { version: document.version, hash: this.textLedger.hashOf(document), dirty: this.isDirty(uri) };
|
|
1009
720
|
}
|
|
1010
|
-
const
|
|
1011
|
-
return
|
|
721
|
+
const recorded = this.textLedger.recordOf(this.documentKey(uri));
|
|
722
|
+
return recorded && { version: recorded.version, hash: recorded.hash, dirty: false };
|
|
1012
723
|
}
|
|
1013
724
|
/**
|
|
1014
|
-
*
|
|
1015
|
-
*
|
|
725
|
+
* The built root's recorded version for a first open of `key` with `text`,
|
|
726
|
+
* one on when the text differs from the root's; `undefined` when the root
|
|
727
|
+
* records no store version. Seeded from the opener's declared version
|
|
728
|
+
* instead, a write based on the built root passes the gate over other text,
|
|
729
|
+
* and the same text looks newer than its model. A built root records none
|
|
730
|
+
* only under a `LangiumDocuments` that does not reconcile at registration.
|
|
1016
731
|
*/
|
|
1017
|
-
|
|
1018
|
-
const
|
|
1019
|
-
if (
|
|
1020
|
-
return
|
|
732
|
+
builtRootOpeningVersion(key, text) {
|
|
733
|
+
const built = this.services.workspace.LangiumDocuments.getDocument(UriUtils.toUri(key));
|
|
734
|
+
if (built === undefined) {
|
|
735
|
+
return undefined;
|
|
736
|
+
}
|
|
737
|
+
const ledger = this.services.workspace.ModelLedger;
|
|
738
|
+
const root = built.parseResult.value;
|
|
739
|
+
const recorded = ledger.versionOf(root);
|
|
740
|
+
if (recorded === UNRECORDED_VERSION || recorded === STALE_VERSION) {
|
|
741
|
+
return undefined;
|
|
1021
742
|
}
|
|
1022
|
-
|
|
1023
|
-
this.__textHashes.set(document, { version: document.version, hash });
|
|
1024
|
-
return hash;
|
|
743
|
+
return (ledger.textOf(root) ?? built.textDocument.getText()) === text ? recorded : recorded + 1;
|
|
1025
744
|
}
|
|
1026
745
|
/**
|
|
1027
746
|
* Reconcile the persisted version sequence with content that reached the
|
|
1028
747
|
* build OUTSIDE the store's write paths — a closed document rebuilt from
|
|
1029
|
-
* disk
|
|
748
|
+
* disk after its release, or replaced by a watched-file change. Steps the
|
|
1030
749
|
* sequence iff `text` differs from the sequence's last-known content and
|
|
1031
750
|
* returns the resulting sequence version so the caller can re-stamp the
|
|
1032
751
|
* rebuilt document (`VersionSyncService.modelProduced`) —
|
|
@@ -1047,19 +766,12 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1047
766
|
if (open !== undefined) {
|
|
1048
767
|
return open.getText() === text ? open.version : undefined;
|
|
1049
768
|
}
|
|
1050
|
-
const
|
|
1051
|
-
const
|
|
1052
|
-
if (
|
|
1053
|
-
this.
|
|
1054
|
-
return 0;
|
|
1055
|
-
}
|
|
1056
|
-
if (hash === sequence.contentHash) {
|
|
1057
|
-
return sequence.version;
|
|
769
|
+
const before = this.textLedger.recordOf(key)?.version;
|
|
770
|
+
const version = this.textLedger.reconcile(key, text);
|
|
771
|
+
if (before !== undefined && version !== before) {
|
|
772
|
+
this.logUri(key, `External content change while closed: sequence stepped to version ${version}`, 'debug');
|
|
1058
773
|
}
|
|
1059
|
-
|
|
1060
|
-
this.__versionSequences.set(key, stepped);
|
|
1061
|
-
this.logUri(key, `External content change while closed: sequence stepped to version ${stepped.version}`, 'debug');
|
|
1062
|
-
return stepped.version;
|
|
774
|
+
return version;
|
|
1063
775
|
}
|
|
1064
776
|
/**
|
|
1065
777
|
* Commit an integrity repair into the OPEN document for `uri`, returning the
|
|
@@ -1106,18 +818,14 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1106
818
|
// Reassigned rather than mutated in place: the default configuration
|
|
1107
819
|
// updates and returns the SAME instance, but an adopter-supplied one may
|
|
1108
820
|
// return a new object, and the store must end up holding whichever it is.
|
|
1109
|
-
const updated = this.
|
|
1110
|
-
this.__syncedDocuments.set(key, updated);
|
|
1111
|
-
this.setAuthor(key, updated.version, INTEGRITY_CLIENT_ID);
|
|
1112
|
-
this.refreshDirty(key);
|
|
821
|
+
const updated = this.commitChange(key, document, [{ text: repaired }], INTEGRITY_CLIENT_ID).document;
|
|
1113
822
|
this.log(updated.uri, `Update to version ${updated.version} by ${this.formatClientId(INTEGRITY_CLIENT_ID)} (repair)`);
|
|
1114
823
|
return { status: 'committed', document: updated };
|
|
1115
824
|
}
|
|
1116
825
|
getAuthor(uri, version) {
|
|
1117
|
-
const
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
if (!clientId && history) {
|
|
826
|
+
const key = this.documentKey(uri);
|
|
827
|
+
const clientId = this.textLedger.authorOf(key, version);
|
|
828
|
+
if (!clientId && this.textLedger.authorOf(key) !== undefined) {
|
|
1121
829
|
// Only warn when there IS a history but the specific version is missing; no history at all
|
|
1122
830
|
// means the document was rebuilt internally (e.g. by a project manager), not an error.
|
|
1123
831
|
this.log(uri, `Could not detect author of version ${version}.`);
|
|
@@ -1133,8 +841,10 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1133
841
|
* `onDidClose` event fires for the last client, so `isOpen` returns `true`
|
|
1134
842
|
* during the close event itself. `isOpenInAnyClient` reads the open table
|
|
1135
843
|
* ({@link __sessions}), which is updated BEFORE the fire, so an `onDidClose`
|
|
1136
|
-
* subscriber that finds this `false` knows the last client just closed
|
|
1137
|
-
*
|
|
844
|
+
* subscriber that finds this `false` knows the last client just closed.
|
|
845
|
+
* What the build keeps is the release's: a subscriber that re-read or
|
|
846
|
+
* rebuilt the document would race the `DocumentReleaseHandler`, and after a
|
|
847
|
+
* lost connection the release waits out its grace.
|
|
1138
848
|
*/
|
|
1139
849
|
isOpenInAnyClient(uri) {
|
|
1140
850
|
return this.__sessions.isOpen(this.documentKey(uri));
|
|
@@ -1175,12 +885,12 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1175
885
|
}
|
|
1176
886
|
/**
|
|
1177
887
|
* Fires once a document no client has open is released: at its last close,
|
|
1178
|
-
* or, for a lost client's last close, when its
|
|
1179
|
-
* another client opens it, or it is deleted
|
|
1180
|
-
*
|
|
888
|
+
* or, for a lost client's last close, when its release grace runs out,
|
|
889
|
+
* another client opens it, or it is deleted, before the
|
|
890
|
+
* `DocumentReleaseHandler` slot is handed the document.
|
|
1181
891
|
*/
|
|
1182
|
-
get
|
|
1183
|
-
return this.
|
|
892
|
+
get onDidReleaseDocument() {
|
|
893
|
+
return this.documentReleasedEmitter.event;
|
|
1184
894
|
}
|
|
1185
895
|
/**
|
|
1186
896
|
* Fires for every save the language client reports of a document it has
|
|
@@ -1191,18 +901,18 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1191
901
|
return this.languageClientSavedEmitter.event;
|
|
1192
902
|
}
|
|
1193
903
|
/**
|
|
1194
|
-
* Whether `uri` is waiting out the
|
|
904
|
+
* Whether `uri` is waiting out the release grace: its last open closed with a
|
|
1195
905
|
* lost connection, and it still holds its unsaved text. Such a document is
|
|
1196
906
|
* open for no client, yet not closed either, so a caller that would persist
|
|
1197
907
|
* a closed document's text to disk treats it as open.
|
|
1198
908
|
*/
|
|
1199
|
-
|
|
1200
|
-
return this.
|
|
909
|
+
isReleaseDeferred(uri) {
|
|
910
|
+
return this.documentReleaseScheduler.isDeferred(this.documentKey(uri));
|
|
1201
911
|
}
|
|
1202
912
|
/**
|
|
1203
913
|
* Whether the store holds `uri` with text that differs from its disk
|
|
1204
914
|
* baseline: what the server last knew the file to hold. `false` for a URI
|
|
1205
|
-
* the store does not hold; a document waiting out the
|
|
915
|
+
* the store does not hold; a document waiting out the release grace is still
|
|
1206
916
|
* held.
|
|
1207
917
|
*
|
|
1208
918
|
* The baseline is the text a first open brought, or what the server wrote,
|
|
@@ -1211,30 +921,29 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1211
921
|
* must know the file reads it instead.
|
|
1212
922
|
*/
|
|
1213
923
|
isDirty(uri) {
|
|
1214
|
-
return this.
|
|
924
|
+
return this.dirtyStateTracker.isDirty(this.documentKey(uri));
|
|
1215
925
|
}
|
|
1216
926
|
/**
|
|
1217
|
-
* Fires each time the answer of {@link isDirty} changes.
|
|
1218
|
-
*
|
|
1219
|
-
*
|
|
1220
|
-
*
|
|
927
|
+
* Fires each time the answer of {@link isDirty} changes. For a document
|
|
928
|
+
* released dirty it fires once the `DocumentReleaseHandler` slot reports the
|
|
929
|
+
* release settled: at the version of the text the build then holds, or
|
|
930
|
+
* without text when the document is gone or the handler failed, though
|
|
931
|
+
* {@link isDirty} answers clean from the release on.
|
|
1221
932
|
*/
|
|
1222
933
|
get onDidChangeDirty() {
|
|
1223
|
-
return this.
|
|
934
|
+
return this.dirtyStateTracker.onDidChangeDirty;
|
|
1224
935
|
}
|
|
1225
936
|
/**
|
|
1226
937
|
* Record that the file behind `uri` holds `text`, or no file at all for
|
|
1227
938
|
* `undefined`. A no-op for a URI the store does not hold: the next first
|
|
1228
939
|
* open sets the baseline from its own text.
|
|
1229
940
|
*/
|
|
1230
|
-
|
|
941
|
+
setDiskBaseline(uri, text) {
|
|
1231
942
|
const key = this.documentKey(uri);
|
|
1232
|
-
const
|
|
1233
|
-
if (
|
|
1234
|
-
|
|
943
|
+
const document = this.__syncedDocuments.get(key);
|
|
944
|
+
if (document !== undefined) {
|
|
945
|
+
this.dirtyStateTracker.setDiskBaseline(key, document, text);
|
|
1235
946
|
}
|
|
1236
|
-
record.diskBaseline = text;
|
|
1237
|
-
this.refreshDirty(key);
|
|
1238
947
|
}
|
|
1239
948
|
/**
|
|
1240
949
|
* Read the file behind `uri` through its disk queue and take it as the
|
|
@@ -1253,20 +962,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1253
962
|
catch (err) {
|
|
1254
963
|
this.tracer.with(key).debug(`Disk baseline: the file cannot be read. ${err instanceof Error ? err.message : String(err)}`);
|
|
1255
964
|
}
|
|
1256
|
-
this.
|
|
1257
|
-
}
|
|
1258
|
-
/** Compare the held text of `uri` with its baseline, and announce a changed answer. */
|
|
1259
|
-
refreshDirty(uri) {
|
|
1260
|
-
const record = this.__documents.get(uri);
|
|
1261
|
-
const document = this.__syncedDocuments.get(uri);
|
|
1262
|
-
if (!record || !document) {
|
|
1263
|
-
return;
|
|
1264
|
-
}
|
|
1265
|
-
const dirty = document.getText() !== record.diskBaseline;
|
|
1266
|
-
if (dirty !== (record.dirty ?? false)) {
|
|
1267
|
-
record.dirty = dirty;
|
|
1268
|
-
this.dirtyChangedEmitter.fire(Object.freeze({ uri, text: { version: document.version, hash: this.heldTextHash(document), dirty } }));
|
|
1269
|
-
}
|
|
965
|
+
this.setDiskBaseline(key, onDisk);
|
|
1270
966
|
}
|
|
1271
967
|
/**
|
|
1272
968
|
* Start a client session under `clientId`. Throws where
|
|
@@ -1300,7 +996,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1300
996
|
}
|
|
1301
997
|
/**
|
|
1302
998
|
* Close every document the language client has open, as a `didClose` for
|
|
1303
|
-
* each would, so each last close
|
|
999
|
+
* each would, so each last close releases its document. For a host whose editor connection
|
|
1304
1000
|
* can end while the process lives on, such as a worker whose port's peer
|
|
1305
1001
|
* closed: the language client is no session, so nothing else closes them.
|
|
1306
1002
|
*
|
|
@@ -1312,7 +1008,8 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1312
1008
|
async closeLanguageClientDocuments() {
|
|
1313
1009
|
await this.initialBuildFinished();
|
|
1314
1010
|
for (const uri of this.__sessions.opensOf(LANGUAGE_CLIENT_ID)) {
|
|
1315
|
-
|
|
1011
|
+
// A close for one URI while others remain keeps the client's hold.
|
|
1012
|
+
this.languageClientShadow.removeAllOpens(uri);
|
|
1316
1013
|
this.notifyDidCloseTextDocument({ textDocument: { uri } });
|
|
1317
1014
|
}
|
|
1318
1015
|
}
|
|
@@ -1326,20 +1023,6 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1326
1023
|
async initialBuildFinished() {
|
|
1327
1024
|
await this.services.workspace.WorkspaceManager.workspaceInitialized.catch(() => undefined);
|
|
1328
1025
|
}
|
|
1329
|
-
/**
|
|
1330
|
-
* Stop tracking every URI the language client holds the document `key`
|
|
1331
|
-
* under, with its shadow and pending pushes. Call before a close by
|
|
1332
|
-
* canonical key that means all of them: a close for one URI while others
|
|
1333
|
-
* remain drops only that URI's and keeps the client's hold.
|
|
1334
|
-
*/
|
|
1335
|
-
untrackLanguageClientDocuments(key) {
|
|
1336
|
-
const languageClientDocuments = this.__documents.get(key)?.languageClientDocuments;
|
|
1337
|
-
for (const clientUri of languageClientDocuments?.keys() ?? []) {
|
|
1338
|
-
this.__shadow.invalidate(clientUri);
|
|
1339
|
-
this.__pendingPushes.delete(clientUri);
|
|
1340
|
-
}
|
|
1341
|
-
languageClientDocuments?.clear();
|
|
1342
|
-
}
|
|
1343
1026
|
/**
|
|
1344
1027
|
* The file behind `uri` was deleted: close every open of it except the
|
|
1345
1028
|
* language client's.
|
|
@@ -1368,14 +1051,14 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1368
1051
|
*/
|
|
1369
1052
|
delete(uri) {
|
|
1370
1053
|
const key = this.documentKey((typeof uri === 'object' && 'uri' in uri ? uri.uri : uri).toString());
|
|
1371
|
-
this.
|
|
1054
|
+
this.languageClientShadow.removeAllOpens(key);
|
|
1372
1055
|
for (const clientId of this.__sessions.clientsOf(key)) {
|
|
1373
1056
|
this.notifyDidCloseTextDocument({ textDocument: { uri: key } }, clientId);
|
|
1374
1057
|
}
|
|
1375
1058
|
// A document waiting out the grace has no client left to close, and is
|
|
1376
1059
|
// released now as its last close would have released it.
|
|
1377
|
-
if (this.
|
|
1378
|
-
this.
|
|
1060
|
+
if (this.documentReleaseScheduler.isDeferred(key)) {
|
|
1061
|
+
this.documentReleaseScheduler.cancel(key);
|
|
1379
1062
|
this.releaseDocument(key);
|
|
1380
1063
|
}
|
|
1381
1064
|
super.delete(key);
|
|
@@ -1402,13 +1085,12 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1402
1085
|
* Only a FIRST open consumes it, so stage only for a URI no client holds
|
|
1403
1086
|
* ({@link isOpenInAnyClient} is `false`). A URI held only through another
|
|
1404
1087
|
* head is not closed: an editor attaching to it joins the existing entry and
|
|
1405
|
-
* never reads the stage, and the
|
|
1406
|
-
*
|
|
1407
|
-
*
|
|
1408
|
-
* URI.
|
|
1088
|
+
* never reads the stage, and the release discards it. An entry lingers
|
|
1089
|
+
* only if `workspace/applyEdit` fails and the file is never opened — the
|
|
1090
|
+
* memory cost is one serialised string per URI.
|
|
1409
1091
|
*/
|
|
1410
1092
|
stagePendingContent(uri, text) {
|
|
1411
|
-
this.
|
|
1093
|
+
this.__pendingContent.set(this.documentKey(uri), text);
|
|
1412
1094
|
}
|
|
1413
1095
|
/**
|
|
1414
1096
|
* Send `newText` to the LSP textual language client (Monaco / VS Code) via
|
|
@@ -1427,20 +1109,19 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1427
1109
|
*
|
|
1428
1110
|
* The diff path is apply-verify-safe: the shadow internally checks that
|
|
1429
1111
|
* `TextDocument.applyEdits(old, edits) === newText` and falls back to a
|
|
1430
|
-
* full replace on mismatch
|
|
1431
|
-
*
|
|
1112
|
+
* full replace on mismatch, logged, so a diff regression becomes log noise,
|
|
1113
|
+
* not data loss.
|
|
1432
1114
|
*
|
|
1433
1115
|
* That safety net verifies the diff against the SHADOW, which is what the
|
|
1434
1116
|
* client is *believed* to hold — so it cannot see the client's buffer moving
|
|
1435
1117
|
* underneath a push. A line-keyed edit is position-dependent: if a genuine
|
|
1436
|
-
* client keystroke lands between
|
|
1437
|
-
*
|
|
1438
|
-
*
|
|
1118
|
+
* client keystroke lands between computing the edits and the client
|
|
1119
|
+
* applying them, the ranges address the wrong lines and splice the buffer
|
|
1120
|
+
* (observed as a duplicated declaration, which the integrity tier then
|
|
1439
1121
|
* "repairs" into a suffixed name and persists). The edit is therefore
|
|
1440
|
-
* addressed at the language client's last known version for that URI
|
|
1441
|
-
*
|
|
1442
|
-
*
|
|
1443
|
-
* reject a push its buffer has outrun. On rejection the shadow is invalidated,
|
|
1122
|
+
* addressed at the language client's last known version for that URI rather
|
|
1123
|
+
* than at `null` ("version intentionally unknown"), which is what lets the
|
|
1124
|
+
* client reject a push its buffer has outrun. On rejection the shadow is invalidated,
|
|
1444
1125
|
* so the caller's retry is a full-range replace — position-independent, and
|
|
1445
1126
|
* safe to apply to whatever the client now holds.
|
|
1446
1127
|
*/
|
|
@@ -1449,38 +1130,19 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1449
1130
|
if (!connection) {
|
|
1450
1131
|
return undefined;
|
|
1451
1132
|
}
|
|
1452
|
-
// The document is keyed by its canonical identity, but
|
|
1453
|
-
//
|
|
1454
|
-
|
|
1455
|
-
// when the same file was opened under a symlink and its real path. Falls back
|
|
1456
|
-
// to the normalized URI when nothing is tracked. The shadow is keyed by each
|
|
1457
|
-
// URI, so every diff is against the right baseline.
|
|
1458
|
-
const recorded = this.__documents.get(this.documentKey(uri))?.languageClientDocuments;
|
|
1459
|
-
const targets = recorded && recorded.size > 0 ? [...recorded.keys()] : [this.toLanguageClientUri(uri)];
|
|
1133
|
+
// The document is keyed by its canonical identity, but the client holds it
|
|
1134
|
+
// under each URI it opened, and each is diffed against its own baseline.
|
|
1135
|
+
const key = this.documentKey(uri);
|
|
1460
1136
|
let lastResult;
|
|
1461
|
-
for (const
|
|
1462
|
-
//
|
|
1463
|
-
//
|
|
1464
|
-
//
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
const edits = this.__shadow.computeEdits(targetUri, newText);
|
|
1468
|
-
if (edits.length === 0) {
|
|
1137
|
+
for (const clientUri of this.languageClientShadow.pushTargets(key, this.toLanguageClientUri(uri))) {
|
|
1138
|
+
// Prepared per target, after the previous target's reply: prepared up
|
|
1139
|
+
// front, a later target is diffed against what it held before a change
|
|
1140
|
+
// that arrived meanwhile.
|
|
1141
|
+
const push = this.languageClientShadow.preparePush(key, clientUri, newText);
|
|
1142
|
+
if (push === undefined) {
|
|
1469
1143
|
continue;
|
|
1470
1144
|
}
|
|
1471
|
-
// Record the push for echo correlation BEFORE the RPC — the client's
|
|
1472
|
-
// echo can race the applyEdit response. See `__pendingPushes`.
|
|
1473
|
-
this.recordPendingPush(targetUri, before, newText);
|
|
1474
1145
|
try {
|
|
1475
|
-
// Version the push only when it is position-DEPENDENT. A full-range
|
|
1476
|
-
// replace lands correctly on any buffer, so gating it would turn a
|
|
1477
|
-
// stale-by-one version into a refused update for no safety gain — and
|
|
1478
|
-
// it is exactly what the caller retries with after a rejection, so
|
|
1479
|
-
// gating it there would refuse the recovery too.
|
|
1480
|
-
const version = isFullReplace(edits) ? UNKNOWN_CLIENT_VERSION : this.languageClientVersion(uri, targetUri);
|
|
1481
|
-
// Captured before the await: a reopen replaces the state, so a late
|
|
1482
|
-
// reply then writes to the old one instead of the new buffer's.
|
|
1483
|
-
const languageClientDocument = recorded?.get(targetUri);
|
|
1484
1146
|
// A full `ApplyWorkspaceEditParams`, `edit` and all — NOT a bare
|
|
1485
1147
|
// `WorkspaceEdit` with a `label` beside it. `applyEdit` takes
|
|
1486
1148
|
// `ApplyWorkspaceEditParams | WorkspaceEdit` and discriminates on
|
|
@@ -1490,180 +1152,45 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
|
|
|
1490
1152
|
// The union is also what hides it at compile time: excess-property
|
|
1491
1153
|
// checking admits a property present in EITHER member, so an object
|
|
1492
1154
|
// matching neither type-checks against the union.
|
|
1155
|
+
const version = push.version ?? UNKNOWN_CLIENT_VERSION;
|
|
1493
1156
|
const result = await connection.workspace.applyEdit({
|
|
1494
1157
|
label: options?.label,
|
|
1495
1158
|
edit: {
|
|
1496
|
-
documentChanges: [TextDocumentEdit.create(OptionalVersionedTextDocumentIdentifier.create(
|
|
1159
|
+
documentChanges: [TextDocumentEdit.create(OptionalVersionedTextDocumentIdentifier.create(clientUri, version), push.edits)]
|
|
1497
1160
|
}
|
|
1498
1161
|
});
|
|
1499
1162
|
if (result && result.applied === false) {
|
|
1500
|
-
|
|
1501
|
-
this.__pendingPushes.delete(targetUri);
|
|
1502
|
-
if (version !== UNKNOWN_CLIENT_VERSION) {
|
|
1503
|
-
this.tracer
|
|
1504
|
-
.with(uri)
|
|
1505
|
-
.warn(`Language client refused applyEdit addressed at version ${version} (it last declared version ${languageClientDocument?.declaredVersion})`);
|
|
1506
|
-
}
|
|
1163
|
+
push.notifyOutcome('refused');
|
|
1507
1164
|
}
|
|
1508
|
-
else if (result?.applied
|
|
1509
|
-
|
|
1510
|
-
// line edit does while the shadow is right; a full replace may be a
|
|
1511
|
-
// no-op the client drops. Left to the echo, a push sent first is
|
|
1512
|
-
// refused; advanced after a no-op, one could pass at a version a
|
|
1513
|
-
// keystroke reached.
|
|
1514
|
-
languageClientDocument.pushedVersion = version + 1;
|
|
1165
|
+
else if (result?.applied) {
|
|
1166
|
+
push.notifyOutcome('applied');
|
|
1515
1167
|
}
|
|
1516
1168
|
lastResult = result;
|
|
1517
1169
|
}
|
|
1518
1170
|
catch (err) {
|
|
1519
|
-
|
|
1520
|
-
this.__pendingPushes.delete(targetUri);
|
|
1171
|
+
push.notifyOutcome('failed');
|
|
1521
1172
|
throw err;
|
|
1522
1173
|
}
|
|
1523
1174
|
}
|
|
1524
1175
|
return lastResult;
|
|
1525
1176
|
}
|
|
1526
1177
|
/**
|
|
1527
|
-
*
|
|
1528
|
-
* `targetUri`, for addressing an outgoing `workspace/applyEdit`.
|
|
1529
|
-
*
|
|
1530
|
-
* Client version ids are CLIENT-owned per LSP, so this is the id the client
|
|
1531
|
-
* itself stamped on its last `didOpen` / `didChange` for `targetUri`, or the
|
|
1532
|
-
* one an applied push moved it to ahead of the push's echo
|
|
1533
|
-
* ({@link LanguageClientDocumentState}) — never the shared server version,
|
|
1534
|
-
* which advances on authored writes the client knows nothing about and would
|
|
1535
|
-
* therefore reject every push.
|
|
1536
|
-
*
|
|
1537
|
-
* Falls back to {@link UNKNOWN_CLIENT_VERSION} when the client has not opened
|
|
1538
|
-
* the document under `targetUri`, which is the honest answer. That is also
|
|
1539
|
-
* the case in which there is no shadow, so the push is already a
|
|
1540
|
-
* position-independent full replace and has nothing to gain from a gate.
|
|
1541
|
-
*/
|
|
1542
|
-
languageClientVersion(uri, targetUri = this.toLanguageClientUri(uri)) {
|
|
1543
|
-
const state = this.__documents.get(this.documentKey(uri))?.languageClientDocuments?.get(targetUri);
|
|
1544
|
-
if (state === undefined) {
|
|
1545
|
-
return UNKNOWN_CLIENT_VERSION;
|
|
1546
|
-
}
|
|
1547
|
-
return Math.max(state.declaredVersion, state.pushedVersion ?? state.declaredVersion);
|
|
1548
|
-
}
|
|
1549
|
-
/**
|
|
1550
|
-
* Append a push to the in-flight queue for `targetUri`
|
|
1551
|
-
* (see {@link __pendingPushes}). Bounded: beyond
|
|
1552
|
-
* {@link PENDING_ECHO_CAP} the oldest entry drops with a debug log — an
|
|
1553
|
-
* echo that far outstanding means the client is not echoing at all, and
|
|
1554
|
-
* an unbounded queue must not become the leak.
|
|
1555
|
-
*/
|
|
1556
|
-
recordPendingPush(targetUri, before, newText) {
|
|
1557
|
-
let pending = this.__pendingPushes.get(targetUri);
|
|
1558
|
-
if (!pending) {
|
|
1559
|
-
pending = [];
|
|
1560
|
-
this.__pendingPushes.set(targetUri, pending);
|
|
1561
|
-
}
|
|
1562
|
-
pending.push({ before, afterHash: textHash(newText) });
|
|
1563
|
-
if (pending.length > PENDING_ECHO_CAP) {
|
|
1564
|
-
pending.shift();
|
|
1565
|
-
this.logUri(targetUri, `Pending-echo queue exceeded ${PENDING_ECHO_CAP} entries; dropped the oldest`, 'debug');
|
|
1566
|
-
}
|
|
1567
|
-
}
|
|
1568
|
-
/**
|
|
1569
|
-
* Decide what an incoming language-client change actually is, by
|
|
1570
|
-
* reconstructing the client's resulting buffer against the text its ranges
|
|
1571
|
-
* address — the pre-push buffer of the OLDEST push still in flight for
|
|
1572
|
-
* `clientFacing`, else whatever that client is believed to hold.
|
|
1573
|
-
*
|
|
1574
|
-
* `undefined` when the client's ranges address the synced text itself —
|
|
1575
|
-
* nothing in flight, and no evidence the client holds anything else. That
|
|
1576
|
-
* is the ordinary path, and the caller then applies the ranges directly.
|
|
1577
|
-
* The two texts part company without a push in flight whenever a client
|
|
1578
|
-
* attaches to a document another client has already written: it opened
|
|
1579
|
-
* from disk, so applying its ranges to the synced text splices lines they
|
|
1580
|
-
* never addressed.
|
|
1581
|
-
*
|
|
1582
|
-
* **Why the oldest, and why reconstruct at all.** The client applies our
|
|
1583
|
-
* pushes in order and echoes each against the buffer it held before that
|
|
1584
|
-
* push, so the first echo to arrive belongs to the oldest entry — a FIFO
|
|
1585
|
-
* correspondence the queue preserves by consuming from the front. Comparing
|
|
1586
|
-
* the reconstruction against every pending hash, not only the oldest, is
|
|
1587
|
-
* what recognises an echo that a newer write already superseded: a rapid
|
|
1588
|
-
* write sequence can deliver the echo of push N after the store applied
|
|
1589
|
-
* push N+1, and everything older is then accounted for too.
|
|
1590
|
-
*
|
|
1591
|
-
* A reconstruction matching NO pending push means the client's buffer went
|
|
1592
|
-
* somewhere we did not send it — it coalesced a keystroke into the echo, or
|
|
1593
|
-
* typed before the push landed. That text is authoritative, and the queue
|
|
1594
|
-
* drops: the client has stopped being a pure mirror, so no outstanding echo
|
|
1595
|
-
* can match again. (A push still in flight at that point will be refused by
|
|
1596
|
-
* the client's own version gate, which invalidates the shadow and makes the
|
|
1597
|
-
* next sync a position-independent full replace.)
|
|
1598
|
-
*
|
|
1599
|
-
* Content equality is a sound echo proof because entries live only between a
|
|
1600
|
-
* push and its echo — a milliseconds window, never history — and the
|
|
1601
|
-
* client's `didChange` stream is ordered, so every buffer state arrives in
|
|
1602
|
-
* mutation order. An UNDO returning the buffer to previously-pushed text is
|
|
1603
|
-
* therefore never swallowed: the edit that preceded it already emptied the
|
|
1604
|
-
* queue, so undo revisits PAST states while the queue holds IN-FLIGHT ones.
|
|
1605
|
-
*/
|
|
1606
|
-
classifyLanguageClientChange(clientFacing, document, changes) {
|
|
1607
|
-
const queued = this.__pendingPushes.get(clientFacing);
|
|
1608
|
-
const pending = queued?.length ? queued : undefined;
|
|
1609
|
-
// The text the client's ranges address: the buffer it held before the
|
|
1610
|
-
// oldest push still in flight, else the buffer it is believed to hold.
|
|
1611
|
-
const clientText = pending?.[0].before ?? this.__shadow.clientText(clientFacing);
|
|
1612
|
-
if (pending === undefined && (clientText === undefined || clientText === document.getText())) {
|
|
1613
|
-
return undefined;
|
|
1614
|
-
}
|
|
1615
|
-
if (pending !== undefined && pending[0].before === undefined && changes.some(change => ContentChange.isIncremental(change))) {
|
|
1616
|
-
// A push sent to a client whose buffer was unknown — a first sync, or
|
|
1617
|
-
// the recovery push after a rejection. The shadow now holds the text
|
|
1618
|
-
// that push MOVES the client to, which is the one text the echo's
|
|
1619
|
-
// ranges provably do not address, so the fallback above is a baseline
|
|
1620
|
-
// known to be wrong rather than merely unverified. Drop the queue and
|
|
1621
|
-
// the shadow: the next sync is then a full replace, which lands on
|
|
1622
|
-
// whatever the client holds. A full-text change is exempt because it
|
|
1623
|
-
// reconstructs identically against any baseline.
|
|
1624
|
-
pending.length = 0;
|
|
1625
|
-
this.__shadow.invalidate(clientFacing);
|
|
1626
|
-
return { kind: 'unreconstructable' };
|
|
1627
|
-
}
|
|
1628
|
-
// Through the configured factories, not `TextDocument` directly, so an
|
|
1629
|
-
// adopter's custom text-document type governs how the ranges are applied
|
|
1630
|
-
// here exactly as it does on the synced document.
|
|
1631
|
-
const probe = this.create(clientFacing, document.languageId, 0, clientText ?? document.getText());
|
|
1632
|
-
const reconstructed = this.update(probe, changes, 0).getText();
|
|
1633
|
-
if (pending !== undefined) {
|
|
1634
|
-
const matchIndex = pending.findIndex(push => push.afterHash === textHash(reconstructed));
|
|
1635
|
-
if (matchIndex >= 0) {
|
|
1636
|
-
pending.splice(0, matchIndex + 1);
|
|
1637
|
-
return { kind: 'echo' };
|
|
1638
|
-
}
|
|
1639
|
-
pending.length = 0;
|
|
1640
|
-
}
|
|
1641
|
-
return { kind: 'divergent', text: reconstructed };
|
|
1642
|
-
}
|
|
1643
|
-
/**
|
|
1644
|
-
* Explicitly baseline the language-client text shadow for a URI. Useful in
|
|
1178
|
+
* Explicitly baseline the language-client shadow for a URI. Useful in
|
|
1645
1179
|
* tests and for adopters that need to seed the shadow without going through
|
|
1646
1180
|
* a `didOpen` event (e.g. after a sideband save). Normal didOpen / didChange
|
|
1647
1181
|
* paths from the LSP language client already auto-track the shadow.
|
|
1648
1182
|
*/
|
|
1649
1183
|
setLanguageClientText(uri, text) {
|
|
1650
|
-
|
|
1651
|
-
this.__shadow.set(clientFacing, text);
|
|
1652
|
-
// An explicit rebaseline supersedes whatever was in flight.
|
|
1653
|
-
this.__pendingPushes.delete(clientFacing);
|
|
1184
|
+
this.languageClientShadow.setClientText(this.toLanguageClientUri(uri), text);
|
|
1654
1185
|
}
|
|
1655
1186
|
/** Drop the shadow baseline for a URI; the next applyEditToLanguageClient sends a full replace. */
|
|
1656
1187
|
invalidateLanguageClientText(uri) {
|
|
1657
|
-
|
|
1658
|
-
this.__shadow.invalidate(clientFacing);
|
|
1659
|
-
this.__pendingPushes.delete(clientFacing);
|
|
1188
|
+
this.languageClientShadow.invalidateClientText(this.toLanguageClientUri(uri));
|
|
1660
1189
|
}
|
|
1661
1190
|
consumePendingContent(uri) {
|
|
1662
|
-
const
|
|
1663
|
-
const content =
|
|
1664
|
-
|
|
1665
|
-
record.pendingContent = undefined;
|
|
1666
|
-
}
|
|
1191
|
+
const key = this.documentKey(uri);
|
|
1192
|
+
const content = this.__pendingContent.get(key);
|
|
1193
|
+
this.__pendingContent.delete(key);
|
|
1667
1194
|
return content;
|
|
1668
1195
|
}
|
|
1669
1196
|
log(uri, message) {
|