Merge pull request #43 from MetabobProject/fix/fs-path-handling

Fix for file structure handling

Author: AviGopal

ext-src/commands/AnalyzeDocument.ts

@@ -6,7 +6,7 @@ import CONSTANTS from '../constants';
 import Util from '../utils';
 import { getExtensionEventEmitter } from '../events';
 
-export function activateAnalyzeCommand(context: vscode.ExtensionContext): void {
+export function activateAnalyzeCommand(context: vscode.ExtensionContext, _debug?: vscode.OutputChannel): void {
   const command = CONSTANTS.analyzeDocumentCommand;
 
   const commandHandler = async () => {
@@ -17,6 +17,7 @@ export function activateAnalyzeCommand(context: vscode.ExtensionContext): void {
     const sessionToken = new Session(context).get()?.value;
 
     const editor = vscode.window.activeTextEditor;
+    _debug?.appendLine('AnalyzeDocument.ts: activateAnalyzeCommand: editor: ' + JSON.stringify(editor));
 
     // If the user has not opened any file then we can't perform any analysis.
     if (!editor) {
@@ -53,7 +54,7 @@ export function activateAnalyzeCommand(context: vscode.ExtensionContext): void {
     const documentMetaData = Util.extractMetaDataFromDocument(editor.document);
 
     Util.withProgress<SubmitRepresentationResponse>(
-      handleDocumentAnalyze(documentMetaData, sessionToken, analyzeState, context),
+      handleDocumentAnalyze(documentMetaData, sessionToken, analyzeState, context, undefined, true, _debug),
       CONSTANTS.analyzeCommandProgressMessage,
     ).then(response => {
       if (response.status === 'pending' || response.status === 'running') {

ext-src/extension.ts

@@ -29,6 +29,7 @@ let expirationTimer: any = undefined;
 
 export function activate(context: vscode.ExtensionContext): void {
   let previousEditor: vscode.TextEditor | undefined = undefined;
+  const _debug = undefined; // vscode.window.createOutputChannel('Metabob');
   bootstrapExtensionEventEmitter();
 
   initState(context);
@@ -56,7 +57,7 @@ export function activate(context: vscode.ExtensionContext): void {
 
     // Analyze command that hit /analyze endpoint with current file content
     // then decorate current file with error
-    activateAnalyzeCommand(context);
+    activateAnalyzeCommand(context, _debug);
 
     // If the user Discard a suggestion, it would be removed from decoration
     // and the global state as well
@@ -129,14 +130,15 @@ export function activate(context: vscode.ExtensionContext): void {
   );
 
   const extensionEventEmitter = getExtensionEventEmitter();
+
   // Analyze on Save functionality is only ran if the user enabled it.
   context.subscriptions.push(
     vscode.workspace.onDidSaveTextDocument(document => {
-      let savedDocumentMetaData = Util.extractMetaDataFromDocument(document);
+      const savedDocumentMetaData = Util.extractMetaDataFromDocument(document);
       const currentWorkSpaceFolder = Util.getRootFolderName();
       if (!savedDocumentMetaData.fileName) return;
 
-      let fileName: string = savedDocumentMetaData.fileName;
+      const fileName: string = savedDocumentMetaData.fileName;
 
       // Will check if the current document is valid code file.
       if (!(analyzeDocumentOnSaveConfig && analyzeDocumentOnSaveConfig === true)) {
@@ -417,6 +419,7 @@ export function activate(context: vscode.ExtensionContext): void {
         });
 
         previousEditor = e;
+
         return;
       }
 

ext-src/helpers/GenerateDecorations.ts

@@ -13,6 +13,7 @@ export function GenerateDecorations(
   results: Problem[],
   editor: vscode.TextEditor,
   jobId?: string,
+  _debug?: vscode.OutputChannel,
 ): {
   decorationType: vscode.TextEditorDecorationType;
   decorations: vscode.DecorationOptions[];
@@ -23,6 +24,7 @@ export function GenerateDecorations(
       if ((endLine - 1) < 0 || (startLine - 1) < 0) {
         return false;
       }
+
       return true;
     })
     .map(vulnerability => {
@@ -43,7 +45,7 @@ export function GenerateDecorations(
       };
 
       const viewDescriptionURI = encodeURIComponent(JSON.stringify(payload));
-
+      _debug?.appendLine("Decoration: " + viewDescriptionURI);
       const hoverFixMessage = `**[Fix](command:metabob.fixSuggestion?${viewDescriptionURI} "This action will display a comprehensive view of the issue along with a recommended solution.")**`;
       const hoverViewDescriptionMessage = `**[More Details](command:metabob.showDetailSuggestion?${viewDescriptionURI} "This action will display a comprehensive view of the issue.")**`;
       const hoverMessage = new vscode.MarkdownString(

ext-src/helpers/HandleDocumentAnalyze.ts

@@ -30,6 +30,7 @@ export const handleDocumentAnalyze = async (
   context: vscode.ExtensionContext,
   jobId?: string,
   suppressRateLimitErrors = false,
+  _debug?: vscode.OutputChannel,
 ) => {
   const tomorrow = new Date();
   tomorrow.setDate(tomorrow.getDate() + 1);
@@ -48,6 +49,7 @@ export const handleDocumentAnalyze = async (
         name: currentWorkSpaceFolder
       },
     });
+
     return failedResponseReturn;
   }
 
@@ -118,13 +120,14 @@ export const handleDocumentAnalyze = async (
 
   let results: AnalyzeState = {};
   const analyzeStateValue = new Analyze(context).get()?.value;
+  _debug?.appendLine('AnalyzeDocument.ts: handleDocumentAnalyze: analyzeStateValue: ' + JSON.stringify(analyzeStateValue));
 
   if (analyzeStateValue) {
     const aggregatedProblemsFilePaths = verifiedResponse.results.map(problem => {
       return problem.path;
     });
 
-    let buggerAnalyzeStateValue: AnalyzeState = {};
+    const buggerAnalyzeStateValue: AnalyzeState = {};
 
     Object.keys(analyzeStateValue).forEach(key => {
       const problem = analyzeStateValue[key];
@@ -141,6 +144,7 @@ export const handleDocumentAnalyze = async (
       if (endLine - 1 < 0 || startLine - 1 < 0) {
         return false;
       }
+
       return true;
     })
     .filter(vulnerability => {
@@ -159,6 +163,7 @@ export const handleDocumentAnalyze = async (
       if (text.length === 0 || text === '' || text === ' ') {
         return false;
       }
+
       return true;
     })
     .forEach(problem => {
@@ -177,6 +182,7 @@ export const handleDocumentAnalyze = async (
     });
 
   const problems = Util.getCurrentEditorProblems(results, documentMetaData.fileName);
+  _debug?.appendLine('AnalyzeDocument.ts: handleDocumentAnalyze: problems: ' + JSON.stringify(problems));
   if (!problems) {
     getExtensionEventEmitter().fire({
       type: 'Analysis_Error',
@@ -196,8 +202,9 @@ export const handleDocumentAnalyze = async (
   const path = problems.map(item => item.path);
 
   const isUserOnValidEditor = path.includes(documentMetaData.fileName);
+  _debug?.appendLine('AnalyzeDocument.ts: handleDocumentAnalyze: isUserOnValidEditor: ' + isUserOnValidEditor);
   if (isUserOnValidEditor) {
-    Util.decorateCurrentEditorWithHighlights(problems, documentMetaData.editor);
+    Util.decorateCurrentEditorWithHighlights(problems, documentMetaData.editor, _debug);
   }
 
   await analyzeState.set(results);

ext-src/utils.ts

@@ -65,8 +65,8 @@ export default class Utils {
   static sleep = (ms: number): Promise<void> => new Promise(res => setTimeout(res, ms));
 
   static getWorkspacePath(): string | undefined {
-    let folders = workspace.workspaceFolders;
-    let path = folders ? folders![0].uri.fsPath : undefined;
+    const folders = workspace.workspaceFolders;
+    const path = folders ? folders![0].uri.fsPath : undefined;
     if (path === undefined) {
       return undefined
     }
@@ -87,9 +87,9 @@ export default class Utils {
   }
 
   static extractMetaDataFromDocument(document: vscode.TextDocument): IDocumentMetaData {
-    const filePath = document.uri.fsPath;
+    const filePath = document.uri.path;
     const workspaceFolder = workspace.getWorkspaceFolder(document.uri);
-    const relativePath = workspaceFolder ? path.relative(workspaceFolder.uri.fsPath, filePath) : '';
+    const relativePath = workspaceFolder ? path.relative(workspaceFolder.uri.path, filePath) : '';
     const splitKey: string | undefined = relativePath.split('/').pop();
     const fileContent = document.getText();
     const isTextDocument = Utils.isTextDocument(document);
@@ -145,6 +145,7 @@ export default class Utils {
 
     if (workspaceFolders) {
       const rootFolder = workspaceFolders[0];
+      
       return rootFolder.name;
     }
 
@@ -161,8 +162,8 @@ export default class Utils {
       return undefined;
     }
 
-    let documentMetaData = this.extractMetaDataFromDocument(editor.document);
-    let fileName: string | undefined = documentMetaData.fileName;
+    const documentMetaData = this.extractMetaDataFromDocument(editor.document);
+    const fileName: string | undefined = documentMetaData.fileName;
     if (!fileName) return undefined
 
     return {
@@ -195,7 +196,7 @@ export default class Utils {
     return results
   }
 
-  static decorateCurrentEditorWithHighlights(problems: Problem[], problemEditor: vscode.TextEditor): boolean {
+  static decorateCurrentEditorWithHighlights(problems: Problem[], problemEditor: vscode.TextEditor, _debug?: vscode.OutputChannel): boolean {
     const currentEditor = vscode.window.activeTextEditor;
     if (!currentEditor) return false;
 
@@ -204,6 +205,7 @@ export default class Utils {
     if (!isUserOnProblemEditor) return false;
 
     const { decorations } = GenerateDecorations(problems, currentEditor);
+    _debug?.appendLine('Decorations: ' + JSON.stringify(decorations));
     problemEditor.setDecorations(decorationType, []);
     problemEditor.setDecorations(decorationType, decorations);