fix(vscode): make work better with venvs (#4482)

Author: benfdking

.circleci/continue_config.yml

@@ -37,6 +37,36 @@ commands:
             - run: circleci-agent step halt
 
 jobs:
+  vscode_e2e_test:
+    docker:
+      - image: cimg/node:20.19.1-browsers
+    resource_class: medium
+    steps:
+      - checkout
+      - run:
+          name: Create Python venv
+          command: |
+            python -m venv venv
+            . ./venv/bin/activate
+      - run:
+          name: Install Python dependencies
+          command: |
+            python -m pip install --upgrade pip
+            make install-dev
+      - run:
+          name: Install Dependencies
+          command: |
+            pnpm install
+      - run:
+          name: Install VSCode 
+          command: |
+            cd vscode/extension
+            pnpm run fetch-vscode
+      - run:
+          name: Run VSCode extension tests
+          command: |
+            cd vscode/extension
+            pnpm run test:e2e:ci
   vscode_test:
     docker:
       - image: cimg/node:20.19.1-browsers

vscode/extension/package.json

@@ -88,6 +88,7 @@
     "test:e2e": "playwright test",
     "test:e2e:ui": "playwright test --ui",
     "test:e2e:headed": "playwright test --headed",
+    "test:e2e:ci": "xvfb-run --server-args=\"-screen 0 1280x720x24\" npx playwright test --reporter=line,junit",
     "fetch-vscode": "tsx scripts/fetch-vscode.ts",
     "compile": "pnpm run check-types && node esbuild.js",
     "check-types": "tsc --noEmit",

vscode/extension/src/utilities/common/python.ts

@@ -5,7 +5,6 @@ import { commands, Disposable, Event, EventEmitter, Uri } from 'vscode'
 import { traceError, traceLog } from './log'
 import { PythonExtension, ResolvedEnvironment } from '@vscode/python-extension'
 import path from 'path'
-import { IS_WINDOWS } from '../isWindows'
 
 export interface IInterpreterDetails {
   path?: string[]
@@ -39,15 +38,16 @@ export async function initializePython(
         api.environments.onDidChangeActiveEnvironmentPath(async e => {
           const environment = await api.environments.resolveEnvironment(e.path)
           const isVirtualEnv = environment?.environment !== undefined
-          const binPath = isVirtualEnv
-            ? environment?.environment?.folderUri.fsPath
+          // Get the directory of the Python executable for virtual environments
+          const pythonDir = environment?.executable.uri
+            ? path.dirname(environment.executable.uri.fsPath)
             : undefined
 
           onDidChangePythonInterpreterEvent.fire({
             path: [e.path],
             resource: e.resource?.uri,
             isVirtualEnvironment: isVirtualEnv,
-            binPath,
+            binPath: isVirtualEnv ? pythonDir : undefined,
           })
         }),
       )
@@ -76,17 +76,16 @@ export async function getInterpreterDetails(
   )
   if (environment?.executable.uri && checkVersion(environment)) {
     const isVirtualEnv = environment.environment !== undefined
-    const binPath = isVirtualEnv
-      ? environment.environment?.folderUri.fsPath
-      : undefined
+    // Get the directory of the Python executable
+    const pythonDir = path.dirname(environment?.executable.uri.fsPath)
 
     return {
       path: [environment?.executable.uri.fsPath],
       resource,
       isVirtualEnvironment: isVirtualEnv,
-      binPath: binPath
-        ? path.join(binPath, IS_WINDOWS ? 'Scripts' : 'bin')
-        : undefined,
+      // For virtual environments, we need to point directly to the bin directory
+      // rather than constructing it from the environment folder
+      binPath: isVirtualEnv ? pythonDir : undefined,
     }
   }
   return { path: undefined, resource }

vscode/extension/src/utilities/exec.ts

@@ -13,7 +13,7 @@ export async function execAsync(
   options: ExecOptions & { signal?: AbortSignal } = {},
 ): Promise<ExecResult> {
   const fullCmd = `${command} ${args.join(' ')}`
-  traceInfo(`Executing command: ${fullCmd}`)
+  traceInfo(`Executing command: ${fullCmd} in ${options.cwd}`)
 
   try {
     const result = await execAsyncCore(command, args, options)

vscode/extension/src/utilities/sqlmesh/sqlmesh.ts

@@ -82,7 +82,10 @@ export const isSqlmeshEnterpriseInstalled = async (): Promise<
   if (isErr(tcloudBin)) {
     return tcloudBin
   }
-  const called = await execAsync(tcloudBin.value, ['is_sqlmesh_installed'])
+  const projectRoot = await getProjectRoot()
+  const called = await execAsync(tcloudBin.value, ['is_sqlmesh_installed'], {
+    cwd: projectRoot.uri.fsPath,
+  })
   if (called.exitCode !== 0) {
     return err({
       type: 'generic',
@@ -232,7 +235,7 @@ export const sqlmeshExec = async (): Promise<
       workspacePath,
       env: {
         PYTHONPATH: interpreterDetails.path?.[0],
-        VIRTUAL_ENV: path.dirname(interpreterDetails.binPath!),
+        VIRTUAL_ENV: path.dirname(path.dirname(interpreterDetails.binPath!)), // binPath now points to bin dir
         PATH: interpreterDetails.binPath!,
       },
       args: [],
@@ -349,8 +352,8 @@ export const sqlmeshLspExec = async (): Promise<
       workspacePath,
       env: {
         PYTHONPATH: interpreterDetails.path?.[0],
-        VIRTUAL_ENV: path.dirname(interpreterDetails.binPath!),
-        PATH: path.join(path.dirname(interpreterDetails.binPath!), 'bin'),
+        VIRTUAL_ENV: path.dirname(path.dirname(interpreterDetails.binPath!)), // binPath now points to bin dir
+        PATH: interpreterDetails.binPath!, // binPath already points to the bin directory
       },
       args: [],
     })