refactor: move PythonEnvironment to manifest and split into provider/interface

Author: mdesmet

src/commands/index.ts

@@ -41,7 +41,7 @@ import {
   ConversationProvider,
   ConversationCommentThread,
 } from "../comment_provider/conversationProvider";
-import { PythonEnvironment } from "../dbt_integration/pythonEnvironment";
+import { PythonEnvironment } from "../manifest/pythonEnvironment";
 import { DBTClient } from "../dbt_client";
 import { existsSync, readFileSync } from "fs";
 import { DBTProject } from "../manifest/dbtProject";
@@ -70,7 +70,7 @@ export class VSCodeCommands implements Disposable {
     private diagnosticsOutputChannel: DiagnosticsOutputChannel,
     private eventEmitterService: SharedStateService,
     private conversationController: ConversationProvider,
-    @inject("PythonEnvironment")
+    @inject(PythonEnvironment)
     private pythonEnvironment: PythonEnvironment,
     private dbtClient: DBTClient,
     private sqlLineagePanel: SQLLineagePanel,

src/commands/walkthroughCommands.ts

@@ -10,7 +10,7 @@ import { DBTProjectContainer } from "../manifest/dbtProjectContainer";
 import { TelemetryService } from "../telemetry";
 import { ProjectQuickPickItem } from "../quickpick/projectQuickPick";
 import { CommandProcessExecutionFactory } from "../dbt_integration/commandProcessExecution";
-import { PythonEnvironment } from "../dbt_integration/pythonEnvironment";
+import { PythonEnvironment } from "../manifest/pythonEnvironment";
 import { DBTTerminal } from "../dbt_integration/terminal";
 import { inject } from "inversify";
 
@@ -31,7 +31,7 @@ export class WalkthroughCommands {
     private dbtProjectContainer: DBTProjectContainer,
     private telemetry: TelemetryService,
     private commandProcessExecutionFactory: CommandProcessExecutionFactory,
-    @inject("PythonEnvironment")
+    @inject(PythonEnvironment)
     private pythonEnvironment: PythonEnvironment,
     @inject("DBTTerminal")
     private dbtTerminal: DBTTerminal,

src/dbt_client/datapilot.ts

@@ -1,5 +1,5 @@
 import { provideSingleton } from "../utils";
-import { PythonEnvironment } from "../dbt_integration/pythonEnvironment";
+import { PythonEnvironment } from "../manifest/pythonEnvironment";
 import { CommandProcessExecutionFactory } from "../dbt_integration/commandProcessExecution";
 import { DBTTerminal } from "../dbt_integration/terminal";
 import { DBTConfiguration } from "../dbt_integration/configuration";
@@ -9,7 +9,7 @@ import { inject } from "inversify";
 export class AltimateDatapilot {
   private packageName = "altimate-datapilot-cli";
   constructor(
-    @inject("PythonEnvironment")
+    @inject(PythonEnvironment)
     private pythonEnvironment: PythonEnvironment,
     private commandProcessExecutionFactory: CommandProcessExecutionFactory,
     @inject("DBTTerminal")

src/dbt_client/index.ts

@@ -1,5 +1,5 @@
 import { commands, Disposable, EventEmitter, window, workspace } from "vscode";
-import { PythonEnvironment } from "../dbt_integration/pythonEnvironment";
+import { PythonEnvironment } from "../manifest/pythonEnvironment";
 import { provideSingleton } from "../utils";
 import { DBTInstallationVerificationEvent } from "./dbtVersionEvent";
 import { existsSync } from "fs";
@@ -29,7 +29,7 @@ export class DBTClient implements Disposable {
   ];
   private shownError = false;
   constructor(
-    @inject("PythonEnvironment")
+    @inject(PythonEnvironment)
     private pythonEnvironment: PythonEnvironment,
     @inject("Factory<DBTDetection>")
     private dbtDetectionFactory: () => DBTDetection,

src/dbt_integration/dbtCloudIntegration.ts

@@ -20,15 +20,15 @@ import { PythonBridge } from "python-bridge";
 import { join, dirname } from "path";
 import path = require("path");
 import { DBTTerminal } from "./terminal";
-import { PythonEnvironment } from "./pythonEnvironment";
+import { RuntimePythonEnvironment } from "./pythonEnvironment";
 import { existsSync, readFileSync } from "fs";
 import semver = require("semver");
 import { NodeMetaData } from "./domain";
 import * as crypto from "crypto";
 import { parse } from "yaml";
 
 export function getDBTPath(
-  pythonEnvironment: PythonEnvironment,
+  pythonEnvironment: RuntimePythonEnvironment,
   terminal: DBTTerminal,
 ): string {
   if (pythonEnvironment.pythonPath) {
@@ -52,7 +52,7 @@ export function getDBTPath(
 export class DBTCloudDetection implements DBTDetection {
   constructor(
     protected commandProcessExecutionFactory: CommandProcessExecutionFactory,
-    protected pythonEnvironment: PythonEnvironment,
+    protected pythonEnvironment: RuntimePythonEnvironment,
     protected terminal: DBTTerminal,
   ) {}
 
@@ -133,7 +133,7 @@ export class DBTCloudProjectIntegration implements DBTProjectIntegration {
       path: string,
       dbtPath: string,
     ) => DBTCommandExecutionStrategy,
-    private pythonEnvironment: PythonEnvironment,
+    private pythonEnvironment: RuntimePythonEnvironment,
     protected terminal: DBTTerminal,
     protected projectRoot: string,
     private projectConfigDiagnostics: DBTDiagnosticData[],
@@ -148,14 +148,15 @@ export class DBTCloudProjectIntegration implements DBTProjectIntegration {
       this.projectRoot,
     );
 
-    this.disposables.push(
-      this.pythonEnvironment.onPythonEnvironmentChanged(() => {
-        this.python = this.executionInfrastructure.createPythonBridge(
-          this.projectRoot,
-        );
-        this.initializeProject();
-      }),
-    );
+    // TODO: Re-implement python environment change handling through PythonEnvironmentProvider
+    // this.disposables.push(
+    //   this.pythonEnvironment.onPythonEnvironmentChanged(() => {
+    //     this.python = this.executionInfrastructure.createPythonBridge(
+    //       this.projectRoot,
+    //     );
+    //     this.initializeProject();
+    //   }),
+    // );
   }
 
   async refreshProjectConfig(): Promise<void> {

src/dbt_integration/dbtCoreIntegration.ts

@@ -21,7 +21,7 @@ import {
   DeferConfig,
   ManifestPathType,
 } from "./dbtIntegration";
-import { PythonEnvironment } from "./pythonEnvironment";
+import { RuntimePythonEnvironment } from "./pythonEnvironment";
 import { CommandProcessExecutionFactory } from "./commandProcessExecution";
 import { PythonBridge, PythonException } from "python-bridge";
 import * as path from "path";
@@ -86,7 +86,7 @@ export interface ProjectHealthcheck {
 
 export class DBTCoreDetection implements DBTDetection {
   constructor(
-    private pythonEnvironment: PythonEnvironment,
+    private pythonEnvironment: RuntimePythonEnvironment,
     private commandProcessExecutionFactory: CommandProcessExecutionFactory,
   ) {}
 
@@ -207,7 +207,7 @@ export class DBTCoreProjectIntegration implements DBTProjectIntegration {
 
   constructor(
     private executionInfrastructure: DBTCommandExecutionInfrastructure,
-    protected pythonEnvironment: PythonEnvironment,
+    protected pythonEnvironment: RuntimePythonEnvironment,
     private pythonDBTCommandExecutionStrategy: PythonDBTCommandExecutionStrategy,
     protected cliDBTCommandExecutionStrategyFactory: (
       path: string,
@@ -229,13 +229,14 @@ export class DBTCoreProjectIntegration implements DBTProjectIntegration {
       this.projectRoot,
     );
 
-    this.disposables.push(
-      this.pythonEnvironment.onPythonEnvironmentChanged(() => {
-        this.python = this.executionInfrastructure.createPythonBridge(
-          this.projectRoot,
-        );
-      }),
-    );
+    // TODO: Re-implement python environment change handling through PythonEnvironmentProvider
+    // this.disposables.push(
+    //   this.pythonEnvironment.onPythonEnvironmentChanged(() => {
+    //     this.python = this.executionInfrastructure.createPythonBridge(
+    //       this.projectRoot,
+    //     );
+    //   }),
+    // );
   }
 
   // remove the trailing slashes if they exists,

src/dbt_integration/dbtFusionCommandIntegration.ts

@@ -15,13 +15,13 @@ import { DBTCloudProjectIntegration, getDBTPath } from "./dbtCloudIntegration";
 import { DBTConfiguration } from "./configuration";
 import path, { join } from "path";
 import { CommandProcessExecutionFactory } from "./commandProcessExecution";
-import { PythonEnvironment } from "./pythonEnvironment";
+import { RuntimePythonEnvironment } from "./pythonEnvironment";
 import { DBTTerminal } from "./terminal";
 
 export class DBTFusionCommandDetection implements DBTDetection {
   constructor(
     protected commandProcessExecutionFactory: CommandProcessExecutionFactory,
-    protected pythonEnvironment: PythonEnvironment,
+    protected pythonEnvironment: RuntimePythonEnvironment,
     protected terminal: DBTTerminal,
     protected dbtConfiguration: DBTConfiguration,
   ) {}

src/dbt_integration/dbtIntegration.ts

@@ -4,7 +4,7 @@ import {
   CommandProcessExecutionFactory,
   CommandProcessResult,
 } from "./commandProcessExecution";
-import { PythonEnvironment } from "./pythonEnvironment";
+import { RuntimePythonEnvironment } from "./pythonEnvironment";
 import { existsSync, readFileSync } from "fs";
 import { DBTTerminal } from "./terminal";
 import { NodeMetaData } from "./domain";
@@ -148,7 +148,7 @@ export class CLIDBTCommandExecutionStrategy
 {
   constructor(
     protected commandProcessExecutionFactory: CommandProcessExecutionFactory,
-    protected pythonEnvironment: PythonEnvironment,
+    protected pythonEnvironment: RuntimePythonEnvironment,
     protected terminal: DBTTerminal,
     protected cwd: string,
     protected dbtPath: string,
@@ -213,7 +213,7 @@ export class PythonDBTCommandExecutionStrategy
 {
   constructor(
     private commandProcessExecutionFactory: CommandProcessExecutionFactory,
-    private pythonEnvironment: PythonEnvironment,
+    private pythonEnvironment: RuntimePythonEnvironment,
     private terminal: DBTTerminal,
     private configuration: DBTConfiguration,
   ) {}
@@ -485,7 +485,7 @@ export interface DBTProjectIntegration {
 
 export class DBTCommandExecutionInfrastructure {
   constructor(
-    private pythonEnvironment: PythonEnvironment,
+    private pythonEnvironment: RuntimePythonEnvironment,
     private terminal: DBTTerminal,
   ) {}
 

src/dbt_integration/pythonEnvironment.ts

@@ -1,16 +1,13 @@
-import { Event, Uri } from "vscode";
 import { EnvironmentVariables } from "./domain";
 
-export interface PythonEnvironment {
-  readonly allPythonPaths: { path: string; pathType: string }[];
-  readonly isPython3: boolean;
+export interface RuntimePythonEnvironment {
   readonly pythonPath: string;
   readonly environmentVariables: EnvironmentVariables;
-  readonly onPythonEnvironmentChanged: Event<Uri | undefined>;
-
-  initialize(): Promise<void>;
-  printEnvVars(): Promise<void>;
-  getResolvedConfigValue(key: string): string;
+}
 
-  dispose(): Promise<void>;
+export interface PythonEnvironmentProvider {
+  getCurrentEnvironment(): RuntimePythonEnvironment;
+  onEnvironmentChanged(
+    callback: (environment: RuntimePythonEnvironment) => void,
+  ): void;
 }

src/document_formatting_edit_provider/dbtDocumentFormattingEditProvider.ts

@@ -17,7 +17,7 @@ import {
   provideSingleton,
 } from "../utils";
 import { TelemetryService } from "../telemetry";
-import { PythonEnvironment } from "../dbt_integration/pythonEnvironment";
+import { PythonEnvironment } from "../manifest/pythonEnvironment";
 import path from "path";
 import fs from "fs";
 import { inject } from "inversify";
@@ -29,7 +29,7 @@ export class DbtDocumentFormattingEditProvider
   constructor(
     private commandProcessExecutionFactory: CommandProcessExecutionFactory,
     private telemetry: TelemetryService,
-    @inject("PythonEnvironment")
+    @inject(PythonEnvironment)
     private pythonEnvironment: PythonEnvironment,
   ) {}