send metric for PackageInstallAttemptFailed (#77)

docascode · Mar 2, 2020 · f6db88b · f6db88b
1 parent 5f5df5c
commit f6db88b
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 4 deletions.
diff --git a/src/observers/telemetryObserver.ts b/src/observers/telemetryObserver.ts
@@ -1,4 +1,4 @@
-import { BaseEvent, UserSignInTriggered, UserSignInCompleted, UserSignInSucceeded, UserSignInFailed, UserSignOutTriggered, UserSignOutCompleted, BuildTriggered, BuildCompleted, BuildSucceeded, BuildFailed, BuildCacheSizeCalculated, LearnMoreClicked, QuickPickTriggered, QuickPickCommandSelected, DependencyInstallStarted, DependencyInstallCompleted, PackageInstallCompleted } from '../common/loggingEvents';
+import { BaseEvent, UserSignInTriggered, UserSignInCompleted, UserSignInSucceeded, UserSignInFailed, UserSignOutTriggered, UserSignOutCompleted, BuildTriggered, BuildCompleted, BuildSucceeded, BuildFailed, BuildCacheSizeCalculated, LearnMoreClicked, QuickPickTriggered, QuickPickCommandSelected, DependencyInstallStarted, DependencyInstallCompleted, PackageInstallCompleted, PackageInstallAttemptFailed } from '../common/loggingEvents';
 import { EventType } from '../common/eventType';
 import { DocsSignInType } from '../shared';
 import { DocsError } from '../error/docsError';
@@ -41,8 +41,9 @@ export class TelemetryObserver {
             case EventType.PackageInstallCompleted:
                 this.handlePackageInstallCompleted(<PackageInstallCompleted>event);
                 break;
-            // TODO: Send Metric for event PackageInstallAttemptFailed
-            // Depends on this PR: https://github.com/microsoft/vscode-extension-telemetry/pull/42
+            case EventType.PackageInstallAttemptFailed:
+                this.handlePackageInstallAttemptFailed(<PackageInstallAttemptFailed>event);
+                break;
             case EventType.QuickPickTriggered:
                 this.handleQuickPickTriggered(<QuickPickTriggered>event);
                 break;
@@ -215,6 +216,18 @@ export class TelemetryObserver {
         );
     }
 
+    private handlePackageInstallAttemptFailed(event: PackageInstallAttemptFailed){
+        this.reporter.sendTelemetryMetric(
+            'InstallDependency.Package.Error',
+            1,
+            {
+                CorrelationId: event.correlationId,
+                PackageId: event.installedPackage.id,
+                ErrorCode: this.getErrorCode(event.err)
+            }
+        );
+    }
+
     private handleQuickPickTriggered(event: QuickPickTriggered) {
         this.reporter.sendTelemetryEvent(
             'QuickPick.Triggered',

diff --git a/test/unitTests/observers/telemetryObserver.test.ts b/test/unitTests/observers/telemetryObserver.test.ts
@@ -1,5 +1,5 @@
 import assert from 'assert';
-import { UserSignInTriggered, UserSignInSucceeded, UserSignInFailed, UserSignOutTriggered, UserSignOutSucceeded, UserSignOutFailed, BuildCanceled, BuildFailed, BuildTriggered, BuildSucceeded, LearnMoreClicked, QuickPickTriggered, QuickPickCommandSelected, DependencyInstallStarted, DependencyInstallCompleted, PackageInstallCompleted, BuildCacheSizeCalculated, } from '../../../src/common/loggingEvents';
+import { UserSignInTriggered, UserSignInSucceeded, UserSignInFailed, UserSignOutTriggered, UserSignOutSucceeded, UserSignOutFailed, BuildCanceled, BuildFailed, BuildTriggered, BuildSucceeded, LearnMoreClicked, QuickPickTriggered, QuickPickCommandSelected, DependencyInstallStarted, DependencyInstallCompleted, PackageInstallCompleted, BuildCacheSizeCalculated, PackageInstallAttemptFailed, } from '../../../src/common/loggingEvents';
 import { TelemetryObserver } from '../../../src/observers/telemetryObserver';
 import { DocsError } from '../../../src/error/docsError';
 import { ErrorCode } from '../../../src/error/errorCode';
@@ -11,6 +11,9 @@ import TelemetryReporter from '../../../src/telemetryReporter';
 describe('TelemetryObserver', () => {
     let observer: TelemetryObserver;
 
+    let sentMetricName: string;
+    let sentMetricValue: number;
+    let sentMetricProperties: any;
     let sentEventName: string;
     let sentEventProperties: any;
     let sentEventMeasurements: any;
@@ -24,6 +27,15 @@ describe('TelemetryObserver', () => {
             sentEventName = eventName;
             sentEventProperties = properties;
             sentEventMeasurements = measurements;
+        },
+        sendTelemetryMetric(
+            metricName: string,
+            value: number,
+            properties?: { [key: string]: string }
+        ): void {
+            sentMetricName = metricName;
+            sentMetricProperties = properties;
+            sentMetricValue = value;
         }
     };
 
@@ -32,6 +44,9 @@ describe('TelemetryObserver', () => {
     });
 
     beforeEach(() => {
+        sentMetricName = undefined;
+        sentMetricProperties = undefined;
+        sentMetricValue = undefined;
         sentEventName = undefined;
         sentEventProperties = undefined;
         sentEventMeasurements = undefined;
@@ -314,6 +329,18 @@ describe('TelemetryObserver', () => {
         });
     });
 
+    it(`PackageInstallAttemptFailed: 'InstallDependency.Package.Error' metric should be sent`, () => {
+        let event = new PackageInstallAttemptFailed('fakedCorrelationId', fakedPackage, 1, new DocsError('Faked error msg', ErrorCode.CheckIntegrityFailed));
+        observer.eventHandler(event);
+        assert.equal(sentMetricName, 'InstallDependency.Package.Error');
+        assert.equal(sentMetricValue, 1);
+        assert.deepStrictEqual(sentMetricProperties, {
+            CorrelationId: 'fakedCorrelationId',
+            PackageId: 'faked-id',
+            ErrorCode: 'CheckIntegrityFailed'
+        });
+    });
+
     it(`QuickPickTriggered: 'QuickPick.Triggered' event should be sent`, () => {
         let event = new QuickPickTriggered('fakedCorrelationId');
         observer.eventHandler(event);