Add support for VS Code's experiment service

news/1 Enhancements/10790.md

@@ -0,0 +1 @@
+Integrate VS Code experiment framework in the extension.

package.json

@@ -3055,6 +3055,7 @@
         "vscode-languageclient": "^6.2.0-next.2",
         "vscode-languageserver": "^6.2.0-next.2",
         "vscode-languageserver-protocol": "^3.16.0-next.2",
+        "vscode-tas-client": "^0.0.757",
         "vsls": "^0.3.1291",
         "winreg": "^1.2.4",
         "winston": "^3.2.1",

src/client/common/experiments/service.ts

@@ -0,0 +1,101 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { inject, named } from 'inversify';
+import { Memento } from 'vscode';
+import { getExperimentationService, IExperimentationService, TargetPopulation } from 'vscode-tas-client';
+import { sendTelemetryEvent } from '../../telemetry';
+import { EventName } from '../../telemetry/constants';
+import { PVSC_EXTENSION_ID } from '../constants';
+import {
+    GLOBAL_MEMENTO,
+    IConfigurationService,
+    IExperimentService,
+    IExtensions,
+    IMemento,
+    IPythonSettings
+} from '../types';
+import { ExperimentationTelemetry } from './telemetry';
+
+export class ExperimentService implements IExperimentService {
+    /**
+     * Experiments the user requested to opt into manually.
+     */
+    public _optInto: string[] = [];
+    /**
+     * Experiments the user requested to opt out from manually.
+     */
+    public _optOutFrom: string[] = [];
+
+    private readonly experimentationService?: IExperimentationService;
+    private settings!: IPythonSettings;
+
+    constructor(
+        @inject(IConfigurationService) readonly configurationService: IConfigurationService,
+        @inject(IExtensions) readonly extensions: IExtensions,
+        @inject(IMemento) @named(GLOBAL_MEMENTO) readonly globalState: Memento
+    ) {
+        this.settings = configurationService.getSettings(undefined);
+
+        // Users can only opt in or out of experiment groups, not control groups.
+        const optInto = this.settings.experiments.optInto;
+        const optOutFrom = this.settings.experiments.optOutFrom;
+        this._optInto = optInto.filter((exp) => !exp.endsWith('control'));
+        this._optOutFrom = optOutFrom.filter((exp) => !exp.endsWith('control'));
+
+        // Don't initialize the experiment service if the extension's experiments setting is disabled.
+        const enabled = this.settings.experiments.enabled;
+        if (!enabled) {
+            return;
+        }
+
+        const extension = extensions.getExtension(PVSC_EXTENSION_ID)!;
+        const version = extension.packageJSON.version!;
+
+        let targetPopulation: TargetPopulation;
+
+        if (/dev/gi.test(version)) {
+            targetPopulation = TargetPopulation.Insiders;
+        } else {
+            targetPopulation = TargetPopulation.Public;
+        }
+
+        const telemetryReporter = new ExperimentationTelemetry();
+
+        this.experimentationService = getExperimentationService(
+            PVSC_EXTENSION_ID,
+            version,
+            targetPopulation,
+            telemetryReporter,
+            globalState
+        );
+    }
+
+    public async inExperiment(flight: string): Promise<boolean> {
+        if (!this.experimentationService) {
+            return false;
+        }
+
+        // Currently the service doesn't support opting in and out of experiments,
+        // so we need to perform these checks and send the corresponding telemetry manually.
+        if (this._optOutFrom.includes('All') || this._optOutFrom.includes(flight)) {
+            sendTelemetryEvent(EventName.PYTHON_EXPERIMENTS_OPT_IN_OUT, undefined, {
+                expNameOptedOutOf: flight
+            });
+
+            return false;
+        }
+
+        if (this._optInto.includes('All') || this._optInto.includes(flight)) {
+            sendTelemetryEvent(EventName.PYTHON_EXPERIMENTS_OPT_IN_OUT, undefined, {
+                expNameOptedInto: flight
+            });
+
+            return true;
+        }
+
+        return this.experimentationService.isCachedFlightEnabled(flight);
+    }
+}

src/client/common/experiments/telemetry.ts

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { IExperimentationTelemetry } from 'vscode-tas-client';
+import { sendTelemetryEvent } from '../../telemetry';
+
+export class ExperimentationTelemetry implements IExperimentationTelemetry {
+    private readonly sharedProperties: { [key: string]: string } = {};
+
+    public setSharedProperty(name: string, value: string): void {
+        this.sharedProperties[name] = value;
+    }
+
+    public postEvent(eventName: string, properties: Map<string, string>): void {
+        // Add shared properties to telemetry props (we may overwrite existing ones).
+        for (const [key, value] of Object.entries(this.sharedProperties)) {
+            properties.set(key, value);
+        }
+
+        const formattedProperties: { [key: string]: string } = {};
+        properties.forEach((value, key) => {
+            formattedProperties[key] = value;
+        });
+
+        // tslint:disable-next-line: no-any
+        sendTelemetryEvent(eventName as any, undefined, formattedProperties);
+    }
+}

src/client/common/serviceRegistry.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 import { IExtensionSingleActivationService } from '../activation/types';
-import { IFileDownloader, IHttpClient, IInterpreterPathService } from '../common/types';
+import { IExperimentService, IFileDownloader, IHttpClient, IInterpreterPathService } from '../common/types';
 import { LiveShareApi } from '../datascience/liveshare/liveshare';
 import { INotebookExecutionLogger } from '../datascience/types';
 import { IServiceManager } from '../ioc/types';
@@ -42,6 +42,7 @@ import { ConfigurationService } from './configuration/service';
 import { CryptoUtils } from './crypto';
 import { EditorUtils } from './editor';
 import { ExperimentsManager } from './experiments/manager';
+import { ExperimentService } from './experiments/service';
 import { FeatureDeprecationManager } from './featureDeprecationManager';
 import {
     ExtensionInsidersDailyChannelRule,
@@ -149,6 +150,7 @@ export function registerTypes(serviceManager: IServiceManager) {
     serviceManager.addSingleton<ILiveShareApi>(ILiveShareApi, LiveShareApi);
     serviceManager.addSingleton<ICryptoUtils>(ICryptoUtils, CryptoUtils);
     serviceManager.addSingleton<IExperimentsManager>(IExperimentsManager, ExperimentsManager);
+    serviceManager.addSingleton<IExperimentService>(IExperimentService, ExperimentService);
 
     serviceManager.addSingleton<ITerminalHelper>(ITerminalHelper, TerminalHelper);
     serviceManager.addSingleton<ITerminalActivationCommandProvider>(

src/client/common/types.ts

@@ -617,6 +617,14 @@ export interface IExperimentsManager {
     sendTelemetryIfInExperiment(experimentName: string): void;
 }
 
+/**
+ * Experiment service leveraging VS Code's experiment framework.
+ */
+export const IExperimentService = Symbol('IExperimentService');
+export interface IExperimentService {
+    inExperiment(experimentName: string): Promise<boolean>;
+}
+
 export type InterpreterConfigurationScope = { uri: Resource; configTarget: ConfigurationTarget };
 export type InspectInterpreterSettingType = {
     globalValue?: string;