feat(vscode): ability to stop server (#4775)

Author: benfdking

vscode/extension/package.json

@@ -93,6 +93,11 @@
         "title": "SQLMesh: Render Model",
         "description": "SQLMesh",
         "icon": "$(open-preview)"
+      },
+      {
+        "command": "sqlmesh.stop",
+        "title": "SQLMesh: Stop Server",
+        "description": "SQLMesh"
       }
     ],
     "menus": {

vscode/extension/src/commands/stop.ts

@@ -0,0 +1,18 @@
+import { window } from 'vscode'
+import { LSPClient } from '../lsp/lsp'
+import { traceInfo } from '../utilities/common/log'
+
+export const stop = (lspClient: LSPClient | undefined) => {
+  return async () => {
+    traceInfo('Stopping LSP server')
+
+    if (!lspClient) {
+      await window.showInformationMessage('LSP server is not running')
+      return
+    }
+
+    await lspClient.stop()
+    await window.showInformationMessage('LSP server stopped')
+    traceInfo('LSP server stopped successfully')
+  }
+}

vscode/extension/src/extension.ts

@@ -13,6 +13,7 @@ import { signOut } from './commands/signout'
 import { signIn } from './commands/signin'
 import { signInSpecifyFlow } from './commands/signinSpecifyFlow'
 import { renderModel, reRenderModelForSourceFile } from './commands/renderModel'
+import { stop } from './commands/stop'
 import { isErr } from '@bus/result'
 import { handleError } from './utilities/errors'
 import { selector, completionProvider } from './completion/completion'
@@ -159,6 +160,7 @@ export async function activate(context: vscode.ExtensionContext) {
     registerCommand(`sqlmesh.restart`, async () => {
       await restart()
     }),
+    registerCommand(`sqlmesh.stop`, stop(lspClient)),
   )
 
   const result = await lspClient.start()

vscode/extension/tests/stop.spec.ts

@@ -0,0 +1,57 @@
+import path from 'path'
+import { startVSCode, SUSHI_SOURCE_PATH } from './utils'
+import os from 'os'
+import { test } from '@playwright/test'
+import fs from 'fs-extra'
+
+test('Stop server works', 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 customer_revenue_lifetime model
+    await window
+      .getByRole('treeitem', { name: 'customers.sql', exact: true })
+      .locator('a')
+      .click()
+
+    await window.waitForSelector('text=grain')
+    await window.waitForSelector('text=Loaded SQLMesh Context')
+
+    // Stop the server
+    await window.keyboard.press(
+      process.platform === 'darwin' ? 'Meta+Shift+P' : 'Control+Shift+P',
+    )
+    await window.keyboard.type('SQLMesh: Stop Server')
+    await window.keyboard.press('Enter')
+
+    // Await LSP server stopped message
+    await window.waitForSelector('text=LSP server stopped')
+
+    // 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')
+
+    // Await error message
+    await window.waitForSelector(
+      'text="Failed to render model: LSP client not ready."',
+    )
+    await close()
+  } finally {
+    await fs.remove(tempDir)
+  }
+})