Adds error handling for file not found in workspace (AST-68623) (#1105)

* Adds error handling for file not found in workspace

* move string to constant file.

* Fix comment

* Refactors error handling in WebViewCommand

* Get GPT configurations func

---------

Co-authored-by: galactica <[email protected]>

Author: cx-sarah-chen

src/commands/webViewCommand.ts

@@ -334,7 +334,6 @@ export class WebViewCommand {
           await this.startSastGpt(
             "Start chat",
             username,
-            detailsDetachedView.getAskKicsUserIcon(),
             detailsDetachedView.getAskKicsIcon(),
             gptResult
           );
@@ -429,6 +428,9 @@ export class WebViewCommand {
       result.vulnerabilityName
     )
       .then((messages) => {
+
+        this.handleSystemNotFindPathError(messages[0].responses[0], "Please ensure that you have opened the correct workspace or the relevant file.");
+        
         this.conversationId = messages[0].conversationId;
         // enable all the buttons and inputs
         this.detailsPanel?.webview.postMessage({
@@ -492,6 +494,8 @@ export class WebViewCommand {
       this.conversationId
     )
       .then((messages) => {
+        this.handleSystemNotFindPathError(messages[0].responses[0], constants.systemNotFindPathError);
+
         this.conversationId = messages[0].conversationId;
         // enable all the buttons and inputs
         this.detailsPanel?.webview.postMessage({
@@ -526,7 +530,6 @@ export class WebViewCommand {
   async startSastGpt(
     userMessage: string,
     user: string,
-    userKicsIcon,
     kicsIcon,
     result: GptResult
   ) {
@@ -554,6 +557,8 @@ export class WebViewCommand {
 
     cx.runSastGpt(userMessage, result.filename, result.resultID, "")
       .then((messages) => {
+        this.handleSystemNotFindPathError(messages[0].responses[0], constants.systemNotFindPathError);
+
         this.conversationId = messages[0].conversationId;
         // enable all the buttons and inputs
         this.detailsPanel?.webview.postMessage({
@@ -580,11 +585,17 @@ export class WebViewCommand {
             user: `${constants.aiSecurityChampion}`,
           },
           thinkID: this.thinkID,
-          icon: kicsIcon,
+          icon: "https://" + kicsIcon.authority + kicsIcon.path,
         });
       });
   }
 
+  handleSystemNotFindPathError(response: string, errorMessage: string): void {
+    if (response.includes(errorMessage)) {
+      throw new Error(constants.gptFileNotInWorkspaceError);
+    }
+  }
+
   sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
   }

src/cx/cx.ts

@@ -47,14 +47,10 @@ export class Cx implements CxPlatform {
   ) {
     const resultsFilePath = getResultsFilePath();
     const cx = new CxWrapper(await this.getAstConfiguration());
-    const gptToken = vscode.workspace
-      .getConfiguration(constants.gptCommandName)
-      .get(constants.gptSettingsKey) as string;
-    const gptEngine = vscode.workspace
-      .getConfiguration(constants.gptCommandName)
-      .get(constants.gptEngineKey) as string;
-    const filePackageObjectList = vscode.workspace.workspaceFolders;
-    if (filePackageObjectList.length > 0) {
+    const { gptToken, gptEngine } = this.getGptConfig();
+     
+      this.validateWorkspaceFolders();
+
       const answer = await cx.sastChat(
         gptToken,
         filePath,
@@ -69,7 +65,7 @@ export class Cx implements CxPlatform {
       } else {
         throw new Error(answer.status);
       }
-    }
+    
   }
 
   async runGpt(
@@ -80,30 +76,45 @@ export class Cx implements CxPlatform {
     queryName: string
   ) {
     const cx = new CxWrapper(await this.getAstConfiguration());
+    const { gptToken, gptEngine } = this.getGptConfig();
+
+    this.validateWorkspaceFolders();
+
+    const answer = await cx.kicsChat(
+      gptToken,
+      filePath,
+      line,
+      severity,
+      queryName,
+      message,
+      null,
+      gptEngine
+    );
+    if (answer.payload && answer.exitCode === 0) {
+      return answer.payload;
+    } else {
+      throw new Error(answer.status);
+    }
+  }
+
+  private validateWorkspaceFolders() {
+    const filePackageObjectList = vscode.workspace.workspaceFolders;
+
+    if (!filePackageObjectList || filePackageObjectList.length <= 0) {
+      throw new Error(constants.gptFileNotInWorkspaceError);
+    }
+  }
+
+   getGptConfig(): { gptToken: string; gptEngine: string } {
     const gptToken = vscode.workspace
       .getConfiguration(constants.gptCommandName)
       .get(constants.gptSettingsKey) as string;
+  
     const gptEngine = vscode.workspace
       .getConfiguration(constants.gptCommandName)
       .get(constants.gptEngineKey) as string;
-    const filePackageObjectList = vscode.workspace.workspaceFolders;
-    if (filePackageObjectList.length > 0) {
-      const answer = await cx.kicsChat(
-        gptToken,
-        filePath,
-        line,
-        severity,
-        queryName,
-        message,
-        null,
-        gptEngine
-      );
-      if (answer.payload && answer.exitCode === 0) {
-        return answer.payload;
-      } else {
-        throw new Error(answer.status);
-      }
-    }
+  
+    return { gptToken, gptEngine };
   }
 
   async mask(filePath: string) {

src/utils/common/constants.ts

@@ -141,6 +141,8 @@ export const constants = {
   gptCommandName: "CheckmarxSecurityChampion",
   gptSettingsKey: "key",
   gptEngineKey: "model",
+  systemNotFindPathError: "The system cannot find the path specified.",
+  gptFileNotInWorkspaceError: "AI Security Champion can't advise you about this vulnerability because the file where the vulnerability was identified isn't open in your VS Code workspace.",
   // Documentation & Feedback
   feedback: "Send us enhancement request or report a bug",
   documentation: "Documentation",

src/views/gptView/gptView.ts

@@ -144,7 +144,7 @@ export class GptView implements vscode.WebviewViewProvider {
         <div id="main_div">
         <div class="container-fluid">
 		<div class="container" style="padding:0;width:100 !important;">
-		<div class="card" style="border:none;margin-bottom:1em;background:transparent;">
+		<div class="card" style="border:none;margin-bottom:1em;background:transparent;color:var(--vscode-editor-foreground);">
                <div class="card-body" style="padding:0">
                   <div class="row">
                      <div class="col">