Improve messages and detect duplicates when importing files

Author: ggabarrin

src/extension.ts

@@ -10,7 +10,7 @@ import { reactionHandler } from './handlers/reaction';
 import { loadCommentsFromFile, saveCommentsToFile } from './persistence';
 import { saveNoteComment, setNoteStatus } from './helpers';
 
-let noteList: vscode.CommentThread[] = [];
+const noteList: vscode.CommentThread[] = [];
 
 export function activate(context: vscode.ExtensionContext) {
   Resource.initialize(context);
@@ -185,7 +185,7 @@ export function activate(context: vscode.ExtensionContext) {
   );
 
   // load persisted comments from file
-  noteList = loadCommentsFromFile();
+  noteList.push(...loadCommentsFromFile());
 }
 
 export function deactivate(context: vscode.ExtensionContext) {

src/parsers/semgrep.ts

@@ -7,27 +7,31 @@ class SemgrepParser {
   static parse(fileContent: string) {
     const toolFindings: ToolFinding[] = [];
 
-    const semgrepFindings = JSON.parse(fileContent).results;
-    semgrepFindings.map((semgrepFinding: any) => {
-      // uri
-      let fullPath = '';
-      if (vscode.workspace.workspaceFolders) {
-        fullPath = vscode.workspace.workspaceFolders[0].uri.fsPath + '/';
-      }
-      const uri = vscode.Uri.file(`${fullPath}${semgrepFinding.path}`);
+    try {
+      const semgrepFindings = JSON.parse(fileContent).results;
+      semgrepFindings.map((semgrepFinding: any) => {
+        // uri
+        let fullPath = '';
+        if (vscode.workspace.workspaceFolders) {
+          fullPath = vscode.workspace.workspaceFolders[0].uri.fsPath + '/';
+        }
+        const uri = vscode.Uri.file(`${fullPath}${semgrepFinding.path}`);
 
-      // range
-      const range = new vscode.Range(
-        semgrepFinding.start.line - 1,
-        0,
-        semgrepFinding.end.line - 1,
-        0,
-      );
+        // range
+        const range = new vscode.Range(
+          semgrepFinding.start.line - 1,
+          0,
+          semgrepFinding.end.line - 1,
+          0,
+        );
 
-      // instantiate tool finding and add to list
-      const toolFinding = new ToolFinding(uri, range, semgrepFinding.extra.message);
-      toolFindings.push(toolFinding);
-    });
+        // instantiate tool finding and add to list
+        const toolFinding = new ToolFinding(uri, range, semgrepFinding.extra.message);
+        toolFindings.push(toolFinding);
+      });
+    } catch {
+      /* empty */
+    }
 
     return toolFindings;
   }

src/webviews/assets/main.js

@@ -9,24 +9,15 @@
     .querySelector('.process-file-button')
     .addEventListener('click', () => onButtonClicked());
 
-  // // Handle messages sent from the extension to the webview
-  // window.addEventListener('message', (event) => {
-  //   const message = event.data; // The json data that the extension sent
-  //   switch (message.type) {
-  //     case 'foo': {
-  //       break;
-  //     }
-  //   }
-  // });
-
   function onButtonClicked() {
     let toolSelect = document.getElementById('toolSelect');
     let toolName = toolSelect.options[toolSelect.selectedIndex].text;
 
     let selectedFile = document.getElementById('fileInput').files[0];
-    readFile(selectedFile).then((fileContent) =>
+    readFile(selectedFile).then((fileContent) => {
       vscode.postMessage({ type: 'processToolFile', toolName, fileContent }),
-    );
+        (document.getElementById('fileInput').value = '');
+    });
   }
 
   async function readFile(file) {

src/webviews/importToolResultsWebview.ts

@@ -106,15 +106,52 @@ function processToolFile(
     }
   }
 
-  // instantiate comments based on parsed tool findings
-  if (toolFindings.length) {
-    toolFindings.map((result: ToolFinding) => {
-      const newThread = commentController.createCommentThread(
-        result.uri,
-        result.range,
-        [],
-      );
-      saveNoteComment(newThread, result.text, true, noteList, toolName);
-    });
+  if (!toolFindings.length) {
+    vscode.window.showErrorMessage('An error has ocurred while parsing the file.');
+    return;
+  }
+
+  if (noteList.length && identifyPotentialDuplicates(toolName, noteList)) {
+    vscode.window
+      .showWarningMessage(
+        `Potential duplicates. Current comments already include findings from ${toolName}. Do you want to import findings anyway?`,
+        'Yes',
+        'No',
+      )
+      .then((answer) => {
+        if (answer === 'Yes') {
+          saveToolFindings(toolFindings, noteList, toolName);
+        }
+      });
+  } else {
+    saveToolFindings(toolFindings, noteList, toolName);
   }
 }
+
+function identifyPotentialDuplicates(
+  toolName: string,
+  noteList: vscode.CommentThread[],
+) {
+  return noteList.some((thread) => {
+    return thread.comments[0].author.name === toolName;
+  });
+}
+
+function saveToolFindings(
+  toolFindings: ToolFinding[],
+  noteList: vscode.CommentThread[],
+  toolName: string,
+) {
+  // instantiate comments based on parsed tool findings
+  toolFindings.forEach((toolFinding: ToolFinding) => {
+    const newThread = commentController.createCommentThread(
+      toolFinding.uri,
+      toolFinding.range,
+      [],
+    );
+    saveNoteComment(newThread, toolFinding.text, true, noteList, toolName);
+  });
+  vscode.window.showInformationMessage(
+    `${toolFindings.length} findings were imported successfully.`,
+  );
+}