Send telemetry when experiment service is ready. (microsoft#17012)

karthiknadig · kimadeline · web-flow · commit 873397538c7b · 2021-08-17T20:19:11.000-07:00
* Send telemetry when experiment service is ready.

* Update tests

* Update src/client/telemetry/index.ts

Co-authored-by: Kim-Adeline Miguel &lt;51720070+kimadeline@users.noreply.github.com&gt;

Co-authored-by: Kim-Adeline Miguel &lt;51720070+kimadeline@users.noreply.github.com&gt;
diff --git a/news/3 Code Health/17011.md b/news/3 Code Health/17011.md
@@ -0,0 +1 @@
+Add telemetry sending time it took to load data from experiment service.
diff --git a/src/client/common/experiments/service.ts b/src/client/common/experiments/service.ts
@@ -81,6 +81,7 @@ export class ExperimentService implements IExperimentService {
 
     public async activate(): Promise<void> {
         if (this.experimentationService) {
+            const initStart = Date.now();
             await this.experimentationService.initializePromise;
 
             const experiments = this.globalState.get<{ features: string[] }>(EXP_MEMENTO_KEY, { features: [] });
@@ -96,6 +97,7 @@ export class ExperimentService implements IExperimentService {
                 // `overrideInMemoryFeatures` was always passed in as `false`. So, the experiment
                 // states did not change mid way.
                 await this.experimentationService.initialFetch;
+                sendTelemetryEvent(EventName.PYTHON_EXPERIMENTS_INIT_PERFORMANCE, Date.now() - initStart);
             }
         }
         sendOptInOptOutTelemetry(this._optInto, this._optOutFrom, this.appEnvironment.packageJson);
diff --git a/src/client/telemetry/constants.ts b/src/client/telemetry/constants.ts
@@ -72,7 +72,9 @@ export enum EventName {
     UNITTEST_RUN_ALL_FAILED = 'UNITTEST.RUN_ALL_FAILED',
     UNITTEST_DISABLED = 'UNITTEST.DISABLED',
 
+    PYTHON_EXPERIMENTS_INIT_PERFORMANCE = 'PYTHON_EXPERIMENTS_INIT_PERFORMANCE',
     PYTHON_EXPERIMENTS_OPT_IN_OPT_OUT_SETTINGS = 'PYTHON_EXPERIMENTS_OPT_IN_OPT_OUT_SETTINGS',
+
     EXTENSION_SURVEY_PROMPT = 'EXTENSION_SURVEY_PROMPT',
     JOIN_MAILING_LIST_PROMPT_DISPLAYED = 'JOIN_MAILING_LIST_PROMPT_DISPLAYED',
     JOIN_MAILING_LIST_PROMPT = 'JOIN_MAILING_LIST_PROMPT',
diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts
@@ -1268,6 +1268,10 @@ export interface IEventNamePropertyMapping {
      * This event also has a measure, "resultLength", which records the number of completions provided.
      */
     [EventName.PYTHON_LANGUAGE_SERVER_REQUEST]: unknown;
+    /**
+     * Telemetry event sent when the experiments service is initialized for the first time.
+     */
+    [EventName.PYTHON_EXPERIMENTS_INIT_PERFORMANCE]: unknown;
     /**
      * Telemetry event sent once on session start with details on which experiments are opted into and opted out from.
      */
diff --git a/src/test/common/experiments/service.unit.test.ts b/src/test/common/experiments/service.unit.test.ts
@@ -431,9 +431,9 @@ suite('Experimentation service', () => {
 
             await experimentService.activate();
 
-            assert.strictEqual(telemetryEvents.length, 1);
-            assert.strictEqual(telemetryEvents[0].eventName, EventName.PYTHON_EXPERIMENTS_OPT_IN_OPT_OUT_SETTINGS);
-            sinon.assert.calledOnce(sendTelemetryEventStub);
+            assert.strictEqual(telemetryEvents.length, 2);
+            assert.strictEqual(telemetryEvents[1].eventName, EventName.PYTHON_EXPERIMENTS_OPT_IN_OPT_OUT_SETTINGS);
+            sinon.assert.calledTwice(sendTelemetryEventStub);
         });
 
         test('The telemetry event properties should only be populated with valid experiment values', async () => {
@@ -465,7 +465,7 @@ suite('Experimentation service', () => {
 
             await experimentService.activate();
 
-            const { properties } = telemetryEvents[0];
+            const { properties } = telemetryEvents[1];
             assert.deepStrictEqual(properties, { optedInto: ['foo'], optedOutFrom: ['bar'] });
         });
 
@@ -498,7 +498,7 @@ suite('Experimentation service', () => {
 
             await experimentService.activate();
 
-            const { properties } = telemetryEvents[0];
+            const { properties } = telemetryEvents[1];
             assert.deepStrictEqual(properties, { optedInto: [], optedOutFrom: [] });
         });
 
@@ -554,7 +554,7 @@ suite('Experimentation service', () => {
 
             await experimentService.activate();
 
-            const { properties } = telemetryEvents[0];
+            const { properties } = telemetryEvents[1];
             assert.deepStrictEqual(properties, { optedInto: [], optedOutFrom: [] });
         });
 
@@ -586,7 +586,7 @@ suite('Experimentation service', () => {
 
             await experimentService.activate();
 
-            const { properties } = telemetryEvents[0];
+            const { properties } = telemetryEvents[1];
             assert.deepStrictEqual(properties, { optedInto: [], optedOutFrom: [] });
         });
     });

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Add telemetry sending time it took to load data from experiment service.`
Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,7 @@ export class ExperimentService implements IExperimentService {`
`81`	`81`
`82`	`82`	`public async activate(): Promise<void> {`
`83`	`83`	`if (this.experimentationService) {`
	`84`	`+ const initStart = Date.now();`
`84`	`85`	`await this.experimentationService.initializePromise;`
`85`	`86`
`86`	`87`	`const experiments = this.globalState.get<{ features: string[] }>(EXP_MEMENTO_KEY, { features: [] });`
`@@ -96,6 +97,7 @@ export class ExperimentService implements IExperimentService {`
`96`	`97`	// `overrideInMemoryFeatures` was always passed in as `false`. So, the experiment
`97`	`98`	`// states did not change mid way.`
`98`	`99`	`await this.experimentationService.initialFetch;`
	`100`	`+ sendTelemetryEvent(EventName.PYTHON_EXPERIMENTS_INIT_PERFORMANCE, Date.now() - initStart);`
`99`	`101`	`}`
`100`	`102`	`}`
`101`	`103`	`sendOptInOptOutTelemetry(this._optInto, this._optOutFrom, this.appEnvironment.packageJson);`