forked from microsoft/vscode-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtensorBoardPrompt.ts
More file actions
108 lines (95 loc) · 4.08 KB
/
tensorBoardPrompt.ts
File metadata and controls
108 lines (95 loc) · 4.08 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import { inject, injectable } from 'inversify';
import { once } from 'lodash';
import { IApplicationShell, ICommandManager } from '../common/application/types';
import { Commands } from '../common/constants';
import { NativeTensorBoard } from '../common/experiments/groups';
import { IExperimentService, IPersistentState, IPersistentStateFactory } from '../common/types';
import { Common, TensorBoard } from '../common/utils/localize';
import { sendTelemetryEvent } from '../telemetry';
import { EventName } from '../telemetry/constants';
import { TensorBoardEntrypoint, TensorBoardEntrypointTrigger, TensorBoardPromptSelection } from './constants';
enum TensorBoardPromptStateKeys {
ShowNativeTensorBoardPrompt = 'showNativeTensorBoardPrompt',
}
@injectable()
export class TensorBoardPrompt {
private state: IPersistentState<boolean>;
private enabled: boolean;
private inExperiment: Promise<boolean>;
private enabledInCurrentSession = true;
private waitingForUserSelection = false;
private sendTelemetryOnce = once((trigger) => {
sendTelemetryEvent(EventName.TENSORBOARD_ENTRYPOINT_SHOWN, undefined, {
entrypoint: TensorBoardEntrypoint.prompt,
trigger,
});
});
constructor(
@inject(IApplicationShell) private applicationShell: IApplicationShell,
@inject(ICommandManager) private commandManager: ICommandManager,
@inject(IPersistentStateFactory) private persistentStateFactory: IPersistentStateFactory,
@inject(IExperimentService) private experimentService: IExperimentService,
) {
this.state = this.persistentStateFactory.createWorkspacePersistentState<boolean>(
TensorBoardPromptStateKeys.ShowNativeTensorBoardPrompt,
true,
);
this.enabled = this.isPromptEnabled();
this.inExperiment = this.isInExperiment();
}
public async showNativeTensorBoardPrompt(trigger: TensorBoardEntrypointTrigger): Promise<void> {
if (
(await this.inExperiment) &&
this.enabled &&
this.enabledInCurrentSession &&
!this.waitingForUserSelection
) {
const yes = Common.bannerLabelYes();
const no = Common.bannerLabelNo();
const doNotAskAgain = Common.doNotShowAgain();
const options = [yes, no, doNotAskAgain];
this.waitingForUserSelection = true;
this.sendTelemetryOnce(trigger);
const selection = await this.applicationShell.showInformationMessage(
TensorBoard.nativeTensorBoardPrompt(),
...options,
);
this.waitingForUserSelection = false;
this.enabledInCurrentSession = false;
let telemetrySelection = TensorBoardPromptSelection.None;
switch (selection) {
case yes:
telemetrySelection = TensorBoardPromptSelection.Yes;
await this.commandManager.executeCommand(
Commands.LaunchTensorBoard,
TensorBoardEntrypoint.prompt,
trigger,
);
break;
case doNotAskAgain:
telemetrySelection = TensorBoardPromptSelection.DoNotAskAgain;
await this.disablePrompt();
break;
case no:
telemetrySelection = TensorBoardPromptSelection.No;
break;
default:
break;
}
sendTelemetryEvent(EventName.TENSORBOARD_LAUNCH_PROMPT_SELECTION, undefined, {
selection: telemetrySelection,
});
}
}
private isPromptEnabled(): boolean {
return this.state.value;
}
private async isInExperiment(): Promise<boolean> {
return this.experimentService.inExperiment(NativeTensorBoard.experiment);
}
private async disablePrompt() {
await this.state.updateValue(false);
}
}