feat(vscode): showing config errors to users

[ci skip]

Author: benfdking

pnpm-lock.yaml

@@ -91,6 +91,7 @@ def load_config_from_paths(
             "SQLMesh project config could not be found. Point the cli to the project path with `sqlmesh -p`. If you haven't set up the SQLMesh project, run `sqlmesh init`."
         )
 
+    yaml_config_path: t.Optional[Path] = None
     for path in [*project_paths, *personal_paths]:
         if not path.exists():
             continue
@@ -107,8 +108,9 @@ def load_config_from_paths(
         if extension in ("yml", "yaml"):
             if config_name != "config" and not python_config:
                 raise ConfigError(
-                    "YAML configs do not support multiple configs. Use Python instead."
+                    "YAML configs do not support multiple configs. Use Python instead.",
                 )
+            yaml_config_path = path.resolve()
             non_python_configs.append(load_config_from_yaml(path))
         elif extension == "py":
             try:
@@ -118,11 +120,12 @@ def load_config_from_paths(
             except ValidationError as e:
                 raise ConfigError(
                     validation_error_message(e, f"Invalid project config '{config_name}':")
-                    + "\n\nVerify your config.py."
+                    + "\n\nVerify your config.py.",
+                    location=full_path,
                 )
         else:
             raise ConfigError(
-                f"Unsupported config file extension '{extension}' in config file '{path}'."
+                f"Unsupported config file extension '{extension}' in config file '{path}'.",
             )
 
     if load_from_env:
@@ -149,7 +152,8 @@ def load_config_from_paths(
     except ValidationError as e:
         raise ConfigError(
             validation_error_message(e, "Invalid project config:")
-            + "\n\nVerify your config.yaml and environment variables."
+            + "\n\nVerify your config.yaml and environment variables.",
+            location=yaml_config_path,
         )
 
     no_dialect_err_msg = "Default model SQL dialect is a required configuration parameter. Set it in the `model_defaults` `dialect` key in your config file."

sqlmesh/core/config/loader.py

@@ -779,7 +779,7 @@ def _get_diagnostics_for_uri(self, uri: URI) -> t.Tuple[t.List[types.Diagnostic]
             return LSPContext.diagnostics_to_lsp_diagnostics(diagnostics), 0
         except ConfigError as config_error:
             diagnostic, error = context_error_to_diagnostic(config_error, uri_filter=uri)
-            if diagnostic:
+            if diagnostic and diagnostic[0] == uri.value:
                 return [diagnostic[1]], 0
             return [], 0
 

sqlmesh/lsp/main.py

@@ -138,6 +138,7 @@
     "fs-extra": "^11.3.0",
     "vscode-jsonrpc": "^8.2.1",
     "vscode-languageclient": "^9.0.1",
+    "yaml": "^2.8.0",
     "zod": "^3.25.71"
   },
   "devDependencies": {

vscode/extension/package.json

@@ -2,8 +2,15 @@ import { test, expect } from './fixtures'
 import fs from 'fs-extra'
 import os from 'os'
 import path from 'path'
-import { openLineageView, saveFile, SUSHI_SOURCE_PATH } from './utils'
+import {
+  openLineageView,
+  runCommand,
+  saveFile,
+  SUSHI_SOURCE_PATH,
+} from './utils'
 import { createPythonInterpreterSettingsSpecifier } from './utils_code_server'
+import { execAsync } from '../src/utilities/exec'
+import yaml from 'yaml'
 
 test('bad project, double model', async ({ page, sharedCodeServer }) => {
   const tempDir = await fs.mkdtemp(
@@ -253,3 +260,80 @@ test('bad project, double model, check lineage', async ({
 
   await page.waitForTimeout(500)
 })
+
+const setup = async (tempDir: string) => {
+  // Run the sqlmesh CLI from the root of the repo using the local path
+  const sqlmeshCliPath = path.resolve(__dirname, '../../../.venv/bin/sqlmesh')
+  const result = await execAsync(sqlmeshCliPath, ['init', 'duckdb'], {
+    cwd: tempDir,
+  })
+  expect(result.exitCode).toBe(0)
+}
+
+test.describe('Bad config.py/config.yaml file issues', () => {
+  test('sqlmesh init, then corrupted config.yaml, invalid yaml', async ({
+    page,
+    sharedCodeServer,
+  }) => {
+    const tempDir = await fs.mkdtemp(
+      path.join(os.tmpdir(), 'vscode-test-tcloud-'),
+    )
+    await setup(tempDir)
+
+    const configYamlPath = path.join(tempDir, 'config.yaml')
+    // Write an invalid YAML to config.yaml
+    await fs.writeFile(configYamlPath, 'invalid_yaml:;asdfasudfy [1, 2, 3')
+    await createPythonInterpreterSettingsSpecifier(tempDir)
+    await page.goto(
+      `http://127.0.0.1:${sharedCodeServer.codeServerPort}/?folder=${tempDir}`,
+    )
+    await page.waitForLoadState('networkidle')
+  })
+  // Load the page
+
+  test('sqlmesh init, then corrupted config.yaml, bad parameters', async ({
+    page,
+    sharedCodeServer,
+  }) => {
+    const tempDir = await fs.mkdtemp(
+      path.join(os.tmpdir(), 'vscode-test-tcloud-'),
+    )
+    await setup(tempDir)
+    await createPythonInterpreterSettingsSpecifier(tempDir)
+
+    const configYamlPath = path.join(tempDir, 'config.yaml')
+    // Write an invalid YAML to config.yaml
+    const config = {
+      gateway: 'test',
+    }
+    // Write config to the yaml file
+    await fs.writeFile(configYamlPath, yaml.stringify(config))
+
+    await page.goto(
+      `http://127.0.0.1:${sharedCodeServer.codeServerPort}/?folder=${tempDir}`,
+    )
+    await page.waitForLoadState('networkidle')
+
+    // Open full_model.sql model
+    await page
+      .getByRole('treeitem', { name: 'models', exact: true })
+      .locator('a')
+      .click()
+    await page
+      .getByRole('treeitem', { name: 'full_model.sql', exact: true })
+      .locator('a')
+      .click()
+
+    // Wait for the error to appear
+    await page.waitForSelector('text=Error creating context')
+
+    // Open the problems view
+    await runCommand(page, 'View: Focus Problems')
+
+    // Asser that the error is present in the problems view
+    await page
+      .getByText('Invalid project config:', { exact: true })
+      .isVisible({ timeout: 1_000 })
+    await page.getByText('Invalid project config:', { exact: true }).click()
+  })
+})