Merge pull request #3 from RefactorSecurity/rethinkdb

Add support for rethinkdb

Author: v8vito

package-lock.json

@@ -84,6 +84,41 @@
           "type": "string",
           "description": "Author name for comments.",
           "default": "User"
+        },
+        "security-notes.collab.enabled": {
+          "type": "boolean",
+          "description": "Enable collaboration via RethinkDB.",
+          "default": false
+        },
+        "security-notes.collab.host": {
+          "type": "string",
+          "description": "Hostname for the RethinkDB connection.",
+          "default": "localhost"
+        },
+        "security-notes.collab.port": {
+          "type": "number",
+          "description": "Port number for the RethinkDB connection.",
+          "default": 28015
+        },
+        "security-notes.collab.database": {
+          "type": "string",
+          "description": "Name of the RethinkDB database.",
+          "default": "security-notes"
+        },
+        "security-notes.collab.username": {
+          "type": "string",
+          "description": "Username for the RethinkDB connection.",
+          "default": "admin"
+        },
+        "security-notes.collab.password": {
+          "type": "string",
+          "description": "Password for the RethinkDB connection.",
+          "default": ""
+        },
+        "security-notes.collab.projectName": {
+          "type": "string",
+          "description": "Project name used as the RethinkDB table.",
+          "default": "project"
         }
       }
     },
@@ -204,6 +239,7 @@
   },
   "devDependencies": {
     "@types/node": "^16.11.7",
+    "@types/rethinkdb": "^2.3.17",
     "@types/vscode": "~1.65.0",
     "@typescript-eslint/eslint-plugin": "^5.42.0",
     "@typescript-eslint/parser": "^5.42.0",
@@ -213,5 +249,10 @@
     "eslint-config-prettier": "^8.6.0",
     "prettier-linter-helpers": "^1.0.0",
     "typescript": "^4.8.4"
+  },
+  "dependencies": {
+    "@types/uuid": "^9.0.0",
+    "rethinkdb": "^2.4.2",
+    "uuid": "^9.0.0"
   }
-}
+}

package.json

@@ -7,13 +7,33 @@ import { Resource } from './reactions/resource';
 import { ImportToolResultsWebview } from './webviews/importToolResultsWebview';
 import { commentController } from './controllers/comments';
 import { reactionHandler } from './handlers/reaction';
-import { loadCommentsFromFile, saveCommentsToFile } from './persistence';
-import { saveNoteComment, setNoteStatus } from './helpers';
-
-const noteList: vscode.CommentThread[] = [];
+import {
+  getSetting,
+  saveNoteComment,
+  setNoteStatus,
+  syncNoteMapWithRemote,
+} from './helpers';
+import { RemoteDb } from './persistence/remote-db';
+import { loadCommentsFromFile, saveCommentsToFile } from './persistence/local';
+
+const noteMap = new Map<string, vscode.CommentThread>();
+let remoteDb: RemoteDb | undefined;
 
 export function activate(context: vscode.ExtensionContext) {
   Resource.initialize(context);
+  if (getSetting('collab.enabled')) {
+    remoteDb = new RemoteDb(
+      getSetting('collab.host'),
+      getSetting('collab.port'),
+      getSetting('collab.username'),
+      getSetting('collab.password'),
+      getSetting('collab.database'),
+      getSetting('collab.projectName'),
+      noteMap,
+    );
+  } else {
+    remoteDb = undefined;
+  }
 
   // A `CommentController` is able to provide comments for documents.
   context.subscriptions.push(commentController);
@@ -37,7 +57,7 @@ export function activate(context: vscode.ExtensionContext) {
     vscode.commands.registerCommand(
       'security-notes.createNote',
       (reply: vscode.CommentReply) => {
-        saveNoteComment(reply.thread, reply.text, true, noteList);
+        saveNoteComment(reply.thread, reply.text, true, noteMap, '', remoteDb);
       },
     ),
   );
@@ -47,7 +67,7 @@ export function activate(context: vscode.ExtensionContext) {
     vscode.commands.registerCommand(
       'security-notes.replyNoteComment',
       (reply: vscode.CommentReply) => {
-        saveNoteComment(reply.thread, reply.text, false, noteList);
+        saveNoteComment(reply.thread, reply.text, false, noteMap, '', remoteDb);
       },
     ),
   );
@@ -119,6 +139,9 @@ export function activate(context: vscode.ExtensionContext) {
             cmt.mode = vscode.CommentMode.Preview;
           }
 
+          if (remoteDb && comment.parent) {
+            remoteDb.pushNoteComment(comment.parent, false);
+          }
           return cmt;
         });
       },
@@ -150,7 +173,13 @@ export function activate(context: vscode.ExtensionContext) {
     vscode.commands.registerCommand(
       'security-notes.setNoteStatusVulnerable',
       (commentReply: vscode.CommentReply) =>
-        setNoteStatus(commentReply, NoteStatus.Vulnerable),
+        setNoteStatus(
+          commentReply.thread,
+          NoteStatus.Vulnerable,
+          noteMap,
+          '',
+          remoteDb,
+        ),
     ),
   );
 
@@ -159,7 +188,13 @@ export function activate(context: vscode.ExtensionContext) {
     vscode.commands.registerCommand(
       'security-notes.setNoteStatusNotVulnerable',
       (commentReply: vscode.CommentReply) =>
-        setNoteStatus(commentReply, NoteStatus.NotVulnerable),
+        setNoteStatus(
+          commentReply.thread,
+          NoteStatus.NotVulnerable,
+          noteMap,
+          '',
+          remoteDb,
+        ),
     ),
   );
 
@@ -168,14 +203,15 @@ export function activate(context: vscode.ExtensionContext) {
     vscode.commands.registerCommand(
       'security-notes.setNoteStatusToDo',
       (commentReply: vscode.CommentReply) =>
-        setNoteStatus(commentReply, NoteStatus.TODO),
+        setNoteStatus(commentReply.thread, NoteStatus.TODO, noteMap, '', remoteDb),
     ),
   );
 
   // webview for importing tool results
   const importToolResultsWebview = new ImportToolResultsWebview(
     context.extensionUri,
-    noteList,
+    noteMap,
+    remoteDb,
   );
   context.subscriptions.push(
     vscode.window.registerWebviewViewProvider(
@@ -185,10 +221,22 @@ export function activate(context: vscode.ExtensionContext) {
   );
 
   // load persisted comments from file
-  noteList.push(...loadCommentsFromFile());
+  const persistedThreads = loadCommentsFromFile();
+  persistedThreads.forEach((thread) => {
+    noteMap.set(thread.contextValue ? thread.contextValue : '', thread);
+  });
+
+  // initial retrieval of notes from database
+  setTimeout(() => {
+    if (remoteDb) {
+      remoteDb.retrieveAll().then((remoteThreads) => {
+        syncNoteMapWithRemote(noteMap, remoteThreads, remoteDb);
+      });
+    }
+  }, 1500);
 }
 
 export function deactivate(context: vscode.ExtensionContext) {
   // persist comments in file
-  saveCommentsToFile(noteList);
+  saveCommentsToFile(noteMap);
 }