forked from DonJayamanne/pythonVSCode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathstartupTelemetry.ts
More file actions
141 lines (132 loc) · 6.06 KB
/
startupTelemetry.ts
File metadata and controls
141 lines (132 loc) · 6.06 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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import * as vscode from 'vscode';
import { IWorkspaceService } from './common/application/types';
import { isTestExecution } from './common/constants';
import { ITerminalHelper } from './common/terminal/types';
import { IInterpreterPathService, Resource } from './common/types';
import { IStopWatch } from './common/utils/stopWatch';
import { IInterpreterAutoSelectionService } from './interpreter/autoSelection/types';
import { ICondaService, IInterpreterService } from './interpreter/contracts';
import { IServiceContainer } from './ioc/types';
import { traceError } from './logging';
import { EnvironmentType, PythonEnvironment } from './pythonEnvironments/info';
import { sendTelemetryEvent } from './telemetry';
import { EventName } from './telemetry/constants';
import { EditorLoadTelemetry } from './telemetry/types';
import { IStartupDurations } from './types';
export async function sendStartupTelemetry(
activatedPromise: Promise<any>,
durations: IStartupDurations,
stopWatch: IStopWatch,
serviceContainer: IServiceContainer,
isFirstSession: boolean,
) {
if (isTestExecution()) {
return;
}
try {
await activatedPromise;
durations.totalNonBlockingActivateTime = stopWatch.elapsedTime - durations.startActivateTime;
const props = await getActivationTelemetryProps(serviceContainer, isFirstSession);
sendTelemetryEvent(EventName.EDITOR_LOAD, durations, props);
} catch (ex) {
traceError('sendStartupTelemetry() failed.', ex);
}
}
export async function sendErrorTelemetry(
ex: Error,
durations: IStartupDurations,
serviceContainer?: IServiceContainer,
) {
try {
let props: any = {};
if (serviceContainer) {
try {
props = await getActivationTelemetryProps(serviceContainer);
} catch (ex) {
traceError('getActivationTelemetryProps() failed.', ex);
}
}
sendTelemetryEvent(EventName.EDITOR_LOAD, durations, props, ex);
} catch (exc2) {
traceError('sendErrorTelemetry() failed.', exc2);
}
}
function isUsingGlobalInterpreterInWorkspace(currentPythonPath: string, serviceContainer: IServiceContainer): boolean {
const service = serviceContainer.get<IInterpreterAutoSelectionService>(IInterpreterAutoSelectionService);
const globalInterpreter = service.getAutoSelectedInterpreter(undefined);
if (!globalInterpreter) {
return false;
}
return currentPythonPath === globalInterpreter.path;
}
export function hasUserDefinedPythonPath(resource: Resource, serviceContainer: IServiceContainer) {
const interpreterPathService = serviceContainer.get<IInterpreterPathService>(IInterpreterPathService);
let settings = interpreterPathService.inspect(resource);
return (settings.workspaceFolderValue && settings.workspaceFolderValue !== 'python') ||
(settings.workspaceValue && settings.workspaceValue !== 'python') ||
(settings.globalValue && settings.globalValue !== 'python')
? true
: false;
}
async function getActivationTelemetryProps(
serviceContainer: IServiceContainer,
isFirstSession?: boolean,
): Promise<EditorLoadTelemetry> {
// TODO: Not all of this data is showing up in the database...
// TODO: If any one of these parts fails we send no info. We should
// be able to partially populate as much as possible instead
// (through granular try-catch statements).
const appName = vscode.env.appName;
const workspaceService = serviceContainer.get<IWorkspaceService>(IWorkspaceService);
const workspaceFolderCount = workspaceService.workspaceFolders?.length || 0;
const terminalHelper = serviceContainer.get<ITerminalHelper>(ITerminalHelper);
const terminalShellType = terminalHelper.identifyTerminalShell();
if (!workspaceService.isTrusted) {
return { workspaceFolderCount, terminal: terminalShellType, isFirstSession };
}
const interpreterService = serviceContainer.get<IInterpreterService>(IInterpreterService);
const mainWorkspaceUri = workspaceService.workspaceFolders?.length
? workspaceService.workspaceFolders[0].uri
: undefined;
const hasPythonThree = await interpreterService.hasInterpreters(async (item) => item.version?.major === 3);
// If an unknown type environment can be found from windows registry or path env var,
// consider them as global type instead of unknown. Such types can only be known after
// windows registry is queried. So wait for the refresh of windows registry locator to
// finish. API getActiveInterpreter() does not block on windows registry by default as
// it is slow.
await interpreterService.refreshPromise;
const interpreter = await interpreterService
.getActiveInterpreter()
.catch<PythonEnvironment | undefined>(() => undefined);
const pythonVersion = interpreter && interpreter.version ? interpreter.version.raw : undefined;
const interpreterType = interpreter ? interpreter.envType : undefined;
if (interpreterType === EnvironmentType.Unknown) {
traceError('Active interpreter type is detected as Unknown', JSON.stringify(interpreter));
}
let condaVersion = undefined;
if (interpreterType === EnvironmentType.Conda) {
const condaLocator = serviceContainer.get<ICondaService>(ICondaService);
condaVersion = await condaLocator
.getCondaVersion()
.then((ver) => (ver ? ver.raw : ''))
.catch<string>(() => '');
}
const usingUserDefinedInterpreter = hasUserDefinedPythonPath(mainWorkspaceUri, serviceContainer);
const usingGlobalInterpreter = interpreter
? isUsingGlobalInterpreterInWorkspace(interpreter.path, serviceContainer)
: false;
return {
condaVersion,
terminal: terminalShellType,
pythonVersion,
interpreterType,
workspaceFolderCount,
hasPythonThree,
usingUserDefinedInterpreter,
usingGlobalInterpreter,
appName,
isFirstSession,
};
}