Strong typing of telemetry properties (#4031)

For #2904
microsoft · Jan 17, 2019 · 3f78993 · 3f78993
1 parent 3eb481f
commit 3f78993
Show file tree

Hide file tree

Showing 19 changed files with 233 additions and 125 deletions.
diff --git a/src/client/application/diagnostics/base.ts b/src/client/application/diagnostics/base.ts
@@ -8,11 +8,12 @@ import { DiagnosticSeverity } from 'vscode';
 import { IServiceContainer } from '../../ioc/types';
 import { sendTelemetryEvent } from '../../telemetry';
 import { EventName } from '../../telemetry/constants';
+import { DiagnosticCodes } from './constants';
 import { DiagnosticScope, IDiagnostic, IDiagnosticFilterService, IDiagnosticsService } from './types';
 
 @injectable()
 export abstract class BaseDiagnostic implements IDiagnostic {
-    constructor(public readonly code: string, public readonly message: string,
+    constructor(public readonly code: DiagnosticCodes, public readonly message: string,
         public readonly severity: DiagnosticSeverity, public readonly scope: DiagnosticScope) { }
 }
 

diff --git a/src/client/application/diagnostics/types.ts b/src/client/application/diagnostics/types.ts
@@ -4,14 +4,15 @@
 'use strict';
 
 import { DiagnosticSeverity, Uri } from 'vscode';
+import { DiagnosticCodes } from './constants';
 
 export enum DiagnosticScope {
     Global = 'Global',
     WorkspaceFolder = 'WorkspaceFolder'
 }
 
 export interface IDiagnostic {
-    readonly code: string;
+    readonly code: DiagnosticCodes;
     readonly message: string;
     readonly severity: DiagnosticSeverity;
     readonly scope: DiagnosticScope;

diff --git a/src/client/common/logger.ts b/src/client/common/logger.ts
@@ -1,4 +1,4 @@
-// tslint:disable:no-console
+// tslint:disable:no-console no-any
 
 import { injectable } from 'inversify';
 import { sendTelemetryEvent } from '../telemetry';
@@ -56,16 +56,18 @@ export enum LogOptions {
 // tslint:disable-next-line:no-any
 function argsToLogString(args: any[]): string {
     try {
-        return (args || []).map((item, index) => {
-            try {
-                if (item.fsPath) {
-                    return `Arg ${index + 1}: <Uri:${item.fsPath}>`;
+        return (args || [])
+            .map((item, index) => {
+                try {
+                    if (item.fsPath) {
+                        return `Arg ${index + 1}: <Uri:${item.fsPath}>`;
+                    }
+                    return `Arg ${index + 1}: ${JSON.stringify(item)}`;
+                } catch {
+                    return `Arg ${index + 1}: UNABLE TO DETERMINE VALUE`;
                 }
-                return `Arg ${index + 1}: ${JSON.stringify(item)}`;
-            } catch {
-                return `Arg ${index + 1}: UNABLE TO DETERMINE VALUE`;
-            }
-        }).join(', ');
+            })
+            .join(', ');
     } catch {
         return '';
     }
@@ -113,10 +115,10 @@ export namespace traceDecorators {
 }
 function trace(message: string, options: LogOptions = LogOptions.None, logLevel?: LogLevel) {
     // tslint:disable-next-line:no-function-expression no-any
-    return function (_: Object, __: string, descriptor: TypedPropertyDescriptor<any>) {
+    return function(_: Object, __: string, descriptor: TypedPropertyDescriptor<any>) {
         const originalMethod = descriptor.value;
         // tslint:disable-next-line:no-function-expression no-any
-        descriptor.value = function (...args: any[]) {
+        descriptor.value = function(...args: any[]) {
             const className = _ && _.constructor ? _.constructor.name : '';
             // tslint:disable-next-line:no-any
             function writeSuccess(returnValue?: any) {
@@ -140,7 +142,7 @@ function trace(message: string, options: LogOptions = LogOptions.None, logLevel?
                 }
                 if (ex) {
                     new Logger().logError(messagesToLog.join(', '), ex);
-                    sendTelemetryEvent('ERROR', undefined, undefined, ex);
+                    sendTelemetryEvent('ERROR' as any, undefined, undefined, ex);
                 } else {
                     new Logger().logInformation(messagesToLog.join(', '));
                 }

diff --git a/src/client/common/terminal/helper.ts b/src/client/common/terminal/helper.ts
@@ -120,7 +120,7 @@ export class TerminalHelper implements ITerminalHelper {
         return promise;
     }
     @traceDecorators.error('Failed to capture telemetry')
-    protected async sendTelemetry(resource: Resource, terminalShellType: TerminalShellType, eventName: string, promise: Promise<string[] | undefined>): Promise<void> {
+    protected async sendTelemetry(resource: Resource, terminalShellType: TerminalShellType, eventName: EventName, promise: Promise<string[] | undefined>): Promise<void> {
         let hasCommands = false;
         const interpreter = await this.interpreterService.getActiveInterpreter(resource);
         let failed = false;

diff --git a/src/client/datascience/constants.ts b/src/client/datascience/constants.ts
@@ -59,33 +59,33 @@ export namespace HistoryMessages {
     export const UpdateSettings = 'update_settings';
 }
 
-export namespace Telemetry {
-    export const ImportNotebook = 'DATASCIENCE.IMPORT_NOTEBOOK';
-    export const RunCell = 'DATASCIENCE.RUN_CELL';
-    export const RunCurrentCell = 'DATASCIENCE.RUN_CURRENT_CELL';
-    export const RunCurrentCellAndAdvance = 'DATASCIENCE.RUN_CURRENT_CELL_AND_ADVANCE';
-    export const RunAllCells = 'DATASCIENCE.RUN_ALL_CELLS';
-    export const DeleteAllCells = 'DATASCIENCE.DELETE_ALL_CELLS';
-    export const DeleteCell = 'DATASCIENCE.DELETE_CELL';
-    export const GotoSourceCode = 'DATASCIENCE.GOTO_SOURCE';
-    export const RestartKernel = 'DATASCIENCE.RESTART_KERNEL';
-    export const ExportNotebook = 'DATASCIENCE.EXPORT_NOTEBOOK';
-    export const Undo = 'DATASCIENCE.UNDO';
-    export const Redo = 'DATASCIENCE.REDO';
-    export const ShowHistoryPane = 'DATASCIENCE.SHOW_HISTORY_PANE';
-    export const ExpandAll = 'DATASCIENCE.EXPAND_ALL';
-    export const CollapseAll = 'DATASCIENCE.COLLAPSE_ALL';
-    export const SelectJupyterURI = 'DATASCIENCE.SELECT_JUPYTER_URI';
-    export const SetJupyterURIToLocal = 'DATASCIENCE.SET_JUPYTER_URI_LOCAL';
-    export const SetJupyterURIToUserSpecified = 'DATASCIENCE.SET_JUPYTER_URI_USER_SPECIFIED';
-    export const Interrupt = 'DATASCIENCE.INTERRUPT';
-    export const ExportPythonFile = 'DATASCIENCE.EXPORT_PYTHON_FILE';
-    export const ExportPythonFileAndOutput = 'DATASCIENCE.EXPORT_PYTHON_FILE_AND_OUTPUT';
-    export const StartJupyter = 'DATASCIENCE.JUPYTERSTARTUPCOST';
-    export const SubmitCellThroughInput = 'DATASCIENCE.SUBMITCELLFROMREPL';
-    export const ConnectLocalJupyter = 'DATASCIENCE.CONNECTLOCALJUPYTER';
-    export const ConnectRemoteJupyter = 'DATASCIENCE.CONNECTREMOTEJUPYTER';
-    export const ConnectFailedJupyter = 'DATASCIENCE.CONNECTFAILEDJUPYTER';
+export enum Telemetry {
+    ImportNotebook = 'DATASCIENCE.IMPORT_NOTEBOOK',
+    RunCell = 'DATASCIENCE.RUN_CELL',
+    RunCurrentCell = 'DATASCIENCE.RUN_CURRENT_CELL',
+    RunCurrentCellAndAdvance = 'DATASCIENCE.RUN_CURRENT_CELL_AND_ADVANCE',
+    RunAllCells = 'DATASCIENCE.RUN_ALL_CELLS',
+    DeleteAllCells = 'DATASCIENCE.DELETE_ALL_CELLS',
+    DeleteCell = 'DATASCIENCE.DELETE_CELL',
+    GotoSourceCode = 'DATASCIENCE.GOTO_SOURCE',
+    RestartKernel = 'DATASCIENCE.RESTART_KERNEL',
+    ExportNotebook = 'DATASCIENCE.EXPORT_NOTEBOOK',
+    Undo = 'DATASCIENCE.UNDO',
+    Redo = 'DATASCIENCE.REDO',
+    ShowHistoryPane = 'DATASCIENCE.SHOW_HISTORY_PANE',
+    ExpandAll = 'DATASCIENCE.EXPAND_ALL',
+    CollapseAll = 'DATASCIENCE.COLLAPSE_ALL',
+    SelectJupyterURI = 'DATASCIENCE.SELECT_JUPYTER_URI',
+    SetJupyterURIToLocal = 'DATASCIENCE.SET_JUPYTER_URI_LOCAL',
+    SetJupyterURIToUserSpecified = 'DATASCIENCE.SET_JUPYTER_URI_USER_SPECIFIED',
+    Interrupt = 'DATASCIENCE.INTERRUPT',
+    ExportPythonFile = 'DATASCIENCE.EXPORT_PYTHON_FILE',
+    ExportPythonFileAndOutput = 'DATASCIENCE.EXPORT_PYTHON_FILE_AND_OUTPUT',
+    StartJupyter = 'DATASCIENCE.JUPYTERSTARTUPCOST',
+    SubmitCellThroughInput = 'DATASCIENCE.SUBMITCELLFROMREPL',
+    ConnectLocalJupyter = 'DATASCIENCE.CONNECTLOCALJUPYTER',
+    ConnectRemoteJupyter = 'DATASCIENCE.CONNECTREMOTEJUPYTER',
+    ConnectFailedJupyter = 'DATASCIENCE.CONNECTFAILEDJUPYTER'
 }
 
 export namespace HelpLinks {

diff --git a/src/client/datascience/history.ts b/src/client/datascience/history.ts
@@ -405,7 +405,7 @@ export class History implements IWebPanelMessageListener, IHistory {
         }
     }
 
-    @captureTelemetry(Telemetry.SubmitCellThroughInput, {}, false)
+    @captureTelemetry(Telemetry.SubmitCellThroughInput, undefined, false)
     // tslint:disable-next-line:no-any
     private submitNewCell(payload?: any) {
         // If there's any payload, it's the code
@@ -422,7 +422,7 @@ export class History implements IWebPanelMessageListener, IHistory {
         return result;
     }
 
-    private logTelemetry = (event : string) => {
+    private logTelemetry = (event : Telemetry) => {
         sendTelemetryEvent(event);
     }
 
@@ -503,7 +503,7 @@ export class History implements IWebPanelMessageListener, IHistory {
         this.loadPromise = this.loadJupyterServer(true);
     }
 
-    @captureTelemetry(Telemetry.GotoSourceCode, {}, false)
+    @captureTelemetry(Telemetry.GotoSourceCode, undefined, false)
     private gotoCode(file: string, line: number) {
         this.gotoCodeInternal(file, line).catch(err => {
             this.applicationShell.showErrorMessage(err);
@@ -530,7 +530,7 @@ export class History implements IWebPanelMessageListener, IHistory {
         }
     }
 
-    @captureTelemetry(Telemetry.ExportNotebook, {}, false)
+    @captureTelemetry(Telemetry.ExportNotebook, undefined, false)
     // tslint:disable-next-line: no-any no-empty
     private export (payload: any) {
         if (payload.contents) {

diff --git a/src/client/datascience/historycommandlistener.ts b/src/client/datascience/historycommandlistener.ts
@@ -114,7 +114,7 @@ export class HistoryCommandListener implements IDataScienceCommandListener {
         }
     }
 
-    @captureTelemetry(Telemetry.ExportPythonFile, {}, false)
+    @captureTelemetry(Telemetry.ExportPythonFile, undefined, false)
     private async exportFile(file: string): Promise<void> {
         if (file && file.length > 0) {
             // If the current file is the active editor, then generate cells from the document.
@@ -154,7 +154,7 @@ export class HistoryCommandListener implements IDataScienceCommandListener {
         }
     }
 
-    @captureTelemetry(Telemetry.ExportPythonFileAndOutput, {}, false)
+    @captureTelemetry(Telemetry.ExportPythonFileAndOutput, undefined, false)
     private async exportFileAndOutput(file: string): Promise<void> {
         if (file && file.length > 0 && this.jupyterExecution.isNotebookSupported()) {
             // If the current file is the active editor, then generate cells from the document.
@@ -333,7 +333,7 @@ export class HistoryCommandListener implements IDataScienceCommandListener {
 
     }
 
-    @captureTelemetry(Telemetry.ShowHistoryPane, {}, false)
+    @captureTelemetry(Telemetry.ShowHistoryPane, undefined, false)
     private showHistoryPane() : Promise<void>{
         const active = this.historyProvider.getOrCreateActive();
         return active.show();