@hydranium/core 1.0.0-next.39 → 1.0.0-next.390

package/lib/langium/workspace/file-system-provider.js

@@ -7,12 +7,12 @@
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
 import { EmptyFileSystemProvider } from '@hydranium/langium';
-import { serveVirtualDocument } from './virtual-document.js';
 /**
- * Empty-filesystem default {@link WritableFileSystemProvider}. For
- * in-memory / browser / test / CLI hosts that don't have a real filesystem.
- * All writes are no-ops. This is the portable `.`-entry default; the
- * Node-backed `DefaultFileSystemProvider`
+ * Empty-filesystem {@link WritableFileSystemProvider}. For browser / test / CLI
+ * hosts that don't have a real filesystem. All writes and deletes are no-ops.
+ * On the portable `.` entry it is the
+ * {@link FileSystemProviderRegistry.host} when `context.fileSystemProvider`
+ * gives no writable provider; the Node-backed `DefaultFileSystemProvider`
  * lives in `@hydranium/core/node` (it pulls `node:fs`).
  */
 export class DefaultEmptyFileSystemProvider extends EmptyFileSystemProvider {
@@ -26,16 +26,118 @@ export class DefaultEmptyFileSystemProvider extends EmptyFileSystemProvider {
     async writeFile(_uri, _content) {
         // no-op
     }
-    // Serve virtual documents from the registered document (there is no disk to
-    // read); delegate everything else to the empty base (which throws). The
-    // base declares these param-less, so the param is optional here.
-    readFile(uri) {
-        const served = uri !== undefined ? serveVirtualDocument(this.services, uri) : undefined;
-        return served !== undefined ? Promise.resolve(served) : super.readFile();
+    async deleteFile(_uri) {
+        // no-op
+    }
+    // `async` so the base's refusal becomes a rejection: it throws
+    // SYNCHRONOUSLY from a method declared to return a promise, and a
+    // synchronous throw escapes the promise chain — `.catch()` never attaches
+    // and `Promise.all` dies while its argument array is still being built, so
+    // a caller reading several URIs cannot handle the miss it asked about. The
+    // base declares `readFile` and `readBinary` param-less, so the param is
+    // optional there.
+    async readFile(_uri) {
+        return super.readFile();
+    }
+    async readBinary(_uri) {
+        return super.readBinary();
+    }
+    async stat(uri) {
+        return super.stat(uri);
+    }
+}
+/** Whether `provider` dispatches by scheme, as the provider bound on `workspace.FileSystemProvider` does. */
+export function isFileSystemProviderRegistry(provider) {
+    return 'providerFor' in provider && typeof provider.providerFor === 'function';
+}
+/**
+ * The framework's {@link FileSystemProviderRegistry}.
+ *
+ * A directory is listed by the provider of its own scheme, so a workspace
+ * root's tree comes from that provider alone.
+ *
+ * `realpath`, `resolveLinks`, `mtimeMs` and `existsSettled` are always present
+ * and forward to the scheme's provider. Where that provider lacks one,
+ * `realpath` and `resolveLinks` return the URI unchanged, `mtimeMs` returns
+ * `undefined` and `existsSettled` answers as `exists`: the answers their
+ * callers already give a provider without them.
+ */
+export class DefaultFileSystemProviderRegistry {
+    services;
+    host;
+    tracer;
+    constructor(services, options) {
+        this.services = services;
+        this.host = options.host;
+        this.tracer = services.Tracer.for(options.logName ?? this.constructor.name).trace('instantiated');
+    }
+    /**
+     * The group is read per call, not in the constructor, so a registered
+     * provider is built on first use and may read slots that reach back to this
+     * one. Only an OWN key of the group counts: the DI container resolves any
+     * key found on the prototype chain, so a scheme such as `constructor` would
+     * otherwise dispatch to a function.
+     */
+    providerFor(uri) {
+        const providers = this.services.fileSystemProviders;
+        return Object.hasOwn(providers, uri.scheme) ? providers[uri.scheme] : this.host;
+    }
+    // The async methods are `async` so a provider that throws synchronously from
+    // one still rejects, for the reason `DefaultEmptyFileSystemProvider` gives.
+    async writeFile(uri, content) {
+        return this.providerFor(uri).writeFile(uri, content);
+    }
+    async deleteFile(uri) {
+        return this.providerFor(uri).deleteFile(uri);
+    }
+    async mtimeMs(uri) {
+        return this.providerFor(uri).mtimeMs?.(uri);
+    }
+    realpath(uri) {
+        const provider = this.providerFor(uri);
+        return provider.realpath ? provider.realpath(uri) : uri;
+    }
+    resolveLinks(uri) {
+        const provider = this.providerFor(uri);
+        if (provider.resolveLinks) {
+            return provider.resolveLinks(uri);
+        }
+        // A provider with `realpath` alone still keys a present path by it.
+        return provider.realpath?.(uri) ?? uri;
+    }
+    async existsSettled(uri) {
+        const provider = this.providerFor(uri);
+        return provider.existsSettled ? provider.existsSettled(uri) : provider.exists(uri);
+    }
+    async stat(uri) {
+        return this.providerFor(uri).stat(uri);
+    }
+    statSync(uri) {
+        return this.providerFor(uri).statSync(uri);
+    }
+    async exists(uri) {
+        return this.providerFor(uri).exists(uri);
+    }
+    existsSync(uri) {
+        return this.providerFor(uri).existsSync(uri);
+    }
+    async readBinary(uri) {
+        return this.providerFor(uri).readBinary(uri);
+    }
+    readBinarySync(uri) {
+        return this.providerFor(uri).readBinarySync(uri);
+    }
+    async readFile(uri) {
+        return this.providerFor(uri).readFile(uri);
     }
     readFileSync(uri) {
-        const served = uri !== undefined ? serveVirtualDocument(this.services, uri) : undefined;
-        return served !== undefined ? served : super.readFileSync();
+        return this.providerFor(uri).readFileSync(uri);
+    }
+    async readDirectory(uri) {
+        return this.providerFor(uri).readDirectory(uri);
+    }
+    readDirectorySync(uri) {
+        return this.providerFor(uri).readDirectorySync(uri);
     }
 }
 //# sourceMappingURL=file-system-provider.js.map

package/lib/langium/workspace/file-system-provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"file-system-provider.js","sourceRoot":"","sources":["../../../src/langium/workspace/file-system-provider.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAGlF,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAK7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAE7D;;;;;;GAMG;AACH,MAAM,OAAO,8BAA+B,SAAQ,uBAAuB;IAIlD;IAHH,MAAM,CAAS;IAElC,YACsB,QAAqC,EACxD,UAA0B,EAAE;QAE5B,KAAK,EAAE,CAAC;QAHW,aAAQ,GAAR,QAAQ,CAA6B;QAIxD,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACrG,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAS,EAAE,QAAgB;QACxC,QAAQ;IACX,CAAC;IAED,4EAA4E;IAC5E,wEAAwE;IACxE,iEAAiE;IACxD,QAAQ,CAAC,GAAS;QACxB,MAAM,MAAM,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxF,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC5E,CAAC;IAEQ,YAAY,CAAC,GAAS;QAC5B,MAAM,MAAM,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxF,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;IAC/D,CAAC;CACH"}
+{"version":3,"file":"file-system-provider.js","sourceRoot":"","sources":["../../../src/langium/workspace/file-system-provider.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAGlF,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAmF7D;;;;;;;GAOG;AACH,MAAM,OAAO,8BAA+B,SAAQ,uBAAuB;IAIlD,QAAQ;IAHX,MAAM,CAAS;IAElC,YACsB,QAAqC,EACxD,OAAO,GAAmB,EAAE;QAE5B,KAAK,EAAE,CAAC;wBAHW,QAAQ;QAI3B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACrG,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAS,EAAE,QAAgB;QACxC,QAAQ;IACX,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAAS;QACvB,QAAQ;IACX,CAAC;IAED,+DAA+D;IAC/D,kEAAkE;IAClE,0EAA0E;IAC1E,2EAA2E;IAC3E,2EAA2E;IAC3E,wEAAwE;IACxE,kBAAkB;IACT,KAAK,CAAC,QAAQ,CAAC,IAAU;QAC/B,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAEQ,KAAK,CAAC,UAAU,CAAC,IAAU;QACjC,OAAO,KAAK,CAAC,UAAU,EAAE,CAAC;IAC7B,CAAC;IAEQ,KAAK,CAAC,IAAI,CAAC,GAAQ;QACzB,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;CACH;AA4BD,6GAA6G;AAC7G,MAAM,UAAU,4BAA4B,CAAC,QAAoC;IAC9E,OAAO,aAAa,IAAI,QAAQ,IAAI,OAAO,QAAQ,CAAC,WAAW,KAAK,UAAU,CAAC;AAClF,CAAC;AAcD;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,iCAAiC;IAOrB,QAAQ;IAJrB,IAAI,CAAQ;IACF,MAAM,CAAS;IAElC,YACsB,QAA2G,EAC9H,OAAiD;wBAD9B,QAAQ;QAG3B,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,GAAQ;QACjB,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;QACpD,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IACnF,CAAC;IAED,6EAA6E;IAC7E,4EAA4E;IAC5E,KAAK,CAAC,SAAS,CAAC,GAAQ,EAAE,OAAe;QACtC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAQ;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAQ;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAED,QAAQ,CAAC,GAAQ;QACd,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACvC,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAC3D,CAAC;IAED,YAAY,CAAC,GAAQ;QAClB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;YACzB,OAAO,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;QACD,oEAAoE;QACpE,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,GAAQ;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACvC,OAAO,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACtF,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAQ;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED,QAAQ,CAAC,GAAQ;QACd,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAQ;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,UAAU,CAAC,GAAQ;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAQ;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAED,cAAc,CAAC,GAAQ;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAQ;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED,YAAY,CAAC,GAAQ;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,GAAQ;QACzB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAED,iBAAiB,CAAC,GAAQ;QACvB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;CACH"}

package/lib/langium/workspace/hydranium-langium-document-factory.d.ts

@@ -6,8 +6,14 @@
  *
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
-import { type AstNode, DefaultLangiumDocumentFactory, type LangiumDocument, type URI } from '@hydranium/langium';
+import { type AstNode, type AstReflection, DefaultLangiumDocumentFactory, type LangiumDocument, type Linker, type MultiReference, type Mutable, type ParseResult, type Reference, type ReferenceInfo, type URI } from '@hydranium/langium';
+import { type CancellationToken } from 'vscode-languageserver-protocol';
+import { type TextDocument } from 'vscode-languageserver-textdocument';
+import { type ModelLedger } from '../../documents/model-ledger.js';
+import { type CstResidencyService } from '../residency/cst-residency-service.js';
+import { type VersionSyncService } from '../../documents/version-sync-service.js';
 import { type ExtendedServiceRegistry } from '../service-registry.js';
+import { type ServerSharedServicesMinimal } from '../shared-services.js';
 /**
  * Framework `LangiumDocumentFactory` that fills in the one thing Langium
  * leaves empty for a code-built document: its text.
@@ -21,10 +27,18 @@ import { type ExtendedServiceRegistry } from '../service-registry.js';
  * scope descriptions pointing at them, stay valid. A `fromString` document
  * already carries its source, so only `fromModel` needs help.
  *
+ * The first build grafts the CST of that text onto the model, as for a shed
+ * document, which gives every reference the `$refNode` the reference index
+ * needs. A model that does not pair node for node with its serialized text is
+ * re-parsed instead, and its nodes are replaced: from its file, or from the
+ * text it holds when no file is at its URI, since reading the URI would throw.
+ * While the document is open, the store's text wins.
+ *
  * Degrades to Langium's text-less `fromModel` when no serializer is bound for
- * the URI's language (the serializer throws or is absent) — the document still
- * works; only a re-read of it would yield empty text, which never happens for a
- * build-once virtual document.
+ * the URI's language (the serializer throws or is absent). Its first build
+ * re-reads it from the store or its file, replacing its nodes, as Langium
+ * does. With neither, it keeps its nodes but gets no CST, so its references
+ * stay out of the reference index and it is not relinked.
  *
  * Also links the model's container properties (`$container` /
  * `$containerProperty` / `$containerIndex`), which Langium's parser sets via
@@ -41,6 +55,16 @@ export declare class HydraniumLangiumDocumentFactory extends DefaultLangiumDocum
      * per-callsite cast. The framework's shared module binds that class.
      */
     protected readonly serviceRegistry: ExtendedServiceRegistry;
+    /** A thunk: a version-sync service whose constructor reads this factory would otherwise be a cycle. */
+    protected readonly versionSyncService: () => VersionSyncService;
+    /** A thunk: a ledger whose constructor reads this factory would otherwise be a cycle. */
+    protected readonly modelLedger: () => ModelLedger;
+    /** A thunk: the residency service resolves `LangiumDocuments`, which is built with this factory. */
+    protected readonly cstResidency: () => CstResidencyService;
+    /** The code-built documents, which are re-read from the text they hold when no file is at their URI. */
+    protected readonly codeBuiltDocuments: WeakSet<LangiumDocument<AstNode>>;
+    protected readonly astReflection: AstReflection;
+    constructor(services: ServerSharedServicesMinimal);
     /**
      * Parse `text` for `uri` under the grammar `languageId` names, instead of
      * the one `uri` routes to.
@@ -60,6 +84,56 @@ export declare class HydraniumLangiumDocumentFactory extends DefaultLangiumDocum
      */
     fromStringInLanguage<T extends AstNode = AstNode>(text: string, uri: URI, languageId: string): LangiumDocument<T>;
     fromModel<T extends AstNode = AstNode>(model: T, uri: URI): LangiumDocument<T>;
+    /**
+     * Replace a code-set reference with one the linker built, holding the same
+     * target. A relink resets and the reference index reads only such
+     * references, and only those listed in `document.references`. The first
+     * build unlinks them before its link phase, which resolves and indexes them.
+     * The target is kept in the field Langium's references hold it in, so a
+     * linker whose references have no such field resolves it on first read.
+     * `undefined` when the reference has no slot to go back in.
+     */
+    protected rebuildReference(linker: Linker, { reference, container, property, index }: ReferenceInfo): Reference | MultiReference | undefined;
+    protected createLangiumDocument<T extends AstNode = AstNode>(parseResult: ParseResult<T>, uri: URI, textDocument?: TextDocument, text?: string): LangiumDocument<T>;
+    /**
+     * The version is read before the parse, for the same reason as in
+     * {@link update}: the text document is the store's, which an edit updates
+     * in place while the parse runs.
+     */
+    protected createAsync<T extends AstNode = AstNode>(uri: URI, content: string | TextDocument, cancelToken: CancellationToken): Promise<LangiumDocument<T>>;
+    /**
+     * The store's version is read before Langium's `update`, which reads the
+     * store's text before its first await: read after, it can belong to an
+     * edit that arrived while the parse ran.
+     *
+     * Reconciled with the store here rather than in a `Parsed` listener, which
+     * a cancel skips, leaving the root on the version of its earlier text.
+     */
+    update<T extends AstNode = AstNode>(document: Mutable<LangiumDocument<T>>, cancellationToken: CancellationToken): Promise<LangiumDocument<T>>;
+    /**
+     * The text a code-built document is read from when no file is at its URI:
+     * the store's while it is open, else the text it holds, serialized at
+     * creation or last read, as `VirtualFileSystemProvider` serves it.
+     * `undefined` for any other document, which is read as Langium reads it.
+     * The store's version is read with its text, since an edit can land
+     * before the caller resumes. Held text has no version.
+     */
+    protected codeBuiltSource(document: LangiumDocument): Promise<{
+        text: string;
+        version: number | undefined;
+    } | undefined>;
+    /**
+     * Langium's `update` with `text` in place of the text it reads from the
+     * store or the URI. Mirrors `DefaultLangiumDocumentFactory.update` of
+     * Langium 4.3.1, so a Langium upgrade has to compare the two. From
+     * Langium 4.4, an override of `getUpdatedText` replaces it.
+     */
+    protected reparse<T extends AstNode = AstNode>(document: Mutable<LangiumDocument<T>>, text: string, cancellationToken: CancellationToken): Promise<LangiumDocument<T>>;
+    /**
+     * `version`, or {@link STALE_VERSION} when the store holds `uri` open with
+     * other text than `parsed`: text read from the file while an open landed.
+     */
+    protected versionOfParsedText(uri: URI, parsed: string | undefined, version: number): number;
     /**
      * Serialize `model` via the per-language serializer, or `undefined` if none
      * is bound, it fails, or it is async — `fromModel` is synchronous, so an

package/lib/langium/workspace/hydranium-langium-document-factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hydranium-langium-document-factory.d.ts","sourceRoot":"","sources":["../../../src/langium/workspace/hydranium-langium-document-factory.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EACJ,KAAK,OAAO,EAEZ,6BAA6B,EAC7B,KAAK,eAAe,EAEpB,KAAK,GAAG,EACV,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAQtE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,+BAAgC,SAAQ,6BAA6B;IAC/E;;;;OAIG;IACH,mBAA2B,eAAe,EAAE,uBAAuB,CAAC;IAEpE;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC;IASxG,SAAS,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,GAAG,eAAe,CAAC,CAAC,CAAC;IAYvF;;;;OAIG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS;CASxE"}
+{"version":3,"file":"hydranium-langium-document-factory.d.ts","sourceRoot":"","sources":["../../../src/langium/workspace/hydranium-langium-document-factory.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EACJ,KAAK,OAAO,EACZ,KAAK,aAAa,EAElB,6BAA6B,EAI7B,KAAK,eAAe,EACpB,KAAK,MAAM,EACX,KAAK,cAAc,EACnB,KAAK,OAAO,EACZ,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,GAAG,EACV,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAEvE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AACjF,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,yCAAyC,CAAC;AAClF,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AAQzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,+BAAgC,SAAQ,6BAA6B;IAC/E;;;;OAIG;IACH,mBAA2B,eAAe,EAAE,uBAAuB,CAAC;IAEpE,uGAAuG;IACvG,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;IAChE,yFAAyF;IACzF,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,WAAW,CAAC;IAClD,oGAAoG;IACpG,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,mBAAmB,CAAC;IAC3D,wGAAwG;IACxG,SAAS,CAAC,QAAQ,CAAC,kBAAkB,oCAAkC;IACvE,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAEhD,YAAY,QAAQ,EAAE,2BAA2B,EAMhD;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,CAOhH;IAEQ,SAAS,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,GAAG,eAAe,CAAC,CAAC,CAAC,CAuBtF;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,gBAAgB,CACvB,MAAM,EAAE,MAAM,EACd,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,aAAa,GACxD,SAAS,GAAG,cAAc,GAAG,SAAS,CA4BxC;IAED,UAAmB,qBAAqB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EACjE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,EAC3B,GAAG,EAAE,GAAG,EACR,YAAY,CAAC,EAAE,YAAY,EAC3B,IAAI,CAAC,EAAE,MAAM,GACb,eAAe,CAAC,CAAC,CAAC,CAUpB;IAED;;;;OAIG;IACH,UAAyB,WAAW,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAC7D,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,MAAM,GAAG,YAAY,EAC9B,WAAW,EAAE,iBAAiB,GAC9B,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAO7B;IAED;;;;;;;OAOG;IACY,MAAM,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAC9C,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EACrC,iBAAiB,EAAE,iBAAiB,GACpC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAsC7B;IAED;;;;;;;OAOG;IACH,UAAgB,eAAe,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAC,CAQ7H;IAED;;;;;OAKG;IACH,UAAgB,OAAO,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAChD,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EACrC,IAAI,EAAE,MAAM,EACZ,iBAAiB,EAAE,iBAAiB,GACpC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAa7B;IAED;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAG3F;IAED;;;;OAIG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAQrE;CACH"}

package/lib/langium/workspace/hydranium-langium-document-factory.js

@@ -6,7 +6,8 @@
  *
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
-import { AstUtils, DefaultLangiumDocumentFactory } from '@hydranium/langium';
+import { AstUtils, DefaultLangiumDocumentFactory, DocumentState, isAstNode, isMultiReference } from '@hydranium/langium';
+import { STALE_VERSION } from '@hydranium/protocol';
 /**
  * Framework `LangiumDocumentFactory` that fills in the one thing Langium
  * leaves empty for a code-built document: its text.
@@ -20,10 +21,18 @@ import { AstUtils, DefaultLangiumDocumentFactory } from '@hydranium/langium';
  * scope descriptions pointing at them, stay valid. A `fromString` document
  * already carries its source, so only `fromModel` needs help.
  *
+ * The first build grafts the CST of that text onto the model, as for a shed
+ * document, which gives every reference the `$refNode` the reference index
+ * needs. A model that does not pair node for node with its serialized text is
+ * re-parsed instead, and its nodes are replaced: from its file, or from the
+ * text it holds when no file is at its URI, since reading the URI would throw.
+ * While the document is open, the store's text wins.
+ *
  * Degrades to Langium's text-less `fromModel` when no serializer is bound for
- * the URI's language (the serializer throws or is absent) — the document still
- * works; only a re-read of it would yield empty text, which never happens for a
- * build-once virtual document.
+ * the URI's language (the serializer throws or is absent). Its first build
+ * re-reads it from the store or its file, replacing its nodes, as Langium
+ * does. With neither, it keeps its nodes but gets no CST, so its references
+ * stay out of the reference index and it is not relinked.
  *
  * Also links the model's container properties (`$container` /
  * `$containerProperty` / `$containerIndex`), which Langium's parser sets via
@@ -34,6 +43,22 @@ import { AstUtils, DefaultLangiumDocumentFactory } from '@hydranium/langium';
  * node identity is preserved.
  */
 export class HydraniumLangiumDocumentFactory extends DefaultLangiumDocumentFactory {
+    /** A thunk: a version-sync service whose constructor reads this factory would otherwise be a cycle. */
+    versionSyncService;
+    /** A thunk: a ledger whose constructor reads this factory would otherwise be a cycle. */
+    modelLedger;
+    /** A thunk: the residency service resolves `LangiumDocuments`, which is built with this factory. */
+    cstResidency;
+    /** The code-built documents, which are re-read from the text they hold when no file is at their URI. */
+    codeBuiltDocuments = new WeakSet();
+    astReflection;
+    constructor(services) {
+        super(services);
+        this.astReflection = services.AstReflection;
+        this.versionSyncService = () => services.workspace.VersionSyncService;
+        this.modelLedger = () => services.workspace.ModelLedger;
+        this.cstResidency = () => services.workspace.CstResidencyService;
+    }
     /**
      * Parse `text` for `uri` under the grammar `languageId` names, instead of
      * the one `uri` routes to.
@@ -63,12 +88,170 @@ export class HydraniumLangiumDocumentFactory extends DefaultLangiumDocumentFacto
         // Make the code-built AST as structurally complete as a parsed one — the
         // parser links containers, `fromModel` does not. In place (identity kept).
         AstUtils.linkContentToContainer(model, { deep: true });
+        // The parser fills in the defaults a model built in code may leave out.
+        // Filled before serializing, since a serializer may read them, and
+        // without them the model does not pair with the parse of its text.
+        for (const node of AstUtils.streamAst(model)) {
+            AstUtils.assignMandatoryProperties(this.astReflection, node);
+        }
         const text = this.serializeModel(model, uri);
         if (text === undefined) {
             return super.fromModel(model, uri);
         }
         const parseResult = { value: model, parserErrors: [], lexerErrors: [] };
-        return this.createLangiumDocument(parseResult, uri, undefined, text);
+        const document = this.createLangiumDocument(parseResult, uri, undefined, text);
+        this.codeBuiltDocuments.add(document);
+        const linker = this.serviceRegistry.getServices(uri).references.Linker;
+        document.references = AstUtils.streamAst(model)
+            .flatMap(node => AstUtils.streamReferences(node))
+            .toArray()
+            .flatMap(info => this.rebuildReference(linker, info) ?? []);
+        return document;
+    }
+    /**
+     * Replace a code-set reference with one the linker built, holding the same
+     * target. A relink resets and the reference index reads only such
+     * references, and only those listed in `document.references`. The first
+     * build unlinks them before its link phase, which resolves and indexes them.
+     * The target is kept in the field Langium's references hold it in, so a
+     * linker whose references have no such field resolves it on first read.
+     * `undefined` when the reference has no slot to go back in.
+     */
+    rebuildReference(linker, { reference, container, property, index }) {
+        const owner = Reflect.get(container, property);
+        if (index !== undefined && !Array.isArray(owner)) {
+            return undefined;
+        }
+        let rebuilt;
+        if (isMultiReference(reference)) {
+            // Read through the field, as `items` would resolve a linker-built reference.
+            const items = '_items' in reference ? reference._items : reference.items;
+            const multi = linker.buildMultiReference(container, property, reference.$refNode, reference.$refText);
+            if ('_items' in multi) {
+                multi._items = Array.isArray(items) ? [...items] : undefined;
+            }
+            rebuilt = multi;
+        }
+        else {
+            const target = '_ref' in reference ? reference._ref : reference.ref;
+            const single = linker.buildReference(container, property, reference.$refNode, reference.$refText);
+            if ('_ref' in single) {
+                single._ref = isAstNode(target) ? target : undefined;
+            }
+            rebuilt = single;
+        }
+        if (Array.isArray(owner) && index !== undefined) {
+            owner[index] = rebuilt;
+        }
+        else {
+            Reflect.set(container, property, rebuilt);
+        }
+        return rebuilt;
+    }
+    createLangiumDocument(parseResult, uri, textDocument, text) {
+        const document = super.createLangiumDocument(parseResult, uri, textDocument, text);
+        // Without `textDocument` Langium creates one at version 0 on first read,
+        // which needs a language for `uri` that a folder URI does not have.
+        const parsed = parseResult.value.$cstNode?.root.fullText ?? text ?? textDocument?.getText();
+        const version = this.versionOfParsedText(uri, parsed, textDocument?.version ?? 0);
+        // A `fromModel` root has no CST to hold its serialized text. Recorded, it
+        // is the text a build grafts a CST from, keeping the model's nodes.
+        this.versionSyncService().modelProduced(document, { version, text: parseResult.value.$cstNode ? undefined : text });
+        return document;
+    }
+    /**
+     * The version is read before the parse, for the same reason as in
+     * {@link update}: the text document is the store's, which an edit updates
+     * in place while the parse runs.
+     */
+    async createAsync(uri, content, cancelToken) {
+        const version = typeof content === 'string' ? undefined : content.version;
+        const document = await super.createAsync(uri, content, cancelToken);
+        if (version !== undefined) {
+            this.versionSyncService().modelProduced(document, { version });
+        }
+        return document;
+    }
+    /**
+     * The store's version is read before Langium's `update`, which reads the
+     * store's text before its first await: read after, it can belong to an
+     * edit that arrived while the parse ran.
+     *
+     * Reconciled with the store here rather than in a `Parsed` listener, which
+     * a cancel skips, leaving the root on the version of its earlier text.
+     */
+    async update(document, cancellationToken) {
+        // Langium keeps the AST when the CST's text equals the new text, but a
+        // shed document has no CST and would get new AST nodes, leaving its
+        // dependents on the old ones. Grafted only when the new text is the text
+        // the AST was parsed from, so an edit on disk or in the store is still
+        // re-parsed. Not `isCstShed`: the builder has already reset the document
+        // to `Changed`. A refused or diverged graft re-parses, and a build after
+        // this one relinks the dependents: this build has prepared its
+        // documents, and a reset now would drop their build state.
+        const root = document.parseResult.value;
+        const parsedFrom = root.$cstNode === undefined ? this.modelLedger().textOf(root) : undefined;
+        const codeBuilt = await this.codeBuiltSource(document);
+        if (parsedFrom !== undefined) {
+            const text = codeBuilt?.text ??
+                this.textDocuments?.get(document.uri.toString())?.getText() ??
+                (await this.fileSystemProvider.readFile(document.uri));
+            if (text === parsedFrom) {
+                this.cstResidency().rehydrate(document);
+                if (root.$cstNode === undefined) {
+                    this.versionSyncService().rebuildWhileCurrent(document);
+                }
+            }
+        }
+        const stored = codeBuilt === undefined ? this.textDocuments?.get(document.uri.toString())?.version : codeBuilt.version;
+        const updated = codeBuilt === undefined
+            ? await super.update(document, cancellationToken)
+            : await this.reparse(document, codeBuilt.text, cancellationToken);
+        const version = stored ??
+            this.versionOfParsedText(updated.uri, this.modelLedger().textOf(updated.parseResult.value) ?? updated.textDocument.getText(), updated.textDocument.version);
+        this.versionSyncService().modelProduced(updated, { version });
+        return updated;
+    }
+    /**
+     * The text a code-built document is read from when no file is at its URI:
+     * the store's while it is open, else the text it holds, serialized at
+     * creation or last read, as `VirtualFileSystemProvider` serves it.
+     * `undefined` for any other document, which is read as Langium reads it.
+     * The store's version is read with its text, since an edit can land
+     * before the caller resumes. Held text has no version.
+     */
+    async codeBuiltSource(document) {
+        if (!this.codeBuiltDocuments.has(document) || (await this.fileSystemProvider.exists(document.uri))) {
+            return undefined;
+        }
+        const open = this.textDocuments?.get(document.uri.toString());
+        return open === undefined
+            ? { text: document.textDocument.getText(), version: undefined }
+            : { text: open.getText(), version: open.version };
+    }
+    /**
+     * Langium's `update` with `text` in place of the text it reads from the
+     * store or the URI. Mirrors `DefaultLangiumDocumentFactory.update` of
+     * Langium 4.3.1, so a Langium upgrade has to compare the two. From
+     * Langium 4.4, an override of `getUpdatedText` replaces it.
+     */
+    async reparse(document, text, cancellationToken) {
+        const textDocument = this.textDocuments?.get(document.uri.toString());
+        Object.defineProperty(document, 'textDocument', textDocument ? { value: textDocument } : { get: this.createTextDocumentGetter(document.uri, text) });
+        if (document.parseResult.value.$cstNode?.root.fullText !== text) {
+            document.parseResult = await this.parseAsync(document.uri, text, cancellationToken);
+            document.parseResult.value.$document = document;
+        }
+        document.state = DocumentState.Parsed;
+        return document;
+    }
+    /**
+     * `version`, or {@link STALE_VERSION} when the store holds `uri` open with
+     * other text than `parsed`: text read from the file while an open landed.
+     */
+    versionOfParsedText(uri, parsed, version) {
+        const open = this.textDocuments?.get(uri.toString());
+        return open !== undefined && parsed !== undefined && open.getText() !== parsed ? STALE_VERSION : version;
     }
     /**
      * Serialize `model` via the per-language serializer, or `undefined` if none

package/lib/langium/workspace/hydranium-langium-document-factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"hydranium-langium-document-factory.js","sourceRoot":"","sources":["../../../src/langium/workspace/hydranium-langium-document-factory.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAEJ,QAAQ,EACR,6BAA6B,EAI/B,MAAM,oBAAoB,CAAC;AAS5B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,+BAAgC,SAAQ,6BAA6B;IAQ/E;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,CAA8B,IAAY,EAAE,GAAQ,EAAE,UAAkB;QACzF,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,iDAAiD,UAAU,cAAc,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChH,CAAC;QACD,MAAM,WAAW,GAAmB,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAI,IAAI,CAAC,CAAC;QACjF,OAAO,IAAI,CAAC,qBAAqB,CAAI,WAAW,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IAC3E,CAAC;IAEQ,SAAS,CAA8B,KAAQ,EAAE,GAAQ;QAC/D,yEAAyE;QACzE,2EAA2E;QAC3E,QAAQ,CAAC,sBAAsB,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC7C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,WAAW,GAAmB,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;QACxF,OAAO,IAAI,CAAC,qBAAqB,CAAI,WAAW,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACO,cAAc,CAAC,KAAc,EAAE,GAAQ;QAC9C,IAAI,CAAC;YACF,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,CAAmB,CAAC;YACzE,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;YACxE,OAAO,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,CAAC;QAAC,MAAM,CAAC;YACN,OAAO,SAAS,CAAC;QACpB,CAAC;IACJ,CAAC;CACH"}
+{"version":3,"file":"hydranium-langium-document-factory.js","sourceRoot":"","sources":["../../../src/langium/workspace/hydranium-langium-document-factory.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAGJ,QAAQ,EACR,6BAA6B,EAC7B,aAAa,EACb,SAAS,EACT,gBAAgB,EASlB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAapD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,OAAO,+BAAgC,SAAQ,6BAA6B;IAQ/E,uGAAuG;IACpF,kBAAkB,CAA2B;IAChE,yFAAyF;IACtE,WAAW,CAAoB;IAClD,oGAAoG;IACjF,YAAY,CAA4B;IAC3D,wGAAwG;IACrF,kBAAkB,GAAG,IAAI,OAAO,EAAmB,CAAC;IACpD,aAAa,CAAgB;IAEhD,YAAY,QAAqC;QAC9C,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChB,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC;QAC5C,IAAI,CAAC,kBAAkB,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,kBAAkB,CAAC;QACtE,IAAI,CAAC,WAAW,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC;QACxD,IAAI,CAAC,YAAY,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,mBAAmB,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,CAA8B,IAAY,EAAE,GAAQ,EAAE,UAAkB;QACzF,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,iDAAiD,UAAU,cAAc,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChH,CAAC;QACD,MAAM,WAAW,GAAmB,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAI,IAAI,CAAC,CAAC;QACjF,OAAO,IAAI,CAAC,qBAAqB,CAAI,WAAW,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IAC3E,CAAC;IAEQ,SAAS,CAA8B,KAAQ,EAAE,GAAQ;QAC/D,yEAAyE;QACzE,2EAA2E;QAC3E,QAAQ,CAAC,sBAAsB,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACvD,wEAAwE;QACxE,mEAAmE;QACnE,mEAAmE;QACnE,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5C,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QAChE,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC7C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,WAAW,GAAmB,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;QACxF,MAAM,QAAQ,GAAG,IAAI,CAAC,qBAAqB,CAAI,WAAW,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QAClF,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;QACvE,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC;aAC3C,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;aAChD,OAAO,EAAE;aACT,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/D,OAAO,QAAQ,CAAC;IACnB,CAAC;IAED;;;;;;;;OAQG;IACO,gBAAgB,CACvB,MAAc,EACd,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAiB;QAExD,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACxD,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,OAAO,SAAS,CAAC;QACpB,CAAC;QACD,IAAI,OAAmC,CAAC;QACxC,IAAI,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC;YAC/B,6EAA6E;YAC7E,MAAM,KAAK,GAAG,QAAQ,IAAI,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC;YACzE,MAAM,KAAK,GAAG,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;YACtG,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC;gBACrB,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,CAAC;YACD,OAAO,GAAG,KAAK,CAAC;QACnB,CAAC;aAAM,CAAC;YACL,MAAM,MAAM,GAAG,MAAM,IAAI,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;YACpE,MAAM,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;YAClG,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;gBACpB,MAAM,CAAC,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,CAAC;YACD,OAAO,GAAG,MAAM,CAAC;QACpB,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/C,KAAK,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC;QAC1B,CAAC;aAAM,CAAC;YACL,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC7C,CAAC;QACD,OAAO,OAAO,CAAC;IAClB,CAAC;IAEkB,qBAAqB,CACrC,WAA2B,EAC3B,GAAQ,EACR,YAA2B,EAC3B,IAAa;QAEb,MAAM,QAAQ,GAAG,KAAK,CAAC,qBAAqB,CAAC,WAAW,EAAE,GAAG,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;QACnF,yEAAyE;QACzE,oEAAoE;QACpE,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI,IAAI,YAAY,EAAE,OAAO,EAAE,CAAC;QAC5F,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,IAAI,CAAC,CAAC,CAAC;QAClF,0EAA0E;QAC1E,oEAAoE;QACpE,IAAI,CAAC,kBAAkB,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACpH,OAAO,QAAQ,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACgB,KAAK,CAAC,WAAW,CACjC,GAAQ,EACR,OAA8B,EAC9B,WAA8B;QAE9B,MAAM,OAAO,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QAC1E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,WAAW,CAAI,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACvE,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,CAAC,kBAAkB,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,QAAQ,CAAC;IACnB,CAAC;IAED;;;;;;;OAOG;IACM,KAAK,CAAC,MAAM,CAClB,QAAqC,EACrC,iBAAoC;QAEpC,uEAAuE;QACvE,oEAAoE;QACpE,yEAAyE;QACzE,uEAAuE;QACvE,yEAAyE;QACzE,yEAAyE;QACzE,+DAA+D;QAC/D,2DAA2D;QAC3D,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC;QACxC,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7F,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,GACP,SAAS,EAAE,IAAI;gBACf,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE;gBAC3D,CAAC,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1D,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;gBACvB,IAAI,CAAC,YAAY,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACxC,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC/B,IAAI,CAAC,kBAAkB,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;gBAC3D,CAAC;YACJ,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC;QACvH,MAAM,OAAO,GACV,SAAS,KAAK,SAAS;YACpB,CAAC,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,CAAC;YACjD,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;QACxE,MAAM,OAAO,GACV,MAAM;YACN,IAAI,CAAC,mBAAmB,CACrB,OAAO,CAAC,GAAG,EACX,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE,EACtF,OAAO,CAAC,YAAY,CAAC,OAAO,CAC9B,CAAC;QACL,IAAI,CAAC,kBAAkB,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC9D,OAAO,OAAO,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,eAAe,CAAC,QAAyB;QACtD,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAClG,OAAO,SAAS,CAAC;QACpB,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9D,OAAO,IAAI,KAAK,SAAS;YACtB,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE;YAC/D,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,OAAO,CACpB,QAAqC,EACrC,IAAY,EACZ,iBAAoC;QAEpC,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtE,MAAM,CAAC,cAAc,CAClB,QAAQ,EACR,cAAc,EACd,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CACrG,CAAC;QACF,IAAI,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YAC/D,QAAQ,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,CAAI,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;YACtF,QAAQ,CAAC,WAAW,CAAC,KAA0B,CAAC,SAAS,GAAG,QAAQ,CAAC;QACzE,CAAC;QACD,QAAQ,CAAC,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC;QACtC,OAAO,QAAQ,CAAC;IACnB,CAAC;IAED;;;OAGG;IACO,mBAAmB,CAAC,GAAQ,EAAE,MAA0B,EAAE,OAAe;QAChF,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrD,OAAO,IAAI,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC;IAC5G,CAAC;IAED;;;;OAIG;IACO,cAAc,CAAC,KAAc,EAAE,GAAQ;QAC9C,IAAI,CAAC;YACF,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,CAAmB,CAAC;YACzE,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;YACxE,OAAO,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,CAAC;QAAC,MAAM,CAAC;YACN,OAAO,SAAS,CAAC;QACpB,CAAC;IACJ,CAAC;CACH"}

package/lib/langium/workspace/hydranium-workspace-lock.d.ts

@@ -6,8 +6,25 @@
  *
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
+import { type Clock, type Tracer } from '@hydranium/protocol';
 import { DefaultWorkspaceLock, type MaybePromise } from '@hydranium/langium';
-import { type CancellationToken } from 'vscode-languageserver-protocol';
+import { type CancellationToken, type Disposable } from 'vscode-languageserver-protocol';
+import { type LogNameOptions } from '../diagnostics/logger.js';
+import { type ServerSharedServicesMinimal } from '../shared-services.js';
+/** Constructor options for {@link HydraniumWorkspaceLock}. */
+export interface HydraniumWorkspaceLockOptions extends LogNameOptions {
+    /**
+     * How long a write may keep running after a later write cancelled it before
+     * the lock logs a warning. Every write and read waits behind it meanwhile, so
+     * one that never ends stops the server. Defaults to 10 s; `0` turns the
+     * check off.
+     */
+    readonly stalledWriteWarnMs?: number;
+}
+/** The write action a {@link HydraniumWorkspaceLock} is running, with the timer its cancellation started. */
+export interface RunningWrite {
+    stallTimer?: Disposable;
+}
 /**
  * Langium's {@link DefaultWorkspaceLock} with the write action marked as a
  * write-lock scope, so anything it reaches can be asked whether the lock is
@@ -26,6 +43,38 @@ import { type CancellationToken } from 'vscode-languageserver-protocol';
  * would turn ordinary read-then-write sequences into false positives.
  */
 export declare class HydraniumWorkspaceLock extends DefaultWorkspaceLock {
+    /** Backs {@link writeCancellations}. */
+    protected cancelledWriteCount: number;
+    protected readonly clock: Clock;
+    protected readonly tracer: Tracer;
+    protected readonly stalledWriteWarnMs: number;
+    protected runningWrite?: RunningWrite;
+    /** Writes queued and not yet started. */
+    protected queuedWrites: number;
+    constructor(services: Pick<ServerSharedServicesMinimal, 'Clock' | 'Tracer'>, options?: HydraniumWorkspaceLockOptions);
+    /**
+     * How many calls to `write` or `cancelWrite` came while a write was still
+     * queued or running. A caller that reads this right after queuing a
+     * write, and reads the same number later, holds a write nothing has
+     * cancelled, whether it is still queued or already running. Its token
+     * answers that only once the write runs, since a queued write has not been
+     * handed it yet. A different number read after the caller's write ended
+     * does not prove that write was cancelled, since a later write that
+     * cancels another queued or running write counts too. A caller that
+     * retries on it builds once more than it needs to.
+     */
+    get writeCancellations(): number;
     write(action: (token: CancellationToken) => MaybePromise<void>): Promise<void>;
+    /** Run `action` as {@link runningWrite}, so a cancellation while it runs can time it. */
+    protected runWrite(action: (token: CancellationToken) => MaybePromise<void>, token: CancellationToken): Promise<void>;
+    /**
+     * Counted here rather than in {@link write}, because Langium's `write` cancels
+     * through this method too. A write that has ended is not counted, so the
+     * next write does not count as cancelling it. A write running when this is
+     * called has been cancelled, by this call or an earlier one, so its timer
+     * starts here.
+     */
+    cancelWrite(): void;
+    protected reportStalledWrite(): void;
 }
 //# sourceMappingURL=hydranium-workspace-lock.d.ts.map

package/lib/langium/workspace/hydranium-workspace-lock.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hydranium-workspace-lock.d.ts","sourceRoot":"","sources":["../../../src/langium/workspace/hydranium-workspace-lock.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,oBAAoB,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAGxE;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,sBAAuB,SAAQ,oBAAoB;IACpD,KAAK,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,YAAY,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAGzF"}
+{"version":3,"file":"hydranium-workspace-lock.d.ts","sourceRoot":"","sources":["../../../src/langium/workspace/hydranium-workspace-lock.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,UAAU,EAAE,MAAM,gCAAgC,CAAC;AACzF,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AAGzE,8DAA8D;AAC9D,MAAM,WAAW,6BAA8B,SAAQ,cAAc;IAClE;;;;;OAKG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CACvC;AAID,6GAA6G;AAC7G,MAAM,WAAW,YAAY;IAC1B,UAAU,CAAC,EAAE,UAAU,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,sBAAuB,SAAQ,oBAAoB;IAC7D,wCAAwC;IACxC,SAAS,CAAC,mBAAmB,SAAK;IAClC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IAChC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAClC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAC9C,SAAS,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IACtC,yCAAyC;IACzC,SAAS,CAAC,YAAY,SAAK;IAE3B,YAAY,QAAQ,EAAE,IAAI,CAAC,2BAA2B,EAAE,OAAO,GAAG,QAAQ,CAAC,EAAE,OAAO,GAAE,6BAAkC,EAKvH;IAED;;;;;;;;;;OAUG;IACH,IAAI,kBAAkB,IAAI,MAAM,CAE/B;IAEQ,KAAK,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,YAAY,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAQtF;IAED,yFAAyF;IACzF,UAAgB,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,YAAY,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAW1H;IAED;;;;;;OAMG;IACM,WAAW,IAAI,IAAI,CAS3B;IAED,SAAS,CAAC,kBAAkB,IAAI,IAAI,CAOnC;CACH"}