Merge pull request #60 from DeepCodeAI/mainline_update1

Updated icon, welcome notification, advanced mode.

Author: Arvi3d

images/deepcode-logo.svg

@@ -46,6 +46,12 @@
       {
         "title": "DeepCode",
         "properties": {
+          "deepcode.advancedMode": {
+            "type": "boolean",
+            "default": false,
+            "description": "Toggle advanced tools for expert users",
+            "scope": "application"
+          },
           "deepcode.url": {
             "type": "string",
             "default": "",
@@ -77,6 +83,13 @@
             "default": true,
             "markdownDescription": "Allow extension's telemetry to be sent to `#deepcode.url#`",
             "scope": "application"
+          },
+          "deepcode.yesWelcomeNotification": {
+            "//": "Name starts with y to put it at the end, as configs are sorted alphbetically",
+            "type": "boolean",
+            "default": true,
+            "markdownDescription": "Show welcome notification after installation and restart",
+            "scope": "application"
           }
         }
       }
@@ -86,7 +99,7 @@
         {
           "id": "deepcode",
           "title": "DeepCode",
-          "icon": "images/deepcode-logo.svg"
+          "icon": "images/deepcode-vscode-icon.svg"
         }
       ]
     },
@@ -120,7 +133,7 @@
         {
           "id": "deepcode.views.actions",
           "name": "Actions",
-          "when": "!deepcode:error && deepcode:loggedIn && deepcode:uploadApproved && deepcode:workspaceFound"
+          "when": "deepcode:advanced && !deepcode:error && deepcode:loggedIn && deepcode:uploadApproved && deepcode:workspaceFound"
         },
         {
           "id": "deepcode.views.support",

images/deepcode-vscode-icon.svg

@@ -14,7 +14,10 @@ import {
   DEEPCODE_OPEN_BROWSER,
   DEEPCODE_OPEN_LOCAL,
 } from "./constants/commands";
-import { openDeepcodeSettingsCommand, createDCIgnoreCommand } from "./utils/vscodeCommandsUtils";
+import {
+  openDeepcodeSettingsCommand,
+  createDCIgnoreCommand,
+} from "./utils/vscodeCommandsUtils";
 import { errorsLogs } from "./messages/errorsServerLogMessages";
 
 import {
@@ -147,6 +150,9 @@ class DeepCodeExtension extends DeepCodeLib implements DeepCode.ExtensionInterfa
     this.startExtension().catch((err) => this.processError(err, {
       message: errorsLogs.failedExecution,
     }));
+    this.checkWelcomeNotification().catch((err) => this.processError(err, {
+      message: errorsLogs.welcomeNotification,
+    }));
   }
 
 }

package.json

@@ -1,5 +1,6 @@
 // vscode commands used in extension work
-export const VSCODE_GO_TO_SETTINGS_COMMAND = "workbench.action.openSettings"; 
+export const VSCODE_GO_TO_SETTINGS_COMMAND = "workbench.action.openSettings";  
+export const VSCODE_VIEW_CONTAINER_PREFIX = "workbench.view.extension.";
 export const VSCODE_ADD_COMMENT_COMMAND = "editor.action.addCommentLine";
 
 // custom depcode commands

src/deepcode/DeepCodeExtension.ts

@@ -14,6 +14,7 @@ export const DEEPCODE_CONTEXT = {
   ANALYZING: "workspaceFound",
   ERROR: "error",
   MODE: "mode",
+  ADVANCED: "advanced",
 };
 
 export const DEEPCODE_ERROR_CODES = {

src/deepcode/constants/commands.ts

@@ -8,7 +8,9 @@ import DeepCodeWorkspaceFoldersWatcher from "../watchers/WorkspaceFoldersWatcher
 import DeepCodeEditorsWatcher from "../watchers/EditorsWatcher";
 import DeepCodeSettingsWatcher from "../watchers/DeepCodeSettingsWatcher";
 import { IDE_NAME, REFRESH_VIEW_DEBOUNCE_INTERVAL } from "../../constants/general";
-import { errorsLogs } from "../../messages/errorsServerLogMessages";
+import { setContext } from "../../utils/vscodeCommandsUtils";
+import { DEEPCODE_CONTEXT } from "../../constants/views";
+import { errorsLogs } from '../../messages/errorsServerLogMessages';
 
 export default abstract class BaseDeepCodeModule implements DeepCode.BaseDeepCodeModuleInterface {
   currentWorkspacePath: string;
@@ -92,6 +94,18 @@ export default abstract class BaseDeepCodeModule implements DeepCode.BaseDeepCod
     return !!vscode.workspace.getConfiguration('deepcode').get<boolean>('yesTelemetry');
   }
 
+  get shouldShowWelcomeNotification(): boolean {
+    return !!vscode.workspace.getConfiguration('deepcode').get<boolean>('yesWelcomeNotification');
+  }
+
+  async hideWelcomeNotification(): Promise<void> {
+    await vscode.workspace.getConfiguration('deepcode').update('yesWelcomeNotification', false, true);
+  }
+
+  get shouldShowAdvancedView(): boolean {
+    return !!vscode.workspace.getConfiguration('deepcode').get<boolean>('advancedMode');
+  }
+
   private getProgressBadgePromise(): Promise<void> {
     if (this.progressBadgePromise === undefined) {
       // This should not be needed, but we resolve pending Promises 
@@ -109,9 +123,16 @@ export default abstract class BaseDeepCodeModule implements DeepCode.BaseDeepCod
   // Leave viewId undefined to remove the badge from all views
   async setLoadingBadge(viewId?: string): Promise<void> {
     if (viewId) {
-      await vscode.window.withProgress(
+      // Using closure on this to allow partial binding in arbitrary positions
+      const self = this;
+      vscode.window.withProgress(
         { location: { viewId } },
-        this.getProgressBadgePromise.bind(this)
+        () => self.getProgressBadgePromise()
+      ).then(
+        () => {},
+        (error) => self.processError(error, {
+          message: errorsLogs.loadingBadge,
+        })
       );
     } else {
       if (this.progressBadgeResolveFn) this.progressBadgeResolveFn();

src/deepcode/constants/views.ts

@@ -1,3 +1,4 @@
+import * as vscode from "vscode";
 import ReportModule from "./ReportModule";
 import DeepCode from "../../../interfaces/DeepCodeInterfaces";
 import http from "../../http/requests";
@@ -7,7 +8,9 @@ import {
   DEEPCODE_VIEW_TC,
   DEEPCODE_CONTEXT
 } from "../../constants/views";
+import { openDeepcodeViewContainer } from "../../utils/vscodeCommandsUtils";
 import { errorsLogs } from "../../messages/errorsServerLogMessages";
+import { deepCodeMessages } from "../../messages/deepCodeMessages";
 
 const sleep = (duration: number) => new Promise(resolve => setTimeout(resolve, duration));
 
@@ -80,8 +83,24 @@ abstract class LoginModule extends ReportModule implements DeepCode.LoginModuleI
     await this.setUploadApproved(true);
     await this.setLoadingBadge();
     await this.checkApproval();
-  } 
+  }
+
+  async checkWelcomeNotification(): Promise<void> {
+    if (this.shouldShowWelcomeNotification) {
+      let pressedButton = await vscode.window.showInformationMessage(
+        deepCodeMessages.welcome.msg,
+        deepCodeMessages.welcome.button
+      );
+      if (pressedButton === deepCodeMessages.welcome.button) {
+        await openDeepcodeViewContainer();
+      }
+      await this.hideWelcomeNotification();
+    }
+  }
 
+  async checkAdvancedMode(): Promise<void> {
+    await setContext(DEEPCODE_CONTEXT.ADVANCED, this.shouldShowAdvancedView);
+  }
 }
 
 export default LoginModule;

src/deepcode/lib/modules/BaseDeepCodeModule.ts

@@ -5,6 +5,9 @@ import { errorsLogs } from "../../messages/errorsServerLogMessages";
 class DeepCodeSettingsWatcher implements DeepCode.DeepCodeWatcherInterface {
 
   private async onChangeConfiguration(extension: DeepCode.ExtensionInterface, key: string): Promise<void> {
+    if (key === 'deepcode.advancedMode') {
+      return extension.checkAdvancedMode();
+    }
     const extensionConfig = vscode.workspace.getConfiguration('deepcode');
     // @ts-ignore */}
     const url: string = extensionConfig.get('url');
@@ -21,7 +24,7 @@ class DeepCodeSettingsWatcher implements DeepCode.DeepCodeWatcherInterface {
     vscode.workspace.onDidChangeConfiguration(
       async (event: vscode.ConfigurationChangeEvent): Promise<void> => {
         const change = [
-          'deepcode.url', 'deepcode.token', 'deepcode.uploadApproved'
+          'deepcode.url', 'deepcode.token', 'deepcode.uploadApproved', 'deepcode.advancedMode'
         ].find(config => event.affectsConfiguration(config));
         if (change) {
           try {

src/deepcode/lib/modules/LoginModule.ts

@@ -0,0 +1,6 @@
+export const deepCodeMessages = {
+  welcome: {
+    msg: "Welcome to DeepCode! Check out our dashboard to start analyzing your code",
+    button: "Check it out",
+  },
+};