feat: add diagnostics change handling and update problems panel

Author: mdesmet

src/dbt_client/dbtCloudIntegration.ts

@@ -156,6 +156,7 @@ export class DBTCloudProjectIntegration implements DBTProjectIntegration {
     protected projectRoot: string,
     private projectConfigDiagnostics: DBTDiagnosticData[],
     private deferConfig: DeferConfig | undefined,
+    private onDiagnosticsChanged: () => void,
   ) {
     this.terminal.debug(
       "DBTCloudProjectIntegration",
@@ -319,6 +320,7 @@ export class DBTCloudProjectIntegration implements DBTProjectIntegration {
     return {
       pythonBridgeDiagnostics: this.pythonBridgeDiagnosticsData,
       rebuildManifestDiagnostics: this.rebuildManifestDiagnosticsData,
+      projectConfigDiagnostics: this.projectConfigDiagnostics,
     };
   }
 
@@ -384,6 +386,7 @@ export class DBTCloudProjectIntegration implements DBTProjectIntegration {
         )
         .map((line) => line.info.msg);
       this.rebuildManifestDiagnosticsData = [];
+      this.onDiagnosticsChanged();
       const filePath = path.join(this.projectRoot, DBT_PROJECT_FILE);
       const diagnosticDataArray: DBTDiagnosticData[] = [
         ...errors.map((error) => ({
@@ -404,6 +407,7 @@ export class DBTCloudProjectIntegration implements DBTProjectIntegration {
         })),
       ];
       this.rebuildManifestDiagnosticsData = diagnosticDataArray;
+      this.onDiagnosticsChanged();
     } catch (error) {
       this.terminal.error(
         "dbtCloudCannotParseProjectCommandExecuteError",
@@ -427,6 +431,7 @@ export class DBTCloudProjectIntegration implements DBTProjectIntegration {
         category: "command-execution",
       };
       this.rebuildManifestDiagnosticsData = [diagnosticData];
+      this.onDiagnosticsChanged();
     }
   }
 
@@ -986,6 +991,7 @@ export class DBTCloudProjectIntegration implements DBTProjectIntegration {
     } catch (error) {} // We don't care about errors here.
     this.rebuildManifestDiagnosticsData = [];
     this.pythonBridgeDiagnosticsData = [];
+    this.onDiagnosticsChanged();
     while (this.disposables.length) {
       const x = this.disposables.pop();
       if (x) {

src/dbt_client/dbtCoreIntegration.ts

@@ -223,6 +223,7 @@ export class DBTCoreProjectIntegration implements DBTProjectIntegration {
     protected projectRoot: string,
     private projectConfigDiagnostics: DBTDiagnosticData[],
     private deferConfig: DeferConfig | undefined,
+    private onDiagnosticsChanged: () => void,
   ) {
     this.dbtTerminal.debug(
       "DBTCoreProjectIntegration",
@@ -430,6 +431,7 @@ export class DBTCoreProjectIntegration implements DBTProjectIntegration {
       }
       await this.createPythonDbtProject(this.python);
       this.pythonBridgeDiagnosticsData = [];
+      this.onDiagnosticsChanged();
     } catch (exc: any) {
       if (exc instanceof PythonException) {
         // python errors can be about anything, so we just associate the error with the project file
@@ -457,6 +459,7 @@ export class DBTCoreProjectIntegration implements DBTProjectIntegration {
           category: "python-bridge",
         };
         this.pythonBridgeDiagnosticsData = [diagnosticData];
+        this.onDiagnosticsChanged();
       }
       this.dbtTerminal.error(
         "pythonBridgeInitPythonError",
@@ -540,6 +543,7 @@ export class DBTCoreProjectIntegration implements DBTProjectIntegration {
     return {
       pythonBridgeDiagnostics: this.pythonBridgeDiagnosticsData,
       rebuildManifestDiagnostics: this.rebuildManifestDiagnosticsData,
+      projectConfigDiagnostics: this.projectConfigDiagnostics,
     };
   }
 
@@ -557,6 +561,7 @@ export class DBTCoreProjectIntegration implements DBTProjectIntegration {
         (python) => python`to_dict(project.safe_parse_project())`,
       );
       this.rebuildManifestDiagnosticsData = [];
+      this.onDiagnosticsChanged();
     } catch (exc) {
       if (exc instanceof PythonException) {
         // dbt errors can be about anything, so we just associate the error with the project file
@@ -573,6 +578,7 @@ export class DBTCoreProjectIntegration implements DBTProjectIntegration {
           category: "manifest-rebuild",
         };
         this.rebuildManifestDiagnosticsData = [diagnosticData];
+        this.onDiagnosticsChanged();
         return;
       }
       this.dbtTerminal.error(
@@ -1030,6 +1036,7 @@ export class DBTCoreProjectIntegration implements DBTProjectIntegration {
     } catch (error) {} // We don't care about errors here.
     this.rebuildManifestDiagnosticsData = [];
     this.pythonBridgeDiagnosticsData = [];
+    this.onDiagnosticsChanged();
     while (this.disposables.length) {
       const x = this.disposables.pop();
       if (x) {

src/dbt_client/dbtFusionCommandIntegration.ts

@@ -512,13 +512,6 @@ export class DBTFusionCommandProjectIntegration extends DBTCloudProjectIntegrati
     return stdout;
   }
 
-  getDiagnostics(): DBTDiagnosticResult {
-    return {
-      pythonBridgeDiagnostics: this.pythonBridgeDiagnosticsData,
-      rebuildManifestDiagnostics: this.rebuildManifestDiagnosticsData,
-    };
-  }
-
   getDeferConfigDefaults(): DeferConfig {
     return {
       deferToProduction: true,

src/dbt_client/diagnostics.ts

@@ -15,6 +15,5 @@ export interface DBTDiagnosticData {
 export interface DBTDiagnosticResult {
   pythonBridgeDiagnostics: DBTDiagnosticData[];
   rebuildManifestDiagnostics: DBTDiagnosticData[];
-  // This is only available on dbtIntegrationAdapter
-  projectConfigDiagnostics?: DBTDiagnosticData[];
+  projectConfigDiagnostics: DBTDiagnosticData[];
 }

src/inversify.config.ts

@@ -392,12 +392,13 @@ container
   >("Factory<DBTCoreProjectIntegration>")
   .toFactory<
     DBTCoreProjectIntegration,
-    [string, DBTDiagnosticData[], DeferConfig | undefined]
+    [string, DBTDiagnosticData[], DeferConfig | undefined, () => void]
   >((context: interfaces.Context) => {
     return (
       projectRoot: string,
       projectConfigDiagnostics: DBTDiagnosticData[],
       deferConfig: DeferConfig | undefined,
+      onDiagnosticsChanged: () => void,
     ) => {
       const { container } = context;
       return new DBTCoreProjectIntegration(
@@ -413,6 +414,7 @@ container
         projectRoot,
         projectConfigDiagnostics,
         deferConfig,
+        onDiagnosticsChanged,
       );
     };
   });
@@ -423,12 +425,13 @@ container
   >("Factory<DBTCoreCommandProjectIntegration>")
   .toFactory<
     DBTCoreCommandProjectIntegration,
-    [string, DBTDiagnosticData[], DeferConfig]
+    [string, DBTDiagnosticData[], DeferConfig | undefined, () => void]
   >((context: interfaces.Context) => {
     return (
       projectRoot: string,
       projectConfigDiagnostics: DBTDiagnosticData[],
-      deferConfig: DeferConfig,
+      deferConfig: DeferConfig | undefined,
+      onDiagnosticsChanged: () => void,
     ) => {
       const { container } = context;
       return new DBTCoreCommandProjectIntegration(
@@ -444,6 +447,7 @@ container
         projectRoot,
         projectConfigDiagnostics,
         deferConfig,
+        onDiagnosticsChanged,
       );
     };
   });
@@ -454,12 +458,13 @@ container
   >("Factory<DBTFusionCommandProjectIntegration>")
   .toFactory<
     DBTFusionCommandProjectIntegration,
-    [string, DBTDiagnosticData[], DeferConfig]
+    [string, DBTDiagnosticData[], DeferConfig | undefined, () => void]
   >((context: interfaces.Context) => {
     return (
       projectRoot: string,
       projectConfigDiagnostics: DBTDiagnosticData[],
-      deferConfig: DeferConfig,
+      deferConfig: DeferConfig | undefined,
+      onDiagnosticsChanged: () => void,
     ) => {
       const { container } = context;
       return new DBTFusionCommandProjectIntegration(
@@ -471,6 +476,7 @@ container
         projectRoot,
         projectConfigDiagnostics,
         deferConfig,
+        onDiagnosticsChanged,
       );
     };
   });
@@ -481,12 +487,13 @@ container
   >("Factory<DBTCloudProjectIntegration>")
   .toFactory<
     DBTCloudProjectIntegration,
-    [string, DBTDiagnosticData[], DeferConfig]
+    [string, DBTDiagnosticData[], DeferConfig | undefined, () => void]
   >((context: interfaces.Context) => {
     return (
       projectRoot: string,
       projectConfigDiagnostics: DBTDiagnosticData[],
-      deferConfig: DeferConfig,
+      deferConfig: DeferConfig | undefined,
+      onDiagnosticsChanged: () => void,
     ) => {
       const { container } = context;
       return new DBTCloudProjectIntegration(
@@ -498,6 +505,7 @@ container
         projectRoot,
         projectConfigDiagnostics,
         deferConfig,
+        onDiagnosticsChanged,
       );
     };
   });

src/manifest/dbtIntegrationAdapter.ts

@@ -100,21 +100,25 @@ export class DBTIntegrationAdapter extends EventEmitter implements DBTFacade {
       projectRoot: string,
       diagnostics: DBTDiagnosticData[],
       deferConfig: DeferConfig | undefined,
+      onDiagnosticsChanged: () => void,
     ) => DBTProjectIntegration,
     private dbtCloudIntegrationFactory: (
       projectRoot: string,
       diagnostics: DBTDiagnosticData[],
       deferConfig: DeferConfig | undefined,
+      onDiagnosticsChanged: () => void,
     ) => DBTProjectIntegration,
     private dbtFusionIntegrationFactory: (
       projectRoot: string,
       diagnostics: DBTDiagnosticData[],
       deferConfig: DeferConfig | undefined,
+      onDiagnosticsChanged: () => void,
     ) => DBTProjectIntegration,
     private dbtCoreCommandIntegrationFactory: (
       projectRoot: string,
       diagnostics: DBTDiagnosticData[],
       deferConfig: DeferConfig | undefined,
+      onDiagnosticsChanged: () => void,
     ) => DBTProjectIntegration,
     private projectRoot: string,
     private deferConfig: DeferConfig | undefined,
@@ -137,30 +141,36 @@ export class DBTIntegrationAdapter extends EventEmitter implements DBTFacade {
   private createIntegration(): DBTProjectIntegration {
     const integrationMode = this.dbtConfiguration.getDbtIntegration();
 
+    const onDiagnosticsChanged = () => this.emit("diagnosticsChanged");
+
     switch (integrationMode) {
       case "cloud":
         return this.dbtCloudIntegrationFactory(
           this.projectRoot,
           this.projectConfigDiagnostics,
           this.deferConfig,
+          onDiagnosticsChanged,
         );
       case "fusion":
         return this.dbtFusionIntegrationFactory(
           this.projectRoot,
           this.projectConfigDiagnostics,
           this.deferConfig,
+          onDiagnosticsChanged,
         );
       case "corecommand":
         return this.dbtCoreCommandIntegrationFactory(
           this.projectRoot,
           this.projectConfigDiagnostics,
           this.deferConfig,
+          onDiagnosticsChanged,
         );
       default: // "core"
         return this.dbtCoreIntegrationFactory(
           this.projectRoot,
           this.projectConfigDiagnostics,
           this.deferConfig,
+          onDiagnosticsChanged,
         );
     }
   }
@@ -228,20 +238,19 @@ export class DBTIntegrationAdapter extends EventEmitter implements DBTFacade {
   }
 
   getDiagnostics() {
-    return {
-      projectConfigDiagnostics: this.projectConfigDiagnostics,
-      ...this.currentIntegration.getDiagnostics(),
-    };
+    this.currentIntegration.getDiagnostics();
   }
 
   private addProjectConfigDiagnostic(diagnostic: DBTDiagnosticData): void {
     // Add to project config diagnostics array
     this.projectConfigDiagnostics.push(diagnostic);
+    this.emit("diagnosticsChanged");
   }
 
   private clearProjectConfigDiagnostics(): void {
     // Clear project config diagnostics
     this.projectConfigDiagnostics.length = 0;
+    this.emit("diagnosticsChanged");
   }
 
   getAdapterType(): string {