forked from DonJayamanne/pythonVSCode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathenvFileTelemetry.ts
More file actions
79 lines (64 loc) · 2.42 KB
/
envFileTelemetry.ts
File metadata and controls
79 lines (64 loc) · 2.42 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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
'use strict';
import { IWorkspaceService } from '../common/application/types';
import { IFileSystem } from '../common/platform/types';
import { Resource } from '../common/types';
import { SystemVariables } from '../common/variables/systemVariables';
import { sendTelemetryEvent } from '.';
import { EventName } from './constants';
let _defaultEnvFileSetting: string | undefined;
let envFileTelemetrySent = false;
export function sendSettingTelemetry(workspaceService: IWorkspaceService, envFileSetting?: string) {
if (shouldSendTelemetry() && envFileSetting !== defaultEnvFileSetting(workspaceService)) {
sendTelemetry(true);
}
}
export function sendFileCreationTelemetry() {
if (shouldSendTelemetry()) {
sendTelemetry();
}
}
export async function sendActivationTelemetry(
fileSystem: IFileSystem,
workspaceService: IWorkspaceService,
resource: Resource
) {
if (shouldSendTelemetry()) {
const systemVariables = new SystemVariables(resource, undefined, workspaceService);
const envFilePath = systemVariables.resolveAny(defaultEnvFileSetting(workspaceService))!;
const envFileExists = await fileSystem.fileExists(envFilePath);
if (envFileExists) {
sendTelemetry();
}
}
}
function sendTelemetry(hasCustomEnvPath: boolean = false) {
sendTelemetryEvent(EventName.ENVFILE_WORKSPACE, undefined, { hasCustomEnvPath });
envFileTelemetrySent = true;
}
function shouldSendTelemetry(): boolean {
return !envFileTelemetrySent;
}
function defaultEnvFileSetting(workspaceService: IWorkspaceService) {
if (!_defaultEnvFileSetting) {
const section = workspaceService.getConfiguration('python');
_defaultEnvFileSetting = section.inspect<string>('envFile')?.defaultValue || '';
}
return _defaultEnvFileSetting;
}
// Set state for tests.
export namespace EnvFileTelemetryTests {
export function setState({ telemetrySent, defaultSetting }: { telemetrySent?: boolean; defaultSetting?: string }) {
if (telemetrySent !== undefined) {
envFileTelemetrySent = telemetrySent;
}
if (defaultEnvFileSetting !== undefined) {
_defaultEnvFileSetting = defaultSetting;
}
}
export function resetState() {
_defaultEnvFileSetting = undefined;
envFileTelemetrySent = false;
}
}