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

// Licensed under the MIT License.

'use strict';

import { DiagnosticCodes } from '../application/diagnostics/constants';

import { TerminalShellType } from '../common/terminal/types';

import { DebugConfigurationType } from '../debugger/extension/types';

import { AutoSelectionRule } from '../interpreter/autoSelection/types';

import { InterpreterType } from '../interpreter/contracts';

import { LinterId } from '../linters/types';

import { IEventNamePropertyMapping } from '../telemetry/index'

import { EventName, PlatformErrors } from './constants';

export type EditorLoadTelemetry = {

condaVersion: string | undefined;

pythonVersion: string | undefined;

interpreterType: InterpreterType | undefined;

terminal: TerminalShellType;

workspaceFolderCount: number;

hasPython3: boolean;

usingUserDefinedInterpreter: boolean;

usingAutoSelectedWorkspaceInterpreter: boolean;

usingGlobalInterpreter: boolean;

};

export type FormatTelemetry = {

tool: 'autopep8' | 'black' | 'yapf';

hasCustomArgs: boolean;

formatSelection: boolean;

};

export type LanguageServerVersionTelemetry = {

success: boolean;

lsVersion?: string;

usedSSL?: boolean;

};

export type LanguageServerErrorTelemetry = {

error: string;

};

export type LanguageServePlatformSupported = {

supported: boolean;

failureType?: 'UnknownError';

};

export type LinterTrigger = 'auto' | 'save';

export type LintingTelemetry = {

tool: LinterId;

hasCustomArgs: boolean;

trigger: LinterTrigger;

executableSpecified: boolean;

};

export type LinterInstallPromptTelemetry = {

tool?: LinterId;

action: 'select' | 'disablePrompt' | 'install';

};

export type LinterSelectionTelemetry = {

tool?: LinterId;

enabled: boolean;

};

export type PythonInterpreterTelemetry = {

trigger: 'ui' | 'shebang' | 'load';

failed: boolean;

pythonVersion?: string;

pipVersion?: string;

};

export type CodeExecutionTelemetry = {

scope: 'file' | 'selection';

};

export type DebuggerTelemetry = IEventNamePropertyMapping[EventName.DEBUGGER];

export type DebuggerPerformanceTelemetry = {

duration: number;

action: 'stepIn' | 'stepOut' | 'continue' | 'next' | 'launch';

};

export type TestTool = 'nosetest' | 'pytest' | 'unittest';

export type TestRunTelemetry = {

tool: TestTool;

scope: 'currentFile' | 'all' | 'file' | 'class' | 'function' | 'failed';

debugging: boolean;

triggerSource: 'ui' | 'codelens' | 'commandpalette' | 'auto' | 'testExplorer';

failed: boolean;

};

export type TestDiscoverytTelemetry = {

tool: TestTool;

trigger: 'ui' | 'commandpalette';

failed: boolean;

};

export type TestConfiguringTelemetry = {

tool?: TestTool;

trigger: 'ui' | 'commandpalette';

failed: boolean;

};

export type FeedbackTelemetry = {

action: 'accepted' | 'dismissed' | 'doNotShowAgain';

};

export type SettingsTelemetry = {

enabled: boolean;

};

export type TerminalTelemetry = {

terminal?: TerminalShellType;

triggeredBy?: 'commandpalette';

pythonVersion?: string;

interpreterType?: InterpreterType;

};

export type DebuggerConfigurationPromtpsTelemetry = {

configurationType: DebugConfigurationType;

autoDetectedDjangoManagePyPath?: boolean;

autoDetectedPyramidIniPath?: boolean;

autoDetectedFlaskAppPyPath?: boolean;

manuallyEnteredAValue?: boolean;

};

export type DiagnosticsAction = {

/**

* Diagnostics command executed.

* @type {string}

*/

commandName?: string;

/**

* Diagnostisc code ignored (message will not be seen again).

* @type {string}

*/

ignoreCode?: string;

/**

* Url of web page launched in browser.

* @type {string}

*/

url?: string;

/**

* Custom actions performed.

* @type {'switchToCommandPrompt'}

*/

action?: 'switchToCommandPrompt';

};

export type DiagnosticsMessages = {

/**

* Code of diagnostics message detected and displayed.

* @type {string}

*/

code: DiagnosticCodes;

};

export type ImportNotebook = {

scope: 'command';

};

export type Platform = {

failureType?: PlatformErrors;

osVersion?: string;

};

export type InterpreterAutoSelection = {

rule?: AutoSelectionRule;

interpreterMissing?: boolean;

identified?: boolean;

updated?: boolean;

};

export type InterpreterDiscovery = {

locator: string;

};

export type InterpreterActivationEnvironmentVariables = {

hasEnvVars?: boolean;

failed?: boolean;

};

export type InterpreterActivation = {

hasCommands?: boolean;

failed?: boolean;

terminal: TerminalShellType;

pythonVersion?: string;

interpreterType: InterpreterType;

};

export const IImportTracker = Symbol('IImportTracker');

export interface IImportTracker {

activate(): Promise<void>;

}