chore(vscode): handle tcloud not being present better (#4424)

Author: benfdking

vscode/extension/src/auth/auth.ts

@@ -14,6 +14,7 @@ import { execAsync } from '../utilities/exec'
 import { getProjectRoot } from '../utilities/common/utilities'
 import z from 'zod'
 import { traceError } from '../utilities/common/log'
+import { ErrorType } from '../utilities/errors'
 
 export const AUTH_TYPE = 'tobikodata'
 export const AUTH_NAME = 'Tobiko'
@@ -70,11 +71,11 @@ export class AuthenticationProviderTobikoCloud
    * Get the status of the authentication provider from the cli
    * @returns true if the user is logged in with the id token, false otherwise
    */
-  private async get_status(): Promise<Result<StatusResponse, string>> {
+  private async get_status(): Promise<Result<StatusResponse, ErrorType>> {
     const workspacePath = await getProjectRoot()
     const tcloudBin = await getTcloudBin()
     if (isErr(tcloudBin)) {
-      return err(tcloudBin.error)
+      return tcloudBin
     }
     const tcloudBinPath = tcloudBin.value
     const result = await execAsync(
@@ -85,7 +86,10 @@ export class AuthenticationProviderTobikoCloud
       },
     )
     if (result.exitCode !== 0) {
-      return err('Failed to get tcloud auth status')
+      return err({
+        type: 'generic',
+        message: 'Failed to get tcloud auth status',
+      })
     }
     const status = result.stdout
     const statusToJson: any = JSON.parse(status)

vscode/extension/src/commands/format.ts

@@ -7,6 +7,7 @@ import {
   handleNotSginedInError,
   handleSqlmeshLspNotFoundError,
   handleSqlmeshLspDependenciesMissingError,
+  handleTcloudBinNotFoundError,
 } from '../utilities/errors'
 import { AuthenticationProviderTobikoCloud } from '../auth/auth'
 import { execAsync } from '../utilities/exec'
@@ -27,6 +28,9 @@ export const format =
         case 'sqlmesh_lsp_dependencies_missing':
           await handleSqlmeshLspDependenciesMissingError(out.error)
           return
+        case 'tcloud_bin_not_found':
+          await handleTcloudBinNotFoundError()
+          return
         case 'generic':
           await vscode.window.showErrorMessage(
             `Project format failed: ${out.error.message}`,

vscode/extension/src/extension.ts

@@ -17,6 +17,7 @@ import {
   handleNotSginedInError,
   handleSqlmeshLspNotFoundError,
   handleSqlmeshLspDependenciesMissingError,
+  handleTcloudBinNotFoundError,
 } from './utilities/errors'
 import { selector, completionProvider } from './completion/completion'
 import { LineagePanel } from './webviews/lineagePanel'
@@ -94,6 +95,9 @@ export async function activate(context: vscode.ExtensionContext) {
           case 'sqlmesh_lsp_dependencies_missing':
             await handleSqlmeshLspDependenciesMissingError(restartResult.error)
             return
+          case 'tcloud_bin_not_found':
+            await handleTcloudBinNotFoundError()
+            return 
           case 'generic':
             await vscode.window.showErrorMessage(
               `Failed to restart LSP: ${restartResult.error.message}`,
@@ -129,6 +133,9 @@ export async function activate(context: vscode.ExtensionContext) {
       case 'sqlmesh_lsp_dependencies_missing':
         await handleSqlmeshLspDependenciesMissingError(result.error)
         break
+      case 'tcloud_bin_not_found':
+        await handleTcloudBinNotFoundError()
+        break
       case 'generic':
         await vscode.window.showErrorMessage(
           `Failed to start LSP: ${result.error.message}`,

vscode/extension/src/utilities/errors.ts

@@ -10,6 +10,9 @@ export type ErrorType =
   | { type: 'generic'; message: string }
   | { type: 'not_signed_in' }
   | { type: 'sqlmesh_lsp_not_found' }
+  // tcloud_bin_not_found is used when the tcloud executable is not found. This is likely to happen if the user 
+  // opens a project that has a `tcloud.yaml` file but doesn't have tcloud installed.
+  | { type: 'tcloud_bin_not_found' }
   // sqlmesh_lsp_dependencies_missing is used when the sqlmesh_lsp is found but the lsp extras are missing.
   | SqlmeshLspDependenciesMissingError
 
@@ -73,3 +76,21 @@ export const handleSqlmeshLspDependenciesMissingError = async (
     }
   }
 }
+
+/**
+ * Handles the case where the tcloud executable is not found.
+ */
+export const handleTcloudBinNotFoundError = async (): Promise<void> => {
+  const result = await window.showErrorMessage(
+    'tcloud executable not found, please check installation',
+    'Install',
+  )
+  if (result === 'Install') {
+    const terminal = window.createTerminal({
+      name: 'Tcloud Install',
+      hideFromUser: false,
+    })
+    terminal.show()
+    terminal.sendText("pip install tcloud", false)
+  }
+}

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

@@ -28,24 +28,36 @@ export interface SqlmeshExecInfo {
 export const isTcloudProject = async (): Promise<Result<boolean, string>> => {
   const projectRoot = await getProjectRoot()
   const tcloudYamlPath = path.join(projectRoot.uri.fsPath, 'tcloud.yaml')
-  if (fs.existsSync(tcloudYamlPath)) {
+  const isTcloudYamlFilePresent = fs.existsSync(tcloudYamlPath)
+  if (isTcloudYamlFilePresent) {
+    traceVerbose(`tcloud yaml file present at : ${tcloudYamlPath}`)
     return ok(true)
   }
-  return isPythonModuleInstalled('tcloud')
+  const isTcloudInstalled = await isPythonModuleInstalled('tcloud')
+  if (isErr(isTcloudInstalled)) {
+    return isTcloudInstalled
+  }
+  traceVerbose(`tcloud is installed: ${isTcloudInstalled.value}`)
+  return ok(isTcloudInstalled.value)
 }
 
 /**
  * Get the tcloud executable for the current Python environment.
  *
  * @returns The tcloud executable for the current Python environment.
  */
-export const getTcloudBin = async (): Promise<Result<string, string>> => {
+export const getTcloudBin = async (): Promise<Result<string, ErrorType>> => {
   const interpreterDetails = await getInterpreterDetails()
   if (!interpreterDetails.path) {
-    return err('No Python interpreter found')
+    return err({
+      type: 'tcloud_bin_not_found',
+    })
   }
   const pythonPath = interpreterDetails.path[0]
   const binPath = path.join(path.dirname(pythonPath), 'tcloud')
+  if (!fs.existsSync(binPath)) {
+    return err({type: 'tcloud_bin_not_found'})
+  }
   return ok(binPath)
 }
 
@@ -59,24 +71,26 @@ const isSqlmeshInstalledSchema = z.object({
  * @returns A Result indicating whether sqlmesh enterprise is installed and updated.
  */
 export const isSqlmeshEnterpriseInstalled = async (): Promise<
-  Result<boolean, string>
+  Result<boolean, ErrorType>
 > => {
   traceInfo('Checking if sqlmesh enterprise is installed')
   const tcloudBin = await getTcloudBin()
   if (isErr(tcloudBin)) {
-    return err(tcloudBin.error)
+    return tcloudBin
   }
   const called = await execAsync(tcloudBin.value, ['is_sqlmesh_installed'])
   if (called.exitCode !== 0) {
-    return err(
-      `Failed to check if sqlmesh enterprise is installed: ${called.stderr}`,
-    )
+    return err({
+      type: 'generic',
+      message: `Failed to check if sqlmesh enterprise is installed: ${called.stderr}`,
+    })
   }
   const parsed = isSqlmeshInstalledSchema.safeParse(JSON.parse(called.stdout))
   if (!parsed.success) {
-    return err(
-      `Failed to parse sqlmesh enterprise installation status: ${parsed.error.message}`,
-    )
+    return err({
+      type: 'generic',
+      message: `Failed to parse sqlmesh enterprise installation status: ${parsed.error.message}`,
+    })
   }
   return ok(parsed.data.is_installed)
 }
@@ -88,16 +102,19 @@ export const isSqlmeshEnterpriseInstalled = async (): Promise<
  */
 export const installSqlmeshEnterprise = async (
   abortController: AbortController,
-): Promise<Result<boolean, string>> => {
+): Promise<Result<boolean, ErrorType>> => {
   const tcloudBin = await getTcloudBin()
   if (isErr(tcloudBin)) {
-    return err(tcloudBin.error)
+    return tcloudBin
   }
   const called = await execAsync(tcloudBin.value, ['install_sqlmesh'], {
     signal: abortController.signal,
   })
   if (called.exitCode !== 0) {
-    return err(`Failed to install sqlmesh enterprise: ${called.stderr}`)
+    return err({
+      type: 'generic',
+      message: `Failed to install sqlmesh enterprise: ${called.stderr}`,
+    })
   }
   return ok(true)
 }
@@ -109,12 +126,12 @@ export const installSqlmeshEnterprise = async (
  * @returns A Result indicating whether sqlmesh enterprise was installed in the call.
  */
 export const ensureSqlmeshEnterpriseInstalled = async (): Promise<
-  Result<boolean, string>
+  Result<boolean, ErrorType>
 > => {
   traceInfo('Ensuring sqlmesh enterprise is installed')
   const isInstalled = await isSqlmeshEnterpriseInstalled()
   if (isErr(isInstalled)) {
-    return err(isInstalled.error)
+    return isInstalled
   }
   if (isInstalled.value) {
     traceInfo('Sqlmesh enterprise is installed')
@@ -180,10 +197,7 @@ export const sqlmeshExec = async (): Promise<
     if (isTcloudInstalled.value) {
       const tcloudBin = await getTcloudBin()
       if (isErr(tcloudBin)) {
-        return err({
-          type: 'generic',
-          message: tcloudBin.error,
-        })
+        return tcloudBin
       }
       const isSignedIn = await isSignedIntoTobikoCloud()
       if (!isSignedIn) {
@@ -193,10 +207,7 @@ export const sqlmeshExec = async (): Promise<
       }
       const ensured = await ensureSqlmeshEnterpriseInstalled()
       if (isErr(ensured)) {
-        return err({
-          type: 'generic',
-          message: ensured.error,
-        })
+        return ensured
       }
       return ok({
         bin: `${tcloudBin.value} sqlmesh`,
@@ -303,10 +314,7 @@ export const sqlmeshLspExec = async (): Promise<
       traceLog('Tcloud installed, installing sqlmesh')
       const tcloudBin = await getTcloudBin()
       if (isErr(tcloudBin)) {
-        return err({
-          type: 'generic',
-          message: tcloudBin.error,
-        })
+        return tcloudBin
       }
       const isSignedIn = await isSignedIntoTobikoCloud()
       if (!isSignedIn) {
@@ -316,10 +324,7 @@ export const sqlmeshLspExec = async (): Promise<
       }
       const ensured = await ensureSqlmeshEnterpriseInstalled()
       if (isErr(ensured)) {
-        return err({
-          type: 'generic',
-          message: ensured.error,
-        })
+        return ensured
       }
     }
     const ensuredDependencies = await ensureSqlmeshLspDependenciesInstalled()