Merge pull request #430 from Couchbase-Ecosystem/DA-597-add-sdk-doctor-to-vs-code-extension

AayushTyagi1 · web-flow · commit 405f556f7175 · 2024-10-25T12:58:25.000+05:30
DA-597 add sdk doctor to vs code extension
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "vscode-couchbase",
   "displayName": "Couchbase",
   "description": "",
-  "version": "2.1.6",
+  "version": "2.1.7",
   "engines": {
     "vscode": "^1.63.1"
   },
@@ -1323,5 +1323,4 @@
       }
     ]
   }
-}
-
+}
diff --git a/src/handlers/dependenciesUtil.ts b/src/handlers/dependenciesUtil.ts
@@ -18,6 +18,9 @@ class DependenciesUtil {
     public static readonly CBIMPORT_EXPORT_VERSION =
         config.CBIMPORT_EXPORT_VERSION;
 
+    public static readonly SDK_DOCTOR_VERSION = config.SDK_DOCTOR_VERSION;
+    public static readonly SDK_DOCTOR_KEY = config.SDK_DOCTOR_KEY;
+
     public static createVersioningFile(directoryPath: string): void {
         const filePath = path.join(
             directoryPath,
diff --git a/src/handlers/handleCLIDownloader.ts b/src/handlers/handleCLIDownloader.ts
@@ -21,6 +21,7 @@ class DependenciesDownloader {
     private readonly TOOL_IMPORT_EXPORT = "import_export";
     private readonly ALL_TOOLS = "all_tools";
     private readonly TOOL_MDB_MIGRATE = "cb_migrate";
+    private readonly SDK_DOCTOR = "sdk-doctor";
 
     private getToolInstallPath(toolKey: string): string {
         if (toolKey === this.TOOL_SHELL) {
@@ -31,14 +32,18 @@ class DependenciesDownloader {
             return "cbmigrate";
         } else if (toolKey === this.ALL_TOOLS) {
             return "cbtools";
-        } else {
+        } else if(toolKey === this.SDK_DOCTOR) {
+            return "sdk-doctor";
+        }
+         else {
             throw new Error("Not Implemented yet");
         }
     }
 
     private getToolsMap(toolKey: string, os: string): Map<CBToolsType, string> {
         const suffix = os.includes("mac") || os.includes("linux") ? "" : ".exe";
         const pathPrefix = "bin" + path.sep;
+        console.log(toolKey);
 
         const map = new Map<CBToolsType, string>();
 
@@ -64,6 +69,8 @@ class DependenciesDownloader {
                 CBToolsType.MCTIMINGS,
                 path.join(pathPrefix, "mctimings" + suffix)
             );
+        } else if (toolKey === this.SDK_DOCTOR) {
+            map.set(CBToolsType.SDK_DOCTOR, 'sdk-doctor'+ suffix);
         } else {
             throw new Error("Not implemented yet");
         }
@@ -80,6 +87,38 @@ class DependenciesDownloader {
     }
     public getDownloadList(os: string): Map<string, ToolSpec> {
         const map = new Map<string, ToolSpec>();
+        // SDK Doctor Download configuration
+        if (os === OSUtil.MACOS_64 || os === OSUtil.MACOS_ARM) {
+            map.set(
+                this.SDK_DOCTOR,
+                this.getToolSpec(
+                    "https://intellij-plugin-dependencies.s3.us-east-2.amazonaws.com/sdkdoctor/1.0.8-sdk-doctor-macos.zip",
+                    this.SDK_DOCTOR,
+                    os
+                )
+            );
+        } else if (os === OSUtil.WINDOWS_64 || os === OSUtil.WINDOWS_ARM) {
+            map.set(
+                this.SDK_DOCTOR,
+                this.getToolSpec(
+                    "https://intellij-plugin-dependencies.s3.us-east-2.amazonaws.com/sdkdoctor/1.0.8-sdk-doctor-windows.zip",
+                    this.SDK_DOCTOR,
+                    os
+                )
+            );
+        } else if (os === OSUtil.LINUX_64 || os === OSUtil.LINUX_ARM) {
+            map.set(
+                this.SDK_DOCTOR,
+                this.getToolSpec(
+                    "https://intellij-plugin-dependencies.s3.us-east-2.amazonaws.com/sdkdoctor/1.0.8-sdk-doctor-linux.zip",
+                    this.SDK_DOCTOR,
+                    os
+                )
+            );
+        } else {
+            throw new Error("OS not supported.");
+        }
+        // CB Tools Download configuration
         if (os === OSUtil.MACOS_64) {
             map.set(
                 this.TOOL_SHELL,
@@ -283,7 +322,7 @@ class DependenciesDownloader {
     ) {
         logger.info("Cleaning up older tools versions if update required");
         const shell: ToolSpec | undefined = downloads.get(this.TOOL_SHELL);
-        if (shell == undefined) {
+        if (shell === undefined) {
             return;
         }
         // Checks if CB shell is installed and requires update by comparing current version of tool with version config value
@@ -307,7 +346,7 @@ class DependenciesDownloader {
 
         }
         const cbimport_export: ToolSpec | undefined = downloads.get(this.TOOL_IMPORT_EXPORT);
-        if (cbimport_export == undefined) {
+        if (cbimport_export === undefined) {
             return;
         }
         // Checks if CB Import/Export is installed and requires update by comparing current version of tool with version config value
@@ -347,6 +386,7 @@ class DependenciesDownloader {
         this.manageShellInstallation(downloads, toolsPath, extensionPath);
         this.manageCbMigrateInstallation(downloads, toolsPath, extensionPath);
         this.manageDataImportExportInstallation(downloads, toolsPath, extensionPath);
+        this.manageSdkDoctorInstallation(downloads, toolsPath, extensionPath); 
     };
 
     private setToolActive(
@@ -524,6 +564,39 @@ class DependenciesDownloader {
         }
     }
 
+    public manageSdkDoctorInstallation(
+        downloads: Map<string, ToolSpec>,
+        toolsPath: string,
+        extensionPath: string
+    ): void {
+        const sdkDoctor = downloads.get(this.SDK_DOCTOR);
+        if (sdkDoctor === undefined) {
+            return;
+        }
+        const sdkDoctorPath = path.join(toolsPath, sdkDoctor.getInstallationPath());
+        const sdkDoctorTool = CBTools.getTool(CBToolsType.SDK_DOCTOR);
+        const sdkDoctorStatus = sdkDoctorTool.status;
+        const sdkDoctorDownloadsMap = downloads.get(this.SDK_DOCTOR);
+        if (sdkDoctorDownloadsMap === undefined) {
+            return;
+        }
+        if (
+            sdkDoctorStatus === ToolStatus.NOT_AVAILABLE &&
+            !this.isInstalled(
+                toolsPath,
+                sdkDoctorDownloadsMap,
+                CBToolsType.SDK_DOCTOR
+            )
+        ) {
+            logger.info("Downloading SDK Doctor.");
+            sdkDoctorTool.status = ToolStatus.DOWNLOADING;
+            this.downloadAndUnzip(sdkDoctorPath, sdkDoctor, extensionPath, DependenciesUtil.SDK_DOCTOR_KEY, DependenciesUtil.SDK_DOCTOR_VERSION);
+        } else {
+            logger.debug("SDK Doctor is already installed");
+            this.setToolActive(ToolStatus.AVAILABLE, sdkDoctorPath, sdkDoctor);
+        }
+    }
+
     // This is a test function, keeping this here to check for any specific downloaded CLI tool
     /* public runFile(targetDir:string) {
          const scriptPath = path.join(targetDir, 'cbsh');
diff --git a/src/handlers/versionConfig.ts b/src/handlers/versionConfig.ts
@@ -8,4 +8,6 @@ export const config = {
     CBMIGRATE_VERSION: "2",
     SHELL_VERSION: "1.0.0",
     CBIMPORT_EXPORT_VERSION: "7.6",
+    SDK_DOCTOR_VERSION: "1.0.8",
+    SDK_DOCTOR_KEY: "sdk-doctor",
 };
diff --git a/src/tools/SDKDocterRunner.ts b/src/tools/SDKDocterRunner.ts
@@ -0,0 +1,67 @@
+import * as childProcess from 'child_process';
+import { CBTools, ToolStatus, Type } from '../util/DependencyDownloaderUtils/CBTool';
+
+export class SdkDoctorRunner {
+    static async run(
+        host: string,
+        ssl: boolean,
+        bucket: string,
+        username: string,
+        password: string,
+        outputCallback: (line: string) => void
+    ): Promise<void> {
+        try {
+            const sdkDoctorTool = CBTools.getTool(Type.SDK_DOCTOR);
+            if (sdkDoctorTool.status !== ToolStatus.AVAILABLE) {
+                throw new Error('SDK Doctor is not available. Please ensure it is installed.');
+            }
+
+            const sdkDoctorExecutable = sdkDoctorTool.path;
+            const clusterUrl = SdkDoctorRunner.adjustClusterProtocol(host, ssl);
+            const args = [
+                'diagnose',
+                `${clusterUrl}/${bucket}`,
+                '-u', username,
+                '-p', password
+            ];
+
+            const process = childProcess.spawn(sdkDoctorExecutable, args);
+
+            process.stdout.on('data', (data) => {
+                const lines = data.toString().split('\n');
+                lines.forEach((line: string) => {
+                    if (line.trim()) {
+                        outputCallback(line.trim());
+                    }
+                });
+            });
+
+            process.stderr.on('data', (data) => {
+                console.error(`SDK Doctor error: ${data}`);
+            });
+
+            await new Promise<void>((resolve, reject) => {
+                process.on('close', (code) => {
+                    if (code !== 0) {
+                        console.warn(`SDK Doctor exited with code ${code}`);
+                    }
+                    resolve();
+                });
+
+                process.on('error', (err) => {
+                    reject(err);
+                });
+            });
+
+        } catch (error) {
+            console.error('Error while running the SDK Doctor', error);
+        }
+    }
+
+    private static adjustClusterProtocol(host: string, ssl: boolean): string {
+        const protocol = ssl ? 'couchbases://' : 'couchbase://';
+        return host.startsWith('couchbase://') || host.startsWith('couchbases://') 
+            ? host 
+            : `${protocol}${host}`;
+    }
+}
diff --git a/src/util/DependencyDownloaderUtils/CBTool.ts b/src/util/DependencyDownloaderUtils/CBTool.ts
@@ -20,7 +20,8 @@ export enum Type {
     CB_EXPORT = "CB_EXPORT",
     CBC_PILLOW_FIGHT = "CBC_PILLOW_FIGHT",
     MCTIMINGS = "MCTIMINGS",
-    CB_MIGRATE = "CB_MIGRATE"
+    CB_MIGRATE = "CB_MIGRATE",
+    SDK_DOCTOR = "SDK_DOCTOR"
 }
 
 
diff --git a/src/util/connections.ts b/src/util/connections.ts
@@ -27,6 +27,7 @@ import { CouchbaseRestAPI } from "./apis/CouchbaseRestAPI";
 import { hasQueryService, hasSearchService } from "./common";
 import { SecretService } from "./secretService";
 import ConnectionEvents from "./events/connectionEvents";
+import { SdkDoctorRunner } from "../tools/SDKDocterRunner";
 
 export function getConnectionId(connection: IConnection) {
   const { url, username } = connection;
@@ -151,6 +152,43 @@ export async function addConnection(clusterConnectionTreeProvider: ClusterConnec
         currentPanel.dispose();
         break;
 
+      case 'testConnection':
+        const { connectionUrl, username, password, bucketName, isSecure } = message;
+        if(bucketName === "") {
+        try {
+          await connect(connectionUrl, { username: username, password: password, configProfile: 'wanDevelopment' });
+          currentPanel.webview.postMessage({
+            command: 'testConnectionResult',
+            result: 'Connection was successfull!'
+        });
+        }
+        catch (err) {
+          currentPanel.webview.postMessage({
+            command: 'testConnectionResult',
+            result: '[ERRO]: Connection Failed ' + err
+        });
+        }
+        return;
+      }
+        const results: string[] = [];
+
+        await SdkDoctorRunner.run(
+            connectionUrl,
+            isSecure,
+            bucketName,
+            username,
+            password,
+            (line) => {
+                results.push(line);
+            }
+        );
+
+        currentPanel.webview.postMessage({
+            command: 'testConnectionResult',
+            result: results.join('\n')
+        });
+        break;
+
       default:
         console.error('Unrecognized command');
     }
@@ -163,10 +201,11 @@ async function handleConnectionError(err: any) {
   if (err instanceof AuthenticationFailureError) {
     answer = await vscode.window.showErrorMessage(`
     Authentication Failed: Please check your credentials and try again \n
-    If you're still having difficulty, please check out this helpful troubleshooting link`, { modal: true }, "Troubleshoot Link");
+    or inform a Bucket on Troubleshooting to inspect your connection \n
+    or check out this helpful troubleshooting link`, { modal: true }, "Troubleshoot Link");
   }
   else {
-    answer = await vscode.window.showErrorMessage(`Could not establish a connection \n ${err} \n If you're having difficulty, please check out this helpful troubleshooting link`, { modal: true }, "Troubleshoot Link");
+    answer = await vscode.window.showErrorMessage(`Could not establish a connection \n ${err} \n Inform a Bucket on Troubleshooting to inspect your connection \n or check out this helpful troubleshooting link`, { modal: true }, "Troubleshoot Link");
   }
 
   if (answer === "Troubleshoot Link") {
diff --git a/src/webViews/connectionScreen.webview.ts b/src/webViews/connectionScreen.webview.ts

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`"name": "vscode-couchbase",`
`3`	`3`	`"displayName": "Couchbase",`
`4`	`4`	`"description": "",`
`5`		`- "version": "2.1.6",`
	`5`	`+ "version": "2.1.7",`
`6`	`6`	`"engines": {`
`7`	`7`	`"vscode": "^1.63.1"`
`8`	`8`	`},`
`@@ -1323,5 +1323,4 @@`
`1323`	`1323`	`}`
`1324`	`1324`	`]`
`1325`	`1325`	`}`
`1326`		`-}`
`1327`		`-`
	`1326`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,8 @@ export enum Type {`
`20`	`20`	`CB_EXPORT = "CB_EXPORT",`
`21`	`21`	`CBC_PILLOW_FIGHT = "CBC_PILLOW_FIGHT",`
`22`	`22`	`MCTIMINGS = "MCTIMINGS",`
`23`		`- CB_MIGRATE = "CB_MIGRATE"`
	`23`	`+ CB_MIGRATE = "CB_MIGRATE",`
	`24`	`+ SDK_DOCTOR = "SDK_DOCTOR"`
`24`	`25`	`}`
`25`	`26`
`26`	`27`