Show Extension Guide in Experiment Group (#462)

* Show Extension Guide in Experiment Group

Signed-off-by: Rome Li <[email protected]>

* Add license info

Signed-off-by: Rome Li <[email protected]>

Author: akaroml

package-lock.json

@@ -135,6 +135,7 @@
     "ts-loader": "^4.3.0",
     "tslint": "^5.20.1",
     "typescript": "^3.7.5",
+    "vscode-tas-client": "^0.1.4",
     "webpack": "^4.43.0",
     "webpack-cli": "^3.3.11"
   },

package.json

@@ -0,0 +1,40 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+import * as vscode from "vscode";
+import { IExperimentationService, IExperimentationTelemetry, getExperimentationService, TargetPopulation } from "vscode-tas-client";
+import { addContextProperty, sendInfo } from "vscode-extension-telemetry-wrapper";
+import { getExtensionName, getExtensionVersion } from "../utils";
+
+class ExperimentationTelemetry implements IExperimentationTelemetry {
+
+  public setSharedProperty(name: string, value: string): void {
+    addContextProperty(name, value);
+  }
+
+  public postEvent(eventName: string, props: Map<string, string>): void {
+    const payload: any = { __event_name__: eventName };
+    for (const [key, value] of props) {
+      payload[key] = value;
+    }
+
+    sendInfo("", payload);
+  }
+
+}
+
+let expService: IExperimentationService;
+
+export function getExpService() {
+  return expService;
+}
+
+export function initialize(context: vscode.ExtensionContext) {
+  expService = getExperimentationService(
+    getExtensionName(),
+    getExtensionVersion(),
+    TargetPopulation.Public,
+    new ExperimentationTelemetry(),
+    context.globalState
+  );
+}

src/exp/index.ts

@@ -8,6 +8,7 @@ import { initialize as initUtils } from "./utils";
 import { initialize as initCommands } from "./commands";
 import { initialize as initRecommendations } from "./recommendation";
 import { initialize as initMisc, showReleaseNotesOnStart, HelpViewType } from "./misc";
+import { initialize as initExp, getExpService } from "./exp";
 import { showOverviewPageOnActivation } from "./overview";
 import { validateJavaRuntime } from "./java-runtime";
 // import { JavaGettingStartedViewSerializer } from "./getting-started";
@@ -23,6 +24,7 @@ async function initializeExtension(operationId: string, context: vscode.Extensio
   initCommands(context);
   initRecommendations(context);
   initMisc(context);
+  initExp(context);
 
   // disable webview serializer because of https://github.com/microsoft/vscode/issues/80185
   // context.subscriptions.push(vscode.window.registerWebviewPanelSerializer("java.overview", new OverviewViewSerializer()));
@@ -45,6 +47,12 @@ async function initializeExtension(operationId: string, context: vscode.Extensio
 }
 
 async function presentFirstView(context: vscode.ExtensionContext) {
+  const presentExtensionGuideByDefault: boolean = await getExpService()?.isFlightEnabledAsync("presentExtensionGuideByDefault") || false;
+  if (presentExtensionGuideByDefault) {
+    showExtensionGuide(context);
+    return;
+  }
+
   const config = vscode.workspace.getConfiguration("java.help");
   const firstView = config.get("firstView");
   if (firstView === HelpViewType.GettingStarted) {
@@ -54,6 +62,15 @@ async function presentFirstView(context: vscode.ExtensionContext) {
   }
 }
 
+async function showExtensionGuide(context: vscode.ExtensionContext) {
+  if (!!context.globalState.get("isExtensionGuidePresented")) {
+    return;
+  }
+
+  await vscode.commands.executeCommand("java.extGuide");
+  context.globalState.update("isExtensionGuidePresented", true);
+}
+
 async function showGettingStartedView(context: vscode.ExtensionContext, isForce: boolean = false) {
   if (!!context.globalState.get("isGettingStartedPresented")) {
     return;

src/extension.ts

@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+export function getExtensionName() {
+  const packageInfo = getPackageInfo();
+  return `${packageInfo["publisher"]}.${packageInfo["name"]}`;
+}
+
+export function getExtensionVersion() {
+  return getPackageInfo()["version"];
+}
+
+function getPackageInfo() {
+  return {} = require("../../package.json");
+}

src/utils/extension.ts

@@ -48,3 +48,4 @@ export async function loadTextFromFile(resourceUri: string) {
 
 export * from "./command";
 export * from "./release-notes";
+export * from "./extension";