Merge pull request #41 from DeepCodeAI/report_suggestion_view

Arvi3d · web-flow · commit 024bdab5b9f1 · 2020-06-19T13:31:29.000+02:00
Report telemetry events
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -63,6 +63,20 @@
             "default": false,
             "markdownDescription": "User consent for code upload to `#deepcode.url#`",
             "scope": "window"
+          },
+          "deepcode.yesCrashReport": {
+            "//": "Name starts with y to put it at the end, as configs are sorted alphbetically",
+            "type": "boolean",
+            "default": true,
+            "markdownDescription": "Allow crash reports to be reported to `#deepcode.url#`",
+            "scope": "application"
+          },
+          "deepcode.yesTelemetry": {
+            "//": "Name starts with y to put it at the end, as configs are sorted alphbetically",
+            "type": "boolean",
+            "default": true,
+            "markdownDescription": "Allow extension's telemetry to be sent to `#deepcode.url#`",
+            "scope": "application"
           }
         }
       }
@@ -103,6 +117,6 @@
     "ignore": "^5.1.4",
     "mz": "^2.7.0",
     "open": "^7.0.0",
-    "@deepcode/tsc": "^1.1.0"
+    "@deepcode/tsc": "^1.3.0"
   }
 }
diff --git a/src/deepcode/DeepCodeExtension.ts b/src/deepcode/DeepCodeExtension.ts
@@ -11,20 +11,20 @@ class DeepCodeExtension extends DeepCodeLib implements DeepCode.ExtensionInterfa
     this.store.createStore(context);
     this.statusBarItem.show();
 
-    context.subscriptions.push( 
+    context.subscriptions.push(
       vscode.commands.registerCommand(
         DEEPCODE_START_COMMAND,
         this.activateExtensionAnalyzeActions.bind(this)
       )
     );
 
-    context.subscriptions.push( 
+    context.subscriptions.push(
       vscode.commands.registerCommand(
         DEEPCODE_SETTINGS_COMMAND,
         openDeepcodeSettingsCommand
       )
     );
-    
+
     context.subscriptions.push(
       { dispose: this.startExtension() },
     );
@@ -43,7 +43,7 @@ class DeepCodeExtension extends DeepCodeLib implements DeepCode.ExtensionInterfa
   }
 
   public startExtension(): any {
-    this.activateWatchers();
+    this.activateAll();
     this.activateExtensionAnalyzeActions();
   }
 
diff --git a/src/deepcode/constants/telemetry.ts b/src/deepcode/constants/telemetry.ts
@@ -0,0 +1,4 @@
+export const TELEMETRY_EVENTS = {
+  ignoreSuggestion: 'ignoreSuggestion',
+  viewSuggestion: 'viewSuggestion',
+};
diff --git a/src/deepcode/http/requests.ts b/src/deepcode/http/requests.ts
@@ -8,7 +8,7 @@ import { IDE_NAME } from "../constants/general";
 const AI = new ServiceAI();
 
 const http = {
-  
+
   login(baseURL: string, source: string = IDE_NAME): Promise<any> {
     return AI.startSession({ baseURL, source });
   },
@@ -35,11 +35,19 @@ const http = {
     });
   },
 
-  // TODO: when API package will implement such functionality
-  // we would have the possibility to send an error to server
-  async sendError(body: any): Promise<void> {
-    return Promise.resolve();
-  }
+  async sendError(baseURL: string, options: {[key: string]: any}): Promise<any> {
+    return AI.reportError({
+      baseURL,
+      ...options
+    });
+  },
+
+  async sendEvent(baseURL: string, options: {[key: string]: any}): Promise<any> {
+    return AI.reportEvent({
+      baseURL,
+      ...options,
+    });
+  },
 };
 
 export default http;
diff --git a/src/deepcode/lib/analyzer/DeepCodeAnalyzer.ts b/src/deepcode/lib/analyzer/DeepCodeAnalyzer.ts
@@ -6,9 +6,11 @@ import {
   createIssuesMarkersDecorationOptions,
   createIssueRelatedInformation,
   createDeepCodeSeveritiesMap,
+  getDeepCodeSeverity,
   extractSuggestionIdFromSuggestionsMap
 } from "../../utils/analysisUtils";
 import { DEEPCODE_NAME } from "../../constants/general";
+import { TELEMETRY_EVENTS } from "../../constants/telemetry";
 import { ISSUES_MARKERS_DECORATION_TYPE } from "../../constants/analysis";
 import { deepCodeMessages } from "../../messages/deepCodeMessages";
 import { errorsLogs } from "../../messages/errorsServerLogMessages";
@@ -20,6 +22,7 @@ class DeepCodeAnalyzer implements DeepCode.AnalyzerInterface {
   private SEVERITIES: {
     [key: number]: { name: vscode.DiagnosticSeverity; show: boolean };
   };
+  private extension: DeepCode.ExtensionInterface | undefined;
   private analysisProgressValue: number = 1; // default value for progress to make it visible from start
   private progress = vscode.window.withProgress;
   private analysisInProgress: boolean = false;
@@ -41,18 +44,34 @@ class DeepCodeAnalyzer implements DeepCode.AnalyzerInterface {
       {
         findSuggestionId: extractSuggestionIdFromSuggestionsMap(
           this.analysisResultsCollection
-        )
+        ),
+        trackIgnoreSuggestion: this.trackIgnoreSuggestion.bind(this)
       }
     );
     this.issueHoverProvider = new DisposableHoverProvider(this.deepcodeReview);
   }
 
+  public activate(extension: DeepCode.ExtensionInterface) {
+    this.extension = extension;
+  }
+
+  public trackIgnoreSuggestion(vscodeSeverity: number, options: {[key: string]: any}): void {
+    if (!this.extension) return;
+    options.data = {
+      severity: getDeepCodeSeverity(vscodeSeverity),
+      ...options.data
+    };
+    this.extension.sendEvent(
+      TELEMETRY_EVENTS.ignoreSuggestion,
+      options
+    );
+  }
 
   public updateAnalysisResultsCollection(results: DeepCode.AnalysisResultsCollectionInterface, rootPath: string): void {
     this.analysisResultsCollection[rootPath] = {...results} as unknown as DeepCode.AnalysisResultsInterface;
     this.createReviewResults();
   }
- 
+
   private createIssueDiagnosticInfo({
     issue,
     issuePositions,
diff --git a/src/deepcode/lib/deepCodeProviders/codeActionsProvider/DeepCodeIssuesActionsProvider.ts b/src/deepcode/lib/deepCodeProviders/codeActionsProvider/DeepCodeIssuesActionsProvider.ts
@@ -21,6 +21,7 @@ export class DeepCodeIssuesActionProvider implements vscode.CodeActionProvider {
 
   private issuesList: vscode.DiagnosticCollection | undefined;
   private findSuggestionId: Function;
+  private trackIgnoreSuggestion: Function;
 
   constructor(
     issuesList: vscode.DiagnosticCollection | undefined,
@@ -29,6 +30,7 @@ export class DeepCodeIssuesActionProvider implements vscode.CodeActionProvider {
     this.issuesList = issuesList;
     this.registerIgnoreIssuesCommand();
     this.findSuggestionId = callbacks.findSuggestionId;
+    this.trackIgnoreSuggestion = callbacks.trackIgnoreSuggestion;
   }
 
   private registerIgnoreIssuesCommand() {
@@ -37,12 +39,23 @@ export class DeepCodeIssuesActionProvider implements vscode.CodeActionProvider {
       ({
         currentEditor,
         issueText,
-        matchedIssue
+        matchedIssue,
+        issueId,
+        isFileIgnore,
       }: {
         currentEditor: vscode.TextEditor;
         matchedIssue: vscode.Diagnostic;
         issueText: string;
+        issueId: string;
+        isFileIgnore?: boolean;
       }): void => {
+        this.trackIgnoreSuggestion(matchedIssue.severity, {
+          message: matchedIssue.message,
+          data: {
+            issueId,
+            isFileIgnore: !!isFileIgnore,
+          }
+        });
         const editor: vscode.TextEditor | undefined =
           currentEditor || vscode.window.activeTextEditor;
         if (!editor || !issueText || !matchedIssue) {
@@ -135,11 +148,10 @@ export class DeepCodeIssuesActionProvider implements vscode.CodeActionProvider {
       issueNameForComment,
       isFileIgnore
     );
-
     ignoreIssueAction.command = {
       command: DEEPCODE_IGNORE_ISSUES_COMMAND,
       title: DEEPCODE_IGNORE_ISSUES_COMMAND,
-      arguments: [{ issueText, matchedIssue }]
+      arguments: [{ issueText, matchedIssue, issueId: issueFullId, isFileIgnore }]
     };
 
     return ignoreIssueAction;
diff --git a/src/deepcode/lib/errorHandler/DeepCodeErrorHandler.ts b/src/deepcode/lib/errorHandler/DeepCodeErrorHandler.ts
@@ -29,7 +29,7 @@ class DeepCodeErrorHandler implements DeepCode.ErrorHandlerInterface {
   private async serverErrorHandler(extension: DeepCode.ExtensionInterface | any): Promise<void> {
     const { msg } = deepCodeMessages.noConnection;
     vscode.window.showErrorMessage(msg);
-    
+
     setTimeout(async () => {
       startDeepCodeCommand();
     }, 5000);
@@ -86,20 +86,18 @@ class DeepCodeErrorHandler implements DeepCode.ErrorHandlerInterface {
     error: DeepCode.errorType,
     options: { [key: string]: any }
   ): Promise<void> {
-    if (process.env.NODE_ENV === "production") {
-      // please disable request sending in dev mode to avoid unnecessary reports to server
-      await http.sendError({
-        //for testing edpoint use source: 'test'
-        source: IDE_NAME,
+    await extension.sendError(
+      {
         type: `${error.statusCode || ""} ${error.name || ""}`.trim(),
-        errorTrace: JSON.stringify(error),
         message: options.message || errorsLogs.undefinedError,
-        ...(extension.token && { sessionToken: extension.token }),
         ...(options.endpoint && { path: options.endpoint }),
         ...(options.bundleId && { bundleId: options.bundleId }),
-        ...(options.data && { data: options.data })
-      });
-    }
+        data: {
+          errorTrace: JSON.stringify(error),
+          ...options.data
+        }
+      }
+    );
   }
 
   private async unauthorizedAccess(extension: DeepCode.ExtensionInterface): Promise<void> {
diff --git a/src/deepcode/lib/modules/BaseDeepCodeModule.ts b/src/deepcode/lib/modules/BaseDeepCodeModule.ts
@@ -67,7 +67,7 @@ export default class BaseDeepCodeModule implements DeepCode.BaseDeepCodeModuleIn
   }
 
   public get source(): string {
-    return process.env['GITPOD_WORKSPACE_ID'] ? 'gitpod' : IDE_NAME; 
+    return process.env['GITPOD_WORKSPACE_ID'] ? 'gitpod' : IDE_NAME;
   }
 
   public get uploadApproved(): boolean {
@@ -77,5 +77,12 @@ export default class BaseDeepCodeModule implements DeepCode.BaseDeepCodeModuleIn
   public async approveUpload(isGlobal: boolean = false): Promise<void> {
     await vscode.workspace.getConfiguration('deepcode').update('uploadApproved', true, isGlobal);
   }
-  
+
+  public get shouldReportErrors(): boolean {
+    return !!vscode.workspace.getConfiguration('deepcode').get('yesCrashReport');
+  }
+
+  public get shouldReportEvents(): boolean {
+    return !!vscode.workspace.getConfiguration('deepcode').get('yesTelemetry');
+  }
 }
diff --git a/src/deepcode/lib/modules/DeepCodeLib.ts b/src/deepcode/lib/modules/DeepCodeLib.ts
@@ -5,11 +5,12 @@ import BundlesModule from "./BundlesModule";
 
 export default class DeepCodeLib extends BundlesModule implements DeepCode.DeepCodeLibInterface {
   
-  public activateWatchers(): void {
+  public activateAll(): void {
     this.filesWatcher.activate(this);
     this.workspacesWatcher.activate(this);
     this.editorsWatcher.activate(this);
     this.settingsWatcher.activate(this);
+    this.analyzer.activate(this);
   }
 
 
@@ -43,12 +44,12 @@ export default class DeepCodeLib extends BundlesModule implements DeepCode.DeepC
 
     if (this.workspacesPaths.length) {
       this.updateCurrentWorkspacePath(this.workspacesPaths[0]);
-      
+
       await this.updateHashesBundles();
 
       // Third, initiate analysis
       try {
-        // Main entry point to 
+        // Main entry point to
         for await (const path of this.workspacesPaths) {
           await this.performBundlesActions(path);
         }
diff --git a/src/deepcode/lib/modules/LoginModule.ts b/src/deepcode/lib/modules/LoginModule.ts
@@ -4,27 +4,27 @@ import * as open from "open";
 import DeepCode from "../../../interfaces/DeepCodeInterfaces";
 import http from "../../http/requests";
 import { deepCodeMessages } from "../../messages/deepCodeMessages";
-import BaseDeepCodeModule from "./BaseDeepCodeModule";
+import ReportModule from "./ReportModule";
 
 const sleep = (duration: number) => new Promise(resolve => setTimeout(resolve, duration));
 
-class LoginModule extends BaseDeepCodeModule implements DeepCode.LoginModuleInterface {
+class LoginModule extends ReportModule implements DeepCode.LoginModuleInterface {
   private pendingLogin: boolean = false;
 
   public async initiateLogin(): Promise<void> {
     if (this.pendingLogin) {
       return
     }
     this.pendingLogin = true;
-    
+
     try {
       const { login } = deepCodeMessages;
       let pressedButton: string | undefined;
-      
+
       pressedButton = await vscode.window.showInformationMessage(login.msg, login.button);
       if (pressedButton === login.button) {
         const result = await http.login(this.baseURL, this.source);
-        
+
         let { sessionToken, loginURL } = result;
         if (!sessionToken || !loginURL) {
           throw new Error();
@@ -48,7 +48,7 @@ class LoginModule extends BaseDeepCodeModule implements DeepCode.LoginModuleInte
     // 20 attempts to wait for user's login & consent
     for (let i = 0; i < 20; i++) {
       await sleep(1000);
-      
+
       const confirmed = await this.checkSession();
       if (confirmed) {
         return
diff --git a/src/deepcode/lib/modules/ReportModule.ts b/src/deepcode/lib/modules/ReportModule.ts
@@ -0,0 +1,34 @@
+import DeepCode from "../../../interfaces/DeepCodeInterfaces";
+import http from "../../http/requests";
+import BaseDeepCodeModule from "./BaseDeepCodeModule";
+
+class ReportModule extends BaseDeepCodeModule implements DeepCode.ReportModuleInterface {
+  private get shouldReport(): boolean {
+    // DEV: uncomment the following line to test this module in development
+    // return true;
+
+    // disabling request sending in dev mode or to self-managed instances.
+    return process.env.NODE_ENV === "production" && this.baseURL === this.defaultBaseURL;
+  }
+
+  public async sendError(options: {[key: string]: any}): Promise<void> {
+    if (!this.shouldReport || !this.shouldReportErrors) return;
+    await http.sendError(this.baseURL, {
+      source: this.source,
+      ...(this.token && { sessionToken: this.token }),
+      ...options
+    });
+  }
+
+  public async sendEvent(event: string, options: {[key: string]: any}): Promise<void> {
+    if (!this.shouldReport || !this.shouldReportEvents) return;
+    await http.sendEvent(this.baseURL, {
+      type: event,
+      source: this.source,
+      ...(this.token && { sessionToken: this.token }),
+      ...options
+    });
+  }
+}
+
+export default ReportModule;
diff --git a/src/deepcode/utils/analysisUtils.ts b/src/deepcode/utils/analysisUtils.ts
diff --git a/src/interfaces/DeepCodeInterfaces.ts b/src/interfaces/DeepCodeInterfaces.ts

Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,20 @@`
`63`	`63`	`"default": false,`
`64`	`64`	"markdownDescription": "User consent for code upload to `#deepcode.url#`",
`65`	`65`	`"scope": "window"`
	`66`	`+ },`
	`67`	`+ "deepcode.yesCrashReport": {`
	`68`	`+ "//": "Name starts with y to put it at the end, as configs are sorted alphbetically",`
	`69`	`+ "type": "boolean",`
	`70`	`+ "default": true,`
	`71`	+ "markdownDescription": "Allow crash reports to be reported to `#deepcode.url#`",
	`72`	`+ "scope": "application"`
	`73`	`+ },`
	`74`	`+ "deepcode.yesTelemetry": {`
	`75`	`+ "//": "Name starts with y to put it at the end, as configs are sorted alphbetically",`
	`76`	`+ "type": "boolean",`
	`77`	`+ "default": true,`
	`78`	+ "markdownDescription": "Allow extension's telemetry to be sent to `#deepcode.url#`",
	`79`	`+ "scope": "application"`
`66`	`80`	`}`
`67`	`81`	`}`
`68`	`82`	`}`
`@@ -103,6 +117,6 @@`
`103`	`117`	`"ignore": "^5.1.4",`
`104`	`118`	`"mz": "^2.7.0",`
`105`	`119`	`"open": "^7.0.0",`
`106`		`- "@deepcode/tsc": "^1.1.0"`
	`120`	`+ "@deepcode/tsc": "^1.3.0"`
`107`	`121`	`}`
`108`	`122`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ export default class BaseDeepCodeModule implements DeepCode.BaseDeepCodeModuleIn`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`public get source(): string {`
`70`		`- return process.env['GITPOD_WORKSPACE_ID'] ? 'gitpod' : IDE_NAME;`
	`70`	`+ return process.env['GITPOD_WORKSPACE_ID'] ? 'gitpod' : IDE_NAME;`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`public get uploadApproved(): boolean {`
`@@ -77,5 +77,12 @@ export default class BaseDeepCodeModule implements DeepCode.BaseDeepCodeModuleIn`
`77`	`77`	`public async approveUpload(isGlobal: boolean = false): Promise<void> {`
`78`	`78`	`await vscode.workspace.getConfiguration('deepcode').update('uploadApproved', true, isGlobal);`
`79`	`79`	`}`
`80`		`-`
	`80`	`+`
	`81`	`+ public get shouldReportErrors(): boolean {`
	`82`	`+ return !!vscode.workspace.getConfiguration('deepcode').get('yesCrashReport');`
	`83`	`+ }`
	`84`	`+`
	`85`	`+ public get shouldReportEvents(): boolean {`
	`86`	`+ return !!vscode.workspace.getConfiguration('deepcode').get('yesTelemetry');`
	`87`	`+ }`
`81`	`88`	`}`