@hydranium/core 1.0.0-next.14 → 1.0.0-next.148

package/lib/langium/document-builder/document-builder.js

@@ -7,9 +7,14 @@
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
 import { ObservableValue } from '@hydranium/protocol';
-import { DefaultDocumentBuilder, DocumentState, OperationCancelled, UriUtils, interruptAndCheck, isOperationCancelled } from '@hydranium/langium';
-import { CancellationToken } from 'vscode-languageserver-protocol';
+import { DefaultDocumentBuilder, DocumentState, MultiMap, OperationCancelled, UriUtils, interruptAndCheck, isOperationCancelled } from '@hydranium/langium';
+// `Diagnostic` as a VALUE: `renderDiagnostics` needs its `getMessageString`
+// namespace helper to read the `string | MarkupContent` union without
+// restating it.
+import { CancellationToken, Diagnostic, Disposable } from 'vscode-languageserver-protocol';
 import { CST_REHYDRATION_RESET_STATE, isCstShed } from '../residency/cst-residency-service.js';
+import { HydraniumWorkspaceLock } from '../workspace/hydranium-workspace-lock.js';
+import { BuildSession } from './build-session.js';
 import { labelPhaseListener } from './labeled-phase-listener.js';
 /** Document states a phase-reached line is emitted for by default — every built phase. */
 export const DEFAULT_LOGGED_PHASES = [
@@ -20,6 +25,19 @@ export const DEFAULT_LOGGED_PHASES = [
     DocumentState.IndexedReferences,
     DocumentState.Validated
 ];
+/**
+ * The build reasons the framework stages through
+ * {@link HydraniumDocumentBuilder.markNextReason}: the LSP events the update
+ * handler dispatches on, and `didClose` for the revert the text store runs
+ * after a last close. Exposed so a subclass layering reasons of its own keeps
+ * the names the framework emits.
+ */
+export const HYDRANIUM_BUILD_REASONS = Object.freeze({
+    didOpen: 'didOpen',
+    didChangeContent: 'didChangeContent',
+    didChangeWatchedFiles: 'didChangeWatchedFiles',
+    didClose: 'didClose'
+});
 /**
  * Consecutive re-queued builds that leave a waited-on document at the same state
  * before {@link HydraniumDocumentBuilder.awaitDocumentState} stops re-queuing it.
@@ -32,25 +50,37 @@ const MAX_STALLED_REQUEUES = 3;
  * Extends Langium's {@link DefaultDocumentBuilder} with:
  *
  * - **Bug-fixes** (always on): an {@link awaitDocumentState} that waits where
- *   the default rejects, a {@link prepareBuild} that keeps a cancelled
+ *   the default rejects (re-queuing, under the workspace lock, a document no
+ *   build will carry), a {@link prepareBuild} that keeps a cancelled
  *   non-validating build from suppressing validation, and a
  *   {@link shouldRelink} that never judges a document unaffected on an index
  *   that does not describe it.
+ * - **Shared locked builds** ({@link scheduleUpdate}): build requests that
+ *   coincide share one locked build instead of cancelling each other.
  * - **URI handling** (always on): directory-aware flattening and cascade
  *   deletes in {@link update}, plus the CST-rehydration and cross-document
  *   refresh resets in {@link resetToState}.
  * - **In-place rebuild helpers** — {@link reparse} and
  *   {@link reparseAndRelink} — for a build-phase listener that mutated a
  *   document's AST and must reconcile it within the same build.
- * - **Diagnostic dedupe** at `Validated` ({@link dedupeDiagnostics}).
+ * - **Diagnostic dedupe** at `Validated` ({@link dedupeDiagnostics}), followed
+ *   by the **one server-side message render** every head inherits
+ *   ({@link renderDiagnostics}).
+ * - **Build sessions** ({@link BuildSession}): each `update` / `build` call is
+ *   one correlated unit carrying an id, a trigger label, a start time and
+ *   cancellation lineage, so every line of a rebuild reads as belonging to it
+ *   and a preempted build is distinguishable from the winner.
  * - **Logging instrumentation** (default on, opt-out via `logLevel: 'off'`):
- *   phase-reached lines, slow-listener breakdowns on `notifyDocumentPhase`,
- *   and slow-build-phase totals on `notifyBuildPhase`.
+ *   a per-build line, phase-reached lines, slow-listener breakdowns on
+ *   `notifyDocumentPhase`, and slow-build-phase totals on `notifyBuildPhase`.
  *
  * Adopters extend this class — the configuration knobs cover what most
  * adopters need; the `format*Line` methods, `formatUri`, and
  * `collectDeletedURIs` are protected so subclasses can customise wording or
- * domain-aware cascades without re-implementing surrounding logic.
+ * domain-aware cascades without re-implementing surrounding logic. An adopter
+ * with build-scoped state of its own subclasses {@link BuildSession} and
+ * overrides {@link createBuildSession}, which puts that state under the same
+ * preemption-correct teardown rather than a reimplementation of it.
  */
 export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
     tracer;
@@ -64,8 +94,15 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
     slowListenerMs;
     /** Live slow-build-phase-total threshold; read `.value` per phase. */
     slowBuildMs;
+    /** Live phase-detail buffering threshold; read `.value` once per build, onto the session. */
+    phaseDetailMs;
     uriPolicy;
     clock;
+    messageRenderer;
+    /** The lock {@link scheduleUpdate} builds under. */
+    workspaceLock;
+    /** The latest write {@link scheduleUpdate} queued, until it ends; see {@link ScheduledUpdate}. */
+    scheduledUpdate;
     /** Narrower handle on the same registry as the inherited `serviceRegistry`, for {@link ExtendedServiceRegistry.registrations}. */
     languageRegistry;
     languageFileExtensions = [];
@@ -76,17 +113,49 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
     refreshCrossDocumentComputedScopes;
     /** LSP event name (e.g. `'didChangeWatchedFiles'`) staged for the next `update()` call. */
     pendingUpdateReason;
+    /**
+     * The build currently in progress, or `undefined` between builds.
+     *
+     * A subclass carrying its own build-scoped state returns a {@link BuildSession}
+     * subclass from {@link createBuildSession} and narrows this with a typeguard
+     * where it reads that state — rather than redeclaring the field, whose
+     * initialiser would run after `super()` and clear a session opened during
+     * construction.
+     */
+    activeSession;
+    /**
+     * `traceId` of the last build that ended in cancellation, for the successor's
+     * "cancels #N" tag. Held here rather than on a session because the session
+     * that carries it is already gone by the time its successor is opened.
+     */
+    lastCancelledTraceId;
+    /** Registered through {@link onDocumentPhaseDelivered}, by phase. */
+    documentPhaseDeliveredListeners = new MultiMap();
+    /**
+     * Called with `false` by {@link buildDocuments} once a build has run every
+     * phase, and with `true` by {@link checkWaitsOnceDrained} after a build that
+     * threw; see {@link awaitDocumentState}. A listener runs synchronously,
+     * inside the build or inside that check's lock read. A throw fails the
+     * finished build; in the read it skips the listeners after it and surfaces
+     * only as an unhandled rejection.
+     */
+    buildEndedListeners = new Set();
+    /** Set while the lock read {@link checkWaitsOnceDrained} queued has not run. */
+    drainCheckQueued = false;
     constructor(services, options = {}) {
         super(services);
         this.languageRegistry = services.ServiceRegistry;
         this.uriPolicy = services.workspace.DocumentUriPolicy;
         this.clock = services.Clock;
+        this.messageRenderer = services.MessageRenderer;
+        this.workspaceLock = services.workspace.WorkspaceLock;
         this.tracer = services.Tracer.for(options.logName ?? 'DocumentBuilder').trace('instantiated');
         this.logLevel = options.logLevel ?? 'debug';
         this.loggedPhases = options.loggedPhases ?? DEFAULT_LOGGED_PHASES;
         this.slowPhaseMs = ObservableValue.from(options.slowPhaseMs ?? 25);
         this.slowListenerMs = ObservableValue.from(options.slowListenerMs ?? 5);
         this.slowBuildMs = ObservableValue.from(options.slowBuildMs ?? 25);
+        this.phaseDetailMs = ObservableValue.from(options.phaseDetailMs ?? 0);
         this.refreshCrossDocumentComputedScopes = options.refreshCrossDocumentComputedScopes ?? false;
         if (this.logLevel !== 'off') {
             this.registerPhaseListeners();
@@ -97,8 +166,8 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
     // ============================================================
     /**
      * Stage an LSP event name for the next `update()` call. Adopters call before
-     * the update fires; `HydraniumDocumentUpdateHandler` does it for the
-     * four LSP events.
+     * the update fires; `HydraniumDocumentUpdateHandler` does it for the LSP
+     * events, and the text store for the revert that follows a last close.
      *
      * The framework stages the value and never reads it back. The consumer is a
      * subclass overriding the build logging, which takes
@@ -109,6 +178,23 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
     markNextReason(reason) {
         this.pendingUpdateReason = reason;
     }
+    /**
+     * Call `listener` with a document once every {@link onDocumentPhase}
+     * listener of `state` ran for it and none was skipped by cancellation, and
+     * with the text version the phase listeners were called at. A write during
+     * them moves the document's own version on, past what they saw.
+     *
+     * Only here is it known what the phase listeners delivered. Langium sets the
+     * document's state before it notifies, and a cancel between two listeners
+     * skips the rest, leaving the document at the phase with those listeners
+     * never run and nothing to run them later. A build-phase listener comes too
+     * late: a cancel after this document but before the batch ends skips it,
+     * although every listener of this document ran.
+     */
+    onDocumentPhaseDelivered(state, listener) {
+        this.documentPhaseDeliveredListeners.add(state, listener);
+        return Disposable.create(() => this.documentPhaseDeliveredListeners.delete(state, listener));
+    }
     /**
      * Diagnostic snapshot for use in timeout/error messages around document
      * state.
@@ -126,7 +212,15 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
         const doc = this.langiumDocuments.getDocument(UriUtils.toUri(this.uriPolicy.canonicalUri(uri)));
         const docState = doc ? DocumentState[doc.state] : 'unknown (document not loaded)';
         const lastPhase = this.lastPhaseMs > 0 ? `${Math.round(performance.now() - this.lastPhaseMs)}ms ago` : 'no phase observed';
-        return `current state: '${docState}', last phase: ${lastPhase}`;
+        return `current state: '${docState}', last phase: ${lastPhase}, active build: ${this.formatSession(this.activeSession)}`;
+    }
+    /** Render a session for a status line. `undefined` — no build in progress — reads as `none`. */
+    formatSession(session) {
+        if (!session) {
+            return 'none';
+        }
+        const id = session.traceId !== undefined ? `#${session.traceId}` : 'untimed';
+        return `${id} (${session.trigger}, ${Math.round(performance.now() - session.startMs)}ms in)`;
     }
     // ============================================================
     // Bug-fixes (always on)
@@ -145,20 +239,36 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
      *
      * Replacing Langium's rejection with a wait makes the wait's liveness this
      * class's responsibility: a listener can only fire if some build is still
-     * going to reach `state`. Both re-queue sites below exist for that, and they
-     * differ only in when the orphaning is observed — {@link isOrphaned} at
-     * registration time, the `onBuildPhase` branch for a build cancelled after
-     * the wait was already armed. Re-queuing stops after
+     * going to reach `state`. So the wait re-queues the document whenever
+     * {@link isOrphaned} holds: once when it is armed, and again after every
+     * build that completes (see {@link buildDocuments}). The second check is
+     * the one a wait armed during a build needs, since only the build's end
+     * shows whether it left the document behind; Langium's `onBuildPhase` for
+     * `Validated` cannot serve, as it stays silent for a build that validates
+     * nothing, such as the workspace's initial one. A build that throws is
+     * checked once the lock drains instead (see {@link checkWaitsOnceDrained}):
+     * whatever cancelled it may build nothing. Re-queuing stops after
      * {@link MAX_STALLED_REQUEUES} builds that fail to advance the document, so a
      * document the builder will never carry to `state` degrades to a pending wait
      * plus a warning rather than an endless build loop.
+     *
+     * A wait for `Validated` on a document that a validating build skips
+     * resolves once that build has indexed its references, without diagnostics:
+     * see {@link skipsValidation}. Waiting on would never end, and re-queuing
+     * would skip it again.
+     *
+     * A re-queued build takes the {@link WorkspaceLock} (see
+     * {@link requeueOrphaned}), so a caller that awaits this wait while it holds
+     * the lock, inside a read or write action, deadlocks on a document that needs
+     * a re-queue: the build waits for that action to end. Await it outside the
+     * lock.
      */
     awaitDocumentState(state, uri, cancelToken) {
         const document = this.langiumDocuments.getDocument(uri);
         if (!document) {
             return super.awaitDocumentState(state, uri, cancelToken);
         }
-        if (document.state >= state) {
+        if (document.state >= state || (state === DocumentState.Validated && this.skipsValidation(document))) {
             return Promise.resolve(uri);
         }
         return new Promise((resolve, reject) => {
@@ -194,34 +304,63 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
                     resolve(doc.uri);
                 }
             }, 'awaitDocumentState'));
-            const buildDisposable = this.onBuildPhase(DocumentState.Validated, () => {
-                if (document.state >= state) {
+            // The phase after which a validating build either validates the
+            // document or has skipped it.
+            const skipDisposable = state === DocumentState.Validated
+                ? this.onDocumentPhase(DocumentState.IndexedReferences, labelPhaseListener((doc) => {
+                    if (UriUtils.equals(doc.uri, uri) && this.skipsValidation(doc)) {
+                        cleanup();
+                        resolve(doc.uri);
+                    }
+                }, 'awaitDocumentState.skipsValidation'))
+                : Disposable.create(() => undefined);
+            const buildEnded = (drained) => {
+                if (document.state >= state || (state === DocumentState.Validated && this.skipsValidation(document))) {
                     cleanup();
                     resolve(uri);
                 }
-                else {
-                    // Orphaned by a cancelled build — re-queue so the next build catches it up.
-                    requeue('cancelled build');
+                else if (drained ? this.activeSession === undefined : this.isOrphaned(document, state)) {
+                    // No build is left to carry the document to `state`. Either
+                    // check fails only while an unlocked build still runs; that
+                    // build carries the document or ends here too.
+                    requeue(drained ? 'build ended early' : 'build ended short of the target');
                 }
-            });
+            };
+            this.buildEndedListeners.add(buildEnded);
+            const buildDisposable = Disposable.create(() => this.buildEndedListeners.delete(buildEnded));
             const cancelDisposable = cancelToken.onCancellationRequested(() => {
                 cleanup();
                 reject(OperationCancelled);
             });
             const cleanup = () => {
                 phaseDisposable.dispose();
+                skipDisposable.dispose();
                 buildDisposable.dispose();
                 cancelDisposable.dispose();
             };
             // Orphaned BEFORE the wait was armed: the build that would have
-            // advanced this document has already finished, so neither listener
-            // above can ever fire. Re-queue now — the listeners are registered, so
-            // the resulting build resolves this wait.
+            // advanced this document has already finished, so none of these
+            // listeners fires until some other build runs. Re-queue now — the listeners are
+            // registered, so the resulting build resolves this wait.
             if (this.isOrphaned(document, state)) {
                 requeue('quiescent builder');
             }
         });
     }
+    /**
+     * Whether the build that carries or last carried `document` has indexed its
+     * references, asks for validation, and still skips it, which is an override
+     * of `shouldValidate` excluding it. A build that does not ask for
+     * validation, such as the workspace's initial one, is not a skip: the next
+     * validating build validates the document. Nor is a document below
+     * `IndexedReferences`: the build writes its options before the first phase,
+     * so the document would pass for skipped before it is even parsed.
+     */
+    skipsValidation(document) {
+        return (document.state >= DocumentState.IndexedReferences &&
+            Boolean(this.getBuildOptions(document).validation) &&
+            !this.shouldValidate(document));
+    }
     /**
      * Whether no build will advance `document` to `state`, so a wait on it can
      * only be resolved by starting one.
@@ -239,7 +378,9 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
      * `currentState` still advances to `Validated` (the validation phase runs
      * over an empty document list). Any first read that wants diagnostics — a
      * one-shot data-head read, a CLI query, `ModelService.validated` — lands
-     * here.
+     * here. A read that arrives while that build still runs finds `currentState`
+     * below `state`, so this holds for it only once the build has ended, which
+     * is why {@link awaitDocumentState} asks again then.
      */
     isOrphaned(document, state) {
         return document.state < state && this.currentState >= state;
@@ -250,13 +391,198 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
      * notification, so awaiting here would invert the dependency. A rejection is
      * logged rather than swallowed — it leaves the waiter pending until its own
      * cancellation token fires, which is worth a line in the log.
+     *
+     * The build is a {@link scheduleUpdate}, entered from a {@link WorkspaceLock}
+     * read. The read waits until no write runs or is queued, so the build neither
+     * runs beside a locked one nor cancels the build a re-queue is fired from.
+     * Unlocked, it runs beside a locked build that cannot cancel it: both
+     * validate the same version and deliver it twice. Taking the write directly,
+     * without the read, cancels the running build and skips the rest of its
+     * build-phase listeners. The read must not await the write, which queues
+     * behind that read. A build scheduled in the gap between the read batch
+     * starting and this action running is still queued, so the re-queue merges
+     * into it rather than cancelling it.
+     *
+     * A write that ran while the read waited may have carried the document to
+     * `state` already, and a second build would deliver that version again; the
+     * read skips the write then.
      */
     requeueOrphaned(document, state, reason) {
         const tracer = this.tracer.withUri(document.uri.toString());
         tracer.info(`Re-queuing orphaned document (at '${DocumentState[document.state]}', needs '${DocumentState[state]}'): ${reason}`);
-        this.update([document.uri], []).catch((err) => {
-            if (!isOperationCancelled(err)) {
-                tracer.error(`Re-queue build failed: ${err instanceof Error ? err.message : String(err)}`);
+        void this.workspaceLock.read(() => {
+            if (document.state >= state) {
+                return;
+            }
+            this.scheduleUpdate([document.uri], []).catch((err) => {
+                if (!isOperationCancelled(err)) {
+                    tracer.error(`Re-queue build failed: ${err instanceof Error ? err.message : String(err)}`);
+                }
+            });
+        });
+    }
+    // ============================================================
+    // Scheduled updates — one locked build for requests that coincide
+    // ============================================================
+    /**
+     * Build `changed` and `deleted` under the {@link WorkspaceLock}, as
+     * `workspaceLock.write(token => update(changed, deleted, token))` would,
+     * except where the build this method queued last already carries the
+     * request. The promise settles when the build that carries the request
+     * ends, completed or cancelled, as the lock's own promise does.
+     *
+     * Without it, requests that coincide cancel each other: each lock write
+     * cancels the one before it, after Langium's `update` has already reset the
+     * documents, scanned the workspace for relinking and called every
+     * `onUpdate` listener.
+     *
+     * - **Queued, not yet running:** the request merges into it, so nothing is
+     *   cancelled. The later of a change and a deletion of one URI wins, so
+     *   each URI reaches `update` in one list only: a file deleted and written
+     *   again before the build starts is a change.
+     * - **Running:** the request joins it only when {@link canJoinRunningUpdate}
+     *   holds, which keeps an edit made while it runs cancelling it.
+     * - **Otherwise,** or when anything else has cancelled that write since it
+     *   was queued, a new write, which cancels the running build as any lock
+     *   write does.
+     *
+     * `reason` is staged through {@link markNextReason} when the write runs. The
+     * latest reason of a merged request wins, as it does in the update
+     * handler's own debounced burst; a joining request's reason is dropped, since
+     * the build it joins has already started. A request without one leaves a
+     * reason staged by the caller in place.
+     *
+     * A caller that must run code of its own inside the write action takes the
+     * lock itself, and forgoes the sharing. A lock that is not a
+     * {@link HydraniumWorkspaceLock} cannot report a cancelled queued write, so
+     * every request then takes its own write.
+     */
+    scheduleUpdate(changed, deleted, reason) {
+        const lock = this.workspaceLock;
+        if (!(lock instanceof HydraniumWorkspaceLock)) {
+            return lock.write(token => {
+                if (reason !== undefined) {
+                    this.markNextReason(reason);
+                }
+                return this.update(changed, deleted, token);
+            });
+        }
+        const scheduled = this.scheduledUpdate;
+        if (scheduled && scheduled.cancellations === lock.writeCancellations) {
+            if (!scheduled.takenVersions) {
+                for (const uri of changed) {
+                    scheduled.changed.set(uri.toString(), uri);
+                    scheduled.deleted.delete(uri.toString());
+                }
+                for (const uri of deleted) {
+                    scheduled.deleted.set(uri.toString(), uri);
+                    scheduled.changed.delete(uri.toString());
+                }
+                scheduled.reason = reason ?? scheduled.reason;
+                return scheduled.promise;
+            }
+            if (this.canJoinRunningUpdate(scheduled, changed, deleted)) {
+                return scheduled.promise;
+            }
+        }
+        // The action runs on a later tick, by which time `request` is assigned.
+        const promise = lock.write(token => this.runScheduledUpdate(request, token));
+        const request = {
+            changed: new Map(changed.map(uri => [uri.toString(), uri])),
+            deleted: new Map(deleted.map(uri => [uri.toString(), uri])),
+            reason,
+            cancellations: lock.writeCancellations,
+            promise
+        };
+        this.scheduledUpdate = request;
+        return promise;
+    }
+    /**
+     * Whether a request for `changed` and `deleted` is carried by the running
+     * `scheduled` build, whose write nothing has cancelled: the request deletes
+     * nothing, and each changed URI is one the build took, held by the text
+     * store at the version it had when the build started.
+     *
+     * Each condition keeps a request from joining a build that would miss its
+     * change. Text that moved since the start may be newer than what the build
+     * parsed; a URI the text store does not hold is read from its file, which
+     * may have changed after the build read it; and a deletion may concern a
+     * document the build has already built. A joined request is also absent
+     * from the running `update`'s `onUpdate` call, which reported the store as
+     * it was when the build started; at an unchanged version that is the store
+     * the request sees.
+     */
+    canJoinRunningUpdate(scheduled, changed, deleted) {
+        const taken = scheduled.takenVersions;
+        if (!taken || deleted.length > 0) {
+            return false;
+        }
+        return changed.every(uri => taken.has(uri.toString()) && taken.get(uri.toString()) === this.textDocuments?.get(uri)?.version);
+    }
+    /**
+     * The write action of a {@link scheduleUpdate}: freeze the request, record
+     * what it takes, stage its reason and run `update`. Releases
+     * {@link scheduledUpdate} inside the lock, whatever throws, so a request
+     * arriving after the build ends starts a write of its own rather than
+     * joining a build that is over.
+     */
+    async runScheduledUpdate(request, token) {
+        try {
+            const taken = new Map();
+            for (const [key, uri] of request.changed) {
+                const version = this.textDocuments?.get(uri)?.version;
+                if (version !== undefined) {
+                    taken.set(key, version);
+                }
+            }
+            request.takenVersions = taken;
+            if (request.reason !== undefined) {
+                this.markNextReason(request.reason);
+            }
+            await this.update([...request.changed.values()], [...request.deleted.values()], token);
+        }
+        finally {
+            if (this.scheduledUpdate === request) {
+                this.scheduledUpdate = undefined;
+            }
+        }
+    }
+    /**
+     * Tell the {@link buildEndedListeners} once every phase has run, which is
+     * the one point where a build that skipped a waited-on document can be seen
+     * to have ended. Langium's `onBuildPhase` for `Validated` is not: it stays
+     * silent when no document reached that phase, which is every build that
+     * validates nothing, the workspace's initial one among them.
+     *
+     * A build that throws, whether cancelled or failed, tells none of them
+     * here: `currentState` is then below `Validated`, so {@link isOrphaned}
+     * could hold for no wait. {@link checkWaitsOnceDrained} tells them instead.
+     */
+    async buildDocuments(documents, options, cancelToken) {
+        await super.buildDocuments(documents, options, cancelToken);
+        for (const listener of [...this.buildEndedListeners]) {
+            listener(false);
+        }
+    }
+    /**
+     * After a build that threw, tell the {@link buildEndedListeners}, with
+     * `drained` set, from a {@link WorkspaceLock} read: it runs once no write
+     * runs or is queued, so no locked build is left that could still carry a
+     * waited-on document. A cancelled build is usually followed by its
+     * canceller's, but a write that builds nothing, such as a last-close revert
+     * that finds its document reopened, leaves a wait armed during the build
+     * with nothing to resolve it, and so does a build that fails. One read
+     * serves every build that throws before it runs.
+     */
+    checkWaitsOnceDrained() {
+        if (this.drainCheckQueued) {
+            return;
+        }
+        this.drainCheckQueued = true;
+        void this.workspaceLock.read(() => {
+            this.drainCheckQueued = false;
+            for (const listener of [...this.buildEndedListeners]) {
+                listener(true);
             }
         });
     }
@@ -331,7 +657,22 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
         this.ensureLanguageFileExtensions();
         const changedURIs = changed.flatMap(uri => this.flattenAndAdaptURI(uri));
         const deletedURIs = deleted.flatMap(uri => this.collectDeletedURIs(uri));
-        return super.update(changedURIs, deletedURIs, cancelToken);
+        return this.runInSession({
+            kind: 'update',
+            trigger: this.buildTriggerLabel(changedURIs, deletedURIs),
+            triggerCountsDocs: changedURIs.length + deletedURIs.length !== 1,
+            changed: changedURIs,
+            deleted: deletedURIs
+        }, this.rebuildLabel(changedURIs, deletedURIs), () => super.update(changedURIs, deletedURIs, cancelToken));
+    }
+    /**
+     * The workspace-initialization entry point, bracketed by a session like
+     * {@link update}. Langium's `update` reaches `buildDocuments` directly rather
+     * than through here, so the two never nest.
+     */
+    build(documents, options, cancelToken) {
+        const uris = documents.map(document => document.uri);
+        return this.runInSession({ kind: 'build', trigger: `${documents.length} docs`, triggerCountsDocs: true, changed: uris, deleted: [] }, `Build documents (${documents.length} docs)`, () => super.build(documents, options, cancelToken));
     }
     /**
      * Refresh cross-document `ComputedScopes` derivations on cascade, when
@@ -528,6 +869,140 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
         ];
     }
     // ============================================================
+    // Build sessions — one rebuild as a correlated unit
+    // ============================================================
+    /**
+     * Open a session, run `body` inside it, and close it — the bracket every
+     * line of a rebuild is emitted within.
+     *
+     * The session is installed **synchronously**, before the timed body runs, so
+     * that state a subclass computed in {@link createBuildSession} is already
+     * readable by the time Langium's `update` consults `shouldRelink`.
+     *
+     * Teardown is preemption-correct, which is the reason this is framework code
+     * rather than a recipe. A build outside the workspace lock overlaps another:
+     * the later one installs itself as {@link activeSession} while the earlier
+     * one is still running, and the earlier one's `finally` runs LAST. Clearing
+     * unconditionally there would discard the later build's state mid-build.
+     * Only the session that is still current clears — and the check is
+     * reference equality on the session object,
+     * not on {@link BuildSession.traceId}, which is `undefined` for every build
+     * whenever the timing level is suppressed and would compare equal to itself
+     * across two different builds.
+     *
+     * Builds outside the lock are not hypothetical even without an adopter: the
+     * model service with `serializeBuilds` off starts one. Two locked builds
+     * never overlap, since the lock starts a write only once the write it
+     * cancelled has unwound.
+     */
+    runInSession(context, label, body) {
+        // Read before installing the new session: the id being superseded belongs
+        // to the OUTGOING build, or — when the previous one already finished
+        // cancelled — to the id it parked for its successor.
+        const supersededId = this.activeSession?.traceId ?? this.lastCancelledTraceId;
+        this.lastCancelledTraceId = undefined;
+        const reason = this.pendingUpdateReason;
+        this.pendingUpdateReason = undefined;
+        const tags = [];
+        if (reason) {
+            tags.push(`event: ${reason}`);
+        }
+        if (supersededId !== undefined) {
+            tags.push(`cancels #${supersededId}`);
+        }
+        const session = this.createBuildSession(context);
+        this.activeSession = session;
+        // A phase's "since previous phase" must measure from the build's start,
+        // not from whenever the last build's final phase happened to land.
+        this.lastPhaseMs = session.startMs;
+        return this.tracer.time(label, async () => {
+            try {
+                await body();
+            }
+            catch (err) {
+                if (isOperationCancelled(err)) {
+                    session.cancelled = true;
+                }
+                this.checkWaitsOnceDrained();
+                throw err;
+            }
+            finally {
+                this.endSession(session);
+            }
+        }, this.logLevel, {
+            logAfterMs: 0,
+            forceMemoryAboveMs: session.buffers ? session.detailThresholdMs : undefined,
+            captureId: id => {
+                session.traceId = id;
+            },
+            tags
+        });
+    }
+    /**
+     * Construct the session for one build. Override to return a
+     * {@link BuildSession} subclass carrying adopter build-scoped state — it is
+     * called before the build body, so anything derived here is readable
+     * throughout it.
+     */
+    createBuildSession(context) {
+        return new BuildSession(performance.now(), context.trigger, context.triggerCountsDocs, this.phaseDetailMs.value);
+    }
+    /**
+     * Close `session`: flush what it buffered, then release it if it is still the
+     * current one (see {@link runInSession} on why that check is conditional).
+     * The flush is unconditional — a preempted build's lines still describe work
+     * that happened.
+     */
+    endSession(session) {
+        this.flushSession(session);
+        if (this.activeSession === session) {
+            this.activeSession = undefined;
+            if (session.cancelled) {
+                this.lastCancelledTraceId = session.traceId;
+            }
+        }
+    }
+    /**
+     * Emit the lines `session` held back, if it ran long enough to be worth the
+     * detail; drop them otherwise. Emits through {@link emit} rather than
+     * {@link log}, which would route them straight back into the buffer.
+     */
+    flushSession(session) {
+        const elapsedMs = performance.now() - session.startMs;
+        if (elapsedMs >= session.detailThresholdMs) {
+            for (const line of session.bufferedLines) {
+                this.emit(line);
+            }
+        }
+        session.bufferedLines.length = 0;
+    }
+    /** Label for the build's own log line. Override to customise wording. */
+    rebuildLabel(changed, deleted) {
+        if (changed.length === 0 && deleted.length === 0) {
+            return 'Rebuild documents (nothing to do)';
+        }
+        if (changed.length === 1 && deleted.length === 0) {
+            return `Rebuild document: ${this.formatUri(changed[0])}`;
+        }
+        if (changed.length === 0 && deleted.length === 1) {
+            return `Rebuild after delete: ${this.formatUri(deleted[0])}`;
+        }
+        return `Rebuild documents (${changed.length} changed, ${deleted.length} deleted)`;
+    }
+    /** Short description of what triggered the build, repeated on every phase line. Override to customise wording. */
+    buildTriggerLabel(changed, deleted) {
+        if (changed.length === 0 && deleted.length === 0) {
+            return 'nothing';
+        }
+        if (changed.length === 1 && deleted.length === 0) {
+            return this.formatUri(changed[0]);
+        }
+        if (changed.length === 0 && deleted.length === 1) {
+            return `deleted ${this.formatUri(deleted[0])}`;
+        }
+        return `${changed.length} changed, ${deleted.length} deleted`;
+    }
+    // ============================================================
     // Logging — phase-reached listeners
     // ============================================================
     registerPhaseListeners() {
@@ -540,15 +1015,37 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
         const now = performance.now();
         const elapsedMs = Math.round(now - this.lastPhaseMs);
         this.lastPhaseMs = now;
+        // Counted before the line is formatted, so the formatter stays a pure
+        // function of state a caller can also set up in a test.
+        if (this.activeSession) {
+            this.activeSession.phasesLogged++;
+        }
         this.log(this.phaseReachedLine(state, documents, elapsedMs));
     }
-    /** Format the phase-reached log line. Override to customise wording. */
+    /**
+     * Format the phase-reached log line. Override to customise wording.
+     *
+     * Within a session the line names what triggered the build, so a phase read
+     * in isolation still says which rebuild it belongs to. `elapsedMs` is ignored
+     * for the FIRST phase of a session: it measures from the previous build's
+     * last phase, an idle gap that says nothing about this build.
+     */
     phaseReachedLine(state, documents, elapsedMs) {
-        const docInfo = documents.length === 1 ? this.formatUri(documents[0].uri) : `${documents.length} docs`;
-        return `Reached phase '${DocumentState[state]}' [${docInfo}, ${elapsedMs}ms since previous phase]`;
+        const session = this.activeSession;
+        let docInfo;
+        if (session) {
+            docInfo = session.triggerCountsDocs ? `building ${session.trigger}` : `building ${session.trigger}, ${documents.length} docs`;
+        }
+        else {
+            docInfo = documents.length === 1 ? this.formatUri(documents[0].uri) : `${documents.length} docs`;
+        }
+        const elapsedInfo = session && session.phasesLogged <= 1
+            ? `${Math.round(performance.now() - session.startMs)}ms since build start`
+            : `${elapsedMs}ms since previous phase`;
+        return `Reached phase '${DocumentState[state]}' [${docInfo}, ${elapsedInfo}]`;
     }
     // ============================================================
-    // Logging — slow-listener breakdown on notifyDocumentPhase
+    // notifyDocumentPhase — the delivery hook and the slow-listener breakdown
     // ============================================================
     async notifyDocumentPhase(document, state, cancelToken) {
         // Before the listeners, one of which is Langium's diagnostics publisher.
@@ -558,16 +1055,15 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
         // build settling inside that window therefore appends after this call has
         // already deduped, and the appended duplicate is published by the listener
         // of the build that deduped. Only `serializeBuilds` closes the window.
+        //
+        // Dedupe before rendering: rendering is deterministic, so it cannot
+        // change which entries are structurally equal, and fewer survive to render.
         if (state === DocumentState.Validated) {
             this.dedupeDiagnostics(document);
-        }
-        if (this.logLevel === 'off') {
-            return super.notifyDocumentPhase(document, state, cancelToken);
+            this.renderDiagnostics(document);
         }
         const listeners = this.documentPhaseListeners.get(state).slice();
-        if (listeners.length === 0) {
-            return;
-        }
+        const version = document.textDocument.version;
         const perListenerMs = [];
         let cancelledListeners = 0;
         const { elapsedMs: totalMs } = await this.clock.measure(async () => {
@@ -587,6 +1083,14 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
                 perListenerMs.push(elapsedMs);
             }
         });
+        if (cancelledListeners === 0) {
+            for (const delivered of this.documentPhaseDeliveredListeners.get(state).slice()) {
+                delivered(document, version);
+            }
+        }
+        if (this.logLevel === 'off' || listeners.length === 0) {
+            return;
+        }
         if (cancelledListeners > 0) {
             this.tracer
                 .withUri(document.uri.toString())
@@ -718,11 +1222,83 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
             document.diagnostics = unique;
         }
     }
+    /**
+     * Render every diagnostic on `document` through the bound message renderer,
+     * in ONE pass over the finished list.
+     *
+     * All three heads read `document.diagnostics` — the LSP publish,
+     * `TransferEncoder.toTransferDiagnostic` and the GLSP validation path — so
+     * one pass here is what keeps the render from happening per head. It is also
+     * the only placement that covers lexer and parser errors, which Langium
+     * pushes onto the document without routing them through `toDiagnostic`.
+     *
+     * Running here rather than from a `Validated` phase listener needs no
+     * ordering assumption: Langium publishes from `addDiagnosticsHandler`, a free
+     * function it registers as such a listener, which can only be outrun.
+     *
+     * **It inherits {@link dedupeDiagnostics}'s window, and therefore the same
+     * precondition.** A build settling inside the listener window appends
+     * diagnostics this pass never saw, and the publisher of the build that
+     * rendered sends them — unrendered. `ModelServiceOptions.serializeBuilds`
+     * closes it and defaults to `true`, so "every diagnostic is rendered" holds
+     * by default and is an opt-out rather than a guarantee. Opting out accepts
+     * unrendered diagnostics on exactly the terms it already accepts duplicates.
+     *
+     * Entries are REPLACED rather than mutated: `sendDiagnostics` passes the
+     * array by reference and serialises later, so an in-place message mutation
+     * reaches the wire even when it runs after the publisher — which would make
+     * a test for the ordering pass in either state.
+     */
+    renderDiagnostics(document) {
+        const diagnostics = document.diagnostics;
+        if (!diagnostics || diagnostics.length === 0) {
+            return;
+        }
+        let changed = false;
+        // No try/catch: `renderDiagnostic` carries a no-throw contract, because an
+        // error escaping this phase strands the document at `Validated` with
+        // Langium's publisher never invoked.
+        const rendered = diagnostics.map(diagnostic => {
+            const text = this.messageRenderer.renderDiagnostic(diagnostic);
+            // Against the message's STRING FORM, not the field. `renderDiagnostic`
+            // answers a `string` by contract, while `Diagnostic.message` is
+            // `string | MarkupContent` since LSP 3.17 — so comparing the answer
+            // against the field never matches for a markup message, and a pass
+            // that replaced on mismatch flattened every un-identified markup
+            // diagnostic to its own plain text. That is silent data loss on the
+            // path whose whole job is to leave such entries alone.
+            if (text === Diagnostic.getMessageString(diagnostic)) {
+                return diagnostic;
+            }
+            changed = true;
+            return { ...diagnostic, message: text };
+        });
+        if (changed) {
+            document.diagnostics = rendered;
+        }
+    }
     // ============================================================
     // Internal helpers
     // ============================================================
-    /** Dispatch a log line at the configured log level; a no-op when `logLevel === 'off'`. */
+    /**
+     * Dispatch a log line at the configured log level; a no-op when `logLevel ===
+     * 'off'`.
+     *
+     * Held on the active session when it buffers, so the "was this build worth a
+     * per-phase breakdown" decision — which needs the build's total duration, and
+     * so cannot be taken by anything that runs while the lines are produced — is
+     * deferred to {@link flushSession}.
+     */
     log(message) {
+        const session = this.activeSession;
+        if (session?.buffers) {
+            session.bufferedLines.push(message);
+            return;
+        }
+        this.emit(message);
+    }
+    /** Write a line out, bypassing session buffering. The single sink every framework log line reaches. */
+    emit(message) {
         this.tracer.logAt(this.logLevel, message);
     }
 }