// Copyright (c) Microsoft Corporation. All rights reserved.

// Licensed under the MIT License.

'use strict';

import { inject, injectable, optional } from 'inversify';

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';

import { Common, ExtensionSurveyBanner, LanguageService } from '../common/utils/localize';

import { sendTelemetryEvent } from '../telemetry';

import { EventName } from '../telemetry/constants';

import { IExtensionSingleActivationService } from './types';

// persistent state names, exported to make use of in testing

export enum extensionSurveyStateKeys {

doNotShowAgain = 'doNotShowExtensionSurveyAgain',

disableSurveyForTime = 'doNotShowExtensionSurveyUntilTime'

}

const timeToDisableSurveyFor = 1000 * 60 * 60 * 24 * 7 * 12; // 12 weeks

const WAIT_TIME_TO_SHOW_SURVEY = 1000 * 60 * 60 * 3; // 3 hours

@injectable()

export class ExtensionSurveyPrompt implements IExtensionSingleActivationService {

constructor(

@inject(IApplicationShell) private appShell: IApplicationShell,

@inject(IBrowserService) private browserService: IBrowserService,

@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

) {}

public async activate(): Promise<void> {

if (!this.experiments.inExperiment(ShowExtensionSurveyPrompt.enabled)) {

this.experiments.sendTelemetryIfInExperiment(ShowExtensionSurveyPrompt.control);

return;

}

const show = this.shouldShowBanner();

if (!show) {

return;

}

setTimeout(() => this.showSurvey().ignoreErrors(), this.waitTimeToShowSurvey);

}

@traceDecorators.error('Failed to check whether to display prompt for extension survey')

public shouldShowBanner(): boolean {

const doNotShowSurveyAgain = this.persistentState.createGlobalPersistentState(

extensionSurveyStateKeys.doNotShowAgain,

false

);

if (doNotShowSurveyAgain.value) {

return false;

}

const isSurveyDisabledForTimeState = this.persistentState.createGlobalPersistentState(

extensionSurveyStateKeys.disableSurveyForTime,

false,

timeToDisableSurveyFor

);

if (isSurveyDisabledForTimeState.value) {

return false;

}

// we only want 10% of folks to see this survey.

const randomSample: number = this.random.getRandomInt(0, 100);

if (randomSample >= this.sampleSizePerOneHundredUsers) {

return false;

}

return true;

}

@traceDecorators.error('Failed to display prompt for extension survey')

public async showSurvey() {

const prompts = [LanguageService.bannerLabelYes(), ExtensionSurveyBanner.maybeLater(), Common.doNotShowAgain()];

const telemetrySelections: ['Yes', 'Maybe later', 'Do not show again'] = [

'Yes',

'Maybe later',

'Do not show again'

];

const selection = await this.appShell.showInformationMessage(ExtensionSurveyBanner.bannerMessage(), ...prompts);

sendTelemetryEvent(EventName.EXTENSION_SURVEY_PROMPT, undefined, {

selection: selection ? telemetrySelections[prompts.indexOf(selection)] : undefined

});

if (!selection) {

return;

}

if (selection === LanguageService.bannerLabelYes()) {

this.launchSurvey();

// Disable survey for a few weeks

await this.persistentState

.createGlobalPersistentState(

extensionSurveyStateKeys.disableSurveyForTime,

false,

timeToDisableSurveyFor

)

.updateValue(true);

} else if (selection === Common.doNotShowAgain()) {

// Never show the survey again

await this.persistentState

.createGlobalPersistentState(extensionSurveyStateKeys.doNotShowAgain, false)

.updateValue(true);

}

}

private launchSurvey() {

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);

}

}