Populate survey links with variables (microsoft#8802)

* Populate survey links with variables * Use node's querystring module Co-Authored-By: Eric Snow <ericsnowcurrently@gmail.com> * Mock vscode version out

Author: Kartik Raj

news/1 Enhancements/8484.md

@@ -0,0 +1 @@
+Populate survey links with variables

src/client/activation/extensionSurvey.ts

@@ -4,10 +4,12 @@
 'use strict';
 
 import { inject, injectable, optional } from 'inversify';
-import { IApplicationShell } from '../common/application/types';
+import * as querystring from 'querystring';
+import { IApplicationEnvironment, IApplicationShell } from '../common/application/types';
 import { ShowExtensionSurveyPrompt } from '../common/experimentGroups';
 import '../common/extensions';
 import { traceDecorators } from '../common/logger';
+import { IPlatformService } from '../common/platform/types';
 import {
  IBrowserService, IExperimentsManager, IPersistentStateFactory, IRandom
 } from '../common/types';
@@ -33,6 +35,8 @@ export class ExtensionSurveyPrompt implements IExtensionSingleActivationService
  @inject(IPersistentStateFactory) private persistentState: IPersistentStateFactory,
  @inject(IRandom) private random: IRandom,
  @inject(IExperimentsManager) private experiments: IExperimentsManager,
+ @inject(IApplicationEnvironment) private appEnvironment: IApplicationEnvironment,
+ @inject(IPlatformService) private platformService: IPlatformService,
  @optional() private sampleSizePerOneHundredUsers: number = 10,
  @optional() private waitTimeToShowSurvey: number = WAIT_TIME_TO_SHOW_SURVEY) { }
 
@@ -86,6 +90,13 @@ export class ExtensionSurveyPrompt implements IExtensionSingleActivationService
  }
 
  private launchSurvey() {
- this.browserService.launch('https://aka.ms/AA5rjx5');
+ const query = querystring.stringify({
+ o: encodeURIComponent(this.platformService.osType), // platform
+ v: encodeURIComponent(this.appEnvironment.vscodeVersion),
+ e: encodeURIComponent(this.appEnvironment.packageJson.version), // extension version
+ m: encodeURIComponent(this.appEnvironment.machineId)
+ });
+ const url = `https://aka.ms/AA5rjx5?${query}`;
+ this.browserService.launch(url);
  }
 }

src/client/common/application/applicationEnvironment.ts

@@ -34,6 +34,9 @@ export class ApplicationEnvironment implements IApplicationEnvironment {
  public get appName(): string {
  return vscode.env.appName;
  }
+ public get vscodeVersion(): string {
+ return vscode.version;
+ }
  public get appRoot(): string {
  return vscode.env.appRoot;
  }

src/client/common/application/types.ts

@@ -903,6 +903,10 @@ export interface IApplicationEnvironment {
  * @memberof IApplicationShell
  */
  readonly extensionChannel: Channel;
+ /**
+ * The version of the editor.
+ */
+ readonly vscodeVersion: string;
 }
 
 export const IWebPanelMessageListener = Symbol('IWebPanelMessageListener');

src/test/activation/extensionSurvey.unit.test.ts

@@ -8,12 +8,14 @@ import * as sinon from 'sinon';
 import { anything, instance, mock, verify, when } from 'ts-mockito';
 import * as TypeMoq from 'typemoq';
 import { ExtensionSurveyPrompt, extensionSurveyStateKeys } from '../../client/activation/extensionSurvey';
-import { IApplicationShell } from '../../client/common/application/types';
+import { IApplicationEnvironment, IApplicationShell } from '../../client/common/application/types';
 import { ShowExtensionSurveyPrompt } from '../../client/common/experimentGroups';
 import { PersistentStateFactory } from '../../client/common/persistentState';
+import { IPlatformService } from '../../client/common/platform/types';
 import { IBrowserService, IExperimentsManager, IPersistentState, IPersistentStateFactory, IRandom } from '../../client/common/types';
 import { createDeferred } from '../../client/common/utils/async';
 import { Common, ExtensionSurveyBanner, LanguageService } from '../../client/common/utils/localize';
+import { OSType } from '../../client/common/utils/platform';
 import { sleep } from '../core';
 
 // tslint:disable:no-any
@@ -25,6 +27,8 @@ suite('Extension survey prompt - shouldShowBanner()', () => {
  let random: TypeMoq.IMock<IRandom>;
  let persistentStateFactory: IPersistentStateFactory;
  let experiments: TypeMoq.IMock<IExperimentsManager>;
+ let platformService: TypeMoq.IMock<IPlatformService>;
+ let appEnvironment: TypeMoq.IMock<IApplicationEnvironment>;
  let disableSurveyForTime: TypeMoq.IMock<IPersistentState<any>>;
  let doNotShowAgain: TypeMoq.IMock<IPersistentState<any>>;
  let extensionSurveyPrompt: ExtensionSurveyPrompt;
@@ -36,9 +40,11 @@ suite('Extension survey prompt - shouldShowBanner()', () => {
  persistentStateFactory = mock(PersistentStateFactory);
  disableSurveyForTime = TypeMoq.Mock.ofType<IPersistentState<any>>();
  doNotShowAgain = TypeMoq.Mock.ofType<IPersistentState<any>>();
+ platformService = TypeMoq.Mock.ofType<IPlatformService>();
+ appEnvironment = TypeMoq.Mock.ofType<IApplicationEnvironment>();
  when(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.disableSurveyForTime, false, anything())).thenReturn(disableSurveyForTime.object);
  when(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.doNotShowAgain, false)).thenReturn(doNotShowAgain.object);
- extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, 10);
+ extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, appEnvironment.object, platformService.object, 10);
  });
  test('Returns false if do not show again is clicked', async () => {
  random
@@ -110,7 +116,7 @@ suite('Extension survey prompt - shouldShowBanner()', () => {
  });
 
  test('Always return true if sample size is 100', async () => {
- extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, 100);
+ extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, appEnvironment.object, platformService.object, 100);
  disableSurveyForTime
  .setup(d => d.value)
  .returns(() => false);
@@ -127,7 +133,7 @@ suite('Extension survey prompt - shouldShowBanner()', () => {
  });
 
  test('Always return false if sample size is 0', async () => {
- extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, 0);
+ extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, appEnvironment.object, platformService.object, 0);
  disableSurveyForTime
  .setup(d => d.value)
  .returns(() => false);
@@ -154,6 +160,8 @@ suite('Extension survey prompt - showSurvey()', () => {
  let persistentStateFactory: IPersistentStateFactory;
  let disableSurveyForTime: TypeMoq.IMock<IPersistentState<any>>;
  let doNotShowAgain: TypeMoq.IMock<IPersistentState<any>>;
+ let platformService: TypeMoq.IMock<IPlatformService>;
+ let appEnvironment: TypeMoq.IMock<IApplicationEnvironment>;
  let extensionSurveyPrompt: ExtensionSurveyPrompt;
  setup(() => {
  appShell = TypeMoq.Mock.ofType<IApplicationShell>();
@@ -162,20 +170,42 @@ suite('Extension survey prompt - showSurvey()', () => {
  persistentStateFactory = mock(PersistentStateFactory);
  disableSurveyForTime = TypeMoq.Mock.ofType<IPersistentState<any>>();
  doNotShowAgain = TypeMoq.Mock.ofType<IPersistentState<any>>();
+ platformService = TypeMoq.Mock.ofType<IPlatformService>();
+ appEnvironment = TypeMoq.Mock.ofType<IApplicationEnvironment>();
  when(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.disableSurveyForTime, false, anything())).thenReturn(disableSurveyForTime.object);
  when(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.doNotShowAgain, false)).thenReturn(doNotShowAgain.object);
  experiments = TypeMoq.Mock.ofType<IExperimentsManager>();
- extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, 10);
+ extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, appEnvironment.object, platformService.object, 10);
  });
 
  test('Launch survey if \'Yes\' option is clicked', async () => {
+ const packageJson = {
+ version: 'extensionVersion'
+ };
  const prompts = [LanguageService.bannerLabelYes(), ExtensionSurveyBanner.maybeLater(), Common.doNotShowAgain()];
+ const expectedUrl = `https://aka.ms/AA5rjx5?o=Windows&v=vscodeVersion&e=extensionVersion&m=machineId`;
+ appEnvironment
+ .setup(a => a.packageJson)
+ .returns(() => packageJson)
+ .verifiable(TypeMoq.Times.once());
+ appEnvironment
+ .setup(a => a.vscodeVersion)
+ .returns(() => 'vscodeVersion')
+ .verifiable(TypeMoq.Times.once());
+ appEnvironment
+ .setup(a => a.machineId)
+ .returns(() => 'machineId')
+ .verifiable(TypeMoq.Times.once());
+ platformService
+ .setup(a => a.osType)
+ .returns(() => OSType.Windows)
+ .verifiable(TypeMoq.Times.once());
  appShell
  .setup(a => a.showInformationMessage(ExtensionSurveyBanner.bannerMessage(), ...prompts))
  .returns(() => Promise.resolve(LanguageService.bannerLabelYes()))
  .verifiable(TypeMoq.Times.once());
  browserService
- .setup(s => s.launch(TypeMoq.It.isAny()))
+ .setup(s => s.launch(expectedUrl))
  .returns(() => Promise.resolve())
  .verifiable(TypeMoq.Times.once());
  disableSurveyForTime
@@ -186,17 +216,24 @@ suite('Extension survey prompt - showSurvey()', () => {
  .setup(d => d.updateValue(true))
  .returns(() => Promise.resolve())
  .verifiable(TypeMoq.Times.never());
+
  await extensionSurveyPrompt.showSurvey();
+
  verify(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.disableSurveyForTime, false, anything())).once();
  verify(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.doNotShowAgain, false)).never();
  appShell.verifyAll();
  browserService.verifyAll();
  disableSurveyForTime.verifyAll();
  doNotShowAgain.verifyAll();
+ appEnvironment.verifyAll();
+ platformService.verifyAll();
  });
 
  test('Do nothing if \'Maybe later\' option is clicked', async () => {
  const prompts = [LanguageService.bannerLabelYes(), ExtensionSurveyBanner.maybeLater(), Common.doNotShowAgain()];
+ platformService
+ .setup(p => p.osType)
+ .verifiable(TypeMoq.Times.never());
  appShell
  .setup(a => a.showInformationMessage(ExtensionSurveyBanner.bannerMessage(), ...prompts))
  .returns(() => Promise.resolve(ExtensionSurveyBanner.maybeLater()))
@@ -213,17 +250,23 @@ suite('Extension survey prompt - showSurvey()', () => {
  .setup(d => d.updateValue(true))
  .returns(() => Promise.resolve())
  .verifiable(TypeMoq.Times.never());
+
  await extensionSurveyPrompt.showSurvey();
+
  verify(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.disableSurveyForTime, false, anything())).never();
  verify(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.doNotShowAgain, false)).never();
  appShell.verifyAll();
  browserService.verifyAll();
  disableSurveyForTime.verifyAll();
  doNotShowAgain.verifyAll();
+ platformService.verifyAll();
  });
 
  test('Do nothing if no option is clicked', async () => {
  const prompts = [LanguageService.bannerLabelYes(), ExtensionSurveyBanner.maybeLater(), Common.doNotShowAgain()];
+ platformService
+ .setup(p => p.osType)
+ .verifiable(TypeMoq.Times.never());
  appShell
  .setup(a => a.showInformationMessage(ExtensionSurveyBanner.bannerMessage(), ...prompts))
  .returns(() => Promise.resolve(undefined))
@@ -240,17 +283,23 @@ suite('Extension survey prompt - showSurvey()', () => {
  .setup(d => d.updateValue(true))
  .returns(() => Promise.resolve())
  .verifiable(TypeMoq.Times.never());
+
  await extensionSurveyPrompt.showSurvey();
+
  verify(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.disableSurveyForTime, false, anything())).never();
  verify(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.doNotShowAgain, false)).never();
  appShell.verifyAll();
  browserService.verifyAll();
  disableSurveyForTime.verifyAll();
  doNotShowAgain.verifyAll();
+ platformService.verifyAll();
  });
 
  test('Disable prompt if \'Do not show again\' option is clicked', async () => {
  const prompts = [LanguageService.bannerLabelYes(), ExtensionSurveyBanner.maybeLater(), Common.doNotShowAgain()];
+ platformService
+ .setup(p => p.osType)
+ .verifiable(TypeMoq.Times.never());
  appShell
  .setup(a => a.showInformationMessage(ExtensionSurveyBanner.bannerMessage(), ...prompts))
  .returns(() => Promise.resolve(Common.doNotShowAgain()))
@@ -267,13 +316,16 @@ suite('Extension survey prompt - showSurvey()', () => {
  .setup(d => d.updateValue(true))
  .returns(() => Promise.resolve())
  .verifiable(TypeMoq.Times.once());
+
  await extensionSurveyPrompt.showSurvey();
+
  verify(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.disableSurveyForTime, false, anything())).never();
  verify(persistentStateFactory.createGlobalPersistentState(extensionSurveyStateKeys.doNotShowAgain, false)).once();
  appShell.verifyAll();
  browserService.verifyAll();
  disableSurveyForTime.verifyAll();
  doNotShowAgain.verifyAll();
+ platformService.verifyAll();
  });
 });
 
@@ -287,12 +339,16 @@ suite('Extension survey prompt - activate()', () => {
  let showSurvey: sinon.SinonStub<any>;
  let experiments: TypeMoq.IMock<IExperimentsManager>;
  let extensionSurveyPrompt: ExtensionSurveyPrompt;
+ let platformService: TypeMoq.IMock<IPlatformService>;
+ let appEnvironment: TypeMoq.IMock<IApplicationEnvironment>;
  setup(() => {
  appShell = TypeMoq.Mock.ofType<IApplicationShell>();
  browserService = TypeMoq.Mock.ofType<IBrowserService>();
  random = TypeMoq.Mock.ofType<IRandom>();
  persistentStateFactory = mock(PersistentStateFactory);
  experiments = TypeMoq.Mock.ofType<IExperimentsManager>();
+ platformService = TypeMoq.Mock.ofType<IPlatformService>();
+ appEnvironment = TypeMoq.Mock.ofType<IApplicationEnvironment>();
  });
 
  teardown(() => {
@@ -303,7 +359,7 @@ suite('Extension survey prompt - activate()', () => {
  shouldShowBanner = sinon.stub(ExtensionSurveyPrompt.prototype, 'shouldShowBanner');
  shouldShowBanner.callsFake(() => false);
  showSurvey = sinon.stub(ExtensionSurveyPrompt.prototype, 'showSurvey');
- extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, 10);
+ extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, appEnvironment.object, platformService.object, 10);
  experiments
  .setup(exp => exp.inExperiment(ShowExtensionSurveyPrompt.enabled))
  .returns(() => false)
@@ -327,7 +383,7 @@ suite('Extension survey prompt - activate()', () => {
  return Promise.resolve();
  });
  // waitTimeToShowSurvey = 50 ms
- extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, 10, 50);
+ extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, appEnvironment.object, platformService.object, 10, 50);
  experiments
  .setup(exp => exp.inExperiment(ShowExtensionSurveyPrompt.enabled))
  .returns(() => true)
@@ -355,7 +411,7 @@ suite('Extension survey prompt - activate()', () => {
  return Promise.resolve();
  });
  // waitTimeToShowSurvey = 50 ms
- extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, 10, 50);
+ extensionSurveyPrompt = new ExtensionSurveyPrompt(appShell.object, browserService.object, instance(persistentStateFactory), random.object, experiments.object, appEnvironment.object, platformService.object, 10, 50);
  experiments
  .setup(exp => exp.inExperiment(ShowExtensionSurveyPrompt.enabled))
  .returns(() => true)