fix(vscode): render models without descriptions (#4593)

Author: benfdking

sqlmesh/lsp/custom.py

@@ -36,7 +36,7 @@ class RenderModelEntry(PydanticModel):
 
     name: str
     fqn: str
-    description: str
+    description: t.Optional[str] = None
     rendered_query: str
 
 

vscode/extension/src/commands/renderModel.ts

@@ -42,10 +42,10 @@ export function renderModel(lspClient?: LSPClient) {
     // If multiple models, let user choose
     let selectedModel: RenderModelEntry
     if (result.value.models.length > 1) {
-      const items = result.value.models.map((model: RenderModelEntry) => ({
+      const items = result.value.models.map(model => ({
         label: model.name,
         description: model.fqn,
-        detail: model.description,
+        detail: model.description ? model.description : undefined,
         model: model,
       }))
 

vscode/extension/src/lsp/custom.ts

@@ -21,7 +21,7 @@ interface RenderModelResponse {
 export interface RenderModelEntry {
   name: string
   fqn: string
-  description: string
+  description: string | null | undefined
   rendered_query: string
 }
 

vscode/extension/tests/render.spec.ts

@@ -35,4 +35,37 @@ test('Render works correctly', async () => {
     } finally {
       await fs.remove(tempDir);
     }
-  });
+  });
+
+test('Render works correctly with model without a description', async () => {
+  const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'vscode-test-sushi-'));
+  await fs.copy(SUSHI_SOURCE_PATH, tempDir);
+
+  try {
+    const { window, close } = await startVSCode(tempDir);
+
+    //   Wait for the models folder to be visible
+    await window.waitForSelector('text=models');
+
+    // Click on the models folder, excluding external_models
+    await window.getByRole('treeitem', { name: 'models', exact: true }).locator('a').click();
+
+    // Open the latest_order model
+    await window.getByRole('treeitem', { name: 'latest_order.sql', exact: true }).locator('a').click();
+
+    await window.waitForSelector('text=custom_full_with_custom_kind');
+    await window.waitForSelector('text=Loaded SQLMesh Context')
+
+    // Render the model
+    await window.keyboard.press(process.platform === 'darwin' ? 'Meta+Shift+P' : 'Control+Shift+P');
+    await window.keyboard.type('Render Model');
+    await window.keyboard.press('Enter');
+
+    // Check if the model is rendered correctly
+    await expect(window.locator('text="orders"."id" AS "id",')).toBeVisible();
+
+    await close();
+  } finally {
+    await fs.remove(tempDir);
+  }
+});

vscode/extension/tests/utils.ts

@@ -40,6 +40,8 @@ export const startVSCode = async (workspaceDir: string): Promise<{
       args,
     });
     const window = await electronApp.firstWindow();
+    await window.waitForLoadState('domcontentloaded');
+    await window.waitForLoadState('networkidle');
     return { window, close: async () => {
       await electronApp.close();
       await fs.removeSync(userDataDir);