feat: project governance custom config

dbt_healthcheck.py

@@ -1,5 +1,7 @@
+from typing import Optional
+
 def project_healthcheck(
-    manifest_path, catalog_path=None, config_path=None, config=None
+    manifest_path, catalog_path=None, config_path=None, config=None, token=None, tenant=None, backend_url: Optional[str] = None,
 ):
     try:
         import logging
@@ -20,6 +22,9 @@ def project_healthcheck(
             manifest=manifest,
             catalog=catalog,
             config=config,
+            token=token,
+            instance_name=tenant,
+            backend_url=backend_url,
         )
         reports = insight_generator.run()
 
@@ -28,6 +33,8 @@ def project_healthcheck(
             k: [json.loads(item.json()) for item in v]
             for k, v in reports[MODEL].items()
         }
+
         return {"model_insights": model_insights}
+
     except Exception as e:
         raise Exception(str(e))

src/altimate.ts

@@ -335,7 +335,7 @@ export interface ConversationGroup {
 
 @provideSingleton(AltimateRequest)
 export class AltimateRequest {
-  private static ALTIMATE_URL = workspace
+  public static ALTIMATE_URL = workspace
     .getConfiguration("dbt")
     .get<string>("altimateUrl", "https://api.myaltimate.com");
 

src/dbt_client/dbtCloudIntegration.ts

@@ -206,6 +206,7 @@ export class DBTCloudProjectIntegration
     private validationProvider: ValidationProvider,
     private deferToProdService: DeferToProdService,
     private projectRoot: Uri,
+    private altimateRequest: AltimateRequest,
   ) {
     this.terminal.debug(
       "DBTCloudProjectIntegration",
@@ -1189,7 +1190,7 @@ export class DBTCloudProjectIntegration
     this.throwBridgeErrorIfAvailable();
     const result = await this.python?.lock<ProjectHealthcheck>(
       (python) =>
-        python!`to_dict(project_healthcheck(${manifestPath}, ${catalogPath}, ${configPath}, ${config}))`,
+        python!`to_dict(project_healthcheck(${manifestPath}, ${catalogPath}, ${configPath}, ${config}, ${this.altimateRequest.getAIKey()}, ${this.altimateRequest.getInstanceName()}, ${AltimateRequest.ALTIMATE_URL}))`,
     );
     return result;
   }

src/dbt_client/dbtCoreIntegration.ts

@@ -1155,7 +1155,7 @@ export class DBTCoreProjectIntegration
       await healthCheckThread.ex`from dbt_healthcheck import *`;
       const result = await healthCheckThread.lock<ProjectHealthcheck>(
         (python) =>
-          python!`to_dict(project_healthcheck(${manifestPath}, ${catalogPath}, ${configPath}, ${config}))`,
+          python!`to_dict(project_healthcheck(${manifestPath}, ${catalogPath}, ${configPath}, ${config}, ${this.altimateRequest.getAIKey()}, ${this.altimateRequest.getInstanceName()}, ${AltimateRequest.ALTIMATE_URL}))`,
       );
       return result;
     } finally {

src/inversify.config.ts

@@ -143,6 +143,7 @@ container
         container.get(ValidationProvider),
         container.get(DeferToProdService),
         projectRoot,
+        container.get(AltimateRequest),
       );
     };
   });

src/webview_provider/insightsPanel.ts

@@ -561,27 +561,45 @@ export class InsightsPanel extends AltimateWebviewProvider {
       args: JSON.stringify(args),
     });
     try {
-      await window.withProgress(
-        {
-          title: `Performing healthcheck...`,
-          location: ProgressLocation.Notification,
-          cancellable: false,
-        },
-        async () => {
-          const projectHealthcheck =
-            await this.dbtProjectContainer.executeAltimateDatapilotHealthcheck(
-              args,
-            );
-          this._panel!.webview.postMessage({
-            command: "response",
-            args: {
-              syncRequestId,
-              body: { projectHealthcheck },
-              status: true,
-            },
-          });
-        },
+      window.showInformationMessage(
+        "Started performing healthcheck. We will notify you once it's done.",
       );
+
+      const projectHealthcheck =
+        await this.dbtProjectContainer.executeAltimateDatapilotHealthcheck(
+          args,
+        );
+      if (this._panel?.visible) {
+        window.showInformationMessage("Healthcheck completed successfully.");
+        this._panel!.webview.postMessage({
+          command: "response",
+          args: {
+            syncRequestId,
+            body: { projectHealthcheck },
+            status: true,
+          },
+        });
+        return;
+      }
+      const result = await window.showInformationMessage(
+        "Healthcheck completed successfully.",
+        "View results",
+      );
+      if (result === "View results") {
+        this.dbtTerminal.debug(
+          "InsightsPanel",
+          "Sending healthcheck results to webview",
+        );
+        await commands.executeCommand("dbtPowerUser.Insights.focus");
+      }
+      this._panel!.webview.postMessage({
+        command: "response",
+        args: {
+          syncRequestId,
+          body: { projectHealthcheck },
+          status: true,
+        },
+      });
     } catch (e) {
       this.emitError(
         syncRequestId,

webview_panels/.storybook/preview.tsx

@@ -8,6 +8,12 @@ import { decorator as VsCodeDecorator } from "./__mocks__/vscode";
 import AppProvider from "../src/modules/app/AppProvider";
 
 const theme = "vscode-dark"; // vscode-light
+const css = `
+    .sb-show-main.vscode-dark {
+      --vscode-panel-background: #1e1e1e;
+    }
+`;
+
 const preview: Preview = {
   decorators: [
     (story) => {
@@ -17,6 +23,7 @@ const preview: Preview = {
     VsCodeDecorator,
     (Story) => (
       <AppProvider>
+        <style>{css}</style>
         <Story />
       </AppProvider>
     ),

webview_panels/src/lib/altimate/altimate-components.d.ts

@@ -3,6 +3,7 @@ import { ButtonHTMLAttributes } from 'react';
 import { ButtonProps } from 'reactstrap';
 import { CaseReducerActions } from '@reduxjs/toolkit';
 import { ChatMessage } from '@ant-design/pro-chat';
+import { ComponentType } from 'react';
 import { Dispatch } from 'react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { PayloadAction } from '@reduxjs/toolkit';
@@ -66,9 +67,16 @@ export declare interface CoachAiResponse {
     personalizationScope: string;
 }
 
-export declare const CoachForm: ({ taskLabel, context, onClose, extra }: Props_10) => JSX_2.Element;
+export declare const CoachForm: (props: CoachFormProps) => JSX_2.Element;
 
-export declare const CoachFormButton: ({}: Props_11) => JSX_2.Element;
+export declare const CoachFormButton: ({}: Props_10) => JSX_2.Element;
+
+declare interface CoachFormProps {
+    taskLabel: keyof typeof TaskLabels;
+    context?: Record<string, unknown>;
+    extra?: Record<string, unknown>;
+    onClose: (data?: unknown) => void;
+}
 
 export declare const CodeBlock: ({ code, language, fileName, editorTheme, theme, showLineNumbers, className, titleActions, }: Props_4) => JSX.Element;
 
@@ -206,7 +214,7 @@ export declare const IconButton: (props: Props) => JSX.Element;
 export declare interface Learning extends z.infer<typeof learningSchema> {
 }
 
-export declare const Learnings: ({ filters, learning }: Props_12) => JSX_2.Element;
+export declare const Learnings: ({ filters, learning }: Props_11) => JSX_2.Element;
 
 export declare const learningSchema: z.ZodObject<{
     train_doc_uid: z.ZodString;
@@ -282,28 +290,74 @@ export declare enum PersonalizationScope {
     ALL_USERS = "AllUsers"
 }
 
+export declare enum ProjectGovernorAllowedFiles {
+    Manifest = "Manifest",
+    Catalog = "Catalog"
+}
+
+export declare interface ProjectGovernorCheck extends z.infer<typeof ProjectGovernorCheckSchema> {
+    id: string;
+}
+
+export declare interface ProjectGovernorCheckConfirmationResponse {
+    ok: boolean;
+}
+
+export declare interface ProjectGovernorCheckFormValues {
+    description: string;
+    type: ProjectGovernorCheckTypes;
+}
+
+export declare const ProjectGovernorCheckSchema: z.ZodObject<{
+    name: z.ZodString;
+    alias: z.ZodString;
+    type: z.ZodEnum<[string, ...string[]]>;
+    description: z.ZodString;
+    files_required: z.ZodArray<z.ZodEnum<[string, ...string[]]>, "many">;
+    config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    name: string;
+    description: string;
+    alias: string;
+    files_required: string[];
+    config: Record<string, unknown>;
+}, {
+    type: string;
+    name: string;
+    description: string;
+    alias: string;
+    files_required: string[];
+    config: Record<string, unknown>;
+}>;
+
+export declare enum ProjectGovernorCheckTypes {
+    DOCUMENTATION = "documentation",
+    TESTS = "tests",
+    MODEL = "model",
+    FILE_STRUCTURE = "file_structure"
+}
+
+export declare interface ProjectGovernorCheckValidateResponse {
+    name: string;
+    description: string;
+}
+
 declare interface Props extends ButtonHTMLAttributes<HTMLButtonElement> {
     color?: string;
 }
 
 declare interface Props_10 {
-    taskLabel: keyof typeof TaskLabels;
-    context?: Record<string, unknown>;
-    extra?: Record<string, unknown>;
-    onClose: () => void;
 }
 
 declare interface Props_11 {
-}
-
-declare interface Props_12 {
     filters?: {
         taskLabel?: keyof typeof TaskLabels;
     };
     learning?: string | null;
 }
 
-declare interface Props_13 {
+declare interface Props_12 {
     onSelect: (selected: (typeof TeamMatesConfig)[0], action: TeamMateActionType) => Promise<boolean | undefined>;
     client: keyof typeof TeamMateAvailability;
 }
@@ -437,7 +491,8 @@ export declare enum TaskLabels {
     DocGen = "DocGen",
     ChartBot = "ChartBot",
     SqlBot = "SqlExpert",
-    OpportunitiesBot = "OpportunitiesBot"
+    OpportunitiesBot = "OpportunitiesBot",
+    ProjectGovernor = "ProjectGovernor"
 }
 
 export declare const TeammateActions: CaseReducerActions<    {
@@ -463,6 +518,8 @@ export declare interface TeamMateConfig {
     key: TaskLabels;
     seeInAction?: boolean;
     comingSoon?: boolean;
+    displayComponent?: ComponentType<any>;
+    formComponent?: ComponentType<any>;
 }
 
 export declare interface TeamMateContextProps {
@@ -474,7 +531,7 @@ export declare const TeamMateProvider: ({ children, }: {
     children: ReactNode;
 }) => JSX.Element;
 
-export declare const TeamMates: ({ onSelect, client }: Props_13) => JSX_2.Element;
+export declare const TeamMates: ({ onSelect, client }: Props_12) => JSX_2.Element;
 
 export declare const TeamMatesConfig: TeamMateConfig[];
 

webview_panels/src/lib/altimate/altimate-components.js

@@ -1,34 +1,37 @@
-import { A as o, B as t, m as n, p as i, o as r, q as C, n as m, t as T, v as l, C as c, F as p, k as g, i as v, h as L, D as u, I as h, y as B, l as M, L as d, P as A, G as b, K as k, J as y, r as F, z as P, E as x, x as D, T as I, H as S, w as f } from "./main.js";
+import { A as s, B as t, m as n, p as r, o as i, q as C, n as c, t as m, v as l, C as T, F as p, k as v, i as g, h, D as L, I as u, y as M, l as P, L as d, P as k, N as A, O as B, M as y, G as F, K as G, J as b, r as S, z as j, E as x, x as D, T as I, H as f, w } from "./main.js";
 import "reactstrap";
 export {
-  o as ApiHelper,
+  s as ApiHelper,
   t as Badge,
   n as CLL,
-  i as ChatTriggerLink,
-  r as Chatbot,
+  r as ChatTriggerLink,
+  i as Chatbot,
   C as Citations,
-  m as CllEvents,
-  T as CoachForm,
+  c as CllEvents,
+  m as CoachForm,
   l as CoachFormButton,
-  c as CodeBlock,
+  T as CodeBlock,
   p as ContentCategory,
-  g as ConversationGroupProvider,
-  v as ConversationInputForm,
-  L as ConversationSources,
-  u as DbtDocs,
-  h as IconButton,
-  B as Learnings,
-  M as Lineage,
+  v as ConversationGroupProvider,
+  g as ConversationInputForm,
+  h as ConversationSources,
+  L as DbtDocs,
+  u as IconButton,
+  M as Learnings,
+  P as Lineage,
   d as LoadingButton,
-  A as PersonalizationScope,
-  b as TaskLabels,
-  k as TeamMateActionType,
-  y as TeamMateAvailability,
-  F as TeamMateProvider,
-  P as TeamMates,
+  k as PersonalizationScope,
+  A as ProjectGovernorAllowedFiles,
+  B as ProjectGovernorCheckSchema,
+  y as ProjectGovernorCheckTypes,
+  F as TaskLabels,
+  G as TeamMateActionType,
+  b as TeamMateAvailability,
+  S as TeamMateProvider,
+  j as TeamMates,
   x as TeamMatesConfig,
   D as TeammateActions,
   I as Tooltip,
-  S as learningSchema,
-  f as useTeamMateContext
+  f as learningSchema,
+  w as useTeamMateContext
 };