@hydranium/core 1.0.0-next.32 → 1.0.0-next.320

package/src/langium/document-builder/build-pipeline-integration.ts

@@ -10,35 +10,11 @@
 import { type LangiumDocument, DocumentState } from '@hydranium/langium';
 import { type CancellationToken } from 'vscode-languageserver';
 import { IntegrityPhase } from '../integrity/integrity-rule.js';
-import { groupDocumentsByLanguage } from '../build-phase-pass/build-phase-pass.js';
+import { AstExtensionPhase } from '../ast-extension/ast-extension-service.js';
+import { BuildPassPhase, groupDocumentsByLanguage } from '../build-phase-pass/build-phase-pass.js';
 import { type ServerSharedServices } from '../module.js';
 import { labelPhaseListener } from './labeled-phase-listener.js';
 
-/**
- * AST extension wiring covers every "useful" `DocumentState` an extension can
- * target. `Changed` has no AST yet; `IndexedContent` carries the same
- * per-document information as `Parsed`. No-op fires for documents with no
- * extension at a given state are negligible (`notifyDocumentPhase` is a plain
- * listener loop), so the framework wires the full set unconditionally rather
- * than collecting declared states from per-language registrations.
- */
-const AST_EXTENSION_PHASES: readonly DocumentState[] = [
-   DocumentState.Parsed,
-   DocumentState.ComputedScopes,
-   DocumentState.Linked,
-   DocumentState.IndexedReferences,
-   DocumentState.Validated
-];
-
-/**
- * Build phases at which the `BuildPhasePassService` is driven. Same useful
- * set as {@link AST_EXTENSION_PHASES}: a pass registered at any other state
- * never fires (the listener is not wired), mirroring the AST-extension contract.
- * `runPasses` no-ops at a phase with no registered pass, so wiring the full set
- * unconditionally costs only an empty-bucket check per phase.
- */
-const BUILD_PHASE_PASS_STATES: readonly DocumentState[] = AST_EXTENSION_PHASES;
-
 /**
  * Default priority of the framework integrity passes. Integrity mutates / cleans
  * the AST that every derived-state pass reads, so it is *foundational* and must
@@ -65,6 +41,19 @@ export interface BuildPipelineIntegrationOptions {
    readonly integrityPriority?: number;
 }
 
+/**
+ * The build-pipeline slot. Empty because nothing calls this service — it wires
+ * itself in its constructor and every seam it offers is `protected`.
+ *
+ * Typing the slot by the class instead would stop an adopter's subclass
+ * satisfying it, since a class carries its `protected` members into the check
+ * and they compare by declaration rather than by shape. The cost of the empty
+ * shape is that any non-null value satisfies it, so a mis-bound slot compiles
+ * and the framework's phase listeners are then never attached.
+ */
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- the slot has no public member to name
+export interface BuildPipelineIntegration {}
+
 /**
  * Wires the framework's build-time features (integrity rules, AST
  * enrichment) into Langium's document-build pipeline. The single shared
@@ -90,7 +79,7 @@ export interface BuildPipelineIntegrationOptions {
  * Eagerly constructed (via `DEFAULT_EAGER_SERVICES`) so the listeners are
  * attached before the first build cycle.
  */
-export class BuildPipelineIntegration {
+export class DefaultBuildPipelineIntegration implements BuildPipelineIntegration {
    constructor(
       protected readonly services: ServerSharedServices,
       options: BuildPipelineIntegrationOptions = {}
@@ -108,17 +97,19 @@ export class BuildPipelineIntegration {
       for (const phase of IntegrityPhase.all()) {
          passes.register({
             id: `framework:integrity:${IntegrityPhase.toString(phase).toLowerCase()}`,
-            state: phase,
+            phase,
             priority: integrityPriority,
             run: (documents, cancelToken) => this.callIntegrity(documents, phase, cancelToken)
          });
       }
 
-      // One onBuildPhase listener per pass state, routed through the overridable
+      // One onBuildPhase listener per pass phase, routed through the overridable
       // `runBuildPhase` seam → priority-ordered, sequential, cancel-aware pass
       // dispatch. The returned promise is awaited by the build pipeline, so a
-      // mutating pass (integrity) reparses before the build advances.
-      for (const phase of BUILD_PHASE_PASS_STATES) {
+      // mutating pass (integrity) reparses before the build advances. The full
+      // set is wired unconditionally: `runPasses` no-ops at a phase with no
+      // pass, so an unused listener costs one empty-bucket check.
+      for (const phase of BuildPassPhase.all()) {
          builder.onBuildPhase(
             phase,
             labelPhaseListener(
@@ -128,11 +119,21 @@ export class BuildPipelineIntegration {
          );
       }
 
+      // Per DOCUMENT as well: `reparseAndRelink` re-indexes one document from
+      // inside the `Linked` phase and fires no build-phase notification, so a
+      // batch-level listener cannot see the AST it replaced.
+      builder.onDocumentPhase(
+         DocumentState.IndexedContent,
+         labelPhaseListener(() => this.clearScopeCaches(), 'BuildPipeline.clearScopeCaches')
+      );
+
       // AST enrichment stays per-document (onDocumentPhase) and node-granular —
       // unchanged by the build-phase-pass registry, which is batch-granular. The
       // listener calls the `extendAst` seam directly (the document-phase analog of
       // `runBuildPhase`); there is no per-phase handler tier — one parameterized seam.
-      for (const phase of AST_EXTENSION_PHASES) {
+      // Wired for every phase unconditionally rather than for the phases the
+      // per-language registrations declare: a no-op fire is a plain listener loop.
+      for (const phase of AstExtensionPhase.all()) {
          builder.onDocumentPhase(
             phase,
             labelPhaseListener(
@@ -174,6 +175,19 @@ export class BuildPipelineIntegration {
       }
    }
 
+   /**
+    * Drop the cached scopes of every REGISTERED language, not of those owning a
+    * document in the batch. The index a scope is built from is
+    * workspace-global, so narrowing to the batch with
+    * {@link groupDocumentsByLanguage}, the way {@link callIntegrity} does,
+    * leaves a cross-grammar reference resolving against a mid-rebuild scope.
+    */
+   protected clearScopeCaches(): void {
+      for (const languageServices of this.services.ServiceRegistry.all) {
+         languageServices.references.ScopeProvider.clearScopeCaches();
+      }
+   }
+
    /** Run AST enrichment for a single document at `phase` via its language service. */
    protected extendAst(document: LangiumDocument, phase: DocumentState, cancelToken: CancellationToken): void {
       this.services.ServiceRegistry.getServices(document.uri).ast.AstExtensionService.extendDocument(document, phase, cancelToken);

package/src/langium/document-builder/build-session.ts

@@ -8,6 +8,7 @@
  ********************************************************************************/
 
 import { type URI } from '@hydranium/langium';
+import { type Stopwatch } from '@hydranium/protocol';
 
 /** What a build is about, handed to `HydraniumDocumentBuilder.createBuildSession`. */
 export interface BuildSessionContext {
@@ -59,14 +60,14 @@ export class BuildSession {
    traceId?: number;
    /** Set when the build ended in `OperationCancelled`, so the successor can tag itself "cancels #N". */
    cancelled = false;
-   /** Phase-reached lines produced so far; the first one measures from {@link startMs} rather than from the previous phase. */
+   /** Phase-reached lines produced so far; the first one measures from {@link sinceStart} rather than from the previous phase. */
    phasesLogged = 0;
    /** Lines held back by {@link detailThresholdMs}; flushed or dropped when the build ends. */
    readonly bufferedLines: string[] = [];
 
    constructor(
-      /** Millisecond timestamp the build started at, on the same clock as `performance.now()`. */
-      readonly startMs: number,
+      /** Running since the build started. */
+      readonly sinceStart: Stopwatch,
       /** What caused this build — a formatted URI, a count summary, or an adopter label. */
       readonly trigger: string,
       /** True when {@link trigger} already states the document count, so a phase line must not repeat it. */