refactored user approval for file upload using configuration layer and added possibility to say "Always yes"

Author: Arvid Paeglit

package.json

@@ -58,6 +58,12 @@
             "default": "",
             "description": "API key",
             "scope": "application"
+          },
+          "deepcode.uploadApproved": {
+            "type": "boolean",
+            "default": false,
+            "markdownDescription": "User consent for code upload to `#deepcode.url#`",
+            "scope": "window"
           }
         }
       }

src/deepcode/DeepCodeExtension.ts

@@ -28,6 +28,18 @@ class DeepCodeExtension extends DeepCodeLib implements DeepCode.ExtensionInterfa
     context.subscriptions.push(
       { dispose: this.startExtension() },
     );
+
+    this.runMigration();
+  }
+
+  private runMigration() {
+    // TODO: remove it after 01.06.2020
+    // Move 'deepcode.api.cloudBackend' to 'deepcode.url' configuration
+    const config = vscode.workspace.getConfiguration('deepcode');
+    const oldBaseURL = config.get('api.cloudBackend');
+    if (!config.get('url') && oldBaseURL) {
+      config.update('url', oldBaseURL, true);
+    }
   }
 
   public startExtension(): any {

src/deepcode/lib/modules/BaseDeepCodeModule.ts

@@ -28,6 +28,7 @@ export default class BaseDeepCodeModule implements DeepCode.BaseDeepCodeModuleIn
   public staticToken = '';
   public staticBaseURL = '';
   public defaultBaseURL = 'https://www.deepcode.ai';
+  public staticuUploadApproved = false;
 
   constructor() {
     this.store = new DeepCodeStore();
@@ -51,7 +52,7 @@ export default class BaseDeepCodeModule implements DeepCode.BaseDeepCodeModuleIn
   }
 
   public get termsConditionsUrl(): string {
-    return `${this.baseURL}tc?utm_source=vsc`;
+    return `${this.baseURL}/tc?utm_source=vsc`;
   }
 
   public get token(): string {
@@ -63,4 +64,13 @@ export default class BaseDeepCodeModule implements DeepCode.BaseDeepCodeModuleIn
     this.staticToken = '';
     vscode.workspace.getConfiguration('deepcode').update('token', value, true);
   }
+
+  public get uploadApproved(): boolean {
+    return this.staticuUploadApproved || !!(vscode.workspace.getConfiguration('deepcode').get('uploadApproved'));
+  }
+
+  public async approveUpload(isGlobal: boolean = false): Promise<void> {
+    await vscode.workspace.getConfiguration('deepcode').update('uploadApproved', true, isGlobal);
+  }
+  
 }

src/deepcode/lib/modules/BundlesModule.ts

@@ -85,6 +85,16 @@ class BundlesModule extends LoginModule
     throw error;
   }
 
+  public async askUploadApproval(): Promise<void> {
+    const { uploadApproval } = deepCodeMessages;
+    let pressedButton: string | undefined;
+    
+    pressedButton = await vscode.window.showInformationMessage(uploadApproval.msg(this.termsConditionsUrl), uploadApproval.workspace, uploadApproval.global);
+    if (pressedButton) {
+      await this.approveUpload(pressedButton === uploadApproval.global);
+    }
+  }
+
   // processing workspaces
   public updateCurrentWorkspacePath(newWorkspacePath: string): void {
     this.currentWorkspacePath = newWorkspacePath;

src/deepcode/lib/modules/DeepCodeLib.ts

@@ -55,16 +55,25 @@ export default class DeepCodeLib extends BundlesModule implements DeepCode.DeepC
 
       await this.updateHashesBundles();
 
+      // First, check logged in or not
       let loggedIn = await this.checkSession();
       if (!loggedIn) {
         await this.initiateLogin();
         loggedIn = await this.checkSession();
+        if (!loggedIn) {
+          return;
+        }
       }
 
-      if (!loggedIn) {
-        return;
+      // Second, check user consent on sending files to server
+      if (!this.uploadApproved) {
+        await this.askUploadApproval();
+        if (!this.uploadApproved) {
+          return;
+        }
       }
-      
+
+      // Third, initiate analysis
       try {
         // Main entry point to 
         for await (const path of this.workspacesPaths) {

src/deepcode/messages/deepCodeMessages.ts

@@ -3,6 +3,12 @@ export const deepCodeMessages = {
     msg: "Login to your account to obtain your API key and start analysing the code with DeepCode.",
     button: "Proceed"
   },
+  uploadApproval: {
+    msg: (termsConditionsUrl: string): string =>	
+    `You are almost set 🤗. Let's confirm and start the remote analysis of this workspace ([DeepCode's Terms & Conditions](${termsConditionsUrl}))`,
+    workspace: "Yes",
+    global: "Always yes"
+  },
   error: {
     msg: "DeepCode encountered a problem.",
     button: "Restart"

src/interfaces/DeepCodeInterfaces.ts

@@ -190,6 +190,8 @@ namespace DeepCode {
     baseURL: string;
     termsConditionsUrl: string;
     token: string;
+    uploadApproved: boolean;
+    approveUpload(): Promise<void>;
     analyzer: DeepCode.AnalyzerInterface;
     statusBarItem: StatusBarItemInterface;
     filesWatcher: DeepCodeWatcherInterface;
@@ -204,6 +206,7 @@ namespace DeepCode {
   }
 
   export interface BundlesModuleInterface {
+    askUploadApproval(): Promise<void>;
     createFilesFilterList(): Promise<void>;
     createWorkspacesList(workspaces: WorkspaceFolder[]): void;
     changeWorkspaceList(workspacePath: string, deleteAddFlag?: boolean): void;