feat(vscode): allow configuring project path

Author: benfdking

vscode/extension/src/utilities/config.ts

@@ -16,7 +16,6 @@ export interface SqlmeshConfiguration {
 export function getSqlmeshConfiguration(): SqlmeshConfiguration {
   const config = workspace.getConfiguration('sqlmesh')
   const projectPath = config.get<string>('projectPath', '')
-
   return {
     projectPath,
   }

vscode/extension/tests/lineage.spec.ts

@@ -14,52 +14,8 @@ const SUSHI_SOURCE_PATH = path.join(__dirname, '..', '..', '..', 'examples', 'su
  * Helper function to launch VS Code and test lineage with given project path config
  */
 async function testLineageWithProjectPath(
-  workspaceDir: string,
-  projectDir: string,
-  projectPathConfig?: string
+  window: Page,
 ): Promise<void> {
-  const ciArgs = process.env.CI ? [
-    '--disable-gpu',
-    '--headless',
-    '--no-sandbox',
-    '--disable-dev-shm-usage',
-    '--window-position=-10000,0',
-  ] : [];
-  
-  const userDataDir = await fs.mkdtemp(path.join(os.tmpdir(), 'vscode-user-data-'));
-  
-  try {
-    // If projectPathConfig is provided, create .vscode/settings.json in the workspace
-    if (projectPathConfig !== undefined) {
-      const vscodeDir = path.join(workspaceDir, '.vscode');
-      await fs.ensureDir(vscodeDir);
-      const settings = {
-        "sqlmesh.projectPath": projectPathConfig
-      };
-      await fs.writeJson(path.join(vscodeDir, 'settings.json'), settings, { spaces: 2 });
-    }
-    
-    const args = [
-      ...ciArgs,
-      `--extensionDevelopmentPath=${EXT_PATH}`,
-      '--disable-workspace-trust',
-      '--disable-telemetry',
-      `--user-data-dir=${userDataDir}`,
-      workspaceDir,
-    ];
-    
-    const electronApp = await electron.launch({
-      executablePath: VS_CODE_EXE,
-      args,
-    });
-
-    const window = await electronApp.firstWindow();
-    await window.waitForLoadState('domcontentloaded');
-    await window.waitForLoadState('networkidle');
-    
-    // Wait a bit for the extension to fully initialize with the settings
-    await window.waitForTimeout(2000);
-
     // Trigger lineage command
     await window.keyboard.press(process.platform === 'darwin' ? 'Meta+Shift+P' : 'Control+Shift+P');
     await window.keyboard.type('Lineage: Focus On View');
@@ -68,56 +24,95 @@ async function testLineageWithProjectPath(
     // Wait for "Loaded SQLmesh Context" text to appear
     const loadedContextText = window.locator('text=Loaded SQLMesh Context');
     await expect(loadedContextText.first()).toBeVisible({ timeout: 15000 });
+}
 
+/**
+ * Launch VS Code and return the window and a function to close the app.
+ * @param workspaceDir The workspace directory to open.
+ * @returns The window and a function to close the app.
+ */
+export const startVSCode = async (workspaceDir: string): Promise<{
+  window: Page,
+  close: () => Promise<void>,
+}> => {
+  const userDataDir = await fs.mkdtemp(path.join(os.tmpdir(), 'vscode-user-data-'));
+  const ciArgs = process.env.CI ? [
+    '--disable-gpu',
+    '--headless',
+    '--no-sandbox',
+    '--disable-dev-shm-usage',
+    '--window-position=-10000,0',
+  ] : [];
+  const args = [
+    ...ciArgs,
+    `--extensionDevelopmentPath=${EXT_PATH}`,
+    '--disable-workspace-trust',
+    '--disable-telemetry',
+    `--user-data-dir=${userDataDir}`,
+    workspaceDir,
+  ];
+  const electronApp = await electron.launch({
+    executablePath: VS_CODE_EXE,
+    args,
+  });
+  const window = await electronApp.firstWindow();
+  await window.waitForLoadState('domcontentloaded');
+  await window.waitForLoadState('networkidle');
+  await window.waitForTimeout(2000);
+  return { window, close: async () => {
     await electronApp.close();
-  } finally {
     await fs.remove(userDataDir);
-  }
-}
-
-export const startVSCode = async (workspaceDir: string) => {
-  
+  } };
 }
 
 test('Lineage panel renders correctly - no project path config (default)', async () => {
   const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'vscode-test-sushi-'));
   await fs.copy(SUSHI_SOURCE_PATH, tempDir);
-
   try {
-    await testLineageWithProjectPath(tempDir, tempDir);
-  } finally {
+  const { window, close } = await startVSCode(tempDir);
+  await testLineageWithProjectPath(window);
+    await close();
+  } finally { 
     await fs.remove(tempDir);
   }
 });
 
 test('Lineage panel renders correctly - relative project path', async () => {
-  // Create workspace directory with subdirectory containing the project
   const workspaceDir = await fs.mkdtemp(path.join(os.tmpdir(), 'vscode-test-workspace-'));
-  const projectSubdir = path.join(workspaceDir, 'projects', 'sushi');
-  await fs.ensureDir(path.dirname(projectSubdir));
-  await fs.copy(SUSHI_SOURCE_PATH, projectSubdir);
+  const projectDir = path.join(workspaceDir, 'projects', 'sushi');
+  await fs.copy(SUSHI_SOURCE_PATH, projectDir);
+
+  const settings = {
+    "sqlmesh.projectPath": path.relative(workspaceDir, projectDir),
+  };
+  await fs.ensureDir(path.join(workspaceDir, '.vscode'));
+  await fs.writeJson(path.join(workspaceDir, '.vscode', 'settings.json'), settings, { spaces: 2 });
 
   try {
-    // Test with relative path
-    await testLineageWithProjectPath(workspaceDir, projectSubdir, 'projects/sushi');
+    const { window, close } = await startVSCode(workspaceDir);
+    await testLineageWithProjectPath(window);
+    await close();
   } finally {
     await fs.remove(workspaceDir);
   }
 });
 
 test('Lineage panel renders correctly - absolute project path', async () => {
-  // Create workspace directory
   const workspaceDir = await fs.mkdtemp(path.join(os.tmpdir(), 'vscode-test-workspace-'));
-  
-  // Create project directory outside workspace
-  const projectDir = await fs.mkdtemp(path.join(os.tmpdir(), 'vscode-test-sushi-project-'));
+  const projectDir = path.join(workspaceDir, 'projects', 'sushi');
+  await fs.ensureDir(path.join(workspaceDir, '.vscode'));
   await fs.copy(SUSHI_SOURCE_PATH, projectDir);
+  await fs.ensureDir(path.join(workspaceDir, '.vscode'));
+  const settings = {
+    "sqlmesh.projectPath": projectDir,
+  };
+  await fs.writeJson(path.join(workspaceDir, '.vscode', 'settings.json'), settings, { spaces: 2 });
 
   try {
-    // Test with absolute path
-    await testLineageWithProjectPath(workspaceDir, projectDir, projectDir);
+    const { window, close } = await startVSCode(workspaceDir);
+    await testLineageWithProjectPath(window);
+    await close();
   } finally {
     await fs.remove(workspaceDir);
-    await fs.remove(projectDir);
   }
 });