feat: improve semantics error reporting

Also makes model seeds cancellable to reduce server load during semantic
analysis.

5 files changed, 79 insertions, 9 deletions

diff --git a/subprojects/frontend/src/xtext/SemanticsService.ts b/subprojects/frontend/src/xtext/SemanticsService.ts
new file mode 100644
index 00000000..50ec371a
--- /dev/null
+++ b/subprojects/frontend/src/xtext/SemanticsService.ts
@@ -0,0 +1,28 @@
+/*
+ * SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+
+import type EditorStore from '../editor/EditorStore';
+
+import type ValidationService from './ValidationService';
+import { SemanticsResult } from './xtextServiceResults';
+
+export default class SemanticsService {
+  constructor(
+    private readonly store: EditorStore,
+    private readonly validationService: ValidationService,
+  ) {}
+
+  onPush(push: unknown): void {
+    const result = SemanticsResult.parse(push);
+    this.validationService.setSemanticsIssues(result.issues ?? []);
+    if (result.error !== undefined) {
+      this.store.setSemanticsError(result.error);
+    } else {
+      this.store.setSemantics(push);
+    }
+    this.store.analysisCompleted();
+  }
+}
diff --git a/subprojects/frontend/src/xtext/UpdateService.ts b/subprojects/frontend/src/xtext/UpdateService.ts
index ee5ebde2..1ac722e1 100644
--- a/subprojects/frontend/src/xtext/UpdateService.ts
+++ b/subprojects/frontend/src/xtext/UpdateService.ts
@@ -133,6 +133,7 @@ export default class UpdateService {
       return;
     }
     log.trace('Editor delta', delta);
+    this.store.analysisStarted();
     const result = await this.webSocketClient.send({
       resource: this.resourceName,
       serviceType: 'update',
@@ -157,6 +158,7 @@ export default class UpdateService {
   private async updateFullTextExclusive(): Promise<void> {
     log.debug('Performing full text update');
     this.tracker.prepareFullTextUpdateExclusive();
+    this.store.analysisStarted();
     const result = await this.webSocketClient.send({
       resource: this.resourceName,
       serviceType: 'update',
diff --git a/subprojects/frontend/src/xtext/ValidationService.ts b/subprojects/frontend/src/xtext/ValidationService.ts
index 64fb63eb..1a896db3 100644
--- a/subprojects/frontend/src/xtext/ValidationService.ts
+++ b/subprojects/frontend/src/xtext/ValidationService.ts
@@ -9,7 +9,7 @@ import type { Diagnostic } from '@codemirror/lint';
 import type EditorStore from '../editor/EditorStore';
 
 import type UpdateService from './UpdateService';
-import { ValidationResult } from './xtextServiceResults';
+import { Issue, ValidationResult } from './xtextServiceResults';
 
 export default class ValidationService {
   constructor(
@@ -17,11 +17,41 @@ export default class ValidationService {
     private readonly updateService: UpdateService,
   ) {}
 
+  private lastValidationIssues: Issue[] = [];
+
+  private lastSemanticsIssues: Issue[] = [];
+
   onPush(push: unknown): void {
-    const { issues } = ValidationResult.parse(push);
+    ({ issues: this.lastValidationIssues } = ValidationResult.parse(push));
+    this.lastSemanticsIssues = [];
+    this.updateDiagnostics();
+    if (
+      this.lastValidationIssues.some(({ severity }) => severity === 'error')
+    ) {
+      this.store.analysisCompleted(true);
+    }
+  }
+
+  onDisconnect(): void {
+    this.store.updateDiagnostics([]);
+    this.lastValidationIssues = [];
+    this.lastSemanticsIssues = [];
+  }
+
+  setSemanticsIssues(issues: Issue[]): void {
+    this.lastSemanticsIssues = issues;
+    this.updateDiagnostics();
+  }
+
+  private updateDiagnostics(): void {
     const allChanges = this.updateService.computeChangesSinceLastUpdate();
     const diagnostics: Diagnostic[] = [];
-    issues.forEach(({ offset, length, severity, description }) => {
+    function createDiagnostic({
+      offset,
+      length,
+      severity,
+      description,
+    }: Issue): void {
       if (severity === 'ignore') {
         return;
       }
@@ -31,11 +61,9 @@ export default class ValidationService {
         severity,
         message: description,
       });
-    });
+    }
+    this.lastValidationIssues.forEach(createDiagnostic);
+    this.lastSemanticsIssues.forEach(createDiagnostic);
     this.store.updateDiagnostics(diagnostics);
   }
-
-  onDisconnect(): void {
-    this.store.updateDiagnostics([]);
-  }
 }
diff --git a/subprojects/frontend/src/xtext/XtextClient.ts b/subprojects/frontend/src/xtext/XtextClient.ts
index d145cd30..87778084 100644
--- a/subprojects/frontend/src/xtext/XtextClient.ts
+++ b/subprojects/frontend/src/xtext/XtextClient.ts
@@ -17,6 +17,7 @@ import getLogger from '../utils/getLogger';
 import ContentAssistService from './ContentAssistService';
 import HighlightingService from './HighlightingService';
 import OccurrencesService from './OccurrencesService';
+import SemanticsService from './SemanticsService';
 import UpdateService from './UpdateService';
 import ValidationService from './ValidationService';
 import XtextWebSocketClient from './XtextWebSocketClient';
@@ -37,6 +38,8 @@ export default class XtextClient {
 
   private readonly occurrencesService: OccurrencesService;
 
+  private readonly semanticsService: SemanticsService;
+
   constructor(
     private readonly store: EditorStore,
     private readonly pwaStore: PWAStore,
@@ -54,6 +57,7 @@ export default class XtextClient {
     );
     this.validationService = new ValidationService(store, this.updateService);
     this.occurrencesService = new OccurrencesService(store, this.updateService);
+    this.semanticsService = new SemanticsService(store, this.validationService);
   }
 
   start(): void {
@@ -67,6 +71,7 @@ export default class XtextClient {
   }
 
   private onDisconnect(): void {
+    this.store.analysisCompleted(true);
     this.highlightingService.onDisconnect();
     this.validationService.onDisconnect();
     this.occurrencesService.onDisconnect();
@@ -115,7 +120,7 @@ export default class XtextClient {
         this.validationService.onPush(push);
         return;
       case 'semantics':
-        this.store.setSemantics(push);
+        this.semanticsService.onPush(push);
         return;
       default:
         throw new Error('Unknown service');
diff --git a/subprojects/frontend/src/xtext/xtextServiceResults.ts b/subprojects/frontend/src/xtext/xtextServiceResults.ts
index d3b467ad..cae95771 100644
--- a/subprojects/frontend/src/xtext/xtextServiceResults.ts
+++ b/subprojects/frontend/src/xtext/xtextServiceResults.ts
@@ -125,3 +125,10 @@ export const FormattingResult = DocumentStateResult.extend({
 });
 
 export type FormattingResult = z.infer<typeof FormattingResult>;
+
+export const SemanticsResult = z.object({
+  error: z.string().optional(),
+  issues: Issue.array().optional(),
+});
+
+export type SemanticsResult = z.infer<typeof SemanticsResult>;