From a5c42b2db40ea06424efd4b80d4c8ea11cf5bfd8 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Fri, 5 Jul 2024 06:52:30 +1000 Subject: [PATCH 001/149] Support category being undefined (#23745) --- .../base/locators/common/nativePythonFinder.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index d7ed825728e8..bbd07c7763b4 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -49,7 +49,7 @@ export interface NativeEnvManagerInfo { export interface NativeGlobalPythonFinder extends Disposable { resolve(executable: string): Promise; refresh(): AsyncIterable; - categoryToKind(category: string): PythonEnvKind; + categoryToKind(category?: string): PythonEnvKind; } interface NativeLog { @@ -79,7 +79,10 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba return environment; } - categoryToKind(category: string): PythonEnvKind { + categoryToKind(category?: string): PythonEnvKind { + if (!category) { + return PythonEnvKind.Unknown; + } switch (category.toLowerCase()) { case 'conda': return PythonEnvKind.Conda; @@ -109,8 +112,6 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba return PythonEnvKind.VirtualEnvWrapper; case 'windowsstore': return PythonEnvKind.MicrosoftStore; - case 'unknown': - return PythonEnvKind.Unknown; default: { this.outputChannel.info(`Unknown Python Environment category '${category}' from Native Locator.`); return PythonEnvKind.Unknown; From 5470d60c33c7f16d3240941b6864103fbc50079a Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Mon, 8 Jul 2024 19:34:36 +1000 Subject: [PATCH 002/149] Handle & track conda envs not found (#23753) --- .../locators/common/nativePythonFinder.ts | 2 + .../locators/common/nativePythonTelemetry.ts | 40 +++++++++++++++++++ src/client/telemetry/constants.ts | 1 + src/client/telemetry/index.ts | 40 +++++++++++++++++++ 4 files changed, 83 insertions(+) create mode 100644 src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index bbd07c7763b4..029c131188fa 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -17,6 +17,7 @@ import { VENVFOLDERS_SETTING_KEY, VENVPATH_SETTING_KEY } from '../lowLevel/custo import { getUserHomeDir } from '../../../../common/utils/platform'; import { createLogOutputChannel } from '../../../../common/vscodeApis/windowApis'; import { PythonEnvKind } from '../../info'; +import { sendNativeTelemetry, NativePythonTelemetry } from './nativePythonTelemetry'; const untildify = require('untildify'); @@ -253,6 +254,7 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba this.outputChannel.trace(data.message); } }), + connection.onNotification('telemetry', (data: NativePythonTelemetry) => sendNativeTelemetry(data)), connection.onClose(() => { disposables.forEach((d) => d.dispose()); }), diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts new file mode 100644 index 000000000000..3634ef5008f4 --- /dev/null +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts @@ -0,0 +1,40 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +import { traceError } from '../../../../logging'; +import { sendTelemetryEvent } from '../../../../telemetry'; +import { EventName } from '../../../../telemetry/constants'; + +export type NativePythonTelemetry = MissingCondaEnvironments; + +export type MissingCondaEnvironments = { + event: 'MissingCondaEnvironments'; + data: { + missing: number; + userProvidedCondaExe?: boolean; + rootPrefixNotFound?: boolean; + condaPrefixNotFound?: boolean; + condaManagerNotFound?: boolean; + sysRcNotFound?: boolean; + userRcNotFound?: boolean; + otherRcNotFound?: boolean; + missingEnvDirsFromSysRc?: number; + missingEnvDirsFromUserRc?: number; + missingEnvDirsFromOtherRc?: number; + missingFromSysRcEnvDirs?: number; + missingFromUserRcEnvDirs?: number; + missingFromOtherRcEnvDirs?: number; + }; +}; + +export function sendNativeTelemetry(data: NativePythonTelemetry): void { + switch (data.event) { + case 'MissingCondaEnvironments': { + sendTelemetryEvent(EventName.NATIVE_FINDER_MISSING_CONDA_ENVS, undefined, data.data); + break; + } + default: { + traceError(`Unhandled Telemetry Event type ${data.event}`); + } + } +} diff --git a/src/client/telemetry/constants.ts b/src/client/telemetry/constants.ts index c24f179baed1..48ed3195d4e4 100644 --- a/src/client/telemetry/constants.ts +++ b/src/client/telemetry/constants.ts @@ -19,6 +19,7 @@ export enum EventName { ENVIRONMENT_WITHOUT_PYTHON_SELECTED = 'ENVIRONMENT_WITHOUT_PYTHON_SELECTED', PYTHON_ENVIRONMENTS_API = 'PYTHON_ENVIRONMENTS_API', PYTHON_INTERPRETER_DISCOVERY = 'PYTHON_INTERPRETER_DISCOVERY', + NATIVE_FINDER_MISSING_CONDA_ENVS = 'NATIVE_FINDER_MISSING_CONDA_ENVS', PYTHON_INTERPRETER_DISCOVERY_INVALID_NATIVE = 'PYTHON_INTERPRETER_DISCOVERY_INVALID_NATIVE', PYTHON_INTERPRETER_AUTO_SELECTION = 'PYTHON_INTERPRETER_AUTO_SELECTION', PYTHON_INTERPRETER_ACTIVATION_ENVIRONMENT_VARIABLES = 'PYTHON_INTERPRETER.ACTIVATION_ENVIRONMENT_VARIABLES', diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index 4dcffdfcc81e..e0a90e9192e6 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -1396,6 +1396,46 @@ export interface IEventNamePropertyMapping { */ missingNativeOtherGlobalEnvs?: number; }; + /** + * Telemetry event sent when Native finder fails to find some conda envs. + */ + /* __GDPR__ + "native_finder_missing_conda_envs" : { + "missing" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "userProvidedCondaExe" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "rootPrefixNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaPrefixNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaManagerNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "missingEnvDirsFromSysRc" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "missingEnvDirsFromUserRc" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "missingEnvDirsFromOtherRc" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "missingFromSysRcEnvDirs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "missingFromUserRcEnvDirs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "missingFromOtherRcEnvDirs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + } + */ + [EventName.NATIVE_FINDER_MISSING_CONDA_ENVS]: { + /** + * Number of missing conda environments. + */ + missing: number; + /** + * Whether a conda exe was provided by the user. + */ + userProvidedCondaExe?: boolean; + rootPrefixNotFound?: boolean; + condaPrefixNotFound?: boolean; + condaManagerNotFound?: boolean; + sysRcNotFound?: boolean; + userRcNotFound?: boolean; + otherRcNotFound?: boolean; + missingEnvDirsFromSysRc?: number; + missingEnvDirsFromUserRc?: number; + missingEnvDirsFromOtherRc?: number; + missingFromSysRcEnvDirs?: number; + missingFromUserRcEnvDirs?: number; + missingFromOtherRcEnvDirs?: number; + }; /** * Telemetry event sent when discovery of all python environments using the native locator(virtualenv, conda, pipenv etc.) finishes. */ From d8ae5750d402cdffacbdfc07010eb98184ccd6b2 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Tue, 9 Jul 2024 08:32:05 +1000 Subject: [PATCH 003/149] Add more data for conda envs not found (#23770) --- .../locators/common/nativePythonTelemetry.ts | 37 +++++++++------- src/client/telemetry/index.ts | 43 +++++++++++++++++++ 2 files changed, 65 insertions(+), 15 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts index 3634ef5008f4..b693f81e7e38 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts @@ -10,27 +10,34 @@ export type NativePythonTelemetry = MissingCondaEnvironments; export type MissingCondaEnvironments = { event: 'MissingCondaEnvironments'; data: { - missing: number; - userProvidedCondaExe?: boolean; - rootPrefixNotFound?: boolean; - condaPrefixNotFound?: boolean; - condaManagerNotFound?: boolean; - sysRcNotFound?: boolean; - userRcNotFound?: boolean; - otherRcNotFound?: boolean; - missingEnvDirsFromSysRc?: number; - missingEnvDirsFromUserRc?: number; - missingEnvDirsFromOtherRc?: number; - missingFromSysRcEnvDirs?: number; - missingFromUserRcEnvDirs?: number; - missingFromOtherRcEnvDirs?: number; + missingCondaEnvironments: { + missing: number; + envDirsNotFound?: number; + userProvidedCondaExe?: boolean; + rootPrefixNotFound?: boolean; + condaPrefixNotFound?: boolean; + condaManagerNotFound?: boolean; + sysRcNotFound?: boolean; + userRcNotFound?: boolean; + otherRcNotFound?: boolean; + missingEnvDirsFromSysRc?: number; + missingEnvDirsFromUserRc?: number; + missingEnvDirsFromOtherRc?: number; + missingFromSysRcEnvDirs?: number; + missingFromUserRcEnvDirs?: number; + missingFromOtherRcEnvDirs?: number; + }; }; }; export function sendNativeTelemetry(data: NativePythonTelemetry): void { switch (data.event) { case 'MissingCondaEnvironments': { - sendTelemetryEvent(EventName.NATIVE_FINDER_MISSING_CONDA_ENVS, undefined, data.data); + sendTelemetryEvent( + EventName.NATIVE_FINDER_MISSING_CONDA_ENVS, + undefined, + data.data.missingCondaEnvironments, + ); break; } default: { diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index e0a90e9192e6..ade7ec8a8c15 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -1402,6 +1402,7 @@ export interface IEventNamePropertyMapping { /* __GDPR__ "native_finder_missing_conda_envs" : { "missing" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "envDirsNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "userProvidedCondaExe" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, "rootPrefixNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, "condaPrefixNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, @@ -1419,21 +1420,63 @@ export interface IEventNamePropertyMapping { * Number of missing conda environments. */ missing: number; + /** + * Total number of env_dirs not found even after parsing the conda_rc files. + * This will tell us that we are either unable to parse some of the conda_rc files or there are other + * env_dirs that we are not able to find. + */ + envDirsNotFound?: number; /** * Whether a conda exe was provided by the user. */ userProvidedCondaExe?: boolean; + /** + * Whether the user provided a conda executable. + */ rootPrefixNotFound?: boolean; + /** + * Whether the conda prefix returned by conda was not found by us. + */ condaPrefixNotFound?: boolean; + /** + * Whether we found a conda manager or not. + */ condaManagerNotFound?: boolean; + /** + * Whether we failed to find the system rc path. + */ sysRcNotFound?: boolean; + /** + * Whether we failed to find the user rc path. + */ userRcNotFound?: boolean; + /** + * Number of config files (excluding sys and user rc) that were not found. + */ otherRcNotFound?: boolean; + /** + * Number of conda envs that were not found by us, and the envs belong to env_dirs in the sys config rc. + */ missingEnvDirsFromSysRc?: number; + /** + * Number of conda envs that were not found by us, and the envs belong to env_dirs in the user config rc. + */ missingEnvDirsFromUserRc?: number; + /** + * Number of conda envs that were not found by us, and the envs belong to env_dirs in the other config rc. + */ missingEnvDirsFromOtherRc?: number; + /** + * Number of conda envs that were not found by us, and the envs belong to env_dirs in the sys config rc. + */ missingFromSysRcEnvDirs?: number; + /** + * Number of conda envs that were not found by us, and the envs belong to env_dirs in the user config rc. + */ missingFromUserRcEnvDirs?: number; + /** + * Number of conda envs that were not found by us, and the envs belong to env_dirs in the other config rc. + */ missingFromOtherRcEnvDirs?: number; }; /** From a5c539d7074d9328ff847f7f29475c2cab35acb6 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Tue, 9 Jul 2024 12:36:35 +1000 Subject: [PATCH 004/149] Determine reasons for Poetry find failures (#23771) --- .../locators/common/nativePythonTelemetry.ts | 30 +++++++++- src/client/telemetry/constants.ts | 1 + src/client/telemetry/index.ts | 59 +++++++++++++++++++ 3 files changed, 88 insertions(+), 2 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts index b693f81e7e38..1bedbaf23699 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts @@ -5,7 +5,7 @@ import { traceError } from '../../../../logging'; import { sendTelemetryEvent } from '../../../../telemetry'; import { EventName } from '../../../../telemetry/constants'; -export type NativePythonTelemetry = MissingCondaEnvironments; +export type NativePythonTelemetry = MissingCondaEnvironments | MissingPoetryEnvironments; export type MissingCondaEnvironments = { event: 'MissingCondaEnvironments'; @@ -30,6 +30,24 @@ export type MissingCondaEnvironments = { }; }; +export type MissingPoetryEnvironments = { + event: 'MissingPoetryEnvironments'; + data: { + missingPoetryEnvironments: { + missing: number; + missingInPath: number; + userProvidedPoetryExe?: boolean; + poetryExeNotFound?: boolean; + globalConfigNotFound?: boolean; + cacheDirNotFound?: boolean; + cacheDirIsDifferent?: boolean; + virtualenvsPathNotFound?: boolean; + virtualenvsPathIsDifferent?: boolean; + inProjectIsDifferent?: boolean; + }; + }; +}; + export function sendNativeTelemetry(data: NativePythonTelemetry): void { switch (data.event) { case 'MissingCondaEnvironments': { @@ -40,8 +58,16 @@ export function sendNativeTelemetry(data: NativePythonTelemetry): void { ); break; } + case 'MissingPoetryEnvironments': { + sendTelemetryEvent( + EventName.NATIVE_FINDER_MISSING_POETRY_ENVS, + undefined, + data.data.missingPoetryEnvironments, + ); + break; + } default: { - traceError(`Unhandled Telemetry Event type ${data.event}`); + traceError(`Unhandled Telemetry Event type ${JSON.stringify(data)}`); } } } diff --git a/src/client/telemetry/constants.ts b/src/client/telemetry/constants.ts index 48ed3195d4e4..69c3a58385d0 100644 --- a/src/client/telemetry/constants.ts +++ b/src/client/telemetry/constants.ts @@ -20,6 +20,7 @@ export enum EventName { PYTHON_ENVIRONMENTS_API = 'PYTHON_ENVIRONMENTS_API', PYTHON_INTERPRETER_DISCOVERY = 'PYTHON_INTERPRETER_DISCOVERY', NATIVE_FINDER_MISSING_CONDA_ENVS = 'NATIVE_FINDER_MISSING_CONDA_ENVS', + NATIVE_FINDER_MISSING_POETRY_ENVS = 'NATIVE_FINDER_MISSING_POETRY_ENVS', PYTHON_INTERPRETER_DISCOVERY_INVALID_NATIVE = 'PYTHON_INTERPRETER_DISCOVERY_INVALID_NATIVE', PYTHON_INTERPRETER_AUTO_SELECTION = 'PYTHON_INTERPRETER_AUTO_SELECTION', PYTHON_INTERPRETER_ACTIVATION_ENVIRONMENT_VARIABLES = 'PYTHON_INTERPRETER.ACTIVATION_ENVIRONMENT_VARIABLES', diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index ade7ec8a8c15..e8e26f884dfe 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -1479,6 +1479,65 @@ export interface IEventNamePropertyMapping { */ missingFromOtherRcEnvDirs?: number; }; + /** + * Telemetry event sent when Native finder fails to find some conda envs. + */ + /* __GDPR__ + "native_finder_missing_poetry_envs" : { + "missing" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "missingInPath" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "userProvidedPoetryExe" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "poetryExeNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "globalConfigNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "cacheDirNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "cacheDirIsDifferent" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "virtualenvsPathNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "virtualenvsPathIsDifferent" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "inProjectIsDifferent" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + } + */ + [EventName.NATIVE_FINDER_MISSING_POETRY_ENVS]: { + /** + * Number of missing poetry environments. + */ + missing: number; + /** + * Total number of missing envs, where the envs are created in the virtualenvs_path directory. + */ + missingInPath: number; + /** + * Whether a poetry exe was provided by the user. + */ + userProvidedPoetryExe?: boolean; + /** + * Whether poetry exe was not found. + */ + poetryExeNotFound?: boolean; + /** + * Whether poetry config was not found. + */ + globalConfigNotFound?: boolean; + /** + * Whether cache_dir was not found. + */ + cacheDirNotFound?: boolean; + /** + * Whether cache_dir found was different from that returned by poetry exe. + */ + cacheDirIsDifferent?: boolean; + /** + * Whether virtualenvs.path was not found. + */ + virtualenvsPathNotFound?: boolean; + /** + * Whether virtualenvs.path found was different from that returned by poetry exe. + */ + virtualenvsPathIsDifferent?: boolean; + /** + * Whether virtualenvs.in-project found was different from that returned by poetry exe. + */ + inProjectIsDifferent?: boolean; + }; /** * Telemetry event sent when discovery of all python environments using the native locator(virtualenv, conda, pipenv etc.) finishes. */ From 462b9bf2cbb98450f9a47e4627cd39d400968405 Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Tue, 9 Jul 2024 13:01:15 -0700 Subject: [PATCH 005/149] Enable explicit Ruff check rules (#23741) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Rafał <23004737+rafrafek@users.noreply.github.com> --- build/ci/addEnvPath.py | 3 +- build/update_ext_version.py | 2 +- python_files/create_conda.py | 19 +- python_files/create_microvenv.py | 6 +- python_files/create_venv.py | 24 +- python_files/download_get_pip.py | 8 +- python_files/get_output_via_markers.py | 4 +- python_files/installed_check.py | 4 +- python_files/linter.py | 1 - python_files/normalizeSelection.py | 42 +-- python_files/printEnvVariables.py | 2 +- python_files/printEnvVariablesToFile.py | 2 +- python_files/pyproject.toml | 63 +++- python_files/python_server.py | 45 +-- python_files/pythonrc.py | 18 +- python_files/run-jedi-language-server.py | 7 +- python_files/shell_exec.py | 6 +- python_files/tensorboard_launcher.py | 18 +- .../testing_tools/adapter/__main__.py | 9 +- .../testing_tools/adapter/discovery.py | 6 +- python_files/testing_tools/adapter/errors.py | 8 +- python_files/testing_tools/adapter/info.py | 30 +- .../testing_tools/adapter/pytest/__init__.py | 1 - .../testing_tools/adapter/pytest/_cli.py | 1 - .../adapter/pytest/_discovery.py | 27 +- .../adapter/pytest/_pytest_item.py | 41 +-- python_files/testing_tools/adapter/report.py | 15 +- python_files/testing_tools/adapter/util.py | 18 +- .../testing_tools/process_json_util.py | 2 +- python_files/testing_tools/run_adapter.py | 12 +- python_files/testing_tools/socket_manager.py | 11 +- .../testing_tools/unittest_discovery.py | 15 +- python_files/testlauncher.py | 19 +- python_files/tests/__init__.py | 1 + python_files/tests/__main__.py | 5 +- .../expected_discovery_test_output.py | 13 +- python_files/tests/pytestadapter/helpers.py | 37 +- .../tests/pytestadapter/test_discovery.py | 66 ++-- .../tests/pytestadapter/test_execution.py | 36 +- .../tests/pytestadapter/test_utils.py | 6 +- python_files/tests/run_all.py | 5 +- python_files/tests/test_create_conda.py | 3 +- python_files/tests/test_create_venv.py | 4 +- python_files/tests/test_dynamic_cursor.py | 43 +-- python_files/tests/test_installed_check.py | 9 +- .../tests/test_normalize_selection.py | 20 +- python_files/tests/test_shell_integration.py | 13 +- python_files/tests/test_smart_selection.py | 66 +--- .../testing_tools/adapter/pytest/test_cli.py | 8 +- .../adapter/pytest/test_discovery.py | 346 ++++++++---------- .../testing_tools/adapter/test___main__.py | 5 +- .../testing_tools/adapter/test_discovery.py | 33 +- .../testing_tools/adapter/test_functional.py | 57 +-- .../testing_tools/adapter/test_report.py | 92 ++--- .../tests/testing_tools/adapter/test_util.py | 23 +- .../expected_discovery_test_output.py | 3 +- .../tests/unittestadapter/test_discovery.py | 23 +- .../tests/unittestadapter/test_execution.py | 57 ++- .../tests/unittestadapter/test_utils.py | 23 +- python_files/tests/util.py | 6 +- python_files/unittestadapter/discovery.py | 10 +- python_files/unittestadapter/execution.py | 89 +++-- python_files/unittestadapter/pvsc_utils.py | 29 +- python_files/visualstudio_py_testlauncher.py | 84 ++--- .../vscode_datascience_helpers/__init__.py | 0 .../tests/__init__.py | 0 .../tests/logParser.py | 79 ++-- python_files/vscode_pytest/__init__.py | 139 ++++--- .../vscode_pytest/run_pytest_script.py | 17 +- 69 files changed, 893 insertions(+), 1046 deletions(-) create mode 100644 python_files/vscode_datascience_helpers/__init__.py create mode 100644 python_files/vscode_datascience_helpers/tests/__init__.py diff --git a/build/ci/addEnvPath.py b/build/ci/addEnvPath.py index abad9ec3b5c9..66eff2a7b25d 100644 --- a/build/ci/addEnvPath.py +++ b/build/ci/addEnvPath.py @@ -3,7 +3,8 @@ #Adds the virtual environment's executable path to json file -import json,sys +import json +import sys import os.path jsonPath = sys.argv[1] key = sys.argv[2] diff --git a/build/update_ext_version.py b/build/update_ext_version.py index fe2b6ae0b81c..6d709ae05f7f 100644 --- a/build/update_ext_version.py +++ b/build/update_ext_version.py @@ -86,7 +86,7 @@ def main(package_json: pathlib.Path, argv: Sequence[str]) -> None: raise ValueError( f"Major version [{major}] must be the current year [{current_year}].", f"If changing major version after new year's, change to {current_year}.1.0", - f"Minor version must be updated based on release or pre-release channel.", + "Minor version must be updated based on release or pre-release channel.", ) if args.release and not is_even(minor): diff --git a/python_files/create_conda.py b/python_files/create_conda.py index 15320a8a1ce6..284f734081b2 100644 --- a/python_files/create_conda.py +++ b/python_files/create_conda.py @@ -48,19 +48,19 @@ def parse_args(argv: Sequence[str]) -> argparse.Namespace: def file_exists(path: Union[str, pathlib.PurePath]) -> bool: - return os.path.exists(path) + return os.path.exists(path) # noqa: PTH110 def conda_env_exists(name: Union[str, pathlib.PurePath]) -> bool: - return os.path.exists(CWD / name) + return os.path.exists(CWD / name) # noqa: PTH110 def run_process(args: Sequence[str], error_message: str) -> None: try: print("Running: " + " ".join(args)) - subprocess.run(args, cwd=os.getcwd(), check=True) - except subprocess.CalledProcessError: - raise VenvError(error_message) + subprocess.run(args, cwd=os.getcwd(), check=True) # noqa: PTH109 + except subprocess.CalledProcessError as exc: + raise VenvError(error_message) from exc def get_conda_env_path(name: str) -> str: @@ -89,11 +89,10 @@ def install_packages(env_path: str) -> None: def add_gitignore(name: str) -> None: - git_ignore = os.fspath(CWD / name / ".gitignore") - if not file_exists(git_ignore): - print(f"Creating: {git_ignore}") - with open(git_ignore, "w") as f: - f.write("*") + git_ignore = CWD / name / ".gitignore" + if not git_ignore.is_file(): + print(f"Creating: {os.fsdecode(git_ignore)}") + git_ignore.write_text("*") def main(argv: Optional[Sequence[str]] = None) -> None: diff --git a/python_files/create_microvenv.py b/python_files/create_microvenv.py index 10eae38ab977..2f2135444bc1 100644 --- a/python_files/create_microvenv.py +++ b/python_files/create_microvenv.py @@ -20,9 +20,9 @@ class MicroVenvError(Exception): def run_process(args: Sequence[str], error_message: str) -> None: try: print("Running: " + " ".join(args)) - subprocess.run(args, cwd=os.getcwd(), check=True) - except subprocess.CalledProcessError: - raise MicroVenvError(error_message) + subprocess.run(args, cwd=os.getcwd(), check=True) # noqa: PTH109 + except subprocess.CalledProcessError as exc: + raise MicroVenvError(error_message) from exc def parse_args(argv: Sequence[str]) -> argparse.Namespace: diff --git a/python_files/create_venv.py b/python_files/create_venv.py index 94724923cda5..020c119fc1d5 100644 --- a/python_files/create_venv.py +++ b/python_files/create_venv.py @@ -89,9 +89,9 @@ def venv_exists(name: str) -> bool: def run_process(args: Sequence[str], error_message: str) -> None: try: print("Running: " + " ".join(args)) - subprocess.run(args, cwd=os.getcwd(), check=True) - except subprocess.CalledProcessError: - raise VenvError(error_message) + subprocess.run(args, cwd=os.getcwd(), check=True) # noqa: PTH109 + except subprocess.CalledProcessError as exc: + raise VenvError(error_message) from exc def get_venv_path(name: str) -> str: @@ -136,10 +136,9 @@ def upgrade_pip(venv_path: str) -> None: def add_gitignore(name: str) -> None: git_ignore = CWD / name / ".gitignore" - if not file_exists(git_ignore): - print("Creating: " + os.fspath(git_ignore)) - with open(git_ignore, "w") as f: - f.write("*") + if git_ignore.is_file(): + print("Creating:", os.fspath(git_ignore)) + git_ignore.write_text("*") def download_pip_pyz(name: str): @@ -148,13 +147,10 @@ def download_pip_pyz(name: str): try: with url_lib.urlopen(url) as response: - pip_pyz_path = os.fspath(CWD / name / "pip.pyz") - with open(pip_pyz_path, "wb") as out_file: - data = response.read() - out_file.write(data) - out_file.flush() - except Exception: - raise VenvError("CREATE_VENV.DOWNLOAD_PIP_FAILED") + pip_pyz_path = CWD / name / "pip.pyz" + pip_pyz_path.write_bytes(data=response.read()) + except Exception as exc: + raise VenvError("CREATE_VENV.DOWNLOAD_PIP_FAILED") from exc def install_pip(name: str): diff --git a/python_files/download_get_pip.py b/python_files/download_get_pip.py index 0df610ef3547..91ab107760d8 100644 --- a/python_files/download_get_pip.py +++ b/python_files/download_get_pip.py @@ -2,9 +2,9 @@ # Licensed under the MIT License. import json -import os import pathlib import urllib.request as url_lib + from packaging.version import parse as version_parser EXTENSION_ROOT = pathlib.Path(__file__).parent.parent @@ -14,7 +14,7 @@ def _get_package_data(): - json_uri = "https://pypi.org/pypi/{0}/json".format(PIP_PACKAGE) + json_uri = f"https://pypi.org/pypi/{PIP_PACKAGE}/json" # Response format: https://warehouse.readthedocs.io/api-reference/json/#project # Release metadata format: https://github.com/pypa/interoperability-peps/blob/master/pep-0426-core-metadata.rst with url_lib.urlopen(json_uri) as response: @@ -22,12 +22,12 @@ def _get_package_data(): def _download_and_save(root, version): - root = os.getcwd() if root is None or root == "." else root + root = pathlib.Path.cwd() if root is None or root == "." else pathlib.Path(root) url = f"https://raw.githubusercontent.com/pypa/get-pip/{version}/public/get-pip.py" print(url) with url_lib.urlopen(url) as response: data = response.read() - get_pip_file = pathlib.Path(root) / "get-pip.py" + get_pip_file = root / "get-pip.py" get_pip_file.write_bytes(data) diff --git a/python_files/get_output_via_markers.py b/python_files/get_output_via_markers.py index 00dd57065b3c..e37f7f8c5df0 100644 --- a/python_files/get_output_via_markers.py +++ b/python_files/get_output_via_markers.py @@ -18,9 +18,9 @@ del sys.argv[0] exec(code, ns, ns) elif module.startswith("-m"): - moduleName = sys.argv[2] + module_name = sys.argv[2] sys.argv = sys.argv[2:] # It should begin with the module name. - runpy.run_module(moduleName, run_name="__main__", alter_sys=True) + runpy.run_module(module_name, run_name="__main__", alter_sys=True) elif module.endswith(".py"): sys.argv = sys.argv[1:] runpy.run_path(module, run_name="__main__") diff --git a/python_files/installed_check.py b/python_files/installed_check.py index 6dafe23b5121..4fa3cdbb2385 100644 --- a/python_files/installed_check.py +++ b/python_files/installed_check.py @@ -36,9 +36,7 @@ def parse_args(argv: Optional[Sequence[str]] = None): def parse_requirements(line: str) -> Optional[Requirement]: try: req = Requirement(line.strip("\\")) - if req.marker is None: - return req - elif req.marker.evaluate(): + if req.marker is None or req.marker.evaluate(): return req except Exception: pass diff --git a/python_files/linter.py b/python_files/linter.py index af9634f83f4b..edbbe9dfafe5 100644 --- a/python_files/linter.py +++ b/python_files/linter.py @@ -1,7 +1,6 @@ import subprocess import sys - linter_settings = { "pylint": { "args": ["--reports=n", "--output-format=json"], diff --git a/python_files/normalizeSelection.py b/python_files/normalizeSelection.py index 71d28bb9c35c..981251289e57 100644 --- a/python_files/normalizeSelection.py +++ b/python_files/normalizeSelection.py @@ -21,12 +21,11 @@ def split_lines(source): def _get_statements(selection): - """ - Process a multiline selection into a list of its top-level statements. + """Process a multiline selection into a list of its top-level statements. + This will remove empty newlines around and within the selection, dedent it, and split it using the result of `ast.parse()`. """ - # Remove blank lines within the selection to prevent the REPL from thinking the block is finished. lines = (line for line in split_lines(selection) if line.strip() != "") @@ -57,7 +56,7 @@ def _get_statements(selection): # Also, not all AST objects can have decorators. if hasattr(node, "decorator_list") and sys.version_info >= (3, 8): # Using getattr instead of node.decorator_list or pyright will complain about an unknown member. - line_end -= len(getattr(node, "decorator_list")) + line_end -= len(getattr(node, "decorator_list")) # noqa: B009 ends.append(line_end) ends.append(len(lines)) @@ -74,7 +73,7 @@ def _get_statements(selection): # Special handling of decorators similar to what's above. if hasattr(node, "decorator_list") and sys.version_info >= (3, 8): # Using getattr instead of node.decorator_list or pyright will complain about an unknown member. - start -= len(getattr(node, "decorator_list")) + start -= len(getattr(node, "decorator_list")) # noqa: B009 block = "\n".join(lines[start:end]) # If the block is multiline, add an extra newline character at its end. @@ -134,18 +133,16 @@ def normalize_lines(selection): def check_exact_exist(top_level_nodes, start_line, end_line): - exact_nodes = [] - for node in top_level_nodes: - if node.lineno == start_line and node.end_lineno == end_line: - exact_nodes.append(node) + return [ + node + for node in top_level_nodes + if node.lineno == start_line and node.end_lineno == end_line + ] - return exact_nodes +def traverse_file(whole_file_content, start_line, end_line, was_highlighted): # noqa: ARG001 + """Intended to traverse through a user's given file content and find, collect all appropriate lines that should be sent to the REPL in case of smart selection. -def traverse_file(wholeFileContent, start_line, end_line, was_highlighted): - """ - Intended to traverse through a user's given file content and find, collect all appropriate lines - that should be sent to the REPL in case of smart selection. This could be exact statement such as just a single line print statement, or a multiline dictionary, or differently styled multi-line list comprehension, etc. Then call the normalize_lines function to normalize our smartly selected code block. @@ -153,7 +150,7 @@ def traverse_file(wholeFileContent, start_line, end_line, was_highlighted): parsed_file_content = None try: - parsed_file_content = ast.parse(wholeFileContent) + parsed_file_content = ast.parse(whole_file_content) except Exception: # Handle case where user is attempting to run code where file contains deprecated Python code. # Let typescript side know and show warning message. @@ -192,8 +189,7 @@ def traverse_file(wholeFileContent, start_line, end_line, was_highlighted): ast.ExceptHandler, ) if isinstance(node, ast_types_with_nodebody) and isinstance(node.body, Iterable): - for child_nodes in node.body: - top_level_nodes.append(child_nodes) + top_level_nodes.extend(node.body) exact_nodes = check_exact_exist(top_level_nodes, start_line, end_line) @@ -202,7 +198,7 @@ def traverse_file(wholeFileContent, start_line, end_line, was_highlighted): which_line_next = 0 for same_line_node in exact_nodes: should_run_top_blocks.append(same_line_node) - smart_code += f"{ast.get_source_segment(wholeFileContent, same_line_node)}\n" + smart_code += f"{ast.get_source_segment(whole_file_content, same_line_node)}\n" which_line_next = get_next_block_lineno(should_run_top_blocks) return { "normalized_smart_result": smart_code, @@ -216,7 +212,7 @@ def traverse_file(wholeFileContent, start_line, end_line, was_highlighted): if start_line == top_node.lineno and end_line == top_node.end_lineno: should_run_top_blocks.append(top_node) - smart_code += f"{ast.get_source_segment(wholeFileContent, top_node)}\n" + smart_code += f"{ast.get_source_segment(whole_file_content, top_node)}\n" break # If we found exact match, don't waste computation in parsing extra nodes. elif start_line >= top_node.lineno and end_line <= top_node.end_lineno: # Case to apply smart selection for multiple line. @@ -231,7 +227,7 @@ def traverse_file(wholeFileContent, start_line, end_line, was_highlighted): should_run_top_blocks.append(top_node) - smart_code += str(ast.get_source_segment(wholeFileContent, top_node)) + smart_code += str(ast.get_source_segment(whole_file_content, top_node)) smart_code += "\n" normalized_smart_result = normalize_lines(smart_code) @@ -262,7 +258,7 @@ def get_next_block_lineno(which_line_next): raw = stdin.read() contents = json.loads(raw.decode("utf-8")) # Empty highlight means user has not explicitly selected specific text. - empty_Highlight = contents.get("emptyHighlight", False) + empty_highlight = contents.get("emptyHighlight", False) # We also get the activeEditor selection start line and end line from the typescript VS Code side. # Remember to add 1 to each of the received since vscode starts line counting from 0 . @@ -273,12 +269,12 @@ def get_next_block_lineno(which_line_next): data = None which_line_next = 0 - if empty_Highlight and contents.get("smartSendSettingsEnabled"): + if empty_highlight and contents.get("smartSendSettingsEnabled"): result = traverse_file( contents["wholeFileContent"], vscode_start_line, vscode_end_line, - not empty_Highlight, + not empty_highlight, ) normalized = result["normalized_smart_result"] which_line_next = result["which_line_next"] diff --git a/python_files/printEnvVariables.py b/python_files/printEnvVariables.py index 353149f237de..bf2cfd80e666 100644 --- a/python_files/printEnvVariables.py +++ b/python_files/printEnvVariables.py @@ -1,7 +1,7 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. -import os import json +import os print(json.dumps(dict(os.environ))) diff --git a/python_files/printEnvVariablesToFile.py b/python_files/printEnvVariablesToFile.py index a4e0d24abbe0..c7ec70dd9684 100644 --- a/python_files/printEnvVariablesToFile.py +++ b/python_files/printEnvVariablesToFile.py @@ -7,6 +7,6 @@ # Last argument is the target file into which we'll write the env variables line by line. output_file = sys.argv[-1] -with open(output_file, "w") as outfile: +with open(output_file, "w") as outfile: # noqa: PTH123 for key, val in os.environ.items(): outfile.write(f"{key}={val}\n") diff --git a/python_files/pyproject.toml b/python_files/pyproject.toml index 0f1b0f466940..afb9d372285c 100644 --- a/python_files/pyproject.toml +++ b/python_files/pyproject.toml @@ -1,15 +1,3 @@ -[tool.black] -exclude = ''' - -( - /( - .data - | .vscode - | lib - )/ -) -''' - [tool.pyright] exclude = ['lib'] extraPaths = ['lib/python', 'lib/jedilsp'] @@ -36,12 +24,59 @@ ignore = [ [tool.ruff] line-length = 100 exclude = [ - "tests/testing_tools/adapter/.data", - "tests/unittestadapter/.data" + "**/.data", + "lib", ] [tool.ruff.format] docstring-code-format = true +[tool.ruff.lint] +# Ruff's defaults are F and a subset of E. +# https://docs.astral.sh/ruff/rules/#rules +# Compatible w/ ruff formatter. https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules +# Up-to-date as of Ruff 0.5.0. +select = [ + "A", # flake8-builtins + "ARG", # flake8-unused-argument + "ASYNC", # flake8-async + "B", # flake8-bugbear + "C4", # flake8-comprehensions + "D2", "D400", "D403", "D419", # pydocstyle + "DJ", # flake8-django + "DTZ", # flake8-dasetimez + "E4", "E7", "E9", # pycodestyle (errors) + "EXE", # flake8-executable + "F", # Pyflakes + "FBT", # flake8-boolean-trap + "FLY", # flynt + "FURB", # refurb + "I", # isort + "INP", # flake8-no-pep420 + "INT", # flake8-gettext + "LOG", # flake8-logging + "N", # pep8-naming + "NPY", # NumPy-specific rules + "PD", # pandas-vet + "PERF", # Perflint + "PIE", # flake8-pie + "PTH", # flake8-pathlib + # flake8-pytest-style + "PT006", "PT007", "PT009", "PT012", "PT014", "PT015", "PT016", "PT017", "PT018", "PT019", + "PT020", "PT021", "PT022", "PT024", "PT025", "PT026", "PT027", + "PYI", # flake8-pyi + "Q", # flake8-quotes + "RET502", "RET503", "RET504", # flake8-return + "RSE", # flake8-raise + "RUF", # Ruff-specific rules + "SIM", # flake8-simplify + "SLF", # flake8-self + "SLOT", # flake8-slots + "TCH", # flake8-type-checking + "UP", # pyupgrade + "W", # pycodestyle (warnings) + "YTT", # flake8-2020 +] + [tool.ruff.lint.pydocstyle] convention = "pep257" diff --git a/python_files/python_server.py b/python_files/python_server.py index 30be834631c6..a4b15f2cbaae 100644 --- a/python_files/python_server.py +++ b/python_files/python_server.py @@ -1,11 +1,11 @@ -from typing import Dict, List, Optional, Union -import sys -import json +import ast import contextlib import io +import json +import sys import traceback import uuid -import ast +from typing import Dict, List, Optional, Union STDIN = sys.stdin STDOUT = sys.stdout @@ -15,7 +15,7 @@ def send_message(msg: str): length_msg = len(msg) - STDOUT.buffer.write(f"Content-Length: {length_msg}\r\n\r\n{msg}".encode(encoding="utf-8")) + STDOUT.buffer.write(f"Content-Length: {length_msg}\r\n\r\n{msg}".encode()) STDOUT.buffer.flush() @@ -50,15 +50,14 @@ def custom_input(prompt=""): if content_length: message_text = STDIN.read(content_length) message_json = json.loads(message_text) - our_user_input = message_json["result"]["userInput"] - return our_user_input + return message_json["result"]["userInput"] except Exception: print_log(traceback.format_exc()) # Set input to our custom input USER_GLOBALS["input"] = custom_input -input = custom_input +input = custom_input # noqa: A001 def handle_response(request_id): @@ -76,7 +75,7 @@ def handle_response(request_id): elif message_json["method"] == "exit": sys.exit(0) - except Exception: + except Exception: # noqa: PERF203 print_log(traceback.format_exc()) @@ -100,12 +99,15 @@ def check_valid_command(request): def execute(request, user_globals): str_output = CustomIO("", encoding="utf-8") str_error = CustomIO("", encoding="utf-8") + str_input = CustomIO("", encoding="utf-8", newline="\n") - with redirect_io("stdout", str_output): - with redirect_io("stderr", str_error): - str_input = CustomIO("", encoding="utf-8", newline="\n") - with redirect_io("stdin", str_input): - exec_user_input(request["params"], user_globals) + with contextlib.redirect_stdout(str_output), contextlib.redirect_stderr(str_error): + original_stdin = sys.stdin + try: + sys.stdin = str_input + exec_user_input(request["params"], user_globals) + finally: + sys.stdin = original_stdin send_response(str_output.get_value(), request["id"]) @@ -113,8 +115,8 @@ def exec_user_input(user_input, user_globals): user_input = user_input[0] if isinstance(user_input, list) else user_input try: - callable = exec_function(user_input) - retval = callable(user_input, user_globals) + callable_ = exec_function(user_input) + retval = callable_(user_input, user_globals) if retval is not None: print(retval) except KeyboardInterrupt: @@ -141,15 +143,6 @@ def get_value(self) -> str: return self.read() -@contextlib.contextmanager -def redirect_io(stream: str, new_stream): - """Redirect stdio streams to a custom stream.""" - old_stream = getattr(sys, stream) - setattr(sys, stream, new_stream) - yield - setattr(sys, stream, old_stream) - - def get_headers(): headers = {} while line := STDIN.readline().strip(): @@ -174,5 +167,5 @@ def get_headers(): elif request_json["method"] == "exit": sys.exit(0) - except Exception: + except Exception: # noqa: PERF203 print_log(traceback.format_exc()) diff --git a/python_files/pythonrc.py b/python_files/pythonrc.py index 2edd88874674..2595143feade 100644 --- a/python_files/pythonrc.py +++ b/python_files/pythonrc.py @@ -6,7 +6,7 @@ original_ps1 = ">>> " -class repl_hooks: +class REPLHooks: def __init__(self): self.global_exit = None self.failure_flag = False @@ -21,11 +21,11 @@ def my_displayhook(self, value): self.original_displayhook(value) - def my_excepthook(self, type, value, traceback): + def my_excepthook(self, type_, value, traceback): self.global_exit = value self.failure_flag = True - self.original_excepthook(type, value, traceback) + self.original_excepthook(type_, value, traceback) def get_last_command(): @@ -37,18 +37,14 @@ def get_last_command(): return last_command -class ps1: - hooks = repl_hooks() +class PS1: + hooks = REPLHooks() sys.excepthook = hooks.my_excepthook sys.displayhook = hooks.my_displayhook # str will get called for every prompt with exit code to show success/failure def __str__(self): - exit_code = 0 - if self.hooks.failure_flag: - exit_code = 1 - else: - exit_code = 0 + exit_code = int(bool(self.hooks.failure_flag)) self.hooks.failure_flag = False # Guide following official VS Code doc for shell integration sequence: result = "" @@ -77,4 +73,4 @@ def __str__(self): if sys.platform != "win32": - sys.ps1 = ps1() + sys.ps1 = PS1() diff --git a/python_files/run-jedi-language-server.py b/python_files/run-jedi-language-server.py index 5a972799bc33..47bf503d596c 100644 --- a/python_files/run-jedi-language-server.py +++ b/python_files/run-jedi-language-server.py @@ -1,9 +1,12 @@ import os +import pathlib import sys # Add the lib path to our sys path so jedi_language_server can find its references -EXTENSION_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) -sys.path.insert(0, os.path.join(EXTENSION_ROOT, "python_files", "lib", "jedilsp")) +extension_dir = pathlib.Path(__file__).parent.parent +EXTENSION_ROOT = os.fsdecode(extension_dir) +sys.path.insert(0, os.fsdecode(extension_dir / "python_files" / "lib" / "jedilsp")) +del extension_dir from jedi_language_server.cli import cli # noqa: E402 diff --git a/python_files/shell_exec.py b/python_files/shell_exec.py index 4987399a53ea..62b6b28af6cd 100644 --- a/python_files/shell_exec.py +++ b/python_files/shell_exec.py @@ -16,7 +16,7 @@ print("Executing command in shell >> " + " ".join(shell_args)) -with open(lock_file, "w") as fp: +with open(lock_file, "w") as fp: # noqa: PTH123 try: # Signal start of execution. fp.write("START\n") @@ -36,7 +36,7 @@ fp.flush() try: # ALso log the error for use from the other side. - with open(lock_file + ".error", "w") as fpError: - fpError.write(traceback.format_exc()) + with open(lock_file + ".error", "w") as fp_error: # noqa: PTH123 + fp_error.write(traceback.format_exc()) except Exception: pass diff --git a/python_files/tensorboard_launcher.py b/python_files/tensorboard_launcher.py index bad1ef09fc6e..a04d51e7eb74 100644 --- a/python_files/tensorboard_launcher.py +++ b/python_files/tensorboard_launcher.py @@ -1,7 +1,9 @@ -import time -import sys -import os +import contextlib import mimetypes +import os +import sys +import time + from tensorboard import program @@ -17,14 +19,12 @@ def main(logdir): tb = program.TensorBoard() tb.configure(bind_all=False, logdir=logdir) url = tb.launch() - sys.stdout.write("TensorBoard started at %s\n" % (url)) + sys.stdout.write(f"TensorBoard started at {url}\n") sys.stdout.flush() - while True: - try: + with contextlib.suppress(KeyboardInterrupt): + while True: time.sleep(60) - except KeyboardInterrupt: - break sys.stdout.write("TensorBoard is shutting down") sys.stdout.flush() @@ -32,5 +32,5 @@ def main(logdir): if __name__ == "__main__": if len(sys.argv) == 2: logdir = str(sys.argv[1]) - sys.stdout.write("Starting TensorBoard with logdir %s" % (logdir)) + sys.stdout.write(f"Starting TensorBoard with logdir {logdir}") main(logdir) diff --git a/python_files/testing_tools/adapter/__main__.py b/python_files/testing_tools/adapter/__main__.py index cc7084eb9439..c4d5c10c95ab 100644 --- a/python_files/testing_tools/adapter/__main__.py +++ b/python_files/testing_tools/adapter/__main__.py @@ -1,7 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. -from __future__ import absolute_import import argparse import sys @@ -85,14 +84,14 @@ def main( ): try: tool = _tools[toolname] - except KeyError: - raise UnsupportedToolError(toolname) + except KeyError as exc: + raise UnsupportedToolError(toolname) from exc try: run = tool[cmdname] report_result = _reporters[cmdname] - except KeyError: - raise UnsupportedCommandError(cmdname) + except KeyError as exc: + raise UnsupportedCommandError(cmdname) from exc parents, result = run(toolargs, **subargs) report_result(result, parents, **subargs) diff --git a/python_files/testing_tools/adapter/discovery.py b/python_files/testing_tools/adapter/discovery.py index 798aea1e93f1..a5fa2e0d6888 100644 --- a/python_files/testing_tools/adapter/discovery.py +++ b/python_files/testing_tools/adapter/discovery.py @@ -1,13 +1,11 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. -from __future__ import absolute_import, print_function import re -from .util import fix_fileid, DIRNAME, NORMCASE from .info import ParentInfo - +from .util import DIRNAME, NORMCASE, fix_fileid FILE_ID_RE = re.compile( r""" @@ -47,7 +45,7 @@ def fix_nodeid( return fileid + (remainder or "") -class DiscoveredTests(object): +class DiscoveredTests: """A container for the discovered tests and their parents.""" def __init__(self): diff --git a/python_files/testing_tools/adapter/errors.py b/python_files/testing_tools/adapter/errors.py index 3e6ae5189cb8..aa6febe315fc 100644 --- a/python_files/testing_tools/adapter/errors.py +++ b/python_files/testing_tools/adapter/errors.py @@ -4,13 +4,13 @@ class UnsupportedToolError(ValueError): def __init__(self, tool): - msg = "unsupported tool {!r}".format(tool) - super(UnsupportedToolError, self).__init__(msg) + msg = f"unsupported tool {tool!r}" + super().__init__(msg) self.tool = tool class UnsupportedCommandError(ValueError): def __init__(self, cmd): - msg = "unsupported cmd {!r}".format(cmd) - super(UnsupportedCommandError, self).__init__(msg) + msg = f"unsupported cmd {cmd!r}" + super().__init__(msg) self.cmd = cmd diff --git a/python_files/testing_tools/adapter/info.py b/python_files/testing_tools/adapter/info.py index 8e5d0442ce15..1e84ee7961f5 100644 --- a/python_files/testing_tools/adapter/info.py +++ b/python_files/testing_tools/adapter/info.py @@ -1,5 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. +# ruff:noqa: PYI024, SLOT002 from collections import namedtuple @@ -8,16 +9,15 @@ class SingleTestPath(namedtuple("TestPath", "root relfile func sub")): """Where to find a single test.""" def __new__(cls, root, relfile, func, sub=None): - self = super(SingleTestPath, cls).__new__( + return super().__new__( cls, str(root) if root else None, str(relfile) if relfile else None, str(func) if func else None, [str(s) for s in sub] if sub else None, ) - return self - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs): # noqa: ARG002 if self.root is None: raise TypeError("missing id") if self.relfile is None: @@ -29,8 +29,8 @@ def __init__(self, *args, **kwargs): class ParentInfo(namedtuple("ParentInfo", "id kind name root relpath parentid")): KINDS = ("folder", "file", "suite", "function", "subtest") - def __new__(cls, id, kind, name, root=None, relpath=None, parentid=None): - self = super(ParentInfo, cls).__new__( + def __new__(cls, id, kind, name, root=None, relpath=None, parentid=None): # noqa: A002 + return super().__new__( cls, id=str(id) if id else None, kind=str(kind) if kind else None, @@ -39,22 +39,21 @@ def __new__(cls, id, kind, name, root=None, relpath=None, parentid=None): relpath=str(relpath) if relpath else None, parentid=str(parentid) if parentid else None, ) - return self - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs): # noqa: ARG002 if self.id is None: raise TypeError("missing id") if self.kind is None: raise TypeError("missing kind") if self.kind not in self.KINDS: - raise ValueError("unsupported kind {!r}".format(self.kind)) + raise ValueError(f"unsupported kind {self.kind!r}") if self.name is None: raise TypeError("missing name") if self.root is None: if self.parentid is not None or self.kind != "folder": raise TypeError("missing root") if self.relpath is not None: - raise TypeError("unexpected relpath {}".format(self.relpath)) + raise TypeError(f"unexpected relpath {self.relpath}") elif self.parentid is None: raise TypeError("missing parentid") elif self.relpath is None and self.kind in ("folder", "file"): @@ -67,8 +66,8 @@ class SingleTestInfo(namedtuple("TestInfo", "id name path source markers parenti MARKERS = ("skip", "skip-if", "expected-failure") KINDS = ("function", "doctest") - def __new__(cls, id, name, path, source, markers, parentid, kind="function"): - self = super(SingleTestInfo, cls).__new__( + def __new__(cls, id, name, path, source, markers, parentid, kind="function"): # noqa: A002 + return super().__new__( cls, str(id) if id else None, str(name) if name else None, @@ -78,9 +77,8 @@ def __new__(cls, id, name, path, source, markers, parentid, kind="function"): str(parentid) if parentid else None, str(kind) if kind else None, ) - return self - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs): # noqa: ARG002 if self.id is None: raise TypeError("missing id") if self.name is None: @@ -92,17 +90,17 @@ def __init__(self, *args, **kwargs): else: srcfile, _, lineno = self.source.rpartition(":") if not srcfile or not lineno or int(lineno) < 0: - raise ValueError("bad source {!r}".format(self.source)) + raise ValueError(f"bad source {self.source!r}") if self.markers: badmarkers = [m for m in self.markers if m not in self.MARKERS] if badmarkers: - raise ValueError("unsupported markers {!r}".format(badmarkers)) + raise ValueError(f"unsupported markers {badmarkers!r}") if self.parentid is None: raise TypeError("missing parentid") if self.kind is None: raise TypeError("missing kind") elif self.kind not in self.KINDS: - raise ValueError("unsupported kind {!r}".format(self.kind)) + raise ValueError(f"unsupported kind {self.kind!r}") @property def root(self): diff --git a/python_files/testing_tools/adapter/pytest/__init__.py b/python_files/testing_tools/adapter/pytest/__init__.py index 89b7c066a459..ce1a1c4d694a 100644 --- a/python_files/testing_tools/adapter/pytest/__init__.py +++ b/python_files/testing_tools/adapter/pytest/__init__.py @@ -1,7 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. -from __future__ import absolute_import from ._cli import add_subparser as add_cli_subparser # noqa: F401 from ._discovery import discover # noqa: F401 diff --git a/python_files/testing_tools/adapter/pytest/_cli.py b/python_files/testing_tools/adapter/pytest/_cli.py index 3d3eec09a199..1556b9ac754c 100644 --- a/python_files/testing_tools/adapter/pytest/_cli.py +++ b/python_files/testing_tools/adapter/pytest/_cli.py @@ -1,7 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. -from __future__ import absolute_import from ..errors import UnsupportedCommandError diff --git a/python_files/testing_tools/adapter/pytest/_discovery.py b/python_files/testing_tools/adapter/pytest/_discovery.py index bbe5ae9856c8..c1cfc9e7cbbd 100644 --- a/python_files/testing_tools/adapter/pytest/_discovery.py +++ b/python_files/testing_tools/adapter/pytest/_discovery.py @@ -1,7 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. -from __future__ import absolute_import, print_function import sys @@ -13,7 +12,7 @@ def discover( pytestargs=None, - hidestdio=False, + hidestdio=False, # noqa: FBT002 # *, _pytest_main=pytest.main, _plugin=None, @@ -36,28 +35,20 @@ def discover( # Some tests where collected but with errors. pass elif ec != 0: - print( - "equivalent command: {} -m pytest {}".format( - sys.executable, util.shlex_unsplit(pytestargs) - ) - ) + print(f"equivalent command: {sys.executable} -m pytest {util.shlex_unsplit(pytestargs)}") if hidestdio: print(stdio.getvalue(), file=sys.stderr) sys.stdout.flush() - raise Exception("pytest discovery failed (exit code {})".format(ec)) - if not _plugin._started: - print( - "equivalent command: {} -m pytest {}".format( - sys.executable, util.shlex_unsplit(pytestargs) - ) - ) + raise Exception(f"pytest discovery failed (exit code {ec})") + if not _plugin._started: # noqa: SLF001 + print(f"equivalent command: {sys.executable} -m pytest {util.shlex_unsplit(pytestargs)}") if hidestdio: print(stdio.getvalue(), file=sys.stderr) sys.stdout.flush() raise Exception("pytest discovery did not start") return ( - _plugin._tests.parents, - list(_plugin._tests), + _plugin._tests.parents, # noqa: SLF001 + list(_plugin._tests), # noqa: SLF001 ) @@ -72,7 +63,7 @@ def _adjust_pytest_args(pytestargs): return pytestargs -class TestCollector(object): +class TestCollector: """This is a pytest plugin that collects the discovered tests.""" @classmethod @@ -88,7 +79,7 @@ def __init__(self, tests=None): # Relevant plugin hooks: # https://docs.pytest.org/en/latest/reference.html#collection-hooks - def pytest_collection_modifyitems(self, session, config, items): + def pytest_collection_modifyitems(self, session, config, items): # noqa: ARG002 self._started = True self._tests.reset() for item in items: diff --git a/python_files/testing_tools/adapter/pytest/_pytest_item.py b/python_files/testing_tools/adapter/pytest/_pytest_item.py index 724b71a1ac44..c7cbbe5684a6 100644 --- a/python_files/testing_tools/adapter/pytest/_pytest_item.py +++ b/python_files/testing_tools/adapter/pytest/_pytest_item.py @@ -89,9 +89,7 @@ + __code__ + __closure__ * own_markers -""" - -from __future__ import absolute_import, print_function +""" # noqa: D205 import sys @@ -112,7 +110,7 @@ def should_never_reach_here(item, **extra): print("and paste the following output there.") print() for field, info in _summarize_item(item): - print("{}: {}".format(field, info)) + print(f"{field}: {info}") if extra: print() print("extra info:") @@ -166,8 +164,8 @@ def parse_item( (parentid, parents, fileid, testfunc, _) = _parse_node_id( item.nodeid[: -len(parameterized)], kind ) - nodeid = "{}{}".format(parentid, parameterized) - parents = [(parentid, item.originalname, kind)] + parents + nodeid = f"{parentid}{parameterized}" + parents = [(parentid, item.originalname, kind), *parents] name = parameterized[1:-1] or "" else: (nodeid, parents, fileid, testfunc, parameterized) = _parse_node_id(item.nodeid, kind) @@ -311,7 +309,7 @@ def _get_location( lineno = -1 # i.e. "unknown" # from pytest, line numbers are 0-based - location = "{}:{}".format(srcfile, int(lineno) + 1) + location = f"{srcfile}:{int(lineno) + 1}" return location, fullname @@ -327,14 +325,11 @@ def _matches_relfile( testroot = _normcase(testroot) srcfile = _normcase(srcfile) relfile = _normcase(relfile) - if srcfile == relfile: - return True - elif srcfile == relfile[len(_pathsep) + 1 :]: - return True - elif srcfile == testroot + relfile[1:]: - return True - else: - return False + return bool( + srcfile == relfile + or srcfile == relfile[len(_pathsep) + 1 :] + or srcfile == testroot + relfile[1:] + ) def _is_legacy_wrapper( @@ -350,9 +345,7 @@ def _is_legacy_wrapper( """ if _pyversion > (3,): return False - if (_pathsep + "unittest" + _pathsep + "case.py") not in srcfile: - return False - return True + return not _pathsep + "unittest" + _pathsep + "case.py" not in srcfile def _unwrap_decorator(func): @@ -579,16 +572,16 @@ def _summarize_item(item): yield field, dir(item) else: yield field, getattr(item, field, "") - except Exception as exc: - yield field, "".format(exc) + except Exception as exc: # noqa: PERF203 + yield field, f"" -def _debug_item(item, showsummary=False): - item._debugging = True +def _debug_item(item, showsummary=False): # noqa: FBT002 + item._debugging = True # noqa: SLF001 try: summary = dict(_summarize_item(item)) finally: - item._debugging = False + item._debugging = False # noqa: SLF001 if showsummary: print(item.nodeid) @@ -602,7 +595,7 @@ def _debug_item(item, showsummary=False): "markers", "props", ): - print(" {:12} {}".format(key, summary[key])) + print(f" {key:12} {summary[key]}") print() return summary diff --git a/python_files/testing_tools/adapter/report.py b/python_files/testing_tools/adapter/report.py index 1ad02fe7bcd4..3fe2fe48c26c 100644 --- a/python_files/testing_tools/adapter/report.py +++ b/python_files/testing_tools/adapter/report.py @@ -1,7 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. -from __future__ import print_function import json @@ -10,8 +9,8 @@ def report_discovered( tests, parents, # *, - pretty=False, - simple=False, + pretty=False, # noqa: FBT002 + simple=False, # noqa: FBT002 _send=print, **_ignored, ): @@ -83,12 +82,12 @@ def report_discovered( kwargs = {} if pretty: # human-formatted - kwargs = dict( - sort_keys=True, - indent=4, - separators=(",", ": "), + kwargs = { + "sort_keys": True, + "indent": 4, + "separators": (",", ": "), # ... - ) + } serialized = json.dumps(data, **kwargs) _send(serialized) diff --git a/python_files/testing_tools/adapter/util.py b/python_files/testing_tools/adapter/util.py index 9f3089fb29d0..52c0fac757f8 100644 --- a/python_files/testing_tools/adapter/util.py +++ b/python_files/testing_tools/adapter/util.py @@ -83,9 +83,8 @@ def fix_relpath( path = _fix_path(path) if path in (".", ".."): return path - if not _path_isabs(path): - if not path.startswith("." + _pathsep): - path = "." + _pathsep + path + if not _path_isabs(path) and not path.startswith("." + _pathsep): + path = "." + _pathsep + path return path @@ -125,7 +124,7 @@ def fix_fileid( fileid, rootdir=None, # *, - normalize=False, + normalize=False, # noqa: FBT002 strictpathsep=None, _pathsep=PATH_SEP, **kwargs, @@ -171,10 +170,7 @@ def fix_fileid( @contextlib.contextmanager def _replace_fd(file, target): - """ - Temporarily replace the file descriptor for `file`, - for which sys.stdout or sys.stderr is passed. - """ + """Temporarily replace the file descriptor for `file`, for which sys.stdout or sys.stderr is passed.""" try: fd = file.fileno() except (AttributeError, io.UnsupportedOperation): @@ -233,7 +229,7 @@ def _temp_io(): @contextlib.contextmanager def hide_stdio(): """Swallow stdout and stderr.""" - with _temp_io() as (sio, fileobj): + with _temp_io() as (sio, fileobj): # noqa: SIM117 with _replace_fd(sys.stdout, fileobj): with _replace_stdout(fileobj): with _replace_fd(sys.stderr, fileobj): @@ -261,9 +257,7 @@ def shlex_unsplit(argv): def _quote_arg(arg): parts = None for i, c in enumerate(arg): - if c.isspace(): - pass - elif c == '"': + if c.isspace() or c == '"': pass elif c == "'": c = "'\"'\"'" diff --git a/python_files/testing_tools/process_json_util.py b/python_files/testing_tools/process_json_util.py index 36067521ea27..8ca9f7261d9e 100644 --- a/python_files/testing_tools/process_json_util.py +++ b/python_files/testing_tools/process_json_util.py @@ -2,7 +2,7 @@ # Licensed under the MIT License. import io import json -from typing import List, Dict +from typing import Dict, List CONTENT_LENGTH: str = "Content-Length:" diff --git a/python_files/testing_tools/run_adapter.py b/python_files/testing_tools/run_adapter.py index 8af4e49dd31c..af3c8ce87479 100644 --- a/python_files/testing_tools/run_adapter.py +++ b/python_files/testing_tools/run_adapter.py @@ -2,20 +2,16 @@ # Licensed under the MIT License. # Replace the "." entry. -import os.path +import os +import pathlib import sys sys.path.insert( 1, - os.path.dirname( # python_files - os.path.dirname( # python_files/testing_tools - os.path.abspath(__file__) # this file - ) - ), + os.fsdecode(pathlib.Path(__file__).parent.parent), ) -from testing_tools.adapter.__main__ import parse_args, main - +from testing_tools.adapter.__main__ import main, parse_args if __name__ == "__main__": tool, cmd, subargs, toolargs = parse_args() diff --git a/python_files/testing_tools/socket_manager.py b/python_files/testing_tools/socket_manager.py index 31b78b254bba..347453a6ca1a 100644 --- a/python_files/testing_tools/socket_manager.py +++ b/python_files/testing_tools/socket_manager.py @@ -1,6 +1,7 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. +import contextlib import socket import sys @@ -20,7 +21,7 @@ def __exit__(self, *_): def connect(self): if sys.platform == "win32": - self._writer = open(self.name, "wt", encoding="utf-8") + self._writer = open(self.name, "w", encoding="utf-8") # noqa: SIM115, PTH123 # reader created in read method else: self._socket = _SOCKET(socket.AF_UNIX, socket.SOCK_STREAM) @@ -65,7 +66,7 @@ def read(self, bufsize=1024) -> str: if sys.platform == "win32": # returns a string automatically from read if not hasattr(self, "_reader"): - self._reader = open(self.name, "rt", encoding="utf-8") + self._reader = open(self.name, encoding="utf-8") # noqa: SIM115, PTH123 return self._reader.read(bufsize) else: # receive bytes and convert to string @@ -75,7 +76,7 @@ def read(self, bufsize=1024) -> str: return data -class SocketManager(object): +class SocketManager: """Create a socket and connect to the given address. The address is a (host: str, port: int) tuple. @@ -111,8 +112,6 @@ def connect(self): def close(self): if self.socket: - try: + with contextlib.suppress(Exception): self.socket.shutdown(socket.SHUT_RDWR) - except Exception: - pass self.socket.close() diff --git a/python_files/testing_tools/unittest_discovery.py b/python_files/testing_tools/unittest_discovery.py index 5d5e9bcc6601..9b792d8e5102 100644 --- a/python_files/testing_tools/unittest_discovery.py +++ b/python_files/testing_tools/unittest_discovery.py @@ -8,7 +8,7 @@ start_dir = sys.argv[1] pattern = sys.argv[2] top_level_dir = sys.argv[3] if len(sys.argv) >= 4 else None -sys.path.insert(0, os.getcwd()) +sys.path.insert(0, os.getcwd()) # noqa: PTH109 def get_sourceline(obj): @@ -34,8 +34,7 @@ def generate_test_cases(suite): if isinstance(test, unittest.TestCase): yield test else: - for test_case in generate_test_cases(test): - yield test_case + yield from generate_test_cases(test) try: @@ -45,12 +44,12 @@ def generate_test_cases(suite): print("start") # Don't remove this line loader_errors = [] for s in generate_test_cases(suite): - tm = getattr(s, s._testMethodName) - testId = s.id() - if testId.startswith("unittest.loader._FailedTest"): - loader_errors.append(s._exception) + tm = getattr(s, s._testMethodName) # noqa: SLF001 + test_id = s.id() + if test_id.startswith("unittest.loader._FailedTest"): + loader_errors.append(s._exception) # noqa: SLF001 else: - print(testId.replace(".", ":") + ":" + get_sourceline(tm)) + print(test_id.replace(".", ":") + ":" + get_sourceline(tm)) except Exception: print("=== exception start ===") traceback.print_exc() diff --git a/python_files/testlauncher.py b/python_files/testlauncher.py index 3278815b380c..2309a203363b 100644 --- a/python_files/testlauncher.py +++ b/python_files/testlauncher.py @@ -7,30 +7,31 @@ def parse_argv(): """Parses arguments for use with the test launcher. + Arguments are: 1. Working directory. 2. Test runner `pytest` 3. Rest of the arguments are passed into the test runner. """ cwd = sys.argv[1] - testRunner = sys.argv[2] + test_runner = sys.argv[2] args = sys.argv[3:] - return (cwd, testRunner, args) + return (cwd, test_runner, args) + +def run(cwd, test_runner, args): + """Runs the test. -def run(cwd, testRunner, args): - """Runs the test cwd -- the current directory to be set testRunner -- test runner to be used `pytest` args -- arguments passed into the test runner """ - - sys.path[0] = os.getcwd() + sys.path[0] = os.getcwd() # noqa: PTH109 os.chdir(cwd) try: - if testRunner == "pytest": + if test_runner == "pytest": import pytest pytest.main(args) @@ -40,5 +41,5 @@ def run(cwd, testRunner, args): if __name__ == "__main__": - cwd, testRunner, args = parse_argv() - run(cwd, testRunner, args) + cwd, test_runner, args = parse_argv() + run(cwd, test_runner, args) diff --git a/python_files/tests/__init__.py b/python_files/tests/__init__.py index 4f762cd1f81a..86bc29ff33e8 100644 --- a/python_files/tests/__init__.py +++ b/python_files/tests/__init__.py @@ -1,5 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. +# ruff:noqa: PTH118, PTH120 import os.path TEST_ROOT = os.path.dirname(__file__) diff --git a/python_files/tests/__main__.py b/python_files/tests/__main__.py index 347222bd85db..2595fce358e4 100644 --- a/python_files/tests/__main__.py +++ b/python_files/tests/__main__.py @@ -34,7 +34,7 @@ def parse_args(): return ns, remainder -def main(pytestargs, markers=None, specific=False): +def main(pytestargs, markers=None, specific=False): # noqa: FBT002 sys.path.insert(1, TESTING_TOOLS_ROOT) sys.path.insert(1, DEBUG_ADAPTER_ROOT) @@ -46,8 +46,7 @@ def main(pytestargs, markers=None, specific=False): pytestargs.insert(0, marker) pytestargs.insert(0, "-m") - ec = pytest.main(pytestargs) - return ec + return pytest.main(pytestargs) if __name__ == "__main__": diff --git a/python_files/tests/pytestadapter/expected_discovery_test_output.py b/python_files/tests/pytestadapter/expected_discovery_test_output.py index 723adaabc3e5..56b116e7dfd5 100644 --- a/python_files/tests/pytestadapter/expected_discovery_test_output.py +++ b/python_files/tests/pytestadapter/expected_discovery_test_output.py @@ -1,6 +1,5 @@ import os - from .helpers import TEST_DATA_PATH, find_test_line_number, get_absolute_test_id # This file contains the expected output dictionaries for tests discovery and is used in test_discovery.py. @@ -850,10 +849,10 @@ "children": [ { "name": "test_a_function", - "path": os.fspath(os.path.join(tests_path, "test_a.py")), + "path": os.fspath(os.path.join(tests_path, "test_a.py")), # noqa: PTH118 "lineno": find_test_line_number( "test_a_function", - os.path.join(tests_path, "test_a.py"), + os.path.join(tests_path, "test_a.py"), # noqa: PTH118 ), "type_": "test", "id_": get_absolute_test_id("tests/test_a.py::test_a_function", tests_a_path), @@ -869,10 +868,10 @@ "children": [ { "name": "test_b_function", - "path": os.fspath(os.path.join(tests_path, "test_b.py")), + "path": os.fspath(os.path.join(tests_path, "test_b.py")), # noqa: PTH118 "lineno": find_test_line_number( "test_b_function", - os.path.join(tests_path, "test_b.py"), + os.path.join(tests_path, "test_b.py"), # noqa: PTH118 ), "type_": "test", "id_": get_absolute_test_id("tests/test_b.py::test_b_function", tests_b_path), @@ -1033,7 +1032,7 @@ "path": str(SYMLINK_FOLDER_PATH_TESTS_TEST_A), "lineno": find_test_line_number( "test_a_function", - os.path.join(tests_path, "test_a.py"), + os.path.join(tests_path, "test_a.py"), # noqa: PTH118 ), "type_": "test", "id_": get_absolute_test_id( @@ -1058,7 +1057,7 @@ "path": str(SYMLINK_FOLDER_PATH_TESTS_TEST_B), "lineno": find_test_line_number( "test_b_function", - os.path.join(tests_path, "test_b.py"), + os.path.join(tests_path, "test_b.py"), # noqa: PTH118 ), "type_": "test", "id_": get_absolute_test_id( diff --git a/python_files/tests/pytestadapter/helpers.py b/python_files/tests/pytestadapter/helpers.py index 978fd7f9ce08..9ec0550fb4b9 100644 --- a/python_files/tests/pytestadapter/helpers.py +++ b/python_files/tests/pytestadapter/helpers.py @@ -11,8 +11,8 @@ import sys import tempfile import threading -from typing import Any, Dict, List, Optional, Tuple import uuid +from typing import Any, Dict, List, Optional, Tuple if sys.platform == "win32": from namedpipe import NPopen @@ -41,7 +41,7 @@ def text_to_python_file(text_file_path: pathlib.Path): yield python_file finally: if python_file: - os.unlink(os.fspath(python_file)) + python_file.unlink() @contextlib.contextmanager @@ -64,13 +64,14 @@ def create_symlink(root: pathlib.Path, target_ext: str, destination_ext: str): def process_data_received(data: str) -> List[Dict[str, Any]]: - """Process the all JSON data which comes from the server. After listen is finished, this function will be called. + """Process the all JSON data which comes from the server. + + After listen is finished, this function will be called. Here the data must be split into individual JSON messages and then parsed. This function also: - Checks that the jsonrpc value is 2.0 - Checks that the last JSON message contains the `eot` token. - """ json_messages = [] remaining = data @@ -99,7 +100,8 @@ def parse_rpc_message(data: str) -> Tuple[Dict[str, str], str]: returns: json_data: A single rpc payload of JSON data from the server. - remaining: The remaining data after the JSON data.""" + remaining: The remaining data after the JSON data. + """ str_stream: io.StringIO = io.StringIO(data) length: int = 0 @@ -133,6 +135,7 @@ def parse_rpc_message(data: str) -> Tuple[Dict[str, str], str]: def _listen_on_pipe_new(listener, result: List[str], completed: threading.Event): """Listen on the named pipe or Unix domain socket for JSON data from the server. + Created as a separate function for clarity in threading context. """ # Windows design @@ -197,14 +200,7 @@ def runner(args: List[str]) -> Optional[List[Dict[str, Any]]]: def runner_with_cwd(args: List[str], path: pathlib.Path) -> Optional[List[Dict[str, Any]]]: """Run the pytest discovery and return the JSON data from the server.""" - process_args: List[str] = [ - sys.executable, - "-m", - "pytest", - "-p", - "vscode_pytest", - "-s", - ] + args + process_args: List[str] = [sys.executable, "-m", "pytest", "-p", "vscode_pytest", "-s", *args] # Generate pipe name, pipe name specific per OS type. pipe_name = generate_random_pipe_name("pytest-discovery-test") @@ -281,7 +277,7 @@ def find_test_line_number(test_name: str, test_file_path) -> str: test_file_path: The path to the test file where the test is located. """ test_file_unique_id: str = "test_marker--" + test_name.split("[")[0] - with open(test_file_path) as f: + with open(test_file_path) as f: # noqa: PTH123 for i, line in enumerate(f): if test_file_unique_id in line: return str(i + 1) @@ -289,11 +285,10 @@ def find_test_line_number(test_name: str, test_file_path) -> str: raise ValueError(error_str) -def get_absolute_test_id(test_id: str, testPath: pathlib.Path) -> str: +def get_absolute_test_id(test_id: str, test_path: pathlib.Path) -> str: """Get the absolute test id by joining the testPath with the test_id.""" split_id = test_id.split("::")[1:] - absolute_test_id = "::".join([str(testPath), *split_id]) - return absolute_test_id + return "::".join([str(test_path), *split_id]) def generate_random_pipe_name(prefix=""): @@ -310,9 +305,9 @@ def generate_random_pipe_name(prefix=""): # For Unix-like systems, use either the XDG_RUNTIME_DIR or a temporary directory. xdg_runtime_dir = os.getenv("XDG_RUNTIME_DIR") if xdg_runtime_dir: - return os.path.join(xdg_runtime_dir, f"{prefix}-{random_suffix}.sock") + return os.path.join(xdg_runtime_dir, f"{prefix}-{random_suffix}.sock") # noqa: PTH118 else: - return os.path.join(tempfile.gettempdir(), f"{prefix}-{random_suffix}.sock") + return os.path.join(tempfile.gettempdir(), f"{prefix}-{random_suffix}.sock") # noqa: PTH118 class UnixPipeServer: @@ -328,9 +323,9 @@ def __init__(self, name): self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) # Ensure the socket does not already exist try: - os.unlink(self.name) + os.unlink(self.name) # noqa: PTH108 except OSError: - if os.path.exists(self.name): + if os.path.exists(self.name): # noqa: PTH110 raise def start(self): diff --git a/python_files/tests/pytestadapter/test_discovery.py b/python_files/tests/pytestadapter/test_discovery.py index f8c4890658c9..c7752cf490ca 100644 --- a/python_files/tests/pytestadapter/test_discovery.py +++ b/python_files/tests/pytestadapter/test_discovery.py @@ -7,9 +7,9 @@ import pytest -from tests.tree_comparison_helper import is_same_tree # noqa: E402 +from tests.tree_comparison_helper import is_same_tree -from . import expected_discovery_test_output, helpers # noqa: E402 +from . import expected_discovery_test_output, helpers def test_import_error(): @@ -31,7 +31,7 @@ def test_import_error(): actual_list: List[Dict[str, Any]] = actual if actual_list is not None: for actual_item in actual_list: - assert all(item in actual_item.keys() for item in ("status", "cwd", "error")) + assert all(item in actual_item for item in ("status", "cwd", "error")) assert actual_item.get("status") == "error" assert actual_item.get("cwd") == os.fspath(helpers.TEST_DATA_PATH) @@ -42,10 +42,10 @@ def test_import_error(): ): # You can add other types if needed assert len(error_content) == 2 else: - assert False + pytest.fail(f"{error_content} is None or not a list, str, or tuple") -def test_syntax_error(tmp_path): +def test_syntax_error(tmp_path): # noqa: ARG001 """Test pytest discovery on a file that has a syntax error. Copies the contents of a .txt file to a .py file in the temporary directory @@ -67,7 +67,7 @@ def test_syntax_error(tmp_path): actual_list: List[Dict[str, Any]] = actual if actual_list is not None: for actual_item in actual_list: - assert all(item in actual_item.keys() for item in ("status", "cwd", "error")) + assert all(item in actual_item for item in ("status", "cwd", "error")) assert actual_item.get("status") == "error" assert actual_item.get("cwd") == os.fspath(helpers.TEST_DATA_PATH) @@ -78,7 +78,7 @@ def test_syntax_error(tmp_path): ): # You can add other types if needed assert len(error_content) == 2 else: - assert False + pytest.fail(f"{error_content} is None or not a list, str, or tuple") def test_parameterized_error_collect(): @@ -92,7 +92,7 @@ def test_parameterized_error_collect(): actual_list: List[Dict[str, Any]] = actual if actual_list is not None: for actual_item in actual_list: - assert all(item in actual_item.keys() for item in ("status", "cwd", "error")) + assert all(item in actual_item for item in ("status", "cwd", "error")) assert actual_item.get("status") == "error" assert actual_item.get("cwd") == os.fspath(helpers.TEST_DATA_PATH) @@ -103,11 +103,11 @@ def test_parameterized_error_collect(): ): # You can add other types if needed assert len(error_content) == 2 else: - assert False + pytest.fail(f"{error_content} is None or not a list, str, or tuple") @pytest.mark.parametrize( - "file, expected_const", + ("file", "expected_const"), [ ( "test_param_span_class.py", @@ -121,10 +121,6 @@ def test_parameterized_error_collect(): "same_function_new_class_param.py", expected_discovery_test_output.same_function_new_class_param_expected_output, ), - ( - "test_multi_class_nest.py", - expected_discovery_test_output.nested_classes_expected_test_output, - ), ( "unittest_skiptest_file_level.py", expected_discovery_test_output.unittest_skip_file_level_expected_output, @@ -168,11 +164,12 @@ def test_parameterized_error_collect(): ], ) def test_pytest_collect(file, expected_const): - """ - Test to test pytest discovery on a variety of test files/ folder structures. - Uses variables from expected_discovery_test_output.py to store the expected dictionary return. - Only handles discovery and therefore already contains the arg --collect-only. - All test discovery will succeed, be in the correct cwd, and match expected test output. + """Test to test pytest discovery on a variety of test files/ folder structures. + + Uses variables from expected_discovery_test_output.py to store the expected + dictionary return. Only handles discovery and therefore already contains the arg + --collect-only. All test discovery will succeed, be in the correct cwd, and match + expected test output. Keyword arguments: file -- a string with the file or folder to run pytest discovery on. @@ -189,7 +186,7 @@ def test_pytest_collect(file, expected_const): actual_list: List[Dict[str, Any]] = actual if actual_list is not None: actual_item = actual_list.pop(0) - assert all(item in actual_item.keys() for item in ("status", "cwd", "error")) + assert all(item in actual_item for item in ("status", "cwd", "error")) assert ( actual_item.get("status") == "success" ), f"Status is not 'success', error is: {actual_item.get('error')}" @@ -206,8 +203,8 @@ def test_pytest_collect(file, expected_const): reason="See https://stackoverflow.com/questions/32877260/privlege-error-trying-to-create-symlink-using-python-on-windows-10", ) def test_symlink_root_dir(): - """ - Test to test pytest discovery with the command line arg --rootdir specified as a symlink path. + """Test to test pytest discovery with the command line arg --rootdir specified as a symlink path. + Discovery should succeed and testids should be relative to the symlinked root directory. """ with helpers.create_symlink(helpers.TEST_DATA_PATH, "root", "symlink_folder") as ( @@ -228,7 +225,7 @@ def test_symlink_root_dir(): try: # Check if all requirements assert all( - item in actual_item.keys() for item in ("status", "cwd", "error") + item in actual_item for item in ("status", "cwd", "error") ), "Required keys are missing" assert actual_item.get("status") == "success", "Status is not 'success'" assert actual_item.get("cwd") == os.fspath( @@ -242,9 +239,9 @@ def test_symlink_root_dir(): def test_pytest_root_dir(): - """ - Test to test pytest discovery with the command line arg --rootdir specified to be a subfolder - of the workspace root. Discovery should succeed and testids should be relative to workspace root. + """Test to test pytest discovery with the command line arg --rootdir specified to be a subfolder of the workspace root. + + Discovery should succeed and testids should be relative to workspace root. """ rd = f"--rootdir={helpers.TEST_DATA_PATH / 'root' / 'tests'}" actual = helpers.runner_with_cwd( @@ -259,7 +256,7 @@ def test_pytest_root_dir(): if actual_list is not None: actual_item = actual_list.pop(0) - assert all(item in actual_item.keys() for item in ("status", "cwd", "error")) + assert all(item in actual_item for item in ("status", "cwd", "error")) assert actual_item.get("status") == "success" assert actual_item.get("cwd") == os.fspath(helpers.TEST_DATA_PATH / "root") assert is_same_tree( @@ -270,9 +267,9 @@ def test_pytest_root_dir(): def test_pytest_config_file(): - """ - Test to test pytest discovery with the command line arg -c with a specified config file which - changes the workspace root. Discovery should succeed and testids should be relative to workspace root. + """Test to test pytest discovery with the command line arg -c with a specified config file which changes the workspace root. + + Discovery should succeed and testids should be relative to workspace root. """ actual = helpers.runner_with_cwd( [ @@ -286,7 +283,7 @@ def test_pytest_config_file(): if actual_list is not None: actual_item = actual_list.pop(0) - assert all(item in actual_item.keys() for item in ("status", "cwd", "error")) + assert all(item in actual_item for item in ("status", "cwd", "error")) assert actual_item.get("status") == "success" assert actual_item.get("cwd") == os.fspath(helpers.TEST_DATA_PATH / "root") assert is_same_tree( @@ -298,7 +295,10 @@ def test_pytest_config_file(): def test_config_sub_folder(): """Here the session node will be a subfolder of the workspace root and the test are in another subfolder. - This tests checks to see if test node path are under the session node and if so the session node is correctly updated to the common path.""" + + This tests checks to see if test node path are under the session node and if so the + session node is correctly updated to the common path. + """ folder_path = helpers.TEST_DATA_PATH / "config_sub_folder" actual = helpers.runner_with_cwd( [ @@ -314,7 +314,7 @@ def test_config_sub_folder(): actual_list: List[Dict[str, Any]] = actual if actual_list is not None: actual_item = actual_list.pop(0) - assert all(item in actual_item.keys() for item in ("status", "cwd", "error")) + assert all(item in actual_item for item in ("status", "cwd", "error")) assert actual_item.get("status") == "success" assert actual_item.get("cwd") == os.fspath(helpers.TEST_DATA_PATH / "config_sub_folder") assert actual_item.get("tests") is not None diff --git a/python_files/tests/pytestadapter/test_execution.py b/python_files/tests/pytestadapter/test_execution.py index 98ed00954d60..3ea8c685a9fe 100644 --- a/python_files/tests/pytestadapter/test_execution.py +++ b/python_files/tests/pytestadapter/test_execution.py @@ -36,10 +36,10 @@ def test_config_file(): assert actual actual_list: List[Dict[str, Any]] = actual assert len(actual_list) == len(expected_const) - actual_result_dict = dict() + actual_result_dict = {} if actual_list is not None: for actual_item in actual_list: - assert all(item in actual_item.keys() for item in ("status", "cwd", "result")) + assert all(item in actual_item for item in ("status", "cwd", "result")) assert actual_item.get("status") == "success" assert actual_item.get("cwd") == os.fspath(new_cwd) actual_result_dict.update(actual_item["result"]) @@ -56,10 +56,10 @@ def test_rootdir_specified(): assert actual actual_list: List[Dict[str, Dict[str, Any]]] = actual assert len(actual_list) == len(expected_const) - actual_result_dict = dict() + actual_result_dict = {} if actual_list is not None: for actual_item in actual_list: - assert all(item in actual_item.keys() for item in ("status", "cwd", "result")) + assert all(item in actual_item for item in ("status", "cwd", "result")) assert actual_item.get("status") == "success" assert actual_item.get("cwd") == os.fspath(new_cwd) actual_result_dict.update(actual_item["result"]) @@ -95,7 +95,7 @@ def test_syntax_error_execution(tmp_path): if actual_list is not None: for actual_item in actual_list: - assert all(item in actual_item.keys() for item in ("status", "cwd", "error")) + assert all(item in actual_item for item in ("status", "cwd", "error")) assert actual_item.get("status") == "error" assert actual_item.get("cwd") == os.fspath(TEST_DATA_PATH) error_content = actual_item.get("error") @@ -104,7 +104,7 @@ def test_syntax_error_execution(tmp_path): ): # You can add other types if needed assert len(error_content) == 1 else: - assert False + pytest.fail(f"{error_content!r} is None or not a list, str, or tuple") def test_bad_id_error_execution(): @@ -117,20 +117,20 @@ def test_bad_id_error_execution(): actual_list: List[Dict[str, Dict[str, Any]]] = actual if actual_list is not None: for actual_item in actual_list: - assert all(item in actual_item.keys() for item in ("status", "cwd", "error")) + assert all(item in actual_item for item in ("status", "cwd", "error")) assert actual_item.get("status") == "error" assert actual_item.get("cwd") == os.fspath(TEST_DATA_PATH) error_content = actual_item.get("error") if error_content is not None and isinstance( error_content, (list, tuple, str) - ): # You can add other types if needed + ): # You can add other types if needed. assert len(error_content) == 1 else: - assert False + pytest.fail(f"{error_content!r} is None or not a list, str, or tuple") @pytest.mark.parametrize( - "test_ids, expected_const", + ("test_ids", "expected_const"), [ ( [ @@ -231,8 +231,8 @@ def test_bad_id_error_execution(): ) def test_pytest_execution(test_ids, expected_const): """ - Test that pytest discovery works as expected where run pytest is always successful - but the actual test results are both successes and failures.: + Test that pytest discovery works as expected where run pytest is always successful, but the actual test results are both successes and failures. + 1: skip_tests_execution_expected_output: test run on a file with skipped tests. 2. error_raised_exception_execution_expected_output: test run on a file that raises an exception. 3. uf_execution_expected_output: unittest tests run on multiple files. @@ -258,10 +258,10 @@ def test_pytest_execution(test_ids, expected_const): assert actual actual_list: List[Dict[str, Dict[str, Any]]] = actual assert len(actual_list) == len(expected_const) - actual_result_dict = dict() + actual_result_dict = {} if actual_list is not None: for actual_item in actual_list: - assert all(item in actual_item.keys() for item in ("status", "cwd", "result")) + assert all(item in actual_item for item in ("status", "cwd", "result")) assert actual_item.get("status") == "success" assert actual_item.get("cwd") == os.fspath(TEST_DATA_PATH) actual_result_dict.update(actual_item["result"]) @@ -277,8 +277,8 @@ def test_pytest_execution(test_ids, expected_const): def test_symlink_run(): - """ - Test to test pytest discovery with the command line arg --rootdir specified as a symlink path. + """Test to test pytest discovery with the command line arg --rootdir specified as a symlink path. + Discovery should succeed and testids should be relative to the symlinked root directory. """ with create_symlink(TEST_DATA_PATH, "root", "symlink_folder") as ( @@ -303,13 +303,13 @@ def test_symlink_run(): try: # Check if all requirements assert all( - item in actual_item.keys() for item in ("status", "cwd", "result") + item in actual_item for item in ("status", "cwd", "result") ), "Required keys are missing" assert actual_item.get("status") == "success", "Status is not 'success'" assert actual_item.get("cwd") == os.fspath( destination ), f"CWD does not match: {os.fspath(destination)}" - actual_result_dict = dict() + actual_result_dict = {} actual_result_dict.update(actual_item["result"]) assert actual_result_dict == expected_const except AssertionError as e: diff --git a/python_files/tests/pytestadapter/test_utils.py b/python_files/tests/pytestadapter/test_utils.py index 9a1a58376ad8..ef0ed2daf4e9 100644 --- a/python_files/tests/pytestadapter/test_utils.py +++ b/python_files/tests/pytestadapter/test_utils.py @@ -1,12 +1,12 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. -import pathlib -import tempfile import os +import pathlib import sys +import tempfile -from .helpers import ( # noqa: E402 +from .helpers import ( TEST_DATA_PATH, ) diff --git a/python_files/tests/run_all.py b/python_files/tests/run_all.py index 7c864ba7c5c1..3edb3cd3440c 100644 --- a/python_files/tests/run_all.py +++ b/python_files/tests/run_all.py @@ -2,10 +2,11 @@ # Licensed under the MIT License. # Replace the "." entry. -import os.path +import os +import pathlib import sys -sys.path[0] = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +sys.path[0] = os.fsdecode(pathlib.Path(__file__).parent.parent) from tests.__main__ import main, parse_args # noqa: E402 diff --git a/python_files/tests/test_create_conda.py b/python_files/tests/test_create_conda.py index 8681184ba821..82daafbea9dc 100644 --- a/python_files/tests/test_create_conda.py +++ b/python_files/tests/test_create_conda.py @@ -4,9 +4,10 @@ import importlib import sys -import create_conda import pytest +import create_conda + @pytest.mark.parametrize("env_exists", [True, False]) @pytest.mark.parametrize("git_ignore", [True, False]) diff --git a/python_files/tests/test_create_venv.py b/python_files/tests/test_create_venv.py index 1539f1d9b44e..2387f099140f 100644 --- a/python_files/tests/test_create_venv.py +++ b/python_files/tests/test_create_venv.py @@ -168,7 +168,7 @@ def test_toml_args(extras, expected): actual = [] - def run_process(args, error_message): + def run_process(args, error_message): # noqa: ARG001 nonlocal actual actual = args[1:] @@ -201,7 +201,7 @@ def test_requirements_args(extras, expected): actual = [] - def run_process(args, error_message): + def run_process(args, error_message): # noqa: ARG001 nonlocal actual actual.append(args) diff --git a/python_files/tests/test_dynamic_cursor.py b/python_files/tests/test_dynamic_cursor.py index 7aea59427aa6..d30887c24d5b 100644 --- a/python_files/tests/test_dynamic_cursor.py +++ b/python_files/tests/test_dynamic_cursor.py @@ -5,13 +5,7 @@ def test_dictionary_mouse_mover(): - """ - Having the mouse cursor on second line, - 'my_dict = {' - and pressing shift+enter should bring the - mouse cursor to line 6, on and to be able to run - 'print('only send the dictionary')' - """ + """Having the mouse cursor on second line, 'my_dict = {' and pressing shift+enter should bring the mouse cursor to line 6, on and to be able to run 'print('only send the dictionary')'.""" importlib.reload(normalizeSelection) src = textwrap.dedent( """\ @@ -24,18 +18,16 @@ def test_dictionary_mouse_mover(): """ ) - result = normalizeSelection.traverse_file(src, 2, 2, False) + result = normalizeSelection.traverse_file(src, 2, 2, was_highlighted=False) assert result["which_line_next"] == 6 def test_beginning_func(): - """ - Pressing shift+enter on the very first line, - of function definition, such as 'my_func():' - It should properly skip the comment and assert the - next executable line to be executed is line 5 at - 'my_dict = {' + """Pressing shift+enter on the very first line, of function definition, such as 'my_func():'. + + It should properly skip the comment and assert the next executable line to be + executed is line 5 at 'my_dict = {'. """ importlib.reload(normalizeSelection) src = textwrap.dedent( @@ -51,7 +43,7 @@ def my_func(): """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["which_line_next"] == 5 @@ -69,7 +61,7 @@ def test_cursor_forloop(): """ ) - result = normalizeSelection.traverse_file(src, 2, 2, False) + result = normalizeSelection.traverse_file(src, 2, 2, was_highlighted=False) assert result["which_line_next"] == 6 @@ -85,7 +77,7 @@ def test_inside_forloop(): """ ) - result = normalizeSelection.traverse_file(src, 2, 2, False) + result = normalizeSelection.traverse_file(src, 2, 2, was_highlighted=False) assert result["which_line_next"] == 3 @@ -98,7 +90,7 @@ def test_skip_sameline_statements(): print("Next line to be run is here!") """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["which_line_next"] == 2 @@ -119,17 +111,14 @@ def test_skip_multi_comp_lambda(): """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) # Shift enter from the very first ( should make # next executable statement as the lambda expression assert result["which_line_next"] == 7 def test_move_whole_class(): - """ - Shift+enter on a class definition - should move the cursor after running whole class. - """ + """Shift+enter on a class definition should move the cursor after running whole class.""" importlib.reload(normalizeSelection) src = textwrap.dedent( """\ @@ -142,7 +131,7 @@ def add_call(self, name, args=None, kwargs=None): print("We should be here after running whole class") """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["which_line_next"] == 7 @@ -163,7 +152,7 @@ def next_func(): print("Not here but above") """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["which_line_next"] == 9 @@ -181,7 +170,7 @@ def test_try_catch_move(): """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["which_line_next"] == 6 @@ -199,5 +188,5 @@ def test_skip_nested(): print("Cursor should be here after running line 1") """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["which_line_next"] == 8 diff --git a/python_files/tests/test_installed_check.py b/python_files/tests/test_installed_check.py index dae019359e08..607e02f34abd 100644 --- a/python_files/tests/test_installed_check.py +++ b/python_files/tests/test_installed_check.py @@ -7,9 +7,9 @@ import pathlib import subprocess import sys +from typing import Dict, List, Optional, Union import pytest -from typing import Dict, List, Optional, Union SCRIPT_PATH = pathlib.Path(__file__).parent.parent / "installed_check.py" TEST_DATA = pathlib.Path(__file__).parent / "test_data" @@ -21,12 +21,12 @@ def generate_file(base_file: pathlib.Path): basename = "pyproject.toml" if "pyproject" in base_file.name else "requirements.txt" fullpath = base_file.parent / basename if fullpath.exists(): - os.unlink(os.fspath(fullpath)) + fullpath.unlink() fullpath.write_text(base_file.read_text(encoding="utf-8")) try: yield fullpath finally: - os.unlink(str(fullpath)) + fullpath.unlink() def run_on_file( @@ -41,8 +41,7 @@ def run_on_file( os.fspath(SCRIPT_PATH), os.fspath(file_path), ], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE, + capture_output=True, check=True, env=env, ) diff --git a/python_files/tests/test_normalize_selection.py b/python_files/tests/test_normalize_selection.py index 60dfddb11e2d..e16eb118db12 100644 --- a/python_files/tests/test_normalize_selection.py +++ b/python_files/tests/test_normalize_selection.py @@ -10,16 +10,16 @@ import normalizeSelection -class TestNormalizationScript(object): +class TestNormalizationScript: """Unit tests for the normalization script.""" - def test_basicNormalization(self): + def test_basic_normalization(self): src = 'print("this is a test")' expected = src + "\n" result = normalizeSelection.normalize_lines(src) assert result == expected - def test_moreThanOneLine(self): + def test_more_than_one_line(self): src = textwrap.dedent( """\ # Some rando comment @@ -38,7 +38,7 @@ def show_something(): result = normalizeSelection.normalize_lines(src) assert result == expected - def test_withHangingIndent(self): + def test_with_hanging_indent(self): src = textwrap.dedent( """\ x = 22 @@ -64,7 +64,7 @@ def test_withHangingIndent(self): result = normalizeSelection.normalize_lines(src) assert result == expected - def test_clearOutExtraneousNewlines(self): + def test_clear_out_extraneous_newlines(self): src = textwrap.dedent( """\ value_x = 22 @@ -88,7 +88,7 @@ def test_clearOutExtraneousNewlines(self): result = normalizeSelection.normalize_lines(src) assert result == expected - def test_clearOutExtraLinesAndWhitespace(self): + def test_clear_out_extra_lines_and_whitespace(self): src = textwrap.dedent( """\ if True: @@ -115,13 +115,13 @@ def test_clearOutExtraLinesAndWhitespace(self): result = normalizeSelection.normalize_lines(src) assert result == expected - def test_partialSingleLine(self): + def test_partial_single_line(self): src = " print('foo')" expected = textwrap.dedent(src) + "\n" result = normalizeSelection.normalize_lines(src) assert result == expected - def test_multiLineWithIndent(self): + def test_multiline_with_indent(self): src = """\ if (x > 0 @@ -146,7 +146,7 @@ def test_multiLineWithIndent(self): result = normalizeSelection.normalize_lines(src) assert result == expected - def test_multiLineWithComment(self): + def test_multiline_with_comment(self): src = textwrap.dedent( """\ @@ -172,7 +172,7 @@ def test_exception(self): result = normalizeSelection.normalize_lines(src) assert result == expected - def test_multilineException(self): + def test_multiline_exception(self): src = textwrap.dedent( """\ diff --git a/python_files/tests/test_shell_integration.py b/python_files/tests/test_shell_integration.py index c5911aad2d1d..ea7ea4099bb2 100644 --- a/python_files/tests/test_shell_integration.py +++ b/python_files/tests/test_shell_integration.py @@ -1,12 +1,13 @@ import importlib import sys from unittest.mock import Mock + import pythonrc def test_decoration_success(): importlib.reload(pythonrc) - ps1 = pythonrc.ps1() + ps1 = pythonrc.PS1() ps1.hooks.failure_flag = False result = str(ps1) @@ -21,7 +22,7 @@ def test_decoration_success(): def test_decoration_failure(): importlib.reload(pythonrc) - ps1 = pythonrc.ps1() + ps1 = pythonrc.PS1() ps1.hooks.failure_flag = True result = str(ps1) @@ -36,10 +37,10 @@ def test_decoration_failure(): def test_displayhook_call(): importlib.reload(pythonrc) - pythonrc.ps1() + pythonrc.PS1() mock_displayhook = Mock() - hooks = pythonrc.repl_hooks() + hooks = pythonrc.REPLHooks() hooks.original_displayhook = mock_displayhook hooks.my_displayhook("mock_value") @@ -49,10 +50,10 @@ def test_displayhook_call(): def test_excepthook_call(): importlib.reload(pythonrc) - pythonrc.ps1() + pythonrc.PS1() mock_excepthook = Mock() - hooks = pythonrc.repl_hooks() + hooks = pythonrc.REPLHooks() hooks.original_excepthook = mock_excepthook hooks.my_excepthook("mock_type", "mock_value", "mock_traceback") diff --git a/python_files/tests/test_smart_selection.py b/python_files/tests/test_smart_selection.py index b86e6f9dc82e..15b1b1a3ec02 100644 --- a/python_files/tests/test_smart_selection.py +++ b/python_files/tests/test_smart_selection.py @@ -26,7 +26,7 @@ def test_part_dictionary(): """ ) - result = normalizeSelection.traverse_file(src, 3, 3, False) + result = normalizeSelection.traverse_file(src, 3, 3, was_highlighted=False) assert result["normalized_smart_result"] == expected @@ -53,7 +53,7 @@ def test_nested_loop(): """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["normalized_smart_result"] == expected @@ -84,7 +84,7 @@ def test_smart_shift_enter_multiple_statements(): print("Mercedes") """ ) - result = normalizeSelection.traverse_file(src, 8, 8, False) + result = normalizeSelection.traverse_file(src, 8, 8, was_highlighted=False) assert result["normalized_smart_result"] == expected @@ -128,7 +128,7 @@ def test_two_layer_dictionary(): } """ ) - result = normalizeSelection.traverse_file(src, 6, 7, False) + result = normalizeSelection.traverse_file(src, 6, 7, was_highlighted=False) assert result["normalized_smart_result"] == expected @@ -158,7 +158,7 @@ def my_dogs(): """ ) - result = normalizeSelection.traverse_file(src, 2, 2, False) + result = normalizeSelection.traverse_file(src, 2, 2, was_highlighted=False) assert result["normalized_smart_result"] == expected @@ -183,18 +183,13 @@ def test_small_forloop(): # Cover the whole for loop block with multiple inner statements # Make sure to contain all of the print statements included. - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["normalized_smart_result"] == expected def inner_for_loop_component(): - """ - Pressing shift+enter inside a for loop, - specifically on a viable expression - by itself, such as print(i) - should only return that exact expression - """ + """Pressing shift+enter inside a for loop, specifically on a viable expression by itself, such as print(i) should only return that exact expression.""" importlib.reload(normalizeSelection) src = textwrap.dedent( """\ @@ -203,7 +198,7 @@ def inner_for_loop_component(): print("Please also send this print statement") """ ) - result = normalizeSelection.traverse_file(src, 2, 2, False) + result = normalizeSelection.traverse_file(src, 2, 2, was_highlighted=False) expected = textwrap.dedent( """\ print(i) @@ -214,13 +209,7 @@ def inner_for_loop_component(): def test_dict_comprehension(): - """ - Having the mouse cursor on the first line, - and pressing shift+enter should return the - whole dictionary comp, respecting user's code style. - """ - - importlib.reload + """Having the mouse cursor on the first line, and pressing shift+enter should return the whole dictionary comp, respecting user's code style.""" src = textwrap.dedent( """\ my_dict_comp = {temp_mover: @@ -235,17 +224,13 @@ def test_dict_comprehension(): """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["normalized_smart_result"] == expected def test_send_whole_generator(): - """ - Pressing shift+enter on the first line, which is the '(' - should be returning the whole generator expression instead of just the '(' - """ - + """Pressing shift+enter on the first line, which is the '(' should be returning the whole generator expression instead of just the '('.""" importlib.reload(normalizeSelection) src = textwrap.dedent( """\ @@ -268,19 +253,13 @@ def test_send_whole_generator(): """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["normalized_smart_result"] == expected def test_multiline_lambda(): - """ - Shift+enter on part of the lambda expression - should return the whole lambda expression, - regardless of whether all the component of - lambda expression is on the same or not. - """ - + """Shift+enter on part of the lambda expression should return the whole lambda expression, regardless of whether all the component of lambda expression is on the same or not.""" importlib.reload(normalizeSelection) src = textwrap.dedent( """\ @@ -298,15 +277,12 @@ def test_multiline_lambda(): """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["normalized_smart_result"] == expected def test_send_whole_class(): - """ - Shift+enter on a class definition - should send the whole class definition - """ + """Shift+enter on a class definition should send the whole class definition.""" importlib.reload(normalizeSelection) src = textwrap.dedent( """\ @@ -319,7 +295,7 @@ def add_call(self, name, args=None, kwargs=None): print("We should be here after running whole class") """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) expected = textwrap.dedent( """\ class Stub(object): @@ -334,11 +310,7 @@ def add_call(self, name, args=None, kwargs=None): def test_send_whole_if_statement(): - """ - Shift+enter on an if statement - should send the whole if statement - including statements inside and else. - """ + """Shift+enter on an if statement should send the whole if statement including statements inside and else.""" importlib.reload(normalizeSelection) src = textwrap.dedent( """\ @@ -359,7 +331,7 @@ def test_send_whole_if_statement(): """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["normalized_smart_result"] == expected @@ -384,5 +356,5 @@ def test_send_try(): """ ) - result = normalizeSelection.traverse_file(src, 1, 1, False) + result = normalizeSelection.traverse_file(src, 1, 1, was_highlighted=False) assert result["normalized_smart_result"] == expected diff --git a/python_files/tests/testing_tools/adapter/pytest/test_cli.py b/python_files/tests/testing_tools/adapter/pytest/test_cli.py index 6f590a31fa56..b1d9196cd50d 100644 --- a/python_files/tests/testing_tools/adapter/pytest/test_cli.py +++ b/python_files/tests/testing_tools/adapter/pytest/test_cli.py @@ -1,16 +1,18 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. +# ruff:noqa: PT009, PT027 import unittest -from ....util import Stub, StubProxy from testing_tools.adapter.errors import UnsupportedCommandError from testing_tools.adapter.pytest._cli import add_subparser +from ....util import Stub, StubProxy + class StubSubparsers(StubProxy): def __init__(self, stub=None, name="subparsers"): - super(StubSubparsers, self).__init__(stub, name) + super().__init__(stub, name) def add_parser(self, name): self.add_call("add_parser", None, {"name": name}) @@ -19,7 +21,7 @@ def add_parser(self, name): class StubArgParser(StubProxy): def __init__(self, stub=None): - super(StubArgParser, self).__init__(stub, "argparser") + super().__init__(stub, "argparser") def add_argument(self, *args, **kwargs): self.add_call("add_argument", args, kwargs) diff --git a/python_files/tests/testing_tools/adapter/pytest/test_discovery.py b/python_files/tests/testing_tools/adapter/pytest/test_discovery.py index 55a0e65102ae..c8658ad2d89e 100644 --- a/python_files/tests/testing_tools/adapter/pytest/test_discovery.py +++ b/python_files/tests/testing_tools/adapter/pytest/test_discovery.py @@ -1,7 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. - -from __future__ import print_function, unicode_literals +# ruff:noqa: PT009, PT027, SLF001 try: from io import StringIO @@ -15,6 +14,7 @@ import _pytest.doctest import pytest + from testing_tools.adapter import info from testing_tools.adapter import util as adapter_util from testing_tools.adapter.pytest import _discovery @@ -37,7 +37,7 @@ def unique(collection, key): class StubPyTest(util.StubProxy): def __init__(self, stub=None): - super(StubPyTest, self).__init__(stub, "pytest") + super().__init__(stub, "pytest") self.return_main = 0 def main(self, args, plugins): @@ -49,7 +49,7 @@ class StubPlugin(util.StubProxy): _started = True def __init__(self, stub=None, tests=None): - super(StubPlugin, self).__init__(stub, "plugin") + super().__init__(stub, "plugin") if tests is None: tests = StubDiscoveredTests(self.stub) self._tests = tests @@ -68,7 +68,7 @@ class StubDiscoveredTests(util.StubProxy): NOT_FOUND = object() def __init__(self, stub=None): - super(StubDiscoveredTests, self).__init__(stub, "discovered") + super().__init__(stub, "discovered") self.return_items = [] self.return_parents = [] @@ -92,12 +92,12 @@ def add_test(self, test, parents): self.add_call("add_test", None, {"test": test, "parents": parents}) -class FakeFunc(object): +class FakeFunc: def __init__(self, name): self.__name__ = name -class FakeMarker(object): +class FakeMarker: def __init__(self, name): self.name = name @@ -107,7 +107,7 @@ class StubPytestItem(util.StubProxy): _hasfunc = True def __init__(self, stub=None, **attrs): - super(StubPytestItem, self).__init__(stub, "pytest.Item") + super().__init__(stub, "pytest.Item") if attrs.get("function") is None: attrs.pop("function", None) self._hasfunc = False @@ -133,9 +133,8 @@ def __repr__(self): def __getattr__(self, name): if not self._debugging: self.add_call(name + " (attr)", None, None) - if name == "function": - if not self._hasfunc: - raise AttributeError(name) + if name == "function" and not self._hasfunc: + raise AttributeError(name) def func(*args, **kwargs): self.add_call(name, args or None, kwargs or None) @@ -153,7 +152,7 @@ def from_args(cls, *args, **kwargs): return self def __init__(self, *args, **kwargs): - super(StubSubtypedItem, self).__init__(*args, **kwargs) + super().__init__(*args, **kwargs) if "nodeid" in self.__dict__: self._nodeid = self.__dict__.pop("nodeid") @@ -182,7 +181,7 @@ def create_stub_doctest_item(*args, **kwargs): class StubPytestSession(util.StubProxy): def __init__(self, stub=None): - super(StubPytestSession, self).__init__(stub, "pytest.Session") + super().__init__(stub, "pytest.Session") def __getattr__(self, name): self.add_call(name + " (attr)", None, None) @@ -195,7 +194,7 @@ def func(*args, **kwargs): class StubPytestConfig(util.StubProxy): def __init__(self, stub=None): - super(StubPytestConfig, self).__init__(stub, "pytest.Config") + super().__init__(stub, "pytest.Config") def __getattr__(self, name): self.add_call(name + " (attr)", None, None) @@ -220,94 +219,67 @@ def normcase(path): def _fix_fileid(*args): return adapter_util.fix_fileid( *args, - **dict( - # dependency injection - _normcase=normcase, - _pathsep=pathsep, - ), + _normcase=normcase, + _pathsep=pathsep, ) def _normalize_test_id(*args): return pytest_item._normalize_test_id( *args, - **dict( - # dependency injection - _fix_fileid=_fix_fileid, - _pathsep=pathsep, - ), + _fix_fileid=_fix_fileid, + _pathsep=pathsep, ) def _iter_nodes(*args): return pytest_item._iter_nodes( *args, - **dict( - # dependency injection - _normalize_test_id=_normalize_test_id, - _normcase=normcase, - _pathsep=pathsep, - ), + _normalize_test_id=_normalize_test_id, + _normcase=normcase, + _pathsep=pathsep, ) def _parse_node_id(*args): return pytest_item._parse_node_id( *args, - **dict( - # dependency injection - _iter_nodes=_iter_nodes, - ), + _iter_nodes=_iter_nodes, ) ########## def _split_fspath(*args): return pytest_item._split_fspath( *args, - **dict( - # dependency injection - _normcase=normcase, - ), + _normcase=normcase, ) ########## def _matches_relfile(*args): return pytest_item._matches_relfile( *args, - **dict( - # dependency injection - _normcase=normcase, - _pathsep=pathsep, - ), + _normcase=normcase, + _pathsep=pathsep, ) def _is_legacy_wrapper(*args): return pytest_item._is_legacy_wrapper( *args, - **dict( - # dependency injection - _pathsep=pathsep, - ), + _pathsep=pathsep, ) def _get_location(*args): return pytest_item._get_location( *args, - **dict( - # dependency injection - _matches_relfile=_matches_relfile, - _is_legacy_wrapper=_is_legacy_wrapper, - _pathsep=pathsep, - ), + _matches_relfile=_matches_relfile, + _is_legacy_wrapper=_is_legacy_wrapper, + _pathsep=pathsep, ) ########## def _parse_item(item): return pytest_item.parse_item( item, - **dict( - # dependency injection - _parse_node_id=_parse_node_id, - _split_fspath=_split_fspath, - _get_location=_get_location, - ), + _parse_node_id=_parse_node_id, + _split_fspath=_split_fspath, + _get_location=_get_location, ) return _parse_item @@ -330,9 +302,7 @@ def ret(args, plugins): class DiscoverTests(unittest.TestCase): - DEFAULT_ARGS = [ - "--collect-only", - ] + DEFAULT_ARGS = ["--collect-only"] # noqa: RUF012 def test_basic(self): stub = util.Stub() @@ -362,7 +332,7 @@ def test_failure(self): pytest.return_main = 2 plugin = StubPlugin(stub) - with self.assertRaises(Exception): + with self.assertRaises(Exception): # noqa: B017 _discovery.discover([], _pytest_main=pytest.main, _plugin=plugin) self.assertEqual( @@ -440,7 +410,7 @@ def test_stdio_hidden_file(self): _discovery.discover( [], hidestdio=True, - _pytest_main=fake_pytest_main(stub, False, pytest_stdout), + _pytest_main=fake_pytest_main(stub, False, pytest_stdout), # noqa: FBT003 _plugin=plugin, ) finally: @@ -468,7 +438,7 @@ def test_stdio_hidden_fd(self): _discovery.discover( [], hidestdio=True, - _pytest_main=fake_pytest_main(stub, True, pytest_stdout), + _pytest_main=fake_pytest_main(stub, True, pytest_stdout), # noqa: FBT003 _plugin=plugin, ) captured = sys.stdout.read() @@ -496,7 +466,7 @@ def test_stdio_not_hidden_file(self): _discovery.discover( [], hidestdio=False, - _pytest_main=fake_pytest_main(stub, False, pytest_stdout), + _pytest_main=fake_pytest_main(stub, False, pytest_stdout), # noqa: FBT003 _plugin=plugin, ) finally: @@ -522,7 +492,7 @@ def test_stdio_not_hidden_fd(self): _discovery.discover( [], hidestdio=False, - _pytest_main=fake_pytest_main(stub, True, pytest_stdout), + _pytest_main=fake_pytest_main(stub, True, pytest_stdout), # noqa: FBT003 _plugin=plugin, ) finally: @@ -628,13 +598,13 @@ def test_modifyitems(self): ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./test_spam.py::SpamTests", "SpamTests", "suite"), ("./test_spam.py", "test_spam.py", "file"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./test_spam.py::SpamTests::test_one", name="test_one", path=info.SingleTestPath( @@ -643,22 +613,22 @@ def test_modifyitems(self): func="SpamTests.test_one", sub=None, ), - source="{}:{}".format(relfile1, 13), + source=f"{relfile1}:{13}", markers=None, parentid="./test_spam.py::SpamTests", ), - ), + }, ), ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./test_spam.py::SpamTests", "SpamTests", "suite"), ("./test_spam.py", "test_spam.py", "file"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./test_spam.py::SpamTests::test_other", name="test_other", path=info.SingleTestPath( @@ -667,21 +637,21 @@ def test_modifyitems(self): func="SpamTests.test_other", sub=None, ), - source="{}:{}".format(relfile1, 20), + source=f"{relfile1}:{20}", markers=None, parentid="./test_spam.py::SpamTests", ), - ), + }, ), ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./test_spam.py", "test_spam.py", "file"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./test_spam.py::test_all", name="test_all", path=info.SingleTestPath( @@ -690,22 +660,22 @@ def test_modifyitems(self): func="test_all", sub=None, ), - source="{}:{}".format(relfile1, 145), + source=f"{relfile1}:{145}", markers=None, parentid="./test_spam.py", ), - ), + }, ), ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./test_spam.py::test_each", "test_each", "function"), ("./test_spam.py", "test_spam.py", "file"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./test_spam.py::test_each[10-10]", name="10-10", path=info.SingleTestPath( @@ -714,17 +684,17 @@ def test_modifyitems(self): func="test_each", sub=["[10-10]"], ), - source="{}:{}".format(relfile1, 274), + source=f"{relfile1}:{274}", markers=None, parentid="./test_spam.py::test_each", ), - ), + }, ), ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ( "./x/y/z/test_eggs.py::All::BasicTests", "BasicTests", @@ -737,7 +707,7 @@ def test_modifyitems(self): ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::All::BasicTests::test_first", name="test_first", path=info.SingleTestPath( @@ -746,17 +716,17 @@ def test_modifyitems(self): func="All.BasicTests.test_first", sub=None, ), - source="{}:{}".format(adapter_util.fix_relpath(relfile2), 32), + source=f"{adapter_util.fix_relpath(relfile2)}:{32}", markers=None, parentid="./x/y/z/test_eggs.py::All::BasicTests", ), - ), + }, ), ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ( "./x/y/z/test_eggs.py::All::BasicTests::test_each", "test_each", @@ -774,7 +744,7 @@ def test_modifyitems(self): ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::All::BasicTests::test_each[1+2-3]", name="1+2-3", path=info.SingleTestPath( @@ -783,11 +753,11 @@ def test_modifyitems(self): func="All.BasicTests.test_each", sub=["[1+2-3]"], ), - source="{}:{}".format(adapter_util.fix_relpath(relfile2), 63), + source=f"{adapter_util.fix_relpath(relfile2)}:{63}", markers=["expected-failure", "skip", "skip-if"], parentid="./x/y/z/test_eggs.py::All::BasicTests::test_each", ), - ), + }, ), ] self.assertEqual(stub.calls, expected) @@ -821,8 +791,8 @@ def test_finish(self): ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./x/y/z/test_eggs.py::SpamTests", "SpamTests", "suite"), ("./x/y/z/test_eggs.py", "test_eggs.py", "file"), ("./x/y/z", "z", "folder"), @@ -830,7 +800,7 @@ def test_finish(self): ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::SpamTests::test_spam", name="test_spam", path=info.SingleTestPath( @@ -839,11 +809,11 @@ def test_finish(self): func="SpamTests.test_spam", sub=None, ), - source="{}:{}".format(adapter_util.fix_relpath(relfile), 13), + source=f"{adapter_util.fix_relpath(relfile)}:{13}", markers=None, parentid="./x/y/z/test_eggs.py::SpamTests", ), - ), + }, ), ], ) @@ -898,13 +868,13 @@ def test_doctest(self): ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./x/test_doctest.txt", "test_doctest.txt", "file"), ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/test_doctest.txt::test_doctest.txt", name="test_doctest.txt", path=info.SingleTestPath( @@ -912,24 +882,24 @@ def test_doctest(self): relfile=adapter_util.fix_relpath(doctestfile), func=None, ), - source="{}:{}".format(adapter_util.fix_relpath(doctestfile), 1), + source=f"{adapter_util.fix_relpath(doctestfile)}:{1}", markers=[], parentid="./x/test_doctest.txt", ), - ), + }, ), ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./x/y/z/test_eggs.py", "test_eggs.py", "file"), ("./x/y/z", "z", "folder"), ("./x/y", "y", "folder"), ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::test_eggs", name="test_eggs", path=info.SingleTestPath( @@ -937,24 +907,24 @@ def test_doctest(self): relfile=adapter_util.fix_relpath(relfile), func=None, ), - source="{}:{}".format(adapter_util.fix_relpath(relfile), 1), + source=f"{adapter_util.fix_relpath(relfile)}:{1}", markers=[], parentid="./x/y/z/test_eggs.py", ), - ), + }, ), ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./x/y/z/test_eggs.py", "test_eggs.py", "file"), ("./x/y/z", "z", "folder"), ("./x/y", "y", "folder"), ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::test_eggs.TestSpam", name="test_eggs.TestSpam", path=info.SingleTestPath( @@ -962,24 +932,24 @@ def test_doctest(self): relfile=adapter_util.fix_relpath(relfile), func=None, ), - source="{}:{}".format(adapter_util.fix_relpath(relfile), 13), + source=f"{adapter_util.fix_relpath(relfile)}:{13}", markers=[], parentid="./x/y/z/test_eggs.py", ), - ), + }, ), ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./x/y/z/test_eggs.py", "test_eggs.py", "file"), ("./x/y/z", "z", "folder"), ("./x/y", "y", "folder"), ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::test_eggs.TestSpam.TestEggs", name="test_eggs.TestSpam.TestEggs", path=info.SingleTestPath( @@ -987,11 +957,11 @@ def test_doctest(self): relfile=adapter_util.fix_relpath(relfile), func=None, ), - source="{}:{}".format(adapter_util.fix_relpath(relfile), 28), + source=f"{adapter_util.fix_relpath(relfile)}:{28}", markers=[], parentid="./x/y/z/test_eggs.py", ), - ), + }, ), ], ) @@ -1025,8 +995,8 @@ def test_nested_brackets(self): ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ( "./x/y/z/test_eggs.py::SpamTests::test_spam", "test_spam", @@ -1039,7 +1009,7 @@ def test_nested_brackets(self): ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::SpamTests::test_spam[a-[b]-c]", name="a-[b]-c", path=info.SingleTestPath( @@ -1048,11 +1018,11 @@ def test_nested_brackets(self): func="SpamTests.test_spam", sub=["[a-[b]-c]"], ), - source="{}:{}".format(adapter_util.fix_relpath(relfile), 13), + source=f"{adapter_util.fix_relpath(relfile)}:{13}", markers=None, parentid="./x/y/z/test_eggs.py::SpamTests::test_spam", ), - ), + }, ), ], ) @@ -1086,8 +1056,8 @@ def test_nested_suite(self): ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ( "./x/y/z/test_eggs.py::SpamTests::Ham::Eggs", "Eggs", @@ -1101,7 +1071,7 @@ def test_nested_suite(self): ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::SpamTests::Ham::Eggs::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1110,11 +1080,11 @@ def test_nested_suite(self): func="SpamTests.Ham.Eggs.test_spam", sub=None, ), - source="{}:{}".format(adapter_util.fix_relpath(relfile), 13), + source=f"{adapter_util.fix_relpath(relfile)}:{13}", markers=None, parentid="./x/y/z/test_eggs.py::SpamTests::Ham::Eggs", ), - ), + }, ), ], ) @@ -1184,8 +1154,8 @@ def test_windows(self): ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ (r"./X/Y/Z/test_Eggs.py::SpamTests", "SpamTests", "suite"), (r"./X/Y/Z/test_Eggs.py", "test_Eggs.py", "file"), (r"./X/Y/Z", "Z", "folder"), @@ -1193,7 +1163,7 @@ def test_windows(self): (r"./X", "X", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id=r"./X/Y/Z/test_Eggs.py::SpamTests::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1206,7 +1176,7 @@ def test_windows(self): markers=None, parentid=r"./X/Y/Z/test_Eggs.py::SpamTests", ), - ), + }, ), # permutations # (*all* the IDs use "/") @@ -1215,13 +1185,13 @@ def test_windows(self): ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ (r"./X/test_a.py", "test_a.py", "file"), (r"./X", "X", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id=r"./X/test_a.py::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1234,19 +1204,19 @@ def test_windows(self): markers=None, parentid=r"./X/test_a.py", ), - ), + }, ), # /, \, / ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ (r"./X/test_b.py", "test_b.py", "file"), (r"./X", "X", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id=r"./X/test_b.py::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1259,19 +1229,19 @@ def test_windows(self): markers=None, parentid=r"./X/test_b.py", ), - ), + }, ), # /, /, \ ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ (r"./X/test_c.py", "test_c.py", "file"), (r"./X", "X", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id=r"./X/test_c.py::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1284,19 +1254,19 @@ def test_windows(self): markers=None, parentid=r"./X/test_c.py", ), - ), + }, ), # /, /, / ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ (r"./X/test_d.py", "test_d.py", "file"), (r"./X", "X", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id=r"./X/test_d.py::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1309,19 +1279,19 @@ def test_windows(self): markers=None, parentid=r"./X/test_d.py", ), - ), + }, ), # \, \, \ ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ (r"./X/test_e.py", "test_e.py", "file"), (r"./X", "X", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id=r"./X/test_e.py::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1334,19 +1304,19 @@ def test_windows(self): markers=None, parentid=r"./X/test_e.py", ), - ), + }, ), # \, \, / ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ (r"./X/test_f.py", "test_f.py", "file"), (r"./X", "X", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id=r"./X/test_f.py::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1359,19 +1329,19 @@ def test_windows(self): markers=None, parentid=r"./X/test_f.py", ), - ), + }, ), # \, /, \ ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ (r"./X/test_g.py", "test_g.py", "file"), (r"./X", "X", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id=r"./X/test_g.py::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1384,19 +1354,19 @@ def test_windows(self): markers=None, parentid=r"./X/test_g.py", ), - ), + }, ), # \, /, / ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ (r"./X/test_h.py", "test_h.py", "file"), (r"./X", "X", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id=r"./X/test_h.py::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1409,7 +1379,7 @@ def test_windows(self): markers=None, parentid=r"./X/test_h.py", ), - ), + }, ), ] self.assertEqual(stub.calls, expected) @@ -1443,8 +1413,8 @@ def test_mysterious_parens(self): ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./x/y/z/test_eggs.py::SpamTests", "SpamTests", "suite"), ("./x/y/z/test_eggs.py", "test_eggs.py", "file"), ("./x/y/z", "z", "folder"), @@ -1452,7 +1422,7 @@ def test_mysterious_parens(self): ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::SpamTests::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1461,11 +1431,11 @@ def test_mysterious_parens(self): func="SpamTests.test_spam", sub=[], ), - source="{}:{}".format(adapter_util.fix_relpath(relfile), 13), + source=f"{adapter_util.fix_relpath(relfile)}:{13}", markers=None, parentid="./x/y/z/test_eggs.py::SpamTests", ), - ), + }, ), ], ) @@ -1499,8 +1469,8 @@ def test_mysterious_colons(self): ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./x/y/z/test_eggs.py::SpamTests", "SpamTests", "suite"), ("./x/y/z/test_eggs.py", "test_eggs.py", "file"), ("./x/y/z", "z", "folder"), @@ -1508,7 +1478,7 @@ def test_mysterious_colons(self): ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::SpamTests::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1517,11 +1487,11 @@ def test_mysterious_colons(self): func="SpamTests.test_spam", sub=[], ), - source="{}:{}".format(adapter_util.fix_relpath(relfile), 13), + source=f"{adapter_util.fix_relpath(relfile)}:{13}", markers=None, parentid="./x/y/z/test_eggs.py::SpamTests", ), - ), + }, ), ], ) @@ -1567,8 +1537,8 @@ def test_imported_test(self): ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./x/y/z/test_eggs.py::SpamTests", "SpamTests", "suite"), ("./x/y/z/test_eggs.py", "test_eggs.py", "file"), ("./x/y/z", "z", "folder"), @@ -1576,7 +1546,7 @@ def test_imported_test(self): ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::SpamTests::test_spam", name="test_spam", path=info.SingleTestPath( @@ -1585,24 +1555,24 @@ def test_imported_test(self): func="SpamTests.test_spam", sub=None, ), - source="{}:{}".format(adapter_util.fix_relpath(srcfile), 13), + source=f"{adapter_util.fix_relpath(srcfile)}:{13}", markers=None, parentid="./x/y/z/test_eggs.py::SpamTests", ), - ), + }, ), ( "discovered.add_test", None, - dict( - parents=[ + { + "parents": [ ("./x/y/z/test_eggs.py", "test_eggs.py", "file"), ("./x/y/z", "z", "folder"), ("./x/y", "y", "folder"), ("./x", "x", "folder"), (".", testroot, "folder"), ], - test=info.SingleTestInfo( + "test": info.SingleTestInfo( id="./x/y/z/test_eggs.py::test_ham", name="test_ham", path=info.SingleTestPath( @@ -1611,11 +1581,11 @@ def test_imported_test(self): func="test_ham", sub=None, ), - source="{}:{}".format(adapter_util.fix_relpath(srcfile), 4), + source=f"{adapter_util.fix_relpath(srcfile)}:{4}", markers=None, parentid="./x/y/z/test_eggs.py", ), - ), + }, ), ], ) diff --git a/python_files/tests/testing_tools/adapter/test___main__.py b/python_files/tests/testing_tools/adapter/test___main__.py index 5ff0ec30c947..8028db530012 100644 --- a/python_files/tests/testing_tools/adapter/test___main__.py +++ b/python_files/tests/testing_tools/adapter/test___main__.py @@ -1,5 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. +# ruff:noqa: PT009, PT027 import unittest @@ -15,7 +16,7 @@ class StubTool(StubProxy): def __init__(self, name, stub=None): - super(StubTool, self).__init__(stub, name) + super().__init__(stub, name) self.return_discover = None def discover(self, args, **kwargs): @@ -27,7 +28,7 @@ def discover(self, args, **kwargs): class StubReporter(StubProxy): def __init__(self, stub=None): - super(StubReporter, self).__init__(stub, "reporter") + super().__init__(stub, "reporter") def report(self, tests, parents, **kwargs): self.add_call("report", (tests, parents), kwargs or None) diff --git a/python_files/tests/testing_tools/adapter/test_discovery.py b/python_files/tests/testing_tools/adapter/test_discovery.py index 2fe4db7caa37..ea9a5cdfd38e 100644 --- a/python_files/tests/testing_tools/adapter/test_discovery.py +++ b/python_files/tests/testing_tools/adapter/test_discovery.py @@ -1,7 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. - -from __future__ import absolute_import, print_function +# ruff:noqa: PT009, PT027 import unittest @@ -32,7 +31,7 @@ def test_list(self): func="test_each", sub=["[10-10]"], ), - source="{}:{}".format(relfile, 10), + source=f"{relfile}:{10}", markers=None, # missing "./": parentid="test_spam.py::test_each", @@ -46,7 +45,7 @@ def test_list(self): func="All.BasicTests.test_first", sub=None, ), - source="{}:{}".format(relfile, 62), + source=f"{relfile}:{62}", markers=None, parentid="test_spam.py::All::BasicTests", ), @@ -123,7 +122,7 @@ def test_parents(self): func="test_each", sub=["[10-10]"], ), - source="{}:{}".format(relfile, 10), + source=f"{relfile}:{10}", markers=None, # missing "./", using pathsep: parentid=relfile + "::test_each", @@ -138,7 +137,7 @@ def test_parents(self): func="All.BasicTests.test_first", sub=None, ), - source="{}:{}".format(relfile, 61), + source=f"{relfile}:{61}", markers=None, # missing "./", using pathsep: parentid=relfile + "::All::BasicTests", @@ -247,7 +246,7 @@ def test_add_test_simple(self): func="test_spam", ), # missing "./": - source="{}:{}".format(relfile, 11), + source=f"{relfile}:{11}", markers=[], # missing "./": parentid=relfile, @@ -303,7 +302,7 @@ def test_multiroot(self): relfile=fix_relpath(relfile1), func="test_spam", ), - source="{}:{}".format(relfile1, 10), + source=f"{relfile1}:{10}", markers=[], # missing "./": parentid=relfile1, @@ -329,7 +328,7 @@ def test_multiroot(self): relfile=fix_relpath(relfile2), func="BasicTests.test_first", ), - source="{}:{}".format(relfile2, 61), + source=f"{relfile2}:{61}", markers=[], parentid=relfile2 + "::BasicTests", ), @@ -366,7 +365,7 @@ def test_multiroot(self): relfile=fix_relpath(relfile1), func="test_spam", ), - source="{}:{}".format(relfile1, 10), + source=f"{relfile1}:{10}", markers=[], parentid="./test_spam.py", ), @@ -379,7 +378,7 @@ def test_multiroot(self): relfile=fix_relpath(relfile2), func="BasicTests.test_first", ), - source="{}:{}".format(relfile2, 61), + source=f"{relfile2}:{61}", markers=[], parentid="./w/test_eggs.py::BasicTests", ), @@ -447,7 +446,7 @@ def test_doctest(self): relfile=doctestfile, func=None, ), - source="{}:{}".format(doctestfile, 0), + source=f"{doctestfile}:{0}", markers=[], parentid=doctestfile, ), @@ -460,7 +459,7 @@ def test_doctest(self): relfile=relfile, func=None, ), - source="{}:{}".format(relfile, 0), + source=f"{relfile}:{0}", markers=[], parentid=relfile, ), @@ -472,7 +471,7 @@ def test_doctest(self): relfile=relfile, func=None, ), - source="{}:{}".format(relfile, 12), + source=f"{relfile}:{12}", markers=[], parentid=relfile, ), @@ -484,7 +483,7 @@ def test_doctest(self): relfile=relfile, func=None, ), - source="{}:{}".format(relfile, 27), + source=f"{relfile}:{27}", markers=[], parentid=relfile, ), @@ -594,7 +593,7 @@ def test_nested_suite_simple(self): relfile=relfile, func="TestOuter.TestInner.test_spam", ), - source="{}:{}".format(relfile, 10), + source=f"{relfile}:{10}", markers=None, parentid=relfile + "::TestOuter::TestInner", ), @@ -606,7 +605,7 @@ def test_nested_suite_simple(self): relfile=relfile, func="TestOuter.TestInner.test_eggs", ), - source="{}:{}".format(relfile, 21), + source=f"{relfile}:{21}", markers=None, parentid=relfile + "::TestOuter::TestInner", ), diff --git a/python_files/tests/testing_tools/adapter/test_functional.py b/python_files/tests/testing_tools/adapter/test_functional.py index 45c85ee951dc..17c36ba743da 100644 --- a/python_files/tests/testing_tools/adapter/test_functional.py +++ b/python_files/tests/testing_tools/adapter/test_functional.py @@ -1,7 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. - -from __future__ import absolute_import, unicode_literals +# ruff:noqa: PT009, PT027, PTH109, PTH118, PTH120 import json import os @@ -43,30 +42,14 @@ def _run_adapter(cmd, tool, *cliargs, **kwargs): hidestdio = kwargs.pop("hidestdio", True) assert not kwargs or tuple(kwargs) == ("stderr",) kwds = kwargs - argv = [sys.executable, SCRIPT, cmd, tool, "--"] + list(cliargs) + argv = [sys.executable, SCRIPT, cmd, tool, "--", *cliargs] if not hidestdio: argv.insert(4, "--no-hide-stdio") kwds["stderr"] = subprocess.STDOUT argv.append("--cache-clear") print("running {!r}".format(" ".join(arg.rpartition(CWD + "/")[-1] for arg in argv))) - output = subprocess.check_output(argv, universal_newlines=True, **kwds) - return output - -def fix_test_order(tests): - if sys.version_info >= (3, 6): - return tests - fixed = [] - curfile = None - group = [] - for test in tests: - if (curfile or "???") not in test["id"]: - fixed.extend(sorted(group, key=lambda t: t["id"])) - group = [] - curfile = test["id"].partition(".py::")[0] + ".py" - group.append(test) - fixed.extend(sorted(group, key=lambda t: t["id"])) - return fixed + return subprocess.check_output(argv, universal_newlines=True, **kwds) def fix_source(tests, testid, srcfile, lineno): @@ -74,17 +57,17 @@ def fix_source(tests, testid, srcfile, lineno): if test["id"] == testid: break else: - raise KeyError("test {!r} not found".format(testid)) + raise KeyError(f"test {testid!r} not found") if not srcfile: srcfile = test["source"].rpartition(":")[0] - test["source"] = fix_path("{}:{}".format(srcfile, lineno)) + test["source"] = fix_path(f"{srcfile}:{lineno}") def sorted_object(obj): if isinstance(obj, dict): - return sorted((key, sorted_object(obj[key])) for key in obj.keys()) + return sorted((key, sorted_object(obj[key])) for key in obj) if isinstance(obj, list): - return sorted((sorted_object(x) for x in obj)) + return sorted(sorted_object(x) for x in obj) else: return obj @@ -98,7 +81,7 @@ class PytestTests(unittest.TestCase): def setUp(self): if PATH_SEP is not os.path.sep: raise unittest.SkipTest("functional tests require unmodified env") - super(PytestTests, self).setUp() + super().setUp() def complex(self, testroot): results = COMPLEX.copy() @@ -150,19 +133,11 @@ def test_discover_simple(self): def test_discover_complex_default(self): projroot, testroot = resolve_testroot("complex") expected = self.complex(projroot) - expected[0]["tests"] = fix_test_order(expected[0]["tests"]) - if sys.version_info < (3,): - decorated = [ - "./tests/test_unittest.py::MyTests::test_skipped", - "./tests/test_unittest.py::MyTests::test_maybe_skipped", - "./tests/test_unittest.py::MyTests::test_maybe_not_skipped", - ] - for testid in decorated: - fix_source(expected[0]["tests"], testid, None, 0) + expected[0]["tests"] = expected[0]["tests"] out = run_adapter("discover", "pytest", "--rootdir", projroot, testroot) result = json.loads(out) - result[0]["tests"] = fix_test_order(result[0]["tests"]) + result[0]["tests"] = result[0]["tests"] self.maxDiff = None self.assertEqual(sorted_object(result), sorted_object(expected)) @@ -232,21 +207,13 @@ def test_discover_complex_doctest(self): "parentid": "./mod.py", }, ] + expected[0]["tests"] - expected[0]["tests"] = fix_test_order(expected[0]["tests"]) - if sys.version_info < (3,): - decorated = [ - "./tests/test_unittest.py::MyTests::test_skipped", - "./tests/test_unittest.py::MyTests::test_maybe_skipped", - "./tests/test_unittest.py::MyTests::test_maybe_not_skipped", - ] - for testid in decorated: - fix_source(expected[0]["tests"], testid, None, 0) + expected[0]["tests"] = expected[0]["tests"] out = run_adapter( "discover", "pytest", "--rootdir", projroot, "--doctest-modules", projroot ) result = json.loads(out) - result[0]["tests"] = fix_test_order(result[0]["tests"]) + result[0]["tests"] = result[0]["tests"] self.maxDiff = None self.assertEqual(sorted_object(result), sorted_object(expected)) diff --git a/python_files/tests/testing_tools/adapter/test_report.py b/python_files/tests/testing_tools/adapter/test_report.py index bb68c8a65e79..8fe7d764cca3 100644 --- a/python_files/tests/testing_tools/adapter/test_report.py +++ b/python_files/tests/testing_tools/adapter/test_report.py @@ -1,13 +1,15 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. +# ruff:noqa: PT009 import json import unittest -from ...util import StubProxy -from testing_tools.adapter.util import fix_path, fix_relpath -from testing_tools.adapter.info import SingleTestInfo, SingleTestPath, ParentInfo +from testing_tools.adapter.info import ParentInfo, SingleTestInfo, SingleTestPath from testing_tools.adapter.report import report_discovered +from testing_tools.adapter.util import fix_path, fix_relpath + +from ...util import StubProxy class StubSender(StubProxy): @@ -34,7 +36,7 @@ def test_basic(self): relfile=relfile, func="test_spam", ), - source="{}:{}".format(relfile, 10), + source=f"{relfile}:{10}", markers=[], parentid="file#1", ), @@ -71,7 +73,7 @@ def test_basic(self): { "id": "test#1", "name": "test_spam", - "source": "{}:{}".format(relfile, 10), + "source": f"{relfile}:{10}", "markers": [], "parentid": "file#1", } @@ -105,7 +107,7 @@ def test_multiroot(self): relfile=relfile1, func="test_spam", ), - source="{}:{}".format(relfile1, 10), + source=f"{relfile1}:{10}", markers=[], parentid=relfileid1, ), @@ -142,7 +144,7 @@ def test_multiroot(self): { "id": relfileid1 + "::test_spam", "name": "test_spam", - "source": "{}:{}".format(relfile1, 10), + "source": f"{relfile1}:{10}", "markers": [], "parentid": relfileid1, } @@ -164,7 +166,7 @@ def test_multiroot(self): relfile=relfile2, func="BasicTests.test_first", ), - source="{}:{}".format(relfile2, 61), + source=f"{relfile2}:{61}", markers=[], parentid=relfileid2 + "::BasicTests", ), @@ -233,7 +235,7 @@ def test_multiroot(self): { "id": relfileid2 + "::BasicTests::test_first", "name": "test_first", - "source": "{}:{}".format(relfile2, 61), + "source": f"{relfile2}:{61}", "markers": [], "parentid": relfileid2 + "::BasicTests", } @@ -287,7 +289,7 @@ def test_complex(self): test_spam.py SpamTests test_okay - """ + """ # noqa: D205, D400 stub = StubSender() testroot = fix_path("/a/b/c") relfileid1 = "./test_ham.py" @@ -305,7 +307,7 @@ def test_complex(self): relfile=fix_path(relfileid1), func="MySuite.test_x1", ), - source="{}:{}".format(fix_path(relfileid1), 10), + source=f"{fix_path(relfileid1)}:{10}", markers=None, parentid=relfileid1 + "::MySuite", ), @@ -317,7 +319,7 @@ def test_complex(self): relfile=fix_path(relfileid1), func="MySuite.test_x2", ), - source="{}:{}".format(fix_path(relfileid1), 21), + source=f"{fix_path(relfileid1)}:{21}", markers=None, parentid=relfileid1 + "::MySuite", ), @@ -329,7 +331,7 @@ def test_complex(self): relfile=fix_path(relfileid2), func="SpamTests.test_okay", ), - source="{}:{}".format(fix_path(relfileid2), 17), + source=f"{fix_path(relfileid2)}:{17}", markers=None, parentid=relfileid2 + "::SpamTests", ), @@ -341,7 +343,7 @@ def test_complex(self): relfile=fix_path(relfileid3), func="test_ham1", ), - source="{}:{}".format(fix_path(relfileid3), 8), + source=f"{fix_path(relfileid3)}:{8}", markers=None, parentid=relfileid3, ), @@ -353,7 +355,7 @@ def test_complex(self): relfile=fix_path(relfileid3), func="HamTests.test_uh_oh", ), - source="{}:{}".format(fix_path(relfileid3), 19), + source=f"{fix_path(relfileid3)}:{19}", markers=["expected-failure"], parentid=relfileid3 + "::HamTests", ), @@ -365,7 +367,7 @@ def test_complex(self): relfile=fix_path(relfileid3), func="HamTests.test_whoa", ), - source="{}:{}".format(fix_path(relfileid3), 35), + source=f"{fix_path(relfileid3)}:{35}", markers=None, parentid=relfileid3 + "::HamTests", ), @@ -378,7 +380,7 @@ def test_complex(self): func="MoreHam.test_yay", sub=["[1-2]"], ), - source="{}:{}".format(fix_path(relfileid3), 57), + source=f"{fix_path(relfileid3)}:{57}", markers=None, parentid=relfileid3 + "::MoreHam::test_yay", ), @@ -391,7 +393,7 @@ def test_complex(self): func="MoreHam.test_yay", sub=["[1-2]", "[3=4]"], ), - source="{}:{}".format(fix_path(relfileid3), 72), + source=f"{fix_path(relfileid3)}:{72}", markers=None, parentid=relfileid3 + "::MoreHam::test_yay[1-2]", ), @@ -403,7 +405,7 @@ def test_complex(self): relfile=fix_path(relfileid4), func="SpamTests.test_okay", ), - source="{}:{}".format(fix_path(relfileid4), 15), + source=f"{fix_path(relfileid4)}:{15}", markers=None, parentid=relfileid4 + "::SpamTests", ), @@ -415,7 +417,7 @@ def test_complex(self): relfile=fix_path(relfileid5), func="SpamTests.test_okay", ), - source="{}:{}".format(fix_path(relfileid5), 12), + source=f"{fix_path(relfileid5)}:{12}", markers=None, parentid=relfileid5 + "::SpamTests", ), @@ -427,7 +429,7 @@ def test_complex(self): relfile=fix_path(relfileid6), func="SpamTests.test_okay", ), - source="{}:{}".format(fix_path(relfileid6), 27), + source=f"{fix_path(relfileid6)}:{27}", markers=None, parentid=relfileid6 + "::SpamTests", ), @@ -731,77 +733,77 @@ def test_complex(self): { "id": relfileid1 + "::MySuite::test_x1", "name": "test_x1", - "source": "{}:{}".format(fix_path(relfileid1), 10), + "source": f"{fix_path(relfileid1)}:{10}", "markers": [], "parentid": relfileid1 + "::MySuite", }, { "id": relfileid1 + "::MySuite::test_x2", "name": "test_x2", - "source": "{}:{}".format(fix_path(relfileid1), 21), + "source": f"{fix_path(relfileid1)}:{21}", "markers": [], "parentid": relfileid1 + "::MySuite", }, { "id": relfileid2 + "::SpamTests::test_okay", "name": "test_okay", - "source": "{}:{}".format(fix_path(relfileid2), 17), + "source": f"{fix_path(relfileid2)}:{17}", "markers": [], "parentid": relfileid2 + "::SpamTests", }, { "id": relfileid3 + "::test_ham1", "name": "test_ham1", - "source": "{}:{}".format(fix_path(relfileid3), 8), + "source": f"{fix_path(relfileid3)}:{8}", "markers": [], "parentid": relfileid3, }, { "id": relfileid3 + "::HamTests::test_uh_oh", "name": "test_uh_oh", - "source": "{}:{}".format(fix_path(relfileid3), 19), + "source": f"{fix_path(relfileid3)}:{19}", "markers": ["expected-failure"], "parentid": relfileid3 + "::HamTests", }, { "id": relfileid3 + "::HamTests::test_whoa", "name": "test_whoa", - "source": "{}:{}".format(fix_path(relfileid3), 35), + "source": f"{fix_path(relfileid3)}:{35}", "markers": [], "parentid": relfileid3 + "::HamTests", }, { "id": relfileid3 + "::MoreHam::test_yay[1-2]", "name": "test_yay[1-2]", - "source": "{}:{}".format(fix_path(relfileid3), 57), + "source": f"{fix_path(relfileid3)}:{57}", "markers": [], "parentid": relfileid3 + "::MoreHam::test_yay", }, { "id": relfileid3 + "::MoreHam::test_yay[1-2][3-4]", "name": "test_yay[1-2][3-4]", - "source": "{}:{}".format(fix_path(relfileid3), 72), + "source": f"{fix_path(relfileid3)}:{72}", "markers": [], "parentid": relfileid3 + "::MoreHam::test_yay[1-2]", }, { "id": relfileid4 + "::SpamTests::test_okay", "name": "test_okay", - "source": "{}:{}".format(fix_path(relfileid4), 15), + "source": f"{fix_path(relfileid4)}:{15}", "markers": [], "parentid": relfileid4 + "::SpamTests", }, { "id": relfileid5 + "::SpamTests::test_okay", "name": "test_okay", - "source": "{}:{}".format(fix_path(relfileid5), 12), + "source": f"{fix_path(relfileid5)}:{12}", "markers": [], "parentid": relfileid5 + "::SpamTests", }, { "id": relfileid6 + "::SpamTests::test_okay", "name": "test_okay", - "source": "{}:{}".format(fix_path(relfileid6), 27), + "source": f"{fix_path(relfileid6)}:{27}", "markers": [], "parentid": relfileid6 + "::SpamTests", }, @@ -833,7 +835,7 @@ def test_simple_basic(self): func="MySuite.test_spam_1", sub=None, ), - source="{}:{}".format(relfile, 10), + source=f"{relfile}:{10}", markers=None, parentid="suite#1", ), @@ -897,7 +899,7 @@ def test_simple_complex(self): test_spam.py SpamTests test_okay - """ + """ # noqa: D205, D400 stub = StubSender() testroot1 = fix_path("/a/b/c") relfile1 = fix_path("./test_ham.py") @@ -918,7 +920,7 @@ def test_simple_complex(self): func="MySuite.test_x1", sub=None, ), - source="{}:{}".format(relfile1, 10), + source=f"{relfile1}:{10}", markers=None, parentid="suite#1", ), @@ -931,7 +933,7 @@ def test_simple_complex(self): func="MySuite.test_x2", sub=None, ), - source="{}:{}".format(relfile1, 21), + source=f"{relfile1}:{21}", markers=None, parentid="suite#1", ), @@ -945,7 +947,7 @@ def test_simple_complex(self): func="SpamTests.test_okay", sub=None, ), - source="{}:{}".format(relfile2, 17), + source=f"{relfile2}:{17}", markers=None, parentid="suite#2", ), @@ -958,7 +960,7 @@ def test_simple_complex(self): func="test_ham1", sub=None, ), - source="{}:{}".format(relfile3, 8), + source=f"{relfile3}:{8}", markers=None, parentid="file#3", ), @@ -971,7 +973,7 @@ def test_simple_complex(self): func="HamTests.test_uh_oh", sub=None, ), - source="{}:{}".format(relfile3, 19), + source=f"{relfile3}:{19}", markers=["expected-failure"], parentid="suite#3", ), @@ -984,7 +986,7 @@ def test_simple_complex(self): func="HamTests.test_whoa", sub=None, ), - source="{}:{}".format(relfile3, 35), + source=f"{relfile3}:{35}", markers=None, parentid="suite#3", ), @@ -997,7 +999,7 @@ def test_simple_complex(self): func="MoreHam.test_yay", sub=["sub1"], ), - source="{}:{}".format(relfile3, 57), + source=f"{relfile3}:{57}", markers=None, parentid="suite#4", ), @@ -1010,7 +1012,7 @@ def test_simple_complex(self): func="MoreHam.test_yay", sub=["sub2", "sub3"], ), - source="{}:{}".format(relfile3, 72), + source=f"{relfile3}:{72}", markers=None, parentid="suite#3", ), @@ -1023,7 +1025,7 @@ def test_simple_complex(self): func="SpamTests.test_okay", sub=None, ), - source="{}:{}".format(relfile4, 15), + source=f"{relfile4}:{15}", markers=None, parentid="suite#5", ), @@ -1036,7 +1038,7 @@ def test_simple_complex(self): func="SpamTests.test_okay", sub=None, ), - source="{}:{}".format(relfile5, 12), + source=f"{relfile5}:{12}", markers=None, parentid="suite#6", ), @@ -1049,7 +1051,7 @@ def test_simple_complex(self): func="SpamTests.test_okay", sub=None, ), - source="{}:{}".format(relfile6, 27), + source=f"{relfile6}:{27}", markers=None, parentid="suite#7", ), diff --git a/python_files/tests/testing_tools/adapter/test_util.py b/python_files/tests/testing_tools/adapter/test_util.py index 8a7cd475a1c7..36df55a1d0f3 100644 --- a/python_files/tests/testing_tools/adapter/test_util.py +++ b/python_files/tests/testing_tools/adapter/test_util.py @@ -1,7 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. - -from __future__ import absolute_import, print_function +# ruff:noqa: PT009, PTH100, PTH118, PTH120, PTH123 import ntpath import os @@ -11,7 +10,6 @@ import sys import unittest - # Pytest 3.7 and later uses pathlib/pathlib2 for path resolution. try: from pathlib import Path @@ -19,9 +17,9 @@ from pathlib2 import Path # type: ignore (for Pylance) from testing_tools.adapter.util import ( + fix_fileid, fix_path, fix_relpath, - fix_fileid, shlex_unsplit, ) @@ -31,6 +29,7 @@ class FilePathTests(unittest.TestCase): def test_isolated_imports(self): import testing_tools.adapter from testing_tools.adapter import util + from . import test_functional ignored = { @@ -88,19 +87,19 @@ def test_fix_path(self): ] for path, expected in tests: pathsep = ntpath.sep - with self.subTest(r"fixed for \: {!r}".format(path)): + with self.subTest(rf"fixed for \: {path!r}"): fixed = fix_path(path, _pathsep=pathsep) self.assertEqual(fixed, expected) pathsep = posixpath.sep - with self.subTest("unchanged for /: {!r}".format(path)): + with self.subTest(f"unchanged for /: {path!r}"): unchanged = fix_path(path, _pathsep=pathsep) self.assertEqual(unchanged, path) # no path -> "." for path in ["", None]: for pathsep in [ntpath.sep, posixpath.sep]: - with self.subTest(r"fixed for {}: {!r}".format(pathsep, path)): + with self.subTest(rf"fixed for {pathsep}: {path!r}"): fixed = fix_path(path, _pathsep=pathsep) self.assertEqual(fixed, ".") @@ -116,7 +115,7 @@ def test_fix_path(self): ) for path in paths: for pathsep in [ntpath.sep, posixpath.sep]: - with self.subTest(r"unchanged for {}: {!r}".format(pathsep, path)): + with self.subTest(rf"unchanged for {pathsep}: {path!r}"): unchanged = fix_path(path, _pathsep=pathsep) self.assertEqual(unchanged, path) @@ -152,7 +151,9 @@ def test_fix_relpath(self): with self.subTest((path, _os_path.sep)): fixed = fix_relpath( path, - _fix_path=(lambda p: fix_path(p, _pathsep=_os_path.sep)), + # Capture the loop variants as default parameters to make sure they + # don't change between iterations. + _fix_path=(lambda p, _sep=_os_path.sep: fix_path(p, _pathsep=_sep)), _path_isabs=_os_path.isabs, _pathsep=_os_path.sep, ) @@ -200,7 +201,7 @@ def test_fix_fileid(self): ) for fileid, _os_path, expected in tests: pathsep = _os_path.sep - with self.subTest(r"for {}: {!r}".format(pathsep, fileid)): + with self.subTest(rf"for {pathsep}: {fileid!r}"): fixed = fix_fileid( fileid, _path_isabs=_os_path.isabs, @@ -259,7 +260,7 @@ def test_fix_fileid(self): ) for fileid, rootdir, _os_path, expected in tests: pathsep = _os_path.sep - with self.subTest(r"for {} (with rootdir {!r}): {!r}".format(pathsep, rootdir, fileid)): + with self.subTest(rf"for {pathsep} (with rootdir {rootdir!r}): {fileid!r}"): fixed = fix_fileid( fileid, rootdir, diff --git a/python_files/tests/unittestadapter/expected_discovery_test_output.py b/python_files/tests/unittestadapter/expected_discovery_test_output.py index 9fca67a3a574..9de0eff8238c 100644 --- a/python_files/tests/unittestadapter/expected_discovery_test_output.py +++ b/python_files/tests/unittestadapter/expected_discovery_test_output.py @@ -2,9 +2,10 @@ # Licensed under the MIT License. import os -from unittestadapter.pvsc_utils import TestNodeTypeEnum import pathlib +from unittestadapter.pvsc_utils import TestNodeTypeEnum + TEST_DATA_PATH = pathlib.Path(__file__).parent / ".data" diff --git a/python_files/tests/unittestadapter/test_discovery.py b/python_files/tests/unittestadapter/test_discovery.py index 94d0bb89c62a..9afff6762fcc 100644 --- a/python_files/tests/unittestadapter/test_discovery.py +++ b/python_files/tests/unittestadapter/test_discovery.py @@ -23,7 +23,7 @@ @pytest.mark.parametrize( - "args, expected", + ("args", "expected"), [ ( ["-s", "something", "-p", "other*", "-t", "else"], @@ -71,18 +71,14 @@ ], ) def test_parse_unittest_args(args: List[str], expected: List[str]) -> None: - """The parse_unittest_args function should return values for the start_dir, pattern, and top_level_dir arguments - when passed as command-line options, and ignore unrecognized arguments. - """ + """The parse_unittest_args function should return values for the start_dir, pattern, and top_level_dir arguments when passed as command-line options, and ignore unrecognized arguments.""" actual = parse_unittest_args(args) assert actual == expected def test_simple_discovery() -> None: - """The discover_tests function should return a dictionary with a "success" status, no errors, and a test tree - if unittest discovery was performed successfully. - """ + """The discover_tests function should return a dictionary with a "success" status, no errors, and a test tree if unittest discovery was performed successfully.""" start_dir = os.fsdecode(TEST_DATA_PATH) pattern = "discovery_simple*" file_path = os.fsdecode(pathlib.PurePath(TEST_DATA_PATH / "discovery_simple.py")) @@ -134,9 +130,7 @@ def test_simple_discovery() -> None: def test_simple_discovery_with_top_dir_calculated() -> None: - """The discover_tests function should return a dictionary with a "success" status, no errors, and a test tree - if unittest discovery was performed successfully. - """ + """The discover_tests function should return a dictionary with a "success" status, no errors, and a test tree if unittest discovery was performed successfully.""" start_dir = "." pattern = "discovery_simple*" file_path = os.fsdecode(pathlib.PurePath(TEST_DATA_PATH / "discovery_simple.py")) @@ -190,9 +184,7 @@ def test_simple_discovery_with_top_dir_calculated() -> None: def test_empty_discovery() -> None: - """The discover_tests function should return a dictionary with a "success" status, no errors, and no test tree - if unittest discovery was performed successfully but no tests were found. - """ + """The discover_tests function should return a dictionary with a "success" status, no errors, and no test tree if unittest discovery was performed successfully but no tests were found.""" start_dir = os.fsdecode(TEST_DATA_PATH) pattern = "discovery_empty*" @@ -204,9 +196,7 @@ def test_empty_discovery() -> None: def test_error_discovery() -> None: - """The discover_tests function should return a dictionary with an "error" status, the discovered tests, and a list of errors - if unittest discovery failed at some point. - """ + """The discover_tests function should return a dictionary with an "error" status, the discovered tests, and a list of errors if unittest discovery failed at some point.""" # Discover tests in .data/discovery_error/. start_path = pathlib.PurePath(TEST_DATA_PATH / "discovery_error") start_dir = os.fsdecode(start_path) @@ -262,6 +252,7 @@ def test_error_discovery() -> None: def test_unit_skip() -> None: """The discover_tests function should return a dictionary with a "success" status, no errors, and test tree. + if unittest discovery was performed and found a test in one file marked as skipped and another file marked as skipped. """ start_dir = os.fsdecode(TEST_DATA_PATH / "unittest_skip") diff --git a/python_files/tests/unittestadapter/test_execution.py b/python_files/tests/unittestadapter/test_execution.py index 44610d5bf6fa..71f1ca1ec73b 100644 --- a/python_files/tests/unittestadapter/test_execution.py +++ b/python_files/tests/unittestadapter/test_execution.py @@ -4,24 +4,24 @@ import os import pathlib import sys +from typing import TYPE_CHECKING, Dict, Optional from unittest.mock import patch -from typing import Dict, Optional import pytest script_dir = pathlib.Path(__file__).parent.parent.parent sys.path.insert(0, os.fspath(script_dir / "lib" / "python")) -from unittestadapter.pvsc_utils import ExecutionPayloadDict # noqa: E402 from unittestadapter.execution import run_tests # noqa: E402 +if TYPE_CHECKING: + from unittestadapter.pvsc_utils import ExecutionPayloadDict + TEST_DATA_PATH = pathlib.Path(__file__).parent / ".data" def test_no_ids_run() -> None: - """This test runs on an empty array of test_ids, therefore it should return - an empty dict for the result. - """ + """This test runs on an empty array of test_ids, therefore it should return an empty dict for the result.""" start_dir: str = os.fspath(TEST_DATA_PATH) testids = [] pattern = "discovery_simple*" @@ -43,16 +43,15 @@ def mock_send_run_data(): def test_single_ids_run(mock_send_run_data): - """This test runs on a single test_id, therefore it should return - a dict with a single key-value pair for the result. + """This test runs on a single test_id, therefore it should return a dict with a single key-value pair for the result. This single test passes so the outcome should be 'success'. """ - id = "discovery_simple.DiscoverySimple.test_one" + id_ = "discovery_simple.DiscoverySimple.test_one" os.environ["TEST_RUN_PIPE"] = "fake" actual: ExecutionPayloadDict = run_tests( os.fspath(TEST_DATA_PATH), - [id], + [id_], "discovery_simple*", None, 1, @@ -71,24 +70,23 @@ def test_single_ids_run(mock_send_run_data): if not isinstance(actual_result, Dict): raise AssertionError("actual_result is not a Dict") assert len(actual_result) == 1 - assert id in actual_result - id_result = actual_result[id] + assert id_ in actual_result + id_result = actual_result[id_] assert id_result is not None assert "outcome" in id_result assert id_result["outcome"] == "success" -def test_subtest_run(mock_send_run_data) -> None: - """This test runs on a the test_subtest which has a single method, test_even, - that uses unittest subtest. +def test_subtest_run(mock_send_run_data) -> None: # noqa: ARG001 + """This test runs on a the test_subtest which has a single method, test_even, that uses unittest subtest. The actual result of run should return a dict payload with 6 entry for the 6 subtests. """ - id = "test_subtest.NumbersTest.test_even" + id_ = "test_subtest.NumbersTest.test_even" os.environ["TEST_RUN_PIPE"] = "fake" actual = run_tests( os.fspath(TEST_DATA_PATH), - [id], + [id_], "test_subtest.py", None, 1, @@ -109,12 +107,12 @@ def test_subtest_run(mock_send_run_data) -> None: assert actual["result"] is not None result = actual["result"] assert len(result) == 6 - for id in subtests_ids: - assert id in result + for id_ in subtests_ids: + assert id_ in result @pytest.mark.parametrize( - "test_ids, pattern, cwd, expected_outcome", + ("test_ids", "pattern", "cwd", "expected_outcome"), [ ( [ @@ -186,7 +184,7 @@ def test_subtest_run(mock_send_run_data) -> None: ), ], ) -def test_multiple_ids_run(mock_send_run_data, test_ids, pattern, cwd, expected_outcome) -> None: +def test_multiple_ids_run(mock_send_run_data, test_ids, pattern, cwd, expected_outcome) -> None: # noqa: ARG001 """ The following are all successful tests of different formats. @@ -217,9 +215,8 @@ def test_multiple_ids_run(mock_send_run_data, test_ids, pattern, cwd, expected_o assert True -def test_failed_tests(mock_send_run_data): +def test_failed_tests(mock_send_run_data): # noqa: ARG001 """This test runs on a single file `test_fail` with two tests that fail.""" - os.environ["TEST_RUN_PIPE"] = "fake" test_ids = [ "test_fail_simple.RunFailSimple.test_one_fail", @@ -246,17 +243,16 @@ def test_failed_tests(mock_send_run_data): assert id_result is not None assert "outcome" in id_result assert id_result["outcome"] == "failure" - assert "message" and "traceback" in id_result + assert "message" in id_result + assert "traceback" in id_result assert "2 not greater than 3" in str(id_result["message"]) or "1 == 1" in str( id_result["traceback"] ) assert True -def test_unknown_id(mock_send_run_data): - """This test runs on a unknown test_id, therefore it should return - an error as the outcome as it attempts to find the given test. - """ +def test_unknown_id(mock_send_run_data): # noqa: ARG001 + """This test runs on a unknown test_id, therefore it should return an error as the outcome as it attempts to find the given test.""" os.environ["TEST_RUN_PIPE"] = "fake" test_ids = ["unknown_id"] actual = run_tests( @@ -279,13 +275,12 @@ def test_unknown_id(mock_send_run_data): assert id_result is not None assert "outcome" in id_result assert id_result["outcome"] == "error" - assert "message" and "traceback" in id_result + assert "message" in id_result + assert "traceback" in id_result def test_incorrect_path(): - """This test runs on a non existent path, therefore it should return - an error as the outcome as it attempts to find the given folder. - """ + """This test runs on a non existent path, therefore it should return an error as the outcome as it attempts to find the given folder.""" test_ids = ["unknown_id"] os.environ["TEST_RUN_PIPE"] = "fake" diff --git a/python_files/tests/unittestadapter/test_utils.py b/python_files/tests/unittestadapter/test_utils.py index 1cb9a4686399..b0341ce37b63 100644 --- a/python_files/tests/unittestadapter/test_utils.py +++ b/python_files/tests/unittestadapter/test_utils.py @@ -25,7 +25,7 @@ @pytest.mark.parametrize( - "directory, pattern, expected", + ("directory", "pattern", "expected"), [ ( ".", @@ -49,7 +49,6 @@ ) def test_simple_test_cases(directory, pattern, expected) -> None: """The get_test_case fuction should return tests from all test suites.""" - actual = [] # Discover tests in .data/. @@ -59,15 +58,13 @@ def test_simple_test_cases(directory, pattern, expected) -> None: suite = loader.discover(start_dir, pattern) # Iterate on get_test_case and save the test id. - for test in get_test_case(suite): - actual.append(test.id()) + actual = [test.id() for test in get_test_case(suite)] assert expected == actual def test_get_existing_child_node() -> None: """The get_child_node fuction should return the child node of a test tree if it exists.""" - tree: TestNode = { "name": "root", "path": "foo", @@ -115,7 +112,6 @@ def test_get_existing_child_node() -> None: def test_no_existing_child_node() -> None: """The get_child_node fuction should add a child node to a test tree and return it if it does not exist.""" - tree: TestNode = { "name": "root", "path": "foo", @@ -172,10 +168,7 @@ def test_no_existing_child_node() -> None: def test_build_simple_tree() -> None: - """The build_test_tree function should build and return a test tree from discovered test suites, - and an empty list of errors if there are none in the discovered data. - """ - + """The build_test_tree function should build and return a test tree from discovered test suites, and an empty list of errors if there are none in the discovered data.""" # Discovery tests in utils_simple_tree.py. start_dir = os.fsdecode(TEST_DATA_PATH) pattern = "utils_simple_tree*" @@ -231,11 +224,7 @@ def test_build_simple_tree() -> None: def test_build_decorated_tree() -> None: - """The build_test_tree function should build and return a test tree from discovered test suites, - with correct line numbers for decorated test, - and an empty list of errors if there are none in the discovered data. - """ - + """The build_test_tree function should build and return a test tree from discovered test suites, with correct line numbers for decorated test, and an empty list of errors if there are none in the discovered data.""" # Discovery tests in utils_decorated_tree.py. start_dir = os.fsdecode(TEST_DATA_PATH) pattern = "utils_decorated_tree*" @@ -291,9 +280,7 @@ def test_build_decorated_tree() -> None: def test_build_empty_tree() -> None: - """The build_test_tree function should return None if there are no discovered test suites, - and an empty list of errors if there are none in the discovered data.""" - + """The build_test_tree function should return None if there are no discovered test suites, and an empty list of errors if there are none in the discovered data.""" start_dir = os.fsdecode(TEST_DATA_PATH) pattern = "does_not_exist*" diff --git a/python_files/tests/util.py b/python_files/tests/util.py index 45c3536145cf..ee240cd95202 100644 --- a/python_files/tests/util.py +++ b/python_files/tests/util.py @@ -2,7 +2,7 @@ # Licensed under the MIT License. -class Stub(object): +class Stub: def __init__(self): self.calls = [] @@ -10,7 +10,7 @@ def add_call(self, name, args=None, kwargs=None): self.calls.append((name, args, kwargs)) -class StubProxy(object): +class StubProxy: def __init__(self, stub=None, name=None): self.name = name self.stub = stub if stub is not None else Stub() @@ -22,5 +22,5 @@ def calls(self): def add_call(self, funcname, *args, **kwargs): callname = funcname if self.name: - callname = "{}.{}".format(self.name, funcname) + callname = f"{self.name}.{funcname}" return self.stub.add_call(callname, *args, **kwargs) diff --git a/python_files/unittestadapter/discovery.py b/python_files/unittestadapter/discovery.py index 58ab8ca1a651..604fe7beaeb1 100644 --- a/python_files/unittestadapter/discovery.py +++ b/python_files/unittestadapter/discovery.py @@ -13,12 +13,12 @@ # If I use from utils then there will be an import error in test_discovery.py. from unittestadapter.pvsc_utils import ( # noqa: E402 + DiscoveryPayloadDict, + EOTPayloadDict, VSCodeUnittestError, build_test_tree, parse_unittest_args, send_post_request, - DiscoveryPayloadDict, - EOTPayloadDict, ) @@ -56,9 +56,9 @@ def discover_tests( "status": "error", } """ - cwd = os.path.abspath(start_dir) + cwd = os.path.abspath(start_dir) # noqa: PTH100 if "/" in start_dir: # is a subdir - parent_dir = os.path.dirname(start_dir) + parent_dir = os.path.dirname(start_dir) # noqa: PTH120 sys.path.insert(0, parent_dir) else: sys.path.insert(0, cwd) @@ -75,7 +75,7 @@ def discover_tests( top_level_dir = start_dir # Get abspath of top level directory for build_test_tree. - top_level_dir = os.path.abspath(top_level_dir) + top_level_dir = os.path.abspath(top_level_dir) # noqa: PTH100 tests, error = build_test_tree(suite, top_level_dir) # test tree built successfully here. diff --git a/python_files/unittestadapter/execution.py b/python_files/unittestadapter/execution.py index 84cc10c4fb1f..e81407e1e83c 100644 --- a/python_files/unittestadapter/execution.py +++ b/python_files/unittestadapter/execution.py @@ -6,10 +6,9 @@ import json import os import pathlib -import socket import sys -import traceback import sysconfig +import traceback import unittest from types import TracebackType from typing import Dict, List, Optional, Tuple, Type, Union @@ -27,12 +26,12 @@ from testing_tools import process_json_util, socket_manager # noqa: E402 from unittestadapter.pvsc_utils import ( # noqa: E402 + EOTPayloadDict, + ExecutionPayloadDict, + TestExecutionStatus, VSCodeUnittestError, parse_unittest_args, send_post_request, - ExecutionPayloadDict, - EOTPayloadDict, - TestExecutionStatus, ) ErrorType = Union[Tuple[Type[BaseException], BaseException, TracebackType], Tuple[None, None, None]] @@ -53,51 +52,51 @@ class TestOutcomeEnum(str, enum.Enum): class UnittestTestResult(unittest.TextTestResult): def __init__(self, *args, **kwargs): - self.formatted: Dict[str, Dict[str, Union[str, None]]] = dict() - super(UnittestTestResult, self).__init__(*args, **kwargs) + self.formatted: Dict[str, Dict[str, Union[str, None]]] = {} + super().__init__(*args, **kwargs) - def startTest(self, test: unittest.TestCase): - super(UnittestTestResult, self).startTest(test) + def startTest(self, test: unittest.TestCase): # noqa: N802 + super().startTest(test) - def addError( + def addError( # noqa: N802 self, test: unittest.TestCase, err: ErrorType, ): - super(UnittestTestResult, self).addError(test, err) + super().addError(test, err) self.formatResult(test, TestOutcomeEnum.error, err) - def addFailure( + def addFailure( # noqa: N802 self, test: unittest.TestCase, err: ErrorType, ): - super(UnittestTestResult, self).addFailure(test, err) + super().addFailure(test, err) self.formatResult(test, TestOutcomeEnum.failure, err) - def addSuccess(self, test: unittest.TestCase): - super(UnittestTestResult, self).addSuccess(test) + def addSuccess(self, test: unittest.TestCase): # noqa: N802 + super().addSuccess(test) self.formatResult(test, TestOutcomeEnum.success) - def addSkip(self, test: unittest.TestCase, reason: str): - super(UnittestTestResult, self).addSkip(test, reason) + def addSkip(self, test: unittest.TestCase, reason: str): # noqa: N802 + super().addSkip(test, reason) self.formatResult(test, TestOutcomeEnum.skipped) - def addExpectedFailure(self, test: unittest.TestCase, err: ErrorType): - super(UnittestTestResult, self).addExpectedFailure(test, err) + def addExpectedFailure(self, test: unittest.TestCase, err: ErrorType): # noqa: N802 + super().addExpectedFailure(test, err) self.formatResult(test, TestOutcomeEnum.expected_failure, err) - def addUnexpectedSuccess(self, test: unittest.TestCase): - super(UnittestTestResult, self).addUnexpectedSuccess(test) + def addUnexpectedSuccess(self, test: unittest.TestCase): # noqa: N802 + super().addUnexpectedSuccess(test) self.formatResult(test, TestOutcomeEnum.unexpected_success) - def addSubTest( + def addSubTest( # noqa: N802 self, test: unittest.TestCase, subtest: unittest.TestCase, err: Union[ErrorType, None], ): - super(UnittestTestResult, self).addSubTest(test, subtest, err) + super().addSubTest(test, subtest, err) self.formatResult( test, TestOutcomeEnum.subtest_failure if err else TestOutcomeEnum.subtest_success, @@ -105,7 +104,7 @@ def addSubTest( subtest, ) - def formatResult( + def formatResult( # noqa: N802 self, test: unittest.TestCase, outcome: str, @@ -125,10 +124,7 @@ def formatResult( tb = "".join(formatted) # Remove the 'Traceback (most recent call last)' formatted = formatted[1:] - if subtest: - test_id = subtest.id() - else: - test_id = test.id() + test_id = subtest.id() if subtest else test.id() result = { "test": test.id(), @@ -192,11 +188,11 @@ def run_tests( top_level_dir: Optional[str], verbosity: int, failfast: Optional[bool], - locals: Optional[bool] = None, + locals_: Optional[bool] = None, ) -> ExecutionPayloadDict: - cwd = os.path.abspath(start_dir) + cwd = os.path.abspath(start_dir) # noqa: PTH100 if "/" in start_dir: # is a subdir - parent_dir = os.path.dirname(start_dir) + parent_dir = os.path.dirname(start_dir) # noqa: PTH120 sys.path.insert(0, parent_dir) else: sys.path.insert(0, cwd) @@ -208,18 +204,18 @@ def run_tests( # If it's a file, split path and file name. start_dir = cwd if cwd.endswith(".py"): - start_dir = os.path.dirname(cwd) - pattern = os.path.basename(cwd) + start_dir = os.path.dirname(cwd) # noqa: PTH120 + pattern = os.path.basename(cwd) # noqa: PTH119 if failfast is None: failfast = False - if locals is None: - locals = False + if locals_ is None: + locals_ = False if verbosity is None: verbosity = 1 runner = unittest.TextTestRunner( resultclass=UnittestTestResult, - tb_locals=locals, + tb_locals=locals_, failfast=failfast, verbosity=verbosity, ) @@ -261,11 +257,8 @@ def run_tests( def send_run_data(raw_data, test_run_pipe): status = raw_data["outcome"] - cwd = os.path.abspath(START_DIR) - if raw_data["subtest"]: - test_id = raw_data["subtest"] - else: - test_id = raw_data["test"] + cwd = os.path.abspath(START_DIR) # noqa: PTH100 + test_id = raw_data["subtest"] or raw_data["test"] test_dict = {} test_dict[test_id] = raw_data payload: ExecutionPayloadDict = {"cwd": cwd, "status": status, "result": test_dict} @@ -283,7 +276,7 @@ def send_run_data(raw_data, test_run_pipe): top_level_dir, verbosity, failfast, - locals, + locals_, ) = parse_unittest_args(argv[index + 1 :]) run_test_ids_pipe = os.environ.get("RUN_TEST_IDS_PIPE") @@ -319,10 +312,10 @@ def send_run_data(raw_data, test_run_pipe): except json.JSONDecodeError: # JSON decoding error, the complete JSON object is not yet received continue - except socket.error as e: + except OSError as e: msg = f"Error: Could not connect to RUN_TEST_IDS_PIPE: {e}" print(msg) - raise VSCodeUnittestError(msg) + raise VSCodeUnittestError(msg) from e try: if raw_json and "params" in raw_json: @@ -336,11 +329,11 @@ def send_run_data(raw_data, test_run_pipe): top_level_dir, verbosity, failfast, - locals, + locals_, ) else: # No test ids received from buffer - cwd = os.path.abspath(start_dir) + cwd = os.path.abspath(start_dir) # noqa: PTH100 status = TestExecutionStatus.error payload: ExecutionPayloadDict = { "cwd": cwd, @@ -349,9 +342,9 @@ def send_run_data(raw_data, test_run_pipe): "result": None, } send_post_request(payload, test_run_pipe) - except json.JSONDecodeError: + except json.JSONDecodeError as exc: msg = "Error: Could not parse test ids from stdin" print(msg) - raise VSCodeUnittestError(msg) + raise VSCodeUnittestError(msg) from exc eot_payload: EOTPayloadDict = {"command_type": "execution", "eot": True} send_post_request(eot_payload, test_run_pipe) diff --git a/python_files/unittestadapter/pvsc_utils.py b/python_files/unittestadapter/pvsc_utils.py index 2eba987603c0..99577fc8e9c5 100644 --- a/python_files/unittestadapter/pvsc_utils.py +++ b/python_files/unittestadapter/pvsc_utils.py @@ -10,16 +10,16 @@ import pathlib import sys import unittest -from typing import List, Optional, Tuple, Union, Dict, Literal, TypedDict - +from typing import Dict, List, Literal, Optional, Tuple, TypedDict, Union script_dir = pathlib.Path(__file__).parent.parent sys.path.append(os.fspath(script_dir)) sys.path.append(os.fspath(script_dir / "lib" / "python")) -from testing_tools import socket_manager # noqa: E402 from typing_extensions import NotRequired # noqa: E402 +from testing_tools import socket_manager # noqa: E402 + # Types @@ -77,7 +77,7 @@ class ExecutionPayloadDict(TypedDict): class EOTPayloadDict(TypedDict): """A dictionary that is used to send a end of transmission post request to the server.""" - command_type: Union[Literal["discovery"], Literal["execution"]] + command_type: Literal["discovery", "execution"] eot: bool @@ -90,8 +90,7 @@ def get_test_case(suite): if isinstance(test, unittest.TestCase): yield test else: - for test_case in get_test_case(test): - yield test_case + yield from get_test_case(test) def get_source_line(obj) -> str: @@ -130,8 +129,11 @@ def build_test_node(path: str, name: str, type_: TestNodeTypeEnum) -> TestNode: def get_child_node(name: str, path: str, type_: TestNodeTypeEnum, root: TestNode) -> TestNode: - """Find a child node in a test tree given its name, type and path. If the node doesn't exist, create it. - Path is required to distinguish between nodes with the same name and type.""" + """Find a child node in a test tree given its name, type and path. + + If the node doesn't exist, create it. + Path is required to distinguish between nodes with the same name and type. + """ try: result = next( node @@ -195,12 +197,12 @@ def build_test_tree( for test_case in get_test_case(suite): test_id = test_case.id() if test_id.startswith("unittest.loader._FailedTest"): - error.append(str(test_case._exception)) # type: ignore + error.append(str(test_case._exception)) # type: ignore # noqa: SLF001 elif test_id.startswith("unittest.loader.ModuleSkipped"): components = test_id.split(".") class_name = f"{components[-1]}.py" # Find/build class node. - file_path = os.fsdecode(os.path.join(directory_path, class_name)) + file_path = os.fsdecode(directory_path / class_name) current_node = get_child_node(class_name, file_path, TestNodeTypeEnum.file, root) else: # Get the static test path components: filename, class name and function name. @@ -220,7 +222,7 @@ def build_test_tree( ) # Find/build file node. - path_components = [top_level_directory] + folders + [py_filename] + path_components = [top_level_directory, *folders, py_filename] file_path = os.fsdecode(pathlib.PurePath("/".join(path_components))) current_node = get_child_node( py_filename, file_path, TestNodeTypeEnum.file, current_node @@ -232,7 +234,7 @@ def build_test_tree( ) # Get test line number. - test_method = getattr(test_case, test_case._testMethodName) + test_method = getattr(test_case, test_case._testMethodName) # noqa: SLF001 lineno = get_source_line(test_method) # Add test node. @@ -266,7 +268,6 @@ def parse_unittest_args( - top_level_directory: The top-level directory of the project, defaults to None, and unittest will use start_directory behind the scenes. """ - arg_parser = argparse.ArgumentParser() arg_parser.add_argument("--start-directory", "-s", default=".") arg_parser.add_argument("--pattern", "-p", default="test*.py") @@ -328,7 +329,7 @@ def send_post_request( except Exception as error: error_msg = f"Error attempting to connect to extension named pipe {test_run_pipe}[vscode-unittest]: {error}" __writer = None - raise VSCodeUnittestError(error_msg) + raise VSCodeUnittestError(error_msg) from error rpc = { "jsonrpc": "2.0", diff --git a/python_files/visualstudio_py_testlauncher.py b/python_files/visualstudio_py_testlauncher.py index b085d5ce4e6f..575f9d4fefc2 100644 --- a/python_files/visualstudio_py_testlauncher.py +++ b/python_files/visualstudio_py_testlauncher.py @@ -32,7 +32,7 @@ import _thread as thread -class _TestOutput(object): +class _TestOutput: """file like object which redirects output to the repl window.""" errors = "strict" @@ -40,7 +40,7 @@ class _TestOutput(object): def __init__(self, old_out, is_stdout): self.is_stdout = is_stdout self.old_out = old_out - if sys.version >= "3." and hasattr(old_out, "buffer"): + if sys.version_info[0] >= 3 and hasattr(old_out, "buffer"): self.buffer = _TestOutputBuffer(old_out.buffer, is_stdout) def flush(self): @@ -79,7 +79,7 @@ def __getattr__(self, name): return getattr(self.old_out, name) -class _TestOutputBuffer(object): +class _TestOutputBuffer: def __init__(self, old_buffer, is_stdout): self.buffer = old_buffer self.is_stdout = is_stdout @@ -101,7 +101,7 @@ def seek(self, pos, whence=0): return self.buffer.seek(pos, whence) -class _IpcChannel(object): +class _IpcChannel: def __init__(self, socket, callback): self.socket = socket self.seq = 0 @@ -109,12 +109,12 @@ def __init__(self, socket, callback): self.lock = thread.allocate_lock() self._closed = False # start the testing reader thread loop - self.test_thread_id = thread.start_new_thread(self.readSocket, ()) + self.test_thread_id = thread.start_new_thread(self.read_socket, ()) def close(self): self._closed = True - def readSocket(self): + def read_socket(self): try: self.socket.recv(1024) self.callback() @@ -139,40 +139,40 @@ def send_event(self, name, **args): class VsTestResult(unittest.TextTestResult): - def startTest(self, test): - super(VsTestResult, self).startTest(test) + def startTest(self, test): # noqa: N802 + super().startTest(test) if _channel is not None: _channel.send_event(name="start", test=test.id()) - def addError(self, test, err): - super(VsTestResult, self).addError(test, err) + def addError(self, test, err): # noqa: N802 + super().addError(test, err) self.sendResult(test, "error", err) - def addFailure(self, test, err): - super(VsTestResult, self).addFailure(test, err) + def addFailure(self, test, err): # noqa: N802 + super().addFailure(test, err) self.sendResult(test, "failed", err) - def addSuccess(self, test): - super(VsTestResult, self).addSuccess(test) + def addSuccess(self, test): # noqa: N802 + super().addSuccess(test) self.sendResult(test, "passed") - def addSkip(self, test, reason): - super(VsTestResult, self).addSkip(test, reason) + def addSkip(self, test, reason): # noqa: N802 + super().addSkip(test, reason) self.sendResult(test, "skipped") - def addExpectedFailure(self, test, err): - super(VsTestResult, self).addExpectedFailure(test, err) + def addExpectedFailure(self, test, err): # noqa: N802 + super().addExpectedFailure(test, err) self.sendResult(test, "failed-expected", err) - def addUnexpectedSuccess(self, test): - super(VsTestResult, self).addUnexpectedSuccess(test) + def addUnexpectedSuccess(self, test): # noqa: N802 + super().addUnexpectedSuccess(test) self.sendResult(test, "passed-unexpected") - def addSubTest(self, test, subtest, err): - super(VsTestResult, self).addSubTest(test, subtest, err) + def addSubTest(self, test, subtest, err): # noqa: N802 + super().addSubTest(test, subtest, err) self.sendResult(test, "subtest-passed" if err is None else "subtest-failed", err, subtest) - def sendResult(self, test, outcome, trace=None, subtest=None): + def sendResult(self, test, outcome, trace=None, subtest=None): # noqa: N802 if _channel is not None: tb = None message = None @@ -195,19 +195,19 @@ def sendResult(self, test, outcome, trace=None, subtest=None): _channel.send_event("result", **result) -def stopTests(): +def stop_tests(): try: os.kill(os.getpid(), signal.SIGUSR1) except Exception: os.kill(os.getpid(), signal.SIGTERM) -class ExitCommand(Exception): +class ExitCommand(Exception): # noqa: N818 pass -def signal_handler(signal, frame): - raise ExitCommand() +def signal_handler(signal, frame): # noqa: ARG001 + raise ExitCommand def main(): @@ -248,9 +248,7 @@ def main(): help="connect to port on localhost and send test results", ) parser.add_option("--us", type="str", help="Directory to start discovery") - parser.add_option( - "--up", type="str", help="Pattern to match test files (" "test*.py" " default)" - ) + parser.add_option("--up", type="str", help="Pattern to match test files (test*.py default)") parser.add_option( "--ut", type="str", @@ -266,14 +264,16 @@ def main(): parser.add_option("--uc", "--catch", type="str", help="Catch control-C and display results") (opts, _) = parser.parse_args() - sys.path[0] = os.getcwd() + sys.path[0] = os.getcwd() # noqa: PTH109 if opts.result_port: try: signal.signal(signal.SIGUSR1, signal_handler) except Exception: with contextlib.suppress(Exception): signal.signal(signal.SIGTERM, signal_handler) - _channel = _IpcChannel(socket.create_connection(("127.0.0.1", opts.result_port)), stopTests) + _channel = _IpcChannel( + socket.create_connection(("127.0.0.1", opts.result_port)), stop_tests + ) sys.stdout = _TestOutput(sys.stdout, is_stdout=True) sys.stderr = _TestOutput(sys.stderr, is_stdout=False) @@ -289,11 +289,11 @@ def main(): sleep(0.1) try: debugger_helper = windll["Microsoft.PythonTools.Debugger.Helper.x86.dll"] - except WindowsError: + except OSError: debugger_helper = windll["Microsoft.PythonTools.Debugger.Helper.x64.dll"] - isTracing = c_char.in_dll(debugger_helper, "isTracing") + is_tracing = c_char.in_dll(debugger_helper, "isTracing") while True: - if isTracing.value != 0: + if is_tracing.value != 0: break sleep(0.1) @@ -318,7 +318,9 @@ def main(): loader = unittest.TestLoader() # opts.us will be passed in suites = loader.discover( - opts.us, pattern=os.path.basename(opts.testFile), top_level_dir=opts.ut + opts.us, + pattern=os.path.basename(opts.testFile), # noqa: PTH119 + top_level_dir=opts.ut, ) suite = None tests = None @@ -327,14 +329,14 @@ def main(): tests = suites else: # Run a specific test class or test method - for test_suite in suites._tests: - for cls in test_suite._tests: + for test_suite in suites._tests: # noqa: SLF001 + for cls in test_suite._tests: # noqa: SLF001 with contextlib.suppress(Exception): for m in cls._tests: - testId = m.id() - if testId.startswith(opts.tests[0]): + test_id = m.id() + if test_id.startswith(opts.tests[0]): suite = cls - if testId in opts.tests: + if test_id in opts.tests: if tests is None: tests = unittest.TestSuite([m]) else: diff --git a/python_files/vscode_datascience_helpers/__init__.py b/python_files/vscode_datascience_helpers/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/python_files/vscode_datascience_helpers/tests/__init__.py b/python_files/vscode_datascience_helpers/tests/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/python_files/vscode_datascience_helpers/tests/logParser.py b/python_files/vscode_datascience_helpers/tests/logParser.py index e07a38e9d4d3..12c090ec581f 100644 --- a/python_files/vscode_datascience_helpers/tests/logParser.py +++ b/python_files/vscode_datascience_helpers/tests/logParser.py @@ -1,4 +1,4 @@ -import argparse +import argparse # noqa: N999 import os import re from io import TextIOWrapper @@ -20,74 +20,75 @@ timestamp_regex = re.compile(r"\d{4}-\d{2}-\d{2}T.*\dZ") -def stripTimestamp(line: str): +def strip_timestamp(line: str): match = timestamp_regex.match(line) if match: return line[match.end() :] return line -def readStripLines(f: TextIOWrapper): - return map(stripTimestamp, f.readlines()) +def read_strip_lines(f: TextIOWrapper): + return map(strip_timestamp, f.readlines()) -def printTestOutput(testlog): +def print_test_output(testlog): # Find all the lines that don't have a PID in them. These are the test output p = Path(testlog[0]) with p.open() as f: - for line in readStripLines(f): + for line in read_strip_lines(f): stripped = line.strip() if len(stripped) > 2 and stripped[0] == "\x1b" and stripped[1] == "[": print(line.rstrip()) # Should be a test line as it has color encoding -def splitByPid(testlog): +def split_by_pid(testlog): # Split testlog into prefixed logs based on pid - baseFile = os.path.splitext(testlog[0])[0] p = Path(testlog[0]) pids = set() logs = {} pid = None - with p.open() as f: - for line in readStripLines(f): - stripped = ansi_escape.sub("", line.strip()) - if len(stripped) > 0: - # Pull out the pid - match = pid_regex.match(stripped) - - # Pids are at least two digits - if match and len(match.group(1)) > 2: - # Pid is found - pid = int(match.group(1)) - - # See if we've created a log for this pid or not - if pid not in pids: - pids.add(pid) - logFile = "{}_{}.log".format(baseFile, pid) - print("Writing to new log: " + logFile) - logs[pid] = Path(logFile).open(mode="w") - - # Add this line to the log - if pid is not None: - logs[pid].write(line) - # Close all of the open logs - for key in logs: - logs[key].close() - - -def doWork(args): + try: + with p.open() as f: + for line in read_strip_lines(f): + stripped = ansi_escape.sub("", line.strip()) + if len(stripped) > 0: + # Pull out the pid + match = pid_regex.match(stripped) + + # Pids are at least two digits + if match and len(match.group(1)) > 2: + # Pid is found + pid = int(match.group(1)) + + # See if we've created a log for this pid or not + if pid not in pids: + pids.add(pid) + log_file = p.with_name(f"{p.stem}_{pid}.log") + print("Writing to new log:", os.fsdecode(log_file)) + logs[pid] = log_file.open(mode="w") + + # Add this line to the log + if pid is not None: + logs[pid].write(line) + finally: + # Close all of the open logs + for key in logs: + logs[key].close() + + +def do_work(args): if not args.testlog: print("Test log should be passed") elif args.testoutput: - printTestOutput(args.testlog) + print_test_output(args.testlog) elif args.split: - splitByPid(args.testlog) + split_by_pid(args.testlog) else: parser.print_usage() def main(): - doWork(parser.parse_args()) + do_work(parser.parse_args()) if __name__ == "__main__": diff --git a/python_files/vscode_pytest/__init__.py b/python_files/vscode_pytest/__init__.py index a7b197ca26a5..c3be7e53d1b6 100644 --- a/python_files/vscode_pytest/__init__.py +++ b/python_files/vscode_pytest/__init__.py @@ -7,7 +7,16 @@ import pathlib import sys import traceback - +from typing import ( + Any, + Dict, + Generator, + List, + Literal, + Optional, + TypedDict, + Union, +) import pytest @@ -15,16 +24,6 @@ sys.path.append(os.fspath(script_dir)) sys.path.append(os.fspath(script_dir / "lib" / "python")) from testing_tools import socket_manager # noqa: E402 -from typing import ( # noqa: E402 - Any, - Dict, - List, - Optional, - Union, - TypedDict, - Literal, - Generator, -) class TestData(TypedDict): @@ -58,13 +57,13 @@ def __init__(self, message): ERRORS = [] IS_DISCOVERY = False -map_id_to_path = dict() -collected_tests_so_far = list() +map_id_to_path = {} +collected_tests_so_far = [] TEST_RUN_PIPE = os.getenv("TEST_RUN_PIPE") SYMLINK_PATH = None -def pytest_load_initial_conftests(early_config, parser, args): +def pytest_load_initial_conftests(early_config, parser, args): # noqa: ARG001 global TEST_RUN_PIPE TEST_RUN_PIPE = os.getenv("TEST_RUN_PIPE") error_string = ( @@ -82,32 +81,32 @@ def pytest_load_initial_conftests(early_config, parser, args): # check if --rootdir is in the args for arg in args: if "--rootdir=" in arg: - rootdir = arg.split("--rootdir=")[1] - if not os.path.exists(rootdir): + rootdir = pathlib.Path(arg.split("--rootdir=")[1]) + if not rootdir.exists(): raise VSCodePytestError( f"The path set in the argument --rootdir={rootdir} does not exist." ) # Check if the rootdir is a symlink or a child of a symlink to the current cwd. - isSymlink = False + is_symlink = False - if os.path.islink(rootdir): - isSymlink = True + if rootdir.is_symlink(): + is_symlink = True print( f"Plugin info[vscode-pytest]: rootdir argument, {rootdir}, is identified as a symlink." ) - elif pathlib.Path(os.path.realpath(rootdir)) != rootdir: + elif rootdir.resolve() != rootdir: print("Plugin info[vscode-pytest]: Checking if rootdir is a child of a symlink.") - isSymlink = has_symlink_parent(rootdir) - if isSymlink: + is_symlink = has_symlink_parent(rootdir) + if is_symlink: print( f"Plugin info[vscode-pytest]: rootdir argument, {rootdir}, is identified as a symlink or child of a symlink, adjusting pytest paths accordingly.", ) global SYMLINK_PATH - SYMLINK_PATH = pathlib.Path(rootdir) + SYMLINK_PATH = rootdir -def pytest_internalerror(excrepr, excinfo): +def pytest_internalerror(excrepr, excinfo): # noqa: ARG001 """A pytest hook that is called when an internal error occurs. Keyword arguments: @@ -150,7 +149,7 @@ def pytest_exception_interact(node, call, report): "Test failed with exception", report.longreprtext, ) - collected_test = testRunResultDict() + collected_test = TestRunResultDict() collected_test[node_id] = item_result cwd = pathlib.Path.cwd() execution_post( @@ -169,14 +168,16 @@ def has_symlink_parent(current_path): # Iterate over all parent directories for parent in curr_path.parents: # Check if the parent directory is a symlink - if os.path.islink(parent): + if parent.is_symlink(): print(f"Symlink found at: {parent}") return True return False -def get_absolute_test_id(test_id: str, testPath: pathlib.Path) -> str: - """A function that returns the absolute test id. This is necessary because testIds are relative to the rootdir. +def get_absolute_test_id(test_id: str, test_path: pathlib.Path) -> str: + """A function that returns the absolute test id. + + This is necessary because testIds are relative to the rootdir. This does not work for our case since testIds when referenced during run time are relative to the instantiation location. Absolute paths for testIds are necessary for the test tree ensures configurations that change the rootdir of pytest are handled correctly. @@ -186,8 +187,7 @@ def get_absolute_test_id(test_id: str, testPath: pathlib.Path) -> str: testPath -- the path to the file the test is located in, as a pathlib.Path object. """ split_id = test_id.split("::")[1:] - absolute_test_id = "::".join([str(testPath), *split_id]) - return absolute_test_id + return "::".join([str(test_path), *split_id]) def pytest_keyboard_interrupt(excinfo): @@ -218,7 +218,7 @@ def create_test_outcome( outcome: str, message: Union[str, None], traceback: Union[str, None], - subtype: Optional[str] = None, + subtype: Optional[str] = None, # noqa: ARG001 ) -> TestOutcome: """A function that creates a TestOutcome object.""" return TestOutcome( @@ -230,7 +230,7 @@ def create_test_outcome( ) -class testRunResultDict(Dict[str, Dict[str, TestOutcome]]): +class TestRunResultDict(Dict[str, Dict[str, TestOutcome]]): """A class that stores all test run results.""" outcome: str @@ -238,10 +238,11 @@ class testRunResultDict(Dict[str, Dict[str, TestOutcome]]): @pytest.hookimpl(hookwrapper=True, trylast=True) -def pytest_report_teststatus(report, config): - """ - A pytest hook that is called when a test is called. It is called 3 times per test, - during setup, call, and teardown. +def pytest_report_teststatus(report, config): # noqa: ARG001 + """A pytest hook that is called when a test is called. + + It is called 3 times per test, during setup, call, and teardown. + Keyword arguments: report -- the report on the test setup, call, and teardown. config -- configuration object. @@ -273,7 +274,7 @@ def pytest_report_teststatus(report, config): message, traceback, ) - collected_test = testRunResultDict() + collected_test = TestRunResultDict() collected_test[absolute_node_id] = item_result execution_post( os.fsdecode(cwd), @@ -292,7 +293,7 @@ def pytest_report_teststatus(report, config): @pytest.hookimpl(hookwrapper=True, trylast=True) -def pytest_runtest_protocol(item, nextitem): +def pytest_runtest_protocol(item, nextitem): # noqa: ARG001 map_id_to_path[item.nodeid] = get_node_path(item) skipped = check_skipped_wrapper(item) if skipped: @@ -307,7 +308,7 @@ def pytest_runtest_protocol(item, nextitem): None, None, ) - collected_test = testRunResultDict() + collected_test = TestRunResultDict() collected_test[absolute_node_id] = item_result execution_post( os.fsdecode(cwd), @@ -325,14 +326,12 @@ def check_skipped_wrapper(item): Keyword arguments: item -- the pytest item object. """ - if item.own_markers: - if check_skipped_condition(item): - return True + if item.own_markers and check_skipped_condition(item): + return True parent = item.parent while isinstance(parent, pytest.Class): - if parent.own_markers: - if check_skipped_condition(parent): - return True + if parent.own_markers and check_skipped_condition(parent): + return True parent = parent.parent return False @@ -343,7 +342,6 @@ def check_skipped_condition(item): Keyword arguments: item -- the pytest item object. """ - for marker in item.own_markers: # If the test is marked with skip then it will not hit the pytest_report_teststatus hook, # therefore we need to handle it as skipped here. @@ -376,14 +374,14 @@ def pytest_sessionfinish(session, exitstatus): if IS_DISCOVERY: if not (exitstatus == 0 or exitstatus == 1 or exitstatus == 5): - errorNode: TestNode = { + error_node: TestNode = { "name": "", "path": cwd, "type_": "error", "children": [], "id_": "", } - post_response(os.fsdecode(cwd), errorNode) + post_response(os.fsdecode(cwd), error_node) try: session_node: Union[TestNode, None] = build_test_tree(session) if not session_node: @@ -396,14 +394,14 @@ def pytest_sessionfinish(session, exitstatus): ERRORS.append( f"Error Occurred, traceback: {(traceback.format_exc() if e.__traceback__ else '')}" ) - errorNode: TestNode = { + error_node: TestNode = { "name": "", "path": cwd, "type_": "error", "children": [], "id_": "", } - post_response(os.fsdecode(cwd), errorNode) + post_response(os.fsdecode(cwd), error_node) else: if exitstatus == 0 or exitstatus == 1: exitstatus_bool = "success" @@ -469,7 +467,9 @@ def build_test_tree(session: pytest.Session) -> TestNode: ERRORS.append( f"unable to find original name for {test_case.name} with parameterization detected." ) - raise VSCodePytestError("Unable to find original name for parameterized test case") + raise VSCodePytestError( + "Unable to find original name for parameterized test case" + ) from None except KeyError: function_test_node: TestNode = create_parameterized_function_node( function_name, get_node_path(test_case), parent_id @@ -529,7 +529,7 @@ def build_test_tree(session: pytest.Session) -> TestNode: file_nodes_dict[test_case.parent] = parent_test_case parent_test_case["children"].append(test_node) created_files_folders_dict: Dict[str, TestNode] = {} - for _, file_node in file_nodes_dict.items(): + for file_node in file_nodes_dict.values(): # Iterate through all the files that exist and construct them into nested folders. root_folder_node: TestNode try: @@ -726,13 +726,11 @@ class DiscoveryPayloadDict(TypedDict): class ExecutionPayloadDict(Dict): - """ - A dictionary that is used to send a execution post request to the server. - """ + """A dictionary that is used to send a execution post request to the server.""" cwd: str status: Literal["success", "error"] - result: Union[testRunResultDict, None] + result: Union[TestRunResultDict, None] not_found: Union[List[str], None] # Currently unused need to check error: Union[str, None] # Currently unused need to check @@ -740,13 +738,13 @@ class ExecutionPayloadDict(Dict): class EOTPayloadDict(TypedDict): """A dictionary that is used to send a end of transmission post request to the server.""" - command_type: Union[Literal["discovery"], Literal["execution"]] + command_type: Literal["discovery", "execution"] eot: bool def get_node_path(node: Any) -> pathlib.Path: - """ - A function that returns the path of a node given the switch to pathlib.Path. + """A function that returns the path of a node given the switch to pathlib.Path. + It also evaluates if the node is a symlink and returns the equivalent path. """ node_path = getattr(node, "path", None) or pathlib.Path(node.fspath) @@ -760,23 +758,22 @@ def get_node_path(node: Any) -> pathlib.Path: if SYMLINK_PATH and not isinstance(node, pytest.Session): # Get relative between the cwd (resolved path) and the node path. try: - # check to see if the node path contains the symlink root already + # Check to see if the node path contains the symlink root already common_path = os.path.commonpath([SYMLINK_PATH, node_path]) if common_path == os.fsdecode(SYMLINK_PATH): - # node path is already relative to the SYMLINK_PATH root therefore return + # The node path is already relative to the SYMLINK_PATH root therefore return return node_path else: - # if the node path is not a symlink, then we need to calculate the equivalent symlink path - # get the relative path between the cwd and the node path (as the node path is not a symlink) + # If the node path is not a symlink, then we need to calculate the equivalent symlink path + # get the relative path between the cwd and the node path (as the node path is not a symlink). rel_path = node_path.relative_to(pathlib.Path.cwd()) # combine the difference between the cwd and the node path with the symlink path - sym_path = pathlib.Path(os.path.join(SYMLINK_PATH, rel_path)) - return sym_path + return pathlib.Path(SYMLINK_PATH, rel_path) except Exception as e: raise VSCodePytestError( f"Error occurred while calculating symlink equivalent from node path: {e}" f"\n SYMLINK_PATH: {SYMLINK_PATH}, \n node path: {node_path}, \n cwd: {pathlib.Path.cwd()}" - ) + ) from e return node_path @@ -785,17 +782,15 @@ def get_node_path(node: Any) -> pathlib.Path: def execution_post( - cwd: str, status: Literal["success", "error"], tests: Union[testRunResultDict, None] + cwd: str, status: Literal["success", "error"], tests: Union[TestRunResultDict, None] ): - """ - Sends a POST request with execution payload details. + """Sends a POST request with execution payload details. Args: cwd (str): Current working directory. status (Literal["success", "error"]): Execution status indicating success or error. tests (Union[testRunResultDict, None]): Test run results, if available. """ - payload: ExecutionPayloadDict = ExecutionPayloadDict( cwd=cwd, status=status, result=tests, not_found=None, error=None ) @@ -869,7 +864,7 @@ def send_post_request( file=sys.stderr, ) __writer = None - raise VSCodePytestError(error_msg) + raise VSCodePytestError(error_msg) from error rpc = { "jsonrpc": "2.0", @@ -895,7 +890,7 @@ def send_post_request( class DeferPlugin: @pytest.hookimpl(wrapper=True) def pytest_xdist_auto_num_workers(self, config: pytest.Config) -> Generator[None, int, int]: - """determine how many workers to use based on how many tests were selected in the test explorer""" + """Determine how many workers to use based on how many tests were selected in the test explorer.""" return min((yield), len(config.option.file_or_dir)) diff --git a/python_files/vscode_pytest/run_pytest_script.py b/python_files/vscode_pytest/run_pytest_script.py index fae9b5e4af18..515e04d1b84d 100644 --- a/python_files/vscode_pytest/run_pytest_script.py +++ b/python_files/vscode_pytest/run_pytest_script.py @@ -3,9 +3,9 @@ import json import os import pathlib -import socket import sys import sysconfig + import pytest # Adds the scripts directory to the PATH as a workaround for enabling shell for test execution. @@ -17,9 +17,10 @@ script_dir = pathlib.Path(__file__).parent.parent sys.path.append(os.fspath(script_dir)) sys.path.append(os.fspath(script_dir / "lib" / "python")) -from testing_tools import process_json_util # noqa: E402 -from testing_tools import socket_manager # noqa: E402 - +from testing_tools import ( # noqa: E402 + process_json_util, + socket_manager, +) # This script handles running pytest via pytest.main(). It is called via run in the # pytest execution adapter and gets the test_ids to run via stdin and the rest of the @@ -29,7 +30,7 @@ # Add the root directory to the path so that we can import the plugin. directory_path = pathlib.Path(__file__).parent.parent sys.path.append(os.fspath(directory_path)) - sys.path.insert(0, os.getcwd()) + sys.path.insert(0, os.getcwd()) # noqa: PTH109 # Get the rest of the args to run with pytest. args = sys.argv[1:] run_test_ids_pipe = os.environ.get("RUN_TEST_IDS_PIPE") @@ -61,13 +62,13 @@ continue except UnicodeDecodeError: continue - except socket.error as e: + except OSError as e: print(f"Error: Could not connect to runTestIdsPort: {e}") print("Error: Could not connect to runTestIdsPort") try: test_ids_from_buffer = raw_json.get("params") if test_ids_from_buffer: - arg_array = ["-p", "vscode_pytest"] + args + test_ids_from_buffer + arg_array = ["-p", "vscode_pytest", *args, *test_ids_from_buffer] print("Running pytest with args: " + str(arg_array)) pytest.main(arg_array) else: @@ -75,7 +76,7 @@ "Error: No test ids received from stdin, could be an error or a run request without ids provided.", ) print("Running pytest with no test ids as args. Args being used: ", args) - arg_array = ["-p", "vscode_pytest"] + args + arg_array = ["-p", "vscode_pytest", *args] pytest.main(arg_array) except json.JSONDecodeError: print( From 7e434a7b5f9a26a7773accb0db78eb9362f8b1b7 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Tue, 9 Jul 2024 14:13:18 -0700 Subject: [PATCH 006/149] Hide Run Python option when in Jupyter Notebook (#23732) Resolves: https://github.com/microsoft/vscode-python/issues/22739 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3de58d434ec4..705569ecab5e 100644 --- a/package.json +++ b/package.json @@ -1361,7 +1361,7 @@ { "submenu": "python.run", "group": "Python", - "when": "editorLangId == python && !virtualWorkspace && shellExecutionSupported && isWorkspaceTrusted" + "when": "editorLangId == python && !virtualWorkspace && shellExecutionSupported && isWorkspaceTrusted && notebookType != jupyter-notebook" }, { "submenu": "python.runFileInteractive", From 658e2de48e07415df6622502d96266e7dd81c684 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Wed, 10 Jul 2024 12:53:44 +1000 Subject: [PATCH 007/149] Add configuration request (#23782) --- .../locators/common/nativePythonFinder.ts | 59 ++++++++++++++----- 1 file changed, 43 insertions(+), 16 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index 029c131188fa..b8cb5c48a157 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -68,6 +68,7 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba constructor() { super(); this.connection = this.start(); + void this.configure(); this.firstRefreshResults = this.refreshFirstTime(); } @@ -320,22 +321,12 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba ); trackPromiseAndNotifyOnCompletion( - this.connection - .sendRequest<{ duration: number }>( - 'refresh', - // Send configuration information to the Python finder. - { - // This has a special meaning in locator, its lot a low priority - // as we treat this as workspace folders that can contain a large number of files. - project_directories: getWorkspaceFolderPaths(), - // We do not want to mix this with `search_paths` - environment_directories: getCustomVirtualEnvDirs(), - conda_executable: getPythonSettingAndUntildify(CONDAPATH_SETTING_KEY), - poetry_executable: getPythonSettingAndUntildify('poetryPath'), - }, - ) - .then(({ duration }) => this.outputChannel.info(`Refresh completed in ${duration}ms`)) - .catch((ex) => this.outputChannel.error('Refresh error', ex)), + this.configure().then(() => + this.connection + .sendRequest<{ duration: number }>('refresh') + .then(({ duration }) => this.outputChannel.info(`Refresh completed in ${duration}ms`)) + .catch((ex) => this.outputChannel.error('Refresh error', ex)), + ), ); completed.promise.finally(() => disposable.dispose()); @@ -344,8 +335,44 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba discovered: discovered.event, }; } + + private lastConfiguration?: ConfigurationOptions; + + /** + * Configuration request, this must always be invoked before any other request. + * Must be invoked when ever there are changes to any data related to the configuration details. + */ + private async configure() { + const options: ConfigurationOptions = { + workspaceDirectories: getWorkspaceFolderPaths(), + // We do not want to mix this with `search_paths` + environmentDirectories: getCustomVirtualEnvDirs(), + condaExecutable: getPythonSettingAndUntildify(CONDAPATH_SETTING_KEY), + poetryExecutable: getPythonSettingAndUntildify('poetryPath'), + }; + // No need to send a configuration request, is there are no changes. + if (JSON.stringify(options) === JSON.stringify(this.lastConfiguration || {})) { + return; + } + try { + this.lastConfiguration = options; + await this.connection.sendRequest('configure', options); + } catch (ex) { + this.outputChannel.error('Refresh error', ex); + } + } } +type ConfigurationOptions = { + workspaceDirectories: string[]; + /** + * Place where virtual envs and the like are stored + * Should not contain workspace folders. + */ + environmentDirectories: string[]; + condaExecutable: string | undefined; + poetryExecutable: string | undefined; +}; /** * Gets all custom virtual environment locations to look for environments. */ From d69d6059df6b7f3d76f35ea427ebfcc09155aa00 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Wed, 10 Jul 2024 12:53:57 +1000 Subject: [PATCH 008/149] Gather additional data to determine failures in identifying conda envs (#23779) --- .../composite/envsCollectionService.ts | 69 ++++++++++++++++++- src/client/telemetry/index.ts | 47 +++++++++++++ 2 files changed, 114 insertions(+), 2 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index 1c62bd6adee2..70d4e9674d02 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -3,6 +3,7 @@ import { Event, EventEmitter, workspace } from 'vscode'; import '../../../../common/extensions'; +import * as fsPath from 'path'; import { createDeferred, Deferred } from '../../../../common/utils/async'; import { StopWatch } from '../../../../common/utils/stopWatch'; import { traceError, traceInfo, traceVerbose } from '../../../../logging'; @@ -28,6 +29,7 @@ import { createNativeGlobalPythonFinder, NativeEnvInfo } from '../common/nativeP import { pathExists } from '../../../../common/platform/fs-paths'; import { noop } from '../../../../common/utils/misc'; import { parseVersion } from '../../info/pythonVersion'; +import { Conda } from '../../../common/environmentManagers/conda'; /** * A service which maintains the collection of known environments. @@ -304,6 +306,12 @@ export class EnvsCollectionService extends PythonEnvsWatcher this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Conda) + .forEach((e) => { + if (e.prefix && envsDirs.some((d) => e.prefix && e.prefix.startsWith(d))) { + missingEnvironments.nativeCondaEnvsInEnvDir += 1; + } + }); + } catch (ex) { + canSpawnConda = false; + } + const prefixesSeenAlready = new Set(); await Promise.all( envs.map(async (env) => { try { @@ -332,9 +365,16 @@ export class EnvsCollectionService extends PythonEnvsWatcher env.executable.sysPrefix.startsWith(d)) + ) { + missingEnvironments.condaEnvsInEnvDir += 1; + } missingEnvironments.missingNativeCondaEnvs += 1; break; case PythonEnvKind.Custom: @@ -419,7 +465,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher getEnvPath(e.executable.filename, e.location).pathType === 'envFolderPath', ).length; const activeStateEnvs = envs.filter((e) => e.kind === PythonEnvKind.ActiveState).length; - const condaEnvs = envs.filter((e) => e.kind === PythonEnvKind.Conda).length; + const condaEnvs = envs.filter((e) => e.kind === PythonEnvKind.Conda); const customEnvs = envs.filter((e) => e.kind === PythonEnvKind.Custom).length; const hatchEnvs = envs.filter((e) => e.kind === PythonEnvKind.Hatch).length; const microsoftStoreEnvs = envs.filter((e) => e.kind === PythonEnvKind.MicrosoftStore).length; @@ -441,6 +487,22 @@ export class EnvsCollectionService extends PythonEnvsWatcher !e.executable.sysPrefix).length; + + await Promise.all( + condaEnvs.map(async (e) => { + if (e.executable.sysPrefix) { + const metadataFolder = fsPath.join(e.executable.sysPrefix, 'conda-meta'); + if (!(await pathExists(metadataFolder))) { + missingEnvironments.invalidCondaEnvs += 1; + } + } + }), + ); + missingEnvironments.invalidCondaEnvs = envs + .filter((e) => e.kind === PythonEnvKind.Conda) + .filter((e) => e.executable.sysPrefix && e.executable.sysPrefix).length; + const nativeEnvironmentsWithoutPython = nativeEnvs.filter((e) => e.executable === undefined).length; const nativeCondaEnvs = nativeEnvs.filter( (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Conda, @@ -493,9 +555,12 @@ export class EnvsCollectionService extends PythonEnvsWatcher Date: Wed, 10 Jul 2024 20:25:46 +1000 Subject: [PATCH 009/149] Native Conda Telemetry (#23787) --- .../composite/envsCollectionService.ts | 20 +++++++++---------- src/client/telemetry/index.ts | 10 ++++++++++ 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index 70d4e9674d02..901b2a735a5e 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -3,7 +3,6 @@ import { Event, EventEmitter, workspace } from 'vscode'; import '../../../../common/extensions'; -import * as fsPath from 'path'; import { createDeferred, Deferred } from '../../../../common/utils/async'; import { StopWatch } from '../../../../common/utils/stopWatch'; import { traceError, traceInfo, traceVerbose } from '../../../../logging'; @@ -29,7 +28,7 @@ import { createNativeGlobalPythonFinder, NativeEnvInfo } from '../common/nativeP import { pathExists } from '../../../../common/platform/fs-paths'; import { noop } from '../../../../common/utils/misc'; import { parseVersion } from '../../info/pythonVersion'; -import { Conda } from '../../../common/environmentManagers/conda'; +import { Conda, isCondaEnvironment } from '../../../common/environmentManagers/conda'; /** * A service which maintains the collection of known environments. @@ -310,6 +309,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher { - if (e.executable.sysPrefix) { - const metadataFolder = fsPath.join(e.executable.sysPrefix, 'conda-meta'); - if (!(await pathExists(metadataFolder))) { - missingEnvironments.invalidCondaEnvs += 1; - } + if (e.executable.sysPrefix && !(await pathExists(e.executable.sysPrefix))) { + missingEnvironments.prefixNotExistsCondaEnvs += 1; + } + if (e.executable.filename && (await isCondaEnvironment(e.executable.filename))) { + missingEnvironments.invalidCondaEnvs += 1; } }), ); - missingEnvironments.invalidCondaEnvs = envs - .filter((e) => e.kind === PythonEnvKind.Conda) - .filter((e) => e.executable.sysPrefix && e.executable.sysPrefix).length; const nativeEnvironmentsWithoutPython = nativeEnvs.filter((e) => e.executable === undefined).length; const nativeCondaEnvs = nativeEnvs.filter( @@ -552,6 +549,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher Date: Wed, 10 Jul 2024 21:56:47 +1000 Subject: [PATCH 010/149] Additional native finder conda telemetry (#23788) --- .../composite/envsCollectionService.ts | 24 ++++++++++++++++++- src/client/telemetry/index.ts | 15 ++++++++++++ 2 files changed, 38 insertions(+), 1 deletion(-) diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index 901b2a735a5e..00eec4866e78 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -330,6 +330,9 @@ export class EnvsCollectionService extends PythonEnvsWatcher(); + Promise.all( + (info?.envs || []).map(async (e) => { + if (duplicate.has(e)) { + condaInfoEnvsDuplicate += 1; + return; + } + duplicate.add(e); + if (!(await pathExists(e))) { + condaInfoEnvsInvalidPrefix += 1; + } + if (!(await isCondaEnvironment(e))) { + condaInfoEnvsInvalid += 1; + } + }), + ); nativeEnvs .filter((e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Conda) .forEach((e) => { @@ -549,7 +568,10 @@ export class EnvsCollectionService extends PythonEnvsWatcher Date: Wed, 10 Jul 2024 09:52:25 -0700 Subject: [PATCH 011/149] Add additional context keys to commands (#23737) In this PR: - Disabling run submenu on Chat code blocks by passing `!inChat` to the sub run menu condition - Enabling the "Restart Python Language Server" command for Jupyter notebooks by adding `notebookType == jupyter-notebook` to its context key --- package.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 705569ecab5e..5f8a639a11ba 100644 --- a/package.json +++ b/package.json @@ -1210,7 +1210,7 @@ "category": "Python", "command": "python.analysis.restartLanguageServer", "title": "%python.command.python.analysis.restartLanguageServer.title%", - "when": "!virtualWorkspace && shellExecutionSupported && editorLangId == python" + "when": "!virtualWorkspace && shellExecutionSupported && (editorLangId == python || notebookType == jupyter-notebook)" }, { "category": "Python", @@ -1361,12 +1361,12 @@ { "submenu": "python.run", "group": "Python", - "when": "editorLangId == python && !virtualWorkspace && shellExecutionSupported && isWorkspaceTrusted && notebookType != jupyter-notebook" + "when": "editorLangId == python && !virtualWorkspace && shellExecutionSupported && isWorkspaceTrusted && !inChat && notebookType != jupyter-notebook" }, { "submenu": "python.runFileInteractive", "group": "Jupyter2", - "when": "editorLangId == python && !virtualWorkspace && shellExecutionSupported && !isJupyterInstalled && isWorkspaceTrusted" + "when": "editorLangId == python && !virtualWorkspace && shellExecutionSupported && !isJupyterInstalled && isWorkspaceTrusted && !inChat" } ], "python.runFileInteractive": [ From 588983df33e2d2476701f17cc236c11b2456254b Mon Sep 17 00:00:00 2001 From: Luciana Abud <45497113+luabud@users.noreply.github.com> Date: Wed, 10 Jul 2024 11:58:09 -0700 Subject: [PATCH 012/149] Update pylance.ts for GDPR clearning (#23789) --- src/client/telemetry/pylance.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/client/telemetry/pylance.ts b/src/client/telemetry/pylance.ts index c3256fae2782..3f406f2cfcbf 100644 --- a/src/client/telemetry/pylance.ts +++ b/src/client/telemetry/pylance.ts @@ -350,7 +350,8 @@ "uselibrarycodefortypes" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "variableinlaytypehints" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "watchforlibrarychanges" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, - "workspacecount" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" } + "workspacecount" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, + "unusablecompilerflags": { "classification": "SystemMetaData", "purpose": "FeatureInsight" } } */ /* __GDPR__ From d0e3feb83e94078ccd4743bdabdd1f97a6c48386 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Thu, 11 Jul 2024 13:59:10 +1000 Subject: [PATCH 013/149] Additional conda telemetry (#23790) --- .../locators/common/nativePythonFinder.ts | 11 +++ .../composite/envsCollectionService.ts | 84 +++++++++++++++++-- .../common/environmentManagers/conda.ts | 4 + src/client/telemetry/index.ts | 32 +++++++ .../envsCollectionService.unit.test.ts | 4 + 5 files changed, 128 insertions(+), 7 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index b8cb5c48a157..196808ac3e5f 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -47,10 +47,17 @@ export interface NativeEnvManagerInfo { version?: string; } +export type NativeCondaInfo = { + canSpawnConda: boolean; + condaRcs: string[]; + envDirs: string[]; +}; + export interface NativeGlobalPythonFinder extends Disposable { resolve(executable: string): Promise; refresh(): AsyncIterable; categoryToKind(category?: string): PythonEnvKind; + getCondaInfo(): Promise; } interface NativeLog { @@ -361,6 +368,10 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba this.outputChannel.error('Refresh error', ex); } } + + async getCondaInfo(): Promise { + return this.connection.sendRequest('condaInfo'); + } } type ConfigurationOptions = { diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index 00eec4866e78..266b2a4966cc 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -333,18 +333,30 @@ export class EnvsCollectionService extends PythonEnvsWatcher(); + await Promise.all( + // eslint-disable-next-line camelcase + [info?.rc_path, info?.user_rc_path, info?.sys_rc_path, ...(info?.config_files || [])].map( + async (rc) => { + if (rc && (await pathExists(rc))) { + condaRcFiles.add(rc); + } + }, + ), + ).catch(noop); + condaRcs = condaRcFiles.size; const duplicate = new Set(); Promise.all( (info?.envs || []).map(async (e) => { @@ -361,6 +373,13 @@ export class EnvsCollectionService extends PythonEnvsWatcher { + if (await pathExists(e)) { + condaInfoEnvsDirs += 1; + } + }), + ); nativeEnvs .filter((e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Conda) .forEach((e) => { @@ -368,9 +387,40 @@ export class EnvsCollectionService extends PythonEnvsWatcher e.executable.sysPrefix.toLowerCase() === rootPrefix && e.kind === PythonEnvKind.Conda, + ) + ) { + condaRootPrefixFoundInInfoNotInNative = nativeEnvs.some( + (e) => e.prefix?.toLowerCase() === rootPrefix.toLowerCase(), + ); + } + } + // eslint-disable-next-line camelcase + const defaultPrefix = (info?.default_prefix || '').toLowerCase(); + if (rootPrefix) { + // Check if we have a conda env that matches this prefix. + if ( + envs.some( + (e) => e.executable.sysPrefix.toLowerCase() === defaultPrefix && e.kind === PythonEnvKind.Conda, + ) + ) { + condaDefaultPrefixFoundInInfoNotInNative = nativeEnvs.some( + (e) => e.prefix?.toLowerCase() === defaultPrefix.toLowerCase(), + ); + } + } } catch (ex) { canSpawnConda = false; } + const nativeCondaInfoPromise = this.nativeFinder.getCondaInfo(); const prefixesSeenAlready = new Set(); await Promise.all( envs.map(async (env) => { @@ -480,6 +530,22 @@ export class EnvsCollectionService extends PythonEnvsWatcher traceError('Failed to send telemetry for missing environments', ex)); + const nativeCondaInfo = await nativeCondaInfoPromise.catch((ex) => + traceError(`Failed to get conda info from native locator`, ex), + ); + + type CondaTelemetry = { + nativeCanSpawnConda?: boolean; + nativeCondaInfoEnvsDirs?: number; + nativeCondaRcs?: number; + }; + + const condaTelemetry: CondaTelemetry = {}; + if (nativeCondaInfo) { + condaTelemetry.nativeCanSpawnConda = nativeCondaInfo.canSpawnConda; + condaTelemetry.nativeCondaInfoEnvsDirs = new Set(nativeCondaInfo.envDirs).size; + condaTelemetry.nativeCondaRcs = new Set(nativeCondaInfo.condaRcs).size; + } const environmentsWithoutPython = envs.filter( (e) => getEnvPath(e.executable.filename, e.location).pathType === 'envFolderPath', ).length; @@ -513,7 +579,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher { + throw new Error('Method not implemented.'); + } + categoryToKind(_category: string): PythonEnvKind { throw new Error('Method not implemented.'); } From 415c55b009d5311b2f2ac024bb6b290dc55c45e0 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Thu, 11 Jul 2024 18:21:51 +1000 Subject: [PATCH 014/149] Performance telemetry for native locator (#23792) --- .../locators/common/nativePythonTelemetry.ts | 57 ++++++++++++++++++- src/client/telemetry/constants.ts | 1 + src/client/telemetry/index.ts | 50 ++++++++++++++++ 3 files changed, 107 insertions(+), 1 deletion(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts index 1bedbaf23699..d7b3150cd748 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts @@ -5,7 +5,7 @@ import { traceError } from '../../../../logging'; import { sendTelemetryEvent } from '../../../../telemetry'; import { EventName } from '../../../../telemetry/constants'; -export type NativePythonTelemetry = MissingCondaEnvironments | MissingPoetryEnvironments; +export type NativePythonTelemetry = MissingCondaEnvironments | MissingPoetryEnvironments | RefreshPerformance; export type MissingCondaEnvironments = { event: 'MissingCondaEnvironments'; @@ -48,6 +48,37 @@ export type MissingPoetryEnvironments = { }; }; +export type RefreshPerformance = { + event: 'RefreshPerformance'; + data: { + refreshPerformance: { + total: number; + breakdown: { + Locators: number; + Path: number; + GlobalVirtualEnvs: number; + Workspaces: number; + }; + locators: { + Conda?: number; + Homebrew?: number; + LinuxGlobalPython?: number; + MacCmdLineTools?: number; + MacPythonOrg?: number; + MacXCode?: number; + PipEnv?: number; + Poetry?: number; + PyEnv?: number; + Venv?: number; + VirtualEnv?: number; + VirtualEnvWrapper?: number; + WindowsRegistry?: number; + WindowsStore?: number; + }; + }; + }; +}; + export function sendNativeTelemetry(data: NativePythonTelemetry): void { switch (data.event) { case 'MissingCondaEnvironments': { @@ -66,6 +97,30 @@ export function sendNativeTelemetry(data: NativePythonTelemetry): void { ); break; } + case 'RefreshPerformance': { + sendTelemetryEvent(EventName.NATIVE_FINDER_PERF, undefined, { + duration: data.data.refreshPerformance.total, + breakdownGlobalVirtualEnvs: data.data.refreshPerformance.breakdown.GlobalVirtualEnvs, + breakdownLocators: data.data.refreshPerformance.breakdown.Locators, + breakdownPath: data.data.refreshPerformance.breakdown.Path, + breakdownWorkspaces: data.data.refreshPerformance.breakdown.Workspaces, + locatorConda: data.data.refreshPerformance.locators.Conda, + locatorHomebrew: data.data.refreshPerformance.locators.Homebrew, + locatorLinuxGlobalPython: data.data.refreshPerformance.locators.LinuxGlobalPython, + locatorMacCmdLineTools: data.data.refreshPerformance.locators.MacCmdLineTools, + locatorMacPythonOrg: data.data.refreshPerformance.locators.MacPythonOrg, + locatorMacXCode: data.data.refreshPerformance.locators.MacXCode, + locatorPipEnv: data.data.refreshPerformance.locators.PipEnv, + locatorPoetry: data.data.refreshPerformance.locators.Poetry, + locatorPyEnv: data.data.refreshPerformance.locators.PyEnv, + locatorVenv: data.data.refreshPerformance.locators.Venv, + locatorVirtualEnv: data.data.refreshPerformance.locators.VirtualEnv, + locatorVirtualEnvWrapper: data.data.refreshPerformance.locators.VirtualEnvWrapper, + locatorWindowsRegistry: data.data.refreshPerformance.locators.WindowsRegistry, + locatorWindowsStore: data.data.refreshPerformance.locators.WindowsStore, + }); + break; + } default: { traceError(`Unhandled Telemetry Event type ${JSON.stringify(data)}`); } diff --git a/src/client/telemetry/constants.ts b/src/client/telemetry/constants.ts index 69c3a58385d0..b5da8fcc96b7 100644 --- a/src/client/telemetry/constants.ts +++ b/src/client/telemetry/constants.ts @@ -21,6 +21,7 @@ export enum EventName { PYTHON_INTERPRETER_DISCOVERY = 'PYTHON_INTERPRETER_DISCOVERY', NATIVE_FINDER_MISSING_CONDA_ENVS = 'NATIVE_FINDER_MISSING_CONDA_ENVS', NATIVE_FINDER_MISSING_POETRY_ENVS = 'NATIVE_FINDER_MISSING_POETRY_ENVS', + NATIVE_FINDER_PERF = 'NATIVE_FINDER_PERF', PYTHON_INTERPRETER_DISCOVERY_INVALID_NATIVE = 'PYTHON_INTERPRETER_DISCOVERY_INVALID_NATIVE', PYTHON_INTERPRETER_AUTO_SELECTION = 'PYTHON_INTERPRETER_AUTO_SELECTION', PYTHON_INTERPRETER_ACTIVATION_ENVIRONMENT_VARIABLES = 'PYTHON_INTERPRETER.ACTIVATION_ENVIRONMENT_VARIABLES', diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index adf9b1e1059e..d8991b093a79 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -1642,6 +1642,56 @@ export interface IEventNamePropertyMapping { */ inProjectIsDifferent?: boolean; }; + /** + * Telemetry containing performance metrics for Native Finder. + */ + /* __GDPR__ + "native_finder_perf" : { + "duration" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "breakdownLocators" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "breakdownPath" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "breakdownGlobalVirtualEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "breakdownWorkspaces" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorConda" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorHomebrew" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorLinuxGlobalPython" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorMacCmdLineTools" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorMacPythonOrg" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorMacXCode" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorPipEnv" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorPoetry" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorPyEnv" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorVenv" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorVirtualEnv" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorVirtualEnvWrapper" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorWindowsRegistry" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorWindowsStore" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + } + */ + [EventName.NATIVE_FINDER_PERF]: { + /** + * Total duration to find envs using native locator. + */ + duration: number; + breakdownLocators?: number; + breakdownPath?: number; + breakdownGlobalVirtualEnvs?: number; + breakdownWorkspaces?: number; + locatorConda?: number; + locatorHomebrew?: number; + locatorLinuxGlobalPython?: number; + locatorMacCmdLineTools?: number; + locatorMacPythonOrg?: number; + locatorMacXCode?: number; + locatorPipEnv?: number; + locatorPoetry?: number; + locatorPyEnv?: number; + locatorVenv?: number; + locatorVirtualEnv?: number; + locatorVirtualEnvWrapper?: number; + locatorWindowsRegistry?: number; + locatorWindowsStore?: number; + }; /** * Telemetry event sent when discovery of all python environments using the native locator(virtualenv, conda, pipenv etc.) finishes. */ From 5fd50986d5c9a869a1fe54ffecaa6fbdf664dc77 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Thu, 11 Jul 2024 09:55:23 -0700 Subject: [PATCH 015/149] Minimize execution output when there is no output for new REPL (#23786) Resolves: https://github.com/microsoft/vscode-python/issues/23520 --- src/client/repl/replController.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/client/repl/replController.ts b/src/client/repl/replController.ts index 86d021cd1c7a..7f11b654c54e 100644 --- a/src/client/repl/replController.ts +++ b/src/client/repl/replController.ts @@ -24,10 +24,11 @@ export function createReplController( exec.start(Date.now()); try { const result = await server.execute(cell.document.getText()); - - exec.replaceOutput([ - new vscode.NotebookCellOutput([vscode.NotebookCellOutputItem.text(result, 'text/plain')]), - ]); + if (result !== '') { + exec.replaceOutput([ + new vscode.NotebookCellOutput([vscode.NotebookCellOutputItem.text(result, 'text/plain')]), + ]); + } exec.end(true); } catch (err) { const error = err as Error; From 55b3129ef2e0c128b76288f7326e23f4f944d750 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Fri, 12 Jul 2024 11:52:15 +1000 Subject: [PATCH 016/149] Capture info for missing conda envs in native locator (#23796) --- .../composite/envsCollectionService.ts | 287 ++++++++++++------ src/client/telemetry/index.ts | 44 ++- 2 files changed, 232 insertions(+), 99 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index 266b2a4966cc..f423a842c50f 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. +import * as fsPath from 'path'; import { Event, EventEmitter, workspace } from 'vscode'; import '../../../../common/extensions'; import { createDeferred, Deferred } from '../../../../common/utils/async'; @@ -28,7 +29,13 @@ import { createNativeGlobalPythonFinder, NativeEnvInfo } from '../common/nativeP import { pathExists } from '../../../../common/platform/fs-paths'; import { noop } from '../../../../common/utils/misc'; import { parseVersion } from '../../info/pythonVersion'; -import { Conda, isCondaEnvironment } from '../../../common/environmentManagers/conda'; +import { + Conda, + CONDAPATH_SETTING_KEY, + getCondaEnvironmentsTxt, + isCondaEnvironment, +} from '../../../common/environmentManagers/conda'; +import { getConfiguration } from '../../../../common/vscodeApis/workspaceApis'; /** * A service which maintains the collection of known environments. @@ -307,12 +314,8 @@ export class EnvsCollectionService extends PythonEnvsWatcher(CONDAPATH_SETTING_KEY) || '').trim()) + .toLowerCase(); + const condaTelemetry: CondaTelemetry = { + condaEnvsInEnvDir: 0, + condaInfoEnvs: 0, + prefixNotExistsCondaEnvs: 0, + condaEnvsWithoutPrefix: 0, + nativeCondaEnvsInEnvDir: 0, + userProvidedCondaExe: userProvidedCondaExe.length > 0, + condaInfoEnvsInvalid: 0, + invalidCondaEnvs: 0, + condaInfoEnvsDuplicate: 0, + condaInfoEnvsInvalidPrefix: 0, + condaInfoEnvsDirs: 0, + nativeCondaRcsNotFound: 0, + nativeCondaEnvDirsNotFound: 0, + nativeCondaEnvDirsNotFoundHasEnvs: 0, + nativeCondaEnvDirsNotFoundHasEnvsInTxt: 0, + }; + + // Get conda telemetry + { + const [info, nativeCondaInfo, condaEnvsInEnvironmentsTxt] = await Promise.all([ + Conda.getConda() + .catch((ex) => traceError('Failed to get conda info', ex)) + .then((conda) => conda?.getInfo()), + this.nativeFinder + .getCondaInfo() + .catch((ex) => traceError(`Failed to get conda info from native locator`, ex)), + getCondaEnvironmentsTxt() + .then(async (items) => { + const validEnvs = new Set(); + await Promise.all( + items.map(async (e) => { + if ((await pathExists(e)) && (await isCondaEnvironment(e))) { + validEnvs.add(fsPath.normalize(e).toLowerCase()); + } + }), + ); + return Array.from(validEnvs); + }) + .catch((ex) => traceError(`Failed to get conda envs from environments.txt`, ex)) + .then((items) => items || []), + ]); + + if (nativeCondaInfo) { + condaTelemetry.nativeCanSpawnConda = nativeCondaInfo.canSpawnConda; + condaTelemetry.nativeCondaInfoEnvsDirs = new Set(nativeCondaInfo.envDirs).size; + condaTelemetry.nativeCondaRcs = new Set(nativeCondaInfo.condaRcs).size; + } + condaTelemetry.condaEnvsInTxt = condaEnvsInEnvironmentsTxt.length; + condaTelemetry.canSpawnConda = !!info; + + // Conda info rcs const condaRcFiles = new Set(); await Promise.all( // eslint-disable-next-line camelcase [info?.rc_path, info?.user_rc_path, info?.sys_rc_path, ...(info?.config_files || [])].map( async (rc) => { if (rc && (await pathExists(rc))) { - condaRcFiles.add(rc); + condaRcFiles.add(fsPath.normalize(rc).toLowerCase()); } }, ), ).catch(noop); - condaRcs = condaRcFiles.size; + const condaRcs = Array.from(condaRcFiles); + condaTelemetry.condaRcs = condaRcs.length; + + // Find the condarcs that were not found by native finder. + const nativeCondaRcs = (nativeCondaInfo?.condaRcs || []).map((rc) => fsPath.normalize(rc).toLowerCase()); + condaTelemetry.nativeCondaRcsNotFound = condaRcs.filter((rc) => !nativeCondaRcs.includes(rc)).length; + + // Conda info envs + const validCondaInfoEnvs = new Set(); const duplicate = new Set(); + // Duplicate, invalid conda environments. Promise.all( (info?.envs || []).map(async (e) => { if (duplicate.has(e)) { - condaInfoEnvsDuplicate += 1; + condaTelemetry.condaInfoEnvsDuplicate += 1; return; } duplicate.add(e); if (!(await pathExists(e))) { - condaInfoEnvsInvalidPrefix += 1; + condaTelemetry.condaInfoEnvsInvalidPrefix += 1; + return; } if (!(await isCondaEnvironment(e))) { - condaInfoEnvsInvalid += 1; + condaTelemetry.condaInfoEnvsInvalid += 1; + return; } + validCondaInfoEnvs.add(fsPath.normalize(e).toLowerCase()); }), ); + const condaInfoEnvs = Array.from(validCondaInfoEnvs); + condaTelemetry.condaInfoEnvs = validCondaInfoEnvs.size; + + // Conda env_dirs + const validEnvDirs = new Set(); Promise.all( - envsDirs.map(async (e) => { + // eslint-disable-next-line camelcase + (info?.envs_dirs || []).map(async (e) => { if (await pathExists(e)) { - condaInfoEnvsDirs += 1; + validEnvDirs.add(e); } }), ); - nativeEnvs - .filter((e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Conda) - .forEach((e) => { - if (e.prefix && envsDirs.some((d) => e.prefix && e.prefix.startsWith(d))) { - missingEnvironments.nativeCondaEnvsInEnvDir += 1; - } - }); + condaTelemetry.condaInfoEnvsDirs = validEnvDirs.size; + envsDirs = Array.from(validEnvDirs).map((e) => fsPath.normalize(e).toLowerCase()); - // Check if we have found the conda env that matches the `root_prefix` in the conda info. - // eslint-disable-next-line camelcase - const rootPrefix = (info?.root_prefix || '').toLowerCase(); - if (rootPrefix) { - // Check if we have a conda env that matches this prefix. + const nativeCondaEnvs = nativeEnvs.filter( + (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Conda, + ); + + // Find the env_dirs that were not found by native finder. + const nativeCondaEnvDirs = (nativeCondaInfo?.envDirs || []).map((envDir) => + fsPath.normalize(envDir).toLowerCase(), + ); + const nativeCondaEnvPrefix = nativeCondaEnvs + .filter((e) => e.prefix) + .map((e) => fsPath.normalize(e.prefix || '').toLowerCase()); + + envsDirs.forEach((envDir) => { if ( - envs.some( - (e) => e.executable.sysPrefix.toLowerCase() === rootPrefix && e.kind === PythonEnvKind.Conda, - ) + !nativeCondaEnvDirs.includes(envDir) && + !nativeCondaEnvDirs.includes(fsPath.join(envDir, 'envs')) && + // If we have a native conda env from this env dir, then we're good. + !nativeCondaEnvPrefix.some((prefix) => prefix.startsWith(envDir)) ) { - condaRootPrefixFoundInInfoNotInNative = nativeEnvs.some( - (e) => e.prefix?.toLowerCase() === rootPrefix.toLowerCase(), - ); + condaTelemetry.nativeCondaEnvDirsNotFound += 1; + + // Find what conda envs returned by `conda info` belong to this envdir folder. + // And find which of those envs do not exist in native conda envs + condaInfoEnvs.forEach((env) => { + if (env.startsWith(envDir)) { + condaTelemetry.nativeCondaEnvDirsNotFoundHasEnvs += 1; + + // Check if this env was in the environments.txt file. + if (condaEnvsInEnvironmentsTxt.includes(env)) { + condaTelemetry.nativeCondaEnvDirsNotFoundHasEnvsInTxt += 1; + } + } + }); } + }); + + // How many envs are in environments.txt that were not found by native locator. + missingEnvironments.missingNativeCondaEnvsFromTxt = condaEnvsInEnvironmentsTxt.filter( + (env) => !nativeCondaEnvPrefix.some((prefix) => prefix === env), + ).length; + + // How many envs found by native locator & conda info are in the env dirs. + condaTelemetry.condaEnvsInEnvDir = condaInfoEnvs.filter((e) => + envsDirs.some((d) => e.startsWith(d)), + ).length; + condaTelemetry.nativeCondaEnvsInEnvDir = nativeCondaEnvs.filter((e) => + nativeCondaEnvDirs.some((d) => (e.prefix || '').startsWith(d)), + ).length; + + // Check if we have found the conda env that matches the `root_prefix` in the conda info. + // eslint-disable-next-line camelcase + let rootPrefix = info?.root_prefix || ''; + if (rootPrefix && (await pathExists(rootPrefix)) && (await isCondaEnvironment(rootPrefix))) { + rootPrefix = fsPath.normalize(rootPrefix).toLowerCase(); + condaTelemetry.condaRootPrefixInCondaExePath = userProvidedCondaExe.startsWith(rootPrefix); + // Check if we have a conda env that matches this prefix but not found in native envs. + condaTelemetry.condaRootPrefixFoundInInfoNotInNative = + condaInfoEnvs.some((env) => env === rootPrefix) && + !nativeCondaEnvs.some((e) => fsPath.normalize(e.prefix || '').toLowerCase() === rootPrefix); } + // eslint-disable-next-line camelcase - const defaultPrefix = (info?.default_prefix || '').toLowerCase(); - if (rootPrefix) { - // Check if we have a conda env that matches this prefix. - if ( - envs.some( - (e) => e.executable.sysPrefix.toLowerCase() === defaultPrefix && e.kind === PythonEnvKind.Conda, - ) - ) { - condaDefaultPrefixFoundInInfoNotInNative = nativeEnvs.some( - (e) => e.prefix?.toLowerCase() === defaultPrefix.toLowerCase(), - ); - } + let defaultPrefix = info?.default_prefix || ''; + if (defaultPrefix && (await pathExists(defaultPrefix)) && (await isCondaEnvironment(defaultPrefix))) { + defaultPrefix = fsPath.normalize(defaultPrefix).toLowerCase(); + condaTelemetry.condaDefaultPrefixInCondaExePath = userProvidedCondaExe.startsWith(defaultPrefix); + // Check if we have a conda env that matches this prefix but not found in native envs. + condaTelemetry.condaDefaultPrefixFoundInInfoNotInNative = + condaInfoEnvs.some((env) => env === defaultPrefix) && + !nativeCondaEnvs.some((e) => fsPath.normalize(e.prefix || '').toLowerCase() === defaultPrefix); } - } catch (ex) { - canSpawnConda = false; } - const nativeCondaInfoPromise = this.nativeFinder.getCondaInfo(); + const prefixesSeenAlready = new Set(); await Promise.all( envs.map(async (env) => { @@ -466,12 +590,6 @@ export class EnvsCollectionService extends PythonEnvsWatcher env.executable.sysPrefix.startsWith(d)) - ) { - missingEnvironments.condaEnvsInEnvDir += 1; - } missingEnvironments.missingNativeCondaEnvs += 1; break; case PythonEnvKind.Custom: @@ -530,22 +648,6 @@ export class EnvsCollectionService extends PythonEnvsWatcher traceError('Failed to send telemetry for missing environments', ex)); - const nativeCondaInfo = await nativeCondaInfoPromise.catch((ex) => - traceError(`Failed to get conda info from native locator`, ex), - ); - - type CondaTelemetry = { - nativeCanSpawnConda?: boolean; - nativeCondaInfoEnvsDirs?: number; - nativeCondaRcs?: number; - }; - - const condaTelemetry: CondaTelemetry = {}; - if (nativeCondaInfo) { - condaTelemetry.nativeCanSpawnConda = nativeCondaInfo.canSpawnConda; - condaTelemetry.nativeCondaInfoEnvsDirs = new Set(nativeCondaInfo.envDirs).size; - condaTelemetry.nativeCondaRcs = new Set(nativeCondaInfo.condaRcs).size; - } const environmentsWithoutPython = envs.filter( (e) => getEnvPath(e.executable.filename, e.location).pathType === 'envFolderPath', ).length; @@ -572,15 +674,15 @@ export class EnvsCollectionService extends PythonEnvsWatcher !e.executable.sysPrefix).length; + condaTelemetry.condaEnvsWithoutPrefix = condaEnvs.filter((e) => !e.executable.sysPrefix).length; await Promise.all( condaEnvs.map(async (e) => { if (e.executable.sysPrefix && !(await pathExists(e.executable.sysPrefix))) { - missingEnvironments.prefixNotExistsCondaEnvs += 1; + condaTelemetry.prefixNotExistsCondaEnvs += 1; } if (e.executable.filename && !(await isCondaEnvironment(e.executable.filename))) { - missingEnvironments.invalidCondaEnvs += 1; + condaTelemetry.invalidCondaEnvs += 1; } }), ); @@ -634,19 +736,10 @@ export class EnvsCollectionService extends PythonEnvsWatcher Date: Fri, 12 Jul 2024 23:40:50 +1000 Subject: [PATCH 017/149] Await on promises (#23802) --- .../base/locators/composite/envsCollectionService.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index f423a842c50f..e6a61964a245 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -438,7 +438,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher(); const duplicate = new Set(); // Duplicate, invalid conda environments. - Promise.all( + await Promise.all( (info?.envs || []).map(async (e) => { if (duplicate.has(e)) { condaTelemetry.condaInfoEnvsDuplicate += 1; @@ -461,7 +461,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher(); - Promise.all( + await Promise.all( // eslint-disable-next-line camelcase (info?.envs_dirs || []).map(async (e) => { if (await pathExists(e)) { @@ -736,7 +736,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher Date: Fri, 12 Jul 2024 09:11:22 -0700 Subject: [PATCH 018/149] Fix Bad GDPR annotations (#23803) --- src/client/telemetry/index.ts | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index 1f69f0f7cde8..127f15ac7158 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -1215,10 +1215,10 @@ export interface IEventNamePropertyMapping { "missingNativeVenvEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "missingNativeVirtualEnvEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "missingNativeVirtualEnvWrapperEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, - "missingNativeOtherGlobalEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" } - "nativeCondaRcsNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" } - "nativeCondaEnvDirsNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" } - "nativeCondaEnvDirsNotFoundHasEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" } + "missingNativeOtherGlobalEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "nativeCondaRcsNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "nativeCondaEnvDirsNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "nativeCondaEnvDirsNotFoundHasEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "nativeCondaEnvDirsNotFoundHasEnvsInTxt" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" } } */ @@ -1556,7 +1556,7 @@ export interface IEventNamePropertyMapping { "missingEnvDirsFromOtherRc" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "missingFromSysRcEnvDirs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "missingFromUserRcEnvDirs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, - "missingFromOtherRcEnvDirs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "missingFromOtherRcEnvDirs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" } } */ [EventName.NATIVE_FINDER_MISSING_CONDA_ENVS]: { @@ -1637,7 +1637,7 @@ export interface IEventNamePropertyMapping { "cacheDirIsDifferent" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, "virtualenvsPathNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, "virtualenvsPathIsDifferent" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, - "inProjectIsDifferent" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "inProjectIsDifferent" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" } } */ [EventName.NATIVE_FINDER_MISSING_POETRY_ENVS]: { @@ -1705,7 +1705,7 @@ export interface IEventNamePropertyMapping { "locatorVirtualEnv" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "locatorVirtualEnvWrapper" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "locatorWindowsRegistry" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, - "locatorWindowsStore" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "locatorWindowsStore" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" } } */ [EventName.NATIVE_FINDER_PERF]: { From e5f8539af2ad1bca609bb7a416b50eb27e2f6014 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Sun, 14 Jul 2024 17:04:00 +1000 Subject: [PATCH 019/149] Additional data to compare conda environments.txt (#23805) --- .../base/locators/common/nativePythonFinder.ts | 3 +++ .../locators/composite/envsCollectionService.ts | 16 ++++++++++++++-- src/client/telemetry/index.ts | 17 ++++++++++++++++- 3 files changed, 33 insertions(+), 3 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index 196808ac3e5f..3478f2d4cd0e 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -51,6 +51,9 @@ export type NativeCondaInfo = { canSpawnConda: boolean; condaRcs: string[]; envDirs: string[]; + environmentsTxt?: string; + environmentsTxtExists?: boolean; + environmentsFromTxt: string[]; }; export interface NativeGlobalPythonFinder extends Disposable { diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index e6a61964a245..f1a3e98b7467 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -359,6 +359,9 @@ export class EnvsCollectionService extends PythonEnvsWatcher traceError('Failed to get conda info', ex)) .then((conda) => conda?.getInfo()), @@ -405,12 +409,20 @@ export class EnvsCollectionService extends PythonEnvsWatcher traceError(`Failed to get conda envs from environments.txt`, ex)) .then((items) => items || []), + getCondaEnvironmentsTxt().catch(noop), ]); + const environmentsTxt = + Array.isArray(envTxt) && envTxt.length ? fsPath.normalize(envTxt[0]).toLowerCase() : undefined; if (nativeCondaInfo) { condaTelemetry.nativeCanSpawnConda = nativeCondaInfo.canSpawnConda; condaTelemetry.nativeCondaInfoEnvsDirs = new Set(nativeCondaInfo.envDirs).size; condaTelemetry.nativeCondaRcs = new Set(nativeCondaInfo.condaRcs).size; + + const nativeEnvTxt = fsPath.normalize(nativeCondaInfo.environmentsTxt || '').toLowerCase(); + condaTelemetry.nativeCondaEnvTxtExists = nativeCondaInfo.environmentsTxtExists === true; + condaTelemetry.nativeCondaEnvsFromTxt = (nativeCondaInfo.environmentsFromTxt || []).length; + condaTelemetry.nativeCondaEnvTxtSame = nativeEnvTxt === environmentsTxt; } condaTelemetry.condaEnvsInTxt = condaEnvsInEnvironmentsTxt.length; condaTelemetry.canSpawnConda = !!info; @@ -736,7 +748,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher Date: Mon, 15 Jul 2024 17:12:43 +1000 Subject: [PATCH 020/149] Capture additional telemetry for conda (#23810) --- .../base/locators/common/nativePythonFinder.ts | 1 + .../base/locators/composite/envsCollectionService.ts | 2 ++ src/client/telemetry/index.ts | 8 +++++++- 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index 3478f2d4cd0e..1392886da7cc 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -49,6 +49,7 @@ export interface NativeEnvManagerInfo { export type NativeCondaInfo = { canSpawnConda: boolean; + userProvidedEnvFound?: boolean; condaRcs: string[]; envDirs: string[]; environmentsTxt?: string; diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index f1a3e98b7467..85b852cc32d0 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -344,6 +344,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher Date: Mon, 15 Jul 2024 12:57:01 -0700 Subject: [PATCH 021/149] Fix debug arg error (#23814) Set justMyCode only in the python debugger, not in the python extension. Closed: https://github.com/microsoft/vscode-python-debugger/issues/335 --- .../configuration/resolvers/attach.ts | 7 -- .../configuration/resolvers/launch.ts | 7 -- src/client/debugger/types.ts | 1 - src/client/testing/common/debugLauncher.ts | 2 - .../resolvers/attach.unit.test.ts | 69 ------------------- .../resolvers/launch.unit.test.ts | 69 +------------------ .../testing/common/debugLauncher.unit.test.ts | 9 --- 7 files changed, 1 insertion(+), 163 deletions(-) diff --git a/src/client/debugger/extension/configuration/resolvers/attach.ts b/src/client/debugger/extension/configuration/resolvers/attach.ts index bdc72680d861..6e5ca501463e 100644 --- a/src/client/debugger/extension/configuration/resolvers/attach.ts +++ b/src/client/debugger/extension/configuration/resolvers/attach.ts @@ -43,17 +43,10 @@ export class AttachConfigurationResolver extends BaseConfigurationResolver { expect(debugConfig).to.have.property('clientOS', getClientOS()); expect(debugConfig).to.have.property('debugOptions').to.be.deep.equal(expectedDebugOptions); }); - - const testsForJustMyCode = [ - { - justMyCode: false, - debugStdLib: true, - expectedResult: false, - }, - { - justMyCode: false, - debugStdLib: false, - expectedResult: false, - }, - { - justMyCode: false, - debugStdLib: undefined, - expectedResult: false, - }, - { - justMyCode: true, - debugStdLib: false, - expectedResult: true, - }, - { - justMyCode: true, - debugStdLib: true, - expectedResult: true, - }, - { - justMyCode: true, - debugStdLib: undefined, - expectedResult: true, - }, - { - justMyCode: undefined, - debugStdLib: false, - expectedResult: true, - }, - { - justMyCode: undefined, - debugStdLib: true, - expectedResult: false, - }, - { - justMyCode: undefined, - debugStdLib: undefined, - expectedResult: true, - }, - ]; - test('Ensure justMyCode property is correctly derived from debugStdLib', async () => { - const activeFile = 'xyz.py'; - const workspaceFolder = createMoqWorkspaceFolder(__dirname); - setupActiveEditor(activeFile, PYTHON_LANGUAGE); - const defaultWorkspace = path.join('usr', 'desktop'); - setupWorkspaces([defaultWorkspace]); - - const debugOptions = debugOptionsAvailable - .slice() - .concat(DebugOptions.Jinja, DebugOptions.Sudo) as DebugOptions[]; - - testsForJustMyCode.forEach(async (testParams) => { - const debugConfig = await resolveDebugConfiguration(workspaceFolder, { - ...attach, - debugOptions, - justMyCode: testParams.justMyCode, - debugStdLib: testParams.debugStdLib, - }); - expect(debugConfig).to.have.property('justMyCode', testParams.expectedResult); - }); - }); }); }); diff --git a/src/test/debugger/extension/configuration/resolvers/launch.unit.test.ts b/src/test/debugger/extension/configuration/resolvers/launch.unit.test.ts index 59f61f81cd85..f312c99b1cbc 100644 --- a/src/test/debugger/extension/configuration/resolvers/launch.unit.test.ts +++ b/src/test/debugger/extension/configuration/resolvers/launch.unit.test.ts @@ -768,80 +768,13 @@ getInfoPerOS().forEach(([osName, osType, path]) => { expect(debugConfig).to.have.property('redirectOutput', true); expect(debugConfig).to.have.property('justMyCode', false); expect(debugConfig).to.have.property('debugOptions'); - const expectedOptions = [ - DebugOptions.DebugStdLib, - DebugOptions.ShowReturnValue, - DebugOptions.RedirectOutput, - ]; + const expectedOptions = [DebugOptions.ShowReturnValue, DebugOptions.RedirectOutput]; if (osType === platform.OSType.Windows) { expectedOptions.push(DebugOptions.FixFilePathCase); } expect((debugConfig as DebugConfiguration).debugOptions).to.be.deep.equal(expectedOptions); }); - const testsForJustMyCode = [ - { - justMyCode: false, - debugStdLib: true, - expectedResult: false, - }, - { - justMyCode: false, - debugStdLib: false, - expectedResult: false, - }, - { - justMyCode: false, - debugStdLib: undefined, - expectedResult: false, - }, - { - justMyCode: true, - debugStdLib: false, - expectedResult: true, - }, - { - justMyCode: true, - debugStdLib: true, - expectedResult: true, - }, - { - justMyCode: true, - debugStdLib: undefined, - expectedResult: true, - }, - { - justMyCode: undefined, - debugStdLib: false, - expectedResult: true, - }, - { - justMyCode: undefined, - debugStdLib: true, - expectedResult: false, - }, - { - justMyCode: undefined, - debugStdLib: undefined, - expectedResult: true, - }, - ]; - test('Ensure justMyCode property is correctly derived from debugStdLib', async () => { - const pythonPath = `PythonPath_${new Date().toString()}`; - const workspaceFolder = createMoqWorkspaceFolder(__dirname); - const pythonFile = 'xyz.py'; - setupIoc(pythonPath); - setupActiveEditor(pythonFile, PYTHON_LANGUAGE); - testsForJustMyCode.forEach(async (testParams) => { - const debugConfig = await resolveDebugConfiguration(workspaceFolder, { - ...launch, - debugStdLib: testParams.debugStdLib, - justMyCode: testParams.justMyCode, - }); - expect(debugConfig).to.have.property('justMyCode', testParams.expectedResult); - }); - }); - const testsForRedirectOutput = [ { console: 'internalConsole', diff --git a/src/test/testing/common/debugLauncher.unit.test.ts b/src/test/testing/common/debugLauncher.unit.test.ts index ef3e678c13f7..31ba761eb946 100644 --- a/src/test/testing/common/debugLauncher.unit.test.ts +++ b/src/test/testing/common/debugLauncher.unit.test.ts @@ -234,13 +234,6 @@ suite('Unit Tests - Debug Launcher', () => { } expected.workspaceFolder = workspaceFolders[0].uri.fsPath; expected.debugOptions = []; - if (expected.justMyCode === undefined) { - // Populate justMyCode using debugStdLib - expected.justMyCode = !expected.debugStdLib; - } - if (!expected.justMyCode) { - expected.debugOptions.push(DebugOptions.DebugStdLib); - } if (expected.stopOnEntry) { expected.debugOptions.push(DebugOptions.StopOnEntry); } @@ -379,7 +372,6 @@ suite('Unit Tests - Debug Launcher', () => { envFile: 'some/dir/.env', redirectOutput: false, debugStdLib: true, - justMyCode: false, // added by LaunchConfigurationResolver: internalConsoleOptions: 'neverOpen', subProcess: true, @@ -399,7 +391,6 @@ suite('Unit Tests - Debug Launcher', () => { envFile: expected.envFile, redirectOutput: expected.redirectOutput, debugStdLib: expected.debugStdLib, - justMyCode: undefined, }, ]); From 8c18f744f12850fcb5b1d878943143ae2df851c4 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Mon, 15 Jul 2024 14:07:21 -0700 Subject: [PATCH 022/149] add backwards compatibility for pytest hook wrapper (#23781) fixes https://github.com/microsoft/vscode-python/issues/23780 --- python_files/vscode_pytest/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python_files/vscode_pytest/__init__.py b/python_files/vscode_pytest/__init__.py index c3be7e53d1b6..656846513c93 100644 --- a/python_files/vscode_pytest/__init__.py +++ b/python_files/vscode_pytest/__init__.py @@ -888,7 +888,7 @@ def send_post_request( class DeferPlugin: - @pytest.hookimpl(wrapper=True) + @pytest.hookimpl(hookwrapper=True) def pytest_xdist_auto_num_workers(self, config: pytest.Config) -> Generator[None, int, int]: """Determine how many workers to use based on how many tests were selected in the test explorer.""" return min((yield), len(config.option.file_or_dir)) From 33f423c9ab422fade4077f0dea7329700e9443a2 Mon Sep 17 00:00:00 2001 From: Paula Date: Tue, 16 Jul 2024 13:16:57 -0700 Subject: [PATCH 023/149] Read launch from devcontainer (#23817) Closed: https://github.com/microsoft/vscode-python-debugger/issues/354 --- .../extension/configuration/launch.json/launchJsonReader.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts b/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts index 1d76e3b8cd26..ed326b585741 100644 --- a/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts +++ b/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts @@ -12,11 +12,11 @@ export async function getConfigurationsForWorkspace(workspace: WorkspaceFolder): const filename = path.join(workspace.uri.fsPath, '.vscode', 'launch.json'); if (!(await fs.pathExists(filename))) { // Check launch config in the workspace file - const codeWorkspaceConfig = getConfiguration('launch'); + const codeWorkspaceConfig = getConfiguration('launch', workspace); if (!codeWorkspaceConfig.configurations || !Array.isArray(codeWorkspaceConfig.configurations)) { return []; } - traceLog(`Using launch configuration in workspace folder.`); + traceLog(`Using launch configuration in workspace folder2.`, codeWorkspaceConfig.configurations); return codeWorkspaceConfig.configurations; } From 5d8f5141e8937151b9981520e01266a21452c376 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Wed, 17 Jul 2024 19:14:32 +1000 Subject: [PATCH 024/149] Add some more telemetry for missing conda envs (#23825) --- .../locators/common/nativePythonFinder.ts | 6 + .../composite/envsCollectionService.ts | 558 ++++++++++-------- src/client/telemetry/index.ts | 31 +- .../envsCollectionService.unit.test.ts | 4 + 4 files changed, 355 insertions(+), 244 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index 1392886da7cc..0905540fd50f 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -62,6 +62,7 @@ export interface NativeGlobalPythonFinder extends Disposable { refresh(): AsyncIterable; categoryToKind(category?: string): PythonEnvKind; getCondaInfo(): Promise; + find(searchPath: string): Promise; } interface NativeLog { @@ -376,6 +377,10 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba async getCondaInfo(): Promise { return this.connection.sendRequest('condaInfo'); } + + public async find(searchPath: string): Promise { + return this.connection.sendRequest('find', { searchPath }); + } } type ConfigurationOptions = { @@ -387,6 +392,7 @@ type ConfigurationOptions = { environmentDirectories: string[]; condaExecutable: string | undefined; poetryExecutable: string | undefined; + cacheDirectory?: string; }; /** * Gets all custom virtual environment locations to look for environments. diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index 85b852cc32d0..4d6805a4609e 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -9,7 +9,7 @@ import { StopWatch } from '../../../../common/utils/stopWatch'; import { traceError, traceInfo, traceVerbose } from '../../../../logging'; import { sendTelemetryEvent } from '../../../../telemetry'; import { EventName } from '../../../../telemetry/constants'; -import { normalizePath } from '../../../common/externalDependencies'; +import { normalizePath, readFile } from '../../../common/externalDependencies'; import { PythonEnvInfo, PythonEnvKind } from '../../info'; import { getEnvPath } from '../../info/env'; import { @@ -25,17 +25,17 @@ import { import { getQueryFilter } from '../../locatorUtils'; import { PythonEnvCollectionChangedEvent, PythonEnvsWatcher } from '../../watcher'; import { IEnvsCollectionCache } from './envsCollectionCache'; -import { createNativeGlobalPythonFinder, NativeEnvInfo } from '../common/nativePythonFinder'; +import { + createNativeGlobalPythonFinder, + NativeEnvInfo, + NativeGlobalPythonFinder as NativePythonFinder, +} from '../common/nativePythonFinder'; import { pathExists } from '../../../../common/platform/fs-paths'; import { noop } from '../../../../common/utils/misc'; import { parseVersion } from '../../info/pythonVersion'; -import { - Conda, - CONDAPATH_SETTING_KEY, - getCondaEnvironmentsTxt, - isCondaEnvironment, -} from '../../../common/environmentManagers/conda'; +import { Conda, CONDAPATH_SETTING_KEY, isCondaEnvironment } from '../../../common/environmentManagers/conda'; import { getConfiguration } from '../../../../common/vscodeApis/workspaceApis'; +import { getUserHomeDir } from '../../../../common/utils/platform'; /** * A service which maintains the collection of known environments. @@ -294,7 +294,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher(); const nativeStopWatch = new StopWatch(); for await (const data of this.nativeFinder.refresh()) { @@ -315,7 +315,6 @@ export class EnvsCollectionService extends PythonEnvsWatcher(CONDAPATH_SETTING_KEY) || '').trim()) - .toLowerCase(); - const condaTelemetry: CondaTelemetry = { - condaEnvsInEnvDir: 0, - condaInfoEnvs: 0, - prefixNotExistsCondaEnvs: 0, - condaEnvsWithoutPrefix: 0, - nativeCondaEnvsInEnvDir: 0, - userProvidedCondaExe: userProvidedCondaExe.length > 0, - condaInfoEnvsInvalid: 0, - invalidCondaEnvs: 0, - condaInfoEnvsDuplicate: 0, - condaInfoEnvsInvalidPrefix: 0, - condaInfoEnvsDirs: 0, - nativeCondaRcsNotFound: 0, - nativeCondaEnvDirsNotFound: 0, - nativeCondaEnvDirsNotFoundHasEnvs: 0, - nativeCondaEnvDirsNotFoundHasEnvsInTxt: 0, - nativeCondaEnvsFromTxt: 0, - }; - - // Get conda telemetry - { - const [info, nativeCondaInfo, condaEnvsInEnvironmentsTxt, envTxt] = await Promise.all([ - Conda.getConda() - .catch((ex) => traceError('Failed to get conda info', ex)) - .then((conda) => conda?.getInfo()), - this.nativeFinder - .getCondaInfo() - .catch((ex) => traceError(`Failed to get conda info from native locator`, ex)), - getCondaEnvironmentsTxt() - .then(async (items) => { - const validEnvs = new Set(); - await Promise.all( - items.map(async (e) => { - if ((await pathExists(e)) && (await isCondaEnvironment(e))) { - validEnvs.add(fsPath.normalize(e).toLowerCase()); - } - }), - ); - return Array.from(validEnvs); - }) - .catch((ex) => traceError(`Failed to get conda envs from environments.txt`, ex)) - .then((items) => items || []), - getCondaEnvironmentsTxt().catch(noop), - ]); - - const environmentsTxt = - Array.isArray(envTxt) && envTxt.length ? fsPath.normalize(envTxt[0]).toLowerCase() : undefined; - if (nativeCondaInfo) { - condaTelemetry.nativeCanSpawnConda = nativeCondaInfo.canSpawnConda; - condaTelemetry.nativeCondaInfoEnvsDirs = new Set(nativeCondaInfo.envDirs).size; - condaTelemetry.nativeCondaRcs = new Set(nativeCondaInfo.condaRcs).size; - condaTelemetry.userProvidedEnvFound = nativeCondaInfo.userProvidedEnvFound; - - const nativeEnvTxt = fsPath.normalize(nativeCondaInfo.environmentsTxt || '').toLowerCase(); - condaTelemetry.nativeCondaEnvTxtExists = nativeCondaInfo.environmentsTxtExists === true; - condaTelemetry.nativeCondaEnvsFromTxt = (nativeCondaInfo.environmentsFromTxt || []).length; - condaTelemetry.nativeCondaEnvTxtSame = nativeEnvTxt === environmentsTxt; - } - condaTelemetry.condaEnvsInTxt = condaEnvsInEnvironmentsTxt.length; - condaTelemetry.canSpawnConda = !!info; - - // Conda info rcs - const condaRcFiles = new Set(); - await Promise.all( - // eslint-disable-next-line camelcase - [info?.rc_path, info?.user_rc_path, info?.sys_rc_path, ...(info?.config_files || [])].map( - async (rc) => { - if (rc && (await pathExists(rc))) { - condaRcFiles.add(fsPath.normalize(rc).toLowerCase()); - } - }, - ), - ).catch(noop); - const condaRcs = Array.from(condaRcFiles); - condaTelemetry.condaRcs = condaRcs.length; - - // Find the condarcs that were not found by native finder. - const nativeCondaRcs = (nativeCondaInfo?.condaRcs || []).map((rc) => fsPath.normalize(rc).toLowerCase()); - condaTelemetry.nativeCondaRcsNotFound = condaRcs.filter((rc) => !nativeCondaRcs.includes(rc)).length; - - // Conda info envs - const validCondaInfoEnvs = new Set(); - const duplicate = new Set(); - // Duplicate, invalid conda environments. - await Promise.all( - (info?.envs || []).map(async (e) => { - if (duplicate.has(e)) { - condaTelemetry.condaInfoEnvsDuplicate += 1; - return; - } - duplicate.add(e); - if (!(await pathExists(e))) { - condaTelemetry.condaInfoEnvsInvalidPrefix += 1; - return; - } - if (!(await isCondaEnvironment(e))) { - condaTelemetry.condaInfoEnvsInvalid += 1; - return; - } - validCondaInfoEnvs.add(fsPath.normalize(e).toLowerCase()); - }), - ); - const condaInfoEnvs = Array.from(validCondaInfoEnvs); - condaTelemetry.condaInfoEnvs = validCondaInfoEnvs.size; - - // Conda env_dirs - const validEnvDirs = new Set(); - await Promise.all( - // eslint-disable-next-line camelcase - (info?.envs_dirs || []).map(async (e) => { - if (await pathExists(e)) { - validEnvDirs.add(e); - } - }), - ); - condaTelemetry.condaInfoEnvsDirs = validEnvDirs.size; - envsDirs = Array.from(validEnvDirs).map((e) => fsPath.normalize(e).toLowerCase()); - - const nativeCondaEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Conda, - ); - - // Find the env_dirs that were not found by native finder. - const nativeCondaEnvDirs = (nativeCondaInfo?.envDirs || []).map((envDir) => - fsPath.normalize(envDir).toLowerCase(), - ); - const nativeCondaEnvPrefix = nativeCondaEnvs - .filter((e) => e.prefix) - .map((e) => fsPath.normalize(e.prefix || '').toLowerCase()); - - envsDirs.forEach((envDir) => { - if ( - !nativeCondaEnvDirs.includes(envDir) && - !nativeCondaEnvDirs.includes(fsPath.join(envDir, 'envs')) && - // If we have a native conda env from this env dir, then we're good. - !nativeCondaEnvPrefix.some((prefix) => prefix.startsWith(envDir)) - ) { - condaTelemetry.nativeCondaEnvDirsNotFound += 1; - - // Find what conda envs returned by `conda info` belong to this envdir folder. - // And find which of those envs do not exist in native conda envs - condaInfoEnvs.forEach((env) => { - if (env.startsWith(envDir)) { - condaTelemetry.nativeCondaEnvDirsNotFoundHasEnvs += 1; - - // Check if this env was in the environments.txt file. - if (condaEnvsInEnvironmentsTxt.includes(env)) { - condaTelemetry.nativeCondaEnvDirsNotFoundHasEnvsInTxt += 1; - } - } - }); - } - }); - - // How many envs are in environments.txt that were not found by native locator. - missingEnvironments.missingNativeCondaEnvsFromTxt = condaEnvsInEnvironmentsTxt.filter( - (env) => !nativeCondaEnvPrefix.some((prefix) => prefix === env), - ).length; - - // How many envs found by native locator & conda info are in the env dirs. - condaTelemetry.condaEnvsInEnvDir = condaInfoEnvs.filter((e) => - envsDirs.some((d) => e.startsWith(d)), - ).length; - condaTelemetry.nativeCondaEnvsInEnvDir = nativeCondaEnvs.filter((e) => - nativeCondaEnvDirs.some((d) => (e.prefix || '').startsWith(d)), - ).length; - - // Check if we have found the conda env that matches the `root_prefix` in the conda info. - // eslint-disable-next-line camelcase - let rootPrefix = info?.root_prefix || ''; - if (rootPrefix && (await pathExists(rootPrefix)) && (await isCondaEnvironment(rootPrefix))) { - rootPrefix = fsPath.normalize(rootPrefix).toLowerCase(); - condaTelemetry.condaRootPrefixInCondaExePath = userProvidedCondaExe.startsWith(rootPrefix); - // Check if we have a conda env that matches this prefix but not found in native envs. - condaTelemetry.condaRootPrefixFoundInInfoNotInNative = - condaInfoEnvs.some((env) => env === rootPrefix) && - !nativeCondaEnvs.some((e) => fsPath.normalize(e.prefix || '').toLowerCase() === rootPrefix); - } - - // eslint-disable-next-line camelcase - let defaultPrefix = info?.default_prefix || ''; - if (defaultPrefix && (await pathExists(defaultPrefix)) && (await isCondaEnvironment(defaultPrefix))) { - defaultPrefix = fsPath.normalize(defaultPrefix).toLowerCase(); - condaTelemetry.condaDefaultPrefixInCondaExePath = userProvidedCondaExe.startsWith(defaultPrefix); - // Check if we have a conda env that matches this prefix but not found in native envs. - condaTelemetry.condaDefaultPrefixFoundInInfoNotInNative = - condaInfoEnvs.some((env) => env === defaultPrefix) && - !nativeCondaEnvs.some((e) => fsPath.normalize(e.prefix || '').toLowerCase() === defaultPrefix); - } - } - + const nativeCondaEnvs = nativeEnvs.filter( + (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Conda, + ); + const condaTelemetry = await getCondaTelemetry(this.nativeFinder, nativeCondaEnvs, nativeEnvs); const prefixesSeenAlready = new Set(); await Promise.all( envs.map(async (env) => { @@ -702,9 +477,6 @@ export class EnvsCollectionService extends PythonEnvsWatcher e.executable === undefined).length; - const nativeCondaEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Conda, - ).length; const nativeCustomEnvs = nativeEnvs.filter( (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Custom, ).length; @@ -750,7 +522,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher { + const homeDir = getUserHomeDir(); + if (!homeDir) { + return undefined; + } + return fsPath.join(homeDir, '.conda', 'environments.txt'); +} + +async function getCondaTelemetry( + nativeFinder: NativePythonFinder, + nativeCondaEnvs: NativeEnvInfo[], + nativeEnvs: NativeEnvInfo[], +): Promise { + let envsDirs: string[] = []; + const userProvidedCondaExe = fsPath.normalize( + (getConfiguration('python').get(CONDAPATH_SETTING_KEY) || '').trim(), + ); + + const condaTelemetry: CondaTelemetry = { + condaEnvsInEnvDir: 0, + condaInfoEnvs: 0, + prefixNotExistsCondaEnvs: 0, + condaEnvsWithoutPrefix: 0, + nativeCondaEnvsInEnvDir: 0, + userProvidedCondaExe: userProvidedCondaExe.length > 0, + condaInfoEnvsInvalid: 0, + invalidCondaEnvs: 0, + condaInfoEnvsDuplicate: 0, + condaInfoEnvsInvalidPrefix: 0, + condaInfoEnvsDirs: 0, + nativeCondaRcsNotFound: 0, + nativeCondaEnvDirsNotFound: 0, + nativeCondaEnvDirsNotFoundHasEnvs: 0, + nativeCondaEnvDirsNotFoundHasEnvsInTxt: 0, + nativeCondaEnvsFromTxt: 0, + missingNativeCondaEnvsFromTxt: 0, + }; + + const [info, nativeCondaInfo, condaEnvsInEnvironmentsTxt, environmentsTxt] = await Promise.all([ + Conda.getConda() + .catch((ex) => traceError('Failed to get conda info', ex)) + .then((conda) => conda?.getInfo()), + nativeFinder.getCondaInfo().catch((ex) => traceError(`Failed to get conda info from native locator`, ex)), + getCondaEnvironmentsTxt() + .then(async (txtFile) => { + if (!txtFile) { + return []; + } + const envs: string[] = []; + const lines = await readFile(txtFile) + .catch(() => '') + .then((c) => c.splitLines({ trim: true, removeEmptyEntries: true })); + + await Promise.all( + lines.map(async (line) => { + if ((await pathExists(line)) && (await isCondaEnvironment(line))) { + envs.push(line); + } + }), + ); + return envs; + }) + .catch((ex) => traceError(`Failed to get conda envs from environments.txt`, ex)) + .then((items) => items || []), + getCondaEnvironmentsTxt().catch(noop), + ]); + + if (nativeCondaInfo) { + condaTelemetry.nativeCanSpawnConda = nativeCondaInfo.canSpawnConda; + condaTelemetry.nativeCondaInfoEnvsDirs = new Set(nativeCondaInfo.envDirs).size; + condaTelemetry.nativeCondaRcs = new Set(nativeCondaInfo.condaRcs).size; + condaTelemetry.userProvidedEnvFound = nativeCondaInfo.userProvidedEnvFound; + + const nativeEnvTxt = fsPath.normalize(nativeCondaInfo.environmentsTxt || ''); + condaTelemetry.nativeCondaEnvTxtExists = nativeCondaInfo.environmentsTxtExists === true; + condaTelemetry.nativeCondaEnvsFromTxt = (nativeCondaInfo.environmentsFromTxt || []).length; + condaTelemetry.nativeCondaEnvTxtSame = nativeEnvTxt === environmentsTxt; + } + condaTelemetry.condaEnvsInTxt = condaEnvsInEnvironmentsTxt.length; + condaTelemetry.canSpawnConda = !!info; + + // Conda info rcs + const condaRcFiles = new Set(); + await Promise.all( + // eslint-disable-next-line camelcase + [info?.rc_path, info?.user_rc_path, info?.sys_rc_path, ...(info?.config_files || [])].map(async (rc) => { + if (rc && (await pathExists(rc))) { + condaRcFiles.add(fsPath.normalize(rc)); + } + }), + ).catch(noop); + const condaRcs = Array.from(condaRcFiles); + condaTelemetry.condaRcs = condaRcs.length; + + // Find the condarcs that were not found by native finder. + const nativeCondaRcs = (nativeCondaInfo?.condaRcs || []).map((rc) => fsPath.normalize(rc)); + condaTelemetry.nativeCondaRcsNotFound = condaRcs.filter((rc) => !nativeCondaRcs.includes(rc)).length; + + // Conda info envs + const validCondaInfoEnvs = new Set(); + const duplicate = new Set(); + // Duplicate, invalid conda environments. + await Promise.all( + (info?.envs || []).map(async (e) => { + if (duplicate.has(e)) { + condaTelemetry.condaInfoEnvsDuplicate += 1; + return; + } + duplicate.add(e); + if (!(await pathExists(e))) { + condaTelemetry.condaInfoEnvsInvalidPrefix += 1; + return; + } + if (!(await isCondaEnvironment(e))) { + condaTelemetry.condaInfoEnvsInvalid += 1; + return; + } + validCondaInfoEnvs.add(fsPath.normalize(e)); + }), + ); + const condaInfoEnvs = Array.from(validCondaInfoEnvs); + condaTelemetry.condaInfoEnvs = validCondaInfoEnvs.size; + + // Conda env_dirs + const validEnvDirs = new Set(); + await Promise.all( + // eslint-disable-next-line camelcase + (info?.envs_dirs || []).map(async (e) => { + if (await pathExists(e)) { + validEnvDirs.add(fsPath.normalize(e)); + } + }), + ); + condaTelemetry.condaInfoEnvsDirs = validEnvDirs.size; + envsDirs = Array.from(validEnvDirs); + + // Find the env_dirs that were not found by native finder. + const nativeCondaEnvDirs = (nativeCondaInfo?.envDirs || []).map((envDir) => fsPath.normalize(envDir)); + const nativeCondaEnvPrefix = nativeCondaEnvs.filter((e) => e.prefix).map((e) => fsPath.normalize(e.prefix || '')); + + envsDirs.forEach((envDir) => { + if ( + !nativeCondaEnvDirs.includes(envDir) && + !nativeCondaEnvDirs.includes(fsPath.join(envDir, 'envs')) && + // If we have a native conda env from this env dir, then we're good. + !nativeCondaEnvPrefix.some((prefix) => prefix.startsWith(envDir)) + ) { + condaTelemetry.nativeCondaEnvDirsNotFound += 1; + + // Find what conda envs returned by `conda info` belong to this envdir folder. + // And find which of those envs do not exist in native conda envs + condaInfoEnvs.forEach((env) => { + if (env.startsWith(envDir)) { + condaTelemetry.nativeCondaEnvDirsNotFoundHasEnvs += 1; + + // Check if this env was in the environments.txt file. + if (condaEnvsInEnvironmentsTxt.includes(env)) { + condaTelemetry.nativeCondaEnvDirsNotFoundHasEnvsInTxt += 1; + } + } + }); + } + }); + + // How many envs are in environments.txt that were not found by native locator. + condaTelemetry.missingNativeCondaEnvsFromTxt = condaEnvsInEnvironmentsTxt.filter( + (env) => !nativeCondaEnvPrefix.some((prefix) => prefix === env), + ).length; + + // How many envs found by native locator & conda info are in the env dirs. + condaTelemetry.condaEnvsInEnvDir = condaInfoEnvs.filter((e) => envsDirs.some((d) => e.startsWith(d))).length; + condaTelemetry.nativeCondaEnvsInEnvDir = nativeCondaEnvs.filter((e) => + nativeCondaEnvDirs.some((d) => (e.prefix || '').startsWith(d)), + ).length; + + // Check if we have found the conda env that matches the `root_prefix` in the conda info. + // eslint-disable-next-line camelcase + let rootPrefix = info?.root_prefix || ''; + if (rootPrefix && (await pathExists(rootPrefix)) && (await isCondaEnvironment(rootPrefix))) { + rootPrefix = fsPath.normalize(rootPrefix); + condaTelemetry.condaRootPrefixInCondaExePath = userProvidedCondaExe + .toLowerCase() + .startsWith(rootPrefix.toLowerCase()); + // Check if we have a conda env that matches this prefix but not found in native envs. + condaTelemetry.condaRootPrefixFoundInInfoNotInNative = + condaInfoEnvs.some((env) => env.toLowerCase() === rootPrefix.toLowerCase()) && + !nativeCondaEnvs.some((e) => fsPath.normalize(e.prefix || '').toLowerCase() === rootPrefix.toLowerCase()); + condaTelemetry.condaRootPrefixFoundInTxt = condaEnvsInEnvironmentsTxt.some( + (e) => e.toLowerCase() === rootPrefix.toLowerCase(), + ); + + if (condaTelemetry.condaRootPrefixFoundInInfoNotInNative) { + // Verify we are able to discover this environment as a conda env using native finder. + const rootPrefixEnvs = await nativeFinder.find(rootPrefix); + // Did we find an env with the same prefix? + const rootPrefixEnv = rootPrefixEnvs.find( + (e) => fsPath.normalize(e.prefix || '').toLowerCase() === rootPrefix.toLowerCase(), + ); + condaTelemetry.condaRootPrefixEnvsAfterFind = rootPrefixEnvs.length; + condaTelemetry.condaRootPrefixFoundInInfoAfterFind = !!rootPrefixEnv; + condaTelemetry.condaRootPrefixFoundInInfoAfterFindKind = rootPrefixEnv?.kind; + condaTelemetry.condaRootPrefixFoundAsAnotherKind = nativeEnvs.find( + (e) => fsPath.normalize(e.prefix || '').toLowerCase() === rootPrefix.toLowerCase(), + )?.kind; + condaTelemetry.condaRootPrefixFoundAsPrefixOfAnother = nativeEnvs.find((e) => + fsPath + .normalize(e.prefix || '') + .toLowerCase() + .startsWith(rootPrefix.toLowerCase()), + )?.kind; + } + } + + // eslint-disable-next-line camelcase + let defaultPrefix = info?.default_prefix || ''; + if (defaultPrefix && (await pathExists(defaultPrefix)) && (await isCondaEnvironment(defaultPrefix))) { + defaultPrefix = fsPath.normalize(defaultPrefix); + condaTelemetry.condaDefaultPrefixInCondaExePath = userProvidedCondaExe + .toLowerCase() + .startsWith(defaultPrefix.toLowerCase()); + // Check if we have a conda env that matches this prefix but not found in native envs. + condaTelemetry.condaDefaultPrefixFoundInInfoNotInNative = + condaInfoEnvs.some((env) => env.toLowerCase() === defaultPrefix.toLowerCase()) && + !nativeCondaEnvs.some( + (e) => fsPath.normalize(e.prefix || '').toLowerCase() === defaultPrefix.toLowerCase(), + ); + condaTelemetry.condaDefaultPrefixFoundInTxt = condaEnvsInEnvironmentsTxt.some( + (e) => e.toLowerCase() === rootPrefix.toLowerCase(), + ); + + if (condaTelemetry.condaDefaultPrefixFoundInInfoNotInNative) { + // Verify we are able to discover this environment as a conda env using native finder. + const defaultPrefixEnvs = await nativeFinder.find(defaultPrefix); + // Did we find an env with the same prefix? + const defaultPrefixEnv = defaultPrefixEnvs.find( + (e) => fsPath.normalize(e.prefix || '').toLowerCase() === defaultPrefix.toLowerCase(), + ); + condaTelemetry.condaDefaultPrefixEnvsAfterFind = defaultPrefixEnvs.length; + condaTelemetry.condaDefaultPrefixFoundInInfoAfterFind = !!defaultPrefixEnv; + condaTelemetry.condaDefaultPrefixFoundInInfoAfterFindKind = defaultPrefixEnv?.kind; + condaTelemetry.condaDefaultPrefixFoundAsAnotherKind = nativeEnvs.find( + (e) => fsPath.normalize(e.prefix || '').toLowerCase() === defaultPrefix.toLowerCase(), + )?.kind; + condaTelemetry.condaDefaultPrefixFoundAsPrefixOfAnother = nativeEnvs.find((e) => + fsPath + .normalize(e.prefix || '') + .toLowerCase() + .startsWith(defaultPrefix.toLowerCase()), + )?.kind; + } + } + + return condaTelemetry; +} diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index f4c108d7385d..f7283597b688 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -1168,10 +1168,22 @@ export interface IEventNamePropertyMapping { "nativeCanSpawnConda" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne"}, "userProvidedEnvFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, "condaRootPrefixFoundInInfoNotInNative" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaDefaultPrefixFoundAsAnotherKind" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaRootPrefixFoundAsPrefixOfAnother" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaDefaultPrefixFoundAsPrefixOfAnother" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaRootPrefixFoundInTxt" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaDefaultPrefixFoundInTxt" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaRootPrefixFoundInInfoAfterFind" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaRootPrefixFoundInInfoAfterFindKind" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaRootPrefixFoundAsAnotherKind" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, "condaRootPrefixInCondaExePath" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, "condaDefaultPrefixFoundInInfoNotInNative" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaDefaultPrefixFoundInInfoAfterFind" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaDefaultPrefixFoundInInfoAfterFindKind" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, "condaDefaultPrefixInCondaExePath" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, "userProvidedCondaExe" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }, + "condaRootPrefixEnvsAfterFind" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "condaDefaultPrefixEnvsAfterFind" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "activeStateEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "condaEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "customEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, @@ -1309,11 +1321,28 @@ export interface IEventNamePropertyMapping { * Global conda envs locations are returned by `conda info` in the `envs_dirs` setting. */ nativeCondaEnvsInEnvDir?: number; + condaRootPrefixEnvsAfterFind?: number; + condaDefaultPrefixEnvsAfterFind?: number; /** * A conda env found that matches the root_prefix returned by `conda info` * However a corresponding conda env not found by native locator. */ - condaRootPrefixFoundInInfoNotInNative?: boolean; + condaDefaultPrefixFoundInInfoAfterFind?: boolean; + condaRootPrefixFoundInTxt?: boolean; + condaDefaultPrefixFoundInTxt?: boolean; + condaDefaultPrefixFoundInInfoAfterFindKind?: string; + condaRootPrefixFoundAsAnotherKind?: string; + condaRootPrefixFoundAsPrefixOfAnother?: string; + condaDefaultPrefixFoundAsAnotherKind?: string; + condaDefaultPrefixFoundAsPrefixOfAnother?: string; + /** + * Whether we were able to identify the conda root prefix in the conda exe path as a conda env using `find` in native finder API. + */ + condaRootPrefixFoundInInfoAfterFind?: boolean; + /** + * Type of python env detected for the conda root prefix. + */ + condaRootPrefixFoundInInfoAfterFindKind?: string; /** * The conda root prefix is found in the conda exe path. */ diff --git a/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts b/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts index 9acd76a6913f..92978738373d 100644 --- a/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts +++ b/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts @@ -29,6 +29,10 @@ import { OSType, getOSType } from '../../../../common'; import * as nativeFinder from '../../../../../client/pythonEnvironments/base/locators/common/nativePythonFinder'; class MockNativePythonFinder implements nativeFinder.NativeGlobalPythonFinder { + find(_searchPath: string): Promise { + throw new Error('Method not implemented.'); + } + getCondaInfo(): Promise { throw new Error('Method not implemented.'); } From 193b929f7cb1d890dc79423bbab7ddaabcf4b54c Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Wed, 17 Jul 2024 11:39:35 -0700 Subject: [PATCH 025/149] Use Native Python Finder as the main locator (#23823) Closes https://github.com/microsoft/vscode-python/issues/23719 --------- Co-authored-by: Don Jayamanne --- src/client/environmentApi.ts | 7 +- .../interpreter/display/progressDisplay.ts | 2 + src/client/pythonEnvironments/base/locator.ts | 1 + .../locators/common/nativePythonFinder.ts | 23 +- .../composite/envsCollectionService.ts | 8 +- .../base/locators/lowLevel/nativeLocator.ts | 6 +- src/client/pythonEnvironments/index.ts | 18 + src/client/pythonEnvironments/nativeAPI.ts | 338 ++++++++++++++++++ .../envsCollectionService.unit.test.ts | 21 +- .../pythonEnvironments/nativeAPI.unit.test.ts | 286 +++++++++++++++ 10 files changed, 687 insertions(+), 23 deletions(-) create mode 100644 src/client/pythonEnvironments/nativeAPI.ts create mode 100644 src/test/pythonEnvironments/nativeAPI.unit.test.ts diff --git a/src/client/environmentApi.ts b/src/client/environmentApi.ts index 5b77ecde1a9d..6c4b5cf94d92 100644 --- a/src/client/environmentApi.ts +++ b/src/client/environmentApi.ts @@ -9,7 +9,7 @@ import { Architecture } from './common/utils/platform'; import { IServiceContainer } from './ioc/types'; import { PythonEnvInfo, PythonEnvKind, PythonEnvType } from './pythonEnvironments/base/info'; import { getEnvPath } from './pythonEnvironments/base/info/env'; -import { IDiscoveryAPI } from './pythonEnvironments/base/locator'; +import { IDiscoveryAPI, ProgressReportStage } from './pythonEnvironments/base/locator'; import { IPythonExecutionFactory } from './common/process/types'; import { traceError, traceVerbose } from './logging'; import { isParentPath, normCasePath } from './common/platform/fs-paths'; @@ -147,6 +147,11 @@ export function buildEnvironmentApi( .ignoreErrors(); } disposables.push( + discoveryApi.onProgress((e) => { + if (e.stage === ProgressReportStage.discoveryFinished) { + knownCache = initKnownCache(); + } + }), discoveryApi.onChanged((e) => { const env = e.new ?? e.old; if (!env || !filterUsingVSCodeContext(env)) { diff --git a/src/client/interpreter/display/progressDisplay.ts b/src/client/interpreter/display/progressDisplay.ts index 5194dd8a5103..d9e85b4caf44 100644 --- a/src/client/interpreter/display/progressDisplay.ts +++ b/src/client/interpreter/display/progressDisplay.ts @@ -39,6 +39,8 @@ export class InterpreterLocatorProgressStatubarHandler implements IExtensionSing if (refreshPromise) { refreshPromise.then(() => this.hideProgress()); } + } else if (event.stage === ProgressReportStage.discoveryFinished) { + this.hideProgress(); } }, this, diff --git a/src/client/pythonEnvironments/base/locator.ts b/src/client/pythonEnvironments/base/locator.ts index da73735cb323..0c7307f32471 100644 --- a/src/client/pythonEnvironments/base/locator.ts +++ b/src/client/pythonEnvironments/base/locator.ts @@ -68,6 +68,7 @@ export interface IPythonEnvsIterator extends IAsyncIterableIt } export enum ProgressReportStage { + idle = 'idle', discoveryStarted = 'discoveryStarted', allPathsDiscovered = 'allPathsDiscovered', discoveryFinished = 'discoveryFinished', diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index 0905540fd50f..6e83742c27b3 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import { Disposable, EventEmitter, Event, Uri } from 'vscode'; +import { Disposable, EventEmitter, Event, Uri, LogOutputChannel } from 'vscode'; import * as ch from 'child_process'; import * as path from 'path'; import * as rpc from 'vscode-jsonrpc/node'; @@ -29,7 +29,7 @@ export interface NativeEnvInfo { displayName?: string; name?: string; executable?: string; - kind: string; + kind?: string; version?: string; prefix?: string; manager?: NativeEnvManagerInfo; @@ -57,10 +57,11 @@ export type NativeCondaInfo = { environmentsFromTxt: string[]; }; -export interface NativeGlobalPythonFinder extends Disposable { +export interface NativePythonFinder extends Disposable { resolve(executable: string): Promise; refresh(): AsyncIterable; categoryToKind(category?: string): PythonEnvKind; + logger(): LogOutputChannel; getCondaInfo(): Promise; find(searchPath: string): Promise; } @@ -70,7 +71,7 @@ interface NativeLog { message: string; } -class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGlobalPythonFinder { +class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePythonFinder { private readonly connection: rpc.MessageConnection; private firstRefreshResults: undefined | (() => AsyncGenerator); @@ -172,6 +173,10 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba } } + logger(): LogOutputChannel { + return this.outputChannel; + } + refreshFirstTime() { const result = this.doRefresh(); const completed = createDeferredFrom(result.completed); @@ -304,7 +309,6 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba disposable.add( this.connection.onNotification('environment', (data: NativeEnvInfo) => { this.outputChannel.info(`Discovered env: ${data.executable || data.prefix}`); - this.outputChannel.trace(`Discovered env info:\n ${JSON.stringify(data, undefined, 4)}`); // We know that in the Python extension if either Version of Prefix is not provided by locator // Then we end up resolving the information. // Lets do that here, @@ -321,7 +325,6 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba }) .then((environment) => { this.outputChannel.info(`Resolved ${environment.executable}`); - this.outputChannel.trace(`Environment resolved:\n ${JSON.stringify(data, undefined, 4)}`); discovered.fire(environment); }) .catch((ex) => this.outputChannel.error(`Error in Resolving ${JSON.stringify(data)}`, ex)); @@ -419,6 +422,10 @@ function getPythonSettingAndUntildify(name: string, scope?: Uri): T | undefin return value; } -export function createNativeGlobalPythonFinder(): NativeGlobalPythonFinder { - return new NativeGlobalPythonFinderImpl(); +let _finder: NativePythonFinder | undefined; +export function getNativePythonFinder(): NativePythonFinder { + if (!_finder) { + _finder = new NativeGlobalPythonFinderImpl(); + } + return _finder; } diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index 4d6805a4609e..c1ac9304c388 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -25,11 +25,7 @@ import { import { getQueryFilter } from '../../locatorUtils'; import { PythonEnvCollectionChangedEvent, PythonEnvsWatcher } from '../../watcher'; import { IEnvsCollectionCache } from './envsCollectionCache'; -import { - createNativeGlobalPythonFinder, - NativeEnvInfo, - NativeGlobalPythonFinder as NativePythonFinder, -} from '../common/nativePythonFinder'; +import { getNativePythonFinder, NativeEnvInfo, NativePythonFinder } from '../common/nativePythonFinder'; import { pathExists } from '../../../../common/platform/fs-paths'; import { noop } from '../../../../common/utils/misc'; import { parseVersion } from '../../info/pythonVersion'; @@ -55,7 +51,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher(); - private nativeFinder = createNativeGlobalPythonFinder(); + private nativeFinder = getNativePythonFinder(); public refreshState = ProgressReportStage.discoveryFinished; diff --git a/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts b/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts index 27dd9828c229..8d17a3488e47 100644 --- a/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts +++ b/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts @@ -10,7 +10,7 @@ import { Conda } from '../../../common/environmentManagers/conda'; import { traceError } from '../../../../logging'; import type { KnownEnvironmentTools } from '../../../../api/types'; import { setPyEnvBinary } from '../../../common/environmentManagers/pyenv'; -import { NativeGlobalPythonFinder, createNativeGlobalPythonFinder } from '../common/nativePythonFinder'; +import { NativePythonFinder, getNativePythonFinder } from '../common/nativePythonFinder'; import { disposeAll } from '../../../../common/utils/resourceLifecycle'; import { Architecture } from '../../../../common/utils/platform'; @@ -54,11 +54,11 @@ export class NativeLocator implements ILocator, IDisposable { private readonly disposables: IDisposable[] = []; - private readonly finder: NativeGlobalPythonFinder; + private readonly finder: NativePythonFinder; constructor() { this.onChanged = this.onChangedEmitter.event; - this.finder = createNativeGlobalPythonFinder(); + this.finder = getNativePythonFinder(); this.disposables.push(this.onChangedEmitter, this.finder); } diff --git a/src/client/pythonEnvironments/index.ts b/src/client/pythonEnvironments/index.ts index 0bd766b4553d..91064bb67599 100644 --- a/src/client/pythonEnvironments/index.ts +++ b/src/client/pythonEnvironments/index.ts @@ -40,9 +40,17 @@ import { traceError } from '../logging'; import { ActiveStateLocator } from './base/locators/lowLevel/activeStateLocator'; import { CustomWorkspaceLocator } from './base/locators/lowLevel/customWorkspaceLocator'; import { PixiLocator } from './base/locators/lowLevel/pixiLocator'; +import { getConfiguration } from '../common/vscodeApis/workspaceApis'; +import { getNativePythonFinder } from './base/locators/common/nativePythonFinder'; +import { createNativeEnvironmentsApi } from './nativeAPI'; const PYTHON_ENV_INFO_CACHE_KEY = 'PYTHON_ENV_INFO_CACHEv2'; +export function shouldUseNativeLocator(): boolean { + const config = getConfiguration('python'); + return config.get('locator', 'js') === 'native'; +} + /** * Set up the Python environments component (during extension activation).' */ @@ -50,6 +58,16 @@ export async function initialize(ext: ExtensionState): Promise { // Set up the legacy IOC container before api is created. initializeLegacyExternalDependencies(ext.legacyIOC.serviceContainer); + if (shouldUseNativeLocator()) { + const finder = getNativePythonFinder(); + const api = createNativeEnvironmentsApi(finder); + registerNewDiscoveryForIOC( + // These are what get wrapped in the legacy adapter. + ext.legacyIOC.serviceManager, + api, + ); + return api; + } const api = await createPythonEnvironments(() => createLocator(ext)); registerNewDiscoveryForIOC( // These are what get wrapped in the legacy adapter. diff --git a/src/client/pythonEnvironments/nativeAPI.ts b/src/client/pythonEnvironments/nativeAPI.ts new file mode 100644 index 000000000000..dca9b17d4dc1 --- /dev/null +++ b/src/client/pythonEnvironments/nativeAPI.ts @@ -0,0 +1,338 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +import * as path from 'path'; +import { Disposable, Event, EventEmitter } from 'vscode'; +import { PythonEnvInfo, PythonEnvKind, PythonEnvType, PythonVersion } from './base/info'; +import { + GetRefreshEnvironmentsOptions, + IDiscoveryAPI, + ProgressNotificationEvent, + ProgressReportStage, + PythonLocatorQuery, + TriggerRefreshOptions, +} from './base/locator'; +import { PythonEnvCollectionChangedEvent } from './base/watcher'; +import { NativeEnvInfo, NativePythonFinder } from './base/locators/common/nativePythonFinder'; +import { createDeferred, Deferred } from '../common/utils/async'; +import { Architecture } from '../common/utils/platform'; +import { parseVersion } from './base/info/pythonVersion'; +import { cache } from '../common/utils/decorators'; +import { traceError, traceLog } from '../logging'; +import { StopWatch } from '../common/utils/stopWatch'; +import { FileChangeType } from '../common/platform/fileSystemWatcher'; + +function makeExecutablePath(prefix?: string): string { + if (!prefix) { + return process.platform === 'win32' ? 'python.exe' : 'python'; + } + return process.platform === 'win32' ? path.join(prefix, 'python.exe') : path.join(prefix, 'python'); +} + +function toArch(a: string | undefined): Architecture { + switch (a) { + case 'x86': + return Architecture.x86; + case 'x64': + return Architecture.x64; + default: + return Architecture.Unknown; + } +} + +function getLocation(nativeEnv: NativeEnvInfo): string { + if (nativeEnv.prefix) { + return nativeEnv.prefix; + } + if (nativeEnv.executable) { + return nativeEnv.executable; + } + // We should not get here: either prefix or executable should always be available + return ''; +} + +function kindToShortString(kind: PythonEnvKind): string | undefined { + switch (kind) { + case PythonEnvKind.Poetry: + return 'poetry'; + case PythonEnvKind.Pyenv: + return 'pyenv'; + case PythonEnvKind.VirtualEnv: + case PythonEnvKind.Venv: + case PythonEnvKind.VirtualEnvWrapper: + case PythonEnvKind.OtherVirtual: + return 'venv'; + case PythonEnvKind.Pipenv: + return 'pipenv'; + case PythonEnvKind.Conda: + return 'conda'; + case PythonEnvKind.ActiveState: + return 'active-state'; + case PythonEnvKind.MicrosoftStore: + return 'Microsoft Store'; + case PythonEnvKind.Hatch: + return 'hatch'; + case PythonEnvKind.Pixi: + return 'pixi'; + case PythonEnvKind.System: + case PythonEnvKind.Unknown: + case PythonEnvKind.OtherGlobal: + case PythonEnvKind.Custom: + default: + return undefined; + } +} + +function toShortVersionString(version: PythonVersion): string { + return `${version.major}.${version.minor}.${version.micro}`.trim(); +} + +function getDisplayName(version: PythonVersion, kind: PythonEnvKind, arch: Architecture, name?: string): string { + const versionStr = toShortVersionString(version); + const kindStr = kindToShortString(kind); + if (arch === Architecture.x86) { + if (kindStr) { + return name ? `Python ${versionStr} 32-bit ('${name}')` : `Python ${versionStr} 32-bit (${kindStr})`; + } + return name ? `Python ${versionStr} 32-bit ('${name}')` : `Python ${versionStr} 32-bit`; + } + if (kindStr) { + return name ? `Python ${versionStr} ('${name}')` : `Python ${versionStr} (${kindStr})`; + } + return name ? `Python ${versionStr} ('${name}')` : `Python ${versionStr}`; +} + +function validEnv(finder: NativePythonFinder, nativeEnv: NativeEnvInfo): boolean { + if (nativeEnv.prefix === undefined && nativeEnv.executable === undefined) { + finder.logger().error(`Invalid environment [native]: ${JSON.stringify(nativeEnv)}`); + return false; + } + return true; +} + +function getEnvType(kind: PythonEnvKind): PythonEnvType | undefined { + switch (kind) { + case PythonEnvKind.Poetry: + case PythonEnvKind.Pyenv: + case PythonEnvKind.VirtualEnv: + case PythonEnvKind.Venv: + case PythonEnvKind.VirtualEnvWrapper: + case PythonEnvKind.OtherVirtual: + case PythonEnvKind.Pipenv: + case PythonEnvKind.ActiveState: + case PythonEnvKind.Hatch: + case PythonEnvKind.Pixi: + return PythonEnvType.Virtual; + + case PythonEnvKind.Conda: + return PythonEnvType.Conda; + + case PythonEnvKind.System: + case PythonEnvKind.Unknown: + case PythonEnvKind.OtherGlobal: + case PythonEnvKind.Custom: + case PythonEnvKind.MicrosoftStore: + default: + return undefined; + } +} + +function getName(nativeEnv: NativeEnvInfo, kind: PythonEnvKind): string { + if (nativeEnv.name) { + return nativeEnv.name; + } + + const envType = getEnvType(kind); + if (nativeEnv.prefix && (envType === PythonEnvType.Conda || envType === PythonEnvType.Virtual)) { + return path.basename(nativeEnv.prefix); + } + return ''; +} + +function toPythonEnvInfo(finder: NativePythonFinder, nativeEnv: NativeEnvInfo): PythonEnvInfo | undefined { + if (!validEnv(finder, nativeEnv)) { + return undefined; + } + const kind = finder.categoryToKind(nativeEnv.kind); + const arch = toArch(nativeEnv.arch); + const version: PythonVersion = parseVersion(nativeEnv.version ?? ''); + const name = getName(nativeEnv, kind); + const displayName = nativeEnv.version + ? getDisplayName(version, kind, arch, name) + : nativeEnv.displayName ?? 'Python'; + + return { + name, + location: getLocation(nativeEnv), + kind, + executable: { + filename: nativeEnv.executable ?? makeExecutablePath(nativeEnv.prefix), + sysPrefix: nativeEnv.prefix ?? '', + ctime: -1, + mtime: -1, + }, + version: { + sysVersion: nativeEnv.version, + major: version.major, + minor: version.minor, + micro: version.micro, + }, + arch, + distro: { + org: '', + }, + source: [], + detailedDisplayName: displayName, + display: displayName, + type: getEnvType(kind), + }; +} + +class NativePythonEnvironments implements IDiscoveryAPI, Disposable { + private _onProgress: EventEmitter; + + private _onChanged: EventEmitter; + + private _refreshPromise?: Deferred; + + private _envs: PythonEnvInfo[] = []; + + constructor(private readonly finder: NativePythonFinder) { + this._onProgress = new EventEmitter(); + this._onChanged = new EventEmitter(); + this.onProgress = this._onProgress.event; + this.onChanged = this._onChanged.event; + this.refreshState = ProgressReportStage.idle; + } + + refreshState: ProgressReportStage; + + onProgress: Event; + + onChanged: Event; + + getRefreshPromise(_options?: GetRefreshEnvironmentsOptions): Promise | undefined { + return this._refreshPromise?.promise; + } + + triggerRefresh(_query?: PythonLocatorQuery, _options?: TriggerRefreshOptions): Promise { + const stopwatch = new StopWatch(); + traceLog('Native locator: Refresh started'); + if (this.refreshState === ProgressReportStage.discoveryStarted && this._refreshPromise?.promise) { + return this._refreshPromise?.promise; + } + + this.refreshState = ProgressReportStage.discoveryStarted; + this._onProgress.fire({ stage: this.refreshState }); + this._refreshPromise = createDeferred(); + + setImmediate(async () => { + try { + for await (const native of this.finder.refresh()) { + if (!validEnv(this.finder, native)) { + // eslint-disable-next-line no-continue + continue; + } + try { + const envPath = native.executable ?? native.prefix; + const version = native.version ? parseVersion(native.version) : undefined; + + if (this.finder.categoryToKind(native.kind) === PythonEnvKind.Conda && !native.executable) { + // This is a conda env without python, no point trying to resolve this. + // There is nothing to resolve + this.addEnv(native); + } else if ( + envPath && + (!version || version.major < 0 || version.minor < 0 || version.micro < 0) + ) { + // We have a path, but no version info, try to resolve the environment. + this.finder + .resolve(envPath) + .then((env) => { + if (env) { + this.addEnv(env); + } + }) + .ignoreErrors(); + } else if ( + envPath && + version && + version.major >= 0 && + version.minor >= 0 && + version.micro >= 0 + ) { + this.addEnv(native); + } else { + traceError(`Failed to process environment: ${JSON.stringify(native)}`); + } + } catch (err) { + traceError(`Failed to process environment: ${err}`); + } + } + this._refreshPromise?.resolve(); + } catch (error) { + this._refreshPromise?.reject(error); + } finally { + traceLog(`Native locator: Refresh finished in ${stopwatch.elapsedTime} ms`); + this.refreshState = ProgressReportStage.discoveryFinished; + this._refreshPromise = undefined; + this._onProgress.fire({ stage: this.refreshState }); + } + }); + + return this._refreshPromise?.promise; + } + + getEnvs(_query?: PythonLocatorQuery): PythonEnvInfo[] { + return this._envs; + } + + addEnv(native: NativeEnvInfo): void { + const info = toPythonEnvInfo(this.finder, native); + if (!info) { + return; + } + const old = this._envs.find((item) => item.executable.filename === info.executable.filename); + if (old) { + this._envs = this._envs.filter((item) => item.executable.filename !== info.executable.filename); + this._envs.push(info); + this._onChanged.fire({ type: FileChangeType.Changed, old, new: info }); + } else { + this._envs.push(info); + this._onChanged.fire({ type: FileChangeType.Created, new: info }); + } + } + + @cache(30_000, true) + async resolveEnv(envPath?: string): Promise { + if (envPath === undefined) { + return undefined; + } + const native = await this.finder.resolve(envPath); + if (native) { + const env = toPythonEnvInfo(this.finder, native); + if (env) { + const old = this._envs.find((item) => item.executable.filename === env.executable.filename); + if (old) { + this._envs = this._envs.filter((item) => item.executable.filename !== env.executable.filename); + this._envs.push(env); + this._onChanged.fire({ type: FileChangeType.Changed, old, new: env }); + } + } + + return env; + } + return undefined; + } + + dispose(): void { + this._onProgress.dispose(); + this._onChanged.dispose(); + } +} + +export function createNativeEnvironmentsApi(finder: NativePythonFinder): IDiscoveryAPI { + const native = new NativePythonEnvironments(finder); + native.triggerRefresh().ignoreErrors(); + return native; +} diff --git a/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts b/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts index 92978738373d..1f319f87d86b 100644 --- a/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts +++ b/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts @@ -7,7 +7,7 @@ import { assert, expect } from 'chai'; import { cloneDeep } from 'lodash'; import * as path from 'path'; import * as sinon from 'sinon'; -import { EventEmitter, Uri } from 'vscode'; +import { EventEmitter, LogOutputChannel, Uri } from 'vscode'; import { FileChangeType } from '../../../../../client/common/platform/fileSystemWatcher'; import { createDeferred, createDeferredFromPromise, sleep } from '../../../../../client/common/utils/async'; import { PythonEnvInfo, PythonEnvKind } from '../../../../../client/pythonEnvironments/base/info'; @@ -27,8 +27,15 @@ import { SimpleLocator } from '../../common'; import { assertEnvEqual, assertEnvsEqual, createFile, deleteFile } from '../envTestUtils'; import { OSType, getOSType } from '../../../../common'; import * as nativeFinder from '../../../../../client/pythonEnvironments/base/locators/common/nativePythonFinder'; +import { MockOutputChannel } from '../../../../mockClasses'; + +class MockNativePythonFinder implements nativeFinder.NativePythonFinder { + private output: LogOutputChannel; + + constructor() { + this.output = new MockOutputChannel('Python Locator'); + } -class MockNativePythonFinder implements nativeFinder.NativeGlobalPythonFinder { find(_searchPath: string): Promise { throw new Error('Method not implemented.'); } @@ -54,13 +61,17 @@ class MockNativePythonFinder implements nativeFinder.NativeGlobalPythonFinder { })(); } + logger(): LogOutputChannel { + return this.output; + } + dispose() { /** noop */ } } suite('Python envs locator - Environments Collection', async () => { - let createNativeGlobalPythonFinderStub: sinon.SinonStub; + let getNativePythonFinderStub: sinon.SinonStub; let collectionService: EnvsCollectionService; let storage: PythonEnvInfo[]; @@ -172,8 +183,8 @@ suite('Python envs locator - Environments Collection', async () => { } setup(async () => { - createNativeGlobalPythonFinderStub = sinon.stub(nativeFinder, 'createNativeGlobalPythonFinder'); - createNativeGlobalPythonFinderStub.returns(new MockNativePythonFinder()); + getNativePythonFinderStub = sinon.stub(nativeFinder, 'getNativePythonFinder'); + getNativePythonFinderStub.returns(new MockNativePythonFinder()); storage = []; const parentLocator = new SimpleLocator(getLocatorEnvs()); const cache = await createCollectionCache({ diff --git a/src/test/pythonEnvironments/nativeAPI.unit.test.ts b/src/test/pythonEnvironments/nativeAPI.unit.test.ts new file mode 100644 index 000000000000..a56b78b33f5b --- /dev/null +++ b/src/test/pythonEnvironments/nativeAPI.unit.test.ts @@ -0,0 +1,286 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +/* eslint-disable class-methods-use-this */ + +import { assert } from 'chai'; +import * as path from 'path'; +import * as typemoq from 'typemoq'; +import * as sinon from 'sinon'; +import * as nativeAPI from '../../client/pythonEnvironments/nativeAPI'; +import { IDiscoveryAPI } from '../../client/pythonEnvironments/base/locator'; +import { + NativeEnvInfo, + NativePythonFinder, +} from '../../client/pythonEnvironments/base/locators/common/nativePythonFinder'; +import { Architecture } from '../../client/common/utils/platform'; +import { PythonEnvInfo, PythonEnvKind, PythonEnvType } from '../../client/pythonEnvironments/base/info'; +import { isWindows } from '../../client/common/platform/platformService'; + +suite('Native Python API', () => { + let api: IDiscoveryAPI; + let mockFinder: typemoq.IMock; + + const basicEnv: NativeEnvInfo = { + displayName: 'Basic Python', + name: 'basic_python', + executable: '/usr/bin/python', + kind: 'system', + version: `3.12.0`, + prefix: '/usr/bin', + }; + + const basicEnv2: NativeEnvInfo = { + displayName: 'Basic Python', + name: 'basic_python', + executable: '/usr/bin/python', + kind: 'system', + version: undefined, // this is intentionally set to trigger resolve + prefix: '/usr/bin', + }; + + const expectedBasicEnv: PythonEnvInfo = { + arch: Architecture.Unknown, + detailedDisplayName: "Python 3.12.0 ('basic_python')", + display: "Python 3.12.0 ('basic_python')", + distro: { org: '' }, + executable: { filename: '/usr/bin/python', sysPrefix: '/usr/bin', ctime: -1, mtime: -1 }, + kind: PythonEnvKind.System, + location: '/usr/bin', + source: [], + name: 'basic_python', + type: undefined, + version: { sysVersion: '3.12.0', major: 3, minor: 12, micro: 0 }, + }; + + const conda: NativeEnvInfo = { + displayName: 'Conda Python', + name: 'conda_python', + executable: '/home/user/.conda/envs/conda_python/python', + kind: 'conda', + version: `3.12.0`, + prefix: '/home/user/.conda/envs/conda_python', + }; + + const conda1: NativeEnvInfo = { + displayName: 'Conda Python', + name: 'conda_python', + executable: '/home/user/.conda/envs/conda_python/python', + kind: 'conda', + version: undefined, // this is intentionally set to test conda without python + prefix: '/home/user/.conda/envs/conda_python', + }; + + const conda2: NativeEnvInfo = { + displayName: 'Conda Python', + name: 'conda_python', + executable: undefined, // this is intentionally set to test env with no executable + kind: 'conda', + version: undefined, // this is intentionally set to test conda without python + prefix: '/home/user/.conda/envs/conda_python', + }; + + const exePath = isWindows() + ? path.join('/home/user/.conda/envs/conda_python', 'python.exe') + : path.join('/home/user/.conda/envs/conda_python', 'python'); + + const expectedConda1: PythonEnvInfo = { + arch: Architecture.Unknown, + detailedDisplayName: "Python 3.12.0 ('conda_python')", + display: "Python 3.12.0 ('conda_python')", + distro: { org: '' }, + executable: { + filename: '/home/user/.conda/envs/conda_python/python', + sysPrefix: '/home/user/.conda/envs/conda_python', + ctime: -1, + mtime: -1, + }, + kind: PythonEnvKind.Conda, + location: '/home/user/.conda/envs/conda_python', + source: [], + name: 'conda_python', + type: PythonEnvType.Conda, + version: { sysVersion: '3.12.0', major: 3, minor: 12, micro: 0 }, + }; + + const expectedConda2: PythonEnvInfo = { + arch: Architecture.Unknown, + detailedDisplayName: 'Conda Python', + display: 'Conda Python', + distro: { org: '' }, + executable: { + filename: exePath, + sysPrefix: '/home/user/.conda/envs/conda_python', + ctime: -1, + mtime: -1, + }, + kind: PythonEnvKind.Conda, + location: '/home/user/.conda/envs/conda_python', + source: [], + name: 'conda_python', + type: PythonEnvType.Conda, + version: { sysVersion: undefined, major: -1, minor: -1, micro: -1 }, + }; + + setup(() => { + mockFinder = typemoq.Mock.ofType(); + + mockFinder + .setup((f) => f.categoryToKind(typemoq.It.isAny())) + .returns((category: string) => { + switch (category.toLowerCase()) { + case 'conda': + return PythonEnvKind.Conda; + case 'system': + case 'homebrew': + case 'macpythonorg': + case 'maccommandlinetools': + case 'macxcode': + case 'windowsregistry': + case 'linuxglobal': + return PythonEnvKind.System; + case 'globalpaths': + return PythonEnvKind.OtherGlobal; + case 'pyenv': + return PythonEnvKind.Pyenv; + case 'poetry': + return PythonEnvKind.Poetry; + case 'pipenv': + return PythonEnvKind.Pipenv; + case 'pyenvvirtualenv': + return PythonEnvKind.VirtualEnv; + case 'venv': + return PythonEnvKind.Venv; + case 'virtualenv': + return PythonEnvKind.VirtualEnv; + case 'virtualenvwrapper': + return PythonEnvKind.VirtualEnvWrapper; + case 'windowsstore': + return PythonEnvKind.MicrosoftStore; + default: { + return PythonEnvKind.Unknown; + } + } + }); + + api = nativeAPI.createNativeEnvironmentsApi(mockFinder.object); + }); + + teardown(() => { + sinon.restore(); + }); + + test('Trigger refresh without resolve', async () => { + mockFinder + .setup((f) => f.refresh()) + .returns(() => { + async function* generator() { + yield* [basicEnv]; + } + return generator(); + }) + .verifiable(typemoq.Times.once()); + + mockFinder.setup((f) => f.resolve(typemoq.It.isAny())).verifiable(typemoq.Times.never()); + + await api.triggerRefresh(); + const actual = api.getEnvs(); + assert.deepEqual(actual, [expectedBasicEnv]); + }); + + test('Trigger refresh with resolve', async () => { + mockFinder + .setup((f) => f.refresh()) + .returns(() => { + async function* generator() { + yield* [basicEnv2]; + } + return generator(); + }) + .verifiable(typemoq.Times.once()); + + mockFinder + .setup((f) => f.resolve(typemoq.It.isAny())) + .returns(() => Promise.resolve(basicEnv)) + .verifiable(typemoq.Times.once()); + + api.triggerRefresh(); + await api.getRefreshPromise(); + + const actual = api.getEnvs(); + assert.deepEqual(actual, [expectedBasicEnv]); + }); + + test('Trigger refresh and use refresh promise API', async () => { + mockFinder + .setup((f) => f.refresh()) + .returns(() => { + async function* generator() { + yield* [basicEnv]; + } + return generator(); + }) + .verifiable(typemoq.Times.once()); + + mockFinder.setup((f) => f.resolve(typemoq.It.isAny())).verifiable(typemoq.Times.never()); + + api.triggerRefresh(); + await api.getRefreshPromise(); + + const actual = api.getEnvs(); + assert.deepEqual(actual, [expectedBasicEnv]); + }); + + test('Conda environment with resolve', async () => { + mockFinder + .setup((f) => f.refresh()) + .returns(() => { + async function* generator() { + yield* [conda1]; + } + return generator(); + }) + .verifiable(typemoq.Times.once()); + mockFinder + .setup((f) => f.resolve(typemoq.It.isAny())) + .returns(() => Promise.resolve(conda)) + .verifiable(typemoq.Times.once()); + + await api.triggerRefresh(); + const actual = api.getEnvs(); + assert.deepEqual(actual, [expectedConda1]); + }); + + test('Conda environment with no python', async () => { + mockFinder + .setup((f) => f.refresh()) + .returns(() => { + async function* generator() { + yield* [conda2]; + } + return generator(); + }) + .verifiable(typemoq.Times.once()); + mockFinder.setup((f) => f.resolve(typemoq.It.isAny())).verifiable(typemoq.Times.never()); + + await api.triggerRefresh(); + const actual = api.getEnvs(); + assert.deepEqual(actual, [expectedConda2]); + }); + + test('Refresh promise undefined after refresh', async () => { + mockFinder + .setup((f) => f.refresh()) + .returns(() => { + async function* generator() { + yield* [basicEnv]; + } + return generator(); + }) + .verifiable(typemoq.Times.once()); + + mockFinder.setup((f) => f.resolve(typemoq.It.isAny())).verifiable(typemoq.Times.never()); + + await api.triggerRefresh(); + assert.isUndefined(api.getRefreshPromise()); + }); +}); From abe223f15edb6ba979b7809a45854119976a4472 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Thu, 18 Jul 2024 17:45:23 +1000 Subject: [PATCH 026/149] Updates to use new Python locator Api (#23832) --- src/client/common/utils/async.ts | 11 ++ .../locators/common/nativePythonFinder.ts | 164 ++++++++++++------ .../composite/envsCollectionService.ts | 45 +++-- .../base/locators/lowLevel/nativeLocator.ts | 62 +++---- src/client/pythonEnvironments/nativeAPI.ts | 10 +- .../envsCollectionService.unit.test.ts | 15 +- .../pythonEnvironments/nativeAPI.unit.test.ts | 48 +---- 7 files changed, 195 insertions(+), 160 deletions(-) diff --git a/src/client/common/utils/async.ts b/src/client/common/utils/async.ts index a99db8e94562..59ac6f64cdbf 100644 --- a/src/client/common/utils/async.ts +++ b/src/client/common/utils/async.ts @@ -232,6 +232,17 @@ export async function flattenIterator(iterator: IAsyncIterator): Promise(iterableItem: AsyncIterable): Promise { + const results: T[] = []; + for await (const item of iterableItem) { + results.push(item); + } + return results; +} + /** * Wait for a condition to be fulfilled within a timeout. * diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index 6e83742c27b3..9dc440a7a88f 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -18,6 +18,7 @@ import { getUserHomeDir } from '../../../../common/utils/platform'; import { createLogOutputChannel } from '../../../../common/vscodeApis/windowApis'; import { PythonEnvKind } from '../../info'; import { sendNativeTelemetry, NativePythonTelemetry } from './nativePythonTelemetry'; +import { traceError } from '../../../../logging'; const untildify = require('untildify'); @@ -29,7 +30,7 @@ export interface NativeEnvInfo { displayName?: string; name?: string; executable?: string; - kind?: string; + kind?: PythonEnvironmentKind; version?: string; prefix?: string; manager?: NativeEnvManagerInfo; @@ -41,12 +42,38 @@ export interface NativeEnvInfo { symlinks?: string[]; } +export enum PythonEnvironmentKind { + Conda = 'Conda', + Homebrew = 'Homebrew', + Pyenv = 'Pyenv', + GlobalPaths = 'GlobalPaths', + PyenvVirtualEnv = 'PyenvVirtualEnv', + Pipenv = 'Pipenv', + Poetry = 'Poetry', + MacPythonOrg = 'MacPythonOrg', + MacCommandLineTools = 'MacCommandLineTools', + LinuxGlobal = 'LinuxGlobal', + MacXCode = 'MacXCode', + Venv = 'Venv', + VirtualEnv = 'VirtualEnv', + VirtualEnvWrapper = 'VirtualEnvWrapper', + WindowsStore = 'WindowsStore', + WindowsRegistry = 'WindowsRegistry', +} + export interface NativeEnvManagerInfo { tool: string; executable: string; version?: string; } +export function isNativeInfoEnvironment(info: NativeEnvInfo | NativeEnvManagerInfo): info is NativeEnvInfo { + if ((info as NativeEnvManagerInfo).tool) { + return false; + } + return true; +} + export type NativeCondaInfo = { canSpawnConda: boolean; userProvidedEnvFound?: boolean; @@ -58,12 +85,62 @@ export type NativeCondaInfo = { }; export interface NativePythonFinder extends Disposable { + /** + * Refresh the list of python environments. + * Returns an async iterable that can be used to iterate over the list of python environments. + * Internally this will take all of the current workspace folders and search for python environments. + * + * If a Uri is provided, then it will search for python environments in that location (ignoring workspaces). + * Uri can be a file or a folder. + * If a PythonEnvironmentKind is provided, then it will search for python environments of that kind (ignoring workspaces). + */ + refresh(options?: PythonEnvironmentKind | Uri[]): AsyncIterable; + /** + * Will spawn the provided Python executable and return information about the environment. + * @param executable + */ resolve(executable: string): Promise; - refresh(): AsyncIterable; - categoryToKind(category?: string): PythonEnvKind; - logger(): LogOutputChannel; + categoryToKind(category?: PythonEnvironmentKind): PythonEnvKind; + /** + * Used only for telemetry. + */ getCondaInfo(): Promise; - find(searchPath: string): Promise; +} + +const mapping = new Map([ + [PythonEnvironmentKind.Conda, PythonEnvKind.Conda], + [PythonEnvironmentKind.GlobalPaths, PythonEnvKind.OtherGlobal], + [PythonEnvironmentKind.Pyenv, PythonEnvKind.Pyenv], + [PythonEnvironmentKind.PyenvVirtualEnv, PythonEnvKind.Pyenv], + [PythonEnvironmentKind.Pipenv, PythonEnvKind.Pipenv], + [PythonEnvironmentKind.Poetry, PythonEnvKind.Poetry], + [PythonEnvironmentKind.VirtualEnv, PythonEnvKind.VirtualEnv], + [PythonEnvironmentKind.VirtualEnvWrapper, PythonEnvKind.VirtualEnvWrapper], + [PythonEnvironmentKind.Venv, PythonEnvKind.Venv], + [PythonEnvironmentKind.WindowsRegistry, PythonEnvKind.System], + [PythonEnvironmentKind.WindowsStore, PythonEnvKind.MicrosoftStore], + [PythonEnvironmentKind.Homebrew, PythonEnvKind.System], + [PythonEnvironmentKind.LinuxGlobal, PythonEnvKind.System], + [PythonEnvironmentKind.MacCommandLineTools, PythonEnvKind.System], + [PythonEnvironmentKind.MacPythonOrg, PythonEnvKind.System], + [PythonEnvironmentKind.MacXCode, PythonEnvKind.System], +]); + +export function categoryToKind(category?: PythonEnvironmentKind, logger?: LogOutputChannel): PythonEnvKind { + if (!category) { + return PythonEnvKind.Unknown; + } + const kind = mapping.get(category); + if (kind) { + return kind; + } + + if (logger) { + logger.error(`Unknown Python Environment category '${category}' from Native Locator.`); + } else { + traceError(`Unknown Python Environment category '${category}' from Native Locator.`); + } + return PythonEnvKind.Unknown; } interface NativeLog { @@ -94,47 +171,11 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho return environment; } - categoryToKind(category?: string): PythonEnvKind { - if (!category) { - return PythonEnvKind.Unknown; - } - switch (category.toLowerCase()) { - case 'conda': - return PythonEnvKind.Conda; - case 'system': - case 'homebrew': - case 'macpythonorg': - case 'maccommandlinetools': - case 'macxcode': - case 'windowsregistry': - case 'linuxglobal': - return PythonEnvKind.System; - case 'globalpaths': - return PythonEnvKind.OtherGlobal; - case 'pyenv': - return PythonEnvKind.Pyenv; - case 'poetry': - return PythonEnvKind.Poetry; - case 'pipenv': - return PythonEnvKind.Pipenv; - case 'pyenvvirtualenv': - return PythonEnvKind.VirtualEnv; - case 'venv': - return PythonEnvKind.Venv; - case 'virtualenv': - return PythonEnvKind.VirtualEnv; - case 'virtualenvwrapper': - return PythonEnvKind.VirtualEnvWrapper; - case 'windowsstore': - return PythonEnvKind.MicrosoftStore; - default: { - this.outputChannel.info(`Unknown Python Environment category '${category}' from Native Locator.`); - return PythonEnvKind.Unknown; - } - } + categoryToKind(category?: PythonEnvironmentKind): PythonEnvKind { + return categoryToKind(category, this.outputChannel); } - async *refresh(): AsyncIterable { + async *refresh(options?: PythonEnvironmentKind | Uri[]): AsyncIterable { if (this.firstRefreshResults) { // If this is the first time we are refreshing, // Then get the results from the first refresh. @@ -143,12 +184,12 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho this.firstRefreshResults = undefined; yield* results; } else { - const result = this.doRefresh(); + const result = this.doRefresh(options); let completed = false; void result.completed.finally(() => { completed = true; }); - const envs: NativeEnvInfo[] = []; + const envs: (NativeEnvInfo | NativeEnvManagerInfo)[] = []; let discovered = createDeferred(); const disposable = result.discovered((data) => { envs.push(data); @@ -173,10 +214,6 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho } } - logger(): LogOutputChannel { - return this.outputChannel; - } - refreshFirstTime() { const result = this.doRefresh(); const completed = createDeferredFrom(result.completed); @@ -283,9 +320,11 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho return connection; } - private doRefresh(): { completed: Promise; discovered: Event } { + private doRefresh( + options?: PythonEnvironmentKind | Uri[], + ): { completed: Promise; discovered: Event } { const disposable = this._register(new DisposableStore()); - const discovered = disposable.add(new EventEmitter()); + const discovered = disposable.add(new EventEmitter()); const completed = createDeferred(); const pendingPromises: Promise[] = []; @@ -306,6 +345,8 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho notifyUponCompletion(); }; + // Assumption is server will ensure there's only one refresh at a time. + // Perhaps we should have a request Id or the like to map the results back to the `refresh` request. disposable.add( this.connection.onNotification('environment', (data: NativeEnvInfo) => { this.outputChannel.info(`Discovered env: ${data.executable || data.prefix}`); @@ -334,11 +375,28 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho } }), ); + disposable.add( + this.connection.onNotification('manager', (data: NativeEnvManagerInfo) => { + this.outputChannel.info(`Discovered manager: (${data.tool}) ${data.executable}`); + discovered.fire(data); + }), + ); + type RefreshOptions = { + searchKind?: PythonEnvironmentKind; + searchPaths?: string[]; + }; + + const refreshOptions: RefreshOptions = {}; + if (options && Array.isArray(options) && options.length > 0) { + refreshOptions.searchPaths = options.map((item) => item.fsPath); + } else if (options && typeof options === 'string') { + refreshOptions.searchKind = options; + } trackPromiseAndNotifyOnCompletion( this.configure().then(() => this.connection - .sendRequest<{ duration: number }>('refresh') + .sendRequest<{ duration: number }>('refresh', refreshOptions) .then(({ duration }) => this.outputChannel.info(`Refresh completed in ${duration}ms`)) .catch((ex) => this.outputChannel.error('Refresh error', ex)), ), diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index c1ac9304c388..1c56525f516a 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -2,9 +2,9 @@ // Licensed under the MIT License. import * as fsPath from 'path'; -import { Event, EventEmitter, workspace } from 'vscode'; +import { Event, EventEmitter, Uri, workspace } from 'vscode'; import '../../../../common/extensions'; -import { createDeferred, Deferred } from '../../../../common/utils/async'; +import { createDeferred, Deferred, flattenIterable } from '../../../../common/utils/async'; import { StopWatch } from '../../../../common/utils/stopWatch'; import { traceError, traceInfo, traceVerbose } from '../../../../logging'; import { sendTelemetryEvent } from '../../../../telemetry'; @@ -25,7 +25,12 @@ import { import { getQueryFilter } from '../../locatorUtils'; import { PythonEnvCollectionChangedEvent, PythonEnvsWatcher } from '../../watcher'; import { IEnvsCollectionCache } from './envsCollectionCache'; -import { getNativePythonFinder, NativeEnvInfo, NativePythonFinder } from '../common/nativePythonFinder'; +import { + getNativePythonFinder, + isNativeInfoEnvironment, + NativeEnvInfo, + NativePythonFinder, +} from '../common/nativePythonFinder'; import { pathExists } from '../../../../common/platform/fs-paths'; import { noop } from '../../../../common/utils/misc'; import { parseVersion } from '../../info/pythonVersion'; @@ -294,16 +299,18 @@ export class EnvsCollectionService extends PythonEnvsWatcher(); const nativeStopWatch = new StopWatch(); for await (const data of this.nativeFinder.refresh()) { - nativeEnvs.push(data); - if (data.executable) { - // Lowercase for purposes of comparison (safe). - executablesFoundByNativeLocator.add(data.executable.toLowerCase()); - } else if (data.prefix) { + if (isNativeInfoEnvironment(data)) { + nativeEnvs.push(data); + if (data.executable) { + // Lowercase for purposes of comparison (safe). + executablesFoundByNativeLocator.add(data.executable.toLowerCase()); + } else if (data.prefix) { + // Lowercase for purposes of comparison (safe). + executablesFoundByNativeLocator.add(data.prefix.toLowerCase()); + } // Lowercase for purposes of comparison (safe). - executablesFoundByNativeLocator.add(data.prefix.toLowerCase()); + (data.symlinks || []).forEach((exe) => executablesFoundByNativeLocator.add(exe.toLowerCase())); } - // Lowercase for purposes of comparison (safe). - (data.symlinks || []).forEach((exe) => executablesFoundByNativeLocator.add(exe.toLowerCase())); } const nativeDuration = nativeStopWatch.elapsedTime; void this.sendNativeLocatorTelemetry(nativeEnvs); @@ -980,11 +987,11 @@ async function getCondaTelemetry( if (condaTelemetry.condaRootPrefixFoundInInfoNotInNative) { // Verify we are able to discover this environment as a conda env using native finder. - const rootPrefixEnvs = await nativeFinder.find(rootPrefix); + const rootPrefixEnvs = await flattenIterable(nativeFinder.refresh([Uri.file(rootPrefix)])); // Did we find an env with the same prefix? - const rootPrefixEnv = rootPrefixEnvs.find( - (e) => fsPath.normalize(e.prefix || '').toLowerCase() === rootPrefix.toLowerCase(), - ); + const rootPrefixEnv = rootPrefixEnvs + .filter(isNativeInfoEnvironment) + .find((e) => fsPath.normalize(e.prefix || '').toLowerCase() === rootPrefix.toLowerCase()); condaTelemetry.condaRootPrefixEnvsAfterFind = rootPrefixEnvs.length; condaTelemetry.condaRootPrefixFoundInInfoAfterFind = !!rootPrefixEnv; condaTelemetry.condaRootPrefixFoundInInfoAfterFindKind = rootPrefixEnv?.kind; @@ -1019,11 +1026,11 @@ async function getCondaTelemetry( if (condaTelemetry.condaDefaultPrefixFoundInInfoNotInNative) { // Verify we are able to discover this environment as a conda env using native finder. - const defaultPrefixEnvs = await nativeFinder.find(defaultPrefix); + const defaultPrefixEnvs = await flattenIterable(nativeFinder.refresh([Uri.file(defaultPrefix)])); // Did we find an env with the same prefix? - const defaultPrefixEnv = defaultPrefixEnvs.find( - (e) => fsPath.normalize(e.prefix || '').toLowerCase() === defaultPrefix.toLowerCase(), - ); + const defaultPrefixEnv = defaultPrefixEnvs + .filter(isNativeInfoEnvironment) + .find((e) => fsPath.normalize(e.prefix || '').toLowerCase() === defaultPrefix.toLowerCase()); condaTelemetry.condaDefaultPrefixEnvsAfterFind = defaultPrefixEnvs.length; condaTelemetry.condaDefaultPrefixFoundInInfoAfterFind = !!defaultPrefixEnv; condaTelemetry.condaDefaultPrefixFoundInInfoAfterFindKind = defaultPrefixEnv?.kind; diff --git a/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts b/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts index 8d17a3488e47..6aa7be8280bc 100644 --- a/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts +++ b/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts @@ -10,7 +10,7 @@ import { Conda } from '../../../common/environmentManagers/conda'; import { traceError } from '../../../../logging'; import type { KnownEnvironmentTools } from '../../../../api/types'; import { setPyEnvBinary } from '../../../common/environmentManagers/pyenv'; -import { NativePythonFinder, getNativePythonFinder } from '../common/nativePythonFinder'; +import { NativePythonFinder, getNativePythonFinder, isNativeInfoEnvironment } from '../common/nativePythonFinder'; import { disposeAll } from '../../../../common/utils/resourceLifecycle'; import { Architecture } from '../../../../common/utils/platform'; @@ -74,37 +74,39 @@ export class NativeLocator implements ILocator, IDisposable { const disposable = new Disposable(() => disposeAll(disposables)); this.disposables.push(disposable); for await (const data of this.finder.refresh()) { - if (data.manager) { - switch (toolToKnownEnvironmentTool(data.manager.tool)) { - case 'Conda': { - Conda.setConda(data.manager.executable); - break; - } - case 'Pyenv': { - setPyEnvBinary(data.manager.executable); - break; - } - default: { - break; + if (isNativeInfoEnvironment(data)) { + if (data.manager) { + switch (toolToKnownEnvironmentTool(data.manager.tool)) { + case 'Conda': { + Conda.setConda(data.manager.executable); + break; + } + case 'Pyenv': { + setPyEnvBinary(data.manager.executable); + break; + } + default: { + break; + } } } - } - if (data.executable) { - const arch = (data.arch || '').toLowerCase(); - const env: BasicEnvInfo = { - kind: this.finder.categoryToKind(data.kind), - executablePath: data.executable ? data.executable : '', - envPath: data.prefix ? data.prefix : undefined, - version: data.version ? parseVersion(data.version) : undefined, - name: data.name ? data.name : '', - displayName: data.displayName ? data.displayName : '', - searchLocation: data.project ? Uri.file(data.project) : undefined, - identifiedUsingNativeLocator: true, - arch: - // eslint-disable-next-line no-nested-ternary - arch === 'x64' ? Architecture.x64 : arch === 'x86' ? Architecture.x86 : undefined, - }; - yield env; + if (data.executable) { + const arch = (data.arch || '').toLowerCase(); + const env: BasicEnvInfo = { + kind: this.finder.categoryToKind(data.kind), + executablePath: data.executable ? data.executable : '', + envPath: data.prefix ? data.prefix : undefined, + version: data.version ? parseVersion(data.version) : undefined, + name: data.name ? data.name : '', + displayName: data.displayName ? data.displayName : '', + searchLocation: data.project ? Uri.file(data.project) : undefined, + identifiedUsingNativeLocator: true, + arch: + // eslint-disable-next-line no-nested-ternary + arch === 'x64' ? Architecture.x64 : arch === 'x86' ? Architecture.x86 : undefined, + }; + yield env; + } } } } diff --git a/src/client/pythonEnvironments/nativeAPI.ts b/src/client/pythonEnvironments/nativeAPI.ts index dca9b17d4dc1..3f4455b00fd3 100644 --- a/src/client/pythonEnvironments/nativeAPI.ts +++ b/src/client/pythonEnvironments/nativeAPI.ts @@ -13,7 +13,7 @@ import { TriggerRefreshOptions, } from './base/locator'; import { PythonEnvCollectionChangedEvent } from './base/watcher'; -import { NativeEnvInfo, NativePythonFinder } from './base/locators/common/nativePythonFinder'; +import { isNativeInfoEnvironment, NativeEnvInfo, NativePythonFinder } from './base/locators/common/nativePythonFinder'; import { createDeferred, Deferred } from '../common/utils/async'; import { Architecture } from '../common/utils/platform'; import { parseVersion } from './base/info/pythonVersion'; @@ -102,9 +102,9 @@ function getDisplayName(version: PythonVersion, kind: PythonEnvKind, arch: Archi return name ? `Python ${versionStr} ('${name}')` : `Python ${versionStr}`; } -function validEnv(finder: NativePythonFinder, nativeEnv: NativeEnvInfo): boolean { +function validEnv(nativeEnv: NativeEnvInfo): boolean { if (nativeEnv.prefix === undefined && nativeEnv.executable === undefined) { - finder.logger().error(`Invalid environment [native]: ${JSON.stringify(nativeEnv)}`); + traceError(`Invalid environment [native]: ${JSON.stringify(nativeEnv)}`); return false; } return true; @@ -150,7 +150,7 @@ function getName(nativeEnv: NativeEnvInfo, kind: PythonEnvKind): string { } function toPythonEnvInfo(finder: NativePythonFinder, nativeEnv: NativeEnvInfo): PythonEnvInfo | undefined { - if (!validEnv(finder, nativeEnv)) { + if (!validEnv(nativeEnv)) { return undefined; } const kind = finder.categoryToKind(nativeEnv.kind); @@ -229,7 +229,7 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { setImmediate(async () => { try { for await (const native of this.finder.refresh()) { - if (!validEnv(this.finder, native)) { + if (!isNativeInfoEnvironment(native) || !validEnv(native)) { // eslint-disable-next-line no-continue continue; } diff --git a/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts b/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts index 1f319f87d86b..45ce63cfbdfc 100644 --- a/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts +++ b/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts @@ -7,7 +7,7 @@ import { assert, expect } from 'chai'; import { cloneDeep } from 'lodash'; import * as path from 'path'; import * as sinon from 'sinon'; -import { EventEmitter, LogOutputChannel, Uri } from 'vscode'; +import { EventEmitter, Uri } from 'vscode'; import { FileChangeType } from '../../../../../client/common/platform/fileSystemWatcher'; import { createDeferred, createDeferredFromPromise, sleep } from '../../../../../client/common/utils/async'; import { PythonEnvInfo, PythonEnvKind } from '../../../../../client/pythonEnvironments/base/info'; @@ -27,15 +27,8 @@ import { SimpleLocator } from '../../common'; import { assertEnvEqual, assertEnvsEqual, createFile, deleteFile } from '../envTestUtils'; import { OSType, getOSType } from '../../../../common'; import * as nativeFinder from '../../../../../client/pythonEnvironments/base/locators/common/nativePythonFinder'; -import { MockOutputChannel } from '../../../../mockClasses'; class MockNativePythonFinder implements nativeFinder.NativePythonFinder { - private output: LogOutputChannel; - - constructor() { - this.output = new MockOutputChannel('Python Locator'); - } - find(_searchPath: string): Promise { throw new Error('Method not implemented.'); } @@ -44,7 +37,7 @@ class MockNativePythonFinder implements nativeFinder.NativePythonFinder { throw new Error('Method not implemented.'); } - categoryToKind(_category: string): PythonEnvKind { + categoryToKind(_category: nativeFinder.PythonEnvironmentKind): PythonEnvKind { throw new Error('Method not implemented.'); } @@ -61,10 +54,6 @@ class MockNativePythonFinder implements nativeFinder.NativePythonFinder { })(); } - logger(): LogOutputChannel { - return this.output; - } - dispose() { /** noop */ } diff --git a/src/test/pythonEnvironments/nativeAPI.unit.test.ts b/src/test/pythonEnvironments/nativeAPI.unit.test.ts index a56b78b33f5b..93fc69951287 100644 --- a/src/test/pythonEnvironments/nativeAPI.unit.test.ts +++ b/src/test/pythonEnvironments/nativeAPI.unit.test.ts @@ -9,8 +9,10 @@ import * as sinon from 'sinon'; import * as nativeAPI from '../../client/pythonEnvironments/nativeAPI'; import { IDiscoveryAPI } from '../../client/pythonEnvironments/base/locator'; import { + categoryToKind, NativeEnvInfo, NativePythonFinder, + PythonEnvironmentKind, } from '../../client/pythonEnvironments/base/locators/common/nativePythonFinder'; import { Architecture } from '../../client/common/utils/platform'; import { PythonEnvInfo, PythonEnvKind, PythonEnvType } from '../../client/pythonEnvironments/base/info'; @@ -24,7 +26,7 @@ suite('Native Python API', () => { displayName: 'Basic Python', name: 'basic_python', executable: '/usr/bin/python', - kind: 'system', + kind: PythonEnvironmentKind.LinuxGlobal, version: `3.12.0`, prefix: '/usr/bin', }; @@ -33,7 +35,7 @@ suite('Native Python API', () => { displayName: 'Basic Python', name: 'basic_python', executable: '/usr/bin/python', - kind: 'system', + kind: PythonEnvironmentKind.LinuxGlobal, version: undefined, // this is intentionally set to trigger resolve prefix: '/usr/bin', }; @@ -56,7 +58,7 @@ suite('Native Python API', () => { displayName: 'Conda Python', name: 'conda_python', executable: '/home/user/.conda/envs/conda_python/python', - kind: 'conda', + kind: PythonEnvironmentKind.Conda, version: `3.12.0`, prefix: '/home/user/.conda/envs/conda_python', }; @@ -65,7 +67,7 @@ suite('Native Python API', () => { displayName: 'Conda Python', name: 'conda_python', executable: '/home/user/.conda/envs/conda_python/python', - kind: 'conda', + kind: PythonEnvironmentKind.Conda, version: undefined, // this is intentionally set to test conda without python prefix: '/home/user/.conda/envs/conda_python', }; @@ -74,7 +76,7 @@ suite('Native Python API', () => { displayName: 'Conda Python', name: 'conda_python', executable: undefined, // this is intentionally set to test env with no executable - kind: 'conda', + kind: PythonEnvironmentKind.Conda, version: undefined, // this is intentionally set to test conda without python prefix: '/home/user/.conda/envs/conda_python', }; @@ -126,41 +128,7 @@ suite('Native Python API', () => { mockFinder .setup((f) => f.categoryToKind(typemoq.It.isAny())) - .returns((category: string) => { - switch (category.toLowerCase()) { - case 'conda': - return PythonEnvKind.Conda; - case 'system': - case 'homebrew': - case 'macpythonorg': - case 'maccommandlinetools': - case 'macxcode': - case 'windowsregistry': - case 'linuxglobal': - return PythonEnvKind.System; - case 'globalpaths': - return PythonEnvKind.OtherGlobal; - case 'pyenv': - return PythonEnvKind.Pyenv; - case 'poetry': - return PythonEnvKind.Poetry; - case 'pipenv': - return PythonEnvKind.Pipenv; - case 'pyenvvirtualenv': - return PythonEnvKind.VirtualEnv; - case 'venv': - return PythonEnvKind.Venv; - case 'virtualenv': - return PythonEnvKind.VirtualEnv; - case 'virtualenvwrapper': - return PythonEnvKind.VirtualEnvWrapper; - case 'windowsstore': - return PythonEnvKind.MicrosoftStore; - default: { - return PythonEnvKind.Unknown; - } - } - }); + .returns((category: PythonEnvironmentKind) => categoryToKind(category)); api = nativeAPI.createNativeEnvironmentsApi(mockFinder.object); }); From 0d1a0f15bebe9eaa8290da5c7cdebe0efcd83735 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Fri, 19 Jul 2024 09:25:24 +1000 Subject: [PATCH 027/149] Configure before resolving and remove old API call (#23834) --- .../base/locators/common/nativePythonFinder.ts | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index 9dc440a7a88f..97601c59dbaa 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -163,6 +163,7 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho } public async resolve(executable: string): Promise { + await this.configure(); const environment = await this.connection.sendRequest('resolve', { executable, }); @@ -438,10 +439,6 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho async getCondaInfo(): Promise { return this.connection.sendRequest('condaInfo'); } - - public async find(searchPath: string): Promise { - return this.connection.sendRequest('find', { searchPath }); - } } type ConfigurationOptions = { From a60f228ab785c846559af5855026191fd979b374 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Thu, 18 Jul 2024 19:45:13 -0400 Subject: [PATCH 028/149] Correctly display native REPL execution status (#23797) Resolves: https://github.com/microsoft/vscode-python/issues/23739 --- python_files/python_server.py | 36 +++++++++++++++++++++---------- src/client/repl/pythonServer.ts | 17 ++++++++++++--- src/client/repl/replController.ts | 26 +++++++--------------- 3 files changed, 47 insertions(+), 32 deletions(-) diff --git a/python_files/python_server.py b/python_files/python_server.py index a4b15f2cbaae..deda05753c4d 100644 --- a/python_files/python_server.py +++ b/python_files/python_server.py @@ -13,28 +13,38 @@ USER_GLOBALS = {} -def send_message(msg: str): +def _send_message(msg: str): length_msg = len(msg) STDOUT.buffer.write(f"Content-Length: {length_msg}\r\n\r\n{msg}".encode()) STDOUT.buffer.flush() +def send_message(**kwargs): + _send_message(json.dumps({"jsonrpc": "2.0", **kwargs})) + + def print_log(msg: str): - send_message(json.dumps({"jsonrpc": "2.0", "method": "log", "params": msg})) + send_message(method="log", params=msg) -def send_response(response: str, response_id: int): - send_message(json.dumps({"jsonrpc": "2.0", "id": response_id, "result": response})) +def send_response( + response: str, + response_id: int, + execution_status: bool = True, # noqa: FBT001, FBT002 +): + send_message( + id=response_id, + result={"status": execution_status, "output": response}, + ) def send_request(params: Optional[Union[List, Dict]] = None): request_id = uuid.uuid4().hex if params is None: - send_message(json.dumps({"jsonrpc": "2.0", "id": request_id, "method": "input"})) + send_message(id=request_id, method="input") else: - send_message( - json.dumps({"jsonrpc": "2.0", "id": request_id, "method": "input", "params": params}) - ) + send_message(id=request_id, method="input", params=params) + return request_id @@ -105,13 +115,14 @@ def execute(request, user_globals): original_stdin = sys.stdin try: sys.stdin = str_input - exec_user_input(request["params"], user_globals) + execution_status = exec_user_input(request["params"], user_globals) finally: sys.stdin = original_stdin - send_response(str_output.get_value(), request["id"]) + + send_response(str_output.get_value(), request["id"], execution_status) -def exec_user_input(user_input, user_globals): +def exec_user_input(user_input, user_globals) -> bool: user_input = user_input[0] if isinstance(user_input, list) else user_input try: @@ -119,10 +130,13 @@ def exec_user_input(user_input, user_globals): retval = callable_(user_input, user_globals) if retval is not None: print(retval) + return True except KeyboardInterrupt: print(traceback.format_exc()) + return False except Exception: print(traceback.format_exc()) + return False class CustomIO(io.TextIOWrapper): diff --git a/src/client/repl/pythonServer.ts b/src/client/repl/pythonServer.ts index e125cf5e8d28..ca45ea900baf 100644 --- a/src/client/repl/pythonServer.ts +++ b/src/client/repl/pythonServer.ts @@ -9,9 +9,13 @@ import { EventName } from '../telemetry/constants'; const SERVER_PATH = path.join(EXTENSION_ROOT_DIR, 'python_files', 'python_server.py'); let serverInstance: PythonServer | undefined; +export interface ExecutionResult { + status: boolean; + output: string; +} export interface PythonServer extends Disposable { - execute(code: string): Promise; + execute(code: string): Promise; interrupt(): void; input(): void; checkValidCommand(code: string): Promise; @@ -52,8 +56,15 @@ class PythonServerImpl implements Disposable { } @captureTelemetry(EventName.EXECUTION_CODE, { scope: 'selection' }, false) - public execute(code: string): Promise { - return this.connection.sendRequest('execute', code); + public async execute(code: string): Promise { + try { + const result = await this.connection.sendRequest('execute', code); + return result as ExecutionResult; + } catch (err) { + const error = err as Error; + traceError(`Error getting response from REPL server:`, error); + } + return undefined; } public interrupt(): void { diff --git a/src/client/repl/replController.ts b/src/client/repl/replController.ts index 7f11b654c54e..4760edc98036 100644 --- a/src/client/repl/replController.ts +++ b/src/client/repl/replController.ts @@ -22,27 +22,17 @@ export function createReplController( for (const cell of cells) { const exec = controller.createNotebookCellExecution(cell); exec.start(Date.now()); - try { - const result = await server.execute(cell.document.getText()); - if (result !== '') { - exec.replaceOutput([ - new vscode.NotebookCellOutput([vscode.NotebookCellOutputItem.text(result, 'text/plain')]), - ]); - } - exec.end(true); - } catch (err) { - const error = err as Error; + + const result = await server.execute(cell.document.getText()); + + if (result?.output) { exec.replaceOutput([ - new vscode.NotebookCellOutput([ - vscode.NotebookCellOutputItem.error({ - name: error.name, - message: error.message, - stack: error.stack, - }), - ]), + new vscode.NotebookCellOutput([vscode.NotebookCellOutputItem.text(result.output, 'text/plain')]), ]); - exec.end(false); + // TODO: Properly update via NotebookCellOutputItem.error later. } + + exec.end(result?.status); } }; disposables.push(controller); From d2646dc787e2e7734b8bb00024ead72239faeaae Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Thu, 18 Jul 2024 21:33:15 -0700 Subject: [PATCH 029/149] More native tests for Native python finder (#23831) --- .github/workflows/build.yml | 7 ++ .github/workflows/pr-check.yml | 18 +++ .../locators/common/nativePythonFinder.ts | 84 ++----------- .../base/locators/common/nativePythonUtils.ts | 61 ++++++++++ .../composite/envsCollectionService.ts | 67 ++++------- .../base/locators/lowLevel/nativeLocator.ts | 113 ------------------ src/client/pythonEnvironments/nativeAPI.ts | 15 +-- .../envsCollectionService.unit.test.ts | 4 - .../pythonEnvironments/nativeAPI.unit.test.ts | 18 +-- .../nativePythonFinder.unit.test.ts | 90 ++++++++++++++ 10 files changed, 227 insertions(+), 250 deletions(-) create mode 100644 src/client/pythonEnvironments/base/locators/common/nativePythonUtils.ts delete mode 100644 src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts create mode 100644 src/test/pythonEnvironments/nativePythonFinder.unit.test.ts diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0fc789d8c69b..42d94e49041c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -257,6 +257,13 @@ jobs: - name: Install test requirements run: python -m pip install --upgrade -r build/test-requirements.txt + - name: Rust Tool Chain setup + uses: dtolnay/rust-toolchain@stable + + - name: Build Native Binaries + run: nox --session native_build + shell: bash + - name: Install functional test requirements run: python -m pip install --upgrade -r ./build/functional-test-requirements.txt if: matrix.test-suite == 'functional' diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml index 34c8c6cc8e79..063857894210 100644 --- a/.github/workflows/pr-check.yml +++ b/.github/workflows/pr-check.yml @@ -253,6 +253,13 @@ jobs: - name: Install test requirements run: python -m pip install --upgrade -r build/test-requirements.txt + - name: Rust Tool Chain setup + uses: dtolnay/rust-toolchain@stable + + - name: Build Native Binaries + run: nox --session native_build + shell: bash + - name: Install functional test requirements run: python -m pip install --upgrade -r ./build/functional-test-requirements.txt if: matrix.test-suite == 'functional' @@ -512,6 +519,17 @@ jobs: requirements-file: './python_files/jedilsp_requirements/requirements.txt' options: '-t ./python_files/lib/jedilsp --implementation py' + - name: Install build pre-requisite + run: python -m pip install wheel nox + shell: bash + + - name: Rust Tool Chain setup + uses: dtolnay/rust-toolchain@stable + + - name: Build Native Binaries + run: nox --session native_build + shell: bash + - name: Install test requirements run: python -m pip install --upgrade -r build/test-requirements.txt diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index 97601c59dbaa..27e5c2e40d6f 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import { Disposable, EventEmitter, Event, Uri, LogOutputChannel } from 'vscode'; +import { Disposable, EventEmitter, Event, Uri } from 'vscode'; import * as ch from 'child_process'; import * as path from 'path'; import * as rpc from 'vscode-jsonrpc/node'; @@ -16,9 +16,8 @@ import { CONDAPATH_SETTING_KEY } from '../../../common/environmentManagers/conda import { VENVFOLDERS_SETTING_KEY, VENVPATH_SETTING_KEY } from '../lowLevel/customVirtualEnvLocator'; import { getUserHomeDir } from '../../../../common/utils/platform'; import { createLogOutputChannel } from '../../../../common/vscodeApis/windowApis'; -import { PythonEnvKind } from '../../info'; import { sendNativeTelemetry, NativePythonTelemetry } from './nativePythonTelemetry'; -import { traceError } from '../../../../logging'; +import { NativePythonEnvironmentKind } from './nativePythonUtils'; const untildify = require('untildify'); @@ -30,7 +29,7 @@ export interface NativeEnvInfo { displayName?: string; name?: string; executable?: string; - kind?: PythonEnvironmentKind; + kind?: NativePythonEnvironmentKind; version?: string; prefix?: string; manager?: NativeEnvManagerInfo; @@ -42,32 +41,13 @@ export interface NativeEnvInfo { symlinks?: string[]; } -export enum PythonEnvironmentKind { - Conda = 'Conda', - Homebrew = 'Homebrew', - Pyenv = 'Pyenv', - GlobalPaths = 'GlobalPaths', - PyenvVirtualEnv = 'PyenvVirtualEnv', - Pipenv = 'Pipenv', - Poetry = 'Poetry', - MacPythonOrg = 'MacPythonOrg', - MacCommandLineTools = 'MacCommandLineTools', - LinuxGlobal = 'LinuxGlobal', - MacXCode = 'MacXCode', - Venv = 'Venv', - VirtualEnv = 'VirtualEnv', - VirtualEnvWrapper = 'VirtualEnvWrapper', - WindowsStore = 'WindowsStore', - WindowsRegistry = 'WindowsRegistry', -} - export interface NativeEnvManagerInfo { tool: string; executable: string; version?: string; } -export function isNativeInfoEnvironment(info: NativeEnvInfo | NativeEnvManagerInfo): info is NativeEnvInfo { +export function isNativeEnvInfo(info: NativeEnvInfo | NativeEnvManagerInfo): info is NativeEnvInfo { if ((info as NativeEnvManagerInfo).tool) { return false; } @@ -92,63 +72,26 @@ export interface NativePythonFinder extends Disposable { * * If a Uri is provided, then it will search for python environments in that location (ignoring workspaces). * Uri can be a file or a folder. - * If a PythonEnvironmentKind is provided, then it will search for python environments of that kind (ignoring workspaces). + * If a NativePythonEnvironmentKind is provided, then it will search for python environments of that kind (ignoring workspaces). */ - refresh(options?: PythonEnvironmentKind | Uri[]): AsyncIterable; + refresh(options?: NativePythonEnvironmentKind | Uri[]): AsyncIterable; /** * Will spawn the provided Python executable and return information about the environment. * @param executable */ resolve(executable: string): Promise; - categoryToKind(category?: PythonEnvironmentKind): PythonEnvKind; /** * Used only for telemetry. */ getCondaInfo(): Promise; } -const mapping = new Map([ - [PythonEnvironmentKind.Conda, PythonEnvKind.Conda], - [PythonEnvironmentKind.GlobalPaths, PythonEnvKind.OtherGlobal], - [PythonEnvironmentKind.Pyenv, PythonEnvKind.Pyenv], - [PythonEnvironmentKind.PyenvVirtualEnv, PythonEnvKind.Pyenv], - [PythonEnvironmentKind.Pipenv, PythonEnvKind.Pipenv], - [PythonEnvironmentKind.Poetry, PythonEnvKind.Poetry], - [PythonEnvironmentKind.VirtualEnv, PythonEnvKind.VirtualEnv], - [PythonEnvironmentKind.VirtualEnvWrapper, PythonEnvKind.VirtualEnvWrapper], - [PythonEnvironmentKind.Venv, PythonEnvKind.Venv], - [PythonEnvironmentKind.WindowsRegistry, PythonEnvKind.System], - [PythonEnvironmentKind.WindowsStore, PythonEnvKind.MicrosoftStore], - [PythonEnvironmentKind.Homebrew, PythonEnvKind.System], - [PythonEnvironmentKind.LinuxGlobal, PythonEnvKind.System], - [PythonEnvironmentKind.MacCommandLineTools, PythonEnvKind.System], - [PythonEnvironmentKind.MacPythonOrg, PythonEnvKind.System], - [PythonEnvironmentKind.MacXCode, PythonEnvKind.System], -]); - -export function categoryToKind(category?: PythonEnvironmentKind, logger?: LogOutputChannel): PythonEnvKind { - if (!category) { - return PythonEnvKind.Unknown; - } - const kind = mapping.get(category); - if (kind) { - return kind; - } - - if (logger) { - logger.error(`Unknown Python Environment category '${category}' from Native Locator.`); - } else { - traceError(`Unknown Python Environment category '${category}' from Native Locator.`); - } - return PythonEnvKind.Unknown; -} - interface NativeLog { level: string; message: string; } -class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePythonFinder { +class NativePythonFinderImpl extends DisposableBase implements NativePythonFinder { private readonly connection: rpc.MessageConnection; private firstRefreshResults: undefined | (() => AsyncGenerator); @@ -172,11 +115,7 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho return environment; } - categoryToKind(category?: PythonEnvironmentKind): PythonEnvKind { - return categoryToKind(category, this.outputChannel); - } - - async *refresh(options?: PythonEnvironmentKind | Uri[]): AsyncIterable { + async *refresh(options?: NativePythonEnvironmentKind | Uri[]): AsyncIterable { if (this.firstRefreshResults) { // If this is the first time we are refreshing, // Then get the results from the first refresh. @@ -322,7 +261,7 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho } private doRefresh( - options?: PythonEnvironmentKind | Uri[], + options?: NativePythonEnvironmentKind | Uri[], ): { completed: Promise; discovered: Event } { const disposable = this._register(new DisposableStore()); const discovered = disposable.add(new EventEmitter()); @@ -384,7 +323,7 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho ); type RefreshOptions = { - searchKind?: PythonEnvironmentKind; + searchKind?: NativePythonEnvironmentKind; searchPaths?: string[]; }; @@ -423,6 +362,7 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePytho environmentDirectories: getCustomVirtualEnvDirs(), condaExecutable: getPythonSettingAndUntildify(CONDAPATH_SETTING_KEY), poetryExecutable: getPythonSettingAndUntildify('poetryPath'), + // We don't use pipenvPath as it is not used for discovery }; // No need to send a configuration request, is there are no changes. if (JSON.stringify(options) === JSON.stringify(this.lastConfiguration || {})) { @@ -480,7 +420,7 @@ function getPythonSettingAndUntildify(name: string, scope?: Uri): T | undefin let _finder: NativePythonFinder | undefined; export function getNativePythonFinder(): NativePythonFinder { if (!_finder) { - _finder = new NativeGlobalPythonFinderImpl(); + _finder = new NativePythonFinderImpl(); } return _finder; } diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonUtils.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonUtils.ts new file mode 100644 index 000000000000..f840ce9a41ec --- /dev/null +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonUtils.ts @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +import { LogOutputChannel } from 'vscode'; +import { PythonEnvKind } from '../../info'; +import { traceError } from '../../../../logging'; + +export enum NativePythonEnvironmentKind { + Conda = 'Conda', + Homebrew = 'Homebrew', + Pyenv = 'Pyenv', + GlobalPaths = 'GlobalPaths', + PyenvVirtualEnv = 'PyenvVirtualEnv', + Pipenv = 'Pipenv', + Poetry = 'Poetry', + MacPythonOrg = 'MacPythonOrg', + MacCommandLineTools = 'MacCommandLineTools', + LinuxGlobal = 'LinuxGlobal', + MacXCode = 'MacXCode', + Venv = 'Venv', + VirtualEnv = 'VirtualEnv', + VirtualEnvWrapper = 'VirtualEnvWrapper', + WindowsStore = 'WindowsStore', + WindowsRegistry = 'WindowsRegistry', +} + +const mapping = new Map([ + [NativePythonEnvironmentKind.Conda, PythonEnvKind.Conda], + [NativePythonEnvironmentKind.GlobalPaths, PythonEnvKind.OtherGlobal], + [NativePythonEnvironmentKind.Pyenv, PythonEnvKind.Pyenv], + [NativePythonEnvironmentKind.PyenvVirtualEnv, PythonEnvKind.Pyenv], + [NativePythonEnvironmentKind.Pipenv, PythonEnvKind.Pipenv], + [NativePythonEnvironmentKind.Poetry, PythonEnvKind.Poetry], + [NativePythonEnvironmentKind.VirtualEnv, PythonEnvKind.VirtualEnv], + [NativePythonEnvironmentKind.VirtualEnvWrapper, PythonEnvKind.VirtualEnvWrapper], + [NativePythonEnvironmentKind.Venv, PythonEnvKind.Venv], + [NativePythonEnvironmentKind.WindowsRegistry, PythonEnvKind.System], + [NativePythonEnvironmentKind.WindowsStore, PythonEnvKind.MicrosoftStore], + [NativePythonEnvironmentKind.Homebrew, PythonEnvKind.System], + [NativePythonEnvironmentKind.LinuxGlobal, PythonEnvKind.System], + [NativePythonEnvironmentKind.MacCommandLineTools, PythonEnvKind.System], + [NativePythonEnvironmentKind.MacPythonOrg, PythonEnvKind.System], + [NativePythonEnvironmentKind.MacXCode, PythonEnvKind.System], +]); + +export function categoryToKind(category?: NativePythonEnvironmentKind, logger?: LogOutputChannel): PythonEnvKind { + if (!category) { + return PythonEnvKind.Unknown; + } + const kind = mapping.get(category); + if (kind) { + return kind; + } + + if (logger) { + logger.error(`Unknown Python Environment category '${category}' from Native Locator.`); + } else { + traceError(`Unknown Python Environment category '${category}' from Native Locator.`); + } + return PythonEnvKind.Unknown; +} diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index 1c56525f516a..5f1fc7c3bf05 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -27,7 +27,7 @@ import { PythonEnvCollectionChangedEvent, PythonEnvsWatcher } from '../../watche import { IEnvsCollectionCache } from './envsCollectionCache'; import { getNativePythonFinder, - isNativeInfoEnvironment, + isNativeEnvInfo, NativeEnvInfo, NativePythonFinder, } from '../common/nativePythonFinder'; @@ -37,6 +37,7 @@ import { parseVersion } from '../../info/pythonVersion'; import { Conda, CONDAPATH_SETTING_KEY, isCondaEnvironment } from '../../../common/environmentManagers/conda'; import { getConfiguration } from '../../../../common/vscodeApis/workspaceApis'; import { getUserHomeDir } from '../../../../common/utils/platform'; +import { categoryToKind } from '../common/nativePythonUtils'; /** * A service which maintains the collection of known environments. @@ -299,7 +300,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher(); const nativeStopWatch = new StopWatch(); for await (const data of this.nativeFinder.refresh()) { - if (isNativeInfoEnvironment(data)) { + if (isNativeEnvInfo(data)) { nativeEnvs.push(data); if (data.executable) { // Lowercase for purposes of comparison (safe). @@ -333,9 +334,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Conda, - ); + const nativeCondaEnvs = nativeEnvs.filter((e) => categoryToKind(e.kind) === PythonEnvKind.Conda); const condaTelemetry = await getCondaTelemetry(this.nativeFinder, nativeCondaEnvs, nativeEnvs); const prefixesSeenAlready = new Set(); await Promise.all( @@ -480,47 +479,31 @@ export class EnvsCollectionService extends PythonEnvsWatcher e.executable === undefined).length; - const nativeCustomEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Custom, - ).length; + const nativeCustomEnvs = nativeEnvs.filter((e) => categoryToKind(e.kind) === PythonEnvKind.Custom).length; const nativeMicrosoftStoreEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.MicrosoftStore, - ).length; - const nativeOtherGlobalEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.OtherGlobal, - ).length; - const nativeOtherVirtualEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.OtherVirtual, - ).length; - const nativePipEnvEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Pipenv, - ).length; - const nativePoetryEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Poetry, + (e) => categoryToKind(e.kind) === PythonEnvKind.MicrosoftStore, ).length; - const nativePyenvEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Pyenv, - ).length; - const nativeSystemEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.System, - ).length; - const nativeUnknownEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Unknown, - ).length; - const nativeVenvEnvs = nativeEnvs.filter((e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Venv) + const nativeOtherGlobalEnvs = nativeEnvs.filter((e) => categoryToKind(e.kind) === PythonEnvKind.OtherGlobal) + .length; + const nativeOtherVirtualEnvs = nativeEnvs.filter((e) => categoryToKind(e.kind) === PythonEnvKind.OtherVirtual) + .length; + const nativePipEnvEnvs = nativeEnvs.filter((e) => categoryToKind(e.kind) === PythonEnvKind.Pipenv).length; + const nativePoetryEnvs = nativeEnvs.filter((e) => categoryToKind(e.kind) === PythonEnvKind.Poetry).length; + const nativePyenvEnvs = nativeEnvs.filter((e) => categoryToKind(e.kind) === PythonEnvKind.Pyenv).length; + const nativeSystemEnvs = nativeEnvs.filter((e) => categoryToKind(e.kind) === PythonEnvKind.System).length; + const nativeUnknownEnvs = nativeEnvs.filter((e) => categoryToKind(e.kind) === PythonEnvKind.Unknown).length; + const nativeVenvEnvs = nativeEnvs.filter((e) => categoryToKind(e.kind) === PythonEnvKind.Venv).length; + const nativeVirtualEnvEnvs = nativeEnvs.filter((e) => categoryToKind(e.kind) === PythonEnvKind.VirtualEnv) .length; - const nativeVirtualEnvEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.VirtualEnv, - ).length; const nativeVirtualEnvWrapperEnvs = nativeEnvs.filter( - (e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.VirtualEnvWrapper, + (e) => categoryToKind(e.kind) === PythonEnvKind.VirtualEnvWrapper, ).length; const nativeGlobal = nativeEnvs.filter( (e) => - this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.OtherGlobal || - this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.System || - this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Custom || - this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.OtherVirtual, + categoryToKind(e.kind) === PythonEnvKind.OtherGlobal || + categoryToKind(e.kind) === PythonEnvKind.System || + categoryToKind(e.kind) === PythonEnvKind.Custom || + categoryToKind(e.kind) === PythonEnvKind.OtherVirtual, ).length; // Intent is to capture time taken for discovery of all envs to complete the first time. @@ -618,7 +601,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher fsPath.normalize(e.prefix || '').toLowerCase() === rootPrefix.toLowerCase()); condaTelemetry.condaRootPrefixEnvsAfterFind = rootPrefixEnvs.length; condaTelemetry.condaRootPrefixFoundInInfoAfterFind = !!rootPrefixEnv; @@ -1029,7 +1012,7 @@ async function getCondaTelemetry( const defaultPrefixEnvs = await flattenIterable(nativeFinder.refresh([Uri.file(defaultPrefix)])); // Did we find an env with the same prefix? const defaultPrefixEnv = defaultPrefixEnvs - .filter(isNativeInfoEnvironment) + .filter(isNativeEnvInfo) .find((e) => fsPath.normalize(e.prefix || '').toLowerCase() === defaultPrefix.toLowerCase()); condaTelemetry.condaDefaultPrefixEnvsAfterFind = defaultPrefixEnvs.length; condaTelemetry.condaDefaultPrefixFoundInInfoAfterFind = !!defaultPrefixEnv; diff --git a/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts b/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts deleted file mode 100644 index 6aa7be8280bc..000000000000 --- a/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts +++ /dev/null @@ -1,113 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. - -import { Disposable, Event, EventEmitter, Uri } from 'vscode'; -import { IDisposable } from '../../../../common/types'; -import { ILocator, BasicEnvInfo, IPythonEnvsIterator } from '../../locator'; -import { PythonEnvsChangedEvent } from '../../watcher'; -import { PythonVersion } from '../../info'; -import { Conda } from '../../../common/environmentManagers/conda'; -import { traceError } from '../../../../logging'; -import type { KnownEnvironmentTools } from '../../../../api/types'; -import { setPyEnvBinary } from '../../../common/environmentManagers/pyenv'; -import { NativePythonFinder, getNativePythonFinder, isNativeInfoEnvironment } from '../common/nativePythonFinder'; -import { disposeAll } from '../../../../common/utils/resourceLifecycle'; -import { Architecture } from '../../../../common/utils/platform'; - -function toolToKnownEnvironmentTool(tool: string): KnownEnvironmentTools { - switch (tool.toLowerCase()) { - case 'conda': - return 'Conda'; - case 'poetry': - return 'Poetry'; - case 'pyenv': - return 'Pyenv'; - default: { - traceError(`Unknown Python Tool '${tool}' from Native Locator.`); - return 'Unknown'; - } - } -} - -function parseVersion(version?: string): PythonVersion | undefined { - if (!version) { - return undefined; - } - - try { - const [major, minor, micro] = version.split('.').map((v) => parseInt(v, 10)); - return { - major: typeof major === 'number' ? major : -1, - minor: typeof minor === 'number' ? minor : -1, - micro: typeof micro === 'number' ? micro : -1, - sysVersion: version, - }; - } catch { - return undefined; - } -} - -export class NativeLocator implements ILocator, IDisposable { - public readonly providerId: string = 'native-locator'; - - private readonly onChangedEmitter = new EventEmitter(); - - private readonly disposables: IDisposable[] = []; - - private readonly finder: NativePythonFinder; - - constructor() { - this.onChanged = this.onChangedEmitter.event; - this.finder = getNativePythonFinder(); - this.disposables.push(this.onChangedEmitter, this.finder); - } - - public readonly onChanged: Event; - - public async dispose(): Promise { - this.disposables.forEach((d) => d.dispose()); - return Promise.resolve(); - } - - public async *iterEnvs(): IPythonEnvsIterator { - const disposables: IDisposable[] = []; - const disposable = new Disposable(() => disposeAll(disposables)); - this.disposables.push(disposable); - for await (const data of this.finder.refresh()) { - if (isNativeInfoEnvironment(data)) { - if (data.manager) { - switch (toolToKnownEnvironmentTool(data.manager.tool)) { - case 'Conda': { - Conda.setConda(data.manager.executable); - break; - } - case 'Pyenv': { - setPyEnvBinary(data.manager.executable); - break; - } - default: { - break; - } - } - } - if (data.executable) { - const arch = (data.arch || '').toLowerCase(); - const env: BasicEnvInfo = { - kind: this.finder.categoryToKind(data.kind), - executablePath: data.executable ? data.executable : '', - envPath: data.prefix ? data.prefix : undefined, - version: data.version ? parseVersion(data.version) : undefined, - name: data.name ? data.name : '', - displayName: data.displayName ? data.displayName : '', - searchLocation: data.project ? Uri.file(data.project) : undefined, - identifiedUsingNativeLocator: true, - arch: - // eslint-disable-next-line no-nested-ternary - arch === 'x64' ? Architecture.x64 : arch === 'x86' ? Architecture.x86 : undefined, - }; - yield env; - } - } - } - } -} diff --git a/src/client/pythonEnvironments/nativeAPI.ts b/src/client/pythonEnvironments/nativeAPI.ts index 3f4455b00fd3..6690beebf7c9 100644 --- a/src/client/pythonEnvironments/nativeAPI.ts +++ b/src/client/pythonEnvironments/nativeAPI.ts @@ -13,7 +13,7 @@ import { TriggerRefreshOptions, } from './base/locator'; import { PythonEnvCollectionChangedEvent } from './base/watcher'; -import { isNativeInfoEnvironment, NativeEnvInfo, NativePythonFinder } from './base/locators/common/nativePythonFinder'; +import { isNativeEnvInfo, NativeEnvInfo, NativePythonFinder } from './base/locators/common/nativePythonFinder'; import { createDeferred, Deferred } from '../common/utils/async'; import { Architecture } from '../common/utils/platform'; import { parseVersion } from './base/info/pythonVersion'; @@ -21,6 +21,7 @@ import { cache } from '../common/utils/decorators'; import { traceError, traceLog } from '../logging'; import { StopWatch } from '../common/utils/stopWatch'; import { FileChangeType } from '../common/platform/fileSystemWatcher'; +import { categoryToKind } from './base/locators/common/nativePythonUtils'; function makeExecutablePath(prefix?: string): string { if (!prefix) { @@ -149,11 +150,11 @@ function getName(nativeEnv: NativeEnvInfo, kind: PythonEnvKind): string { return ''; } -function toPythonEnvInfo(finder: NativePythonFinder, nativeEnv: NativeEnvInfo): PythonEnvInfo | undefined { +function toPythonEnvInfo(nativeEnv: NativeEnvInfo): PythonEnvInfo | undefined { if (!validEnv(nativeEnv)) { return undefined; } - const kind = finder.categoryToKind(nativeEnv.kind); + const kind = categoryToKind(nativeEnv.kind); const arch = toArch(nativeEnv.arch); const version: PythonVersion = parseVersion(nativeEnv.version ?? ''); const name = getName(nativeEnv, kind); @@ -229,7 +230,7 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { setImmediate(async () => { try { for await (const native of this.finder.refresh()) { - if (!isNativeInfoEnvironment(native) || !validEnv(native)) { + if (!isNativeEnvInfo(native) || !validEnv(native)) { // eslint-disable-next-line no-continue continue; } @@ -237,7 +238,7 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { const envPath = native.executable ?? native.prefix; const version = native.version ? parseVersion(native.version) : undefined; - if (this.finder.categoryToKind(native.kind) === PythonEnvKind.Conda && !native.executable) { + if (categoryToKind(native.kind) === PythonEnvKind.Conda && !native.executable) { // This is a conda env without python, no point trying to resolve this. // There is nothing to resolve this.addEnv(native); @@ -288,7 +289,7 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { } addEnv(native: NativeEnvInfo): void { - const info = toPythonEnvInfo(this.finder, native); + const info = toPythonEnvInfo(native); if (!info) { return; } @@ -310,7 +311,7 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { } const native = await this.finder.resolve(envPath); if (native) { - const env = toPythonEnvInfo(this.finder, native); + const env = toPythonEnvInfo(native); if (env) { const old = this._envs.find((item) => item.executable.filename === env.executable.filename); if (old) { diff --git a/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts b/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts index 45ce63cfbdfc..b807e337a4da 100644 --- a/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts +++ b/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts @@ -37,10 +37,6 @@ class MockNativePythonFinder implements nativeFinder.NativePythonFinder { throw new Error('Method not implemented.'); } - categoryToKind(_category: nativeFinder.PythonEnvironmentKind): PythonEnvKind { - throw new Error('Method not implemented.'); - } - resolve(_executable: string): Promise { throw new Error('Method not implemented.'); } diff --git a/src/test/pythonEnvironments/nativeAPI.unit.test.ts b/src/test/pythonEnvironments/nativeAPI.unit.test.ts index 93fc69951287..89be5dc374e2 100644 --- a/src/test/pythonEnvironments/nativeAPI.unit.test.ts +++ b/src/test/pythonEnvironments/nativeAPI.unit.test.ts @@ -9,14 +9,13 @@ import * as sinon from 'sinon'; import * as nativeAPI from '../../client/pythonEnvironments/nativeAPI'; import { IDiscoveryAPI } from '../../client/pythonEnvironments/base/locator'; import { - categoryToKind, NativeEnvInfo, NativePythonFinder, - PythonEnvironmentKind, } from '../../client/pythonEnvironments/base/locators/common/nativePythonFinder'; import { Architecture } from '../../client/common/utils/platform'; import { PythonEnvInfo, PythonEnvKind, PythonEnvType } from '../../client/pythonEnvironments/base/info'; import { isWindows } from '../../client/common/platform/platformService'; +import { NativePythonEnvironmentKind } from '../../client/pythonEnvironments/base/locators/common/nativePythonUtils'; suite('Native Python API', () => { let api: IDiscoveryAPI; @@ -26,7 +25,7 @@ suite('Native Python API', () => { displayName: 'Basic Python', name: 'basic_python', executable: '/usr/bin/python', - kind: PythonEnvironmentKind.LinuxGlobal, + kind: NativePythonEnvironmentKind.LinuxGlobal, version: `3.12.0`, prefix: '/usr/bin', }; @@ -35,7 +34,7 @@ suite('Native Python API', () => { displayName: 'Basic Python', name: 'basic_python', executable: '/usr/bin/python', - kind: PythonEnvironmentKind.LinuxGlobal, + kind: NativePythonEnvironmentKind.LinuxGlobal, version: undefined, // this is intentionally set to trigger resolve prefix: '/usr/bin', }; @@ -58,7 +57,7 @@ suite('Native Python API', () => { displayName: 'Conda Python', name: 'conda_python', executable: '/home/user/.conda/envs/conda_python/python', - kind: PythonEnvironmentKind.Conda, + kind: NativePythonEnvironmentKind.Conda, version: `3.12.0`, prefix: '/home/user/.conda/envs/conda_python', }; @@ -67,7 +66,7 @@ suite('Native Python API', () => { displayName: 'Conda Python', name: 'conda_python', executable: '/home/user/.conda/envs/conda_python/python', - kind: PythonEnvironmentKind.Conda, + kind: NativePythonEnvironmentKind.Conda, version: undefined, // this is intentionally set to test conda without python prefix: '/home/user/.conda/envs/conda_python', }; @@ -76,7 +75,7 @@ suite('Native Python API', () => { displayName: 'Conda Python', name: 'conda_python', executable: undefined, // this is intentionally set to test env with no executable - kind: PythonEnvironmentKind.Conda, + kind: NativePythonEnvironmentKind.Conda, version: undefined, // this is intentionally set to test conda without python prefix: '/home/user/.conda/envs/conda_python', }; @@ -125,11 +124,6 @@ suite('Native Python API', () => { setup(() => { mockFinder = typemoq.Mock.ofType(); - - mockFinder - .setup((f) => f.categoryToKind(typemoq.It.isAny())) - .returns((category: PythonEnvironmentKind) => categoryToKind(category)); - api = nativeAPI.createNativeEnvironmentsApi(mockFinder.object); }); diff --git a/src/test/pythonEnvironments/nativePythonFinder.unit.test.ts b/src/test/pythonEnvironments/nativePythonFinder.unit.test.ts new file mode 100644 index 000000000000..b6182da8111f --- /dev/null +++ b/src/test/pythonEnvironments/nativePythonFinder.unit.test.ts @@ -0,0 +1,90 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +import { assert } from 'chai'; +import * as sinon from 'sinon'; +import * as typemoq from 'typemoq'; +import { WorkspaceConfiguration } from 'vscode'; +import { + getNativePythonFinder, + isNativeEnvInfo, + NativeEnvInfo, + NativePythonFinder, +} from '../../client/pythonEnvironments/base/locators/common/nativePythonFinder'; +import * as windowsApis from '../../client/common/vscodeApis/windowApis'; +import { MockOutputChannel } from '../mockClasses'; +import * as workspaceApis from '../../client/common/vscodeApis/workspaceApis'; + +suite('Native Python Finder', () => { + let finder: NativePythonFinder; + let createLogOutputChannelStub: sinon.SinonStub; + let getConfigurationStub: sinon.SinonStub; + let configMock: typemoq.IMock; + let getWorkspaceFolderPathsStub: sinon.SinonStub; + + setup(() => { + createLogOutputChannelStub = sinon.stub(windowsApis, 'createLogOutputChannel'); + createLogOutputChannelStub.returns(new MockOutputChannel('locator')); + + getWorkspaceFolderPathsStub = sinon.stub(workspaceApis, 'getWorkspaceFolderPaths'); + getWorkspaceFolderPathsStub.returns([]); + + getConfigurationStub = sinon.stub(workspaceApis, 'getConfiguration'); + configMock = typemoq.Mock.ofType(); + configMock.setup((c) => c.get('venvPath')).returns(() => undefined); + configMock.setup((c) => c.get('venvFolders')).returns(() => []); + configMock.setup((c) => c.get('condaPath')).returns(() => ''); + configMock.setup((c) => c.get('poetryPath')).returns(() => ''); + getConfigurationStub.returns(configMock.object); + + finder = getNativePythonFinder(); + }); + + teardown(() => { + sinon.restore(); + }); + + suiteTeardown(() => { + finder.dispose(); + }); + + test('Refresh should return python environments', async () => { + const envs = []; + for await (const env of finder.refresh()) { + envs.push(env); + } + + // typically all test envs should have at least one environment + assert.isNotEmpty(envs); + }); + + test('Resolve should return python environments with version', async () => { + const envs = []; + for await (const env of finder.refresh()) { + envs.push(env); + } + + // typically all test envs should have at least one environment + assert.isNotEmpty(envs); + + // pick and env without version + const env: NativeEnvInfo | undefined = envs + .filter((e) => isNativeEnvInfo(e)) + .find((e) => e.version && e.version.length > 0 && (e.executable || (e as NativeEnvInfo).prefix)); + + if (env) { + env.version = undefined; + } else { + assert.fail('Expected at least one env with valid version'); + } + + const envPath = env.executable ?? env.prefix; + if (envPath) { + const resolved = await finder.resolve(envPath); + assert.isString(resolved.version, 'Version must be a string'); + assert.isTrue((resolved?.version?.length ?? 0) > 0, 'Version must not be empty'); + } else { + assert.fail('Expected either executable or prefix to be defined'); + } + }); +}); From 1cc490bb49f6131e57a53257077105e89ff511f2 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Fri, 19 Jul 2024 09:27:59 -0700 Subject: [PATCH 030/149] Add executable path as `id` for envs (#23840) --- src/client/pythonEnvironments/nativeAPI.ts | 4 +++- src/test/pythonEnvironments/nativeAPI.unit.test.ts | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/client/pythonEnvironments/nativeAPI.ts b/src/client/pythonEnvironments/nativeAPI.ts index 6690beebf7c9..8f12addabfb4 100644 --- a/src/client/pythonEnvironments/nativeAPI.ts +++ b/src/client/pythonEnvironments/nativeAPI.ts @@ -162,12 +162,14 @@ function toPythonEnvInfo(nativeEnv: NativeEnvInfo): PythonEnvInfo | undefined { ? getDisplayName(version, kind, arch, name) : nativeEnv.displayName ?? 'Python'; + const executable = nativeEnv.executable ?? makeExecutablePath(nativeEnv.prefix); return { name, location: getLocation(nativeEnv), kind, + id: executable, executable: { - filename: nativeEnv.executable ?? makeExecutablePath(nativeEnv.prefix), + filename: executable, sysPrefix: nativeEnv.prefix ?? '', ctime: -1, mtime: -1, diff --git a/src/test/pythonEnvironments/nativeAPI.unit.test.ts b/src/test/pythonEnvironments/nativeAPI.unit.test.ts index 89be5dc374e2..e40016595a7b 100644 --- a/src/test/pythonEnvironments/nativeAPI.unit.test.ts +++ b/src/test/pythonEnvironments/nativeAPI.unit.test.ts @@ -41,6 +41,7 @@ suite('Native Python API', () => { const expectedBasicEnv: PythonEnvInfo = { arch: Architecture.Unknown, + id: '/usr/bin/python', detailedDisplayName: "Python 3.12.0 ('basic_python')", display: "Python 3.12.0 ('basic_python')", distro: { org: '' }, @@ -89,6 +90,7 @@ suite('Native Python API', () => { detailedDisplayName: "Python 3.12.0 ('conda_python')", display: "Python 3.12.0 ('conda_python')", distro: { org: '' }, + id: '/home/user/.conda/envs/conda_python/python', executable: { filename: '/home/user/.conda/envs/conda_python/python', sysPrefix: '/home/user/.conda/envs/conda_python', @@ -108,6 +110,7 @@ suite('Native Python API', () => { detailedDisplayName: 'Conda Python', display: 'Conda Python', distro: { org: '' }, + id: exePath, executable: { filename: exePath, sysPrefix: '/home/user/.conda/envs/conda_python', From 226ba0a343b1415cb776d9b58ec712ec109fbf23 Mon Sep 17 00:00:00 2001 From: DetachHead <57028336+DetachHead@users.noreply.github.com> Date: Tue, 23 Jul 2024 03:59:49 +1000 Subject: [PATCH 031/149] xdist fixes (#23791) - Don't use xdist when only running one test. this makes it slightly faster when running one test, because instead of creating a single worker it just runs the test in the same process - fix #23816 - fix issue where the plugin was being registered multiple times --------- Co-authored-by: detachhead --- python_files/vscode_pytest/__init__.py | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/python_files/vscode_pytest/__init__.py b/python_files/vscode_pytest/__init__.py index 656846513c93..2764d1c89782 100644 --- a/python_files/vscode_pytest/__init__.py +++ b/python_files/vscode_pytest/__init__.py @@ -19,6 +19,7 @@ ) import pytest +from pluggy import Result script_dir = pathlib.Path(__file__).parent.parent sys.path.append(os.fspath(script_dir)) @@ -889,11 +890,25 @@ def send_post_request( class DeferPlugin: @pytest.hookimpl(hookwrapper=True) - def pytest_xdist_auto_num_workers(self, config: pytest.Config) -> Generator[None, int, int]: + def pytest_xdist_auto_num_workers( + self, config: pytest.Config + ) -> Generator[None, Result[int], None]: """Determine how many workers to use based on how many tests were selected in the test explorer.""" - return min((yield), len(config.option.file_or_dir)) + outcome = yield + result = min(outcome.get_result(), len(config.option.file_or_dir)) + if result == 1: + result = 0 + outcome.force_result(result) def pytest_plugin_registered(plugin: object, manager: pytest.PytestPluginManager): - if manager.hasplugin("xdist") and not isinstance(plugin, DeferPlugin): - manager.register(DeferPlugin()) + plugin_name = "vscode_xdist" + if ( + # only register the plugin if xdist is enabled: + manager.hasplugin("xdist") + # prevent infinite recursion: + and not isinstance(plugin, DeferPlugin) + # prevent this plugin from being registered multiple times: + and not manager.hasplugin(plugin_name) + ): + manager.register(DeferPlugin(), name=plugin_name) From f09ab3f651d726367055dd8a748d7f4b43b78c26 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 22 Jul 2024 14:25:33 -0700 Subject: [PATCH 032/149] Ensure env manager executable is set (#23845) --- .../common/environmentManagers/conda.ts | 4 + src/client/pythonEnvironments/nativeAPI.ts | 104 +++++++++++------- .../pythonEnvironments/nativeAPI.unit.test.ts | 44 ++++++++ 3 files changed, 112 insertions(+), 40 deletions(-) diff --git a/src/client/pythonEnvironments/common/environmentManagers/conda.ts b/src/client/pythonEnvironments/common/environmentManagers/conda.ts index d19d3f5c7ffe..71f4242c3b99 100644 --- a/src/client/pythonEnvironments/common/environmentManagers/conda.ts +++ b/src/client/pythonEnvironments/common/environmentManagers/conda.ts @@ -615,3 +615,7 @@ export class Conda { return true; } } + +export function setCondaBinary(executable: string): void { + Conda.setConda(executable); +} diff --git a/src/client/pythonEnvironments/nativeAPI.ts b/src/client/pythonEnvironments/nativeAPI.ts index 8f12addabfb4..d98f5d86406e 100644 --- a/src/client/pythonEnvironments/nativeAPI.ts +++ b/src/client/pythonEnvironments/nativeAPI.ts @@ -13,15 +13,22 @@ import { TriggerRefreshOptions, } from './base/locator'; import { PythonEnvCollectionChangedEvent } from './base/watcher'; -import { isNativeEnvInfo, NativeEnvInfo, NativePythonFinder } from './base/locators/common/nativePythonFinder'; +import { + isNativeEnvInfo, + NativeEnvInfo, + NativeEnvManagerInfo, + NativePythonFinder, +} from './base/locators/common/nativePythonFinder'; import { createDeferred, Deferred } from '../common/utils/async'; import { Architecture } from '../common/utils/platform'; import { parseVersion } from './base/info/pythonVersion'; import { cache } from '../common/utils/decorators'; -import { traceError, traceLog } from '../logging'; +import { traceError, traceLog, traceWarn } from '../logging'; import { StopWatch } from '../common/utils/stopWatch'; import { FileChangeType } from '../common/platform/fileSystemWatcher'; import { categoryToKind } from './base/locators/common/nativePythonUtils'; +import { setCondaBinary } from './common/environmentManagers/conda'; +import { setPyEnvBinary } from './common/environmentManagers/pyenv'; function makeExecutablePath(prefix?: string): string { if (!prefix) { @@ -232,44 +239,10 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { setImmediate(async () => { try { for await (const native of this.finder.refresh()) { - if (!isNativeEnvInfo(native) || !validEnv(native)) { - // eslint-disable-next-line no-continue - continue; - } - try { - const envPath = native.executable ?? native.prefix; - const version = native.version ? parseVersion(native.version) : undefined; - - if (categoryToKind(native.kind) === PythonEnvKind.Conda && !native.executable) { - // This is a conda env without python, no point trying to resolve this. - // There is nothing to resolve - this.addEnv(native); - } else if ( - envPath && - (!version || version.major < 0 || version.minor < 0 || version.micro < 0) - ) { - // We have a path, but no version info, try to resolve the environment. - this.finder - .resolve(envPath) - .then((env) => { - if (env) { - this.addEnv(env); - } - }) - .ignoreErrors(); - } else if ( - envPath && - version && - version.major >= 0 && - version.minor >= 0 && - version.micro >= 0 - ) { - this.addEnv(native); - } else { - traceError(`Failed to process environment: ${JSON.stringify(native)}`); - } - } catch (err) { - traceError(`Failed to process environment: ${err}`); + if (isNativeEnvInfo(native)) { + this.processEnv(native); + } else { + this.processEnvManager(native); } } this._refreshPromise?.resolve(); @@ -286,6 +259,57 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { return this._refreshPromise?.promise; } + private processEnv(native: NativeEnvInfo): void { + if (!validEnv(native)) { + return; + } + + try { + const envPath = native.executable ?? native.prefix; + const version = native.version ? parseVersion(native.version) : undefined; + + if (categoryToKind(native.kind) === PythonEnvKind.Conda && !native.executable) { + // This is a conda env without python, no point trying to resolve this. + // There is nothing to resolve + this.addEnv(native); + } else if (envPath && (!version || version.major < 0 || version.minor < 0 || version.micro < 0)) { + // We have a path, but no version info, try to resolve the environment. + this.finder + .resolve(envPath) + .then((env) => { + if (env) { + this.addEnv(env); + } + }) + .ignoreErrors(); + } else if (envPath && version && version.major >= 0 && version.minor >= 0 && version.micro >= 0) { + this.addEnv(native); + } else { + traceError(`Failed to process environment: ${JSON.stringify(native)}`); + } + } catch (err) { + traceError(`Failed to process environment: ${err}`); + } + } + + // eslint-disable-next-line class-methods-use-this + private processEnvManager(native: NativeEnvManagerInfo) { + const tool = native.tool.toLowerCase(); + switch (tool) { + case 'conda': + traceLog(`Conda environment manager found at: ${native.executable}`); + setCondaBinary(native.executable); + break; + case 'pyenv': + traceLog(`Pyenv environment manager found at: ${native.executable}`); + setPyEnvBinary(native.executable); + break; + default: + traceWarn(`Unknown environment manager: ${native.tool}`); + break; + } + } + getEnvs(_query?: PythonLocatorQuery): PythonEnvInfo[] { return this._envs; } diff --git a/src/test/pythonEnvironments/nativeAPI.unit.test.ts b/src/test/pythonEnvironments/nativeAPI.unit.test.ts index e40016595a7b..2f122d850280 100644 --- a/src/test/pythonEnvironments/nativeAPI.unit.test.ts +++ b/src/test/pythonEnvironments/nativeAPI.unit.test.ts @@ -10,16 +10,21 @@ import * as nativeAPI from '../../client/pythonEnvironments/nativeAPI'; import { IDiscoveryAPI } from '../../client/pythonEnvironments/base/locator'; import { NativeEnvInfo, + NativeEnvManagerInfo, NativePythonFinder, } from '../../client/pythonEnvironments/base/locators/common/nativePythonFinder'; import { Architecture } from '../../client/common/utils/platform'; import { PythonEnvInfo, PythonEnvKind, PythonEnvType } from '../../client/pythonEnvironments/base/info'; import { isWindows } from '../../client/common/platform/platformService'; import { NativePythonEnvironmentKind } from '../../client/pythonEnvironments/base/locators/common/nativePythonUtils'; +import * as condaApi from '../../client/pythonEnvironments/common/environmentManagers/conda'; +import * as pyenvApi from '../../client/pythonEnvironments/common/environmentManagers/pyenv'; suite('Native Python API', () => { let api: IDiscoveryAPI; let mockFinder: typemoq.IMock; + let setCondaBinaryStub: sinon.SinonStub; + let setPyEnvBinaryStub: sinon.SinonStub; const basicEnv: NativeEnvInfo = { displayName: 'Basic Python', @@ -128,6 +133,9 @@ suite('Native Python API', () => { setup(() => { mockFinder = typemoq.Mock.ofType(); api = nativeAPI.createNativeEnvironmentsApi(mockFinder.object); + + setCondaBinaryStub = sinon.stub(condaApi, 'setCondaBinary'); + setPyEnvBinaryStub = sinon.stub(pyenvApi, 'setPyEnvBinary'); }); teardown(() => { @@ -248,4 +256,40 @@ suite('Native Python API', () => { await api.triggerRefresh(); assert.isUndefined(api.getRefreshPromise()); }); + + test('Setting conda binary', async () => { + const condaMgr: NativeEnvManagerInfo = { + tool: 'Conda', + executable: '/usr/bin/conda', + }; + mockFinder + .setup((f) => f.refresh()) + .returns(() => { + async function* generator() { + yield* [condaMgr]; + } + return generator(); + }) + .verifiable(typemoq.Times.once()); + await api.triggerRefresh(); + assert.isTrue(setCondaBinaryStub.calledOnceWith(condaMgr.executable)); + }); + + test('Setting pyenv binary', async () => { + const pyenvMgr: NativeEnvManagerInfo = { + tool: 'PyEnv', + executable: '/usr/bin/pyenv', + }; + mockFinder + .setup((f) => f.refresh()) + .returns(() => { + async function* generator() { + yield* [pyenvMgr]; + } + return generator(); + }) + .verifiable(typemoq.Times.once()); + await api.triggerRefresh(); + assert.isTrue(setPyEnvBinaryStub.calledOnceWith(pyenvMgr.executable)); + }); }); From 7cc813d5c2b63b729869732c18682b84029333ee Mon Sep 17 00:00:00 2001 From: Paula Date: Mon, 22 Jul 2024 16:16:49 -0700 Subject: [PATCH 033/149] Update logging in getConfigurationsForWorkspace (#23847) --- .../extension/configuration/launch.json/launchJsonReader.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts b/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts index ed326b585741..4177dd90e4a2 100644 --- a/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts +++ b/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts @@ -16,7 +16,7 @@ export async function getConfigurationsForWorkspace(workspace: WorkspaceFolder): if (!codeWorkspaceConfig.configurations || !Array.isArray(codeWorkspaceConfig.configurations)) { return []; } - traceLog(`Using launch configuration in workspace folder2.`, codeWorkspaceConfig.configurations); + traceLog('Using configuration in workspace'); return codeWorkspaceConfig.configurations; } @@ -29,7 +29,7 @@ export async function getConfigurationsForWorkspace(workspace: WorkspaceFolder): throw Error('Missing field in launch.json: version'); } // We do not bother ensuring each item is a DebugConfiguration... - traceLog(`Using launch configuration in launch.json file.`); + traceLog('Using configuration in launch.json'); return parsed.configurations; } From 066b9c3dbeeb846bf1b9346a4bcabfe9bd460621 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 22 Jul 2024 17:43:47 -0700 Subject: [PATCH 034/149] Fix `location` for native environments (#23851) --- src/client/pythonEnvironments/nativeAPI.ts | 16 +++++++++------- .../pythonEnvironments/nativeAPI.unit.test.ts | 4 ++-- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/src/client/pythonEnvironments/nativeAPI.ts b/src/client/pythonEnvironments/nativeAPI.ts index d98f5d86406e..dd49b5599906 100644 --- a/src/client/pythonEnvironments/nativeAPI.ts +++ b/src/client/pythonEnvironments/nativeAPI.ts @@ -48,15 +48,17 @@ function toArch(a: string | undefined): Architecture { } } -function getLocation(nativeEnv: NativeEnvInfo): string { - if (nativeEnv.prefix) { - return nativeEnv.prefix; - } +function getLocation(nativeEnv: NativeEnvInfo, executable: string): string { if (nativeEnv.executable) { return nativeEnv.executable; } - // We should not get here: either prefix or executable should always be available - return ''; + + if (nativeEnv.prefix) { + return nativeEnv.prefix; + } + + // This is a path to a generated executable. Needed for backwards compatibility. + return executable; } function kindToShortString(kind: PythonEnvKind): string | undefined { @@ -172,7 +174,7 @@ function toPythonEnvInfo(nativeEnv: NativeEnvInfo): PythonEnvInfo | undefined { const executable = nativeEnv.executable ?? makeExecutablePath(nativeEnv.prefix); return { name, - location: getLocation(nativeEnv), + location: getLocation(nativeEnv, executable), kind, id: executable, executable: { diff --git a/src/test/pythonEnvironments/nativeAPI.unit.test.ts b/src/test/pythonEnvironments/nativeAPI.unit.test.ts index 2f122d850280..c6c684e2b4e5 100644 --- a/src/test/pythonEnvironments/nativeAPI.unit.test.ts +++ b/src/test/pythonEnvironments/nativeAPI.unit.test.ts @@ -52,7 +52,7 @@ suite('Native Python API', () => { distro: { org: '' }, executable: { filename: '/usr/bin/python', sysPrefix: '/usr/bin', ctime: -1, mtime: -1 }, kind: PythonEnvKind.System, - location: '/usr/bin', + location: '/usr/bin/python', source: [], name: 'basic_python', type: undefined, @@ -103,7 +103,7 @@ suite('Native Python API', () => { mtime: -1, }, kind: PythonEnvKind.Conda, - location: '/home/user/.conda/envs/conda_python', + location: '/home/user/.conda/envs/conda_python/python', source: [], name: 'conda_python', type: PythonEnvType.Conda, From 9fad643d76375849095b05c7003f91a58f545179 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Tue, 23 Jul 2024 13:20:42 +1000 Subject: [PATCH 035/149] Ensure telemetry measurements are sent correctly (#23850) --- .../locators/common/nativePythonTelemetry.ts | 36 +++++++++++-------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts index d7b3150cd748..717f1c01a47a 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts @@ -79,6 +79,8 @@ export type RefreshPerformance = { }; }; +let refreshTelemetrySent = false; + export function sendNativeTelemetry(data: NativePythonTelemetry): void { switch (data.event) { case 'MissingCondaEnvironments': { @@ -98,26 +100,30 @@ export function sendNativeTelemetry(data: NativePythonTelemetry): void { break; } case 'RefreshPerformance': { - sendTelemetryEvent(EventName.NATIVE_FINDER_PERF, undefined, { + if (refreshTelemetrySent) { + break; + } + refreshTelemetrySent = true; + sendTelemetryEvent(EventName.NATIVE_FINDER_PERF, { duration: data.data.refreshPerformance.total, breakdownGlobalVirtualEnvs: data.data.refreshPerformance.breakdown.GlobalVirtualEnvs, breakdownLocators: data.data.refreshPerformance.breakdown.Locators, breakdownPath: data.data.refreshPerformance.breakdown.Path, breakdownWorkspaces: data.data.refreshPerformance.breakdown.Workspaces, - locatorConda: data.data.refreshPerformance.locators.Conda, - locatorHomebrew: data.data.refreshPerformance.locators.Homebrew, - locatorLinuxGlobalPython: data.data.refreshPerformance.locators.LinuxGlobalPython, - locatorMacCmdLineTools: data.data.refreshPerformance.locators.MacCmdLineTools, - locatorMacPythonOrg: data.data.refreshPerformance.locators.MacPythonOrg, - locatorMacXCode: data.data.refreshPerformance.locators.MacXCode, - locatorPipEnv: data.data.refreshPerformance.locators.PipEnv, - locatorPoetry: data.data.refreshPerformance.locators.Poetry, - locatorPyEnv: data.data.refreshPerformance.locators.PyEnv, - locatorVenv: data.data.refreshPerformance.locators.Venv, - locatorVirtualEnv: data.data.refreshPerformance.locators.VirtualEnv, - locatorVirtualEnvWrapper: data.data.refreshPerformance.locators.VirtualEnvWrapper, - locatorWindowsRegistry: data.data.refreshPerformance.locators.WindowsRegistry, - locatorWindowsStore: data.data.refreshPerformance.locators.WindowsStore, + locatorConda: data.data.refreshPerformance.locators.Conda || 0, + locatorHomebrew: data.data.refreshPerformance.locators.Homebrew || 0, + locatorLinuxGlobalPython: data.data.refreshPerformance.locators.LinuxGlobalPython || 0, + locatorMacCmdLineTools: data.data.refreshPerformance.locators.MacCmdLineTools || 0, + locatorMacPythonOrg: data.data.refreshPerformance.locators.MacPythonOrg || 0, + locatorMacXCode: data.data.refreshPerformance.locators.MacXCode || 0, + locatorPipEnv: data.data.refreshPerformance.locators.PipEnv || 0, + locatorPoetry: data.data.refreshPerformance.locators.Poetry || 0, + locatorPyEnv: data.data.refreshPerformance.locators.PyEnv || 0, + locatorVenv: data.data.refreshPerformance.locators.Venv || 0, + locatorVirtualEnv: data.data.refreshPerformance.locators.VirtualEnv || 0, + locatorVirtualEnvWrapper: data.data.refreshPerformance.locators.VirtualEnvWrapper || 0, + locatorWindowsRegistry: data.data.refreshPerformance.locators.WindowsRegistry || 0, + locatorWindowsStore: data.data.refreshPerformance.locators.WindowsStore || 0, }); break; } From 82015bc59b2ca41cb560d0cb5010bc62ef86f02f Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 22 Jul 2024 20:22:28 -0700 Subject: [PATCH 036/149] Add support for file system watching with native python locator (#23852) --- src/client/common/vscodeApis/workspaceApis.ts | 20 +++ src/client/pythonEnvironments/base/locator.ts | 2 +- .../base/locators/common/pythonWatcher.ts | 146 ++++++++++++++++ src/client/pythonEnvironments/index.ts | 2 + src/client/pythonEnvironments/nativeAPI.ts | 162 +++++++++++++----- .../pythonEnvironments/nativeAPI.unit.test.ts | 22 ++- 6 files changed, 308 insertions(+), 46 deletions(-) create mode 100644 src/client/pythonEnvironments/base/locators/common/pythonWatcher.ts diff --git a/src/client/common/vscodeApis/workspaceApis.ts b/src/client/common/vscodeApis/workspaceApis.ts index 0e860743a32d..d41c877e5aa8 100644 --- a/src/client/common/vscodeApis/workspaceApis.ts +++ b/src/client/common/vscodeApis/workspaceApis.ts @@ -59,3 +59,23 @@ export function onDidChangeTextDocument(handler: (e: vscode.TextDocumentChangeEv export function onDidChangeConfiguration(handler: (e: vscode.ConfigurationChangeEvent) => unknown): vscode.Disposable { return vscode.workspace.onDidChangeConfiguration(handler); } + +export function createFileSystemWatcher( + globPattern: vscode.GlobPattern, + ignoreCreateEvents?: boolean, + ignoreChangeEvents?: boolean, + ignoreDeleteEvents?: boolean, +): vscode.FileSystemWatcher { + return vscode.workspace.createFileSystemWatcher( + globPattern, + ignoreCreateEvents, + ignoreChangeEvents, + ignoreDeleteEvents, + ); +} + +export function onDidChangeWorkspaceFolders( + handler: (e: vscode.WorkspaceFoldersChangeEvent) => unknown, +): vscode.Disposable { + return vscode.workspace.onDidChangeWorkspaceFolders(handler); +} diff --git a/src/client/pythonEnvironments/base/locator.ts b/src/client/pythonEnvironments/base/locator.ts index 0c7307f32471..0c15f8b27e5f 100644 --- a/src/client/pythonEnvironments/base/locator.ts +++ b/src/client/pythonEnvironments/base/locator.ts @@ -134,7 +134,7 @@ export type PythonLocatorQuery = BasicPythonLocatorQuery & { */ providerId?: string; /** - * If provided, results area limited to this env. + * If provided, results are limited to this env. */ envPath?: string; }; diff --git a/src/client/pythonEnvironments/base/locators/common/pythonWatcher.ts b/src/client/pythonEnvironments/base/locators/common/pythonWatcher.ts new file mode 100644 index 000000000000..ce7851ec729f --- /dev/null +++ b/src/client/pythonEnvironments/base/locators/common/pythonWatcher.ts @@ -0,0 +1,146 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +import { Disposable, Event, EventEmitter, GlobPattern, RelativePattern, Uri, WorkspaceFolder } from 'vscode'; +import { createFileSystemWatcher, getWorkspaceFolder } from '../../../../common/vscodeApis/workspaceApis'; +import { isWindows } from '../../../../common/platform/platformService'; +import { arePathsSame } from '../../../common/externalDependencies'; +import { FileChangeType } from '../../../../common/platform/fileSystemWatcher'; + +export interface PythonWorkspaceEnvEvent { + type: FileChangeType; + workspaceFolder: WorkspaceFolder; + executable: string; +} + +export interface PythonGlobalEnvEvent { + type: FileChangeType; + uri: Uri; +} + +export interface PythonWatcher extends Disposable { + watchWorkspace(wf: WorkspaceFolder): void; + unwatchWorkspace(wf: WorkspaceFolder): void; + onDidWorkspaceEnvChanged: Event; + + watchPath(uri: Uri, pattern?: string): void; + unwatchPath(uri: Uri): void; + onDidGlobalEnvChanged: Event; +} + +/* + * The pattern to search for python executables in the workspace. + * project + * ├── python or python.exe <--- This is what we are looking for. + * ├── .conda + * │ └── python or python.exe <--- This is what we are looking for. + * └── .venv + * │ └── Scripts or bin + * │ └── python or python.exe <--- This is what we are looking for. + */ +const WORKSPACE_PATTERN = isWindows() ? '**/python.exe' : '**/python'; + +class PythonWatcherImpl implements PythonWatcher { + private disposables: Disposable[] = []; + + private readonly _onDidWorkspaceEnvChanged = new EventEmitter(); + + private readonly _onDidGlobalEnvChanged = new EventEmitter(); + + private readonly _disposeMap: Map = new Map(); + + constructor() { + this.disposables.push(this._onDidWorkspaceEnvChanged, this._onDidGlobalEnvChanged); + } + + onDidGlobalEnvChanged: Event = this._onDidGlobalEnvChanged.event; + + onDidWorkspaceEnvChanged: Event = this._onDidWorkspaceEnvChanged.event; + + watchWorkspace(wf: WorkspaceFolder): void { + if (this._disposeMap.has(wf.uri.fsPath)) { + const disposer = this._disposeMap.get(wf.uri.fsPath); + disposer?.dispose(); + } + + const disposables: Disposable[] = []; + const watcher = createFileSystemWatcher(new RelativePattern(wf, WORKSPACE_PATTERN)); + disposables.push( + watcher, + watcher.onDidChange((uri) => { + this.fireWorkspaceEvent(FileChangeType.Changed, wf, uri); + }), + watcher.onDidCreate((uri) => { + this.fireWorkspaceEvent(FileChangeType.Created, wf, uri); + }), + watcher.onDidDelete((uri) => { + this.fireWorkspaceEvent(FileChangeType.Deleted, wf, uri); + }), + ); + + const disposable = { + dispose: () => { + disposables.forEach((d) => d.dispose()); + this._disposeMap.delete(wf.uri.fsPath); + }, + }; + this._disposeMap.set(wf.uri.fsPath, disposable); + } + + unwatchWorkspace(wf: WorkspaceFolder): void { + const disposable = this._disposeMap.get(wf.uri.fsPath); + disposable?.dispose(); + } + + private fireWorkspaceEvent(type: FileChangeType, wf: WorkspaceFolder, uri: Uri) { + const uriWorkspace = getWorkspaceFolder(uri); + if (uriWorkspace && arePathsSame(uriWorkspace.uri.fsPath, wf.uri.fsPath)) { + this._onDidWorkspaceEnvChanged.fire({ type, workspaceFolder: wf, executable: uri.fsPath }); + } + } + + watchPath(uri: Uri, pattern?: string): void { + if (this._disposeMap.has(uri.fsPath)) { + const disposer = this._disposeMap.get(uri.fsPath); + disposer?.dispose(); + } + + const glob: GlobPattern = pattern ? new RelativePattern(uri, pattern) : uri.fsPath; + const disposables: Disposable[] = []; + const watcher = createFileSystemWatcher(glob); + disposables.push( + watcher, + watcher.onDidChange(() => { + this._onDidGlobalEnvChanged.fire({ type: FileChangeType.Changed, uri }); + }), + watcher.onDidCreate(() => { + this._onDidGlobalEnvChanged.fire({ type: FileChangeType.Created, uri }); + }), + watcher.onDidDelete(() => { + this._onDidGlobalEnvChanged.fire({ type: FileChangeType.Deleted, uri }); + }), + ); + + const disposable = { + dispose: () => { + disposables.forEach((d) => d.dispose()); + this._disposeMap.delete(uri.fsPath); + }, + }; + this._disposeMap.set(uri.fsPath, disposable); + } + + unwatchPath(uri: Uri): void { + const disposable = this._disposeMap.get(uri.fsPath); + disposable?.dispose(); + } + + dispose() { + this.disposables.forEach((d) => d.dispose()); + this._disposeMap.forEach((d) => d.dispose()); + } +} + +export function createPythonWatcher(): PythonWatcher { + return new PythonWatcherImpl(); +} diff --git a/src/client/pythonEnvironments/index.ts b/src/client/pythonEnvironments/index.ts index 91064bb67599..373812b33061 100644 --- a/src/client/pythonEnvironments/index.ts +++ b/src/client/pythonEnvironments/index.ts @@ -60,7 +60,9 @@ export async function initialize(ext: ExtensionState): Promise { if (shouldUseNativeLocator()) { const finder = getNativePythonFinder(); + ext.disposables.push(finder); const api = createNativeEnvironmentsApi(finder); + ext.disposables.push(api); registerNewDiscoveryForIOC( // These are what get wrapped in the legacy adapter. ext.legacyIOC.serviceManager, diff --git a/src/client/pythonEnvironments/nativeAPI.ts b/src/client/pythonEnvironments/nativeAPI.ts index dd49b5599906..ddf2371fc319 100644 --- a/src/client/pythonEnvironments/nativeAPI.ts +++ b/src/client/pythonEnvironments/nativeAPI.ts @@ -2,7 +2,7 @@ // Licensed under the MIT License. import * as path from 'path'; -import { Disposable, Event, EventEmitter } from 'vscode'; +import { Disposable, Event, EventEmitter, Uri, WorkspaceFoldersChangeEvent } from 'vscode'; import { PythonEnvInfo, PythonEnvKind, PythonEnvType, PythonVersion } from './base/info'; import { GetRefreshEnvironmentsOptions, @@ -20,15 +20,21 @@ import { NativePythonFinder, } from './base/locators/common/nativePythonFinder'; import { createDeferred, Deferred } from '../common/utils/async'; -import { Architecture } from '../common/utils/platform'; +import { Architecture, getUserHomeDir } from '../common/utils/platform'; import { parseVersion } from './base/info/pythonVersion'; import { cache } from '../common/utils/decorators'; import { traceError, traceLog, traceWarn } from '../logging'; import { StopWatch } from '../common/utils/stopWatch'; import { FileChangeType } from '../common/platform/fileSystemWatcher'; -import { categoryToKind } from './base/locators/common/nativePythonUtils'; +import { categoryToKind, NativePythonEnvironmentKind } from './base/locators/common/nativePythonUtils'; import { setCondaBinary } from './common/environmentManagers/conda'; import { setPyEnvBinary } from './common/environmentManagers/pyenv'; +import { + createPythonWatcher, + PythonGlobalEnvEvent, + PythonWorkspaceEnvEvent, +} from './base/locators/common/pythonWatcher'; +import { getWorkspaceFolders, onDidChangeWorkspaceFolders } from '../common/vscodeApis/workspaceApis'; function makeExecutablePath(prefix?: string): string { if (!prefix) { @@ -209,12 +215,23 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { private _envs: PythonEnvInfo[] = []; + private _disposables: Disposable[] = []; + constructor(private readonly finder: NativePythonFinder) { this._onProgress = new EventEmitter(); this._onChanged = new EventEmitter(); + this.onProgress = this._onProgress.event; this.onChanged = this._onChanged.event; + this.refreshState = ProgressReportStage.idle; + this._disposables.push(this._onProgress, this._onChanged); + + this.initializeWatcher(); + } + + dispose(): void { + this._disposables.forEach((d) => d.dispose()); } refreshState: ProgressReportStage; @@ -240,13 +257,16 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { setImmediate(async () => { try { + const before = this._envs.map((env) => env.executable.filename); + const after: string[] = []; for await (const native of this.finder.refresh()) { - if (isNativeEnvInfo(native)) { - this.processEnv(native); - } else { - this.processEnvManager(native); + const exe = this.processNative(native); + if (exe) { + after.push(exe); } } + const envsToRemove = before.filter((item) => !after.includes(item)); + envsToRemove.forEach((item) => this.removeEnv(item)); this._refreshPromise?.resolve(); } catch (error) { this._refreshPromise?.reject(error); @@ -261,37 +281,48 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { return this._refreshPromise?.promise; } - private processEnv(native: NativeEnvInfo): void { + private processNative(native: NativeEnvInfo | NativeEnvManagerInfo): string | undefined { + if (isNativeEnvInfo(native)) { + return this.processEnv(native); + } + this.processEnvManager(native); + + return undefined; + } + + private processEnv(native: NativeEnvInfo): string | undefined { if (!validEnv(native)) { - return; + return undefined; } try { - const envPath = native.executable ?? native.prefix; const version = native.version ? parseVersion(native.version) : undefined; if (categoryToKind(native.kind) === PythonEnvKind.Conda && !native.executable) { // This is a conda env without python, no point trying to resolve this. // There is nothing to resolve - this.addEnv(native); - } else if (envPath && (!version || version.major < 0 || version.minor < 0 || version.micro < 0)) { + return this.addEnv(native)?.executable.filename; + } + if (native.executable && (!version || version.major < 0 || version.minor < 0 || version.micro < 0)) { // We have a path, but no version info, try to resolve the environment. this.finder - .resolve(envPath) + .resolve(native.executable) .then((env) => { if (env) { this.addEnv(env); } }) .ignoreErrors(); - } else if (envPath && version && version.major >= 0 && version.minor >= 0 && version.micro >= 0) { - this.addEnv(native); - } else { - traceError(`Failed to process environment: ${JSON.stringify(native)}`); + return native.executable; + } + if (native.executable && version && version.major >= 0 && version.minor >= 0 && version.micro >= 0) { + return this.addEnv(native)?.executable.filename; } + traceError(`Failed to process environment: ${JSON.stringify(native)}`); } catch (err) { traceError(`Failed to process environment: ${err}`); } + return undefined; } // eslint-disable-next-line class-methods-use-this @@ -316,20 +347,32 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { return this._envs; } - addEnv(native: NativeEnvInfo): void { + private addEnv(native: NativeEnvInfo, searchLocation?: Uri): PythonEnvInfo | undefined { const info = toPythonEnvInfo(native); - if (!info) { - return; + if (info) { + const old = this._envs.find((item) => item.executable.filename === info.executable.filename); + if (old) { + this._envs = this._envs.filter((item) => item.executable.filename !== info.executable.filename); + this._envs.push(info); + this._onChanged.fire({ type: FileChangeType.Changed, old, new: info, searchLocation }); + } else { + this._envs.push(info); + this._onChanged.fire({ type: FileChangeType.Created, new: info, searchLocation }); + } } - const old = this._envs.find((item) => item.executable.filename === info.executable.filename); - if (old) { - this._envs = this._envs.filter((item) => item.executable.filename !== info.executable.filename); - this._envs.push(info); - this._onChanged.fire({ type: FileChangeType.Changed, old, new: info }); - } else { - this._envs.push(info); - this._onChanged.fire({ type: FileChangeType.Created, new: info }); + + return info; + } + + private removeEnv(env: PythonEnvInfo | string): void { + if (typeof env === 'string') { + const old = this._envs.find((item) => item.executable.filename === env); + this._envs = this._envs.filter((item) => item.executable.filename !== env); + this._onChanged.fire({ type: FileChangeType.Deleted, old }); + return; } + this._envs = this._envs.filter((item) => item.executable.filename !== env.executable.filename); + this._onChanged.fire({ type: FileChangeType.Deleted, old: env }); } @cache(30_000, true) @@ -339,28 +382,63 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { } const native = await this.finder.resolve(envPath); if (native) { - const env = toPythonEnvInfo(native); - if (env) { - const old = this._envs.find((item) => item.executable.filename === env.executable.filename); - if (old) { - this._envs = this._envs.filter((item) => item.executable.filename !== env.executable.filename); - this._envs.push(env); - this._onChanged.fire({ type: FileChangeType.Changed, old, new: env }); + return this.addEnv(native); + } + return undefined; + } + + private initializeWatcher(): void { + const watcher = createPythonWatcher(); + this._disposables.push( + watcher.onDidGlobalEnvChanged((e) => this.pathEventHandler(e)), + watcher.onDidWorkspaceEnvChanged(async (e) => { + await this.workspaceEventHandler(e); + }), + onDidChangeWorkspaceFolders((e: WorkspaceFoldersChangeEvent) => { + e.removed.forEach((wf) => watcher.unwatchWorkspace(wf)); + e.added.forEach((wf) => watcher.watchWorkspace(wf)); + }), + watcher, + ); + + getWorkspaceFolders()?.forEach((wf) => watcher.watchWorkspace(wf)); + const home = getUserHomeDir(); + if (home) { + watcher.watchPath(Uri.file(path.join(home, '.conda', 'environments.txt'))); + } + } + + private async pathEventHandler(e: PythonGlobalEnvEvent): Promise { + if (e.type === FileChangeType.Created || e.type === FileChangeType.Changed) { + if (e.uri.fsPath.endsWith('environment.txt')) { + const before = this._envs + .filter((env) => env.kind === PythonEnvKind.Conda) + .map((env) => env.executable.filename); + for await (const native of this.finder.refresh(NativePythonEnvironmentKind.Conda)) { + this.processNative(native); } + const after = this._envs + .filter((env) => env.kind === PythonEnvKind.Conda) + .map((env) => env.executable.filename); + const envsToRemove = before.filter((item) => !after.includes(item)); + envsToRemove.forEach((item) => this.removeEnv(item)); } - - return env; } - return undefined; } - dispose(): void { - this._onProgress.dispose(); - this._onChanged.dispose(); + private async workspaceEventHandler(e: PythonWorkspaceEnvEvent): Promise { + if (e.type === FileChangeType.Created || e.type === FileChangeType.Changed) { + const native = await this.finder.resolve(e.executable); + if (native) { + this.addEnv(native, e.workspaceFolder.uri); + } + } else { + this.removeEnv(e.executable); + } } } -export function createNativeEnvironmentsApi(finder: NativePythonFinder): IDiscoveryAPI { +export function createNativeEnvironmentsApi(finder: NativePythonFinder): IDiscoveryAPI & Disposable { const native = new NativePythonEnvironments(finder); native.triggerRefresh().ignoreErrors(); return native; diff --git a/src/test/pythonEnvironments/nativeAPI.unit.test.ts b/src/test/pythonEnvironments/nativeAPI.unit.test.ts index c6c684e2b4e5..088a44a0c1a3 100644 --- a/src/test/pythonEnvironments/nativeAPI.unit.test.ts +++ b/src/test/pythonEnvironments/nativeAPI.unit.test.ts @@ -19,12 +19,17 @@ import { isWindows } from '../../client/common/platform/platformService'; import { NativePythonEnvironmentKind } from '../../client/pythonEnvironments/base/locators/common/nativePythonUtils'; import * as condaApi from '../../client/pythonEnvironments/common/environmentManagers/conda'; import * as pyenvApi from '../../client/pythonEnvironments/common/environmentManagers/pyenv'; +import * as pw from '../../client/pythonEnvironments/base/locators/common/pythonWatcher'; +import * as ws from '../../client/common/vscodeApis/workspaceApis'; suite('Native Python API', () => { let api: IDiscoveryAPI; let mockFinder: typemoq.IMock; let setCondaBinaryStub: sinon.SinonStub; let setPyEnvBinaryStub: sinon.SinonStub; + let createPythonWatcherStub: sinon.SinonStub; + let mockWatcher: typemoq.IMock; + let getWorkspaceFoldersStub: sinon.SinonStub; const basicEnv: NativeEnvInfo = { displayName: 'Basic Python', @@ -131,11 +136,22 @@ suite('Native Python API', () => { }; setup(() => { - mockFinder = typemoq.Mock.ofType(); - api = nativeAPI.createNativeEnvironmentsApi(mockFinder.object); - setCondaBinaryStub = sinon.stub(condaApi, 'setCondaBinary'); setPyEnvBinaryStub = sinon.stub(pyenvApi, 'setPyEnvBinary'); + getWorkspaceFoldersStub = sinon.stub(ws, 'getWorkspaceFolders'); + getWorkspaceFoldersStub.returns([]); + + createPythonWatcherStub = sinon.stub(pw, 'createPythonWatcher'); + mockWatcher = typemoq.Mock.ofType(); + createPythonWatcherStub.returns(mockWatcher.object); + + mockWatcher.setup((w) => w.watchWorkspace(typemoq.It.isAny())).returns(() => undefined); + mockWatcher.setup((w) => w.watchPath(typemoq.It.isAny(), typemoq.It.isAny())).returns(() => undefined); + mockWatcher.setup((w) => w.unwatchWorkspace(typemoq.It.isAny())).returns(() => undefined); + mockWatcher.setup((w) => w.unwatchPath(typemoq.It.isAny())).returns(() => undefined); + + mockFinder = typemoq.Mock.ofType(); + api = nativeAPI.createNativeEnvironmentsApi(mockFinder.object); }); teardown(() => { From a45df211785f43f0f8bfa250f943d885be4f6c4c Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Tue, 23 Jul 2024 14:03:26 +1000 Subject: [PATCH 037/149] Add Cache dir for native locator (#23853) --- src/client/common/persistentState.ts | 6 +++++- .../locators/common/nativePythonFinder.ts | 20 +++++++++++++++---- .../composite/envsCollectionService.ts | 10 ++++++++-- src/client/pythonEnvironments/index.ts | 3 ++- 4 files changed, 31 insertions(+), 8 deletions(-) diff --git a/src/client/common/persistentState.ts b/src/client/common/persistentState.ts index e82299bfc670..ab30ac5d611c 100644 --- a/src/client/common/persistentState.ts +++ b/src/client/common/persistentState.ts @@ -3,7 +3,7 @@ 'use strict'; -import { inject, injectable, named } from 'inversify'; +import { inject, injectable, named, optional } from 'inversify'; import { Memento } from 'vscode'; import { IExtensionSingleActivationService } from '../activation/types'; import { traceError } from '../logging'; @@ -19,6 +19,7 @@ import { } from './types'; import { cache } from './utils/decorators'; import { noop } from './utils/misc'; +import { clearCacheDirectory } from '../pythonEnvironments/base/locators/common/nativePythonFinder'; let _workspaceState: Memento | undefined; const _workspaceKeys: string[] = []; @@ -126,6 +127,7 @@ export class PersistentStateFactory implements IPersistentStateFactory, IExtensi @inject(IMemento) @named(GLOBAL_MEMENTO) private globalState: Memento, @inject(IMemento) @named(WORKSPACE_MEMENTO) private workspaceState: Memento, @inject(ICommandManager) private cmdManager?: ICommandManager, + @inject(IExtensionContext) @optional() private context?: IExtensionContext, ) {} public async activate(): Promise { @@ -180,6 +182,7 @@ export class PersistentStateFactory implements IPersistentStateFactory, IExtensi } private async cleanAllPersistentStates(): Promise { + const clearCacheDirPromise = this.context ? clearCacheDirectory(this.context).catch() : Promise.resolve(); await Promise.all( this._globalKeysStorage.value.map(async (keyContent) => { const storage = this.createGlobalPersistentState(keyContent.key); @@ -194,6 +197,7 @@ export class PersistentStateFactory implements IPersistentStateFactory, IExtensi ); await this._globalKeysStorage.updateValue([]); await this._workspaceKeysStorage.updateValue([]); + await clearCacheDirPromise; this.cmdManager?.executeCommand('workbench.action.reloadWindow').then(noop); } } diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index 27e5c2e40d6f..b9e4a91c43b0 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -3,6 +3,7 @@ import { Disposable, EventEmitter, Event, Uri } from 'vscode'; import * as ch from 'child_process'; +import * as fs from 'fs-extra'; import * as path from 'path'; import * as rpc from 'vscode-jsonrpc/node'; import { PassThrough } from 'stream'; @@ -18,6 +19,7 @@ import { getUserHomeDir } from '../../../../common/utils/platform'; import { createLogOutputChannel } from '../../../../common/vscodeApis/windowApis'; import { sendNativeTelemetry, NativePythonTelemetry } from './nativePythonTelemetry'; import { NativePythonEnvironmentKind } from './nativePythonUtils'; +import type { IExtensionContext } from '../../../../common/types'; const untildify = require('untildify'); @@ -98,7 +100,7 @@ class NativePythonFinderImpl extends DisposableBase implements NativePythonFinde private readonly outputChannel = this._register(createLogOutputChannel('Python Locator', { log: true })); - constructor() { + constructor(private readonly cacheDirectory?: Uri) { super(); this.connection = this.start(); void this.configure(); @@ -362,7 +364,7 @@ class NativePythonFinderImpl extends DisposableBase implements NativePythonFinde environmentDirectories: getCustomVirtualEnvDirs(), condaExecutable: getPythonSettingAndUntildify(CONDAPATH_SETTING_KEY), poetryExecutable: getPythonSettingAndUntildify('poetryPath'), - // We don't use pipenvPath as it is not used for discovery + cacheDirectory: this.cacheDirectory?.fsPath, }; // No need to send a configuration request, is there are no changes. if (JSON.stringify(options) === JSON.stringify(this.lastConfiguration || {})) { @@ -418,9 +420,19 @@ function getPythonSettingAndUntildify(name: string, scope?: Uri): T | undefin } let _finder: NativePythonFinder | undefined; -export function getNativePythonFinder(): NativePythonFinder { +export function getNativePythonFinder(context?: IExtensionContext): NativePythonFinder { if (!_finder) { - _finder = new NativePythonFinderImpl(); + const cacheDirectory = context ? getCacheDirectory(context) : undefined; + _finder = new NativePythonFinderImpl(cacheDirectory); } return _finder; } + +export function getCacheDirectory(context: IExtensionContext): Uri { + return Uri.joinPath(context.globalStorageUri, 'pythonLocator'); +} + +export async function clearCacheDirectory(context: IExtensionContext): Promise { + const cacheDirectory = getCacheDirectory(context); + await fs.emptyDir(cacheDirectory.fsPath).catch(noop); +} diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts index 5f1fc7c3bf05..9b2a9b9d54a3 100644 --- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts +++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts @@ -38,6 +38,7 @@ import { Conda, CONDAPATH_SETTING_KEY, isCondaEnvironment } from '../../../commo import { getConfiguration } from '../../../../common/vscodeApis/workspaceApis'; import { getUserHomeDir } from '../../../../common/utils/platform'; import { categoryToKind } from '../common/nativePythonUtils'; +import type { IExtensionContext } from '../../../../common/types'; /** * A service which maintains the collection of known environments. @@ -57,7 +58,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher(); - private nativeFinder = getNativePythonFinder(); + private readonly nativeFinder: NativePythonFinder; public refreshState = ProgressReportStage.discoveryFinished; @@ -70,8 +71,13 @@ export class EnvsCollectionService extends PythonEnvsWatcher { const query: PythonLocatorQuery | undefined = event.providerId ? { providerId: event.providerId, envPath: event.envPath } diff --git a/src/client/pythonEnvironments/index.ts b/src/client/pythonEnvironments/index.ts index 373812b33061..2c6555d62024 100644 --- a/src/client/pythonEnvironments/index.ts +++ b/src/client/pythonEnvironments/index.ts @@ -59,7 +59,7 @@ export async function initialize(ext: ExtensionState): Promise { initializeLegacyExternalDependencies(ext.legacyIOC.serviceContainer); if (shouldUseNativeLocator()) { - const finder = getNativePythonFinder(); + const finder = getNativePythonFinder(ext.context); ext.disposables.push(finder); const api = createNativeEnvironmentsApi(finder); ext.disposables.push(api); @@ -153,6 +153,7 @@ async function createLocator( await createCollectionCache(ext), // This is shared. resolvingLocator, + ext.context, ); return caching; } From 40933177732987e65b754b983e9d994195f967ec Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Tue, 23 Jul 2024 18:23:29 +1000 Subject: [PATCH 038/149] Metrics tracking launch times for native locator (#23854) --- .../locators/common/nativePythonFinder.ts | 21 ++++- .../locators/common/nativePythonTelemetry.ts | 12 ++- src/client/telemetry/index.ts | 77 ++++++++++++++++++- 3 files changed, 105 insertions(+), 5 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index b9e4a91c43b0..4f3352aa98ce 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -20,6 +20,7 @@ import { createLogOutputChannel } from '../../../../common/vscodeApis/windowApis import { sendNativeTelemetry, NativePythonTelemetry } from './nativePythonTelemetry'; import { NativePythonEnvironmentKind } from './nativePythonUtils'; import type { IExtensionContext } from '../../../../common/types'; +import { StopWatch } from '../../../../common/utils/stopWatch'; const untildify = require('untildify'); @@ -100,6 +101,12 @@ class NativePythonFinderImpl extends DisposableBase implements NativePythonFinde private readonly outputChannel = this._register(createLogOutputChannel('Python Locator', { log: true })); + private initialRefreshMetrics = { + timeToSpawn: 0, + timeToConfigure: 0, + timeToRefresh: 0, + }; + constructor(private readonly cacheDirectory?: Uri) { super(); this.connection = this.start(); @@ -199,7 +206,9 @@ class NativePythonFinderImpl extends DisposableBase implements NativePythonFinde const writable = new PassThrough(); const disposables: Disposable[] = []; try { + const stopWatch = new StopWatch(); const proc = ch.spawn(PYTHON_ENV_TOOLS_PATH, ['server'], { env: process.env }); + this.initialRefreshMetrics.timeToSpawn = stopWatch.elapsedTime; proc.stdout.pipe(readable, { end: false }); proc.stderr.on('data', (data) => this.outputChannel.error(data.toString())); writable.pipe(proc.stdin, { end: false }); @@ -251,7 +260,9 @@ class NativePythonFinderImpl extends DisposableBase implements NativePythonFinde this.outputChannel.trace(data.message); } }), - connection.onNotification('telemetry', (data: NativePythonTelemetry) => sendNativeTelemetry(data)), + connection.onNotification('telemetry', (data: NativePythonTelemetry) => + sendNativeTelemetry(data, this.initialRefreshMetrics), + ), connection.onClose(() => { disposables.forEach((d) => d.dispose()); }), @@ -269,6 +280,7 @@ class NativePythonFinderImpl extends DisposableBase implements NativePythonFinde const discovered = disposable.add(new EventEmitter()); const completed = createDeferred(); const pendingPromises: Promise[] = []; + const stopWatch = new StopWatch(); const notifyUponCompletion = () => { const initialCount = pendingPromises.length; @@ -339,7 +351,10 @@ class NativePythonFinderImpl extends DisposableBase implements NativePythonFinde this.configure().then(() => this.connection .sendRequest<{ duration: number }>('refresh', refreshOptions) - .then(({ duration }) => this.outputChannel.info(`Refresh completed in ${duration}ms`)) + .then(({ duration }) => { + this.outputChannel.info(`Refresh completed in ${duration}ms`); + this.initialRefreshMetrics.timeToRefresh = stopWatch.elapsedTime; + }) .catch((ex) => this.outputChannel.error('Refresh error', ex)), ), ); @@ -371,8 +386,10 @@ class NativePythonFinderImpl extends DisposableBase implements NativePythonFinde return; } try { + const stopWatch = new StopWatch(); this.lastConfiguration = options; await this.connection.sendRequest('configure', options); + this.initialRefreshMetrics.timeToConfigure = stopWatch.elapsedTime; } catch (ex) { this.outputChannel.error('Refresh error', ex); } diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts index 717f1c01a47a..6675ca3a7ce7 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts @@ -81,7 +81,14 @@ export type RefreshPerformance = { let refreshTelemetrySent = false; -export function sendNativeTelemetry(data: NativePythonTelemetry): void { +export function sendNativeTelemetry( + data: NativePythonTelemetry, + initialRefreshMetrics: { + timeToSpawn: number; + timeToConfigure: number; + timeToRefresh: number; + }, +): void { switch (data.event) { case 'MissingCondaEnvironments': { sendTelemetryEvent( @@ -124,6 +131,9 @@ export function sendNativeTelemetry(data: NativePythonTelemetry): void { locatorVirtualEnvWrapper: data.data.refreshPerformance.locators.VirtualEnvWrapper || 0, locatorWindowsRegistry: data.data.refreshPerformance.locators.WindowsRegistry || 0, locatorWindowsStore: data.data.refreshPerformance.locators.WindowsStore || 0, + timeToSpawn: initialRefreshMetrics.timeToSpawn, + timeToConfigure: initialRefreshMetrics.timeToConfigure, + timeToRefresh: initialRefreshMetrics.timeToRefresh, }); break; } diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index f7283597b688..8383409d141a 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -1755,38 +1755,111 @@ export interface IEventNamePropertyMapping { "locatorVirtualEnv" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "locatorVirtualEnvWrapper" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "locatorWindowsRegistry" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, - "locatorWindowsStore" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" } + "locatorWindowsStore" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "timeToSpawn" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "timeToConfigure" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "timeToRefresh" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" } } */ [EventName.NATIVE_FINDER_PERF]: { /** * Total duration to find envs using native locator. + * This is the time from the perspective of the Native Locator. + * I.e. starting from the time the request to refresh was received until the end of the refresh. */ duration: number; + /** + * Time taken by all locators to find the environments. + * I.e. time for Conda + Poetry + Pyenv, etc (note: all of them run in parallel). + */ breakdownLocators?: number; + /** + * Time taken to find Python environments in the paths found in the PATH env variable. + */ breakdownPath?: number; + /** + * Time taken to find Python environments in the global virtual env locations. + */ breakdownGlobalVirtualEnvs?: number; + /** + * Time taken to find Python environments in the workspaces. + */ breakdownWorkspaces?: number; + /** + * Time taken to find all global Conda environments. + */ locatorConda?: number; + /** + * Time taken to find all Homebrew environments. + */ locatorHomebrew?: number; + /** + * Time taken to find all global Python environments on Linux. + */ locatorLinuxGlobalPython?: number; + /** + * Time taken to find all Python environments belonging to Mac Command Line Tools . + */ locatorMacCmdLineTools?: number; + /** + * Time taken to find all Python environments belonging to Mac Python Org. + */ locatorMacPythonOrg?: number; + /** + * Time taken to find all Python environments belonging to Mac XCode. + */ locatorMacXCode?: number; + /** + * Time taken to find all Pipenv environments. + */ locatorPipEnv?: number; + /** + * Time taken to find all Poetry environments. + */ locatorPoetry?: number; + /** + * Time taken to find all Pyenv environments. + */ locatorPyEnv?: number; + /** + * Time taken to find all Venv environments. + */ locatorVenv?: number; + /** + * Time taken to find all VirtualEnv environments. + */ locatorVirtualEnv?: number; + /** + * Time taken to find all VirtualEnvWrapper environments. + */ locatorVirtualEnvWrapper?: number; + /** + * Time taken to find all Windows Registry environments. + */ locatorWindowsRegistry?: number; + /** + * Time taken to find all Windows Store environments. + */ locatorWindowsStore?: number; + /** + * Total time taken to spawn the Native Python finder process. + */ + timeToSpawn?: number; + /** + * Total time taken to configure the Native Python finder process. + */ + timeToConfigure?: number; + /** + * Total time taken to refresh the Environments (from perspective of Python extension). + * Time = total time taken to process the `refresh` request. + */ + timeToRefresh?: number; }; /** * Telemetry event sent when discovery of all python environments using the native locator(virtualenv, conda, pipenv etc.) finishes. */ /* __GDPR__ - "python_interpreter_discovery_native" : { + "python_interpreter_discovery_invalid_native" : { "duration" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "invalidVersionsCondaEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "invalidVersionsCustomEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, From 1f12640f0f12f2c294b9c92302f172cf0f5e03d4 Mon Sep 17 00:00:00 2001 From: Erik De Bonte Date: Tue, 23 Jul 2024 10:13:52 -0700 Subject: [PATCH 039/149] Update Pylance settings telemetry property list to match code (#23841) --- src/client/telemetry/pylance.ts | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/client/telemetry/pylance.ts b/src/client/telemetry/pylance.ts index 3f406f2cfcbf..a80dfa7b4118 100644 --- a/src/client/telemetry/pylance.ts +++ b/src/client/telemetry/pylance.ts @@ -329,29 +329,34 @@ "addimportexactmatchonly" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "autoimportcompletions" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "autosearchpaths" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, + "callArgumentNameInlayHints" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "completefunctionparens" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, + "disableTaggedHints" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "disableworkspacesymbol" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "enableextractcodeaction" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, + "enablePytestSupport" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "extracommitchars" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "formatontype" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "functionReturnInlayTypeHints" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "hasconfigfile" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "hasextrapaths" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "importformat" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, + "intelliCodeEnabled" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "includeusersymbolsinautoimport" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "indexing" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "lspinteractivewindows" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "lspnotebooks" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "movesymbol" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, + "nodeExecutable" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "openfilesonly" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "pytestparameterinlaytypehints" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "typecheckingmode" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, + "unusablecompilerflags": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "useimportheuristic" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "uselibrarycodefortypes" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "variableinlaytypehints" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "watchforlibrarychanges" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, - "workspacecount" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, - "unusablecompilerflags": { "classification": "SystemMetaData", "purpose": "FeatureInsight" } + "workspacecount" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" } } */ /* __GDPR__ From 30058f27ebaeba43ef729e10e94fe90a265a2fdf Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Wed, 24 Jul 2024 07:00:53 +1000 Subject: [PATCH 040/149] Add a new measure for native finder perf (#23861) --- .../base/locators/common/nativePythonTelemetry.ts | 1 + src/client/telemetry/index.ts | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts index 6675ca3a7ce7..489b9a98c4aa 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonTelemetry.ts @@ -113,6 +113,7 @@ export function sendNativeTelemetry( refreshTelemetrySent = true; sendTelemetryEvent(EventName.NATIVE_FINDER_PERF, { duration: data.data.refreshPerformance.total, + totalDuration: data.data.refreshPerformance.total, breakdownGlobalVirtualEnvs: data.data.refreshPerformance.breakdown.GlobalVirtualEnvs, breakdownLocators: data.data.refreshPerformance.breakdown.Locators, breakdownPath: data.data.refreshPerformance.breakdown.Path, diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index 8383409d141a..e995ec6d53eb 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -1738,6 +1738,7 @@ export interface IEventNamePropertyMapping { /* __GDPR__ "native_finder_perf" : { "duration" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, + "totalDuration" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "breakdownLocators" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "breakdownPath" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, "breakdownGlobalVirtualEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }, @@ -1767,7 +1768,7 @@ export interface IEventNamePropertyMapping { * This is the time from the perspective of the Native Locator. * I.e. starting from the time the request to refresh was received until the end of the refresh. */ - duration: number; + totalDuration: number; /** * Time taken by all locators to find the environments. * I.e. time for Conda + Poetry + Pyenv, etc (note: all of them run in parallel). From cecdf3ccd123a5d86b15fedf58acaf8120b3edd7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 24 Jul 2024 13:38:07 -0700 Subject: [PATCH 041/149] Bump zipp from 3.17.0 to 3.19.1 in /python_files/jedilsp_requirements (#23778) Bumps [zipp](https://github.com/jaraco/zipp) from 3.17.0 to 3.19.1.
Changelog

Sourced from zipp's changelog.

v3.19.1

Bugfixes

  • Improved handling of malformed zip files. (#119)

v3.19.0

Features

  • Implement is_symlink. (#117)

v3.18.2

No significant changes.

v3.18.1

No significant changes.

v3.18.0

Features

  • Bypass ZipFile.namelist in glob for better performance. (#106)
  • Refactored glob functionality to support a more generalized solution with support for platform-specific path separators. (#108)

Bugfixes

  • Add special accounting for pypy when computing the stack level for text encoding warnings. (#114)
Commits

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=zipp&package-manager=pip&previous-version=3.17.0&new-version=3.19.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) ---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/microsoft/vscode-python/network/alerts).
Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- python_files/jedilsp_requirements/requirements.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/python_files/jedilsp_requirements/requirements.txt b/python_files/jedilsp_requirements/requirements.txt index 5ee0244deb80..657f3d5af90b 100644 --- a/python_files/jedilsp_requirements/requirements.txt +++ b/python_files/jedilsp_requirements/requirements.txt @@ -35,7 +35,7 @@ jedi==0.19.1 \ jedi-language-server==0.41.1 \ --hash=sha256:3f15ca5cc28e728564f7d63583e171b418025582447ce023512e3f2b2d71ebae \ --hash=sha256:ca9b3e7f48b70f0988d85ffde4f01dd1ab94c8e0f69e8c6424e6657117b44f91 - # via -r python_files\jedilsp_requirements\requirements.in + # via -r requirements.in lsprotocol==2023.0.0b1 \ --hash=sha256:ade2cd0fa0ede7965698cb59cd05d3adbd19178fd73e83f72ef57a032fbb9d62 \ --hash=sha256:f7a2d4655cbd5639f373ddd1789807450c543341fa0a32b064ad30dbb9f510d4 @@ -50,7 +50,7 @@ pygls==1.0.2 \ --hash=sha256:6d278d29fa6559b0f7a448263c85cb64ec6e9369548b02f1a7944060848b21f9 \ --hash=sha256:888ed63d1f650b4fc64d603d73d37545386ec533c0caac921aed80f80ea946a4 # via - # -r python_files\jedilsp_requirements\requirements.in + # -r requirements.in # jedi-language-server typeguard==3.0.2 \ --hash=sha256:bbe993854385284ab42fd5bd3bee6f6556577ce8b50696d6cb956d704f286c8e \ @@ -63,7 +63,7 @@ typing-extensions==4.8.0 \ # cattrs # jedi-language-server # typeguard -zipp==3.17.0 \ - --hash=sha256:0e923e726174922dce09c53c59ad483ff7bbb8e572e00c7f7c46b88556409f31 \ - --hash=sha256:84e64a1c28cf7e91ed2078bb8cc8c259cb19b76942096c8d7b84947690cabaf0 +zipp==3.19.1 \ + --hash=sha256:2828e64edb5386ea6a52e7ba7cdb17bb30a73a858f5eb6eb93d8d36f5ea26091 \ + --hash=sha256:35427f6d5594f4acf82d25541438348c26736fa9b3afa2754bcd63cdb99d8e8f # via importlib-metadata From cb31457a56cf5b841eae5108e16ad635aa7f04f8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 24 Jul 2024 13:38:39 -0700 Subject: [PATCH 042/149] Bump importlib-metadata from 8.0.0 to 8.1.0 (#23864) Bumps [importlib-metadata](https://github.com/python/importlib_metadata) from 8.0.0 to 8.1.0.
Changelog

Sourced from importlib-metadata's changelog.

v8.1.0

Features

  • Prioritize valid dists to invalid dists when retrieving by name. (#489)
Commits

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=importlib-metadata&package-manager=pip&previous-version=8.0.0&new-version=8.1.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) ---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/requirements.txt b/requirements.txt index a3fdcad8f9aa..a58927a27629 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,9 +4,9 @@ # # pip-compile --generate-hashes requirements.in # -importlib-metadata==8.0.0 \ - --hash=sha256:15584cf2b1bf449d98ff8a6ff1abef57bf20f3ac6454f431736cd3e660921b2f \ - --hash=sha256:188bd24e4c346d3f0a933f275c2fec67050326a856b9a359881d7c2a697e8812 +importlib-metadata==8.1.0 \ + --hash=sha256:3cd29f739ed65973840b068e3132135ce954c254d48b5b640484467ef7ab3c8c \ + --hash=sha256:fcdcb1d5ead7bdf3dd32657bb94ebe9d2aabfe89a19782ddc32da5041d6ebfb4 # via -r requirements.in microvenv==2023.5.post1 \ --hash=sha256:32c46afea874e300f69f1add0806eb0795fd02b5fb251092fba0b73c059a7d1f \ From 89ebe528fad40fcd05174d1a88a437e192627a34 Mon Sep 17 00:00:00 2001 From: DetachHead <57028336+DetachHead@users.noreply.github.com> Date: Fri, 26 Jul 2024 06:04:41 +1000 Subject: [PATCH 043/149] fix crash when importing `pluggy.Result` on old versions of pluggy (#23866) fixes #23816 --------- Co-authored-by: detachhead Co-authored-by: eleanorjboyd --- python_files/vscode_pytest/__init__.py | 58 +++++++++++++------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/python_files/vscode_pytest/__init__.py b/python_files/vscode_pytest/__init__.py index 2764d1c89782..baa9df90eddd 100644 --- a/python_files/vscode_pytest/__init__.py +++ b/python_files/vscode_pytest/__init__.py @@ -1,6 +1,8 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. +from __future__ import annotations + import atexit import json import os @@ -8,24 +10,24 @@ import sys import traceback from typing import ( + TYPE_CHECKING, Any, Dict, Generator, - List, Literal, - Optional, TypedDict, - Union, ) import pytest -from pluggy import Result script_dir = pathlib.Path(__file__).parent.parent sys.path.append(os.fspath(script_dir)) sys.path.append(os.fspath(script_dir / "lib" / "python")) from testing_tools import socket_manager # noqa: E402 +if TYPE_CHECKING: + from pluggy import Result + class TestData(TypedDict): """A general class that all test objects inherit from.""" @@ -46,7 +48,7 @@ class TestItem(TestData): class TestNode(TestData): """A general class that handles all test data which contains children.""" - children: "list[Union[TestNode, TestItem, None]]" + children: list[TestNode | TestItem | None] class VSCodePytestError(Exception): @@ -209,17 +211,17 @@ class TestOutcome(Dict): test: str outcome: Literal["success", "failure", "skipped", "error"] - message: Union[str, None] - traceback: Union[str, None] - subtest: Optional[str] + message: str | None + traceback: str | None + subtest: str | None def create_test_outcome( testid: str, outcome: str, - message: Union[str, None], - traceback: Union[str, None], - subtype: Optional[str] = None, # noqa: ARG001 + message: str | None, + traceback: str | None, + subtype: str | None = None, # noqa: ARG001 ) -> TestOutcome: """A function that creates a TestOutcome object.""" return TestOutcome( @@ -235,7 +237,7 @@ class TestRunResultDict(Dict[str, Dict[str, TestOutcome]]): """A class that stores all test run results.""" outcome: str - tests: Dict[str, TestOutcome] + tests: dict[str, TestOutcome] @pytest.hookimpl(hookwrapper=True, trylast=True) @@ -384,7 +386,7 @@ def pytest_sessionfinish(session, exitstatus): } post_response(os.fsdecode(cwd), error_node) try: - session_node: Union[TestNode, None] = build_test_tree(session) + session_node: TestNode | None = build_test_tree(session) if not session_node: raise VSCodePytestError( "Something went wrong following pytest finish, \ @@ -430,10 +432,10 @@ def build_test_tree(session: pytest.Session) -> TestNode: session -- the pytest session object. """ session_node = create_session_node(session) - session_children_dict: Dict[str, TestNode] = {} - file_nodes_dict: Dict[Any, TestNode] = {} - class_nodes_dict: Dict[str, TestNode] = {} - function_nodes_dict: Dict[str, TestNode] = {} + session_children_dict: dict[str, TestNode] = {} + file_nodes_dict: dict[Any, TestNode] = {} + class_nodes_dict: dict[str, TestNode] = {} + function_nodes_dict: dict[str, TestNode] = {} # Check to see if the global variable for symlink path is set if SYMLINK_PATH: @@ -492,7 +494,7 @@ def build_test_tree(session: pytest.Session) -> TestNode: if isinstance(test_case.parent, pytest.Class): case_iter = test_case.parent node_child_iter = test_node - test_class_node: Union[TestNode, None] = None + test_class_node: TestNode | None = None while isinstance(case_iter, pytest.Class): # While the given node is a class, create a class and nest the previous node as a child. try: @@ -529,7 +531,7 @@ def build_test_tree(session: pytest.Session) -> TestNode: parent_test_case = create_file_node(test_case.parent) file_nodes_dict[test_case.parent] = parent_test_case parent_test_case["children"].append(test_node) - created_files_folders_dict: Dict[str, TestNode] = {} + created_files_folders_dict: dict[str, TestNode] = {} for file_node in file_nodes_dict.values(): # Iterate through all the files that exist and construct them into nested folders. root_folder_node: TestNode @@ -562,7 +564,7 @@ def build_test_tree(session: pytest.Session) -> TestNode: def build_nested_folders( file_node: TestNode, - created_files_folders_dict: Dict[str, TestNode], + created_files_folders_dict: dict[str, TestNode], session_node: TestNode, ) -> TestNode: """Takes a file or folder and builds the nested folder structure for it. @@ -722,8 +724,8 @@ class DiscoveryPayloadDict(TypedDict): cwd: str status: Literal["success", "error"] - tests: Optional[TestNode] - error: Optional[List[str]] + tests: TestNode | None + error: list[str] | None class ExecutionPayloadDict(Dict): @@ -731,9 +733,9 @@ class ExecutionPayloadDict(Dict): cwd: str status: Literal["success", "error"] - result: Union[TestRunResultDict, None] - not_found: Union[List[str], None] # Currently unused need to check - error: Union[str, None] # Currently unused need to check + result: TestRunResultDict | None + not_found: list[str] | None # Currently unused need to check + error: str | None # Currently unused need to check class EOTPayloadDict(TypedDict): @@ -782,9 +784,7 @@ def get_node_path(node: Any) -> pathlib.Path: atexit.register(lambda: __writer.close() if __writer else None) -def execution_post( - cwd: str, status: Literal["success", "error"], tests: Union[TestRunResultDict, None] -): +def execution_post(cwd: str, status: Literal["success", "error"], tests: TestRunResultDict | None): """Sends a POST request with execution payload details. Args: @@ -829,7 +829,7 @@ def default(self, obj): def send_post_request( - payload: Union[ExecutionPayloadDict, DiscoveryPayloadDict, EOTPayloadDict], + payload: ExecutionPayloadDict | DiscoveryPayloadDict | EOTPayloadDict, cls_encoder=None, ): """ From b13f38d3692f09c31bfe8862dec86628e2fc5edd Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Fri, 26 Jul 2024 09:33:51 -0700 Subject: [PATCH 044/149] Update release_plan.md (#23873) updates including swap with Eleanor and Karthik for June and December --- .github/release_plan.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/release_plan.md b/.github/release_plan.md index 4fbec42adffa..9d0cdecee07c 100644 --- a/.github/release_plan.md +++ b/.github/release_plan.md @@ -8,18 +8,18 @@ Feature freeze is Monday @ 17:00 America/Vancouver, XXX XX. At that point, commi | Month | Primary | Secondary | |:----------|:----------|:------------| -✅ | ~~January~~ | ~~Eleanor~~ | ~~Karthik~~ | -✅ | ~~February~~ | ~~Kartik~~ | ~~Anthony~~ | -✅| ~~March~~ | ~~Karthik~~ | ~~Eleanor~~ | -✅| ~~April~~ | ~~Paula~~ | ~~Eleanor~~ | -| May | Anthony | Karthik | -| June | Eleanor | Paula | +| ~~January~~ | ~~Eleanor~~ | ~~Karthik~~ | +| ~~February~~ | ~~Kartik~~ | ~~Anthony~~ | +| ~~March~~ | ~~Karthik~~ | ~~Eleanor~~ | +| ~~April~~ | ~~Paula~~ | ~~Eleanor~~ | +| ~~May~~ | ~~Anthony~~ | ~~Karthik~~ | +| ~~June~~ | ~~Karthik~~ | ~~Eleanor~~ | | July | Anthony | Karthik | | August | Paula | Anthony | | September | Anthony | Eleanor | | October | Paula | Karthik | | November | Eleanor | Paula | -| December | Karthik | Anthony | +| December | Eleanor | Anthony | Paula: 3 primary, 2 secondary Eleanor: 3 primary (2 left), 3 secondary (2 left) From 279ebbfce2a0885af54cb8538ba672f848896064 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Mon, 29 Jul 2024 12:04:47 -0400 Subject: [PATCH 045/149] Bump version to 2024.12.0-rc (#23881) --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 6419b9f3393e..39c4a6d0ab0c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "python", - "version": "2024.11.0-dev", + "version": "2024.12.0-rc", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "python", - "version": "2024.11.0-dev", + "version": "2024.12.0-rc", "license": "MIT", "dependencies": { "@iarna/toml": "^2.2.5", diff --git a/package.json b/package.json index 5f8a639a11ba..da78518a5e21 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "python", "displayName": "Python", "description": "Python language support with extension access points for IntelliSense (Pylance), Debugging (Python Debugger), linting, formatting, refactoring, unit tests, and more.", - "version": "2024.11.0-dev", + "version": "2024.12.0-rc", "featureFlags": { "usingNewInterpreterStorage": true }, From 774badcdebc543c176b3d0dd346f3321333578e3 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Mon, 29 Jul 2024 09:16:57 -0700 Subject: [PATCH 046/149] Update info-needed-closer.yml (#23876) resolve error: `Error Input required app_id, app_installation_id, app_private_key` --- .github/workflows/info-needed-closer.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/info-needed-closer.yml b/.github/workflows/info-needed-closer.yml index 270715672d9c..64a96b06e556 100644 --- a/.github/workflows/info-needed-closer.yml +++ b/.github/workflows/info-needed-closer.yml @@ -24,6 +24,7 @@ jobs: - name: Run info-needed Closer uses: ./actions/needs-more-info-closer with: + token: ${{secrets.GITHUB_TOKEN}} label: info-needed closeDays: 30 closeComment: "Because we have not heard back with the information we requested, we are closing this issue for now. If you are able to provide the info later on, then we will be happy to re-open this issue to pick up where we left off. \n\nHappy Coding!" From 79515eacd47b23ba222b4b0803ad6606c13cc48b Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Mon, 29 Jul 2024 12:37:44 -0400 Subject: [PATCH 047/149] Bump version to 2024.13.0-dev (#23882) --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 39c4a6d0ab0c..3c5dccda0cad 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "python", - "version": "2024.12.0-rc", + "version": "2024.13.0-dev", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "python", - "version": "2024.12.0-rc", + "version": "2024.13.0-dev", "license": "MIT", "dependencies": { "@iarna/toml": "^2.2.5", diff --git a/package.json b/package.json index da78518a5e21..8e17e9e2bdb1 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "python", "displayName": "Python", "description": "Python language support with extension access points for IntelliSense (Pylance), Debugging (Python Debugger), linting, formatting, refactoring, unit tests, and more.", - "version": "2024.12.0-rc", + "version": "2024.13.0-dev", "featureFlags": { "usingNewInterpreterStorage": true }, From 3641652cca5622839f196c2dc13d5648b8fc8a21 Mon Sep 17 00:00:00 2001 From: Heejae Chang <1333179+heejaechang@users.noreply.github.com> Date: Tue, 30 Jul 2024 16:11:39 -0700 Subject: [PATCH 048/149] Downgrade lsp packages (#23890) found issue on the latest LSP packages - https://github.com/microsoft/vscode-languageserver-node/issues/1525 downgrading to the previous version see PR which moved to newer version - https://github.com/microsoft/vscode-python/commit/bc2f5e367a4db329df2bd26c04fef9d10384fd94 --- package-lock.json | 68 ++++++++++++++++----------------- package.json | 6 +-- src/client/browser/extension.ts | 2 +- 3 files changed, 38 insertions(+), 38 deletions(-) diff --git a/package-lock.json b/package-lock.json index 3c5dccda0cad..73b3b4431bb1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -33,9 +33,9 @@ "unicode": "^14.0.0", "untildify": "^4.0.0", "vscode-debugprotocol": "^1.28.0", - "vscode-jsonrpc": "^9.0.0-next.4", - "vscode-languageclient": "^10.0.0-next.8", - "vscode-languageserver-protocol": "^3.17.6-next.6", + "vscode-jsonrpc": "^9.0.0-next.2", + "vscode-languageclient": "^10.0.0-next.2", + "vscode-languageserver-protocol": "^3.17.6-next.3", "vscode-tas-client": "^0.1.84", "which": "^2.0.2", "winreg": "^1.2.4", @@ -13203,24 +13203,24 @@ "deprecated": "This package has been renamed to @vscode/debugprotocol, please update to the new name" }, "node_modules/vscode-jsonrpc": { - "version": "9.0.0-next.4", - "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-9.0.0-next.4.tgz", - "integrity": "sha512-zSVIr58lJSMYKIsZ5P7GtBbv1eEx25eNyOf0NmEzxmn1GhUNJAVAb5hkA1poKUwj1FRMwN6CeyWxZypmr8SsQQ==", + "version": "9.0.0-next.2", + "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-9.0.0-next.2.tgz", + "integrity": "sha512-meIaXAgChCHzWy45QGU8YpCNyqnZQ/sYeCj32OLDDbUYsCF7AvgpdXx3nnZn9yzr8ed0Od9bW+NGphEmXsqvIQ==", "engines": { "node": ">=14.0.0" } }, "node_modules/vscode-languageclient": { - "version": "10.0.0-next.8", - "resolved": "https://registry.npmjs.org/vscode-languageclient/-/vscode-languageclient-10.0.0-next.8.tgz", - "integrity": "sha512-D9inIHgqKayO9Tv0MeLb3XIL76yTuWmKdHqcGZKzjtQrMGJgASJDYWTapu+yAjEpDp0gmVOaCYyIlLB86ncDoQ==", + "version": "10.0.0-next.2", + "resolved": "https://registry.npmjs.org/vscode-languageclient/-/vscode-languageclient-10.0.0-next.2.tgz", + "integrity": "sha512-ERKtgOkto4pHCxC2u1K3FfsYHSt8AeuZJjg1u/3TvnrCbBkMxrpn5mHWkh4m3rl6qo2Wk4m9YFgU6F7KCWQNZw==", "dependencies": { "minimatch": "^9.0.3", "semver": "^7.6.0", - "vscode-languageserver-protocol": "3.17.6-next.6" + "vscode-languageserver-protocol": "3.17.6-next.3" }, "engines": { - "vscode": "^1.89.0" + "vscode": "^1.86.0" } }, "node_modules/vscode-languageclient/node_modules/brace-expansion": { @@ -13246,18 +13246,18 @@ } }, "node_modules/vscode-languageserver-protocol": { - "version": "3.17.6-next.6", - "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.6-next.6.tgz", - "integrity": "sha512-naxM9kc/phpl0kAFNVPejMUWUtzFXdPYY/BtQTYtfbBbHf8sceHOrKkmf6yynZRu1A4oFtRZNqV3wyFRTWqUHw==", + "version": "3.17.6-next.3", + "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.6-next.3.tgz", + "integrity": "sha512-H8ATH5SAvc3JzttS+AL6g681PiBOZM/l34WP2JZk4akY3y7NqTP+f9cJ+MhrVBbD3aDS8bdAKewZgbFLW6M8Pg==", "dependencies": { - "vscode-jsonrpc": "9.0.0-next.4", - "vscode-languageserver-types": "3.17.6-next.4" + "vscode-jsonrpc": "9.0.0-next.2", + "vscode-languageserver-types": "3.17.6-next.3" } }, "node_modules/vscode-languageserver-types": { - "version": "3.17.6-next.4", - "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.6-next.4.tgz", - "integrity": "sha512-SeJTpH/S14EbxOAVaOUoGVqPToqpRTld5QO5Ghig3AlbFJTFF9Wu7srHMfa85L0SX1RYAuuCSFKJVVCxDIk1/Q==" + "version": "3.17.6-next.3", + "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.6-next.3.tgz", + "integrity": "sha512-l5kNFXFRQGuzriXpuBqFpRmkf6f6A4VoU3h95OsVkqIOoi1k7KbwSo600cIdsKSJWrPg/+vX+QMPcMw1oI7ItA==" }, "node_modules/vscode-tas-client": { "version": "0.1.84", @@ -24210,18 +24210,18 @@ "integrity": "sha512-+OMm11R1bGYbpIJ5eQIkwoDGFF4GvBz3Ztl6/VM+/RNNb2Gjk2c0Ku+oMmfhlTmTlPCpgHBsH4JqVCbUYhu5bA==" }, "vscode-jsonrpc": { - "version": "9.0.0-next.4", - "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-9.0.0-next.4.tgz", - "integrity": "sha512-zSVIr58lJSMYKIsZ5P7GtBbv1eEx25eNyOf0NmEzxmn1GhUNJAVAb5hkA1poKUwj1FRMwN6CeyWxZypmr8SsQQ==" + "version": "9.0.0-next.2", + "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-9.0.0-next.2.tgz", + "integrity": "sha512-meIaXAgChCHzWy45QGU8YpCNyqnZQ/sYeCj32OLDDbUYsCF7AvgpdXx3nnZn9yzr8ed0Od9bW+NGphEmXsqvIQ==" }, "vscode-languageclient": { - "version": "10.0.0-next.8", - "resolved": "https://registry.npmjs.org/vscode-languageclient/-/vscode-languageclient-10.0.0-next.8.tgz", - "integrity": "sha512-D9inIHgqKayO9Tv0MeLb3XIL76yTuWmKdHqcGZKzjtQrMGJgASJDYWTapu+yAjEpDp0gmVOaCYyIlLB86ncDoQ==", + "version": "10.0.0-next.2", + "resolved": "https://registry.npmjs.org/vscode-languageclient/-/vscode-languageclient-10.0.0-next.2.tgz", + "integrity": "sha512-ERKtgOkto4pHCxC2u1K3FfsYHSt8AeuZJjg1u/3TvnrCbBkMxrpn5mHWkh4m3rl6qo2Wk4m9YFgU6F7KCWQNZw==", "requires": { "minimatch": "^9.0.3", "semver": "^7.6.0", - "vscode-languageserver-protocol": "3.17.6-next.6" + "vscode-languageserver-protocol": "3.17.6-next.3" }, "dependencies": { "brace-expansion": { @@ -24243,18 +24243,18 @@ } }, "vscode-languageserver-protocol": { - "version": "3.17.6-next.6", - "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.6-next.6.tgz", - "integrity": "sha512-naxM9kc/phpl0kAFNVPejMUWUtzFXdPYY/BtQTYtfbBbHf8sceHOrKkmf6yynZRu1A4oFtRZNqV3wyFRTWqUHw==", + "version": "3.17.6-next.3", + "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.6-next.3.tgz", + "integrity": "sha512-H8ATH5SAvc3JzttS+AL6g681PiBOZM/l34WP2JZk4akY3y7NqTP+f9cJ+MhrVBbD3aDS8bdAKewZgbFLW6M8Pg==", "requires": { - "vscode-jsonrpc": "9.0.0-next.4", - "vscode-languageserver-types": "3.17.6-next.4" + "vscode-jsonrpc": "9.0.0-next.2", + "vscode-languageserver-types": "3.17.6-next.3" } }, "vscode-languageserver-types": { - "version": "3.17.6-next.4", - "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.6-next.4.tgz", - "integrity": "sha512-SeJTpH/S14EbxOAVaOUoGVqPToqpRTld5QO5Ghig3AlbFJTFF9Wu7srHMfa85L0SX1RYAuuCSFKJVVCxDIk1/Q==" + "version": "3.17.6-next.3", + "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.6-next.3.tgz", + "integrity": "sha512-l5kNFXFRQGuzriXpuBqFpRmkf6f6A4VoU3h95OsVkqIOoi1k7KbwSo600cIdsKSJWrPg/+vX+QMPcMw1oI7ItA==" }, "vscode-tas-client": { "version": "0.1.84", diff --git a/package.json b/package.json index 8e17e9e2bdb1..649e19af1c67 100644 --- a/package.json +++ b/package.json @@ -1536,9 +1536,9 @@ "unicode": "^14.0.0", "untildify": "^4.0.0", "vscode-debugprotocol": "^1.28.0", - "vscode-jsonrpc": "^9.0.0-next.4", - "vscode-languageclient": "^10.0.0-next.8", - "vscode-languageserver-protocol": "^3.17.6-next.6", + "vscode-jsonrpc": "^9.0.0-next.2", + "vscode-languageclient": "^10.0.0-next.2", + "vscode-languageserver-protocol": "^3.17.6-next.3", "vscode-tas-client": "^0.1.84", "which": "^2.0.2", "winreg": "^1.2.4", diff --git a/src/client/browser/extension.ts b/src/client/browser/extension.ts index 35854d141cad..28e1912f67e4 100644 --- a/src/client/browser/extension.ts +++ b/src/client/browser/extension.ts @@ -108,7 +108,7 @@ async function runPylance( middleware, }; - const client = new LanguageClient('python', 'Python Language Server', worker, clientOptions); + const client = new LanguageClient('python', 'Python Language Server', clientOptions, worker); languageClient = client; context.subscriptions.push( From 3dad6c9327de34a39443c47ea25c1cfc56202b83 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Wed, 31 Jul 2024 15:31:02 -0400 Subject: [PATCH 049/149] Add tests for native REPL (#23729) Resolves: https://github.com/microsoft/vscode-python/issues/23519 --- package-lock.json | 11 ++ package.json | 2 +- src/client/common/application/commands.ts | 4 +- src/client/extensionActivation.ts | 5 +- src/client/repl/replCommands.ts | 7 +- src/test/repl/replCommand.test.ts | 204 ++++++++++++++++++++++ 6 files changed, 226 insertions(+), 7 deletions(-) create mode 100644 src/test/repl/replCommand.test.ts diff --git a/package-lock.json b/package-lock.json index 73b3b4431bb1..bde67795d468 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,6 +12,7 @@ "@iarna/toml": "^2.2.5", "@vscode/extension-telemetry": "^0.8.4", "arch": "^2.1.0", + "diff-match-patch": "^1.0.5", "fs-extra": "^10.0.1", "glob": "^7.2.0", "hash.js": "^1.1.7", @@ -4636,6 +4637,11 @@ "node": ">=0.3.1" } }, + "node_modules/diff-match-patch": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/diff-match-patch/-/diff-match-patch-1.0.5.tgz", + "integrity": "sha512-IayShXAgj/QMXgB0IWmKx+rOPuGMhqm5w6jvFxmVenXKIzRqTAAsbBPT3kWQeGANj3jGgvcvv4yK6SxqYmikgw==" + }, "node_modules/diffie-hellman": { "version": "5.0.3", "resolved": "https://registry.npmjs.org/diffie-hellman/-/diffie-hellman-5.0.3.tgz", @@ -17602,6 +17608,11 @@ "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", "dev": true }, + "diff-match-patch": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/diff-match-patch/-/diff-match-patch-1.0.5.tgz", + "integrity": "sha512-IayShXAgj/QMXgB0IWmKx+rOPuGMhqm5w6jvFxmVenXKIzRqTAAsbBPT3kWQeGANj3jGgvcvv4yK6SxqYmikgw==" + }, "diffie-hellman": { "version": "5.0.3", "resolved": "https://registry.npmjs.org/diffie-hellman/-/diffie-hellman-5.0.3.tgz", diff --git a/package.json b/package.json index 649e19af1c67..0b2def5937f6 100644 --- a/package.json +++ b/package.json @@ -87,7 +87,7 @@ "description": "%walkthrough.pythonWelcome.description%", "when": "workspacePlatform != webworker", "steps": [ - { + { "id": "python.createPythonFolder", "title": "%walkthrough.step.python.createPythonFolder.title%", "description": "%walkthrough.step.python.createPythonFolder.description%", diff --git a/src/client/common/application/commands.ts b/src/client/common/application/commands.ts index 4c00971ffdd5..388bcf8052fa 100644 --- a/src/client/common/application/commands.ts +++ b/src/client/common/application/commands.ts @@ -38,8 +38,6 @@ interface ICommandNameWithoutArgumentTypeMapping { [Commands.Enable_SourceMap_Support]: []; [Commands.Exec_Selection_In_Terminal]: []; [Commands.Exec_Selection_In_Django_Shell]: []; - [Commands.Exec_In_REPL]: []; - [Commands.Exec_In_REPL_Enter]: []; [Commands.Create_Terminal]: []; [Commands.PickLocalProcess]: []; [Commands.ClearStorage]: []; @@ -98,6 +96,8 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu ['workbench.action.openIssueReporter']: [{ extensionId: string; issueBody: string }]; [Commands.GetSelectedInterpreterPath]: [{ workspaceFolder: string } | string[]]; [Commands.TriggerEnvironmentSelection]: [undefined | Uri]; + [Commands.Exec_In_REPL]: [undefined | Uri]; + [Commands.Exec_In_REPL_Enter]: [undefined | Uri]; [Commands.Exec_In_Terminal]: [undefined, Uri]; [Commands.Exec_In_Terminal_Icon]: [undefined, Uri]; [Commands.Debug_In_Terminal]: [Uri]; diff --git a/src/client/extensionActivation.ts b/src/client/extensionActivation.ts index f401f2493eed..6f2a4565299f 100644 --- a/src/client/extensionActivation.ts +++ b/src/client/extensionActivation.ts @@ -107,8 +107,9 @@ export function activateFeatures(ext: ExtensionState, _components: Components): pathUtils, ); const executionHelper = ext.legacyIOC.serviceContainer.get(ICodeExecutionHelper); - registerReplCommands(ext.disposables, interpreterService, executionHelper); - registerReplExecuteOnEnter(ext.disposables, interpreterService); + const commandManager = ext.legacyIOC.serviceContainer.get(ICommandManager); + registerReplCommands(ext.disposables, interpreterService, executionHelper, commandManager); + registerReplExecuteOnEnter(ext.disposables, interpreterService, commandManager); } /// ////////////////////////// diff --git a/src/client/repl/replCommands.ts b/src/client/repl/replCommands.ts index 7c4977b1aeff..c3f167ff51cc 100644 --- a/src/client/repl/replCommands.ts +++ b/src/client/repl/replCommands.ts @@ -1,5 +1,6 @@ import { commands, Uri, window } from 'vscode'; import { Disposable } from 'vscode-jsonrpc'; +import { ICommandManager } from '../common/application/types'; import { Commands } from '../common/constants'; import { noop } from '../common/utils/misc'; import { IInterpreterService } from '../interpreter/contracts'; @@ -24,9 +25,10 @@ export async function registerReplCommands( disposables: Disposable[], interpreterService: IInterpreterService, executionHelper: ICodeExecutionHelper, + commandManager: ICommandManager, ): Promise { disposables.push( - commands.registerCommand(Commands.Exec_In_REPL, async (uri: Uri) => { + commandManager.registerCommand(Commands.Exec_In_REPL, async (uri: Uri) => { const nativeREPLSetting = getSendToNativeREPLSetting(); if (!nativeREPLSetting) { @@ -64,9 +66,10 @@ export async function registerReplCommands( export async function registerReplExecuteOnEnter( disposables: Disposable[], interpreterService: IInterpreterService, + commandManager: ICommandManager, ): Promise { disposables.push( - commands.registerCommand(Commands.Exec_In_REPL_Enter, async (uri: Uri) => { + commandManager.registerCommand(Commands.Exec_In_REPL_Enter, async (uri: Uri) => { const interpreter = await interpreterService.getActiveInterpreter(uri); if (!interpreter) { commands.executeCommand(Commands.TriggerEnvironmentSelection, uri).then(noop, noop); diff --git a/src/test/repl/replCommand.test.ts b/src/test/repl/replCommand.test.ts new file mode 100644 index 000000000000..444b8e5f16b9 --- /dev/null +++ b/src/test/repl/replCommand.test.ts @@ -0,0 +1,204 @@ +// Create test suite and test cases for the `replUtils` module +import * as TypeMoq from 'typemoq'; +import { Disposable } from 'vscode'; +import * as sinon from 'sinon'; +import { expect } from 'chai'; +import { IInterpreterService } from '../../client/interpreter/contracts'; +import { ICommandManager } from '../../client/common/application/types'; +import { ICodeExecutionHelper } from '../../client/terminals/types'; +import * as replCommands from '../../client/repl/replCommands'; +import * as replUtils from '../../client/repl/replUtils'; +import * as nativeRepl from '../../client/repl/nativeRepl'; +import { Commands } from '../../client/common/constants'; +import { PythonEnvironment } from '../../client/pythonEnvironments/info'; + +suite('REPL - register native repl command', () => { + let interpreterService: TypeMoq.IMock; + let commandManager: TypeMoq.IMock; + let executionHelper: TypeMoq.IMock; + let getSendToNativeREPLSettingStub: sinon.SinonStub; + // @ts-ignore: TS6133 + // eslint-disable-next-line @typescript-eslint/no-unused-vars + let registerCommandSpy: sinon.SinonSpy; + let executeInTerminalStub: sinon.SinonStub; + let getNativeReplStub: sinon.SinonStub; + let disposable: TypeMoq.IMock; + let disposableArray: Disposable[] = []; + setup(() => { + interpreterService = TypeMoq.Mock.ofType(); + commandManager = TypeMoq.Mock.ofType(); + executionHelper = TypeMoq.Mock.ofType(); + commandManager + .setup((cm) => cm.registerCommand(TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny())) + .returns(() => TypeMoq.Mock.ofType().object); + + getSendToNativeREPLSettingStub = sinon.stub(replUtils, 'getSendToNativeREPLSetting'); + getSendToNativeREPLSettingStub.returns(false); + executeInTerminalStub = sinon.stub(replUtils, 'executeInTerminal'); + executeInTerminalStub.returns(Promise.resolve()); + registerCommandSpy = sinon.spy(commandManager.object, 'registerCommand'); + disposable = TypeMoq.Mock.ofType(); + disposableArray = [disposable.object]; + }); + + teardown(() => { + sinon.restore(); + disposableArray.forEach((d) => { + if (d) { + d.dispose(); + } + }); + + disposableArray = []; + }); + + test('Ensure repl command is registered', async () => { + interpreterService + .setup((i) => i.getActiveInterpreter(TypeMoq.It.isAny())) + .returns(() => Promise.resolve(({ path: 'ps' } as unknown) as PythonEnvironment)); + + await replCommands.registerReplCommands( + disposableArray, + interpreterService.object, + executionHelper.object, + commandManager.object, + ); + + commandManager.verify( + (c) => c.registerCommand(TypeMoq.It.isAny(), TypeMoq.It.isAny()), + TypeMoq.Times.atLeastOnce(), + ); + }); + + test('Ensure getSendToNativeREPLSetting is called', async () => { + interpreterService + .setup((i) => i.getActiveInterpreter(TypeMoq.It.isAny())) + .returns(() => Promise.resolve(({ path: 'ps' } as unknown) as PythonEnvironment)); + + let commandHandler: undefined | (() => Promise); + commandManager + // eslint-disable-next-line @typescript-eslint/no-explicit-any + .setup((c) => c.registerCommand as any) + // eslint-disable-next-line @typescript-eslint/no-explicit-any + .returns(() => (command: string, callback: (...args: any[]) => any, _thisArg?: any) => { + if (command === Commands.Exec_In_REPL) { + commandHandler = callback; + } + // eslint-disable-next-line no-void + return { dispose: () => void 0 }; + }); + replCommands.registerReplCommands( + disposableArray, + interpreterService.object, + executionHelper.object, + commandManager.object, + ); + + expect(commandHandler).not.to.be.an('undefined', 'Command handler not initialized'); + + await commandHandler!(); + + sinon.assert.calledOnce(getSendToNativeREPLSettingStub); + }); + + test('Ensure executeInTerminal is called when getSendToNativeREPLSetting returns false', async () => { + interpreterService + .setup((i) => i.getActiveInterpreter(TypeMoq.It.isAny())) + .returns(() => Promise.resolve(({ path: 'ps' } as unknown) as PythonEnvironment)); + getSendToNativeREPLSettingStub.returns(false); + + let commandHandler: undefined | (() => Promise); + commandManager + // eslint-disable-next-line @typescript-eslint/no-explicit-any + .setup((c) => c.registerCommand as any) + // eslint-disable-next-line @typescript-eslint/no-explicit-any + .returns(() => (command: string, callback: (...args: any[]) => any, _thisArg?: any) => { + if (command === Commands.Exec_In_REPL) { + commandHandler = callback; + } + // eslint-disable-next-line no-void + return { dispose: () => void 0 }; + }); + replCommands.registerReplCommands( + disposableArray, + interpreterService.object, + executionHelper.object, + commandManager.object, + ); + + expect(commandHandler).not.to.be.an('undefined', 'Command handler not initialized'); + + await commandHandler!(); + + sinon.assert.calledOnce(executeInTerminalStub); + }); + + test('Ensure we call getNativeREPL() when interpreter exist', async () => { + interpreterService + .setup((i) => i.getActiveInterpreter(TypeMoq.It.isAny())) + .returns(() => Promise.resolve(({ path: 'ps' } as unknown) as PythonEnvironment)); + getSendToNativeREPLSettingStub.returns(true); + getNativeReplStub = sinon.stub(nativeRepl, 'getNativeRepl'); + + let commandHandler: undefined | ((uri: string) => Promise); + commandManager + // eslint-disable-next-line @typescript-eslint/no-explicit-any + .setup((c) => c.registerCommand as any) + // eslint-disable-next-line @typescript-eslint/no-explicit-any + .returns(() => (command: string, callback: (...args: any[]) => any, _thisArg?: any) => { + if (command === Commands.Exec_In_REPL) { + commandHandler = callback; + } + // eslint-disable-next-line no-void + return { dispose: () => void 0 }; + }); + replCommands.registerReplCommands( + disposableArray, + interpreterService.object, + executionHelper.object, + commandManager.object, + ); + + expect(commandHandler).not.to.be.an('undefined', 'Command handler not initialized'); + + await commandHandler!('uri'); + sinon.assert.calledOnce(getNativeReplStub); + }); + + test('Ensure we do not call getNativeREPL() when interpreter does not exist', async () => { + getNativeReplStub = sinon.stub(nativeRepl, 'getNativeRepl'); + getSendToNativeREPLSettingStub.returns(true); + + interpreterService + .setup((i) => i.getActiveInterpreter(TypeMoq.It.isAny())) + .returns(() => Promise.resolve(undefined)); + + let commandHandler: undefined | ((uri: string) => Promise); + commandManager + // eslint-disable-next-line @typescript-eslint/no-explicit-any + .setup((c) => c.registerCommand as any) + // eslint-disable-next-line @typescript-eslint/no-explicit-any + .returns(() => (command: string, callback: (...args: any[]) => any, _thisArg?: any) => { + if (command === Commands.Exec_In_REPL) { + commandHandler = callback; + } + // eslint-disable-next-line no-void + return { dispose: () => void 0 }; + }); + interpreterService + .setup((i) => i.getActiveInterpreter(TypeMoq.It.isAny())) + .returns(() => Promise.resolve(undefined)); + + replCommands.registerReplCommands( + disposableArray, + interpreterService.object, + executionHelper.object, + commandManager.object, + ); + + expect(commandHandler).not.to.be.an('undefined', 'Command handler not initialized'); + + await commandHandler!('uri'); + sinon.assert.notCalled(getNativeReplStub); + }); +}); From 40302fd84bd2f263782e576ab208ac2c6a29225c Mon Sep 17 00:00:00 2001 From: Luciana Abud <45497113+luabud@users.noreply.github.com> Date: Thu, 1 Aug 2024 15:46:47 -0700 Subject: [PATCH 050/149] Add GDPR tags for Pylance event (#23900) --- src/client/telemetry/pylance.ts | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/client/telemetry/pylance.ts b/src/client/telemetry/pylance.ts index a80dfa7b4118..93129718bc94 100644 --- a/src/client/telemetry/pylance.ts +++ b/src/client/telemetry/pylance.ts @@ -395,3 +395,11 @@ "index_count" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" } } */ +/** + * Telemetry event sent when LSP server crashes + */ +/* __GDPR__ +"language_server_crash" : { + "oom" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "rchiodo" } +} +*/ From 8ad3b94aa60e85502e5af829b2de5ac085f19a8e Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Fri, 2 Aug 2024 16:11:28 -0700 Subject: [PATCH 051/149] Update release plan for stable (#23896) --- .github/release_plan.md | 4 ++++ build/azure-pipeline.stable.yml | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/release_plan.md b/.github/release_plan.md index 9d0cdecee07c..ecff43a28ee0 100644 --- a/.github/release_plan.md +++ b/.github/release_plan.md @@ -40,6 +40,9 @@ NOTE: the number of this release is in the issue title and can be substituted in - [ ] checkout to `main` on your local machine and run `git fetch` to ensure your local is up to date with the remote repo. - [ ] Create a new branch called **`bump-release-[YYYY.minor]`**. +- [ ] Update `pet`: + - [ ] Go to the [pet](https://github.com/microsoft/python-environment-tools) repo and check `main` and latest `release/*` branch. If there are new changes in `main` then create a branch called `release/YYYY.minor` (matching python extension release `major.minor`). + - [ ] Update `build\azure-pipeline.stable.yml` to point to the latest `release/YYYY.minor` for `python-environment-tools`. - [ ] Change the version in `package.json` to the next **even** number and switch the `-dev` to `-rc`. (🤖) - [ ] Run `npm install` to make sure `package-lock.json` is up-to-date _(you should now see changes to the `package.json` and `package-lock.json` at this point which update the version number **only**)_. (🤖) - [ ] Update `ThirdPartyNotices-Repository.txt` as appropriate. You can check by looking at the [commit history](https://github.com/microsoft/vscode-python/commits/main) and scrolling through to see if there's anything listed there which might have pulled in some code directly into the repository from somewhere else. If you are still unsure you can check with the team. @@ -111,6 +114,7 @@ NOTE: this PR should make all CI relating to `main` be passing again (such as th - [ ] Create a branch against **`release/YYYY.minor`** called **`release-[YYYY.minor.point]`**. - [ ] Bump the point version number in the `package.json` to the next `YYYY.minor.point` - [ ] Run `npm install` to make sure `package-lock.json` is up-to-date _(you should now see changes to the `package.json` and `package-lock.json` only relating to the new version number)_ . (🤖) +- [ ] If Point Release is due to an issue in `pet`. Update `build\azure-pipeline.stable.yml` to point to the branch `release/YYYY.minor` for `python-environment-tools` with the fix or decided by the team. - [ ] Create a PR from this branch against `release/YYYY.minor` - [ ] **Rebase** and merge this PR into the release branch - [ ] Create a draft GitHub release for the release notes (🤖) ❄️ diff --git a/build/azure-pipeline.stable.yml b/build/azure-pipeline.stable.yml index 5feccd962d51..ec59f05ef360 100644 --- a/build/azure-pipeline.stable.yml +++ b/build/azure-pipeline.stable.yml @@ -17,7 +17,7 @@ resources: - repository: python-environment-tools type: github name: microsoft/python-environment-tools - ref: release/latest + ref: release/2024.12 endpoint: Monaco parameters: From f6a6a322dc718b8ad06547bbf1998f060f318341 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Tue, 6 Aug 2024 14:36:33 +1000 Subject: [PATCH 052/149] Remove the middleware addon component from all language servers (#23898) Fixes #23897 --- src/client/activation/hidingMiddleware.ts | 500 ------------------ .../jedi/languageClientMiddleware.ts | 1 - .../activation/languageClientMiddleware.ts | 43 -- .../node/languageClientMiddleware.ts | 8 - 4 files changed, 552 deletions(-) delete mode 100644 src/client/activation/hidingMiddleware.ts diff --git a/src/client/activation/hidingMiddleware.ts b/src/client/activation/hidingMiddleware.ts deleted file mode 100644 index 91258b7d844c..000000000000 --- a/src/client/activation/hidingMiddleware.ts +++ /dev/null @@ -1,500 +0,0 @@ -/* eslint-disable consistent-return */ -/* eslint-disable class-methods-use-this */ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. -import { - CallHierarchyIncomingCall, - CallHierarchyItem, - CallHierarchyOutgoingCall, - CancellationToken, - CodeAction, - CodeActionContext, - CodeLens, - Color, - ColorInformation, - ColorPresentation, - Command, - CompletionContext, - CompletionItem, - Declaration as VDeclaration, - Definition, - DefinitionLink, - Diagnostic, - Disposable, - DocumentHighlight, - DocumentLink, - DocumentSymbol, - FoldingContext, - FoldingRange, - FormattingOptions, - LinkedEditingRanges, - Location, - Position, - Position as VPosition, - ProviderResult, - Range, - SelectionRange, - SemanticTokens, - SemanticTokensEdits, - SignatureHelp, - SignatureHelpContext, - SymbolInformation, - TextDocument, - TextDocumentChangeEvent, - TextEdit, - Uri, - WorkspaceEdit, -} from 'vscode'; -import { HandleDiagnosticsSignature, Middleware } from 'vscode-languageclient/node'; - -import { ProvideDeclarationSignature } from 'vscode-languageclient/lib/common/declaration'; -import { - PrepareCallHierarchySignature, - CallHierarchyIncomingCallsSignature, - CallHierarchyOutgoingCallsSignature, -} from 'vscode-languageclient/lib/common/callHierarchy'; -import { - ProvideDocumentColorsSignature, - ProvideColorPresentationSignature, -} from 'vscode-languageclient/lib/common/colorProvider'; -import { ProvideFoldingRangeSignature } from 'vscode-languageclient/lib/common/foldingRange'; -import { ProvideImplementationSignature } from 'vscode-languageclient/lib/common/implementation'; -import { ProvideLinkedEditingRangeSignature } from 'vscode-languageclient/lib/common/linkedEditingRange'; -import { ProvideSelectionRangeSignature } from 'vscode-languageclient/lib/common/selectionRange'; -import { - DocumentSemanticsTokensSignature, - DocumentSemanticsTokensEditsSignature, - DocumentRangeSemanticTokensSignature, -} from 'vscode-languageclient/lib/common/semanticTokens'; -import { ProvideTypeDefinitionSignature } from 'vscode-languageclient/lib/common/typeDefinition'; -import { ProvideHoverSignature } from 'vscode-languageclient/lib/common/hover'; -import { - ProvideCompletionItemsSignature, - ResolveCompletionItemSignature, -} from 'vscode-languageclient/lib/common/completion'; -import { ProvideDefinitionSignature } from 'vscode-languageclient/lib/common/definition'; -import { ProvideDocumentHighlightsSignature } from 'vscode-languageclient/lib/common/documentHighlight'; -import { ProvideReferencesSignature } from 'vscode-languageclient/lib/common/reference'; -import { ProvideDocumentSymbolsSignature } from 'vscode-languageclient/lib/common/documentSymbol'; -import { ProvideCodeActionsSignature } from 'vscode-languageclient/lib/common/codeAction'; -import { ProvideCodeLensesSignature } from 'vscode-languageclient/lib/common/codeLens'; -import { ProvideDocumentLinksSignature } from 'vscode-languageclient/lib/common/documentLink'; -import { - ProvideDocumentFormattingEditsSignature, - ProvideDocumentRangeFormattingEditsSignature, - ProvideOnTypeFormattingEditsSignature, -} from 'vscode-languageclient/lib/common/formatting'; -import { ProvideRenameEditsSignature, PrepareRenameSignature } from 'vscode-languageclient/lib/common/rename'; -import { ProvideSignatureHelpSignature } from 'vscode-languageclient/lib/common/signatureHelp'; -import { isNotebookCell } from '../common/utils/misc'; - -/** - * This class is used to hide all intellisense requests for notebook cells. - */ -class HidingMiddlewareAddon implements Middleware, Disposable { - constructor() { - // Make sure a bunch of functions are bound to this. VS code can call them without a this context - this.handleDiagnostics = this.handleDiagnostics.bind(this); - this.didOpen = this.didOpen.bind(this); - this.didSave = this.didSave.bind(this); - this.didChange = this.didChange.bind(this); - this.didClose = this.didClose.bind(this); - } - - public dispose(): void { - // Nothing to dispose at the moment - } - - public async didChange(event: TextDocumentChangeEvent, next: (ev: TextDocumentChangeEvent) => void): Promise { - if (!isNotebookCell(event.document.uri)) { - return next(event); - } - } - - public async didOpen(document: TextDocument, next: (ev: TextDocument) => void): Promise { - if (!isNotebookCell(document.uri)) { - return next(document); - } - } - - public async didClose(document: TextDocument, next: (ev: TextDocument) => void): Promise { - if (!isNotebookCell(document.uri)) { - return next(document); - } - } - - // eslint-disable-next-line class-methods-use-this - public async didSave(event: TextDocument, next: (ev: TextDocument) => void): Promise { - if (!isNotebookCell(event.uri)) { - return next(event); - } - } - - // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types - public provideCompletionItem( - document: TextDocument, - position: Position, - context: CompletionContext, - token: CancellationToken, - next: ProvideCompletionItemsSignature, - ) { - if (!isNotebookCell(document.uri)) { - return next(document, position, context, token); - } - } - - // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types - public provideHover( - document: TextDocument, - position: Position, - token: CancellationToken, - next: ProvideHoverSignature, - ) { - if (!isNotebookCell(document.uri)) { - return next(document, position, token); - } - } - - // eslint-disable-next-line class-methods-use-this - public resolveCompletionItem( - item: CompletionItem, - token: CancellationToken, - next: ResolveCompletionItemSignature, - ): ProviderResult { - // Range should have already been remapped. - - // TODO: What if the LS needs to read the range? It won't make sense. This might mean - // doing this at the extension level is not possible. - return next(item, token); - } - - public provideSignatureHelp( - document: TextDocument, - position: Position, - context: SignatureHelpContext, - token: CancellationToken, - next: ProvideSignatureHelpSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, position, context, token); - } - } - - public provideDefinition( - document: TextDocument, - position: Position, - token: CancellationToken, - next: ProvideDefinitionSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, position, token); - } - } - - public provideReferences( - document: TextDocument, - position: Position, - options: { - includeDeclaration: boolean; - }, - token: CancellationToken, - next: ProvideReferencesSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, position, options, token); - } - } - - public provideDocumentHighlights( - document: TextDocument, - position: Position, - token: CancellationToken, - next: ProvideDocumentHighlightsSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, position, token); - } - } - - public provideDocumentSymbols( - document: TextDocument, - token: CancellationToken, - next: ProvideDocumentSymbolsSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, token); - } - } - - // eslint-disable-next-line class-methods-use-this - public provideCodeActions( - document: TextDocument, - range: Range, - context: CodeActionContext, - token: CancellationToken, - next: ProvideCodeActionsSignature, - ): ProviderResult<(Command | CodeAction)[]> { - if (!isNotebookCell(document.uri)) { - return next(document, range, context, token); - } - } - - // eslint-disable-next-line class-methods-use-this - public provideCodeLenses( - document: TextDocument, - token: CancellationToken, - next: ProvideCodeLensesSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, token); - } - } - - // eslint-disable-next-line class-methods-use-this - public provideDocumentFormattingEdits( - document: TextDocument, - options: FormattingOptions, - token: CancellationToken, - next: ProvideDocumentFormattingEditsSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, options, token); - } - } - - // eslint-disable-next-line class-methods-use-this - public provideDocumentRangeFormattingEdits( - document: TextDocument, - range: Range, - options: FormattingOptions, - token: CancellationToken, - next: ProvideDocumentRangeFormattingEditsSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, range, options, token); - } - } - - // eslint-disable-next-line class-methods-use-this - public provideOnTypeFormattingEdits( - document: TextDocument, - position: Position, - ch: string, - options: FormattingOptions, - token: CancellationToken, - next: ProvideOnTypeFormattingEditsSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, position, ch, options, token); - } - } - - // eslint-disable-next-line class-methods-use-this - public provideRenameEdits( - document: TextDocument, - position: Position, - newName: string, - token: CancellationToken, - next: ProvideRenameEditsSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, position, newName, token); - } - } - - // eslint-disable-next-line class-methods-use-this - public prepareRename( - document: TextDocument, - position: Position, - token: CancellationToken, - next: PrepareRenameSignature, - ): ProviderResult< - | Range - | { - range: Range; - placeholder: string; - } - > { - if (!isNotebookCell(document.uri)) { - return next(document, position, token); - } - } - - // eslint-disable-next-line class-methods-use-this - public provideDocumentLinks( - document: TextDocument, - token: CancellationToken, - next: ProvideDocumentLinksSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, token); - } - } - - // eslint-disable-next-line class-methods-use-this - public provideDeclaration( - document: TextDocument, - position: VPosition, - token: CancellationToken, - next: ProvideDeclarationSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, position, token); - } - } - - public handleDiagnostics(uri: Uri, diagnostics: Diagnostic[], next: HandleDiagnosticsSignature): void { - if (isNotebookCell(uri)) { - // Swallow all diagnostics for cells - next(uri, []); - } else { - next(uri, diagnostics); - } - } - - public provideTypeDefinition( - document: TextDocument, - position: Position, - token: CancellationToken, - next: ProvideTypeDefinitionSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, position, token); - } - } - - public provideImplementation( - document: TextDocument, - position: VPosition, - token: CancellationToken, - next: ProvideImplementationSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, position, token); - } - } - - public provideDocumentColors( - document: TextDocument, - token: CancellationToken, - next: ProvideDocumentColorsSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, token); - } - } - - public provideColorPresentations( - color: Color, - context: { - document: TextDocument; - range: Range; - }, - token: CancellationToken, - next: ProvideColorPresentationSignature, - ): ProviderResult { - if (!isNotebookCell(context.document.uri)) { - return next(color, context, token); - } - } - - public provideFoldingRanges( - document: TextDocument, - context: FoldingContext, - token: CancellationToken, - next: ProvideFoldingRangeSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, context, token); - } - } - - public provideSelectionRanges( - document: TextDocument, - positions: readonly Position[], - token: CancellationToken, - next: ProvideSelectionRangeSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, positions, token); - } - } - - public prepareCallHierarchy( - document: TextDocument, - positions: Position, - token: CancellationToken, - next: PrepareCallHierarchySignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, positions, token); - } - } - - public provideCallHierarchyIncomingCalls( - item: CallHierarchyItem, - token: CancellationToken, - next: CallHierarchyIncomingCallsSignature, - ): ProviderResult { - if (!isNotebookCell(item.uri)) { - return next(item, token); - } - } - - public provideCallHierarchyOutgoingCalls( - item: CallHierarchyItem, - token: CancellationToken, - next: CallHierarchyOutgoingCallsSignature, - ): ProviderResult { - if (!isNotebookCell(item.uri)) { - return next(item, token); - } - } - - public provideDocumentSemanticTokens( - document: TextDocument, - token: CancellationToken, - next: DocumentSemanticsTokensSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, token); - } - } - - public provideDocumentSemanticTokensEdits( - document: TextDocument, - previousResultId: string, - token: CancellationToken, - next: DocumentSemanticsTokensEditsSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, previousResultId, token); - } - } - - public provideDocumentRangeSemanticTokens( - document: TextDocument, - range: Range, - token: CancellationToken, - next: DocumentRangeSemanticTokensSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, range, token); - } - } - - public provideLinkedEditingRange( - document: TextDocument, - position: Position, - token: CancellationToken, - next: ProvideLinkedEditingRangeSignature, - ): ProviderResult { - if (!isNotebookCell(document.uri)) { - return next(document, position, token); - } - } -} - -export function createHidingMiddleware(): Middleware & Disposable { - return new HidingMiddlewareAddon(); -} diff --git a/src/client/activation/jedi/languageClientMiddleware.ts b/src/client/activation/jedi/languageClientMiddleware.ts index 656c47309bb9..c8bb99629946 100644 --- a/src/client/activation/jedi/languageClientMiddleware.ts +++ b/src/client/activation/jedi/languageClientMiddleware.ts @@ -8,6 +8,5 @@ import { LanguageServerType } from '../types'; export class JediLanguageClientMiddleware extends LanguageClientMiddleware { public constructor(serviceContainer: IServiceContainer, serverVersion?: string) { super(serviceContainer, LanguageServerType.Jedi, serverVersion); - this.setupHidingMiddleware(serviceContainer); } } diff --git a/src/client/activation/languageClientMiddleware.ts b/src/client/activation/languageClientMiddleware.ts index 711725e3de62..d3d1e0c3c171 100644 --- a/src/client/activation/languageClientMiddleware.ts +++ b/src/client/activation/languageClientMiddleware.ts @@ -1,11 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import { IJupyterExtensionDependencyManager } from '../common/application/types'; -import { IDisposableRegistry, IExtensions } from '../common/types'; import { IServiceContainer } from '../ioc/types'; import { sendTelemetryEvent } from '../telemetry'; -import { createHidingMiddleware } from './hidingMiddleware'; import { LanguageClientMiddlewareBase } from './languageClientMiddlewareBase'; import { LanguageServerType } from './types'; @@ -14,44 +11,4 @@ export class LanguageClientMiddleware extends LanguageClientMiddlewareBase { public constructor(serviceContainer: IServiceContainer, serverType: LanguageServerType, serverVersion?: string) { super(serviceContainer, serverType, sendTelemetryEvent, serverVersion); } - - /** - * Creates the HidingMiddleware if needed and sets up code to do so if needed after - * Jupyter is installed. - * - * This method should be called from the constructor of derived classes. It is separated - * from the constructor to allow derived classes to initialize before it is called. - */ - protected setupHidingMiddleware(serviceContainer: IServiceContainer) { - const jupyterDependencyManager = serviceContainer.get( - IJupyterExtensionDependencyManager, - ); - const disposables = serviceContainer.get(IDisposableRegistry) || []; - const extensions = serviceContainer.get(IExtensions); - - // Enable notebook support if jupyter support is installed - if (this.shouldCreateHidingMiddleware(jupyterDependencyManager)) { - this.notebookAddon = createHidingMiddleware(); - } - - disposables.push( - extensions?.onDidChange(async () => { - await this.onExtensionChange(jupyterDependencyManager); - }), - ); - } - - protected shouldCreateHidingMiddleware(jupyterDependencyManager: IJupyterExtensionDependencyManager): boolean { - return jupyterDependencyManager && jupyterDependencyManager.isJupyterExtensionInstalled; - } - - protected async onExtensionChange(jupyterDependencyManager: IJupyterExtensionDependencyManager): Promise { - if (jupyterDependencyManager) { - if (this.notebookAddon && !this.shouldCreateHidingMiddleware(jupyterDependencyManager)) { - this.notebookAddon = undefined; - } else if (!this.notebookAddon && this.shouldCreateHidingMiddleware(jupyterDependencyManager)) { - this.notebookAddon = createHidingMiddleware(); - } - } - } } diff --git a/src/client/activation/node/languageClientMiddleware.ts b/src/client/activation/node/languageClientMiddleware.ts index 1a5da3d1a349..dfd65f1bb418 100644 --- a/src/client/activation/node/languageClientMiddleware.ts +++ b/src/client/activation/node/languageClientMiddleware.ts @@ -1,7 +1,6 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import { IJupyterExtensionDependencyManager } from '../../common/application/types'; import { IServiceContainer } from '../../ioc/types'; import { LanguageClientMiddleware } from '../languageClientMiddleware'; @@ -10,12 +9,5 @@ import { LanguageServerType } from '../types'; export class NodeLanguageClientMiddleware extends LanguageClientMiddleware { public constructor(serviceContainer: IServiceContainer, serverVersion?: string) { super(serviceContainer, LanguageServerType.Node, serverVersion); - - this.setupHidingMiddleware(serviceContainer); - } - - // eslint-disable-next-line class-methods-use-this - protected shouldCreateHidingMiddleware(_: IJupyterExtensionDependencyManager): boolean { - return false; } } From 1c8d20e5689d2313b1b45b32793d9691d7c78f21 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Tue, 6 Aug 2024 08:20:08 -0700 Subject: [PATCH 053/149] Debug test session proposed (#23891) fixes https://github.com/microsoft/vscode-python/issues/23752 skip tests due to: https://github.com/microsoft/vscode-python/issues/22170 --- src/client/testing/common/debugLauncher.ts | 32 +++++++++++++++---- .../testing/testController/controller.ts | 1 - .../testing/common/debugLauncher.unit.test.ts | 21 ++++++++++-- 3 files changed, 44 insertions(+), 10 deletions(-) diff --git a/src/client/testing/common/debugLauncher.ts b/src/client/testing/common/debugLauncher.ts index aef1a9fd9197..cd4b7181f447 100644 --- a/src/client/testing/common/debugLauncher.ts +++ b/src/client/testing/common/debugLauncher.ts @@ -1,6 +1,6 @@ import { inject, injectable, named } from 'inversify'; import * as path from 'path'; -import { DebugConfiguration, l10n, Uri, WorkspaceFolder } from 'vscode'; +import { DebugConfiguration, l10n, Uri, WorkspaceFolder, DebugSession } from 'vscode'; import { IApplicationShell, IDebugService } from '../../common/application/types'; import { EXTENSION_ROOT_DIR } from '../../common/constants'; import * as internalScripts from '../../common/process/internal/scripts'; @@ -9,7 +9,7 @@ import { DebuggerTypeName, PythonDebuggerTypeName } from '../../debugger/constan import { IDebugConfigurationResolver } from '../../debugger/extension/configuration/types'; import { DebugPurpose, LaunchRequestArguments } from '../../debugger/types'; import { IServiceContainer } from '../../ioc/types'; -import { traceError } from '../../logging'; +import { traceError, traceVerbose } from '../../logging'; import { TestProvider } from '../types'; import { ITestDebugLauncher, LaunchOptions } from './types'; import { getConfigurationsForWorkspace } from '../../debugger/extension/configuration/launch.json/launchJsonReader'; @@ -34,12 +34,20 @@ export class DebugLauncher implements ITestDebugLauncher { public async launchDebugger(options: LaunchOptions, callback?: () => void): Promise { const deferred = createDeferred(); + let hasCallbackBeenCalled = false; if (options.token && options.token.isCancellationRequested) { + hasCallbackBeenCalled = true; return undefined; deferred.resolve(); callback?.(); } + options.token?.onCancellationRequested(() => { + deferred.resolve(); + callback?.(); + hasCallbackBeenCalled = true; + }); + const workspaceFolder = DebugLauncher.resolveWorkspaceFolder(options.cwd); const launchArgs = await this.getLaunchArgs( options, @@ -48,11 +56,23 @@ export class DebugLauncher implements ITestDebugLauncher { ); const debugManager = this.serviceContainer.get(IDebugService); - debugManager.onDidTerminateDebugSession(() => { - deferred.resolve(); - callback?.(); + let activatedDebugSession: DebugSession | undefined; + debugManager.startDebugging(workspaceFolder, launchArgs).then(() => { + // Save the debug session after it is started so we can check if it is the one that was terminated. + activatedDebugSession = debugManager.activeDebugSession; + }); + debugManager.onDidTerminateDebugSession((session) => { + traceVerbose(`Debug session terminated. sessionId: ${session.id}`); + // Only resolve no callback has been made and the session is the one that was started. + if ( + !hasCallbackBeenCalled && + activatedDebugSession !== undefined && + session.id === activatedDebugSession?.id + ) { + deferred.resolve(); + callback?.(); + } }); - debugManager.startDebugging(workspaceFolder, launchArgs); return deferred.promise; } diff --git a/src/client/testing/testController/controller.ts b/src/client/testing/testController/controller.ts index b55eaa446018..58edfb059666 100644 --- a/src/client/testing/testController/controller.ts +++ b/src/client/testing/testController/controller.ts @@ -378,7 +378,6 @@ export class PythonTestController implements ITestController, IExtensionSingleAc `Running Tests for Workspace(s): ${workspaces.map((w) => w.uri.fsPath).join(';')}`, true, ); - const dispose = token.onCancellationRequested(() => { runInstance.appendOutput(`\nRun instance cancelled.\r\n`); runInstance.end(); diff --git a/src/test/testing/common/debugLauncher.unit.test.ts b/src/test/testing/common/debugLauncher.unit.test.ts index 31ba761eb946..bdcb7b63762c 100644 --- a/src/test/testing/common/debugLauncher.unit.test.ts +++ b/src/test/testing/common/debugLauncher.unit.test.ts @@ -10,7 +10,7 @@ import * as sinon from 'sinon'; import * as TypeMoq from 'typemoq'; import * as fs from 'fs-extra'; import * as workspaceApis from '../../../client/common/vscodeApis/workspaceApis'; -import { CancellationTokenSource, DebugConfiguration, Uri, WorkspaceFolder } from 'vscode'; +import { CancellationTokenSource, DebugConfiguration, DebugSession, Uri, WorkspaceFolder } from 'vscode'; import { IInvalidPythonPathInDebuggerService } from '../../../client/application/diagnostics/types'; import { IApplicationShell, IDebugService } from '../../../client/common/application/types'; import { EXTENSION_ROOT_DIR } from '../../../client/common/constants'; @@ -30,6 +30,7 @@ import { TestProvider } from '../../../client/testing/types'; import { isOs, OSType } from '../../common'; import { IEnvironmentActivationService } from '../../../client/interpreter/activation/types'; import * as util from '../../../client/testing/testController/common/utils'; +import { createDeferred } from '../../../client/common/utils/async'; use(chaiAsPromised); @@ -125,17 +126,31 @@ suite('Unit Tests - Debug Launcher', () => { .setup((x) => x.getEnvironmentVariables(TypeMoq.It.isAny(), TypeMoq.It.isAny())) .returns(() => Promise.resolve(expected.env)); + const deferred = createDeferred(); + debugService .setup((d) => d.startDebugging(TypeMoq.It.isValue(workspaceFolder), TypeMoq.It.isValue(expected))) .returns((_wspc: WorkspaceFolder, _expectedParam: DebugConfiguration) => { + deferred.resolve(); return Promise.resolve(undefined as any); - }) + }); + + // create a fake debug session that the debug service will return on terminate + const fakeDebugSession = TypeMoq.Mock.ofType(); + fakeDebugSession.setup((ds) => ds.id).returns(() => 'id-val'); + const debugSessionInstance = fakeDebugSession.object; + + debugService + .setup((d) => d.activeDebugSession) + .returns(() => debugSessionInstance) .verifiable(TypeMoq.Times.once()); debugService .setup((d) => d.onDidTerminateDebugSession(TypeMoq.It.isAny())) .returns((callback) => { - callback(); + deferred.promise.then(() => { + callback(debugSessionInstance); + }); return undefined as any; }) .verifiable(TypeMoq.Times.once()); From 48e277a7e597ee8ef8b22889b5e971b261d48700 Mon Sep 17 00:00:00 2001 From: Luciana Abud <45497113+luabud@users.noreply.github.com> Date: Tue, 6 Aug 2024 14:10:38 -0700 Subject: [PATCH 054/149] Fix event name in GDPR tag (#23917) --- src/client/telemetry/pylance.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/client/telemetry/pylance.ts b/src/client/telemetry/pylance.ts index 93129718bc94..b03a3e23062c 100644 --- a/src/client/telemetry/pylance.ts +++ b/src/client/telemetry/pylance.ts @@ -399,7 +399,7 @@ * Telemetry event sent when LSP server crashes */ /* __GDPR__ -"language_server_crash" : { +"language_server.crash" : { "oom" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "rchiodo" } } */ From e90b95df9f1f3ac587ee3e23b8741c07e6557222 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Wed, 7 Aug 2024 12:55:05 -0700 Subject: [PATCH 055/149] Allow native REPL launch from command palette (#23912) Resolves: https://github.com/microsoft/vscode-python/issues/23727 Allow users to launch Native REPL via command palette. Will also be handling https://github.com/microsoft/vscode-python/issues/23821 in this PR. -- setting proper workspace directory. Related: #23656 Covering scenarios: - Provide selection option if user is in multi-workspace scenario (already included in PR) - Automatically pick workspace as directory for context of REPL if user is in single-workspace scenario (already included in PR) - Handle case where user does not open any workspace and attempt to launch native REPL from plain/empty VS Code instance via command palette option (already included in PR) --- package-lock.json | 11 --- package.json | 15 ++++- package.nls.json | 3 +- src/client/common/application/commands.ts | 1 + src/client/common/constants.ts | 1 + src/client/extensionActivation.ts | 3 +- src/client/repl/nativeRepl.ts | 82 +++++++++++++++++++---- src/client/repl/pythonServer.ts | 6 +- src/client/repl/replCommands.ts | 30 ++++++++- src/client/repl/replController.ts | 3 +- src/test/repl/nativeRepl.test.ts | 70 +++++++++++++++++++ 11 files changed, 191 insertions(+), 34 deletions(-) create mode 100644 src/test/repl/nativeRepl.test.ts diff --git a/package-lock.json b/package-lock.json index bde67795d468..73b3b4431bb1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,7 +12,6 @@ "@iarna/toml": "^2.2.5", "@vscode/extension-telemetry": "^0.8.4", "arch": "^2.1.0", - "diff-match-patch": "^1.0.5", "fs-extra": "^10.0.1", "glob": "^7.2.0", "hash.js": "^1.1.7", @@ -4637,11 +4636,6 @@ "node": ">=0.3.1" } }, - "node_modules/diff-match-patch": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/diff-match-patch/-/diff-match-patch-1.0.5.tgz", - "integrity": "sha512-IayShXAgj/QMXgB0IWmKx+rOPuGMhqm5w6jvFxmVenXKIzRqTAAsbBPT3kWQeGANj3jGgvcvv4yK6SxqYmikgw==" - }, "node_modules/diffie-hellman": { "version": "5.0.3", "resolved": "https://registry.npmjs.org/diffie-hellman/-/diffie-hellman-5.0.3.tgz", @@ -17608,11 +17602,6 @@ "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", "dev": true }, - "diff-match-patch": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/diff-match-patch/-/diff-match-patch-1.0.5.tgz", - "integrity": "sha512-IayShXAgj/QMXgB0IWmKx+rOPuGMhqm5w6jvFxmVenXKIzRqTAAsbBPT3kWQeGANj3jGgvcvv4yK6SxqYmikgw==" - }, "diffie-hellman": { "version": "5.0.3", "resolved": "https://registry.npmjs.org/diffie-hellman/-/diffie-hellman-5.0.3.tgz", diff --git a/package.json b/package.json index 0b2def5937f6..a43bb33944e2 100644 --- a/package.json +++ b/package.json @@ -344,7 +344,12 @@ { "category": "Python", "command": "python.startREPL", - "title": "%python.command.python.startREPL.title%" + "title": "%python.command.python.startTerminalREPL.title%" + }, + { + "category": "Python", + "command": "python.startNativeREPL", + "title": "%python.command.python.startNativeREPL.title%" }, { "category": "Python", @@ -1328,7 +1333,13 @@ { "category": "Python", "command": "python.startREPL", - "title": "%python.command.python.startREPL.title%", + "title": "%python.command.python.startTerminalREPL.title%", + "when": "!virtualWorkspace && shellExecutionSupported" + }, + { + "category": "Python", + "command": "python.startNativeREPL", + "title": "%python.command.python.startNativeREPL.title%", "when": "!virtualWorkspace && shellExecutionSupported" }, { diff --git a/package.nls.json b/package.nls.json index dcf8a2ddf5f9..5a5029231b17 100644 --- a/package.nls.json +++ b/package.nls.json @@ -1,5 +1,6 @@ { - "python.command.python.startREPL.title": "Start Terminal REPL", + "python.command.python.startTerminalREPL.title": "Start Terminal REPL", + "python.command.python.startNativeREPL.title": "Start Native Python REPL", "python.command.python.createEnvironment.title": "Create Environment...", "python.command.python.createNewFile.title": "New Python File", "python.command.python.createTerminal.title": "Create Terminal", diff --git a/src/client/common/application/commands.ts b/src/client/common/application/commands.ts index 388bcf8052fa..4580a91a78d1 100644 --- a/src/client/common/application/commands.ts +++ b/src/client/common/application/commands.ts @@ -96,6 +96,7 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu ['workbench.action.openIssueReporter']: [{ extensionId: string; issueBody: string }]; [Commands.GetSelectedInterpreterPath]: [{ workspaceFolder: string } | string[]]; [Commands.TriggerEnvironmentSelection]: [undefined | Uri]; + [Commands.Start_Native_REPL]: [undefined | Uri]; [Commands.Exec_In_REPL]: [undefined | Uri]; [Commands.Exec_In_REPL_Enter]: [undefined | Uri]; [Commands.Exec_In_Terminal]: [undefined, Uri]; diff --git a/src/client/common/constants.ts b/src/client/common/constants.ts index d5b82f68ae97..23e9c131b25c 100644 --- a/src/client/common/constants.ts +++ b/src/client/common/constants.ts @@ -62,6 +62,7 @@ export namespace Commands { export const Set_Interpreter = 'python.setInterpreter'; export const Set_ShebangInterpreter = 'python.setShebangInterpreter'; export const Start_REPL = 'python.startREPL'; + export const Start_Native_REPL = 'python.startNativeREPL'; export const Tests_Configure = 'python.configureTests'; export const TriggerEnvironmentSelection = 'python.triggerEnvSelection'; export const ViewOutput = 'python.viewOutput'; diff --git a/src/client/extensionActivation.ts b/src/client/extensionActivation.ts index 6f2a4565299f..77ed2edf6716 100644 --- a/src/client/extensionActivation.ts +++ b/src/client/extensionActivation.ts @@ -52,7 +52,7 @@ import { initializePersistentStateForTriggers } from './common/persistentState'; import { logAndNotifyOnLegacySettings } from './logging/settingLogs'; import { DebuggerTypeName } from './debugger/constants'; import { StopWatch } from './common/utils/stopWatch'; -import { registerReplCommands, registerReplExecuteOnEnter } from './repl/replCommands'; +import { registerReplCommands, registerReplExecuteOnEnter, registerStartNativeReplCommand } from './repl/replCommands'; export async function activateComponents( // `ext` is passed to any extra activation funcs. @@ -108,6 +108,7 @@ export function activateFeatures(ext: ExtensionState, _components: Components): ); const executionHelper = ext.legacyIOC.serviceContainer.get(ICodeExecutionHelper); const commandManager = ext.legacyIOC.serviceContainer.get(ICommandManager); + registerStartNativeReplCommand(ext.disposables, interpreterService); registerReplCommands(ext.disposables, interpreterService, executionHelper, commandManager); registerReplExecuteOnEnter(ext.disposables, interpreterService, commandManager); } diff --git a/src/client/repl/nativeRepl.ts b/src/client/repl/nativeRepl.ts index e6a596f4434a..e28d21228666 100644 --- a/src/client/repl/nativeRepl.ts +++ b/src/client/repl/nativeRepl.ts @@ -1,32 +1,51 @@ // Native Repl class that holds instance of pythonServer and replController -import { NotebookController, NotebookControllerAffinity, NotebookDocument, TextEditor, workspace } from 'vscode'; +import { + NotebookController, + NotebookControllerAffinity, + NotebookDocument, + QuickPickItem, + TextEditor, + workspace, + WorkspaceFolder, +} from 'vscode'; import { Disposable } from 'vscode-jsonrpc'; import { PVSC_EXTENSION_ID } from '../common/constants'; +import { showQuickPick } from '../common/vscodeApis/windowApis'; +import { getWorkspaceFolders } from '../common/vscodeApis/workspaceApis'; import { PythonEnvironment } from '../pythonEnvironments/info'; import { createPythonServer, PythonServer } from './pythonServer'; import { executeNotebookCell, openInteractiveREPL, selectNotebookKernel } from './replCommandHandler'; import { createReplController } from './replController'; export class NativeRepl implements Disposable { - private pythonServer: PythonServer; + // Adding ! since it will get initialized in create method, not the constructor. + private pythonServer!: PythonServer; - private interpreter: PythonEnvironment; + private cwd: string | undefined; + + private interpreter!: PythonEnvironment; private disposables: Disposable[] = []; - private replController: NotebookController; + private replController!: NotebookController; private notebookDocument: NotebookDocument | undefined; // TODO: In the future, could also have attribute of URI for file specific REPL. - constructor(interpreter: PythonEnvironment) { - this.interpreter = interpreter; + private constructor() { + this.watchNotebookClosed(); + } - this.pythonServer = createPythonServer([interpreter.path as string]); - this.replController = this.setReplController(); + // Static async factory method to handle asynchronous initialization + public static async create(interpreter: PythonEnvironment): Promise { + const nativeRepl = new NativeRepl(); + nativeRepl.interpreter = interpreter; + await nativeRepl.setReplDirectory(); + nativeRepl.pythonServer = createPythonServer([interpreter.path as string], nativeRepl.cwd); + nativeRepl.replController = nativeRepl.setReplController(); - this.watchNotebookClosed(); + return nativeRepl; } dispose(): void { @@ -47,13 +66,46 @@ export class NativeRepl implements Disposable { ); } + /** + * Function that set up desired directory for REPL. + * If there is multiple workspaces, prompt the user to choose + * which directory we should set in context of native REPL. + */ + private async setReplDirectory(): Promise { + // Figure out uri via workspaceFolder as uri parameter always + // seem to be undefined from parameter when trying to access from replCommands.ts + const workspaces: readonly WorkspaceFolder[] | undefined = getWorkspaceFolders(); + + if (workspaces) { + // eslint-disable-next-line no-shadow + const workspacesQuickPickItems: QuickPickItem[] = workspaces.map((workspace) => ({ + label: workspace.name, + description: workspace.uri.fsPath, + })); + + if (workspacesQuickPickItems.length === 0) { + this.cwd = process.cwd(); // Yields '/' on no workspace scenario. + } else if (workspacesQuickPickItems.length === 1) { + this.cwd = workspacesQuickPickItems[0].description; + } else { + // Show choices of workspaces for user to choose from. + const selection = (await showQuickPick(workspacesQuickPickItems, { + placeHolder: 'Select current working directory for new REPL', + matchOnDescription: true, + ignoreFocusOut: true, + })) as QuickPickItem; + this.cwd = selection?.description; + } + } + } + /** * Function that check if NotebookController for REPL exists, and returns it in Singleton manner. * @returns NotebookController */ public setReplController(): NotebookController { if (!this.replController) { - return createReplController(this.interpreter.path, this.disposables); + return createReplController(this.interpreter!.path, this.disposables, this.cwd); } return this.replController; } @@ -84,14 +136,16 @@ export class NativeRepl implements Disposable { * Function that opens interactive repl, selects kernel, and send/execute code to the native repl. * @param code */ - public async sendToNativeRepl(code: string): Promise { + public async sendToNativeRepl(code?: string): Promise { const notebookEditor = await openInteractiveREPL(this.replController, this.notebookDocument); this.notebookDocument = notebookEditor.notebook; if (this.notebookDocument) { this.replController.updateNotebookAffinity(this.notebookDocument, NotebookControllerAffinity.Default); await selectNotebookKernel(notebookEditor, this.replController.id, PVSC_EXTENSION_ID); - await executeNotebookCell(this.notebookDocument, code); + if (code) { + await executeNotebookCell(this.notebookDocument, code); + } } } } @@ -103,9 +157,9 @@ let nativeRepl: NativeRepl | undefined; // In multi REPL scenario, hashmap of UR * @param interpreter * @returns Native REPL instance */ -export function getNativeRepl(interpreter: PythonEnvironment, disposables: Disposable[]): NativeRepl { +export async function getNativeRepl(interpreter: PythonEnvironment, disposables: Disposable[]): Promise { if (!nativeRepl) { - nativeRepl = new NativeRepl(interpreter); + nativeRepl = await NativeRepl.create(interpreter); disposables.push(nativeRepl); } return nativeRepl; diff --git a/src/client/repl/pythonServer.ts b/src/client/repl/pythonServer.ts index ca45ea900baf..fbcb1104dc69 100644 --- a/src/client/repl/pythonServer.ts +++ b/src/client/repl/pythonServer.ts @@ -89,12 +89,14 @@ class PythonServerImpl implements Disposable { } } -export function createPythonServer(interpreter: string[]): PythonServer { +export function createPythonServer(interpreter: string[], cwd?: string): PythonServer { if (serverInstance) { return serverInstance; } - const pythonServer = ch.spawn(interpreter[0], [...interpreter.slice(1), SERVER_PATH]); + const pythonServer = ch.spawn(interpreter[0], [...interpreter.slice(1), SERVER_PATH], { + cwd, // Launch with correct workspace directory + }); pythonServer.stderr.on('data', (data) => { traceError(data.toString()); diff --git a/src/client/repl/replCommands.ts b/src/client/repl/replCommands.ts index c3f167ff51cc..5570fa8384f4 100644 --- a/src/client/repl/replCommands.ts +++ b/src/client/repl/replCommands.ts @@ -14,6 +14,32 @@ import { insertNewLineToREPLInput, isMultiLineText, } from './replUtils'; +import { registerCommand } from '../common/vscodeApis/commandApis'; + +/** + * Register Start Native REPL command in the command palette + * + * @param disposables + * @param interpreterService + * @param commandManager + * @returns Promise + */ +export async function registerStartNativeReplCommand( + disposables: Disposable[], + interpreterService: IInterpreterService, +): Promise { + disposables.push( + registerCommand(Commands.Start_Native_REPL, async (uri: Uri) => { + const interpreter = await getActiveInterpreter(uri, interpreterService); + if (interpreter) { + if (interpreter) { + const nativeRepl = await getNativeRepl(interpreter, disposables); + await nativeRepl.sendToNativeRepl(); + } + } + }), + ); +} /** * Registers REPL command for shift+enter if sendToNativeREPL setting is enabled. @@ -39,7 +65,7 @@ export async function registerReplCommands( const interpreter = await getActiveInterpreter(uri, interpreterService); if (interpreter) { - const nativeRepl = getNativeRepl(interpreter, disposables); + const nativeRepl = await getNativeRepl(interpreter, disposables); const activeEditor = window.activeTextEditor; if (activeEditor) { const code = await getSelectedTextToExecute(activeEditor); @@ -76,7 +102,7 @@ export async function registerReplExecuteOnEnter( return; } - const nativeRepl = getNativeRepl(interpreter, disposables); + const nativeRepl = await getNativeRepl(interpreter, disposables); const completeCode = await nativeRepl?.checkUserInputCompleteCode(window.activeTextEditor); const editor = window.activeTextEditor; diff --git a/src/client/repl/replController.ts b/src/client/repl/replController.ts index 4760edc98036..7c1f8fd0c6b2 100644 --- a/src/client/repl/replController.ts +++ b/src/client/repl/replController.ts @@ -4,8 +4,9 @@ import { createPythonServer } from './pythonServer'; export function createReplController( interpreterPath: string, disposables: vscode.Disposable[], + cwd?: string, ): vscode.NotebookController { - const server = createPythonServer([interpreterPath]); + const server = createPythonServer([interpreterPath], cwd); disposables.push(server); const controller = vscode.notebooks.createNotebookController('pythonREPL', 'interactive', 'Python REPL'); diff --git a/src/test/repl/nativeRepl.test.ts b/src/test/repl/nativeRepl.test.ts new file mode 100644 index 000000000000..0fc55abe1a64 --- /dev/null +++ b/src/test/repl/nativeRepl.test.ts @@ -0,0 +1,70 @@ +/* eslint-disable no-unused-expressions */ +/* eslint-disable @typescript-eslint/no-explicit-any */ +import * as TypeMoq from 'typemoq'; +import * as sinon from 'sinon'; +import { Disposable } from 'vscode'; +import { expect } from 'chai'; + +import { IInterpreterService } from '../../client/interpreter/contracts'; +import { PythonEnvironment } from '../../client/pythonEnvironments/info'; +import { getNativeRepl, NativeRepl } from '../../client/repl/nativeRepl'; + +suite('REPL - Native REPL', () => { + let interpreterService: TypeMoq.IMock; + + let disposable: TypeMoq.IMock; + let disposableArray: Disposable[] = []; + + let setReplDirectoryStub: sinon.SinonStub; + let setReplControllerSpy: sinon.SinonSpy; + + setup(() => { + interpreterService = TypeMoq.Mock.ofType(); + interpreterService + .setup((i) => i.getActiveInterpreter(TypeMoq.It.isAny())) + .returns(() => Promise.resolve(({ path: 'ps' } as unknown) as PythonEnvironment)); + disposable = TypeMoq.Mock.ofType(); + disposableArray = [disposable.object]; + + setReplDirectoryStub = sinon.stub(NativeRepl.prototype as any, 'setReplDirectory').resolves(); // Stubbing private method + // Use a spy instead of a stub for setReplController + setReplControllerSpy = sinon.spy(NativeRepl.prototype, 'setReplController'); + }); + + teardown(() => { + disposableArray.forEach((d) => { + if (d) { + d.dispose(); + } + }); + + disposableArray = []; + sinon.restore(); + }); + + test('getNativeRepl should call create constructor', async () => { + const createMethodStub = sinon.stub(NativeRepl, 'create'); + interpreterService + .setup((i) => i.getActiveInterpreter(TypeMoq.It.isAny())) + .returns(() => Promise.resolve(({ path: 'ps' } as unknown) as PythonEnvironment)); + const interpreter = await interpreterService.object.getActiveInterpreter(); + await getNativeRepl(interpreter as PythonEnvironment, disposableArray); + + expect(createMethodStub.calledOnce).to.be.true; + }); + + test('create should call setReplDirectory, setReplController', async () => { + const interpreter = await interpreterService.object.getActiveInterpreter(); + interpreterService + .setup((i) => i.getActiveInterpreter(TypeMoq.It.isAny())) + .returns(() => Promise.resolve(({ path: 'ps' } as unknown) as PythonEnvironment)); + + await NativeRepl.create(interpreter as PythonEnvironment); + + expect(setReplDirectoryStub.calledOnce).to.be.true; + expect(setReplControllerSpy.calledOnce).to.be.true; + + setReplDirectoryStub.restore(); + setReplControllerSpy.restore(); + }); +}); From 20e186f3e520164bd1eea9ff97eb12c3cd5ac0f8 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Thu, 8 Aug 2024 14:32:43 -0700 Subject: [PATCH 056/149] Fix issues with localization and signing (#23931) Fixes https://github.com/microsoft/python-environment-tools/issues/139 Related https://github.com/microsoft/vscode-python/issues/23926 --- build/azure-pipeline.pre-release.yml | 27 ++------ build/azure-pipeline.stable.yml | 23 ++----- noxfile.py | 94 +++++++++++++++++++--------- 3 files changed, 77 insertions(+), 67 deletions(-) diff --git a/build/azure-pipeline.pre-release.yml b/build/azure-pipeline.pre-release.yml index e66b59dc3aab..56bed785588f 100644 --- a/build/azure-pipeline.pre-release.yml +++ b/build/azure-pipeline.pre-release.yml @@ -18,13 +18,6 @@ resources: ref: main endpoint: Monaco - - repository: python-environment-tools - type: github - name: microsoft/python-environment-tools - ref: main - endpoint: Monaco - - parameters: - name: publishExtension displayName: 🚀 Publish Extension @@ -38,11 +31,7 @@ extends: ghCreateTag: false standardizedVersioning: true l10nSourcePaths: ./src/client - sourceRepositoriesToScan: - include: - - repository: python-environment-tools - exclude: - - repository: translations + needsTools: true buildPlatforms: - name: Linux @@ -76,10 +65,6 @@ extends: vsceTarget: win32-x64 buildSteps: - - checkout: self - displayName: Checkout Python Extension - path: ./s - - task: NodeTool@0 inputs: versionSpec: '18.17.1' @@ -104,9 +89,6 @@ extends: - script: nox --session install_python_libs displayName: Install Jedi, get-pip, etc - # - script: python ./build/update_ext_version.py --for-publishing - # displayName: Update build number - - script: python ./build/update_package_file.py displayName: Update telemetry in package.json @@ -116,9 +98,12 @@ extends: - script: npx gulp prePublishBundle displayName: Build - - checkout: python-environment-tools + - script: nox --session azure_pet_checkout displayName: Checkout python-environment-tools - path: ./s/python-env-tools + env: + PYTHON_ENV_TOOLS_DEST: $(Build.SourcesDirectory) + PYTHON_ENV_TOOLS_REF: main + PYTHON_ENV_TOOLS_TEMP: $(Agent.TempDirectory) - script: nox --session azure_pet_build_before displayName: Enable cargo config for azure diff --git a/build/azure-pipeline.stable.yml b/build/azure-pipeline.stable.yml index ec59f05ef360..4cd0567ec8c1 100644 --- a/build/azure-pipeline.stable.yml +++ b/build/azure-pipeline.stable.yml @@ -14,12 +14,6 @@ resources: ref: main endpoint: Monaco - - repository: python-environment-tools - type: github - name: microsoft/python-environment-tools - ref: release/2024.12 - endpoint: Monaco - parameters: - name: publishExtension displayName: 🚀 Publish Extension @@ -31,11 +25,7 @@ extends: parameters: publishExtension: ${{ parameters.publishExtension }} l10nSourcePaths: ./src/client - sourceRepositoriesToScan: - include: - - repository: python-environment-tools - exclude: - - repository: translations + needsTools: true buildPlatforms: - name: Linux @@ -69,10 +59,6 @@ extends: vsceTarget: win32-x64 buildSteps: - - checkout: self - displayName: Checkout Python Extension - path: ./s - - task: NodeTool@0 inputs: versionSpec: '18.17.1' @@ -106,9 +92,12 @@ extends: - script: npx gulp prePublishBundle displayName: Build - - checkout: python-environment-tools + - script: nox --session azure_pet_checkout displayName: Checkout python-environment-tools - path: ./s/python-env-tools + env: + PYTHON_ENV_TOOLS_DEST: $(Build.SourcesDirectory) + PYTHON_ENV_TOOLS_REF: release/2024.12 + PYTHON_ENV_TOOLS_TEMP: $(Agent.TempDirectory) - script: nox --session azure_pet_build_before displayName: Enable cargo config for azure diff --git a/noxfile.py b/noxfile.py index 8fe5842ee348..58ac6f1206aa 100644 --- a/noxfile.py +++ b/noxfile.py @@ -12,6 +12,21 @@ EXT_ROOT = pathlib.Path(__file__).parent +def delete_dir(path: pathlib.Path, ignore_errors=None): + attempt = 0 + known = [] + while attempt < 5: + try: + shutil.rmtree(os.fspath(path), ignore_errors=ignore_errors) + return + except PermissionError as pe: + if os.fspath(pe.filename) in known: + break + print(f"Changing permissions on {pe.filename}") + os.chmod(pe.filename, 0o666) + + shutil.rmtree(os.fspath(path)) + @nox.session() def install_python_libs(session: nox.Session): requirements = [ @@ -48,6 +63,45 @@ def install_python_libs(session: nox.Session): if pathlib.Path("./python_files/lib/temp").exists(): shutil.rmtree("./python_files/lib/temp") +@nox.session() +def azure_pet_checkout(session: nox.Session): + branch = os.getenv("PYTHON_ENV_TOOLS_REF", "main") + + # dest dir should be /python-env-tools + dest_dir = (pathlib.Path(os.getenv("PYTHON_ENV_TOOLS_DEST")) / "python-env-tools").resolve() + + # temp dir should be + temp_dir = (pathlib.Path(os.getenv("PYTHON_ENV_TOOLS_TEMP")) / "python-env-tools").resolve() + session.log(f"Cloning python-environment-tools to {temp_dir}") + temp_dir.mkdir(0o766, parents=True, exist_ok=True) + + try: + with session.cd(temp_dir): + session.run("git", "init", external=True) + session.run( + "git", + "remote", + "add", + "origin", + "https://github.com/microsoft/python-environment-tools", + external=True, + ) + session.run("git", "fetch", "origin", branch, external=True) + session.run( + "git", "checkout", "--force", "-B", branch, f"origin/{branch}", external=True + ) + delete_dir(temp_dir / ".git") + delete_dir(temp_dir / ".github") + delete_dir(temp_dir / ".vscode") + (temp_dir / "CODE_OF_CONDUCT.md").unlink() + shutil.move(os.fspath(temp_dir), os.fspath(dest_dir)) + except PermissionError as e: + print(f"Permission error: {e}") + if not dest_dir.exists(): + raise + finally: + delete_dir(temp_dir, ignore_errors=True) + @nox.session() def azure_pet_build_before(session: nox.Session): @@ -132,37 +186,19 @@ def native_build(session: nox.Session): vscode_ignore.write_text("\n".join(filtered_lines) + "\n", encoding="utf-8") -def delete_dir(path: pathlib.Path, ignore_errors=None): - attempt = 0 - known = [] - while attempt < 5: - try: - shutil.rmtree(os.fspath(path), ignore_errors=ignore_errors) - return - except PermissionError as pe: - if os.fspath(pe.filename) in known: - break - print(f"Changing permissions on {pe.filename}") - os.chmod(pe.filename, 0o666) - - shutil.rmtree(os.fspath(path)) - - @nox.session() def checkout_native(session: nox.Session): dest = (pathlib.Path.cwd() / "python-env-tools").resolve() if dest.exists(): shutil.rmtree(os.fspath(dest)) - tempdir = os.getenv("TEMP") or os.getenv("TMP") or "/tmp" - tempdir = pathlib.Path(tempdir) / str(uuid.uuid4()) / "python-env-tools" - tempdir.mkdir(0o666, parents=True) - - session.log(f"Temp dir: {tempdir}") + temp_dir = os.getenv("TEMP") or os.getenv("TMP") or "/tmp" + temp_dir = pathlib.Path(temp_dir) / str(uuid.uuid4()) / "python-env-tools" + temp_dir.mkdir(0o766, parents=True) - session.log(f"Cloning python-environment-tools to {tempdir}") + session.log(f"Cloning python-environment-tools to {temp_dir}") try: - with session.cd(tempdir): + with session.cd(temp_dir): session.run("git", "init", external=True) session.run( "git", @@ -176,17 +212,17 @@ def checkout_native(session: nox.Session): session.run( "git", "checkout", "--force", "-B", "main", "origin/main", external=True ) - delete_dir(tempdir / ".git") - delete_dir(tempdir / ".github") - delete_dir(tempdir / ".vscode") - (tempdir / "CODE_OF_CONDUCT.md").unlink() - shutil.move(os.fspath(tempdir), os.fspath(dest)) + delete_dir(temp_dir / ".git") + delete_dir(temp_dir / ".github") + delete_dir(temp_dir / ".vscode") + (temp_dir / "CODE_OF_CONDUCT.md").unlink() + shutil.move(os.fspath(temp_dir), os.fspath(dest)) except PermissionError as e: print(f"Permission error: {e}") if not dest.exists(): raise finally: - delete_dir(tempdir.parent, ignore_errors=True) + delete_dir(temp_dir.parent, ignore_errors=True) @nox.session() From 3fea99386619518a8f3f4bd6426601e1786bc471 Mon Sep 17 00:00:00 2001 From: Daniel Imms <2193314+Tyriar@users.noreply.github.com> Date: Mon, 12 Aug 2024 11:38:39 -0700 Subject: [PATCH 057/149] Remove finalized terminalShellIntegration from proposals (#23940) cc @anthonykim1 --- package.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/package.json b/package.json index a43bb33944e2..42b1a03ff281 100644 --- a/package.json +++ b/package.json @@ -24,8 +24,7 @@ "quickPickItemTooltip", "terminalDataWriteEvent", "terminalExecuteCommandEvent", - "contribIssueReporter", - "terminalShellIntegration" + "contribIssueReporter" ], "author": { "name": "Microsoft Corporation" From f417024a1f4671c19f0959128a063c7b2fe98198 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Mon, 12 Aug 2024 12:05:59 -0700 Subject: [PATCH 058/149] Attempt to handle pixi error more gracefully (#23937) For: https://github.com/microsoft/vscode-python/issues/23911 and https://github.com/microsoft/vscode-python/issues/23906 (For virtual/remote scenario) Locating pixi environment, regardless of presence of pixi environment, is leading to crash. Hoping to address this and handle errors more gracefully so program does not terminate. /cc @baszalmstra --- .../common/environmentManagers/pixi.ts | 67 +++++++++++++------ 1 file changed, 47 insertions(+), 20 deletions(-) diff --git a/src/client/pythonEnvironments/common/environmentManagers/pixi.ts b/src/client/pythonEnvironments/common/environmentManagers/pixi.ts index f3d6dc3e081e..7aa1d55acd2c 100644 --- a/src/client/pythonEnvironments/common/environmentManagers/pixi.ts +++ b/src/client/pythonEnvironments/common/environmentManagers/pixi.ts @@ -169,16 +169,22 @@ export class Pixi { */ @cache(1_000, true, 1_000) public async getPixiInfo(cwd: string): Promise { - const infoOutput = await exec(this.command, ['info', '--json'], { - cwd, - throwOnStdErr: false, - }).catch(traceError); - if (!infoOutput) { + try { + const infoOutput = await exec(this.command, ['info', '--json'], { + cwd, + throwOnStdErr: false, + }); + + if (!infoOutput || !infoOutput.stdout) { + return undefined; + } + + const pixiInfo: PixiInfo = JSON.parse(infoOutput.stdout); + return pixiInfo; + } catch (error) { + traceError(`Failed to get pixi info for ${cwd}`, error); return undefined; } - - const pixiInfo: PixiInfo = JSON.parse(infoOutput.stdout); - return pixiInfo; } /** @@ -186,14 +192,24 @@ export class Pixi { */ @cache(30_000, true, 10_000) public async getVersion(): Promise { - const versionOutput = await exec(this.command, ['--version'], { - throwOnStdErr: false, - }).catch(traceError); - if (!versionOutput) { + try { + const versionOutput = await exec(this.command, ['--version'], { + throwOnStdErr: false, + }); + if (!versionOutput || !versionOutput.stdout) { + return undefined; + } + + const versionParts = versionOutput.stdout.split(' '); + if (versionParts.length < 2) { + return undefined; + } + + return versionParts[1].trim(); + } catch (error) { + traceError(`Failed to get pixi version`, error); return undefined; } - - return versionOutput.stdout.split(' ')[1].trim(); } /** @@ -279,13 +295,24 @@ export async function getPixiEnvironmentFromInterpreter( // Usually the pixi environments are stored under `/.pixi/envs//`. So, // we walk backwards to determine the project directory. - const envName = path.basename(prefix); - const envsDir = path.dirname(prefix); - const dotPixiDir = path.dirname(envsDir); - const pixiProjectDir = path.dirname(dotPixiDir); + let envName: string | undefined; + let envsDir: string; + let dotPixiDir: string; + let pixiProjectDir: string; + let pixiInfo: PixiInfo | undefined; + + try { + envName = path.basename(prefix); + envsDir = path.dirname(prefix); + dotPixiDir = path.dirname(envsDir); + pixiProjectDir = path.dirname(dotPixiDir); + + // Invoke pixi to get information about the pixi project + pixiInfo = await pixi.getPixiInfo(pixiProjectDir); + } catch (error) { + traceWarn('Error processing paths or getting Pixi Info:', error); + } - // Invoke pixi to get information about the pixi project - const pixiInfo = await pixi.getPixiInfo(pixiProjectDir); if (!pixiInfo || !pixiInfo.project_info) { traceWarn(`failed to determine pixi project information for the interpreter at ${interpreterPath}`); return undefined; From c13bb07894455d27ed4fb94b12262e9be006176e Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Tue, 13 Aug 2024 13:40:31 -0700 Subject: [PATCH 059/149] REPL Telemetry for Terminal REPL and Native REPL (#23941) Resolves: https://github.com/microsoft/vscode-python/issues/23740 Also organize Telemetry for Terminal REPL vs. Native REPL. Now we can sort them out with new attribute 'replType' on the REPL Event. With this PR: - (EventName.REPL, { replType: 'Terminal' }) for when people launch Terminal REPL via Command Palette, Manually type Python in terminal (tried to account for all Python cases that will trigger REPL). - (EventName.REPL, { replType: 'Native' }) for when people launch Native REPL via Command Palette. --------- Co-authored-by: Karthik Nadig --- src/client/extensionActivation.ts | 2 ++ src/client/providers/replProvider.ts | 2 +- src/client/repl/replCommands.ts | 4 +++- src/client/telemetry/index.ts | 9 +++++++-- .../codeExecution/terminalReplWatcher.ts | 19 +++++++++++++++++++ 5 files changed, 32 insertions(+), 4 deletions(-) create mode 100644 src/client/terminals/codeExecution/terminalReplWatcher.ts diff --git a/src/client/extensionActivation.ts b/src/client/extensionActivation.ts index 77ed2edf6716..fe5d18a8b83f 100644 --- a/src/client/extensionActivation.ts +++ b/src/client/extensionActivation.ts @@ -53,6 +53,7 @@ import { logAndNotifyOnLegacySettings } from './logging/settingLogs'; import { DebuggerTypeName } from './debugger/constants'; import { StopWatch } from './common/utils/stopWatch'; import { registerReplCommands, registerReplExecuteOnEnter, registerStartNativeReplCommand } from './repl/replCommands'; +import { registerTriggerForTerminalREPL } from './terminals/codeExecution/terminalReplWatcher'; export async function activateComponents( // `ext` is passed to any extra activation funcs. @@ -108,6 +109,7 @@ export function activateFeatures(ext: ExtensionState, _components: Components): ); const executionHelper = ext.legacyIOC.serviceContainer.get(ICodeExecutionHelper); const commandManager = ext.legacyIOC.serviceContainer.get(ICommandManager); + registerTriggerForTerminalREPL(ext.disposables); registerStartNativeReplCommand(ext.disposables, interpreterService); registerReplCommands(ext.disposables, interpreterService, executionHelper, commandManager); registerReplExecuteOnEnter(ext.disposables, interpreterService, commandManager); diff --git a/src/client/providers/replProvider.ts b/src/client/providers/replProvider.ts index ba01dea3390d..810e24b78f42 100644 --- a/src/client/providers/replProvider.ts +++ b/src/client/providers/replProvider.ts @@ -28,7 +28,7 @@ export class ReplProvider implements Disposable { this.disposables.push(disposable); } - @captureTelemetry(EventName.REPL) + @captureTelemetry(EventName.REPL, { replType: 'Terminal' }) private async commandHandler() { const resource = this.activeResourceService.getActiveResource(); const interpreterService = this.serviceContainer.get(IInterpreterService); diff --git a/src/client/repl/replCommands.ts b/src/client/repl/replCommands.ts index 5570fa8384f4..120ddf13effc 100644 --- a/src/client/repl/replCommands.ts +++ b/src/client/repl/replCommands.ts @@ -15,6 +15,8 @@ import { isMultiLineText, } from './replUtils'; import { registerCommand } from '../common/vscodeApis/commandApis'; +import { sendTelemetryEvent } from '../telemetry'; +import { EventName } from '../telemetry/constants'; /** * Register Start Native REPL command in the command palette @@ -30,6 +32,7 @@ export async function registerStartNativeReplCommand( ): Promise { disposables.push( registerCommand(Commands.Start_Native_REPL, async (uri: Uri) => { + sendTelemetryEvent(EventName.REPL, undefined, { replType: 'Native' }); const interpreter = await getActiveInterpreter(uri, interpreterService); if (interpreter) { if (interpreter) { @@ -61,7 +64,6 @@ export async function registerReplCommands( await executeInTerminal(); return; } - const interpreter = await getActiveInterpreter(uri, interpreterService); if (interpreter) { diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index e995ec6d53eb..4904b330c75b 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -2305,10 +2305,15 @@ export interface IEventNamePropertyMapping { */ /* __GDPR__ "repl" : { - "duration" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "karthiknadig" } + "duration" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "anthonykim1" } } */ - [EventName.REPL]: never | undefined; + [EventName.REPL]: { + /** + * Whether the user launched the Terminal REPL or Native REPL + */ + replType: 'Terminal' | 'Native'; + }; /** * Telemetry event sent if and when user configure tests command. This command can be trigerred from multiple places in the extension. (Command palette, prompt etc.) */ diff --git a/src/client/terminals/codeExecution/terminalReplWatcher.ts b/src/client/terminals/codeExecution/terminalReplWatcher.ts new file mode 100644 index 000000000000..5921bf8b07c4 --- /dev/null +++ b/src/client/terminals/codeExecution/terminalReplWatcher.ts @@ -0,0 +1,19 @@ +import { Disposable, TerminalShellExecutionStartEvent } from 'vscode'; +import { onDidStartTerminalShellExecution } from '../../common/vscodeApis/windowApis'; +import { sendTelemetryEvent } from '../../telemetry'; +import { EventName } from '../../telemetry/constants'; + +function checkREPLCommand(command: string): boolean { + const lower = command.toLowerCase().trimStart(); + return lower.startsWith('python ') || lower.startsWith('py '); +} + +export function registerTriggerForTerminalREPL(disposables: Disposable[]): void { + disposables.push( + onDidStartTerminalShellExecution(async (e: TerminalShellExecutionStartEvent) => { + if (e.execution.commandLine.isTrusted && checkREPLCommand(e.execution.commandLine.value)) { + sendTelemetryEvent(EventName.REPL, undefined, { replType: 'Terminal' }); + } + }), + ); +} From b872cb490f6281798aef24b20fd3afd8e0355ac6 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Tue, 13 Aug 2024 14:40:58 -0700 Subject: [PATCH 060/149] Fire telemetry when REPLs are launched via shift+enter (#23944) Related to https://github.com/microsoft/vscode-python/issues/23740 In addition to : #23941 Fire telemetry for when REPL is launched via shift+enter. /cc @cwebster-99 --- src/client/repl/nativeRepl.ts | 3 +++ src/client/terminals/codeExecution/terminalCodeExecution.ts | 4 +++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/client/repl/nativeRepl.ts b/src/client/repl/nativeRepl.ts index e28d21228666..eaa97f9518df 100644 --- a/src/client/repl/nativeRepl.ts +++ b/src/client/repl/nativeRepl.ts @@ -17,6 +17,8 @@ import { PythonEnvironment } from '../pythonEnvironments/info'; import { createPythonServer, PythonServer } from './pythonServer'; import { executeNotebookCell, openInteractiveREPL, selectNotebookKernel } from './replCommandHandler'; import { createReplController } from './replController'; +import { EventName } from '../telemetry/constants'; +import { sendTelemetryEvent } from '../telemetry'; export class NativeRepl implements Disposable { // Adding ! since it will get initialized in create method, not the constructor. @@ -159,6 +161,7 @@ let nativeRepl: NativeRepl | undefined; // In multi REPL scenario, hashmap of UR */ export async function getNativeRepl(interpreter: PythonEnvironment, disposables: Disposable[]): Promise { if (!nativeRepl) { + sendTelemetryEvent(EventName.REPL, undefined, { replType: 'Native' }); nativeRepl = await NativeRepl.create(interpreter); disposables.push(nativeRepl); } diff --git a/src/client/terminals/codeExecution/terminalCodeExecution.ts b/src/client/terminals/codeExecution/terminalCodeExecution.ts index ce317dec20e7..f2750fedaa07 100644 --- a/src/client/terminals/codeExecution/terminalCodeExecution.ts +++ b/src/client/terminals/codeExecution/terminalCodeExecution.ts @@ -17,6 +17,8 @@ import { IInterpreterService } from '../../interpreter/contracts'; import { traceInfo } from '../../logging'; import { buildPythonExecInfo, PythonExecInfo } from '../../pythonEnvironments/exec'; import { ICodeExecutionService } from '../../terminals/types'; +import { EventName } from '../../telemetry/constants'; +import { sendTelemetryEvent } from '../../telemetry'; @injectable() export class TerminalCodeExecutionProvider implements ICodeExecutionService { @@ -67,7 +69,7 @@ export class TerminalCodeExecutionProvider implements ICodeExecutionService { await terminalService.show(); return; } - + sendTelemetryEvent(EventName.REPL, undefined, { replType: 'Terminal' }); this.replActive = new Promise(async (resolve) => { const replCommandArgs = await this.getExecutableInfo(resource); let listener: IDisposable; From 59a8d030d99d6cb63c1fdc493f3f18c9012af723 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Wed, 14 Aug 2024 13:04:44 -0700 Subject: [PATCH 061/149] Django Test Compatibility (#23935) implements and thus closes https://github.com/microsoft/vscode-python/issues/22206 resolves https://github.com/microsoft/vscode-python/issues/73! --- build/test-requirements.txt | 3 + python_files/tests/pytestadapter/helpers.py | 35 +++++- .../.data/simple_django/db.sqlite3 | Bin 0 -> 143360 bytes .../.data/simple_django/manage.py | 23 ++++ .../.data/simple_django/mysite/__init__.py | 2 + .../.data/simple_django/mysite/asgi.py | 9 ++ .../.data/simple_django/mysite/settings.py | 102 +++++++++++++++++ .../.data/simple_django/mysite/urls.py | 9 ++ .../.data/simple_django/mysite/wsgi.py | 7 ++ .../.data/simple_django/polls/__init__.py | 2 + .../.data/simple_django/polls/admin.py | 2 + .../.data/simple_django/polls/apps.py | 13 +++ .../polls/migrations/0001_initial.py | 52 +++++++++ .../polls/migrations/__init__.py | 2 + .../.data/simple_django/polls/models.py | 25 +++++ .../.data/simple_django/polls/tests.py | 38 +++++++ .../.data/simple_django/polls/urls.py | 11 ++ .../.data/simple_django/polls/views.py | 7 ++ .../django_test_execution_script.py | 17 +++ .../tests/unittestadapter/test_discovery.py | 39 ++++++- .../tests/unittestadapter/test_execution.py | 51 ++++++++- python_files/unittestadapter/discovery.py | 33 ++++-- .../unittestadapter/django_handler.py | 106 ++++++++++++++++++ .../unittestadapter/django_test_runner.py | 99 ++++++++++++++++ python_files/unittestadapter/execution.py | 39 +++++-- python_files/unittestadapter/pvsc_utils.py | 2 +- 26 files changed, 702 insertions(+), 26 deletions(-) create mode 100644 python_files/tests/unittestadapter/.data/simple_django/db.sqlite3 create mode 100755 python_files/tests/unittestadapter/.data/simple_django/manage.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/mysite/__init__.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/mysite/asgi.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/mysite/settings.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/mysite/urls.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/mysite/wsgi.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/polls/__init__.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/polls/admin.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/polls/apps.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/polls/migrations/0001_initial.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/polls/migrations/__init__.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/polls/models.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/polls/tests.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/polls/urls.py create mode 100644 python_files/tests/unittestadapter/.data/simple_django/polls/views.py create mode 100644 python_files/tests/unittestadapter/django_test_execution_script.py create mode 100644 python_files/unittestadapter/django_handler.py create mode 100644 python_files/unittestadapter/django_test_runner.py diff --git a/build/test-requirements.txt b/build/test-requirements.txt index 6457f988d320..4229104ddcc9 100644 --- a/build/test-requirements.txt +++ b/build/test-requirements.txt @@ -24,3 +24,6 @@ freezegun # testing custom pytest plugin require the use of named pipes namedpipe; platform_system == "Windows" + +# typing for Django files +django-stubs diff --git a/python_files/tests/pytestadapter/helpers.py b/python_files/tests/pytestadapter/helpers.py index 9ec0550fb4b9..4f6631a44c00 100644 --- a/python_files/tests/pytestadapter/helpers.py +++ b/python_files/tests/pytestadapter/helpers.py @@ -193,17 +193,35 @@ def _run_test_code(proc_args: List[str], proc_env, proc_cwd: str, completed: thr def runner(args: List[str]) -> Optional[List[Dict[str, Any]]]: - """Run the pytest discovery and return the JSON data from the server.""" + """Run a subprocess and a named-pipe to listen for messages at the same time with threading.""" print("\n Running python test subprocess with cwd set to: ", TEST_DATA_PATH) return runner_with_cwd(args, TEST_DATA_PATH) def runner_with_cwd(args: List[str], path: pathlib.Path) -> Optional[List[Dict[str, Any]]]: - """Run the pytest discovery and return the JSON data from the server.""" - process_args: List[str] = [sys.executable, "-m", "pytest", "-p", "vscode_pytest", "-s", *args] + """Run a subprocess and a named-pipe to listen for messages at the same time with threading.""" + return runner_with_cwd_env(args, path, {}) + + +def runner_with_cwd_env( + args: List[str], path: pathlib.Path, env_add: Dict[str, str] +) -> Optional[List[Dict[str, Any]]]: + """ + Run a subprocess and a named-pipe to listen for messages at the same time with threading. + + Includes environment variables to add to the test environment. + """ + process_args: List[str] + pipe_name: str + if "MANAGE_PY_PATH" in env_add: + # If we are running Django, generate a unittest-specific pipe name. + process_args = [sys.executable, *args] + pipe_name = generate_random_pipe_name("unittest-discovery-test") + else: + process_args = [sys.executable, "-m", "pytest", "-p", "vscode_pytest", "-s", *args] + pipe_name = generate_random_pipe_name("pytest-discovery-test") # Generate pipe name, pipe name specific per OS type. - pipe_name = generate_random_pipe_name("pytest-discovery-test") # Windows design if sys.platform == "win32": @@ -216,6 +234,9 @@ def runner_with_cwd(args: List[str], path: pathlib.Path) -> Optional[List[Dict[s "PYTHONPATH": os.fspath(pathlib.Path(__file__).parent.parent.parent), } ) + # if additional environment variables are passed, add them to the environment + if env_add: + env.update(env_add) completed = threading.Event() @@ -244,6 +265,9 @@ def runner_with_cwd(args: List[str], path: pathlib.Path) -> Optional[List[Dict[s "PYTHONPATH": os.fspath(pathlib.Path(__file__).parent.parent.parent), } ) + # if additional environment variables are passed, add them to the environment + if env_add: + env.update(env_add) server = UnixPipeServer(pipe_name) server.start() @@ -255,10 +279,11 @@ def runner_with_cwd(args: List[str], path: pathlib.Path) -> Optional[List[Dict[s ) t1.start() - t2 = threading.Thread( + t2: threading.Thread = threading.Thread( target=_run_test_code, args=(process_args, env, path, completed), ) + t2.start() t1.join() diff --git a/python_files/tests/unittestadapter/.data/simple_django/db.sqlite3 b/python_files/tests/unittestadapter/.data/simple_django/db.sqlite3 new file mode 100644 index 0000000000000000000000000000000000000000..519ec5e1a11ca6cfaa9418e6540bca99936887b3 GIT binary patch literal 143360 zcmeI5Yit|Yb;mg(#fL?5^sqd;Ys(r@tF;+fE50duv)yRDj8|P-UfXhZ4RkRbk|Ua4 zij+ypk8aVHT5l30ZGk3efEH*|1Sr~~{m>T>6ls7WMUlP}6iI+SQncuYv_aFfDYE+^ z3D9%z%y1qgC9S&wcI7`|k7n*Y_sluJd*{yFbMKH>FJGv2G|> zpYWvNh28uA#l4KzHIdz=WGYcEZ59UGJ#iqr`;_fx zvRQzvy(tEzuD2lU&L7BJhqFqeTuG<0rG(XT`Us5=Z$EvqR+HT0Gza#Lnv_EgIs15& zs%FtqH8zoQv(eES9i?+`TVqWswVBE1v`mRtjU^`zs1qw!8K%W%w(?$^ zkYBvAc5(H}b@_$jb$RvL#-+7&QhBkszCosPB?C)cDSohcrMP~sc-3}N;~a7MIhK2c zo3ysRwz0N);lgzzvG`nHBkZ@SPrJq9VCRVMCdLBN(von0%7vC+VK$)pad;R;J^Nh+ zPwyiRRx4cgfXH5dUnn5W&I%u%cOvUGz9T~*JrJF3wcWncY*CB6t+vWH)Yj=_Y9-!l zmefe143{(w*;7K>QfqbVO!=&JCMwSi?WmiZ{YFxbTJF?tla+4!na9e_X04$SqCWTI z$s>NLI4gK~ci6sFr^hvgDvIRk`G)No4>-x*?%3{nFd!8Q!u`Bezj|A;t}gw;=t~U^ zsQEsj2WkeomUp}{6Lrfe_5k(6=wrI${(v+$Cv;zR0p-lOXMthh9tf7R4X*UJ=Xg5c zm(I`a*(`M8db{BJL3)a2|2?~pj|Qa0Md9_Iw*0Xua;L0A{{YXd+;_metj#^DPWL0h z-W6K8sWz%j$IaU?Y5$v3@BVD{ObMGU@$U1!fYeM2-PicVHsDl>y1lK`)sj|Mw&+Qu zuH1x5{+&Jo1`!M!!>Pay+}G2eSOv4I6Qiyo`0-hh-&3%fhK#s`!f zkmPgL`~Zn}p!Sn?Z`7}5?{^E$AHSO!%PouwVYqxf^Mp<(mdL90`GEcK> z@C=oVcdrWpX?a=LRqgDyYSot7VS_P)iQQ^e;{ha#k%jLvd$Ziv%hfXQqg*? z@9skV!1VD5ZKuXgdc-e^pAswLT=Z+vpN&2n`9b7!kvox0_#5F*hd&ga82i%L8)Gk$ z7(O5X0w4eaAOHd&00JOzhzTU7Mm^HP>UOhUZzmFoq*80tIyJSPN~AJNiTqMJDW{TW zQ>nAbs7>|9StYXW{&+5&z*B8Aal|)x6!qtItre7BmoVDwQv!*GB2OC7UW+wFaq3 zv*0pKZnf_5dS-#xW<%Mmt5v0ZqgkW4z(7^WOnxP?>LXP|*-(|TR2gQ`Roi502dhXF z(z%3}_adf>A-#xEwTWCJm0cborVD2C*t0;UkWJ-sd4bR^xY6xhFu#(`rP%mCC{{e; ze~4cZKPTQ6KQ8{V_?wh~4+ww&2!H?xfB*=900@8p2!H?xfWX@#Fdp_U2t0;pgd4n5 zKJTL7T4p0hLf*L`Pvp_I@DcBA$h%NVZfS<;M9nBDQINy zpaY9pObgy+Q`%aoFm;4H35r#Z_+R2*iT@yeUi>w&D&7@8{4<^}tT2;2T> z#5X<7!w4)w;EVdEC4R)i2NYwNp5uqsQjC!aI%|lB1k42yZ2n&!%Xq|p5`SO(s8|xu zis9%#NB=PTsc0*@9(^)88Ts$X-$s5n@>3klCTEKi)q+OA@D+ zgY-tYMqk&UCo&m5!IV0wOVM{?G^%zfJ;9JVIYUx&@gQ5FZYiQ8Q_BgiCBUsQ2NOMe z%!Jd&Nop}2Ff1~YZ8n)nrytWL4Xey#CTZAZCdD2l$%Ul=v&>9mV$3%4IQ9sa@pJ2p zK~2v%0s9~OM0LH`(6CDNU9S~N)u+vq*u+?55PVavRi`h|T zuuGa5Z5KU3FL(&Er+nOUHtg$}%noFFd4oLn8K#=~hK*c;-ppVUhHa*VVH7)jj9$4A zW)^(R7&Dt$!S+wmYZTNLz5MKanAtl$KZ?$ADVx2(!^jWunYbE9G%|fgp4$$&EEf-91w&LFO+eoThgKLW^0$P`jML z&XS~e14z;^(k^M3*prOWO97#UWoDpVjG5PyVe|iTr0WsCO|$=hMlpb25#JEE#FxbL zVn&=3$3-Ff?daE|e-r&|^jD*AL>ti`i=L0BqO;L(M4do7SV`C zeZq{;3wA^}R9k!_%n3LG8e@8rp@c^yj_@;E;ffHq&mEu$NbaO#V?6}A^xfOdGWL2?}@)H{<`>S@t4F;ia#fQMC^*Mi92Fbtchju74aqU zviJfizy}0C00ck)1V8`;KmY_l00ck)1P(iaQLi8bWxk!|+mn1d!?uAFe0!X4ALH9c z+1CFE-%5OYjBlsecJwIUPVwy|-%hZtZ=7#MzK!y2gl)ZHz8&M+BYYcT+mRsO2Kd&` zx1&C9Nbs?Zmu*J8-cShh|A)PC!aooI0T2KI5C8!X009sH0T2KI5b$_x-~R_3AOHd& z00JNY0w4eaAOHd&00JNY0*90U#{Y-3V&N7DfB*=900@8p2!H?xfB*=900`I!VEk`` zfn5*)0T2KI5C8!X009sH0T2KI5ICd+F#bQJ6$`gO00ck)1V8`;KmY_l00ck)1VF$> z0ONlf4D5mc2!H?xfB*=900@8p2!H?xfWRRo5D9$OBMM*ih>u7AF7#FZ7b17UAM+m_ zeaZKWV{e6?2^PoR@BMS(izAnWPk6rUdD;b`J3bYVE-eY&WUW!r?y5VT8_G^wYbn)M zb7#A)@7F3yPEDq?%1X&CaP-`j;_60GUR!^z__7>xXZMwl$(Ppq#bWa57(Z*R5{q}A znG8s;l1c5oP2v_RWLqJV&L+xW6n`)!lRMg5=t)bML zRrm2p!>^6iXD<}xm^+&hC75!p(b1|}OJ2XUA+KM%a6x|Y%G$-%E7#>0ir3}UYa5r= z)=AOD;`#=8&@A25${n&MCU>;E9bUjnZfV=Cn0#Apm2ar6)2T!v-qT7#YPmyRDVue* z8k5^wYQ0XUmUkNMTD757dXnD=4axS2iom}^&xA1q!euAeJj?eVY|Fp$LM=a}3T&TVadZDVcq!iDQbV(~dT zi`f$U;n~m7YiI}7Yq;F0ZINpgwWG1U9+`OeN2P$&Tot;vtX9KK;Tx;9xLZzgvsB7% zrpi5o^o!0`;IUyB=>avno4>mlBVe75Rm{VB5ogNTav`Phs_47oCkIqRpOCv-Ff`h# zps&av{EOoO=@sgME?RA=ubke;v(BfKOeM;t&B9>2Ck|w{uHL3>Kak-O?RbypqhQxl%5ja@~a8r5`cO z8g@H&%OB)ywuUy)V&*c>p!%im-C;NNR8vO-(q($w$hsWY8=rNN6!O_@A)Cqc5F5`( z#|B&;{B*+0_={pz`v`TB*?ml_&S^L;`?n!(=B2R-xN z*~Z*gCkIe(Q7}B&=e8cF=iXz|+?>#T)ef|~ax5T~>7IMtRry2Pp<2jlY9(oV5O#|` zI;=go1$%AV)ah;*?gI9P9Dg@Hx!)A26Y&;=-FXXVU(>U$D610LO(;>Wq*K{a!sl|$RR=w8Il(u$jM{ATd*P+*e(3N?*p>Ans zsARl*T?k0a%fhb8bsD3kty;CEvSCZRFJZ)?*BoA11s^#FipRZ|JzafI*v;~A$ab?{Zz~jE zX|rI6^JvZ)2ytdUP!z;GkHY4dZ4nRGg!1-INnyc`K_QRs(PTin8W*|+9%nS7H*K0W zW^>Tm-R)XSk6EjTj=me&J?PC@3q?OZgKkXvSeh22y3D3f89 zv#e`+#+k_!o6fwd-Ln{FY;*4RnS6>)n(~B9?VmWen>iqa^i;wxU5X1HPSXgYQP{G{ zj}@nJO44~emVDAL6=#PPwxXZO-fplvu^8aN_$>~KXYlx|wI@2;ot5!GZO$27OJ?mH z^{J@1_vby6mlv5E{HOTDj_E;T-7~&Fd*mCQ)In&xo>}5;<-_x@zmN9z zn#v0dK*55$4@6>HZMW|>9U2S*Rij!Kye(BKy3ui> zQnOj_tzV#AmbyP_66B}YLy|p(*45ZRYH)}2OeGkLp-N$1zvA*b-ShwQaihaEao6|^bX7V{Lqt6yua#5p3?W?A& z+@V@*vlW&!YXz>;QcrYsE+E}o6m~^xBE~AxcY<=WqA{QlN>8@`YR;6(+KN_kn|6F3)9e+-`o*%LXSj*35;2;<_uj_(NUV=MB%6>-Rx-X{`C-aFSENKmumE6 zO>3*o1=;rH61t(LxN(!(=V>91`Ts*0)PYMN00JNY0w4eaAOHd&00JNY0wCZbfbqWz z2o6C21V8`;KmY_l00ck)1V8`;K;RG(!1(_VRw`Tq0T2KI5C8!X009sH0T2KI5C8!e z0gV4$KyU~GAOHd&00JNY0w4eaAOHd&00M`Q0LK4^uu|a?2!H?xfB*=900@8p2!H?x zfB*=%2t?>OC~kVhZ;5{|{-yZG;-|%riFYUg9}oZm5C8!X009sH0T2KI5C8!X0D-qj zKn(gk(xdzf`t@G}muz$+$^UNGKeu=GZ{5?ME^DN98KWEapx2?5p`(dBY zGd<0IxrqHFOTQ|XZ&rt191=l z0T2KI5C8!X009sH0T2KI5CDPq6am}%fAKwKIE)1W5C8!X009sH0T2KI5C8!X009s< zFag{6|G;G+2m&Ag0w4eaAOHd&00JNY0w4eaAn@KIz}Ei@;@3R%4<8T!0T2KI5C8!X z009sH0T2KI5CDPq5`p+>deMJw^`#qX=TuwX*?uOKNM)81`K5GHP9@K#(q~hNCsz{5 zL?OY(|6cJ+9`S#~f1^M6fB*=900@8p2!H?xfB*=900@8p2)z3VOnOH>r-C6i@@E5o zxzemY6CN4$91n&zZfJ7*)q4?P)H4$dtv5UJ)=v2bTmSDBzvB_VFTO>8@Bsl3009sH g0T2KI5C8!X009sH0T4J81bp6*;ANW;uQwF>KZ^#Ur2qf` literal 0 HcmV?d00001 diff --git a/python_files/tests/unittestadapter/.data/simple_django/manage.py b/python_files/tests/unittestadapter/.data/simple_django/manage.py new file mode 100755 index 000000000000..c5734a6babee --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/manage.py @@ -0,0 +1,23 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. +"""Django's command-line utility for administrative tasks.""" +import os +import sys + + +def main(): + """Run administrative tasks.""" + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings') + try: + from django.core.management import execute_from_command_line + except ImportError as exc: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) from exc + execute_from_command_line(sys.argv) + + +if __name__ == '__main__': + main() diff --git a/python_files/tests/unittestadapter/.data/simple_django/mysite/__init__.py b/python_files/tests/unittestadapter/.data/simple_django/mysite/__init__.py new file mode 100644 index 000000000000..5b7f7a925cc0 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/mysite/__init__.py @@ -0,0 +1,2 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. diff --git a/python_files/tests/unittestadapter/.data/simple_django/mysite/asgi.py b/python_files/tests/unittestadapter/.data/simple_django/mysite/asgi.py new file mode 100644 index 000000000000..bb01f607934c --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/mysite/asgi.py @@ -0,0 +1,9 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings') + +application = get_asgi_application() diff --git a/python_files/tests/unittestadapter/.data/simple_django/mysite/settings.py b/python_files/tests/unittestadapter/.data/simple_django/mysite/settings.py new file mode 100644 index 000000000000..3120fb4e829f --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/mysite/settings.py @@ -0,0 +1,102 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. +""" +Django settings for mysite project. + +Generated by 'django-admin startproject' using Django 3.2.22. + +For more information on this file, see +https://docs.djangoproject.com/en/3.2/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/3.2/ref/settings/ +""" + +from pathlib import Path + +# Build paths inside the project like this: BASE_DIR / 'subdir'. +BASE_DIR = Path(__file__).resolve().parent.parent + + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + "polls.apps.PollsConfig", + "django.contrib.admin", + "django.contrib.auth", + "django.contrib.contenttypes", + "django.contrib.sessions", + "django.contrib.messages", + "django.contrib.staticfiles", +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', +] + +ROOT_URLCONF = 'mysite.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'mysite.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/3.2/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': BASE_DIR / 'db.sqlite3', + } +} + + + + +# Internationalization +# https://docs.djangoproject.com/en/3.2/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_L10N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/3.2/howto/static-files/ + +STATIC_URL = '/static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' diff --git a/python_files/tests/unittestadapter/.data/simple_django/mysite/urls.py b/python_files/tests/unittestadapter/.data/simple_django/mysite/urls.py new file mode 100644 index 000000000000..02e76f125c72 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/mysite/urls.py @@ -0,0 +1,9 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. +from django.contrib import admin +from django.urls import include, path + +urlpatterns = [ + path("polls/", include("polls.urls")), + path("admin/", admin.site.urls), +] diff --git a/python_files/tests/unittestadapter/.data/simple_django/mysite/wsgi.py b/python_files/tests/unittestadapter/.data/simple_django/mysite/wsgi.py new file mode 100644 index 000000000000..e932bff6649e --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/mysite/wsgi.py @@ -0,0 +1,7 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. +import os + +from django.core.wsgi import get_wsgi_application + +application = get_wsgi_application() diff --git a/python_files/tests/unittestadapter/.data/simple_django/polls/__init__.py b/python_files/tests/unittestadapter/.data/simple_django/polls/__init__.py new file mode 100644 index 000000000000..5b7f7a925cc0 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/polls/__init__.py @@ -0,0 +1,2 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. diff --git a/python_files/tests/unittestadapter/.data/simple_django/polls/admin.py b/python_files/tests/unittestadapter/.data/simple_django/polls/admin.py new file mode 100644 index 000000000000..5b7f7a925cc0 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/polls/admin.py @@ -0,0 +1,2 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. diff --git a/python_files/tests/unittestadapter/.data/simple_django/polls/apps.py b/python_files/tests/unittestadapter/.data/simple_django/polls/apps.py new file mode 100644 index 000000000000..e31968ce16c0 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/polls/apps.py @@ -0,0 +1,13 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +from django.apps import AppConfig +from django.utils.functional import cached_property + + +class PollsConfig(AppConfig): + @cached_property + def default_auto_field(self): + return "django.db.models.BigAutoField" + + name = "polls" diff --git a/python_files/tests/unittestadapter/.data/simple_django/polls/migrations/0001_initial.py b/python_files/tests/unittestadapter/.data/simple_django/polls/migrations/0001_initial.py new file mode 100644 index 000000000000..e33d24a3f704 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/polls/migrations/0001_initial.py @@ -0,0 +1,52 @@ +# Generated by Django 5.0.8 on 2024-08-09 20:04 + +import django.db.models.deletion +from django.db import migrations, models + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [] + + operations = [ + migrations.CreateModel( + name="Question", + fields=[ + ( + "id", + models.BigAutoField( + auto_created=True, + primary_key=True, + serialize=False, + verbose_name="ID", + ), + ), + ("question_text", models.CharField(max_length=200, default="")), + ("pub_date", models.DateTimeField(verbose_name="date published", auto_now_add=True)), + ], + ), + migrations.CreateModel( + name="Choice", + fields=[ + ( + "id", + models.BigAutoField( + auto_created=True, + primary_key=True, + serialize=False, + verbose_name="ID", + ), + ), + ("choice_text", models.CharField(max_length=200)), + ("votes", models.IntegerField(default=0)), + ( + "question", + models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, to="polls.question" + ), + ), + ], + ), + ] diff --git a/python_files/tests/unittestadapter/.data/simple_django/polls/migrations/__init__.py b/python_files/tests/unittestadapter/.data/simple_django/polls/migrations/__init__.py new file mode 100644 index 000000000000..5b7f7a925cc0 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/polls/migrations/__init__.py @@ -0,0 +1,2 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. diff --git a/python_files/tests/unittestadapter/.data/simple_django/polls/models.py b/python_files/tests/unittestadapter/.data/simple_django/polls/models.py new file mode 100644 index 000000000000..260a3da60f99 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/polls/models.py @@ -0,0 +1,25 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +from django.db import models +from django.utils import timezone +import datetime + + +class Question(models.Model): + question_text = models.CharField(max_length=200) + pub_date = models.DateTimeField("date published") + def __str__(self): + return self.question_text + def was_published_recently(self): + if self.pub_date > timezone.now(): + return False + return self.pub_date >= timezone.now() - datetime.timedelta(days=1) + + +class Choice(models.Model): + question = models.ForeignKey(Question, on_delete=models.CASCADE) + choice_text = models.CharField(max_length=200) + votes = models.IntegerField() + def __str__(self): + return self.choice_text diff --git a/python_files/tests/unittestadapter/.data/simple_django/polls/tests.py b/python_files/tests/unittestadapter/.data/simple_django/polls/tests.py new file mode 100644 index 000000000000..243262f195a8 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/polls/tests.py @@ -0,0 +1,38 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +from django.utils import timezone +from django.test import TestCase +from .models import Question +import datetime + +class QuestionModelTests(TestCase): + def test_was_published_recently_with_future_question(self): + """ + was_published_recently() returns False for questions whose pub_date + is in the future. + """ + time = timezone.now() + datetime.timedelta(days=30) + future_question: Question = Question.objects.create(pub_date=time) + self.assertIs(future_question.was_published_recently(), False) + + def test_was_published_recently_with_future_question_2(self): + """ + was_published_recently() returns False for questions whose pub_date + is in the future. + """ + time = timezone.now() + datetime.timedelta(days=30) + future_question = Question.objects.create(pub_date=time) + self.assertIs(future_question.was_published_recently(), True) + + def test_question_creation_and_retrieval(self): + """ + Test that a Question can be created and retrieved from the database. + """ + time = timezone.now() + question = Question.objects.create(pub_date=time, question_text="What's new?") + retrieved_question = Question.objects.get(question_text=question.question_text) + self.assertEqual(question, retrieved_question) + self.assertEqual(retrieved_question.question_text, "What's new?") + self.assertEqual(retrieved_question.pub_date, time) + diff --git a/python_files/tests/unittestadapter/.data/simple_django/polls/urls.py b/python_files/tests/unittestadapter/.data/simple_django/polls/urls.py new file mode 100644 index 000000000000..5756c7daa847 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/polls/urls.py @@ -0,0 +1,11 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +from django.urls import path + +from . import views + +urlpatterns = [ + # ex: /polls/ + path("", views.index, name="index"), +] diff --git a/python_files/tests/unittestadapter/.data/simple_django/polls/views.py b/python_files/tests/unittestadapter/.data/simple_django/polls/views.py new file mode 100644 index 000000000000..cccb6b3b0685 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/simple_django/polls/views.py @@ -0,0 +1,7 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. +from django.http import HttpResponse +from .models import Question # noqa: F401 + +def index(request): + return HttpResponse("Hello, world. You're at the polls index.") diff --git a/python_files/tests/unittestadapter/django_test_execution_script.py b/python_files/tests/unittestadapter/django_test_execution_script.py new file mode 100644 index 000000000000..21dd945224ea --- /dev/null +++ b/python_files/tests/unittestadapter/django_test_execution_script.py @@ -0,0 +1,17 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +import os +import pathlib +import sys + +sys.path.append(os.fspath(pathlib.Path(__file__).parent.parent)) + +from unittestadapter.django_handler import django_execution_runner + +if __name__ == "__main__": + args = sys.argv[1:] + manage_py_path = args[0] + test_ids = args[1:] + # currently doesn't support additional args past test_ids. + django_execution_runner(manage_py_path, test_ids, []) diff --git a/python_files/tests/unittestadapter/test_discovery.py b/python_files/tests/unittestadapter/test_discovery.py index 9afff6762fcc..972556de999b 100644 --- a/python_files/tests/unittestadapter/test_discovery.py +++ b/python_files/tests/unittestadapter/test_discovery.py @@ -4,7 +4,7 @@ import os import pathlib import sys -from typing import List +from typing import Any, Dict, List import pytest @@ -14,7 +14,7 @@ script_dir = pathlib.Path(__file__).parent.parent sys.path.append(os.fspath(script_dir)) - +from tests.pytestadapter import helpers # noqa: E402 from tests.tree_comparison_helper import is_same_tree # noqa: E402 from . import expected_discovery_test_output # noqa: E402 @@ -290,3 +290,38 @@ def test_complex_tree() -> None: expected_discovery_test_output.complex_tree_expected_output, ["id_", "lineno", "name"], ) + + +def test_simple_django_collect(): + test_data_path: pathlib.Path = pathlib.Path(__file__).parent / ".data" + python_files_path: pathlib.Path = pathlib.Path(__file__).parent.parent.parent + discovery_script_path: str = os.fsdecode(python_files_path / "unittestadapter" / "discovery.py") + data_path: pathlib.Path = test_data_path / "simple_django" + manage_py_path: str = os.fsdecode(pathlib.Path(data_path, "manage.py")) + + actual = helpers.runner_with_cwd_env( + [ + discovery_script_path, + "--udiscovery", + ], + data_path, + {"MANAGE_PY_PATH": manage_py_path}, + ) + + assert actual + actual_list: List[Dict[str, Any]] = actual + assert actual_list is not None + if actual_list is not None: + actual_item = actual_list.pop(0) + assert all(item in actual_item for item in ("status", "cwd")) + assert ( + actual_item.get("status") == "success" + ), f"Status is not 'success', error is: {actual_item.get('error')}" + assert actual_item.get("cwd") == os.fspath(data_path) + assert len(actual_item["tests"]["children"]) == 1 + assert actual_item["tests"]["children"][0]["children"][0]["id_"] == os.fsdecode( + pathlib.PurePath(test_data_path, "simple_django", "polls", "tests.py") + ) + assert ( + len(actual_item["tests"]["children"][0]["children"][0]["children"][0]["children"]) == 3 + ) diff --git a/python_files/tests/unittestadapter/test_execution.py b/python_files/tests/unittestadapter/test_execution.py index 71f1ca1ec73b..f369c6d770b0 100644 --- a/python_files/tests/unittestadapter/test_execution.py +++ b/python_files/tests/unittestadapter/test_execution.py @@ -4,14 +4,18 @@ import os import pathlib import sys -from typing import TYPE_CHECKING, Dict, Optional +from typing import TYPE_CHECKING, Any, Dict, List, Optional from unittest.mock import patch import pytest -script_dir = pathlib.Path(__file__).parent.parent.parent -sys.path.insert(0, os.fspath(script_dir / "lib" / "python")) +sys.path.append(os.fspath(pathlib.Path(__file__).parent)) +python_files_path = pathlib.Path(__file__).parent.parent.parent +sys.path.insert(0, os.fspath(python_files_path)) +sys.path.insert(0, os.fspath(python_files_path / "lib" / "python")) + +from tests.pytestadapter import helpers # noqa: E402 from unittestadapter.execution import run_tests # noqa: E402 if TYPE_CHECKING: @@ -296,3 +300,44 @@ def test_incorrect_path(): assert all(item in actual for item in ("cwd", "status", "error")) assert actual["status"] == "error" assert actual["cwd"] == os.fspath(TEST_DATA_PATH / "unknown_folder") + + +def test_basic_run_django(): + """This test runs on a simple django project with three tests, two of which pass and one that fails.""" + data_path: pathlib.Path = TEST_DATA_PATH / "simple_django" + manage_py_path: str = os.fsdecode(data_path / "manage.py") + execution_script: pathlib.Path = ( + pathlib.Path(__file__).parent / "django_test_execution_script.py" + ) + + test_ids = [ + "polls.tests.QuestionModelTests.test_was_published_recently_with_future_question", + "polls.tests.QuestionModelTests.test_was_published_recently_with_future_question_2", + "polls.tests.QuestionModelTests.test_question_creation_and_retrieval", + ] + script_str = os.fsdecode(execution_script) + actual = helpers.runner_with_cwd_env( + [script_str, manage_py_path, *test_ids], + data_path, + {"MANAGE_PY_PATH": manage_py_path}, + ) + assert actual + actual_list: List[Dict[str, Dict[str, Any]]] = actual + actual_result_dict = {} + assert len(actual_list) == 3 + for actual_item in actual_list: + assert all(item in actual_item for item in ("status", "cwd", "result")) + assert actual_item.get("cwd") == os.fspath(data_path) + actual_result_dict.update(actual_item["result"]) + for test_id in test_ids: + assert test_id in actual_result_dict + id_result = actual_result_dict[test_id] + assert id_result is not None + assert "outcome" in id_result + if ( + test_id + == "polls.tests.QuestionModelTests.test_was_published_recently_with_future_question_2" + ): + assert id_result["outcome"] == "failure" + else: + assert id_result["outcome"] == "success" diff --git a/python_files/unittestadapter/discovery.py b/python_files/unittestadapter/discovery.py index 604fe7beaeb1..660dda0b292c 100644 --- a/python_files/unittestadapter/discovery.py +++ b/python_files/unittestadapter/discovery.py @@ -8,9 +8,11 @@ import unittest from typing import List, Optional -script_dir = pathlib.Path(__file__).parent.parent +script_dir = pathlib.Path(__file__).parent sys.path.append(os.fspath(script_dir)) +from django_handler import django_discovery_runner # noqa: E402 + # If I use from utils then there will be an import error in test_discovery.py. from unittestadapter.pvsc_utils import ( # noqa: E402 DiscoveryPayloadDict, @@ -118,10 +120,25 @@ def discover_tests( print(error_msg, file=sys.stderr) raise VSCodeUnittestError(error_msg) - # Perform test discovery. - payload = discover_tests(start_dir, pattern, top_level_dir) - # Post this discovery payload. - send_post_request(payload, test_run_pipe) - # Post EOT token. - eot_payload: EOTPayloadDict = {"command_type": "discovery", "eot": True} - send_post_request(eot_payload, test_run_pipe) + if manage_py_path := os.environ.get("MANAGE_PY_PATH"): + # Django configuration requires manage.py path to enable. + print( + f"MANAGE_PY_PATH is set, running Django discovery with path to manage.py as: ${manage_py_path}" + ) + try: + # collect args for Django discovery runner. + args = argv[index + 1 :] or [] + django_discovery_runner(manage_py_path, args) + # eot payload sent within Django runner. + except Exception as e: + error_msg = f"Error configuring Django test runner: {e}" + print(error_msg, file=sys.stderr) + raise VSCodeUnittestError(error_msg) # noqa: B904 + else: + # Perform regular unittest test discovery. + payload = discover_tests(start_dir, pattern, top_level_dir) + # Post this discovery payload. + send_post_request(payload, test_run_pipe) + # Post EOT token. + eot_payload: EOTPayloadDict = {"command_type": "discovery", "eot": True} + send_post_request(eot_payload, test_run_pipe) diff --git a/python_files/unittestadapter/django_handler.py b/python_files/unittestadapter/django_handler.py new file mode 100644 index 000000000000..dc520c13aff1 --- /dev/null +++ b/python_files/unittestadapter/django_handler.py @@ -0,0 +1,106 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +import os +import pathlib +import subprocess +import sys +from typing import List + +script_dir = pathlib.Path(__file__).parent +sys.path.append(os.fspath(script_dir)) +sys.path.insert(0, os.fspath(script_dir / "lib" / "python")) + +from pvsc_utils import ( # noqa: E402 + VSCodeUnittestError, +) + + +def django_discovery_runner(manage_py_path: str, args: List[str]) -> None: + # Attempt a small amount of validation on the manage.py path. + try: + pathlib.Path(manage_py_path) + except Exception as e: + raise VSCodeUnittestError(f"Error running Django, manage.py path is not a valid path: {e}") # noqa: B904 + + try: + # Get path to the custom_test_runner.py parent folder, add to sys.path and new environment used for subprocess. + custom_test_runner_dir = pathlib.Path(__file__).parent + sys.path.insert(0, os.fspath(custom_test_runner_dir)) + env = os.environ.copy() + if "PYTHONPATH" in env: + env["PYTHONPATH"] = os.fspath(custom_test_runner_dir) + os.pathsep + env["PYTHONPATH"] + else: + env["PYTHONPATH"] = os.fspath(custom_test_runner_dir) + + # Build command to run 'python manage.py test'. + command = [ + sys.executable, + manage_py_path, + "test", + "--testrunner=django_test_runner.CustomDiscoveryTestRunner", + ] + command.extend(args) + print("Running Django tests with command:", command) + + subprocess_discovery = subprocess.run( + command, + capture_output=True, + text=True, + env=env, + ) + print(subprocess_discovery.stderr, file=sys.stderr) + print(subprocess_discovery.stdout, file=sys.stdout) + # Zero return code indicates success, 1 indicates test failures, so both are considered successful. + if subprocess_discovery.returncode not in (0, 1): + error_msg = "Django test discovery process exited with non-zero error code See stderr above for more details." + print(error_msg, file=sys.stderr) + except Exception as e: + raise VSCodeUnittestError(f"Error during Django discovery: {e}") # noqa: B904 + + +def django_execution_runner(manage_py_path: str, test_ids: List[str], args: List[str]) -> None: + # Attempt a small amount of validation on the manage.py path. + try: + pathlib.Path(manage_py_path) + except Exception as e: + raise VSCodeUnittestError(f"Error running Django, manage.py path is not a valid path: {e}") # noqa: B904 + + try: + # Get path to the custom_test_runner.py parent folder, add to sys.path. + custom_test_runner_dir: pathlib.Path = pathlib.Path(__file__).parent + sys.path.insert(0, os.fspath(custom_test_runner_dir)) + env: dict[str, str] = os.environ.copy() + if "PYTHONPATH" in env: + env["PYTHONPATH"] = os.fspath(custom_test_runner_dir) + os.pathsep + env["PYTHONPATH"] + else: + env["PYTHONPATH"] = os.fspath(custom_test_runner_dir) + + # Build command to run 'python manage.py test'. + command: List[str] = [ + sys.executable, + manage_py_path, + "test", + "--testrunner=django_test_runner.CustomExecutionTestRunner", + ] + # Add any additional arguments to the command provided by the user. + command.extend(args) + # Add the test_ids to the command. + print("Test IDs: ", test_ids) + print("args: ", args) + command.extend(test_ids) + print("Running Django run tests with command: ", command) + subprocess_execution = subprocess.run( + command, + capture_output=True, + text=True, + env=env, + ) + print(subprocess_execution.stderr, file=sys.stderr) + print(subprocess_execution.stdout, file=sys.stdout) + # Zero return code indicates success, 1 indicates test failures, so both are considered successful. + if subprocess_execution.returncode not in (0, 1): + error_msg = "Django test execution process exited with non-zero error code See stderr above for more details." + print(error_msg, file=sys.stderr) + except Exception as e: + print(f"Error during Django test execution: {e}", file=sys.stderr) diff --git a/python_files/unittestadapter/django_test_runner.py b/python_files/unittestadapter/django_test_runner.py new file mode 100644 index 000000000000..4225e2c8fa65 --- /dev/null +++ b/python_files/unittestadapter/django_test_runner.py @@ -0,0 +1,99 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +import os +import pathlib +import sys + +script_dir = pathlib.Path(__file__).parent.parent +sys.path.append(os.fspath(script_dir)) + +from typing import TYPE_CHECKING # noqa: E402 + +from execution import UnittestTestResult # noqa: E402 +from pvsc_utils import ( # noqa: E402 + DiscoveryPayloadDict, + EOTPayloadDict, + VSCodeUnittestError, + build_test_tree, + send_post_request, +) + +try: + from django.test.runner import DiscoverRunner +except ImportError: + raise ImportError( # noqa: B904 + "Django module not found. Please only use the environment variable MANAGE_PY_PATH if you want to use Django." + ) + + +if TYPE_CHECKING: + import unittest + + +class CustomDiscoveryTestRunner(DiscoverRunner): + """Custom test runner for Django to handle test DISCOVERY and building the test tree.""" + + def run_tests(self, test_labels, **kwargs): + test_run_pipe: str | None = os.getenv("TEST_RUN_PIPE") + if not test_run_pipe: + error_msg = ( + "UNITTEST ERROR: TEST_RUN_PIPE is not set at the time of unittest trying to send data. " + "Please confirm this environment variable is not being changed or removed " + "as it is required for successful test discovery and execution." + f"TEST_RUN_PIPE = {test_run_pipe}\n" + ) + print(error_msg, file=sys.stderr) + raise VSCodeUnittestError(error_msg) + try: + top_level_dir: pathlib.Path = pathlib.Path.cwd() + + # Discover tests and build into a tree. + suite: unittest.TestSuite = self.build_suite(test_labels, **kwargs) + tests, error = build_test_tree(suite, os.fspath(top_level_dir)) + + payload: DiscoveryPayloadDict = { + "cwd": os.fspath(top_level_dir), + "status": "success", + "tests": None, + } + payload["tests"] = tests if tests is not None else None + if len(error): + payload["status"] = "error" + payload["error"] = error + + # Send discovery payload. + send_post_request(payload, test_run_pipe) + # Send EOT token. + eot_payload: EOTPayloadDict = {"command_type": "discovery", "eot": True} + send_post_request(eot_payload, test_run_pipe) + return 0 # Skip actual test execution, return 0 as no tests were run. + except Exception as e: + error_msg = ( + "DJANGO ERROR: An error occurred while discovering and building the test suite. " + f"Error: {e}\n" + ) + print(error_msg, file=sys.stderr) + raise VSCodeUnittestError(error_msg) # noqa: B904 + + +class CustomExecutionTestRunner(DiscoverRunner): + """Custom test runner for Django to handle test EXECUTION and uses UnittestTestResult to send dynamic run results.""" + + def get_test_runner_kwargs(self): + """Override to provide custom test runner; resultclass.""" + test_run_pipe: str | None = os.getenv("TEST_RUN_PIPE") + if not test_run_pipe: + error_msg = ( + "UNITTEST ERROR: TEST_RUN_PIPE is not set at the time of Django trying to send data. " + "Please confirm this environment variable is not being changed or removed " + "as it is required for successful test discovery and execution." + f"TEST_RUN_PIPE = {test_run_pipe}\n" + ) + print(error_msg, file=sys.stderr) + raise VSCodeUnittestError(error_msg) + # Get existing kwargs + kwargs = super().get_test_runner_kwargs() + # Add custom resultclass, same resultclass as used in unittest. + kwargs["resultclass"] = UnittestTestResult + return kwargs diff --git a/python_files/unittestadapter/execution.py b/python_files/unittestadapter/execution.py index e81407e1e83c..4bc668bf71b6 100644 --- a/python_files/unittestadapter/execution.py +++ b/python_files/unittestadapter/execution.py @@ -19,10 +19,10 @@ sysconfig.get_paths()["scripts"] + os.pathsep + os.environ[path_var_name] ) - -script_dir = pathlib.Path(__file__).parent.parent +script_dir = pathlib.Path(__file__).parent sys.path.append(os.fspath(script_dir)) -sys.path.insert(0, os.fspath(script_dir / "lib" / "python")) + +from django_handler import django_execution_runner # noqa: E402 from testing_tools import process_json_util, socket_manager # noqa: E402 from unittestadapter.pvsc_utils import ( # noqa: E402 @@ -58,6 +58,24 @@ def __init__(self, *args, **kwargs): def startTest(self, test: unittest.TestCase): # noqa: N802 super().startTest(test) + def stopTestRun(self): # noqa: N802 + super().stopTestRun() + # After stopping the test run, send EOT + test_run_pipe = os.getenv("TEST_RUN_PIPE") + if os.getenv("MANAGE_PY_PATH"): + # only send this if it is a Django run + if not test_run_pipe: + print( + "UNITTEST ERROR: TEST_RUN_PIPE is not set at the time of unittest trying to send data. " + f"TEST_RUN_PIPE = {test_run_pipe}\n", + file=sys.stderr, + ) + raise VSCodeUnittestError( + "UNITTEST ERROR: TEST_RUN_PIPE is not set at the time of unittest trying to send data. " + ) + eot_payload: EOTPayloadDict = {"command_type": "execution", "eot": True} + send_post_request(eot_payload, test_run_pipe) + def addError( # noqa: N802 self, test: unittest.TestCase, @@ -318,9 +336,14 @@ def send_run_data(raw_data, test_run_pipe): raise VSCodeUnittestError(msg) from e try: - if raw_json and "params" in raw_json: + if raw_json and "params" in raw_json and raw_json["params"]: test_ids_from_buffer = raw_json["params"] - if test_ids_from_buffer: + # Check to see if we are running django tests. + if manage_py_path := os.environ.get("MANAGE_PY_PATH"): + args = argv[index + 1 :] or [] + django_execution_runner(manage_py_path, test_ids_from_buffer, args) + # the django run subprocesses sends the eot payload. + else: # Perform test execution. payload = run_tests( start_dir, @@ -331,6 +354,8 @@ def send_run_data(raw_data, test_run_pipe): failfast, locals_, ) + eot_payload: EOTPayloadDict = {"command_type": "execution", "eot": True} + send_post_request(eot_payload, test_run_pipe) else: # No test ids received from buffer cwd = os.path.abspath(start_dir) # noqa: PTH100 @@ -342,9 +367,9 @@ def send_run_data(raw_data, test_run_pipe): "result": None, } send_post_request(payload, test_run_pipe) + eot_payload: EOTPayloadDict = {"command_type": "execution", "eot": True} + send_post_request(eot_payload, test_run_pipe) except json.JSONDecodeError as exc: msg = "Error: Could not parse test ids from stdin" print(msg) raise VSCodeUnittestError(msg) from exc - eot_payload: EOTPayloadDict = {"command_type": "execution", "eot": True} - send_post_request(eot_payload, test_run_pipe) diff --git a/python_files/unittestadapter/pvsc_utils.py b/python_files/unittestadapter/pvsc_utils.py index 99577fc8e9c5..12a299a8992f 100644 --- a/python_files/unittestadapter/pvsc_utils.py +++ b/python_files/unittestadapter/pvsc_utils.py @@ -301,7 +301,7 @@ def parse_unittest_args( def send_post_request( payload: Union[ExecutionPayloadDict, DiscoveryPayloadDict, EOTPayloadDict], - test_run_pipe: str, + test_run_pipe: Optional[str], ): """ Sends a post request to the server. From e9f107113ed9a96842d39b8346917a49fb25288d Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Fri, 16 Aug 2024 15:09:46 -0700 Subject: [PATCH 062/149] Fix telemetry not getting picked up for Terminal REPL (#23958) https://github.com/microsoft/vscode-python/pull/23941 Having no blank spaces in front of plain 'python' or 'python3' were returning falsey value. --- python_files/Notebooks intro.ipynb | 95 ++++++++++--------- .../codeExecution/terminalReplWatcher.ts | 2 +- 2 files changed, 49 insertions(+), 48 deletions(-) diff --git a/python_files/Notebooks intro.ipynb b/python_files/Notebooks intro.ipynb index 850d7f5a86f9..0e8aadad1919 100644 --- a/python_files/Notebooks intro.ipynb +++ b/python_files/Notebooks intro.ipynb @@ -11,7 +11,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "1. Open the command palette with the shortcut: `Ctrl/Command` + `Shift` + `P`\r\n", + "1. Open the command palette with the shortcut: `Ctrl/Command` + `Shift` + `P`\n", "2. Search for the command `Create New Blank Notebook`" ] }, @@ -26,8 +26,8 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "1. Open the command palette with the shortcut: `Ctrl/Command` + `Shift` + `P`\r\n", - "\r\n", + "1. Open the command palette with the shortcut: `Ctrl/Command` + `Shift` + `P`\n", + "\n", "2. Search for the command `Python: Open Start Page`" ] }, @@ -42,10 +42,10 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "You are currently viewing what we call our Notebook Editor. It is an interactive document based on Jupyter Notebooks that supports the intermixing of code, outputs and markdown documentation. \r\n", - "\r\n", - "This cell is a markdown cell. To edit the text in this cell, simply double click on the cell to change it into edit mode.\r\n", - "\r\n", + "You are currently viewing what we call our Notebook Editor. It is an interactive document based on Jupyter Notebooks that supports the intermixing of code, outputs and markdown documentation. \n", + "\n", + "This cell is a markdown cell. To edit the text in this cell, simply double click on the cell to change it into edit mode.\n", + "\n", "The next cell below is a code cell. You can switch a cell between code and markdown by clicking on the code ![code icon](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/codeIcon.PNG) /markdown ![markdown icon](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/markdownIcon.PNG) icons or using the keyboard shortcut `M` and `Y` respectively." ] }, @@ -55,16 +55,16 @@ "metadata": {}, "outputs": [], "source": [ - "print('hello world')" + "print(\"hello world\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ - "* To execute the code in the cell above, click on the cell to select it and then either press the play ![play](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/playIcon.PNG) button in the cell toolbar, or use the keyboard shortcut `Ctrl/Command` + `Enter`.\r\n", - "* To edit the code, just click in cell and start editing.\r\n", - "* To add a new cell below, click the `Add Cell` icon ![add cell](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/addIcon.PNG) at the bottom left of the cell or enter command mode with the `ESC` Key and then use the keyboard shortcut `B` to create the new cell below.\r\n" + "* To execute the code in the cell above, click on the cell to select it and then either press the play ![play](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/playIcon.PNG) button in the cell toolbar, or use the keyboard shortcut `Ctrl/Command` + `Enter`.\n", + "* To edit the code, just click in cell and start editing.\n", + "* To add a new cell below, click the `Add Cell` icon ![add cell](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/addIcon.PNG) at the bottom left of the cell or enter command mode with the `ESC` Key and then use the keyboard shortcut `B` to create the new cell below.\n" ] }, { @@ -78,40 +78,40 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "**Variable explorer**\r\n", - "\r\n", - "To view all your active variables and their current values in the notebook, click on the variable explorer icon ![variable explorer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/variableExplorerIcon.PNG) in the top toolbar.\r\n", - "\r\n", - "![Variable Explorer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/variableexplorer.png)\r\n", - "\r\n", - "**Data Viewer**\r\n", - "\r\n", - "To view your data frame in a more visual \"Excel\" like format, open the variable explorer and to the left of any dataframe object, you will see the data viewer icon ![data viewer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/dataViewerIcon.PNG) which you can click to open the data viewer.\r\n", - "\r\n", - "![Data Viewer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/dataviewer.gif)\r\n", - "\r\n", - "**Convert to Python File**\r\n", - "\r\n", - "To export your notebook to a Python file (.py), click on the `Convert to Python script` icon ![Export icon](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/exportIcon.PNG) in the top toolbar \r\n", - "\r\n", - "![Export](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/savetopythonfile.png)\r\n", - "\r\n", - "**Plot Viewer**\r\n", - "\r\n", - "If you have a graph (such as matplotlib) in your output, you'll notice if you hover over the graph, the `Plot Viewer` icon ![Plot Viewer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/plotViewerIcon.PNG) will appear in the top left. Click the icon to open up the graph in the Plotviewer which allows you to zoom on your plots and export it in formats such as png and jpeg.\r\n", - "\r\n", - "![Plot Viewer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/plotviewer.gif)\r\n", - "\r\n", - "**Switching Kernels**\r\n", - "\r\n", - "The notebook editor will detect all kernels in your system by default. To change your notebook kernel, click on the kernel status in the top toolbar at the far right. For example, your kernel status may say \"Python 3: Idle\". This will open up the kernel selector where you can choose your desired kernel.\r\n", - "\r\n", - "![Switching Kernels](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/kernelchange.gif)\r\n", - "\r\n", - "**Remote Jupyter Server**\r\n", - "\r\n", - "To connect to a remote Jupyter server, open the command prompt and search for the command `Specify remote or local Jupyter server for connections`. Then select `Existing` and enter the remote Jupyter server URL. Afterwards, you'll be prompted to reload the window and the Notebook will be opened connected to the remote Jupyter server.\r\n", - "\r\n", + "**Variable explorer**\n", + "\n", + "To view all your active variables and their current values in the notebook, click on the variable explorer icon ![variable explorer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/variableExplorerIcon.PNG) in the top toolbar.\n", + "\n", + "![Variable Explorer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/variableexplorer.png)\n", + "\n", + "**Data Viewer**\n", + "\n", + "To view your data frame in a more visual \"Excel\" like format, open the variable explorer and to the left of any dataframe object, you will see the data viewer icon ![data viewer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/dataViewerIcon.PNG) which you can click to open the data viewer.\n", + "\n", + "![Data Viewer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/dataviewer.gif)\n", + "\n", + "**Convert to Python File**\n", + "\n", + "To export your notebook to a Python file (.py), click on the `Convert to Python script` icon ![Export icon](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/exportIcon.PNG) in the top toolbar \n", + "\n", + "![Export](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/savetopythonfile.png)\n", + "\n", + "**Plot Viewer**\n", + "\n", + "If you have a graph (such as matplotlib) in your output, you'll notice if you hover over the graph, the `Plot Viewer` icon ![Plot Viewer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/plotViewerIcon.PNG) will appear in the top left. Click the icon to open up the graph in the Plotviewer which allows you to zoom on your plots and export it in formats such as png and jpeg.\n", + "\n", + "![Plot Viewer](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/plotviewer.gif)\n", + "\n", + "**Switching Kernels**\n", + "\n", + "The notebook editor will detect all kernels in your system by default. To change your notebook kernel, click on the kernel status in the top toolbar at the far right. For example, your kernel status may say \"Python 3: Idle\". This will open up the kernel selector where you can choose your desired kernel.\n", + "\n", + "![Switching Kernels](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/kernelchange.gif)\n", + "\n", + "**Remote Jupyter Server**\n", + "\n", + "To connect to a remote Jupyter server, open the command prompt and search for the command `Specify remote or local Jupyter server for connections`. Then select `Existing` and enter the remote Jupyter server URL. Afterwards, you'll be prompted to reload the window and the Notebook will be opened connected to the remote Jupyter server.\n", + "\n", "![Remote](https://raw.githubusercontent.com/microsoft/vscode-python/main/images/remoteserver.gif)" ] }, @@ -129,7 +129,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "- [Data science tutorial for Visual Studio Code](https://code.visualstudio.com/docs/python/data-science-tutorial)\r\n", + "- [Data science tutorial for Visual Studio Code](https://code.visualstudio.com/docs/python/data-science-tutorial)\n", "- [Jupyter Notebooks in Visual Studio Code documentation](https://code.visualstudio.com/docs/python/jupyter-support)" ] } @@ -145,9 +145,10 @@ "name": "python3" }, "language_info": { + "name": "python", "version": "3.8.6-final" } }, "nbformat": 4, "nbformat_minor": 0 -} \ No newline at end of file +} diff --git a/src/client/terminals/codeExecution/terminalReplWatcher.ts b/src/client/terminals/codeExecution/terminalReplWatcher.ts index 5921bf8b07c4..dfe89ce1dc87 100644 --- a/src/client/terminals/codeExecution/terminalReplWatcher.ts +++ b/src/client/terminals/codeExecution/terminalReplWatcher.ts @@ -5,7 +5,7 @@ import { EventName } from '../../telemetry/constants'; function checkREPLCommand(command: string): boolean { const lower = command.toLowerCase().trimStart(); - return lower.startsWith('python ') || lower.startsWith('py '); + return lower.startsWith('python') || lower.startsWith('py'); } export function registerTriggerForTerminalREPL(disposables: Disposable[]): void { From a3dcf1bba19ee960d5887854ecc920dc5f8d4aa0 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Mon, 19 Aug 2024 12:55:17 -0700 Subject: [PATCH 063/149] Fix execInREPL Enter to respect complete expression (#23973) Resolves: https://github.com/microsoft/vscode-python/issues/23934 Updating to check filed of object, since structure/type has changed when I refactored code for native REPL. --- src/client/repl/pythonServer.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/client/repl/pythonServer.ts b/src/client/repl/pythonServer.ts index fbcb1104dc69..a342e989af7c 100644 --- a/src/client/repl/pythonServer.ts +++ b/src/client/repl/pythonServer.ts @@ -75,8 +75,8 @@ class PythonServerImpl implements Disposable { } public async checkValidCommand(code: string): Promise { - const completeCode = await this.connection.sendRequest('check_valid_command', code); - if (completeCode === 'True') { + const completeCode: ExecutionResult = await this.connection.sendRequest('check_valid_command', code); + if (completeCode.output === 'True') { return new Promise((resolve) => resolve(true)); } return new Promise((resolve) => resolve(false)); From 9cd6b2d744decc42e11102a9fd24ddeeeca7f8bd Mon Sep 17 00:00:00 2001 From: Courtney Webster <60238438+cwebster-99@users.noreply.github.com> Date: Mon, 19 Aug 2024 17:37:29 -0500 Subject: [PATCH 064/149] Add GDPR comment for `repltype` (#23974) Add missing GDPR comment for new `repltype` telemetry - this ensure it will get classified correctly --- src/client/telemetry/index.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index 4904b330c75b..fb1cb3a96be7 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -2305,7 +2305,8 @@ export interface IEventNamePropertyMapping { */ /* __GDPR__ "repl" : { - "duration" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "anthonykim1" } + "duration" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "anthonykim1" }, + "repltype" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "anthonykim1" } } */ [EventName.REPL]: { From fdddaf9899df729ddfafe085e2cde7218c3b74c5 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Tue, 20 Aug 2024 10:48:12 -0700 Subject: [PATCH 065/149] Additional graceful handling for pixi (#23942) In addition to first PR https://github.com/microsoft/vscode-python/pull/23937 I've been able to repro aggressive errors of ``` 2024-08-12 13:59:21.087 [error] [Error: spawn pixi ENOENT at ChildProcess._handle.onexit (node:internal/child_process:286:19) at onErrorNT (node:internal/child_process:484:16) at process.processTicksAndRejections (node:internal/process/task_queues:82:21)] { errno: -2, code: 'ENOENT', syscall: 'spawn pixi', path: 'pixi', spawnargs: [ '--version' ] } ``` ``` 2024-08-12 13:59:20.794 [error] Reading directory to watch failed [Error: ENOENT: no such file or directory, scandir '/Users/anthonykim/Desktop/vscode-python/.pixi/envs' at Object.readdirSync (node:fs:1509:26) at t.readdirSync (node:electron/js2c/node_init:2:11418) at /Users/anthonykim/.vscode/extensions/ms-python.python-2024.13.2024080901-darwin-arm64/out/client/extension.js:2:583006 at /Users/anthonykim/.vscode/extensions/ms-python.python-2024.13.2024080901-darwin-arm64/out/client/extension.js:2:583197 at Array.map () at d.initWatchers (/Users/anthonykim/.vscode/extensions/ms-python.python-2024.13.2024080901-darwin-arm64/out/client/extension.js:2:582915) at async d.ensureWatchersReady (/Users/anthonykim/.vscode/extensions/ms-python.python-2024.13.2024080901-darwin-arm64/out/client/extension.js:2:539326)] { errno: -2, code: 'ENOENT', syscall: 'scandir', path: '/Users/anthonykim/Desktop/vscode-python/.pixi/envs' } ``` even when I dont have pixi in my workspace. Changing the log level on this and adding more wraps around that should give necessary hint/message when needed without crashing program. --------- Co-authored-by: Karthik Nadig --- .../base/locators/common/resourceBasedLocator.ts | 8 ++++++-- .../base/locators/lowLevel/fsWatchingLocator.ts | 8 ++++---- .../common/environmentManagers/pixi.ts | 10 ++++------ 3 files changed, 14 insertions(+), 12 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/resourceBasedLocator.ts b/src/client/pythonEnvironments/base/locators/common/resourceBasedLocator.ts index 9391888cf0cf..8b56b4c7b8c1 100644 --- a/src/client/pythonEnvironments/base/locators/common/resourceBasedLocator.ts +++ b/src/client/pythonEnvironments/base/locators/common/resourceBasedLocator.ts @@ -4,7 +4,7 @@ import { IDisposable } from '../../../../common/types'; import { createDeferred, Deferred } from '../../../../common/utils/async'; import { Disposables } from '../../../../common/utils/resourceLifecycle'; -import { traceError } from '../../../../logging'; +import { traceError, traceWarn } from '../../../../logging'; import { arePathsSame, isVirtualWorkspace } from '../../../common/externalDependencies'; import { getEnvPath } from '../../info/env'; import { BasicEnvInfo, IPythonEnvsIterator, Locator, PythonLocatorQuery } from '../../locator'; @@ -36,7 +36,11 @@ export abstract class LazyResourceBasedLocator extends Locator imp protected async activate(): Promise { await this.ensureResourcesReady(); // There is not need to wait for the watchers to get started. - this.ensureWatchersReady().ignoreErrors(); + try { + this.ensureWatchersReady(); + } catch (ex) { + traceWarn(`Failed to ensure watchers are ready for locator ${this.constructor.name}`, ex); + } } public async dispose(): Promise { diff --git a/src/client/pythonEnvironments/base/locators/lowLevel/fsWatchingLocator.ts b/src/client/pythonEnvironments/base/locators/lowLevel/fsWatchingLocator.ts index 71bd30f7cfdc..dd7db5538565 100644 --- a/src/client/pythonEnvironments/base/locators/lowLevel/fsWatchingLocator.ts +++ b/src/client/pythonEnvironments/base/locators/lowLevel/fsWatchingLocator.ts @@ -6,7 +6,7 @@ import * as path from 'path'; import { Uri } from 'vscode'; import { FileChangeType, watchLocationForPattern } from '../../../../common/platform/fileSystemWatcher'; import { sleep } from '../../../../common/utils/async'; -import { traceError, traceVerbose } from '../../../../logging'; +import { traceVerbose, traceWarn } from '../../../../logging'; import { getEnvironmentDirFromPath } from '../../../common/commonUtils'; import { PythonEnvStructure, @@ -32,13 +32,13 @@ function checkDirWatchable(dirname: string): DirUnwatchableReason { names = fs.readdirSync(dirname); } catch (err) { const exception = err as NodeJS.ErrnoException; - traceError('Reading directory to watch failed', exception); + traceVerbose('Reading directory failed', exception); if (exception.code === 'ENOENT') { // Treat a missing directory as unwatchable since it can lead to CPU load issues: // https://github.com/microsoft/vscode-python/issues/18459 return 'directory does not exist'; } - throw err; // re-throw + return undefined; } // The limit here is an educated guess. if (names.length > 200) { @@ -117,7 +117,7 @@ export abstract class FSWatchingLocator extends LazyResourceBasedLocator { // that might be watched due to a glob are not checked. const unwatchable = await checkDirWatchable(root); if (unwatchable) { - traceError(`Dir "${root}" is not watchable (${unwatchable})`); + traceWarn(`Dir "${root}" is not watchable (${unwatchable})`); return undefined; } return root; diff --git a/src/client/pythonEnvironments/common/environmentManagers/pixi.ts b/src/client/pythonEnvironments/common/environmentManagers/pixi.ts index 7aa1d55acd2c..d7baa4b53f6e 100644 --- a/src/client/pythonEnvironments/common/environmentManagers/pixi.ts +++ b/src/client/pythonEnvironments/common/environmentManagers/pixi.ts @@ -9,7 +9,7 @@ import { OSType, getOSType, getUserHomeDir } from '../../../common/utils/platfor import { exec, getPythonSetting, onDidChangePythonSetting, pathExists, pathExistsSync } from '../externalDependencies'; import { cache } from '../../../common/utils/decorators'; import { isTestExecution } from '../../../common/constants'; -import { traceError, traceVerbose, traceWarn } from '../../../logging'; +import { traceVerbose, traceWarn } from '../../../logging'; import { OUTPUT_MARKER_SCRIPT } from '../../../common/process/internal/scripts'; export const PIXITOOLPATH_SETTING_KEY = 'pixiToolPath'; @@ -119,7 +119,7 @@ export class Pixi { yield customPixiToolPath; } } catch (ex) { - traceError(`Failed to get pixi setting`, ex); + traceWarn(`Failed to get pixi setting`, ex); } // Check unqualified filename, in case it's on PATH. @@ -182,7 +182,7 @@ export class Pixi { const pixiInfo: PixiInfo = JSON.parse(infoOutput.stdout); return pixiInfo; } catch (error) { - traceError(`Failed to get pixi info for ${cwd}`, error); + traceWarn(`Failed to get pixi info for ${cwd}`, error); return undefined; } } @@ -199,15 +199,13 @@ export class Pixi { if (!versionOutput || !versionOutput.stdout) { return undefined; } - const versionParts = versionOutput.stdout.split(' '); if (versionParts.length < 2) { return undefined; } - return versionParts[1].trim(); } catch (error) { - traceError(`Failed to get pixi version`, error); + traceVerbose(`Failed to get pixi version`, error); return undefined; } } From e751377b01a0507939e87d3b5d0f239b1f9fa661 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Tue, 20 Aug 2024 14:14:11 -0700 Subject: [PATCH 066/149] Do not truncate whitespace for multi-line string (#23977) Resolves: https://github.com/microsoft/vscode-python/issues/23743 It seems that when people have a multi line string such surrounded by """ quotes, the white spacing inside the quote is very much intentional, and so if we detect that they are in such code-block, we would rather not normalize/truncate the white spaces for that specific code block. --- python_files/normalizeSelection.py | 4 ++++ .../terminalExec/sample2_normalized_selection.py | 10 +++++++++- src/test/python_files/terminalExec/sample2_raw.py | 10 ++++++++-- 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/python_files/normalizeSelection.py b/python_files/normalizeSelection.py index 981251289e57..7ea283cc09a6 100644 --- a/python_files/normalizeSelection.py +++ b/python_files/normalizeSelection.py @@ -26,6 +26,10 @@ def _get_statements(selection): This will remove empty newlines around and within the selection, dedent it, and split it using the result of `ast.parse()`. """ + if '"""' in selection or "'''" in selection: + yield selection + return + # Remove blank lines within the selection to prevent the REPL from thinking the block is finished. lines = (line for line in split_lines(selection) if line.strip() != "") diff --git a/src/test/python_files/terminalExec/sample2_normalized_selection.py b/src/test/python_files/terminalExec/sample2_normalized_selection.py index a333d4e0daae..be7b280479c0 100644 --- a/src/test/python_files/terminalExec/sample2_normalized_selection.py +++ b/src/test/python_files/terminalExec/sample2_normalized_selection.py @@ -1,7 +1,15 @@ def add(x, y): - """Adds x to y""" + """ + + Adds x + to + y + + + """ # Some comment return x + y v = add(1, 7) print(v) + diff --git a/src/test/python_files/terminalExec/sample2_raw.py b/src/test/python_files/terminalExec/sample2_raw.py index 6ab7e67637f4..230abfda89cb 100644 --- a/src/test/python_files/terminalExec/sample2_raw.py +++ b/src/test/python_files/terminalExec/sample2_raw.py @@ -1,7 +1,13 @@ def add(x, y): - """Adds x to y""" + """ + + Adds x + to + y + + + """ # Some comment - return x + y v = add(1, 7) From 8ea21a9b5e0a8a35ea88b4d0879542ec20980b44 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Thu, 22 Aug 2024 00:49:53 +1000 Subject: [PATCH 067/149] Handle poetry env manager from native locator (#23983) For #23982 --- src/client/pythonEnvironments/nativeAPI.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/client/pythonEnvironments/nativeAPI.ts b/src/client/pythonEnvironments/nativeAPI.ts index ddf2371fc319..2d13500fdcd8 100644 --- a/src/client/pythonEnvironments/nativeAPI.ts +++ b/src/client/pythonEnvironments/nativeAPI.ts @@ -337,6 +337,9 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { traceLog(`Pyenv environment manager found at: ${native.executable}`); setPyEnvBinary(native.executable); break; + case 'poetry': + traceLog(`Poetry environment manager found at: ${native.executable}`); + break; default: traceWarn(`Unknown environment manager: ${native.tool}`); break; From 32d519b4eb14729bb2190c440c79aa66439d6d05 Mon Sep 17 00:00:00 2001 From: Rich Chiodo Date: Fri, 23 Aug 2024 12:02:15 -0700 Subject: [PATCH 068/149] Update to latest lsp for pull diagnostics (#23979) This is to match the latest updates we've made in pylance. See this PR: https://github.com/microsoft/pyrx/pull/5590 --- .eslintrc | 1 + package-lock.json | 2807 ++++++++++++----- package.json | 28 +- src/client/activation/extensionSurvey.ts | 6 +- .../checks/macPythonInterpreter.ts | 2 +- src/client/browser/extension.ts | 2 +- .../commands/reportIssueCommand.ts | 2 +- src/client/common/configSettings.ts | 3 +- src/client/common/extensions.ts | 7 - src/client/common/helpers.ts | 5 + src/client/common/installer/types.ts | 1 + src/client/common/interpreterPathService.ts | 2 +- src/client/common/platform/fileSystem.ts | 2 +- src/client/common/platform/fs-paths.ts | 184 +- src/client/common/platform/pathUtils.ts | 3 +- src/client/common/utils/multiStepInput.ts | 2 +- src/client/common/variables/environment.ts | 2 +- .../variables/environmentVariablesProvider.ts | 4 +- src/client/common/vscodeApis/extensionsApi.ts | 2 +- .../launch.json/launchJsonReader.ts | 2 +- .../installPython/installPythonViaTerminal.ts | 2 +- .../commands/setInterpreter.ts | 3 +- .../virtualEnvs/activatedEnvLaunch.ts | 4 +- .../virtualEnvs/condaInheritEnvPrompt.ts | 4 +- .../locators/common/nativePythonFinder.ts | 5 +- .../lowLevel/customVirtualEnvLocator.ts | 8 +- .../globalVirtualEnvronmentLocator.ts | 3 +- .../lowLevel/microsoftStoreLocator.ts | 4 +- .../common/environmentManagers/conda.ts | 2 +- .../environmentManagers/simplevirtualenvs.ts | 2 +- .../common/externalDependencies.ts | 7 +- .../pythonEnvironments/common/posixUtils.ts | 2 +- .../common/pythonBinariesWatcher.ts | 3 +- .../creation/common/commonUtils.ts | 2 +- .../creation/common/createEnvTriggerUtils.ts | 2 +- .../creation/common/workspaceSelection.ts | 2 +- .../creation/provider/venvDeleteUtils.ts | 2 +- .../creation/provider/venvUtils.ts | 2 +- src/client/telemetry/importTracker.ts | 2 +- src/client/tensorBoard/tensorBoardSession.ts | 2 +- .../envCollectionActivation/service.ts | 4 +- .../testController/common/resultsHelper.ts | 2 +- src/test/.vscode/settings.json | 3 +- src/test/common.ts | 10 +- .../commands/reportIssueCommand.unit.test.ts | 2 +- .../configSettings.pythonPath.unit.test.ts | 3 +- .../configSettings.unit.test.ts | 2 +- src/test/common/exitCIAfterTestReporter.ts | 3 +- src/test/common/moduleInstaller.test.ts | 41 +- .../platform/filesystem.functional.test.ts | 15 +- src/test/common/platform/filesystem.test.ts | 2 +- .../common/platform/filesystem.unit.test.ts | 2 +- .../platform/fs-temp.functional.test.ts | 2 +- .../platformService.functional.test.ts | 2 +- src/test/common/platform/utils.ts | 2 +- src/test/common/process/logger.unit.test.ts | 4 +- src/test/common/process/proc.exec.test.ts | 2 +- .../common/process/proc.observable.test.ts | 2 +- .../process/pythonEnvironment.unit.test.ts | 2 +- .../pythonProc.simple.multiroot.test.ts | 4 +- .../common/process/pythonProcess.unit.test.ts | 2 +- .../process/pythonToolService.unit.test.ts | 2 +- src/test/common/serviceRegistry.unit.test.ts | 2 +- src/test/common/socketCallbackHandler.test.ts | 4 +- .../terminalActivation.testvirtualenvs.ts | 2 +- src/test/common/utils/decorators.unit.test.ts | 2 +- .../envVarsProvider.multiroot.test.ts | 2 +- .../envVarsService.functional.test.ts | 2 +- .../common/variables/envVarsService.test.ts | 2 +- .../variables/envVarsService.unit.test.ts | 2 +- .../commands/setInterpreter.unit.test.ts | 17 +- src/test/debugger/envVars.test.ts | 2 +- .../extension/adapter/adapter.test.ts | 2 +- .../extension/adapter/factory.unit.test.ts | 4 +- .../outdatedDebuggerPrompt.unit.test.ts | 8 +- .../launch.json/launchJsonReader.unit.test.ts | 2 +- src/test/debugger/utils.ts | 2 +- src/test/fakeVSCFileSystemAPI.ts | 2 +- src/test/fixtures.ts | 2 +- src/test/index.ts | 6 +- src/test/initialize.ts | 4 +- .../install/channelManager.channels.test.ts | 5 +- .../install/channelManager.messages.test.ts | 9 +- .../interpreterService.unit.test.ts | 47 +- src/test/mocks/helper.ts | 19 +- src/test/mocks/mockChildProcess.ts | 4 + src/test/mocks/process.ts | 6 +- src/test/mocks/vsc/charCode.ts | 4 +- src/test/performance/load.perf.test.ts | 2 +- src/test/performanceTest.ts | 6 +- src/test/providers/terminal.unit.test.ts | 2 +- .../base/locators/envTestUtils.ts | 2 +- .../lowLevel/activestateLocator.unit.test.ts | 4 +- .../lowLevel/condaLocator.testvirtualenvs.ts | 2 +- .../lowLevel/condaLocator.unit.test.ts | 2 +- .../customVirtualEnvLocator.unit.test.ts | 3 +- .../lowLevel/microsoftStoreLocator.test.ts | 2 +- .../locators/lowLevel/watcherTestUtils.ts | 2 +- .../environmentManagers/conda.unit.test.ts | 64 +- .../simplevirtualenvs.unit.test.ts | 2 +- .../common/installCheckUtils.unit.test.ts | 2 +- .../common/workspaceSelection.unit.test.ts | 2 +- .../creation/createEnvApi.unit.test.ts | 2 +- .../createEnvButtonContext.unit.test.ts | 2 +- .../creation/createEnvironment.unit.test.ts | 2 +- .../installedPackagesDiagnostics.unit.test.ts | 2 +- .../provider/commonUtils.unit.test.ts | 2 +- .../condaCreationProvider.unit.test.ts | 3 +- .../venvCreationProvider.unit.test.ts | 3 +- .../provider/venvDeleteUtils.unit.test.ts | 2 +- .../creation/provider/venvUtils.unit.test.ts | 4 +- .../pyProjectTomlContext.unit.test.ts | 2 +- src/test/serviceRegistry.ts | 23 +- src/test/smoke/common.ts | 8 +- src/test/smoke/datascience.smoke.test.ts | 2 +- src/test/smoke/jedilsp.smoke.test.ts | 2 +- src/test/smoke/runInTerminal.smoke.test.ts | 2 +- src/test/smoke/smartSend.smoke.test.ts | 2 +- src/test/smokeTest.ts | 4 +- src/test/standardTest.ts | 2 +- src/test/telemetry/index.unit.test.ts | 2 +- .../tensorBoardFileWatcher.test.ts | 2 +- .../terminals/codeExecution/helper.test.ts | 2 +- .../terminals/codeExecution/smartSend.test.ts | 2 +- .../terminals/serviceRegistry.unit.test.ts | 13 +- src/test/testBootstrap.ts | 2 +- src/test/testRunner.ts | 8 +- .../testing/common/debugLauncher.unit.test.ts | 4 +- .../configSettingService.unit.test.ts | 2 +- .../testing/common/testingAdapter.test.ts | 3 +- .../testing/configurationFactory.unit.test.ts | 2 +- .../pytestDiscoveryAdapter.unit.test.ts | 2 +- .../pytestExecutionAdapter.unit.test.ts | 2 +- .../testCancellationRunAdapters.unit.test.ts | 4 +- .../testDiscoveryAdapter.unit.test.ts | 2 +- .../testExecutionAdapter.unit.test.ts | 2 +- src/test/utils/fs.ts | 2 +- src/test/utils/vscode.ts | 2 +- tsconfig.browser.json | 3 +- tsconfig.json | 3 +- 140 files changed, 2468 insertions(+), 1168 deletions(-) diff --git a/.eslintrc b/.eslintrc index 62e2aa6c52ba..03bfab0d4710 100644 --- a/.eslintrc +++ b/.eslintrc @@ -69,6 +69,7 @@ "no-control-regex": "off", "no-extend-native": "off", "no-multi-str": "off", + "no-shadow": "off", "no-param-reassign": "off", "no-prototype-builtins": "off", "no-restricted-syntax": [ diff --git a/package-lock.json b/package-lock.json index 73b3b4431bb1..40be8e47f4dc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,11 +12,11 @@ "@iarna/toml": "^2.2.5", "@vscode/extension-telemetry": "^0.8.4", "arch": "^2.1.0", - "fs-extra": "^10.0.1", + "fs-extra": "^11.2.0", "glob": "^7.2.0", "hash.js": "^1.1.7", "iconv-lite": "^0.6.3", - "inversify": "^5.0.4", + "inversify": "^6.0.2", "jsonc-parser": "^3.0.0", "lodash": "^4.17.21", "minimatch": "^5.0.1", @@ -31,11 +31,10 @@ "tmp": "^0.0.33", "uint64be": "^3.0.0", "unicode": "^14.0.0", - "untildify": "^4.0.0", "vscode-debugprotocol": "^1.28.0", - "vscode-jsonrpc": "^9.0.0-next.2", - "vscode-languageclient": "^10.0.0-next.2", - "vscode-languageserver-protocol": "^3.17.6-next.3", + "vscode-jsonrpc": "^9.0.0-next.5", + "vscode-languageclient": "^10.0.0-next.12", + "vscode-languageserver-protocol": "^3.17.6-next.10", "vscode-tas-client": "^0.1.84", "which": "^2.0.2", "winreg": "^1.2.4", @@ -48,22 +47,22 @@ "@types/chai-arrays": "^2.0.0", "@types/chai-as-promised": "^7.1.0", "@types/download": "^8.0.1", - "@types/fs-extra": "^9.0.13", + "@types/fs-extra": "^11.0.4", "@types/glob": "^7.2.0", "@types/lodash": "^4.14.104", "@types/mocha": "^9.1.0", - "@types/node": "^18.17.1", + "@types/node": "^22.5.0", "@types/semver": "^5.5.0", "@types/shortid": "^0.0.29", - "@types/sinon": "^10.0.11", + "@types/sinon": "^17.0.3", "@types/stack-trace": "0.0.29", "@types/tmp": "^0.0.33", "@types/vscode": "^1.81.0", "@types/which": "^2.0.1", "@types/winreg": "^1.2.30", "@types/xml2js": "^0.4.2", - "@typescript-eslint/eslint-plugin": "^3.7.0", - "@typescript-eslint/parser": "^3.7.0", + "@typescript-eslint/eslint-plugin": "^6.21.0", + "@typescript-eslint/parser": "^6.21.0", "@vscode/test-electron": "^2.3.8", "@vscode/vsce": "^2.27.0", "bent": "^7.3.12", @@ -71,13 +70,14 @@ "chai-arrays": "^2.0.0", "chai-as-promised": "^7.1.1", "copy-webpack-plugin": "^9.1.0", + "cross-env": "^7.0.3", "cross-spawn": "^6.0.5", "del": "^6.0.0", "download": "^8.0.0", "eslint": "^7.2.0", "eslint-config-airbnb": "^18.2.0", "eslint-config-prettier": "^8.3.0", - "eslint-plugin-import": "^2.25.4", + "eslint-plugin-import": "^2.29.1", "eslint-plugin-jsx-a11y": "^6.3.1", "eslint-plugin-react": "^7.20.3", "eslint-plugin-react-hooks": "^4.0.0", @@ -96,14 +96,14 @@ "prettier": "^2.0.2", "rewiremock": "^3.13.0", "shortid": "^2.2.8", - "sinon": "^13.0.1", + "sinon": "^18.0.0", "source-map-support": "^0.5.12", "ts-loader": "^9.2.8", "ts-mockito": "^2.5.0", "ts-node": "^10.7.0", "tsconfig-paths-webpack-plugin": "^3.2.0", "typemoq": "^2.1.0", - "typescript": "4.5.5", + "typescript": "~5.2", "uuid": "^8.3.2", "webpack": "^5.76.0", "webpack-bundle-analyzer": "^4.5.0", @@ -882,6 +882,42 @@ "node": ">=10.0.0" } }, + "node_modules/@eslint-community/eslint-utils": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz", + "integrity": "sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^3.3.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "peerDependencies": { + "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" + } + }, + "node_modules/@eslint-community/eslint-utils/node_modules/eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/@eslint-community/regexpp": { + "version": "4.11.0", + "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.11.0.tgz", + "integrity": "sha512-G/M/tIiMrTAxEWRfLfQJMmGNX28IxBg4PBz8XqQhqUHLFI6TL2htpIB1iQCj144V5ee/JaKyT9/WZ0MGZWfA7A==", + "dev": true, + "engines": { + "node": "^12.0.0 || ^14.0.0 || >=16.0.0" + } + }, "node_modules/@eslint/eslintrc": { "version": "0.4.3", "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.3.tgz", @@ -1475,38 +1511,47 @@ } }, "node_modules/@sinonjs/commons": { - "version": "1.8.3", - "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", - "integrity": "sha512-xkNcLAn/wZaX14RPlwizcKicDk9G3F8m2nU3L7Ukm5zBgTwiT0wsoFAHx9Jq56fJA1z/7uKGtCRu16sOUCLIHQ==", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-3.0.1.tgz", + "integrity": "sha512-K3mCHKQ9sVh8o1C9cxkwxaOmXoAMlDxC1mYyHrjqOWEcBjYr76t96zL2zlj5dUGZ3HSw240X1qgH3Mjf1yJWpQ==", "dev": true, "dependencies": { "type-detect": "4.0.8" } }, "node_modules/@sinonjs/fake-timers": { - "version": "9.1.1", - "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-9.1.1.tgz", - "integrity": "sha512-Wp5vwlZ0lOqpSYGKqr53INws9HLkt6JDc/pDZcPf7bchQnrXJMXPns8CXx0hFikMSGSWfvtvvpb2gtMVfkWagA==", + "version": "11.2.2", + "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-11.2.2.tgz", + "integrity": "sha512-G2piCSxQ7oWOxwGSAyFHfPIsyeJGXYtc6mFbnFA+kRXkiEnTl8c/8jul2S329iFBnDI9HGoeWWAZvuvOkZccgw==", "dev": true, "dependencies": { - "@sinonjs/commons": "^1.7.0" + "@sinonjs/commons": "^3.0.0" } }, "node_modules/@sinonjs/samsam": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/@sinonjs/samsam/-/samsam-6.1.1.tgz", - "integrity": "sha512-cZ7rKJTLiE7u7Wi/v9Hc2fs3Ucc3jrWeMgPHbbTCeVAB2S0wOBbYlkJVeNSL04i7fdhT8wIbDq1zhC/PXTD2SA==", + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@sinonjs/samsam/-/samsam-8.0.0.tgz", + "integrity": "sha512-Bp8KUVlLp8ibJZrnvq2foVhP0IVX2CIprMJPK0vqGqgrDa0OHVKeZyBykqskkrdxV6yKBPmGasO8LVjAKR3Gew==", "dev": true, "dependencies": { - "@sinonjs/commons": "^1.6.0", + "@sinonjs/commons": "^2.0.0", "lodash.get": "^4.4.2", "type-detect": "^4.0.8" } }, + "node_modules/@sinonjs/samsam/node_modules/@sinonjs/commons": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-2.0.0.tgz", + "integrity": "sha512-uLa0j859mMrg2slwQYdO/AkrOfmH+X6LTVmNTS9CqexuE2IvVORIkSpJLqePAbEnKJ77aMmCwr1NUZ57120Xcg==", + "dev": true, + "dependencies": { + "type-detect": "4.0.8" + } + }, "node_modules/@sinonjs/text-encoding": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/@sinonjs/text-encoding/-/text-encoding-0.7.1.tgz", - "integrity": "sha512-+iTbntw2IZPb/anVDbypzfQa+ay64MW0Zo8aJ8gZPWMMK6/OubMVb6lUPMagqjOPnmtauXnFCACVl3O7ogjeqQ==", + "version": "0.7.3", + "resolved": "https://registry.npmjs.org/@sinonjs/text-encoding/-/text-encoding-0.7.3.tgz", + "integrity": "sha512-DE427ROAphMQzU4ENbliGYrBSYPXF+TtLg9S8vzeA+OF4ZKzoDdzfL8sxuMUGS/lgRhM6j1URSk9ghf7Xo1tyA==", "dev": true }, "node_modules/@tootallnate/once": { @@ -1621,12 +1666,6 @@ "@types/estree": "*" } }, - "node_modules/@types/eslint-visitor-keys": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@types/eslint-visitor-keys/-/eslint-visitor-keys-1.0.0.tgz", - "integrity": "sha512-OCutwjDZ4aFS6PB1UZ988C4YgwlBHJd6wCeQqaLdmadZ/7e+w79+hbMUFC1QXDNCmdyoRfAFdm0RypzwR+Qpag==", - "dev": true - }, "node_modules/@types/estree": { "version": "0.0.51", "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.51.tgz", @@ -1634,11 +1673,12 @@ "dev": true }, "node_modules/@types/fs-extra": { - "version": "9.0.13", - "resolved": "https://registry.npmjs.org/@types/fs-extra/-/fs-extra-9.0.13.tgz", - "integrity": "sha512-nEnwB++1u5lVDM2UI4c1+5R+FYaKfaAzS4OococimjVm3nQw3TuzH5UNsocrcTBbhnerblyHj4A49qXbIiZdpA==", + "version": "11.0.4", + "resolved": "https://registry.npmjs.org/@types/fs-extra/-/fs-extra-11.0.4.tgz", + "integrity": "sha512-yTbItCNreRooED33qjunPthRcSjERP1r4MqCZc7wv0u2sUkzTFp45tgUfS5+r7FrZPdmCCNflLhVSP/o+SemsQ==", "dev": true, "dependencies": { + "@types/jsonfile": "*", "@types/node": "*" } }, @@ -1678,9 +1718,9 @@ } }, "node_modules/@types/json-schema": { - "version": "7.0.9", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.9.tgz", - "integrity": "sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ==", + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", "dev": true }, "node_modules/@types/json5": { @@ -1689,6 +1729,15 @@ "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", "dev": true }, + "node_modules/@types/jsonfile": { + "version": "6.1.4", + "resolved": "https://registry.npmjs.org/@types/jsonfile/-/jsonfile-6.1.4.tgz", + "integrity": "sha512-D5qGUYwjvnNNextdU59/+fI+spnwtTFmyQP0h+PfIOSkNfpU6AOICUOkm4i0OnSk+NyjdPJrxCDro0sJsWlRpQ==", + "dev": true, + "dependencies": { + "@types/node": "*" + } + }, "node_modules/@types/lodash": { "version": "4.14.181", "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.181.tgz", @@ -1708,10 +1757,13 @@ "dev": true }, "node_modules/@types/node": { - "version": "18.17.14", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.17.14.tgz", - "integrity": "sha512-ZE/5aB73CyGqgQULkLG87N9GnyGe5TcQjv34pwS8tfBs1IkCh0ASM69mydb2znqd6v0eX+9Ytvk6oQRqu8T1Vw==", - "dev": true + "version": "22.5.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.5.0.tgz", + "integrity": "sha512-DkFrJOe+rfdHTqqMg0bSNlGlQ85hSoh2TPzZyhHsXnMtligRWpxUySiyw8FY14ITt24HVCiQPWxS3KO/QlGmWg==", + "dev": true, + "dependencies": { + "undici-types": "~6.19.2" + } }, "node_modules/@types/semver": { "version": "5.5.0", @@ -1731,9 +1783,9 @@ "dev": true }, "node_modules/@types/sinon": { - "version": "10.0.11", - "resolved": "https://registry.npmjs.org/@types/sinon/-/sinon-10.0.11.tgz", - "integrity": "sha512-dmZsHlBsKUtBpHriNjlK0ndlvEh8dcb9uV9Afsbt89QIyydpC7NcR+nWlAhASfy3GHnxTl4FX/aKE7XZUt/B4g==", + "version": "17.0.3", + "resolved": "https://registry.npmjs.org/@types/sinon/-/sinon-17.0.3.tgz", + "integrity": "sha512-j3uovdn8ewky9kRBG19bOwaZbexJu/XjtkHyjvUgt4xfPFz18dcORIMqnYh66Fx3Powhcr85NT5+er3+oViapw==", "dev": true, "dependencies": { "@types/sinonjs__fake-timers": "*" @@ -1791,28 +1843,33 @@ } }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-3.10.1.tgz", - "integrity": "sha512-PQg0emRtzZFWq6PxBcdxRH3QIQiyFO3WCVpRL3fgj5oQS3CDs3AeAKfv4DxNhzn8ITdNJGJ4D3Qw8eAJf3lXeQ==", - "dev": true, - "dependencies": { - "@typescript-eslint/experimental-utils": "3.10.1", - "debug": "^4.1.1", - "functional-red-black-tree": "^1.0.1", - "regexpp": "^3.0.0", - "semver": "^7.3.2", - "tsutils": "^3.17.1" + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-6.21.0.tgz", + "integrity": "sha512-oy9+hTPCUFpngkEZUSzbf9MxI65wbKFoQYsgPdILTfbUldp5ovUuphZVe4i30emU9M/kP+T64Di0mxl7dSw3MA==", + "dev": true, + "dependencies": { + "@eslint-community/regexpp": "^4.5.1", + "@typescript-eslint/scope-manager": "6.21.0", + "@typescript-eslint/type-utils": "6.21.0", + "@typescript-eslint/utils": "6.21.0", + "@typescript-eslint/visitor-keys": "6.21.0", + "debug": "^4.3.4", + "graphemer": "^1.4.0", + "ignore": "^5.2.4", + "natural-compare": "^1.4.0", + "semver": "^7.5.4", + "ts-api-utils": "^1.0.1" }, "engines": { - "node": "^10.12.0 || >=12.0.0" + "node": "^16.0.0 || >=18.0.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "@typescript-eslint/parser": "^3.0.0", - "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + "@typescript-eslint/parser": "^6.0.0 || ^6.0.0-alpha", + "eslint": "^7.0.0 || ^8.0.0" }, "peerDependenciesMeta": { "typescript": { @@ -1821,9 +1878,9 @@ } }, "node_modules/@typescript-eslint/eslint-plugin/node_modules/debug": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.2.tgz", - "integrity": "sha512-mOp8wKcvj7XxC78zLgw/ZA+6TSgkoE2C/ienthhRD298T7UNwAg9diBpLRxC0mOezLl4B0xV7M0cCO6P/O0Xhw==", + "version": "4.3.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", + "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", "dev": true, "dependencies": { "ms": "2.1.2" @@ -1837,50 +1894,88 @@ } } }, - "node_modules/@typescript-eslint/experimental-utils": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-3.10.1.tgz", - "integrity": "sha512-DewqIgscDzmAfd5nOGe4zm6Bl7PKtMG2Ad0KG8CUZAHlXfAKTF9Ol5PXhiMh39yRL2ChRH1cuuUGOcVyyrhQIw==", + "node_modules/@typescript-eslint/parser": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-6.21.0.tgz", + "integrity": "sha512-tbsV1jPne5CkFQCgPBcDOt30ItF7aJoZL997JSF7MhGQqOeT3svWRYxiqlfA5RUdlHN6Fi+EI9bxqbdyAUZjYQ==", "dev": true, "dependencies": { - "@types/json-schema": "^7.0.3", - "@typescript-eslint/types": "3.10.1", - "@typescript-eslint/typescript-estree": "3.10.1", - "eslint-scope": "^5.0.0", - "eslint-utils": "^2.0.0" + "@typescript-eslint/scope-manager": "6.21.0", + "@typescript-eslint/types": "6.21.0", + "@typescript-eslint/typescript-estree": "6.21.0", + "@typescript-eslint/visitor-keys": "6.21.0", + "debug": "^4.3.4" }, "engines": { - "node": "^10.12.0 || >=12.0.0" + "node": "^16.0.0 || >=18.0.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "*" + "eslint": "^7.0.0 || ^8.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } } }, - "node_modules/@typescript-eslint/parser": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-3.10.1.tgz", - "integrity": "sha512-Ug1RcWcrJP02hmtaXVS3axPPTTPnZjupqhgj+NnZ6BCkwSImWk/283347+x9wN+lqOdK9Eo3vsyiyDHgsmiEJw==", + "node_modules/@typescript-eslint/parser/node_modules/debug": { + "version": "4.3.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", + "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", "dev": true, "dependencies": { - "@types/eslint-visitor-keys": "^1.0.0", - "@typescript-eslint/experimental-utils": "3.10.1", - "@typescript-eslint/types": "3.10.1", - "@typescript-eslint/typescript-estree": "3.10.1", - "eslint-visitor-keys": "^1.1.0" + "ms": "2.1.2" }, "engines": { - "node": "^10.12.0 || >=12.0.0" + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/scope-manager": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-6.21.0.tgz", + "integrity": "sha512-OwLUIWZJry80O99zvqXVEioyniJMa+d2GrqpUTqi5/v5D5rOrppJVBPa0yKCblcigC0/aYAzxxqQ1B+DS2RYsg==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "6.21.0", + "@typescript-eslint/visitor-keys": "6.21.0" + }, + "engines": { + "node": "^16.0.0 || >=18.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/type-utils": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-6.21.0.tgz", + "integrity": "sha512-rZQI7wHfao8qMX3Rd3xqeYSMCL3SoiSQLBATSiVKARdFGCYSRvmViieZjqc58jKgs8Y8i9YvVVhRbHSTA4VBag==", + "dev": true, + "dependencies": { + "@typescript-eslint/typescript-estree": "6.21.0", + "@typescript-eslint/utils": "6.21.0", + "debug": "^4.3.4", + "ts-api-utils": "^1.0.1" + }, + "engines": { + "node": "^16.0.0 || >=18.0.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + "eslint": "^7.0.0 || ^8.0.0" }, "peerDependenciesMeta": { "typescript": { @@ -1888,13 +1983,30 @@ } } }, + "node_modules/@typescript-eslint/type-utils/node_modules/debug": { + "version": "4.3.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", + "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, "node_modules/@typescript-eslint/types": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-3.10.1.tgz", - "integrity": "sha512-+3+FCUJIahE9q0lDi1WleYzjCwJs5hIsbugIgnbB+dSCYUxl8L6PwmsyOPFZde2hc1DlTo/xnkOgiTLSyAbHiQ==", + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-6.21.0.tgz", + "integrity": "sha512-1kFmZ1rOm5epu9NZEZm1kckCDGj5UJEf7P1kliH4LKu/RkwpsfqqGmY2OOcUs18lSlQBKLDYBOGxRVtrMN5lpg==", "dev": true, "engines": { - "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + "node": "^16.0.0 || >=18.0.0" }, "funding": { "type": "opencollective", @@ -1902,22 +2014,22 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-3.10.1.tgz", - "integrity": "sha512-QbcXOuq6WYvnB3XPsZpIwztBoquEYLXh2MtwVU+kO8jgYCiv4G5xrSP/1wg4tkvrEE+esZVquIPX/dxPlePk1w==", + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-6.21.0.tgz", + "integrity": "sha512-6npJTkZcO+y2/kr+z0hc4HwNfrrP4kNYh57ek7yCNlrBjWQ1Y0OS7jiZTkgumrvkX5HkEKXFZkkdFNkaW2wmUQ==", "dev": true, "dependencies": { - "@typescript-eslint/types": "3.10.1", - "@typescript-eslint/visitor-keys": "3.10.1", - "debug": "^4.1.1", - "glob": "^7.1.6", - "is-glob": "^4.0.1", - "lodash": "^4.17.15", - "semver": "^7.3.2", - "tsutils": "^3.17.1" + "@typescript-eslint/types": "6.21.0", + "@typescript-eslint/visitor-keys": "6.21.0", + "debug": "^4.3.4", + "globby": "^11.1.0", + "is-glob": "^4.0.3", + "minimatch": "9.0.3", + "semver": "^7.5.4", + "ts-api-utils": "^1.0.1" }, "engines": { - "node": "^10.12.0 || >=12.0.0" + "node": "^16.0.0 || >=18.0.0" }, "funding": { "type": "opencollective", @@ -1929,10 +2041,19 @@ } } }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, "node_modules/@typescript-eslint/typescript-estree/node_modules/debug": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.2.tgz", - "integrity": "sha512-mOp8wKcvj7XxC78zLgw/ZA+6TSgkoE2C/ienthhRD298T7UNwAg9diBpLRxC0mOezLl4B0xV7M0cCO6P/O0Xhw==", + "version": "4.3.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", + "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", "dev": true, "dependencies": { "ms": "2.1.2" @@ -1946,22 +2067,81 @@ } } }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/minimatch": { + "version": "9.0.3", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", + "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/@typescript-eslint/utils": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-6.21.0.tgz", + "integrity": "sha512-NfWVaC8HP9T8cbKQxHcsJBY5YE1O33+jpMwN45qzWWaPDZgLIbo12toGMWnmhvCpd3sIxkpDw3Wv1B3dYrbDQQ==", + "dev": true, + "dependencies": { + "@eslint-community/eslint-utils": "^4.4.0", + "@types/json-schema": "^7.0.12", + "@types/semver": "^7.5.0", + "@typescript-eslint/scope-manager": "6.21.0", + "@typescript-eslint/types": "6.21.0", + "@typescript-eslint/typescript-estree": "6.21.0", + "semver": "^7.5.4" + }, + "engines": { + "node": "^16.0.0 || >=18.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^7.0.0 || ^8.0.0" + } + }, + "node_modules/@typescript-eslint/utils/node_modules/@types/semver": { + "version": "7.5.8", + "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.5.8.tgz", + "integrity": "sha512-I8EUhyrgfLrcTkzV3TSsGyl1tSuPrEDzr0yd5m90UgNxQkyDXULk3b6MlQqTCpZpNtWe1K0hzclnZkTcLBe2UQ==", + "dev": true + }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-3.10.1.tgz", - "integrity": "sha512-9JgC82AaQeglebjZMgYR5wgmfUdUc+EitGUUMW8u2nDckaeimzW+VsoLV6FoimPv2id3VQzfjwBxEMVz08ameQ==", + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-6.21.0.tgz", + "integrity": "sha512-JJtkDduxLi9bivAB+cYOVMtbkqdPOhZ+ZI5LC47MIRrDV4Yn2o+ZnW10Nkmr28xRpSpdJ6Sm42Hjf2+REYXm0A==", "dev": true, "dependencies": { - "eslint-visitor-keys": "^1.1.0" + "@typescript-eslint/types": "6.21.0", + "eslint-visitor-keys": "^3.4.1" }, "engines": { - "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + "node": "^16.0.0 || >=18.0.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" } }, + "node_modules/@typescript-eslint/visitor-keys/node_modules/eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, "node_modules/@ungap/promise-all-settled": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/@ungap/promise-all-settled/-/promise-all-settled-1.1.2.tgz", @@ -2712,6 +2892,22 @@ "node": ">=0.10.0" } }, + "node_modules/array-buffer-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.1.tgz", + "integrity": "sha512-ahC5W1xgou+KTXix4sAO8Ki12Q+jf4i0+tmk3sC+zgcynshkHxzpXdImBehiUYKKKDwvfFiJl1tZt6ewscS1Mg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.5", + "is-array-buffer": "^3.0.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/array-each": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/array-each/-/array-each-1.0.1.tgz", @@ -2722,15 +2918,16 @@ } }, "node_modules/array-includes": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.4.tgz", - "integrity": "sha512-ZTNSQkmWumEbiHO2GF4GmWxYVTiQyJy2XOTa15sdQSrvKn7l+180egQMqlrMOUMCyLMD7pmyQe4mMDUT6Behrw==", + "version": "3.1.8", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.8.tgz", + "integrity": "sha512-itaWrbYbqpGXkGhZPGUulwnhVf5Hpy1xiCFsGqyIGglbBxmG5vSjxQen3/WGOjPpNEv1RtBLKxbmVXm8HpJStQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.1", - "get-intrinsic": "^1.1.1", + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.4", "is-string": "^1.0.7" }, "engines": { @@ -2758,15 +2955,36 @@ "node": ">=8" } }, - "node_modules/array.prototype.flat": { + "node_modules/array.prototype.findlastindex": { "version": "1.2.5", - "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.5.tgz", - "integrity": "sha512-KaYU+S+ndVqyUnignHftkwc58o3uVU1jzczILJ1tN2YaIZpFIKBiP/x/j97E5MVPsaCloPbqWLB/8qCTVvT2qg==", + "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.5.tgz", + "integrity": "sha512-zfETvRFA8o7EiNn++N5f/kaCw221hrpGsDmcpndVupkPzEc1Wuf3VgC0qby1BbHs7f5DVYjgtEU2LLh5bqeGfQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-shim-unscopables": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.flat": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.3.2.tgz", + "integrity": "sha512-djYB+Zx2vLewY8RWlNCUdHjDXs2XOgm602S9E7P/UpHgfeHL00cRiIF+IN/G/aUJ7kGPb6yO/ErDI5V2s8iycA==", "dev": true, "dependencies": { "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.0" + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" }, "engines": { "node": ">= 0.4" @@ -2776,14 +2994,37 @@ } }, "node_modules/array.prototype.flatmap": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.2.5.tgz", - "integrity": "sha512-08u6rVyi1Lj7oqWbS9nUxliETrtIROT4XGTA4D/LWGten6E3ocm7cy9SIrmNHOL5XVbVuckUp3X6Xyg8/zpvHA==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.2.tgz", + "integrity": "sha512-Ewyx0c9PmpcsByhSW4r+9zDU7sGjFc86qf/kKtuSCRdhfbk0SNLLkaT5qvcHnRGgc5NP/ly/y+qkXkqONX54CQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.0" + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/arraybuffer.prototype.slice": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.3.tgz", + "integrity": "sha512-bMxMKAjg13EBSVscxTaYA4mRc5t1UAXa2kXiGTNfZ079HIWXEkKmkgFrh/nJqamaLSrXO5H4WFFkPEaLJWbs3A==", + "dev": true, + "dependencies": { + "array-buffer-byte-length": "^1.0.1", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "es-abstract": "^1.22.3", + "es-errors": "^1.2.1", + "get-intrinsic": "^1.2.3", + "is-array-buffer": "^3.0.4", + "is-shared-array-buffer": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -2931,10 +3172,13 @@ "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" }, "node_modules/available-typed-arrays": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.5.tgz", - "integrity": "sha512-DMD0KiN46eipeziST1LPP/STfDU0sufISXmjSgvVsoU2tqxctQeASejWcfNtxYKqETM1UxQ8sp2OrSBWpHY6sw==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", "dev": true, + "dependencies": { + "possible-typed-array-names": "^1.0.0" + }, "engines": { "node": ">= 0.4" }, @@ -4180,6 +4424,68 @@ "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", "dev": true }, + "node_modules/cross-env": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-env/-/cross-env-7.0.3.tgz", + "integrity": "sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw==", + "dev": true, + "dependencies": { + "cross-spawn": "^7.0.1" + }, + "bin": { + "cross-env": "src/bin/cross-env.js", + "cross-env-shell": "src/bin/cross-env-shell.js" + }, + "engines": { + "node": ">=10.14", + "npm": ">=6", + "yarn": ">=1" + } + }, + "node_modules/cross-env/node_modules/cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/cross-env/node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/cross-env/node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cross-env/node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/cross-spawn": { "version": "6.0.5", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz", @@ -4254,6 +4560,57 @@ "integrity": "sha512-sdQSFB7+llfUcQHUQO3+B8ERRj0Oa4w9POWMI/puGtuf7gFywGmkaLCElnudfTiKZV+NvHqL0ifzdrI8Ro7ESA==", "dev": true }, + "node_modules/data-view-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.1.tgz", + "integrity": "sha512-0lht7OugA5x3iJLOWFhWK/5ehONdprk0ISXqVFn/NFrDu+cuc8iADFrGQz5BnRK7LLU3JmkbXSxaqX+/mXYtUA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.1.tgz", + "integrity": "sha512-4J7wRJD3ABAzr8wP+OcIcqq2dlUKp4DVflx++hs5h5ZKydWMI6/D/fAot+yh6g2tHh8fLFTvNOaVN357NvSrOQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-offset": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.0.tgz", + "integrity": "sha512-t/Ygsytq+R995EJ5PZlD4Cu56sWa8InXySaViRzw9apusqsOO2bQP+SbYzAhR0pFKoB+43lYy8rWban9JSuXnA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/debug": { "version": "2.6.9", "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", @@ -4541,15 +4898,20 @@ } }, "node_modules/define-properties": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", - "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", "dev": true, "dependencies": { - "object-keys": "^1.0.12" + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" }, "engines": { "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, "node_modules/del": { @@ -4917,31 +5279,57 @@ } }, "node_modules/es-abstract": { - "version": "1.19.2", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.19.2.tgz", - "integrity": "sha512-gfSBJoZdlL2xRiOCy0g8gLMryhoe1TlimjzU99L/31Z8QEGIhVQI+EWwt5lT+AuU9SnorVupXFqqOGqGfsyO6w==", + "version": "1.23.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz", + "integrity": "sha512-e+HfNH61Bj1X9/jLc5v1owaLYuHdeHHSQlkhCBiTK8rBvKaULl/beGMxwrMXjpYrv4pz22BlY570vVePA2ho4A==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", + "array-buffer-byte-length": "^1.0.1", + "arraybuffer.prototype.slice": "^1.0.3", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "data-view-buffer": "^1.0.1", + "data-view-byte-length": "^1.0.1", + "data-view-byte-offset": "^1.0.0", + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-set-tostringtag": "^2.0.3", "es-to-primitive": "^1.2.1", - "function-bind": "^1.1.1", - "get-intrinsic": "^1.1.1", - "get-symbol-description": "^1.0.0", - "has": "^1.0.3", + "function.prototype.name": "^1.1.6", + "get-intrinsic": "^1.2.4", + "get-symbol-description": "^1.0.2", + "globalthis": "^1.0.3", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2", + "has-proto": "^1.0.3", "has-symbols": "^1.0.3", - "internal-slot": "^1.0.3", - "is-callable": "^1.2.4", - "is-negative-zero": "^2.0.2", + "hasown": "^2.0.2", + "internal-slot": "^1.0.7", + "is-array-buffer": "^3.0.4", + "is-callable": "^1.2.7", + "is-data-view": "^1.0.1", + "is-negative-zero": "^2.0.3", "is-regex": "^1.1.4", - "is-shared-array-buffer": "^1.0.1", + "is-shared-array-buffer": "^1.0.3", "is-string": "^1.0.7", + "is-typed-array": "^1.1.13", "is-weakref": "^1.0.2", - "object-inspect": "^1.12.0", + "object-inspect": "^1.13.1", "object-keys": "^1.1.1", - "object.assign": "^4.1.2", - "string.prototype.trimend": "^1.0.4", - "string.prototype.trimstart": "^1.0.4", - "unbox-primitive": "^1.0.1" + "object.assign": "^4.1.5", + "regexp.prototype.flags": "^1.5.2", + "safe-array-concat": "^1.1.2", + "safe-regex-test": "^1.0.3", + "string.prototype.trim": "^1.2.9", + "string.prototype.trimend": "^1.0.8", + "string.prototype.trimstart": "^1.0.8", + "typed-array-buffer": "^1.0.2", + "typed-array-byte-length": "^1.0.1", + "typed-array-byte-offset": "^1.0.2", + "typed-array-length": "^1.0.6", + "unbox-primitive": "^1.0.2", + "which-typed-array": "^1.1.15" }, "engines": { "node": ">= 0.4" @@ -4977,6 +5365,41 @@ "integrity": "sha512-1HQ2M2sPtxwnvOvT1ZClHyQDiggdNjURWpY2we6aMKCQiUVxTmVs2UYPLIrD84sS+kMdUwfBSylbJPwNnBrnHQ==", "dev": true }, + "node_modules/es-object-atoms": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.0.0.tgz", + "integrity": "sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==", + "dev": true, + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-set-tostringtag": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.3.tgz", + "integrity": "sha512-3T8uNMC3OQTHkFUsFq8r/BwAXLHvU/9O9mE0fBc/MY5iq/8H7ncvO947LmYA6ldWw9Uh8Yhf25zu6n7nML5QWQ==", + "dev": true, + "dependencies": { + "get-intrinsic": "^1.2.4", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.1" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-shim-unscopables": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.0.2.tgz", + "integrity": "sha512-J3yBRXCzDu4ULnQwxyToo/OjdMx6akgVC7K6few0a7F/0wLtmKKN7I73AH5T2836UuXRqN7Qg+IIUw/+YJksRw==", + "dev": true, + "dependencies": { + "hasown": "^2.0.0" + } + }, "node_modules/es-to-primitive": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", @@ -5133,13 +5556,14 @@ } }, "node_modules/eslint-import-resolver-node": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.6.tgz", - "integrity": "sha512-0En0w03NRVMn9Uiyn8YRPDKvWjxCWkslUEhGNTdGx15RvPJYQ+lbOlqrlNI2vEAs4pDYK4f/HN2TbDmk5TP0iw==", + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.9.tgz", + "integrity": "sha512-WFj2isz22JahUv+B788TlO3N6zL3nNJGU8CcZbPZvVEkBPaJdCV4vy5wyghty5ROFbCRnm132v8BScu5/1BQ8g==", "dev": true, "dependencies": { "debug": "^3.2.7", - "resolve": "^1.20.0" + "is-core-module": "^2.13.0", + "resolve": "^1.22.4" } }, "node_modules/eslint-import-resolver-node/node_modules/debug": { @@ -5152,16 +5576,20 @@ } }, "node_modules/eslint-module-utils": { - "version": "2.7.3", - "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.7.3.tgz", - "integrity": "sha512-088JEC7O3lDZM9xGe0RerkOMd0EjFl+Yvd1jPWIkMT5u3H9+HC34mWWPnqPrN13gieT9pBOO+Qt07Nb/6TresQ==", + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.8.1.tgz", + "integrity": "sha512-rXDXR3h7cs7dy9RNpUlQf80nX31XWJEyGq1tRMo+6GsO5VmTe4UTwtmonAD4ZkAsrfMVDA2wlGJ3790Ys+D49Q==", "dev": true, "dependencies": { - "debug": "^3.2.7", - "find-up": "^2.1.0" + "debug": "^3.2.7" }, "engines": { "node": ">=4" + }, + "peerDependenciesMeta": { + "eslint": { + "optional": true + } } }, "node_modules/eslint-module-utils/node_modules/debug": { @@ -5173,83 +5601,29 @@ "ms": "^2.1.1" } }, - "node_modules/eslint-module-utils/node_modules/find-up": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", - "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", - "dev": true, - "dependencies": { - "locate-path": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/eslint-module-utils/node_modules/locate-path": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", - "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", - "dev": true, - "dependencies": { - "p-locate": "^2.0.0", - "path-exists": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/eslint-module-utils/node_modules/p-limit": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", - "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", - "dev": true, - "dependencies": { - "p-try": "^1.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/eslint-module-utils/node_modules/p-locate": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", - "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", - "dev": true, - "dependencies": { - "p-limit": "^1.1.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/eslint-module-utils/node_modules/p-try": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", - "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", - "dev": true, - "engines": { - "node": ">=4" - } - }, "node_modules/eslint-plugin-import": { - "version": "2.25.4", - "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.25.4.tgz", - "integrity": "sha512-/KJBASVFxpu0xg1kIBn9AUa8hQVnszpwgE7Ld0lKAlx7Ie87yzEzCgSkekt+le/YVhiaosO4Y14GDAOc41nfxA==", + "version": "2.29.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.29.1.tgz", + "integrity": "sha512-BbPC0cuExzhiMo4Ff1BTVwHpjjv28C5R+btTOGaCRC7UEz801up0JadwkeSk5Ued6TG34uaczuVuH6qyy5YUxw==", "dev": true, "dependencies": { - "array-includes": "^3.1.4", - "array.prototype.flat": "^1.2.5", - "debug": "^2.6.9", + "array-includes": "^3.1.7", + "array.prototype.findlastindex": "^1.2.3", + "array.prototype.flat": "^1.3.2", + "array.prototype.flatmap": "^1.3.2", + "debug": "^3.2.7", "doctrine": "^2.1.0", - "eslint-import-resolver-node": "^0.3.6", - "eslint-module-utils": "^2.7.2", - "has": "^1.0.3", - "is-core-module": "^2.8.0", + "eslint-import-resolver-node": "^0.3.9", + "eslint-module-utils": "^2.8.0", + "hasown": "^2.0.0", + "is-core-module": "^2.13.1", "is-glob": "^4.0.3", - "minimatch": "^3.0.4", - "object.values": "^1.1.5", - "resolve": "^1.20.0", - "tsconfig-paths": "^3.12.0" + "minimatch": "^3.1.2", + "object.fromentries": "^2.0.7", + "object.groupby": "^1.0.1", + "object.values": "^1.1.7", + "semver": "^6.3.1", + "tsconfig-paths": "^3.15.0" }, "engines": { "node": ">=4" @@ -5258,6 +5632,15 @@ "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8" } }, + "node_modules/eslint-plugin-import/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "dependencies": { + "ms": "^2.1.1" + } + }, "node_modules/eslint-plugin-import/node_modules/minimatch": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", @@ -5270,6 +5653,15 @@ "node": "*" } }, + "node_modules/eslint-plugin-import/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, "node_modules/eslint-plugin-jsx-a11y": { "version": "6.5.1", "resolved": "https://registry.npmjs.org/eslint-plugin-jsx-a11y/-/eslint-plugin-jsx-a11y-6.5.1.tgz", @@ -6238,6 +6630,15 @@ "readable-stream": "^2.3.6" } }, + "node_modules/for-each": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz", + "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==", + "dev": true, + "dependencies": { + "is-callable": "^1.1.3" + } + }, "node_modules/for-in": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/for-in/-/for-in-1.0.2.tgz", @@ -6259,12 +6660,6 @@ "node": ">=0.10.0" } }, - "node_modules/foreach": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/foreach/-/foreach-2.0.5.tgz", - "integrity": "sha1-C+4AUBiusmDQo6865ljdATbsG5k=", - "dev": true - }, "node_modules/foreground-child": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-2.0.0.tgz", @@ -6358,16 +6753,16 @@ "dev": true }, "node_modules/fs-extra": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.1.tgz", - "integrity": "sha512-NbdoVMZso2Lsrn/QwLXOy6rm0ufY2zEOKCDzJR/0kBsb0E6qed0P3iYK+Ath3BfvXEeu4JhEtXLgILx5psUfag==", + "version": "11.2.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.2.0.tgz", + "integrity": "sha512-PmDi3uwK5nFuXh7XDTlVnS17xJS7vW36is2+w3xcv8SVxiB4NyATf4ctkVY5bkSjX0Y4nbvZCq1/EjtEyr9ktw==", "dependencies": { "graceful-fs": "^4.2.0", "jsonfile": "^6.0.1", "universalify": "^2.0.0" }, "engines": { - "node": ">=12" + "node": ">=14.14" } }, "node_modules/fs-extra/node_modules/jsonfile": { @@ -6438,12 +6833,39 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/function.prototype.name": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.6.tgz", + "integrity": "sha512-Z5kx79swU5P27WEayXM1tBi5Ze/lbIyiNgU3qyXUOf9b2rgXYyF9Dy9Cx+IQv/Lc8WCG6L82zwUPpSS9hGehIg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "functions-have-names": "^1.2.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/functional-red-black-tree": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", "dev": true }, + "node_modules/functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", @@ -6521,13 +6943,14 @@ } }, "node_modules/get-symbol-description": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.0.tgz", - "integrity": "sha512-2EmdH1YvIQiZpltCNgkuiUnyukzxM/R6NDJX31Ke3BG1Nq5b0S2PhX59UKi9vZpPDQVdqn+1IcaAwnzTT5vCjw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.2.tgz", + "integrity": "sha512-g0QYk1dZBxGwk+Ngc+ltRH2IBp2f7zBkBMBJZCDerh6EhlhSR6+9irMCuT/09zD6qkarHUSn529sK/yL4S27mg==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "get-intrinsic": "^1.1.1" + "call-bind": "^1.0.5", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4" }, "engines": { "node": ">= 0.4" @@ -6686,6 +7109,22 @@ "node": ">=4" } }, + "node_modules/globalthis": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/globalthis/-/globalthis-1.0.4.tgz", + "integrity": "sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ==", + "dev": true, + "dependencies": { + "define-properties": "^1.2.1", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/globby": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", @@ -6778,6 +7217,12 @@ "integrity": "sha1-TK+tdrxi8C+gObL5Tpo906ORpyU=", "dev": true }, + "node_modules/graphemer": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", + "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", + "dev": true + }, "node_modules/growl": { "version": "1.10.5", "resolved": "https://registry.npmjs.org/growl/-/growl-1.10.5.tgz", @@ -7178,6 +7623,7 @@ "version": "1.0.3", "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "dev": true, "dependencies": { "function-bind": "^1.1.1" }, @@ -7186,9 +7632,9 @@ } }, "node_modules/has-bigints": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", - "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz", + "integrity": "sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ==", "dev": true, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -7261,12 +7707,12 @@ } }, "node_modules/has-tostringtag": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.0.tgz", - "integrity": "sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", "dev": true, "dependencies": { - "has-symbols": "^1.0.2" + "has-symbols": "^1.0.3" }, "engines": { "node": ">= 0.4" @@ -7323,7 +7769,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", - "dev": true, "dependencies": { "function-bind": "^1.1.2" }, @@ -7481,9 +7926,9 @@ ] }, "node_modules/ignore": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", - "integrity": "sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ==", + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", + "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", "dev": true, "engines": { "node": ">= 4" @@ -7589,13 +8034,13 @@ "dev": true }, "node_modules/internal-slot": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.3.tgz", - "integrity": "sha512-O0DB1JC/sPyZl7cIo78n5dR7eUSwwpYPiXRhTzNxZVAMUuB8vlnRFyLxdrVToks6XPLVnFfbzaVd5WLjhgg+vA==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz", + "integrity": "sha512-NGnrKwXzSms2qUUih/ILZ5JBqNTSa1+ZmP6flaIp6KmSElgE9qdndzS3cqjrDovwFdmwsGsLdeFgB6suw+1e9g==", "dev": true, "dependencies": { - "get-intrinsic": "^1.1.0", - "has": "^1.0.3", + "es-errors": "^1.3.0", + "hasown": "^2.0.0", "side-channel": "^1.0.4" }, "engines": { @@ -7625,9 +8070,9 @@ } }, "node_modules/inversify": { - "version": "5.0.5", - "resolved": "https://registry.npmjs.org/inversify/-/inversify-5.0.5.tgz", - "integrity": "sha512-60QsfPz8NAU/GZqXu8hJ+BhNf/C/c+Hp0eDc6XMIJTxBiP36AQyyQKpBkOVTLWBFDQWYVHpbbEuIsHu9dLuJDA==" + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/inversify/-/inversify-6.0.2.tgz", + "integrity": "sha512-i9m8j/7YIv4mDuYXUAcrpKPSaju/CIly9AHK5jvCBeoiM/2KEsuCQTTP+rzSWWpLYWRukdXFSl6ZTk2/uumbiA==" }, "node_modules/is-absolute": { "version": "1.0.0", @@ -7658,11 +8103,30 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-array-buffer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.4.tgz", + "integrity": "sha512-wcjaerHw0ydZwfhiKbXJWLDY8A7yV7KhjQOpb83hGgGfId/aQa4TOvwyzn2PuswW2gPCYEL/nEAiSVpdOj1lXw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-bigint": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.2.tgz", - "integrity": "sha512-0JV5+SOCQkIdzjBK9buARcV804Ddu7A0Qet6sHi3FimE9ne6m4BGQZfRn+NZiXbBk4F4XmHfDZIipLj9pX8dSA==", + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz", + "integrity": "sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==", "dev": true, + "dependencies": { + "has-bigints": "^1.0.1" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -7679,6 +8143,22 @@ "node": ">=8" } }, + "node_modules/is-boolean-object": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz", + "integrity": "sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-buffer": { "version": "1.1.6", "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz", @@ -7686,9 +8166,9 @@ "dev": true }, "node_modules/is-callable": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.4.tgz", - "integrity": "sha512-nsuwtxZfMX67Oryl9LCQ+upnC0Z0BgpwntpS89m1H/TLF0zNfzfLMV/9Wa/6MZsj0acpEjAO0KF1xT6ZdLl95w==", + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", + "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", "dev": true, "engines": { "node": ">= 0.4" @@ -7698,11 +8178,29 @@ } }, "node_modules/is-core-module": { - "version": "2.13.0", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.0.tgz", - "integrity": "sha512-Z7dk6Qo8pOCp3l4tsX2C5ZVas4V+UxwQodwZhLopL91TX8UyyHEXafPcyoeeWuLrwzHcr3igO78wNLwHJHsMCQ==", + "version": "2.15.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.0.tgz", + "integrity": "sha512-Dd+Lb2/zvk9SKy1TGCt1wFJFo/MWBPMX5x7KcvLajWTGuomczdQX61PvY5yK6SVACwpoexWo81IfFyoKY2QnTA==", + "dependencies": { + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-data-view": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.1.tgz", + "integrity": "sha512-AHkaJrsUVW6wq6JS8y3JnM/GJF/9cf+k20+iDzlSaJrinEo5+7vRiteOSwBhHRiAyQATN1AmY4hwzxJKPmYf+w==", + "dev": true, "dependencies": { - "has": "^1.0.3" + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -7815,9 +8313,9 @@ } }, "node_modules/is-negative-zero": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.2.tgz", - "integrity": "sha512-dqJvarLawXsFbNDeJW7zAz8ItJ9cd28YufuuFzh0G8pNHjJMnY08Dv7sYX2uF5UpQOwieAeOExEYAWWfu7ZZUA==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz", + "integrity": "sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==", "dev": true, "engines": { "node": ">= 0.4" @@ -7835,6 +8333,21 @@ "node": ">=0.12.0" } }, + "node_modules/is-number-object": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.7.tgz", + "integrity": "sha512-k1U0IRzLMo7ZlYIfzRu23Oh6MiIFasgpb9X76eqfFZAqwH44UI4KTBvBYIZ1dSL9ZzChTB9ShHfLkR4pdW5krQ==", + "dev": true, + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-object": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/is-object/-/is-object-1.0.1.tgz", @@ -7918,10 +8431,16 @@ } }, "node_modules/is-shared-array-buffer": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.1.tgz", - "integrity": "sha512-IU0NmyknYZN0rChcKhRO1X8LYz5Isj/Fsqh8NJOSf+N/hCOTwy29F32Ik7a+QszE63IdvmwdTPDd6cZ5pg4cwA==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.3.tgz", + "integrity": "sha512-nA2hv5XIhLR3uVzDDfCIknerhx8XUKnstuOERPNNIinXG7v9u+ohXF67vxm4TPTEPU6lm61ZkwP3c9PCB97rhg==", "dev": true, + "dependencies": { + "call-bind": "^1.0.7" + }, + "engines": { + "node": ">= 0.4" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -7966,16 +8485,12 @@ } }, "node_modules/is-typed-array": { - "version": "1.1.8", - "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.8.tgz", - "integrity": "sha512-HqH41TNZq2fgtGT8WHVFVJhBVGuY3AnP3Q36K8JKXUxSxRgk/d+7NjmwG2vo2mYmXK8UYZKu0qH8bVP5gEisjA==", + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.13.tgz", + "integrity": "sha512-uZ25/bUAlUY5fR4OKT4rZQEBrzQWYV9ZJYGGsUmEJ6thodVJ1HX64ePQ6Z0qPWP+m+Uq6e9UugrE38jeYsDSMw==", "dev": true, "dependencies": { - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.2", - "es-abstract": "^1.18.5", - "foreach": "^2.0.5", - "has-tostringtag": "^1.0.0" + "which-typed-array": "^1.1.14" }, "engines": { "node": ">= 0.4" @@ -8484,9 +8999,9 @@ } }, "node_modules/just-extend": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.2.1.tgz", - "integrity": "sha512-g3UB796vUFIY90VIv/WX3L2c8CS2MdWUww3CNrYmqza1Fg0DURc2K/O4YrnklBdQarSJ/y8JnJYDGc+1iumQjg==", + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-6.2.0.tgz", + "integrity": "sha512-cYofQu2Xpom82S6qD778jBDpwvvy39s1l/hrYij2u9AMdQcGRpaBu6kY4mVhuno5kJVi1DAz4aiphA2WI1/OAw==", "dev": true }, "node_modules/jwa": { @@ -8710,7 +9225,7 @@ "node_modules/lodash.get": { "version": "4.4.2", "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", - "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", + "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==", "dev": true }, "node_modules/lodash.includes": { @@ -9537,16 +10052,16 @@ "dev": true }, "node_modules/nise": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/nise/-/nise-5.1.1.tgz", - "integrity": "sha512-yr5kW2THW1AkxVmCnKEh4nbYkJdB3I7LUkiUgOvEkOp414mc2UMaHMA7pjq1nYowhdoJZGwEKGaQVbxfpWj10A==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/nise/-/nise-6.0.0.tgz", + "integrity": "sha512-K8ePqo9BFvN31HXwEtTNGzgrPpmvgciDsFz8aztFjt4LqKO/JeFD8tBOeuDiCMXrIl/m1YvfH8auSpxfaD09wg==", "dev": true, "dependencies": { - "@sinonjs/commons": "^1.8.3", - "@sinonjs/fake-timers": ">=5", - "@sinonjs/text-encoding": "^0.7.1", - "just-extend": "^4.0.2", - "path-to-regexp": "^1.7.0" + "@sinonjs/commons": "^3.0.0", + "@sinonjs/fake-timers": "^11.2.2", + "@sinonjs/text-encoding": "^0.7.2", + "just-extend": "^6.2.0", + "path-to-regexp": "^6.2.1" } }, "node_modules/node-abi": { @@ -10005,14 +10520,14 @@ } }, "node_modules/object.assign": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", - "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz", + "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "has-symbols": "^1.0.1", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "has-symbols": "^1.0.3", "object-keys": "^1.1.1" }, "engines": { @@ -10052,14 +10567,15 @@ } }, "node_modules/object.fromentries": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.5.tgz", - "integrity": "sha512-CAyG5mWQRRiBU57Re4FKoTBjXfDoNwdFVH2Y1tS9PqCsfUTymAohOkEMSG3aRNKmv4lV3O7p1et7c187q6bynw==", + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", + "integrity": "sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0" }, "engines": { "node": ">= 0.4" @@ -10068,6 +10584,20 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/object.groupby": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/object.groupby/-/object.groupby-1.0.3.tgz", + "integrity": "sha512-+Lhy3TQTuzXI5hevh8sBGqbmurHbbIjAi0Z4S63nthVLmLxfbj4T54a4CfZrXIrt9iP4mVAPYMo/v99taj3wjQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/object.hasown": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/object.hasown/-/object.hasown-1.1.0.tgz", @@ -10094,14 +10624,14 @@ } }, "node_modules/object.values": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.5.tgz", - "integrity": "sha512-QUZRW0ilQ3PnPpbNtgdNV1PDbEqLIiSFB3l+EnGtBQ/8SUTLj1PZwtQHABZtLgwpJZTSZhuGLOGk57Drx2IvYg==", + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.0.tgz", + "integrity": "sha512-yBYjY9QX2hnRmZHAjG/f13MzmBzxzYgQhFrke06TTyKY5zSTEqkOeukBzIdVA3j3ulu8Qa3MbVFShV7T2RmGtQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" }, "engines": { "node": ">= 0.4" @@ -10424,15 +10954,6 @@ "integrity": "sha1-zDPSTVJeCZpTiMAzbG4yuRYGCeA=", "dev": true }, - "node_modules/path-exists": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", - "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", - "dev": true, - "engines": { - "node": ">=4" - } - }, "node_modules/path-is-absolute": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", @@ -10477,18 +10998,9 @@ } }, "node_modules/path-to-regexp": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz", - "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==", - "dev": true, - "dependencies": { - "isarray": "0.0.1" - } - }, - "node_modules/path-to-regexp/node_modules/isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.2.2.tgz", + "integrity": "sha512-GQX3SSMokngb36+whdpRXE+3f9V8UzyAorlYvOGx87ufGHehNTn5lCxrKtLyZ4Yl/wEKnNnr98ZzOwwDZV5ogw==", "dev": true }, "node_modules/path-type": { @@ -10606,6 +11118,15 @@ "node": ">= 0.10" } }, + "node_modules/possible-typed-array-names": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz", + "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==", + "dev": true, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/postinstall-build": { "version": "5.0.3", "resolved": "https://registry.npmjs.org/postinstall-build/-/postinstall-build-5.0.3.tgz", @@ -10963,13 +11484,15 @@ "dev": true }, "node_modules/regexp.prototype.flags": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.1.tgz", - "integrity": "sha512-pMR7hBVUUGI7PMA37m2ofIdQCsomVnas+Jn5UPGAHQ+/LlwKm/aTLJHdasmHRzlfeZwHiAOaRSo2rbBDm3nNUQ==", + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.2.tgz", + "integrity": "sha512-NcDiDkTLuPR+++OCKB0nWafEmhg/Da8aUPLPMQbK+bxKKCm1/S5he+AqYa4PlMCVBalb4/yxIRub6qkEx5yJbw==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "call-bind": "^1.0.6", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "set-function-name": "^2.0.1" }, "engines": { "node": ">= 0.4" @@ -11261,12 +11784,53 @@ "resolved": "https://registry.npmjs.org/rxjs-compat/-/rxjs-compat-6.6.7.tgz", "integrity": "sha512-szN4fK+TqBPOFBcBcsR0g2cmTTUF/vaFEOZNuSdfU8/pGFnNmmn2u8SystYXG1QMrjOPBc6XTKHMVfENDf6hHw==" }, + "node_modules/safe-array-concat": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.2.tgz", + "integrity": "sha512-vj6RsCsWBCf19jIeHEfkRMw8DPiBb+DMXklQ/1SGDHOMlHdPUkZXFQ2YdplS23zESTijAcurb1aSgJA3AgMu1Q==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "get-intrinsic": "^1.2.4", + "has-symbols": "^1.0.3", + "isarray": "^2.0.5" + }, + "engines": { + "node": ">=0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/safe-array-concat/node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true + }, "node_modules/safe-buffer": { "version": "5.1.2", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", "dev": true }, + "node_modules/safe-regex-test": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.3.tgz", + "integrity": "sha512-CdASjNJPvRa7roO6Ra/gLYBTzYzzPyyBXxIMdGW3USQLyjWEls2RgW5UBTXaQVp+OrpeCK3bLem8smtmheoRuw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-regex": "^1.1.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/safer-buffer": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", @@ -11378,6 +11942,21 @@ "node": ">= 0.4" } }, + "node_modules/set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "dev": true, + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/setimmediate": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/setimmediate/-/setimmediate-1.0.5.tgz", @@ -11545,17 +12124,17 @@ } }, "node_modules/sinon": { - "version": "13.0.1", - "resolved": "https://registry.npmjs.org/sinon/-/sinon-13.0.1.tgz", - "integrity": "sha512-8yx2wIvkBjIq/MGY1D9h1LMraYW+z1X0mb648KZnKSdvLasvDu7maa0dFaNYdTDczFgbjNw2tOmWdTk9saVfwQ==", + "version": "18.0.0", + "resolved": "https://registry.npmjs.org/sinon/-/sinon-18.0.0.tgz", + "integrity": "sha512-+dXDXzD1sBO6HlmZDd7mXZCR/y5ECiEiGCBSGuFD/kZ0bDTofPYc6JaeGmPSF+1j1MejGUWkORbYOLDyvqCWpA==", "dev": true, "dependencies": { - "@sinonjs/commons": "^1.8.3", - "@sinonjs/fake-timers": "^9.0.0", - "@sinonjs/samsam": "^6.1.1", - "diff": "^5.0.0", - "nise": "^5.1.1", - "supports-color": "^7.2.0" + "@sinonjs/commons": "^3.0.1", + "@sinonjs/fake-timers": "^11.2.2", + "@sinonjs/samsam": "^8.0.0", + "diff": "^5.2.0", + "nise": "^6.0.0", + "supports-color": "^7" }, "funding": { "type": "opencollective", @@ -11563,9 +12142,9 @@ } }, "node_modules/sinon/node_modules/diff": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/diff/-/diff-5.0.0.tgz", - "integrity": "sha512-/VTCrvm5Z0JGty/BWHljh+BAiw3IK+2j87NGMu8Nwc/f48WoDAC395uomO9ZD117ZOBaHmkX1oyLvkVM/aIT3w==", + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-5.2.0.tgz", + "integrity": "sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==", "dev": true, "engines": { "node": ">=0.3.1" @@ -11892,27 +12471,50 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/string.prototype.trim": { + "version": "1.2.9", + "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.9.tgz", + "integrity": "sha512-klHuCNxiMZ8MlsOihJhJEBJAiMVqU3Z2nEXWfWnIqjN0gEFS9J9+IxKozWWtQGcgoa1WUZzLjKPTr4ZHNFTFxw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.0", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/string.prototype.trimend": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", - "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.8.tgz", + "integrity": "sha512-p73uL5VCHCO2BZZ6krwwQE3kCzM7NKmis8S//xEC6fQonchbum4eP6kR4DLEjQFO3Wnj3Fuo8NM0kOSjVdHjZQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" }, "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/string.prototype.trimstart": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", - "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz", + "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -12396,6 +12998,18 @@ "node": ">=0.10.0" } }, + "node_modules/ts-api-utils": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.3.0.tgz", + "integrity": "sha512-UQMIo7pb8WRomKR1/+MFVLTroIvDVtMX3K6OUir8ynLyzB8Jeriont2bTAtmNPa1ekAgN7YPDyf6V+ygrdU+eQ==", + "dev": true, + "engines": { + "node": ">=16" + }, + "peerDependencies": { + "typescript": ">=4.2.0" + } + }, "node_modules/ts-loader": { "version": "9.2.8", "resolved": "https://registry.npmjs.org/ts-loader/-/ts-loader-9.2.8.tgz", @@ -12538,13 +13152,13 @@ } }, "node_modules/tsconfig-paths": { - "version": "3.14.1", - "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.14.1.tgz", - "integrity": "sha512-fxDhWnFSLt3VuTwtvJt5fpwxBHg5AdKWMsgcPOOIilyjymcYVZoCQF8fvFRezCNfblEXmi+PcM1eYHeOAgXCOQ==", + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.15.0.tgz", + "integrity": "sha512-2Ac2RgzDe/cn48GvOe3M+o82pEFewD3UPbyoUHHdKasHwJKjds4fLXWf/Ux5kATBKN20oaFGu+jbElp1pos0mg==", "dev": true, "dependencies": { "@types/json5": "^0.0.29", - "json5": "^1.0.1", + "json5": "^1.0.2", "minimist": "^1.2.6", "strip-bom": "^3.0.0" } @@ -12656,21 +13270,6 @@ "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.10.0.tgz", "integrity": "sha512-qOebF53frne81cf0S9B41ByenJ3/IuH8yJKngAX35CmiZySA0khhkovshKK+jGCaMnVomla7gVlIcc3EvKPbTQ==" }, - "node_modules/tsutils": { - "version": "3.21.0", - "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", - "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", - "dev": true, - "dependencies": { - "tslib": "^1.8.1" - }, - "engines": { - "node": ">= 6" - }, - "peerDependencies": { - "typescript": ">=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta" - } - }, "node_modules/tty-browserify": { "version": "0.0.0", "resolved": "https://registry.npmjs.org/tty-browserify/-/tty-browserify-0.0.0.tgz", @@ -12729,6 +13328,79 @@ "node": ">=8" } }, + "node_modules/typed-array-buffer": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.2.tgz", + "integrity": "sha512-gEymJYKZtKXzzBzM4jqa9w6Q1Jjm7x2d+sh19AdsD4wqnMPDYyvwpsIc2Q/835kHuo3BEQ7CjelGhfTsoBb2MQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/typed-array-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.1.tgz", + "integrity": "sha512-3iMJ9q0ao7WE9tWcaYKIptkNBuOIcZCCT0d4MRvuuH88fEoEH62IuQe0OtraD3ebQEoTRk8XCBoknUNc1Y67pw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typed-array-byte-offset": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.2.tgz", + "integrity": "sha512-Ous0vodHa56FviZucS2E63zkgtgrACj7omjwd/8lTEMEPFFyjfixMZ1ZXenpgCFBBt4EC1J2XsyVS2gkG0eTFA==", + "dev": true, + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typed-array-length": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.6.tgz", + "integrity": "sha512-/OxDN6OtAk5KBpGb28T+HZc2M+ADtvRxXrKKbUwtsLgdoxgX13hyy7ek6bFRl5+aBs2yZzB0c4CnQfAtVypW/g==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13", + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/typed-rest-client": { "version": "1.8.11", "resolved": "https://registry.npmjs.org/typed-rest-client/-/typed-rest-client-1.8.11.tgz", @@ -12765,16 +13437,16 @@ } }, "node_modules/typescript": { - "version": "4.5.5", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", - "integrity": "sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==", + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz", + "integrity": "sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==", "dev": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" }, "engines": { - "node": ">=4.2.0" + "node": ">=14.17" } }, "node_modules/uc.micro": { @@ -12789,14 +13461,14 @@ "integrity": "sha512-mliiCSrsE29aNBI7O9W5gGv6WmA9kBR8PtTt6Apaxns076IRdYrrtFhXHEWMj5CSum3U7cv7/pi4xmi4XsIOqg==" }, "node_modules/unbox-primitive": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", - "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", + "integrity": "sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==", "dev": true, "dependencies": { - "function-bind": "^1.1.1", - "has-bigints": "^1.0.1", - "has-symbols": "^1.0.2", + "call-bind": "^1.0.2", + "has-bigints": "^1.0.2", + "has-symbols": "^1.0.3", "which-boxed-primitive": "^1.0.2" }, "funding": { @@ -12861,6 +13533,12 @@ "fastest-levenshtein": "^1.0.7" } }, + "node_modules/undici-types": { + "version": "6.19.8", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz", + "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==", + "dev": true + }, "node_modules/unicode": { "version": "14.0.0", "resolved": "https://registry.npmjs.org/unicode/-/unicode-14.0.0.tgz", @@ -12879,14 +13557,6 @@ "through2-filter": "^3.0.0" } }, - "node_modules/untildify": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/untildify/-/untildify-4.0.0.tgz", - "integrity": "sha512-KK8xQ1mkzZeg9inewmFVDNkg3l5LUhoq9kN6iWYB/CC9YMG8HA+c1Q8HwDe6dEX7kErrEVNVBO3fWsVq5iDgtw==", - "engines": { - "node": ">=8" - } - }, "node_modules/update-browserslist-db": { "version": "1.0.11", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.11.tgz", @@ -13203,24 +13873,24 @@ "deprecated": "This package has been renamed to @vscode/debugprotocol, please update to the new name" }, "node_modules/vscode-jsonrpc": { - "version": "9.0.0-next.2", - "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-9.0.0-next.2.tgz", - "integrity": "sha512-meIaXAgChCHzWy45QGU8YpCNyqnZQ/sYeCj32OLDDbUYsCF7AvgpdXx3nnZn9yzr8ed0Od9bW+NGphEmXsqvIQ==", + "version": "9.0.0-next.5", + "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-9.0.0-next.5.tgz", + "integrity": "sha512-Sl/8RAJtfF/2x/TPBVRuhzRAcqYR/QDjEjNqMcoKFfqsxfVUPzikupRDQYB77Gkbt1RrW43sSuZ5uLtNAcikQQ==", "engines": { "node": ">=14.0.0" } }, "node_modules/vscode-languageclient": { - "version": "10.0.0-next.2", - "resolved": "https://registry.npmjs.org/vscode-languageclient/-/vscode-languageclient-10.0.0-next.2.tgz", - "integrity": "sha512-ERKtgOkto4pHCxC2u1K3FfsYHSt8AeuZJjg1u/3TvnrCbBkMxrpn5mHWkh4m3rl6qo2Wk4m9YFgU6F7KCWQNZw==", + "version": "10.0.0-next.12", + "resolved": "https://registry.npmjs.org/vscode-languageclient/-/vscode-languageclient-10.0.0-next.12.tgz", + "integrity": "sha512-q7cVYCcYiv+a+fJYCbjMMScOGBnX162IBeUMFg31mvnN7RHKx5/CwKaCz+r+RciJrRXMqS8y8qpEVGgeIPnbxg==", "dependencies": { "minimatch": "^9.0.3", "semver": "^7.6.0", - "vscode-languageserver-protocol": "3.17.6-next.3" + "vscode-languageserver-protocol": "3.17.6-next.10" }, "engines": { - "vscode": "^1.86.0" + "vscode": "^1.91.0" } }, "node_modules/vscode-languageclient/node_modules/brace-expansion": { @@ -13246,18 +13916,18 @@ } }, "node_modules/vscode-languageserver-protocol": { - "version": "3.17.6-next.3", - "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.6-next.3.tgz", - "integrity": "sha512-H8ATH5SAvc3JzttS+AL6g681PiBOZM/l34WP2JZk4akY3y7NqTP+f9cJ+MhrVBbD3aDS8bdAKewZgbFLW6M8Pg==", + "version": "3.17.6-next.10", + "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.6-next.10.tgz", + "integrity": "sha512-KOrrWn4NVC5jnFC5N6y/fyNKtx8rVYr67lhL/Z0P4ZBAN27aBsCnLBWAMIkYyJ1K8EZaE5r7gqdxrS9JPB6LIg==", "dependencies": { - "vscode-jsonrpc": "9.0.0-next.2", - "vscode-languageserver-types": "3.17.6-next.3" + "vscode-jsonrpc": "9.0.0-next.5", + "vscode-languageserver-types": "3.17.6-next.5" } }, "node_modules/vscode-languageserver-types": { - "version": "3.17.6-next.3", - "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.6-next.3.tgz", - "integrity": "sha512-l5kNFXFRQGuzriXpuBqFpRmkf6f6A4VoU3h95OsVkqIOoi1k7KbwSo600cIdsKSJWrPg/+vX+QMPcMw1oI7ItA==" + "version": "3.17.6-next.5", + "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.6-next.5.tgz", + "integrity": "sha512-QFmf3Yl1tCgUQfA77N9Me/LXldJXkIVypQbty2rJ1DNHQkC+iwvm4Z2tXg9czSwlhvv0pD4pbF5mT7WhAglolw==" }, "node_modules/vscode-tas-client": { "version": "0.1.84", @@ -13581,45 +14251,17 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/which-boxed-primitive/node_modules/is-boolean-object": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.1.tgz", - "integrity": "sha512-bXdQWkECBUIAcCkeH1unwJLIpZYaa5VvuygSyS/c2lf719mTKZDU5UdDRlpd01UjADgmW8RfqaP+mRaVPdr/Ng==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/which-boxed-primitive/node_modules/is-number-object": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.5.tgz", - "integrity": "sha512-RU0lI/n95pMoUKu9v1BZP5MBcZuNSVJkMkAG2dJqC4z2GlkGUNeH68SuHuBKBD/XFe+LHZ+f9BKkLET60Niedw==", - "dev": true, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/which-typed-array": { - "version": "1.1.7", - "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.7.tgz", - "integrity": "sha512-vjxaB4nfDqwKI0ws7wZpxIlde1XrLX5uB0ZjpfshgmapJMD7jJWhZI+yToJTqaFByF0eNBcYxbjmCzoRP7CfEw==", + "version": "1.1.15", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.15.tgz", + "integrity": "sha512-oV0jmFtUky6CXfkqehVvBP/LSWJ2sy4vWMioiENyJLePrBO/yKyV9OyJySfAKosh+RYkIl5zJCNZ8/4JncrpdA==", "dev": true, "dependencies": { - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.2", - "es-abstract": "^1.18.5", - "foreach": "^2.0.5", - "has-tostringtag": "^1.0.0", - "is-typed-array": "^1.1.7" + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-tostringtag": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -14634,6 +15276,29 @@ "integrity": "sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==", "dev": true }, + "@eslint-community/eslint-utils": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz", + "integrity": "sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==", + "dev": true, + "requires": { + "eslint-visitor-keys": "^3.3.0" + }, + "dependencies": { + "eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true + } + } + }, + "@eslint-community/regexpp": { + "version": "4.11.0", + "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.11.0.tgz", + "integrity": "sha512-G/M/tIiMrTAxEWRfLfQJMmGNX28IxBg4PBz8XqQhqUHLFI6TL2htpIB1iQCj144V5ee/JaKyT9/WZ0MGZWfA7A==", + "dev": true + }, "@eslint/eslintrc": { "version": "0.4.3", "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.3.tgz", @@ -15101,38 +15766,49 @@ "dev": true }, "@sinonjs/commons": { - "version": "1.8.3", - "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", - "integrity": "sha512-xkNcLAn/wZaX14RPlwizcKicDk9G3F8m2nU3L7Ukm5zBgTwiT0wsoFAHx9Jq56fJA1z/7uKGtCRu16sOUCLIHQ==", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-3.0.1.tgz", + "integrity": "sha512-K3mCHKQ9sVh8o1C9cxkwxaOmXoAMlDxC1mYyHrjqOWEcBjYr76t96zL2zlj5dUGZ3HSw240X1qgH3Mjf1yJWpQ==", "dev": true, "requires": { "type-detect": "4.0.8" } }, "@sinonjs/fake-timers": { - "version": "9.1.1", - "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-9.1.1.tgz", - "integrity": "sha512-Wp5vwlZ0lOqpSYGKqr53INws9HLkt6JDc/pDZcPf7bchQnrXJMXPns8CXx0hFikMSGSWfvtvvpb2gtMVfkWagA==", + "version": "11.2.2", + "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-11.2.2.tgz", + "integrity": "sha512-G2piCSxQ7oWOxwGSAyFHfPIsyeJGXYtc6mFbnFA+kRXkiEnTl8c/8jul2S329iFBnDI9HGoeWWAZvuvOkZccgw==", "dev": true, "requires": { - "@sinonjs/commons": "^1.7.0" + "@sinonjs/commons": "^3.0.0" } }, "@sinonjs/samsam": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/@sinonjs/samsam/-/samsam-6.1.1.tgz", - "integrity": "sha512-cZ7rKJTLiE7u7Wi/v9Hc2fs3Ucc3jrWeMgPHbbTCeVAB2S0wOBbYlkJVeNSL04i7fdhT8wIbDq1zhC/PXTD2SA==", + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@sinonjs/samsam/-/samsam-8.0.0.tgz", + "integrity": "sha512-Bp8KUVlLp8ibJZrnvq2foVhP0IVX2CIprMJPK0vqGqgrDa0OHVKeZyBykqskkrdxV6yKBPmGasO8LVjAKR3Gew==", "dev": true, "requires": { - "@sinonjs/commons": "^1.6.0", + "@sinonjs/commons": "^2.0.0", "lodash.get": "^4.4.2", "type-detect": "^4.0.8" + }, + "dependencies": { + "@sinonjs/commons": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-2.0.0.tgz", + "integrity": "sha512-uLa0j859mMrg2slwQYdO/AkrOfmH+X6LTVmNTS9CqexuE2IvVORIkSpJLqePAbEnKJ77aMmCwr1NUZ57120Xcg==", + "dev": true, + "requires": { + "type-detect": "4.0.8" + } + } } }, "@sinonjs/text-encoding": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/@sinonjs/text-encoding/-/text-encoding-0.7.1.tgz", - "integrity": "sha512-+iTbntw2IZPb/anVDbypzfQa+ay64MW0Zo8aJ8gZPWMMK6/OubMVb6lUPMagqjOPnmtauXnFCACVl3O7ogjeqQ==", + "version": "0.7.3", + "resolved": "https://registry.npmjs.org/@sinonjs/text-encoding/-/text-encoding-0.7.3.tgz", + "integrity": "sha512-DE427ROAphMQzU4ENbliGYrBSYPXF+TtLg9S8vzeA+OF4ZKzoDdzfL8sxuMUGS/lgRhM6j1URSk9ghf7Xo1tyA==", "dev": true }, "@tootallnate/once": { @@ -15244,12 +15920,6 @@ "@types/estree": "*" } }, - "@types/eslint-visitor-keys": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@types/eslint-visitor-keys/-/eslint-visitor-keys-1.0.0.tgz", - "integrity": "sha512-OCutwjDZ4aFS6PB1UZ988C4YgwlBHJd6wCeQqaLdmadZ/7e+w79+hbMUFC1QXDNCmdyoRfAFdm0RypzwR+Qpag==", - "dev": true - }, "@types/estree": { "version": "0.0.51", "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.51.tgz", @@ -15257,11 +15927,12 @@ "dev": true }, "@types/fs-extra": { - "version": "9.0.13", - "resolved": "https://registry.npmjs.org/@types/fs-extra/-/fs-extra-9.0.13.tgz", - "integrity": "sha512-nEnwB++1u5lVDM2UI4c1+5R+FYaKfaAzS4OococimjVm3nQw3TuzH5UNsocrcTBbhnerblyHj4A49qXbIiZdpA==", + "version": "11.0.4", + "resolved": "https://registry.npmjs.org/@types/fs-extra/-/fs-extra-11.0.4.tgz", + "integrity": "sha512-yTbItCNreRooED33qjunPthRcSjERP1r4MqCZc7wv0u2sUkzTFp45tgUfS5+r7FrZPdmCCNflLhVSP/o+SemsQ==", "dev": true, "requires": { + "@types/jsonfile": "*", "@types/node": "*" } }, @@ -15300,9 +15971,9 @@ } }, "@types/json-schema": { - "version": "7.0.9", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.9.tgz", - "integrity": "sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ==", + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", "dev": true }, "@types/json5": { @@ -15311,6 +15982,15 @@ "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", "dev": true }, + "@types/jsonfile": { + "version": "6.1.4", + "resolved": "https://registry.npmjs.org/@types/jsonfile/-/jsonfile-6.1.4.tgz", + "integrity": "sha512-D5qGUYwjvnNNextdU59/+fI+spnwtTFmyQP0h+PfIOSkNfpU6AOICUOkm4i0OnSk+NyjdPJrxCDro0sJsWlRpQ==", + "dev": true, + "requires": { + "@types/node": "*" + } + }, "@types/lodash": { "version": "4.14.181", "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.181.tgz", @@ -15330,10 +16010,13 @@ "dev": true }, "@types/node": { - "version": "18.17.14", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.17.14.tgz", - "integrity": "sha512-ZE/5aB73CyGqgQULkLG87N9GnyGe5TcQjv34pwS8tfBs1IkCh0ASM69mydb2znqd6v0eX+9Ytvk6oQRqu8T1Vw==", - "dev": true + "version": "22.5.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.5.0.tgz", + "integrity": "sha512-DkFrJOe+rfdHTqqMg0bSNlGlQ85hSoh2TPzZyhHsXnMtligRWpxUySiyw8FY14ITt24HVCiQPWxS3KO/QlGmWg==", + "dev": true, + "requires": { + "undici-types": "~6.19.2" + } }, "@types/semver": { "version": "5.5.0", @@ -15353,9 +16036,9 @@ "dev": true }, "@types/sinon": { - "version": "10.0.11", - "resolved": "https://registry.npmjs.org/@types/sinon/-/sinon-10.0.11.tgz", - "integrity": "sha512-dmZsHlBsKUtBpHriNjlK0ndlvEh8dcb9uV9Afsbt89QIyydpC7NcR+nWlAhASfy3GHnxTl4FX/aKE7XZUt/B4g==", + "version": "17.0.3", + "resolved": "https://registry.npmjs.org/@types/sinon/-/sinon-17.0.3.tgz", + "integrity": "sha512-j3uovdn8ewky9kRBG19bOwaZbexJu/XjtkHyjvUgt4xfPFz18dcORIMqnYh66Fx3Powhcr85NT5+er3+oViapw==", "dev": true, "requires": { "@types/sinonjs__fake-timers": "*" @@ -15413,23 +16096,52 @@ } }, "@typescript-eslint/eslint-plugin": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-3.10.1.tgz", - "integrity": "sha512-PQg0emRtzZFWq6PxBcdxRH3QIQiyFO3WCVpRL3fgj5oQS3CDs3AeAKfv4DxNhzn8ITdNJGJ4D3Qw8eAJf3lXeQ==", + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-6.21.0.tgz", + "integrity": "sha512-oy9+hTPCUFpngkEZUSzbf9MxI65wbKFoQYsgPdILTfbUldp5ovUuphZVe4i30emU9M/kP+T64Di0mxl7dSw3MA==", + "dev": true, + "requires": { + "@eslint-community/regexpp": "^4.5.1", + "@typescript-eslint/scope-manager": "6.21.0", + "@typescript-eslint/type-utils": "6.21.0", + "@typescript-eslint/utils": "6.21.0", + "@typescript-eslint/visitor-keys": "6.21.0", + "debug": "^4.3.4", + "graphemer": "^1.4.0", + "ignore": "^5.2.4", + "natural-compare": "^1.4.0", + "semver": "^7.5.4", + "ts-api-utils": "^1.0.1" + }, + "dependencies": { + "debug": { + "version": "4.3.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", + "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + } + } + }, + "@typescript-eslint/parser": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-6.21.0.tgz", + "integrity": "sha512-tbsV1jPne5CkFQCgPBcDOt30ItF7aJoZL997JSF7MhGQqOeT3svWRYxiqlfA5RUdlHN6Fi+EI9bxqbdyAUZjYQ==", "dev": true, "requires": { - "@typescript-eslint/experimental-utils": "3.10.1", - "debug": "^4.1.1", - "functional-red-black-tree": "^1.0.1", - "regexpp": "^3.0.0", - "semver": "^7.3.2", - "tsutils": "^3.17.1" + "@typescript-eslint/scope-manager": "6.21.0", + "@typescript-eslint/types": "6.21.0", + "@typescript-eslint/typescript-estree": "6.21.0", + "@typescript-eslint/visitor-keys": "6.21.0", + "debug": "^4.3.4" }, "dependencies": { "debug": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.2.tgz", - "integrity": "sha512-mOp8wKcvj7XxC78zLgw/ZA+6TSgkoE2C/ienthhRD298T7UNwAg9diBpLRxC0mOezLl4B0xV7M0cCO6P/O0Xhw==", + "version": "4.3.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", + "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", "dev": true, "requires": { "ms": "2.1.2" @@ -15437,72 +16149,129 @@ } } }, - "@typescript-eslint/experimental-utils": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-3.10.1.tgz", - "integrity": "sha512-DewqIgscDzmAfd5nOGe4zm6Bl7PKtMG2Ad0KG8CUZAHlXfAKTF9Ol5PXhiMh39yRL2ChRH1cuuUGOcVyyrhQIw==", + "@typescript-eslint/scope-manager": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-6.21.0.tgz", + "integrity": "sha512-OwLUIWZJry80O99zvqXVEioyniJMa+d2GrqpUTqi5/v5D5rOrppJVBPa0yKCblcigC0/aYAzxxqQ1B+DS2RYsg==", "dev": true, "requires": { - "@types/json-schema": "^7.0.3", - "@typescript-eslint/types": "3.10.1", - "@typescript-eslint/typescript-estree": "3.10.1", - "eslint-scope": "^5.0.0", - "eslint-utils": "^2.0.0" + "@typescript-eslint/types": "6.21.0", + "@typescript-eslint/visitor-keys": "6.21.0" } }, - "@typescript-eslint/parser": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-3.10.1.tgz", - "integrity": "sha512-Ug1RcWcrJP02hmtaXVS3axPPTTPnZjupqhgj+NnZ6BCkwSImWk/283347+x9wN+lqOdK9Eo3vsyiyDHgsmiEJw==", + "@typescript-eslint/type-utils": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-6.21.0.tgz", + "integrity": "sha512-rZQI7wHfao8qMX3Rd3xqeYSMCL3SoiSQLBATSiVKARdFGCYSRvmViieZjqc58jKgs8Y8i9YvVVhRbHSTA4VBag==", "dev": true, "requires": { - "@types/eslint-visitor-keys": "^1.0.0", - "@typescript-eslint/experimental-utils": "3.10.1", - "@typescript-eslint/types": "3.10.1", - "@typescript-eslint/typescript-estree": "3.10.1", - "eslint-visitor-keys": "^1.1.0" + "@typescript-eslint/typescript-estree": "6.21.0", + "@typescript-eslint/utils": "6.21.0", + "debug": "^4.3.4", + "ts-api-utils": "^1.0.1" + }, + "dependencies": { + "debug": { + "version": "4.3.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", + "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + } } }, "@typescript-eslint/types": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-3.10.1.tgz", - "integrity": "sha512-+3+FCUJIahE9q0lDi1WleYzjCwJs5hIsbugIgnbB+dSCYUxl8L6PwmsyOPFZde2hc1DlTo/xnkOgiTLSyAbHiQ==", + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-6.21.0.tgz", + "integrity": "sha512-1kFmZ1rOm5epu9NZEZm1kckCDGj5UJEf7P1kliH4LKu/RkwpsfqqGmY2OOcUs18lSlQBKLDYBOGxRVtrMN5lpg==", "dev": true }, "@typescript-eslint/typescript-estree": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-3.10.1.tgz", - "integrity": "sha512-QbcXOuq6WYvnB3XPsZpIwztBoquEYLXh2MtwVU+kO8jgYCiv4G5xrSP/1wg4tkvrEE+esZVquIPX/dxPlePk1w==", + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-6.21.0.tgz", + "integrity": "sha512-6npJTkZcO+y2/kr+z0hc4HwNfrrP4kNYh57ek7yCNlrBjWQ1Y0OS7jiZTkgumrvkX5HkEKXFZkkdFNkaW2wmUQ==", "dev": true, "requires": { - "@typescript-eslint/types": "3.10.1", - "@typescript-eslint/visitor-keys": "3.10.1", - "debug": "^4.1.1", - "glob": "^7.1.6", - "is-glob": "^4.0.1", - "lodash": "^4.17.15", - "semver": "^7.3.2", - "tsutils": "^3.17.1" + "@typescript-eslint/types": "6.21.0", + "@typescript-eslint/visitor-keys": "6.21.0", + "debug": "^4.3.4", + "globby": "^11.1.0", + "is-glob": "^4.0.3", + "minimatch": "9.0.3", + "semver": "^7.5.4", + "ts-api-utils": "^1.0.1" }, "dependencies": { + "brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "requires": { + "balanced-match": "^1.0.0" + } + }, "debug": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.2.tgz", - "integrity": "sha512-mOp8wKcvj7XxC78zLgw/ZA+6TSgkoE2C/ienthhRD298T7UNwAg9diBpLRxC0mOezLl4B0xV7M0cCO6P/O0Xhw==", + "version": "4.3.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", + "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", "dev": true, "requires": { "ms": "2.1.2" } + }, + "minimatch": { + "version": "9.0.3", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", + "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", + "dev": true, + "requires": { + "brace-expansion": "^2.0.1" + } + } + } + }, + "@typescript-eslint/utils": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-6.21.0.tgz", + "integrity": "sha512-NfWVaC8HP9T8cbKQxHcsJBY5YE1O33+jpMwN45qzWWaPDZgLIbo12toGMWnmhvCpd3sIxkpDw3Wv1B3dYrbDQQ==", + "dev": true, + "requires": { + "@eslint-community/eslint-utils": "^4.4.0", + "@types/json-schema": "^7.0.12", + "@types/semver": "^7.5.0", + "@typescript-eslint/scope-manager": "6.21.0", + "@typescript-eslint/types": "6.21.0", + "@typescript-eslint/typescript-estree": "6.21.0", + "semver": "^7.5.4" + }, + "dependencies": { + "@types/semver": { + "version": "7.5.8", + "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.5.8.tgz", + "integrity": "sha512-I8EUhyrgfLrcTkzV3TSsGyl1tSuPrEDzr0yd5m90UgNxQkyDXULk3b6MlQqTCpZpNtWe1K0hzclnZkTcLBe2UQ==", + "dev": true } } }, "@typescript-eslint/visitor-keys": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-3.10.1.tgz", - "integrity": "sha512-9JgC82AaQeglebjZMgYR5wgmfUdUc+EitGUUMW8u2nDckaeimzW+VsoLV6FoimPv2id3VQzfjwBxEMVz08ameQ==", + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-6.21.0.tgz", + "integrity": "sha512-JJtkDduxLi9bivAB+cYOVMtbkqdPOhZ+ZI5LC47MIRrDV4Yn2o+ZnW10Nkmr28xRpSpdJ6Sm42Hjf2+REYXm0A==", "dev": true, "requires": { - "eslint-visitor-keys": "^1.1.0" + "@typescript-eslint/types": "6.21.0", + "eslint-visitor-keys": "^3.4.1" + }, + "dependencies": { + "eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true + } } }, "@ungap/promise-all-settled": { @@ -16075,6 +16844,16 @@ "integrity": "sha1-45sJrqne+Gao8gbiiK9jkZuuOcQ=", "dev": true }, + "array-buffer-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.1.tgz", + "integrity": "sha512-ahC5W1xgou+KTXix4sAO8Ki12Q+jf4i0+tmk3sC+zgcynshkHxzpXdImBehiUYKKKDwvfFiJl1tZt6ewscS1Mg==", + "dev": true, + "requires": { + "call-bind": "^1.0.5", + "is-array-buffer": "^3.0.4" + } + }, "array-each": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/array-each/-/array-each-1.0.1.tgz", @@ -16082,15 +16861,16 @@ "dev": true }, "array-includes": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.4.tgz", - "integrity": "sha512-ZTNSQkmWumEbiHO2GF4GmWxYVTiQyJy2XOTa15sdQSrvKn7l+180egQMqlrMOUMCyLMD7pmyQe4mMDUT6Behrw==", + "version": "3.1.8", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.8.tgz", + "integrity": "sha512-itaWrbYbqpGXkGhZPGUulwnhVf5Hpy1xiCFsGqyIGglbBxmG5vSjxQen3/WGOjPpNEv1RtBLKxbmVXm8HpJStQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.1", - "get-intrinsic": "^1.1.1", + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.4", "is-string": "^1.0.7" } }, @@ -16106,26 +16886,58 @@ "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", "dev": true }, - "array.prototype.flat": { + "array.prototype.findlastindex": { "version": "1.2.5", - "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.5.tgz", - "integrity": "sha512-KaYU+S+ndVqyUnignHftkwc58o3uVU1jzczILJ1tN2YaIZpFIKBiP/x/j97E5MVPsaCloPbqWLB/8qCTVvT2qg==", + "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.5.tgz", + "integrity": "sha512-zfETvRFA8o7EiNn++N5f/kaCw221hrpGsDmcpndVupkPzEc1Wuf3VgC0qby1BbHs7f5DVYjgtEU2LLh5bqeGfQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-shim-unscopables": "^1.0.2" + } + }, + "array.prototype.flat": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.3.2.tgz", + "integrity": "sha512-djYB+Zx2vLewY8RWlNCUdHjDXs2XOgm602S9E7P/UpHgfeHL00cRiIF+IN/G/aUJ7kGPb6yO/ErDI5V2s8iycA==", "dev": true, "requires": { "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.0" + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" } }, "array.prototype.flatmap": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.2.5.tgz", - "integrity": "sha512-08u6rVyi1Lj7oqWbS9nUxliETrtIROT4XGTA4D/LWGten6E3ocm7cy9SIrmNHOL5XVbVuckUp3X6Xyg8/zpvHA==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.2.tgz", + "integrity": "sha512-Ewyx0c9PmpcsByhSW4r+9zDU7sGjFc86qf/kKtuSCRdhfbk0SNLLkaT5qvcHnRGgc5NP/ly/y+qkXkqONX54CQ==", "dev": true, "requires": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.0" + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" + } + }, + "arraybuffer.prototype.slice": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.3.tgz", + "integrity": "sha512-bMxMKAjg13EBSVscxTaYA4mRc5t1UAXa2kXiGTNfZ079HIWXEkKmkgFrh/nJqamaLSrXO5H4WFFkPEaLJWbs3A==", + "dev": true, + "requires": { + "array-buffer-byte-length": "^1.0.1", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "es-abstract": "^1.22.3", + "es-errors": "^1.2.1", + "get-intrinsic": "^1.2.3", + "is-array-buffer": "^3.0.4", + "is-shared-array-buffer": "^1.0.2" } }, "asn1.js": { @@ -16247,10 +17059,13 @@ "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" }, "available-typed-arrays": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.5.tgz", - "integrity": "sha512-DMD0KiN46eipeziST1LPP/STfDU0sufISXmjSgvVsoU2tqxctQeASejWcfNtxYKqETM1UxQ8sp2OrSBWpHY6sw==", - "dev": true + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "dev": true, + "requires": { + "possible-typed-array-names": "^1.0.0" + } }, "axe-core": { "version": "4.4.1", @@ -17238,6 +18053,49 @@ "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", "dev": true }, + "cross-env": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-env/-/cross-env-7.0.3.tgz", + "integrity": "sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw==", + "dev": true, + "requires": { + "cross-spawn": "^7.0.1" + }, + "dependencies": { + "cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "requires": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + } + }, + "path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true + }, + "shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "requires": { + "shebang-regex": "^3.0.0" + } + }, + "shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true + } + } + }, "cross-spawn": { "version": "6.0.5", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz", @@ -17299,6 +18157,39 @@ "integrity": "sha512-sdQSFB7+llfUcQHUQO3+B8ERRj0Oa4w9POWMI/puGtuf7gFywGmkaLCElnudfTiKZV+NvHqL0ifzdrI8Ro7ESA==", "dev": true }, + "data-view-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.1.tgz", + "integrity": "sha512-0lht7OugA5x3iJLOWFhWK/5ehONdprk0ISXqVFn/NFrDu+cuc8iADFrGQz5BnRK7LLU3JmkbXSxaqX+/mXYtUA==", + "dev": true, + "requires": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + } + }, + "data-view-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.1.tgz", + "integrity": "sha512-4J7wRJD3ABAzr8wP+OcIcqq2dlUKp4DVflx++hs5h5ZKydWMI6/D/fAot+yh6g2tHh8fLFTvNOaVN357NvSrOQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + } + }, + "data-view-byte-offset": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.0.tgz", + "integrity": "sha512-t/Ygsytq+R995EJ5PZlD4Cu56sWa8InXySaViRzw9apusqsOO2bQP+SbYzAhR0pFKoB+43lYy8rWban9JSuXnA==", + "dev": true, + "requires": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + } + }, "debug": { "version": "2.6.9", "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", @@ -17530,12 +18421,14 @@ "dev": true }, "define-properties": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", - "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", "dev": true, "requires": { - "object-keys": "^1.0.12" + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" } }, "del": { @@ -17842,31 +18735,57 @@ "dev": true }, "es-abstract": { - "version": "1.19.2", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.19.2.tgz", - "integrity": "sha512-gfSBJoZdlL2xRiOCy0g8gLMryhoe1TlimjzU99L/31Z8QEGIhVQI+EWwt5lT+AuU9SnorVupXFqqOGqGfsyO6w==", + "version": "1.23.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz", + "integrity": "sha512-e+HfNH61Bj1X9/jLc5v1owaLYuHdeHHSQlkhCBiTK8rBvKaULl/beGMxwrMXjpYrv4pz22BlY570vVePA2ho4A==", "dev": true, "requires": { - "call-bind": "^1.0.2", + "array-buffer-byte-length": "^1.0.1", + "arraybuffer.prototype.slice": "^1.0.3", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "data-view-buffer": "^1.0.1", + "data-view-byte-length": "^1.0.1", + "data-view-byte-offset": "^1.0.0", + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-set-tostringtag": "^2.0.3", "es-to-primitive": "^1.2.1", - "function-bind": "^1.1.1", - "get-intrinsic": "^1.1.1", - "get-symbol-description": "^1.0.0", - "has": "^1.0.3", + "function.prototype.name": "^1.1.6", + "get-intrinsic": "^1.2.4", + "get-symbol-description": "^1.0.2", + "globalthis": "^1.0.3", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2", + "has-proto": "^1.0.3", "has-symbols": "^1.0.3", - "internal-slot": "^1.0.3", - "is-callable": "^1.2.4", - "is-negative-zero": "^2.0.2", + "hasown": "^2.0.2", + "internal-slot": "^1.0.7", + "is-array-buffer": "^3.0.4", + "is-callable": "^1.2.7", + "is-data-view": "^1.0.1", + "is-negative-zero": "^2.0.3", "is-regex": "^1.1.4", - "is-shared-array-buffer": "^1.0.1", + "is-shared-array-buffer": "^1.0.3", "is-string": "^1.0.7", + "is-typed-array": "^1.1.13", "is-weakref": "^1.0.2", - "object-inspect": "^1.12.0", + "object-inspect": "^1.13.1", "object-keys": "^1.1.1", - "object.assign": "^4.1.2", - "string.prototype.trimend": "^1.0.4", - "string.prototype.trimstart": "^1.0.4", - "unbox-primitive": "^1.0.1" + "object.assign": "^4.1.5", + "regexp.prototype.flags": "^1.5.2", + "safe-array-concat": "^1.1.2", + "safe-regex-test": "^1.0.3", + "string.prototype.trim": "^1.2.9", + "string.prototype.trimend": "^1.0.8", + "string.prototype.trimstart": "^1.0.8", + "typed-array-buffer": "^1.0.2", + "typed-array-byte-length": "^1.0.1", + "typed-array-byte-offset": "^1.0.2", + "typed-array-length": "^1.0.6", + "unbox-primitive": "^1.0.2", + "which-typed-array": "^1.1.15" } }, "es-define-property": { @@ -17890,6 +18809,35 @@ "integrity": "sha512-1HQ2M2sPtxwnvOvT1ZClHyQDiggdNjURWpY2we6aMKCQiUVxTmVs2UYPLIrD84sS+kMdUwfBSylbJPwNnBrnHQ==", "dev": true }, + "es-object-atoms": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.0.0.tgz", + "integrity": "sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==", + "dev": true, + "requires": { + "es-errors": "^1.3.0" + } + }, + "es-set-tostringtag": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.3.tgz", + "integrity": "sha512-3T8uNMC3OQTHkFUsFq8r/BwAXLHvU/9O9mE0fBc/MY5iq/8H7ncvO947LmYA6ldWw9Uh8Yhf25zu6n7nML5QWQ==", + "dev": true, + "requires": { + "get-intrinsic": "^1.2.4", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.1" + } + }, + "es-shim-unscopables": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.0.2.tgz", + "integrity": "sha512-J3yBRXCzDu4ULnQwxyToo/OjdMx6akgVC7K6few0a7F/0wLtmKKN7I73AH5T2836UuXRqN7Qg+IIUw/+YJksRw==", + "dev": true, + "requires": { + "hasown": "^2.0.0" + } + }, "es-to-primitive": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", @@ -18162,13 +19110,14 @@ "requires": {} }, "eslint-import-resolver-node": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.6.tgz", - "integrity": "sha512-0En0w03NRVMn9Uiyn8YRPDKvWjxCWkslUEhGNTdGx15RvPJYQ+lbOlqrlNI2vEAs4pDYK4f/HN2TbDmk5TP0iw==", + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.9.tgz", + "integrity": "sha512-WFj2isz22JahUv+B788TlO3N6zL3nNJGU8CcZbPZvVEkBPaJdCV4vy5wyghty5ROFbCRnm132v8BScu5/1BQ8g==", "dev": true, "requires": { "debug": "^3.2.7", - "resolve": "^1.20.0" + "is-core-module": "^2.13.0", + "resolve": "^1.22.4" }, "dependencies": { "debug": { @@ -18183,13 +19132,12 @@ } }, "eslint-module-utils": { - "version": "2.7.3", - "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.7.3.tgz", - "integrity": "sha512-088JEC7O3lDZM9xGe0RerkOMd0EjFl+Yvd1jPWIkMT5u3H9+HC34mWWPnqPrN13gieT9pBOO+Qt07Nb/6TresQ==", + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.8.1.tgz", + "integrity": "sha512-rXDXR3h7cs7dy9RNpUlQf80nX31XWJEyGq1tRMo+6GsO5VmTe4UTwtmonAD4ZkAsrfMVDA2wlGJ3790Ys+D49Q==", "dev": true, "requires": { - "debug": "^3.2.7", - "find-up": "^2.1.0" + "debug": "^3.2.7" }, "dependencies": { "debug": { @@ -18200,73 +19148,43 @@ "requires": { "ms": "^2.1.1" } - }, - "find-up": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", - "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", - "dev": true, - "requires": { - "locate-path": "^2.0.0" - } - }, - "locate-path": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", - "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", - "dev": true, - "requires": { - "p-locate": "^2.0.0", - "path-exists": "^3.0.0" - } - }, - "p-limit": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", - "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", - "dev": true, - "requires": { - "p-try": "^1.0.0" - } - }, - "p-locate": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", - "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", - "dev": true, - "requires": { - "p-limit": "^1.1.0" - } - }, - "p-try": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", - "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", - "dev": true } } }, "eslint-plugin-import": { - "version": "2.25.4", - "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.25.4.tgz", - "integrity": "sha512-/KJBASVFxpu0xg1kIBn9AUa8hQVnszpwgE7Ld0lKAlx7Ie87yzEzCgSkekt+le/YVhiaosO4Y14GDAOc41nfxA==", + "version": "2.29.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.29.1.tgz", + "integrity": "sha512-BbPC0cuExzhiMo4Ff1BTVwHpjjv28C5R+btTOGaCRC7UEz801up0JadwkeSk5Ued6TG34uaczuVuH6qyy5YUxw==", "dev": true, "requires": { - "array-includes": "^3.1.4", - "array.prototype.flat": "^1.2.5", - "debug": "^2.6.9", + "array-includes": "^3.1.7", + "array.prototype.findlastindex": "^1.2.3", + "array.prototype.flat": "^1.3.2", + "array.prototype.flatmap": "^1.3.2", + "debug": "^3.2.7", "doctrine": "^2.1.0", - "eslint-import-resolver-node": "^0.3.6", - "eslint-module-utils": "^2.7.2", - "has": "^1.0.3", - "is-core-module": "^2.8.0", + "eslint-import-resolver-node": "^0.3.9", + "eslint-module-utils": "^2.8.0", + "hasown": "^2.0.0", + "is-core-module": "^2.13.1", "is-glob": "^4.0.3", - "minimatch": "^3.0.4", - "object.values": "^1.1.5", - "resolve": "^1.20.0", - "tsconfig-paths": "^3.12.0" + "minimatch": "^3.1.2", + "object.fromentries": "^2.0.7", + "object.groupby": "^1.0.1", + "object.values": "^1.1.7", + "semver": "^6.3.1", + "tsconfig-paths": "^3.15.0" }, "dependencies": { + "debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "requires": { + "ms": "^2.1.1" + } + }, "minimatch": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", @@ -18275,6 +19193,12 @@ "requires": { "brace-expansion": "^1.1.7" } + }, + "semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true } } }, @@ -18844,6 +19768,15 @@ "readable-stream": "^2.3.6" } }, + "for-each": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz", + "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==", + "dev": true, + "requires": { + "is-callable": "^1.1.3" + } + }, "for-in": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/for-in/-/for-in-1.0.2.tgz", @@ -18859,12 +19792,6 @@ "for-in": "^1.0.1" } }, - "foreach": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/foreach/-/foreach-2.0.5.tgz", - "integrity": "sha1-C+4AUBiusmDQo6865ljdATbsG5k=", - "dev": true - }, "foreground-child": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-2.0.0.tgz", @@ -18942,9 +19869,9 @@ "dev": true }, "fs-extra": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.1.tgz", - "integrity": "sha512-NbdoVMZso2Lsrn/QwLXOy6rm0ufY2zEOKCDzJR/0kBsb0E6qed0P3iYK+Ath3BfvXEeu4JhEtXLgILx5psUfag==", + "version": "11.2.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.2.0.tgz", + "integrity": "sha512-PmDi3uwK5nFuXh7XDTlVnS17xJS7vW36is2+w3xcv8SVxiB4NyATf4ctkVY5bkSjX0Y4nbvZCq1/EjtEyr9ktw==", "requires": { "graceful-fs": "^4.2.0", "jsonfile": "^6.0.1", @@ -19003,12 +19930,30 @@ "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==" }, + "function.prototype.name": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.6.tgz", + "integrity": "sha512-Z5kx79swU5P27WEayXM1tBi5Ze/lbIyiNgU3qyXUOf9b2rgXYyF9Dy9Cx+IQv/Lc8WCG6L82zwUPpSS9hGehIg==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "functions-have-names": "^1.2.3" + } + }, "functional-red-black-tree": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", "dev": true }, + "functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true + }, "gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", @@ -19059,13 +20004,14 @@ "dev": true }, "get-symbol-description": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.0.tgz", - "integrity": "sha512-2EmdH1YvIQiZpltCNgkuiUnyukzxM/R6NDJX31Ke3BG1Nq5b0S2PhX59UKi9vZpPDQVdqn+1IcaAwnzTT5vCjw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.2.tgz", + "integrity": "sha512-g0QYk1dZBxGwk+Ngc+ltRH2IBp2f7zBkBMBJZCDerh6EhlhSR6+9irMCuT/09zD6qkarHUSn529sK/yL4S27mg==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "get-intrinsic": "^1.1.1" + "call-bind": "^1.0.5", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4" } }, "github-from-package": { @@ -19194,6 +20140,16 @@ "integrity": "sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==", "dev": true }, + "globalthis": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/globalthis/-/globalthis-1.0.4.tgz", + "integrity": "sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ==", + "dev": true, + "requires": { + "define-properties": "^1.2.1", + "gopd": "^1.0.1" + } + }, "globby": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", @@ -19270,6 +20226,12 @@ "integrity": "sha1-TK+tdrxi8C+gObL5Tpo906ORpyU=", "dev": true }, + "graphemer": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", + "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", + "dev": true + }, "growl": { "version": "1.10.5", "resolved": "https://registry.npmjs.org/growl/-/growl-1.10.5.tgz", @@ -19577,14 +20539,15 @@ "version": "1.0.3", "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "dev": true, "requires": { "function-bind": "^1.1.1" } }, "has-bigints": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", - "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz", + "integrity": "sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ==", "dev": true }, "has-flag": { @@ -19630,12 +20593,12 @@ } }, "has-tostringtag": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.0.tgz", - "integrity": "sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", "dev": true, "requires": { - "has-symbols": "^1.0.2" + "has-symbols": "^1.0.3" } }, "hash-base": { @@ -19679,7 +20642,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", - "dev": true, "requires": { "function-bind": "^1.1.2" } @@ -19790,9 +20752,9 @@ "dev": true }, "ignore": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", - "integrity": "sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ==", + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", + "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", "dev": true }, "immediate": { @@ -19873,13 +20835,13 @@ "dev": true }, "internal-slot": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.3.tgz", - "integrity": "sha512-O0DB1JC/sPyZl7cIo78n5dR7eUSwwpYPiXRhTzNxZVAMUuB8vlnRFyLxdrVToks6XPLVnFfbzaVd5WLjhgg+vA==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz", + "integrity": "sha512-NGnrKwXzSms2qUUih/ILZ5JBqNTSa1+ZmP6flaIp6KmSElgE9qdndzS3cqjrDovwFdmwsGsLdeFgB6suw+1e9g==", "dev": true, "requires": { - "get-intrinsic": "^1.1.0", - "has": "^1.0.3", + "es-errors": "^1.3.0", + "hasown": "^2.0.0", "side-channel": "^1.0.4" } }, @@ -19900,9 +20862,9 @@ } }, "inversify": { - "version": "5.0.5", - "resolved": "https://registry.npmjs.org/inversify/-/inversify-5.0.5.tgz", - "integrity": "sha512-60QsfPz8NAU/GZqXu8hJ+BhNf/C/c+Hp0eDc6XMIJTxBiP36AQyyQKpBkOVTLWBFDQWYVHpbbEuIsHu9dLuJDA==" + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/inversify/-/inversify-6.0.2.tgz", + "integrity": "sha512-i9m8j/7YIv4mDuYXUAcrpKPSaju/CIly9AHK5jvCBeoiM/2KEsuCQTTP+rzSWWpLYWRukdXFSl6ZTk2/uumbiA==" }, "is-absolute": { "version": "1.0.0", @@ -19924,11 +20886,24 @@ "has-tostringtag": "^1.0.0" } }, + "is-array-buffer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.4.tgz", + "integrity": "sha512-wcjaerHw0ydZwfhiKbXJWLDY8A7yV7KhjQOpb83hGgGfId/aQa4TOvwyzn2PuswW2gPCYEL/nEAiSVpdOj1lXw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.2.1" + } + }, "is-bigint": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.2.tgz", - "integrity": "sha512-0JV5+SOCQkIdzjBK9buARcV804Ddu7A0Qet6sHi3FimE9ne6m4BGQZfRn+NZiXbBk4F4XmHfDZIipLj9pX8dSA==", - "dev": true + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz", + "integrity": "sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==", + "dev": true, + "requires": { + "has-bigints": "^1.0.1" + } }, "is-binary-path": { "version": "2.1.0", @@ -19939,6 +20914,16 @@ "binary-extensions": "^2.0.0" } }, + "is-boolean-object": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz", + "integrity": "sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + } + }, "is-buffer": { "version": "1.1.6", "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz", @@ -19946,17 +20931,26 @@ "dev": true }, "is-callable": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.4.tgz", - "integrity": "sha512-nsuwtxZfMX67Oryl9LCQ+upnC0Z0BgpwntpS89m1H/TLF0zNfzfLMV/9Wa/6MZsj0acpEjAO0KF1xT6ZdLl95w==", + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", + "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", "dev": true }, "is-core-module": { - "version": "2.13.0", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.0.tgz", - "integrity": "sha512-Z7dk6Qo8pOCp3l4tsX2C5ZVas4V+UxwQodwZhLopL91TX8UyyHEXafPcyoeeWuLrwzHcr3igO78wNLwHJHsMCQ==", + "version": "2.15.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.0.tgz", + "integrity": "sha512-Dd+Lb2/zvk9SKy1TGCt1wFJFo/MWBPMX5x7KcvLajWTGuomczdQX61PvY5yK6SVACwpoexWo81IfFyoKY2QnTA==", + "requires": { + "hasown": "^2.0.2" + } + }, + "is-data-view": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.1.tgz", + "integrity": "sha512-AHkaJrsUVW6wq6JS8y3JnM/GJF/9cf+k20+iDzlSaJrinEo5+7vRiteOSwBhHRiAyQATN1AmY4hwzxJKPmYf+w==", + "dev": true, "requires": { - "has": "^1.0.3" + "is-typed-array": "^1.1.13" } }, "is-date-object": { @@ -20027,9 +21021,9 @@ "dev": true }, "is-negative-zero": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.2.tgz", - "integrity": "sha512-dqJvarLawXsFbNDeJW7zAz8ItJ9cd28YufuuFzh0G8pNHjJMnY08Dv7sYX2uF5UpQOwieAeOExEYAWWfu7ZZUA==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz", + "integrity": "sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==", "dev": true }, "is-number": { @@ -20038,6 +21032,15 @@ "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", "dev": true }, + "is-number-object": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.7.tgz", + "integrity": "sha512-k1U0IRzLMo7ZlYIfzRu23Oh6MiIFasgpb9X76eqfFZAqwH44UI4KTBvBYIZ1dSL9ZzChTB9ShHfLkR4pdW5krQ==", + "dev": true, + "requires": { + "has-tostringtag": "^1.0.0" + } + }, "is-object": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/is-object/-/is-object-1.0.1.tgz", @@ -20097,10 +21100,13 @@ "dev": true }, "is-shared-array-buffer": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.1.tgz", - "integrity": "sha512-IU0NmyknYZN0rChcKhRO1X8LYz5Isj/Fsqh8NJOSf+N/hCOTwy29F32Ik7a+QszE63IdvmwdTPDd6cZ5pg4cwA==", - "dev": true + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.3.tgz", + "integrity": "sha512-nA2hv5XIhLR3uVzDDfCIknerhx8XUKnstuOERPNNIinXG7v9u+ohXF67vxm4TPTEPU6lm61ZkwP3c9PCB97rhg==", + "dev": true, + "requires": { + "call-bind": "^1.0.7" + } }, "is-stream": { "version": "1.1.0", @@ -20127,16 +21133,12 @@ } }, "is-typed-array": { - "version": "1.1.8", - "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.8.tgz", - "integrity": "sha512-HqH41TNZq2fgtGT8WHVFVJhBVGuY3AnP3Q36K8JKXUxSxRgk/d+7NjmwG2vo2mYmXK8UYZKu0qH8bVP5gEisjA==", + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.13.tgz", + "integrity": "sha512-uZ25/bUAlUY5fR4OKT4rZQEBrzQWYV9ZJYGGsUmEJ6thodVJ1HX64ePQ6Z0qPWP+m+Uq6e9UugrE38jeYsDSMw==", "dev": true, "requires": { - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.2", - "es-abstract": "^1.18.5", - "foreach": "^2.0.5", - "has-tostringtag": "^1.0.0" + "which-typed-array": "^1.1.14" } }, "is-typedarray": { @@ -20532,9 +21534,9 @@ } }, "just-extend": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.2.1.tgz", - "integrity": "sha512-g3UB796vUFIY90VIv/WX3L2c8CS2MdWUww3CNrYmqza1Fg0DURc2K/O4YrnklBdQarSJ/y8JnJYDGc+1iumQjg==", + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-6.2.0.tgz", + "integrity": "sha512-cYofQu2Xpom82S6qD778jBDpwvvy39s1l/hrYij2u9AMdQcGRpaBu6kY4mVhuno5kJVi1DAz4aiphA2WI1/OAw==", "dev": true }, "jwa": { @@ -20726,7 +21728,7 @@ "lodash.get": { "version": "4.4.2", "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", - "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", + "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==", "dev": true }, "lodash.includes": { @@ -21375,16 +22377,16 @@ "dev": true }, "nise": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/nise/-/nise-5.1.1.tgz", - "integrity": "sha512-yr5kW2THW1AkxVmCnKEh4nbYkJdB3I7LUkiUgOvEkOp414mc2UMaHMA7pjq1nYowhdoJZGwEKGaQVbxfpWj10A==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/nise/-/nise-6.0.0.tgz", + "integrity": "sha512-K8ePqo9BFvN31HXwEtTNGzgrPpmvgciDsFz8aztFjt4LqKO/JeFD8tBOeuDiCMXrIl/m1YvfH8auSpxfaD09wg==", "dev": true, "requires": { - "@sinonjs/commons": "^1.8.3", - "@sinonjs/fake-timers": ">=5", - "@sinonjs/text-encoding": "^0.7.1", - "just-extend": "^4.0.2", - "path-to-regexp": "^1.7.0" + "@sinonjs/commons": "^3.0.0", + "@sinonjs/fake-timers": "^11.2.2", + "@sinonjs/text-encoding": "^0.7.2", + "just-extend": "^6.2.0", + "path-to-regexp": "^6.2.1" } }, "node-abi": { @@ -21752,14 +22754,14 @@ "dev": true }, "object.assign": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", - "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz", + "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==", "dev": true, "requires": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "has-symbols": "^1.0.1", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "has-symbols": "^1.0.3", "object-keys": "^1.1.1" } }, @@ -21787,14 +22789,26 @@ } }, "object.fromentries": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.5.tgz", - "integrity": "sha512-CAyG5mWQRRiBU57Re4FKoTBjXfDoNwdFVH2Y1tS9PqCsfUTymAohOkEMSG3aRNKmv4lV3O7p1et7c187q6bynw==", + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", + "integrity": "sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0" + } + }, + "object.groupby": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/object.groupby/-/object.groupby-1.0.3.tgz", + "integrity": "sha512-+Lhy3TQTuzXI5hevh8sBGqbmurHbbIjAi0Z4S63nthVLmLxfbj4T54a4CfZrXIrt9iP4mVAPYMo/v99taj3wjQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2" } }, "object.hasown": { @@ -21817,14 +22831,14 @@ } }, "object.values": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.5.tgz", - "integrity": "sha512-QUZRW0ilQ3PnPpbNtgdNV1PDbEqLIiSFB3l+EnGtBQ/8SUTLj1PZwtQHABZtLgwpJZTSZhuGLOGk57Drx2IvYg==", + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.0.tgz", + "integrity": "sha512-yBYjY9QX2hnRmZHAjG/f13MzmBzxzYgQhFrke06TTyKY5zSTEqkOeukBzIdVA3j3ulu8Qa3MbVFShV7T2RmGtQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" } }, "once": { @@ -22075,12 +23089,6 @@ "integrity": "sha1-zDPSTVJeCZpTiMAzbG4yuRYGCeA=", "dev": true }, - "path-exists": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", - "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", - "dev": true - }, "path-is-absolute": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", @@ -22113,21 +23121,10 @@ "dev": true }, "path-to-regexp": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz", - "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==", - "dev": true, - "requires": { - "isarray": "0.0.1" - }, - "dependencies": { - "isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", - "dev": true - } - } + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.2.2.tgz", + "integrity": "sha512-GQX3SSMokngb36+whdpRXE+3f9V8UzyAorlYvOGx87ufGHehNTn5lCxrKtLyZ4Yl/wEKnNnr98ZzOwwDZV5ogw==", + "dev": true }, "path-type": { "version": "4.0.0", @@ -22214,6 +23211,12 @@ "extend-shallow": "^3.0.2" } }, + "possible-typed-array-names": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz", + "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==", + "dev": true + }, "postinstall-build": { "version": "5.0.3", "resolved": "https://registry.npmjs.org/postinstall-build/-/postinstall-build-5.0.3.tgz", @@ -22501,13 +23504,15 @@ "dev": true }, "regexp.prototype.flags": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.1.tgz", - "integrity": "sha512-pMR7hBVUUGI7PMA37m2ofIdQCsomVnas+Jn5UPGAHQ+/LlwKm/aTLJHdasmHRzlfeZwHiAOaRSo2rbBDm3nNUQ==", + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.2.tgz", + "integrity": "sha512-NcDiDkTLuPR+++OCKB0nWafEmhg/Da8aUPLPMQbK+bxKKCm1/S5he+AqYa4PlMCVBalb4/yxIRub6qkEx5yJbw==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "call-bind": "^1.0.6", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "set-function-name": "^2.0.1" } }, "regexpp": { @@ -22712,12 +23717,43 @@ "resolved": "https://registry.npmjs.org/rxjs-compat/-/rxjs-compat-6.6.7.tgz", "integrity": "sha512-szN4fK+TqBPOFBcBcsR0g2cmTTUF/vaFEOZNuSdfU8/pGFnNmmn2u8SystYXG1QMrjOPBc6XTKHMVfENDf6hHw==" }, + "safe-array-concat": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.2.tgz", + "integrity": "sha512-vj6RsCsWBCf19jIeHEfkRMw8DPiBb+DMXklQ/1SGDHOMlHdPUkZXFQ2YdplS23zESTijAcurb1aSgJA3AgMu1Q==", + "dev": true, + "requires": { + "call-bind": "^1.0.7", + "get-intrinsic": "^1.2.4", + "has-symbols": "^1.0.3", + "isarray": "^2.0.5" + }, + "dependencies": { + "isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true + } + } + }, "safe-buffer": { "version": "5.1.2", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", "dev": true }, + "safe-regex-test": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.3.tgz", + "integrity": "sha512-CdASjNJPvRa7roO6Ra/gLYBTzYzzPyyBXxIMdGW3USQLyjWEls2RgW5UBTXaQVp+OrpeCK3bLem8smtmheoRuw==", + "dev": true, + "requires": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-regex": "^1.1.4" + } + }, "safer-buffer": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", @@ -22805,6 +23841,18 @@ "has-property-descriptors": "^1.0.2" } }, + "set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "dev": true, + "requires": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + } + }, "setimmediate": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/setimmediate/-/setimmediate-1.0.5.tgz", @@ -22916,23 +23964,23 @@ } }, "sinon": { - "version": "13.0.1", - "resolved": "https://registry.npmjs.org/sinon/-/sinon-13.0.1.tgz", - "integrity": "sha512-8yx2wIvkBjIq/MGY1D9h1LMraYW+z1X0mb648KZnKSdvLasvDu7maa0dFaNYdTDczFgbjNw2tOmWdTk9saVfwQ==", + "version": "18.0.0", + "resolved": "https://registry.npmjs.org/sinon/-/sinon-18.0.0.tgz", + "integrity": "sha512-+dXDXzD1sBO6HlmZDd7mXZCR/y5ECiEiGCBSGuFD/kZ0bDTofPYc6JaeGmPSF+1j1MejGUWkORbYOLDyvqCWpA==", "dev": true, "requires": { - "@sinonjs/commons": "^1.8.3", - "@sinonjs/fake-timers": "^9.0.0", - "@sinonjs/samsam": "^6.1.1", - "diff": "^5.0.0", - "nise": "^5.1.1", - "supports-color": "^7.2.0" + "@sinonjs/commons": "^3.0.1", + "@sinonjs/fake-timers": "^11.2.2", + "@sinonjs/samsam": "^8.0.0", + "diff": "^5.2.0", + "nise": "^6.0.0", + "supports-color": "^7" }, "dependencies": { "diff": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/diff/-/diff-5.0.0.tgz", - "integrity": "sha512-/VTCrvm5Z0JGty/BWHljh+BAiw3IK+2j87NGMu8Nwc/f48WoDAC395uomO9ZD117ZOBaHmkX1oyLvkVM/aIT3w==", + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-5.2.0.tgz", + "integrity": "sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==", "dev": true }, "has-flag": { @@ -23188,24 +24236,38 @@ "side-channel": "^1.0.4" } }, + "string.prototype.trim": { + "version": "1.2.9", + "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.9.tgz", + "integrity": "sha512-klHuCNxiMZ8MlsOihJhJEBJAiMVqU3Z2nEXWfWnIqjN0gEFS9J9+IxKozWWtQGcgoa1WUZzLjKPTr4ZHNFTFxw==", + "dev": true, + "requires": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.0", + "es-object-atoms": "^1.0.0" + } + }, "string.prototype.trimend": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", - "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.8.tgz", + "integrity": "sha512-p73uL5VCHCO2BZZ6krwwQE3kCzM7NKmis8S//xEC6fQonchbum4eP6kR4DLEjQFO3Wnj3Fuo8NM0kOSjVdHjZQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" } }, "string.prototype.trimstart": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", - "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz", + "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" } }, "strip-ansi": { @@ -23588,6 +24650,13 @@ "escape-string-regexp": "^1.0.2" } }, + "ts-api-utils": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.3.0.tgz", + "integrity": "sha512-UQMIo7pb8WRomKR1/+MFVLTroIvDVtMX3K6OUir8ynLyzB8Jeriont2bTAtmNPa1ekAgN7YPDyf6V+ygrdU+eQ==", + "dev": true, + "requires": {} + }, "ts-loader": { "version": "9.2.8", "resolved": "https://registry.npmjs.org/ts-loader/-/ts-loader-9.2.8.tgz", @@ -23682,13 +24751,13 @@ } }, "tsconfig-paths": { - "version": "3.14.1", - "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.14.1.tgz", - "integrity": "sha512-fxDhWnFSLt3VuTwtvJt5fpwxBHg5AdKWMsgcPOOIilyjymcYVZoCQF8fvFRezCNfblEXmi+PcM1eYHeOAgXCOQ==", + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.15.0.tgz", + "integrity": "sha512-2Ac2RgzDe/cn48GvOe3M+o82pEFewD3UPbyoUHHdKasHwJKjds4fLXWf/Ux5kATBKN20oaFGu+jbElp1pos0mg==", "dev": true, "requires": { "@types/json5": "^0.0.29", - "json5": "^1.0.1", + "json5": "^1.0.2", "minimist": "^1.2.6", "strip-bom": "^3.0.0" }, @@ -23777,15 +24846,6 @@ "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.10.0.tgz", "integrity": "sha512-qOebF53frne81cf0S9B41ByenJ3/IuH8yJKngAX35CmiZySA0khhkovshKK+jGCaMnVomla7gVlIcc3EvKPbTQ==" }, - "tsutils": { - "version": "3.21.0", - "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", - "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", - "dev": true, - "requires": { - "tslib": "^1.8.1" - } - }, "tty-browserify": { "version": "0.0.0", "resolved": "https://registry.npmjs.org/tty-browserify/-/tty-browserify-0.0.0.tgz", @@ -23829,6 +24889,58 @@ "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==", "dev": true }, + "typed-array-buffer": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.2.tgz", + "integrity": "sha512-gEymJYKZtKXzzBzM4jqa9w6Q1Jjm7x2d+sh19AdsD4wqnMPDYyvwpsIc2Q/835kHuo3BEQ7CjelGhfTsoBb2MQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-typed-array": "^1.1.13" + } + }, + "typed-array-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.1.tgz", + "integrity": "sha512-3iMJ9q0ao7WE9tWcaYKIptkNBuOIcZCCT0d4MRvuuH88fEoEH62IuQe0OtraD3ebQEoTRk8XCBoknUNc1Y67pw==", + "dev": true, + "requires": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + } + }, + "typed-array-byte-offset": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.2.tgz", + "integrity": "sha512-Ous0vodHa56FviZucS2E63zkgtgrACj7omjwd/8lTEMEPFFyjfixMZ1ZXenpgCFBBt4EC1J2XsyVS2gkG0eTFA==", + "dev": true, + "requires": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + } + }, + "typed-array-length": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.6.tgz", + "integrity": "sha512-/OxDN6OtAk5KBpGb28T+HZc2M+ADtvRxXrKKbUwtsLgdoxgX13hyy7ek6bFRl5+aBs2yZzB0c4CnQfAtVypW/g==", + "dev": true, + "requires": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13", + "possible-typed-array-names": "^1.0.0" + } + }, "typed-rest-client": { "version": "1.8.11", "resolved": "https://registry.npmjs.org/typed-rest-client/-/typed-rest-client-1.8.11.tgz", @@ -23861,9 +24973,9 @@ } }, "typescript": { - "version": "4.5.5", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", - "integrity": "sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==", + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz", + "integrity": "sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==", "dev": true }, "uc.micro": { @@ -23878,14 +24990,14 @@ "integrity": "sha512-mliiCSrsE29aNBI7O9W5gGv6WmA9kBR8PtTt6Apaxns076IRdYrrtFhXHEWMj5CSum3U7cv7/pi4xmi4XsIOqg==" }, "unbox-primitive": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", - "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", + "integrity": "sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==", "dev": true, "requires": { - "function-bind": "^1.1.1", - "has-bigints": "^1.0.1", - "has-symbols": "^1.0.2", + "call-bind": "^1.0.2", + "has-bigints": "^1.0.2", + "has-symbols": "^1.0.3", "which-boxed-primitive": "^1.0.2" } }, @@ -23940,6 +25052,12 @@ "integrity": "sha512-+hhVICbnp+rlzZMgxXenpvTxpuvA67Bfgtt+O9WOE5jo7w/dyiF1VmoZVIHvP2EkUjsyKyTwYKlLhA+j47m1Ew==", "dev": true }, + "undici-types": { + "version": "6.19.8", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz", + "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==", + "dev": true + }, "unicode": { "version": "14.0.0", "resolved": "https://registry.npmjs.org/unicode/-/unicode-14.0.0.tgz", @@ -23955,11 +25073,6 @@ "through2-filter": "^3.0.0" } }, - "untildify": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/untildify/-/untildify-4.0.0.tgz", - "integrity": "sha512-KK8xQ1mkzZeg9inewmFVDNkg3l5LUhoq9kN6iWYB/CC9YMG8HA+c1Q8HwDe6dEX7kErrEVNVBO3fWsVq5iDgtw==" - }, "update-browserslist-db": { "version": "1.0.11", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.11.tgz", @@ -24210,18 +25323,18 @@ "integrity": "sha512-+OMm11R1bGYbpIJ5eQIkwoDGFF4GvBz3Ztl6/VM+/RNNb2Gjk2c0Ku+oMmfhlTmTlPCpgHBsH4JqVCbUYhu5bA==" }, "vscode-jsonrpc": { - "version": "9.0.0-next.2", - "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-9.0.0-next.2.tgz", - "integrity": "sha512-meIaXAgChCHzWy45QGU8YpCNyqnZQ/sYeCj32OLDDbUYsCF7AvgpdXx3nnZn9yzr8ed0Od9bW+NGphEmXsqvIQ==" + "version": "9.0.0-next.5", + "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-9.0.0-next.5.tgz", + "integrity": "sha512-Sl/8RAJtfF/2x/TPBVRuhzRAcqYR/QDjEjNqMcoKFfqsxfVUPzikupRDQYB77Gkbt1RrW43sSuZ5uLtNAcikQQ==" }, "vscode-languageclient": { - "version": "10.0.0-next.2", - "resolved": "https://registry.npmjs.org/vscode-languageclient/-/vscode-languageclient-10.0.0-next.2.tgz", - "integrity": "sha512-ERKtgOkto4pHCxC2u1K3FfsYHSt8AeuZJjg1u/3TvnrCbBkMxrpn5mHWkh4m3rl6qo2Wk4m9YFgU6F7KCWQNZw==", + "version": "10.0.0-next.12", + "resolved": "https://registry.npmjs.org/vscode-languageclient/-/vscode-languageclient-10.0.0-next.12.tgz", + "integrity": "sha512-q7cVYCcYiv+a+fJYCbjMMScOGBnX162IBeUMFg31mvnN7RHKx5/CwKaCz+r+RciJrRXMqS8y8qpEVGgeIPnbxg==", "requires": { "minimatch": "^9.0.3", "semver": "^7.6.0", - "vscode-languageserver-protocol": "3.17.6-next.3" + "vscode-languageserver-protocol": "3.17.6-next.10" }, "dependencies": { "brace-expansion": { @@ -24243,18 +25356,18 @@ } }, "vscode-languageserver-protocol": { - "version": "3.17.6-next.3", - "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.6-next.3.tgz", - "integrity": "sha512-H8ATH5SAvc3JzttS+AL6g681PiBOZM/l34WP2JZk4akY3y7NqTP+f9cJ+MhrVBbD3aDS8bdAKewZgbFLW6M8Pg==", + "version": "3.17.6-next.10", + "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.6-next.10.tgz", + "integrity": "sha512-KOrrWn4NVC5jnFC5N6y/fyNKtx8rVYr67lhL/Z0P4ZBAN27aBsCnLBWAMIkYyJ1K8EZaE5r7gqdxrS9JPB6LIg==", "requires": { - "vscode-jsonrpc": "9.0.0-next.2", - "vscode-languageserver-types": "3.17.6-next.3" + "vscode-jsonrpc": "9.0.0-next.5", + "vscode-languageserver-types": "3.17.6-next.5" } }, "vscode-languageserver-types": { - "version": "3.17.6-next.3", - "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.6-next.3.tgz", - "integrity": "sha512-l5kNFXFRQGuzriXpuBqFpRmkf6f6A4VoU3h95OsVkqIOoi1k7KbwSo600cIdsKSJWrPg/+vX+QMPcMw1oI7ItA==" + "version": "3.17.6-next.5", + "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.6-next.5.tgz", + "integrity": "sha512-QFmf3Yl1tCgUQfA77N9Me/LXldJXkIVypQbty2rJ1DNHQkC+iwvm4Z2tXg9czSwlhvv0pD4pbF5mT7WhAglolw==" }, "vscode-tas-client": { "version": "0.1.84", @@ -24477,37 +25590,19 @@ "is-number-object": "^1.0.4", "is-string": "^1.0.5", "is-symbol": "^1.0.3" - }, - "dependencies": { - "is-boolean-object": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.1.tgz", - "integrity": "sha512-bXdQWkECBUIAcCkeH1unwJLIpZYaa5VvuygSyS/c2lf719mTKZDU5UdDRlpd01UjADgmW8RfqaP+mRaVPdr/Ng==", - "dev": true, - "requires": { - "call-bind": "^1.0.2" - } - }, - "is-number-object": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.5.tgz", - "integrity": "sha512-RU0lI/n95pMoUKu9v1BZP5MBcZuNSVJkMkAG2dJqC4z2GlkGUNeH68SuHuBKBD/XFe+LHZ+f9BKkLET60Niedw==", - "dev": true - } } }, "which-typed-array": { - "version": "1.1.7", - "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.7.tgz", - "integrity": "sha512-vjxaB4nfDqwKI0ws7wZpxIlde1XrLX5uB0ZjpfshgmapJMD7jJWhZI+yToJTqaFByF0eNBcYxbjmCzoRP7CfEw==", + "version": "1.1.15", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.15.tgz", + "integrity": "sha512-oV0jmFtUky6CXfkqehVvBP/LSWJ2sy4vWMioiENyJLePrBO/yKyV9OyJySfAKosh+RYkIl5zJCNZ8/4JncrpdA==", "dev": true, "requires": { - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.2", - "es-abstract": "^1.18.5", - "foreach": "^2.0.5", - "has-tostringtag": "^1.0.0", - "is-typed-array": "^1.1.7" + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-tostringtag": "^1.0.2" } }, "wildcard": { diff --git a/package.json b/package.json index 42b1a03ff281..df3cfc046ed6 100644 --- a/package.json +++ b/package.json @@ -1525,11 +1525,11 @@ "@iarna/toml": "^2.2.5", "@vscode/extension-telemetry": "^0.8.4", "arch": "^2.1.0", - "fs-extra": "^10.0.1", + "fs-extra": "^11.2.0", "glob": "^7.2.0", "hash.js": "^1.1.7", "iconv-lite": "^0.6.3", - "inversify": "^5.0.4", + "inversify": "^6.0.2", "jsonc-parser": "^3.0.0", "lodash": "^4.17.21", "minimatch": "^5.0.1", @@ -1544,11 +1544,10 @@ "tmp": "^0.0.33", "uint64be": "^3.0.0", "unicode": "^14.0.0", - "untildify": "^4.0.0", "vscode-debugprotocol": "^1.28.0", - "vscode-jsonrpc": "^9.0.0-next.2", - "vscode-languageclient": "^10.0.0-next.2", - "vscode-languageserver-protocol": "^3.17.6-next.3", + "vscode-jsonrpc": "^9.0.0-next.5", + "vscode-languageclient": "^10.0.0-next.12", + "vscode-languageserver-protocol": "^3.17.6-next.10", "vscode-tas-client": "^0.1.84", "which": "^2.0.2", "winreg": "^1.2.4", @@ -1561,22 +1560,22 @@ "@types/chai-arrays": "^2.0.0", "@types/chai-as-promised": "^7.1.0", "@types/download": "^8.0.1", - "@types/fs-extra": "^9.0.13", + "@types/fs-extra": "^11.0.4", "@types/glob": "^7.2.0", "@types/lodash": "^4.14.104", "@types/mocha": "^9.1.0", - "@types/node": "^18.17.1", + "@types/node": "^22.5.0", "@types/semver": "^5.5.0", "@types/shortid": "^0.0.29", - "@types/sinon": "^10.0.11", + "@types/sinon": "^17.0.3", "@types/stack-trace": "0.0.29", "@types/tmp": "^0.0.33", "@types/vscode": "^1.81.0", "@types/which": "^2.0.1", "@types/winreg": "^1.2.30", "@types/xml2js": "^0.4.2", - "@typescript-eslint/eslint-plugin": "^3.7.0", - "@typescript-eslint/parser": "^3.7.0", + "@typescript-eslint/eslint-plugin": "^6.21.0", + "@typescript-eslint/parser": "^6.21.0", "@vscode/test-electron": "^2.3.8", "@vscode/vsce": "^2.27.0", "bent": "^7.3.12", @@ -1584,13 +1583,14 @@ "chai-arrays": "^2.0.0", "chai-as-promised": "^7.1.1", "copy-webpack-plugin": "^9.1.0", + "cross-env": "^7.0.3", "cross-spawn": "^6.0.5", "del": "^6.0.0", "download": "^8.0.0", "eslint": "^7.2.0", "eslint-config-airbnb": "^18.2.0", "eslint-config-prettier": "^8.3.0", - "eslint-plugin-import": "^2.25.4", + "eslint-plugin-import": "^2.29.1", "eslint-plugin-jsx-a11y": "^6.3.1", "eslint-plugin-react": "^7.20.3", "eslint-plugin-react-hooks": "^4.0.0", @@ -1609,14 +1609,14 @@ "prettier": "^2.0.2", "rewiremock": "^3.13.0", "shortid": "^2.2.8", - "sinon": "^13.0.1", + "sinon": "^18.0.0", "source-map-support": "^0.5.12", "ts-loader": "^9.2.8", "ts-mockito": "^2.5.0", "ts-node": "^10.7.0", "tsconfig-paths-webpack-plugin": "^3.2.0", "typemoq": "^2.1.0", - "typescript": "4.5.5", + "typescript": "~5.2", "uuid": "^8.3.2", "webpack": "^5.76.0", "webpack-bundle-analyzer": "^4.5.0", diff --git a/src/client/activation/extensionSurvey.ts b/src/client/activation/extensionSurvey.ts index 11b581a27252..c5b7c525fea8 100644 --- a/src/client/activation/extensionSurvey.ts +++ b/src/client/activation/extensionSurvey.ts @@ -3,7 +3,7 @@ 'use strict'; -import { inject, injectable, optional } from 'inversify'; +import { inject, injectable } from 'inversify'; import * as querystring from 'querystring'; import { env, UIKind } from 'vscode'; import { IApplicationEnvironment, IApplicationShell } from '../common/application/types'; @@ -37,8 +37,8 @@ export class ExtensionSurveyPrompt implements IExtensionSingleActivationService @inject(IExperimentService) private experiments: IExperimentService, @inject(IApplicationEnvironment) private appEnvironment: IApplicationEnvironment, @inject(IPlatformService) private platformService: IPlatformService, - @optional() private sampleSizePerOneHundredUsers: number = 10, - @optional() private waitTimeToShowSurvey: number = WAIT_TIME_TO_SHOW_SURVEY, + private sampleSizePerOneHundredUsers: number = 10, + private waitTimeToShowSurvey: number = WAIT_TIME_TO_SHOW_SURVEY, ) {} public async activate(): Promise { diff --git a/src/client/application/diagnostics/checks/macPythonInterpreter.ts b/src/client/application/diagnostics/checks/macPythonInterpreter.ts index 19ccc2f8beb9..21d6b34fb7c5 100644 --- a/src/client/application/diagnostics/checks/macPythonInterpreter.ts +++ b/src/client/application/diagnostics/checks/macPythonInterpreter.ts @@ -40,7 +40,7 @@ export const InvalidMacPythonInterpreterServiceId = 'InvalidMacPythonInterpreter export class InvalidMacPythonInterpreterService extends BaseDiagnosticsService { protected changeThrottleTimeout = 1000; - private timeOut?: NodeJS.Timer | number; + private timeOut?: NodeJS.Timeout | number; constructor( @inject(IServiceContainer) serviceContainer: IServiceContainer, diff --git a/src/client/browser/extension.ts b/src/client/browser/extension.ts index 28e1912f67e4..35854d141cad 100644 --- a/src/client/browser/extension.ts +++ b/src/client/browser/extension.ts @@ -108,7 +108,7 @@ async function runPylance( middleware, }; - const client = new LanguageClient('python', 'Python Language Server', clientOptions, worker); + const client = new LanguageClient('python', 'Python Language Server', worker, clientOptions); languageClient = client; context.subscriptions.push( diff --git a/src/client/common/application/commands/reportIssueCommand.ts b/src/client/common/application/commands/reportIssueCommand.ts index f5f1f0ac0c0e..2286bd1e6be2 100644 --- a/src/client/common/application/commands/reportIssueCommand.ts +++ b/src/client/common/application/commands/reportIssueCommand.ts @@ -3,11 +3,11 @@ 'use strict'; -import * as fs from 'fs-extra'; import * as os from 'os'; import * as path from 'path'; import { inject, injectable } from 'inversify'; import { isEqual } from 'lodash'; +import * as fs from '../../platform/fs-paths'; import { IExtensionSingleActivationService } from '../../../activation/types'; import { IApplicationEnvironment, ICommandManager, IWorkspaceService } from '../types'; import { EXTENSION_ROOT_DIR } from '../../../constants'; diff --git a/src/client/common/configSettings.ts b/src/client/common/configSettings.ts index dbd78c5287e5..6cae60c9fb97 100644 --- a/src/client/common/configSettings.ts +++ b/src/client/common/configSettings.ts @@ -38,8 +38,7 @@ import { debounceSync } from './utils/decorators'; import { SystemVariables } from './variables/systemVariables'; import { getOSType, OSType } from './utils/platform'; import { isWindows } from './platform/platformService'; - -const untildify = require('untildify'); +import { untildify } from './helpers'; export class PythonSettings implements IPythonSettings { private get onDidChange(): Event { diff --git a/src/client/common/extensions.ts b/src/client/common/extensions.ts index e68e3838ee1d..a074106b73b1 100644 --- a/src/client/common/extensions.ts +++ b/src/client/common/extensions.ts @@ -63,13 +63,6 @@ String.prototype.trimQuotes = function (this: string): string { return this.replace(/(^['"])|(['"]$)/g, ''); }; -declare interface Promise { - /** - * Catches task error and ignores them. - */ - ignoreErrors(): Promise; -} - /** * Explicitly tells that promise should be run asynchonously. */ diff --git a/src/client/common/helpers.ts b/src/client/common/helpers.ts index 5359284da66a..52eeb1e087aa 100644 --- a/src/client/common/helpers.ts +++ b/src/client/common/helpers.ts @@ -2,6 +2,7 @@ // Licensed under the MIT License. 'use strict'; +import * as os from 'os'; import { ModuleNotInstalledError } from './errors/moduleNotInstalledError'; @@ -19,3 +20,7 @@ export function isNotInstalledError(error: Error): boolean { const isModuleNoInstalledError = error.message.indexOf('No module named') >= 0; return errorObj.code === 'ENOENT' || errorObj.code === 127 || isModuleNoInstalledError; } + +export function untildify(path: string): string { + return path.replace(/^~($|\/|\\)/, `${os.homedir()}$1`); +} diff --git a/src/client/common/installer/types.ts b/src/client/common/installer/types.ts index 53696b948571..efc7535af708 100644 --- a/src/client/common/installer/types.ts +++ b/src/client/common/installer/types.ts @@ -79,6 +79,7 @@ export interface IProductPathService { } export enum ModuleInstallFlags { + none = 0, upgrade = 1, updateDependencies = 2, reInstall = 4, diff --git a/src/client/common/interpreterPathService.ts b/src/client/common/interpreterPathService.ts index 8af142962565..935d0bd89ad7 100644 --- a/src/client/common/interpreterPathService.ts +++ b/src/client/common/interpreterPathService.ts @@ -3,7 +3,7 @@ 'use strict'; -import * as fs from 'fs-extra'; +import * as fs from '../common/platform/fs-paths'; import { inject, injectable } from 'inversify'; import { ConfigurationChangeEvent, ConfigurationTarget, Event, EventEmitter, Uri } from 'vscode'; import { traceError, traceVerbose } from '../logging'; diff --git a/src/client/common/platform/fileSystem.ts b/src/client/common/platform/fileSystem.ts index 8f962b0f776f..3e7f441654ec 100644 --- a/src/client/common/platform/fileSystem.ts +++ b/src/client/common/platform/fileSystem.ts @@ -333,7 +333,7 @@ export class FileSystemUtils implements IFileSystemUtils { pathUtils.paths, tmp || TemporaryFileSystem.withDefaults(), getHash || getHashString, - globFiles || promisify(glob), + globFiles || promisify(glob.default), ); } diff --git a/src/client/common/platform/fs-paths.ts b/src/client/common/platform/fs-paths.ts index 17df7507f7d9..fa809d31b0b9 100644 --- a/src/client/common/platform/fs-paths.ts +++ b/src/client/common/platform/fs-paths.ts @@ -4,11 +4,10 @@ import * as nodepath from 'path'; import { getSearchPathEnvVarNames } from '../utils/exec'; import * as fs from 'fs-extra'; +import * as os from 'os'; import { getOSType, OSType } from '../utils/platform'; import { IExecutables, IFileSystemPaths, IFileSystemPathUtils } from './types'; -const untildify = require('untildify'); - // The parts of node's 'path' module used by FileSystemPaths. interface INodePath { sep: string; @@ -120,7 +119,7 @@ export class FileSystemPathUtils implements IFileSystemPathUtils { } return new FileSystemPathUtils( // Use the current user's home directory. - untildify('~'), + os.homedir(), paths, Executables.withDefaults(), // Use the actual node "path" module. @@ -183,6 +182,105 @@ export async function copyFile(src: string, dest: string): Promise { }); } +// These function exist so we can stub them out in tests. We can't stub out the fs module directly +// because of the way that sinon does stubbing, so we have these intermediaries instead. +export { Stats, WriteStream, ReadStream, PathLike, Dirent, PathOrFileDescriptor } from 'fs-extra'; + +export function existsSync(path: string): boolean { + return fs.existsSync(path); +} + +export function readFileSync(filePath: string, encoding: BufferEncoding): string; +export function readFileSync(filePath: string): Buffer; +export function readFileSync(filePath: string, options: { encoding: BufferEncoding }): string; +export function readFileSync( + filePath: string, + options?: { encoding: BufferEncoding } | BufferEncoding | undefined, +): string | Buffer { + if (typeof options === 'string') { + return fs.readFileSync(filePath, { encoding: options }); + } + return fs.readFileSync(filePath, options); +} + +export function readJSONSync(filePath: string): any { + return fs.readJSONSync(filePath); +} + +export function readdirSync(path: string): string[]; +export function readdirSync( + path: string, + options: fs.ObjectEncodingOptions & { + withFileTypes: true; + }, +): fs.Dirent[]; +export function readdirSync( + path: string, + options: fs.ObjectEncodingOptions & { + withFileTypes: false; + }, +): string[]; +export function readdirSync( + path: fs.PathLike, + options?: fs.ObjectEncodingOptions & { + withFileTypes: boolean; + recursive?: boolean | undefined; + }, +): string[] | fs.Dirent[] { + if (options === undefined || options.withFileTypes === false) { + return fs.readdirSync(path); + } + return fs.readdirSync(path, { ...options, withFileTypes: true }); +} + +export function readlink(path: string): Promise { + return fs.readlink(path); +} + +export function unlink(path: string): Promise { + return fs.unlink(path); +} + +export function symlink(target: string, path: string, type?: fs.SymlinkType): Promise { + return fs.symlink(target, path, type); +} + +export function symlinkSync(target: string, path: string, type?: fs.SymlinkType): void { + return fs.symlinkSync(target, path, type); +} + +export function unlinkSync(path: string): void { + return fs.unlinkSync(path); +} + +export function statSync(path: string): fs.Stats { + return fs.statSync(path); +} + +export function stat(path: string): Promise { + return fs.stat(path); +} + +export function lstat(path: string): Promise { + return fs.lstat(path); +} + +export function chmod(path: string, mod: fs.Mode): Promise { + return fs.chmod(path, mod); +} + +export function createReadStream(path: string): fs.ReadStream { + return fs.createReadStream(path); +} + +export function createWriteStream(path: string): fs.WriteStream { + return fs.createWriteStream(path); +} + +export function pathExistsSync(path: string): boolean { + return fs.pathExistsSync(path); +} + export function pathExists(absPath: string): Promise { return fs.pathExists(absPath); } @@ -190,3 +288,83 @@ export function pathExists(absPath: string): Promise { export function createFile(filename: string): Promise { return fs.createFile(filename); } + +export function rmdir(path: string, options?: fs.RmDirOptions): Promise { + return fs.rmdir(path, options); +} + +export function remove(path: string): Promise { + return fs.remove(path); +} + +export function readFile(filePath: string, encoding: BufferEncoding): Promise; +export function readFile(filePath: string): Promise; +export function readFile(filePath: string, options: { encoding: BufferEncoding }): Promise; +export function readFile( + filePath: string, + options?: { encoding: BufferEncoding } | BufferEncoding | undefined, +): Promise { + if (typeof options === 'string') { + return fs.readFile(filePath, { encoding: options }); + } + return fs.readFile(filePath, options); +} + +export function readJson(filePath: string): Promise { + return fs.readJson(filePath); +} + +export function writeFile(filePath: string, data: any, options?: { encoding: BufferEncoding }): Promise { + return fs.writeFile(filePath, data, options); +} + +export function mkdir(dirPath: string): Promise { + return fs.mkdir(dirPath); +} + +export function mkdirp(dirPath: string): Promise { + return fs.mkdirp(dirPath); +} + +export function rename(oldPath: string, newPath: string): Promise { + return fs.rename(oldPath, newPath); +} + +export function ensureDir(dirPath: string): Promise { + return fs.ensureDir(dirPath); +} + +export function ensureFile(filePath: string): Promise { + return fs.ensureFile(filePath); +} + +export function ensureSymlink(target: string, filePath: string, type?: fs.SymlinkType): Promise { + return fs.ensureSymlink(target, filePath, type); +} + +export function appendFile(filePath: string, data: any, options?: { encoding: BufferEncoding }): Promise { + return fs.appendFile(filePath, data, options); +} + +export function readdir(path: string): Promise; +export function readdir( + path: string, + options: fs.ObjectEncodingOptions & { + withFileTypes: true; + }, +): Promise; +export function readdir( + path: fs.PathLike, + options?: fs.ObjectEncodingOptions & { + withFileTypes: true; + }, +): Promise { + if (options === undefined) { + return fs.readdir(path); + } + return fs.readdir(path, options); +} + +export function emptyDir(dirPath: string): Promise { + return fs.emptyDir(dirPath); +} diff --git a/src/client/common/platform/pathUtils.ts b/src/client/common/platform/pathUtils.ts index ed3dc28b1de5..b3be39f4644b 100644 --- a/src/client/common/platform/pathUtils.ts +++ b/src/client/common/platform/pathUtils.ts @@ -6,8 +6,7 @@ import * as path from 'path'; import { IPathUtils, IsWindows } from '../types'; import { OSType } from '../utils/platform'; import { Executables, FileSystemPaths, FileSystemPathUtils } from './fs-paths'; - -const untildify = require('untildify'); +import { untildify } from '../helpers'; @injectable() export class PathUtils implements IPathUtils { diff --git a/src/client/common/utils/multiStepInput.ts b/src/client/common/utils/multiStepInput.ts index e2b2567b5b4e..2de1684a4d2e 100644 --- a/src/client/common/utils/multiStepInput.ts +++ b/src/client/common/utils/multiStepInput.ts @@ -26,7 +26,7 @@ export class InputFlowAction { } // eslint-disable-next-line @typescript-eslint/no-explicit-any -export type InputStep = (input: MultiStepInput, state: T) => Promise | void>; +export type InputStep = (input: MultiStepInput, state: T) => Promise | void>; type buttonCallbackType = (quickPick: QuickPick) => void; diff --git a/src/client/common/variables/environment.ts b/src/client/common/variables/environment.ts index 81e6b8b2cfc9..9f0abd9b0ee7 100644 --- a/src/client/common/variables/environment.ts +++ b/src/client/common/variables/environment.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import { pathExistsSync, readFileSync } from 'fs-extra'; +import { pathExistsSync, readFileSync } from '../platform/fs-paths'; import { inject, injectable } from 'inversify'; import * as path from 'path'; import { traceError } from '../../logging'; diff --git a/src/client/common/variables/environmentVariablesProvider.ts b/src/client/common/variables/environmentVariablesProvider.ts index 2524aac21017..14573d2204aa 100644 --- a/src/client/common/variables/environmentVariablesProvider.ts +++ b/src/client/common/variables/environmentVariablesProvider.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import { inject, injectable, optional } from 'inversify'; +import { inject, injectable } from 'inversify'; import * as path from 'path'; import { ConfigurationChangeEvent, Disposable, Event, EventEmitter, FileSystemWatcher, Uri } from 'vscode'; import { traceError, traceVerbose } from '../../logging'; @@ -33,7 +33,7 @@ export class EnvironmentVariablesProvider implements IEnvironmentVariablesProvid @inject(IPlatformService) private platformService: IPlatformService, @inject(IWorkspaceService) private workspaceService: IWorkspaceService, @inject(ICurrentProcess) private process: ICurrentProcess, - @optional() private cacheDuration: number = CACHE_DURATION, + private cacheDuration: number = CACHE_DURATION, ) { disposableRegistry.push(this); this.changeEventEmitter = new EventEmitter(); diff --git a/src/client/common/vscodeApis/extensionsApi.ts b/src/client/common/vscodeApis/extensionsApi.ts index 4e1664a3dfae..f099d6f636b0 100644 --- a/src/client/common/vscodeApis/extensionsApi.ts +++ b/src/client/common/vscodeApis/extensionsApi.ts @@ -2,8 +2,8 @@ // Licensed under the MIT License. import * as path from 'path'; -import * as fs from 'fs-extra'; import * as vscode from 'vscode'; +import * as fs from '../platform/fs-paths'; import { PVSC_EXTENSION_ID } from '../constants'; export function getExtension(extensionId: string): vscode.Extension | undefined { diff --git a/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts b/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts index 4177dd90e4a2..d5857638821a 100644 --- a/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts +++ b/src/client/debugger/extension/configuration/launch.json/launchJsonReader.ts @@ -2,9 +2,9 @@ // Licensed under the MIT License. import * as path from 'path'; -import * as fs from 'fs-extra'; import { parse } from 'jsonc-parser'; import { DebugConfiguration, Uri, WorkspaceFolder } from 'vscode'; +import * as fs from '../../../../common/platform/fs-paths'; import { getConfiguration, getWorkspaceFolder } from '../../../../common/vscodeApis/workspaceApis'; import { traceLog } from '../../../../logging'; diff --git a/src/client/interpreter/configuration/interpreterSelector/commands/installPython/installPythonViaTerminal.ts b/src/client/interpreter/configuration/interpreterSelector/commands/installPython/installPythonViaTerminal.ts index 9da7284a3bea..3b4a6d428baa 100644 --- a/src/client/interpreter/configuration/interpreterSelector/commands/installPython/installPythonViaTerminal.ts +++ b/src/client/interpreter/configuration/interpreterSelector/commands/installPython/installPythonViaTerminal.ts @@ -94,7 +94,7 @@ export class InstallPythonViaTerminal implements IExtensionSingleActivationServi async function isPackageAvailable(packageManager: PackageManagers) { try { const which = require('which') as typeof whichTypes; - const resolvedPath = await which(packageManager); + const resolvedPath = await which.default(packageManager); traceVerbose(`Resolved path to ${packageManager} module:`, resolvedPath); return resolvedPath.trim().length > 0; } catch (ex) { diff --git a/src/client/interpreter/configuration/interpreterSelector/commands/setInterpreter.ts b/src/client/interpreter/configuration/interpreterSelector/commands/setInterpreter.ts index 0a663ac9f0d3..e65cd1567ac4 100644 --- a/src/client/interpreter/configuration/interpreterSelector/commands/setInterpreter.ts +++ b/src/client/interpreter/configuration/interpreterSelector/commands/setInterpreter.ts @@ -46,8 +46,7 @@ import { ISpecialQuickPickItem, } from '../../types'; import { BaseInterpreterSelectorCommand } from './base'; - -const untildify = require('untildify'); +import { untildify } from '../../../../common/helpers'; export type InterpreterStateArgs = { path?: string; workspace: Resource }; export type QuickPickType = IInterpreterQuickPickItem | ISpecialQuickPickItem | QuickPickItem; diff --git a/src/client/interpreter/virtualEnvs/activatedEnvLaunch.ts b/src/client/interpreter/virtualEnvs/activatedEnvLaunch.ts index d5470e528ab9..21bcc12b0d06 100644 --- a/src/client/interpreter/virtualEnvs/activatedEnvLaunch.ts +++ b/src/client/interpreter/virtualEnvs/activatedEnvLaunch.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import { inject, injectable, optional } from 'inversify'; +import { inject, injectable } from 'inversify'; import { ConfigurationTarget } from 'vscode'; import * as path from 'path'; import { IApplicationShell, IWorkspaceService } from '../../common/application/types'; @@ -29,7 +29,7 @@ export class ActivatedEnvironmentLaunch implements IActivatedEnvironmentLaunch { private readonly pythonPathUpdaterService: IPythonPathUpdaterServiceManager, @inject(IInterpreterService) private readonly interpreterService: IInterpreterService, @inject(IProcessServiceFactory) private readonly processServiceFactory: IProcessServiceFactory, - @optional() public wasSelected: boolean = false, + public wasSelected: boolean = false, ) {} @cache(-1, true) diff --git a/src/client/interpreter/virtualEnvs/condaInheritEnvPrompt.ts b/src/client/interpreter/virtualEnvs/condaInheritEnvPrompt.ts index cf9175345cb0..6b5295724449 100644 --- a/src/client/interpreter/virtualEnvs/condaInheritEnvPrompt.ts +++ b/src/client/interpreter/virtualEnvs/condaInheritEnvPrompt.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import { inject, injectable, optional } from 'inversify'; +import { inject, injectable } from 'inversify'; import { ConfigurationTarget, Uri } from 'vscode'; import { IExtensionActivationService } from '../../activation/types'; import { IApplicationEnvironment, IApplicationShell, IWorkspaceService } from '../../common/application/types'; @@ -26,7 +26,7 @@ export class CondaInheritEnvPrompt implements IExtensionActivationService { @inject(IPersistentStateFactory) private readonly persistentStateFactory: IPersistentStateFactory, @inject(IPlatformService) private readonly platformService: IPlatformService, @inject(IApplicationEnvironment) private readonly appEnvironment: IApplicationEnvironment, - @optional() public hasPromptBeenShownInCurrentSession: boolean = false, + public hasPromptBeenShownInCurrentSession: boolean = false, ) {} public async activate(resource: Uri): Promise { diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index 4f3352aa98ce..a05fcb8b4de4 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -3,10 +3,10 @@ import { Disposable, EventEmitter, Event, Uri } from 'vscode'; import * as ch from 'child_process'; -import * as fs from 'fs-extra'; import * as path from 'path'; import * as rpc from 'vscode-jsonrpc/node'; import { PassThrough } from 'stream'; +import * as fs from '../../../../common/platform/fs-paths'; import { isWindows } from '../../../../common/platform/platformService'; import { EXTENSION_ROOT_DIR } from '../../../../constants'; import { createDeferred, createDeferredFrom } from '../../../../common/utils/async'; @@ -21,8 +21,7 @@ import { sendNativeTelemetry, NativePythonTelemetry } from './nativePythonTeleme import { NativePythonEnvironmentKind } from './nativePythonUtils'; import type { IExtensionContext } from '../../../../common/types'; import { StopWatch } from '../../../../common/utils/stopWatch'; - -const untildify = require('untildify'); +import { untildify } from '../../../../common/helpers'; const PYTHON_ENV_TOOLS_PATH = isWindows() ? path.join(EXTENSION_ROOT_DIR, 'python-env-tools', 'bin', 'pet.exe') diff --git a/src/client/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.ts b/src/client/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.ts index ae74d2f3e189..4c6a05af4acc 100644 --- a/src/client/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.ts +++ b/src/client/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.ts @@ -9,12 +9,7 @@ import { PythonEnvKind } from '../../info'; import { BasicEnvInfo, IPythonEnvsIterator } from '../../locator'; import { FSWatchingLocator } from './fsWatchingLocator'; import { findInterpretersInDir, looksLikeBasicVirtualPython } from '../../../common/commonUtils'; -import { - getPythonSetting, - onDidChangePythonSetting, - pathExists, - untildify, -} from '../../../common/externalDependencies'; +import { getPythonSetting, onDidChangePythonSetting, pathExists } from '../../../common/externalDependencies'; import { isPipenvEnvironment } from '../../../common/environmentManagers/pipenv'; import { isVenvEnvironment, @@ -25,6 +20,7 @@ import '../../../../common/extensions'; import { asyncFilter } from '../../../../common/utils/arrayUtils'; import { traceError, traceInfo, traceVerbose } from '../../../../logging'; import { StopWatch } from '../../../../common/utils/stopWatch'; +import { untildify } from '../../../../common/helpers'; /** * Default number of levels of sub-directories to recurse when looking for interpreters. */ diff --git a/src/client/pythonEnvironments/base/locators/lowLevel/globalVirtualEnvronmentLocator.ts b/src/client/pythonEnvironments/base/locators/lowLevel/globalVirtualEnvronmentLocator.ts index 3964a6ceb893..86fbbed55043 100644 --- a/src/client/pythonEnvironments/base/locators/lowLevel/globalVirtualEnvronmentLocator.ts +++ b/src/client/pythonEnvironments/base/locators/lowLevel/globalVirtualEnvronmentLocator.ts @@ -10,7 +10,7 @@ import { PythonEnvKind } from '../../info'; import { BasicEnvInfo, IPythonEnvsIterator } from '../../locator'; import { FSWatchingLocator } from './fsWatchingLocator'; import { findInterpretersInDir, looksLikeBasicVirtualPython } from '../../../common/commonUtils'; -import { pathExists, untildify } from '../../../common/externalDependencies'; +import { pathExists } from '../../../common/externalDependencies'; import { getProjectDir, isPipenvEnvironment } from '../../../common/environmentManagers/pipenv'; import { isVenvEnvironment, @@ -21,6 +21,7 @@ import '../../../../common/extensions'; import { asyncFilter } from '../../../../common/utils/arrayUtils'; import { traceError, traceInfo, traceVerbose } from '../../../../logging'; import { StopWatch } from '../../../../common/utils/stopWatch'; +import { untildify } from '../../../../common/helpers'; const DEFAULT_SEARCH_DEPTH = 2; /** diff --git a/src/client/pythonEnvironments/base/locators/lowLevel/microsoftStoreLocator.ts b/src/client/pythonEnvironments/base/locators/lowLevel/microsoftStoreLocator.ts index 60528bd939aa..2068a05f3a69 100644 --- a/src/client/pythonEnvironments/base/locators/lowLevel/microsoftStoreLocator.ts +++ b/src/client/pythonEnvironments/base/locators/lowLevel/microsoftStoreLocator.ts @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fsapi from 'fs-extra'; import * as minimatch from 'minimatch'; import * as path from 'path'; +import * as fsapi from '../../../../common/platform/fs-paths'; import { PythonEnvKind } from '../../info'; import { IPythonEnvsIterator, BasicEnvInfo } from '../../locator'; import { FSWatchingLocator } from './fsWatchingLocator'; @@ -35,7 +35,7 @@ const pythonExeGlob = 'python3.{[0-9],[0-9][0-9]}.exe'; * @returns {boolean} : Returns true if the path matches pattern for windows python executable. */ function isMicrosoftStorePythonExePattern(interpreterPath: string): boolean { - return minimatch(path.basename(interpreterPath), pythonExeGlob, { nocase: true }); + return minimatch.default(path.basename(interpreterPath), pythonExeGlob, { nocase: true }); } /** diff --git a/src/client/pythonEnvironments/common/environmentManagers/conda.ts b/src/client/pythonEnvironments/common/environmentManagers/conda.ts index 71f4242c3b99..bd4aba219416 100644 --- a/src/client/pythonEnvironments/common/environmentManagers/conda.ts +++ b/src/client/pythonEnvironments/common/environmentManagers/conda.ts @@ -1,6 +1,6 @@ -import * as fsapi from 'fs-extra'; import * as path from 'path'; import { lt, SemVer } from 'semver'; +import * as fsapi from '../../../common/platform/fs-paths'; import { getEnvironmentVariable, getOSType, getUserHomeDir, OSType } from '../../../common/utils/platform'; import { arePathsSame, diff --git a/src/client/pythonEnvironments/common/environmentManagers/simplevirtualenvs.ts b/src/client/pythonEnvironments/common/environmentManagers/simplevirtualenvs.ts index 78a018138e2b..0ad24252f341 100644 --- a/src/client/pythonEnvironments/common/environmentManagers/simplevirtualenvs.ts +++ b/src/client/pythonEnvironments/common/environmentManagers/simplevirtualenvs.ts @@ -1,8 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fsapi from 'fs-extra'; import * as path from 'path'; +import * as fsapi from '../../../common/platform/fs-paths'; import '../../../common/extensions'; import { splitLines } from '../../../common/stringUtils'; import { getEnvironmentVariable, getOSType, getUserHomeDir, OSType } from '../../../common/utils/platform'; diff --git a/src/client/pythonEnvironments/common/externalDependencies.ts b/src/client/pythonEnvironments/common/externalDependencies.ts index d6b774744a70..b0922f8bab06 100644 --- a/src/client/pythonEnvironments/common/externalDependencies.ts +++ b/src/client/pythonEnvironments/common/externalDependencies.ts @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fsapi from 'fs-extra'; import * as path from 'path'; import * as vscode from 'vscode'; +import * as fsapi from '../../common/platform/fs-paths'; import { IWorkspaceService } from '../../common/application/types'; import { ExecutionResult, IProcessServiceFactory, ShellOptions, SpawnOptions } from '../../common/process/types'; import { IDisposable, IConfigurationService, IExperimentService } from '../../common/types'; @@ -67,9 +67,6 @@ export function readFileSync(filePath: string): string { return fsapi.readFileSync(filePath, 'utf-8'); } -// eslint-disable-next-line global-require -export const untildify: (value: string) => string = require('untildify'); - /** * Returns true if given file path exists within the given parent directory, false otherwise. * @param filePath File path to check for @@ -161,7 +158,7 @@ export async function* getSubDirs( root: string, options?: { resolveSymlinks?: boolean }, ): AsyncIterableIterator { - const dirContents = await fsapi.promises.readdir(root, { withFileTypes: true }); + const dirContents = await fsapi.readdir(root, { withFileTypes: true }); const generators = dirContents.map((item) => { async function* generator() { const fullPath = path.join(root, item.name); diff --git a/src/client/pythonEnvironments/common/posixUtils.ts b/src/client/pythonEnvironments/common/posixUtils.ts index 0e79ec9d590e..8149706a5707 100644 --- a/src/client/pythonEnvironments/common/posixUtils.ts +++ b/src/client/pythonEnvironments/common/posixUtils.ts @@ -2,9 +2,9 @@ // Licensed under the MIT License. import * as fs from 'fs'; -import * as fsapi from 'fs-extra'; import * as path from 'path'; import { uniq } from 'lodash'; +import * as fsapi from '../../common/platform/fs-paths'; import { getSearchPathEntries } from '../../common/utils/exec'; import { resolveSymbolicLink } from './externalDependencies'; import { traceError, traceInfo, traceVerbose, traceWarn } from '../../logging'; diff --git a/src/client/pythonEnvironments/common/pythonBinariesWatcher.ts b/src/client/pythonEnvironments/common/pythonBinariesWatcher.ts index b3c5fba96cb0..efc7d56409c8 100644 --- a/src/client/pythonEnvironments/common/pythonBinariesWatcher.ts +++ b/src/client/pythonEnvironments/common/pythonBinariesWatcher.ts @@ -28,7 +28,7 @@ export function watchLocationForPythonBinaries( const [baseGlob] = resolvedGlob.split('/').slice(-1); function callbackClosure(type: FileChangeType, e: string) { traceVerbose('Received event', type, JSON.stringify(e), 'for baseglob', baseGlob); - const isMatch = minimatch(path.basename(e), baseGlob, { nocase: getOSType() === OSType.Windows }); + const isMatch = minimatch.default(path.basename(e), baseGlob, { nocase: getOSType() === OSType.Windows }); if (!isMatch) { // When deleting the file for some reason path to all directories leading up to python are reported // Skip those events @@ -39,6 +39,7 @@ export function watchLocationForPythonBinaries( return watchLocationForPattern(baseDir, resolvedGlob, callbackClosure); } +// eslint-disable-next-line no-shadow export enum PythonEnvStructure { Standard = 'standard', Flat = 'flat', diff --git a/src/client/pythonEnvironments/creation/common/commonUtils.ts b/src/client/pythonEnvironments/creation/common/commonUtils.ts index 9bb5e5318ecd..5d5ee8b0310a 100644 --- a/src/client/pythonEnvironments/creation/common/commonUtils.ts +++ b/src/client/pythonEnvironments/creation/common/commonUtils.ts @@ -1,8 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fs from 'fs-extra'; import * as path from 'path'; import { WorkspaceFolder } from 'vscode'; +import * as fs from '../../../common/platform/fs-paths'; import { Commands } from '../../../common/constants'; import { Common } from '../../../common/utils/localize'; import { executeCommand } from '../../../common/vscodeApis/commandApis'; diff --git a/src/client/pythonEnvironments/creation/common/createEnvTriggerUtils.ts b/src/client/pythonEnvironments/creation/common/createEnvTriggerUtils.ts index 0da5ba574118..f3c6ea58a25c 100644 --- a/src/client/pythonEnvironments/creation/common/createEnvTriggerUtils.ts +++ b/src/client/pythonEnvironments/creation/common/createEnvTriggerUtils.ts @@ -2,8 +2,8 @@ // Licensed under the MIT License. import * as path from 'path'; -import * as fsapi from 'fs-extra'; import { ConfigurationTarget, Uri, WorkspaceFolder } from 'vscode'; +import * as fsapi from '../../../common/platform/fs-paths'; import { getPipRequirementsFiles } from '../provider/venvUtils'; import { getExtension } from '../../../common/vscodeApis/extensionsApi'; import { PVSC_EXTENSION_ID } from '../../../common/constants'; diff --git a/src/client/pythonEnvironments/creation/common/workspaceSelection.ts b/src/client/pythonEnvironments/creation/common/workspaceSelection.ts index 72d34c62cc7c..3ebab1c67fb4 100644 --- a/src/client/pythonEnvironments/creation/common/workspaceSelection.ts +++ b/src/client/pythonEnvironments/creation/common/workspaceSelection.ts @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fsapi from 'fs-extra'; import * as path from 'path'; import { CancellationToken, QuickPickItem, WorkspaceFolder } from 'vscode'; +import * as fsapi from '../../../common/platform/fs-paths'; import { MultiStepAction, showErrorMessage, showQuickPickWithBack } from '../../../common/vscodeApis/windowApis'; import { getWorkspaceFolders } from '../../../common/vscodeApis/workspaceApis'; import { Common, CreateEnv } from '../../../common/utils/localize'; diff --git a/src/client/pythonEnvironments/creation/provider/venvDeleteUtils.ts b/src/client/pythonEnvironments/creation/provider/venvDeleteUtils.ts index 46a0adf0f228..9bd410c09f51 100644 --- a/src/client/pythonEnvironments/creation/provider/venvDeleteUtils.ts +++ b/src/client/pythonEnvironments/creation/provider/venvDeleteUtils.ts @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fs from 'fs-extra'; import * as path from 'path'; import { WorkspaceFolder } from 'vscode'; +import * as fs from '../../../common/platform/fs-paths'; import { traceError, traceInfo } from '../../../logging'; import { getVenvPath, showErrorMessageWithLogs } from '../common/commonUtils'; import { CreateEnv } from '../../../common/utils/localize'; diff --git a/src/client/pythonEnvironments/creation/provider/venvUtils.ts b/src/client/pythonEnvironments/creation/provider/venvUtils.ts index 94d20c674a3f..5a2c0bb8a2d3 100644 --- a/src/client/pythonEnvironments/creation/provider/venvUtils.ts +++ b/src/client/pythonEnvironments/creation/provider/venvUtils.ts @@ -2,7 +2,6 @@ // Licensed under the MIT License import * as tomljs from '@iarna/toml'; -import * as fs from 'fs-extra'; import { flatten, isArray } from 'lodash'; import * as path from 'path'; import { @@ -15,6 +14,7 @@ import { Uri, WorkspaceFolder, } from 'vscode'; +import * as fs from '../../../common/platform/fs-paths'; import { Common, CreateEnv } from '../../../common/utils/localize'; import { MultiStepAction, diff --git a/src/client/telemetry/importTracker.ts b/src/client/telemetry/importTracker.ts index 06991a815140..48b20f053453 100644 --- a/src/client/telemetry/importTracker.ts +++ b/src/client/telemetry/importTracker.ts @@ -49,7 +49,7 @@ const testExecution = isTestExecution(); export class ImportTracker implements IExtensionSingleActivationService { public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: true }; - private pendingChecks = new Map(); + private pendingChecks = new Map(); private static sentMatches: Set = new Set(); diff --git a/src/client/tensorBoard/tensorBoardSession.ts b/src/client/tensorBoard/tensorBoardSession.ts index fb54ad6f32e6..13e5e66e0a30 100644 --- a/src/client/tensorBoard/tensorBoardSession.ts +++ b/src/client/tensorBoard/tensorBoardSession.ts @@ -1,6 +1,5 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fs from 'fs-extra'; import { ChildProcess } from 'child_process'; import * as path from 'path'; import { @@ -24,6 +23,7 @@ import { window, workspace, } from 'vscode'; +import * as fs from '../common/platform/fs-paths'; import { IApplicationShell, ICommandManager, IWorkspaceService } from '../common/application/types'; import { createPromiseFromCancellation } from '../common/cancellation'; import { tensorboardLauncher } from '../common/process/internal/scripts'; diff --git a/src/client/terminals/envCollectionActivation/service.ts b/src/client/terminals/envCollectionActivation/service.ts index 8993007ce7c8..77e478b3577d 100644 --- a/src/client/terminals/envCollectionActivation/service.ts +++ b/src/client/terminals/envCollectionActivation/service.ts @@ -11,7 +11,7 @@ import { EnvironmentVariableMutatorOptions, ProgressLocation, } from 'vscode'; -import { pathExists } from 'fs-extra'; +import { pathExists, normCase } from '../../common/platform/fs-paths'; import { IExtensionActivationService } from '../../activation/types'; import { IApplicationShell, IApplicationEnvironment, IWorkspaceService } from '../../common/application/types'; import { inTerminalEnvVarExperiment } from '../../common/experiments/helpers'; @@ -35,7 +35,7 @@ import { getSearchPathEnvVarNames } from '../../common/utils/exec'; import { EnvironmentVariables, IEnvironmentVariablesProvider } from '../../common/variables/types'; import { TerminalShellType } from '../../common/terminal/types'; import { OSType } from '../../common/utils/platform'; -import { normCase } from '../../common/platform/fs-paths'; + import { PythonEnvType } from '../../pythonEnvironments/base/info'; import { IShellIntegrationService, ITerminalDeactivateService, ITerminalEnvVarCollectionService } from '../types'; import { ProgressService } from '../../common/application/progressService'; diff --git a/src/client/testing/testController/common/resultsHelper.ts b/src/client/testing/testController/common/resultsHelper.ts index 2fce78919766..6474c726e09c 100644 --- a/src/client/testing/testController/common/resultsHelper.ts +++ b/src/client/testing/testController/common/resultsHelper.ts @@ -1,8 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fsapi from 'fs-extra'; import { Location, TestItem, TestMessage, TestRun } from 'vscode'; +import * as fsapi from '../../../common/platform/fs-paths'; import { getRunIdFromRawData, getTestCaseNodes } from './testItemUtilities'; import { TestData } from './types'; import { fixLogLines } from './utils'; diff --git a/src/test/.vscode/settings.json b/src/test/.vscode/settings.json index faeb48ffa29c..cd2b4152591d 100644 --- a/src/test/.vscode/settings.json +++ b/src/test/.vscode/settings.json @@ -13,5 +13,6 @@ "python.linting.banditEnabled": false, // Don't set this to `Pylance`, for CI we want to use the LS that ships with the extension. "python.languageServer": "Jedi", - "python.pythonPath": "C:\\GIT\\s p\\vscode-python\\.venv\\Scripts\\python.exe" + "python.pythonPath": "C:\\GIT\\s p\\vscode-python\\.venv\\Scripts\\python.exe", + "python.defaultInterpreterPath": "python" } diff --git a/src/test/common.ts b/src/test/common.ts index bbf48f0e14c7..8c2512959bdf 100644 --- a/src/test/common.ts +++ b/src/test/common.ts @@ -5,7 +5,7 @@ // IMPORTANT: Do not import anything from the 'client' folder in this file as that folder is not available during smoke tests. import * as assert from 'assert'; -import * as fs from 'fs-extra'; +import * as fs from '../client/common/platform/fs-paths'; import * as glob from 'glob'; import * as path from 'path'; import { coerce, SemVer } from 'semver'; @@ -50,7 +50,7 @@ export type PythonSettingKeys = async function disposePythonSettings() { if (!IS_SMOKE_TEST) { - const configSettings = await import('../client/common/configSettings'); + const configSettings = await import('../client/common/configSettings.js'); configSettings.PythonSettings.dispose(); } } @@ -224,7 +224,7 @@ export async function deleteFile(file: string) { export async function deleteFiles(globPattern: string) { const items = await new Promise((resolve, reject) => { - glob(globPattern, (ex, files) => (ex ? reject(ex) : resolve(files))); + glob.default(globPattern, (ex, files) => (ex ? reject(ex) : resolve(files))); }); return Promise.all(items.map((item) => fs.remove(item).catch(noop))); @@ -292,7 +292,7 @@ export function correctPathForOsType(pathToCorrect: string, os?: OSType): string * @return `SemVer` version of the Python interpreter, or `undefined` if an error occurs. */ export async function getPythonSemVer(procService?: IProcessService): Promise { - const proc = await import('../client/common/process/proc'); + const proc = await import('../client/common/process/proc.js'); const pythonProcRunner = procService ? procService : new proc.ProcessService(); const pyVerArgs = ['-c', 'import sys;print("{0}.{1}.{2}".format(*sys.version_info[:3]))']; @@ -508,7 +508,7 @@ export async function openFile(file: string): Promise { const vscode = require('vscode') as typeof import('vscode'); const textDocument = await vscode.workspace.openTextDocument(file); await vscode.window.showTextDocument(textDocument); - assert(vscode.window.activeTextEditor, 'No active editor'); + assert.ok(vscode.window.activeTextEditor, 'No active editor'); return textDocument; } diff --git a/src/test/common/application/commands/reportIssueCommand.unit.test.ts b/src/test/common/application/commands/reportIssueCommand.unit.test.ts index 2a35a6306cd2..50701ecdf4c6 100644 --- a/src/test/common/application/commands/reportIssueCommand.unit.test.ts +++ b/src/test/common/application/commands/reportIssueCommand.unit.test.ts @@ -5,11 +5,11 @@ 'use strict'; import * as sinon from 'sinon'; -import * as fs from 'fs-extra'; import * as path from 'path'; import { anything, capture, instance, mock, verify, when } from 'ts-mockito'; import { expect } from 'chai'; import { WorkspaceFolder } from 'vscode-languageserver-protocol'; +import * as fs from '../../../../client/common/platform/fs-paths'; import * as Telemetry from '../../../../client/telemetry'; import { LanguageServerType } from '../../../../client/activation/types'; import { CommandManager } from '../../../../client/common/application/commandManager'; diff --git a/src/test/common/configSettings/configSettings.pythonPath.unit.test.ts b/src/test/common/configSettings/configSettings.pythonPath.unit.test.ts index b59ee34877a7..29082bb5854f 100644 --- a/src/test/common/configSettings/configSettings.pythonPath.unit.test.ts +++ b/src/test/common/configSettings/configSettings.pythonPath.unit.test.ts @@ -16,8 +16,7 @@ import { noop } from '../../../client/common/utils/misc'; import { PythonEnvironment } from '../../../client/pythonEnvironments/info'; import * as EnvFileTelemetry from '../../../client/telemetry/envFileTelemetry'; import { MockAutoSelectionService } from '../../mocks/autoSelector'; - -const untildify = require('untildify'); +import { untildify } from '../../../client/common/helpers'; suite('Python Settings - pythonPath', () => { class CustomPythonSettings extends PythonSettings { diff --git a/src/test/common/configSettings/configSettings.unit.test.ts b/src/test/common/configSettings/configSettings.unit.test.ts index c4389629e0ec..43fbf17e970e 100644 --- a/src/test/common/configSettings/configSettings.unit.test.ts +++ b/src/test/common/configSettings/configSettings.unit.test.ts @@ -8,7 +8,6 @@ import * as path from 'path'; import * as sinon from 'sinon'; import * as TypeMoq from 'typemoq'; -import untildify = require('untildify'); import { WorkspaceConfiguration } from 'vscode'; import { LanguageServerType } from '../../../client/activation/types'; import { IApplicationEnvironment } from '../../../client/common/application/types'; @@ -27,6 +26,7 @@ import * as EnvFileTelemetry from '../../../client/telemetry/envFileTelemetry'; import { ITestingSettings } from '../../../client/testing/configuration/types'; import { MockAutoSelectionService } from '../../mocks/autoSelector'; import { MockMemento } from '../../mocks/mementos'; +import { untildify } from '../../../client/common/helpers'; suite('Python Settings', async () => { class CustomPythonSettings extends PythonSettings { diff --git a/src/test/common/exitCIAfterTestReporter.ts b/src/test/common/exitCIAfterTestReporter.ts index a2350f26a943..cb04d3a90b38 100644 --- a/src/test/common/exitCIAfterTestReporter.ts +++ b/src/test/common/exitCIAfterTestReporter.ts @@ -7,7 +7,8 @@ // This is a hack, however for some reason the process running the tests do not exit. // The hack is to force it to die when tests are done, if this doesn't work we've got a bigger problem on our hands. -import * as fs from 'fs-extra'; +import * as fs from '../../client/common/platform/fs-paths'; + import * as net from 'net'; import * as path from 'path'; import { EXTENSION_ROOT_DIR_FOR_TESTS } from '../constants'; diff --git a/src/test/common/moduleInstaller.test.ts b/src/test/common/moduleInstaller.test.ts index 6d1d153aba94..0b900b97c4c0 100644 --- a/src/test/common/moduleInstaller.test.ts +++ b/src/test/common/moduleInstaller.test.ts @@ -1,7 +1,7 @@ import { expect, should as chaiShould, use as chaiUse } from 'chai'; import * as chaiAsPromised from 'chai-as-promised'; import { SemVer } from 'semver'; -import { instance, mock, when } from 'ts-mockito'; +import { instance, mock } from 'ts-mockito'; import * as TypeMoq from 'typemoq'; import { Uri } from 'vscode'; import { IExtensionSingleActivationService } from '../../client/activation/types'; @@ -101,8 +101,9 @@ import { MockModuleInstaller } from '../mocks/moduleInstaller'; import { MockProcessService } from '../mocks/proc'; import { UnitTestIocContainer } from '../testing/serviceRegistry'; import { closeActiveWindows, initializeTest } from '../initialize'; +import { createTypeMoq } from '../mocks/helper'; -chaiUse(chaiAsPromised); +chaiUse(chaiAsPromised.default); const info: PythonEnvironment = { architecture: Architecture.Unknown, @@ -149,8 +150,8 @@ suite('Module Installer', () => { ioc.serviceManager.addSingleton(IProcessLogger, ProcessLogger); ioc.serviceManager.addSingleton(IInstaller, ProductInstaller); - mockTerminalService = TypeMoq.Mock.ofType(); - mockTerminalFactory = TypeMoq.Mock.ofType(); + mockTerminalService = createTypeMoq(); + mockTerminalFactory = createTypeMoq(); // If resource is provided, then ensure we do not invoke without the resource. mockTerminalFactory .setup((t) => t.getTerminalService(TypeMoq.It.isAny())) @@ -160,11 +161,13 @@ suite('Module Installer', () => { ITerminalServiceFactory, mockTerminalFactory.object, ); - const activatedEnvironmentLaunch = mock(); - when(activatedEnvironmentLaunch.selectIfLaunchedViaActivatedEnv()).thenResolve(undefined); + const activatedEnvironmentLaunch = createTypeMoq(); + activatedEnvironmentLaunch + .setup((t) => t.selectIfLaunchedViaActivatedEnv()) + .returns(() => Promise.resolve(undefined)); ioc.serviceManager.addSingletonInstance( IActivatedEnvironmentLaunch, - instance(activatedEnvironmentLaunch), + activatedEnvironmentLaunch.object, ); ioc.serviceManager.addSingleton(IModuleInstaller, PipInstaller); ioc.serviceManager.addSingleton(IModuleInstaller, CondaInstaller); @@ -182,10 +185,10 @@ suite('Module Installer', () => { ioc.serviceManager.addSingletonInstance(IsWindows, false); await ioc.registerMockInterpreterTypes(); - condaService = TypeMoq.Mock.ofType(); - condaLocatorService = TypeMoq.Mock.ofType(); + condaService = createTypeMoq(); + condaLocatorService = createTypeMoq(); ioc.serviceManager.rebindInstance(ICondaService, condaService.object); - interpreterService = TypeMoq.Mock.ofType(); + interpreterService = createTypeMoq(); ioc.serviceManager.rebindInstance(IInterpreterService, interpreterService.object); ioc.serviceManager.addSingleton(IActiveResourceService, ActiveResourceService); @@ -267,10 +270,8 @@ suite('Module Installer', () => { new MockModuleInstaller('mock', true), ); ioc.serviceManager.addSingletonInstance(ITerminalHelper, instance(mock(TerminalHelper))); - - const processService = (await ioc.serviceContainer - .get(IProcessServiceFactory) - .create()) as MockProcessService; + const factory = ioc.serviceManager.get(IProcessServiceFactory); + const processService = (await factory.create()) as MockProcessService; processService.onExec((file, args, _options, callback) => { if (args.length > 1 && args[0] === '-c' && args[1] === 'import pip') { callback({ stdout: '' }); @@ -321,13 +322,13 @@ suite('Module Installer', () => { await expect(pipInstaller.isSupported()).to.eventually.equal(true, 'Pip is not supported'); }); test('Ensure conda is supported', async () => { - const serviceContainer = TypeMoq.Mock.ofType(); + const serviceContainer = createTypeMoq(); - const configService = TypeMoq.Mock.ofType(); + const configService = createTypeMoq(); serviceContainer .setup((c) => c.get(TypeMoq.It.isValue(IConfigurationService))) .returns(() => configService.object); - const settings = TypeMoq.Mock.ofType(); + const settings = createTypeMoq(); const pythonPath = 'pythonABC'; settings.setup((s) => s.pythonPath).returns(() => pythonPath); configService.setup((c) => c.getSettings(TypeMoq.It.isAny())).returns(() => settings.object); @@ -347,13 +348,13 @@ suite('Module Installer', () => { await expect(condaInstaller.isSupported()).to.eventually.equal(true, 'Conda is not supported'); }); test('Ensure conda is not supported even if conda is available', async () => { - const serviceContainer = TypeMoq.Mock.ofType(); + const serviceContainer = createTypeMoq(); - const configService = TypeMoq.Mock.ofType(); + const configService = createTypeMoq(); serviceContainer .setup((c) => c.get(TypeMoq.It.isValue(IConfigurationService))) .returns(() => configService.object); - const settings = TypeMoq.Mock.ofType(); + const settings = createTypeMoq(); const pythonPath = 'pythonABC'; settings.setup((s) => s.pythonPath).returns(() => pythonPath); configService.setup((c) => c.getSettings(TypeMoq.It.isAny())).returns(() => settings.object); diff --git a/src/test/common/platform/filesystem.functional.test.ts b/src/test/common/platform/filesystem.functional.test.ts index 542af602f583..be9a369935f3 100644 --- a/src/test/common/platform/filesystem.functional.test.ts +++ b/src/test/common/platform/filesystem.functional.test.ts @@ -2,9 +2,8 @@ // Licensed under the MIT License. import { expect, use } from 'chai'; -import * as fs from 'fs-extra'; import { convertStat, FileSystem, FileSystemUtils, RawFileSystem } from '../../../client/common/platform/fileSystem'; -import { FileSystemPaths, FileSystemPathUtils } from '../../../client/common/platform/fs-paths'; +import * as fs from '../../../client/common/platform/fs-paths'; import { FileType } from '../../../client/common/platform/types'; import { createDeferred, sleep } from '../../../client/common/utils/async'; import { noop } from '../../../client/common/utils/misc'; @@ -137,7 +136,7 @@ suite('FileSystem - raw', () => { await fileSystem.appendText(filename, dataToAppend); - const actual = await fs.readFile(filename, 'utf8'); + const actual = await fs.readFile(filename, { encoding: 'utf8' }); expect(actual).to.be.equal(expected); }); @@ -148,14 +147,14 @@ suite('FileSystem - raw', () => { await fileSystem.appendText(filename, dataToAppend); - const actual = await fs.readFile(filename, 'utf8'); + const actual = await fs.readFile(filename, { encoding: 'utf8' }); expect(actual).to.be.equal(expected); }); test('creates the file if it does not already exist', async () => { await fileSystem.appendText(DOES_NOT_EXIST, 'spam'); - const actual = await fs.readFile(DOES_NOT_EXIST, 'utf8'); + const actual = await fs.readFile(DOES_NOT_EXIST, { encoding: 'utf8' }); expect(actual).to.be.equal('spam'); }); @@ -497,8 +496,8 @@ suite('FileSystem', () => { }); suite('path-related', () => { - const paths = FileSystemPaths.withDefaults(); - const pathUtils = FileSystemPathUtils.withDefaults(paths); + const paths = fs.FileSystemPaths.withDefaults(); + const pathUtils = fs.FileSystemPathUtils.withDefaults(paths); suite('directorySeparatorChar', () => { // tested fully in the FileSystemPaths tests. @@ -536,7 +535,7 @@ suite('FileSystem', () => { await fileSystem.appendFile(filename, dataToAppend); - const actual = await fs.readFile(filename, 'utf8'); + const actual = await fs.readFile(filename, { encoding: 'utf8' }); expect(actual).to.be.equal(expected); }); }); diff --git a/src/test/common/platform/filesystem.test.ts b/src/test/common/platform/filesystem.test.ts index a95b96af8d14..a1afab02d1fe 100644 --- a/src/test/common/platform/filesystem.test.ts +++ b/src/test/common/platform/filesystem.test.ts @@ -2,7 +2,7 @@ // Licensed under the MIT License. import { expect } from 'chai'; -import * as fsextra from 'fs-extra'; +import * as fsextra from '../../../client/common/platform/fs-paths'; import * as path from 'path'; import { convertStat, FileSystem, FileSystemUtils, RawFileSystem } from '../../../client/common/platform/fileSystem'; import { FileType, IFileSystem, IFileSystemUtils, IRawFileSystem } from '../../../client/common/platform/types'; diff --git a/src/test/common/platform/filesystem.unit.test.ts b/src/test/common/platform/filesystem.unit.test.ts index 8c54b0c08ab7..f012cb9fb27e 100644 --- a/src/test/common/platform/filesystem.unit.test.ts +++ b/src/test/common/platform/filesystem.unit.test.ts @@ -3,7 +3,7 @@ import { expect } from 'chai'; import * as fs from 'fs'; -import * as fsextra from 'fs-extra'; +import * as fsextra from '../../../client/common/platform/fs-paths'; import * as TypeMoq from 'typemoq'; import * as vscode from 'vscode'; import { FileSystemUtils, RawFileSystem } from '../../../client/common/platform/fileSystem'; diff --git a/src/test/common/platform/fs-temp.functional.test.ts b/src/test/common/platform/fs-temp.functional.test.ts index 9fb4fe189b96..67bca3338e76 100644 --- a/src/test/common/platform/fs-temp.functional.test.ts +++ b/src/test/common/platform/fs-temp.functional.test.ts @@ -2,7 +2,7 @@ // Licensed under the MIT License. import { expect, use } from 'chai'; -import * as fs from 'fs-extra'; +import * as fs from '../../../client/common/platform/fs-paths'; import { TemporaryFileSystem } from '../../../client/common/platform/fs-temp'; import { TemporaryFile } from '../../../client/common/platform/types'; import { assertDoesNotExist, assertExists, FSFixture } from './utils'; diff --git a/src/test/common/platform/platformService.functional.test.ts b/src/test/common/platform/platformService.functional.test.ts index 3c2042807ab8..9f16a6ebf386 100644 --- a/src/test/common/platform/platformService.functional.test.ts +++ b/src/test/common/platform/platformService.functional.test.ts @@ -10,7 +10,7 @@ import { parse } from 'semver'; import { PlatformService } from '../../../client/common/platform/platformService'; import { OSType } from '../../../client/common/utils/platform'; -use(chaiAsPromised); +use(chaiAsPromised.default); suite('PlatformService', () => { const osType = getOSType(); diff --git a/src/test/common/platform/utils.ts b/src/test/common/platform/utils.ts index cc30ad84b8b9..881e3cd019b9 100644 --- a/src/test/common/platform/utils.ts +++ b/src/test/common/platform/utils.ts @@ -2,7 +2,7 @@ // Licensed under the MIT License. import { expect } from 'chai'; -import * as fsextra from 'fs-extra'; +import * as fsextra from '../../../client/common/platform/fs-paths'; import * as net from 'net'; import * as path from 'path'; import * as tmpMod from 'tmp'; diff --git a/src/test/common/process/logger.unit.test.ts b/src/test/common/process/logger.unit.test.ts index ebce120b7e6c..f1421ea58b85 100644 --- a/src/test/common/process/logger.unit.test.ts +++ b/src/test/common/process/logger.unit.test.ts @@ -7,19 +7,19 @@ import * as path from 'path'; import * as sinon from 'sinon'; import * as TypeMoq from 'typemoq'; -import untildify = require('untildify'); import { WorkspaceFolder } from 'vscode'; import { IWorkspaceService } from '../../../client/common/application/types'; import { ProcessLogger } from '../../../client/common/process/logger'; import { getOSType, OSType } from '../../../client/common/utils/platform'; import * as logging from '../../../client/logging'; +import { untildify } from '../../../client/common/helpers'; suite('ProcessLogger suite', () => { let workspaceService: TypeMoq.IMock; let logger: ProcessLogger; let traceLogStub: sinon.SinonStub; - suiteSetup(() => { + suiteSetup(async () => { workspaceService = TypeMoq.Mock.ofType(); workspaceService .setup((w) => w.workspaceFolders) diff --git a/src/test/common/process/proc.exec.test.ts b/src/test/common/process/proc.exec.test.ts index 7e771e884b82..21351d811b63 100644 --- a/src/test/common/process/proc.exec.test.ts +++ b/src/test/common/process/proc.exec.test.ts @@ -13,7 +13,7 @@ import { isOs, isPythonVersion } from '../../common'; import { getExtensionSettings } from '../../extensionSettings'; import { initialize } from './../../initialize'; -use(chaiAsPromised); +use(chaiAsPromised.default); suite('ProcessService Observable', () => { let pythonPath: string; diff --git a/src/test/common/process/proc.observable.test.ts b/src/test/common/process/proc.observable.test.ts index 74a613f0ec1d..debae38cc6eb 100644 --- a/src/test/common/process/proc.observable.test.ts +++ b/src/test/common/process/proc.observable.test.ts @@ -10,7 +10,7 @@ import { isOs, OSType } from '../../common'; import { getExtensionSettings } from '../../extensionSettings'; import { initialize } from './../../initialize'; -use(chaiAsPromised); +use(chaiAsPromised.default); suite('ProcessService', () => { let pythonPath: string; diff --git a/src/test/common/process/pythonEnvironment.unit.test.ts b/src/test/common/process/pythonEnvironment.unit.test.ts index 49faa91e2aaf..f4b11bb97cd5 100644 --- a/src/test/common/process/pythonEnvironment.unit.test.ts +++ b/src/test/common/process/pythonEnvironment.unit.test.ts @@ -17,7 +17,7 @@ import { Architecture } from '../../../client/common/utils/platform'; import { Conda } from '../../../client/pythonEnvironments/common/environmentManagers/conda'; import { OUTPUT_MARKER_SCRIPT } from '../../../client/common/process/internal/scripts'; -use(chaiAsPromised); +use(chaiAsPromised.default); suite('PythonEnvironment', () => { let processService: TypeMoq.IMock; diff --git a/src/test/common/process/pythonProc.simple.multiroot.test.ts b/src/test/common/process/pythonProc.simple.multiroot.test.ts index 5089af8b5eb3..fc4fbf5328a9 100644 --- a/src/test/common/process/pythonProc.simple.multiroot.test.ts +++ b/src/test/common/process/pythonProc.simple.multiroot.test.ts @@ -6,9 +6,9 @@ import { expect, use } from 'chai'; import * as chaiAsPromised from 'chai-as-promised'; import { execFile } from 'child_process'; -import * as fs from 'fs-extra'; import * as path from 'path'; import { ConfigurationTarget, Uri } from 'vscode'; +import * as fs from '../../../client/common/platform/fs-paths'; import { IPythonExecutionFactory, StdErrError } from '../../../client/common/process/types'; import { IConfigurationService } from '../../../client/common/types'; import { clearCache } from '../../../client/common/utils/cacheUtils'; @@ -18,7 +18,7 @@ import { clearPythonPathInWorkspaceFolder } from '../../common'; import { getExtensionSettings } from '../../extensionSettings'; import { closeActiveWindows, initialize, initializeTest, IS_MULTI_ROOT_TEST, TEST_TIMEOUT } from '../../initialize'; -use(chaiAsPromised); +use(chaiAsPromised.default); const multirootPath = path.join(__dirname, '..', '..', '..', '..', 'src', 'testMultiRootWkspc'); const workspace4Path = Uri.file(path.join(multirootPath, 'workspace4')); diff --git a/src/test/common/process/pythonProcess.unit.test.ts b/src/test/common/process/pythonProcess.unit.test.ts index d799e08b08b5..7382fc9f9869 100644 --- a/src/test/common/process/pythonProcess.unit.test.ts +++ b/src/test/common/process/pythonProcess.unit.test.ts @@ -10,7 +10,7 @@ import { createPythonProcessService } from '../../../client/common/process/pytho import { IProcessService, StdErrError } from '../../../client/common/process/types'; import { noop } from '../../core'; -use(chaiAsPromised); +use(chaiAsPromised.default); suite('PythonProcessService', () => { let processService: TypeMoq.IMock; diff --git a/src/test/common/process/pythonToolService.unit.test.ts b/src/test/common/process/pythonToolService.unit.test.ts index 59733f8a5e8d..bef199ce223a 100644 --- a/src/test/common/process/pythonToolService.unit.test.ts +++ b/src/test/common/process/pythonToolService.unit.test.ts @@ -24,7 +24,7 @@ import { ExecutionInfo } from '../../../client/common/types'; import { ServiceContainer } from '../../../client/ioc/container'; import { noop } from '../../core'; -use(chaiAsPromised); +use(chaiAsPromised.default); suite('Process - Python tool execution service', () => { const resource = Uri.parse('one'); diff --git a/src/test/common/serviceRegistry.unit.test.ts b/src/test/common/serviceRegistry.unit.test.ts index 8ba7b7faaa90..9a82681625d4 100644 --- a/src/test/common/serviceRegistry.unit.test.ts +++ b/src/test/common/serviceRegistry.unit.test.ts @@ -127,7 +127,7 @@ suite('Common - Service Registry', () => { .setup((s) => s.addSingleton( typemoq.It.isValue(mapping[0] as any), - typemoq.It.is((value) => mapping[1] === value), + typemoq.It.is((value: any) => mapping[1] === value), ), ) .verifiable(typemoq.Times.atLeastOnce()); diff --git a/src/test/common/socketCallbackHandler.test.ts b/src/test/common/socketCallbackHandler.test.ts index 4f4587077f79..5fbac0083125 100644 --- a/src/test/common/socketCallbackHandler.test.ts +++ b/src/test/common/socketCallbackHandler.test.ts @@ -189,7 +189,7 @@ suite('SocketCallbackHandler', () => { expect(port).to.be.greaterThan(0); }); test('Succesfully starts with specific port', async () => { - const availablePort = await getFreePort({ host: 'localhost' }); + const availablePort = await getFreePort.default({ host: 'localhost' }); const port = await socketServer.Start({ port: availablePort, host: 'localhost' }); expect(port).to.be.equal(availablePort); }); @@ -311,7 +311,7 @@ suite('SocketCallbackHandler', () => { }); test('Succesful Handshake with specific port', async () => { const availablePort = await new Promise((resolve, reject) => - getFreePort({ host: 'localhost' }).then(resolve, reject), + getFreePort.default({ host: 'localhost' }).then(resolve, reject), ); const port = await socketServer.Start({ port: availablePort, host: 'localhost' }); diff --git a/src/test/common/terminals/environmentActivationProviders/terminalActivation.testvirtualenvs.ts b/src/test/common/terminals/environmentActivationProviders/terminalActivation.testvirtualenvs.ts index 58ae464d0113..5a5e65a9c0f2 100644 --- a/src/test/common/terminals/environmentActivationProviders/terminalActivation.testvirtualenvs.ts +++ b/src/test/common/terminals/environmentActivationProviders/terminalActivation.testvirtualenvs.ts @@ -4,7 +4,7 @@ 'use strict'; import { expect } from 'chai'; -import * as fs from 'fs-extra'; +import * as fs from '../../../../client/common/platform/fs-paths'; import * as path from 'path'; import * as sinon from 'sinon'; import * as vscode from 'vscode'; diff --git a/src/test/common/utils/decorators.unit.test.ts b/src/test/common/utils/decorators.unit.test.ts index 753434d0c4f8..ca8be4e9def1 100644 --- a/src/test/common/utils/decorators.unit.test.ts +++ b/src/test/common/utils/decorators.unit.test.ts @@ -8,7 +8,7 @@ import * as chaiPromise from 'chai-as-promised'; import { clearCache } from '../../../client/common/utils/cacheUtils'; import { cache, makeDebounceAsyncDecorator, makeDebounceDecorator } from '../../../client/common/utils/decorators'; import { sleep } from '../../core'; -use(chaiPromise); +use(chaiPromise.default); suite('Common Utils - Decorators', function () { // For some reason, sometimes we have timeouts on CI. diff --git a/src/test/common/variables/envVarsProvider.multiroot.test.ts b/src/test/common/variables/envVarsProvider.multiroot.test.ts index ccdca42c54a0..e558bf8b1efc 100644 --- a/src/test/common/variables/envVarsProvider.multiroot.test.ts +++ b/src/test/common/variables/envVarsProvider.multiroot.test.ts @@ -23,7 +23,7 @@ import { MockAutoSelectionService } from '../../mocks/autoSelector'; import { MockProcess } from '../../mocks/process'; import { UnitTestIocContainer } from '../../testing/serviceRegistry'; -use(chaiAsPromised); +use(chaiAsPromised.default); const multirootPath = path.join(__dirname, '..', '..', '..', '..', 'src', 'testMultiRootWkspc'); const workspace4Path = Uri.file(path.join(multirootPath, 'workspace4')); diff --git a/src/test/common/variables/envVarsService.functional.test.ts b/src/test/common/variables/envVarsService.functional.test.ts index 0886bc823960..3cf55eddbd45 100644 --- a/src/test/common/variables/envVarsService.functional.test.ts +++ b/src/test/common/variables/envVarsService.functional.test.ts @@ -13,7 +13,7 @@ import { EnvironmentVariablesService } from '../../../client/common/variables/en import { IEnvironmentVariablesService } from '../../../client/common/variables/types'; import { getOSType } from '../../common'; -use(chaiAsPromised); +use(chaiAsPromised.default); // Functional tests that run code using the VS Code API are found // in envVarsService.test.ts. diff --git a/src/test/common/variables/envVarsService.test.ts b/src/test/common/variables/envVarsService.test.ts index f289d291ac19..c7151a8e33b9 100644 --- a/src/test/common/variables/envVarsService.test.ts +++ b/src/test/common/variables/envVarsService.test.ts @@ -14,7 +14,7 @@ import { EnvironmentVariablesService } from '../../../client/common/variables/en import { IEnvironmentVariablesService } from '../../../client/common/variables/types'; import { getOSType } from '../../common'; -use(chaiAsPromised); +use(chaiAsPromised.default); const envFilesFolderPath = path.join(__dirname, '..', '..', '..', '..', 'src', 'testMultiRootWkspc', 'workspace4'); diff --git a/src/test/common/variables/envVarsService.unit.test.ts b/src/test/common/variables/envVarsService.unit.test.ts index 0c978b2f9e86..3709d97b9f62 100644 --- a/src/test/common/variables/envVarsService.unit.test.ts +++ b/src/test/common/variables/envVarsService.unit.test.ts @@ -12,7 +12,7 @@ import { IPathUtils } from '../../../client/common/types'; import { EnvironmentVariablesService, parseEnvFile } from '../../../client/common/variables/environment'; import { getSearchPathEnvVarNames } from '../../../client/common/utils/exec'; -use(chaiAsPromised); +use(chaiAsPromised.default); type PathVar = 'Path' | 'PATH'; const PATHS = getSearchPathEnvVarNames(); diff --git a/src/test/configuration/interpreterSelector/commands/setInterpreter.unit.test.ts b/src/test/configuration/interpreterSelector/commands/setInterpreter.unit.test.ts index 1871a1b46874..5737a2e416c5 100644 --- a/src/test/configuration/interpreterSelector/commands/setInterpreter.unit.test.ts +++ b/src/test/configuration/interpreterSelector/commands/setInterpreter.unit.test.ts @@ -47,8 +47,7 @@ import { Commands, Octicons } from '../../../../client/common/constants'; import { IInterpreterService, PythonEnvironmentsChangedEvent } from '../../../../client/interpreter/contracts'; import { createDeferred, sleep } from '../../../../client/common/utils/async'; import { SystemVariables } from '../../../../client/common/variables/systemVariables'; - -const untildify = require('untildify'); +import { untildify } from '../../../../client/common/helpers'; type TelemetryEventType = { eventName: EventName; properties: unknown }; @@ -277,7 +276,7 @@ suite('Set Interpreter Command', () => { >); assert.deepStrictEqual(activeItem, recommended); } else { - assert(false, 'Not a function'); + assert.ok(false, 'Not a function'); } delete actualParameters!.activeItem; assert.deepStrictEqual(actualParameters, expectedParameters, 'Params not equal'); @@ -331,7 +330,7 @@ suite('Set Interpreter Command', () => { >); assert.deepStrictEqual(activeItem, recommended); } else { - assert(false, 'Not a function'); + assert.ok(false, 'Not a function'); } delete actualParameters!.activeItem; assert.deepStrictEqual(actualParameters, expectedParameters, 'Params not equal'); @@ -381,7 +380,7 @@ suite('Set Interpreter Command', () => { >); assert.deepStrictEqual(activeItem, noPythonInstalled); } else { - assert(false, 'Not a function'); + assert.ok(false, 'Not a function'); } delete actualParameters!.activeItem; assert.deepStrictEqual(actualParameters, expectedParameters, 'Params not equal'); @@ -753,7 +752,7 @@ suite('Set Interpreter Command', () => { >); assert.deepStrictEqual(activeItem, recommended); } else { - assert(false, 'Not a function'); + assert.ok(false, 'Not a function'); } delete actualParameters!.activeItem; @@ -972,7 +971,7 @@ suite('Set Interpreter Command', () => { // eslint-disable-next-line @typescript-eslint/no-explicit-any await step!(multiStepInput.object as any, state); - assert( + assert.ok( _enterOrBrowseInterpreterPath.calledOnceWith(multiStepInput.object, { path: undefined, workspace: undefined, @@ -1523,9 +1522,9 @@ suite('Set Interpreter Command', () => { expect(inputStep).to.not.equal(undefined, ''); - assert(pickInterpreter.notCalled); + assert.ok(pickInterpreter.notCalled); await inputStep(); - assert(pickInterpreter.calledOnce); + assert.ok(pickInterpreter.calledOnce); }); }); }); diff --git a/src/test/debugger/envVars.test.ts b/src/test/debugger/envVars.test.ts index c043146fe53d..ae21c7fd5d49 100644 --- a/src/test/debugger/envVars.test.ts +++ b/src/test/debugger/envVars.test.ts @@ -17,7 +17,7 @@ import { closeActiveWindows, initialize, initializeTest, IS_MULTI_ROOT_TEST, TES import { UnitTestIocContainer } from '../testing/serviceRegistry'; import { normCase } from '../../client/common/platform/fs-paths'; -use(chaiAsPromised); +use(chaiAsPromised.default); suite('Resolving Environment Variables when Debugging', () => { let ioc: UnitTestIocContainer; diff --git a/src/test/debugger/extension/adapter/adapter.test.ts b/src/test/debugger/extension/adapter/adapter.test.ts index dd0e9d560bca..cd53b41102ab 100644 --- a/src/test/debugger/extension/adapter/adapter.test.ts +++ b/src/test/debugger/extension/adapter/adapter.test.ts @@ -4,7 +4,7 @@ 'use strict'; import { expect } from 'chai'; -import * as fs from 'fs-extra'; +import * as fs from '../../../../client/common/platform/fs-paths'; import * as path from 'path'; import * as vscode from 'vscode'; import { openFile } from '../../../common'; diff --git a/src/test/debugger/extension/adapter/factory.unit.test.ts b/src/test/debugger/extension/adapter/factory.unit.test.ts index 6204bb835479..fde87d930078 100644 --- a/src/test/debugger/extension/adapter/factory.unit.test.ts +++ b/src/test/debugger/extension/adapter/factory.unit.test.ts @@ -6,7 +6,7 @@ import * as assert from 'assert'; import { expect, use } from 'chai'; import * as chaiAsPromised from 'chai-as-promised'; -import * as fs from 'fs-extra'; +import * as fs from '../../../../client/common/platform/fs-paths'; import * as path from 'path'; import * as sinon from 'sinon'; import rewiremock from 'rewiremock'; @@ -30,7 +30,7 @@ import { ICommandManager } from '../../../../client/common/application/types'; import { CommandManager } from '../../../../client/common/application/commandManager'; import * as pythonDebugger from '../../../../client/debugger/pythonDebugger'; -use(chaiAsPromised); +use(chaiAsPromised.default); suite('Debugging - Adapter Factory', () => { let factory: IDebugAdapterDescriptorFactory; diff --git a/src/test/debugger/extension/adapter/outdatedDebuggerPrompt.unit.test.ts b/src/test/debugger/extension/adapter/outdatedDebuggerPrompt.unit.test.ts index 0ab094119a5c..9f9497317417 100644 --- a/src/test/debugger/extension/adapter/outdatedDebuggerPrompt.unit.test.ts +++ b/src/test/debugger/extension/adapter/outdatedDebuggerPrompt.unit.test.ts @@ -82,7 +82,7 @@ suite('Debugging - Outdated Debugger Prompt tests.', () => { // First call should show info once sinon.assert.calledOnce(showInformationMessageStub); - assert(prompter); + assert.ok(prompter); prompter!.onDidSendMessage!(ptvsdOutputEvent); // Can't use deferred promise here @@ -104,7 +104,7 @@ suite('Debugging - Outdated Debugger Prompt tests.', () => { const session = createSession(); const prompter = await promptFactory.createDebugAdapterTracker(session); - assert(prompter); + assert.ok(prompter); prompter!.onDidSendMessage!(ptvsdOutputEvent); await deferred.promise; @@ -130,7 +130,7 @@ suite('Debugging - Outdated Debugger Prompt tests.', () => { const session = createSession(); const prompter = await promptFactory.createDebugAdapterTracker(session); - assert(prompter); + assert.ok(prompter); prompter!.onDidSendMessage!(debugpyOutputEvent); // Can't use deferred promise here @@ -168,7 +168,7 @@ suite('Debugging - Outdated Debugger Prompt tests.', () => { const session = createSession(); const prompter = await promptFactory.createDebugAdapterTracker(session); - assert(prompter); + assert.ok(prompter); prompter!.onDidSendMessage!(message); // Can't use deferred promise here diff --git a/src/test/debugger/extension/configuration/launch.json/launchJsonReader.unit.test.ts b/src/test/debugger/extension/configuration/launch.json/launchJsonReader.unit.test.ts index 8ed19dc254aa..4241f3526f1a 100644 --- a/src/test/debugger/extension/configuration/launch.json/launchJsonReader.unit.test.ts +++ b/src/test/debugger/extension/configuration/launch.json/launchJsonReader.unit.test.ts @@ -4,10 +4,10 @@ 'use strict'; import * as sinon from 'sinon'; -import * as fs from 'fs-extra'; import * as path from 'path'; import { Uri } from 'vscode'; import { assert } from 'chai'; +import * as fs from '../../../../../client/common/platform/fs-paths'; import { getConfigurationsForWorkspace } from '../../../../../client/debugger/extension/configuration/launch.json/launchJsonReader'; import * as vscodeApis from '../../../../../client/common/vscodeApis/workspaceApis'; diff --git a/src/test/debugger/utils.ts b/src/test/debugger/utils.ts index 749adb359597..9ccb8958b660 100644 --- a/src/test/debugger/utils.ts +++ b/src/test/debugger/utils.ts @@ -4,7 +4,7 @@ 'use strict'; import { expect } from 'chai'; -import * as fs from 'fs-extra'; +import * as fs from '../../client/common/platform/fs-paths'; import * as path from 'path'; import * as vscode from 'vscode'; import { DebugProtocol } from 'vscode-debugprotocol'; diff --git a/src/test/fakeVSCFileSystemAPI.ts b/src/test/fakeVSCFileSystemAPI.ts index df5356a04919..1811f51dcd04 100644 --- a/src/test/fakeVSCFileSystemAPI.ts +++ b/src/test/fakeVSCFileSystemAPI.ts @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fsextra from 'fs-extra'; import * as path from 'path'; import { FileStat, FileType, Uri } from 'vscode'; +import * as fsextra from '../client/common/platform/fs-paths'; import { convertStat } from '../client/common/platform/fileSystem'; import { createDeferred } from '../client/common/utils/async'; diff --git a/src/test/fixtures.ts b/src/test/fixtures.ts index 2b7a5bd9e65d..fbd8c20c9659 100644 --- a/src/test/fixtures.ts +++ b/src/test/fixtures.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fs from 'fs-extra'; +import * as fs from '../client/common/platform/fs-paths'; import { sleep } from '../client/common/utils/async'; import { PYTHON_PATH } from './common'; import { Proc, spawn } from './proc'; diff --git a/src/test/index.ts b/src/test/index.ts index 60c730bffcf2..f528a7551220 100644 --- a/src/test/index.ts +++ b/src/test/index.ts @@ -107,7 +107,7 @@ function configure(): SetupOptions { */ function activatePythonExtensionScript() { const ex = new Error('Failed to initialize Python extension for tests after 3 minutes'); - let timer: NodeJS.Timer | undefined; + let timer: NodeJS.Timeout | undefined; const failed = new Promise((_, reject) => { timer = setTimeout(() => reject(ex), MAX_EXTENSION_ACTIVATION_TIME); }); @@ -127,7 +127,7 @@ function activatePythonExtensionScript() { */ export async function run(): Promise { const options = configure(); - const mocha = new Mocha(options); + const mocha = new Mocha.default(options); const testsRoot = path.join(__dirname); // Enable source map support. @@ -136,7 +136,7 @@ export async function run(): Promise { // Ignore `ds.test.js` test files when running other tests. const ignoreGlob = options.testFilesSuffix.toLowerCase() === 'ds.test' ? [] : ['**/**.ds.test.js']; const testFiles = await new Promise((resolve, reject) => { - glob( + glob.default( `**/**.${options.testFilesSuffix}.js`, { ignore: ['**/**.unit.test.js', '**/**.functional.test.js'].concat(ignoreGlob), cwd: testsRoot }, (error, files) => { diff --git a/src/test/initialize.ts b/src/test/initialize.ts index 9c3f0ac387a7..0ed75a0aa5c1 100644 --- a/src/test/initialize.ts +++ b/src/test/initialize.ts @@ -38,7 +38,7 @@ export async function initialize(): Promise { const api = await activateExtension(); if (!IS_SMOKE_TEST) { // When running smoke tests, we won't have access to these. - const configSettings = await import('../client/common/configSettings'); + const configSettings = await import('../client/common/configSettings.js'); // Dispose any cached python settings (used only in test env). configSettings.PythonSettings.dispose(); } @@ -58,7 +58,7 @@ export async function initializeTest(): Promise { await closeActiveWindows(); if (!IS_SMOKE_TEST) { // When running smoke tests, we won't have access to these. - const configSettings = await import('../client/common/configSettings'); + const configSettings = await import('../client/common/configSettings.js'); // Dispose any cached python settings (used only in test env). configSettings.PythonSettings.dispose(); } diff --git a/src/test/install/channelManager.channels.test.ts b/src/test/install/channelManager.channels.test.ts index 0d8190f046a3..e43fa21daf17 100644 --- a/src/test/install/channelManager.channels.test.ts +++ b/src/test/install/channelManager.channels.test.ts @@ -16,6 +16,7 @@ import { ServiceContainer } from '../../client/ioc/container'; import { ServiceManager } from '../../client/ioc/serviceManager'; import { IServiceContainer } from '../../client/ioc/types'; import { MockAutoSelectionService } from '../mocks/autoSelector'; +import { createTypeMoq } from '../mocks/helper'; suite('Installation - installation channels', () => { let serviceManager: ServiceManager; @@ -71,7 +72,7 @@ suite('Installation - installation channels', () => { const installer1 = mockInstaller(true, '1'); const installer2 = mockInstaller(true, '2'); - const appShell = TypeMoq.Mock.ofType(); + const appShell = createTypeMoq(); serviceManager.addSingletonInstance(IApplicationShell, appShell.object); // eslint-disable-next-line @typescript-eslint/no-explicit-any @@ -98,7 +99,7 @@ suite('Installation - installation channels', () => { }); function mockInstaller(supported: boolean, name: string, priority?: number): TypeMoq.IMock { - const installer = TypeMoq.Mock.ofType(); + const installer = createTypeMoq(); installer .setup((x) => x.isSupported(TypeMoq.It.isAny())) .returns( diff --git a/src/test/install/channelManager.messages.test.ts b/src/test/install/channelManager.messages.test.ts index 326ba1ad4bfd..1e9953b8b753 100644 --- a/src/test/install/channelManager.messages.test.ts +++ b/src/test/install/channelManager.messages.test.ts @@ -21,6 +21,7 @@ import { ServiceManager } from '../../client/ioc/serviceManager'; import { IServiceContainer } from '../../client/ioc/types'; import { EnvironmentType, PythonEnvironment } from '../../client/pythonEnvironments/info'; import { MockAutoSelectionService } from '../mocks/autoSelector'; +import { createTypeMoq } from '../mocks/helper'; const info: PythonEnvironment = { architecture: Architecture.Unknown, @@ -45,16 +46,16 @@ suite('Installation - channel messages', () => { const serviceManager = new ServiceManager(cont); serviceContainer = new ServiceContainer(cont); - platform = TypeMoq.Mock.ofType(); + platform = createTypeMoq(); serviceManager.addSingletonInstance(IPlatformService, platform.object); - appShell = TypeMoq.Mock.ofType(); + appShell = createTypeMoq(); serviceManager.addSingletonInstance(IApplicationShell, appShell.object); - interpreters = TypeMoq.Mock.ofType(); + interpreters = createTypeMoq(); serviceManager.addSingletonInstance(IInterpreterService, interpreters.object); - const moduleInstaller = TypeMoq.Mock.ofType(); + const moduleInstaller = createTypeMoq(); serviceManager.addSingletonInstance(IModuleInstaller, moduleInstaller.object); serviceManager.addSingleton( IInterpreterAutoSelectionService, diff --git a/src/test/interpreters/interpreterService.unit.test.ts b/src/test/interpreters/interpreterService.unit.test.ts index d8a0ada23a6f..81a6a014a7e0 100644 --- a/src/test/interpreters/interpreterService.unit.test.ts +++ b/src/test/interpreters/interpreterService.unit.test.ts @@ -36,10 +36,11 @@ import { ServiceManager } from '../../client/ioc/serviceManager'; import { PYTHON_PATH } from '../common'; import { MockAutoSelectionService } from '../mocks/autoSelector'; import * as proposedApi from '../../client/environmentApi'; +import { createTypeMoq } from '../mocks/helper'; /* eslint-disable @typescript-eslint/no-explicit-any */ -use(chaiAsPromised); +use(chaiAsPromised.default); suite('Interpreters service', () => { let serviceManager: ServiceManager; @@ -67,23 +68,23 @@ suite('Interpreters service', () => { serviceManager = new ServiceManager(cont); serviceContainer = new ServiceContainer(cont); - interpreterPathService = TypeMoq.Mock.ofType(); - updater = TypeMoq.Mock.ofType(); - pyenvs = TypeMoq.Mock.ofType(); - helper = TypeMoq.Mock.ofType(); - workspace = TypeMoq.Mock.ofType(); - config = TypeMoq.Mock.ofType(); - fileSystem = TypeMoq.Mock.ofType(); - interpreterDisplay = TypeMoq.Mock.ofType(); - persistentStateFactory = TypeMoq.Mock.ofType(); - pythonExecutionFactory = TypeMoq.Mock.ofType(); - pythonExecutionService = TypeMoq.Mock.ofType(); - configService = TypeMoq.Mock.ofType(); - installer = TypeMoq.Mock.ofType(); - appShell = TypeMoq.Mock.ofType(); - experiments = TypeMoq.Mock.ofType(); - - pythonSettings = TypeMoq.Mock.ofType(); + interpreterPathService = createTypeMoq(); + updater = createTypeMoq(); + pyenvs = createTypeMoq(); + helper = createTypeMoq(); + workspace = createTypeMoq(); + config = createTypeMoq(); + fileSystem = createTypeMoq(); + interpreterDisplay = createTypeMoq(); + persistentStateFactory = createTypeMoq(); + pythonExecutionFactory = createTypeMoq(); + pythonExecutionService = createTypeMoq(); + configService = createTypeMoq(); + installer = createTypeMoq(); + appShell = createTypeMoq(); + experiments = createTypeMoq(); + + pythonSettings = createTypeMoq(); pythonSettings.setup((s) => s.pythonPath).returns(() => PYTHON_PATH); configService.setup((c) => c.getSettings(TypeMoq.It.isAny())).returns(() => pythonSettings.object); @@ -166,7 +167,7 @@ suite('Interpreters service', () => { test('Changes to active document should invoke interpreter.refresh method', async () => { const service = new InterpreterService(serviceContainer, pyenvs.object); - const documentManager = TypeMoq.Mock.ofType(); + const documentManager = createTypeMoq(); workspace.setup((w) => w.workspaceFolders).returns(() => [{ uri: '' }] as any); let activeTextEditorChangeHandler: (e: TextEditor | undefined) => any | undefined; @@ -179,9 +180,9 @@ suite('Interpreters service', () => { serviceManager.addSingletonInstance(IDocumentManager, documentManager.object); service.initialize(); - const textEditor = TypeMoq.Mock.ofType(); + const textEditor = createTypeMoq(); const uri = Uri.file(path.join('usr', 'file.py')); - const document = TypeMoq.Mock.ofType(); + const document = createTypeMoq(); textEditor.setup((t) => t.document).returns(() => document.object); document.setup((d) => d.uri).returns(() => uri); activeTextEditorChangeHandler!(textEditor.object); @@ -191,7 +192,7 @@ suite('Interpreters service', () => { test('If there is no active document then interpreter.refresh should not be invoked', async () => { const service = new InterpreterService(serviceContainer, pyenvs.object); - const documentManager = TypeMoq.Mock.ofType(); + const documentManager = createTypeMoq(); workspace.setup((w) => w.workspaceFolders).returns(() => [{ uri: '' }] as any); let activeTextEditorChangeHandler: (e?: TextEditor | undefined) => any | undefined; @@ -211,7 +212,7 @@ suite('Interpreters service', () => { test('Register the correct handler', async () => { const service = new InterpreterService(serviceContainer, pyenvs.object); - const documentManager = TypeMoq.Mock.ofType(); + const documentManager = createTypeMoq(); workspace.setup((w) => w.workspaceFolders).returns(() => [{ uri: '' }] as any); let interpreterPathServiceHandler: (e: InterpreterConfigurationScope) => any | undefined = () => 0; diff --git a/src/test/mocks/helper.ts b/src/test/mocks/helper.ts index 24d7a8290b18..d61bf728a25c 100644 --- a/src/test/mocks/helper.ts +++ b/src/test/mocks/helper.ts @@ -1,7 +1,11 @@ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-explicit-any */ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. - +import * as TypeMoq from 'typemoq'; import { Readable } from 'stream'; +// eslint-disable-next-line import/no-unresolved +import * as common from 'typemoq/Common/_all'; export class FakeReadableStream extends Readable { _read(_size: unknown): void | null { @@ -9,3 +13,16 @@ export class FakeReadableStream extends Readable { this.push(null); // end the stream } } + +export function createTypeMoq( + targetCtor?: common.CtorWithArgs, + behavior?: TypeMoq.MockBehavior, + shouldOverrideTarget?: boolean, + ...targetCtorArgs: any[] +): TypeMoq.IMock { + // Use typemoqs for those things that are resolved as promises. mockito doesn't allow nesting of mocks. ES6 Proxy class + // is the problem. We still need to make it thenable though. See this issue: https://github.com/florinn/typemoq/issues/67 + const result = TypeMoq.Mock.ofType(targetCtor, behavior, shouldOverrideTarget, ...targetCtorArgs); + result.setup((x: any) => x.then).returns(() => undefined); + return result; +} diff --git a/src/test/mocks/mockChildProcess.ts b/src/test/mocks/mockChildProcess.ts index c0a24b1c955f..e26ea1c7aa45 100644 --- a/src/test/mocks/mockChildProcess.ts +++ b/src/test/mocks/mockChildProcess.ts @@ -236,4 +236,8 @@ export class MockChildProcess extends EventEmitter { this.stdout?.destroy(); return true; } + + dispose(): void { + this.stdout?.destroy(); + } } diff --git a/src/test/mocks/process.ts b/src/test/mocks/process.ts index 3c1b339aff44..d290cae5bf71 100644 --- a/src/test/mocks/process.ts +++ b/src/test/mocks/process.ts @@ -4,9 +4,9 @@ 'use strict'; import { injectable } from 'inversify'; -import * as TypeMoq from 'typemoq'; import { ICurrentProcess } from '../../client/common/types'; import { EnvironmentVariables } from '../../client/common/variables/types'; +import { createTypeMoq } from './helper'; @injectable() export class MockProcess implements ICurrentProcess { @@ -24,12 +24,12 @@ export class MockProcess implements ICurrentProcess { // eslint-disable-next-line class-methods-use-this public get stdout(): NodeJS.WriteStream { - return TypeMoq.Mock.ofType().object; + return createTypeMoq().object; } // eslint-disable-next-line class-methods-use-this public get stdin(): NodeJS.ReadStream { - return TypeMoq.Mock.ofType().object; + return createTypeMoq().object; } // eslint-disable-next-line class-methods-use-this diff --git a/src/test/mocks/vsc/charCode.ts b/src/test/mocks/vsc/charCode.ts index d0fac68fbc57..fe450d491ef1 100644 --- a/src/test/mocks/vsc/charCode.ts +++ b/src/test/mocks/vsc/charCode.ts @@ -346,8 +346,8 @@ export const enum CharCode { LINE_SEPARATOR_2028 = 8232, // http://www.fileformat.info/info/unicode/category/Sk/list.htm - U_CIRCUMFLEX = 0x005e, // U+005E CIRCUMFLEX - U_GRAVE_ACCENT = 0x0060, // U+0060 GRAVE ACCENT + U_CIRCUMFLEX = Caret, // U+005E CIRCUMFLEX + U_GRAVE_ACCENT = BackTick, // U+0060 GRAVE ACCENT U_DIAERESIS = 0x00a8, // U+00A8 DIAERESIS U_MACRON = 0x00af, // U+00AF MACRON U_ACUTE_ACCENT = 0x00b4, // U+00B4 ACUTE ACCENT diff --git a/src/test/performance/load.perf.test.ts b/src/test/performance/load.perf.test.ts index 3fe9c6caa37d..0067803af8f0 100644 --- a/src/test/performance/load.perf.test.ts +++ b/src/test/performance/load.perf.test.ts @@ -4,7 +4,7 @@ 'use strict'; import { expect } from 'chai'; -import * as fs from 'fs-extra'; +import * as fs from '../../client/common/platform/fs-paths'; import { EOL } from 'os'; import * as path from 'path'; import { commands, extensions } from 'vscode'; diff --git a/src/test/performanceTest.ts b/src/test/performanceTest.ts index d4ac6bf262d0..2398f745c27a 100644 --- a/src/test/performanceTest.ts +++ b/src/test/performanceTest.ts @@ -17,7 +17,7 @@ process.env.VSC_PYTHON_PERF_TEST = '1'; import { spawn } from 'child_process'; import * as download from 'download'; -import * as fs from 'fs-extra'; +import * as fs from '../client/common/platform/fs-paths'; import * as path from 'path'; import * as bent from 'bent'; import { LanguageServerType } from '../client/activation/types'; @@ -123,7 +123,7 @@ class TestRunner { private async getReleaseVersion(): Promise { const url = `https://marketplace.visualstudio.com/items?itemName=${PVSC_EXTENSION_ID}`; - const request = bent('string', 'GET', 200); + const request = bent.default('string', 'GET', 200); const content: string = await request(url); const re = NamedRegexp('"version"S?:S?"(:\\d{4}\\.\\d{1,2}\\.\\d{1,2})"', 'g'); @@ -143,7 +143,7 @@ class TestRunner { return destination; } - await download(url, path.dirname(destination), { filename: path.basename(destination) }); + await download.default(url, path.dirname(destination), { filename: path.basename(destination) }); return destination; } } diff --git a/src/test/providers/terminal.unit.test.ts b/src/test/providers/terminal.unit.test.ts index 603c0710f8c5..1924f42d6927 100644 --- a/src/test/providers/terminal.unit.test.ts +++ b/src/test/providers/terminal.unit.test.ts @@ -233,7 +233,7 @@ suite('Terminal Provider', () => { try { await terminalProvider.initialize(undefined); } catch (ex) { - assert(false, `No error should be thrown, ${ex}`); + assert.ok(false, `No error should be thrown, ${ex}`); } }); }); diff --git a/src/test/pythonEnvironments/base/locators/envTestUtils.ts b/src/test/pythonEnvironments/base/locators/envTestUtils.ts index a46dab274b41..db29575d29ba 100644 --- a/src/test/pythonEnvironments/base/locators/envTestUtils.ts +++ b/src/test/pythonEnvironments/base/locators/envTestUtils.ts @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fsapi from 'fs-extra'; import * as assert from 'assert'; import { exec } from 'child_process'; import { cloneDeep, zip } from 'lodash'; import { promisify } from 'util'; +import * as fsapi from '../../../../client/common/platform/fs-paths'; import { PythonEnvInfo, PythonVersion, UNKNOWN_PYTHON_VERSION } from '../../../../client/pythonEnvironments/base/info'; import { getEmptyVersion } from '../../../../client/pythonEnvironments/base/info/pythonVersion'; import { BasicEnvInfo } from '../../../../client/pythonEnvironments/base/locator'; diff --git a/src/test/pythonEnvironments/base/locators/lowLevel/activestateLocator.unit.test.ts b/src/test/pythonEnvironments/base/locators/lowLevel/activestateLocator.unit.test.ts index bf86db883433..b0b18fb3827e 100644 --- a/src/test/pythonEnvironments/base/locators/lowLevel/activestateLocator.unit.test.ts +++ b/src/test/pythonEnvironments/base/locators/lowLevel/activestateLocator.unit.test.ts @@ -3,7 +3,7 @@ import * as path from 'path'; import * as sinon from 'sinon'; -import * as fsapi from 'fs-extra'; +import * as fsapi from '../../../../../client/common/platform/fs-paths'; import { PythonEnvKind } from '../../../../../client/pythonEnvironments/base/info'; import * as externalDependencies from '../../../../../client/pythonEnvironments/common/externalDependencies'; import { getEnvs } from '../../../../../client/pythonEnvironments/base/locatorUtils'; @@ -38,7 +38,7 @@ suite('ActiveState Locator', () => { const stateToolDir = ActiveState.getStateToolDir(); if (stateToolDir) { - sinon.stub(fsapi, 'pathExists').callsFake((dir: string) => dir === stateToolDir); + sinon.stub(fsapi, 'pathExists').callsFake((dir: string) => Promise.resolve(dir === stateToolDir)); } sinon.stub(externalDependencies, 'getPythonSetting').returns(undefined); diff --git a/src/test/pythonEnvironments/base/locators/lowLevel/condaLocator.testvirtualenvs.ts b/src/test/pythonEnvironments/base/locators/lowLevel/condaLocator.testvirtualenvs.ts index 25a3df90202f..3c7d4348b1c5 100644 --- a/src/test/pythonEnvironments/base/locators/lowLevel/condaLocator.testvirtualenvs.ts +++ b/src/test/pythonEnvironments/base/locators/lowLevel/condaLocator.testvirtualenvs.ts @@ -3,9 +3,9 @@ // Licensed under the MIT License. import * as path from 'path'; -import * as fs from 'fs-extra'; import { assert } from 'chai'; import * as sinon from 'sinon'; +import * as fs from '../../../../../client/common/platform/fs-paths'; import * as platformUtils from '../../../../../client/common/utils/platform'; import { CondaEnvironmentLocator } from '../../../../../client/pythonEnvironments/base/locators/lowLevel/condaLocator'; import { sleep } from '../../../../core'; diff --git a/src/test/pythonEnvironments/base/locators/lowLevel/condaLocator.unit.test.ts b/src/test/pythonEnvironments/base/locators/lowLevel/condaLocator.unit.test.ts index 1bf3ef19398d..605109b7a67e 100644 --- a/src/test/pythonEnvironments/base/locators/lowLevel/condaLocator.unit.test.ts +++ b/src/test/pythonEnvironments/base/locators/lowLevel/condaLocator.unit.test.ts @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fsapi from 'fs-extra'; import * as path from 'path'; import * as sinon from 'sinon'; +import * as fsapi from '../../../../../client/common/platform/fs-paths'; import { PythonReleaseLevel, PythonVersion } from '../../../../../client/pythonEnvironments/base/info'; import * as externalDeps from '../../../../../client/pythonEnvironments/common/externalDependencies'; import { getPythonVersionFromConda } from '../../../../../client/pythonEnvironments/common/environmentManagers/conda'; diff --git a/src/test/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.unit.test.ts b/src/test/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.unit.test.ts index 43effcfa4538..e570c3fb72da 100644 --- a/src/test/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.unit.test.ts +++ b/src/test/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.unit.test.ts @@ -9,6 +9,7 @@ import * as platformUtils from '../../../../../client/common/utils/platform'; import { PythonEnvKind } from '../../../../../client/pythonEnvironments/base/info'; import { getEnvs } from '../../../../../client/pythonEnvironments/base/locatorUtils'; import { PythonEnvsChangedEvent } from '../../../../../client/pythonEnvironments/base/watcher'; +import * as helpers from '../../../../../client/common/helpers'; import * as externalDependencies from '../../../../../client/pythonEnvironments/common/externalDependencies'; import { CustomVirtualEnvironmentLocator, @@ -32,7 +33,7 @@ suite('CustomVirtualEnvironment Locator', () => { let untildify: sinon.SinonStub; setup(async () => { - untildify = sinon.stub(externalDependencies, 'untildify'); + untildify = sinon.stub(helpers, 'untildify'); untildify.callsFake((value: string) => value.replace('~', testVirtualHomeDir)); getUserHomeDirStub = sinon.stub(platformUtils, 'getUserHomeDir'); getUserHomeDirStub.returns(testVirtualHomeDir); diff --git a/src/test/pythonEnvironments/base/locators/lowLevel/microsoftStoreLocator.test.ts b/src/test/pythonEnvironments/base/locators/lowLevel/microsoftStoreLocator.test.ts index fc3e9b7f5663..511597dd28db 100644 --- a/src/test/pythonEnvironments/base/locators/lowLevel/microsoftStoreLocator.test.ts +++ b/src/test/pythonEnvironments/base/locators/lowLevel/microsoftStoreLocator.test.ts @@ -2,9 +2,9 @@ // Licensed under the MIT License. import { assert } from 'chai'; -import * as fs from 'fs-extra'; import * as path from 'path'; import { Uri } from 'vscode'; +import * as fs from '../../../../../client/common/platform/fs-paths'; import { FileChangeType } from '../../../../../client/common/platform/fileSystemWatcher'; import { createDeferred, Deferred, sleep } from '../../../../../client/common/utils/async'; import { PythonEnvKind } from '../../../../../client/pythonEnvironments/base/info'; diff --git a/src/test/pythonEnvironments/base/locators/lowLevel/watcherTestUtils.ts b/src/test/pythonEnvironments/base/locators/lowLevel/watcherTestUtils.ts index 6e269f5680ba..e9c7be3ec321 100644 --- a/src/test/pythonEnvironments/base/locators/lowLevel/watcherTestUtils.ts +++ b/src/test/pythonEnvironments/base/locators/lowLevel/watcherTestUtils.ts @@ -2,8 +2,8 @@ // Licensed under the MIT License. import { assert } from 'chai'; -import * as fs from 'fs-extra'; import * as path from 'path'; +import * as fs from '../../../../../client/common/platform/fs-paths'; import { FileChangeType } from '../../../../../client/common/platform/fileSystemWatcher'; import { IDisposable } from '../../../../../client/common/types'; import { createDeferred, Deferred, sleep } from '../../../../../client/common/utils/async'; diff --git a/src/test/pythonEnvironments/common/environmentManagers/conda.unit.test.ts b/src/test/pythonEnvironments/common/environmentManagers/conda.unit.test.ts index d888f1d4edff..e621c25aeb62 100644 --- a/src/test/pythonEnvironments/common/environmentManagers/conda.unit.test.ts +++ b/src/test/pythonEnvironments/common/environmentManagers/conda.unit.test.ts @@ -1,10 +1,10 @@ +/* eslint-disable @typescript-eslint/no-explicit-any */ import { assert, expect } from 'chai'; -import * as fs from 'fs'; -import * as fsapi from 'fs-extra'; import * as path from 'path'; import * as sinon from 'sinon'; import * as util from 'util'; import { eq } from 'semver'; +import * as fs from '../../../../client/common/platform/fs-paths'; import * as platform from '../../../../client/common/utils/platform'; import { PythonEnvKind } from '../../../../client/pythonEnvironments/base/info'; import { getEnvs } from '../../../../client/pythonEnvironments/base/locatorUtils'; @@ -105,17 +105,17 @@ suite('Conda and its environments are located correctly', () => { sinon.stub(platform, 'getUserHomeDir').callsFake(() => homeDir); - sinon.stub(fsapi, 'lstat').callsFake(async (filePath: fs.PathLike) => { + sinon.stub(fs, 'lstat').callsFake(async (filePath: fs.PathLike) => { if (typeof filePath !== 'string') { throw new Error(`expected filePath to be string, got ${typeof filePath}`); } const file = getFile(filePath, 'throwIfMissing'); return { isDirectory: () => typeof file !== 'string', - } as fsapi.Stats; + } as fs.Stats; }); - sinon.stub(fsapi, 'pathExists').callsFake(async (filePath: string | Buffer) => { + sinon.stub(fs, 'pathExists').callsFake(async (filePath: string | Buffer) => { if (typeof filePath !== 'string') { throw new Error(`expected filePath to be string, got ${typeof filePath}`); } @@ -127,16 +127,9 @@ suite('Conda and its environments are located correctly', () => { return true; }); - sinon.stub(fsapi, 'readdir').callsFake(async (filePath: fs.PathLike) => { - if (typeof filePath !== 'string') { - throw new Error(`expected filePath to be string, got ${typeof filePath}`); - } - return (Object.keys(getFile(filePath, 'throwIfMissing')) as unknown) as fs.Dirent[]; - }); - - sinon - .stub(fs.promises, 'readdir' as any) // eslint-disable-line @typescript-eslint/no-explicit-any - .callsFake(async (filePath: fs.PathLike, options?: { withFileTypes?: boolean }) => { + sinon.stub(fs, 'readdir').callsFake( + // eslint-disable-next-line @typescript-eslint/no-explicit-any + async (filePath: fs.PathLike, options?: { withFileTypes?: boolean }): Promise => { if (typeof filePath !== 'string') { throw new Error(`expected path to be string, got ${typeof path}`); } @@ -146,6 +139,10 @@ suite('Conda and its environments are located correctly', () => { throw new Error(`${path} is not a directory`); } + if (options === undefined) { + return (Object.keys(getFile(filePath, 'throwIfMissing')) as unknown) as fs.Dirent[]; + } + const names = Object.keys(dir); if (!options?.withFileTypes) { return names; @@ -164,27 +161,34 @@ suite('Conda and its environments are located correctly', () => { isSymbolicLink: () => false, isFIFO: () => false, isSocket: () => false, + parentPath: '', }; }, ); - }); - - sinon - .stub(fsapi, 'readFile' as any) // eslint-disable-line @typescript-eslint/no-explicit-any - .callsFake(async (filePath: string | Buffer | number, encoding: string) => { - if (typeof filePath !== 'string') { - throw new Error(`expected filePath to be string, got ${typeof filePath}`); - } else if (encoding !== 'utf8') { - throw new Error(`Unsupported encoding ${encoding}`); + }, + ); + const readFileStub = async ( + filePath: fs.PathOrFileDescriptor, + options: { encoding: BufferEncoding; flag?: string | undefined } | BufferEncoding, + ): Promise => { + if (typeof filePath !== 'string') { + throw new Error(`expected filePath to be string, got ${typeof filePath}`); + } else if (typeof options === 'string') { + if (options !== 'utf8') { + throw new Error(`Unsupported encoding ${options}`); } + } else if ((options as any).encoding !== 'utf8') { + throw new Error(`Unsupported encoding ${(options as any).encoding}`); + } - const contents = getFile(filePath); - if (typeof contents !== 'string') { - throw new Error(`${filePath} is not a file`); - } + const contents = getFile(filePath); + if (typeof contents !== 'string') { + throw new Error(`${filePath} is not a file`); + } - return contents; - }); + return contents; + }; + sinon.stub(fs, 'readFile' as any).callsFake(readFileStub as any); sinon.stub(externalDependencies, 'exec').callsFake(async (command: string, args: string[]) => { for (const prefix of ['', ...execPath]) { diff --git a/src/test/pythonEnvironments/common/environmentManagers/simplevirtualenvs.unit.test.ts b/src/test/pythonEnvironments/common/environmentManagers/simplevirtualenvs.unit.test.ts index 8ffb64b741a3..6d75668b8556 100644 --- a/src/test/pythonEnvironments/common/environmentManagers/simplevirtualenvs.unit.test.ts +++ b/src/test/pythonEnvironments/common/environmentManagers/simplevirtualenvs.unit.test.ts @@ -2,9 +2,9 @@ // Licensed under the MIT License. import * as assert from 'assert'; -import * as fsapi from 'fs-extra'; import * as path from 'path'; import * as sinon from 'sinon'; +import * as fsapi from '../../../../client/common/platform/fs-paths'; import * as platformUtils from '../../../../client/common/utils/platform'; import { PythonReleaseLevel, PythonVersion } from '../../../../client/pythonEnvironments/base/info'; import * as fileUtils from '../../../../client/pythonEnvironments/common/externalDependencies'; diff --git a/src/test/pythonEnvironments/creation/common/installCheckUtils.unit.test.ts b/src/test/pythonEnvironments/creation/common/installCheckUtils.unit.test.ts index 2ad1addbb1bc..2900b9b89c8f 100644 --- a/src/test/pythonEnvironments/creation/common/installCheckUtils.unit.test.ts +++ b/src/test/pythonEnvironments/creation/common/installCheckUtils.unit.test.ts @@ -13,7 +13,7 @@ import { SpawnOptions } from '../../../../client/common/process/types'; import { IInterpreterService } from '../../../../client/interpreter/contracts'; import { PythonEnvironment } from '../../../../client/pythonEnvironments/info'; -chaiUse(chaiAsPromised); +chaiUse(chaiAsPromised.default); function getSomeRequirementFile(): typemoq.IMock { const someFilePath = 'requirements.txt'; diff --git a/src/test/pythonEnvironments/creation/common/workspaceSelection.unit.test.ts b/src/test/pythonEnvironments/creation/common/workspaceSelection.unit.test.ts index 57047db1d2bc..1d3df521fd0a 100644 --- a/src/test/pythonEnvironments/creation/common/workspaceSelection.unit.test.ts +++ b/src/test/pythonEnvironments/creation/common/workspaceSelection.unit.test.ts @@ -12,7 +12,7 @@ import { pickWorkspaceFolder } from '../../../../client/pythonEnvironments/creat import * as windowApis from '../../../../client/common/vscodeApis/windowApis'; import { EXTENSION_ROOT_DIR_FOR_TESTS } from '../../../constants'; -chaiUse(chaiAsPromised); +chaiUse(chaiAsPromised.default); suite('Create environment workspace selection tests', () => { let showQuickPickWithBackStub: sinon.SinonStub; diff --git a/src/test/pythonEnvironments/creation/createEnvApi.unit.test.ts b/src/test/pythonEnvironments/creation/createEnvApi.unit.test.ts index 786bd26a881c..f8c75f76e2b8 100644 --- a/src/test/pythonEnvironments/creation/createEnvApi.unit.test.ts +++ b/src/test/pythonEnvironments/creation/createEnvApi.unit.test.ts @@ -15,7 +15,7 @@ import * as windowApis from '../../../client/common/vscodeApis/windowApis'; import { handleCreateEnvironmentCommand } from '../../../client/pythonEnvironments/creation/createEnvironment'; import { CreateEnvironmentProvider } from '../../../client/pythonEnvironments/creation/proposed.createEnvApis'; -chaiUse(chaiAsPromised); +chaiUse(chaiAsPromised.default); suite('Create Environment APIs', () => { let registerCommandStub: sinon.SinonStub; diff --git a/src/test/pythonEnvironments/creation/createEnvButtonContext.unit.test.ts b/src/test/pythonEnvironments/creation/createEnvButtonContext.unit.test.ts index eec2d066aadb..b666191b37bf 100644 --- a/src/test/pythonEnvironments/creation/createEnvButtonContext.unit.test.ts +++ b/src/test/pythonEnvironments/creation/createEnvButtonContext.unit.test.ts @@ -11,7 +11,7 @@ import * as workspaceApis from '../../../client/common/vscodeApis/workspaceApis' import { IDisposableRegistry } from '../../../client/common/types'; import { registerCreateEnvironmentButtonFeatures } from '../../../client/pythonEnvironments/creation/createEnvButtonContext'; -chaiUse(chaiAsPromised); +chaiUse(chaiAsPromised.default); class FakeDisposable { public dispose() { diff --git a/src/test/pythonEnvironments/creation/createEnvironment.unit.test.ts b/src/test/pythonEnvironments/creation/createEnvironment.unit.test.ts index f16f81233369..9aa9a606d22f 100644 --- a/src/test/pythonEnvironments/creation/createEnvironment.unit.test.ts +++ b/src/test/pythonEnvironments/creation/createEnvironment.unit.test.ts @@ -12,7 +12,7 @@ import { IDisposableRegistry } from '../../../client/common/types'; import { onCreateEnvironmentStarted } from '../../../client/pythonEnvironments/creation/createEnvApi'; import { CreateEnvironmentProvider } from '../../../client/pythonEnvironments/creation/proposed.createEnvApis'; -chaiUse(chaiAsPromised); +chaiUse(chaiAsPromised.default); suite('Create Environments Tests', () => { let showQuickPickStub: sinon.SinonStub; diff --git a/src/test/pythonEnvironments/creation/installedPackagesDiagnostics.unit.test.ts b/src/test/pythonEnvironments/creation/installedPackagesDiagnostics.unit.test.ts index ca984b6122f0..21bddd33c678 100644 --- a/src/test/pythonEnvironments/creation/installedPackagesDiagnostics.unit.test.ts +++ b/src/test/pythonEnvironments/creation/installedPackagesDiagnostics.unit.test.ts @@ -18,7 +18,7 @@ import { } from '../../../client/pythonEnvironments/creation/installedPackagesDiagnostic'; import { IInterpreterService } from '../../../client/interpreter/contracts'; -chaiUse(chaiAsPromised); +chaiUse(chaiAsPromised.default); class FakeDisposable { public dispose() { diff --git a/src/test/pythonEnvironments/creation/provider/commonUtils.unit.test.ts b/src/test/pythonEnvironments/creation/provider/commonUtils.unit.test.ts index 55ad81cdb486..ee177a58c779 100644 --- a/src/test/pythonEnvironments/creation/provider/commonUtils.unit.test.ts +++ b/src/test/pythonEnvironments/creation/provider/commonUtils.unit.test.ts @@ -2,10 +2,10 @@ // Licensed under the MIT License. import { expect } from 'chai'; -import * as fs from 'fs-extra'; import * as path from 'path'; import * as sinon from 'sinon'; import { Uri } from 'vscode'; +import * as fs from '../../../../client/common/platform/fs-paths'; import { hasVenv } from '../../../../client/pythonEnvironments/creation/common/commonUtils'; import { EXTENSION_ROOT_DIR_FOR_TESTS } from '../../../constants'; diff --git a/src/test/pythonEnvironments/creation/provider/condaCreationProvider.unit.test.ts b/src/test/pythonEnvironments/creation/provider/condaCreationProvider.unit.test.ts index e1344dc5f3ad..e2ff9b2ab486 100644 --- a/src/test/pythonEnvironments/creation/provider/condaCreationProvider.unit.test.ts +++ b/src/test/pythonEnvironments/creation/provider/condaCreationProvider.unit.test.ts @@ -24,7 +24,7 @@ import { CreateEnvironmentResult, } from '../../../../client/pythonEnvironments/creation/proposed.createEnvApis'; -chaiUse(chaiAsPromised); +chaiUse(chaiAsPromised.default); suite('Conda Creation provider tests', () => { let condaProvider: CreateEnvironmentProvider; @@ -166,6 +166,7 @@ suite('Conda Creation provider tests', () => { out: { subscribe: ( _next?: (value: Output) => void, + // eslint-disable-next-line no-shadow error?: (error: unknown) => void, complete?: () => void, ) => { diff --git a/src/test/pythonEnvironments/creation/provider/venvCreationProvider.unit.test.ts b/src/test/pythonEnvironments/creation/provider/venvCreationProvider.unit.test.ts index 72914b9118e2..aa2d317c405e 100644 --- a/src/test/pythonEnvironments/creation/provider/venvCreationProvider.unit.test.ts +++ b/src/test/pythonEnvironments/creation/provider/venvCreationProvider.unit.test.ts @@ -24,7 +24,7 @@ import { CreateEnvironmentResult, } from '../../../../client/pythonEnvironments/creation/proposed.createEnvApis'; -chaiUse(chaiAsPromised); +chaiUse(chaiAsPromised.default); suite('venv Creation provider tests', () => { let venvProvider: CreateEnvironmentProvider; @@ -198,6 +198,7 @@ suite('venv Creation provider tests', () => { out: { subscribe: ( _next?: (value: Output) => void, + // eslint-disable-next-line no-shadow error?: (error: unknown) => void, complete?: () => void, ) => { diff --git a/src/test/pythonEnvironments/creation/provider/venvDeleteUtils.unit.test.ts b/src/test/pythonEnvironments/creation/provider/venvDeleteUtils.unit.test.ts index d075979b70b1..231222acbaec 100644 --- a/src/test/pythonEnvironments/creation/provider/venvDeleteUtils.unit.test.ts +++ b/src/test/pythonEnvironments/creation/provider/venvDeleteUtils.unit.test.ts @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import * as fs from 'fs-extra'; import * as sinon from 'sinon'; import { Uri, WorkspaceFolder } from 'vscode'; import { assert } from 'chai'; import * as path from 'path'; +import * as fs from '../../../../client/common/platform/fs-paths'; import { EXTENSION_ROOT_DIR_FOR_TESTS } from '../../../constants'; import * as commonUtils from '../../../../client/pythonEnvironments/creation/common/commonUtils'; import { diff --git a/src/test/pythonEnvironments/creation/provider/venvUtils.unit.test.ts b/src/test/pythonEnvironments/creation/provider/venvUtils.unit.test.ts index 053524331ba9..2c8ec2ebce87 100644 --- a/src/test/pythonEnvironments/creation/provider/venvUtils.unit.test.ts +++ b/src/test/pythonEnvironments/creation/provider/venvUtils.unit.test.ts @@ -2,10 +2,10 @@ // Licensed under the MIT License. import { assert, use as chaiUse } from 'chai'; import * as chaiAsPromised from 'chai-as-promised'; -import * as fs from 'fs-extra'; import * as sinon from 'sinon'; import { Uri } from 'vscode'; import * as path from 'path'; +import * as fs from '../../../../client/common/platform/fs-paths'; import * as windowApis from '../../../../client/common/vscodeApis/windowApis'; import * as workspaceApis from '../../../../client/common/vscodeApis/workspaceApis'; import { @@ -18,7 +18,7 @@ import { EXTENSION_ROOT_DIR_FOR_TESTS } from '../../../constants'; import { CreateEnv } from '../../../../client/common/utils/localize'; import { createDeferred } from '../../../../client/common/utils/async'; -chaiUse(chaiAsPromised); +chaiUse(chaiAsPromised.default); suite('Venv Utils test', () => { let findFilesStub: sinon.SinonStub; diff --git a/src/test/pythonEnvironments/creation/pyProjectTomlContext.unit.test.ts b/src/test/pythonEnvironments/creation/pyProjectTomlContext.unit.test.ts index 7106ee64162f..8363837a4a36 100644 --- a/src/test/pythonEnvironments/creation/pyProjectTomlContext.unit.test.ts +++ b/src/test/pythonEnvironments/creation/pyProjectTomlContext.unit.test.ts @@ -12,7 +12,7 @@ import * as workspaceApis from '../../../client/common/vscodeApis/workspaceApis' import { IDisposableRegistry } from '../../../client/common/types'; import { registerPyProjectTomlFeatures } from '../../../client/pythonEnvironments/creation/pyProjectTomlContext'; -chaiUse(chaiAsPromised); +chaiUse(chaiAsPromised.default); class FakeDisposable { public dispose() { diff --git a/src/test/serviceRegistry.ts b/src/test/serviceRegistry.ts index a175b3303223..9da8ec9a3fd3 100644 --- a/src/test/serviceRegistry.ts +++ b/src/test/serviceRegistry.ts @@ -2,7 +2,7 @@ // Licensed under the MIT License. import { Container } from 'inversify'; -import { anything, instance, mock, when } from 'ts-mockito'; +import { anything } from 'ts-mockito'; import * as TypeMoq from 'typemoq'; import { Disposable, Memento } from 'vscode'; import { FileSystem } from '../client/common/platform/fileSystem'; @@ -53,6 +53,7 @@ import { MockMemento } from './mocks/mementos'; import { MockProcessService } from './mocks/proc'; import { MockProcess } from './mocks/process'; import { registerForIOC } from './pythonEnvironments/legacyIOC'; +import { createTypeMoq } from './mocks/helper'; export class IocContainer { // This may be set (before any registration happens) to indicate @@ -125,12 +126,10 @@ export class IocContainer { public registerProcessTypes(): void { processRegisterTypes(this.serviceManager); - const mockEnvironmentActivationService = mock(EnvironmentActivationService); - when(mockEnvironmentActivationService.getActivatedEnvironmentVariables(anything())).thenResolve(); - this.serviceManager.addSingletonInstance( - IEnvironmentActivationService, - instance(mockEnvironmentActivationService), - ); + const mockEnvironmentActivationService = createTypeMoq(); + mockEnvironmentActivationService + .setup((f) => f.getActivatedEnvironmentVariables(anything())) + .returns(() => Promise.resolve(undefined)); } public registerVariableTypes(): void { @@ -151,7 +150,7 @@ export class IocContainer { } public registerMockProcessTypes(): void { - const processServiceFactory = TypeMoq.Mock.ofType(); + const processServiceFactory = createTypeMoq(); // eslint-disable-next-line @typescript-eslint/no-explicit-any const processService = new MockProcessService(new ProcessService(process.env as any)); @@ -169,11 +168,13 @@ export class IocContainer { IEnvironmentActivationService, EnvironmentActivationService, ); - const mockEnvironmentActivationService = mock(EnvironmentActivationService); - when(mockEnvironmentActivationService.getActivatedEnvironmentVariables(anything())).thenResolve(); + const mockEnvironmentActivationService = createTypeMoq(); + mockEnvironmentActivationService + .setup((m) => m.getActivatedEnvironmentVariables(anything())) + .returns(() => Promise.resolve(undefined)); this.serviceManager.rebindInstance( IEnvironmentActivationService, - instance(mockEnvironmentActivationService), + mockEnvironmentActivationService.object, ); } diff --git a/src/test/smoke/common.ts b/src/test/smoke/common.ts index faf18ebd286e..5f5b691fb496 100644 --- a/src/test/smoke/common.ts +++ b/src/test/smoke/common.ts @@ -4,10 +4,10 @@ 'use strict'; import * as assert from 'assert'; -import * as fs from 'fs-extra'; import * as glob from 'glob'; import * as path from 'path'; import * as vscode from 'vscode'; +import * as fs from '../../client/common/platform/fs-paths'; import { JUPYTER_EXTENSION_ID } from '../../client/common/constants'; import { SMOKE_TEST_EXTENSIONS_DIR } from '../constants'; import { noop, sleep } from '../core'; @@ -25,7 +25,7 @@ export async function removeLanguageServerFiles(): Promise { } async function getLanguageServerFolders(): Promise { return new Promise((resolve, reject) => { - glob('languageServer.*', { cwd: SMOKE_TEST_EXTENSIONS_DIR }, (ex, matches) => { + glob.default('languageServer.*', { cwd: SMOKE_TEST_EXTENSIONS_DIR }, (ex, matches) => { if (ex) { reject(ex); } else { @@ -51,7 +51,7 @@ export async function openNotebook(file: string): Promise { assert.fail(`Something went wrong showing the text document: ${err}`); }); - assert(vscode.window.activeTextEditor, 'No active editor'); + assert.ok(vscode.window.activeTextEditor, 'No active editor'); // Make sure LS completes file loading and analysis. // In test mode it awaits for the completion before trying // to fetch data for completion, hover.etc. diff --git a/src/test/smoke/datascience.smoke.test.ts b/src/test/smoke/datascience.smoke.test.ts index 30298183c511..9f4421de4676 100644 --- a/src/test/smoke/datascience.smoke.test.ts +++ b/src/test/smoke/datascience.smoke.test.ts @@ -4,9 +4,9 @@ 'use strict'; import * as assert from 'assert'; -import * as fs from 'fs-extra'; import * as path from 'path'; import * as vscode from 'vscode'; +import * as fs from '../../client/common/platform/fs-paths'; import { openFile, waitForCondition } from '../common'; import { EXTENSION_ROOT_DIR_FOR_TESTS } from '../constants'; import { sleep } from '../core'; diff --git a/src/test/smoke/jedilsp.smoke.test.ts b/src/test/smoke/jedilsp.smoke.test.ts index e25d2bcdd1cc..a2087ff42085 100644 --- a/src/test/smoke/jedilsp.smoke.test.ts +++ b/src/test/smoke/jedilsp.smoke.test.ts @@ -3,9 +3,9 @@ 'use strict'; -import * as fs from 'fs-extra'; import * as path from 'path'; import * as vscode from 'vscode'; +import * as fs from '../../client/common/platform/fs-paths'; import { openFile, waitForCondition } from '../common'; import { EXTENSION_ROOT_DIR_FOR_TESTS, IS_SMOKE_TEST } from '../constants'; diff --git a/src/test/smoke/runInTerminal.smoke.test.ts b/src/test/smoke/runInTerminal.smoke.test.ts index 43b53e4480e0..bd4c88e44e80 100644 --- a/src/test/smoke/runInTerminal.smoke.test.ts +++ b/src/test/smoke/runInTerminal.smoke.test.ts @@ -4,9 +4,9 @@ 'use strict'; import * as assert from 'assert'; -import * as fs from 'fs-extra'; import * as path from 'path'; import * as vscode from 'vscode'; +import * as fs from '../../client/common/platform/fs-paths'; import { openFile, waitForCondition } from '../common'; import { EXTENSION_ROOT_DIR_FOR_TESTS, IS_SMOKE_TEST } from '../constants'; import { closeActiveWindows, initialize, initializeTest } from '../initialize'; diff --git a/src/test/smoke/smartSend.smoke.test.ts b/src/test/smoke/smartSend.smoke.test.ts index 20ec70af9b5b..a35c02ceaa63 100644 --- a/src/test/smoke/smartSend.smoke.test.ts +++ b/src/test/smoke/smartSend.smoke.test.ts @@ -1,7 +1,7 @@ import * as vscode from 'vscode'; import * as path from 'path'; -import * as fs from 'fs-extra'; import { assert } from 'chai'; +import * as fs from '../../client/common/platform/fs-paths'; import { EXTENSION_ROOT_DIR_FOR_TESTS, IS_SMOKE_TEST } from '../constants'; import { closeActiveWindows, initialize, initializeTest } from '../initialize'; import { openFile, waitForCondition } from '../common'; diff --git a/src/test/smokeTest.ts b/src/test/smokeTest.ts index de66e7aba5f0..bcd70c0e3417 100644 --- a/src/test/smokeTest.ts +++ b/src/test/smokeTest.ts @@ -7,7 +7,7 @@ process.env.VSC_PYTHON_SMOKE_TEST = '1'; import { spawn } from 'child_process'; -import * as fs from 'fs-extra'; +import * as fs from '../client/common/platform/fs-paths'; import * as glob from 'glob'; import * as path from 'path'; import { unzip } from './common'; @@ -81,7 +81,7 @@ class TestRunner { private async extractLatestExtension(targetDir: string): Promise { const extensionFile = await new Promise((resolve, reject) => - glob('*.vsix', (ex, files) => (ex ? reject(ex) : resolve(files[0]))), + glob.default('*.vsix', (ex, files) => (ex ? reject(ex) : resolve(files[0]))), ); await unzip(extensionFile, targetDir); } diff --git a/src/test/standardTest.ts b/src/test/standardTest.ts index 0fe53437cf3d..00eb3d7cf8c4 100644 --- a/src/test/standardTest.ts +++ b/src/test/standardTest.ts @@ -1,5 +1,5 @@ import { spawnSync } from 'child_process'; -import * as fs from 'fs-extra'; +import * as fs from '../client/common/platform/fs-paths'; import * as os from 'os'; import * as path from 'path'; import { downloadAndUnzipVSCode, resolveCliPathFromVSCodeExecutablePath, runTests } from '@vscode/test-electron'; diff --git a/src/test/telemetry/index.unit.test.ts b/src/test/telemetry/index.unit.test.ts index e155ac0a2092..d8a6b72eedc6 100644 --- a/src/test/telemetry/index.unit.test.ts +++ b/src/test/telemetry/index.unit.test.ts @@ -5,7 +5,7 @@ import { expect } from 'chai'; import rewiremock from 'rewiremock'; import * as sinon from 'sinon'; -import * as fs from 'fs-extra'; +import * as fs from '../../client/common/platform/fs-paths'; import { _resetSharedProperties, diff --git a/src/test/tensorBoard/tensorBoardFileWatcher.test.ts b/src/test/tensorBoard/tensorBoardFileWatcher.test.ts index cd2692aabcfd..3ad9ada21bdb 100644 --- a/src/test/tensorBoard/tensorBoardFileWatcher.test.ts +++ b/src/test/tensorBoard/tensorBoardFileWatcher.test.ts @@ -1,7 +1,7 @@ import { assert } from 'chai'; -import * as fse from 'fs-extra'; import * as path from 'path'; import * as sinon from 'sinon'; +import * as fse from '../../client/common/platform/fs-paths'; import { IWorkspaceService } from '../../client/common/application/types'; import { IExperimentService } from '../../client/common/types'; import { TensorBoardFileWatcher } from '../../client/tensorBoard/tensorBoardFileWatcher'; diff --git a/src/test/terminals/codeExecution/helper.test.ts b/src/test/terminals/codeExecution/helper.test.ts index 6e2ea2a61061..9a6deefcb7bf 100644 --- a/src/test/terminals/codeExecution/helper.test.ts +++ b/src/test/terminals/codeExecution/helper.test.ts @@ -4,11 +4,11 @@ 'use strict'; import { expect } from 'chai'; -import * as fs from 'fs-extra'; import * as path from 'path'; import { SemVer } from 'semver'; import * as TypeMoq from 'typemoq'; import { Position, Range, Selection, TextDocument, TextEditor, TextLine, Uri } from 'vscode'; +import * as fs from '../../../client/common/platform/fs-paths'; import { IActiveResourceService, IApplicationShell, diff --git a/src/test/terminals/codeExecution/smartSend.test.ts b/src/test/terminals/codeExecution/smartSend.test.ts index c6f4ae195d16..89f5ac2b5e4d 100644 --- a/src/test/terminals/codeExecution/smartSend.test.ts +++ b/src/test/terminals/codeExecution/smartSend.test.ts @@ -1,9 +1,9 @@ import * as TypeMoq from 'typemoq'; import * as path from 'path'; import { TextEditor, Selection, Position, TextDocument, Uri } from 'vscode'; -import * as fs from 'fs-extra'; import { SemVer } from 'semver'; import { assert, expect } from 'chai'; +import * as fs from '../../../client/common/platform/fs-paths'; import { IActiveResourceService, IApplicationShell, diff --git a/src/test/terminals/serviceRegistry.unit.test.ts b/src/test/terminals/serviceRegistry.unit.test.ts index 8c2a0a69eae9..cb5b7715c4b7 100644 --- a/src/test/terminals/serviceRegistry.unit.test.ts +++ b/src/test/terminals/serviceRegistry.unit.test.ts @@ -1,3 +1,4 @@ +/* eslint-disable @typescript-eslint/no-explicit-any */ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. @@ -44,8 +45,8 @@ suite('Terminal - Service Registry', () => { services .setup((s) => s.addSingleton( - typemoq.It.is((v) => args[0] === v), - typemoq.It.is((value) => args[1] === value), + typemoq.It.is((v: any) => args[0] === v), + typemoq.It.is((value: any) => args[1] === value), ), ) .verifiable(typemoq.Times.once()); @@ -53,8 +54,8 @@ suite('Terminal - Service Registry', () => { services .setup((s) => s.addSingleton( - typemoq.It.is((v) => args[0] === v), - typemoq.It.is((value) => args[1] === value), + typemoq.It.is((v: any) => args[0] === v), + typemoq.It.is((value: any) => args[1] === value), typemoq.It.isValue((args[2] as unknown) as string), ), @@ -65,8 +66,8 @@ suite('Terminal - Service Registry', () => { services .setup((s) => s.addBinding( - typemoq.It.is((v) => ITerminalEnvVarCollectionService === v), - typemoq.It.is((value) => IExtensionActivationService === value), + typemoq.It.is((v: any) => ITerminalEnvVarCollectionService === v), + typemoq.It.is((value: any) => IExtensionActivationService === value), ), ) .verifiable(typemoq.Times.once()); diff --git a/src/test/testBootstrap.ts b/src/test/testBootstrap.ts index 03f24a680d0d..ab902255203b 100644 --- a/src/test/testBootstrap.ts +++ b/src/test/testBootstrap.ts @@ -4,7 +4,7 @@ 'use strict'; import { ChildProcess, spawn, SpawnOptions } from 'child_process'; -import * as fs from 'fs-extra'; +import * as fs from '../client/common/platform/fs-paths'; import { AddressInfo, createServer, Server } from 'net'; import * as path from 'path'; import { EXTENSION_ROOT_DIR } from '../client/constants'; diff --git a/src/test/testRunner.ts b/src/test/testRunner.ts index 9dd9ead56e58..6187597a46a3 100644 --- a/src/test/testRunner.ts +++ b/src/test/testRunner.ts @@ -19,7 +19,7 @@ if (!tty.getWindowSize) { }; } -let mocha = new Mocha({ +let mocha = new Mocha.default({ ui: 'tdd', colors: true, }); @@ -40,7 +40,7 @@ export function configure(setupOptions: SetupOptions): void { } // Force Mocha to exit. (setupOptions as any).exit = true; - mocha = new Mocha(setupOptions); + mocha = new Mocha.default(setupOptions); } export async function run(): Promise { @@ -59,7 +59,7 @@ export async function run(): Promise { */ function initializationScript() { const ex = new Error('Failed to initialize Python extension for tests after 3 minutes'); - let timer: NodeJS.Timer | undefined; + let timer: NodeJS.Timeout | undefined; const failed = new Promise((_, reject) => { timer = setTimeout(() => reject(ex), MAX_EXTENSION_ACTIVATION_TIME); }); @@ -69,7 +69,7 @@ export async function run(): Promise { } // Run the tests. await new Promise((resolve, reject) => { - glob( + glob.default( `**/**.${testFilesGlob}.js`, { ignore: ['**/**.unit.test.js', '**/**.functional.test.js'], cwd: testsRoot }, (error, files) => { diff --git a/src/test/testing/common/debugLauncher.unit.test.ts b/src/test/testing/common/debugLauncher.unit.test.ts index bdcb7b63762c..e31579640c9a 100644 --- a/src/test/testing/common/debugLauncher.unit.test.ts +++ b/src/test/testing/common/debugLauncher.unit.test.ts @@ -8,7 +8,7 @@ import * as chaiAsPromised from 'chai-as-promised'; import * as path from 'path'; import * as sinon from 'sinon'; import * as TypeMoq from 'typemoq'; -import * as fs from 'fs-extra'; +import * as fs from '../../../client/common/platform/fs-paths'; import * as workspaceApis from '../../../client/common/vscodeApis/workspaceApis'; import { CancellationTokenSource, DebugConfiguration, DebugSession, Uri, WorkspaceFolder } from 'vscode'; import { IInvalidPythonPathInDebuggerService } from '../../../client/application/diagnostics/types'; @@ -32,7 +32,7 @@ import { IEnvironmentActivationService } from '../../../client/interpreter/activ import * as util from '../../../client/testing/testController/common/utils'; import { createDeferred } from '../../../client/common/utils/async'; -use(chaiAsPromised); +use(chaiAsPromised.default); suite('Unit Tests - Debug Launcher', () => { let serviceContainer: TypeMoq.IMock; diff --git a/src/test/testing/common/services/configSettingService.unit.test.ts b/src/test/testing/common/services/configSettingService.unit.test.ts index 92d66f021491..d369d7ead825 100644 --- a/src/test/testing/common/services/configSettingService.unit.test.ts +++ b/src/test/testing/common/services/configSettingService.unit.test.ts @@ -16,7 +16,7 @@ import { TestConfigSettingsService } from '../../../../client/testing/common/con import { ITestConfigSettingsService, UnitTestProduct } from '../../../../client/testing/common/types'; import { BufferedTestConfigSettingsService } from '../../../../client/testing/common/bufferedTestConfigSettingService'; -use(chaiPromise); +use(chaiPromise.default); const updateMethods: (keyof Omit)[] = [ 'updateTestArgs', diff --git a/src/test/testing/common/testingAdapter.test.ts b/src/test/testing/common/testingAdapter.test.ts index c01fed29bac7..ad5c66df4cda 100644 --- a/src/test/testing/common/testingAdapter.test.ts +++ b/src/test/testing/common/testingAdapter.test.ts @@ -21,6 +21,7 @@ import { PythonResultResolver } from '../../../client/testing/testController/com import { TestProvider } from '../../../client/testing/types'; import { PYTEST_PROVIDER, UNITTEST_PROVIDER } from '../../../client/testing/common/constants'; import { IEnvironmentVariablesProvider } from '../../../client/common/variables/types'; +import { createTypeMoq } from '../../mocks/helper'; suite('End to End Tests: test adapters', () => { let resultResolver: ITestResultResolver; @@ -105,7 +106,7 @@ suite('End to End Tests: test adapters', () => { // create objects that were not injected - testOutputChannel = typeMoq.Mock.ofType(); + testOutputChannel = createTypeMoq(); testOutputChannel .setup((x) => x.append(typeMoq.It.isAny())) .callback((appendVal: any) => { diff --git a/src/test/testing/configurationFactory.unit.test.ts b/src/test/testing/configurationFactory.unit.test.ts index 74f7dd0da19b..0813e3f4aae1 100644 --- a/src/test/testing/configurationFactory.unit.test.ts +++ b/src/test/testing/configurationFactory.unit.test.ts @@ -14,7 +14,7 @@ import { TestConfigurationManagerFactory } from '../../client/testing/configurat import * as pytest from '../../client/testing/configuration/pytest/testConfigurationManager'; import * as unittest from '../../client/testing/configuration/unittest/testConfigurationManager'; -use(chaiAsPromised); +use(chaiAsPromised.default); suite('Unit Tests - ConfigurationManagerFactory', () => { let factory: ITestConfigurationManagerFactory; diff --git a/src/test/testing/testController/pytest/pytestDiscoveryAdapter.unit.test.ts b/src/test/testing/testController/pytest/pytestDiscoveryAdapter.unit.test.ts index d1587f59bd2d..87b91f6ae2da 100644 --- a/src/test/testing/testController/pytest/pytestDiscoveryAdapter.unit.test.ts +++ b/src/test/testing/testController/pytest/pytestDiscoveryAdapter.unit.test.ts @@ -81,7 +81,7 @@ suite('pytest test discovery adapter', () => { .returns(() => { deferred2.resolve(); return { - proc: mockProc, + proc: mockProc as any, out: output, dispose: () => { /* no-body */ diff --git a/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts b/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts index b82a663cf86c..911cca4a284f 100644 --- a/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts +++ b/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts @@ -55,7 +55,7 @@ suite('pytest test execution adapter', () => { .returns(() => { deferred4.resolve(); return { - proc: mockProc, + proc: mockProc as any, out: output, dispose: () => { /* no-body */ diff --git a/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts b/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts index bddf057d4f0c..fc120ef1f526 100644 --- a/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts +++ b/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts @@ -72,7 +72,7 @@ suite('Execution Flow Run Adapters', () => { .returns(() => { cancellationToken.cancel(); return { - proc: mockProc, + proc: mockProc as any, out: typeMoq.Mock.ofType>>().object, dispose: () => { /* no-body */ @@ -150,7 +150,7 @@ suite('Execution Flow Run Adapters', () => { .returns(() => { cancellationToken.cancel(); return { - proc: mockProc, + proc: mockProc as any, out: typeMoq.Mock.ofType>>().object, dispose: () => { /* no-body */ diff --git a/src/test/testing/testController/unittest/testDiscoveryAdapter.unit.test.ts b/src/test/testing/testController/unittest/testDiscoveryAdapter.unit.test.ts index 7c700fdd4ec4..e0442197467f 100644 --- a/src/test/testing/testController/unittest/testDiscoveryAdapter.unit.test.ts +++ b/src/test/testing/testController/unittest/testDiscoveryAdapter.unit.test.ts @@ -54,7 +54,7 @@ suite('Unittest test discovery adapter', () => { deferred.resolve(); console.log('execObservable is returning'); return { - proc: mockProc, + proc: mockProc as any, out: output, dispose: () => { /* no-body */ diff --git a/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts b/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts index 6d4757eff8d1..6881524af20c 100644 --- a/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts +++ b/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts @@ -55,7 +55,7 @@ suite('Unittest test execution adapter', () => { .returns(() => { deferred4.resolve(); return { - proc: mockProc, + proc: mockProc as any, out: output, dispose: () => { /* no-body */ diff --git a/src/test/utils/fs.ts b/src/test/utils/fs.ts index 2b78184d13e2..13f46bd38f82 100644 --- a/src/test/utils/fs.ts +++ b/src/test/utils/fs.ts @@ -3,7 +3,7 @@ 'use strict'; -import * as fsapi from 'fs-extra'; +import * as fsapi from '../../client/common/platform/fs-paths'; import * as path from 'path'; import * as tmp from 'tmp'; import { parseTree } from '../../client/common/utils/text'; diff --git a/src/test/utils/vscode.ts b/src/test/utils/vscode.ts index a10ceb2e8881..4364c507c36f 100644 --- a/src/test/utils/vscode.ts +++ b/src/test/utils/vscode.ts @@ -1,5 +1,5 @@ import * as path from 'path'; -import * as fs from 'fs-extra'; +import * as fs from '../../client/common/platform/fs-paths'; import { EXTENSION_ROOT_DIR } from '../../client/common/constants'; const insidersVersion = /^\^(\d+\.\d+\.\d+)-(insider|\d{8})$/; diff --git a/tsconfig.browser.json b/tsconfig.browser.json index ca00a4e2b193..e34f3f6788ac 100644 --- a/tsconfig.browser.json +++ b/tsconfig.browser.json @@ -2,6 +2,7 @@ "extends": "./tsconfig.json", "include": [ "./src/client/browser", - "./types" + "./types", + "./typings/*.d.ts", ] } diff --git a/tsconfig.json b/tsconfig.json index 797bf6736f15..718d4ab4aad1 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -4,7 +4,8 @@ "paths": { "*": ["types/*"] }, - "module": "commonjs", + "module": "NodeNext", + "moduleResolution": "NodeNext", "target": "es2018", "outDir": "out", "lib": [ From 16bffdefcb13f98101a7389fc30d3160d2fad8b2 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 26 Aug 2024 13:15:54 -0700 Subject: [PATCH 069/149] Bump importlib-metadata from 8.1.0 to 8.4.0 (#23980) Bumps [importlib-metadata](https://github.com/python/importlib_metadata) from 8.1.0 to 8.4.0.
Changelog

Sourced from importlib-metadata's changelog.

v8.4.0

Features

  • Deferred import of inspect for import performance. (#499)

v8.3.0

Features

  • Disallow passing of 'dist' to EntryPoints.select.

v8.2.0

Features

  • Add SimplePath to importlib_metadata.all. (#494)
Commits

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=importlib-metadata&package-manager=pip&previous-version=8.1.0&new-version=8.4.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) ---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/requirements.txt b/requirements.txt index a58927a27629..82b97eca2bb8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,9 +4,9 @@ # # pip-compile --generate-hashes requirements.in # -importlib-metadata==8.1.0 \ - --hash=sha256:3cd29f739ed65973840b068e3132135ce954c254d48b5b640484467ef7ab3c8c \ - --hash=sha256:fcdcb1d5ead7bdf3dd32657bb94ebe9d2aabfe89a19782ddc32da5041d6ebfb4 +importlib-metadata==8.4.0 \ + --hash=sha256:66f342cc6ac9818fc6ff340576acd24d65ba0b3efabb2b4ac08b598965a4a2f1 \ + --hash=sha256:9a547d3bc3608b025f93d403fdd1aae741c24fbb8314df4b155675742ce303c5 # via -r requirements.in microvenv==2023.5.post1 \ --hash=sha256:32c46afea874e300f69f1add0806eb0795fd02b5fb251092fba0b73c059a7d1f \ From 460f623275b370303e33eb2767654606f9f51ee1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 26 Aug 2024 13:16:38 -0700 Subject: [PATCH 070/149] Bump elliptic from 6.5.4 to 6.5.7 (#23986) Bumps [elliptic](https://github.com/indutny/elliptic) from 6.5.4 to 6.5.7.
Commits

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=elliptic&package-manager=npm_and_yarn&previous-version=6.5.4&new-version=6.5.7)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) ---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/microsoft/vscode-python/network/alerts).
Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index 40be8e47f4dc..91eb74277a07 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5171,9 +5171,9 @@ "dev": true }, "node_modules/elliptic": { - "version": "6.5.4", - "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.4.tgz", - "integrity": "sha512-iLhC6ULemrljPZb+QutR5TQGB+pdW6KGD5RSegS+8sorOZT+rdQFbsQFJgvN3eRqNALqJer4oQ16YvJHlU8hzQ==", + "version": "6.5.7", + "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.7.tgz", + "integrity": "sha512-ESVCtTwiA+XhY3wyh24QqRGBoP3rEdDUl3EDUUo9tft074fi19IrdpH7hLCMMP3CIj7jb3W96rn8lt/BqIlt5Q==", "dev": true, "dependencies": { "bn.js": "^4.11.9", @@ -18644,9 +18644,9 @@ "dev": true }, "elliptic": { - "version": "6.5.4", - "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.4.tgz", - "integrity": "sha512-iLhC6ULemrljPZb+QutR5TQGB+pdW6KGD5RSegS+8sorOZT+rdQFbsQFJgvN3eRqNALqJer4oQ16YvJHlU8hzQ==", + "version": "6.5.7", + "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.7.tgz", + "integrity": "sha512-ESVCtTwiA+XhY3wyh24QqRGBoP3rEdDUl3EDUUo9tft074fi19IrdpH7hLCMMP3CIj7jb3W96rn8lt/BqIlt5Q==", "dev": true, "requires": { "bn.js": "^4.11.9", From 61bc2d510ee0b3d69bed259f21b318c6f129254f Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Mon, 26 Aug 2024 13:36:21 -0700 Subject: [PATCH 071/149] Fix stop sending double telemetry for Terminal REPL (#23995) Related: https://github.com/microsoft/vscode-python/issues/23740 --- src/client/providers/replProvider.ts | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/client/providers/replProvider.ts b/src/client/providers/replProvider.ts index 810e24b78f42..dd9df89a78a3 100644 --- a/src/client/providers/replProvider.ts +++ b/src/client/providers/replProvider.ts @@ -4,8 +4,6 @@ import { Commands } from '../common/constants'; import { noop } from '../common/utils/misc'; import { IInterpreterService } from '../interpreter/contracts'; import { IServiceContainer } from '../ioc/types'; -import { captureTelemetry } from '../telemetry'; -import { EventName } from '../telemetry/constants'; import { ICodeExecutionService } from '../terminals/types'; export class ReplProvider implements Disposable { @@ -28,7 +26,6 @@ export class ReplProvider implements Disposable { this.disposables.push(disposable); } - @captureTelemetry(EventName.REPL, { replType: 'Terminal' }) private async commandHandler() { const resource = this.activeResourceService.getActiveResource(); const interpreterService = this.serviceContainer.get(IInterpreterService); From 7ccf01ebe33624a7dbb7b69abe5e0c3db11d3735 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Mon, 26 Aug 2024 15:31:12 -0700 Subject: [PATCH 072/149] Correctly track native REPL state (#23997) Resolves: #23996 --- src/client/repl/nativeRepl.ts | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/src/client/repl/nativeRepl.ts b/src/client/repl/nativeRepl.ts index eaa97f9518df..8b233f765468 100644 --- a/src/client/repl/nativeRepl.ts +++ b/src/client/repl/nativeRepl.ts @@ -20,6 +20,7 @@ import { createReplController } from './replController'; import { EventName } from '../telemetry/constants'; import { sendTelemetryEvent } from '../telemetry'; +let nativeRepl: NativeRepl | undefined; // In multi REPL scenario, hashmap of URI to Repl. export class NativeRepl implements Disposable { // Adding ! since it will get initialized in create method, not the constructor. private pythonServer!: PythonServer; @@ -34,6 +35,8 @@ export class NativeRepl implements Disposable { private notebookDocument: NotebookDocument | undefined; + public newReplSession: boolean | undefined = true; + // TODO: In the future, could also have attribute of URI for file specific REPL. private constructor() { this.watchNotebookClosed(); @@ -63,6 +66,7 @@ export class NativeRepl implements Disposable { workspace.onDidCloseNotebookDocument((nb) => { if (this.notebookDocument && nb.uri.toString() === this.notebookDocument.uri.toString()) { this.notebookDocument = undefined; + this.newReplSession = true; } }), ); @@ -152,8 +156,6 @@ export class NativeRepl implements Disposable { } } -let nativeRepl: NativeRepl | undefined; // In multi REPL scenario, hashmap of URI to Repl. - /** * Get Singleton Native REPL Instance * @param interpreter @@ -161,9 +163,12 @@ let nativeRepl: NativeRepl | undefined; // In multi REPL scenario, hashmap of UR */ export async function getNativeRepl(interpreter: PythonEnvironment, disposables: Disposable[]): Promise { if (!nativeRepl) { - sendTelemetryEvent(EventName.REPL, undefined, { replType: 'Native' }); nativeRepl = await NativeRepl.create(interpreter); disposables.push(nativeRepl); } + if (nativeRepl && nativeRepl.newReplSession) { + sendTelemetryEvent(EventName.REPL, undefined, { replType: 'Native' }); + nativeRepl.newReplSession = false; + } return nativeRepl; } From eb0ed8efee74c094f3c5691d3cb71be1e06e61a6 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Tue, 3 Sep 2024 10:33:46 -0700 Subject: [PATCH 073/149] Version updates for Python Extension Release 2024.14.0 (#24040) --- build/azure-pipeline.stable.yml | 2 +- package-lock.json | 746 ++++++++++++++++---------------- package.json | 2 +- 3 files changed, 372 insertions(+), 378 deletions(-) diff --git a/build/azure-pipeline.stable.yml b/build/azure-pipeline.stable.yml index 4cd0567ec8c1..8f3210f7ee27 100644 --- a/build/azure-pipeline.stable.yml +++ b/build/azure-pipeline.stable.yml @@ -96,7 +96,7 @@ extends: displayName: Checkout python-environment-tools env: PYTHON_ENV_TOOLS_DEST: $(Build.SourcesDirectory) - PYTHON_ENV_TOOLS_REF: release/2024.12 + PYTHON_ENV_TOOLS_REF: release/2024.14 PYTHON_ENV_TOOLS_TEMP: $(Agent.TempDirectory) - script: nox --session azure_pet_build_before diff --git a/package-lock.json b/package-lock.json index 91eb74277a07..28e55a92fd0c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "python", - "version": "2024.13.0-dev", + "version": "2024.14.0-rc", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "python", - "version": "2024.13.0-dev", + "version": "2024.14.0-rc", "license": "MIT", "dependencies": { "@iarna/toml": "^2.2.5", @@ -1118,14 +1118,14 @@ } }, "node_modules/@jridgewell/gen-mapping": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.2.tgz", - "integrity": "sha512-mh65xKQAzI6iBcFzwv28KVWSmCkdRBWoOh+bYQGW3+6OZvbbN3TqMGo5hqYxQniRcH9F2VZIoJCm4pa3BPDK/A==", + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.5.tgz", + "integrity": "sha512-IzL8ZoEDIBRWEzlCcRhOaCupYyN5gdIK+Q6fbFdPDg6HqX6jpkItn7DFIpW9LQzXG6Df9sA7+OKnq0qlz/GaQg==", "dev": true, "dependencies": { - "@jridgewell/set-array": "^1.0.1", + "@jridgewell/set-array": "^1.2.1", "@jridgewell/sourcemap-codec": "^1.4.10", - "@jridgewell/trace-mapping": "^0.3.9" + "@jridgewell/trace-mapping": "^0.3.24" }, "engines": { "node": ">=6.0.0" @@ -1141,22 +1141,22 @@ } }, "node_modules/@jridgewell/set-array": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.1.2.tgz", - "integrity": "sha512-xnkseuNADM0gt2bs+BvhO0p78Mk762YnZdsuzFV018NoG1Sj1SCQvpSqa7XUaTam5vAGasABV9qXASMKnFMwMw==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.2.1.tgz", + "integrity": "sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A==", "dev": true, "engines": { "node": ">=6.0.0" } }, "node_modules/@jridgewell/source-map": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.2.tgz", - "integrity": "sha512-m7O9o2uR8k2ObDysZYzdfhb08VuEml5oWGiosa1VdaPZ/A6QyPkAJuwN0Q1lhULOf6B7MtQmHENS743hWtCrgw==", + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.6.tgz", + "integrity": "sha512-1ZJTZebgqllO79ue2bm3rIGud/bOe0pP5BjSRCRxxYkEZS8STV7zN84UBbiYu7jy+eCKSnVIUgoWWE/tt+shMQ==", "dev": true, "dependencies": { - "@jridgewell/gen-mapping": "^0.3.0", - "@jridgewell/trace-mapping": "^0.3.9" + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.25" } }, "node_modules/@jridgewell/sourcemap-codec": { @@ -1166,13 +1166,13 @@ "dev": true }, "node_modules/@jridgewell/trace-mapping": { - "version": "0.3.18", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.18.tgz", - "integrity": "sha512-w+niJYzMHdd7USdiH2U6869nqhD2nbfZXND5Yp93qIbEmnDNk7PD48o+YchRVpzMU7M6jVCbenTR7PA1FLQ9pA==", + "version": "0.3.25", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz", + "integrity": "sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ==", "dev": true, "dependencies": { - "@jridgewell/resolve-uri": "3.1.0", - "@jridgewell/sourcemap-codec": "1.4.14" + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" } }, "node_modules/@microsoft/1ds-core-js": { @@ -1646,30 +1646,10 @@ "@types/node": "*" } }, - "node_modules/@types/eslint": { - "version": "8.4.1", - "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-8.4.1.tgz", - "integrity": "sha512-GE44+DNEyxxh2Kc6ro/VkIj+9ma0pO0bwv9+uHSyBrikYOHr8zYcdPvnBOp1aw8s+CjRvuSx7CyWqRrNFQ59mA==", - "dev": true, - "dependencies": { - "@types/estree": "*", - "@types/json-schema": "*" - } - }, - "node_modules/@types/eslint-scope": { - "version": "3.7.3", - "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.3.tgz", - "integrity": "sha512-PB3ldyrcnAicT35TWPs5IcwKD8S333HMaa2VVv4+wdvebJkjWuW/xESoB8IwRcog8HYVYamb1g/R31Qv5Bx03g==", - "dev": true, - "dependencies": { - "@types/eslint": "*", - "@types/estree": "*" - } - }, "node_modules/@types/estree": { - "version": "0.0.51", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.51.tgz", - "integrity": "sha512-CuPgU6f3eT/XgKKPqKd/gLZV1Xmvf1a2R5POBOGQa6uv82xpls89HU5zKeVoyR8XzHd1RGNOlQlvUe3CFkjWNQ==", + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.5.tgz", + "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==", "dev": true }, "node_modules/@types/fs-extra": { @@ -2399,148 +2379,148 @@ } }, "node_modules/@webassemblyjs/ast": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.11.1.tgz", - "integrity": "sha512-ukBh14qFLjxTQNTXocdyksN5QdM28S1CxHt2rdskFyL+xFV7VremuBLVbmCePj+URalXBENx/9Lm7lnhihtCSw==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.12.1.tgz", + "integrity": "sha512-EKfMUOPRRUTy5UII4qJDGPpqfwjOmZ5jeGFwid9mnoqIFK+e0vqoi1qH56JpmZSzEL53jKnNzScdmftJyG5xWg==", "dev": true, "dependencies": { - "@webassemblyjs/helper-numbers": "1.11.1", - "@webassemblyjs/helper-wasm-bytecode": "1.11.1" + "@webassemblyjs/helper-numbers": "1.11.6", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6" } }, "node_modules/@webassemblyjs/floating-point-hex-parser": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.11.1.tgz", - "integrity": "sha512-iGRfyc5Bq+NnNuX8b5hwBrRjzf0ocrJPI6GWFodBFzmFnyvrQ83SHKhmilCU/8Jv67i4GJZBMhEzltxzcNagtQ==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.11.6.tgz", + "integrity": "sha512-ejAj9hfRJ2XMsNHk/v6Fu2dGS+i4UaXBXGemOfQ/JfQ6mdQg/WXtwleQRLLS4OvfDhv8rYnVwH27YJLMyYsxhw==", "dev": true }, "node_modules/@webassemblyjs/helper-api-error": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.11.1.tgz", - "integrity": "sha512-RlhS8CBCXfRUR/cwo2ho9bkheSXG0+NwooXcc3PAILALf2QLdFyj7KGsKRbVc95hZnhnERon4kW/D3SZpp6Tcg==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.11.6.tgz", + "integrity": "sha512-o0YkoP4pVu4rN8aTJgAyj9hC2Sv5UlkzCHhxqWj8butaLvnpdc2jOwh4ewE6CX0txSfLn/UYaV/pheS2Txg//Q==", "dev": true }, "node_modules/@webassemblyjs/helper-buffer": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.11.1.tgz", - "integrity": "sha512-gwikF65aDNeeXa8JxXa2BAk+REjSyhrNC9ZwdT0f8jc4dQQeDQ7G4m0f2QCLPJiMTTO6wfDmRmj/pW0PsUvIcA==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.12.1.tgz", + "integrity": "sha512-nzJwQw99DNDKr9BVCOZcLuJJUlqkJh+kVzVl6Fmq/tI5ZtEyWT1KZMyOXltXLZJmDtvLCDgwsyrkohEtopTXCw==", "dev": true }, "node_modules/@webassemblyjs/helper-numbers": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.11.1.tgz", - "integrity": "sha512-vDkbxiB8zfnPdNK9Rajcey5C0w+QJugEglN0of+kmO8l7lDb77AnlKYQF7aarZuCrv+l0UvqL+68gSDr3k9LPQ==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.11.6.tgz", + "integrity": "sha512-vUIhZ8LZoIWHBohiEObxVm6hwP034jwmc9kuq5GdHZH0wiLVLIPcMCdpJzG4C11cHoQ25TFIQj9kaVADVX7N3g==", "dev": true, "dependencies": { - "@webassemblyjs/floating-point-hex-parser": "1.11.1", - "@webassemblyjs/helper-api-error": "1.11.1", + "@webassemblyjs/floating-point-hex-parser": "1.11.6", + "@webassemblyjs/helper-api-error": "1.11.6", "@xtuc/long": "4.2.2" } }, "node_modules/@webassemblyjs/helper-wasm-bytecode": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.11.1.tgz", - "integrity": "sha512-PvpoOGiJwXeTrSf/qfudJhwlvDQxFgelbMqtq52WWiXC6Xgg1IREdngmPN3bs4RoO83PnL/nFrxucXj1+BX62Q==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.11.6.tgz", + "integrity": "sha512-sFFHKwcmBprO9e7Icf0+gddyWYDViL8bpPjJJl0WHxCdETktXdmtWLGVzoHbqUcY4Be1LkNfwTmXOJUFZYSJdA==", "dev": true }, "node_modules/@webassemblyjs/helper-wasm-section": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.11.1.tgz", - "integrity": "sha512-10P9No29rYX1j7F3EVPX3JvGPQPae+AomuSTPiF9eBQeChHI6iqjMIwR9JmOJXwpnn/oVGDk7I5IlskuMwU/pg==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.12.1.tgz", + "integrity": "sha512-Jif4vfB6FJlUlSbgEMHUyk1j234GTNG9dBJ4XJdOySoj518Xj0oGsNi59cUQF4RRMS9ouBUxDDdyBVfPTypa5g==", "dev": true, "dependencies": { - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/helper-buffer": "1.11.1", - "@webassemblyjs/helper-wasm-bytecode": "1.11.1", - "@webassemblyjs/wasm-gen": "1.11.1" + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-buffer": "1.12.1", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/wasm-gen": "1.12.1" } }, "node_modules/@webassemblyjs/ieee754": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.11.1.tgz", - "integrity": "sha512-hJ87QIPtAMKbFq6CGTkZYJivEwZDbQUgYd3qKSadTNOhVY7p+gfP6Sr0lLRVTaG1JjFj+r3YchoqRYxNH3M0GQ==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.11.6.tgz", + "integrity": "sha512-LM4p2csPNvbij6U1f19v6WR56QZ8JcHg3QIJTlSwzFcmx6WSORicYj6I63f9yU1kEUtrpG+kjkiIAkevHpDXrg==", "dev": true, "dependencies": { "@xtuc/ieee754": "^1.2.0" } }, "node_modules/@webassemblyjs/leb128": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.11.1.tgz", - "integrity": "sha512-BJ2P0hNZ0u+Th1YZXJpzW6miwqQUGcIHT1G/sf72gLVD9DZ5AdYTqPNbHZh6K1M5VmKvFXwGSWZADz+qBWxeRw==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.11.6.tgz", + "integrity": "sha512-m7a0FhE67DQXgouf1tbN5XQcdWoNgaAuoULHIfGFIEVKA6tu/edls6XnIlkmS6FrXAquJRPni3ZZKjw6FSPjPQ==", "dev": true, "dependencies": { "@xtuc/long": "4.2.2" } }, "node_modules/@webassemblyjs/utf8": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.11.1.tgz", - "integrity": "sha512-9kqcxAEdMhiwQkHpkNiorZzqpGrodQQ2IGrHHxCy+Ozng0ofyMA0lTqiLkVs1uzTRejX+/O0EOT7KxqVPuXosQ==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.11.6.tgz", + "integrity": "sha512-vtXf2wTQ3+up9Zsg8sa2yWiQpzSsMyXj0qViVP6xKGCUT8p8YJ6HqI7l5eCnWx1T/FYdsv07HQs2wTFbbof/RA==", "dev": true }, "node_modules/@webassemblyjs/wasm-edit": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.11.1.tgz", - "integrity": "sha512-g+RsupUC1aTHfR8CDgnsVRVZFJqdkFHpsHMfJuWQzWU3tvnLC07UqHICfP+4XyL2tnr1amvl1Sdp06TnYCmVkA==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.12.1.tgz", + "integrity": "sha512-1DuwbVvADvS5mGnXbE+c9NfA8QRcZ6iKquqjjmR10k6o+zzsRVesil54DKexiowcFCPdr/Q0qaMgB01+SQ1u6g==", "dev": true, "dependencies": { - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/helper-buffer": "1.11.1", - "@webassemblyjs/helper-wasm-bytecode": "1.11.1", - "@webassemblyjs/helper-wasm-section": "1.11.1", - "@webassemblyjs/wasm-gen": "1.11.1", - "@webassemblyjs/wasm-opt": "1.11.1", - "@webassemblyjs/wasm-parser": "1.11.1", - "@webassemblyjs/wast-printer": "1.11.1" + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-buffer": "1.12.1", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/helper-wasm-section": "1.12.1", + "@webassemblyjs/wasm-gen": "1.12.1", + "@webassemblyjs/wasm-opt": "1.12.1", + "@webassemblyjs/wasm-parser": "1.12.1", + "@webassemblyjs/wast-printer": "1.12.1" } }, "node_modules/@webassemblyjs/wasm-gen": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.11.1.tgz", - "integrity": "sha512-F7QqKXwwNlMmsulj6+O7r4mmtAlCWfO/0HdgOxSklZfQcDu0TpLiD1mRt/zF25Bk59FIjEuGAIyn5ei4yMfLhA==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.12.1.tgz", + "integrity": "sha512-TDq4Ojh9fcohAw6OIMXqiIcTq5KUXTGRkVxbSo1hQnSy6lAM5GSdfwWeSxpAo0YzgsgF182E/U0mDNhuA0tW7w==", "dev": true, "dependencies": { - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/helper-wasm-bytecode": "1.11.1", - "@webassemblyjs/ieee754": "1.11.1", - "@webassemblyjs/leb128": "1.11.1", - "@webassemblyjs/utf8": "1.11.1" + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/ieee754": "1.11.6", + "@webassemblyjs/leb128": "1.11.6", + "@webassemblyjs/utf8": "1.11.6" } }, "node_modules/@webassemblyjs/wasm-opt": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.11.1.tgz", - "integrity": "sha512-VqnkNqnZlU5EB64pp1l7hdm3hmQw7Vgqa0KF/KCNO9sIpI6Fk6brDEiX+iCOYrvMuBWDws0NkTOxYEb85XQHHw==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.12.1.tgz", + "integrity": "sha512-Jg99j/2gG2iaz3hijw857AVYekZe2SAskcqlWIZXjji5WStnOpVoat3gQfT/Q5tb2djnCjBtMocY/Su1GfxPBg==", "dev": true, "dependencies": { - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/helper-buffer": "1.11.1", - "@webassemblyjs/wasm-gen": "1.11.1", - "@webassemblyjs/wasm-parser": "1.11.1" + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-buffer": "1.12.1", + "@webassemblyjs/wasm-gen": "1.12.1", + "@webassemblyjs/wasm-parser": "1.12.1" } }, "node_modules/@webassemblyjs/wasm-parser": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.11.1.tgz", - "integrity": "sha512-rrBujw+dJu32gYB7/Lup6UhdkPx9S9SnobZzRVL7VcBH9Bt9bCBLEuX/YXOOtBsOZ4NQrRykKhffRWHvigQvOA==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.12.1.tgz", + "integrity": "sha512-xikIi7c2FHXysxXe3COrVUPSheuBtpcfhbpFj4gmu7KRLYOzANztwUU0IbsqvMqzuNK2+glRGWCEqZo1WCLyAQ==", "dev": true, "dependencies": { - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/helper-api-error": "1.11.1", - "@webassemblyjs/helper-wasm-bytecode": "1.11.1", - "@webassemblyjs/ieee754": "1.11.1", - "@webassemblyjs/leb128": "1.11.1", - "@webassemblyjs/utf8": "1.11.1" + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-api-error": "1.11.6", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/ieee754": "1.11.6", + "@webassemblyjs/leb128": "1.11.6", + "@webassemblyjs/utf8": "1.11.6" } }, "node_modules/@webassemblyjs/wast-printer": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.11.1.tgz", - "integrity": "sha512-IQboUWM4eKzWW+N/jij2sRatKMh99QEelo3Eb2q0qXkvPRISAj8Qxtmw5itwqK+TTkBuUIE45AxYPToqPtL5gg==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.12.1.tgz", + "integrity": "sha512-+X4WAlOisVWQMikjbcvY2e0rwPsKQ9F688lksZhBcPycBBuii3O7m8FACbDMWDojpAqvjIncrG8J0XHKyQfVeA==", "dev": true, "dependencies": { - "@webassemblyjs/ast": "1.11.1", + "@webassemblyjs/ast": "1.12.1", "@xtuc/long": "4.2.2" } }, @@ -2611,6 +2591,15 @@ "acorn": "^8" } }, + "node_modules/acorn-import-attributes": { + "version": "1.9.5", + "resolved": "https://registry.npmjs.org/acorn-import-attributes/-/acorn-import-attributes-1.9.5.tgz", + "integrity": "sha512-n02Vykv5uA3eHGM/Z2dQrcD56kL8TyDb2p1+0P83PClMnC/nc+anbQRhIOWnSq4Ke/KvDPrY3C9hDtC/A3eHnQ==", + "dev": true, + "peerDependencies": { + "acorn": "^8" + } + }, "node_modules/acorn-jsx": { "version": "5.3.2", "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", @@ -3518,9 +3507,9 @@ } }, "node_modules/browserslist": { - "version": "4.21.9", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.21.9.tgz", - "integrity": "sha512-M0MFoZzbUrRU4KNfCrDLnvyE7gub+peetoTid3TBIqtunaDJyXlwhakT+/VkvSXcfIzFfK/nkCs4nmyTmxdNSg==", + "version": "4.23.3", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.3.tgz", + "integrity": "sha512-btwCFJVjI4YWDNfau8RhZ+B1Q/VLoUITrm3RlP6y1tYGWIOa+InuYiRGXUBXo8nA1qKmHMyLB/iVQg5TT4eFoA==", "dev": true, "funding": [ { @@ -3537,10 +3526,10 @@ } ], "dependencies": { - "caniuse-lite": "^1.0.30001503", - "electron-to-chromium": "^1.4.431", - "node-releases": "^2.0.12", - "update-browserslist-db": "^1.0.11" + "caniuse-lite": "^1.0.30001646", + "electron-to-chromium": "^1.5.4", + "node-releases": "^2.0.18", + "update-browserslist-db": "^1.1.0" }, "bin": { "browserslist": "cli.js" @@ -3702,9 +3691,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001512", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001512.tgz", - "integrity": "sha512-2S9nK0G/mE+jasCUsMPlARhRCts1ebcp2Ji8Y8PWi4NDE1iRdLCnEPHkEfeBrGC45L4isBx5ur3IQ6yTE2mRZw==", + "version": "1.0.30001655", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001655.tgz", + "integrity": "sha512-jRGVy3iSGO5Uutn2owlb5gR6qsGngTw9ZTb4ali9f3glshcNmJ2noam4Mo9zia5P9Dk3jNNydy7vQjuE5dQmfg==", "dev": true, "funding": [ { @@ -5165,9 +5154,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.4.450", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.450.tgz", - "integrity": "sha512-BLG5HxSELlrMx7dJ2s+8SFlsCtJp37Zpk2VAxyC6CZtbc+9AJeZHfYHbrlSgdXp6saQ8StMqOTEDaBKgA7u1sw==", + "version": "1.5.13", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.13.tgz", + "integrity": "sha512-lbBcvtIJ4J6sS4tb5TLp1b4LyfCdMkwStzXPyAgVgTRAsep4bvrAGaBOP7ZJtQMNJpSQ9SqG4brWOroNaQtm7Q==", "dev": true }, "node_modules/elliptic": { @@ -5224,9 +5213,9 @@ } }, "node_modules/enhanced-resolve": { - "version": "5.12.0", - "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.12.0.tgz", - "integrity": "sha512-QHTXI/sZQmko1cbDoNAa3mJ5qhWUUNAq3vR0/YiD379fWQrcfuoX1+HW2S0MTt7XmoPLapdaDKUtelUSPic7hQ==", + "version": "5.17.1", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.17.1.tgz", + "integrity": "sha512-LMHl3dXhTcfv8gM4kEzIUeTQ+7fpdA0l2tUf34BddXPkz2A5xJ5L/Pchd5BL6rdccM9QGvu0sWZzK1Z1t4wwyg==", "dev": true, "dependencies": { "graceful-fs": "^4.2.4", @@ -5360,9 +5349,9 @@ } }, "node_modules/es-module-lexer": { - "version": "0.9.3", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-0.9.3.tgz", - "integrity": "sha512-1HQ2M2sPtxwnvOvT1ZClHyQDiggdNjURWpY2we6aMKCQiUVxTmVs2UYPLIrD84sS+kMdUwfBSylbJPwNnBrnHQ==", + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.5.4.tgz", + "integrity": "sha512-MVNK56NiMrOwitFB7cqDwq0CQutbw+0BvLshJSse0MUNU+y1FC3bUS/AQg7oUng+/wKrrki7JfmwtVHkVfPLlw==", "dev": true }, "node_modules/es-object-atoms": { @@ -5430,9 +5419,9 @@ "dev": true }, "node_modules/escalade": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", - "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", "dev": true, "engines": { "node": ">=6" @@ -9538,9 +9527,9 @@ } }, "node_modules/micromatch": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", - "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "dev": true, "dependencies": { "braces": "^3.0.3", @@ -10326,9 +10315,9 @@ } }, "node_modules/node-releases": { - "version": "2.0.12", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.12.tgz", - "integrity": "sha512-QzsYKWhXTWx8h1kIvqfnC++o0pEmpRQA/aenALsL2F4pqNVr7YzcdMlDij5WBnwftRbJCNJL/O7zdKaxKPHqgQ==", + "version": "2.0.18", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.18.tgz", + "integrity": "sha512-d9VeXT4SJ7ZeOqGX6R5EM022wpL+eWPooLI+5UpWn2jCT1aosUQEhQP214x33Wkwx3JQMvIm+tIoVOdodFS40g==", "dev": true }, "node_modules/node-stream-zip": { @@ -11044,9 +11033,9 @@ "dev": true }, "node_modules/picocolors": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", - "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.0.tgz", + "integrity": "sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==", "dev": true }, "node_modules/picomatch": { @@ -11842,9 +11831,9 @@ "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==" }, "node_modules/schema-utils": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.1.1.tgz", - "integrity": "sha512-Y5PQxS4ITlC+EahLuXaY86TXfR7Dc5lw294alXOq86JAHCihAIZfqv8nNCWvaEJvaC51uN9hbLGeV0cFBdH+Fw==", + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", "dev": true, "dependencies": { "@types/json-schema": "^7.0.8", @@ -12769,13 +12758,13 @@ } }, "node_modules/terser": { - "version": "5.14.2", - "resolved": "https://registry.npmjs.org/terser/-/terser-5.14.2.tgz", - "integrity": "sha512-oL0rGeM/WFQCUd0y2QrWxYnq7tfSuKBiqTjRPWrRgB46WD/kiwHwF8T23z78H6Q6kGCuuHcPB+KULHRdxvVGQA==", + "version": "5.31.6", + "resolved": "https://registry.npmjs.org/terser/-/terser-5.31.6.tgz", + "integrity": "sha512-PQ4DAriWzKj+qgehQ7LK5bQqCFNMmlhjR2PFFLuqGCpuCAauxemVBWwWOxo3UIwWQx8+Pr61Df++r76wDmkQBg==", "dev": true, "dependencies": { - "@jridgewell/source-map": "^0.3.2", - "acorn": "^8.5.0", + "@jridgewell/source-map": "^0.3.3", + "acorn": "^8.8.2", "commander": "^2.20.0", "source-map-support": "~0.5.20" }, @@ -12787,16 +12776,16 @@ } }, "node_modules/terser-webpack-plugin": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.1.tgz", - "integrity": "sha512-GvlZdT6wPQKbDNW/GDQzZFg/j4vKU96yl2q6mcUkzKOgW4gwf1Z8cZToUCrz31XHlPWH8MVb1r2tFtdDtTGJ7g==", + "version": "5.3.10", + "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.10.tgz", + "integrity": "sha512-BKFPWlPDndPs+NGGCr1U59t0XScL5317Y0UReNrHaw9/FwhPENlq6bfgs+4yPfyP51vqC1bQ4rp1EfXW5ZSH9w==", "dev": true, "dependencies": { + "@jridgewell/trace-mapping": "^0.3.20", "jest-worker": "^27.4.5", "schema-utils": "^3.1.1", - "serialize-javascript": "^6.0.0", - "source-map": "^0.6.1", - "terser": "^5.7.2" + "serialize-javascript": "^6.0.1", + "terser": "^5.26.0" }, "engines": { "node": ">= 10.13.0" @@ -12820,6 +12809,15 @@ } } }, + "node_modules/terser-webpack-plugin/node_modules/serialize-javascript": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", + "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", + "dev": true, + "dependencies": { + "randombytes": "^2.1.0" + } + }, "node_modules/test-exclude": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", @@ -13558,9 +13556,9 @@ } }, "node_modules/update-browserslist-db": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.11.tgz", - "integrity": "sha512-dCwEFf0/oT85M1fHBg4F0jtLwJrutGoHSQXCh7u4o2t1drG+c0a9Flnqww6XUKSfQMPpJBRjU8d4RXB09qtvaA==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.0.tgz", + "integrity": "sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ==", "dev": true, "funding": [ { @@ -13577,8 +13575,8 @@ } ], "dependencies": { - "escalade": "^3.1.1", - "picocolors": "^1.0.0" + "escalade": "^3.1.2", + "picocolors": "^1.0.1" }, "bin": { "update-browserslist-db": "cli.js" @@ -13941,9 +13939,9 @@ } }, "node_modules/watchpack": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.4.0.tgz", - "integrity": "sha512-Lcvm7MGST/4fup+ifyKi2hjyIAwcdI4HRgtvTpIUxBRhB+RFtUh8XtDOxUfctVCnhVi+QQj49i91OyvzkJl6cg==", + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.4.2.tgz", + "integrity": "sha512-TnbFSbcOCcDgjZ4piURLCbJ3nJhznVh9kw6F6iokjiFPl8ONxe9A6nMDVXDiNbrSfLILs6vB07F7wLBrwPYzJw==", "dev": true, "dependencies": { "glob-to-regexp": "^0.4.1", @@ -13954,34 +13952,33 @@ } }, "node_modules/webpack": { - "version": "5.76.0", - "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.76.0.tgz", - "integrity": "sha512-l5sOdYBDunyf72HW8dF23rFtWq/7Zgvt/9ftMof71E/yUb1YLOBmTgA2K4vQthB3kotMrSj609txVE0dnr2fjA==", + "version": "5.94.0", + "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.94.0.tgz", + "integrity": "sha512-KcsGn50VT+06JH/iunZJedYGUJS5FGjow8wb9c0v5n1Om8O1g4L6LjtfxwlXIATopoQu+vOXXa7gYisWxCoPyg==", "dev": true, "dependencies": { - "@types/eslint-scope": "^3.7.3", - "@types/estree": "^0.0.51", - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/wasm-edit": "1.11.1", - "@webassemblyjs/wasm-parser": "1.11.1", + "@types/estree": "^1.0.5", + "@webassemblyjs/ast": "^1.12.1", + "@webassemblyjs/wasm-edit": "^1.12.1", + "@webassemblyjs/wasm-parser": "^1.12.1", "acorn": "^8.7.1", - "acorn-import-assertions": "^1.7.6", - "browserslist": "^4.14.5", + "acorn-import-attributes": "^1.9.5", + "browserslist": "^4.21.10", "chrome-trace-event": "^1.0.2", - "enhanced-resolve": "^5.10.0", - "es-module-lexer": "^0.9.0", + "enhanced-resolve": "^5.17.1", + "es-module-lexer": "^1.2.1", "eslint-scope": "5.1.1", "events": "^3.2.0", "glob-to-regexp": "^0.4.1", - "graceful-fs": "^4.2.9", + "graceful-fs": "^4.2.11", "json-parse-even-better-errors": "^2.3.1", "loader-runner": "^4.2.0", "mime-types": "^2.1.27", "neo-async": "^2.6.2", - "schema-utils": "^3.1.0", + "schema-utils": "^3.2.0", "tapable": "^2.1.1", - "terser-webpack-plugin": "^5.1.3", - "watchpack": "^2.4.0", + "terser-webpack-plugin": "^5.3.10", + "watchpack": "^2.4.1", "webpack-sources": "^3.2.3" }, "bin": { @@ -15442,14 +15439,14 @@ "dev": true }, "@jridgewell/gen-mapping": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.2.tgz", - "integrity": "sha512-mh65xKQAzI6iBcFzwv28KVWSmCkdRBWoOh+bYQGW3+6OZvbbN3TqMGo5hqYxQniRcH9F2VZIoJCm4pa3BPDK/A==", + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.5.tgz", + "integrity": "sha512-IzL8ZoEDIBRWEzlCcRhOaCupYyN5gdIK+Q6fbFdPDg6HqX6jpkItn7DFIpW9LQzXG6Df9sA7+OKnq0qlz/GaQg==", "dev": true, "requires": { - "@jridgewell/set-array": "^1.0.1", + "@jridgewell/set-array": "^1.2.1", "@jridgewell/sourcemap-codec": "^1.4.10", - "@jridgewell/trace-mapping": "^0.3.9" + "@jridgewell/trace-mapping": "^0.3.24" } }, "@jridgewell/resolve-uri": { @@ -15459,19 +15456,19 @@ "dev": true }, "@jridgewell/set-array": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.1.2.tgz", - "integrity": "sha512-xnkseuNADM0gt2bs+BvhO0p78Mk762YnZdsuzFV018NoG1Sj1SCQvpSqa7XUaTam5vAGasABV9qXASMKnFMwMw==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.2.1.tgz", + "integrity": "sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A==", "dev": true }, "@jridgewell/source-map": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.2.tgz", - "integrity": "sha512-m7O9o2uR8k2ObDysZYzdfhb08VuEml5oWGiosa1VdaPZ/A6QyPkAJuwN0Q1lhULOf6B7MtQmHENS743hWtCrgw==", + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.6.tgz", + "integrity": "sha512-1ZJTZebgqllO79ue2bm3rIGud/bOe0pP5BjSRCRxxYkEZS8STV7zN84UBbiYu7jy+eCKSnVIUgoWWE/tt+shMQ==", "dev": true, "requires": { - "@jridgewell/gen-mapping": "^0.3.0", - "@jridgewell/trace-mapping": "^0.3.9" + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.25" } }, "@jridgewell/sourcemap-codec": { @@ -15481,13 +15478,13 @@ "dev": true }, "@jridgewell/trace-mapping": { - "version": "0.3.18", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.18.tgz", - "integrity": "sha512-w+niJYzMHdd7USdiH2U6869nqhD2nbfZXND5Yp93qIbEmnDNk7PD48o+YchRVpzMU7M6jVCbenTR7PA1FLQ9pA==", + "version": "0.3.25", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz", + "integrity": "sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ==", "dev": true, "requires": { - "@jridgewell/resolve-uri": "3.1.0", - "@jridgewell/sourcemap-codec": "1.4.14" + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" } }, "@microsoft/1ds-core-js": { @@ -15900,30 +15897,10 @@ "@types/node": "*" } }, - "@types/eslint": { - "version": "8.4.1", - "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-8.4.1.tgz", - "integrity": "sha512-GE44+DNEyxxh2Kc6ro/VkIj+9ma0pO0bwv9+uHSyBrikYOHr8zYcdPvnBOp1aw8s+CjRvuSx7CyWqRrNFQ59mA==", - "dev": true, - "requires": { - "@types/estree": "*", - "@types/json-schema": "*" - } - }, - "@types/eslint-scope": { - "version": "3.7.3", - "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.3.tgz", - "integrity": "sha512-PB3ldyrcnAicT35TWPs5IcwKD8S333HMaa2VVv4+wdvebJkjWuW/xESoB8IwRcog8HYVYamb1g/R31Qv5Bx03g==", - "dev": true, - "requires": { - "@types/eslint": "*", - "@types/estree": "*" - } - }, "@types/estree": { - "version": "0.0.51", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.51.tgz", - "integrity": "sha512-CuPgU6f3eT/XgKKPqKd/gLZV1Xmvf1a2R5POBOGQa6uv82xpls89HU5zKeVoyR8XzHd1RGNOlQlvUe3CFkjWNQ==", + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.5.tgz", + "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==", "dev": true }, "@types/fs-extra": { @@ -16452,148 +16429,148 @@ "optional": true }, "@webassemblyjs/ast": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.11.1.tgz", - "integrity": "sha512-ukBh14qFLjxTQNTXocdyksN5QdM28S1CxHt2rdskFyL+xFV7VremuBLVbmCePj+URalXBENx/9Lm7lnhihtCSw==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.12.1.tgz", + "integrity": "sha512-EKfMUOPRRUTy5UII4qJDGPpqfwjOmZ5jeGFwid9mnoqIFK+e0vqoi1qH56JpmZSzEL53jKnNzScdmftJyG5xWg==", "dev": true, "requires": { - "@webassemblyjs/helper-numbers": "1.11.1", - "@webassemblyjs/helper-wasm-bytecode": "1.11.1" + "@webassemblyjs/helper-numbers": "1.11.6", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6" } }, "@webassemblyjs/floating-point-hex-parser": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.11.1.tgz", - "integrity": "sha512-iGRfyc5Bq+NnNuX8b5hwBrRjzf0ocrJPI6GWFodBFzmFnyvrQ83SHKhmilCU/8Jv67i4GJZBMhEzltxzcNagtQ==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.11.6.tgz", + "integrity": "sha512-ejAj9hfRJ2XMsNHk/v6Fu2dGS+i4UaXBXGemOfQ/JfQ6mdQg/WXtwleQRLLS4OvfDhv8rYnVwH27YJLMyYsxhw==", "dev": true }, "@webassemblyjs/helper-api-error": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.11.1.tgz", - "integrity": "sha512-RlhS8CBCXfRUR/cwo2ho9bkheSXG0+NwooXcc3PAILALf2QLdFyj7KGsKRbVc95hZnhnERon4kW/D3SZpp6Tcg==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.11.6.tgz", + "integrity": "sha512-o0YkoP4pVu4rN8aTJgAyj9hC2Sv5UlkzCHhxqWj8butaLvnpdc2jOwh4ewE6CX0txSfLn/UYaV/pheS2Txg//Q==", "dev": true }, "@webassemblyjs/helper-buffer": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.11.1.tgz", - "integrity": "sha512-gwikF65aDNeeXa8JxXa2BAk+REjSyhrNC9ZwdT0f8jc4dQQeDQ7G4m0f2QCLPJiMTTO6wfDmRmj/pW0PsUvIcA==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.12.1.tgz", + "integrity": "sha512-nzJwQw99DNDKr9BVCOZcLuJJUlqkJh+kVzVl6Fmq/tI5ZtEyWT1KZMyOXltXLZJmDtvLCDgwsyrkohEtopTXCw==", "dev": true }, "@webassemblyjs/helper-numbers": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.11.1.tgz", - "integrity": "sha512-vDkbxiB8zfnPdNK9Rajcey5C0w+QJugEglN0of+kmO8l7lDb77AnlKYQF7aarZuCrv+l0UvqL+68gSDr3k9LPQ==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.11.6.tgz", + "integrity": "sha512-vUIhZ8LZoIWHBohiEObxVm6hwP034jwmc9kuq5GdHZH0wiLVLIPcMCdpJzG4C11cHoQ25TFIQj9kaVADVX7N3g==", "dev": true, "requires": { - "@webassemblyjs/floating-point-hex-parser": "1.11.1", - "@webassemblyjs/helper-api-error": "1.11.1", + "@webassemblyjs/floating-point-hex-parser": "1.11.6", + "@webassemblyjs/helper-api-error": "1.11.6", "@xtuc/long": "4.2.2" } }, "@webassemblyjs/helper-wasm-bytecode": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.11.1.tgz", - "integrity": "sha512-PvpoOGiJwXeTrSf/qfudJhwlvDQxFgelbMqtq52WWiXC6Xgg1IREdngmPN3bs4RoO83PnL/nFrxucXj1+BX62Q==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.11.6.tgz", + "integrity": "sha512-sFFHKwcmBprO9e7Icf0+gddyWYDViL8bpPjJJl0WHxCdETktXdmtWLGVzoHbqUcY4Be1LkNfwTmXOJUFZYSJdA==", "dev": true }, "@webassemblyjs/helper-wasm-section": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.11.1.tgz", - "integrity": "sha512-10P9No29rYX1j7F3EVPX3JvGPQPae+AomuSTPiF9eBQeChHI6iqjMIwR9JmOJXwpnn/oVGDk7I5IlskuMwU/pg==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.12.1.tgz", + "integrity": "sha512-Jif4vfB6FJlUlSbgEMHUyk1j234GTNG9dBJ4XJdOySoj518Xj0oGsNi59cUQF4RRMS9ouBUxDDdyBVfPTypa5g==", "dev": true, "requires": { - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/helper-buffer": "1.11.1", - "@webassemblyjs/helper-wasm-bytecode": "1.11.1", - "@webassemblyjs/wasm-gen": "1.11.1" + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-buffer": "1.12.1", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/wasm-gen": "1.12.1" } }, "@webassemblyjs/ieee754": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.11.1.tgz", - "integrity": "sha512-hJ87QIPtAMKbFq6CGTkZYJivEwZDbQUgYd3qKSadTNOhVY7p+gfP6Sr0lLRVTaG1JjFj+r3YchoqRYxNH3M0GQ==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.11.6.tgz", + "integrity": "sha512-LM4p2csPNvbij6U1f19v6WR56QZ8JcHg3QIJTlSwzFcmx6WSORicYj6I63f9yU1kEUtrpG+kjkiIAkevHpDXrg==", "dev": true, "requires": { "@xtuc/ieee754": "^1.2.0" } }, "@webassemblyjs/leb128": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.11.1.tgz", - "integrity": "sha512-BJ2P0hNZ0u+Th1YZXJpzW6miwqQUGcIHT1G/sf72gLVD9DZ5AdYTqPNbHZh6K1M5VmKvFXwGSWZADz+qBWxeRw==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.11.6.tgz", + "integrity": "sha512-m7a0FhE67DQXgouf1tbN5XQcdWoNgaAuoULHIfGFIEVKA6tu/edls6XnIlkmS6FrXAquJRPni3ZZKjw6FSPjPQ==", "dev": true, "requires": { "@xtuc/long": "4.2.2" } }, "@webassemblyjs/utf8": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.11.1.tgz", - "integrity": "sha512-9kqcxAEdMhiwQkHpkNiorZzqpGrodQQ2IGrHHxCy+Ozng0ofyMA0lTqiLkVs1uzTRejX+/O0EOT7KxqVPuXosQ==", + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.11.6.tgz", + "integrity": "sha512-vtXf2wTQ3+up9Zsg8sa2yWiQpzSsMyXj0qViVP6xKGCUT8p8YJ6HqI7l5eCnWx1T/FYdsv07HQs2wTFbbof/RA==", "dev": true }, "@webassemblyjs/wasm-edit": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.11.1.tgz", - "integrity": "sha512-g+RsupUC1aTHfR8CDgnsVRVZFJqdkFHpsHMfJuWQzWU3tvnLC07UqHICfP+4XyL2tnr1amvl1Sdp06TnYCmVkA==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.12.1.tgz", + "integrity": "sha512-1DuwbVvADvS5mGnXbE+c9NfA8QRcZ6iKquqjjmR10k6o+zzsRVesil54DKexiowcFCPdr/Q0qaMgB01+SQ1u6g==", "dev": true, "requires": { - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/helper-buffer": "1.11.1", - "@webassemblyjs/helper-wasm-bytecode": "1.11.1", - "@webassemblyjs/helper-wasm-section": "1.11.1", - "@webassemblyjs/wasm-gen": "1.11.1", - "@webassemblyjs/wasm-opt": "1.11.1", - "@webassemblyjs/wasm-parser": "1.11.1", - "@webassemblyjs/wast-printer": "1.11.1" + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-buffer": "1.12.1", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/helper-wasm-section": "1.12.1", + "@webassemblyjs/wasm-gen": "1.12.1", + "@webassemblyjs/wasm-opt": "1.12.1", + "@webassemblyjs/wasm-parser": "1.12.1", + "@webassemblyjs/wast-printer": "1.12.1" } }, "@webassemblyjs/wasm-gen": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.11.1.tgz", - "integrity": "sha512-F7QqKXwwNlMmsulj6+O7r4mmtAlCWfO/0HdgOxSklZfQcDu0TpLiD1mRt/zF25Bk59FIjEuGAIyn5ei4yMfLhA==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.12.1.tgz", + "integrity": "sha512-TDq4Ojh9fcohAw6OIMXqiIcTq5KUXTGRkVxbSo1hQnSy6lAM5GSdfwWeSxpAo0YzgsgF182E/U0mDNhuA0tW7w==", "dev": true, "requires": { - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/helper-wasm-bytecode": "1.11.1", - "@webassemblyjs/ieee754": "1.11.1", - "@webassemblyjs/leb128": "1.11.1", - "@webassemblyjs/utf8": "1.11.1" + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/ieee754": "1.11.6", + "@webassemblyjs/leb128": "1.11.6", + "@webassemblyjs/utf8": "1.11.6" } }, "@webassemblyjs/wasm-opt": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.11.1.tgz", - "integrity": "sha512-VqnkNqnZlU5EB64pp1l7hdm3hmQw7Vgqa0KF/KCNO9sIpI6Fk6brDEiX+iCOYrvMuBWDws0NkTOxYEb85XQHHw==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.12.1.tgz", + "integrity": "sha512-Jg99j/2gG2iaz3hijw857AVYekZe2SAskcqlWIZXjji5WStnOpVoat3gQfT/Q5tb2djnCjBtMocY/Su1GfxPBg==", "dev": true, "requires": { - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/helper-buffer": "1.11.1", - "@webassemblyjs/wasm-gen": "1.11.1", - "@webassemblyjs/wasm-parser": "1.11.1" + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-buffer": "1.12.1", + "@webassemblyjs/wasm-gen": "1.12.1", + "@webassemblyjs/wasm-parser": "1.12.1" } }, "@webassemblyjs/wasm-parser": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.11.1.tgz", - "integrity": "sha512-rrBujw+dJu32gYB7/Lup6UhdkPx9S9SnobZzRVL7VcBH9Bt9bCBLEuX/YXOOtBsOZ4NQrRykKhffRWHvigQvOA==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.12.1.tgz", + "integrity": "sha512-xikIi7c2FHXysxXe3COrVUPSheuBtpcfhbpFj4gmu7KRLYOzANztwUU0IbsqvMqzuNK2+glRGWCEqZo1WCLyAQ==", "dev": true, "requires": { - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/helper-api-error": "1.11.1", - "@webassemblyjs/helper-wasm-bytecode": "1.11.1", - "@webassemblyjs/ieee754": "1.11.1", - "@webassemblyjs/leb128": "1.11.1", - "@webassemblyjs/utf8": "1.11.1" + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-api-error": "1.11.6", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/ieee754": "1.11.6", + "@webassemblyjs/leb128": "1.11.6", + "@webassemblyjs/utf8": "1.11.6" } }, "@webassemblyjs/wast-printer": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.11.1.tgz", - "integrity": "sha512-IQboUWM4eKzWW+N/jij2sRatKMh99QEelo3Eb2q0qXkvPRISAj8Qxtmw5itwqK+TTkBuUIE45AxYPToqPtL5gg==", + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.12.1.tgz", + "integrity": "sha512-+X4WAlOisVWQMikjbcvY2e0rwPsKQ9F688lksZhBcPycBBuii3O7m8FACbDMWDojpAqvjIncrG8J0XHKyQfVeA==", "dev": true, "requires": { - "@webassemblyjs/ast": "1.11.1", + "@webassemblyjs/ast": "1.12.1", "@xtuc/long": "4.2.2" } }, @@ -16643,6 +16620,13 @@ "integrity": "sha512-cmMwop9x+8KFhxvKrKfPYmN6/pKTYYHBqLa0DfvVZcKMJWNyWLnaqND7dx/qn66R7ewM1UX5XMaDVP5wlVTaVA==", "requires": {} }, + "acorn-import-attributes": { + "version": "1.9.5", + "resolved": "https://registry.npmjs.org/acorn-import-attributes/-/acorn-import-attributes-1.9.5.tgz", + "integrity": "sha512-n02Vykv5uA3eHGM/Z2dQrcD56kL8TyDb2p1+0P83PClMnC/nc+anbQRhIOWnSq4Ke/KvDPrY3C9hDtC/A3eHnQ==", + "dev": true, + "requires": {} + }, "acorn-jsx": { "version": "5.3.2", "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", @@ -17349,15 +17333,15 @@ } }, "browserslist": { - "version": "4.21.9", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.21.9.tgz", - "integrity": "sha512-M0MFoZzbUrRU4KNfCrDLnvyE7gub+peetoTid3TBIqtunaDJyXlwhakT+/VkvSXcfIzFfK/nkCs4nmyTmxdNSg==", + "version": "4.23.3", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.3.tgz", + "integrity": "sha512-btwCFJVjI4YWDNfau8RhZ+B1Q/VLoUITrm3RlP6y1tYGWIOa+InuYiRGXUBXo8nA1qKmHMyLB/iVQg5TT4eFoA==", "dev": true, "requires": { - "caniuse-lite": "^1.0.30001503", - "electron-to-chromium": "^1.4.431", - "node-releases": "^2.0.12", - "update-browserslist-db": "^1.0.11" + "caniuse-lite": "^1.0.30001646", + "electron-to-chromium": "^1.5.4", + "node-releases": "^2.0.18", + "update-browserslist-db": "^1.1.0" } }, "buffer": { @@ -17483,9 +17467,9 @@ "dev": true }, "caniuse-lite": { - "version": "1.0.30001512", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001512.tgz", - "integrity": "sha512-2S9nK0G/mE+jasCUsMPlARhRCts1ebcp2Ji8Y8PWi4NDE1iRdLCnEPHkEfeBrGC45L4isBx5ur3IQ6yTE2mRZw==", + "version": "1.0.30001655", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001655.tgz", + "integrity": "sha512-jRGVy3iSGO5Uutn2owlb5gR6qsGngTw9ZTb4ali9f3glshcNmJ2noam4Mo9zia5P9Dk3jNNydy7vQjuE5dQmfg==", "dev": true }, "caseless": { @@ -18638,9 +18622,9 @@ } }, "electron-to-chromium": { - "version": "1.4.450", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.450.tgz", - "integrity": "sha512-BLG5HxSELlrMx7dJ2s+8SFlsCtJp37Zpk2VAxyC6CZtbc+9AJeZHfYHbrlSgdXp6saQ8StMqOTEDaBKgA7u1sw==", + "version": "1.5.13", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.13.tgz", + "integrity": "sha512-lbBcvtIJ4J6sS4tb5TLp1b4LyfCdMkwStzXPyAgVgTRAsep4bvrAGaBOP7ZJtQMNJpSQ9SqG4brWOroNaQtm7Q==", "dev": true }, "elliptic": { @@ -18696,9 +18680,9 @@ } }, "enhanced-resolve": { - "version": "5.12.0", - "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.12.0.tgz", - "integrity": "sha512-QHTXI/sZQmko1cbDoNAa3mJ5qhWUUNAq3vR0/YiD379fWQrcfuoX1+HW2S0MTt7XmoPLapdaDKUtelUSPic7hQ==", + "version": "5.17.1", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.17.1.tgz", + "integrity": "sha512-LMHl3dXhTcfv8gM4kEzIUeTQ+7fpdA0l2tUf34BddXPkz2A5xJ5L/Pchd5BL6rdccM9QGvu0sWZzK1Z1t4wwyg==", "dev": true, "requires": { "graceful-fs": "^4.2.4", @@ -18804,9 +18788,9 @@ "dev": true }, "es-module-lexer": { - "version": "0.9.3", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-0.9.3.tgz", - "integrity": "sha512-1HQ2M2sPtxwnvOvT1ZClHyQDiggdNjURWpY2we6aMKCQiUVxTmVs2UYPLIrD84sS+kMdUwfBSylbJPwNnBrnHQ==", + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.5.4.tgz", + "integrity": "sha512-MVNK56NiMrOwitFB7cqDwq0CQutbw+0BvLshJSse0MUNU+y1FC3bUS/AQg7oUng+/wKrrki7JfmwtVHkVfPLlw==", "dev": true }, "es-object-atoms": { @@ -18862,9 +18846,9 @@ "dev": true }, "escalade": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", - "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", "dev": true }, "escape-string-regexp": { @@ -21993,9 +21977,9 @@ "dev": true }, "micromatch": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", - "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "dev": true, "requires": { "braces": "^3.0.3", @@ -22606,9 +22590,9 @@ } }, "node-releases": { - "version": "2.0.12", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.12.tgz", - "integrity": "sha512-QzsYKWhXTWx8h1kIvqfnC++o0pEmpRQA/aenALsL2F4pqNVr7YzcdMlDij5WBnwftRbJCNJL/O7zdKaxKPHqgQ==", + "version": "2.0.18", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.18.tgz", + "integrity": "sha512-d9VeXT4SJ7ZeOqGX6R5EM022wpL+eWPooLI+5UpWn2jCT1aosUQEhQP214x33Wkwx3JQMvIm+tIoVOdodFS40g==", "dev": true }, "node-stream-zip": { @@ -23158,9 +23142,9 @@ "dev": true }, "picocolors": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", - "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.0.tgz", + "integrity": "sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==", "dev": true }, "picomatch": { @@ -23765,9 +23749,9 @@ "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==" }, "schema-utils": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.1.1.tgz", - "integrity": "sha512-Y5PQxS4ITlC+EahLuXaY86TXfR7Dc5lw294alXOq86JAHCihAIZfqv8nNCWvaEJvaC51uN9hbLGeV0cFBdH+Fw==", + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", "dev": true, "requires": { "@types/json-schema": "^7.0.8", @@ -24479,28 +24463,39 @@ } }, "terser": { - "version": "5.14.2", - "resolved": "https://registry.npmjs.org/terser/-/terser-5.14.2.tgz", - "integrity": "sha512-oL0rGeM/WFQCUd0y2QrWxYnq7tfSuKBiqTjRPWrRgB46WD/kiwHwF8T23z78H6Q6kGCuuHcPB+KULHRdxvVGQA==", + "version": "5.31.6", + "resolved": "https://registry.npmjs.org/terser/-/terser-5.31.6.tgz", + "integrity": "sha512-PQ4DAriWzKj+qgehQ7LK5bQqCFNMmlhjR2PFFLuqGCpuCAauxemVBWwWOxo3UIwWQx8+Pr61Df++r76wDmkQBg==", "dev": true, "requires": { - "@jridgewell/source-map": "^0.3.2", - "acorn": "^8.5.0", + "@jridgewell/source-map": "^0.3.3", + "acorn": "^8.8.2", "commander": "^2.20.0", "source-map-support": "~0.5.20" } }, "terser-webpack-plugin": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.1.tgz", - "integrity": "sha512-GvlZdT6wPQKbDNW/GDQzZFg/j4vKU96yl2q6mcUkzKOgW4gwf1Z8cZToUCrz31XHlPWH8MVb1r2tFtdDtTGJ7g==", + "version": "5.3.10", + "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.10.tgz", + "integrity": "sha512-BKFPWlPDndPs+NGGCr1U59t0XScL5317Y0UReNrHaw9/FwhPENlq6bfgs+4yPfyP51vqC1bQ4rp1EfXW5ZSH9w==", "dev": true, "requires": { + "@jridgewell/trace-mapping": "^0.3.20", "jest-worker": "^27.4.5", "schema-utils": "^3.1.1", - "serialize-javascript": "^6.0.0", - "source-map": "^0.6.1", - "terser": "^5.7.2" + "serialize-javascript": "^6.0.1", + "terser": "^5.26.0" + }, + "dependencies": { + "serialize-javascript": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", + "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", + "dev": true, + "requires": { + "randombytes": "^2.1.0" + } + } } }, "test-exclude": { @@ -25074,13 +25069,13 @@ } }, "update-browserslist-db": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.11.tgz", - "integrity": "sha512-dCwEFf0/oT85M1fHBg4F0jtLwJrutGoHSQXCh7u4o2t1drG+c0a9Flnqww6XUKSfQMPpJBRjU8d4RXB09qtvaA==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.0.tgz", + "integrity": "sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ==", "dev": true, "requires": { - "escalade": "^3.1.1", - "picocolors": "^1.0.0" + "escalade": "^3.1.2", + "picocolors": "^1.0.1" } }, "uri-js": { @@ -25378,9 +25373,9 @@ } }, "watchpack": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.4.0.tgz", - "integrity": "sha512-Lcvm7MGST/4fup+ifyKi2hjyIAwcdI4HRgtvTpIUxBRhB+RFtUh8XtDOxUfctVCnhVi+QQj49i91OyvzkJl6cg==", + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.4.2.tgz", + "integrity": "sha512-TnbFSbcOCcDgjZ4piURLCbJ3nJhznVh9kw6F6iokjiFPl8ONxe9A6nMDVXDiNbrSfLILs6vB07F7wLBrwPYzJw==", "dev": true, "requires": { "glob-to-regexp": "^0.4.1", @@ -25388,34 +25383,33 @@ } }, "webpack": { - "version": "5.76.0", - "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.76.0.tgz", - "integrity": "sha512-l5sOdYBDunyf72HW8dF23rFtWq/7Zgvt/9ftMof71E/yUb1YLOBmTgA2K4vQthB3kotMrSj609txVE0dnr2fjA==", + "version": "5.94.0", + "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.94.0.tgz", + "integrity": "sha512-KcsGn50VT+06JH/iunZJedYGUJS5FGjow8wb9c0v5n1Om8O1g4L6LjtfxwlXIATopoQu+vOXXa7gYisWxCoPyg==", "dev": true, "requires": { - "@types/eslint-scope": "^3.7.3", - "@types/estree": "^0.0.51", - "@webassemblyjs/ast": "1.11.1", - "@webassemblyjs/wasm-edit": "1.11.1", - "@webassemblyjs/wasm-parser": "1.11.1", + "@types/estree": "^1.0.5", + "@webassemblyjs/ast": "^1.12.1", + "@webassemblyjs/wasm-edit": "^1.12.1", + "@webassemblyjs/wasm-parser": "^1.12.1", "acorn": "^8.7.1", - "acorn-import-assertions": "^1.7.6", - "browserslist": "^4.14.5", + "acorn-import-attributes": "^1.9.5", + "browserslist": "^4.21.10", "chrome-trace-event": "^1.0.2", - "enhanced-resolve": "^5.10.0", - "es-module-lexer": "^0.9.0", + "enhanced-resolve": "^5.17.1", + "es-module-lexer": "^1.2.1", "eslint-scope": "5.1.1", "events": "^3.2.0", "glob-to-regexp": "^0.4.1", - "graceful-fs": "^4.2.9", + "graceful-fs": "^4.2.11", "json-parse-even-better-errors": "^2.3.1", "loader-runner": "^4.2.0", "mime-types": "^2.1.27", "neo-async": "^2.6.2", - "schema-utils": "^3.1.0", + "schema-utils": "^3.2.0", "tapable": "^2.1.1", - "terser-webpack-plugin": "^5.1.3", - "watchpack": "^2.4.0", + "terser-webpack-plugin": "^5.3.10", + "watchpack": "^2.4.1", "webpack-sources": "^3.2.3" } }, diff --git a/package.json b/package.json index df3cfc046ed6..41ba5bd3ab25 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "python", "displayName": "Python", "description": "Python language support with extension access points for IntelliSense (Pylance), Debugging (Python Debugger), linting, formatting, refactoring, unit tests, and more.", - "version": "2024.13.0-dev", + "version": "2024.14.0-rc", "featureFlags": { "usingNewInterpreterStorage": true }, From d9c0ce10cc59f0b67cc03a5eb2f426586430537b Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Tue, 3 Sep 2024 11:47:19 -0700 Subject: [PATCH 074/149] Update `main` to next pre-release version (#24043) --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 28e55a92fd0c..c5050689a039 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "python", - "version": "2024.14.0-rc", + "version": "2024.15.0-dev", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "python", - "version": "2024.14.0-rc", + "version": "2024.15.0-dev", "license": "MIT", "dependencies": { "@iarna/toml": "^2.2.5", diff --git a/package.json b/package.json index 41ba5bd3ab25..3cd9b017532b 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "python", "displayName": "Python", "description": "Python language support with extension access points for IntelliSense (Pylance), Debugging (Python Debugger), linting, formatting, refactoring, unit tests, and more.", - "version": "2024.14.0-rc", + "version": "2024.15.0-dev", "featureFlags": { "usingNewInterpreterStorage": true }, From 884efada0cfc1cb106f9fbc2af16481f2623bc77 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Tue, 3 Sep 2024 14:21:43 -0700 Subject: [PATCH 075/149] fix django manage.py path validation (#24019) fixes https://github.com/microsoft/vscode-python/issues/24001 --- python_files/unittestadapter/django_handler.py | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/python_files/unittestadapter/django_handler.py b/python_files/unittestadapter/django_handler.py index dc520c13aff1..9daa816d0918 100644 --- a/python_files/unittestadapter/django_handler.py +++ b/python_files/unittestadapter/django_handler.py @@ -18,10 +18,8 @@ def django_discovery_runner(manage_py_path: str, args: List[str]) -> None: # Attempt a small amount of validation on the manage.py path. - try: - pathlib.Path(manage_py_path) - except Exception as e: - raise VSCodeUnittestError(f"Error running Django, manage.py path is not a valid path: {e}") # noqa: B904 + if not pathlib.Path(manage_py_path).exists(): + raise VSCodeUnittestError("Error running Django, manage.py path does not exist.") try: # Get path to the custom_test_runner.py parent folder, add to sys.path and new environment used for subprocess. @@ -61,10 +59,8 @@ def django_discovery_runner(manage_py_path: str, args: List[str]) -> None: def django_execution_runner(manage_py_path: str, test_ids: List[str], args: List[str]) -> None: # Attempt a small amount of validation on the manage.py path. - try: - pathlib.Path(manage_py_path) - except Exception as e: - raise VSCodeUnittestError(f"Error running Django, manage.py path is not a valid path: {e}") # noqa: B904 + if not pathlib.Path(manage_py_path).exists(): + raise VSCodeUnittestError("Error running Django, manage.py path does not exist.") try: # Get path to the custom_test_runner.py parent folder, add to sys.path. From 3343560547a37d3f1e11d25a0a7b20f97db9c716 Mon Sep 17 00:00:00 2001 From: Rich Chiodo Date: Wed, 4 Sep 2024 09:27:22 -0700 Subject: [PATCH 076/149] Fix failing multiroot test (#24049) Fixes https://github.com/microsoft/vscode-python/issues/24046 --- .vscode/launch.json | 3 +++ .../envVarsProvider.multiroot.test.ts | 25 +++++++++++++------ 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index 4dc107853fc6..1e983413c8d4 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -127,6 +127,9 @@ "--extensionDevelopmentPath=${workspaceFolder}", "--extensionTestsPath=${workspaceFolder}/out/test" ], + "env": { + "VSC_PYTHON_CI_TEST_GREP": "" // Modify this to run a subset of the single workspace tests + }, "sourceMaps": true, "smartStep": true, "outFiles": ["${workspaceFolder}/out/**/*", "!${workspaceFolder}/**/node_modules**/*"], diff --git a/src/test/common/variables/envVarsProvider.multiroot.test.ts b/src/test/common/variables/envVarsProvider.multiroot.test.ts index e558bf8b1efc..3ba073d71474 100644 --- a/src/test/common/variables/envVarsProvider.multiroot.test.ts +++ b/src/test/common/variables/envVarsProvider.multiroot.test.ts @@ -4,7 +4,7 @@ import { expect, use } from 'chai'; import * as chaiAsPromised from 'chai-as-promised'; import * as path from 'path'; -import { anything, instance, mock, when } from 'ts-mockito'; +import { anything } from 'ts-mockito'; import { ConfigurationTarget, Disposable, Uri, workspace } from 'vscode'; import { WorkspaceService } from '../../../client/common/application/workspace'; import { PlatformService } from '../../../client/common/platform/platformService'; @@ -14,7 +14,6 @@ import { getSearchPathEnvVarNames } from '../../../client/common/utils/exec'; import { EnvironmentVariablesService } from '../../../client/common/variables/environment'; import { EnvironmentVariablesProvider } from '../../../client/common/variables/environmentVariablesProvider'; import { EnvironmentVariables } from '../../../client/common/variables/types'; -import { EnvironmentActivationService } from '../../../client/interpreter/activation/service'; import { IEnvironmentActivationService } from '../../../client/interpreter/activation/types'; import { IInterpreterAutoSelectionService } from '../../../client/interpreter/autoSelection/types'; import { clearPythonPathInWorkspaceFolder, isOs, OSType, updateSetting } from '../../common'; @@ -22,6 +21,7 @@ import { closeActiveWindows, initialize, initializeTest, IS_MULTI_ROOT_TEST } fr import { MockAutoSelectionService } from '../../mocks/autoSelector'; import { MockProcess } from '../../mocks/process'; import { UnitTestIocContainer } from '../../testing/serviceRegistry'; +import { createTypeMoq } from '../../mocks/helper'; use(chaiAsPromised.default); @@ -47,12 +47,21 @@ suite('Multiroot Environment Variables Provider', () => { ioc.registerProcessTypes(); ioc.registerInterpreterStorageTypes(); await ioc.registerMockInterpreterTypes(); - const mockEnvironmentActivationService = mock(EnvironmentActivationService); - when(mockEnvironmentActivationService.getActivatedEnvironmentVariables(anything())).thenResolve(); - ioc.serviceManager.rebindInstance( - IEnvironmentActivationService, - instance(mockEnvironmentActivationService), - ); + const mockEnvironmentActivationService = createTypeMoq(); + mockEnvironmentActivationService + .setup((m) => m.getActivatedEnvironmentVariables(anything())) + .returns(() => Promise.resolve({})); + if (ioc.serviceManager.tryGet(IEnvironmentActivationService)) { + ioc.serviceManager.rebindInstance( + IEnvironmentActivationService, + mockEnvironmentActivationService.object, + ); + } else { + ioc.serviceManager.addSingletonInstance( + IEnvironmentActivationService, + mockEnvironmentActivationService.object, + ); + } return initializeTest(); }); suiteTeardown(closeActiveWindows); From e6949103f1e3de4c050ade7db10a554e537acf92 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Wed, 4 Sep 2024 11:48:31 -0700 Subject: [PATCH 077/149] Remove use of mocked output channel in virtual workspace (#24051) --- src/client/extensionInit.ts | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/src/client/extensionInit.ts b/src/client/extensionInit.ts index 851bc943cb8d..38b402b3c9de 100644 --- a/src/client/extensionInit.ts +++ b/src/client/extensionInit.ts @@ -5,7 +5,6 @@ import { Container } from 'inversify'; import { Disposable, Memento, window } from 'vscode'; -import { instance, mock } from 'ts-mockito'; import { registerTypes as platformRegisterTypes } from './common/platform/serviceRegistry'; import { registerTypes as processRegisterTypes } from './common/process/serviceRegistry'; import { registerTypes as commonRegisterTypes } from './common/serviceRegistry'; @@ -29,7 +28,6 @@ import * as pythonEnvironments from './pythonEnvironments'; import { IDiscoveryAPI } from './pythonEnvironments/base/locator'; import { registerLogger } from './logging'; import { OutputChannelLogger } from './logging/outputChannelLogger'; -import { WorkspaceService } from './common/application/workspace'; // The code in this module should do nothing more complex than register // objects to DI and simple init (e.g. no side effects). That implies @@ -57,12 +55,7 @@ export function initializeGlobals( disposables.push(standardOutputChannel); disposables.push(registerLogger(new OutputChannelLogger(standardOutputChannel))); - const workspaceService = new WorkspaceService(); - const unitTestOutChannel = - workspaceService.isVirtualWorkspace || !workspaceService.isTrusted - ? // Do not create any test related output UI when using virtual workspaces. - instance(mock()) - : window.createOutputChannel(OutputChannelNames.pythonTest); + const unitTestOutChannel = window.createOutputChannel(OutputChannelNames.pythonTest); disposables.push(unitTestOutChannel); serviceManager.addSingletonInstance(ILogOutputChannel, standardOutputChannel); From ef7c7e3aedd29322d014cc0724f21ba04e5e2191 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Thu, 5 Sep 2024 13:02:38 -0700 Subject: [PATCH 078/149] switch to using temp file for test_ids (#24054) first step in work on https://github.com/microsoft/vscode-python/issues/23279 --------- Co-authored-by: Karthik Nadig --- .../tests/unittestadapter/conftest.py | 6 - python_files/unittestadapter/execution.py | 116 +++++++----------- .../vscode_pytest/run_pytest_script.py | 74 ++++------- .../testing/testController/common/utils.ts | 33 +++++ .../pytest/pytestExecutionAdapter.ts | 8 +- .../unittest/testExecutionAdapter.ts | 6 +- .../pytestExecutionAdapter.unit.test.ts | 16 +-- .../testCancellationRunAdapters.unit.test.ts | 8 +- .../testExecutionAdapter.unit.test.ts | 14 +-- 9 files changed, 128 insertions(+), 153 deletions(-) diff --git a/python_files/tests/unittestadapter/conftest.py b/python_files/tests/unittestadapter/conftest.py index 19af85d1e095..5b7f7a925cc0 100644 --- a/python_files/tests/unittestadapter/conftest.py +++ b/python_files/tests/unittestadapter/conftest.py @@ -1,8 +1,2 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. - -import sys - -# Ignore the contents of this folder for Python 2 tests. -if sys.version_info[0] < 3: - collect_ignore_glob = ["*.py"] diff --git a/python_files/unittestadapter/execution.py b/python_files/unittestadapter/execution.py index 4bc668bf71b6..8e4b2462e681 100644 --- a/python_files/unittestadapter/execution.py +++ b/python_files/unittestadapter/execution.py @@ -3,7 +3,6 @@ import atexit import enum -import json import os import pathlib import sys @@ -24,7 +23,6 @@ from django_handler import django_execution_runner # noqa: E402 -from testing_tools import process_json_util, socket_manager # noqa: E402 from unittestadapter.pvsc_utils import ( # noqa: E402 EOTPayloadDict, ExecutionPayloadDict, @@ -269,8 +267,15 @@ def run_tests( return payload +def execute_eot_and_cleanup(): + eot_payload: EOTPayloadDict = {"command_type": "execution", "eot": True} + send_post_request(eot_payload, test_run_pipe) + if __socket: + __socket.close() + + __socket = None -atexit.register(lambda: __socket.close() if __socket else None) +atexit.register(execute_eot_and_cleanup) def send_run_data(raw_data, test_run_pipe): @@ -306,70 +311,43 @@ def send_run_data(raw_data, test_run_pipe): if not test_run_pipe: print("Error[vscode-unittest]: TEST_RUN_PIPE env var is not set.") raise VSCodeUnittestError("Error[vscode-unittest]: TEST_RUN_PIPE env var is not set.") - test_ids_from_buffer = [] - raw_json = None - try: - with socket_manager.PipeManager(run_test_ids_pipe) as sock: - buffer: str = "" - while True: - # Receive the data from the client - data: str = sock.read() - if not data: - break - - # Append the received data to the buffer - buffer += data - - try: - # Try to parse the buffer as JSON - raw_json = process_json_util.process_rpc_json(buffer) - # Clear the buffer as complete JSON object is received - buffer = "" - print("Received JSON data in run") - break - except json.JSONDecodeError: - # JSON decoding error, the complete JSON object is not yet received - continue - except OSError as e: - msg = f"Error: Could not connect to RUN_TEST_IDS_PIPE: {e}" - print(msg) - raise VSCodeUnittestError(msg) from e - + test_ids = [] try: - if raw_json and "params" in raw_json and raw_json["params"]: - test_ids_from_buffer = raw_json["params"] - # Check to see if we are running django tests. - if manage_py_path := os.environ.get("MANAGE_PY_PATH"): - args = argv[index + 1 :] or [] - django_execution_runner(manage_py_path, test_ids_from_buffer, args) - # the django run subprocesses sends the eot payload. - else: - # Perform test execution. - payload = run_tests( - start_dir, - test_ids_from_buffer, - pattern, - top_level_dir, - verbosity, - failfast, - locals_, - ) - eot_payload: EOTPayloadDict = {"command_type": "execution", "eot": True} - send_post_request(eot_payload, test_run_pipe) - else: - # No test ids received from buffer - cwd = os.path.abspath(start_dir) # noqa: PTH100 - status = TestExecutionStatus.error - payload: ExecutionPayloadDict = { - "cwd": cwd, - "status": status, - "error": "No test ids received from buffer", - "result": None, - } - send_post_request(payload, test_run_pipe) - eot_payload: EOTPayloadDict = {"command_type": "execution", "eot": True} - send_post_request(eot_payload, test_run_pipe) - except json.JSONDecodeError as exc: - msg = "Error: Could not parse test ids from stdin" - print(msg) - raise VSCodeUnittestError(msg) from exc + # Read the test ids from the file, attempt to delete file afterwords. + ids_path = pathlib.Path(run_test_ids_pipe) + test_ids = ids_path.read_text(encoding="utf-8").splitlines() + print("Received test ids from temp file.") + try: + ids_path.unlink() + except Exception as e: + print("Error[vscode-pytest]: unable to delete temp file" + str(e)) + + except Exception as e: + # No test ids received from buffer, return error payload + cwd = pathlib.Path(start_dir).absolute() + status: TestExecutionStatus = TestExecutionStatus.error + payload: ExecutionPayloadDict = { + "cwd": str(cwd), + "status": status, + "result": None, + "error": "No test ids read from temp file," + str(e), + } + send_post_request(payload, test_run_pipe) + + # If no error occurred, we will have test ids to run. + if manage_py_path := os.environ.get("MANAGE_PY_PATH"): + print("MANAGE_PY_PATH env var set, running Django test suite.") + args = argv[index + 1 :] or [] + django_execution_runner(manage_py_path, test_ids, args) + # the django run subprocesses sends the eot payload. + else: + # Perform regular unittest execution. + payload = run_tests( + start_dir, + test_ids, + pattern, + top_level_dir, + verbosity, + failfast, + locals_, + ) diff --git a/python_files/vscode_pytest/run_pytest_script.py b/python_files/vscode_pytest/run_pytest_script.py index 515e04d1b84d..79e039607c4b 100644 --- a/python_files/vscode_pytest/run_pytest_script.py +++ b/python_files/vscode_pytest/run_pytest_script.py @@ -1,6 +1,5 @@ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. -import json import os import pathlib import sys @@ -17,10 +16,12 @@ script_dir = pathlib.Path(__file__).parent.parent sys.path.append(os.fspath(script_dir)) sys.path.append(os.fspath(script_dir / "lib" / "python")) -from testing_tools import ( # noqa: E402 - process_json_util, - socket_manager, -) + + +def run_pytest(args): + arg_array = ["-p", "vscode_pytest", *args] + pytest.main(arg_array) + # This script handles running pytest via pytest.main(). It is called via run in the # pytest execution adapter and gets the test_ids to run via stdin and the rest of the @@ -34,52 +35,21 @@ # Get the rest of the args to run with pytest. args = sys.argv[1:] run_test_ids_pipe = os.environ.get("RUN_TEST_IDS_PIPE") - if not run_test_ids_pipe: - print("Error[vscode-pytest]: RUN_TEST_IDS_PIPE env var is not set.") - raw_json = {} - try: - socket_name = os.environ.get("RUN_TEST_IDS_PIPE") - with socket_manager.PipeManager(socket_name) as sock: - buffer = "" - while True: - # Receive the data from the client as a string - data = sock.read(3000) - if not data: - break - - # Append the received data to the buffer - buffer += data - - try: - # Try to parse the buffer as JSON - raw_json = process_json_util.process_rpc_json(buffer) - # Clear the buffer as complete JSON object is received - buffer = "" - print("Received JSON data in run script") - break - except json.JSONDecodeError: - # JSON decoding error, the complete JSON object is not yet received - continue - except UnicodeDecodeError: - continue - except OSError as e: - print(f"Error: Could not connect to runTestIdsPort: {e}") - print("Error: Could not connect to runTestIdsPort") - try: - test_ids_from_buffer = raw_json.get("params") - if test_ids_from_buffer: - arg_array = ["-p", "vscode_pytest", *args, *test_ids_from_buffer] + if run_test_ids_pipe: + try: + # Read the test ids from the file, delete file, and run pytest. + ids_path = pathlib.Path(run_test_ids_pipe) + ids = ids_path.read_text(encoding="utf-8").splitlines() + try: + ids_path.unlink() + except Exception as e: + print("Error[vscode-pytest]: unable to delete temp file" + str(e)) + arg_array = ["-p", "vscode_pytest", *args, *ids] print("Running pytest with args: " + str(arg_array)) pytest.main(arg_array) - else: - print( - "Error: No test ids received from stdin, could be an error or a run request without ids provided.", - ) - print("Running pytest with no test ids as args. Args being used: ", args) - arg_array = ["-p", "vscode_pytest", *args] - pytest.main(arg_array) - except json.JSONDecodeError: - print( - "Error: Could not parse test ids from stdin. Raw json received from socket: \n", - raw_json, - ) + except Exception as e: + print("Error[vscode-pytest]: unable to read testIds from temp file" + str(e)) + run_pytest(args) + else: + print("Error[vscode-pytest]: RUN_TEST_IDS_PIPE env var is not set.") + run_pytest(args) diff --git a/src/client/testing/testController/common/utils.ts b/src/client/testing/testController/common/utils.ts index 759fb0713de4..cf82a2ebd1c1 100644 --- a/src/client/testing/testController/common/utils.ts +++ b/src/client/testing/testController/common/utils.ts @@ -3,6 +3,8 @@ import * as net from 'net'; import * as path from 'path'; import * as fs from 'fs'; +import * as os from 'os'; +import * as crypto from 'crypto'; import { CancellationToken, Position, TestController, TestItem, Uri, Range, Disposable } from 'vscode'; import { Message } from 'vscode-jsonrpc'; import { traceError, traceInfo, traceLog, traceVerbose } from '../../../logging'; @@ -20,6 +22,7 @@ import { } from './types'; import { Deferred, createDeferred } from '../../../common/utils/async'; import { createNamedPipeServer, generateRandomPipeName } from '../../../common/pipes/namedPipes'; +import { EXTENSION_ROOT_DIR } from '../../../constants'; export function fixLogLines(content: string): string { const lines = content.split(/\r?\n/g); @@ -193,6 +196,36 @@ interface ExecutionResultMessage extends Message { params: ExecutionTestPayload | EOTTestPayload; } +/** + * Writes an array of test IDs to a temporary file. + * + * @param testIds - The array of test IDs to write. + * @returns A promise that resolves to the file name of the temporary file. + */ +export async function writeTestIdsFile(testIds: string[]): Promise { + // temp file name in format of test-ids-.txt + const randomSuffix = crypto.randomBytes(10).toString('hex'); + const tempName = `test-ids-${randomSuffix}.txt`; + // create temp file + let tempFileName: string; + try { + traceLog('Attempting to use temp directory for test ids file, file name:', tempName); + tempFileName = path.join(os.tmpdir(), tempName); + } catch (error) { + // Handle the error when accessing the temp directory + traceError('Error accessing temp directory:', error, ' Attempt to use extension root dir instead'); + // Make new temp directory in extension root dir + const tempDir = path.join(EXTENSION_ROOT_DIR, '.temp'); + await fs.promises.mkdir(tempDir, { recursive: true }); + tempFileName = path.join(EXTENSION_ROOT_DIR, '.temp', tempName); + traceLog('New temp file:', tempFileName); + } + // write test ids to file + await fs.promises.writeFile(tempFileName, testIds.join('\n')); + // return file name + return tempFileName; +} + export async function startRunResultNamedPipe( dataReceivedCallback: (payload: ExecutionTestPayload | EOTTestPayload) => void, deferredTillServerClose: Deferred, diff --git a/src/client/testing/testController/pytest/pytestExecutionAdapter.ts b/src/client/testing/testController/pytest/pytestExecutionAdapter.ts index 5099efde179c..9d48003525d6 100644 --- a/src/client/testing/testController/pytest/pytestExecutionAdapter.ts +++ b/src/client/testing/testController/pytest/pytestExecutionAdapter.ts @@ -142,9 +142,9 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { testArgs = utils.addValueIfKeyNotExist(testArgs, '--capture', 'no'); } - // add port with run test ids to env vars - const testIdsPipeName = await utils.startTestIdsNamedPipe(testIds); - mutableEnv.RUN_TEST_IDS_PIPE = testIdsPipeName; + // create a file with the test ids and set the environment variable to the file name + const testIdsFileName = await utils.writeTestIdsFile(testIds); + mutableEnv.RUN_TEST_IDS_PIPE = testIdsFileName; traceInfo(`All environment variables set for pytest execution: ${JSON.stringify(mutableEnv)}`); const spawnOptions: SpawnOptions = { @@ -162,7 +162,7 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { args: testArgs, token: runInstance?.token, testProvider: PYTEST_PROVIDER, - runTestIdsPort: testIdsPipeName, + runTestIdsPort: testIdsFileName, pytestPort: resultNamedPipeName, }; traceInfo(`Running DEBUG pytest with arguments: ${testArgs} for workspace ${uri.fsPath} \r\n`); diff --git a/src/client/testing/testController/unittest/testExecutionAdapter.ts b/src/client/testing/testController/unittest/testExecutionAdapter.ts index 4746c3101752..b3e134a30dd6 100644 --- a/src/client/testing/testController/unittest/testExecutionAdapter.ts +++ b/src/client/testing/testController/unittest/testExecutionAdapter.ts @@ -137,8 +137,8 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { traceLog(`Running UNITTEST execution for the following test ids: ${testIds}`); // create named pipe server to send test ids - const testIdsPipeName = await utils.startTestIdsNamedPipe(testIds); - mutableEnv.RUN_TEST_IDS_PIPE = testIdsPipeName; + const testIdsFileName = await utils.writeTestIdsFile(testIds); + mutableEnv.RUN_TEST_IDS_PIPE = testIdsFileName; traceInfo(`All environment variables set for pytest execution: ${JSON.stringify(mutableEnv)}`); const spawnOptions: SpawnOptions = { @@ -167,7 +167,7 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { args, token: options.token, testProvider: UNITTEST_PROVIDER, - runTestIdsPort: testIdsPipeName, + runTestIdsPort: testIdsFileName, pytestPort: resultNamedPipeName, // change this from pytest }; traceInfo(`Running DEBUG unittest for workspace ${options.cwd} with arguments: ${args}\r\n`); diff --git a/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts b/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts index 911cca4a284f..040734601a09 100644 --- a/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts +++ b/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts @@ -33,7 +33,7 @@ suite('pytest test execution adapter', () => { (global as any).EXTENSION_ROOT_DIR = EXTENSION_ROOT_DIR; let myTestPath: string; let mockProc: MockChildProcess; - let utilsStartTestIdsNamedPipeStub: sinon.SinonStub; + let utilsWriteTestIdsFileStub: sinon.SinonStub; let utilsStartRunResultNamedPipeStub: sinon.SinonStub; setup(() => { configService = ({ @@ -65,7 +65,7 @@ suite('pytest test execution adapter', () => { execFactory = typeMoq.Mock.ofType(); // added - utilsStartTestIdsNamedPipeStub = sinon.stub(util, 'startTestIdsNamedPipe'); + utilsWriteTestIdsFileStub = sinon.stub(util, 'writeTestIdsFile'); debugLauncher = typeMoq.Mock.ofType(); execFactory .setup((x) => x.createActivatedEnvironment(typeMoq.It.isAny())) @@ -95,7 +95,7 @@ suite('pytest test execution adapter', () => { teardown(() => { sinon.restore(); }); - test('startTestIdServer called with correct testIds', async () => { + test('WriteTestIdsFile called with correct testIds', async () => { const deferred2 = createDeferred(); const deferred3 = createDeferred(); execFactory = typeMoq.Mock.ofType(); @@ -105,7 +105,7 @@ suite('pytest test execution adapter', () => { deferred2.resolve(); return Promise.resolve(execService.object); }); - utilsStartTestIdsNamedPipeStub.callsFake(() => { + utilsWriteTestIdsFileStub.callsFake(() => { deferred3.resolve(); return Promise.resolve({ name: 'mockName', @@ -129,7 +129,7 @@ suite('pytest test execution adapter', () => { mockProc.trigger('close'); // assert - sinon.assert.calledWithExactly(utilsStartTestIdsNamedPipeStub, testIds); + sinon.assert.calledWithExactly(utilsWriteTestIdsFileStub, testIds); }); test('pytest execution called with correct args', async () => { const deferred2 = createDeferred(); @@ -141,7 +141,7 @@ suite('pytest test execution adapter', () => { deferred2.resolve(); return Promise.resolve(execService.object); }); - utilsStartTestIdsNamedPipeStub.callsFake(() => { + utilsWriteTestIdsFileStub.callsFake(() => { deferred3.resolve(); return Promise.resolve('testIdPipe-mockName'); }); @@ -192,7 +192,7 @@ suite('pytest test execution adapter', () => { deferred2.resolve(); return Promise.resolve(execService.object); }); - utilsStartTestIdsNamedPipeStub.callsFake(() => { + utilsWriteTestIdsFileStub.callsFake(() => { deferred3.resolve(); return Promise.resolve('testIdPipe-mockName'); }); @@ -243,7 +243,7 @@ suite('pytest test execution adapter', () => { test('Debug launched correctly for pytest', async () => { const deferred3 = createDeferred(); const deferredEOT = createDeferred(); - utilsStartTestIdsNamedPipeStub.callsFake(() => { + utilsWriteTestIdsFileStub.callsFake(() => { deferred3.resolve(); return Promise.resolve('testIdPipe-mockName'); }); diff --git a/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts b/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts index fc120ef1f526..563735e6a467 100644 --- a/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts +++ b/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts @@ -28,7 +28,7 @@ suite('Execution Flow Run Adapters', () => { (global as any).EXTENSION_ROOT_DIR = EXTENSION_ROOT_DIR; let myTestPath: string; let mockProc: MockChildProcess; - let utilsStartTestIdsNamedPipe: sinon.SinonStub; + let utilsWriteTestIdsFileStub: sinon.SinonStub; let utilsStartRunResultNamedPipe: sinon.SinonStub; let serverDisposeStub: sinon.SinonStub; @@ -47,7 +47,7 @@ suite('Execution Flow Run Adapters', () => { execFactoryStub = typeMoq.Mock.ofType(); // mocked utility functions that handle pipe related functions - utilsStartTestIdsNamedPipe = sinon.stub(util, 'startTestIdsNamedPipe'); + utilsWriteTestIdsFileStub = sinon.stub(util, 'writeTestIdsFile'); utilsStartRunResultNamedPipe = sinon.stub(util, 'startRunResultNamedPipe'); serverDisposeStub = sinon.stub(); @@ -87,7 +87,7 @@ suite('Execution Flow Run Adapters', () => { // test ids named pipe mocking const deferredStartTestIdsNamedPipe = createDeferred(); - utilsStartTestIdsNamedPipe.callsFake(() => { + utilsWriteTestIdsFileStub.callsFake(() => { deferredStartTestIdsNamedPipe.resolve(); return Promise.resolve('named-pipe'); }); @@ -165,7 +165,7 @@ suite('Execution Flow Run Adapters', () => { // test ids named pipe mocking const deferredStartTestIdsNamedPipe = createDeferred(); - utilsStartTestIdsNamedPipe.callsFake(() => { + utilsWriteTestIdsFileStub.callsFake(() => { deferredStartTestIdsNamedPipe.resolve(); return Promise.resolve('named-pipe'); }); diff --git a/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts b/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts index 6881524af20c..0cb64a8c75cd 100644 --- a/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts +++ b/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts @@ -33,7 +33,7 @@ suite('Unittest test execution adapter', () => { (global as any).EXTENSION_ROOT_DIR = EXTENSION_ROOT_DIR; let myTestPath: string; let mockProc: MockChildProcess; - let utilsStartTestIdsNamedPipeStub: sinon.SinonStub; + let utilsWriteTestIdsFileStub: sinon.SinonStub; let utilsStartRunResultNamedPipeStub: sinon.SinonStub; setup(() => { configService = ({ @@ -65,7 +65,7 @@ suite('Unittest test execution adapter', () => { execFactory = typeMoq.Mock.ofType(); // added - utilsStartTestIdsNamedPipeStub = sinon.stub(util, 'startTestIdsNamedPipe'); + utilsWriteTestIdsFileStub = sinon.stub(util, 'writeTestIdsFile'); debugLauncher = typeMoq.Mock.ofType(); execFactory .setup((x) => x.createActivatedEnvironment(typeMoq.It.isAny())) @@ -105,7 +105,7 @@ suite('Unittest test execution adapter', () => { deferred2.resolve(); return Promise.resolve(execService.object); }); - utilsStartTestIdsNamedPipeStub.callsFake(() => { + utilsWriteTestIdsFileStub.callsFake(() => { deferred3.resolve(); return Promise.resolve({ name: 'mockName', @@ -129,7 +129,7 @@ suite('Unittest test execution adapter', () => { mockProc.trigger('close'); // assert - sinon.assert.calledWithExactly(utilsStartTestIdsNamedPipeStub, testIds); + sinon.assert.calledWithExactly(utilsWriteTestIdsFileStub, testIds); }); test('unittest execution called with correct args', async () => { const deferred2 = createDeferred(); @@ -141,7 +141,7 @@ suite('Unittest test execution adapter', () => { deferred2.resolve(); return Promise.resolve(execService.object); }); - utilsStartTestIdsNamedPipeStub.callsFake(() => { + utilsWriteTestIdsFileStub.callsFake(() => { deferred3.resolve(); return Promise.resolve('testIdPipe-mockName'); }); @@ -191,7 +191,7 @@ suite('Unittest test execution adapter', () => { deferred2.resolve(); return Promise.resolve(execService.object); }); - utilsStartTestIdsNamedPipeStub.callsFake(() => { + utilsWriteTestIdsFileStub.callsFake(() => { deferred3.resolve(); return Promise.resolve('testIdPipe-mockName'); }); @@ -242,7 +242,7 @@ suite('Unittest test execution adapter', () => { test('Debug launched correctly for unittest', async () => { const deferred3 = createDeferred(); const deferredEOT = createDeferred(); - utilsStartTestIdsNamedPipeStub.callsFake(() => { + utilsWriteTestIdsFileStub.callsFake(() => { deferred3.resolve(); return Promise.resolve('testIdPipe-mockName'); }); From e3a7c7a0c0ee7e5e25884ebee61fbf63d1a18ff6 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Thu, 5 Sep 2024 15:09:35 -0700 Subject: [PATCH 079/149] Download `pet` from azure pipeline build (#24052) --- build/azure-pipeline.pre-release.yml | 46 +++++++++++++++------------- 1 file changed, 24 insertions(+), 22 deletions(-) diff --git a/build/azure-pipeline.pre-release.yml b/build/azure-pipeline.pre-release.yml index 56bed785588f..c6de846ee851 100644 --- a/build/azure-pipeline.pre-release.yml +++ b/build/azure-pipeline.pre-release.yml @@ -31,7 +31,6 @@ extends: ghCreateTag: false standardizedVersioning: true l10nSourcePaths: ./src/client - needsTools: true buildPlatforms: - name: Linux @@ -98,27 +97,30 @@ extends: - script: npx gulp prePublishBundle displayName: Build - - script: nox --session azure_pet_checkout - displayName: Checkout python-environment-tools - env: - PYTHON_ENV_TOOLS_DEST: $(Build.SourcesDirectory) - PYTHON_ENV_TOOLS_REF: main - PYTHON_ENV_TOOLS_TEMP: $(Agent.TempDirectory) - - - script: nox --session azure_pet_build_before - displayName: Enable cargo config for azure - - - template: azure-pipelines/extension/templates/steps/build-extension-rust-package.yml@templates - parameters: - vsceTarget: $(vsceTarget) - binaryName: pet - signing: true - workingDirectory: $(Build.SourcesDirectory)/python-env-tools - buildWasm: false - runTest: false - - - script: nox --session azure_pet_build_after - displayName: Move bin to final location + - bash: | + mkdir -p $(Build.SourcesDirectory)/python-env-tools/bin + chmod +x $(Build.SourcesDirectory)/python-env-tools/bin + displayName: Make Directory for python-env-tool binary + + - task: DownloadPipelineArtifact@2 + inputs: + buildType: 'specific' + project: 'Monaco' + definition: 591 + buildVersionToDownload: 'latestFromBranch' + branchName: 'refs/heads/main' + targetPath: '$(Build.SourcesDirectory)/python-env-tools/bin' + artifactName: 'bin-$(vsceTarget)' + itemPattern: | + pet.exe + pet + ThirdPartyNotices.txt + + - bash: | + ls -lf ./python-env-tools/bin + chmod +x ./python-env-tools/bin/pet* + ls -lf ./python-env-tools/bin + displayName: Set chmod for pet binary - script: python -c "import shutil; shutil.rmtree('.nox', ignore_errors=True)" displayName: Clean up Nox From 223eca9194a7c42f6b3a9a5296e6f562187681e9 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Fri, 6 Sep 2024 09:23:22 -0700 Subject: [PATCH 080/149] Better messaging for tests output in virtual or untrusted scenario (#24060) --- src/client/common/vscodeApis/workspaceApis.ts | 26 ++++++++++++++----- src/client/extensionInit.ts | 6 ++++- 2 files changed, 25 insertions(+), 7 deletions(-) diff --git a/src/client/common/vscodeApis/workspaceApis.ts b/src/client/common/vscodeApis/workspaceApis.ts index d41c877e5aa8..137382dc71a0 100644 --- a/src/client/common/vscodeApis/workspaceApis.ts +++ b/src/client/common/vscodeApis/workspaceApis.ts @@ -36,11 +36,11 @@ export function findFiles( return vscode.workspace.findFiles(include, exclude, maxResults, token); } -export function onDidCloseTextDocument(handler: (e: vscode.TextDocument) => unknown): vscode.Disposable { +export function onDidCloseTextDocument(handler: (e: vscode.TextDocument) => void): vscode.Disposable { return vscode.workspace.onDidCloseTextDocument(handler); } -export function onDidSaveTextDocument(handler: (e: vscode.TextDocument) => unknown): vscode.Disposable { +export function onDidSaveTextDocument(handler: (e: vscode.TextDocument) => void): vscode.Disposable { return vscode.workspace.onDidSaveTextDocument(handler); } @@ -48,15 +48,15 @@ export function getOpenTextDocuments(): readonly vscode.TextDocument[] { return vscode.workspace.textDocuments; } -export function onDidOpenTextDocument(handler: (doc: vscode.TextDocument) => unknown): vscode.Disposable { +export function onDidOpenTextDocument(handler: (doc: vscode.TextDocument) => void): vscode.Disposable { return vscode.workspace.onDidOpenTextDocument(handler); } -export function onDidChangeTextDocument(handler: (e: vscode.TextDocumentChangeEvent) => unknown): vscode.Disposable { +export function onDidChangeTextDocument(handler: (e: vscode.TextDocumentChangeEvent) => void): vscode.Disposable { return vscode.workspace.onDidChangeTextDocument(handler); } -export function onDidChangeConfiguration(handler: (e: vscode.ConfigurationChangeEvent) => unknown): vscode.Disposable { +export function onDidChangeConfiguration(handler: (e: vscode.ConfigurationChangeEvent) => void): vscode.Disposable { return vscode.workspace.onDidChangeConfiguration(handler); } @@ -75,7 +75,21 @@ export function createFileSystemWatcher( } export function onDidChangeWorkspaceFolders( - handler: (e: vscode.WorkspaceFoldersChangeEvent) => unknown, + handler: (e: vscode.WorkspaceFoldersChangeEvent) => void, ): vscode.Disposable { return vscode.workspace.onDidChangeWorkspaceFolders(handler); } + +export function isVirtualWorkspace(): boolean { + const isVirtualWorkspace = + vscode.workspace.workspaceFolders && vscode.workspace.workspaceFolders.every((f) => f.uri.scheme !== 'file'); + return !!isVirtualWorkspace; +} + +export function isTrusted(): boolean { + return vscode.workspace.isTrusted; +} + +export function onDidGrantWorkspaceTrust(handler: () => void): vscode.Disposable { + return vscode.workspace.onDidGrantWorkspaceTrust(handler); +} diff --git a/src/client/extensionInit.ts b/src/client/extensionInit.ts index 38b402b3c9de..1332dc6bd070 100644 --- a/src/client/extensionInit.ts +++ b/src/client/extensionInit.ts @@ -4,7 +4,7 @@ 'use strict'; import { Container } from 'inversify'; -import { Disposable, Memento, window } from 'vscode'; +import { Disposable, l10n, Memento, window } from 'vscode'; import { registerTypes as platformRegisterTypes } from './common/platform/serviceRegistry'; import { registerTypes as processRegisterTypes } from './common/process/serviceRegistry'; import { registerTypes as commonRegisterTypes } from './common/serviceRegistry'; @@ -28,6 +28,7 @@ import * as pythonEnvironments from './pythonEnvironments'; import { IDiscoveryAPI } from './pythonEnvironments/base/locator'; import { registerLogger } from './logging'; import { OutputChannelLogger } from './logging/outputChannelLogger'; +import { isTrusted, isVirtualWorkspace } from './common/vscodeApis/workspaceApis'; // The code in this module should do nothing more complex than register // objects to DI and simple init (e.g. no side effects). That implies @@ -57,6 +58,9 @@ export function initializeGlobals( const unitTestOutChannel = window.createOutputChannel(OutputChannelNames.pythonTest); disposables.push(unitTestOutChannel); + if (isVirtualWorkspace() || !isTrusted()) { + unitTestOutChannel.appendLine(l10n.t('Unit tests are not supported in this environment.')); + } serviceManager.addSingletonInstance(ILogOutputChannel, standardOutputChannel); serviceManager.addSingletonInstance(ITestOutputChannel, unitTestOutChannel); From 34dac5c8741af2cf1f140e74706ae9304051ae8d Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Fri, 6 Sep 2024 10:48:39 -0700 Subject: [PATCH 081/149] Stable extension builds using `pet` from Azure Feed (#24063) --- build/azure-pipeline.stable.yml | 45 ++++++++++---------- noxfile.py | 74 +-------------------------------- 2 files changed, 25 insertions(+), 94 deletions(-) diff --git a/build/azure-pipeline.stable.yml b/build/azure-pipeline.stable.yml index 8f3210f7ee27..5f7536efbe2a 100644 --- a/build/azure-pipeline.stable.yml +++ b/build/azure-pipeline.stable.yml @@ -92,27 +92,30 @@ extends: - script: npx gulp prePublishBundle displayName: Build - - script: nox --session azure_pet_checkout - displayName: Checkout python-environment-tools - env: - PYTHON_ENV_TOOLS_DEST: $(Build.SourcesDirectory) - PYTHON_ENV_TOOLS_REF: release/2024.14 - PYTHON_ENV_TOOLS_TEMP: $(Agent.TempDirectory) - - - script: nox --session azure_pet_build_before - displayName: Enable cargo config for azure - - - template: azure-pipelines/extension/templates/steps/build-extension-rust-package.yml@templates - parameters: - vsceTarget: $(vsceTarget) - binaryName: pet - signing: true - workingDirectory: $(Build.SourcesDirectory)/python-env-tools - buildWasm: false - runTest: false - - - script: nox --session azure_pet_build_after - displayName: Move bin to final location + - bash: | + mkdir -p $(Build.SourcesDirectory)/python-env-tools/bin + chmod +x $(Build.SourcesDirectory)/python-env-tools/bin + displayName: Make Directory for python-env-tool binary + + - task: DownloadPipelineArtifact@2 + inputs: + buildType: 'specific' + project: 'Monaco' + definition: 593 + buildVersionToDownload: 'latestFromBranch' + branchName: 'refs/heads/release/2024.14' + targetPath: '$(Build.SourcesDirectory)/python-env-tools/bin' + artifactName: 'bin-$(vsceTarget)' + itemPattern: | + pet.exe + pet + ThirdPartyNotices.txt + + - bash: | + ls -lf ./python-env-tools/bin + chmod +x ./python-env-tools/bin/pet* + ls -lf ./python-env-tools/bin + displayName: Set chmod for pet binary - script: python -c "import shutil; shutil.rmtree('.nox', ignore_errors=True)" displayName: Clean up Nox diff --git a/noxfile.py b/noxfile.py index 58ac6f1206aa..60e22d461074 100644 --- a/noxfile.py +++ b/noxfile.py @@ -27,6 +27,7 @@ def delete_dir(path: pathlib.Path, ignore_errors=None): shutil.rmtree(os.fspath(path)) + @nox.session() def install_python_libs(session: nox.Session): requirements = [ @@ -63,79 +64,6 @@ def install_python_libs(session: nox.Session): if pathlib.Path("./python_files/lib/temp").exists(): shutil.rmtree("./python_files/lib/temp") -@nox.session() -def azure_pet_checkout(session: nox.Session): - branch = os.getenv("PYTHON_ENV_TOOLS_REF", "main") - - # dest dir should be /python-env-tools - dest_dir = (pathlib.Path(os.getenv("PYTHON_ENV_TOOLS_DEST")) / "python-env-tools").resolve() - - # temp dir should be - temp_dir = (pathlib.Path(os.getenv("PYTHON_ENV_TOOLS_TEMP")) / "python-env-tools").resolve() - session.log(f"Cloning python-environment-tools to {temp_dir}") - temp_dir.mkdir(0o766, parents=True, exist_ok=True) - - try: - with session.cd(temp_dir): - session.run("git", "init", external=True) - session.run( - "git", - "remote", - "add", - "origin", - "https://github.com/microsoft/python-environment-tools", - external=True, - ) - session.run("git", "fetch", "origin", branch, external=True) - session.run( - "git", "checkout", "--force", "-B", branch, f"origin/{branch}", external=True - ) - delete_dir(temp_dir / ".git") - delete_dir(temp_dir / ".github") - delete_dir(temp_dir / ".vscode") - (temp_dir / "CODE_OF_CONDUCT.md").unlink() - shutil.move(os.fspath(temp_dir), os.fspath(dest_dir)) - except PermissionError as e: - print(f"Permission error: {e}") - if not dest_dir.exists(): - raise - finally: - delete_dir(temp_dir, ignore_errors=True) - - -@nox.session() -def azure_pet_build_before(session: nox.Session): - source_dir = pathlib.Path(pathlib.Path.cwd() / "python-env-tools").resolve() - config_toml_disabled = source_dir / ".cargo" / "config.toml.disabled" - config_toml = source_dir / ".cargo" / "config.toml" - if config_toml_disabled.exists() and not config_toml.exists(): - config_toml.write_bytes(config_toml_disabled.read_bytes()) - - -@nox.session() -def azure_pet_build_after(session: nox.Session): - source_dir = pathlib.Path(pathlib.Path.cwd() / "python-env-tools").resolve() - ext = sysconfig.get_config_var("EXE") or "" - bin_name = f"pet{ext}" - - abs_bin_path = None - for root, _, files in os.walk(os.fspath(source_dir / "target")): - bin_path = pathlib.Path(root) / "release" / bin_name - if bin_path.exists(): - abs_bin_path = bin_path.absolute() - break - - assert abs_bin_path - - dest_dir = pathlib.Path(pathlib.Path.cwd() / "python-env-tools").resolve() - if not pathlib.Path(dest_dir / "bin").exists(): - pathlib.Path(dest_dir / "bin").mkdir() - bin_dest = dest_dir / "bin" / bin_name - shutil.copyfile(abs_bin_path, bin_dest) - - if sys.platform != "win32": - os.chmod(os.fspath(bin_dest), 0o755) - @nox.session() def native_build(session: nox.Session): From 08e7fdfeebec42720c9b4f012c1502efc6ef8aed Mon Sep 17 00:00:00 2001 From: Rich Chiodo Date: Mon, 9 Sep 2024 13:45:37 -0700 Subject: [PATCH 082/149] Update engine version to match LSP client (#24065) Co-authored-by: Karthik Nadig --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index c5050689a039..06737473c436 100644 --- a/package-lock.json +++ b/package-lock.json @@ -116,7 +116,7 @@ "yargs": "^15.3.1" }, "engines": { - "vscode": "^1.89.0-20240415" + "vscode": "^1.91.0" } }, "node_modules/@aashutoshrathi/word-wrap": { diff --git a/package.json b/package.json index 3cd9b017532b..e033fde418c0 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "theme": "dark" }, "engines": { - "vscode": "^1.89.0-20240415" + "vscode": "^1.91.0" }, "enableTelemetry": false, "keywords": [ From 6578d9d0b7d411103a0358d45d16787d1715a232 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Wed, 11 Sep 2024 19:15:48 -0400 Subject: [PATCH 083/149] Revert "Do not truncate whitespace for multi-line string" (#24096) Reverts microsoft/vscode-python#23977 Have to revert https://github.com/microsoft/vscode-python/pull/23977 with issue: https://github.com/microsoft/vscode-python/issues/23743 due to https://github.com/microsoft/vscode-python/issues/24069 Will revisit why https://github.com/microsoft/vscode-python/issues/23743 is breaking if contained inside other top level (in ast term) code block, and look into how to support https://github.com/microsoft/vscode-python/issues/23743 without breaking. --- python_files/normalizeSelection.py | 4 ---- .../terminalExec/sample2_normalized_selection.py | 10 +--------- src/test/python_files/terminalExec/sample2_raw.py | 10 ++-------- 3 files changed, 3 insertions(+), 21 deletions(-) diff --git a/python_files/normalizeSelection.py b/python_files/normalizeSelection.py index 7ea283cc09a6..981251289e57 100644 --- a/python_files/normalizeSelection.py +++ b/python_files/normalizeSelection.py @@ -26,10 +26,6 @@ def _get_statements(selection): This will remove empty newlines around and within the selection, dedent it, and split it using the result of `ast.parse()`. """ - if '"""' in selection or "'''" in selection: - yield selection - return - # Remove blank lines within the selection to prevent the REPL from thinking the block is finished. lines = (line for line in split_lines(selection) if line.strip() != "") diff --git a/src/test/python_files/terminalExec/sample2_normalized_selection.py b/src/test/python_files/terminalExec/sample2_normalized_selection.py index be7b280479c0..a333d4e0daae 100644 --- a/src/test/python_files/terminalExec/sample2_normalized_selection.py +++ b/src/test/python_files/terminalExec/sample2_normalized_selection.py @@ -1,15 +1,7 @@ def add(x, y): - """ - - Adds x - to - y - - - """ + """Adds x to y""" # Some comment return x + y v = add(1, 7) print(v) - diff --git a/src/test/python_files/terminalExec/sample2_raw.py b/src/test/python_files/terminalExec/sample2_raw.py index 230abfda89cb..6ab7e67637f4 100644 --- a/src/test/python_files/terminalExec/sample2_raw.py +++ b/src/test/python_files/terminalExec/sample2_raw.py @@ -1,13 +1,7 @@ def add(x, y): - """ - - Adds x - to - y - - - """ + """Adds x to y""" # Some comment + return x + y v = add(1, 7) From 216c7ed065d74d2170774232983953fb50e9c150 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Thu, 12 Sep 2024 18:57:08 -0400 Subject: [PATCH 084/149] Switch over to executeCommand from sendText (#24078) Resolves: https://github.com/microsoft/vscode-python/issues/23929 TODO: (debt --> in separate PR) Have ensureTerminal return Promise instead of Promise and saving this in the TerminalService class. Would avoid many uses of the !, and maybe even get to throw away the TerminalService class itself. --- .github/actions/smoke-tests/action.yml | 2 +- package-lock.json | 16 +- package.json | 4 +- .../common/application/terminalManager.ts | 17 +- src/client/common/application/types.ts | 6 + src/client/common/terminal/service.ts | 63 +++- .../common/terminal/syncTerminalService.ts | 6 +- src/client/common/terminal/types.ts | 9 +- .../codeExecution/terminalCodeExecution.ts | 2 +- .../common/terminals/service.unit.test.ts | 58 +++- ...rminalEnvVarCollectionService.unit.test.ts | 3 +- src/test/mocks/vsc/index.ts | 2 + src/test/smoke/smartSend.smoke.test.ts | 131 ++++---- .../terminalCodeExec.unit.test.ts | 8 +- ...scode.proposed.envCollectionWorkspace.d.ts | 7 - types/vscode.proposed.envShellEvent.d.ts | 16 - ...ode.proposed.terminalShellIntegration.d.ts | 312 ------------------ 17 files changed, 233 insertions(+), 429 deletions(-) delete mode 100644 types/vscode.proposed.envShellEvent.d.ts delete mode 100644 types/vscode.proposed.terminalShellIntegration.d.ts diff --git a/.github/actions/smoke-tests/action.yml b/.github/actions/smoke-tests/action.yml index cc2912115176..d4ac73b1a803 100644 --- a/.github/actions/smoke-tests/action.yml +++ b/.github/actions/smoke-tests/action.yml @@ -43,7 +43,7 @@ runs: # Bits from the VSIX are reused by smokeTest.ts to speed things up. - name: Download VSIX - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: ${{ inputs.artifact_name }} diff --git a/package-lock.json b/package-lock.json index 06737473c436..7d8cc145dc38 100644 --- a/package-lock.json +++ b/package-lock.json @@ -57,7 +57,7 @@ "@types/sinon": "^17.0.3", "@types/stack-trace": "0.0.29", "@types/tmp": "^0.0.33", - "@types/vscode": "^1.81.0", + "@types/vscode": "^1.93.0", "@types/which": "^2.0.1", "@types/winreg": "^1.2.30", "@types/xml2js": "^0.4.2", @@ -116,7 +116,7 @@ "yargs": "^15.3.1" }, "engines": { - "vscode": "^1.91.0" + "vscode": "^1.93.0" } }, "node_modules/@aashutoshrathi/word-wrap": { @@ -1796,9 +1796,9 @@ "dev": true }, "node_modules/@types/vscode": { - "version": "1.81.0", - "resolved": "https://registry.npmjs.org/@types/vscode/-/vscode-1.81.0.tgz", - "integrity": "sha512-YIaCwpT+O2E7WOMq0eCgBEABE++SX3Yl/O02GoMIF2DO3qAtvw7m6BXFYsxnc6XyzwZgh6/s/UG78LSSombl2w==", + "version": "1.93.0", + "resolved": "https://registry.npmjs.org/@types/vscode/-/vscode-1.93.0.tgz", + "integrity": "sha512-kUK6jAHSR5zY8ps42xuW89NLcBpw1kOabah7yv38J8MyiYuOHxLQBi0e7zeXbQgVefDy/mZZetqEFC+Fl5eIEQ==", "dev": true }, "node_modules/@types/which": { @@ -16046,9 +16046,9 @@ "dev": true }, "@types/vscode": { - "version": "1.81.0", - "resolved": "https://registry.npmjs.org/@types/vscode/-/vscode-1.81.0.tgz", - "integrity": "sha512-YIaCwpT+O2E7WOMq0eCgBEABE++SX3Yl/O02GoMIF2DO3qAtvw7m6BXFYsxnc6XyzwZgh6/s/UG78LSSombl2w==", + "version": "1.93.0", + "resolved": "https://registry.npmjs.org/@types/vscode/-/vscode-1.93.0.tgz", + "integrity": "sha512-kUK6jAHSR5zY8ps42xuW89NLcBpw1kOabah7yv38J8MyiYuOHxLQBi0e7zeXbQgVefDy/mZZetqEFC+Fl5eIEQ==", "dev": true }, "@types/which": { diff --git a/package.json b/package.json index e033fde418c0..e588b025c159 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "theme": "dark" }, "engines": { - "vscode": "^1.91.0" + "vscode": "^1.93.0" }, "enableTelemetry": false, "keywords": [ @@ -1570,7 +1570,7 @@ "@types/sinon": "^17.0.3", "@types/stack-trace": "0.0.29", "@types/tmp": "^0.0.33", - "@types/vscode": "^1.81.0", + "@types/vscode": "^1.93.0", "@types/which": "^2.0.1", "@types/winreg": "^1.2.30", "@types/xml2js": "^0.4.2", diff --git a/src/client/common/application/terminalManager.ts b/src/client/common/application/terminalManager.ts index e5b758437393..9d0536e85243 100644 --- a/src/client/common/application/terminalManager.ts +++ b/src/client/common/application/terminalManager.ts @@ -2,7 +2,16 @@ // Licensed under the MIT License. import { injectable } from 'inversify'; -import { Event, EventEmitter, Terminal, TerminalOptions, window } from 'vscode'; +import { + Disposable, + Event, + EventEmitter, + Terminal, + TerminalOptions, + TerminalShellExecutionEndEvent, + TerminalShellIntegrationChangeEvent, + window, +} from 'vscode'; import { traceLog } from '../../logging'; import { ITerminalManager } from './types'; @@ -23,6 +32,12 @@ export class TerminalManager implements ITerminalManager { public createTerminal(options: TerminalOptions): Terminal { return monkeyPatchTerminal(window.createTerminal(options)); } + public onDidChangeTerminalShellIntegration(handler: (e: TerminalShellIntegrationChangeEvent) => void): Disposable { + return window.onDidChangeTerminalShellIntegration(handler); + } + public onDidEndTerminalShellExecution(handler: (e: TerminalShellExecutionEndEvent) => void): Disposable { + return window.onDidEndTerminalShellExecution(handler); + } } /** diff --git a/src/client/common/application/types.ts b/src/client/common/application/types.ts index 6705331bf57d..413122f2584b 100644 --- a/src/client/common/application/types.ts +++ b/src/client/common/application/types.ts @@ -40,6 +40,8 @@ import { StatusBarItem, Terminal, TerminalOptions, + TerminalShellExecutionEndEvent, + TerminalShellIntegrationChangeEvent, TextDocument, TextDocumentChangeEvent, TextDocumentShowOptions, @@ -936,6 +938,10 @@ export interface ITerminalManager { * @return A new Terminal. */ createTerminal(options: TerminalOptions): Terminal; + + onDidChangeTerminalShellIntegration(handler: (e: TerminalShellIntegrationChangeEvent) => void): Disposable; + + onDidEndTerminalShellExecution(handler: (e: TerminalShellExecutionEndEvent) => void): Disposable; } export const IDebugService = Symbol('IDebugManager'); diff --git a/src/client/common/terminal/service.ts b/src/client/common/terminal/service.ts index de276762de4b..19cdf0aea0a1 100644 --- a/src/client/common/terminal/service.ts +++ b/src/client/common/terminal/service.ts @@ -20,6 +20,7 @@ import { ITerminalService, TerminalCreationOptions, TerminalShellType, + ITerminalExecutedCommand, } from './types'; @injectable() @@ -32,6 +33,7 @@ export class TerminalService implements ITerminalService, Disposable { private terminalActivator: ITerminalActivator; private terminalAutoActivator: ITerminalAutoActivation; private readonly envVarScript = path.join(EXTENSION_ROOT_DIR, 'python_files', 'pythonrc.py'); + private readonly executeCommandListeners: Set = new Set(); public get onDidCloseTerminal(): Event { return this.terminalClosed.event.bind(this.terminalClosed); } @@ -48,8 +50,12 @@ export class TerminalService implements ITerminalService, Disposable { this.terminalActivator = this.serviceContainer.get(ITerminalActivator); } public dispose() { - if (this.terminal) { - this.terminal.dispose(); + this.terminal?.dispose(); + + if (this.executeCommandListeners && this.executeCommandListeners.size > 0) { + this.executeCommandListeners.forEach((d) => { + d?.dispose(); + }); } } public async sendCommand(command: string, args: string[], _?: CancellationToken): Promise { @@ -59,8 +65,9 @@ export class TerminalService implements ITerminalService, Disposable { this.terminal!.show(true); } - this.terminal!.sendText(text, true); + await this.executeCommand(text); } + /** @deprecated */ public async sendText(text: string): Promise { await this.ensureTerminal(); if (!this.options?.hideFromUser) { @@ -68,12 +75,57 @@ export class TerminalService implements ITerminalService, Disposable { } this.terminal!.sendText(text); } + public async executeCommand(commandLine: string): Promise { + const terminal = this.terminal!; + if (!this.options?.hideFromUser) { + terminal.show(true); + } + + // If terminal was just launched, wait some time for shell integration to onDidChangeShellIntegration. + if (!terminal.shellIntegration) { + const promise = new Promise((resolve) => { + const shellIntegrationChangeEventListener = this.terminalManager.onDidChangeTerminalShellIntegration( + () => { + this.executeCommandListeners.delete(shellIntegrationChangeEventListener); + resolve(true); + }, + ); + const TIMEOUT_DURATION = 3000; + setTimeout(() => { + this.executeCommandListeners.add(shellIntegrationChangeEventListener); + resolve(true); + }, TIMEOUT_DURATION); + }); + await promise; + } + + if (terminal.shellIntegration) { + const execution = terminal.shellIntegration.executeCommand(commandLine); + return await new Promise((resolve) => { + const listener = this.terminalManager.onDidEndTerminalShellExecution((e) => { + if (e.execution === execution) { + this.executeCommandListeners.delete(listener); + resolve({ execution, exitCode: e.exitCode }); + } + }); + if (listener) { + this.executeCommandListeners.add(listener); + } + }); + } else { + terminal.sendText(commandLine); + } + + return undefined; + } + public async show(preserveFocus: boolean = true): Promise { await this.ensureTerminal(preserveFocus); if (!this.options?.hideFromUser) { this.terminal!.show(preserveFocus); } } + // TODO: Debt switch to Promise ---> breaks 20 tests public async ensureTerminal(preserveFocus: boolean = true): Promise { if (this.terminal) { return; @@ -89,7 +141,7 @@ export class TerminalService implements ITerminalService, Disposable { // Sometimes the terminal takes some time to start up before it can start accepting input. await new Promise((resolve) => setTimeout(resolve, 100)); - await this.terminalActivator.activateEnvironmentInTerminal(this.terminal!, { + await this.terminalActivator.activateEnvironmentInTerminal(this.terminal, { resource: this.options?.resource, preserveFocus, interpreter: this.options?.interpreter, @@ -97,10 +149,11 @@ export class TerminalService implements ITerminalService, Disposable { }); if (!this.options?.hideFromUser) { - this.terminal!.show(preserveFocus); + this.terminal.show(preserveFocus); } this.sendTelemetry().ignoreErrors(); + return; } private terminalCloseHandler(terminal: Terminal) { if (terminal === this.terminal) { diff --git a/src/client/common/terminal/syncTerminalService.ts b/src/client/common/terminal/syncTerminalService.ts index 4e95ddab01b5..7b25c714a035 100644 --- a/src/client/common/terminal/syncTerminalService.ts +++ b/src/client/common/terminal/syncTerminalService.ts @@ -14,7 +14,7 @@ import * as internalScripts from '../process/internal/scripts'; import { createDeferred, Deferred } from '../utils/async'; import { noop } from '../utils/misc'; import { TerminalService } from './service'; -import { ITerminalService } from './types'; +import { ITerminalService, ITerminalExecutedCommand } from './types'; enum State { notStarted = 0, @@ -146,9 +146,13 @@ export class SynchronousTerminalService implements ITerminalService, Disposable lockFile.dispose(); } } + /** @deprecated */ public sendText(text: string): Promise { return this.terminalService.sendText(text); } + public executeCommand(commandLine: string): Promise { + return this.terminalService.executeCommand(commandLine); + } public show(preserveFocus?: boolean | undefined): Promise { return this.terminalService.show(preserveFocus); } diff --git a/src/client/common/terminal/types.ts b/src/client/common/terminal/types.ts index 49f42e7c19f6..aa8ff73cc205 100644 --- a/src/client/common/terminal/types.ts +++ b/src/client/common/terminal/types.ts @@ -3,7 +3,7 @@ 'use strict'; -import { CancellationToken, Event, Terminal, Uri } from 'vscode'; +import { CancellationToken, Event, Terminal, Uri, TerminalShellExecution } from 'vscode'; import { PythonEnvironment } from '../../pythonEnvironments/info'; import { IEventNamePropertyMapping } from '../../telemetry/index'; import { IDisposable, Resource } from '../types'; @@ -52,10 +52,17 @@ export interface ITerminalService extends IDisposable { cancel?: CancellationToken, swallowExceptions?: boolean, ): Promise; + /** @deprecated */ sendText(text: string): Promise; + executeCommand(commandLine: string): Promise; show(preserveFocus?: boolean): Promise; } +export interface ITerminalExecutedCommand { + execution: TerminalShellExecution; + exitCode: number | undefined; +} + export const ITerminalServiceFactory = Symbol('ITerminalServiceFactory'); export type TerminalCreationOptions = { diff --git a/src/client/terminals/codeExecution/terminalCodeExecution.ts b/src/client/terminals/codeExecution/terminalCodeExecution.ts index f2750fedaa07..3cba6141763b 100644 --- a/src/client/terminals/codeExecution/terminalCodeExecution.ts +++ b/src/client/terminals/codeExecution/terminalCodeExecution.ts @@ -59,7 +59,7 @@ export class TerminalCodeExecutionProvider implements ICodeExecutionService { this.configurationService.updateSetting('REPL.enableREPLSmartSend', false, resource); } } else { - await this.getTerminalService(resource).sendText(code); + await this.getTerminalService(resource).executeCommand(code); } } diff --git a/src/test/common/terminals/service.unit.test.ts b/src/test/common/terminals/service.unit.test.ts index 61556e3df2d1..f0754948a233 100644 --- a/src/test/common/terminals/service.unit.test.ts +++ b/src/test/common/terminals/service.unit.test.ts @@ -4,7 +4,15 @@ import { expect } from 'chai'; import * as path from 'path'; import * as TypeMoq from 'typemoq'; -import { Disposable, Terminal as VSCodeTerminal, WorkspaceConfiguration } from 'vscode'; +import { + Disposable, + EventEmitter, + TerminalShellExecution, + TerminalShellExecutionEndEvent, + TerminalShellIntegration, + Terminal as VSCodeTerminal, + WorkspaceConfiguration, +} from 'vscode'; import { ITerminalManager, IWorkspaceService } from '../../../client/common/application/types'; import { EXTENSION_ROOT_DIR } from '../../../client/common/constants'; import { IPlatformService } from '../../../client/common/platform/types'; @@ -26,9 +34,44 @@ suite('Terminal Service', () => { let disposables: Disposable[] = []; let mockServiceContainer: TypeMoq.IMock; let terminalAutoActivator: TypeMoq.IMock; + let terminalShellIntegration: TypeMoq.IMock; + let onDidEndTerminalShellExecutionEmitter: EventEmitter; + let event: TerminalShellExecutionEndEvent; + setup(() => { terminal = TypeMoq.Mock.ofType(); + terminalShellIntegration = TypeMoq.Mock.ofType(); + terminal.setup((t) => t.shellIntegration).returns(() => terminalShellIntegration.object); + + onDidEndTerminalShellExecutionEmitter = new EventEmitter(); terminalManager = TypeMoq.Mock.ofType(); + const execution: TerminalShellExecution = { + commandLine: { + value: 'dummy text', + isTrusted: true, + confidence: 2, + }, + cwd: undefined, + read: function (): AsyncIterable { + throw new Error('Function not implemented.'); + }, + }; + + event = { + execution, + exitCode: 0, + terminal: terminal.object, + shellIntegration: terminalShellIntegration.object, + }; + + terminalShellIntegration.setup((t) => t.executeCommand(TypeMoq.It.isAny())).returns(() => execution); + + terminalManager + .setup((t) => t.onDidEndTerminalShellExecution) + .returns(() => { + setTimeout(() => onDidEndTerminalShellExecutionEmitter.fire(event), 100); + return onDidEndTerminalShellExecutionEmitter.event; + }); platformService = TypeMoq.Mock.ofType(); workspaceService = TypeMoq.Mock.ofType(); terminalHelper = TypeMoq.Mock.ofType(); @@ -37,6 +80,7 @@ suite('Terminal Service', () => { disposables = []; mockServiceContainer = TypeMoq.Mock.ofType(); + mockServiceContainer.setup((c) => c.get(ITerminalManager)).returns(() => terminalManager.object); mockServiceContainer.setup((c) => c.get(ITerminalHelper)).returns(() => terminalHelper.object); mockServiceContainer.setup((c) => c.get(IPlatformService)).returns(() => platformService.object); @@ -75,10 +119,16 @@ suite('Terminal Service', () => { .setup((h) => h.buildCommandForTerminal(TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny())) .returns(() => 'dummy text'); + terminalManager + .setup((t) => t.onDidEndTerminalShellExecution) + .returns(() => { + setTimeout(() => onDidEndTerminalShellExecutionEmitter.fire(event), 100); + return onDidEndTerminalShellExecutionEmitter.event; + }); // Sending a command will cause the terminal to be created await service.sendCommand('', []); - terminal.verify((t) => t.show(TypeMoq.It.isValue(true)), TypeMoq.Times.exactly(2)); + terminal.verify((t) => t.show(TypeMoq.It.isValue(true)), TypeMoq.Times.atLeastOnce()); service.dispose(); terminal.verify((t) => t.dispose(), TypeMoq.Times.exactly(1)); }); @@ -99,10 +149,10 @@ suite('Terminal Service', () => { await service.sendCommand(commandToSend, args); - terminal.verify((t) => t.show(TypeMoq.It.isValue(true)), TypeMoq.Times.exactly(2)); + terminal.verify((t) => t.show(TypeMoq.It.isValue(true)), TypeMoq.Times.atLeastOnce()); terminal.verify( (t) => t.sendText(TypeMoq.It.isValue(commandToExpect), TypeMoq.It.isValue(true)), - TypeMoq.Times.exactly(1), + TypeMoq.Times.never(), ); }); diff --git a/src/test/interpreters/activation/terminalEnvVarCollectionService.unit.test.ts b/src/test/interpreters/activation/terminalEnvVarCollectionService.unit.test.ts index 22b5dcf7477a..5d1027d12702 100644 --- a/src/test/interpreters/activation/terminalEnvVarCollectionService.unit.test.ts +++ b/src/test/interpreters/activation/terminalEnvVarCollectionService.unit.test.ts @@ -134,7 +134,6 @@ suite('Terminal Environment Variable Collection Service', () => { test('When not in experiment, do not apply activated variables to the collection and clear it instead', async () => { reset(experimentService); - when(context.environmentVariableCollection).thenReturn(instance(collection)); when(experimentService.inExperimentSync(TerminalEnvVarActivation.experiment)).thenReturn(false); const applyCollectionStub = sinon.stub(terminalEnvVarCollectionService, '_applyCollection'); applyCollectionStub.resolves(); @@ -147,7 +146,7 @@ suite('Terminal Environment Variable Collection Service', () => { verify(applicationEnvironment.onDidChangeShell(anything(), anything(), anything())).never(); assert(applyCollectionStub.notCalled, 'Collection should not be applied on activation'); - verify(collection.clear()).atLeast(1); + verify(globalCollection.clear()).atLeast(1); }); test('When interpreter changes, apply new activated variables to the collection', async () => { diff --git a/src/test/mocks/vsc/index.ts b/src/test/mocks/vsc/index.ts index 774ba388bb4e..4ba0c0bcbf92 100644 --- a/src/test/mocks/vsc/index.ts +++ b/src/test/mocks/vsc/index.ts @@ -369,6 +369,8 @@ export class CodeActionKind { public static readonly SourceFixAll: CodeActionKind = new CodeActionKind('source.fix.all'); + public static readonly Notebook: CodeActionKind = new CodeActionKind('notebook'); + private constructor(private _value: string) {} public append(parts: string): CodeActionKind { diff --git a/src/test/smoke/smartSend.smoke.test.ts b/src/test/smoke/smartSend.smoke.test.ts index a35c02ceaa63..7f894df923ee 100644 --- a/src/test/smoke/smartSend.smoke.test.ts +++ b/src/test/smoke/smartSend.smoke.test.ts @@ -6,78 +6,81 @@ import { EXTENSION_ROOT_DIR_FOR_TESTS, IS_SMOKE_TEST } from '../constants'; import { closeActiveWindows, initialize, initializeTest } from '../initialize'; import { openFile, waitForCondition } from '../common'; -suite('Smoke Test: Run Smart Selection and Advance Cursor', () => { - suiteSetup(async function () { - if (!IS_SMOKE_TEST) { - return this.skip(); - } - await initialize(); - return undefined; - }); +// TODO: This test is being flaky for windows, need to investigate why only fails on windows +if (process.platform !== 'win32') { + suite('Smoke Test: Run Smart Selection and Advance Cursor', () => { + suiteSetup(async function () { + if (!IS_SMOKE_TEST) { + return this.skip(); + } + await initialize(); + return undefined; + }); - setup(initializeTest); - suiteTeardown(closeActiveWindows); - teardown(closeActiveWindows); + setup(initializeTest); + suiteTeardown(closeActiveWindows); + teardown(closeActiveWindows); - test('Smart Send', async () => { - const file = path.join( - EXTENSION_ROOT_DIR_FOR_TESTS, - 'src', - 'testMultiRootWkspc', - 'smokeTests', - 'create_delete_file.py', - ); - const outputFile = path.join( - EXTENSION_ROOT_DIR_FOR_TESTS, - 'src', - 'testMultiRootWkspc', - 'smokeTests', - 'smart_send_smoke.txt', - ); + test('Smart Send', async () => { + const file = path.join( + EXTENSION_ROOT_DIR_FOR_TESTS, + 'src', + 'testMultiRootWkspc', + 'smokeTests', + 'create_delete_file.py', + ); + const outputFile = path.join( + EXTENSION_ROOT_DIR_FOR_TESTS, + 'src', + 'testMultiRootWkspc', + 'smokeTests', + 'smart_send_smoke.txt', + ); - await fs.remove(outputFile); + await fs.remove(outputFile); - const textDocument = await openFile(file); + const textDocument = await openFile(file); - if (vscode.window.activeTextEditor) { - const myPos = new vscode.Position(0, 0); - vscode.window.activeTextEditor!.selections = [new vscode.Selection(myPos, myPos)]; - } - await vscode.commands - .executeCommand('python.execSelectionInTerminal', textDocument.uri) - .then(undefined, (err) => { - assert.fail(`Something went wrong running the Python file in the terminal: ${err}`); - }); + if (vscode.window.activeTextEditor) { + const myPos = new vscode.Position(0, 0); + vscode.window.activeTextEditor!.selections = [new vscode.Selection(myPos, myPos)]; + } + await vscode.commands + .executeCommand('python.execSelectionInTerminal', textDocument.uri) + .then(undefined, (err) => { + assert.fail(`Something went wrong running the Python file in the terminal: ${err}`); + }); - const checkIfFileHasBeenCreated = () => fs.pathExists(outputFile); - await waitForCondition(checkIfFileHasBeenCreated, 10_000, `"${outputFile}" file not created`); + const checkIfFileHasBeenCreated = () => fs.pathExists(outputFile); + await waitForCondition(checkIfFileHasBeenCreated, 10_000, `"${outputFile}" file not created`); - await vscode.commands - .executeCommand('python.execSelectionInTerminal', textDocument.uri) - .then(undefined, (err) => { - assert.fail(`Something went wrong running the Python file in the terminal: ${err}`); - }); - await vscode.commands - .executeCommand('python.execSelectionInTerminal', textDocument.uri) - .then(undefined, (err) => { - assert.fail(`Something went wrong running the Python file in the terminal: ${err}`); - }); + await vscode.commands + .executeCommand('python.execSelectionInTerminal', textDocument.uri) + .then(undefined, (err) => { + assert.fail(`Something went wrong running the Python file in the terminal: ${err}`); + }); + await vscode.commands + .executeCommand('python.execSelectionInTerminal', textDocument.uri) + .then(undefined, (err) => { + assert.fail(`Something went wrong running the Python file in the terminal: ${err}`); + }); - async function wait() { - return new Promise((resolve) => { - setTimeout(() => { - resolve(); - }, 10000); - }); - } + async function wait() { + return new Promise((resolve) => { + setTimeout(() => { + resolve(); + }, 10000); + }); + } - await wait(); + await wait(); - const deletedFile = !(await fs.pathExists(outputFile)); - if (deletedFile) { - assert.ok(true, `"${outputFile}" file has been deleted`); - } else { - assert.fail(`"${outputFile}" file still exists`); - } + const deletedFile = !(await fs.pathExists(outputFile)); + if (deletedFile) { + assert.ok(true, `"${outputFile}" file has been deleted`); + } else { + assert.fail(`"${outputFile}" file still exists`); + } + }); }); -}); +} diff --git a/src/test/terminals/codeExecution/terminalCodeExec.unit.test.ts b/src/test/terminals/codeExecution/terminalCodeExec.unit.test.ts index 4f60adb3b931..4b5537f515d2 100644 --- a/src/test/terminals/codeExecution/terminalCodeExec.unit.test.ts +++ b/src/test/terminals/codeExecution/terminalCodeExec.unit.test.ts @@ -643,10 +643,10 @@ suite('Terminal - Code Execution', () => { terminalSettings.setup((t) => t.launchArgs).returns(() => terminalArgs); await executor.execute('cmd1'); - terminalService.verify(async (t) => t.sendText('cmd1'), TypeMoq.Times.once()); + terminalService.verify(async (t) => t.executeCommand('cmd1'), TypeMoq.Times.once()); await executor.execute('cmd2'); - terminalService.verify(async (t) => t.sendText('cmd2'), TypeMoq.Times.once()); + terminalService.verify(async (t) => t.executeCommand('cmd2'), TypeMoq.Times.once()); }); test('Ensure code is sent to the same terminal for a particular resource', async () => { @@ -668,10 +668,10 @@ suite('Terminal - Code Execution', () => { terminalSettings.setup((t) => t.launchArgs).returns(() => terminalArgs); await executor.execute('cmd1', resource); - terminalService.verify(async (t) => t.sendText('cmd1'), TypeMoq.Times.once()); + terminalService.verify(async (t) => t.executeCommand('cmd1'), TypeMoq.Times.once()); await executor.execute('cmd2', resource); - terminalService.verify(async (t) => t.sendText('cmd2'), TypeMoq.Times.once()); + terminalService.verify(async (t) => t.executeCommand('cmd2'), TypeMoq.Times.once()); }); }); }); diff --git a/types/vscode.proposed.envCollectionWorkspace.d.ts b/types/vscode.proposed.envCollectionWorkspace.d.ts index 494929ba15eb..a03a639b5ee2 100644 --- a/types/vscode.proposed.envCollectionWorkspace.d.ts +++ b/types/vscode.proposed.envCollectionWorkspace.d.ts @@ -27,11 +27,4 @@ declare module 'vscode' { */ getScoped(scope: EnvironmentVariableScope): EnvironmentVariableCollection; } - - export type EnvironmentVariableScope = { - /** - * Any specific workspace folder to get collection for. If unspecified, collection applicable to all workspace folders is returned. - */ - workspaceFolder?: WorkspaceFolder; - }; } diff --git a/types/vscode.proposed.envShellEvent.d.ts b/types/vscode.proposed.envShellEvent.d.ts deleted file mode 100644 index 8fed971ef711..000000000000 --- a/types/vscode.proposed.envShellEvent.d.ts +++ /dev/null @@ -1,16 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. - *--------------------------------------------------------------------------------------------*/ - -declare module 'vscode' { - - // See https://github.com/microsoft/vscode/issues/160694 - export namespace env { - - /** - * An {@link Event} which fires when the default shell changes. - */ - export const onDidChangeShell: Event; - } -} diff --git a/types/vscode.proposed.terminalShellIntegration.d.ts b/types/vscode.proposed.terminalShellIntegration.d.ts deleted file mode 100644 index 5ff18b60ca72..000000000000 --- a/types/vscode.proposed.terminalShellIntegration.d.ts +++ /dev/null @@ -1,312 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. - *--------------------------------------------------------------------------------------------*/ - -declare module 'vscode' { - // https://github.com/microsoft/vscode/issues/145234 - - /** - * A command that was executed in a terminal. - */ - export interface TerminalShellExecution { - /** - * The command line that was executed. The {@link TerminalShellExecutionCommandLineConfidence confidence} - * of this value depends on the specific shell's shell integration implementation. This - * value may become more accurate after {@link window.onDidEndTerminalShellExecution} is - * fired. - * - * @example - * // Log the details of the command line on start and end - * window.onDidStartTerminalShellExecution(event => { - * const commandLine = event.execution.commandLine; - * console.log(`Command started\n${summarizeCommandLine(commandLine)}`); - * }); - * window.onDidEndTerminalShellExecution(event => { - * const commandLine = event.execution.commandLine; - * console.log(`Command ended\n${summarizeCommandLine(commandLine)}`); - * }); - * function summarizeCommandLine(commandLine: TerminalShellExecutionCommandLine) { - * return [ - * ` Command line: ${command.ommandLine.value}`, - * ` Confidence: ${command.ommandLine.confidence}`, - * ` Trusted: ${command.ommandLine.isTrusted} - * ].join('\n'); - * } - */ - readonly commandLine: TerminalShellExecutionCommandLine; - - /** - * The working directory that was reported by the shell when this command executed. This - * {@link Uri} may represent a file on another machine (eg. ssh into another machine). This - * requires the shell integration to support working directory reporting. - */ - readonly cwd: Uri | undefined; - - /** - * Creates a stream of raw data (including escape sequences) that is written to the - * terminal. This will only include data that was written after `readData` was called for - * the first time, ie. you must call `readData` immediately after the command is executed - * via {@link TerminalShellIntegration.executeCommand} or - * {@link window.onDidStartTerminalShellExecution} to not miss any data. - * - * @example - * // Log all data written to the terminal for a command - * const command = term.shellIntegration.executeCommand({ commandLine: 'echo "Hello world"' }); - * const stream = command.read(); - * for await (const data of stream) { - * console.log(data); - * } - */ - read(): AsyncIterable; - } - - /** - * A command line that was executed in a terminal. - */ - export interface TerminalShellExecutionCommandLine { - /** - * The full command line that was executed, including both the command and its arguments. - */ - readonly value: string; - - /** - * Whether the command line value came from a trusted source and is therefore safe to - * execute without user additional confirmation, such as a notification that asks "Do you - * want to execute (command)?". This verification is likely only needed if you are going to - * execute the command again. - * - * This is `true` only when the command line was reported explicitly by the shell - * integration script (ie. {@link TerminalShellExecutionCommandLineConfidence.High high confidence}) - * and it used a nonce for verification. - */ - readonly isTrusted: boolean; - - /** - * The confidence of the command line value which is determined by how the value was - * obtained. This depends upon the implementation of the shell integration script. - */ - readonly confidence: TerminalShellExecutionCommandLineConfidence; - } - - /** - * The confidence of a {@link TerminalShellExecutionCommandLine} value. - */ - enum TerminalShellExecutionCommandLineConfidence { - /** - * The command line value confidence is low. This means that the value was read from the - * terminal buffer using markers reported by the shell integration script. Additionally one - * of the following conditions will be met: - * - * - The command started on the very left-most column which is unusual, or - * - The command is multi-line which is more difficult to accurately detect due to line - * continuation characters and right prompts. - * - Command line markers were not reported by the shell integration script. - */ - Low = 0, - - /** - * The command line value confidence is medium. This means that the value was read from the - * terminal buffer using markers reported by the shell integration script. The command is - * single-line and does not start on the very left-most column (which is unusual). - */ - Medium = 1, - - /** - * The command line value confidence is high. This means that the value was explicitly sent - * from the shell integration script or the command was executed via the - * {@link TerminalShellIntegration.executeCommand} API. - */ - High = 2, - } - - export interface Terminal { - /** - * An object that contains [shell integration](https://code.visualstudio.com/docs/terminal/shell-integration)-powered - * features for the terminal. This will always be `undefined` immediately after the terminal - * is created. Listen to {@link window.onDidActivateTerminalShellIntegration} to be notified - * when shell integration is activated for a terminal. - * - * Note that this object may remain undefined if shell integation never activates. For - * example Command Prompt does not support shell integration and a user's shell setup could - * conflict with the automatic shell integration activation. - */ - readonly shellIntegration: TerminalShellIntegration | undefined; - } - - /** - * [Shell integration](https://code.visualstudio.com/docs/terminal/shell-integration)-powered capabilities owned by a terminal. - */ - export interface TerminalShellIntegration { - /** - * The current working directory of the terminal. This {@link Uri} may represent a file on - * another machine (eg. ssh into another machine). This requires the shell integration to - * support working directory reporting. - */ - readonly cwd: Uri | undefined; - - /** - * Execute a command, sending ^C as necessary to interrupt any running command if needed. - * - * @param commandLine The command line to execute, this is the exact text that will be sent - * to the terminal. - * - * @example - * // Execute a command in a terminal immediately after being created - * const myTerm = window.createTerminal(); - * window.onDidActivateTerminalShellIntegration(async ({ terminal, shellIntegration }) => { - * if (terminal === myTerm) { - * const command = shellIntegration.executeCommand('echo "Hello world"'); - * const code = await command.exitCode; - * console.log(`Command exited with code ${code}`); - * } - * })); - * // Fallback to sendText if there is no shell integration within 3 seconds of launching - * setTimeout(() => { - * if (!myTerm.shellIntegration) { - * myTerm.sendText('echo "Hello world"'); - * // Without shell integration, we can't know when the command has finished or what the - * // exit code was. - * } - * }, 3000); - * - * @example - * // Send command to terminal that has been alive for a while - * const commandLine = 'echo "Hello world"'; - * if (term.shellIntegration) { - * const command = term.shellIntegration.executeCommand({ commandLine }); - * const code = await command.exitCode; - * console.log(`Command exited with code ${code}`); - * } else { - * term.sendText(commandLine); - * // Without shell integration, we can't know when the command has finished or what the - * // exit code was. - * } - */ - executeCommand(commandLine: string): TerminalShellExecution; - - /** - * Execute a command, sending ^C as necessary to interrupt any running command if needed. - * - * *Note* This is not guaranteed to work as [shell integration](https://code.visualstudio.com/docs/terminal/shell-integration) - * must be activated. Check whether {@link TerminalShellExecution.exitCode} is rejected to - * verify whether it was successful. - * - * @param command A command to run. - * @param args Arguments to launch the executable with which will be automatically escaped - * based on the executable type. - * - * @example - * // Execute a command in a terminal immediately after being created - * const myTerm = window.createTerminal(); - * window.onDidActivateTerminalShellIntegration(async ({ terminal, shellIntegration }) => { - * if (terminal === myTerm) { - * const command = shellIntegration.executeCommand({ - * command: 'echo', - * args: ['Hello world'] - * }); - * const code = await command.exitCode; - * console.log(`Command exited with code ${code}`); - * } - * })); - * // Fallback to sendText if there is no shell integration within 3 seconds of launching - * setTimeout(() => { - * if (!myTerm.shellIntegration) { - * myTerm.sendText('echo "Hello world"'); - * // Without shell integration, we can't know when the command has finished or what the - * // exit code was. - * } - * }, 3000); - * - * @example - * // Send command to terminal that has been alive for a while - * const commandLine = 'echo "Hello world"'; - * if (term.shellIntegration) { - * const command = term.shellIntegration.executeCommand({ - * command: 'echo', - * args: ['Hello world'] - * }); - * const code = await command.exitCode; - * console.log(`Command exited with code ${code}`); - * } else { - * term.sendText(commandLine); - * // Without shell integration, we can't know when the command has finished or what the - * // exit code was. - * } - */ - executeCommand(executable: string, args: string[]): TerminalShellExecution; - } - - export interface TerminalShellIntegrationChangeEvent { - /** - * The terminal that shell integration has been activated in. - */ - readonly terminal: Terminal; - - /** - * The shell integration object. - */ - readonly shellIntegration: TerminalShellIntegration; - } - - export interface TerminalShellExecutionStartEvent { - /** - * The terminal that shell integration has been activated in. - */ - readonly terminal: Terminal; - - /** - * The shell integration object. - */ - readonly shellIntegration: TerminalShellIntegration; - - /** - * The terminal shell execution that has ended. - */ - readonly execution: TerminalShellExecution; - } - - export interface TerminalShellExecutionEndEvent { - /** - * The terminal that shell integration has been activated in. - */ - readonly terminal: Terminal; - - /** - * The shell integration object. - */ - readonly shellIntegration: TerminalShellIntegration; - - /** - * The terminal shell execution that has ended. - */ - readonly execution: TerminalShellExecution; - - /** - * The exit code reported by the shell. `undefined` means the shell did not report an exit - * code or the shell reported a command started before the command finished. - */ - readonly exitCode: number | undefined; - } - - export namespace window { - /** - * Fires when shell integration activates or one of its properties changes in a terminal. - */ - export const onDidChangeTerminalShellIntegration: Event; - - /** - * This will be fired when a terminal command is started. This event will fire only when - * [shell integration](https://code.visualstudio.com/docs/terminal/shell-integration) is - * activated for the terminal. - */ - export const onDidStartTerminalShellExecution: Event; - - /** - * This will be fired when a terminal command is ended. This event will fire only when - * [shell integration](https://code.visualstudio.com/docs/terminal/shell-integration) is - * activated for the terminal. - */ - export const onDidEndTerminalShellExecution: Event; - } -} From 0ae1a5dcf7625de914344ea1dae543c3cd208b46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20Ram=C3=ADrez=20Mondrag=C3=B3n?= <16805946+edgarrmondragon@users.noreply.github.com> Date: Fri, 13 Sep 2024 00:57:43 -0600 Subject: [PATCH 085/149] Add `uv.lock` to file associations (#23991) > `uv.lock` is a human-readable TOML file https://docs.astral.sh/uv/concepts/projects/#lockfile --- package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index e588b025c159..257b8abe54e3 100644 --- a/package.json +++ b/package.json @@ -1192,7 +1192,8 @@ { "filenames": [ "Pipfile", - "poetry.lock" + "poetry.lock", + "uv.lock" ], "id": "toml" }, From 144ecf686e3c675e1c8676a834f38badd124eb92 Mon Sep 17 00:00:00 2001 From: Stella <100439259+StellaHuang95@users.noreply.github.com> Date: Fri, 13 Sep 2024 16:06:07 -0700 Subject: [PATCH 086/149] Enable proposed APIs for `codeActionAI` (#24108) Addresses https://github.com/microsoft/vscode-python/issues/24068 - Enable proposed APIs for `codeActionAI` - Pin the engine to `1.94.0-20240913` --- package-lock.json | 2 +- package.json | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7d8cc145dc38..87af2d83a205 100644 --- a/package-lock.json +++ b/package-lock.json @@ -116,7 +116,7 @@ "yargs": "^15.3.1" }, "engines": { - "vscode": "^1.93.0" + "vscode": "^1.94.0-20240913" } }, "node_modules/@aashutoshrathi/word-wrap": { diff --git a/package.json b/package.json index 257b8abe54e3..ab0f4b1bb82d 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,8 @@ "quickPickItemTooltip", "terminalDataWriteEvent", "terminalExecuteCommandEvent", - "contribIssueReporter" + "contribIssueReporter", + "codeActionAI" ], "author": { "name": "Microsoft Corporation" @@ -45,7 +46,7 @@ "theme": "dark" }, "engines": { - "vscode": "^1.93.0" + "vscode": "^1.94.0-20240913" }, "enableTelemetry": false, "keywords": [ From b59af57db6248c3d5deb2f2854fc7fe7583a1a8c Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Tue, 17 Sep 2024 18:17:58 -0400 Subject: [PATCH 087/149] Contribute problem matcher (#24114) Resolves: https://github.com/microsoft/vscode-python/issues/3828 Breaking https://github.com/microsoft/vscode-python/pull/23953 down into two PR 1. problem matcher --> make sure to cover case where there is invalid strings printed before the Error (e.g. NameError or ValueError) 2. Whether we will replace 'Run In Terminal by contributing task with the problem matcher attached. --------- Co-authored-by: Karthik Nadig --- package.json | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/package.json b/package.json index ab0f4b1bb82d..085eaf694718 100644 --- a/package.json +++ b/package.json @@ -80,6 +80,30 @@ "browser": "./dist/extension.browser.js", "l10n": "./l10n", "contributes": { + "problemMatchers": + [ + { + "name": "python", + "owner": "python", + "source": "python", + "fileLocation": "autoDetect", + "pattern": [ + { + "regexp": "^.*File \\\"([^\\\"]|.*)\\\", line (\\d+).*", + "file": 1, + "line": 2 + }, + { + "regexp": "^\\s*(.*)\\s*$" + + }, + { + "regexp": "^\\s*(.*Error.*)$", + "message": 1 + } + ] + } + ], "walkthroughs": [ { "id": "pythonWelcome", From 717e518b689b1f8f2b931a7522718bd0fa0c16df Mon Sep 17 00:00:00 2001 From: Aaron Munger Date: Tue, 17 Sep 2024 18:44:55 -0700 Subject: [PATCH 088/149] variable provider for native repl (#24094) fix https://github.com/microsoft/vscode-python/issues/24066 --- package.json | 1 + python_files/get_variable_info.py | 539 ++++++++++++++++++ python_files/tests/test_get_variable_info.py | 114 ++++ src/client/repl/nativeRepl.ts | 11 +- src/client/repl/pythonServer.ts | 22 +- src/client/repl/variables/types.ts | 17 + .../repl/variables/variableRequester.ts | 59 ++ .../repl/variables/variableResultCache.ts | 28 + .../repl/variables/variablesProvider.ts | 146 +++++ src/test/repl/variableProvider.test.ts | 240 ++++++++ ...ode.proposed.notebookVariableProvider.d.ts | 55 ++ 11 files changed, 1228 insertions(+), 4 deletions(-) create mode 100644 python_files/get_variable_info.py create mode 100644 python_files/tests/test_get_variable_info.py create mode 100644 src/client/repl/variables/types.ts create mode 100644 src/client/repl/variables/variableRequester.ts create mode 100644 src/client/repl/variables/variableResultCache.ts create mode 100644 src/client/repl/variables/variablesProvider.ts create mode 100644 src/test/repl/variableProvider.test.ts create mode 100644 types/vscode.proposed.notebookVariableProvider.d.ts diff --git a/package.json b/package.json index 085eaf694718..fb46cab3d6c8 100644 --- a/package.json +++ b/package.json @@ -25,6 +25,7 @@ "terminalDataWriteEvent", "terminalExecuteCommandEvent", "contribIssueReporter", + "notebookVariableProvider", "codeActionAI" ], "author": { diff --git a/python_files/get_variable_info.py b/python_files/get_variable_info.py new file mode 100644 index 000000000000..d60795982617 --- /dev/null +++ b/python_files/get_variable_info.py @@ -0,0 +1,539 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See LICENSE in the project root +# for license information. + +import locale +import sys +from typing import ClassVar + + +# this class is from in ptvsd/debugpy tools +class SafeRepr(object): # noqa: UP004 + # Can be used to override the encoding from locale.getpreferredencoding() + locale_preferred_encoding = None + + # Can be used to override the encoding used for sys.stdout.encoding + sys_stdout_encoding = None + + # String types are truncated to maxstring_outer when at the outer- + # most level, and truncated to maxstring_inner characters inside + # collections. + maxstring_outer = 2**16 + maxstring_inner = 128 + string_types = (str, bytes) + bytes = bytes + set_info = (set, "{", "}", False) + frozenset_info = (frozenset, "frozenset({", "})", False) + int_types = (int,) + long_iter_types = (list, tuple, bytearray, range, dict, set, frozenset) + + # Collection types are recursively iterated for each limit in + # maxcollection. + maxcollection = (60, 20) + + # Specifies type, prefix string, suffix string, and whether to include a + # comma if there is only one element. (Using a sequence rather than a + # mapping because we use isinstance() to determine the matching type.) + collection_types = [ # noqa: RUF012 + (tuple, "(", ")", True), + (list, "[", "]", False), + frozenset_info, + set_info, + ] + try: + from collections import deque + + collection_types.append((deque, "deque([", "])", False)) + except Exception: + pass + + # type, prefix string, suffix string, item prefix string, + # item key/value separator, item suffix string + dict_types: ClassVar[list] = [(dict, "{", "}", "", ": ", "")] + try: + from collections import OrderedDict + + dict_types.append((OrderedDict, "OrderedDict([", "])", "(", ", ", ")")) + except Exception: + pass + + # All other types are treated identically to strings, but using + # different limits. + maxother_outer = 2**16 + maxother_inner = 128 + + convert_to_hex = False + raw_value = False + + def __call__(self, obj): + """ + :param object obj: + The object for which we want a representation. + + :return str: + Returns bytes encoded as utf-8 on py2 and str on py3. + """ # noqa: D205 + try: + return "".join(self._repr(obj, 0)) + except Exception: + try: + return f"An exception was raised: {sys.exc_info()[1]!r}" + except Exception: + return "An exception was raised" + + def _repr(self, obj, level): + """Returns an iterable of the parts in the final repr string.""" + try: + obj_repr = type(obj).__repr__ + except Exception: + obj_repr = None + + def has_obj_repr(t): + r = t.__repr__ + try: + return obj_repr == r + except Exception: + return obj_repr is r + + for t, prefix, suffix, comma in self.collection_types: + if isinstance(obj, t) and has_obj_repr(t): + return self._repr_iter(obj, level, prefix, suffix, comma) + + for ( + t, + prefix, + suffix, + item_prefix, + item_sep, + item_suffix, + ) in self.dict_types: + if isinstance(obj, t) and has_obj_repr(t): + return self._repr_dict( + obj, level, prefix, suffix, item_prefix, item_sep, item_suffix + ) + + for t in self.string_types: + if isinstance(obj, t) and has_obj_repr(t): + return self._repr_str(obj, level) + + if self._is_long_iter(obj): + return self._repr_long_iter(obj) + + return self._repr_other(obj, level) + + # Determines whether an iterable exceeds the limits set in + # maxlimits, and is therefore unsafe to repr(). + def _is_long_iter(self, obj, level=0): + try: + # Strings have their own limits (and do not nest). Because + # they don't have __iter__ in 2.x, this check goes before + # the next one. + if isinstance(obj, self.string_types): + return len(obj) > self.maxstring_inner + + # If it's not an iterable (and not a string), it's fine. + if not hasattr(obj, "__iter__"): + return False + + # If it's not an instance of these collection types then it + # is fine. Note: this is a fix for + # https://github.com/Microsoft/ptvsd/issues/406 + if not isinstance(obj, self.long_iter_types): + return False + + # Iterable is its own iterator - this is a one-off iterable + # like generator or enumerate(). We can't really count that, + # but repr() for these should not include any elements anyway, + # so we can treat it the same as non-iterables. + if obj is iter(obj): + return False + + # range reprs fine regardless of length. + if isinstance(obj, range): + return False + + # numpy and scipy collections (ndarray etc) have + # self-truncating repr, so they're always safe. + try: + module = type(obj).__module__.partition(".")[0] + if module in ("numpy", "scipy"): + return False + except Exception: + pass + + # Iterables that nest too deep are considered long. + if level >= len(self.maxcollection): + return True + + # It is too long if the length exceeds the limit, or any + # of its elements are long iterables. + if hasattr(obj, "__len__"): + try: + size = len(obj) + except Exception: + size = None + if size is not None and size > self.maxcollection[level]: + return True + return any(self._is_long_iter(item, level + 1) for item in obj) + return any( + i > self.maxcollection[level] or self._is_long_iter(item, level + 1) + for i, item in enumerate(obj) + ) + + except Exception: + # If anything breaks, assume the worst case. + return True + + def _repr_iter(self, obj, level, prefix, suffix, comma_after_single_element=False): # noqa: FBT002 + yield prefix + + if level >= len(self.maxcollection): + yield "..." + else: + count = self.maxcollection[level] + yield_comma = False + for item in obj: + if yield_comma: + yield ", " + yield_comma = True + + count -= 1 + if count <= 0: + yield "..." + break + + yield from self._repr(item, 100 if item is obj else level + 1) + else: + if comma_after_single_element: # noqa: SIM102 + if count == self.maxcollection[level] - 1: + yield "," + yield suffix + + def _repr_long_iter(self, obj): + try: + length = hex(len(obj)) if self.convert_to_hex else len(obj) + obj_repr = f"<{type(obj).__name__}, len() = {length}>" + except Exception: + try: + obj_repr = "<" + type(obj).__name__ + ">" + except Exception: + obj_repr = "" + yield obj_repr + + def _repr_dict(self, obj, level, prefix, suffix, item_prefix, item_sep, item_suffix): + if not obj: + yield prefix + suffix + return + if level >= len(self.maxcollection): + yield prefix + "..." + suffix + return + + yield prefix + + count = self.maxcollection[level] + yield_comma = False + + obj_keys = list(obj) + + for key in obj_keys: + if yield_comma: + yield ", " + yield_comma = True + + count -= 1 + if count <= 0: + yield "..." + break + + yield item_prefix + for p in self._repr(key, level + 1): + yield p + + yield item_sep + + try: + item = obj[key] + except Exception: + yield "" + else: + for p in self._repr(item, 100 if item is obj else level + 1): + yield p + yield item_suffix + + yield suffix + + def _repr_str(self, obj, level): + try: + if self.raw_value: + # For raw value retrieval, ignore all limits. + if isinstance(obj, bytes): + yield obj.decode("latin-1") + else: + yield obj + return + + limit_inner = self.maxother_inner + limit_outer = self.maxother_outer + limit = limit_inner if level > 0 else limit_outer + if len(obj) <= limit: + # Note that we check the limit before doing the repr (so, the final string + # may actually be considerably bigger on some cases, as besides + # the additional u, b, ' chars, some chars may be escaped in repr, so + # even a single char such as \U0010ffff may end up adding more + # chars than expected). + yield self._convert_to_unicode_or_bytes_repr(repr(obj)) + return + + # Slightly imprecise calculations - we may end up with a string that is + # up to 6 characters longer than limit. If you need precise formatting, + # you are using the wrong class. + left_count, right_count = max(1, int(2 * limit / 3)), max(1, int(limit / 3)) + + # Important: only do repr after slicing to avoid duplicating a byte array that could be + # huge. + + # Note: we don't deal with high surrogates here because we're not dealing with the + # repr() of a random object. + # i.e.: A high surrogate unicode char may be splitted on Py2, but as we do a `repr` + # afterwards, that's ok. + + # Also, we just show the unicode/string/bytes repr() directly to make clear what the + # input type was (so, on py2 a unicode would start with u' and on py3 a bytes would + # start with b'). + + part1 = obj[:left_count] + part1 = repr(part1) + part1 = part1[: part1.rindex("'")] # Remove the last ' + + part2 = obj[-right_count:] + part2 = repr(part2) + part2 = part2[part2.index("'") + 1 :] # Remove the first ' (and possibly u or b). + + yield part1 + yield "..." + yield part2 + except: # noqa: E722 + # This shouldn't really happen, but let's play it safe. + # exception('Error getting string representation to show.') + yield from self._repr_obj(obj, level, self.maxother_inner, self.maxother_outer) + + def _repr_other(self, obj, level): + return self._repr_obj(obj, level, self.maxother_inner, self.maxother_outer) + + def _repr_obj(self, obj, level, limit_inner, limit_outer): + try: + if self.raw_value: + # For raw value retrieval, ignore all limits. + if isinstance(obj, bytes): + yield obj.decode("latin-1") + return + + try: + mv = memoryview(obj) + except Exception: + yield self._convert_to_unicode_or_bytes_repr(repr(obj)) + return + else: + # Map bytes to Unicode codepoints with same values. + yield mv.tobytes().decode("latin-1") + return + elif self.convert_to_hex and isinstance(obj, self.int_types): + obj_repr = hex(obj) + else: + obj_repr = repr(obj) + except Exception: + try: + obj_repr = object.__repr__(obj) + except Exception: + try: + obj_repr = "" + except Exception: + obj_repr = "" + + limit = limit_inner if level > 0 else limit_outer + + if limit >= len(obj_repr): + yield self._convert_to_unicode_or_bytes_repr(obj_repr) + return + + # Slightly imprecise calculations - we may end up with a string that is + # up to 3 characters longer than limit. If you need precise formatting, + # you are using the wrong class. + left_count, right_count = max(1, int(2 * limit / 3)), max(1, int(limit / 3)) + + yield obj_repr[:left_count] + yield "..." + yield obj_repr[-right_count:] + + def _convert_to_unicode_or_bytes_repr(self, obj_repr): + return obj_repr + + def _bytes_as_unicode_if_possible(self, obj_repr): + # We try to decode with 3 possible encoding (sys.stdout.encoding, + # locale.getpreferredencoding() and 'utf-8). If no encoding can decode + # the input, we return the original bytes. + try_encodings = [] + encoding = self.sys_stdout_encoding or getattr(sys.stdout, "encoding", None) + if encoding: + try_encodings.append(encoding.lower()) + + preferred_encoding = self.locale_preferred_encoding or locale.getpreferredencoding() + if preferred_encoding: + preferred_encoding = preferred_encoding.lower() + if preferred_encoding not in try_encodings: + try_encodings.append(preferred_encoding) + + if "utf-8" not in try_encodings: + try_encodings.append("utf-8") + + for encoding in try_encodings: + try: + return obj_repr.decode(encoding) + except UnicodeDecodeError: # noqa: PERF203 + pass + + return obj_repr # Return the original version (in bytes) + + +class DisplayOptions: + def __init__(self, width, max_columns): + self.width = width + self.max_columns = max_columns + + +_safe_repr = SafeRepr() +_collection_types = ["list", "tuple", "set"] +_array_page_size = 50 + + +def _get_value(variable): + return _safe_repr(variable) + + +def _get_property_names(variable): + props = [] + private_props = [] + for prop in dir(variable): + if not prop.startswith("_"): + props.append(prop) + elif not prop.startswith("__"): + private_props.append(prop) + return props + private_props + + +def _get_full_type(var_type): + module = "" + if hasattr(var_type, "__module__") and var_type.__module__ != "builtins": + module = var_type.__module__ + "." + if hasattr(var_type, "__qualname__"): + return module + var_type.__qualname__ + elif hasattr(var_type, "__name__"): + return module + var_type.__name__ + return None + + +def _get_variable_description(variable): + result = {} + + var_type = type(variable) + result["type"] = _get_full_type(var_type) + if hasattr(var_type, "__mro__"): + result["interfaces"] = [_get_full_type(t) for t in var_type.__mro__] + + if hasattr(variable, "__len__") and result["type"] in _collection_types: + result["count"] = len(variable) + + result["hasNamedChildren"] = hasattr(variable, "__dict__") or isinstance(variable, dict) + + result["value"] = _get_value(variable) + return result + + +def _get_child_property(root, property_chain): + try: + variable = root + for prop in property_chain: + if isinstance(prop, int): + if hasattr(variable, "__getitem__"): + variable = variable[prop] + elif isinstance(variable, set): + variable = list(variable)[prop] + else: + return None + elif hasattr(variable, prop): + variable = getattr(variable, prop) + elif isinstance(variable, dict) and prop in variable: + variable = variable[prop] + else: + return None + except Exception: + return None + + return variable + + +types_to_exclude = ["module", "function", "method", "class", "type"] + + +### Get info on variables at the root level +def getVariableDescriptions(): # noqa: N802 + return [ + { + "name": varName, + **_get_variable_description(globals()[varName]), + "root": varName, + "propertyChain": [], + "language": "python", + } + for varName in globals() + if type(globals()[varName]).__name__ not in types_to_exclude + and not varName.startswith("__") + ] + + +### Get info on children of a variable reached through the given property chain +def getAllChildrenDescriptions(root_var_name, property_chain, start_index): # noqa: N802 + root = globals()[root_var_name] + if root is None: + return [] + + parent = root + if len(property_chain) > 0: + parent = _get_child_property(root, property_chain) + + children = [] + parent_info = _get_variable_description(parent) + if "count" in parent_info: + if parent_info["count"] > 0: + last_item = min(parent_info["count"], start_index + _array_page_size) + index_range = range(start_index, last_item) + children = [ + { + **_get_variable_description(_get_child_property(parent, [i])), + "name": str(i), + "root": root_var_name, + "propertyChain": [*property_chain, i], + "language": "python", + } + for i in index_range + ] + elif parent_info["hasNamedChildren"]: + children_names = [] + if hasattr(parent, "__dict__"): + children_names = _get_property_names(parent) + elif isinstance(parent, dict): + children_names = list(parent.keys()) + + children = [] + for prop in children_names: + child_property = _get_child_property(parent, [prop]) + if child_property is not None and type(child_property).__name__ not in types_to_exclude: + child = { + **_get_variable_description(child_property), + "name": prop, + "root": root_var_name, + "propertyChain": [*property_chain, prop], + } + children.append(child) + + return children diff --git a/python_files/tests/test_get_variable_info.py b/python_files/tests/test_get_variable_info.py new file mode 100644 index 000000000000..73f94fe26f06 --- /dev/null +++ b/python_files/tests/test_get_variable_info.py @@ -0,0 +1,114 @@ +import get_variable_info + + +def set_global_variable(value): + # setting on the module allows tests to set a variable that the module under test can access + get_variable_info.test_variable = value # pyright: ignore[reportGeneralTypeIssues] + + +def get_global_variable(): + results = get_variable_info.getVariableDescriptions() + for variable in results: + if variable["name"] == "test_variable": + return variable + return None + + +def assert_variable_found(variable, expected_value, expected_type, expected_count=None): + set_global_variable(variable) + variable = get_global_variable() + assert variable is not None + if expected_value is not None: + assert variable["value"] == expected_value + assert variable["type"] == expected_type + if expected_count is not None: + assert variable["count"] == expected_count + else: + assert "count" not in variable + return variable + + +def assert_indexed_child(variable, start_index, expected_index, expected_child_value=None): + children = get_variable_info.getAllChildrenDescriptions( + variable["root"], variable["propertyChain"], start_index + ) + child = children[expected_index] + + if expected_child_value is not None: + assert child["value"] == expected_child_value + return child + + +def assert_property(variable, expected_property_name, expected_property_value=None): + children = get_variable_info.getAllChildrenDescriptions( + variable["root"], variable["propertyChain"], 0 + ) + found = None + for child in children: + chain = child["propertyChain"] + property_name = chain[-1] if chain else None + if property_name == expected_property_name: + found = child + break + + assert found is not None + if expected_property_value is not None: + assert found["value"] == expected_property_value + return found + + +def test_simple(): + assert_variable_found(1, "1", "int", None) + + +def test_list(): + found = assert_variable_found([1, 2, 3], "[1, 2, 3]", "list", 3) + assert_indexed_child(found, 0, 0, "1") + + +def test_dict(): + found = assert_variable_found({"a": 1, "b": 2}, "{'a': 1, 'b': 2}", "dict", None) + assert found["hasNamedChildren"] + assert_property(found, "a", "1") + assert_property(found, "b", "2") + + +def test_tuple(): + found = assert_variable_found((1, 2, 3), "(1, 2, 3)", "tuple", 3) + assert_indexed_child(found, 0, 0, "1") + + +def test_set(): + found = assert_variable_found({1, 2, 3}, "{1, 2, 3}", "set", 3) + assert_indexed_child(found, 0, 0, "1") + + +def test_self_referencing_dict(): + d = {} + d["self"] = d + found = assert_variable_found(d, "{'self': {...}}", "dict", None) + assert_property(found, "self", "{'self': {...}}") + + +def test_nested_list(): + found = assert_variable_found([[1, 2], [3, 4]], "[[1, 2], [3, 4]]", "list", 2) + assert_indexed_child(found, 0, 0, "[1, 2]") + + +def test_long_list(): + child = assert_variable_found(list(range(1_000_000)), None, "list", 1_000_000) + value = child["value"] + assert value.startswith("[0, 1, 2, 3") + assert value.endswith("...]") + assert_indexed_child(child, 400_000, 10, "400010") + assert_indexed_child(child, 999_950, 10, "999960") + + +def test_get_nested_children(): + d = [{"a": {("hello")}}] + found = assert_variable_found(d, "[{'a': {...}}]", "list", 1) + + found = assert_indexed_child(found, 0, 0) + found = assert_property(found, "a") + found = assert_indexed_child(found, 0, 0) + assert found["value"] == "'hello'" diff --git a/src/client/repl/nativeRepl.ts b/src/client/repl/nativeRepl.ts index 8b233f765468..8e0337f8d276 100644 --- a/src/client/repl/nativeRepl.ts +++ b/src/client/repl/nativeRepl.ts @@ -19,6 +19,8 @@ import { executeNotebookCell, openInteractiveREPL, selectNotebookKernel } from ' import { createReplController } from './replController'; import { EventName } from '../telemetry/constants'; import { sendTelemetryEvent } from '../telemetry'; +import { VariablesProvider } from './variables/variablesProvider'; +import { VariableRequester } from './variables/variableRequester'; let nativeRepl: NativeRepl | undefined; // In multi REPL scenario, hashmap of URI to Repl. export class NativeRepl implements Disposable { @@ -48,7 +50,7 @@ export class NativeRepl implements Disposable { nativeRepl.interpreter = interpreter; await nativeRepl.setReplDirectory(); nativeRepl.pythonServer = createPythonServer([interpreter.path as string], nativeRepl.cwd); - nativeRepl.replController = nativeRepl.setReplController(); + nativeRepl.setReplController(); return nativeRepl; } @@ -111,7 +113,12 @@ export class NativeRepl implements Disposable { */ public setReplController(): NotebookController { if (!this.replController) { - return createReplController(this.interpreter!.path, this.disposables, this.cwd); + this.replController = createReplController(this.interpreter!.path, this.disposables, this.cwd); + this.replController.variableProvider = new VariablesProvider( + new VariableRequester(this.pythonServer), + () => this.notebookDocument, + this.pythonServer.onCodeExecuted, + ); } return this.replController; } diff --git a/src/client/repl/pythonServer.ts b/src/client/repl/pythonServer.ts index a342e989af7c..0f500f0431bc 100644 --- a/src/client/repl/pythonServer.ts +++ b/src/client/repl/pythonServer.ts @@ -1,7 +1,7 @@ import * as path from 'path'; import * as ch from 'child_process'; import * as rpc from 'vscode-jsonrpc/node'; -import { Disposable, window } from 'vscode'; +import { Disposable, Event, EventEmitter, window } from 'vscode'; import { EXTENSION_ROOT_DIR } from '../constants'; import { traceError, traceLog } from '../logging'; import { captureTelemetry } from '../telemetry'; @@ -15,15 +15,21 @@ export interface ExecutionResult { } export interface PythonServer extends Disposable { + onCodeExecuted: Event; execute(code: string): Promise; + executeSilently(code: string): Promise; interrupt(): void; input(): void; checkValidCommand(code: string): Promise; } -class PythonServerImpl implements Disposable { +class PythonServerImpl implements PythonServer, Disposable { private readonly disposables: Disposable[] = []; + private readonly _onCodeExecuted = new EventEmitter(); + + onCodeExecuted = this._onCodeExecuted.event; + constructor(private connection: rpc.MessageConnection, private pythonServer: ch.ChildProcess) { this.initialize(); this.input(); @@ -57,6 +63,18 @@ class PythonServerImpl implements Disposable { @captureTelemetry(EventName.EXECUTION_CODE, { scope: 'selection' }, false) public async execute(code: string): Promise { + const result = await this.executeCode(code); + if (result?.status) { + this._onCodeExecuted.fire(); + } + return result; + } + + public executeSilently(code: string): Promise { + return this.executeCode(code); + } + + private async executeCode(code: string): Promise { try { const result = await this.connection.sendRequest('execute', code); return result as ExecutionResult; diff --git a/src/client/repl/variables/types.ts b/src/client/repl/variables/types.ts new file mode 100644 index 000000000000..1e3c80d32077 --- /dev/null +++ b/src/client/repl/variables/types.ts @@ -0,0 +1,17 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +import { CancellationToken, Variable } from 'vscode'; + +export interface IVariableDescription extends Variable { + /** The name of the variable at the root scope */ + root: string; + /** How to look up the specific property of the root variable */ + propertyChain: (string | number)[]; + /** The number of children for collection types */ + count?: number; + /** Names of children */ + hasNamedChildren?: boolean; + /** A method to get the children of this variable */ + getChildren?: (start: number, token: CancellationToken) => Promise; +} diff --git a/src/client/repl/variables/variableRequester.ts b/src/client/repl/variables/variableRequester.ts new file mode 100644 index 000000000000..e66afdcd6616 --- /dev/null +++ b/src/client/repl/variables/variableRequester.ts @@ -0,0 +1,59 @@ +import { CancellationToken } from 'vscode'; +import path from 'path'; +import * as fsapi from '../../common/platform/fs-paths'; +import { IVariableDescription } from './types'; +import { PythonServer } from '../pythonServer'; +import { EXTENSION_ROOT_DIR } from '../../constants'; + +const VARIABLE_SCRIPT_LOCATION = path.join(EXTENSION_ROOT_DIR, 'python_files', 'get_variable_info.py'); + +export class VariableRequester { + public static scriptContents: string | undefined; + + constructor(private pythonServer: PythonServer) {} + + async getAllVariableDescriptions( + parent: IVariableDescription | undefined, + start: number, + token: CancellationToken, + ): Promise { + const scriptLines = (await getContentsOfVariablesScript()).split(/(?:\r\n|\n)/); + if (parent) { + const printCall = `import json;return json.dumps(getAllChildrenDescriptions(\'${ + parent.root + }\', ${JSON.stringify(parent.propertyChain)}, ${start}))`; + scriptLines.push(printCall); + } else { + scriptLines.push('import json;return json.dumps(getVariableDescriptions())'); + } + + if (token.isCancellationRequested) { + return []; + } + + const script = wrapScriptInFunction(scriptLines); + const result = await this.pythonServer.executeSilently(script); + + if (result?.output && !token.isCancellationRequested) { + return JSON.parse(result.output) as IVariableDescription[]; + } + + return []; + } +} + +function wrapScriptInFunction(scriptLines: string[]): string { + const indented = scriptLines.map((line) => ` ${line}`).join('\n'); + // put everything into a function scope and then delete that scope + // TODO: run in a background thread + return `def __VSCODE_run_script():\n${indented}\nprint(__VSCODE_run_script())\ndel __VSCODE_run_script`; +} + +async function getContentsOfVariablesScript(): Promise { + if (VariableRequester.scriptContents) { + return VariableRequester.scriptContents; + } + const contents = await fsapi.readFile(VARIABLE_SCRIPT_LOCATION, 'utf-8'); + VariableRequester.scriptContents = contents; + return VariableRequester.scriptContents; +} diff --git a/src/client/repl/variables/variableResultCache.ts b/src/client/repl/variables/variableResultCache.ts new file mode 100644 index 000000000000..1e19415becb7 --- /dev/null +++ b/src/client/repl/variables/variableResultCache.ts @@ -0,0 +1,28 @@ +import { VariablesResult } from 'vscode'; + +export class VariableResultCache { + private cache = new Map(); + + private executionCount = 0; + + getResults(executionCount: number, cacheKey: string): VariablesResult[] | undefined { + if (this.executionCount !== executionCount) { + this.cache.clear(); + this.executionCount = executionCount; + } + + return this.cache.get(cacheKey); + } + + setResults(executionCount: number, cacheKey: string, results: VariablesResult[]): void { + if (this.executionCount < executionCount) { + this.cache.clear(); + this.executionCount = executionCount; + } else if (this.executionCount > executionCount) { + // old results, don't cache + return; + } + + this.cache.set(cacheKey, results); + } +} diff --git a/src/client/repl/variables/variablesProvider.ts b/src/client/repl/variables/variablesProvider.ts new file mode 100644 index 000000000000..ffb7c221d00c --- /dev/null +++ b/src/client/repl/variables/variablesProvider.ts @@ -0,0 +1,146 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +import { + CancellationToken, + NotebookDocument, + Variable, + NotebookVariablesRequestKind, + VariablesResult, + EventEmitter, + Event, + NotebookVariableProvider, +} from 'vscode'; +import { VariableResultCache } from './variableResultCache'; +import { IVariableDescription } from './types'; +import { VariableRequester } from './variableRequester'; + +export class VariablesProvider implements NotebookVariableProvider { + private readonly variableResultCache = new VariableResultCache(); + + private _onDidChangeVariables = new EventEmitter(); + + onDidChangeVariables = this._onDidChangeVariables.event; + + private executionCount = 0; + + constructor( + private readonly variableRequester: VariableRequester, + private readonly getNotebookDocument: () => NotebookDocument | undefined, + codeExecutedEvent: Event, + ) { + codeExecutedEvent(() => this.onDidExecuteCode()); + } + + onDidExecuteCode(): void { + const notebook = this.getNotebookDocument(); + if (notebook) { + this.executionCount += 1; + this._onDidChangeVariables.fire(notebook); + } + } + + async *provideVariables( + notebook: NotebookDocument, + parent: Variable | undefined, + kind: NotebookVariablesRequestKind, + start: number, + token: CancellationToken, + ): AsyncIterable { + const notebookDocument = this.getNotebookDocument(); + if (token.isCancellationRequested || !notebookDocument || notebookDocument !== notebook) { + return; + } + + const { executionCount } = this; + const cacheKey = getVariableResultCacheKey(notebook.uri.toString(), parent, start); + let results = this.variableResultCache.getResults(executionCount, cacheKey); + + if (parent) { + const parentDescription = parent as IVariableDescription; + if (!results && parentDescription.getChildren) { + const variables = await parentDescription.getChildren(start, token); + if (token.isCancellationRequested) { + return; + } + results = variables.map((variable) => this.createVariableResult(variable)); + this.variableResultCache.setResults(executionCount, cacheKey, results); + } else if (!results) { + // no cached results and no way to get children, so return empty + return; + } + + for (const result of results) { + yield result; + } + + // check if we have more indexed children to return + if ( + kind === 2 && + parentDescription.count && + results.length > 0 && + parentDescription.count > start + results.length + ) { + for await (const result of this.provideVariables( + notebook, + parent, + kind, + start + results.length, + token, + )) { + yield result; + } + } + } else { + if (!results) { + const variables = await this.variableRequester.getAllVariableDescriptions(undefined, start, token); + if (token.isCancellationRequested) { + return; + } + results = variables.map((variable) => this.createVariableResult(variable)); + this.variableResultCache.setResults(executionCount, cacheKey, results); + } + + for (const result of results) { + yield result; + } + } + } + + private createVariableResult(result: IVariableDescription): VariablesResult { + const indexedChildrenCount = result.count ?? 0; + const hasNamedChildren = !!result.hasNamedChildren; + const variable = { + getChildren: (start: number, token: CancellationToken) => this.getChildren(variable, start, token), + expression: createExpression(result.root, result.propertyChain), + ...result, + } as Variable; + return { variable, hasNamedChildren, indexedChildrenCount }; + } + + async getChildren(variable: Variable, start: number, token: CancellationToken): Promise { + const parent = variable as IVariableDescription; + return this.variableRequester.getAllVariableDescriptions(parent, start, token); + } +} + +function createExpression(root: string, propertyChain: (string | number)[]): string { + let expression = root; + for (const property of propertyChain) { + if (typeof property === 'string') { + expression += `.${property}`; + } else { + expression += `[${property}]`; + } + } + return expression; +} + +function getVariableResultCacheKey(uri: string, parent: Variable | undefined, start: number) { + let parentKey = ''; + const parentDescription = parent as IVariableDescription; + if (parentDescription) { + parentKey = `${parentDescription.name}.${parentDescription.propertyChain.join('.')}[[${start}`; + } + return `${uri}:${parentKey}`; +} diff --git a/src/test/repl/variableProvider.test.ts b/src/test/repl/variableProvider.test.ts new file mode 100644 index 000000000000..8b45fae0c5a0 --- /dev/null +++ b/src/test/repl/variableProvider.test.ts @@ -0,0 +1,240 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +import { assert } from 'chai'; +import { NotebookDocument, CancellationTokenSource, VariablesResult, Variable, EventEmitter } from 'vscode'; +import * as TypeMoq from 'typemoq'; +import { IVariableDescription } from '../../client/repl/variables/types'; +import { VariablesProvider } from '../../client/repl/variables/variablesProvider'; +import { VariableRequester } from '../../client/repl/variables/variableRequester'; + +suite.only('ReplVariablesProvider', () => { + let provider: VariablesProvider; + let varRequester: TypeMoq.IMock; + let notebook: TypeMoq.IMock; + const executionEventEmitter = new EventEmitter(); + const cancellationToken = new CancellationTokenSource().token; + + const objectVariable: IVariableDescription = { + name: 'myObject', + value: '...', + root: 'myObject', + hasNamedChildren: true, + propertyChain: [], + }; + + const listVariable: IVariableDescription = { + name: 'myList', + value: '[...]', + count: 3, + root: 'myObject', + propertyChain: ['myList'], + }; + + function createListItem(index: number): IVariableDescription { + return { + name: index.toString(), + value: `value${index}`, + count: index, + root: 'myObject', + propertyChain: ['myList', index], + }; + } + + function setVariablesForParent( + parent: IVariableDescription | undefined, + result: IVariableDescription[], + updated?: IVariableDescription[], + startIndex?: number, + ) { + let returnedOnce = false; + varRequester + .setup((v) => v.getAllVariableDescriptions(parent, startIndex ?? TypeMoq.It.isAny(), TypeMoq.It.isAny())) + .returns(() => { + if (updated && returnedOnce) { + return Promise.resolve(updated); + } + returnedOnce = true; + return Promise.resolve(result); + }); + } + + async function provideVariables(parent: Variable | undefined, kind = 1) { + const results: VariablesResult[] = []; + for await (const result of provider.provideVariables(notebook.object, parent, kind, 0, cancellationToken)) { + results.push(result); + } + return results; + } + + setup(() => { + varRequester = TypeMoq.Mock.ofType(); + notebook = TypeMoq.Mock.ofType(); + provider = new VariablesProvider(varRequester.object, () => notebook.object, executionEventEmitter.event); + }); + + test('provideVariables without parent should yield variables', async () => { + setVariablesForParent(undefined, [objectVariable]); + + const results = await provideVariables(undefined); + + assert.isNotEmpty(results); + assert.equal(results.length, 1); + assert.equal(results[0].variable.name, 'myObject'); + assert.equal(results[0].variable.expression, 'myObject'); + }); + + test('provideVariables with a parent should call get children correctly', async () => { + const listVariableItems = [0, 1, 2].map(createListItem); + setVariablesForParent(undefined, [objectVariable]); + + // pass each the result as the parent in the next call + const rootVariable = (await provideVariables(undefined))[0]; + setVariablesForParent(rootVariable.variable as IVariableDescription, [listVariable]); + const listResult = (await provideVariables(rootVariable!.variable))[0]; + setVariablesForParent(listResult.variable as IVariableDescription, listVariableItems); + const listItems = await provideVariables(listResult!.variable, 2); + + assert.equal(listResult.variable.name, 'myList'); + assert.equal(listResult.variable.expression, 'myObject.myList'); + assert.isNotEmpty(listItems); + assert.equal(listItems.length, 3); + listItems.forEach((item, index) => { + assert.equal(item.variable.name, index.toString()); + assert.equal(item.variable.value, `value${index}`); + assert.equal(item.variable.expression, `myObject.myList[${index}]`); + }); + }); + + test('All indexed variables should be returned when requested', async () => { + const listVariable: IVariableDescription = { + name: 'myList', + value: '[...]', + count: 6, + root: 'myList', + propertyChain: [], + }; + + setVariablesForParent(undefined, [listVariable]); + const rootVariable = (await provideVariables(undefined))[0]; + const firstPage = [0, 1, 2].map(createListItem); + const secondPage = [3, 4, 5].map(createListItem); + setVariablesForParent(rootVariable.variable as IVariableDescription, firstPage, undefined, 0); + setVariablesForParent(rootVariable.variable as IVariableDescription, secondPage, undefined, firstPage.length); + + const listItemResult = await provideVariables(rootVariable!.variable, 2); + + assert.equal(listItemResult.length, 6, 'full list of items should be returned'); + listItemResult.forEach((item, index) => { + assert.equal(item.variable.name, index.toString()); + assert.equal(item.variable.value, `value${index}`); + }); + }); + + test('Getting less indexed items than the specified count is handled', async () => { + const listVariable: IVariableDescription = { + name: 'myList', + value: '[...]', + count: 6, + root: 'myList', + propertyChain: [], + }; + + const firstPage = [0, 1, 2].map(createListItem); + const secondPage = [3, 4].map(createListItem); + setVariablesForParent(undefined, [listVariable]); + const rootVariable = (await provideVariables(undefined))[0]; + setVariablesForParent(rootVariable.variable as IVariableDescription, firstPage, undefined, 0); + setVariablesForParent(rootVariable.variable as IVariableDescription, secondPage, undefined, firstPage.length); + setVariablesForParent(rootVariable.variable as IVariableDescription, [], undefined, 5); + + const listItemResult = await provideVariables(rootVariable!.variable, 2); + + assert.equal(listItemResult.length, 5); + listItemResult.forEach((item, index) => { + assert.equal(item.variable.name, index.toString()); + assert.equal(item.variable.value, `value${index}`); + }); + }); + + test('Getting variables again with new execution count should get updated variables', async () => { + const intVariable: IVariableDescription = { + name: 'myInt', + value: '1', + root: '', + propertyChain: [], + }; + setVariablesForParent(undefined, [intVariable], [{ ...intVariable, value: '2' }]); + + const first = await provideVariables(undefined); + executionEventEmitter.fire(); + const second = await provideVariables(undefined); + + assert.equal(first.length, 1); + assert.equal(second.length, 1); + assert.equal(first[0].variable.value, '1'); + assert.equal(second[0].variable.value, '2'); + }); + + test('Getting variables again with same execution count should not make another call', async () => { + const intVariable: IVariableDescription = { + name: 'myInt', + value: '1', + root: '', + propertyChain: [], + }; + + setVariablesForParent(undefined, [intVariable]); + + const first = await provideVariables(undefined); + const second = await provideVariables(undefined); + + assert.equal(first.length, 1); + assert.equal(second.length, 1); + assert.equal(first[0].variable.value, '1'); + + varRequester.verify( + (x) => x.getAllVariableDescriptions(TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny()), + TypeMoq.Times.once(), + ); + }); + + test('Cache pages of indexed children correctly', async () => { + const listVariable: IVariableDescription = { + name: 'myList', + value: '[...]', + count: 6, + root: 'myList', + propertyChain: [], + }; + + const firstPage = [0, 1, 2].map(createListItem); + const secondPage = [3, 4, 5].map(createListItem); + setVariablesForParent(undefined, [listVariable]); + const rootVariable = (await provideVariables(undefined))[0]; + setVariablesForParent(rootVariable.variable as IVariableDescription, firstPage, undefined, 0); + setVariablesForParent(rootVariable.variable as IVariableDescription, secondPage, undefined, firstPage.length); + + await provideVariables(rootVariable!.variable, 2); + + // once for the parent and once for each of the two pages of list items + varRequester.verify( + (x) => x.getAllVariableDescriptions(TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny()), + TypeMoq.Times.exactly(3), + ); + + const listItemResult = await provideVariables(rootVariable!.variable, 2); + + assert.equal(listItemResult.length, 6, 'full list of items should be returned'); + listItemResult.forEach((item, index) => { + assert.equal(item.variable.name, index.toString()); + assert.equal(item.variable.value, `value${index}`); + }); + + // no extra calls for getting the children again + varRequester.verify( + (x) => x.getAllVariableDescriptions(TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny()), + TypeMoq.Times.exactly(3), + ); + }); +}); diff --git a/types/vscode.proposed.notebookVariableProvider.d.ts b/types/vscode.proposed.notebookVariableProvider.d.ts new file mode 100644 index 000000000000..4fac96c45f0a --- /dev/null +++ b/types/vscode.proposed.notebookVariableProvider.d.ts @@ -0,0 +1,55 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for license information. + *--------------------------------------------------------------------------------------------*/ +declare module 'vscode' { + + export interface NotebookController { + /** Set this to attach a variable provider to this controller. */ + variableProvider?: NotebookVariableProvider; + } + + export enum NotebookVariablesRequestKind { + Named = 1, + Indexed = 2 + } + + interface VariablesResult { + variable: Variable; + hasNamedChildren: boolean; + indexedChildrenCount: number; + } + + interface NotebookVariableProvider { + onDidChangeVariables: Event; + + /** When parent is undefined, this is requesting global Variables. When a variable is passed, it's requesting child props of that Variable. */ + provideVariables(notebook: NotebookDocument, parent: Variable | undefined, kind: NotebookVariablesRequestKind, start: number, token: CancellationToken): AsyncIterable; + } + + interface Variable { + /** The variable's name. */ + name: string; + + /** The variable's value. + This can be a multi-line text, e.g. for a function the body of a function. + For structured variables (which do not have a simple value), it is recommended to provide a one-line representation of the structured object. + This helps to identify the structured object in the collapsed state when its children are not yet visible. + An empty string can be used if no value should be shown in the UI. + */ + value: string; + + /** The code that represents how the variable would be accessed in the runtime environment */ + expression?: string; + + /** The type of the variable's value */ + type?: string; + + /** The interfaces or contracts that the type satisfies */ + interfaces?: string[]; + + /** The language of the variable's value */ + language?: string; + } + +} From 8268131ebf05261340ad750ba321e9a7d9c6a93b Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Wed, 18 Sep 2024 08:33:28 -0700 Subject: [PATCH 089/149] Implementation of Test Coverage (#24118) fixes https://github.com/microsoft/vscode-python/issues/22671 --- .gitignore | 5 + build/functional-test-requirements.txt | 2 + build/test-requirements.txt | 4 + .../.data/coverage_gen/__init__.py | 2 + .../.data/coverage_gen/reverse.py | 19 ++ .../.data/coverage_gen/test_reverse.py | 28 +++ python_files/tests/pytestadapter/helpers.py | 44 +++++ .../tests/pytestadapter/test_coverage.py | 50 ++++++ .../.data/coverage_ex/__init__.py | 2 + .../.data/coverage_ex/reverse.py | 14 ++ .../.data/coverage_ex/test_reverse.py | 32 ++++ .../tests/unittestadapter/test_coverage.py | 57 ++++++ python_files/unittestadapter/execution.py | 62 ++++++- python_files/unittestadapter/pvsc_utils.py | 18 +- python_files/vscode_pytest/__init__.py | 82 ++++++++- .../vscode_pytest/run_pytest_script.py | 14 ++ .../testController/common/resultResolver.ts | 79 +++++++- .../testing/testController/common/types.ts | 33 +++- .../testing/testController/controller.ts | 48 +++-- .../pytest/pytestExecutionAdapter.ts | 22 ++- .../unittest/testExecutionAdapter.ts | 15 +- .../testController/workspaceTestAdapter.ts | 10 +- src/test/mocks/vsc/index.ts | 18 ++ .../testing/common/testingAdapter.test.ts | 169 +++++++++++++++--- .../pytestExecutionAdapter.unit.test.ts | 60 ++++++- .../testCancellationRunAdapters.unit.test.ts | 6 +- .../testExecutionAdapter.unit.test.ts | 59 +++++- src/test/vscode-mock.ts | 3 +- .../coverageWorkspace/even.py | 8 + .../coverageWorkspace/test_even.py | 11 ++ 30 files changed, 895 insertions(+), 81 deletions(-) create mode 100644 python_files/tests/pytestadapter/.data/coverage_gen/__init__.py create mode 100644 python_files/tests/pytestadapter/.data/coverage_gen/reverse.py create mode 100644 python_files/tests/pytestadapter/.data/coverage_gen/test_reverse.py create mode 100644 python_files/tests/pytestadapter/test_coverage.py create mode 100644 python_files/tests/unittestadapter/.data/coverage_ex/__init__.py create mode 100644 python_files/tests/unittestadapter/.data/coverage_ex/reverse.py create mode 100644 python_files/tests/unittestadapter/.data/coverage_ex/test_reverse.py create mode 100644 python_files/tests/unittestadapter/test_coverage.py create mode 100644 src/testTestingRootWkspc/coverageWorkspace/even.py create mode 100644 src/testTestingRootWkspc/coverageWorkspace/test_even.py diff --git a/.gitignore b/.gitignore index f703e34173fd..1b47f15705bb 100644 --- a/.gitignore +++ b/.gitignore @@ -49,3 +49,8 @@ dist/** package.nls.*.json l10n/ python-env-tools/** +# coverage files produced as test output +python_files/tests/*/.data/.coverage* +python_files/tests/*/.data/*/.coverage* +src/testTestingRootWkspc/coverageWorkspace/.coverage + diff --git a/build/functional-test-requirements.txt b/build/functional-test-requirements.txt index d45208f671f4..5c3a9e3116ed 100644 --- a/build/functional-test-requirements.txt +++ b/build/functional-test-requirements.txt @@ -1,3 +1,5 @@ # List of requirements for functional tests versioneer numpy +pytest +pytest-cov diff --git a/build/test-requirements.txt b/build/test-requirements.txt index 4229104ddcc9..c5c18a048f56 100644 --- a/build/test-requirements.txt +++ b/build/test-requirements.txt @@ -27,3 +27,7 @@ namedpipe; platform_system == "Windows" # typing for Django files django-stubs + +# for coverage +coverage +pytest-cov diff --git a/python_files/tests/pytestadapter/.data/coverage_gen/__init__.py b/python_files/tests/pytestadapter/.data/coverage_gen/__init__.py new file mode 100644 index 000000000000..5b7f7a925cc0 --- /dev/null +++ b/python_files/tests/pytestadapter/.data/coverage_gen/__init__.py @@ -0,0 +1,2 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. diff --git a/python_files/tests/pytestadapter/.data/coverage_gen/reverse.py b/python_files/tests/pytestadapter/.data/coverage_gen/reverse.py new file mode 100644 index 000000000000..cb6755a3a369 --- /dev/null +++ b/python_files/tests/pytestadapter/.data/coverage_gen/reverse.py @@ -0,0 +1,19 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +def reverse_string(s): + if s is None or s == "": + return "Error: Input is None" + return s[::-1] + +def reverse_sentence(sentence): + if sentence is None or sentence == "": + return "Error: Input is None" + words = sentence.split() + reversed_words = [reverse_string(word) for word in words] + return " ".join(reversed_words) + +# Example usage +if __name__ == "__main__": + sample_string = "hello" + print(reverse_string(sample_string)) # Output: "olleh" diff --git a/python_files/tests/pytestadapter/.data/coverage_gen/test_reverse.py b/python_files/tests/pytestadapter/.data/coverage_gen/test_reverse.py new file mode 100644 index 000000000000..e7319f143608 --- /dev/null +++ b/python_files/tests/pytestadapter/.data/coverage_gen/test_reverse.py @@ -0,0 +1,28 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +from .reverse import reverse_sentence, reverse_string + + +def test_reverse_sentence(): + """ + Tests the reverse_sentence function to ensure it correctly reverses each word in a sentence. + + Test cases: + - "hello world" should be reversed to "olleh dlrow" + - "Python is fun" should be reversed to "nohtyP si nuf" + - "a b c" should remain "a b c" as each character is a single word + """ + assert reverse_sentence("hello world") == "olleh dlrow" + assert reverse_sentence("Python is fun") == "nohtyP si nuf" + assert reverse_sentence("a b c") == "a b c" + +def test_reverse_sentence_error(): + assert reverse_sentence("") == "Error: Input is None" + assert reverse_sentence(None) == "Error: Input is None" + + +def test_reverse_string(): + assert reverse_string("hello") == "olleh" + assert reverse_string("Python") == "nohtyP" + # this test specifically does not cover the error cases diff --git a/python_files/tests/pytestadapter/helpers.py b/python_files/tests/pytestadapter/helpers.py index 4f6631a44c00..991c7efbc60c 100644 --- a/python_files/tests/pytestadapter/helpers.py +++ b/python_files/tests/pytestadapter/helpers.py @@ -203,6 +203,26 @@ def runner_with_cwd(args: List[str], path: pathlib.Path) -> Optional[List[Dict[s return runner_with_cwd_env(args, path, {}) +def split_array_at_item(arr: List[str], item: str) -> Tuple[List[str], List[str]]: + """ + Splits an array into two subarrays at the specified item. + + Args: + arr (List[str]): The array to be split. + item (str): The item at which to split the array. + + Returns: + Tuple[List[str], List[str]]: A tuple containing two subarrays. The first subarray includes the item and all elements before it. The second subarray includes all elements after the item. If the item is not found, the first subarray is the original array and the second subarray is empty. + """ + if item in arr: + index = arr.index(item) + before = arr[: index + 1] + after = arr[index + 1 :] + return before, after + else: + return arr, [] + + def runner_with_cwd_env( args: List[str], path: pathlib.Path, env_add: Dict[str, str] ) -> Optional[List[Dict[str, Any]]]: @@ -217,10 +237,34 @@ def runner_with_cwd_env( # If we are running Django, generate a unittest-specific pipe name. process_args = [sys.executable, *args] pipe_name = generate_random_pipe_name("unittest-discovery-test") + elif "_TEST_VAR_UNITTEST" in env_add: + before_args, after_ids = split_array_at_item(args, "*test*.py") + process_args = [sys.executable, *before_args] + pipe_name = generate_random_pipe_name("unittest-execution-test") + test_ids_pipe = os.fspath( + script_dir / "tests" / "unittestadapter" / ".data" / "coverage_ex" / "10943021.txt" + ) + env_add.update({"RUN_TEST_IDS_PIPE": test_ids_pipe}) + test_ids_arr = after_ids + with open(test_ids_pipe, "w") as f: # noqa: PTH123 + f.write("\n".join(test_ids_arr)) else: process_args = [sys.executable, "-m", "pytest", "-p", "vscode_pytest", "-s", *args] pipe_name = generate_random_pipe_name("pytest-discovery-test") + if "COVERAGE_ENABLED" in env_add and "_TEST_VAR_UNITTEST" not in env_add: + process_args = [ + sys.executable, + "-m", + "pytest", + "-p", + "vscode_pytest", + "--cov=.", + "--cov-branch", + "-s", + *args, + ] + # Generate pipe name, pipe name specific per OS type. # Windows design diff --git a/python_files/tests/pytestadapter/test_coverage.py b/python_files/tests/pytestadapter/test_coverage.py new file mode 100644 index 000000000000..31e2be24437e --- /dev/null +++ b/python_files/tests/pytestadapter/test_coverage.py @@ -0,0 +1,50 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. +import os +import pathlib +import sys + +script_dir = pathlib.Path(__file__).parent.parent +sys.path.append(os.fspath(script_dir)) + +from .helpers import ( # noqa: E402 + TEST_DATA_PATH, + runner_with_cwd_env, +) + + +def test_simple_pytest_coverage(): + """ + Test coverage payload is correct for simple pytest example. Output of coverage run is below. + + Name Stmts Miss Branch BrPart Cover + --------------------------------------------------- + __init__.py 0 0 0 0 100% + reverse.py 13 3 8 2 76% + test_reverse.py 11 0 0 0 100% + --------------------------------------------------- + TOTAL 24 3 8 2 84% + + """ + args = [] + env_add = {"COVERAGE_ENABLED": "True"} + cov_folder_path = TEST_DATA_PATH / "coverage_gen" + actual = runner_with_cwd_env(args, cov_folder_path, env_add) + assert actual + coverage = actual[-1] + assert coverage + results = coverage["result"] + assert results + assert len(results) == 3 + focal_function_coverage = results.get(os.fspath(TEST_DATA_PATH / "coverage_gen" / "reverse.py")) + assert focal_function_coverage + assert focal_function_coverage.get("lines_covered") is not None + assert focal_function_coverage.get("lines_missed") is not None + assert set(focal_function_coverage.get("lines_covered")) == {4, 5, 7, 9, 10, 11, 12, 13, 14, 17} + assert set(focal_function_coverage.get("lines_missed")) == {18, 19, 6} + assert ( + focal_function_coverage.get("executed_branches") > 0 + ), "executed_branches are a number greater than 0." + assert ( + focal_function_coverage.get("total_branches") > 0 + ), "total_branches are a number greater than 0." diff --git a/python_files/tests/unittestadapter/.data/coverage_ex/__init__.py b/python_files/tests/unittestadapter/.data/coverage_ex/__init__.py new file mode 100644 index 000000000000..5b7f7a925cc0 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/coverage_ex/__init__.py @@ -0,0 +1,2 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. diff --git a/python_files/tests/unittestadapter/.data/coverage_ex/reverse.py b/python_files/tests/unittestadapter/.data/coverage_ex/reverse.py new file mode 100644 index 000000000000..4840b7d05bf3 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/coverage_ex/reverse.py @@ -0,0 +1,14 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +def reverse_string(s): + if s is None or s == "": + return "Error: Input is None" + return s[::-1] + +def reverse_sentence(sentence): + if sentence is None or sentence == "": + return "Error: Input is None" + words = sentence.split() + reversed_words = [reverse_string(word) for word in words] + return " ".join(reversed_words) diff --git a/python_files/tests/unittestadapter/.data/coverage_ex/test_reverse.py b/python_files/tests/unittestadapter/.data/coverage_ex/test_reverse.py new file mode 100644 index 000000000000..2521e3dc1935 --- /dev/null +++ b/python_files/tests/unittestadapter/.data/coverage_ex/test_reverse.py @@ -0,0 +1,32 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +import unittest +from reverse import reverse_sentence, reverse_string + +class TestReverseFunctions(unittest.TestCase): + + def test_reverse_sentence(self): + """ + Tests the reverse_sentence function to ensure it correctly reverses each word in a sentence. + + Test cases: + - "hello world" should be reversed to "olleh dlrow" + - "Python is fun" should be reversed to "nohtyP si nuf" + - "a b c" should remain "a b c" as each character is a single word + """ + self.assertEqual(reverse_sentence("hello world"), "olleh dlrow") + self.assertEqual(reverse_sentence("Python is fun"), "nohtyP si nuf") + self.assertEqual(reverse_sentence("a b c"), "a b c") + + def test_reverse_sentence_error(self): + self.assertEqual(reverse_sentence(""), "Error: Input is None") + self.assertEqual(reverse_sentence(None), "Error: Input is None") + + def test_reverse_string(self): + self.assertEqual(reverse_string("hello"), "olleh") + self.assertEqual(reverse_string("Python"), "nohtyP") + # this test specifically does not cover the error cases + +if __name__ == '__main__': + unittest.main() diff --git a/python_files/tests/unittestadapter/test_coverage.py b/python_files/tests/unittestadapter/test_coverage.py new file mode 100644 index 000000000000..0089e9ae5504 --- /dev/null +++ b/python_files/tests/unittestadapter/test_coverage.py @@ -0,0 +1,57 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +import os +import pathlib +import sys + +sys.path.append(os.fspath(pathlib.Path(__file__).parent)) + +python_files_path = pathlib.Path(__file__).parent.parent.parent +sys.path.insert(0, os.fspath(python_files_path)) +sys.path.insert(0, os.fspath(python_files_path / "lib" / "python")) + +from tests.pytestadapter import helpers # noqa: E402 + +TEST_DATA_PATH = pathlib.Path(__file__).parent / ".data" + + +def test_basic_coverage(): + """This test runs on a simple django project with three tests, two of which pass and one that fails.""" + coverage_ex_folder: pathlib.Path = TEST_DATA_PATH / "coverage_ex" + execution_script: pathlib.Path = python_files_path / "unittestadapter" / "execution.py" + test_ids = [ + "test_reverse.TestReverseFunctions.test_reverse_sentence", + "test_reverse.TestReverseFunctions.test_reverse_sentence_error", + "test_reverse.TestReverseFunctions.test_reverse_string", + ] + argv = [os.fsdecode(execution_script), "--udiscovery", "-vv", "-s", ".", "-p", "*test*.py"] + argv = argv + test_ids + + actual = helpers.runner_with_cwd_env( + argv, + coverage_ex_folder, + {"COVERAGE_ENABLED": os.fspath(coverage_ex_folder), "_TEST_VAR_UNITTEST": "True"}, + ) + + assert actual + coverage = actual[-1] + assert coverage + results = coverage["result"] + assert results + assert len(results) == 3 + focal_function_coverage = results.get(os.fspath(TEST_DATA_PATH / "coverage_ex" / "reverse.py")) + assert focal_function_coverage + assert focal_function_coverage.get("lines_covered") is not None + assert focal_function_coverage.get("lines_missed") is not None + assert set(focal_function_coverage.get("lines_covered")) == {4, 5, 7, 9, 10, 11, 12, 13, 14} + assert set(focal_function_coverage.get("lines_missed")) == {6} + assert ( + focal_function_coverage.get("executed_branches") > 0 + ), "executed_branches are a number greater than 0." + assert ( + focal_function_coverage.get("total_branches") > 0 + ), "total_branches are a number greater than 0." diff --git a/python_files/unittestadapter/execution.py b/python_files/unittestadapter/execution.py index 8e4b2462e681..2c49182c8633 100644 --- a/python_files/unittestadapter/execution.py +++ b/python_files/unittestadapter/execution.py @@ -10,7 +10,7 @@ import traceback import unittest from types import TracebackType -from typing import Dict, List, Optional, Tuple, Type, Union +from typing import Dict, Iterator, List, Optional, Tuple, Type, Union # Adds the scripts directory to the PATH as a workaround for enabling shell for test execution. path_var_name = "PATH" if "PATH" in os.environ else "Path" @@ -24,8 +24,10 @@ from django_handler import django_execution_runner # noqa: E402 from unittestadapter.pvsc_utils import ( # noqa: E402 + CoveragePayloadDict, EOTPayloadDict, ExecutionPayloadDict, + FileCoverageInfo, TestExecutionStatus, VSCodeUnittestError, parse_unittest_args, @@ -304,7 +306,6 @@ def send_run_data(raw_data, test_run_pipe): run_test_ids_pipe = os.environ.get("RUN_TEST_IDS_PIPE") test_run_pipe = os.getenv("TEST_RUN_PIPE") - if not run_test_ids_pipe: print("Error[vscode-unittest]: RUN_TEST_IDS_PIPE env var is not set.") raise VSCodeUnittestError("Error[vscode-unittest]: RUN_TEST_IDS_PIPE env var is not set.") @@ -312,6 +313,7 @@ def send_run_data(raw_data, test_run_pipe): print("Error[vscode-unittest]: TEST_RUN_PIPE env var is not set.") raise VSCodeUnittestError("Error[vscode-unittest]: TEST_RUN_PIPE env var is not set.") test_ids = [] + cwd = pathlib.Path(start_dir).absolute() try: # Read the test ids from the file, attempt to delete file afterwords. ids_path = pathlib.Path(run_test_ids_pipe) @@ -324,7 +326,6 @@ def send_run_data(raw_data, test_run_pipe): except Exception as e: # No test ids received from buffer, return error payload - cwd = pathlib.Path(start_dir).absolute() status: TestExecutionStatus = TestExecutionStatus.error payload: ExecutionPayloadDict = { "cwd": str(cwd), @@ -334,6 +335,27 @@ def send_run_data(raw_data, test_run_pipe): } send_post_request(payload, test_run_pipe) + workspace_root = os.environ.get("COVERAGE_ENABLED") + # For unittest COVERAGE_ENABLED is to the root of the workspace so correct data is collected + cov = None + is_coverage_run = os.environ.get("COVERAGE_ENABLED") is not None + if is_coverage_run: + print( + "COVERAGE_ENABLED env var set, starting coverage. workspace_root used as parent dir:", + workspace_root, + ) + import coverage + + source_ar: List[str] = [] + if workspace_root: + source_ar.append(workspace_root) + if top_level_dir: + source_ar.append(top_level_dir) + if start_dir: + source_ar.append(os.path.abspath(start_dir)) # noqa: PTH100 + cov = coverage.Coverage(branch=True, source=source_ar) # is at least 1 of these required?? + cov.start() + # If no error occurred, we will have test ids to run. if manage_py_path := os.environ.get("MANAGE_PY_PATH"): print("MANAGE_PY_PATH env var set, running Django test suite.") @@ -351,3 +373,37 @@ def send_run_data(raw_data, test_run_pipe): failfast, locals_, ) + + if is_coverage_run: + from coverage.plugin import FileReporter + from coverage.report_core import get_analysis_to_report + from coverage.results import Analysis + + if not cov: + raise VSCodeUnittestError("Coverage is enabled but cov is not set") + cov.stop() + cov.save() + analysis_iterator: Iterator[Tuple[FileReporter, Analysis]] = get_analysis_to_report( + cov, None + ) + + file_coverage_map: Dict[str, FileCoverageInfo] = {} + for fr, analysis in analysis_iterator: + file_str: str = fr.filename + executed_branches = analysis.numbers.n_executed_branches + total_branches = analysis.numbers.n_branches + + file_info: FileCoverageInfo = { + "lines_covered": list(analysis.executed), # set + "lines_missed": list(analysis.missing), # set + "executed_branches": executed_branches, # int + "total_branches": total_branches, # int + } + file_coverage_map[file_str] = file_info + payload_cov: CoveragePayloadDict = CoveragePayloadDict( + coverage=True, + cwd=os.fspath(cwd), + result=file_coverage_map, + error=None, + ) + send_post_request(payload_cov, test_run_pipe) diff --git a/python_files/unittestadapter/pvsc_utils.py b/python_files/unittestadapter/pvsc_utils.py index 12a299a8992f..25088f0cb7a2 100644 --- a/python_files/unittestadapter/pvsc_utils.py +++ b/python_files/unittestadapter/pvsc_utils.py @@ -81,6 +81,22 @@ class EOTPayloadDict(TypedDict): eot: bool +class FileCoverageInfo(TypedDict): + lines_covered: List[int] + lines_missed: List[int] + executed_branches: int + total_branches: int + + +class CoveragePayloadDict(Dict): + """A dictionary that is used to send a execution post request to the server.""" + + coverage: bool + cwd: str + result: Optional[Dict[str, FileCoverageInfo]] + error: Optional[str] # Currently unused need to check + + # Helper functions for data retrieval. @@ -300,7 +316,7 @@ def parse_unittest_args( def send_post_request( - payload: Union[ExecutionPayloadDict, DiscoveryPayloadDict, EOTPayloadDict], + payload: Union[ExecutionPayloadDict, DiscoveryPayloadDict, EOTPayloadDict, CoveragePayloadDict], test_run_pipe: Optional[str], ): """ diff --git a/python_files/vscode_pytest/__init__.py b/python_files/vscode_pytest/__init__.py index baa9df90eddd..6f04c45f00e6 100644 --- a/python_files/vscode_pytest/__init__.py +++ b/python_files/vscode_pytest/__init__.py @@ -14,6 +14,7 @@ Any, Dict, Generator, + Iterator, Literal, TypedDict, ) @@ -65,6 +66,8 @@ def __init__(self, message): TEST_RUN_PIPE = os.getenv("TEST_RUN_PIPE") SYMLINK_PATH = None +INCLUDE_BRANCHES = False + def pytest_load_initial_conftests(early_config, parser, args): # noqa: ARG001 global TEST_RUN_PIPE @@ -81,6 +84,10 @@ def pytest_load_initial_conftests(early_config, parser, args): # noqa: ARG001 global IS_DISCOVERY IS_DISCOVERY = True + if "--cov-branch" in args: + global INCLUDE_BRANCHES + INCLUDE_BRANCHES = True + # check if --rootdir is in the args for arg in args: if "--rootdir=" in arg: @@ -356,6 +363,13 @@ def check_skipped_condition(item): return False +class FileCoverageInfo(TypedDict): + lines_covered: list[int] + lines_missed: list[int] + executed_branches: int + total_branches: int + + def pytest_sessionfinish(session, exitstatus): """A pytest hook that is called after pytest has fulled finished. @@ -420,9 +434,54 @@ def pytest_sessionfinish(session, exitstatus): None, ) # send end of transmission token + + # send coverageee if enabled + is_coverage_run = os.environ.get("COVERAGE_ENABLED") + if is_coverage_run == "True": + # load the report and build the json result to return + import coverage + from coverage.report_core import get_analysis_to_report + + if TYPE_CHECKING: + from coverage.plugin import FileReporter + from coverage.results import Analysis + + cov = coverage.Coverage() + cov.load() + analysis_iterator: Iterator[tuple[FileReporter, Analysis]] = get_analysis_to_report( + cov, None + ) + + file_coverage_map: dict[str, FileCoverageInfo] = {} + for fr, analysis in analysis_iterator: + file_str: str = fr.filename + executed_branches = analysis.numbers.n_executed_branches + total_branches = analysis.numbers.n_branches + if not INCLUDE_BRANCHES: + print("coverage not run with branches") + # if covearge wasn't run with branches, set the total branches value to -1 to signal that it is not available + executed_branches = 0 + total_branches = -1 + + file_info: FileCoverageInfo = { + "lines_covered": list(analysis.executed), # set + "lines_missed": list(analysis.missing), # set + "executed_branches": executed_branches, # int + "total_branches": total_branches, # int + } + file_coverage_map[file_str] = file_info + + payload: CoveragePayloadDict = CoveragePayloadDict( + coverage=True, + cwd=os.fspath(cwd), + result=file_coverage_map, + error=None, + ) + send_post_request(payload) + command_type = "discovery" if IS_DISCOVERY else "execution" - payload: EOTPayloadDict = {"command_type": command_type, "eot": True} - send_post_request(payload) + payload_eot: EOTPayloadDict = {"command_type": command_type, "eot": True} + send_post_request(payload_eot) def build_test_tree(session: pytest.Session) -> TestNode: @@ -738,6 +797,15 @@ class ExecutionPayloadDict(Dict): error: str | None # Currently unused need to check +class CoveragePayloadDict(Dict): + """A dictionary that is used to send a execution post request to the server.""" + + coverage: bool + cwd: str + result: dict[str, FileCoverageInfo] | None + error: str | None # Currently unused need to check + + class EOTPayloadDict(TypedDict): """A dictionary that is used to send a end of transmission post request to the server.""" @@ -822,14 +890,14 @@ def post_response(cwd: str, session_node: TestNode) -> None: class PathEncoder(json.JSONEncoder): """A custom JSON encoder that encodes pathlib.Path objects as strings.""" - def default(self, obj): - if isinstance(obj, pathlib.Path): - return os.fspath(obj) - return super().default(obj) + def default(self, o): + if isinstance(o, pathlib.Path): + return os.fspath(o) + return super().default(o) def send_post_request( - payload: ExecutionPayloadDict | DiscoveryPayloadDict | EOTPayloadDict, + payload: ExecutionPayloadDict | DiscoveryPayloadDict | EOTPayloadDict | CoveragePayloadDict, cls_encoder=None, ): """ diff --git a/python_files/vscode_pytest/run_pytest_script.py b/python_files/vscode_pytest/run_pytest_script.py index 79e039607c4b..9abe3fd6b86c 100644 --- a/python_files/vscode_pytest/run_pytest_script.py +++ b/python_files/vscode_pytest/run_pytest_script.py @@ -34,6 +34,20 @@ def run_pytest(args): sys.path.insert(0, os.getcwd()) # noqa: PTH109 # Get the rest of the args to run with pytest. args = sys.argv[1:] + + # Check if coverage is enabled and adjust the args accordingly. + is_coverage_run = os.environ.get("COVERAGE_ENABLED") + coverage_enabled = False + if is_coverage_run == "True": + # If coverage is enabled, check if the coverage plugin is already in the args, if so keep user args. + for arg in args: + if "--cov" in arg: + coverage_enabled = True + break + if not coverage_enabled: + print("Coverage is enabled, adding branch coverage as an argument.") + args = [*args, "--cov=.", "--cov-branch"] + run_test_ids_pipe = os.environ.get("RUN_TEST_IDS_PIPE") if run_test_ids_pipe: try: diff --git a/src/client/testing/testController/common/resultResolver.ts b/src/client/testing/testController/common/resultResolver.ts index 16ee79371b37..54a21a712133 100644 --- a/src/client/testing/testController/common/resultResolver.ts +++ b/src/client/testing/testController/common/resultResolver.ts @@ -10,9 +10,20 @@ import { Location, TestRun, MarkdownString, + TestCoverageCount, + FileCoverage, + FileCoverageDetail, + StatementCoverage, + Range, } from 'vscode'; import * as util from 'util'; -import { DiscoveredTestPayload, EOTTestPayload, ExecutionTestPayload, ITestResultResolver } from './types'; +import { + CoveragePayload, + DiscoveredTestPayload, + EOTTestPayload, + ExecutionTestPayload, + ITestResultResolver, +} from './types'; import { TestProvider } from '../../types'; import { traceError, traceVerbose } from '../../../logging'; import { Testing } from '../../../common/utils/localize'; @@ -36,6 +47,8 @@ export class PythonResultResolver implements ITestResultResolver { public subTestStats: Map = new Map(); + public detailedCoverageMap = new Map(); + constructor(testController: TestController, testProvider: TestProvider, private workspaceUri: Uri) { this.testController = testController; this.testProvider = testProvider; @@ -105,7 +118,7 @@ export class PythonResultResolver implements ITestResultResolver { } public resolveExecution( - payload: ExecutionTestPayload | EOTTestPayload, + payload: ExecutionTestPayload | EOTTestPayload | CoveragePayload, runInstance: TestRun, deferredTillEOT: Deferred, ): void { @@ -113,9 +126,71 @@ export class PythonResultResolver implements ITestResultResolver { // eot sent once per connection traceVerbose('EOT received, resolving deferredTillServerClose'); deferredTillEOT.resolve(); + } else if ('coverage' in payload) { + // coverage data is sent once per connection + traceVerbose('Coverage data received.'); + this._resolveCoverage(payload as CoveragePayload, runInstance); } else { this._resolveExecution(payload as ExecutionTestPayload, runInstance); } + if ('coverage' in payload) { + // coverage data is sent once per connection + traceVerbose('Coverage data received.'); + this._resolveCoverage(payload as CoveragePayload, runInstance); + } + } + + public _resolveCoverage(payload: CoveragePayload, runInstance: TestRun): void { + if (payload.result === undefined) { + return; + } + for (const [key, value] of Object.entries(payload.result)) { + const fileNameStr = key; + const fileCoverageMetrics = value; + const linesCovered = fileCoverageMetrics.lines_covered ? fileCoverageMetrics.lines_covered : []; // undefined if no lines covered + const linesMissed = fileCoverageMetrics.lines_missed ? fileCoverageMetrics.lines_missed : []; // undefined if no lines missed + const executedBranches = fileCoverageMetrics.executed_branches; + const totalBranches = fileCoverageMetrics.total_branches; + + const lineCoverageCount = new TestCoverageCount( + linesCovered.length, + linesCovered.length + linesMissed.length, + ); + const uri = Uri.file(fileNameStr); + let fileCoverage: FileCoverage; + if (totalBranches === -1) { + // branch coverage was not enabled and should not be displayed + fileCoverage = new FileCoverage(uri, lineCoverageCount); + } else { + const branchCoverageCount = new TestCoverageCount(executedBranches, totalBranches); + fileCoverage = new FileCoverage(uri, lineCoverageCount, branchCoverageCount); + } + runInstance.addCoverage(fileCoverage); + + // create detailed coverage array for each file (only line coverage on detailed, not branch) + const detailedCoverageArray: FileCoverageDetail[] = []; + // go through all covered lines, create new StatementCoverage, and add to detailedCoverageArray + for (const line of linesCovered) { + // line is 1-indexed, so we need to subtract 1 to get the 0-indexed line number + // true value means line is covered + const statementCoverage = new StatementCoverage( + true, + new Range(line - 1, 0, line - 1, Number.MAX_SAFE_INTEGER), + ); + detailedCoverageArray.push(statementCoverage); + } + for (const line of linesMissed) { + // line is 1-indexed, so we need to subtract 1 to get the 0-indexed line number + // false value means line is NOT covered + const statementCoverage = new StatementCoverage( + false, + new Range(line - 1, 0, line - 1, Number.MAX_SAFE_INTEGER), + ); + detailedCoverageArray.push(statementCoverage); + } + + this.detailedCoverageMap.set(fileNameStr, detailedCoverageArray); + } } public _resolveExecution(payload: ExecutionTestPayload, runInstance: TestRun): void { diff --git a/src/client/testing/testController/common/types.ts b/src/client/testing/testController/common/types.ts index 319898f3189a..7846461a46a9 100644 --- a/src/client/testing/testController/common/types.ts +++ b/src/client/testing/testController/common/types.ts @@ -4,6 +4,7 @@ import { CancellationToken, Event, + FileCoverageDetail, OutputChannel, TestController, TestItem, @@ -150,7 +151,7 @@ export type TestCommandOptions = { command: TestDiscoveryCommand | TestExecutionCommand; token?: CancellationToken; outChannel?: OutputChannel; - debugBool?: boolean; + profileKind?: TestRunProfileKind; testIds?: string[]; }; @@ -195,18 +196,21 @@ export interface ITestResultResolver { runIdToVSid: Map; runIdToTestItem: Map; vsIdToRunId: Map; + detailedCoverageMap: Map; + resolveDiscovery( payload: DiscoveredTestPayload | EOTTestPayload, deferredTillEOT: Deferred, token?: CancellationToken, ): void; resolveExecution( - payload: ExecutionTestPayload | EOTTestPayload, + payload: ExecutionTestPayload | EOTTestPayload | CoveragePayload, runInstance: TestRun, deferredTillEOT: Deferred, ): void; _resolveDiscovery(payload: DiscoveredTestPayload, token?: CancellationToken): void; _resolveExecution(payload: ExecutionTestPayload, runInstance: TestRun): void; + _resolveCoverage(payload: CoveragePayload, runInstance: TestRun): void; } export interface ITestDiscoveryAdapter { // ** first line old method signature, second line new method signature @@ -217,11 +221,11 @@ export interface ITestDiscoveryAdapter { // interface for execution/runner adapter export interface ITestExecutionAdapter { // ** first line old method signature, second line new method signature - runTests(uri: Uri, testIds: string[], debugBool?: boolean): Promise; + runTests(uri: Uri, testIds: string[], profileKind?: boolean | TestRunProfileKind): Promise; runTests( uri: Uri, testIds: string[], - debugBool?: boolean, + profileKind?: boolean | TestRunProfileKind, runInstance?: TestRun, executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, @@ -260,6 +264,27 @@ export type EOTTestPayload = { eot: boolean; }; +export type CoveragePayload = { + coverage: boolean; + cwd: string; + result?: { + [filePathStr: string]: FileCoverageMetrics; + }; + error: string; +}; + +// using camel-case for these types to match the python side +export type FileCoverageMetrics = { + // eslint-disable-next-line camelcase + lines_covered: number[]; + // eslint-disable-next-line camelcase + lines_missed: number[]; + // eslint-disable-next-line camelcase + executed_branches: number; + // eslint-disable-next-line camelcase + total_branches: number; +}; + export type ExecutionTestPayload = { cwd: string; status: 'success' | 'error'; diff --git a/src/client/testing/testController/controller.ts b/src/client/testing/testController/controller.ts index 58edfb059666..dd624078a534 100644 --- a/src/client/testing/testController/controller.ts +++ b/src/client/testing/testController/controller.ts @@ -16,6 +16,8 @@ import { Uri, EventEmitter, TextDocument, + FileCoverageDetail, + TestRun, } from 'vscode'; import { IExtensionSingleActivationService } from '../../activation/types'; import { ICommandManager, IWorkspaceService } from '../../common/application/types'; @@ -38,7 +40,6 @@ import { ITestFrameworkController, TestRefreshOptions, ITestExecutionAdapter, - ITestResultResolver, } from './common/types'; import { UnittestTestDiscoveryAdapter } from './unittest/testDiscoveryAdapter'; import { UnittestTestExecutionAdapter } from './unittest/testExecutionAdapter'; @@ -118,6 +119,14 @@ export class PythonTestController implements ITestController, IExtensionSingleAc this.disposables.push(delayTrigger); this.refreshData = delayTrigger; + const coverageProfile = this.testController.createRunProfile( + 'Coverage Tests', + TestRunProfileKind.Coverage, + this.runTests.bind(this), + true, + RunTestTag, + ); + this.disposables.push( this.testController.createRunProfile( 'Run Tests', @@ -133,6 +142,7 @@ export class PythonTestController implements ITestController, IExtensionSingleAc true, DebugTestTag, ), + coverageProfile, ); this.testController.resolveHandler = this.resolveChildren.bind(this); this.testController.refreshHandler = (token: CancellationToken) => { @@ -160,7 +170,8 @@ export class PythonTestController implements ITestController, IExtensionSingleAc let discoveryAdapter: ITestDiscoveryAdapter; let executionAdapter: ITestExecutionAdapter; let testProvider: TestProvider; - let resultResolver: ITestResultResolver; + let resultResolver: PythonResultResolver; + if (settings.testing.unittestEnabled) { testProvider = UNITTEST_PROVIDER; resultResolver = new PythonResultResolver(this.testController, testProvider, workspace.uri); @@ -384,6 +395,7 @@ export class PythonTestController implements ITestController, IExtensionSingleAc }); const unconfiguredWorkspaces: WorkspaceFolder[] = []; + try { await Promise.all( workspaces.map(async (workspace) => { @@ -406,6 +418,28 @@ export class PythonTestController implements ITestController, IExtensionSingleAc const settings = this.configSettings.getSettings(workspace.uri); if (testItems.length > 0) { + // coverage?? + const testAdapter = + this.testAdapters.get(workspace.uri) || + (this.testAdapters.values().next().value as WorkspaceTestAdapter); + + if (request.profile?.kind && request.profile?.kind === TestRunProfileKind.Coverage) { + request.profile.loadDetailedCoverage = ( + _testRun: TestRun, + fileCoverage, + _token, + ): Thenable => { + const details = testAdapter.resultResolver.detailedCoverageMap.get( + fileCoverage.uri.fsPath, + ); + if (details === undefined) { + // given file has no detailed coverage data + return Promise.resolve([]); + } + return Promise.resolve(details); + }; + } + if (settings.testing.pytestEnabled) { sendTelemetryEvent(EventName.UNITTEST_RUN, undefined, { tool: 'pytest', @@ -413,15 +447,12 @@ export class PythonTestController implements ITestController, IExtensionSingleAc }); // ** experiment to roll out NEW test discovery mechanism if (pythonTestAdapterRewriteEnabled(this.serviceContainer)) { - const testAdapter = - this.testAdapters.get(workspace.uri) || - (this.testAdapters.values().next().value as WorkspaceTestAdapter); return testAdapter.executeTests( this.testController, runInstance, testItems, token, - request.profile?.kind === TestRunProfileKind.Debug, + request.profile?.kind, this.pythonExecFactory, this.debugLauncher, ); @@ -444,15 +475,12 @@ export class PythonTestController implements ITestController, IExtensionSingleAc }); // ** experiment to roll out NEW test discovery mechanism if (pythonTestAdapterRewriteEnabled(this.serviceContainer)) { - const testAdapter = - this.testAdapters.get(workspace.uri) || - (this.testAdapters.values().next().value as WorkspaceTestAdapter); return testAdapter.executeTests( this.testController, runInstance, testItems, token, - request.profile?.kind === TestRunProfileKind.Debug, + request.profile?.kind, this.pythonExecFactory, this.debugLauncher, ); diff --git a/src/client/testing/testController/pytest/pytestExecutionAdapter.ts b/src/client/testing/testController/pytest/pytestExecutionAdapter.ts index 9d48003525d6..bfaaab9d6586 100644 --- a/src/client/testing/testController/pytest/pytestExecutionAdapter.ts +++ b/src/client/testing/testController/pytest/pytestExecutionAdapter.ts @@ -1,13 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import { TestRun, Uri } from 'vscode'; +import { TestRun, TestRunProfileKind, Uri } from 'vscode'; import * as path from 'path'; import { ChildProcess } from 'child_process'; import { IConfigurationService, ITestOutputChannel } from '../../../common/types'; import { Deferred } from '../../../common/utils/async'; import { traceError, traceInfo, traceVerbose } from '../../../logging'; -import { EOTTestPayload, ExecutionTestPayload, ITestExecutionAdapter, ITestResultResolver } from '../common/types'; +import { + CoveragePayload, + EOTTestPayload, + ExecutionTestPayload, + ITestExecutionAdapter, + ITestResultResolver, +} from '../common/types'; import { ExecutionFactoryCreateWithEnvironmentOptions, IPythonExecutionFactory, @@ -31,7 +37,7 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { async runTests( uri: Uri, testIds: string[], - debugBool?: boolean, + profileKind?: TestRunProfileKind, runInstance?: TestRun, executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, @@ -41,7 +47,7 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { const deferredTillServerClose: Deferred = utils.createTestingDeferred(); // create callback to handle data received on the named pipe - const dataReceivedCallback = (data: ExecutionTestPayload | EOTTestPayload) => { + const dataReceivedCallback = (data: ExecutionTestPayload | EOTTestPayload | CoveragePayload) => { if (runInstance && !runInstance.token.isCancellationRequested) { this.resultResolver?.resolveExecution(data, runInstance, deferredTillEOT); } else { @@ -75,7 +81,7 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { deferredTillEOT, serverDispose, runInstance, - debugBool, + profileKind, executionFactory, debugLauncher, ); @@ -102,7 +108,7 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { deferredTillEOT: Deferred, serverDispose: () => void, runInstance?: TestRun, - debugBool?: boolean, + profileKind?: TestRunProfileKind, executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, ): Promise { @@ -120,6 +126,10 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { const pythonPathCommand = [fullPluginPath, ...pythonPathParts].join(path.delimiter); mutableEnv.PYTHONPATH = pythonPathCommand; mutableEnv.TEST_RUN_PIPE = resultNamedPipeName; + if (profileKind && profileKind === TestRunProfileKind.Coverage) { + mutableEnv.COVERAGE_ENABLED = 'True'; + } + const debugBool = profileKind && profileKind === TestRunProfileKind.Debug; // Create the Python environment in which to execute the command. const creationOptions: ExecutionFactoryCreateWithEnvironmentOptions = { diff --git a/src/client/testing/testController/unittest/testExecutionAdapter.ts b/src/client/testing/testController/unittest/testExecutionAdapter.ts index b3e134a30dd6..8e5277fe68d9 100644 --- a/src/client/testing/testController/unittest/testExecutionAdapter.ts +++ b/src/client/testing/testController/unittest/testExecutionAdapter.ts @@ -2,7 +2,7 @@ // Licensed under the MIT License. import * as path from 'path'; -import { TestRun, Uri } from 'vscode'; +import { TestRun, TestRunProfileKind, Uri } from 'vscode'; import { ChildProcess } from 'child_process'; import { IConfigurationService, ITestOutputChannel } from '../../../common/types'; import { Deferred, createDeferred } from '../../../common/utils/async'; @@ -43,7 +43,7 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { public async runTests( uri: Uri, testIds: string[], - debugBool?: boolean, + profileKind?: TestRunProfileKind, runInstance?: TestRun, executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, @@ -81,7 +81,7 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { deferredTillEOT, serverDispose, runInstance, - debugBool, + profileKind, executionFactory, debugLauncher, ); @@ -107,7 +107,7 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { deferredTillEOT: Deferred, serverDispose: () => void, runInstance?: TestRun, - debugBool?: boolean, + profileKind?: TestRunProfileKind, executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, ): Promise { @@ -124,12 +124,15 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { const pythonPathCommand = [cwd, ...pythonPathParts].join(path.delimiter); mutableEnv.PYTHONPATH = pythonPathCommand; mutableEnv.TEST_RUN_PIPE = resultNamedPipeName; + if (profileKind && profileKind === TestRunProfileKind.Coverage) { + mutableEnv.COVERAGE_ENABLED = cwd; + } const options: TestCommandOptions = { workspaceFolder: uri, command, cwd, - debugBool, + profileKind, testIds, outChannel: this.outputChannel, token: runInstance?.token, @@ -161,7 +164,7 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { } try { - if (options.debugBool) { + if (options.profileKind && options.profileKind === TestRunProfileKind.Debug) { const launchOptions: LaunchOptions = { cwd: options.cwd, args, diff --git a/src/client/testing/testController/workspaceTestAdapter.ts b/src/client/testing/testController/workspaceTestAdapter.ts index 5fe69dfe3d69..a0e65cfb5061 100644 --- a/src/client/testing/testController/workspaceTestAdapter.ts +++ b/src/client/testing/testController/workspaceTestAdapter.ts @@ -2,7 +2,7 @@ // Licensed under the MIT License. import * as util from 'util'; -import { CancellationToken, TestController, TestItem, TestRun, Uri } from 'vscode'; +import { CancellationToken, TestController, TestItem, TestRun, TestRunProfileKind, Uri } from 'vscode'; import { createDeferred, Deferred } from '../../common/utils/async'; import { Testing } from '../../common/utils/localize'; import { traceError } from '../../logging'; @@ -34,7 +34,7 @@ export class WorkspaceTestAdapter { private discoveryAdapter: ITestDiscoveryAdapter, private executionAdapter: ITestExecutionAdapter, private workspaceUri: Uri, - private resultResolver: ITestResultResolver, + public resultResolver: ITestResultResolver, ) {} public async executeTests( @@ -42,7 +42,7 @@ export class WorkspaceTestAdapter { runInstance: TestRun, includes: TestItem[], token?: CancellationToken, - debugBool?: boolean, + profileKind?: boolean | TestRunProfileKind, executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, ): Promise { @@ -76,13 +76,13 @@ export class WorkspaceTestAdapter { await this.executionAdapter.runTests( this.workspaceUri, testCaseIds, - debugBool, + profileKind, runInstance, executionFactory, debugLauncher, ); } else { - await this.executionAdapter.runTests(this.workspaceUri, testCaseIds, debugBool); + await this.executionAdapter.runTests(this.workspaceUri, testCaseIds, profileKind); } deferred.resolve(); } catch (ex) { diff --git a/src/test/mocks/vsc/index.ts b/src/test/mocks/vsc/index.ts index 4ba0c0bcbf92..152beb64cdf4 100644 --- a/src/test/mocks/vsc/index.ts +++ b/src/test/mocks/vsc/index.ts @@ -576,3 +576,21 @@ export class Location { this.range = rangeOrPosition; } } + +/** + * The kind of executions that {@link TestRunProfile TestRunProfiles} control. + */ +export enum TestRunProfileKind { + /** + * The `Run` test profile kind. + */ + Run = 1, + /** + * The `Debug` test profile kind. + */ + Debug = 2, + /** + * The `Coverage` test profile kind. + */ + Coverage = 3, +} diff --git a/src/test/testing/common/testingAdapter.test.ts b/src/test/testing/common/testingAdapter.test.ts index ad5c66df4cda..d0dd5b02d283 100644 --- a/src/test/testing/common/testingAdapter.test.ts +++ b/src/test/testing/common/testingAdapter.test.ts @@ -1,7 +1,7 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import { TestController, TestRun, Uri } from 'vscode'; +import { TestController, TestRun, TestRunProfileKind, Uri } from 'vscode'; import * as typeMoq from 'typemoq'; import * as path from 'path'; import * as assert from 'assert'; @@ -71,6 +71,12 @@ suite('End to End Tests: test adapters', () => { 'testTestingRootWkspc', 'symlink_parent-folder', ); + const rootPathCoverageWorkspace = path.join( + EXTENSION_ROOT_DIR_FOR_TESTS, + 'src', + 'testTestingRootWkspc', + 'coverageWorkspace', + ); suiteSetup(async () => { serviceContainer = (await initialize()).serviceContainer; @@ -199,7 +205,6 @@ suite('End to End Tests: test adapters', () => { assert.strictEqual(callCount, 1, 'Expected _resolveDiscovery to be called once'); }); }); - test('unittest discovery adapter large workspace', async () => { // result resolver and saved data for assertions let actualData: { @@ -562,7 +567,7 @@ suite('End to End Tests: test adapters', () => { .runTests( workspaceUri, ['test_simple.SimpleClass.test_simple_unit'], - false, + TestRunProfileKind.Run, testRun.object, pythonExecFactory, ) @@ -642,7 +647,7 @@ suite('End to End Tests: test adapters', () => { .runTests( workspaceUri, ['test_parameterized_subtest.NumbersTest.test_even'], - false, + TestRunProfileKind.Run, testRun.object, pythonExecFactory, ) @@ -717,7 +722,7 @@ suite('End to End Tests: test adapters', () => { .runTests( workspaceUri, [`${rootPathSmallWorkspace}/test_simple.py::test_a`], - false, + TestRunProfileKind.Run, testRun.object, pythonExecFactory, ) @@ -751,6 +756,118 @@ suite('End to End Tests: test adapters', () => { } }); }); + + test('Unittest execution with coverage, small workspace', async () => { + // result resolver and saved data for assertions + resultResolver = new PythonResultResolver(testController, unittestProvider, workspaceUri); + resultResolver._resolveCoverage = async (payload, _token?) => { + assert.strictEqual(payload.cwd, rootPathCoverageWorkspace, 'Expected cwd to be the workspace folder'); + assert.ok(payload.result, 'Expected results to be present'); + const simpleFileCov = payload.result[`${rootPathCoverageWorkspace}/even.py`]; + assert.ok(simpleFileCov, 'Expected test_simple.py coverage to be present'); + // since only one test was run, the other test in the same file will have missed coverage lines + assert.strictEqual(simpleFileCov.lines_covered.length, 3, 'Expected 1 line to be covered in even.py'); + assert.strictEqual(simpleFileCov.lines_missed.length, 1, 'Expected 3 lines to be missed in even.py'); + assert.strictEqual(simpleFileCov.executed_branches, 1, 'Expected 3 lines to be missed in even.py'); + assert.strictEqual(simpleFileCov.total_branches, 2, 'Expected 3 lines to be missed in even.py'); + return Promise.resolve(); + }; + + // set workspace to test workspace folder + workspaceUri = Uri.parse(rootPathCoverageWorkspace); + configService.getSettings(workspaceUri).testing.unittestArgs = ['-s', '.', '-p', '*test*.py']; + // run execution + const executionAdapter = new UnittestTestExecutionAdapter( + configService, + testOutputChannel.object, + resultResolver, + envVarsService, + ); + const testRun = typeMoq.Mock.ofType(); + testRun + .setup((t) => t.token) + .returns( + () => + ({ + onCancellationRequested: () => undefined, + } as any), + ); + let collectedOutput = ''; + testRun + .setup((t) => t.appendOutput(typeMoq.It.isAny())) + .callback((output: string) => { + collectedOutput += output; + traceLog('appendOutput was called with:', output); + }) + .returns(() => false); + await executionAdapter + .runTests( + workspaceUri, + ['test_even.TestNumbers.test_odd'], + TestRunProfileKind.Coverage, + testRun.object, + pythonExecFactory, + ) + .finally(() => { + assert.ok(collectedOutput, 'expect output to be collected'); + }); + }); + test('pytest coverage execution, small workspace', async () => { + // result resolver and saved data for assertions + resultResolver = new PythonResultResolver(testController, pytestProvider, workspaceUri); + resultResolver._resolveCoverage = async (payload, _runInstance?) => { + assert.strictEqual(payload.cwd, rootPathCoverageWorkspace, 'Expected cwd to be the workspace folder'); + assert.ok(payload.result, 'Expected results to be present'); + const simpleFileCov = payload.result[`${rootPathCoverageWorkspace}/even.py`]; + assert.ok(simpleFileCov, 'Expected test_simple.py coverage to be present'); + // since only one test was run, the other test in the same file will have missed coverage lines + assert.strictEqual(simpleFileCov.lines_covered.length, 3, 'Expected 1 line to be covered in even.py'); + assert.strictEqual(simpleFileCov.lines_missed.length, 1, 'Expected 3 lines to be missed in even.py'); + assert.strictEqual(simpleFileCov.executed_branches, 1, 'Expected 3 lines to be missed in even.py'); + assert.strictEqual(simpleFileCov.total_branches, 2, 'Expected 3 lines to be missed in even.py'); + + return Promise.resolve(); + }; + // set workspace to test workspace folder + workspaceUri = Uri.parse(rootPathCoverageWorkspace); + configService.getSettings(workspaceUri).testing.pytestArgs = []; + + // run pytest execution + const executionAdapter = new PytestTestExecutionAdapter( + configService, + testOutputChannel.object, + resultResolver, + envVarsService, + ); + const testRun = typeMoq.Mock.ofType(); + testRun + .setup((t) => t.token) + .returns( + () => + ({ + onCancellationRequested: () => undefined, + } as any), + ); + let collectedOutput = ''; + testRun + .setup((t) => t.appendOutput(typeMoq.It.isAny())) + .callback((output: string) => { + collectedOutput += output; + traceLog('appendOutput was called with:', output); + }) + .returns(() => false); + await executionAdapter + .runTests( + workspaceUri, + [`${rootPathCoverageWorkspace}/test_even.py::TestNumbers::test_odd`], + TestRunProfileKind.Coverage, + testRun.object, + pythonExecFactory, + ) + .then(() => { + assert.ok(collectedOutput, 'expect output to be collected'); + }); + }); test('pytest execution adapter large workspace', async () => { // result resolver and saved data for assertions resultResolver = new PythonResultResolver(testController, unittestProvider, workspaceUri); @@ -810,17 +927,19 @@ suite('End to End Tests: test adapters', () => { traceLog('appendOutput was called with:', output); }) .returns(() => false); - await executionAdapter.runTests(workspaceUri, testIds, false, testRun.object, pythonExecFactory).then(() => { - // verify that the _resolveExecution was called once per test - assert.strictEqual(callCount, 2000, 'Expected _resolveExecution to be called once'); - assert.strictEqual(failureOccurred, false, failureMsg); + await executionAdapter + .runTests(workspaceUri, testIds, TestRunProfileKind.Run, testRun.object, pythonExecFactory) + .then(() => { + // verify that the _resolveExecution was called once per test + assert.strictEqual(callCount, 2000, 'Expected _resolveExecution to be called once'); + assert.strictEqual(failureOccurred, false, failureMsg); - // verify output works for large repo - assert.ok( - collectedOutput.includes('test session starts'), - 'The test string does not contain the expected stdout output from pytest.', - ); - }); + // verify output works for large repo + assert.ok( + collectedOutput.includes('test session starts'), + 'The test string does not contain the expected stdout output from pytest.', + ); + }); }); test('unittest discovery adapter seg fault error handling', async () => { resultResolver = new PythonResultResolver(testController, unittestProvider, workspaceUri); @@ -1008,10 +1127,12 @@ suite('End to End Tests: test adapters', () => { onCancellationRequested: () => undefined, } as any), ); - await executionAdapter.runTests(workspaceUri, testIds, false, testRun.object, pythonExecFactory).finally(() => { - assert.strictEqual(callCount, 1, 'Expected _resolveExecution to be called once'); - assert.strictEqual(failureOccurred, false, failureMsg); - }); + await executionAdapter + .runTests(workspaceUri, testIds, TestRunProfileKind.Run, testRun.object, pythonExecFactory) + .finally(() => { + assert.strictEqual(callCount, 1, 'Expected _resolveExecution to be called once'); + assert.strictEqual(failureOccurred, false, failureMsg); + }); }); test('pytest execution adapter seg fault error handling', async () => { resultResolver = new PythonResultResolver(testController, pytestProvider, workspaceUri); @@ -1069,9 +1190,11 @@ suite('End to End Tests: test adapters', () => { onCancellationRequested: () => undefined, } as any), ); - await executionAdapter.runTests(workspaceUri, testIds, false, testRun.object, pythonExecFactory).finally(() => { - assert.strictEqual(callCount, 1, 'Expected _resolveExecution to be called once'); - assert.strictEqual(failureOccurred, false, failureMsg); - }); + await executionAdapter + .runTests(workspaceUri, testIds, TestRunProfileKind.Run, testRun.object, pythonExecFactory) + .finally(() => { + assert.strictEqual(callCount, 1, 'Expected _resolveExecution to be called once'); + assert.strictEqual(failureOccurred, false, failureMsg); + }); }); }); diff --git a/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts b/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts index 040734601a09..8ab701ad6f57 100644 --- a/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts +++ b/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts @@ -2,7 +2,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. import * as assert from 'assert'; -import { TestRun, Uri } from 'vscode'; +import { TestRun, Uri, TestRunProfileKind } from 'vscode'; import * as typeMoq from 'typemoq'; import * as sinon from 'sinon'; import * as path from 'path'; @@ -121,7 +121,7 @@ suite('pytest test execution adapter', () => { adapter = new PytestTestExecutionAdapter(configService, outputChannel.object); const testIds = ['test1id', 'test2id']; - adapter.runTests(uri, testIds, false, testRun.object, execFactory.object); + adapter.runTests(uri, testIds, TestRunProfileKind.Run, testRun.object, execFactory.object); // add in await and trigger await deferred2.promise; @@ -150,7 +150,7 @@ suite('pytest test execution adapter', () => { const uri = Uri.file(myTestPath); const outputChannel = typeMoq.Mock.ofType(); adapter = new PytestTestExecutionAdapter(configService, outputChannel.object); - adapter.runTests(uri, [], false, testRun.object, execFactory.object); + adapter.runTests(uri, [], TestRunProfileKind.Run, testRun.object, execFactory.object); await deferred2.promise; await deferred3.promise; @@ -174,6 +174,7 @@ suite('pytest test execution adapter', () => { assert.equal(options.env?.PYTHONPATH, expectedExtraVariables.PYTHONPATH); assert.equal(options.env?.TEST_RUN_PIPE, expectedExtraVariables.TEST_RUN_PIPE); assert.equal(options.env?.RUN_TEST_IDS_PIPE, expectedExtraVariables.RUN_TEST_IDS_PIPE); + assert.equal(options.env?.COVERAGE_ENABLED, undefined); // coverage not enabled assert.equal(options.cwd, uri.fsPath); assert.equal(options.throwOnStdErr, true); return true; @@ -208,7 +209,7 @@ suite('pytest test execution adapter', () => { const uri = Uri.file(myTestPath); const outputChannel = typeMoq.Mock.ofType(); adapter = new PytestTestExecutionAdapter(configService, outputChannel.object); - adapter.runTests(uri, [], false, testRun.object, execFactory.object); + adapter.runTests(uri, [], TestRunProfileKind.Run, testRun.object, execFactory.object); await deferred2.promise; await deferred3.promise; @@ -267,7 +268,14 @@ suite('pytest test execution adapter', () => { const uri = Uri.file(myTestPath); const outputChannel = typeMoq.Mock.ofType(); adapter = new PytestTestExecutionAdapter(configService, outputChannel.object); - await adapter.runTests(uri, [], true, testRun.object, execFactory.object, debugLauncher.object); + await adapter.runTests( + uri, + [], + TestRunProfileKind.Debug, + testRun.object, + execFactory.object, + debugLauncher.object, + ); await deferred3.promise; debugLauncher.verify( (x) => @@ -286,4 +294,46 @@ suite('pytest test execution adapter', () => { typeMoq.Times.once(), ); }); + test('pytest execution with coverage turns on correctly', async () => { + const deferred2 = createDeferred(); + const deferred3 = createDeferred(); + execFactory = typeMoq.Mock.ofType(); + execFactory + .setup((x) => x.createActivatedEnvironment(typeMoq.It.isAny())) + .returns(() => { + deferred2.resolve(); + return Promise.resolve(execService.object); + }); + utilsWriteTestIdsFileStub.callsFake(() => { + deferred3.resolve(); + return Promise.resolve('testIdPipe-mockName'); + }); + const testRun = typeMoq.Mock.ofType(); + testRun.setup((t) => t.token).returns(() => ({ onCancellationRequested: () => undefined } as any)); + const uri = Uri.file(myTestPath); + const outputChannel = typeMoq.Mock.ofType(); + adapter = new PytestTestExecutionAdapter(configService, outputChannel.object); + adapter.runTests(uri, [], TestRunProfileKind.Coverage, testRun.object, execFactory.object); + + await deferred2.promise; + await deferred3.promise; + await deferred4.promise; + mockProc.trigger('close'); + + const pathToPythonFiles = path.join(EXTENSION_ROOT_DIR, 'python_files'); + const pathToPythonScript = path.join(pathToPythonFiles, 'vscode_pytest', 'run_pytest_script.py'); + const rootDirArg = `--rootdir=${myTestPath}`; + const expectedArgs = [pathToPythonScript, rootDirArg]; + execService.verify( + (x) => + x.execObservable( + expectedArgs, + typeMoq.It.is((options) => { + assert.equal(options.env?.COVERAGE_ENABLED, 'True'); + return true; + }), + ), + typeMoq.Times.once(), + ); + }); }); diff --git a/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts b/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts index 563735e6a467..41f2fe257681 100644 --- a/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts +++ b/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts @@ -1,7 +1,7 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -import { CancellationTokenSource, TestRun, Uri } from 'vscode'; +import { CancellationTokenSource, TestRun, TestRunProfileKind, Uri } from 'vscode'; import * as typeMoq from 'typemoq'; import * as sinon from 'sinon'; import * as path from 'path'; @@ -126,7 +126,7 @@ suite('Execution Flow Run Adapters', () => { await testAdapter.runTests( Uri.file(myTestPath), [], - false, + TestRunProfileKind.Run, testRunMock.object, execFactoryStub.object, debugLauncher.object, @@ -220,7 +220,7 @@ suite('Execution Flow Run Adapters', () => { await testAdapter.runTests( Uri.file(myTestPath), [], - true, + TestRunProfileKind.Debug, testRunMock.object, execFactoryStub.object, debugLauncher.object, diff --git a/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts b/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts index 0cb64a8c75cd..88292c2254d8 100644 --- a/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts +++ b/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts @@ -2,7 +2,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. import * as assert from 'assert'; -import { TestRun, Uri } from 'vscode'; +import { TestRun, TestRunProfileKind, Uri } from 'vscode'; import * as typeMoq from 'typemoq'; import * as sinon from 'sinon'; import * as path from 'path'; @@ -121,7 +121,7 @@ suite('Unittest test execution adapter', () => { adapter = new UnittestTestExecutionAdapter(configService, outputChannel.object); const testIds = ['test1id', 'test2id']; - adapter.runTests(uri, testIds, false, testRun.object, execFactory.object); + adapter.runTests(uri, testIds, TestRunProfileKind.Run, testRun.object, execFactory.object); // add in await and trigger await deferred2.promise; @@ -150,7 +150,7 @@ suite('Unittest test execution adapter', () => { const uri = Uri.file(myTestPath); const outputChannel = typeMoq.Mock.ofType(); adapter = new UnittestTestExecutionAdapter(configService, outputChannel.object); - adapter.runTests(uri, [], false, testRun.object, execFactory.object); + adapter.runTests(uri, [], TestRunProfileKind.Run, testRun.object, execFactory.object); await deferred2.promise; await deferred3.promise; @@ -173,6 +173,7 @@ suite('Unittest test execution adapter', () => { assert.equal(options.env?.PYTHONPATH, expectedExtraVariables.PYTHONPATH); assert.equal(options.env?.TEST_RUN_PIPE, expectedExtraVariables.TEST_RUN_PIPE); assert.equal(options.env?.RUN_TEST_IDS_PIPE, expectedExtraVariables.RUN_TEST_IDS_PIPE); + assert.equal(options.env?.COVERAGE_ENABLED, undefined); // coverage not enabled assert.equal(options.cwd, uri.fsPath); assert.equal(options.throwOnStdErr, true); return true; @@ -207,7 +208,7 @@ suite('Unittest test execution adapter', () => { const uri = Uri.file(myTestPath); const outputChannel = typeMoq.Mock.ofType(); adapter = new UnittestTestExecutionAdapter(configService, outputChannel.object); - adapter.runTests(uri, [], false, testRun.object, execFactory.object); + adapter.runTests(uri, [], TestRunProfileKind.Run, testRun.object, execFactory.object); await deferred2.promise; await deferred3.promise; @@ -266,7 +267,14 @@ suite('Unittest test execution adapter', () => { const uri = Uri.file(myTestPath); const outputChannel = typeMoq.Mock.ofType(); adapter = new UnittestTestExecutionAdapter(configService, outputChannel.object); - await adapter.runTests(uri, [], true, testRun.object, execFactory.object, debugLauncher.object); + await adapter.runTests( + uri, + [], + TestRunProfileKind.Debug, + testRun.object, + execFactory.object, + debugLauncher.object, + ); await deferred3.promise; debugLauncher.verify( (x) => @@ -284,4 +292,45 @@ suite('Unittest test execution adapter', () => { typeMoq.Times.once(), ); }); + test('unittest execution with coverage turned on correctly', async () => { + const deferred2 = createDeferred(); + const deferred3 = createDeferred(); + execFactory = typeMoq.Mock.ofType(); + execFactory + .setup((x) => x.createActivatedEnvironment(typeMoq.It.isAny())) + .returns(() => { + deferred2.resolve(); + return Promise.resolve(execService.object); + }); + utilsWriteTestIdsFileStub.callsFake(() => { + deferred3.resolve(); + return Promise.resolve('testIdPipe-mockName'); + }); + const testRun = typeMoq.Mock.ofType(); + testRun.setup((t) => t.token).returns(() => ({ onCancellationRequested: () => undefined } as any)); + const uri = Uri.file(myTestPath); + const outputChannel = typeMoq.Mock.ofType(); + adapter = new UnittestTestExecutionAdapter(configService, outputChannel.object); + adapter.runTests(uri, [], TestRunProfileKind.Coverage, testRun.object, execFactory.object); + + await deferred2.promise; + await deferred3.promise; + await deferred4.promise; + mockProc.trigger('close'); + + const pathToPythonFiles = path.join(EXTENSION_ROOT_DIR, 'python_files'); + const pathToExecutionScript = path.join(pathToPythonFiles, 'unittestadapter', 'execution.py'); + const expectedArgs = [pathToExecutionScript, '--udiscovery', '.']; + execService.verify( + (x) => + x.execObservable( + expectedArgs, + typeMoq.It.is((options) => { + assert.equal(options.env?.COVERAGE_ENABLED, uri.fsPath); + return true; + }), + ), + typeMoq.Times.once(), + ); + }); }); diff --git a/src/test/vscode-mock.ts b/src/test/vscode-mock.ts index ec44d302d063..0605b1718166 100644 --- a/src/test/vscode-mock.ts +++ b/src/test/vscode-mock.ts @@ -113,7 +113,7 @@ mockedVSCode.ViewColumn = vscodeMocks.vscMockExtHostedTypes.ViewColumn; mockedVSCode.TextEditorRevealType = vscodeMocks.vscMockExtHostedTypes.TextEditorRevealType; mockedVSCode.TreeItem = vscodeMocks.vscMockExtHostedTypes.TreeItem; mockedVSCode.TreeItemCollapsibleState = vscodeMocks.vscMockExtHostedTypes.TreeItemCollapsibleState; -mockedVSCode.CodeActionKind = vscodeMocks.CodeActionKind; +(mockedVSCode as any).CodeActionKind = vscodeMocks.CodeActionKind; mockedVSCode.CompletionItemKind = vscodeMocks.CompletionItemKind; mockedVSCode.CompletionTriggerKind = vscodeMocks.CompletionTriggerKind; mockedVSCode.DebugAdapterExecutable = vscodeMocks.DebugAdapterExecutable; @@ -133,3 +133,4 @@ mockedVSCode.LogLevel = vscodeMocks.LogLevel; (mockedVSCode as any).ProtocolTypeHierarchyItem = vscodeMocks.vscMockExtHostedTypes.ProtocolTypeHierarchyItem; (mockedVSCode as any).CancellationError = vscodeMocks.vscMockExtHostedTypes.CancellationError; (mockedVSCode as any).LSPCancellationError = vscodeMocks.vscMockExtHostedTypes.LSPCancellationError; +mockedVSCode.TestRunProfileKind = vscodeMocks.TestRunProfileKind; diff --git a/src/testTestingRootWkspc/coverageWorkspace/even.py b/src/testTestingRootWkspc/coverageWorkspace/even.py new file mode 100644 index 000000000000..e395b024ecc5 --- /dev/null +++ b/src/testTestingRootWkspc/coverageWorkspace/even.py @@ -0,0 +1,8 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + + +def number_type(n: int) -> str: + if n % 2 == 0: + return "even" + return "odd" diff --git a/src/testTestingRootWkspc/coverageWorkspace/test_even.py b/src/testTestingRootWkspc/coverageWorkspace/test_even.py new file mode 100644 index 000000000000..ca78535860f4 --- /dev/null +++ b/src/testTestingRootWkspc/coverageWorkspace/test_even.py @@ -0,0 +1,11 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +from even import number_type +import unittest + + +class TestNumbers(unittest.TestCase): + def test_odd(self): + n = number_type(1) + assert n == "odd" From 9a22fb437e16f8a783466d0d24ee15ecb1cb754e Mon Sep 17 00:00:00 2001 From: Aaron Munger Date: Wed, 18 Sep 2024 14:58:04 -0700 Subject: [PATCH 090/149] account for inline chat widget (#24130) `enter` should apply to the inline chat widget if it is focused, not the parent code editor --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index fb46cab3d6c8..9c71db626cde 100644 --- a/package.json +++ b/package.json @@ -1161,7 +1161,7 @@ { "command": "python.execInREPLEnter", "key": "enter", - "when": "!config.interactiveWindow.executeWithShiftEnter && activeEditor == 'workbench.editor.interactive'" + "when": "!config.interactiveWindow.executeWithShiftEnter && activeEditor == 'workbench.editor.interactive' && !inlineChatFocused" }, { "command": "python.refreshTensorBoard", From 07a075537bdac224ea5f8221bd49b93ddf636f58 Mon Sep 17 00:00:00 2001 From: Aaron Munger Date: Thu, 19 Sep 2024 08:26:05 -0700 Subject: [PATCH 091/149] use new context key for both repl-type editors (#24131) both the repl editor and the IW can be accounted for with the new compositeNotebook context key --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 9c71db626cde..696856aba561 100644 --- a/package.json +++ b/package.json @@ -1151,12 +1151,12 @@ { "command": "python.execSelectionInTerminal", "key": "shift+enter", - "when": "editorTextFocus && editorLangId == python && !findInputFocussed && !replaceInputFocussed && !jupyter.ownsSelection && !notebookEditorFocused && activeEditor != 'workbench.editor.interactive'" + "when": "editorTextFocus && editorLangId == python && !findInputFocussed && !replaceInputFocussed && !jupyter.ownsSelection && !notebookEditorFocused && !isCompositeNotebook" }, { "command": "python.execInREPL", "key": "shift+enter", - "when": "!accessibilityModeEnabled && config.python.REPL.sendToNativeREPL && activeEditor != 'workbench.editor.interactive'&& editorLangId == python && editorTextFocus && !jupyter.ownsSelection && !notebookEditorFocused" + "when": "!accessibilityModeEnabled && config.python.REPL.sendToNativeREPL && editorLangId == python && editorTextFocus && !jupyter.ownsSelection && !notebookEditorFocused && !isCompositeNotebook" }, { "command": "python.execInREPLEnter", From 3fcb3fadfbf049a9541f3dfacff44f66b06c4b6f Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Thu, 19 Sep 2024 13:21:16 -0400 Subject: [PATCH 092/149] Adding PYTHONSTARTUP with shell integration to environment variable collection (#24111) Resolves: https://github.com/microsoft/vscode-python/issues/23930 - setting to opt out of PYTHONSTARTUP injection. --------- Co-authored-by: Courtney Webster <60238438+cwebster-99@users.noreply.github.com> --- package.json | 6 +++++ package.nls.json | 1 + src/client/common/types.ts | 1 + src/client/common/vscodeApis/workspaceApis.ts | 8 ++++++ src/client/extensionActivation.ts | 3 +++ .../envCollectionActivation/service.ts | 17 +++++++----- .../shellIntegrationService.ts | 4 +-- src/client/terminals/pythonStartup.ts | 27 +++++++++++++++++++ src/client/terminals/serviceRegistry.ts | 10 ++++--- src/client/terminals/types.ts | 9 +++++-- ...rminalEnvVarCollectionService.unit.test.ts | 6 ++--- .../terminals/codeExecution/helper.test.ts | 7 ++++- .../terminals/codeExecution/smartSend.test.ts | 7 ++++- .../terminals/serviceRegistry.unit.test.ts | 6 ++--- 14 files changed, 91 insertions(+), 21 deletions(-) create mode 100644 src/client/terminals/pythonStartup.ts diff --git a/package.json b/package.json index 696856aba561..af945dc2754e 100644 --- a/package.json +++ b/package.json @@ -656,6 +656,12 @@ "scope": "resource", "type": "array" }, + "python.REPL.enableShellIntegration": { + "default": true, + "description": "%python.REPL.enableShellIntegration.description%", + "scope": "resource", + "type": "boolean" + }, "python.REPL.enableREPLSmartSend": { "default": true, "description": "%python.EnableREPLSmartSend.description%", diff --git a/package.nls.json b/package.nls.json index 5a5029231b17..f032f3d7c275 100644 --- a/package.nls.json +++ b/package.nls.json @@ -65,6 +65,7 @@ "python.pixiToolPath.description": "Path to the pixi executable.", "python.EnableREPLSmartSend.description": "Toggle Smart Send for the Python REPL. Smart Send enables sending the smallest runnable block of code to the REPL on Shift+Enter and moves the cursor accordingly.", "python.REPL.sendToNativeREPL.description": "Toggle to send code to Python REPL instead of the terminal on execution. Turning this on will change the behavior for both Smart Send and Run Selection/Line in the Context Menu.", + "python.REPL.enableShellIntegration.description": "Enable Shell Integration for Python Terminal REPL. Shell Integration enhances the terminal experience by allowing command decorations, run recent command, and improving accessibility for Python REPL in the terminal.", "python.tensorBoard.logDirectory.description": "Set this setting to your preferred TensorBoard log directory to skip log directory prompt when starting TensorBoard.", "python.tensorBoard.logDirectory.markdownDeprecationMessage": "Tensorboard support has been moved to the extension [Tensorboard extension](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.tensorboard). Instead use the setting `tensorBoard.logDirectory`.", "python.tensorBoard.logDirectory.deprecationMessage": "Tensorboard support has been moved to the extension Tensorboard extension. Instead use the setting `tensorBoard.logDirectory`.", diff --git a/src/client/common/types.ts b/src/client/common/types.ts index 754e08004213..283319fd6cec 100644 --- a/src/client/common/types.ts +++ b/src/client/common/types.ts @@ -202,6 +202,7 @@ export interface ITerminalSettings { export interface IREPLSettings { readonly enableREPLSmartSend: boolean; readonly sendToNativeREPL: boolean; + readonly enableShellIntegration: boolean; } export interface IExperiments { diff --git a/src/client/common/vscodeApis/workspaceApis.ts b/src/client/common/vscodeApis/workspaceApis.ts index 137382dc71a0..cb516da73075 100644 --- a/src/client/common/vscodeApis/workspaceApis.ts +++ b/src/client/common/vscodeApis/workspaceApis.ts @@ -93,3 +93,11 @@ export function isTrusted(): boolean { export function onDidGrantWorkspaceTrust(handler: () => void): vscode.Disposable { return vscode.workspace.onDidGrantWorkspaceTrust(handler); } + +export function createDirectory(uri: vscode.Uri): Thenable { + return vscode.workspace.fs.createDirectory(uri); +} + +export function copy(source: vscode.Uri, dest: vscode.Uri, options?: { overwrite?: boolean }): Thenable { + return vscode.workspace.fs.copy(source, dest, options); +} diff --git a/src/client/extensionActivation.ts b/src/client/extensionActivation.ts index fe5d18a8b83f..429004e951cb 100644 --- a/src/client/extensionActivation.ts +++ b/src/client/extensionActivation.ts @@ -54,6 +54,7 @@ import { DebuggerTypeName } from './debugger/constants'; import { StopWatch } from './common/utils/stopWatch'; import { registerReplCommands, registerReplExecuteOnEnter, registerStartNativeReplCommand } from './repl/replCommands'; import { registerTriggerForTerminalREPL } from './terminals/codeExecution/terminalReplWatcher'; +import { registerPythonStartup } from './terminals/pythonStartup'; export async function activateComponents( // `ext` is passed to any extra activation funcs. @@ -177,6 +178,8 @@ async function activateLegacy(ext: ExtensionState, startupStopWatch: StopWatch): serviceManager.get(ITerminalAutoActivation).register(); + await registerPythonStartup(ext.context); + serviceManager.get(ICodeExecutionManager).registerCommands(); disposables.push(new ReplProvider(serviceContainer)); diff --git a/src/client/terminals/envCollectionActivation/service.ts b/src/client/terminals/envCollectionActivation/service.ts index 77e478b3577d..62971aa1fa98 100644 --- a/src/client/terminals/envCollectionActivation/service.ts +++ b/src/client/terminals/envCollectionActivation/service.ts @@ -37,7 +37,11 @@ import { TerminalShellType } from '../../common/terminal/types'; import { OSType } from '../../common/utils/platform'; import { PythonEnvType } from '../../pythonEnvironments/base/info'; -import { IShellIntegrationService, ITerminalDeactivateService, ITerminalEnvVarCollectionService } from '../types'; +import { + IShellIntegrationDetectionService, + ITerminalDeactivateService, + ITerminalEnvVarCollectionService, +} from '../types'; import { ProgressService } from '../../common/application/progressService'; @injectable() @@ -80,7 +84,8 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ @inject(IConfigurationService) private readonly configurationService: IConfigurationService, @inject(ITerminalDeactivateService) private readonly terminalDeactivateService: ITerminalDeactivateService, @inject(IPathUtils) private readonly pathUtils: IPathUtils, - @inject(IShellIntegrationService) private readonly shellIntegrationService: IShellIntegrationService, + @inject(IShellIntegrationDetectionService) + private readonly shellIntegrationDetectionService: IShellIntegrationDetectionService, @inject(IEnvironmentVariablesProvider) private readonly environmentVariablesProvider: IEnvironmentVariablesProvider, ) { @@ -113,7 +118,7 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ this, this.disposables, ); - this.shellIntegrationService.onDidChangeStatus( + this.shellIntegrationDetectionService.onDidChangeStatus( async () => { traceInfo("Shell integration status changed, can confirm it's working."); await this._applyCollection(undefined).ignoreErrors(); @@ -139,7 +144,7 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ this.disposables, ); const { shell } = this.applicationEnvironment; - const isActive = await this.shellIntegrationService.isWorking(); + const isActive = await this.shellIntegrationDetectionService.isWorking(); const shellType = identifyShellFromShellPath(shell); if (!isActive && shellType !== TerminalShellType.commandPrompt) { traceWarn( @@ -328,7 +333,7 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ // PS1 should be set but no PS1 was set. return; } - const config = await this.shellIntegrationService.isWorking(); + const config = await this.shellIntegrationDetectionService.isWorking(); if (!config) { traceVerbose('PS1 is not set when shell integration is disabled.'); return; @@ -395,7 +400,7 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ } private async getPrependOptions(): Promise { - const isActive = await this.shellIntegrationService.isWorking(); + const isActive = await this.shellIntegrationDetectionService.isWorking(); // Ideally we would want to prepend exactly once, either at shell integration or process creation. // TODO: Stop prepending altogether once https://github.com/microsoft/vscode/issues/145234 is available. return isActive diff --git a/src/client/terminals/envCollectionActivation/shellIntegrationService.ts b/src/client/terminals/envCollectionActivation/shellIntegrationService.ts index 8ab3d84122b7..71cfb18dd437 100644 --- a/src/client/terminals/envCollectionActivation/shellIntegrationService.ts +++ b/src/client/terminals/envCollectionActivation/shellIntegrationService.ts @@ -14,7 +14,7 @@ import { TerminalShellType } from '../../common/terminal/types'; import { IDisposableRegistry, IPersistentStateFactory } from '../../common/types'; import { sleep } from '../../common/utils/async'; import { traceError, traceVerbose } from '../../logging'; -import { IShellIntegrationService } from '../types'; +import { IShellIntegrationDetectionService } from '../types'; /** * This is a list of shells which support shell integration: @@ -33,7 +33,7 @@ export enum isShellIntegrationWorking { } @injectable() -export class ShellIntegrationService implements IShellIntegrationService { +export class ShellIntegrationDetectionService implements IShellIntegrationDetectionService { private isWorkingForShell = new Set(); private readonly didChange = new EventEmitter(); diff --git a/src/client/terminals/pythonStartup.ts b/src/client/terminals/pythonStartup.ts new file mode 100644 index 000000000000..9a6b956d7f6e --- /dev/null +++ b/src/client/terminals/pythonStartup.ts @@ -0,0 +1,27 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +import { ExtensionContext, Uri } from 'vscode'; +import * as path from 'path'; +import { copy, createDirectory, getConfiguration } from '../common/vscodeApis/workspaceApis'; +import { EXTENSION_ROOT_DIR } from '../constants'; + +export async function registerPythonStartup(context: ExtensionContext): Promise { + const config = getConfiguration('python'); + const pythonrcSetting = config.get('REPL.enableShellIntegration'); + + if (pythonrcSetting) { + const storageUri = context.storageUri || context.globalStorageUri; + try { + await createDirectory(storageUri); + } catch { + // already exists, most likely + } + const destPath = Uri.joinPath(storageUri, 'pythonrc.py'); + const sourcePath = path.join(EXTENSION_ROOT_DIR, 'python_files', 'pythonrc.py'); + await copy(Uri.file(sourcePath), destPath, { overwrite: true }); + context.environmentVariableCollection.replace('PYTHONSTARTUP', destPath.fsPath); + } else { + context.environmentVariableCollection.delete('PYTHONSTARTUP'); + } +} diff --git a/src/client/terminals/serviceRegistry.ts b/src/client/terminals/serviceRegistry.ts index 3474edadd744..e62701dcec0e 100644 --- a/src/client/terminals/serviceRegistry.ts +++ b/src/client/terminals/serviceRegistry.ts @@ -12,7 +12,7 @@ import { ICodeExecutionHelper, ICodeExecutionManager, ICodeExecutionService, - IShellIntegrationService, + IShellIntegrationDetectionService, ITerminalAutoActivation, ITerminalDeactivateService, ITerminalEnvVarCollectionService, @@ -20,8 +20,8 @@ import { import { TerminalEnvVarCollectionService } from './envCollectionActivation/service'; import { IExtensionActivationService, IExtensionSingleActivationService } from '../activation/types'; import { TerminalIndicatorPrompt } from './envCollectionActivation/indicatorPrompt'; -import { ShellIntegrationService } from './envCollectionActivation/shellIntegrationService'; import { TerminalDeactivateService } from './envCollectionActivation/deactivateService'; +import { ShellIntegrationDetectionService } from './envCollectionActivation/shellIntegrationService'; export function registerTypes(serviceManager: IServiceManager): void { serviceManager.addSingleton(ICodeExecutionHelper, CodeExecutionHelper); @@ -50,6 +50,10 @@ export function registerTypes(serviceManager: IServiceManager): void { IExtensionSingleActivationService, TerminalIndicatorPrompt, ); - serviceManager.addSingleton(IShellIntegrationService, ShellIntegrationService); + serviceManager.addSingleton( + IShellIntegrationDetectionService, + ShellIntegrationDetectionService, + ); + serviceManager.addBinding(ITerminalEnvVarCollectionService, IExtensionActivationService); } diff --git a/src/client/terminals/types.ts b/src/client/terminals/types.ts index 4c73da63dd1e..ada3acd851a9 100644 --- a/src/client/terminals/types.ts +++ b/src/client/terminals/types.ts @@ -42,8 +42,8 @@ export interface ITerminalEnvVarCollectionService { isTerminalPromptSetCorrectly(resource?: Resource): boolean; } -export const IShellIntegrationService = Symbol('IShellIntegrationService'); -export interface IShellIntegrationService { +export const IShellIntegrationDetectionService = Symbol('IShellIntegrationDetectionService'); +export interface IShellIntegrationDetectionService { onDidChangeStatus: Event; isWorking(): Promise; } @@ -53,3 +53,8 @@ export interface ITerminalDeactivateService { initializeScriptParams(shell: string): Promise; getScriptLocation(shell: string, resource: Resource): Promise; } + +export const IPythonStartupEnvVarService = Symbol('IPythonStartupEnvVarService'); +export interface IPythonStartupEnvVarService { + register(): void; +} diff --git a/src/test/interpreters/activation/terminalEnvVarCollectionService.unit.test.ts b/src/test/interpreters/activation/terminalEnvVarCollectionService.unit.test.ts index 5d1027d12702..3550a92ba1ec 100644 --- a/src/test/interpreters/activation/terminalEnvVarCollectionService.unit.test.ts +++ b/src/test/interpreters/activation/terminalEnvVarCollectionService.unit.test.ts @@ -37,7 +37,7 @@ import { IInterpreterService } from '../../../client/interpreter/contracts'; import { PathUtils } from '../../../client/common/platform/pathUtils'; import { PythonEnvType } from '../../../client/pythonEnvironments/base/info'; import { PythonEnvironment } from '../../../client/pythonEnvironments/info'; -import { IShellIntegrationService, ITerminalDeactivateService } from '../../../client/terminals/types'; +import { IShellIntegrationDetectionService, ITerminalDeactivateService } from '../../../client/terminals/types'; import { IEnvironmentVariablesProvider } from '../../../client/common/variables/types'; suite('Terminal Environment Variable Collection Service', () => { @@ -58,7 +58,7 @@ suite('Terminal Environment Variable Collection Service', () => { title: Interpreters.activatingTerminals, }; let configService: IConfigurationService; - let shellIntegrationService: IShellIntegrationService; + let shellIntegrationService: IShellIntegrationDetectionService; const displayPath = 'display/path'; const customShell = 'powershell'; const defaultShell = defaultShells[getOSType()]; @@ -76,7 +76,7 @@ suite('Terminal Environment Variable Collection Service', () => { context = mock(); shell = mock(); const envVarProvider = mock(); - shellIntegrationService = mock(); + shellIntegrationService = mock(); when(shellIntegrationService.isWorking()).thenResolve(true); globalCollection = mock(); collection = mock(); diff --git a/src/test/terminals/codeExecution/helper.test.ts b/src/test/terminals/codeExecution/helper.test.ts index 9a6deefcb7bf..e15c41957726 100644 --- a/src/test/terminals/codeExecution/helper.test.ts +++ b/src/test/terminals/codeExecution/helper.test.ts @@ -112,7 +112,12 @@ suite('Terminal - Code Execution Helper', () => { activeResourceService.setup((a) => a.getActiveResource()).returns(() => resource); pythonSettings .setup((s) => s.REPL) - .returns(() => ({ enableREPLSmartSend: false, REPLSmartSend: false, sendToNativeREPL: false })); + .returns(() => ({ + enableREPLSmartSend: false, + REPLSmartSend: false, + sendToNativeREPL: false, + enableShellIntegration: true, + })); configurationService.setup((x) => x.getSettings(TypeMoq.It.isAny())).returns(() => pythonSettings.object); configurationService .setup((c) => c.getSettings(TypeMoq.It.isAny())) diff --git a/src/test/terminals/codeExecution/smartSend.test.ts b/src/test/terminals/codeExecution/smartSend.test.ts index 89f5ac2b5e4d..594db361f51e 100644 --- a/src/test/terminals/codeExecution/smartSend.test.ts +++ b/src/test/terminals/codeExecution/smartSend.test.ts @@ -109,7 +109,12 @@ suite('REPL - Smart Send', () => { pythonSettings .setup((s) => s.REPL) - .returns(() => ({ enableREPLSmartSend: true, REPLSmartSend: true, sendToNativeREPL: false })); + .returns(() => ({ + enableREPLSmartSend: true, + REPLSmartSend: true, + sendToNativeREPL: false, + enableShellIntegration: true, + })); configurationService.setup((x) => x.getSettings(TypeMoq.It.isAny())).returns(() => pythonSettings.object); diff --git a/src/test/terminals/serviceRegistry.unit.test.ts b/src/test/terminals/serviceRegistry.unit.test.ts index cb5b7715c4b7..4f865cdedc0d 100644 --- a/src/test/terminals/serviceRegistry.unit.test.ts +++ b/src/test/terminals/serviceRegistry.unit.test.ts @@ -14,17 +14,17 @@ import { TerminalCodeExecutionProvider } from '../../client/terminals/codeExecut import { TerminalDeactivateService } from '../../client/terminals/envCollectionActivation/deactivateService'; import { TerminalIndicatorPrompt } from '../../client/terminals/envCollectionActivation/indicatorPrompt'; import { TerminalEnvVarCollectionService } from '../../client/terminals/envCollectionActivation/service'; -import { ShellIntegrationService } from '../../client/terminals/envCollectionActivation/shellIntegrationService'; import { registerTypes } from '../../client/terminals/serviceRegistry'; import { ICodeExecutionHelper, ICodeExecutionManager, ICodeExecutionService, - IShellIntegrationService, + IShellIntegrationDetectionService, ITerminalAutoActivation, ITerminalDeactivateService, ITerminalEnvVarCollectionService, } from '../../client/terminals/types'; +import { ShellIntegrationDetectionService } from '../../client/terminals/envCollectionActivation/shellIntegrationService'; suite('Terminal - Service Registry', () => { test('Ensure all services get registered', () => { @@ -39,7 +39,7 @@ suite('Terminal - Service Registry', () => { [ITerminalEnvVarCollectionService, TerminalEnvVarCollectionService], [IExtensionSingleActivationService, TerminalIndicatorPrompt], [ITerminalDeactivateService, TerminalDeactivateService], - [IShellIntegrationService, ShellIntegrationService], + [IShellIntegrationDetectionService, ShellIntegrationDetectionService], ].forEach((args) => { if (args.length === 2) { services From cac5bb2a11ae2f0bbf28d36481d04e5f955a0da9 Mon Sep 17 00:00:00 2001 From: Connor Peet Date: Thu, 19 Sep 2024 10:44:27 -0700 Subject: [PATCH 093/149] Add a command copilot calls back to ensure testing is set up (#24128) See https://github.com/microsoft/vscode-copilot/wiki/Package.json-Copilot-Contributions --- package.json | 6 +++++ src/client/common/application/commands.ts | 1 + src/client/common/constants.ts | 1 + src/client/common/utils/localize.ts | 1 + src/client/testing/common/types.ts | 1 + src/client/testing/configuration/index.ts | 5 ++++ src/client/testing/main.ts | 27 ++++++++++++++++++++- src/test/testing/configuration.unit.test.ts | 9 +++++++ 8 files changed, 50 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index af945dc2754e..3b1518f40121 100644 --- a/package.json +++ b/package.json @@ -67,6 +67,7 @@ "onDebugInitialConfigurations", "onLanguage:python", "onDebugResolve:python", + "onCommand:python.copilotSetupTests", "workspaceContains:mspythonconfig.json", "workspaceContains:pyproject.toml", "workspaceContains:Pipfile", @@ -1517,6 +1518,11 @@ } ] }, + "copilot": { + "tests": { + "getSetupConfirmation": "python.copilotSetupTests" + } + }, "scripts": { "package": "gulp clean && gulp prePublishBundle && vsce package -o ms-python-insiders.vsix", "prePublish": "gulp clean && gulp prePublishNonBundle", diff --git a/src/client/common/application/commands.ts b/src/client/common/application/commands.ts index 4580a91a78d1..36f8c6d2ac17 100644 --- a/src/client/common/application/commands.ts +++ b/src/client/common/application/commands.ts @@ -103,6 +103,7 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu [Commands.Exec_In_Terminal_Icon]: [undefined, Uri]; [Commands.Debug_In_Terminal]: [Uri]; [Commands.Tests_Configure]: [undefined, undefined | CommandSource, undefined | Uri]; + [Commands.Tests_CopilotSetup]: [undefined | Uri]; [Commands.LaunchTensorBoard]: [TensorBoardEntrypoint, TensorBoardEntrypointTrigger]; ['workbench.view.testing.focus']: []; ['cursorMove']: [ diff --git a/src/client/common/constants.ts b/src/client/common/constants.ts index 23e9c131b25c..df585abe1653 100644 --- a/src/client/common/constants.ts +++ b/src/client/common/constants.ts @@ -64,6 +64,7 @@ export namespace Commands { export const Start_REPL = 'python.startREPL'; export const Start_Native_REPL = 'python.startNativeREPL'; export const Tests_Configure = 'python.configureTests'; + export const Tests_CopilotSetup = 'python.copilotSetupTests'; export const TriggerEnvironmentSelection = 'python.triggerEnvSelection'; export const ViewOutput = 'python.viewOutput'; } diff --git a/src/client/common/utils/localize.ts b/src/client/common/utils/localize.ts index beed5a8999ea..3e11b1ca177b 100644 --- a/src/client/common/utils/localize.ts +++ b/src/client/common/utils/localize.ts @@ -432,6 +432,7 @@ export namespace Testing { export const errorUnittestExecution = l10n.t('Unittest test execution error'); export const cancelPytestExecution = l10n.t('Canceled pytest test execution'); export const errorPytestExecution = l10n.t('pytest test execution error'); + export const copilotSetupMessage = l10n.t('Confirm your Python testing framework to enable test discovery.'); } export namespace OutdatedDebugger { diff --git a/src/client/testing/common/types.ts b/src/client/testing/common/types.ts index 29a6de7768cb..67a9a44a5706 100644 --- a/src/client/testing/common/types.ts +++ b/src/client/testing/common/types.ts @@ -61,6 +61,7 @@ export interface ITestsHelper { export const ITestConfigurationService = Symbol('ITestConfigurationService'); export interface ITestConfigurationService { + hasConfiguredTests(wkspace: Uri): boolean; displayTestFrameworkError(wkspace: Uri): Promise; selectTestRunner(placeHolderMessage: string): Promise; enableTest(wkspace: Uri, product: UnitTestProduct): Promise; diff --git a/src/client/testing/configuration/index.ts b/src/client/testing/configuration/index.ts index e85154e72738..4825e9aa4f6a 100644 --- a/src/client/testing/configuration/index.ts +++ b/src/client/testing/configuration/index.ts @@ -35,6 +35,11 @@ export class UnitTestConfigurationService implements ITestConfigurationService { this.workspaceService = serviceContainer.get(IWorkspaceService); } + public hasConfiguredTests(wkspace: Uri): boolean { + const settings = this.configurationService.getSettings(wkspace); + return settings.testing.pytestEnabled || settings.testing.unittestEnabled || false; + } + public async displayTestFrameworkError(wkspace: Uri): Promise { const settings = this.configurationService.getSettings(wkspace); let enabledCount = settings.testing.pytestEnabled ? 1 : 0; diff --git a/src/client/testing/main.ts b/src/client/testing/main.ts index deebf2b34c06..c2675ed4a72b 100644 --- a/src/client/testing/main.ts +++ b/src/client/testing/main.ts @@ -1,7 +1,7 @@ 'use strict'; import { inject, injectable } from 'inversify'; -import { ConfigurationChangeEvent, Disposable, Uri, tests, TestResultState, WorkspaceFolder } from 'vscode'; +import { ConfigurationChangeEvent, Disposable, Uri, tests, TestResultState, WorkspaceFolder, Command } from 'vscode'; import { IApplicationShell, ICommandManager, IContextKeyManager, IWorkspaceService } from '../common/application/types'; import * as constants from '../common/constants'; import '../common/extensions'; @@ -170,6 +170,31 @@ export class UnitTestManagementService implements IExtensionActivationService { this.testController?.refreshTestData(resource, { forceRefresh: true }); }, ), + commandManager.registerCommand(constants.Commands.Tests_CopilotSetup, (resource?: Uri): + | { message: string; command: Command } + | undefined => { + const wkspaceFolder = + this.workspaceService.getWorkspaceFolder(resource) || this.workspaceService.workspaceFolders?.at(0); + if (!wkspaceFolder) { + return undefined; + } + + const configurationService = this.serviceContainer.get( + ITestConfigurationService, + ); + if (configurationService.hasConfiguredTests(wkspaceFolder.uri)) { + return undefined; + } + + return { + message: Testing.copilotSetupMessage, + command: { + title: Testing.configureTests, + command: constants.Commands.Tests_Configure, + arguments: [undefined, constants.CommandSource.ui, resource], + }, + }; + }), ); } diff --git a/src/test/testing/configuration.unit.test.ts b/src/test/testing/configuration.unit.test.ts index abb57aac2309..6682abf019b8 100644 --- a/src/test/testing/configuration.unit.test.ts +++ b/src/test/testing/configuration.unit.test.ts @@ -250,6 +250,15 @@ suite('Unit Tests - ConfigurationService', () => { expect(selectedItem).to.be.equal(undefined, 'invalid value'); appShell.verifyAll(); }); + test('Correctly returns hasConfiguredTests', () => { + let enabled = false; + unitTestSettings.setup((u) => u.unittestEnabled).returns(() => false); + unitTestSettings.setup((u) => u.pytestEnabled).returns(() => enabled); + + expect(testConfigService.target.hasConfiguredTests(workspaceUri)).to.equal(false); + enabled = true; + expect(testConfigService.target.hasConfiguredTests(workspaceUri)).to.equal(true); + }); test('Prompt to enable a test if a test framework is not enabled', async () => { unitTestSettings.setup((u) => u.pytestEnabled).returns(() => false); unitTestSettings.setup((u) => u.unittestEnabled).returns(() => false); From 62897c6f0594216ce7ab397fe80ed66c0346bb0b Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Thu, 19 Sep 2024 16:25:20 -0400 Subject: [PATCH 094/149] Add logging for executeCommand (#24138) Need logging to further investigate https://github.com/microsoft/vscode-python/pull/24123#issuecomment-2357498601 for windows. --- src/client/common/terminal/service.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/client/common/terminal/service.ts b/src/client/common/terminal/service.ts index 19cdf0aea0a1..09d75a42fa00 100644 --- a/src/client/common/terminal/service.ts +++ b/src/client/common/terminal/service.ts @@ -22,6 +22,7 @@ import { TerminalShellType, ITerminalExecutedCommand, } from './types'; +import { traceVerbose } from '../../logging'; @injectable() export class TerminalService implements ITerminalService, Disposable { @@ -111,9 +112,11 @@ export class TerminalService implements ITerminalService, Disposable { if (listener) { this.executeCommandListeners.add(listener); } + traceVerbose(`Shell Integration is enabled, executeCommand: ${commandLine}`); }); } else { terminal.sendText(commandLine); + traceVerbose(`Shell Integration is disabled, sendText: ${commandLine}`); } return undefined; From 63280be2279484fae9d0d61c5b94576a36b9c693 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Thu, 19 Sep 2024 18:49:25 -0400 Subject: [PATCH 095/149] Default PYTHONSTARTUP to opt out/off for Stable Release (#24140) From discussion in the original issue: https://github.com/microsoft/vscode-python/issues/23930#issuecomment-2362192346 Making default to be false for September stable, perhaps we could turn it on to true for insiders AFTER once we ship out stable. /cc @Tyriar --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3b1518f40121..f02bb2bf2e01 100644 --- a/package.json +++ b/package.json @@ -658,7 +658,7 @@ "type": "array" }, "python.REPL.enableShellIntegration": { - "default": true, + "default": false, "description": "%python.REPL.enableShellIntegration.description%", "scope": "resource", "type": "boolean" From f9bb1f105662c611221b0f115dd0b24d9c0d992f Mon Sep 17 00:00:00 2001 From: Aaron Munger Date: Fri, 20 Sep 2024 11:55:53 -0700 Subject: [PATCH 096/149] Use new REPL notebook API (#24029) --- package-lock.json | 2 +- package.json | 12 +++- src/client/common/application/commands.ts | 1 + src/client/common/constants.ts | 1 + src/client/repl/nativeRepl.ts | 2 +- src/client/repl/replCommandHandler.ts | 46 +++++++-------- src/client/repl/replCommands.ts | 56 ++++++++++++------- src/client/repl/replController.ts | 2 +- .../vscode.proposed.notebookReplDocument.d.ts | 33 +++++++++++ 9 files changed, 103 insertions(+), 52 deletions(-) create mode 100644 types/vscode.proposed.notebookReplDocument.d.ts diff --git a/package-lock.json b/package-lock.json index 87af2d83a205..f2034d927997 100644 --- a/package-lock.json +++ b/package-lock.json @@ -116,7 +116,7 @@ "yargs": "^15.3.1" }, "engines": { - "vscode": "^1.94.0-20240913" + "vscode": "^1.94.0-20240918" } }, "node_modules/@aashutoshrathi/word-wrap": { diff --git a/package.json b/package.json index f02bb2bf2e01..dc0887402b8c 100644 --- a/package.json +++ b/package.json @@ -25,8 +25,9 @@ "terminalDataWriteEvent", "terminalExecuteCommandEvent", "contribIssueReporter", - "notebookVariableProvider", - "codeActionAI" + "codeActionAI", + "notebookReplDocument", + "notebookVariableProvider" ], "author": { "name": "Microsoft Corporation" @@ -47,7 +48,7 @@ "theme": "dark" }, "engines": { - "vscode": "^1.94.0-20240913" + "vscode": "^1.94.0-20240918" }, "enableTelemetry": false, "keywords": [ @@ -1168,6 +1169,11 @@ { "command": "python.execInREPLEnter", "key": "enter", + "when": "!config.interactiveWindow.executeWithShiftEnter && activeEditor == 'workbench.editor.repl' && !inlineChatFocused" + }, + { + "command": "python.execInInteractiveWindowEnter", + "key": "enter", "when": "!config.interactiveWindow.executeWithShiftEnter && activeEditor == 'workbench.editor.interactive' && !inlineChatFocused" }, { diff --git a/src/client/common/application/commands.ts b/src/client/common/application/commands.ts index 36f8c6d2ac17..41bbe8b4f4ea 100644 --- a/src/client/common/application/commands.ts +++ b/src/client/common/application/commands.ts @@ -99,6 +99,7 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu [Commands.Start_Native_REPL]: [undefined | Uri]; [Commands.Exec_In_REPL]: [undefined | Uri]; [Commands.Exec_In_REPL_Enter]: [undefined | Uri]; + [Commands.Exec_In_IW_Enter]: [undefined | Uri]; [Commands.Exec_In_Terminal]: [undefined, Uri]; [Commands.Exec_In_Terminal_Icon]: [undefined, Uri]; [Commands.Debug_In_Terminal]: [Uri]; diff --git a/src/client/common/constants.ts b/src/client/common/constants.ts index df585abe1653..51e38d5ef3e6 100644 --- a/src/client/common/constants.ts +++ b/src/client/common/constants.ts @@ -49,6 +49,7 @@ export namespace Commands { export const Exec_In_REPL = 'python.execInREPL'; export const Exec_Selection_In_Django_Shell = 'python.execSelectionInDjangoShell'; export const Exec_In_REPL_Enter = 'python.execInREPLEnter'; + export const Exec_In_IW_Enter = 'python.execInInteractiveWindowEnter'; export const Exec_Selection_In_Terminal = 'python.execSelectionInTerminal'; export const GetSelectedInterpreterPath = 'python.interpreterPath'; export const InstallJupyter = 'python.installJupyter'; diff --git a/src/client/repl/nativeRepl.ts b/src/client/repl/nativeRepl.ts index 8e0337f8d276..413c795e80d6 100644 --- a/src/client/repl/nativeRepl.ts +++ b/src/client/repl/nativeRepl.ts @@ -157,7 +157,7 @@ export class NativeRepl implements Disposable { this.replController.updateNotebookAffinity(this.notebookDocument, NotebookControllerAffinity.Default); await selectNotebookKernel(notebookEditor, this.replController.id, PVSC_EXTENSION_ID); if (code) { - await executeNotebookCell(this.notebookDocument, code); + await executeNotebookCell(notebookEditor, code); } } } diff --git a/src/client/repl/replCommandHandler.ts b/src/client/repl/replCommandHandler.ts index 599692a4300e..b8fe579647a1 100644 --- a/src/client/repl/replCommandHandler.ts +++ b/src/client/repl/replCommandHandler.ts @@ -12,6 +12,7 @@ import { workspace, } from 'vscode'; import { getExistingReplViewColumn } from './replUtils'; +import { PVSC_EXTENSION_ID } from '../common/constants'; /** * Function that opens/show REPL using IW UI. @@ -23,29 +24,24 @@ export async function openInteractiveREPL( notebookController: NotebookController, notebookDocument: NotebookDocument | undefined, ): Promise { - let notebookEditor: NotebookEditor | undefined; + let viewColumn = ViewColumn.Beside; // Case where NotebookDocument (REPL document already exists in the tab) if (notebookDocument) { const existingReplViewColumn = getExistingReplViewColumn(notebookDocument); - const replViewColumn = existingReplViewColumn ?? ViewColumn.Beside; - notebookEditor = await window.showNotebookDocument(notebookDocument!, { viewColumn: replViewColumn }); + viewColumn = existingReplViewColumn ?? viewColumn; } else if (!notebookDocument) { - // Case where NotebookDocument doesnt exist, open new REPL tab - const interactiveWindowObject = (await commands.executeCommand( - 'interactive.open', - { - preserveFocus: true, - viewColumn: ViewColumn.Beside, - }, - undefined, - notebookController.id, - 'Python REPL', - )) as { notebookEditor: NotebookEditor }; - notebookEditor = interactiveWindowObject.notebookEditor; - notebookDocument = interactiveWindowObject.notebookEditor.notebook; + // Case where NotebookDocument doesnt exist, create a blank one. + notebookDocument = await workspace.openNotebookDocument('jupyter-notebook'); } - return notebookEditor!; + const editor = window.showNotebookDocument(notebookDocument!, { viewColumn, asRepl: 'Python REPL' }); + await commands.executeCommand('notebook.selectKernel', { + editor, + id: notebookController.id, + extension: PVSC_EXTENSION_ID, + }); + + return editor; } /** @@ -73,13 +69,14 @@ export async function selectNotebookKernel( * @param code * @return Promise */ -export async function executeNotebookCell(notebookDocument: NotebookDocument, code: string): Promise { - const { cellCount } = notebookDocument; - await addCellToNotebook(notebookDocument, code); +export async function executeNotebookCell(notebookEditor: NotebookEditor, code: string): Promise { + const { notebook, replOptions } = notebookEditor; + const cellIndex = replOptions?.appendIndex ?? notebook.cellCount; + await addCellToNotebook(notebook, cellIndex, code); // Execute the cell commands.executeCommand('notebook.cell.execute', { - ranges: [{ start: cellCount, end: cellCount + 1 }], - document: notebookDocument.uri, + ranges: [{ start: cellIndex, end: cellIndex + 1 }], + document: notebook.uri, }); } @@ -89,11 +86,10 @@ export async function executeNotebookCell(notebookDocument: NotebookDocument, co * @param code * */ -async function addCellToNotebook(notebookDocument: NotebookDocument, code: string): Promise { +async function addCellToNotebook(notebookDocument: NotebookDocument, index: number, code: string): Promise { const notebookCellData = new NotebookCellData(NotebookCellKind.Code, code as string, 'python'); - const { cellCount } = notebookDocument!; // Add new cell to interactive window document - const notebookEdit = NotebookEdit.insertCells(cellCount, [notebookCellData]); + const notebookEdit = NotebookEdit.insertCells(index, [notebookCellData]); const workspaceEdit = new WorkspaceEdit(); workspaceEdit.set(notebookDocument!.uri, [notebookEdit]); await workspace.applyEdit(workspaceEdit); diff --git a/src/client/repl/replCommands.ts b/src/client/repl/replCommands.ts index 120ddf13effc..82b4aae4e5ee 100644 --- a/src/client/repl/replCommands.ts +++ b/src/client/repl/replCommands.ts @@ -98,29 +98,43 @@ export async function registerReplExecuteOnEnter( ): Promise { disposables.push( commandManager.registerCommand(Commands.Exec_In_REPL_Enter, async (uri: Uri) => { - const interpreter = await interpreterService.getActiveInterpreter(uri); - if (!interpreter) { - commands.executeCommand(Commands.TriggerEnvironmentSelection, uri).then(noop, noop); - return; - } + await onInputEnter(uri, 'repl.execute', interpreterService, disposables); + }), + ); + disposables.push( + commandManager.registerCommand(Commands.Exec_In_IW_Enter, async (uri: Uri) => { + await onInputEnter(uri, 'interactive.execute', interpreterService, disposables); + }), + ); +} - const nativeRepl = await getNativeRepl(interpreter, disposables); - const completeCode = await nativeRepl?.checkUserInputCompleteCode(window.activeTextEditor); - const editor = window.activeTextEditor; +async function onInputEnter( + uri: Uri, + commandName: string, + interpreterService: IInterpreterService, + disposables: Disposable[], +): Promise { + const interpreter = await interpreterService.getActiveInterpreter(uri); + if (!interpreter) { + commands.executeCommand(Commands.TriggerEnvironmentSelection, uri).then(noop, noop); + return; + } - if (editor) { - // Execute right away when complete code and Not multi-line - if (completeCode && !isMultiLineText(editor)) { - await commands.executeCommand('interactive.execute'); - } else { - insertNewLineToREPLInput(editor); + const nativeRepl = await getNativeRepl(interpreter, disposables); + const completeCode = await nativeRepl?.checkUserInputCompleteCode(window.activeTextEditor); + const editor = window.activeTextEditor; - // Handle case when user enters on blank line, just trigger interactive.execute - if (editor && editor.document.lineAt(editor.selection.active.line).text === '') { - await commands.executeCommand('interactive.execute'); - } - } + if (editor) { + // Execute right away when complete code and Not multi-line + if (completeCode && !isMultiLineText(editor)) { + await commands.executeCommand(commandName); + } else { + insertNewLineToREPLInput(editor); + + // Handle case when user enters on blank line, just trigger interactive.execute + if (editor && editor.document.lineAt(editor.selection.active.line).text === '') { + await commands.executeCommand(commandName); } - }), - ); + } + } } diff --git a/src/client/repl/replController.ts b/src/client/repl/replController.ts index 7c1f8fd0c6b2..08c2a27066a1 100644 --- a/src/client/repl/replController.ts +++ b/src/client/repl/replController.ts @@ -9,7 +9,7 @@ export function createReplController( const server = createPythonServer([interpreterPath], cwd); disposables.push(server); - const controller = vscode.notebooks.createNotebookController('pythonREPL', 'interactive', 'Python REPL'); + const controller = vscode.notebooks.createNotebookController('pythonREPL', 'jupyter-notebook', 'Python REPL'); controller.supportedLanguages = ['python']; controller.supportsExecutionOrder = true; diff --git a/types/vscode.proposed.notebookReplDocument.d.ts b/types/vscode.proposed.notebookReplDocument.d.ts new file mode 100644 index 000000000000..d78450e944a8 --- /dev/null +++ b/types/vscode.proposed.notebookReplDocument.d.ts @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for license information. + *--------------------------------------------------------------------------------------------*/ + +declare module 'vscode' { + + export interface NotebookDocumentShowOptions { + /** + * The notebook should be opened in a REPL editor, + * where the last cell of the notebook is an input box and the other cells are the read-only history. + * When the value is a string, it will be used as the label for the editor tab. + */ + readonly asRepl?: boolean | string | { + /** + * The label to be used for the editor tab. + */ + readonly label: string; + }; + } + + export interface NotebookEditor { + /** + * Information about the REPL editor if the notebook was opened as a repl. + */ + replOptions?: { + /** + * The index where new cells should be appended. + */ + appendIndex: number; + }; + } +} From 336a110882888f6bb46d270cd9daf8dda667d976 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Fri, 20 Sep 2024 15:25:38 -0400 Subject: [PATCH 097/149] add experimental tag for enableShellIntegration (#24144) To better control flow of: https://github.com/microsoft/vscode-python/issues/24141 Adding experimental tag: This way, we are able to control the default value without having to recovery release in the worst case scenario. --- package.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index dc0887402b8c..940409ede228 100644 --- a/package.json +++ b/package.json @@ -662,7 +662,10 @@ "default": false, "description": "%python.REPL.enableShellIntegration.description%", "scope": "resource", - "type": "boolean" + "type": "boolean", + "tags": [ + "experimental" + ] }, "python.REPL.enableREPLSmartSend": { "default": true, From af2aa6e370d87f2de2013a9518270809bdc2545a Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Fri, 20 Sep 2024 20:29:43 -0400 Subject: [PATCH 098/149] Remove variableProvider suite.only from limiting other tests (#24146) Related: https://github.com/microsoft/vscode-python/pull/24094/files#diff-0f06d935b3fbdcc3b6bb01c3987d454c6eb0c3cb0eebbd7c2a58456b0442c4a1R11 seems to be only limiting itself to be ran as a test and no other. /cc @amunger --- src/test/repl/variableProvider.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/test/repl/variableProvider.test.ts b/src/test/repl/variableProvider.test.ts index 8b45fae0c5a0..1b151d34c096 100644 --- a/src/test/repl/variableProvider.test.ts +++ b/src/test/repl/variableProvider.test.ts @@ -8,7 +8,7 @@ import { IVariableDescription } from '../../client/repl/variables/types'; import { VariablesProvider } from '../../client/repl/variables/variablesProvider'; import { VariableRequester } from '../../client/repl/variables/variableRequester'; -suite.only('ReplVariablesProvider', () => { +suite('ReplVariablesProvider', () => { let provider: VariablesProvider; let varRequester: TypeMoq.IMock; let notebook: TypeMoq.IMock; From f8b861a9db291ea5a7b74a36b4b5fae328c54ab3 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Mon, 23 Sep 2024 14:52:03 -0400 Subject: [PATCH 099/149] Change PYTHONSTARTUP setting name to Python.terminal.shell integration.enabled (#24153) Resolves: https://github.com/microsoft/vscode-python/issues/24143 /cc @cwebster-99 @Tyriar --------- Co-authored-by: Daniel Imms <2193314+Tyriar@users.noreply.github.com> --- package.json | 4 ++-- package.nls.json | 2 +- src/client/common/configSettings.ts | 1 + src/client/common/types.ts | 2 +- src/client/terminals/pythonStartup.ts | 2 +- src/test/terminals/codeExecution/helper.test.ts | 1 - src/test/terminals/codeExecution/smartSend.test.ts | 1 - 7 files changed, 6 insertions(+), 7 deletions(-) diff --git a/package.json b/package.json index 940409ede228..eb197afee69b 100644 --- a/package.json +++ b/package.json @@ -658,9 +658,9 @@ "scope": "resource", "type": "array" }, - "python.REPL.enableShellIntegration": { + "python.terminal.shellIntegration.enabled": { "default": false, - "description": "%python.REPL.enableShellIntegration.description%", + "description": "%python.terminal.shellIntegration.enabled.description%", "scope": "resource", "type": "boolean", "tags": [ diff --git a/package.nls.json b/package.nls.json index f032f3d7c275..c92e21be5b61 100644 --- a/package.nls.json +++ b/package.nls.json @@ -65,10 +65,10 @@ "python.pixiToolPath.description": "Path to the pixi executable.", "python.EnableREPLSmartSend.description": "Toggle Smart Send for the Python REPL. Smart Send enables sending the smallest runnable block of code to the REPL on Shift+Enter and moves the cursor accordingly.", "python.REPL.sendToNativeREPL.description": "Toggle to send code to Python REPL instead of the terminal on execution. Turning this on will change the behavior for both Smart Send and Run Selection/Line in the Context Menu.", - "python.REPL.enableShellIntegration.description": "Enable Shell Integration for Python Terminal REPL. Shell Integration enhances the terminal experience by allowing command decorations, run recent command, and improving accessibility for Python REPL in the terminal.", "python.tensorBoard.logDirectory.description": "Set this setting to your preferred TensorBoard log directory to skip log directory prompt when starting TensorBoard.", "python.tensorBoard.logDirectory.markdownDeprecationMessage": "Tensorboard support has been moved to the extension [Tensorboard extension](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.tensorboard). Instead use the setting `tensorBoard.logDirectory`.", "python.tensorBoard.logDirectory.deprecationMessage": "Tensorboard support has been moved to the extension Tensorboard extension. Instead use the setting `tensorBoard.logDirectory`.", + "python.terminal.shellIntegration.enabled.description": "Enable [shell integration](https://code.visualstudio.com/docs/terminal/shell-integration) for the terminals running python. Shell integration enhances the terminal experience by enabling command decorations, run recent command, improving accessibility among other things.", "python.terminal.activateEnvInCurrentTerminal.description": "Activate Python Environment in the current Terminal on load of the Extension.", "python.terminal.activateEnvironment.description": "Activate Python Environment in all Terminals created.", "python.terminal.executeInFileDir.description": "When executing a file in the terminal, whether to use execute in the file's directory, instead of the current open folder.", diff --git a/src/client/common/configSettings.ts b/src/client/common/configSettings.ts index 6cae60c9fb97..1b637e7aac2d 100644 --- a/src/client/common/configSettings.ts +++ b/src/client/common/configSettings.ts @@ -368,6 +368,7 @@ export class PythonSettings implements IPythonSettings { launchArgs: [], activateEnvironment: true, activateEnvInCurrentTerminal: false, + enableShellIntegration: false, }; this.REPL = pythonSettings.get('REPL')!; diff --git a/src/client/common/types.ts b/src/client/common/types.ts index 283319fd6cec..035e6ec4638b 100644 --- a/src/client/common/types.ts +++ b/src/client/common/types.ts @@ -197,12 +197,12 @@ export interface ITerminalSettings { readonly launchArgs: string[]; readonly activateEnvironment: boolean; readonly activateEnvInCurrentTerminal: boolean; + readonly enableShellIntegration: boolean; } export interface IREPLSettings { readonly enableREPLSmartSend: boolean; readonly sendToNativeREPL: boolean; - readonly enableShellIntegration: boolean; } export interface IExperiments { diff --git a/src/client/terminals/pythonStartup.ts b/src/client/terminals/pythonStartup.ts index 9a6b956d7f6e..542a2e6a6355 100644 --- a/src/client/terminals/pythonStartup.ts +++ b/src/client/terminals/pythonStartup.ts @@ -8,7 +8,7 @@ import { EXTENSION_ROOT_DIR } from '../constants'; export async function registerPythonStartup(context: ExtensionContext): Promise { const config = getConfiguration('python'); - const pythonrcSetting = config.get('REPL.enableShellIntegration'); + const pythonrcSetting = config.get('terminal.shellIntegration.enabled'); if (pythonrcSetting) { const storageUri = context.storageUri || context.globalStorageUri; diff --git a/src/test/terminals/codeExecution/helper.test.ts b/src/test/terminals/codeExecution/helper.test.ts index e15c41957726..ebadd153705e 100644 --- a/src/test/terminals/codeExecution/helper.test.ts +++ b/src/test/terminals/codeExecution/helper.test.ts @@ -116,7 +116,6 @@ suite('Terminal - Code Execution Helper', () => { enableREPLSmartSend: false, REPLSmartSend: false, sendToNativeREPL: false, - enableShellIntegration: true, })); configurationService.setup((x) => x.getSettings(TypeMoq.It.isAny())).returns(() => pythonSettings.object); configurationService diff --git a/src/test/terminals/codeExecution/smartSend.test.ts b/src/test/terminals/codeExecution/smartSend.test.ts index 594db361f51e..f315bc004d4e 100644 --- a/src/test/terminals/codeExecution/smartSend.test.ts +++ b/src/test/terminals/codeExecution/smartSend.test.ts @@ -113,7 +113,6 @@ suite('REPL - Smart Send', () => { enableREPLSmartSend: true, REPLSmartSend: true, sendToNativeREPL: false, - enableShellIntegration: true, })); configurationService.setup((x) => x.getSettings(TypeMoq.It.isAny())).returns(() => pythonSettings.object); From 8cfd2d097132216890adbb79afe1e2d4dc5ca68d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 23 Sep 2024 11:52:51 -0700 Subject: [PATCH 100/149] Bump importlib-metadata from 8.4.0 to 8.5.0 (#24100) Bumps [importlib-metadata](https://github.com/python/importlib_metadata) from 8.4.0 to 8.5.0.
Changelog

Sourced from importlib-metadata's changelog.

v8.5.0

Features

  • Deferred import of zipfile.Path (#502)
  • Deferred import of json (#503)
  • Rely on zipp overlay for zipfile.Path.
Commits
  • b34810b Finalize
  • 8c1d1fa Merge pull request #501 from Avasam/Pass-mypy-and-link-issues
  • afa39e8 Back out changes to tests._path
  • 8b909f9 Merge pull request #503 from danielhollas/defer-json
  • 2a3f50d Add news fragment.
  • 3f78dc1 Add comment to protect the deferred import.
  • 18eb2da Revert "Defer platform import"
  • 58832f2 Merge pull request #502 from danielhollas/defer-zipp
  • e3ce33b Add news fragment.
  • d11b67f Add comment to protect the deferred import.
  • Additional commits viewable in compare view

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=importlib-metadata&package-manager=pip&previous-version=8.4.0&new-version=8.5.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) ---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- requirements.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/requirements.txt b/requirements.txt index 82b97eca2bb8..e17a6a86b979 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,9 +4,9 @@ # # pip-compile --generate-hashes requirements.in # -importlib-metadata==8.4.0 \ - --hash=sha256:66f342cc6ac9818fc6ff340576acd24d65ba0b3efabb2b4ac08b598965a4a2f1 \ - --hash=sha256:9a547d3bc3608b025f93d403fdd1aae741c24fbb8314df4b155675742ce303c5 +importlib-metadata==8.5.0 \ + --hash=sha256:45e54197d28b7a7f1559e60b95e7c567032b602131fbd588f1497f47880aa68b \ + --hash=sha256:71522656f0abace1d072b9e5481a48f07c138e00f079c38c8f883823f9c26bd7 # via -r requirements.in microvenv==2023.5.post1 \ --hash=sha256:32c46afea874e300f69f1add0806eb0795fd02b5fb251092fba0b73c059a7d1f \ @@ -24,7 +24,7 @@ typing-extensions==4.12.2 \ --hash=sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d \ --hash=sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8 # via -r requirements.in -zipp==3.19.2 \ - --hash=sha256:bf1dcf6450f873a13e952a29504887c89e6de7506209e5b1bcc3460135d4de19 \ - --hash=sha256:f091755f667055f2d02b32c53771a7a6c8b47e1fdbc4b72a8b9072b3eef8015c +zipp==3.20.1 \ + --hash=sha256:9960cd8967c8f85a56f920d5d507274e74f9ff813a0ab8889a5b5be2daf44064 \ + --hash=sha256:c22b14cc4763c5a5b04134207736c107db42e9d3ef2d9779d465f5f1bcba572b # via importlib-metadata From c314babd2837cc0a66cb521c0f14f5a39afe5647 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 23 Sep 2024 12:06:46 -0700 Subject: [PATCH 101/149] Fix issue with creating `.gitignore` with venvs (#24155) Fixes https://github.com/microsoft/vscode-python/issues/24151 --- python_files/create_venv.py | 14 +++++++++++--- python_files/tests/test_create_venv.py | 15 ++++++++++++++- 2 files changed, 25 insertions(+), 4 deletions(-) diff --git a/python_files/create_venv.py b/python_files/create_venv.py index 020c119fc1d5..fd1ff9ab1a47 100644 --- a/python_files/create_venv.py +++ b/python_files/create_venv.py @@ -78,6 +78,10 @@ def file_exists(path: Union[str, pathlib.PurePath]) -> bool: return pathlib.Path(path).exists() +def is_file(path: Union[str, pathlib.PurePath]) -> bool: + return pathlib.Path(path).is_file() + + def venv_exists(name: str) -> bool: return ( (CWD / name).exists() @@ -134,11 +138,15 @@ def upgrade_pip(venv_path: str) -> None: print("CREATE_VENV.UPGRADED_PIP") +def create_gitignore(git_ignore: Union[str, pathlib.PurePath]): + print("Creating:", os.fspath(git_ignore)) + pathlib.Path(git_ignore).write_text("*") + + def add_gitignore(name: str) -> None: git_ignore = CWD / name / ".gitignore" - if git_ignore.is_file(): - print("Creating:", os.fspath(git_ignore)) - git_ignore.write_text("*") + if not is_file(git_ignore): + create_gitignore(git_ignore) def download_pip_pyz(name: str): diff --git a/python_files/tests/test_create_venv.py b/python_files/tests/test_create_venv.py index 2387f099140f..72fabdaaecac 100644 --- a/python_files/tests/test_create_venv.py +++ b/python_files/tests/test_create_venv.py @@ -51,13 +51,14 @@ def test_venv_not_installed_windows(): @pytest.mark.parametrize("env_exists", ["hasEnv", "noEnv"]) -@pytest.mark.parametrize("git_ignore", ["useGitIgnore", "skipGitIgnore"]) +@pytest.mark.parametrize("git_ignore", ["useGitIgnore", "skipGitIgnore", "gitIgnoreExists"]) @pytest.mark.parametrize("install", ["requirements", "toml", "skipInstall"]) def test_create_env(env_exists, git_ignore, install): importlib.reload(create_venv) create_venv.is_installed = lambda _x: True create_venv.venv_exists = lambda _n: env_exists == "hasEnv" create_venv.upgrade_pip = lambda _x: None + create_venv.is_file = lambda _x: git_ignore == "gitIgnoreExists" install_packages_called = False @@ -84,9 +85,19 @@ def run_process(args, error_message): def add_gitignore(_name): nonlocal add_gitignore_called add_gitignore_called = True + if not create_venv.is_file(_name): + create_venv.create_gitignore(_name) create_venv.add_gitignore = add_gitignore + create_gitignore_called = False + + def create_gitignore(_p): + nonlocal create_gitignore_called + create_gitignore_called = True + + create_venv.create_gitignore = create_gitignore + args = [] if git_ignore == "useGitIgnore": args += ["--git-ignore"] @@ -104,6 +115,8 @@ def add_gitignore(_name): # add_gitignore is called when new venv is created and git_ignore is True assert add_gitignore_called == ((env_exists == "noEnv") and (git_ignore == "useGitIgnore")) + assert create_gitignore_called == (add_gitignore_called and (git_ignore != "gitIgnoreExists")) + @pytest.mark.parametrize("install_type", ["requirements", "pyproject", "both"]) def test_install_packages(install_type): From f7e0857546c61c438ae85a61f517625a8245232c Mon Sep 17 00:00:00 2001 From: Vishrut Sharma Date: Mon, 23 Sep 2024 13:48:16 -0700 Subject: [PATCH 102/149] Remove redundant @typescript-eslint/no-explicit-any suppression (#24091) Removed redundant @typescript-eslint/no-explicit-any suppression. Resolves https://github.com/microsoft/vscode-python/issues/24076 --- src/client/common/types.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/client/common/types.ts b/src/client/common/types.ts index 035e6ec4638b..71813c71904e 100644 --- a/src/client/common/types.ts +++ b/src/client/common/types.ts @@ -24,7 +24,6 @@ import { EnvironmentVariables } from './variables/types'; import { ITestingSettings } from '../testing/configuration/types'; export interface IDisposable { - // eslint-disable-next-line @typescript-eslint/no-explicit-any dispose(): void | undefined | Promise; } From 06a976fc45f75f9478cab1e0a96351dbdff8cae2 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Mon, 23 Sep 2024 18:10:12 -0400 Subject: [PATCH 103/149] Tests for PYTHONSTARTUP setting (#24145) Adding test for: https://github.com/microsoft/vscode-python/pull/24111 --- .../terminals/codeExecution/smartSend.test.ts | 3 + .../shellIntegration/pythonStartup.test.ts | 125 ++++++++++++++++++ 2 files changed, 128 insertions(+) create mode 100644 src/test/terminals/shellIntegration/pythonStartup.test.ts diff --git a/src/test/terminals/codeExecution/smartSend.test.ts b/src/test/terminals/codeExecution/smartSend.test.ts index f315bc004d4e..05c45f00f60f 100644 --- a/src/test/terminals/codeExecution/smartSend.test.ts +++ b/src/test/terminals/codeExecution/smartSend.test.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + import * as TypeMoq from 'typemoq'; import * as path from 'path'; import { TextEditor, Selection, Position, TextDocument, Uri } from 'vscode'; diff --git a/src/test/terminals/shellIntegration/pythonStartup.test.ts b/src/test/terminals/shellIntegration/pythonStartup.test.ts new file mode 100644 index 000000000000..41388fc331c8 --- /dev/null +++ b/src/test/terminals/shellIntegration/pythonStartup.test.ts @@ -0,0 +1,125 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +import * as sinon from 'sinon'; +import * as TypeMoq from 'typemoq'; +import { GlobalEnvironmentVariableCollection, Uri, WorkspaceConfiguration } from 'vscode'; +import * as workspaceApis from '../../../client/common/vscodeApis/workspaceApis'; +import { registerPythonStartup } from '../../../client/terminals/pythonStartup'; +import { IExtensionContext } from '../../../client/common/types'; + +suite('Terminal - Shell Integration with PYTHONSTARTUP', () => { + let getConfigurationStub: sinon.SinonStub; + let pythonConfig: TypeMoq.IMock; + let editorConfig: TypeMoq.IMock; + let context: TypeMoq.IMock; + let createDirectoryStub: sinon.SinonStub; + let copyStub: sinon.SinonStub; + let globalEnvironmentVariableCollection: TypeMoq.IMock; + + setup(() => { + context = TypeMoq.Mock.ofType(); + globalEnvironmentVariableCollection = TypeMoq.Mock.ofType(); + + // Question: Why do we have to set up environmentVariableCollection and globalEnvironmentVariableCollection in this flip-flop way? + // Reference: /vscode-python/src/test/interpreters/activation/terminalEnvVarCollectionService.unit.test.ts + context.setup((c) => c.environmentVariableCollection).returns(() => globalEnvironmentVariableCollection.object); + context.setup((c) => c.storageUri).returns(() => Uri.parse('a')); + + globalEnvironmentVariableCollection + .setup((c) => c.replace(TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny())) + .returns(() => Promise.resolve()); + + globalEnvironmentVariableCollection.setup((c) => c.delete(TypeMoq.It.isAny())).returns(() => Promise.resolve()); + + getConfigurationStub = sinon.stub(workspaceApis, 'getConfiguration'); + createDirectoryStub = sinon.stub(workspaceApis, 'createDirectory'); + copyStub = sinon.stub(workspaceApis, 'copy'); + + pythonConfig = TypeMoq.Mock.ofType(); + editorConfig = TypeMoq.Mock.ofType(); + getConfigurationStub.callsFake((section: string) => { + if (section === 'python') { + return pythonConfig.object; + } + return editorConfig.object; + }); + + createDirectoryStub.callsFake((_) => Promise.resolve()); + copyStub.callsFake((_, __, ___) => Promise.resolve()); + }); + + teardown(() => { + sinon.restore(); + }); + + test('Verify createDirectory is called when shell integration is enabled', async () => { + pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => true); + + await registerPythonStartup(context.object); + + sinon.assert.calledOnce(createDirectoryStub); + }); + + test('Verify createDirectory is not called when shell integration is disabled', async () => { + pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => false); + + await registerPythonStartup(context.object); + + sinon.assert.notCalled(createDirectoryStub); + }); + + test('Verify copy is called when shell integration is enabled', async () => { + pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => true); + + await registerPythonStartup(context.object); + + sinon.assert.calledOnce(copyStub); + }); + + test('Verify copy is not called when shell integration is disabled', async () => { + pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => false); + + await registerPythonStartup(context.object); + + sinon.assert.notCalled(copyStub); + }); + + test('PYTHONSTARTUP is set when enableShellIntegration setting is true', async () => { + pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => true); + + await registerPythonStartup(context.object); + + globalEnvironmentVariableCollection.verify( + (c) => c.replace('PYTHONSTARTUP', TypeMoq.It.isAny(), TypeMoq.It.isAny()), + TypeMoq.Times.once(), + ); + }); + + test('environmentCollection should not remove PYTHONSTARTUP when enableShellIntegration setting is true', async () => { + pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => true); + + await registerPythonStartup(context.object); + + globalEnvironmentVariableCollection.verify((c) => c.delete('PYTHONSTARTUP'), TypeMoq.Times.never()); + }); + + test('PYTHONSTARTUP is not set when enableShellIntegration setting is false', async () => { + pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => false); + + await registerPythonStartup(context.object); + + globalEnvironmentVariableCollection.verify( + (c) => c.replace('PYTHONSTARTUP', TypeMoq.It.isAny(), TypeMoq.It.isAny()), + TypeMoq.Times.never(), + ); + }); + + test('PYTHONSTARTUP is deleted when enableShellIntegration setting is false', async () => { + pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => false); + + await registerPythonStartup(context.object); + + globalEnvironmentVariableCollection.verify((c) => c.delete('PYTHONSTARTUP'), TypeMoq.Times.once()); + }); +}); From 14e134e2520575c8462911c64c2aa029be0556e4 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 23 Sep 2024 15:36:56 -0700 Subject: [PATCH 104/149] Add separate enum for telemetry when running python manually. (#24157) --- src/client/telemetry/index.ts | 2 +- src/client/terminals/codeExecution/terminalReplWatcher.ts | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index fb1cb3a96be7..2e29cd72d66c 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -2313,7 +2313,7 @@ export interface IEventNamePropertyMapping { /** * Whether the user launched the Terminal REPL or Native REPL */ - replType: 'Terminal' | 'Native'; + replType: 'Terminal' | 'Native' | 'manualTerminal'; }; /** * Telemetry event sent if and when user configure tests command. This command can be trigerred from multiple places in the extension. (Command palette, prompt etc.) diff --git a/src/client/terminals/codeExecution/terminalReplWatcher.ts b/src/client/terminals/codeExecution/terminalReplWatcher.ts index dfe89ce1dc87..bab70cb2f654 100644 --- a/src/client/terminals/codeExecution/terminalReplWatcher.ts +++ b/src/client/terminals/codeExecution/terminalReplWatcher.ts @@ -5,14 +5,14 @@ import { EventName } from '../../telemetry/constants'; function checkREPLCommand(command: string): boolean { const lower = command.toLowerCase().trimStart(); - return lower.startsWith('python') || lower.startsWith('py'); + return lower.startsWith('python') || lower.startsWith('py '); } export function registerTriggerForTerminalREPL(disposables: Disposable[]): void { disposables.push( onDidStartTerminalShellExecution(async (e: TerminalShellExecutionStartEvent) => { if (e.execution.commandLine.isTrusted && checkREPLCommand(e.execution.commandLine.value)) { - sendTelemetryEvent(EventName.REPL, undefined, { replType: 'Terminal' }); + sendTelemetryEvent(EventName.REPL, undefined, { replType: 'manualTerminal' }); } }), ); From d879a0d718e58b5617cb1242df2c791c189fc17a Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Tue, 24 Sep 2024 00:15:41 -0400 Subject: [PATCH 105/149] Adjust PythonStartUp test for new setting value (#24165) Since setting name is changed: https://github.com/microsoft/vscode-python/pull/24153 Adjusting the test accordingly. --- .../shellIntegration/pythonStartup.test.ts | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/test/terminals/shellIntegration/pythonStartup.test.ts b/src/test/terminals/shellIntegration/pythonStartup.test.ts index 41388fc331c8..5d25c2563cf9 100644 --- a/src/test/terminals/shellIntegration/pythonStartup.test.ts +++ b/src/test/terminals/shellIntegration/pythonStartup.test.ts @@ -54,7 +54,7 @@ suite('Terminal - Shell Integration with PYTHONSTARTUP', () => { }); test('Verify createDirectory is called when shell integration is enabled', async () => { - pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => true); + pythonConfig.setup((p) => p.get('terminal.shellIntegration.enabled')).returns(() => true); await registerPythonStartup(context.object); @@ -62,7 +62,7 @@ suite('Terminal - Shell Integration with PYTHONSTARTUP', () => { }); test('Verify createDirectory is not called when shell integration is disabled', async () => { - pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => false); + pythonConfig.setup((p) => p.get('terminal.shellIntegration.enabled')).returns(() => false); await registerPythonStartup(context.object); @@ -70,7 +70,7 @@ suite('Terminal - Shell Integration with PYTHONSTARTUP', () => { }); test('Verify copy is called when shell integration is enabled', async () => { - pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => true); + pythonConfig.setup((p) => p.get('terminal.shellIntegration.enabled')).returns(() => true); await registerPythonStartup(context.object); @@ -78,7 +78,7 @@ suite('Terminal - Shell Integration with PYTHONSTARTUP', () => { }); test('Verify copy is not called when shell integration is disabled', async () => { - pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => false); + pythonConfig.setup((p) => p.get('terminal.shellIntegration.enabled')).returns(() => false); await registerPythonStartup(context.object); @@ -86,7 +86,7 @@ suite('Terminal - Shell Integration with PYTHONSTARTUP', () => { }); test('PYTHONSTARTUP is set when enableShellIntegration setting is true', async () => { - pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => true); + pythonConfig.setup((p) => p.get('terminal.shellIntegration.enabled')).returns(() => true); await registerPythonStartup(context.object); @@ -97,7 +97,7 @@ suite('Terminal - Shell Integration with PYTHONSTARTUP', () => { }); test('environmentCollection should not remove PYTHONSTARTUP when enableShellIntegration setting is true', async () => { - pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => true); + pythonConfig.setup((p) => p.get('terminal.shellIntegration.enabled')).returns(() => true); await registerPythonStartup(context.object); @@ -105,7 +105,7 @@ suite('Terminal - Shell Integration with PYTHONSTARTUP', () => { }); test('PYTHONSTARTUP is not set when enableShellIntegration setting is false', async () => { - pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => false); + pythonConfig.setup((p) => p.get('terminal.shellIntegration.enabled')).returns(() => false); await registerPythonStartup(context.object); @@ -116,7 +116,7 @@ suite('Terminal - Shell Integration with PYTHONSTARTUP', () => { }); test('PYTHONSTARTUP is deleted when enableShellIntegration setting is false', async () => { - pythonConfig.setup((p) => p.get('REPL.enableShellIntegration')).returns(() => false); + pythonConfig.setup((p) => p.get('terminal.shellIntegration.enabled')).returns(() => false); await registerPythonStartup(context.object); From dd76d4ffeb5279ae4d808435bbe4171b669e0ca4 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Tue, 24 Sep 2024 14:05:09 -0400 Subject: [PATCH 106/149] Change log level on pixi interpreter discovery to reduce confusion (#24164) Reference: https://github.com/microsoft/vscode-python/issues/23773 and https://github.com/microsoft/vscode-python/issues/23773#issuecomment-2364779903 It seems that pixi warnings may be confusing unnecessary confusion among folks who may not even intend to use pixi environment. Changing log level for clarity and further help diagnosing problems that may be unrelated to pixi. --- .../pythonEnvironments/common/environmentManagers/pixi.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/client/pythonEnvironments/common/environmentManagers/pixi.ts b/src/client/pythonEnvironments/common/environmentManagers/pixi.ts index d7baa4b53f6e..32db66932385 100644 --- a/src/client/pythonEnvironments/common/environmentManagers/pixi.ts +++ b/src/client/pythonEnvironments/common/environmentManagers/pixi.ts @@ -273,7 +273,7 @@ export async function getPixiEnvironmentFromInterpreter( // Find the pixi executable for the project pixi = pixi || (await Pixi.getPixi()); if (!pixi) { - traceWarn(`could not find a pixi interpreter for the interpreter at ${interpreterPath}`); + traceVerbose(`could not find a pixi interpreter for the interpreter at ${interpreterPath}`); return undefined; } From 30b7884c7b385013e0c116e845548ec6d2d5d912 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Tue, 24 Sep 2024 20:22:11 -0400 Subject: [PATCH 107/149] Fix) Python Shell Integration setting should have markdown description (#24187) Resolves: https://github.com/microsoft/vscode-python/issues/24186 Related: https://github.com/microsoft/vscode-python/issues/23930 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index eb197afee69b..d14cea0917ed 100644 --- a/package.json +++ b/package.json @@ -660,7 +660,7 @@ }, "python.terminal.shellIntegration.enabled": { "default": false, - "description": "%python.terminal.shellIntegration.enabled.description%", + "markdownDescription": "%python.terminal.shellIntegration.enabled.description%", "scope": "resource", "type": "boolean", "tags": [ From 710d3c80f2e0c18104bfb48ecdc37a4aa57d067d Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Wed, 25 Sep 2024 14:19:59 -0700 Subject: [PATCH 108/149] Remove branch coverage and refactor coverage.py methods for accessing (#24180) Removing branch coverage from the payload as the initial way it was being discovered / added was not documented / in the coverage.py API and therefore is not guaranteed to be stable. Removing for now with plans to add upstream and re-include in the extension here coverage PR: https://github.com/microsoft/vscode-python/pull/24118 --- .../tests/pytestadapter/test_coverage.py | 6 --- .../tests/unittestadapter/test_coverage.py | 6 --- python_files/unittestadapter/execution.py | 31 ++++++------- python_files/unittestadapter/pvsc_utils.py | 2 - python_files/vscode_pytest/__init__.py | 44 +++++-------------- .../vscode_pytest/run_pytest_script.py | 3 +- .../testController/common/resultResolver.ts | 18 +------- .../testing/testController/common/types.ts | 4 -- .../testing/common/testingAdapter.test.ts | 4 -- 9 files changed, 26 insertions(+), 92 deletions(-) diff --git a/python_files/tests/pytestadapter/test_coverage.py b/python_files/tests/pytestadapter/test_coverage.py index 31e2be24437e..5dd8a0323b24 100644 --- a/python_files/tests/pytestadapter/test_coverage.py +++ b/python_files/tests/pytestadapter/test_coverage.py @@ -42,9 +42,3 @@ def test_simple_pytest_coverage(): assert focal_function_coverage.get("lines_missed") is not None assert set(focal_function_coverage.get("lines_covered")) == {4, 5, 7, 9, 10, 11, 12, 13, 14, 17} assert set(focal_function_coverage.get("lines_missed")) == {18, 19, 6} - assert ( - focal_function_coverage.get("executed_branches") > 0 - ), "executed_branches are a number greater than 0." - assert ( - focal_function_coverage.get("total_branches") > 0 - ), "total_branches are a number greater than 0." diff --git a/python_files/tests/unittestadapter/test_coverage.py b/python_files/tests/unittestadapter/test_coverage.py index 0089e9ae5504..594aa764370e 100644 --- a/python_files/tests/unittestadapter/test_coverage.py +++ b/python_files/tests/unittestadapter/test_coverage.py @@ -49,9 +49,3 @@ def test_basic_coverage(): assert focal_function_coverage.get("lines_missed") is not None assert set(focal_function_coverage.get("lines_covered")) == {4, 5, 7, 9, 10, 11, 12, 13, 14} assert set(focal_function_coverage.get("lines_missed")) == {6} - assert ( - focal_function_coverage.get("executed_branches") > 0 - ), "executed_branches are a number greater than 0." - assert ( - focal_function_coverage.get("total_branches") > 0 - ), "total_branches are a number greater than 0." diff --git a/python_files/unittestadapter/execution.py b/python_files/unittestadapter/execution.py index 2c49182c8633..7884c80d84d9 100644 --- a/python_files/unittestadapter/execution.py +++ b/python_files/unittestadapter/execution.py @@ -10,7 +10,7 @@ import traceback import unittest from types import TracebackType -from typing import Dict, Iterator, List, Optional, Tuple, Type, Union +from typing import Dict, List, Optional, Set, Tuple, Type, Union # Adds the scripts directory to the PATH as a workaround for enabling shell for test execution. path_var_name = "PATH" if "PATH" in os.environ else "Path" @@ -375,31 +375,26 @@ def send_run_data(raw_data, test_run_pipe): ) if is_coverage_run: - from coverage.plugin import FileReporter - from coverage.report_core import get_analysis_to_report - from coverage.results import Analysis + import coverage if not cov: raise VSCodeUnittestError("Coverage is enabled but cov is not set") cov.stop() cov.save() - analysis_iterator: Iterator[Tuple[FileReporter, Analysis]] = get_analysis_to_report( - cov, None - ) - + cov.load() + file_set: Set[str] = cov.get_data().measured_files() file_coverage_map: Dict[str, FileCoverageInfo] = {} - for fr, analysis in analysis_iterator: - file_str: str = fr.filename - executed_branches = analysis.numbers.n_executed_branches - total_branches = analysis.numbers.n_branches - + for file in file_set: + analysis = cov.analysis2(file) + lines_executable = {int(line_no) for line_no in analysis[1]} + lines_missed = {int(line_no) for line_no in analysis[3]} + lines_covered = lines_executable - lines_missed file_info: FileCoverageInfo = { - "lines_covered": list(analysis.executed), # set - "lines_missed": list(analysis.missing), # set - "executed_branches": executed_branches, # int - "total_branches": total_branches, # int + "lines_covered": list(lines_covered), # list of int + "lines_missed": list(lines_missed), # list of int } - file_coverage_map[file_str] = file_info + file_coverage_map[file] = file_info + payload_cov: CoveragePayloadDict = CoveragePayloadDict( coverage=True, cwd=os.fspath(cwd), diff --git a/python_files/unittestadapter/pvsc_utils.py b/python_files/unittestadapter/pvsc_utils.py index 25088f0cb7a2..8246c580f3ad 100644 --- a/python_files/unittestadapter/pvsc_utils.py +++ b/python_files/unittestadapter/pvsc_utils.py @@ -84,8 +84,6 @@ class EOTPayloadDict(TypedDict): class FileCoverageInfo(TypedDict): lines_covered: List[int] lines_missed: List[int] - executed_branches: int - total_branches: int class CoveragePayloadDict(Dict): diff --git a/python_files/vscode_pytest/__init__.py b/python_files/vscode_pytest/__init__.py index 6f04c45f00e6..92a803190886 100644 --- a/python_files/vscode_pytest/__init__.py +++ b/python_files/vscode_pytest/__init__.py @@ -14,7 +14,6 @@ Any, Dict, Generator, - Iterator, Literal, TypedDict, ) @@ -66,8 +65,6 @@ def __init__(self, message): TEST_RUN_PIPE = os.getenv("TEST_RUN_PIPE") SYMLINK_PATH = None -INCLUDE_BRANCHES = False - def pytest_load_initial_conftests(early_config, parser, args): # noqa: ARG001 global TEST_RUN_PIPE @@ -84,10 +81,6 @@ def pytest_load_initial_conftests(early_config, parser, args): # noqa: ARG001 global IS_DISCOVERY IS_DISCOVERY = True - if "--cov-branch" in args: - global INCLUDE_BRANCHES - INCLUDE_BRANCHES = True - # check if --rootdir is in the args for arg in args: if "--rootdir=" in arg: @@ -366,8 +359,6 @@ def check_skipped_condition(item): class FileCoverageInfo(TypedDict): lines_covered: list[int] lines_missed: list[int] - executed_branches: int - total_branches: int def pytest_sessionfinish(session, exitstatus): @@ -435,41 +426,26 @@ def pytest_sessionfinish(session, exitstatus): ) # send end of transmission token - # send coverageee if enabled + # send coverage if enabled is_coverage_run = os.environ.get("COVERAGE_ENABLED") if is_coverage_run == "True": # load the report and build the json result to return import coverage - from coverage.report_core import get_analysis_to_report - - if TYPE_CHECKING: - from coverage.plugin import FileReporter - from coverage.results import Analysis cov = coverage.Coverage() cov.load() - analysis_iterator: Iterator[tuple[FileReporter, Analysis]] = get_analysis_to_report( - cov, None - ) - + file_set: set[str] = cov.get_data().measured_files() file_coverage_map: dict[str, FileCoverageInfo] = {} - for fr, analysis in analysis_iterator: - file_str: str = fr.filename - executed_branches = analysis.numbers.n_executed_branches - total_branches = analysis.numbers.n_branches - if not INCLUDE_BRANCHES: - print("coverage not run with branches") - # if covearge wasn't run with branches, set the total branches value to -1 to signal that it is not available - executed_branches = 0 - total_branches = -1 - + for file in file_set: + analysis = cov.analysis2(file) + lines_executable = {int(line_no) for line_no in analysis[1]} + lines_missed = {int(line_no) for line_no in analysis[3]} + lines_covered = lines_executable - lines_missed file_info: FileCoverageInfo = { - "lines_covered": list(analysis.executed), # set - "lines_missed": list(analysis.missing), # set - "executed_branches": executed_branches, # int - "total_branches": total_branches, # int + "lines_covered": list(lines_covered), # list of int + "lines_missed": list(lines_missed), # list of int } - file_coverage_map[file_str] = file_info + file_coverage_map[file] = file_info payload: CoveragePayloadDict = CoveragePayloadDict( coverage=True, diff --git a/python_files/vscode_pytest/run_pytest_script.py b/python_files/vscode_pytest/run_pytest_script.py index 9abe3fd6b86c..61a77c51a156 100644 --- a/python_files/vscode_pytest/run_pytest_script.py +++ b/python_files/vscode_pytest/run_pytest_script.py @@ -45,8 +45,7 @@ def run_pytest(args): coverage_enabled = True break if not coverage_enabled: - print("Coverage is enabled, adding branch coverage as an argument.") - args = [*args, "--cov=.", "--cov-branch"] + args = [*args, "--cov=."] run_test_ids_pipe = os.environ.get("RUN_TEST_IDS_PIPE") if run_test_ids_pipe: diff --git a/src/client/testing/testController/common/resultResolver.ts b/src/client/testing/testController/common/resultResolver.ts index 54a21a712133..0788c224b0cc 100644 --- a/src/client/testing/testController/common/resultResolver.ts +++ b/src/client/testing/testController/common/resultResolver.ts @@ -133,11 +133,6 @@ export class PythonResultResolver implements ITestResultResolver { } else { this._resolveExecution(payload as ExecutionTestPayload, runInstance); } - if ('coverage' in payload) { - // coverage data is sent once per connection - traceVerbose('Coverage data received.'); - this._resolveCoverage(payload as CoveragePayload, runInstance); - } } public _resolveCoverage(payload: CoveragePayload, runInstance: TestRun): void { @@ -149,22 +144,13 @@ export class PythonResultResolver implements ITestResultResolver { const fileCoverageMetrics = value; const linesCovered = fileCoverageMetrics.lines_covered ? fileCoverageMetrics.lines_covered : []; // undefined if no lines covered const linesMissed = fileCoverageMetrics.lines_missed ? fileCoverageMetrics.lines_missed : []; // undefined if no lines missed - const executedBranches = fileCoverageMetrics.executed_branches; - const totalBranches = fileCoverageMetrics.total_branches; const lineCoverageCount = new TestCoverageCount( linesCovered.length, linesCovered.length + linesMissed.length, ); const uri = Uri.file(fileNameStr); - let fileCoverage: FileCoverage; - if (totalBranches === -1) { - // branch coverage was not enabled and should not be displayed - fileCoverage = new FileCoverage(uri, lineCoverageCount); - } else { - const branchCoverageCount = new TestCoverageCount(executedBranches, totalBranches); - fileCoverage = new FileCoverage(uri, lineCoverageCount, branchCoverageCount); - } + const fileCoverage = new FileCoverage(uri, lineCoverageCount); runInstance.addCoverage(fileCoverage); // create detailed coverage array for each file (only line coverage on detailed, not branch) @@ -189,7 +175,7 @@ export class PythonResultResolver implements ITestResultResolver { detailedCoverageArray.push(statementCoverage); } - this.detailedCoverageMap.set(fileNameStr, detailedCoverageArray); + this.detailedCoverageMap.set(uri.fsPath, detailedCoverageArray); } } diff --git a/src/client/testing/testController/common/types.ts b/src/client/testing/testController/common/types.ts index 7846461a46a9..0942d9d2588c 100644 --- a/src/client/testing/testController/common/types.ts +++ b/src/client/testing/testController/common/types.ts @@ -279,10 +279,6 @@ export type FileCoverageMetrics = { lines_covered: number[]; // eslint-disable-next-line camelcase lines_missed: number[]; - // eslint-disable-next-line camelcase - executed_branches: number; - // eslint-disable-next-line camelcase - total_branches: number; }; export type ExecutionTestPayload = { diff --git a/src/test/testing/common/testingAdapter.test.ts b/src/test/testing/common/testingAdapter.test.ts index d0dd5b02d283..dcd45b2e56bc 100644 --- a/src/test/testing/common/testingAdapter.test.ts +++ b/src/test/testing/common/testingAdapter.test.ts @@ -768,8 +768,6 @@ suite('End to End Tests: test adapters', () => { // since only one test was run, the other test in the same file will have missed coverage lines assert.strictEqual(simpleFileCov.lines_covered.length, 3, 'Expected 1 line to be covered in even.py'); assert.strictEqual(simpleFileCov.lines_missed.length, 1, 'Expected 3 lines to be missed in even.py'); - assert.strictEqual(simpleFileCov.executed_branches, 1, 'Expected 3 lines to be missed in even.py'); - assert.strictEqual(simpleFileCov.total_branches, 2, 'Expected 3 lines to be missed in even.py'); return Promise.resolve(); }; @@ -823,8 +821,6 @@ suite('End to End Tests: test adapters', () => { // since only one test was run, the other test in the same file will have missed coverage lines assert.strictEqual(simpleFileCov.lines_covered.length, 3, 'Expected 1 line to be covered in even.py'); assert.strictEqual(simpleFileCov.lines_missed.length, 1, 'Expected 3 lines to be missed in even.py'); - assert.strictEqual(simpleFileCov.executed_branches, 1, 'Expected 3 lines to be missed in even.py'); - assert.strictEqual(simpleFileCov.total_branches, 2, 'Expected 3 lines to be missed in even.py'); return Promise.resolve(); }; From 9f6735e761f15f8f664754d4fdf46d58c3c5f1c5 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Thu, 26 Sep 2024 16:18:32 -0700 Subject: [PATCH 109/149] Prioritize `conda` handler over `pixi` handler (#24198) Related https://github.com/microsoft/vscode-python/issues/24087 --- .../common/process/pythonExecutionFactory.ts | 25 ++++++++++--------- .../pythonExecutionFactory.unit.test.ts | 7 ++++++ 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/src/client/common/process/pythonExecutionFactory.ts b/src/client/common/process/pythonExecutionFactory.ts index 939c91514952..d8401a603d03 100644 --- a/src/client/common/process/pythonExecutionFactory.ts +++ b/src/client/common/process/pythonExecutionFactory.ts @@ -80,16 +80,16 @@ export class PythonExecutionFactory implements IPythonExecutionFactory { } const processService: IProcessService = await this.processServiceFactory.create(options.resource); - const pixiExecutionService = await this.createPixiExecutionService(pythonPath, processService); - if (pixiExecutionService) { - return pixiExecutionService; - } - const condaExecutionService = await this.createCondaExecutionService(pythonPath, processService); if (condaExecutionService) { return condaExecutionService; } + const pixiExecutionService = await this.createPixiExecutionService(pythonPath, processService); + if (pixiExecutionService) { + return pixiExecutionService; + } + const windowsStoreInterpreterCheck = this.pyenvs.isMicrosoftStoreInterpreter.bind(this.pyenvs); const env = (await windowsStoreInterpreterCheck(pythonPath)) @@ -122,15 +122,16 @@ export class PythonExecutionFactory implements IPythonExecutionFactory { processService.on('exec', this.logger.logProcess.bind(this.logger)); this.disposables.push(processService); + const condaExecutionService = await this.createCondaExecutionService(pythonPath, processService); + if (condaExecutionService) { + return condaExecutionService; + } + const pixiExecutionService = await this.createPixiExecutionService(pythonPath, processService); if (pixiExecutionService) { return pixiExecutionService; } - const condaExecutionService = await this.createCondaExecutionService(pythonPath, processService); - if (condaExecutionService) { - return condaExecutionService; - } const env = createPythonEnv(pythonPath, processService, this.fileSystem); return createPythonService(processService, env); } @@ -161,11 +162,11 @@ export class PythonExecutionFactory implements IPythonExecutionFactory { } const env = await createPixiEnv(pixiEnvironment, processService, this.fileSystem); - if (!env) { - return undefined; + if (env) { + return createPythonService(processService, env); } - return createPythonService(processService, env); + return undefined; } } diff --git a/src/test/common/process/pythonExecutionFactory.unit.test.ts b/src/test/common/process/pythonExecutionFactory.unit.test.ts index e31a9e4d900e..dd0061b79d63 100644 --- a/src/test/common/process/pythonExecutionFactory.unit.test.ts +++ b/src/test/common/process/pythonExecutionFactory.unit.test.ts @@ -36,6 +36,7 @@ import { ServiceContainer } from '../../../client/ioc/container'; import { EnvironmentType, PythonEnvironment } from '../../../client/pythonEnvironments/info'; import { IInterpreterAutoSelectionService } from '../../../client/interpreter/autoSelection/types'; import { Conda, CONDA_RUN_VERSION } from '../../../client/pythonEnvironments/common/environmentManagers/conda'; +import * as pixi from '../../../client/pythonEnvironments/common/environmentManagers/pixi'; const pythonInterpreter: PythonEnvironment = { path: '/foo/bar/python.exe', @@ -87,10 +88,15 @@ suite('Process - PythonExecutionFactory', () => { let executionService: typemoq.IMock; let autoSelection: IInterpreterAutoSelectionService; let interpreterPathExpHelper: IInterpreterPathService; + let getPixiEnvironmentFromInterpreterStub: sinon.SinonStub; const pythonPath = 'path/to/python'; setup(() => { sinon.stub(Conda, 'getConda').resolves(new Conda('conda')); sinon.stub(Conda.prototype, 'getInterpreterPathForEnvironment').resolves(pythonPath); + + getPixiEnvironmentFromInterpreterStub = sinon.stub(pixi, 'getPixiEnvironmentFromInterpreter'); + getPixiEnvironmentFromInterpreterStub.resolves(undefined); + activationHelper = mock(EnvironmentActivationService); processFactory = mock(ProcessServiceFactory); configService = mock(ConfigurationService); @@ -336,6 +342,7 @@ suite('Process - PythonExecutionFactory', () => { } else { verify(pyenvs.getCondaEnvironment(interpreter!.path)).once(); } + expect(getPixiEnvironmentFromInterpreterStub.notCalled).to.be.equal(true); }); test('Ensure `createActivatedEnvironment` returns a PythonExecutionService instance if createCondaExecutionService() returns undefined', async () => { From 60bd5459c23b5342d8752d02fac6d566ae0de8f9 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 30 Sep 2024 14:49:51 -0700 Subject: [PATCH 110/149] Update version for 2024.16.0 release (#24212) --- package-lock.json | 16 ++++++++-------- package.json | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index f2034d927997..839f0c812e9a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "python", - "version": "2024.15.0-dev", + "version": "2024.16.0-rc", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "python", - "version": "2024.15.0-dev", + "version": "2024.16.0-rc", "license": "MIT", "dependencies": { "@iarna/toml": "^2.2.5", @@ -10987,9 +10987,9 @@ } }, "node_modules/path-to-regexp": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.2.2.tgz", - "integrity": "sha512-GQX3SSMokngb36+whdpRXE+3f9V8UzyAorlYvOGx87ufGHehNTn5lCxrKtLyZ4Yl/wEKnNnr98ZzOwwDZV5ogw==", + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.3.0.tgz", + "integrity": "sha512-Yhpw4T9C6hPpgPeA28us07OJeqZ5EzQTkbfwuhsUg0c237RomFoETJgmp2sa3F/41gfLE6G5cqcYwznmeEeOlQ==", "dev": true }, "node_modules/path-type": { @@ -23105,9 +23105,9 @@ "dev": true }, "path-to-regexp": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.2.2.tgz", - "integrity": "sha512-GQX3SSMokngb36+whdpRXE+3f9V8UzyAorlYvOGx87ufGHehNTn5lCxrKtLyZ4Yl/wEKnNnr98ZzOwwDZV5ogw==", + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.3.0.tgz", + "integrity": "sha512-Yhpw4T9C6hPpgPeA28us07OJeqZ5EzQTkbfwuhsUg0c237RomFoETJgmp2sa3F/41gfLE6G5cqcYwznmeEeOlQ==", "dev": true }, "path-type": { diff --git a/package.json b/package.json index d14cea0917ed..13ec2e5784b9 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "python", "displayName": "Python", "description": "Python language support with extension access points for IntelliSense (Pylance), Debugging (Python Debugger), linting, formatting, refactoring, unit tests, and more.", - "version": "2024.15.0-dev", + "version": "2024.16.0-rc", "featureFlags": { "usingNewInterpreterStorage": true }, From 23424cbc2cdf779b3f197dd8e93f8acf20b84e67 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 30 Sep 2024 15:54:16 -0700 Subject: [PATCH 111/149] Update version for pre-release (#24213) --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 839f0c812e9a..6c21df06a3e4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "python", - "version": "2024.16.0-rc", + "version": "2024.17.0-dev", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "python", - "version": "2024.16.0-rc", + "version": "2024.17.0-dev", "license": "MIT", "dependencies": { "@iarna/toml": "^2.2.5", diff --git a/package.json b/package.json index 13ec2e5784b9..7ffb5b3b8dce 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "python", "displayName": "Python", "description": "Python language support with extension access points for IntelliSense (Pylance), Debugging (Python Debugger), linting, formatting, refactoring, unit tests, and more.", - "version": "2024.16.0-rc", + "version": "2024.17.0-dev", "featureFlags": { "usingNewInterpreterStorage": true }, From 8bcf04648295cdecc845b1c3adb494a6c9319408 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 30 Sep 2024 22:47:07 -0700 Subject: [PATCH 112/149] Remove unnecessary file read on execution (#24196) Unused event that is not needed for file execution. --- .../codeExecution/codeExecutionManager.ts | 17 +---------------- src/client/terminals/types.ts | 1 - .../codeExecutionManager.unit.test.ts | 5 ----- 3 files changed, 1 insertion(+), 22 deletions(-) diff --git a/src/client/terminals/codeExecution/codeExecutionManager.ts b/src/client/terminals/codeExecution/codeExecutionManager.ts index 061918b7a74a..ff665af1a07a 100644 --- a/src/client/terminals/codeExecution/codeExecutionManager.ts +++ b/src/client/terminals/codeExecution/codeExecutionManager.ts @@ -4,12 +4,11 @@ 'use strict'; import { inject, injectable } from 'inversify'; -import { Disposable, Event, EventEmitter, Uri } from 'vscode'; +import { Disposable, EventEmitter, Uri } from 'vscode'; import { ICommandManager, IDocumentManager } from '../../common/application/types'; import { Commands } from '../../common/constants'; import '../../common/extensions'; -import { IFileSystem } from '../../common/platform/types'; import { IDisposableRegistry, IConfigurationService, Resource } from '../../common/types'; import { noop } from '../../common/utils/misc'; import { IInterpreterService } from '../../interpreter/contracts'; @@ -30,15 +29,10 @@ export class CodeExecutionManager implements ICodeExecutionManager { @inject(ICommandManager) private commandManager: ICommandManager, @inject(IDocumentManager) private documentManager: IDocumentManager, @inject(IDisposableRegistry) private disposableRegistry: Disposable[], - @inject(IFileSystem) private fileSystem: IFileSystem, @inject(IConfigurationService) private readonly configSettings: IConfigurationService, @inject(IServiceContainer) private serviceContainer: IServiceContainer, ) {} - public get onExecutedCode(): Event { - return this.eventEmitter.event; - } - public registerCommands() { [Commands.Exec_In_Terminal, Commands.Exec_In_Terminal_Icon, Commands.Exec_In_Separate_Terminal].forEach( (cmd) => { @@ -127,15 +121,6 @@ export class CodeExecutionManager implements ICodeExecutionManager { fileToExecute = fileAfterSave; } - try { - const contents = await this.fileSystem.readFile(fileToExecute.fsPath); - this.eventEmitter.fire(contents); - } catch { - // Ignore any errors that occur for firing this event. It's only used - // for telemetry - noop(); - } - const executionService = this.serviceContainer.get(ICodeExecutionService, 'standard'); await executionService.executeFile(fileToExecute, options); } diff --git a/src/client/terminals/types.ts b/src/client/terminals/types.ts index ada3acd851a9..5fd129e8fe89 100644 --- a/src/client/terminals/types.ts +++ b/src/client/terminals/types.ts @@ -24,7 +24,6 @@ export interface ICodeExecutionHelper { export const ICodeExecutionManager = Symbol('ICodeExecutionManager'); export interface ICodeExecutionManager { - onExecutedCode: Event; registerCommands(): void; } diff --git a/src/test/terminals/codeExecution/codeExecutionManager.unit.test.ts b/src/test/terminals/codeExecution/codeExecutionManager.unit.test.ts index 29c310f6c724..be58ecbc8e6b 100644 --- a/src/test/terminals/codeExecution/codeExecutionManager.unit.test.ts +++ b/src/test/terminals/codeExecution/codeExecutionManager.unit.test.ts @@ -7,7 +7,6 @@ import { Disposable, TextDocument, TextEditor, Uri } from 'vscode'; import { ICommandManager, IDocumentManager, IWorkspaceService } from '../../../client/common/application/types'; import { Commands } from '../../../client/common/constants'; -import { IFileSystem } from '../../../client/common/platform/types'; import { IServiceContainer } from '../../../client/ioc/types'; import { CodeExecutionManager } from '../../../client/terminals/codeExecution/codeExecutionManager'; import { ICodeExecutionHelper, ICodeExecutionManager, ICodeExecutionService } from '../../../client/terminals/types'; @@ -24,12 +23,9 @@ suite('Terminal - Code Execution Manager', () => { let serviceContainer: TypeMoq.IMock; let documentManager: TypeMoq.IMock; let configService: TypeMoq.IMock; - let fileSystem: TypeMoq.IMock; let interpreterService: TypeMoq.IMock; let triggerCreateEnvironmentCheckNonBlockingStub: sinon.SinonStub; setup(() => { - fileSystem = TypeMoq.Mock.ofType(); - fileSystem.setup((f) => f.readFile(TypeMoq.It.isAny())).returns(() => Promise.resolve('')); workspace = TypeMoq.Mock.ofType(); workspace .setup((c) => c.onDidChangeWorkspaceFolders(TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny())) @@ -51,7 +47,6 @@ suite('Terminal - Code Execution Manager', () => { commandManager.object, documentManager.object, disposables, - fileSystem.object, configService.object, serviceContainer.object, ); From 7d01dc2f931cf42411d42a82e54e35ff2b7bf6af Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Wed, 2 Oct 2024 10:14:05 -0700 Subject: [PATCH 113/149] Use latest build of `pet` from `main` for pre-release (#24223) --- build/azure-pipeline.pre-release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build/azure-pipeline.pre-release.yml b/build/azure-pipeline.pre-release.yml index c6de846ee851..7a796e45a8ba 100644 --- a/build/azure-pipeline.pre-release.yml +++ b/build/azure-pipeline.pre-release.yml @@ -107,7 +107,7 @@ extends: buildType: 'specific' project: 'Monaco' definition: 591 - buildVersionToDownload: 'latestFromBranch' + buildVersionToDownload: 'latest' branchName: 'refs/heads/main' targetPath: '$(Build.SourcesDirectory)/python-env-tools/bin' artifactName: 'bin-$(vsceTarget)' From 3e7d8e17b3434e32cb2e7559099861f091c1900c Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Wed, 2 Oct 2024 15:34:28 -0700 Subject: [PATCH 114/149] support setting only `--cov-report` arg (#24225) fixes https://github.com/microsoft/vscode-python/issues/24168. We should support `--cov-report=` set without the need to set `--cov=` since the default (`--cov=.`) will work for many users --- .../tests/pytestadapter/test_coverage.py | 46 +++++++++++++++++++ .../vscode_pytest/run_pytest_script.py | 4 +- 2 files changed, 49 insertions(+), 1 deletion(-) diff --git a/python_files/tests/pytestadapter/test_coverage.py b/python_files/tests/pytestadapter/test_coverage.py index 5dd8a0323b24..d4e3669e2733 100644 --- a/python_files/tests/pytestadapter/test_coverage.py +++ b/python_files/tests/pytestadapter/test_coverage.py @@ -4,6 +4,8 @@ import pathlib import sys +import pytest + script_dir = pathlib.Path(__file__).parent.parent sys.path.append(os.fspath(script_dir)) @@ -42,3 +44,47 @@ def test_simple_pytest_coverage(): assert focal_function_coverage.get("lines_missed") is not None assert set(focal_function_coverage.get("lines_covered")) == {4, 5, 7, 9, 10, 11, 12, 13, 14, 17} assert set(focal_function_coverage.get("lines_missed")) == {18, 19, 6} + + +coverage_file_path = TEST_DATA_PATH / "coverage_gen" / "coverage.json" + + +@pytest.fixture +def cleanup_coverage_file(): + # delete the coverage file if it exists as part of test cleanup + yield + if os.path.exists(coverage_file_path): # noqa: PTH110 + os.remove(coverage_file_path) # noqa: PTH107 + + +def test_coverage_gen_report(cleanup_coverage_file): # noqa: ARG001 + """ + Test coverage payload is correct for simple pytest example. Output of coverage run is below. + + Name Stmts Miss Branch BrPart Cover + --------------------------------------------------- + __init__.py 0 0 0 0 100% + reverse.py 13 3 8 2 76% + test_reverse.py 11 0 0 0 100% + --------------------------------------------------- + TOTAL 24 3 8 2 84% + + """ + args = ["--cov-report=json"] + env_add = {"COVERAGE_ENABLED": "True"} + cov_folder_path = TEST_DATA_PATH / "coverage_gen" + actual = runner_with_cwd_env(args, cov_folder_path, env_add) + assert actual + coverage = actual[-1] + assert coverage + results = coverage["result"] + assert results + assert len(results) == 3 + focal_function_coverage = results.get(os.fspath(TEST_DATA_PATH / "coverage_gen" / "reverse.py")) + assert focal_function_coverage + assert focal_function_coverage.get("lines_covered") is not None + assert focal_function_coverage.get("lines_missed") is not None + assert set(focal_function_coverage.get("lines_covered")) == {4, 5, 7, 9, 10, 11, 12, 13, 14, 17} + assert set(focal_function_coverage.get("lines_missed")) == {18, 19, 6} + # assert that the coverage file was created at the right path + assert os.path.exists(coverage_file_path) # noqa: PTH110 diff --git a/python_files/vscode_pytest/run_pytest_script.py b/python_files/vscode_pytest/run_pytest_script.py index 61a77c51a156..1abfb8b27004 100644 --- a/python_files/vscode_pytest/run_pytest_script.py +++ b/python_files/vscode_pytest/run_pytest_script.py @@ -41,7 +41,9 @@ def run_pytest(args): if is_coverage_run == "True": # If coverage is enabled, check if the coverage plugin is already in the args, if so keep user args. for arg in args: - if "--cov" in arg: + # if '--cov' is an arg or if '--cov=' is in an arg (check to see if this arg is set to not override user intent) + if arg == "--cov" or "--cov=" in arg: + print("coverage already enabled with specific args") coverage_enabled = True break if not coverage_enabled: From d072503585939f000f382f803be49e2ed58d0c41 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Fri, 4 Oct 2024 01:29:22 +1000 Subject: [PATCH 115/149] Avoid prefixing with home when unnecessary (#24230) Fixes https://github.com/microsoft/vscode-python/issues/24133 --- .../base/locators/common/nativePythonFinder.ts | 5 ++++- .../base/locators/lowLevel/customVirtualEnvLocator.ts | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts index a05fcb8b4de4..55c5ed9f83a3 100644 --- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts +++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts @@ -422,7 +422,10 @@ function getCustomVirtualEnvDirs(): string[] { const venvFolders = getPythonSettingAndUntildify(VENVFOLDERS_SETTING_KEY) ?? []; const homeDir = getUserHomeDir(); if (homeDir) { - venvFolders.map((item) => path.join(homeDir, item)).forEach((d) => venvDirs.push(d)); + venvFolders + .map((item) => (item.startsWith(homeDir) ? item : path.join(homeDir, item))) + .forEach((d) => venvDirs.push(d)); + venvFolders.forEach((item) => venvDirs.push(untildify(item))); } return Array.from(new Set(venvDirs)); } diff --git a/src/client/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.ts b/src/client/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.ts index 4c6a05af4acc..6aa83bbc376b 100644 --- a/src/client/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.ts +++ b/src/client/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.ts @@ -41,7 +41,10 @@ async function getCustomVirtualEnvDirs(): Promise { const venvFolders = getPythonSetting(VENVFOLDERS_SETTING_KEY) ?? []; const homeDir = getUserHomeDir(); if (homeDir && (await pathExists(homeDir))) { - venvFolders.map((item) => path.join(homeDir, item)).forEach((d) => venvDirs.push(d)); + venvFolders + .map((item) => (item.startsWith(homeDir) ? item : path.join(homeDir, item))) + .forEach((d) => venvDirs.push(d)); + venvFolders.forEach((item) => venvDirs.push(untildify(item))); } return asyncFilter(uniq(venvDirs), pathExists); } From 4b37abd3185800bb35fb04cc8bdf9e47dfb7e0d0 Mon Sep 17 00:00:00 2001 From: Aaron Munger Date: Thu, 3 Oct 2024 14:17:28 -0700 Subject: [PATCH 116/149] prevent test.only (#24235) I almost checked in a change to disable all tests again. This will prevent that --- .eslintrc | 8 ++++++-- package-lock.json | 17 +++++++++++++++++ package.json | 5 ++--- 3 files changed, 25 insertions(+), 5 deletions(-) diff --git a/.eslintrc b/.eslintrc index 03bfab0d4710..6ddb988b21a6 100644 --- a/.eslintrc +++ b/.eslintrc @@ -5,7 +5,10 @@ "mocha": true }, "parser": "@typescript-eslint/parser", - "plugins": ["@typescript-eslint"], + "plugins": [ + "@typescript-eslint", + "no-only-tests" + ], "extends": [ "airbnb", "plugin:@typescript-eslint/recommended", @@ -97,6 +100,7 @@ } ], "operator-assignment": "off", - "strict": "off" + "strict": "off", + "no-only-tests/no-only-tests": ["error", { "block": ["test", "suite"], "focus": ["only"] }] } } diff --git a/package-lock.json b/package-lock.json index 6c21df06a3e4..492696acd558 100644 --- a/package-lock.json +++ b/package-lock.json @@ -79,6 +79,7 @@ "eslint-config-prettier": "^8.3.0", "eslint-plugin-import": "^2.29.1", "eslint-plugin-jsx-a11y": "^6.3.1", + "eslint-plugin-no-only-tests": "^3.3.0", "eslint-plugin-react": "^7.20.3", "eslint-plugin-react-hooks": "^4.0.0", "expose-loader": "^3.1.0", @@ -5708,6 +5709,16 @@ "node": "*" } }, + "node_modules/eslint-plugin-no-only-tests": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-no-only-tests/-/eslint-plugin-no-only-tests-3.3.0.tgz", + "integrity": "sha512-brcKcxGnISN2CcVhXJ/kEQlNa0MEfGRtwKtWA16SkqXHKitaKIMrfemJKLKX1YqDU5C/5JY3PvZXd5jEW04e0Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=5.0.0" + } + }, "node_modules/eslint-plugin-react": { "version": "7.29.4", "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.29.4.tgz", @@ -19233,6 +19244,12 @@ } } }, + "eslint-plugin-no-only-tests": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-no-only-tests/-/eslint-plugin-no-only-tests-3.3.0.tgz", + "integrity": "sha512-brcKcxGnISN2CcVhXJ/kEQlNa0MEfGRtwKtWA16SkqXHKitaKIMrfemJKLKX1YqDU5C/5JY3PvZXd5jEW04e0Q==", + "dev": true + }, "eslint-plugin-react": { "version": "7.29.4", "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.29.4.tgz", diff --git a/package.json b/package.json index 7ffb5b3b8dce..a8a45202367f 100644 --- a/package.json +++ b/package.json @@ -83,8 +83,7 @@ "browser": "./dist/extension.browser.js", "l10n": "./l10n", "contributes": { - "problemMatchers": - [ + "problemMatchers": [ { "name": "python", "owner": "python", @@ -98,7 +97,6 @@ }, { "regexp": "^\\s*(.*)\\s*$" - }, { "regexp": "^\\s*(.*Error.*)$", @@ -1640,6 +1638,7 @@ "eslint-config-prettier": "^8.3.0", "eslint-plugin-import": "^2.29.1", "eslint-plugin-jsx-a11y": "^6.3.1", + "eslint-plugin-no-only-tests": "^3.3.0", "eslint-plugin-react": "^7.20.3", "eslint-plugin-react-hooks": "^4.0.0", "expose-loader": "^3.1.0", From c60f0dd92cc691b1f6d4e95610a63d9b74bbe796 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 3 Oct 2024 14:22:47 -0700 Subject: [PATCH 117/149] Bump tomli from 2.0.1 to 2.0.2 (#24229) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Bumps [tomli](https://github.com/hukkin/tomli) from 2.0.1 to 2.0.2.
Changelog

Sourced from tomli's changelog.

2.0.2

  • Removed
    • Python 3.7 support
  • Improved
    • Make loads raise TypeError not AttributeError on bad input types that do not have the replace attribute. Improve error message when bytes is received.
  • Type annotations
    • Type annotate load input as typing.IO[bytes] (previously typing.BinaryIO).
Commits
  • 3ec6775 Bump version: 2.0.1 → 2.0.2
  • 1dcd317 Add v2.0.2 changelog
  • c94ee69 Fix GitHub Actions badge
  • 4e245a4 tomli.loads: Raise TypeError not AttributeError. Improve message (#229)
  • facdab0 Update pre-commit. Remove docformatter
  • a613867 Use sys.version_info in compatibility layer (#220)
  • 39eff9b Add support for Python 3.12, drop EOL 3.7 (#224)
  • 0054e60 [pre-commit.ci] pre-commit autoupdate (#208)
  • 1bd3345 Test against Python 3.12-dev
  • 5646e69 Type annotate as IO[bytes], not BinaryIO
  • Additional commits viewable in compare view

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=tomli&package-manager=pip&previous-version=2.0.1&new-version=2.0.2)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) ---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/requirements.txt b/requirements.txt index e17a6a86b979..c523507dea32 100644 --- a/requirements.txt +++ b/requirements.txt @@ -16,9 +16,9 @@ packaging==24.1 \ --hash=sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002 \ --hash=sha256:5b8f2217dbdbd2f7f384c41c628544e6d52f2d0f53c6d0c3ea61aa5d1d7ff124 # via -r requirements.in -tomli==2.0.1 \ - --hash=sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc \ - --hash=sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f +tomli==2.0.2 \ + --hash=sha256:2ebe24485c53d303f690b0ec092806a085f07af5a5aa1464f3931eec36caaa38 \ + --hash=sha256:d46d457a85337051c36524bc5349dd91b1877838e2979ac5ced3e710ed8a60ed # via -r requirements.in typing-extensions==4.12.2 \ --hash=sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d \ From 3362dc366cedc38656d1ce844e857b2ca4a73ae6 Mon Sep 17 00:00:00 2001 From: Aaron Munger Date: Thu, 3 Oct 2024 14:45:11 -0700 Subject: [PATCH 118/149] enable turning off the variable provider (#24231) along with https://github.com/microsoft/vscode/pull/230349 let people disable the feature in case it causes perf issues --- package.json | 6 ++ package.nls.json | 1 + .../repl/variables/variablesProvider.ts | 17 +++++- src/test/repl/variableProvider.test.ts | 61 ++++++++++++++++++- 4 files changed, 82 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index a8a45202367f..1e43143f3c03 100644 --- a/package.json +++ b/package.json @@ -680,6 +680,12 @@ "experimental" ] }, + "python.REPL.provideVariables": { + "default": true, + "description": "%python.REPL.provideVariables.description%", + "scope": "resource", + "type": "boolean" + }, "python.testing.autoTestDiscoverOnSaveEnabled": { "default": true, "description": "%python.testing.autoTestDiscoverOnSaveEnabled.description%", diff --git a/package.nls.json b/package.nls.json index c92e21be5b61..8909a3f4c5b9 100644 --- a/package.nls.json +++ b/package.nls.json @@ -65,6 +65,7 @@ "python.pixiToolPath.description": "Path to the pixi executable.", "python.EnableREPLSmartSend.description": "Toggle Smart Send for the Python REPL. Smart Send enables sending the smallest runnable block of code to the REPL on Shift+Enter and moves the cursor accordingly.", "python.REPL.sendToNativeREPL.description": "Toggle to send code to Python REPL instead of the terminal on execution. Turning this on will change the behavior for both Smart Send and Run Selection/Line in the Context Menu.", + "python.REPL.provideVariables.description": "Toggle to provide variables for the REPL variable view for the native REPL.", "python.tensorBoard.logDirectory.description": "Set this setting to your preferred TensorBoard log directory to skip log directory prompt when starting TensorBoard.", "python.tensorBoard.logDirectory.markdownDeprecationMessage": "Tensorboard support has been moved to the extension [Tensorboard extension](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.tensorboard). Instead use the setting `tensorBoard.logDirectory`.", "python.tensorBoard.logDirectory.deprecationMessage": "Tensorboard support has been moved to the extension Tensorboard extension. Instead use the setting `tensorBoard.logDirectory`.", diff --git a/src/client/repl/variables/variablesProvider.ts b/src/client/repl/variables/variablesProvider.ts index ffb7c221d00c..f033451dc80e 100644 --- a/src/client/repl/variables/variablesProvider.ts +++ b/src/client/repl/variables/variablesProvider.ts @@ -10,10 +10,12 @@ import { EventEmitter, Event, NotebookVariableProvider, + Uri, } from 'vscode'; import { VariableResultCache } from './variableResultCache'; import { IVariableDescription } from './types'; import { VariableRequester } from './variableRequester'; +import { getConfiguration } from '../../common/vscodeApis/workspaceApis'; export class VariablesProvider implements NotebookVariableProvider { private readonly variableResultCache = new VariableResultCache(); @@ -36,7 +38,9 @@ export class VariablesProvider implements NotebookVariableProvider { const notebook = this.getNotebookDocument(); if (notebook) { this.executionCount += 1; - this._onDidChangeVariables.fire(notebook); + if (isEnabled(notebook.uri)) { + this._onDidChangeVariables.fire(notebook); + } } } @@ -48,7 +52,12 @@ export class VariablesProvider implements NotebookVariableProvider { token: CancellationToken, ): AsyncIterable { const notebookDocument = this.getNotebookDocument(); - if (token.isCancellationRequested || !notebookDocument || notebookDocument !== notebook) { + if ( + !isEnabled(notebook.uri) || + token.isCancellationRequested || + !notebookDocument || + notebookDocument !== notebook + ) { return; } @@ -144,3 +153,7 @@ function getVariableResultCacheKey(uri: string, parent: Variable | undefined, st } return `${uri}:${parentKey}`; } + +function isEnabled(resource?: Uri) { + return getConfiguration('python', resource).get('REPL.provideVariables'); +} diff --git a/src/test/repl/variableProvider.test.ts b/src/test/repl/variableProvider.test.ts index 1b151d34c096..e401041e17d9 100644 --- a/src/test/repl/variableProvider.test.ts +++ b/src/test/repl/variableProvider.test.ts @@ -2,16 +2,29 @@ // Licensed under the MIT License. import { assert } from 'chai'; -import { NotebookDocument, CancellationTokenSource, VariablesResult, Variable, EventEmitter } from 'vscode'; +import sinon from 'sinon'; +import { + NotebookDocument, + CancellationTokenSource, + VariablesResult, + Variable, + EventEmitter, + ConfigurationScope, + WorkspaceConfiguration, +} from 'vscode'; import * as TypeMoq from 'typemoq'; import { IVariableDescription } from '../../client/repl/variables/types'; import { VariablesProvider } from '../../client/repl/variables/variablesProvider'; import { VariableRequester } from '../../client/repl/variables/variableRequester'; +import * as workspaceApis from '../../client/common/vscodeApis/workspaceApis'; suite('ReplVariablesProvider', () => { let provider: VariablesProvider; let varRequester: TypeMoq.IMock; let notebook: TypeMoq.IMock; + let getConfigurationStub: sinon.SinonStub; + let configMock: TypeMoq.IMock; + let enabled: boolean; const executionEventEmitter = new EventEmitter(); const cancellationToken = new CancellationTokenSource().token; @@ -68,9 +81,23 @@ suite('ReplVariablesProvider', () => { } setup(() => { + enabled = true; varRequester = TypeMoq.Mock.ofType(); notebook = TypeMoq.Mock.ofType(); provider = new VariablesProvider(varRequester.object, () => notebook.object, executionEventEmitter.event); + configMock = TypeMoq.Mock.ofType(); + configMock.setup((c) => c.get('REPL.provideVariables')).returns(() => enabled); + getConfigurationStub = sinon.stub(workspaceApis, 'getConfiguration'); + getConfigurationStub.callsFake((section?: string, _scope?: ConfigurationScope | null) => { + if (section === 'python') { + return configMock.object; + } + return undefined; + }); + }); + + teardown(() => { + sinon.restore(); }); test('provideVariables without parent should yield variables', async () => { @@ -84,6 +111,38 @@ suite('ReplVariablesProvider', () => { assert.equal(results[0].variable.expression, 'myObject'); }); + test('No variables are returned when variable provider is disabled', async () => { + enabled = false; + setVariablesForParent(undefined, [objectVariable]); + + const results = await provideVariables(undefined); + + assert.isEmpty(results); + }); + + test('No change event from provider when disabled', async () => { + enabled = false; + let eventFired = false; + provider.onDidChangeVariables(() => { + eventFired = true; + }); + + executionEventEmitter.fire(); + + assert.isFalse(eventFired, 'event should not have fired'); + }); + + test('Variables change event from provider should fire when execution happens', async () => { + let eventFired = false; + provider.onDidChangeVariables(() => { + eventFired = true; + }); + + executionEventEmitter.fire(); + + assert.isTrue(eventFired, 'event should have fired'); + }); + test('provideVariables with a parent should call get children correctly', async () => { const listVariableItems = [0, 1, 2].map(createListItem); setVariablesForParent(undefined, [objectVariable]); From 92762ca7d96ee864b81102bd1c3b022e2c9ab826 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Thu, 3 Oct 2024 14:57:57 -0700 Subject: [PATCH 119/149] remove EOT from testing communication (#24220) remove the need for the EOT in the communication design between the extension and the python subprocesses produced to run testing. --- python_files/tests/pytestadapter/helpers.py | 7 +--- python_files/unittestadapter/discovery.py | 5 --- .../unittestadapter/django_test_runner.py | 4 --- python_files/unittestadapter/execution.py | 26 +------------- python_files/unittestadapter/pvsc_utils.py | 9 +---- python_files/vscode_pytest/__init__.py | 13 +------ .../testController/common/resultResolver.ts | 31 +++-------------- .../testing/testController/common/types.ts | 18 ++-------- .../testing/testController/common/utils.ts | 22 ++++-------- .../pytest/pytestDiscoveryAdapter.ts | 20 ++++------- .../pytest/pytestExecutionAdapter.ts | 29 +++------------- .../unittest/testDiscoveryAdapter.ts | 23 ++++--------- .../unittest/testExecutionAdapter.ts | 23 +++---------- .../testController/payloadTestCases.ts | 13 ++----- .../pytestExecutionAdapter.unit.test.ts | 24 ++++--------- .../resultResolver.unit.test.ts | 34 ++++++------------- .../testCancellationRunAdapters.unit.test.ts | 22 ------------ .../testExecutionAdapter.unit.test.ts | 24 ++++--------- 18 files changed, 64 insertions(+), 283 deletions(-) diff --git a/python_files/tests/pytestadapter/helpers.py b/python_files/tests/pytestadapter/helpers.py index 991c7efbc60c..7972eedd0919 100644 --- a/python_files/tests/pytestadapter/helpers.py +++ b/python_files/tests/pytestadapter/helpers.py @@ -71,7 +71,6 @@ def process_data_received(data: str) -> List[Dict[str, Any]]: This function also: - Checks that the jsonrpc value is 2.0 - - Checks that the last JSON message contains the `eot` token. """ json_messages = [] remaining = data @@ -85,10 +84,7 @@ def process_data_received(data: str) -> List[Dict[str, Any]]: else: json_messages.append(json_data["params"]) - last_json = json_messages.pop(-1) - if "eot" not in last_json: - raise ValueError("Last JSON messages does not contain 'eot' as its last payload.") - return json_messages # return the list of json messages, only the params part without the EOT token + return json_messages # return the list of json messages def parse_rpc_message(data: str) -> Tuple[Dict[str, str], str]: @@ -96,7 +92,6 @@ def parse_rpc_message(data: str) -> Tuple[Dict[str, str], str]: A single rpc payload is in the format: content-length: #LEN# \r\ncontent-type: application/json\r\n\r\n{"jsonrpc": "2.0", "params": ENTIRE_DATA} - with EOT params: "params": {"command_type": "discovery", "eot": true} returns: json_data: A single rpc payload of JSON data from the server. diff --git a/python_files/unittestadapter/discovery.py b/python_files/unittestadapter/discovery.py index 660dda0b292c..ce8251218743 100644 --- a/python_files/unittestadapter/discovery.py +++ b/python_files/unittestadapter/discovery.py @@ -16,7 +16,6 @@ # If I use from utils then there will be an import error in test_discovery.py. from unittestadapter.pvsc_utils import ( # noqa: E402 DiscoveryPayloadDict, - EOTPayloadDict, VSCodeUnittestError, build_test_tree, parse_unittest_args, @@ -129,7 +128,6 @@ def discover_tests( # collect args for Django discovery runner. args = argv[index + 1 :] or [] django_discovery_runner(manage_py_path, args) - # eot payload sent within Django runner. except Exception as e: error_msg = f"Error configuring Django test runner: {e}" print(error_msg, file=sys.stderr) @@ -139,6 +137,3 @@ def discover_tests( payload = discover_tests(start_dir, pattern, top_level_dir) # Post this discovery payload. send_post_request(payload, test_run_pipe) - # Post EOT token. - eot_payload: EOTPayloadDict = {"command_type": "discovery", "eot": True} - send_post_request(eot_payload, test_run_pipe) diff --git a/python_files/unittestadapter/django_test_runner.py b/python_files/unittestadapter/django_test_runner.py index 4225e2c8fa65..c1cca7ac2780 100644 --- a/python_files/unittestadapter/django_test_runner.py +++ b/python_files/unittestadapter/django_test_runner.py @@ -13,7 +13,6 @@ from execution import UnittestTestResult # noqa: E402 from pvsc_utils import ( # noqa: E402 DiscoveryPayloadDict, - EOTPayloadDict, VSCodeUnittestError, build_test_tree, send_post_request, @@ -64,9 +63,6 @@ def run_tests(self, test_labels, **kwargs): # Send discovery payload. send_post_request(payload, test_run_pipe) - # Send EOT token. - eot_payload: EOTPayloadDict = {"command_type": "discovery", "eot": True} - send_post_request(eot_payload, test_run_pipe) return 0 # Skip actual test execution, return 0 as no tests were run. except Exception as e: error_msg = ( diff --git a/python_files/unittestadapter/execution.py b/python_files/unittestadapter/execution.py index 7884c80d84d9..644b233fc530 100644 --- a/python_files/unittestadapter/execution.py +++ b/python_files/unittestadapter/execution.py @@ -25,7 +25,6 @@ from unittestadapter.pvsc_utils import ( # noqa: E402 CoveragePayloadDict, - EOTPayloadDict, ExecutionPayloadDict, FileCoverageInfo, TestExecutionStatus, @@ -60,21 +59,6 @@ def startTest(self, test: unittest.TestCase): # noqa: N802 def stopTestRun(self): # noqa: N802 super().stopTestRun() - # After stopping the test run, send EOT - test_run_pipe = os.getenv("TEST_RUN_PIPE") - if os.getenv("MANAGE_PY_PATH"): - # only send this if it is a Django run - if not test_run_pipe: - print( - "UNITTEST ERROR: TEST_RUN_PIPE is not set at the time of unittest trying to send data. " - f"TEST_RUN_PIPE = {test_run_pipe}\n", - file=sys.stderr, - ) - raise VSCodeUnittestError( - "UNITTEST ERROR: TEST_RUN_PIPE is not set at the time of unittest trying to send data. " - ) - eot_payload: EOTPayloadDict = {"command_type": "execution", "eot": True} - send_post_request(eot_payload, test_run_pipe) def addError( # noqa: N802 self, @@ -269,15 +253,8 @@ def run_tests( return payload -def execute_eot_and_cleanup(): - eot_payload: EOTPayloadDict = {"command_type": "execution", "eot": True} - send_post_request(eot_payload, test_run_pipe) - if __socket: - __socket.close() - - __socket = None -atexit.register(execute_eot_and_cleanup) +atexit.register(lambda: __socket.close() if __socket else None) def send_run_data(raw_data, test_run_pipe): @@ -361,7 +338,6 @@ def send_run_data(raw_data, test_run_pipe): print("MANAGE_PY_PATH env var set, running Django test suite.") args = argv[index + 1 :] or [] django_execution_runner(manage_py_path, test_ids, args) - # the django run subprocesses sends the eot payload. else: # Perform regular unittest execution. payload = run_tests( diff --git a/python_files/unittestadapter/pvsc_utils.py b/python_files/unittestadapter/pvsc_utils.py index 8246c580f3ad..09e61ff40518 100644 --- a/python_files/unittestadapter/pvsc_utils.py +++ b/python_files/unittestadapter/pvsc_utils.py @@ -74,13 +74,6 @@ class ExecutionPayloadDict(TypedDict): error: NotRequired[str] -class EOTPayloadDict(TypedDict): - """A dictionary that is used to send a end of transmission post request to the server.""" - - command_type: Literal["discovery", "execution"] - eot: bool - - class FileCoverageInfo(TypedDict): lines_covered: List[int] lines_missed: List[int] @@ -314,7 +307,7 @@ def parse_unittest_args( def send_post_request( - payload: Union[ExecutionPayloadDict, DiscoveryPayloadDict, EOTPayloadDict, CoveragePayloadDict], + payload: Union[ExecutionPayloadDict, DiscoveryPayloadDict, CoveragePayloadDict], test_run_pipe: Optional[str], ): """ diff --git a/python_files/vscode_pytest/__init__.py b/python_files/vscode_pytest/__init__.py index 92a803190886..ca06bf174418 100644 --- a/python_files/vscode_pytest/__init__.py +++ b/python_files/vscode_pytest/__init__.py @@ -455,10 +455,6 @@ def pytest_sessionfinish(session, exitstatus): ) send_post_request(payload) - command_type = "discovery" if IS_DISCOVERY else "execution" - payload_eot: EOTPayloadDict = {"command_type": command_type, "eot": True} - send_post_request(payload_eot) - def build_test_tree(session: pytest.Session) -> TestNode: """Builds a tree made up of testing nodes from the pytest session. @@ -782,13 +778,6 @@ class CoveragePayloadDict(Dict): error: str | None # Currently unused need to check -class EOTPayloadDict(TypedDict): - """A dictionary that is used to send a end of transmission post request to the server.""" - - command_type: Literal["discovery", "execution"] - eot: bool - - def get_node_path(node: Any) -> pathlib.Path: """A function that returns the path of a node given the switch to pathlib.Path. @@ -873,7 +862,7 @@ def default(self, o): def send_post_request( - payload: ExecutionPayloadDict | DiscoveryPayloadDict | EOTPayloadDict | CoveragePayloadDict, + payload: ExecutionPayloadDict | DiscoveryPayloadDict | CoveragePayloadDict, cls_encoder=None, ): """ diff --git a/src/client/testing/testController/common/resultResolver.ts b/src/client/testing/testController/common/resultResolver.ts index 0788c224b0cc..d2b8fcaa24a5 100644 --- a/src/client/testing/testController/common/resultResolver.ts +++ b/src/client/testing/testController/common/resultResolver.ts @@ -17,13 +17,7 @@ import { Range, } from 'vscode'; import * as util from 'util'; -import { - CoveragePayload, - DiscoveredTestPayload, - EOTTestPayload, - ExecutionTestPayload, - ITestResultResolver, -} from './types'; +import { CoveragePayload, DiscoveredTestPayload, ExecutionTestPayload, ITestResultResolver } from './types'; import { TestProvider } from '../../types'; import { traceError, traceVerbose } from '../../../logging'; import { Testing } from '../../../common/utils/localize'; @@ -32,7 +26,6 @@ import { sendTelemetryEvent } from '../../../telemetry'; import { EventName } from '../../../telemetry/constants'; import { splitLines } from '../../../common/stringUtils'; import { buildErrorNodeOptions, populateTestTree, splitTestNameWithRegex } from './utils'; -import { Deferred } from '../../../common/utils/async'; export class PythonResultResolver implements ITestResultResolver { testController: TestController; @@ -58,14 +51,8 @@ export class PythonResultResolver implements ITestResultResolver { this.vsIdToRunId = new Map(); } - public resolveDiscovery( - payload: DiscoveredTestPayload | EOTTestPayload, - deferredTillEOT: Deferred, - token?: CancellationToken, - ): void { - if ('eot' in payload && payload.eot === true) { - deferredTillEOT.resolve(); - } else if (!payload) { + public resolveDiscovery(payload: DiscoveredTestPayload, token?: CancellationToken): void { + if (!payload) { // No test data is available } else { this._resolveDiscovery(payload as DiscoveredTestPayload, token); @@ -117,16 +104,8 @@ export class PythonResultResolver implements ITestResultResolver { }); } - public resolveExecution( - payload: ExecutionTestPayload | EOTTestPayload | CoveragePayload, - runInstance: TestRun, - deferredTillEOT: Deferred, - ): void { - if ('eot' in payload && payload.eot === true) { - // eot sent once per connection - traceVerbose('EOT received, resolving deferredTillServerClose'); - deferredTillEOT.resolve(); - } else if ('coverage' in payload) { + public resolveExecution(payload: ExecutionTestPayload | CoveragePayload, runInstance: TestRun): void { + if ('coverage' in payload) { // coverage data is sent once per connection traceVerbose('Coverage data received.'); this._resolveCoverage(payload as CoveragePayload, runInstance); diff --git a/src/client/testing/testController/common/types.ts b/src/client/testing/testController/common/types.ts index 0942d9d2588c..0de3ff8ad0c0 100644 --- a/src/client/testing/testController/common/types.ts +++ b/src/client/testing/testController/common/types.ts @@ -16,7 +16,6 @@ import { import { ITestDebugLauncher, TestDiscoveryOptions } from '../../common/types'; import { IPythonExecutionFactory } from '../../../common/process/types'; import { EnvironmentVariables } from '../../../common/variables/types'; -import { Deferred } from '../../../common/utils/async'; export type TestRunInstanceOptions = TestRunOptions & { exclude?: readonly TestItem[]; @@ -198,16 +197,8 @@ export interface ITestResultResolver { vsIdToRunId: Map; detailedCoverageMap: Map; - resolveDiscovery( - payload: DiscoveredTestPayload | EOTTestPayload, - deferredTillEOT: Deferred, - token?: CancellationToken, - ): void; - resolveExecution( - payload: ExecutionTestPayload | EOTTestPayload | CoveragePayload, - runInstance: TestRun, - deferredTillEOT: Deferred, - ): void; + resolveDiscovery(payload: DiscoveredTestPayload, token?: CancellationToken): void; + resolveExecution(payload: ExecutionTestPayload | CoveragePayload, runInstance: TestRun): void; _resolveDiscovery(payload: DiscoveredTestPayload, token?: CancellationToken): void; _resolveExecution(payload: ExecutionTestPayload, runInstance: TestRun): void; _resolveCoverage(payload: CoveragePayload, runInstance: TestRun): void; @@ -259,11 +250,6 @@ export type DiscoveredTestPayload = { error?: string[]; }; -export type EOTTestPayload = { - commandType: 'discovery' | 'execution'; - eot: boolean; -}; - export type CoveragePayload = { coverage: boolean; cwd: string; diff --git a/src/client/testing/testController/common/utils.ts b/src/client/testing/testController/common/utils.ts index cf82a2ebd1c1..d386d953b933 100644 --- a/src/client/testing/testController/common/utils.ts +++ b/src/client/testing/testController/common/utils.ts @@ -16,7 +16,6 @@ import { DiscoveredTestItem, DiscoveredTestNode, DiscoveredTestPayload, - EOTTestPayload, ExecutionTestPayload, ITestResultResolver, } from './types'; @@ -193,7 +192,7 @@ export async function startTestIdsNamedPipe(testIds: string[]): Promise } interface ExecutionResultMessage extends Message { - params: ExecutionTestPayload | EOTTestPayload; + params: ExecutionTestPayload; } /** @@ -227,7 +226,7 @@ export async function writeTestIdsFile(testIds: string[]): Promise { } export async function startRunResultNamedPipe( - dataReceivedCallback: (payload: ExecutionTestPayload | EOTTestPayload) => void, + dataReceivedCallback: (payload: ExecutionTestPayload) => void, deferredTillServerClose: Deferred, cancellationToken?: CancellationToken, ): Promise<{ name: string } & Disposable> { @@ -259,8 +258,7 @@ export async function startRunResultNamedPipe( }), reader.listen((data: Message) => { traceVerbose(`Test Result named pipe ${pipeName} received data`); - // if EOT, call decrement connection count (callback) - dataReceivedCallback((data as ExecutionResultMessage).params as ExecutionTestPayload | EOTTestPayload); + dataReceivedCallback((data as ExecutionResultMessage).params as ExecutionTestPayload); }), ); server.serverOnClosePromise().then(() => { @@ -275,11 +273,11 @@ export async function startRunResultNamedPipe( } interface DiscoveryResultMessage extends Message { - params: DiscoveredTestPayload | EOTTestPayload; + params: DiscoveredTestPayload; } export async function startDiscoveryNamedPipe( - callback: (payload: DiscoveredTestPayload | EOTTestPayload) => void, + callback: (payload: DiscoveredTestPayload) => void, cancellationToken?: CancellationToken, ): Promise<{ name: string } & Disposable> { traceVerbose('Starting Test Discovery named pipe'); @@ -302,10 +300,9 @@ export async function startDiscoveryNamedPipe( }), reader.listen((data: Message) => { traceVerbose(`Test Discovery named pipe ${pipeName} received data`); - callback((data as DiscoveryResultMessage).params as DiscoveredTestPayload | EOTTestPayload); + callback((data as DiscoveryResultMessage).params as DiscoveredTestPayload); }), reader.onClose(() => { - callback(createEOTPayload(true)); traceVerbose(`Test Discovery named pipe ${pipeName} closed`); dispose(); }), @@ -475,13 +472,6 @@ export function createDiscoveryErrorPayload( }; } -export function createEOTPayload(executionBool: boolean): EOTTestPayload { - return { - commandType: executionBool ? 'execution' : 'discovery', - eot: true, - } as EOTTestPayload; -} - /** * Splits a test name into its parent test name and subtest unique section. * diff --git a/src/client/testing/testController/pytest/pytestDiscoveryAdapter.ts b/src/client/testing/testController/pytest/pytestDiscoveryAdapter.ts index dd7bc9b21847..2162c1fe6e71 100644 --- a/src/client/testing/testController/pytest/pytestDiscoveryAdapter.ts +++ b/src/client/testing/testController/pytest/pytestDiscoveryAdapter.ts @@ -9,14 +9,13 @@ import { SpawnOptions, } from '../../../common/process/types'; import { IConfigurationService, ITestOutputChannel } from '../../../common/types'; -import { Deferred, createDeferred } from '../../../common/utils/async'; +import { Deferred } from '../../../common/utils/async'; import { EXTENSION_ROOT_DIR } from '../../../constants'; import { traceError, traceInfo, traceVerbose, traceWarn } from '../../../logging'; -import { DiscoveredTestPayload, EOTTestPayload, ITestDiscoveryAdapter, ITestResultResolver } from '../common/types'; +import { DiscoveredTestPayload, ITestDiscoveryAdapter, ITestResultResolver } from '../common/types'; import { MESSAGE_ON_TESTING_OUTPUT_MOVE, createDiscoveryErrorPayload, - createEOTPayload, createTestingDeferred, fixLogLinesNoTrailing, startDiscoveryNamedPipe, @@ -37,17 +36,13 @@ export class PytestTestDiscoveryAdapter implements ITestDiscoveryAdapter { ) {} async discoverTests(uri: Uri, executionFactory?: IPythonExecutionFactory): Promise { - const deferredTillEOT: Deferred = createDeferred(); - - const { name, dispose } = await startDiscoveryNamedPipe((data: DiscoveredTestPayload | EOTTestPayload) => { - this.resultResolver?.resolveDiscovery(data, deferredTillEOT); + const { name, dispose } = await startDiscoveryNamedPipe((data: DiscoveredTestPayload) => { + this.resultResolver?.resolveDiscovery(data); }); try { - await this.runPytestDiscovery(uri, name, deferredTillEOT, executionFactory); + await this.runPytestDiscovery(uri, name, executionFactory); } finally { - await deferredTillEOT.promise; - traceVerbose('deferredTill EOT resolved'); dispose(); } // this is only a placeholder to handle function overloading until rewrite is finished @@ -58,7 +53,6 @@ export class PytestTestDiscoveryAdapter implements ITestDiscoveryAdapter { async runPytestDiscovery( uri: Uri, discoveryPipeName: string, - deferredTillEOT: Deferred, executionFactory?: IPythonExecutionFactory, ): Promise { const relativePathToPytest = 'python_files'; @@ -143,10 +137,8 @@ export class PytestTestDiscoveryAdapter implements ITestDiscoveryAdapter { traceError( `Subprocess exited unsuccessfully with exit code ${code} and signal ${signal} on workspace ${uri.fsPath}. Creating and sending error discovery payload`, ); - this.resultResolver?.resolveDiscovery(createDiscoveryErrorPayload(code, signal, cwd), deferredTillEOT); - this.resultResolver?.resolveDiscovery(createEOTPayload(false), deferredTillEOT); + this.resultResolver?.resolveDiscovery(createDiscoveryErrorPayload(code, signal, cwd)); } - // deferredTillEOT is resolved when all data sent on stdout and stderr is received, close event is only called when this occurs // due to the sync reading of the output. deferredTillExecClose?.resolve(); }); diff --git a/src/client/testing/testController/pytest/pytestExecutionAdapter.ts b/src/client/testing/testController/pytest/pytestExecutionAdapter.ts index bfaaab9d6586..bcd97f450b58 100644 --- a/src/client/testing/testController/pytest/pytestExecutionAdapter.ts +++ b/src/client/testing/testController/pytest/pytestExecutionAdapter.ts @@ -7,13 +7,7 @@ import { ChildProcess } from 'child_process'; import { IConfigurationService, ITestOutputChannel } from '../../../common/types'; import { Deferred } from '../../../common/utils/async'; import { traceError, traceInfo, traceVerbose } from '../../../logging'; -import { - CoveragePayload, - EOTTestPayload, - ExecutionTestPayload, - ITestExecutionAdapter, - ITestResultResolver, -} from '../common/types'; +import { ExecutionTestPayload, ITestExecutionAdapter, ITestResultResolver } from '../common/types'; import { ExecutionFactoryCreateWithEnvironmentOptions, IPythonExecutionFactory, @@ -42,14 +36,12 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, ): Promise { - // deferredTillEOT awaits EOT message and deferredTillServerClose awaits named pipe server close - const deferredTillEOT: Deferred = utils.createTestingDeferred(); const deferredTillServerClose: Deferred = utils.createTestingDeferred(); // create callback to handle data received on the named pipe - const dataReceivedCallback = (data: ExecutionTestPayload | EOTTestPayload | CoveragePayload) => { + const dataReceivedCallback = (data: ExecutionTestPayload) => { if (runInstance && !runInstance.token.isCancellationRequested) { - this.resultResolver?.resolveExecution(data, runInstance, deferredTillEOT); + this.resultResolver?.resolveExecution(data, runInstance); } else { traceError(`No run instance found, cannot resolve execution, for workspace ${uri.fsPath}.`); } @@ -60,9 +52,8 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { runInstance?.token, // token to cancel ); runInstance?.token.onCancellationRequested(() => { - traceInfo(`Test run cancelled, resolving 'till EOT' deferred for ${uri.fsPath}.`); + traceInfo(`Test run cancelled, resolving 'TillServerClose' deferred for ${uri.fsPath}.`); // if canceled, stop listening for results - deferredTillEOT.resolve(); serverDispose(); // this will resolve deferredTillServerClose const executionPayload: ExecutionTestPayload = { @@ -78,7 +69,6 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { uri, testIds, name, - deferredTillEOT, serverDispose, runInstance, profileKind, @@ -86,8 +76,6 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { debugLauncher, ); } finally { - // wait for to send EOT - await deferredTillEOT.promise; await deferredTillServerClose.promise; } @@ -105,7 +93,6 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { uri: Uri, testIds: string[], resultNamedPipeName: string, - deferredTillEOT: Deferred, serverDispose: () => void, runInstance?: TestRun, profileKind?: TestRunProfileKind, @@ -178,7 +165,6 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { traceInfo(`Running DEBUG pytest with arguments: ${testArgs} for workspace ${uri.fsPath} \r\n`); await debugLauncher!.launchDebugger(launchOptions, () => { serverDispose(); // this will resolve deferredTillServerClose - deferredTillEOT?.resolve(); }); } else { // deferredTillExecClose is resolved when all stdout and stderr is read @@ -238,19 +224,12 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { this.resultResolver?.resolveExecution( utils.createExecutionErrorPayload(code, signal, testIds, cwd), runInstance, - deferredTillEOT, - ); - this.resultResolver?.resolveExecution( - utils.createEOTPayload(true), - runInstance, - deferredTillEOT, ); } // this doesn't work, it instead directs us to the noop one which is defined first // potentially this is due to the server already being close, if this is the case? serverDispose(); // this will resolve deferredTillServerClose } - // deferredTillEOT is resolved when all data sent on stdout and stderr is received, close event is only called when this occurs // due to the sync reading of the output. deferredTillExecClose.resolve(); }); diff --git a/src/client/testing/testController/unittest/testDiscoveryAdapter.ts b/src/client/testing/testController/unittest/testDiscoveryAdapter.ts index 8e6edcc16b56..b2047f96a01f 100644 --- a/src/client/testing/testController/unittest/testDiscoveryAdapter.ts +++ b/src/client/testing/testController/unittest/testDiscoveryAdapter.ts @@ -7,13 +7,12 @@ import { IConfigurationService, ITestOutputChannel } from '../../../common/types import { EXTENSION_ROOT_DIR } from '../../../constants'; import { DiscoveredTestPayload, - EOTTestPayload, ITestDiscoveryAdapter, ITestResultResolver, TestCommandOptions, TestDiscoveryCommand, } from '../common/types'; -import { Deferred, createDeferred } from '../../../common/utils/async'; +import { createDeferred } from '../../../common/utils/async'; import { EnvironmentVariables, IEnvironmentVariablesProvider } from '../../../common/variables/types'; import { ExecutionFactoryCreateWithEnvironmentOptions, @@ -24,11 +23,10 @@ import { import { MESSAGE_ON_TESTING_OUTPUT_MOVE, createDiscoveryErrorPayload, - createEOTPayload, fixLogLinesNoTrailing, startDiscoveryNamedPipe, } from '../common/utils'; -import { traceError, traceInfo, traceLog, traceVerbose } from '../../../logging'; +import { traceError, traceInfo, traceLog } from '../../../logging'; /** * Wrapper class for unittest test discovery. This is where we call `runTestCommand`. @@ -46,10 +44,8 @@ export class UnittestTestDiscoveryAdapter implements ITestDiscoveryAdapter { const { unittestArgs } = settings.testing; const cwd = settings.testing.cwd && settings.testing.cwd.length > 0 ? settings.testing.cwd : uri.fsPath; - const deferredTillEOT: Deferred = createDeferred(); - - const { name, dispose } = await startDiscoveryNamedPipe((data: DiscoveredTestPayload | EOTTestPayload) => { - this.resultResolver?.resolveDiscovery(data, deferredTillEOT); + const { name, dispose } = await startDiscoveryNamedPipe((data: DiscoveredTestPayload) => { + this.resultResolver?.resolveDiscovery(data); }); // set up env with the pipe name @@ -68,10 +64,8 @@ export class UnittestTestDiscoveryAdapter implements ITestDiscoveryAdapter { }; try { - await this.runDiscovery(uri, options, name, cwd, deferredTillEOT, executionFactory); + await this.runDiscovery(uri, options, name, cwd, executionFactory); } finally { - await deferredTillEOT.promise; - traceVerbose('deferredTill EOT resolved'); dispose(); } // placeholder until after the rewrite is adopted @@ -85,7 +79,6 @@ export class UnittestTestDiscoveryAdapter implements ITestDiscoveryAdapter { options: TestCommandOptions, testRunPipeName: string, cwd: string, - deferredTillEOT: Deferred, executionFactory?: IPythonExecutionFactory, ): Promise { // get and edit env vars @@ -146,11 +139,7 @@ export class UnittestTestDiscoveryAdapter implements ITestDiscoveryAdapter { traceError( `Subprocess exited unsuccessfully with exit code ${code} and signal ${signal} on workspace ${uri.fsPath}. Creating and sending error discovery payload`, ); - this.resultResolver?.resolveDiscovery( - createDiscoveryErrorPayload(code, signal, cwd), - deferredTillEOT, - ); - this.resultResolver?.resolveDiscovery(createEOTPayload(false), deferredTillEOT); + this.resultResolver?.resolveDiscovery(createDiscoveryErrorPayload(code, signal, cwd)); } deferredTillExecClose.resolve(); }); diff --git a/src/client/testing/testController/unittest/testExecutionAdapter.ts b/src/client/testing/testController/unittest/testExecutionAdapter.ts index 8e5277fe68d9..285f045f3e33 100644 --- a/src/client/testing/testController/unittest/testExecutionAdapter.ts +++ b/src/client/testing/testController/unittest/testExecutionAdapter.ts @@ -8,7 +8,6 @@ import { IConfigurationService, ITestOutputChannel } from '../../../common/types import { Deferred, createDeferred } from '../../../common/utils/async'; import { EXTENSION_ROOT_DIR } from '../../../constants'; import { - EOTTestPayload, ExecutionTestPayload, ITestExecutionAdapter, ITestResultResolver, @@ -48,14 +47,13 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, ): Promise { - // deferredTillEOT awaits EOT message and deferredTillServerClose awaits named pipe server close - const deferredTillEOT: Deferred = utils.createTestingDeferred(); + // deferredTillServerClose awaits named pipe server close const deferredTillServerClose: Deferred = utils.createTestingDeferred(); // create callback to handle data received on the named pipe - const dataReceivedCallback = (data: ExecutionTestPayload | EOTTestPayload) => { + const dataReceivedCallback = (data: ExecutionTestPayload) => { if (runInstance && !runInstance.token.isCancellationRequested) { - this.resultResolver?.resolveExecution(data, runInstance, deferredTillEOT); + this.resultResolver?.resolveExecution(data, runInstance); } else { traceError(`No run instance found, cannot resolve execution, for workspace ${uri.fsPath}.`); } @@ -66,10 +64,8 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { runInstance?.token, // token to cancel ); runInstance?.token.onCancellationRequested(() => { - console.log(`Test run cancelled, resolving 'till EOT' deferred for ${uri.fsPath}.`); + console.log(`Test run cancelled, resolving 'till TillAllServerClose' deferred for ${uri.fsPath}.`); // if canceled, stop listening for results - deferredTillEOT.resolve(); - // if canceled, close the server, resolves the deferredTillAllServerClose deferredTillServerClose.resolve(); serverDispose(); }); @@ -78,7 +74,6 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { uri, testIds, resultNamedPipeName, - deferredTillEOT, serverDispose, runInstance, profileKind, @@ -88,8 +83,6 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { } catch (error) { traceError(`Error in running unittest tests: ${error}`); } finally { - // wait for EOT - await deferredTillEOT.promise; await deferredTillServerClose.promise; } const executionPayload: ExecutionTestPayload = { @@ -104,7 +97,6 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { uri: Uri, testIds: string[], resultNamedPipeName: string, - deferredTillEOT: Deferred, serverDispose: () => void, runInstance?: TestRun, profileKind?: TestRunProfileKind, @@ -181,7 +173,6 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { } await debugLauncher.launchDebugger(launchOptions, () => { serverDispose(); // this will resolve the deferredTillAllServerClose - deferredTillEOT?.resolve(); }); } else { // This means it is running the test @@ -232,12 +223,6 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter { this.resultResolver?.resolveExecution( utils.createExecutionErrorPayload(code, signal, testIds, cwd), runInstance, - deferredTillEOT, - ); - this.resultResolver?.resolveExecution( - utils.createEOTPayload(true), - runInstance, - deferredTillEOT, ); } serverDispose(); diff --git a/src/test/testing/testController/payloadTestCases.ts b/src/test/testing/testController/payloadTestCases.ts index af33b46c5a36..7f2f5e23bfc3 100644 --- a/src/test/testing/testController/payloadTestCases.ts +++ b/src/test/testing/testController/payloadTestCases.ts @@ -3,12 +3,6 @@ export interface DataWithPayloadChunks { data: string; } -const EOT_PAYLOAD = `Content-Length: 42 -Content-Type: application/json -Request-uuid: fake-u-u-i-d - -{"command_type": "execution", "eot": true}`; - const SINGLE_UNITTEST_SUBTEST = { cwd: '/home/runner/work/vscode-python/vscode-python/path with spaces/src/testTestingRootWkspc/largeWorkspace', status: 'success', @@ -84,7 +78,7 @@ export function PAYLOAD_SINGLE_CHUNK(uuid: string): DataWithPayloadChunks { const payload = createPayload(uuid, SINGLE_UNITTEST_SUBTEST); return { - payloadArray: [payload, EOT_PAYLOAD], + payloadArray: [payload], data: JSON.stringify(SINGLE_UNITTEST_SUBTEST.result), }; } @@ -99,7 +93,7 @@ export function PAYLOAD_MULTI_CHUNK(uuid: string): DataWithPayloadChunks { result += JSON.stringify(SINGLE_UNITTEST_SUBTEST.result); } return { - payloadArray: [payload, EOT_PAYLOAD], + payloadArray: [payload], data: result, }; } @@ -116,7 +110,6 @@ export function PAYLOAD_ONLY_HEADER_MULTI_CHUNK(uuid: string): DataWithPayloadCh const payload2 = val.substring(firstSpaceIndex); payloadArray.push(payload1); payloadArray.push(payload2); - payloadArray.push(EOT_PAYLOAD); return { payloadArray, data: result, @@ -128,7 +121,6 @@ export function PAYLOAD_SPLIT_ACROSS_CHUNKS_ARRAY(uuid: string): DataWithPayload const payload = createPayload(uuid, SINGLE_PYTEST_PAYLOAD); const splitPayload = splitIntoRandomSubstrings(payload); const finalResult = JSON.stringify(SINGLE_PYTEST_PAYLOAD.result); - splitPayload.push(EOT_PAYLOAD); return { payloadArray: splitPayload, data: finalResult, @@ -143,7 +135,6 @@ export function PAYLOAD_SPLIT_MULTI_CHUNK_ARRAY(uuid: string): DataWithPayloadCh JSON.stringify(SINGLE_PYTEST_PAYLOAD_TWO.result), ); - splitPayload.push(EOT_PAYLOAD); return { payloadArray: splitPayload, data: finalResult, diff --git a/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts b/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts index 8ab701ad6f57..9e0f0d3d6302 100644 --- a/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts +++ b/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts @@ -243,19 +243,16 @@ suite('pytest test execution adapter', () => { }); test('Debug launched correctly for pytest', async () => { const deferred3 = createDeferred(); - const deferredEOT = createDeferred(); - utilsWriteTestIdsFileStub.callsFake(() => { - deferred3.resolve(); - return Promise.resolve('testIdPipe-mockName'); - }); + utilsWriteTestIdsFileStub.callsFake(() => Promise.resolve('testIdPipe-mockName')); debugLauncher .setup((dl) => dl.launchDebugger(typeMoq.It.isAny(), typeMoq.It.isAny())) - .returns(async () => { + .returns(async (_opts, callback) => { traceInfo('stubs launch debugger'); - deferredEOT.resolve(); + if (typeof callback === 'function') { + deferred3.resolve(); + callback(); + } }); - const utilsCreateEOTStub: sinon.SinonStub = sinon.stub(util, 'createTestingDeferred'); - utilsCreateEOTStub.callsFake(() => deferredEOT); const testRun = typeMoq.Mock.ofType(); testRun .setup((t) => t.token) @@ -268,14 +265,7 @@ suite('pytest test execution adapter', () => { const uri = Uri.file(myTestPath); const outputChannel = typeMoq.Mock.ofType(); adapter = new PytestTestExecutionAdapter(configService, outputChannel.object); - await adapter.runTests( - uri, - [], - TestRunProfileKind.Debug, - testRun.object, - execFactory.object, - debugLauncher.object, - ); + adapter.runTests(uri, [], TestRunProfileKind.Debug, testRun.object, execFactory.object, debugLauncher.object); await deferred3.promise; debugLauncher.verify( (x) => diff --git a/src/test/testing/testController/resultResolver.unit.test.ts b/src/test/testing/testController/resultResolver.unit.test.ts index 5ecf75987b3c..108edb45da7e 100644 --- a/src/test/testing/testController/resultResolver.unit.test.ts +++ b/src/test/testing/testController/resultResolver.unit.test.ts @@ -14,7 +14,6 @@ import { import * as testItemUtilities from '../../../client/testing/testController/common/testItemUtilities'; import * as ResultResolver from '../../../client/testing/testController/common/resultResolver'; import * as util from '../../../client/testing/testController/common/utils'; -import { Deferred, createDeferred } from '../../../client/common/utils/async'; import { traceLog } from '../../../client/logging'; suite('Result Resolver tests', () => { @@ -89,8 +88,7 @@ suite('Result Resolver tests', () => { const populateTestTreeStub = sinon.stub(util, 'populateTestTree').returns(); // call resolve discovery - const deferredTillEOT: Deferred = createDeferred(); - resultResolver.resolveDiscovery(payload, deferredTillEOT, cancelationToken); + resultResolver.resolveDiscovery(payload, cancelationToken); // assert the stub functions were called with the correct parameters @@ -129,8 +127,7 @@ suite('Result Resolver tests', () => { const createErrorTestItemStub = sinon.stub(testItemUtilities, 'createErrorTestItem').returns(blankTestItem); // call resolve discovery - const deferredTillEOT: Deferred = createDeferred(); - resultResolver.resolveDiscovery(payload, deferredTillEOT, cancelationToken); + resultResolver.resolveDiscovery(payload, cancelationToken); // assert the stub functions were called with the correct parameters @@ -175,8 +172,7 @@ suite('Result Resolver tests', () => { // stub out functionality of populateTestTreeStub which is called in resolveDiscovery const populateTestTreeStub = sinon.stub(util, 'populateTestTree').returns(); // call resolve discovery - const deferredTillEOT: Deferred = createDeferred(); - resultResolver.resolveDiscovery(payload, deferredTillEOT, cancelationToken); + resultResolver.resolveDiscovery(payload, cancelationToken); // assert the stub functions were called with the correct parameters @@ -239,10 +235,8 @@ suite('Result Resolver tests', () => { const deleteSpy = sinon.spy(testController.items, 'delete'); const replaceSpy = sinon.spy(testController.items, 'replace'); // call resolve discovery - let deferredTillEOT: Deferred = createDeferred(); - resultResolver.resolveDiscovery(regPayload, deferredTillEOT, cancelationToken); - deferredTillEOT = createDeferred(); - resultResolver.resolveDiscovery(errorPayload, deferredTillEOT, cancelationToken); + resultResolver.resolveDiscovery(regPayload, cancelationToken); + resultResolver.resolveDiscovery(errorPayload, cancelationToken); // assert the stub functions were called with the correct parameters @@ -375,8 +369,7 @@ suite('Result Resolver tests', () => { }; // call resolveExecution - const deferredTillEOT: Deferred = createDeferred(); - resultResolver.resolveExecution(successPayload, runInstance.object, deferredTillEOT); + resultResolver.resolveExecution(successPayload, runInstance.object); // verify that the passed function was called for the single test item assert.ok(generatedId); @@ -416,8 +409,7 @@ suite('Result Resolver tests', () => { }; // call resolveExecution - const deferredTillEOT: Deferred = createDeferred(); - resultResolver.resolveExecution(successPayload, runInstance.object, deferredTillEOT); + resultResolver.resolveExecution(successPayload, runInstance.object); // verify that the passed function was called for the single test item runInstance.verify((r) => r.failed(typemoq.It.isAny(), typemoq.It.isAny()), typemoq.Times.once()); @@ -456,8 +448,7 @@ suite('Result Resolver tests', () => { }; // call resolveExecution - const deferredTillEOT: Deferred = createDeferred(); - resultResolver.resolveExecution(successPayload, runInstance.object, deferredTillEOT); + resultResolver.resolveExecution(successPayload, runInstance.object); // verify that the passed function was called for the single test item runInstance.verify((r) => r.skipped(typemoq.It.isAny()), typemoq.Times.once()); @@ -496,8 +487,7 @@ suite('Result Resolver tests', () => { }; // call resolveExecution - const deferredTillEOT: Deferred = createDeferred(); - resultResolver.resolveExecution(successPayload, runInstance.object, deferredTillEOT); + resultResolver.resolveExecution(successPayload, runInstance.object); // verify that the passed function was called for the single test item runInstance.verify((r) => r.errored(typemoq.It.isAny(), typemoq.It.isAny()), typemoq.Times.once()); @@ -536,8 +526,7 @@ suite('Result Resolver tests', () => { }; // call resolveExecution - const deferredTillEOT: Deferred = createDeferred(); - resultResolver.resolveExecution(successPayload, runInstance.object, deferredTillEOT); + resultResolver.resolveExecution(successPayload, runInstance.object); // verify that the passed function was called for the single test item runInstance.verify((r) => r.passed(typemoq.It.isAny()), typemoq.Times.once()); @@ -558,8 +547,7 @@ suite('Result Resolver tests', () => { error: 'error', }; - const deferredTillEOT: Deferred = createDeferred(); - resultResolver.resolveExecution(errorPayload, runInstance.object, deferredTillEOT); + resultResolver.resolveExecution(errorPayload, runInstance.object); // verify that none of these functions are called diff --git a/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts b/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts index 41f2fe257681..96f15f0b91f7 100644 --- a/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts +++ b/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts @@ -110,17 +110,6 @@ suite('Execution Flow Run Adapters', () => { } }); - // mock EOT token & ExecClose token - const deferredEOT = createDeferred(); - const deferredExecClose = createDeferred(); - const utilsCreateEOTStub: sinon.SinonStub = sinon.stub(util, 'createTestingDeferred'); - utilsCreateEOTStub.callsFake(() => { - if (utilsCreateEOTStub.callCount === 1) { - return deferredEOT; - } - return deferredExecClose; - }); - // define adapter and run tests const testAdapter = createAdapter(adapter, configService, typeMoq.Mock.ofType().object); await testAdapter.runTests( @@ -191,17 +180,6 @@ suite('Execution Flow Run Adapters', () => { } }); - // mock EOT token & ExecClose token - const deferredEOT = createDeferred(); - const deferredExecClose = createDeferred(); - const utilsCreateEOTStub: sinon.SinonStub = sinon.stub(util, 'createTestingDeferred'); - utilsCreateEOTStub.callsFake(() => { - if (utilsCreateEOTStub.callCount === 1) { - return deferredEOT; - } - return deferredExecClose; - }); - // debugLauncher mocked debugLauncher .setup((dl) => dl.launchDebugger(typeMoq.It.isAny(), typeMoq.It.isAny())) diff --git a/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts b/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts index 88292c2254d8..d763cbcdff92 100644 --- a/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts +++ b/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts @@ -242,19 +242,16 @@ suite('Unittest test execution adapter', () => { }); test('Debug launched correctly for unittest', async () => { const deferred3 = createDeferred(); - const deferredEOT = createDeferred(); - utilsWriteTestIdsFileStub.callsFake(() => { - deferred3.resolve(); - return Promise.resolve('testIdPipe-mockName'); - }); + utilsWriteTestIdsFileStub.callsFake(() => Promise.resolve('testIdPipe-mockName')); debugLauncher .setup((dl) => dl.launchDebugger(typeMoq.It.isAny(), typeMoq.It.isAny())) - .returns(async () => { + .returns(async (_opts, callback) => { traceInfo('stubs launch debugger'); - deferredEOT.resolve(); + if (typeof callback === 'function') { + deferred3.resolve(); + callback(); + } }); - const utilsCreateEOTStub: sinon.SinonStub = sinon.stub(util, 'createTestingDeferred'); - utilsCreateEOTStub.callsFake(() => deferredEOT); const testRun = typeMoq.Mock.ofType(); testRun .setup((t) => t.token) @@ -267,14 +264,7 @@ suite('Unittest test execution adapter', () => { const uri = Uri.file(myTestPath); const outputChannel = typeMoq.Mock.ofType(); adapter = new UnittestTestExecutionAdapter(configService, outputChannel.object); - await adapter.runTests( - uri, - [], - TestRunProfileKind.Debug, - testRun.object, - execFactory.object, - debugLauncher.object, - ); + adapter.runTests(uri, [], TestRunProfileKind.Debug, testRun.object, execFactory.object, debugLauncher.object); await deferred3.promise; debugLauncher.verify( (x) => From b8c0fc42dd962a71d9d747601249280f8c771c0a Mon Sep 17 00:00:00 2001 From: Bill Schnurr Date: Thu, 3 Oct 2024 15:23:14 -0700 Subject: [PATCH 120/149] Update pylance.ts (#24237) add lsversion to language_server.crash event --- src/client/telemetry/pylance.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/client/telemetry/pylance.ts b/src/client/telemetry/pylance.ts index b03a3e23062c..8d04e4c607f7 100644 --- a/src/client/telemetry/pylance.ts +++ b/src/client/telemetry/pylance.ts @@ -400,6 +400,7 @@ */ /* __GDPR__ "language_server.crash" : { - "oom" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "rchiodo" } + "oom" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "rchiodo" }, + "lsversion" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "rchiodo" }, } */ From 1b36762ea24282ed230e4625fb91338e5044a7d5 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Thu, 3 Oct 2024 23:23:12 -0700 Subject: [PATCH 121/149] Remove notification for old linter formatter settings (#24240) Closes https://github.com/microsoft/vscode-python/issues/23679 --- src/client/extensionActivation.ts | 2 - src/client/logging/settingLogs.ts | 119 ------------------------------ 2 files changed, 121 deletions(-) delete mode 100644 src/client/logging/settingLogs.ts diff --git a/src/client/extensionActivation.ts b/src/client/extensionActivation.ts index 429004e951cb..a4da35c88b9b 100644 --- a/src/client/extensionActivation.ts +++ b/src/client/extensionActivation.ts @@ -49,7 +49,6 @@ import { IInterpreterQuickPick } from './interpreter/configuration/types'; import { registerAllCreateEnvironmentFeatures } from './pythonEnvironments/creation/registrations'; import { registerCreateEnvironmentTriggers } from './pythonEnvironments/creation/createEnvironmentTrigger'; import { initializePersistentStateForTriggers } from './common/persistentState'; -import { logAndNotifyOnLegacySettings } from './logging/settingLogs'; import { DebuggerTypeName } from './debugger/constants'; import { StopWatch } from './common/utils/stopWatch'; import { registerReplCommands, registerReplExecuteOnEnter, registerStartNativeReplCommand } from './repl/replCommands'; @@ -194,7 +193,6 @@ async function activateLegacy(ext: ExtensionState, startupStopWatch: StopWatch): }); disposables.push(terminalProvider); - logAndNotifyOnLegacySettings(); registerCreateEnvironmentTriggers(disposables); initializePersistentStateForTriggers(ext.context); } diff --git a/src/client/logging/settingLogs.ts b/src/client/logging/settingLogs.ts deleted file mode 100644 index 1243e544cae3..000000000000 --- a/src/client/logging/settingLogs.ts +++ /dev/null @@ -1,119 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. - -import { l10n } from 'vscode'; -import { traceError, traceInfo } from '.'; -import { Commands, PVSC_EXTENSION_ID } from '../common/constants'; -import { showWarningMessage } from '../common/vscodeApis/windowApis'; -import { getConfiguration, getWorkspaceFolders } from '../common/vscodeApis/workspaceApis'; -import { Common } from '../common/utils/localize'; -import { executeCommand } from '../common/vscodeApis/commandApis'; - -function logOnLegacyFormatterSetting(): boolean { - let usesLegacyFormatter = false; - getWorkspaceFolders()?.forEach(async (workspace) => { - let config = getConfiguration('editor', { uri: workspace.uri, languageId: 'python' }); - if (!config) { - config = getConfiguration('editor', workspace.uri); - if (!config) { - traceError('Unable to get editor configuration'); - } - } - const formatter = config.get('defaultFormatter', ''); - traceInfo(`Default formatter is set to ${formatter} for workspace ${workspace.uri.fsPath}`); - if (formatter === PVSC_EXTENSION_ID) { - usesLegacyFormatter = true; - traceError( - 'The setting "editor.defaultFormatter" for Python is set to "ms-python.python" which is deprecated.', - ); - traceError('Formatting features have been moved to separate formatter extensions.'); - traceError('See here for more information: https://code.visualstudio.com/docs/python/formatting'); - traceError('Please install the formatter extension you prefer and set it as the default formatter.'); - traceError('For `autopep8` use: https://marketplace.visualstudio.com/items?itemName=ms-python.autopep8'); - traceError( - 'For `black` use: https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter', - ); - traceError('For `yapf` use: https://marketplace.visualstudio.com/items?itemName=eeyore.yapf'); - } - }); - return usesLegacyFormatter; -} - -function logOnLegacyLinterSetting(): boolean { - let usesLegacyLinter = false; - getWorkspaceFolders()?.forEach(async (workspace) => { - let config = getConfiguration('python', { uri: workspace.uri, languageId: 'python' }); - if (!config) { - config = getConfiguration('python', workspace.uri); - if (!config) { - traceError('Unable to get editor configuration'); - } - } - - const linters: string[] = [ - 'pylint', - 'flake8', - 'mypy', - 'pydocstyle', - 'pylama', - 'pycodestyle', - 'bandit', - 'prospector', - ]; - - linters.forEach((linter) => { - const linterEnabled = config.get(`linting.${linter}Enabled`, false); - if (linterEnabled) { - usesLegacyLinter = true; - traceError(`Following setting is deprecated: "python.linting.${linter}Enabled"`); - traceError( - `All settings starting with "python.linting." are deprecated and can be removed from settings.`, - ); - traceError('Linting features have been moved to separate linter extensions.'); - traceError('See here for more information: https://code.visualstudio.com/docs/python/linting'); - if (linter === 'pylint' || linter === 'flake8') { - traceError( - `Please install "${linter}" extension: https://marketplace.visualstudio.com/items?itemName=ms-python.${linter}`, - ); - } else if (linter === 'mypy') { - traceError( - `Please install "${linter}" extension: https://marketplace.visualstudio.com/items?itemName=ms-python.mypy-type-checker`, - ); - } else if (['pydocstyle', 'pylama', 'pycodestyle', 'bandit'].includes(linter)) { - traceError( - `Selected linter "${linter}" may be supported by extensions like "Ruff", which include several linter rules: https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff`, - ); - } - } - }); - }); - - return usesLegacyLinter; -} - -let _isShown = false; -async function notifyLegacySettings(): Promise { - if (_isShown) { - return; - } - _isShown = true; - const response = await showWarningMessage( - l10n.t( - 'You have deprecated linting or formatting settings for Python. Please see the [logs](command:{0}) for more details.', - Commands.ViewOutput, - ), - Common.learnMore, - ); - if (response === Common.learnMore) { - executeCommand('vscode.open', 'https://aka.ms/AAlgvkb'); - } -} - -export function logAndNotifyOnLegacySettings(): void { - const usesLegacyFormatter = logOnLegacyFormatterSetting(); - const usesLegacyLinter = logOnLegacyLinterSetting(); - - if (usesLegacyFormatter || usesLegacyLinter) { - setImmediate(() => notifyLegacySettings().ignoreErrors()); - } -} From e5b47b96e2c2dc1e425e345201a69c8aaadcf47e Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Fri, 4 Oct 2024 10:17:08 -0700 Subject: [PATCH 122/149] Fix error with `displayName` is missing in PackageJSON (#24246) Closes https://github.com/microsoft/vscode-python/issues/24244 --- .../common/application/commands/reportIssueCommand.ts | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/client/common/application/commands/reportIssueCommand.ts b/src/client/common/application/commands/reportIssueCommand.ts index 2286bd1e6be2..f2b4f3ffc8c4 100644 --- a/src/client/common/application/commands/reportIssueCommand.ts +++ b/src/client/common/application/commands/reportIssueCommand.ts @@ -104,7 +104,12 @@ export class ReportIssueCommandHandler implements IExtensionSingleActivationServ const installedExtensions = getExtensions() .filter((extension) => !extension.id.startsWith('vscode.')) - .sort((a, b) => a.packageJSON.displayName.localeCompare(b.packageJSON.displayName)) + .sort((a, b) => { + if (a.packageJSON.displayName && b.packageJSON.displayName) { + return a.packageJSON.displayName.localeCompare(b.packageJSON.displayName); + } + return a.id.localeCompare(b.id); + }) .map( (extension) => `|${extension.packageJSON.displayName}|${extension.id}|${extension.packageJSON.version}|`, From 6bd34bf7942372b04ce77578f7308ee81aedcc7b Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Fri, 4 Oct 2024 10:20:39 -0700 Subject: [PATCH 123/149] Wait 0.5 second for shell integration event, otherwise fall back to sendtext. (#24248) For some reason, it seems like shell integration may take awhile to get activated: https://github.com/microsoft/vscode-python/issues/24239 Performance issue seemed to indicate exactly 3 second coming from the https://github.com/microsoft/vscode-python/pull/24078/files#diff-5290f3097d5f92e3495c8abfbe095dff83c3f8de3dcac08ab2d0304f71bb412fR93, so lets try reducing this to 0.5 second and let user fall back to sendText. We may need further investigate why onDidChangeTerminalShellIntegration may be taking awhile. --- src/client/common/terminal/service.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/client/common/terminal/service.ts b/src/client/common/terminal/service.ts index 09d75a42fa00..511135fa8b2f 100644 --- a/src/client/common/terminal/service.ts +++ b/src/client/common/terminal/service.ts @@ -91,7 +91,7 @@ export class TerminalService implements ITerminalService, Disposable { resolve(true); }, ); - const TIMEOUT_DURATION = 3000; + const TIMEOUT_DURATION = 500; setTimeout(() => { this.executeCommandListeners.add(shellIntegrationChangeEventListener); resolve(true); From 8c4dee44782cf11685bc043f91dd7b08a3616429 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:00:44 -0700 Subject: [PATCH 124/149] Allow pytest to use correct interpreter from getActiveInterpreter (#24250) Resolves: https://github.com/microsoft/vscode-python/issues/24122 Related: https://github.com/microsoft/vscode-python/issues/24190, https://github.com/microsoft/vscode-python/issues/24127 I think the culprit was we were not passing in interpreter when we call createActivatedEnvironment. --- src/client/testing/testController/common/types.ts | 8 +++++++- src/client/testing/testController/controller.ts | 4 ++++ .../testController/pytest/pytestDiscoveryAdapter.ts | 11 +++++++++-- .../testController/pytest/pytestExecutionAdapter.ts | 5 +++++ .../testing/testController/workspaceTestAdapter.ts | 6 +++++- 5 files changed, 30 insertions(+), 4 deletions(-) diff --git a/src/client/testing/testController/common/types.ts b/src/client/testing/testController/common/types.ts index 0de3ff8ad0c0..58132a83484a 100644 --- a/src/client/testing/testController/common/types.ts +++ b/src/client/testing/testController/common/types.ts @@ -16,6 +16,7 @@ import { import { ITestDebugLauncher, TestDiscoveryOptions } from '../../common/types'; import { IPythonExecutionFactory } from '../../../common/process/types'; import { EnvironmentVariables } from '../../../common/variables/types'; +import { PythonEnvironment } from '../../../pythonEnvironments/info'; export type TestRunInstanceOptions = TestRunOptions & { exclude?: readonly TestItem[]; @@ -206,7 +207,11 @@ export interface ITestResultResolver { export interface ITestDiscoveryAdapter { // ** first line old method signature, second line new method signature discoverTests(uri: Uri): Promise; - discoverTests(uri: Uri, executionFactory: IPythonExecutionFactory): Promise; + discoverTests( + uri: Uri, + executionFactory: IPythonExecutionFactory, + interpreter?: PythonEnvironment, + ): Promise; } // interface for execution/runner adapter @@ -220,6 +225,7 @@ export interface ITestExecutionAdapter { runInstance?: TestRun, executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, + interpreter?: PythonEnvironment, ): Promise; } diff --git a/src/client/testing/testController/controller.ts b/src/client/testing/testController/controller.ts index dd624078a534..12d0fec23134 100644 --- a/src/client/testing/testController/controller.ts +++ b/src/client/testing/testController/controller.ts @@ -276,6 +276,7 @@ export class PythonTestController implements ITestController, IExtensionSingleAc this.testController, this.refreshCancellation.token, this.pythonExecFactory, + await this.interpreterService.getActiveInterpreter(workspace.uri), ); } else { traceError('Unable to find test adapter for workspace.'); @@ -297,6 +298,7 @@ export class PythonTestController implements ITestController, IExtensionSingleAc this.testController, this.refreshCancellation.token, this.pythonExecFactory, + await this.interpreterService.getActiveInterpreter(workspace.uri), ); } else { traceError('Unable to find test adapter for workspace.'); @@ -455,6 +457,7 @@ export class PythonTestController implements ITestController, IExtensionSingleAc request.profile?.kind, this.pythonExecFactory, this.debugLauncher, + await this.interpreterService.getActiveInterpreter(workspace.uri), ); } return this.pytest.runTests( @@ -483,6 +486,7 @@ export class PythonTestController implements ITestController, IExtensionSingleAc request.profile?.kind, this.pythonExecFactory, this.debugLauncher, + await this.interpreterService.getActiveInterpreter(workspace.uri), ); } // below is old way of running unittest execution diff --git a/src/client/testing/testController/pytest/pytestDiscoveryAdapter.ts b/src/client/testing/testController/pytest/pytestDiscoveryAdapter.ts index 2162c1fe6e71..e62bd02dd3de 100644 --- a/src/client/testing/testController/pytest/pytestDiscoveryAdapter.ts +++ b/src/client/testing/testController/pytest/pytestDiscoveryAdapter.ts @@ -23,6 +23,7 @@ import { hasSymlinkParent, } from '../common/utils'; import { IEnvironmentVariablesProvider } from '../../../common/variables/types'; +import { PythonEnvironment } from '../../../pythonEnvironments/info'; /** * Wrapper class for unittest test discovery. This is where we call `runTestCommand`. #this seems incorrectly copied @@ -35,13 +36,17 @@ export class PytestTestDiscoveryAdapter implements ITestDiscoveryAdapter { private readonly envVarsService?: IEnvironmentVariablesProvider, ) {} - async discoverTests(uri: Uri, executionFactory?: IPythonExecutionFactory): Promise { + async discoverTests( + uri: Uri, + executionFactory?: IPythonExecutionFactory, + interpreter?: PythonEnvironment, + ): Promise { const { name, dispose } = await startDiscoveryNamedPipe((data: DiscoveredTestPayload) => { this.resultResolver?.resolveDiscovery(data); }); try { - await this.runPytestDiscovery(uri, name, executionFactory); + await this.runPytestDiscovery(uri, name, executionFactory, interpreter); } finally { dispose(); } @@ -54,6 +59,7 @@ export class PytestTestDiscoveryAdapter implements ITestDiscoveryAdapter { uri: Uri, discoveryPipeName: string, executionFactory?: IPythonExecutionFactory, + interpreter?: PythonEnvironment, ): Promise { const relativePathToPytest = 'python_files'; const fullPluginPath = path.join(EXTENSION_ROOT_DIR, relativePathToPytest); @@ -100,6 +106,7 @@ export class PytestTestDiscoveryAdapter implements ITestDiscoveryAdapter { const creationOptions: ExecutionFactoryCreateWithEnvironmentOptions = { allowEnvironmentFetchExceptions: false, resource: uri, + interpreter, }; const execService = await executionFactory?.createActivatedEnvironment(creationOptions); // delete UUID following entire discovery finishing. diff --git a/src/client/testing/testController/pytest/pytestExecutionAdapter.ts b/src/client/testing/testController/pytest/pytestExecutionAdapter.ts index bcd97f450b58..fadec7f73488 100644 --- a/src/client/testing/testController/pytest/pytestExecutionAdapter.ts +++ b/src/client/testing/testController/pytest/pytestExecutionAdapter.ts @@ -19,6 +19,7 @@ import { PYTEST_PROVIDER } from '../../common/constants'; import { EXTENSION_ROOT_DIR } from '../../../common/constants'; import * as utils from '../common/utils'; import { IEnvironmentVariablesProvider } from '../../../common/variables/types'; +import { PythonEnvironment } from '../../../pythonEnvironments/info'; export class PytestTestExecutionAdapter implements ITestExecutionAdapter { constructor( @@ -35,6 +36,7 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { runInstance?: TestRun, executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, + interpreter?: PythonEnvironment, ): Promise { const deferredTillServerClose: Deferred = utils.createTestingDeferred(); @@ -74,6 +76,7 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { profileKind, executionFactory, debugLauncher, + interpreter, ); } finally { await deferredTillServerClose.promise; @@ -98,6 +101,7 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { profileKind?: TestRunProfileKind, executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, + interpreter?: PythonEnvironment, ): Promise { const relativePathToPytest = 'python_files'; const fullPluginPath = path.join(EXTENSION_ROOT_DIR, relativePathToPytest); @@ -122,6 +126,7 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter { const creationOptions: ExecutionFactoryCreateWithEnvironmentOptions = { allowEnvironmentFetchExceptions: false, resource: uri, + interpreter, }; // need to check what will happen in the exec service is NOT defined and is null const execService = await executionFactory?.createActivatedEnvironment(creationOptions); diff --git a/src/client/testing/testController/workspaceTestAdapter.ts b/src/client/testing/testController/workspaceTestAdapter.ts index a0e65cfb5061..81641ee5125c 100644 --- a/src/client/testing/testController/workspaceTestAdapter.ts +++ b/src/client/testing/testController/workspaceTestAdapter.ts @@ -14,6 +14,7 @@ import { ITestDiscoveryAdapter, ITestExecutionAdapter, ITestResultResolver } fro import { IPythonExecutionFactory } from '../../common/process/types'; import { ITestDebugLauncher } from '../common/types'; import { buildErrorNodeOptions } from './common/utils'; +import { PythonEnvironment } from '../../pythonEnvironments/info'; /** * This class exposes a test-provider-agnostic way of discovering tests. @@ -45,6 +46,7 @@ export class WorkspaceTestAdapter { profileKind?: boolean | TestRunProfileKind, executionFactory?: IPythonExecutionFactory, debugLauncher?: ITestDebugLauncher, + interpreter?: PythonEnvironment, ): Promise { if (this.executing) { traceError('Test execution already in progress, not starting a new one.'); @@ -80,6 +82,7 @@ export class WorkspaceTestAdapter { runInstance, executionFactory, debugLauncher, + interpreter, ); } else { await this.executionAdapter.runTests(this.workspaceUri, testCaseIds, profileKind); @@ -115,6 +118,7 @@ export class WorkspaceTestAdapter { testController: TestController, token?: CancellationToken, executionFactory?: IPythonExecutionFactory, + interpreter?: PythonEnvironment, ): Promise { sendTelemetryEvent(EventName.UNITTEST_DISCOVERING, undefined, { tool: this.testProvider }); @@ -130,7 +134,7 @@ export class WorkspaceTestAdapter { try { // ** execution factory only defined for new rewrite way if (executionFactory !== undefined) { - await this.discoveryAdapter.discoverTests(this.workspaceUri, executionFactory); + await this.discoveryAdapter.discoverTests(this.workspaceUri, executionFactory, interpreter); } else { await this.discoveryAdapter.discoverTests(this.workspaceUri); } From ebe55a4da14fb346ecdd0a62e57639f9848d6ae5 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Fri, 4 Oct 2024 17:10:03 -0700 Subject: [PATCH 125/149] only show coverage button for rewrite (#24249) fixes https://github.com/microsoft/vscode-python/issues/24241 --- .../testing/testController/controller.ts | 23 +++++++++++-------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/src/client/testing/testController/controller.ts b/src/client/testing/testController/controller.ts index 12d0fec23134..f969760c45b6 100644 --- a/src/client/testing/testController/controller.ts +++ b/src/client/testing/testController/controller.ts @@ -119,14 +119,6 @@ export class PythonTestController implements ITestController, IExtensionSingleAc this.disposables.push(delayTrigger); this.refreshData = delayTrigger; - const coverageProfile = this.testController.createRunProfile( - 'Coverage Tests', - TestRunProfileKind.Coverage, - this.runTests.bind(this), - true, - RunTestTag, - ); - this.disposables.push( this.testController.createRunProfile( 'Run Tests', @@ -142,8 +134,19 @@ export class PythonTestController implements ITestController, IExtensionSingleAc true, DebugTestTag, ), - coverageProfile, ); + if (pythonTestAdapterRewriteEnabled(this.serviceContainer)) { + // only add the coverage profile if the new test adapter is enabled + const coverageProfile = this.testController.createRunProfile( + 'Coverage Tests', + TestRunProfileKind.Coverage, + this.runTests.bind(this), + true, + RunTestTag, + ); + + this.disposables.push(coverageProfile); + } this.testController.resolveHandler = this.resolveChildren.bind(this); this.testController.refreshHandler = (token: CancellationToken) => { this.disposables.push( @@ -420,11 +423,11 @@ export class PythonTestController implements ITestController, IExtensionSingleAc const settings = this.configSettings.getSettings(workspace.uri); if (testItems.length > 0) { - // coverage?? const testAdapter = this.testAdapters.get(workspace.uri) || (this.testAdapters.values().next().value as WorkspaceTestAdapter); + // no profile will have TestRunProfileKind.Coverage if rewrite isn't enabled if (request.profile?.kind && request.profile?.kind === TestRunProfileKind.Coverage) { request.profile.loadDetailedCoverage = ( _testRun: TestRun, From 204b8ca483c576aaefc159dfd10f17123fd3062f Mon Sep 17 00:00:00 2001 From: Michael Noah <92764374+mnoah1@users.noreply.github.com> Date: Mon, 7 Oct 2024 16:18:49 -0400 Subject: [PATCH 126/149] Add customizable interpreter discovery timeout (#24227) Addressing issue https://github.com/microsoft/vscode-python/issues/24226 This adds a way to customize the timeout for the interpreter info script to run, by customizing the duration of the `VSC_PYTHON_INTERPRETER_INFO_TIMEOUT` environment variable. This is to address setups (e.g. a monorepo with Bazel) where the hard coded 15 seconds is insufficient, as the first Python run also includes additional setup work to ensure the venv is available for use before the interpreter can actually execute. This is being done via env var instead of via a VS Code setting to avoid introducing additional settings that will be deprecated after other planned upcoming work on interpreter discovery (see discussion on 24226). --- src/client/pythonEnvironments/base/info/interpreter.ts | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/client/pythonEnvironments/base/info/interpreter.ts b/src/client/pythonEnvironments/base/info/interpreter.ts index d0cb1f13f8f8..e19e1f0d45c2 100644 --- a/src/client/pythonEnvironments/base/info/interpreter.ts +++ b/src/client/pythonEnvironments/base/info/interpreter.ts @@ -8,7 +8,7 @@ import { InterpreterInfoJson, } from '../../../common/process/internal/scripts'; import { Architecture } from '../../../common/utils/platform'; -import { traceError, traceVerbose } from '../../../logging'; +import { traceError, traceInfo, traceVerbose } from '../../../logging'; import { shellExecute } from '../../common/externalDependencies'; import { copyPythonExecInfo, PythonExecInfo } from '../../exec'; import { parseVersion } from './pythonVersion'; @@ -82,7 +82,13 @@ export async function getInterpreterInfo( ); // Sometimes on CI, the python process takes a long time to start up. This is a workaround for that. - const standardTimeout = isCI ? 30000 : 15000; + let standardTimeout = isCI ? 30000 : 15000; + if (process.env.VSC_PYTHON_INTERPRETER_INFO_TIMEOUT !== undefined) { + // Custom override for setups where the initial Python setup process may take longer than the standard timeout. + standardTimeout = parseInt(process.env.VSC_PYTHON_INTERPRETER_INFO_TIMEOUT, 10); + traceInfo(`Custom interpreter discovery timeout: ${standardTimeout}`); + } + // Try shell execing the command, followed by the arguments. This will make node kill the process if it // takes too long. // Sometimes the python path isn't valid, timeout if that's the case. From c2ed6b25a0a1000154b965615ba7f420a513d0e2 Mon Sep 17 00:00:00 2001 From: Luciana Abud <45497113+luabud@users.noreply.github.com> Date: Wed, 9 Oct 2024 10:34:47 -0700 Subject: [PATCH 127/149] Update pylance gdpr classification tag (#24274) --- src/client/telemetry/pylance.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/client/telemetry/pylance.ts b/src/client/telemetry/pylance.ts index 8d04e4c607f7..959d105e5b9e 100644 --- a/src/client/telemetry/pylance.ts +++ b/src/client/telemetry/pylance.ts @@ -29,7 +29,7 @@ "method" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "modulehash" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "moduleversion" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, - "resultLength" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true } + "resultlength" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true } } */ /* __GDPR__ @@ -321,7 +321,7 @@ "lsversion" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "method" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "modulehash" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, - "resultLength" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true } + "resultlength" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true } } */ /* __GDPR__ From 041be0db8e279b2c50dcb616ca4648fc3c475233 Mon Sep 17 00:00:00 2001 From: Logan Ramos Date: Wed, 9 Oct 2024 11:20:27 -0700 Subject: [PATCH 128/149] Fix GDPR annotations (#24278) --- src/client/telemetry/pylance.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/client/telemetry/pylance.ts b/src/client/telemetry/pylance.ts index 959d105e5b9e..70d901641881 100644 --- a/src/client/telemetry/pylance.ts +++ b/src/client/telemetry/pylance.ts @@ -401,6 +401,6 @@ /* __GDPR__ "language_server.crash" : { "oom" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "rchiodo" }, - "lsversion" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "rchiodo" }, + "lsversion" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "rchiodo" } } */ From 9be9308ca2911a9fe2925b35c14f7aeccdb7f5ce Mon Sep 17 00:00:00 2001 From: Raymond Zhao <7199958+rzhao271@users.noreply.github.com> Date: Fri, 11 Oct 2024 11:51:13 -0700 Subject: [PATCH 129/149] fix: tag non-stable settings with new system (#24287) This PR changes some setting tags as follows: - Remove the experimental tag from the `python.missingPackage.severity` setting considering the setting does not seem to be experimental and that the setting does not seem to be part of any experiment. - Add the onExP tag onto the `python.locator` setting considering the setting is both experimental (based on its description) and part of an experiment. - Change the experimental tag to preview for `python.terminal.shellIntegration.enabled`, considering it is a non-stable setting that does not seem to be part of an experiment. - Add the onExP tag to `python.REPL.sendToNativeREPL` considering it is part of an experiment. --- package.json | 13 ++++++------- package.nls.json | 4 ++-- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/package.json b/package.json index 1e43143f3c03..d4c36905d1e3 100644 --- a/package.json +++ b/package.json @@ -582,10 +582,7 @@ "Warning" ], "scope": "resource", - "type": "string", - "tags": [ - "experimental" - ] + "type": "string" }, "python.locator": { "default": "js", @@ -595,7 +592,8 @@ "native" ], "tags": [ - "experimental" + "experimental", + "onExP" ], "scope": "machine", "type": "string" @@ -662,7 +660,7 @@ "scope": "resource", "type": "boolean", "tags": [ - "experimental" + "preview" ] }, "python.REPL.enableREPLSmartSend": { @@ -677,7 +675,8 @@ "scope": "resource", "type": "boolean", "tags": [ - "experimental" + "experimental", + "onExP" ] }, "python.REPL.provideVariables": { diff --git a/package.nls.json b/package.nls.json index 8909a3f4c5b9..b60863ef1e49 100644 --- a/package.nls.json +++ b/package.nls.json @@ -36,8 +36,8 @@ "python.diagnostics.sourceMapsEnabled.description": "Enable source map support for meaningful stack traces in error logs.", "python.envFile.description": "Absolute path to a file containing environment variable definitions.", "python.experiments.enabled.description": "Enables A/B tests experiments in the Python extension. If enabled, you may get included in proposed enhancements and/or features.", - "python.experiments.optInto.description": "List of experiment to opt into. If empty, user is assigned the default experiment groups. See [here](https://github.com/microsoft/vscode-python/wiki/AB-Experiments) for more details.", - "python.experiments.optOutFrom.description": "List of experiment to opt out of. If empty, user is assigned the default experiment groups. See [here](https://github.com/microsoft/vscode-python/wiki/AB-Experiments) for more details.", + "python.experiments.optInto.description": "List of experiments to opt into. If empty, user is assigned the default experiment groups. See [here](https://github.com/microsoft/vscode-python/wiki/AB-Experiments) for more details.", + "python.experiments.optOutFrom.description": "List of experiments to opt out of. If empty, user is assigned the default experiment groups. See [here](https://github.com/microsoft/vscode-python/wiki/AB-Experiments) for more details.", "python.experiments.All.description": "Combined list of all experiments.", "python.experiments.pythonSurveyNotification.description": "Denotes the Python Survey Notification experiment.", "python.experiments.pythonPromptNewToolsExt.description": "Denotes the Python Prompt New Tools Extension experiment.", From c5a8e4fa36fb32c163cc7a353c793dd14cf63aa1 Mon Sep 17 00:00:00 2001 From: Bregwin Jogi <91784318+brokoli777@users.noreply.github.com> Date: Mon, 14 Oct 2024 12:12:52 -0400 Subject: [PATCH 130/149] Refactor code to remove unused JSDoc types (#24300) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes #24077 Removes redundant type annotations from JSDocs in TypeScript files where the type is already inferred by TypeScript. For example: ![image](https://github.com/user-attachments/assets/9ee1f0b6-f36f-4f4f-81dc-5178d46808cb) Here I removed JSDoc types but I still kept all the useful information. I tried to be on the liberal side to avoid removing any comments that provide useful context or clarify behavior. If I missed any or if more can be removed, I’m happy to go over it again. Additionally, if this issue only applies to a specific folder or scope, please let me know so I can make the necessary adjustments. --- pythonExtensionApi/src/main.ts | 1 - src/client/activation/types.ts | 24 +------------------ src/client/api.ts | 1 - src/client/api/types.ts | 1 - src/client/application/diagnostics/base.ts | 5 ---- src/client/application/types.ts | 2 -- src/client/common/application/commands.ts | 4 ---- src/client/common/application/types.ts | 3 --- src/client/common/cancellation.ts | 11 --------- src/client/common/constants.ts | 2 -- src/client/common/extensions.ts | 1 - src/client/common/installer/types.ts | 5 ---- src/client/common/terminal/shellDetector.ts | 4 ---- .../shellDetectors/settingsShellDetector.ts | 4 ---- .../terminalNameShellDetector.ts | 4 ---- .../userEnvironmentShellDetector.ts | 4 ---- .../vscEnvironmentShellDetector.ts | 4 ---- .../common/terminal/syncTerminalService.ts | 5 ---- src/client/common/terminal/types.ts | 16 +------------ src/client/common/utils/async.ts | 6 ----- src/client/common/utils/cacheUtils.ts | 6 +---- src/client/common/utils/misc.ts | 7 ------ .../hooks/childProcessAttachHandler.ts | 3 --- .../hooks/childProcessAttachService.ts | 3 --- src/client/deprecatedProposedApiTypes.ts | 1 - src/client/interpreter/autoSelection/types.ts | 3 --- .../creation/common/createEnvTriggerUtils.ts | 3 +-- src/client/repl/nativeRepl.ts | 4 ---- src/client/repl/replCommandHandler.ts | 12 ---------- src/client/repl/replCommands.ts | 10 -------- src/client/repl/replUtils.ts | 12 +--------- src/client/telemetry/index.ts | 2 -- src/test/common.ts | 6 ----- src/test/common/utils/decorators.unit.test.ts | 5 ---- src/test/index.ts | 6 ----- src/test/mocks/vsc/arrays.ts | 3 --- src/test/utils/interpreters.ts | 4 ---- 37 files changed, 5 insertions(+), 192 deletions(-) diff --git a/pythonExtensionApi/src/main.ts b/pythonExtensionApi/src/main.ts index dccbd78f6f04..154ffbbd857a 100644 --- a/pythonExtensionApi/src/main.ts +++ b/pythonExtensionApi/src/main.ts @@ -25,7 +25,6 @@ export interface PythonExtension { /** * Gets the path to the debugger package used by the extension. - * @returns {Promise} */ getDebuggerPackagePath(): Promise; }; diff --git a/src/client/activation/types.ts b/src/client/activation/types.ts index 3a949e480d4b..e3b9b818691a 100644 --- a/src/client/activation/types.ts +++ b/src/client/activation/types.ts @@ -12,27 +12,14 @@ import { PythonEnvironment } from '../pythonEnvironments/info'; export const IExtensionActivationManager = Symbol('IExtensionActivationManager'); /** * Responsible for activation of extension. - * - * @export - * @interface IExtensionActivationManager - * @extends {IDisposable} */ export interface IExtensionActivationManager extends IDisposable { - /** - * Method invoked when extension activates (invoked once). - * - * @returns {Promise} - * @memberof IExtensionActivationManager - */ + // Method invoked when extension activates (invoked once). activate(startupStopWatch: StopWatch): Promise; /** * Method invoked when a workspace is loaded. * This is where we place initialization scripts for each workspace. * (e.g. if we need to run code for each workspace, then this is where that happens). - * - * @param {Resource} resource - * @returns {Promise} - * @memberof IExtensionActivationManager */ activateWorkspace(resource: Resource): Promise; } @@ -43,8 +30,6 @@ export const IExtensionActivationService = Symbol('IExtensionActivationService') * invoked for every workspace folder (in multi-root workspace folders) during the activation of the extension. * This is a great hook for extension activation code, i.e. you don't need to modify * the `extension.ts` file to invoke some code when extension gets activated. - * @export - * @interface IExtensionActivationService */ export interface IExtensionActivationService { supportedWorkspaceTypes: { untrustedWorkspace: boolean; virtualWorkspace: boolean }; @@ -100,8 +85,6 @@ export interface ILanguageServerProxy extends IDisposable { * Sends a request to LS so as to load other extensions. * This is used as a plugin loader mechanism. * Anyone (such as intellicode) wanting to interact with LS, needs to send this request to LS. - * @param {{}} [args] - * @memberof ILanguageServerProxy */ loadExtension(args?: unknown): void; } @@ -110,9 +93,6 @@ export const ILanguageServerOutputChannel = Symbol('ILanguageServerOutputChannel export interface ILanguageServerOutputChannel { /** * Creates output channel if necessary and returns it - * - * @type {ILogOutputChannel} - * @memberof ILanguageServerOutputChannel */ readonly channel: ILogOutputChannel; } @@ -123,8 +103,6 @@ export const IExtensionSingleActivationService = Symbol('IExtensionSingleActivat * invoked during the activation of the extension. * This is a great hook for extension activation code, i.e. you don't need to modify * the `extension.ts` file to invoke some code when extension gets activated. - * @export - * @interface IExtensionSingleActivationService */ export interface IExtensionSingleActivationService { supportedWorkspaceTypes: { untrustedWorkspace: boolean; virtualWorkspace: boolean }; diff --git a/src/client/api.ts b/src/client/api.ts index aaaba540af23..899326647808 100644 --- a/src/client/api.ts +++ b/src/client/api.ts @@ -80,7 +80,6 @@ export function buildApi( * @param {Resource} [resource] A resource for which the setting is asked for. * * When no resource is provided, the setting scoped to the first workspace folder is returned. * * If no folder is present, it returns the global setting. - * @returns {({ execCommand: string[] | undefined })} */ getExecutionDetails( resource?: Resource, diff --git a/src/client/api/types.ts b/src/client/api/types.ts index 873d5e802d5b..4e67334121fb 100644 --- a/src/client/api/types.ts +++ b/src/client/api/types.ts @@ -25,7 +25,6 @@ export interface PythonExtension { /** * Gets the path to the debugger package used by the extension. - * @returns {Promise} */ getDebuggerPackagePath(): Promise; }; diff --git a/src/client/application/diagnostics/base.ts b/src/client/application/diagnostics/base.ts index 17bb7559ee77..8ce1c3b83184 100644 --- a/src/client/application/diagnostics/base.ts +++ b/src/client/application/diagnostics/base.ts @@ -73,11 +73,6 @@ export abstract class BaseDiagnosticsService implements IDiagnosticsService, IDi /** * Returns a key used to keep track of whether a diagnostic was handled or not. * So as to prevent handling/displaying messages multiple times for the same diagnostic. - * - * @protected - * @param {IDiagnostic} diagnostic - * @returns {string} - * @memberof BaseDiagnosticsService */ protected getDiagnosticsKey(diagnostic: IDiagnostic): string { if (diagnostic.scope === DiagnosticScope.Global) { diff --git a/src/client/application/types.ts b/src/client/application/types.ts index 460ac39807c8..cfd41f7b9746 100644 --- a/src/client/application/types.ts +++ b/src/client/application/types.ts @@ -11,8 +11,6 @@ export interface IApplicationDiagnostics { /** * Perform pre-extension activation health checks. * E.g. validate user environment, etc. - * @returns {Promise} - * @memberof IApplicationDiagnostics */ performPreStartupHealthCheck(resource: Resource): Promise; register(): void; diff --git a/src/client/common/application/commands.ts b/src/client/common/application/commands.ts index 41bbe8b4f4ea..5fde061fb1e0 100644 --- a/src/client/common/application/commands.ts +++ b/src/client/common/application/commands.ts @@ -14,7 +14,6 @@ export type CommandsWithoutArgs = keyof ICommandNameWithoutArgumentTypeMapping; /** * Mapping between commands and list or arguments. * These commands do NOT have any arguments. - * @interface ICommandNameWithoutArgumentTypeMapping */ interface ICommandNameWithoutArgumentTypeMapping { [Commands.InstallPythonOnMac]: []; @@ -52,9 +51,6 @@ export type AllCommands = keyof ICommandNameArgumentTypeMapping; /** * Mapping between commands and list of arguments. * Used to provide strong typing for command & args. - * @export - * @interface ICommandNameArgumentTypeMapping - * @extends {ICommandNameWithoutArgumentTypeMapping} */ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgumentTypeMapping { [Commands.Create_Environment]: [CreateEnvironmentOptions]; diff --git a/src/client/common/application/types.ts b/src/client/common/application/types.ts index 413122f2584b..65a8833a691c 100644 --- a/src/client/common/application/types.ts +++ b/src/client/common/application/types.ts @@ -818,9 +818,6 @@ export interface IWorkspaceService { /** * Generate a key that's unique to the workspace folder (could be fsPath). - * @param {(Uri | undefined)} resource - * @returns {string} - * @memberof IWorkspaceService */ getWorkspaceFolderIdentifier(resource: Uri | undefined, defaultValue?: string): string; /** diff --git a/src/client/common/cancellation.ts b/src/client/common/cancellation.ts index c820c1ad4324..7c9c26c597b3 100644 --- a/src/client/common/cancellation.ts +++ b/src/client/common/cancellation.ts @@ -16,11 +16,6 @@ export class CancellationError extends Error { } /** * Create a promise that will either resolve with a default value or reject when the token is cancelled. - * - * @export - * @template T - * @param {({ defaultValue: T; token: CancellationToken; cancelAction: 'reject' | 'resolve' })} options - * @returns {Promise} */ export function createPromiseFromCancellation(options: { defaultValue: T; @@ -50,10 +45,6 @@ export function createPromiseFromCancellation(options: { /** * Create a single unified cancellation token that wraps multiple cancellation tokens. - * - * @export - * @param {(...(CancellationToken | undefined)[])} tokens - * @returns {CancellationToken} */ export function wrapCancellationTokens(...tokens: (CancellationToken | undefined)[]): CancellationToken { const wrappedCancellantionToken = new CancellationTokenSource(); @@ -117,7 +108,6 @@ export namespace Cancellation { /** * isCanceled returns a boolean indicating if the cancel token has been canceled. - * @param cancelToken */ export function isCanceled(cancelToken?: CancellationToken): boolean { return cancelToken ? cancelToken.isCancellationRequested : false; @@ -125,7 +115,6 @@ export namespace Cancellation { /** * throws a CancellationError if the token is canceled. - * @param cancelToken */ export function throwIfCanceled(cancelToken?: CancellationToken): void { if (isCanceled(cancelToken)) { diff --git a/src/client/common/constants.ts b/src/client/common/constants.ts index 51e38d5ef3e6..68bd44fa769a 100644 --- a/src/client/common/constants.ts +++ b/src/client/common/constants.ts @@ -111,8 +111,6 @@ export function isTestExecution(): boolean { /** * Whether we're running unit tests (*.unit.test.ts). * These tests have a special meaning, they run fast. - * @export - * @returns {boolean} */ export function isUnitTestExecution(): boolean { return process.env.VSC_PYTHON_UNIT_TEST === '1'; diff --git a/src/client/common/extensions.ts b/src/client/common/extensions.ts index a074106b73b1..033a375b1e56 100644 --- a/src/client/common/extensions.ts +++ b/src/client/common/extensions.ts @@ -28,7 +28,6 @@ declare interface String { /** * Appropriately formats a string so it can be used as an argument for a command in a shell. * E.g. if an argument contains a space, then it will be enclosed within double quotes. - * @param {String} value. */ String.prototype.toCommandArgumentForPythonExt = function (this: string): string { if (!this) { diff --git a/src/client/common/installer/types.ts b/src/client/common/installer/types.ts index efc7535af708..679b8b0ea668 100644 --- a/src/client/common/installer/types.ts +++ b/src/client/common/installer/types.ts @@ -18,11 +18,6 @@ export interface IModuleInstaller { * If a cancellation token is provided, then a cancellable progress message is dispalyed. * At this point, this method would resolve only after the module has been successfully installed. * If cancellation token is not provided, its not guaranteed that module installation has completed. - * @param {string} name - * @param {InterpreterUri} [resource] - * @param {CancellationToken} [cancel] - * @returns {Promise} - * @memberof IModuleInstaller */ installModule( productOrModuleName: Product | string, diff --git a/src/client/common/terminal/shellDetector.ts b/src/client/common/terminal/shellDetector.ts index ad515d42c734..bf183f20a279 100644 --- a/src/client/common/terminal/shellDetector.ts +++ b/src/client/common/terminal/shellDetector.ts @@ -33,10 +33,6 @@ export class ShellDetector { * 3. Try to identify the type of the shell based on the user environment (OS). * 4. If all else fail, use defaults hardcoded (cmd for windows, bash for linux & mac). * More information here: https://github.com/microsoft/vscode/issues/74233#issuecomment-497527337 - * - * @param {Terminal} [terminal] - * @returns {TerminalShellType} - * @memberof TerminalHelper */ public identifyTerminalShell(terminal?: Terminal): TerminalShellType { let shell: TerminalShellType | undefined; diff --git a/src/client/common/terminal/shellDetectors/settingsShellDetector.ts b/src/client/common/terminal/shellDetectors/settingsShellDetector.ts index 3eeb9d2e85da..6288675ec3f8 100644 --- a/src/client/common/terminal/shellDetectors/settingsShellDetector.ts +++ b/src/client/common/terminal/shellDetectors/settingsShellDetector.ts @@ -13,10 +13,6 @@ import { BaseShellDetector } from './baseShellDetector'; /** * Identifies the shell based on the user settings. - * - * @export - * @class SettingsShellDetector - * @extends {BaseShellDetector} */ @injectable() export class SettingsShellDetector extends BaseShellDetector { diff --git a/src/client/common/terminal/shellDetectors/terminalNameShellDetector.ts b/src/client/common/terminal/shellDetectors/terminalNameShellDetector.ts index 80911e85c1b5..0f14adbe9d36 100644 --- a/src/client/common/terminal/shellDetectors/terminalNameShellDetector.ts +++ b/src/client/common/terminal/shellDetectors/terminalNameShellDetector.ts @@ -11,10 +11,6 @@ import { BaseShellDetector } from './baseShellDetector'; /** * Identifies the shell, based on the display name of the terminal. - * - * @export - * @class TerminalNameShellDetector - * @extends {BaseShellDetector} */ @injectable() export class TerminalNameShellDetector extends BaseShellDetector { diff --git a/src/client/common/terminal/shellDetectors/userEnvironmentShellDetector.ts b/src/client/common/terminal/shellDetectors/userEnvironmentShellDetector.ts index bed2848ece92..da84eef4d46f 100644 --- a/src/client/common/terminal/shellDetectors/userEnvironmentShellDetector.ts +++ b/src/client/common/terminal/shellDetectors/userEnvironmentShellDetector.ts @@ -13,10 +13,6 @@ import { BaseShellDetector } from './baseShellDetector'; /** * Identifies the shell based on the users environment (env variables). - * - * @export - * @class UserEnvironmentShellDetector - * @extends {BaseShellDetector} */ @injectable() export class UserEnvironmentShellDetector extends BaseShellDetector { diff --git a/src/client/common/terminal/shellDetectors/vscEnvironmentShellDetector.ts b/src/client/common/terminal/shellDetectors/vscEnvironmentShellDetector.ts index a4592374b36f..9ca1b8c4ec22 100644 --- a/src/client/common/terminal/shellDetectors/vscEnvironmentShellDetector.ts +++ b/src/client/common/terminal/shellDetectors/vscEnvironmentShellDetector.ts @@ -12,10 +12,6 @@ import { BaseShellDetector } from './baseShellDetector'; /** * Identifies the shell, based on the VSC Environment API. - * - * @export - * @class VSCEnvironmentShellDetector - * @extends {BaseShellDetector} */ export class VSCEnvironmentShellDetector extends BaseShellDetector { constructor(@inject(IApplicationEnvironment) private readonly appEnv: IApplicationEnvironment) { diff --git a/src/client/common/terminal/syncTerminalService.ts b/src/client/common/terminal/syncTerminalService.ts index 7b25c714a035..e5b120a11110 100644 --- a/src/client/common/terminal/syncTerminalService.ts +++ b/src/client/common/terminal/syncTerminalService.ts @@ -92,11 +92,6 @@ class ExecutionState implements Disposable { * - Send text to a terminal that executes our python file, passing in the original text as args * - The pthon file will execute the commands as a subprocess * - At the end of the execution a file is created to singal completion. - * - * @export - * @class SynchronousTerminalService - * @implements {ITerminalService} - * @implements {Disposable} */ export class SynchronousTerminalService implements ITerminalService, Disposable { private readonly disposables: Disposable[] = []; diff --git a/src/client/common/terminal/types.ts b/src/client/common/terminal/types.ts index aa8ff73cc205..f8ae38f5d403 100644 --- a/src/client/common/terminal/types.ts +++ b/src/client/common/terminal/types.ts @@ -100,10 +100,6 @@ export interface ITerminalServiceFactory { /** * Gets a terminal service. * If one exists with the same information, that is returned else a new one is created. - * - * @param {TerminalCreationOptions} - * @returns {ITerminalService} - * @memberof ITerminalServiceFactory */ getTerminalService(options: TerminalCreationOptions & { newTerminalPerFile?: boolean }): ITerminalService; createTerminalService(resource?: Uri, title?: string): ITerminalService; @@ -132,11 +128,7 @@ export type TerminalActivationOptions = { resource?: Resource; preserveFocus?: boolean; interpreter?: PythonEnvironment; - /** - * When sending commands to the terminal, do not display the terminal. - * - * @type {boolean} - */ + // When sending commands to the terminal, do not display the terminal. hideFromUser?: boolean; }; export interface ITerminalActivator { @@ -170,16 +162,10 @@ export const IShellDetector = Symbol('IShellDetector'); /** * Used to identify a shell. * Each implemenetion will provide a unique way of identifying the shell. - * - * @export - * @interface IShellDetector */ export interface IShellDetector { /** * Classes with higher priorities will be used first when identifying the shell. - * - * @type {number} - * @memberof IShellDetector */ readonly priority: number; identify(telemetryProperties: ShellIdentificationTelemetry, terminal?: Terminal): TerminalShellType | undefined; diff --git a/src/client/common/utils/async.ts b/src/client/common/utils/async.ts index 59ac6f64cdbf..cabea8225ac9 100644 --- a/src/client/common/utils/async.ts +++ b/src/client/common/utils/async.ts @@ -245,12 +245,6 @@ export async function flattenIterable(iterableItem: AsyncIterable): Promis /** * Wait for a condition to be fulfilled within a timeout. - * - * @export - * @param {() => Promise} condition - * @param {number} timeoutMs - * @param {string} errorMessage - * @returns {Promise} */ export async function waitForCondition( condition: () => Promise, diff --git a/src/client/common/utils/cacheUtils.ts b/src/client/common/utils/cacheUtils.ts index 2564eff52003..6101b3ef928f 100644 --- a/src/client/common/utils/cacheUtils.ts +++ b/src/client/common/utils/cacheUtils.ts @@ -5,11 +5,7 @@ const globalCacheStore = new Map(); -/** - * Gets a cache store to be used to store return values of methods or any other. - * - * @returns - */ +// Gets a cache store to be used to store return values of methods or any other. export function getGlobalCacheStore() { return globalCacheStore; } diff --git a/src/client/common/utils/misc.ts b/src/client/common/utils/misc.ts index 455392d28eb1..a461d25d9d30 100644 --- a/src/client/common/utils/misc.ts +++ b/src/client/common/utils/misc.ts @@ -27,10 +27,6 @@ type NonFunctionPropertyNames = { [K in keyof T]: T[K] extends Function ? nev * Checking whether something is a Resource (Uri/undefined). * Using `instanceof Uri` doesn't always work as the object is not an instance of Uri (at least not in tests). * That's why VSC too has a helper method `URI.isUri` (though not public). - * - * @export - * @param {InterpreterUri} [resource] - * @returns {resource is Resource} */ export function isResource(resource?: InterpreterUri): resource is Resource { if (!resource) { @@ -44,9 +40,6 @@ export function isResource(resource?: InterpreterUri): resource is Resource { * Checking whether something is a Uri. * Using `instanceof Uri` doesn't always work as the object is not an instance of Uri (at least not in tests). * That's why VSC too has a helper method `URI.isUri` (though not public). - * - * @param {InterpreterUri} [resource] - * @returns {resource is Uri} */ function isUri(resource?: Uri | any): resource is Uri { diff --git a/src/client/debugger/extension/hooks/childProcessAttachHandler.ts b/src/client/debugger/extension/hooks/childProcessAttachHandler.ts index 23602ffce086..233818e00aaf 100644 --- a/src/client/debugger/extension/hooks/childProcessAttachHandler.ts +++ b/src/client/debugger/extension/hooks/childProcessAttachHandler.ts @@ -14,9 +14,6 @@ import { DebuggerTypeName } from '../../constants'; /** * This class is responsible for automatically attaching the debugger to any * child processes launched. I.e. this is the class responsible for multi-proc debugging. - * @export - * @class ChildProcessAttachEventHandler - * @implements {IDebugSessionEventHandlers} */ @injectable() export class ChildProcessAttachEventHandler implements IDebugSessionEventHandlers { diff --git a/src/client/debugger/extension/hooks/childProcessAttachService.ts b/src/client/debugger/extension/hooks/childProcessAttachService.ts index 08f44bc3cea5..24eaf1b52769 100644 --- a/src/client/debugger/extension/hooks/childProcessAttachService.ts +++ b/src/client/debugger/extension/hooks/childProcessAttachService.ts @@ -17,9 +17,6 @@ import { getWorkspaceFolders } from '../../../common/vscodeApis/workspaceApis'; /** * This class is responsible for attaching the debugger to any * child processes launched. I.e. this is the class responsible for multi-proc debugging. - * @export - * @class ChildProcessAttachEventHandler - * @implements {IChildProcessAttachService} */ @injectable() export class ChildProcessAttachService implements IChildProcessAttachService { diff --git a/src/client/deprecatedProposedApiTypes.ts b/src/client/deprecatedProposedApiTypes.ts index 79b267d5b873..eb76d61dc907 100644 --- a/src/client/deprecatedProposedApiTypes.ts +++ b/src/client/deprecatedProposedApiTypes.ts @@ -57,7 +57,6 @@ export interface DeprecatedProposedAPI { * @param {Resource} [resource] A resource for which the setting is asked for. * * When no resource is provided, the setting scoped to the first workspace folder is returned. * * If no folder is present, it returns the global setting. - * @returns {({ execCommand: string[] | undefined })} */ getExecutionDetails( resource?: Resource, diff --git a/src/client/interpreter/autoSelection/types.ts b/src/client/interpreter/autoSelection/types.ts index 8833c6cac371..91d0224717d4 100644 --- a/src/client/interpreter/autoSelection/types.ts +++ b/src/client/interpreter/autoSelection/types.ts @@ -14,9 +14,6 @@ export const IInterpreterAutoSelectionProxyService = Symbol('IInterpreterAutoSel * However, the class that reads python Path, must first give preference to selected interpreter. * But all classes everywhere make use of python settings! * Solution - Use a proxy that does nothing first, but later the real instance is injected. - * - * @export - * @interface IInterpreterAutoSelectionProxyService */ export interface IInterpreterAutoSelectionProxyService { readonly onDidChangeAutoSelectedInterpreter: Event; diff --git a/src/client/pythonEnvironments/creation/common/createEnvTriggerUtils.ts b/src/client/pythonEnvironments/creation/common/createEnvTriggerUtils.ts index f3c6ea58a25c..eccbf64a7866 100644 --- a/src/client/pythonEnvironments/creation/common/createEnvTriggerUtils.ts +++ b/src/client/pythonEnvironments/creation/common/createEnvTriggerUtils.ts @@ -67,8 +67,7 @@ export async function isGlobalPythonSelected(workspace: WorkspaceFolder): Promis /** * Checks the setting `python.createEnvironment.trigger` to see if we should perform the checks * to prompt to create an environment. - * @export - * @returns : True if we should prompt to create an environment. + * Returns True if we should prompt to create an environment. */ export function shouldPromptToCreateEnv(): boolean { const config = getConfiguration('python'); diff --git a/src/client/repl/nativeRepl.ts b/src/client/repl/nativeRepl.ts index 413c795e80d6..8304a27db6ea 100644 --- a/src/client/repl/nativeRepl.ts +++ b/src/client/repl/nativeRepl.ts @@ -109,7 +109,6 @@ export class NativeRepl implements Disposable { /** * Function that check if NotebookController for REPL exists, and returns it in Singleton manner. - * @returns NotebookController */ public setReplController(): NotebookController { if (!this.replController) { @@ -125,8 +124,6 @@ export class NativeRepl implements Disposable { /** * Function that checks if native REPL's text input box contains complete code. - * @param activeEditor - * @param pythonServer * @returns Promise - True if complete/Valid code is present, False otherwise. */ public async checkUserInputCompleteCode(activeEditor: TextEditor | undefined): Promise { @@ -147,7 +144,6 @@ export class NativeRepl implements Disposable { /** * Function that opens interactive repl, selects kernel, and send/execute code to the native repl. - * @param code */ public async sendToNativeRepl(code?: string): Promise { const notebookEditor = await openInteractiveREPL(this.replController, this.notebookDocument); diff --git a/src/client/repl/replCommandHandler.ts b/src/client/repl/replCommandHandler.ts index b8fe579647a1..0e4408d76bfb 100644 --- a/src/client/repl/replCommandHandler.ts +++ b/src/client/repl/replCommandHandler.ts @@ -16,9 +16,6 @@ import { PVSC_EXTENSION_ID } from '../common/constants'; /** * Function that opens/show REPL using IW UI. - * @param notebookController - * @param notebookEditor - * @returns notebookEditor */ export async function openInteractiveREPL( notebookController: NotebookController, @@ -46,10 +43,6 @@ export async function openInteractiveREPL( /** * Function that selects notebook Kernel. - * @param notebookEditor - * @param notebookControllerId - * @param extensionId - * @return Promise */ export async function selectNotebookKernel( notebookEditor: NotebookEditor, @@ -65,9 +58,6 @@ export async function selectNotebookKernel( /** * Function that executes notebook cell given code. - * @param notebookDocument - * @param code - * @return Promise */ export async function executeNotebookCell(notebookEditor: NotebookEditor, code: string): Promise { const { notebook, replOptions } = notebookEditor; @@ -83,8 +73,6 @@ export async function executeNotebookCell(notebookEditor: NotebookEditor, code: /** * Function that adds cell to notebook. * This function will only get called when notebook document is defined. - * @param code - * */ async function addCellToNotebook(notebookDocument: NotebookDocument, index: number, code: string): Promise { const notebookCellData = new NotebookCellData(NotebookCellKind.Code, code as string, 'python'); diff --git a/src/client/repl/replCommands.ts b/src/client/repl/replCommands.ts index 82b4aae4e5ee..e35cdbf8a7a0 100644 --- a/src/client/repl/replCommands.ts +++ b/src/client/repl/replCommands.ts @@ -20,11 +20,6 @@ import { EventName } from '../telemetry/constants'; /** * Register Start Native REPL command in the command palette - * - * @param disposables - * @param interpreterService - * @param commandManager - * @returns Promise */ export async function registerStartNativeReplCommand( disposables: Disposable[], @@ -46,9 +41,6 @@ export async function registerStartNativeReplCommand( /** * Registers REPL command for shift+enter if sendToNativeREPL setting is enabled. - * @param disposables - * @param interpreterService - * @returns Promise */ export async function registerReplCommands( disposables: Disposable[], @@ -88,8 +80,6 @@ export async function registerReplCommands( /** * Command triggered for 'Enter': Conditionally call interactive.execute OR insert \n in text input box. - * @param disposables - * @param interpreterService */ export async function registerReplExecuteOnEnter( disposables: Disposable[], diff --git a/src/client/repl/replUtils.ts b/src/client/repl/replUtils.ts index ec68f0a59bb6..5f58f461155b 100644 --- a/src/client/repl/replUtils.ts +++ b/src/client/repl/replUtils.ts @@ -9,7 +9,6 @@ import { getMultiLineSelectionText, getSingleLineSelectionText } from '../termin /** * Function that executes selected code in the terminal. - * @returns Promise */ export async function executeInTerminal(): Promise { await commands.executeCommand(Commands.Exec_Selection_In_Terminal); @@ -45,12 +44,7 @@ export function getSendToNativeREPLSetting(): boolean { return configuration.get('REPL.sendToNativeREPL', false); } -/** - * Function that inserts new line in the given (input) text editor - * @param activeEditor - * @returns void - */ - +// Function that inserts new line in the given (input) text editor export function insertNewLineToREPLInput(activeEditor: TextEditor | undefined): void { if (activeEditor) { const position = activeEditor.selection.active; @@ -70,9 +64,6 @@ export function isMultiLineText(textEditor: TextEditor): boolean { /** * Function that trigger interpreter warning if invalid interpreter. * Function will also return undefined or active interpreter - * @parm uri - * @param interpreterService - * @returns Promise */ export async function getActiveInterpreter( uri: Uri, @@ -88,7 +79,6 @@ export async function getActiveInterpreter( /** * Function that will return ViewColumn for existing Native REPL that belongs to given NotebookDocument. - * @returns ViewColumn | undefined */ export function getExistingReplViewColumn(notebookDocument: NotebookDocument): ViewColumn | undefined { const ourNotebookUri = notebookDocument.uri.toString(); diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index 2e29cd72d66c..ae4fd53adff6 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -24,7 +24,6 @@ import type { TestTool } from './types'; * Checks whether telemetry is supported. * Its possible this function gets called within Debug Adapter, vscode isn't available in there. * Within DA, there's a completely different way to send telemetry. - * @returns {boolean} */ function isTelemetrySupported(): boolean { try { @@ -42,7 +41,6 @@ let packageJSON: any; /** * Checks if the telemetry is disabled - * @returns {boolean} */ export function isTelemetryDisabled(): boolean { if (!packageJSON) { diff --git a/src/test/common.ts b/src/test/common.ts index 8c2512959bdf..00de8fd3f4a6 100644 --- a/src/test/common.ts +++ b/src/test/common.ts @@ -452,12 +452,6 @@ export async function unzip(zipFile: string, targetFolder: string): Promise Promise} condition - * @param {number} timeoutMs - * @param {string} errorMessage - * @returns {Promise} */ export async function waitForCondition( condition: () => Promise, diff --git a/src/test/common/utils/decorators.unit.test.ts b/src/test/common/utils/decorators.unit.test.ts index ca8be4e9def1..b1e86c4e2013 100644 --- a/src/test/common/utils/decorators.unit.test.ts +++ b/src/test/common/utils/decorators.unit.test.ts @@ -72,8 +72,6 @@ suite('Common Utils - Decorators', function () { * This has an accuracy of around 2-20ms. * However we're dealing with tests that need accuracy of 1ms. * Use API that'll give us better accuracy when dealing with elapsed times. - * - * @returns {number} */ function getHighPrecisionTime(): number { const currentTime = process.hrtime(); @@ -91,9 +89,6 @@ suite('Common Utils - Decorators', function () { * await new Promise(resolve = setTimeout(resolve, 100)) * console.log(currentTime - startTijme) * ``` - * - * @param {number} actualDelay - * @param {number} expectedDelay */ function assertElapsedTimeWithinRange(actualDelay: number, expectedDelay: number) { const difference = actualDelay - expectedDelay; diff --git a/src/test/index.ts b/src/test/index.ts index f528a7551220..a4c69a2a9ac6 100644 --- a/src/test/index.ts +++ b/src/test/index.ts @@ -44,8 +44,6 @@ process.on('unhandledRejection', (ex: any, _a) => { /** * Configure the test environment and return the optoins required to run moch tests. - * - * @returns {SetupOptions} */ function configure(): SetupOptions { process.env.VSC_PYTHON_CI_TEST = '1'; @@ -103,7 +101,6 @@ function configure(): SetupOptions { * to complete. * That's when we know out PVSC extension specific code is ready for testing. * So, this code needs to run always for every test running in VS Code (what we call these `system test`) . - * @returns */ function activatePythonExtensionScript() { const ex = new Error('Failed to initialize Python extension for tests after 3 minutes'); @@ -121,9 +118,6 @@ function activatePythonExtensionScript() { /** * Runner, invoked by VS Code. * More info https://code.visualstudio.com/api/working-with-extensions/testing-extension - * - * @export - * @returns {Promise} */ export async function run(): Promise { const options = configure(); diff --git a/src/test/mocks/vsc/arrays.ts b/src/test/mocks/vsc/arrays.ts index c06cefa7c27f..ad2020c57110 100644 --- a/src/test/mocks/vsc/arrays.ts +++ b/src/test/mocks/vsc/arrays.ts @@ -186,9 +186,6 @@ export function sortedDiff(before: T[], after: T[], compare: (a: T, b: T) => /** * Takes two *sorted* arrays and computes their delta (removed, added elements). * Finishes in `Math.min(before.length, after.length)` steps. - * @param before - * @param after - * @param compare */ export function delta(before: T[], after: T[], compare: (a: T, b: T) => number): { removed: T[]; added: T[] } { const splices = sortedDiff(before, after, compare); diff --git a/src/test/utils/interpreters.ts b/src/test/utils/interpreters.ts index e499c85ca96e..ece3b7731c5c 100644 --- a/src/test/utils/interpreters.ts +++ b/src/test/utils/interpreters.ts @@ -9,10 +9,6 @@ import { EnvironmentType, PythonEnvironment } from '../../client/pythonEnvironme /** * Creates a PythonInterpreter object for testing purposes, with unique name, version and path. * If required a custom name, version and the like can be provided. - * - * @export - * @param {Partial} [info] - * @returns {PythonEnvironment} */ export function createPythonInterpreter(info?: Partial): PythonEnvironment { const rnd = new Date().getTime().toString(); From 5112073b029c71d0a5585f07f7f46bd8bf9983f3 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 14 Oct 2024 09:22:31 -0700 Subject: [PATCH 131/149] Fix for conda activation during testing (#24295) --- src/client/pythonEnvironments/nativeAPI.ts | 32 ++++++++++++++++++- .../pythonEnvironments/nativeAPI.unit.test.ts | 2 +- 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/src/client/pythonEnvironments/nativeAPI.ts b/src/client/pythonEnvironments/nativeAPI.ts index 2d13500fdcd8..31ad80608283 100644 --- a/src/client/pythonEnvironments/nativeAPI.ts +++ b/src/client/pythonEnvironments/nativeAPI.ts @@ -55,6 +55,10 @@ function toArch(a: string | undefined): Architecture { } function getLocation(nativeEnv: NativeEnvInfo, executable: string): string { + if (nativeEnv.kind === NativePythonEnvironmentKind.Conda) { + return nativeEnv.prefix ?? path.dirname(executable); + } + if (nativeEnv.executable) { return nativeEnv.executable; } @@ -206,6 +210,32 @@ function toPythonEnvInfo(nativeEnv: NativeEnvInfo): PythonEnvInfo | undefined { }; } +function hasChanged(old: PythonEnvInfo, newEnv: PythonEnvInfo): boolean { + if (old.executable.filename !== newEnv.executable.filename) { + return true; + } + if (old.version.major !== newEnv.version.major) { + return true; + } + if (old.version.minor !== newEnv.version.minor) { + return true; + } + if (old.version.micro !== newEnv.version.micro) { + return true; + } + if (old.location !== newEnv.location) { + return true; + } + if (old.kind !== newEnv.kind) { + return true; + } + if (old.arch !== newEnv.arch) { + return true; + } + + return false; +} + class NativePythonEnvironments implements IDiscoveryAPI, Disposable { private _onProgress: EventEmitter; @@ -354,7 +384,7 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { const info = toPythonEnvInfo(native); if (info) { const old = this._envs.find((item) => item.executable.filename === info.executable.filename); - if (old) { + if (old && hasChanged(old, info)) { this._envs = this._envs.filter((item) => item.executable.filename !== info.executable.filename); this._envs.push(info); this._onChanged.fire({ type: FileChangeType.Changed, old, new: info, searchLocation }); diff --git a/src/test/pythonEnvironments/nativeAPI.unit.test.ts b/src/test/pythonEnvironments/nativeAPI.unit.test.ts index 088a44a0c1a3..f7f956c7a20e 100644 --- a/src/test/pythonEnvironments/nativeAPI.unit.test.ts +++ b/src/test/pythonEnvironments/nativeAPI.unit.test.ts @@ -108,7 +108,7 @@ suite('Native Python API', () => { mtime: -1, }, kind: PythonEnvKind.Conda, - location: '/home/user/.conda/envs/conda_python/python', + location: '/home/user/.conda/envs/conda_python', source: [], name: 'conda_python', type: PythonEnvType.Conda, From 97b46109ccdfd26f1a0cc8a339316a043d5213bf Mon Sep 17 00:00:00 2001 From: T-256 <132141463+T-256@users.noreply.github.com> Date: Mon, 14 Oct 2024 21:12:24 +0330 Subject: [PATCH 132/149] Make `python_server.py` compatible to Python 3.7 (#24252) ``` 2024-10-05 15:12:00.813 [error] File "c:\Users\User\.vscode\extensions\ms-python.python-2024.16.0-win32-x64\python_files\python_server.py", line 162 while line := STDIN.readline().strip(): ^ SyntaxError: invalid syntax 2024-10-05 15:12:00.816 [error] Python server exited with code 1 2024-10-05 15:14:46.427 [error] Error getting response from REPL server: [k [Error]: Connection is closed. at pe (c:\Users\User\.vscode\extensions\ms-python.python-2024.16.0-win32-x64\out\client\extension.js:2:2053423) at Object.sendRequest (c:\Users\User\.vscode\extensions\ms-python.python-2024.16.0-win32-x64\out\client\extension.js:2:2055781) at g.executeCode (c:\Users\User\.vscode\extensions\ms-python.python-2024.16.0-win32-x64\out\client\extension.js:2:799948) at g.execute (c:\Users\User\.vscode\extensions\ms-python.python-2024.16.0-win32-x64\out\client\extension.js:2:799770) at u.value (c:\Users\User\.vscode\extensions\ms-python.python-2024.16.0-win32-x64\out\client\extension.js:2:829806) at i.executeHandler (c:\Users\User\.vscode\extensions\ms-python.python-2024.16.0-win32-x64\out\client\extension.js:2:805190) at bb.$executeCells (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:155:24084) at Zb.S (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:31:113896) at Zb.Q (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:31:113676) at Zb.M (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:31:112765) at Zb.L (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:31:111870) at gh.value (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:31:110667) at T.B (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:29:732) at T.fire (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:29:950) at no.fire (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:31:9399) at gh.value (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:174:13273) at T.B (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:29:732) at T.fire (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:29:950) at no.fire (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:31:9399) at MessagePortMain. (file:///c:/Users/User/AppData/Local/Programs/Microsoft%20VS%20Code/resources/app/out/vs/workbench/api/node/extensionHostProcess.js:174:11562) at MessagePortMain.emit (node:events:519:28) at MessagePortMain._internalPort.emit (node:electron/js2c/utility_init:2:2619)] { code: 1 } ``` --- python_files/python_server.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/python_files/python_server.py b/python_files/python_server.py index deda05753c4d..40133917a3ec 100644 --- a/python_files/python_server.py +++ b/python_files/python_server.py @@ -159,7 +159,10 @@ def get_value(self) -> str: def get_headers(): headers = {} - while line := STDIN.readline().strip(): + while True: + line = STDIN.readline().strip() + if not line: + break name, value = line.split(":", 1) headers[name] = value.strip() return headers From 7d471a4eae42313c93d4b330754d783efbfb1f8a Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 7 Oct 2024 09:13:33 -0700 Subject: [PATCH 133/149] Enable 3.13-dev tests --- .github/workflows/build.yml | 2 +- .github/workflows/pr-check.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 42d94e49041c..77ccded55884 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -165,7 +165,7 @@ jobs: # macOS runners are expensive, and we assume that Ubuntu is enough to cover the Unix case. os: [ubuntu-latest, windows-latest] # Run the tests on the oldest and most recent versions of Python. - python: ['3.8', '3.x', '3.12-dev'] + python: ['3.8', '3.x', '3.13-dev'] steps: - name: Checkout diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml index 063857894210..f43f418bb024 100644 --- a/.github/workflows/pr-check.yml +++ b/.github/workflows/pr-check.yml @@ -147,7 +147,7 @@ jobs: # macOS runners are expensive, and we assume that Ubuntu is enough to cover the Unix case. os: [ubuntu-latest, windows-latest] # Run the tests on the oldest and most recent versions of Python. - python: ['3.8', '3.x'] # run for 3 pytest versions, most recent stable, oldest version supported and pre-release + python: ['3.8', '3.x', '3.13-dev'] # run for 3 pytest versions, most recent stable, oldest version supported and pre-release pytest-version: ['pytest', 'pytest@pre-release', 'pytest==6.2.0'] steps: From f6af3a1564935c86e0dd7db915966a9b5c4a89a0 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 7 Oct 2024 11:00:08 -0700 Subject: [PATCH 134/149] Switch to `pytest` --- .../tests/testing_tools/adapter/test_util.py | 586 +++++++++--------- 1 file changed, 290 insertions(+), 296 deletions(-) diff --git a/python_files/tests/testing_tools/adapter/test_util.py b/python_files/tests/testing_tools/adapter/test_util.py index 36df55a1d0f3..cfe56eba57ab 100644 --- a/python_files/tests/testing_tools/adapter/test_util.py +++ b/python_files/tests/testing_tools/adapter/test_util.py @@ -10,6 +10,8 @@ import sys import unittest +import pytest + # Pytest 3.7 and later uses pathlib/pathlib2 for path resolution. try: from pathlib import Path @@ -24,305 +26,297 @@ ) -@unittest.skipIf(sys.version_info < (3,), "Python 2 does not have subTest") -class FilePathTests(unittest.TestCase): - def test_isolated_imports(self): - import testing_tools.adapter - from testing_tools.adapter import util - - from . import test_functional - - ignored = { - str(Path(os.path.abspath(__file__)).resolve()), - str(Path(os.path.abspath(util.__file__)).resolve()), - str(Path(os.path.abspath(test_functional.__file__)).resolve()), - } - adapter = os.path.abspath(os.path.dirname(testing_tools.adapter.__file__)) - tests = os.path.join( - os.path.abspath(os.path.dirname(os.path.dirname(testing_tools.__file__))), - "tests", - "testing_tools", - "adapter", - ) - found = [] - for root in [adapter, tests]: - for dirname, _, files in os.walk(root): - if ".data" in dirname: +def is_python313_or_later(): + return sys.version_info >= (3, 1, 3) + + +def test_isolated_imports(): + import testing_tools.adapter + from testing_tools.adapter import util + + from . import test_functional + + ignored = { + str(Path(os.path.abspath(__file__)).resolve()), + str(Path(os.path.abspath(util.__file__)).resolve()), + str(Path(os.path.abspath(test_functional.__file__)).resolve()), + } + adapter = os.path.abspath(os.path.dirname(testing_tools.adapter.__file__)) + tests = os.path.join( + os.path.abspath(os.path.dirname(os.path.dirname(testing_tools.__file__))), + "tests", + "testing_tools", + "adapter", + ) + found = [] + for root in [adapter, tests]: + for dirname, _, files in os.walk(root): + if ".data" in dirname: + continue + for basename in files: + if not basename.endswith(".py"): continue - for basename in files: - if not basename.endswith(".py"): - continue - filename = os.path.join(dirname, basename) - if filename in ignored: - continue - with open(filename) as srcfile: - for line in srcfile: - if line.strip() == "import os.path": - found.append(filename) - break - - if found: - self.fail( - os.linesep.join( - [ - "", - "Please only use path-related API from testing_tools.adapter.util.", - 'Found use of "os.path" in the following files:', - ] - + [" " + file for file in found] - ) - ) + filename = os.path.join(dirname, basename) + if filename in ignored: + continue + with open(filename) as srcfile: + for line in srcfile: + if line.strip() == "import os.path": + found.append(filename) + break - def test_fix_path(self): - tests = [ - ("./spam.py", r".\spam.py"), - ("./some-dir", r".\some-dir"), - ("./some-dir/", ".\\some-dir\\"), - ("./some-dir/eggs", r".\some-dir\eggs"), - ("./some-dir/eggs/spam.py", r".\some-dir\eggs\spam.py"), - ("X/y/Z/a.B.c.PY", r"X\y\Z\a.B.c.PY"), - ("/", "\\"), - ("/spam", r"\spam"), - ("C:/spam", r"C:\spam"), - ] - for path, expected in tests: - pathsep = ntpath.sep - with self.subTest(rf"fixed for \: {path!r}"): - fixed = fix_path(path, _pathsep=pathsep) - self.assertEqual(fixed, expected) - - pathsep = posixpath.sep - with self.subTest(f"unchanged for /: {path!r}"): - unchanged = fix_path(path, _pathsep=pathsep) - self.assertEqual(unchanged, path) - - # no path -> "." - for path in ["", None]: - for pathsep in [ntpath.sep, posixpath.sep]: - with self.subTest(rf"fixed for {pathsep}: {path!r}"): - fixed = fix_path(path, _pathsep=pathsep) - self.assertEqual(fixed, ".") - - # no-op paths - paths = [path for _, path in tests] - paths.extend( - [ - ".", - "..", - "some-dir", - "spam.py", - ] - ) - for path in paths: - for pathsep in [ntpath.sep, posixpath.sep]: - with self.subTest(rf"unchanged for {pathsep}: {path!r}"): - unchanged = fix_path(path, _pathsep=pathsep) - self.assertEqual(unchanged, path) - - def test_fix_relpath(self): - tests = [ - ("spam.py", posixpath, "./spam.py"), - ("eggs/spam.py", posixpath, "./eggs/spam.py"), - ("eggs/spam/", posixpath, "./eggs/spam/"), - (r"\spam.py", posixpath, r"./\spam.py"), - ("spam.py", ntpath, r".\spam.py"), - (r"eggs\spam.py", ntpath, r".\eggs\spam.py"), - ("eggs\\spam\\", ntpath, ".\\eggs\\spam\\"), - ("/spam.py", ntpath, r"\spam.py"), # Note the fixed "/". - # absolute - ("/", posixpath, "/"), - ("/spam.py", posixpath, "/spam.py"), - ("\\", ntpath, "\\"), - (r"\spam.py", ntpath, r"\spam.py"), - (r"C:\spam.py", ntpath, r"C:\spam.py"), - # no-op - ("./spam.py", posixpath, "./spam.py"), - (r".\spam.py", ntpath, r".\spam.py"), - ] - # no-op - for path in [".", ".."]: - tests.extend( + if found: + pytest.fail( + os.linesep.join( [ - (path, posixpath, path), - (path, ntpath, path), + "", + "Please only use path-related API from testing_tools.adapter.util.", + 'Found use of "os.path" in the following files:', ] + + [" " + file for file in found] ) - for path, _os_path, expected in tests: - with self.subTest((path, _os_path.sep)): - fixed = fix_relpath( - path, - # Capture the loop variants as default parameters to make sure they - # don't change between iterations. - _fix_path=(lambda p, _sep=_os_path.sep: fix_path(p, _pathsep=_sep)), - _path_isabs=_os_path.isabs, - _pathsep=_os_path.sep, - ) - self.assertEqual(fixed, expected) - - def test_fix_fileid(self): - common = [ - ("spam.py", "./spam.py"), - ("eggs/spam.py", "./eggs/spam.py"), - ("eggs/spam/", "./eggs/spam/"), - # absolute (no-op) - ("/", "/"), - ("//", "//"), - ("/spam.py", "/spam.py"), - # no-op - (None, None), - ("", ""), - (".", "."), - ("./spam.py", "./spam.py"), - ] - tests = [(p, posixpath, e) for p, e in common] - tests.extend( - (p, posixpath, e) - for p, e in [ - (r"\spam.py", r"./\spam.py"), - ] - ) - tests.extend((p, ntpath, e) for p, e in common) - tests.extend( - (p, ntpath, e) - for p, e in [ - (r"eggs\spam.py", "./eggs/spam.py"), - ("eggs\\spam\\", "./eggs/spam/"), - (r".\spam.py", r"./spam.py"), - # absolute - (r"\spam.py", "/spam.py"), - (r"C:\spam.py", "C:/spam.py"), - ("\\", "/"), - ("\\\\", "//"), - ("C:\\\\", "C://"), - ("C:/", "C:/"), - ("C://", "C://"), - ("C:/spam.py", "C:/spam.py"), - ] - ) - for fileid, _os_path, expected in tests: - pathsep = _os_path.sep - with self.subTest(rf"for {pathsep}: {fileid!r}"): - fixed = fix_fileid( - fileid, - _path_isabs=_os_path.isabs, - _normcase=_os_path.normcase, - _pathsep=pathsep, - ) - self.assertEqual(fixed, expected) - - # with rootdir - common = [ - ("spam.py", "/eggs", "./spam.py"), - ("spam.py", r"\eggs", "./spam.py"), - # absolute - ("/spam.py", "/", "./spam.py"), - ("/eggs/spam.py", "/eggs", "./spam.py"), - ("/eggs/spam.py", "/eggs/", "./spam.py"), - # no-op - ("/spam.py", "/eggs", "/spam.py"), - ("/spam.py", "/eggs/", "/spam.py"), - # root-only (no-op) - ("/", "/", "/"), - ("/", "/spam", "/"), - ("//", "/", "//"), - ("//", "//", "//"), - ("//", "//spam", "//"), - ] - tests = [(p, r, posixpath, e) for p, r, e in common] - tests = [(p, r, ntpath, e) for p, r, e in common] - tests.extend( - (p, r, ntpath, e) - for p, r, e in [ - ("spam.py", r"\eggs", "./spam.py"), - # absolute - (r"\spam.py", "\\", r"./spam.py"), - (r"C:\spam.py", "C:\\", r"./spam.py"), - (r"\eggs\spam.py", r"\eggs", r"./spam.py"), - (r"\eggs\spam.py", "\\eggs\\", r"./spam.py"), - # normcase - (r"C:\spam.py", "c:\\", r"./spam.py"), - (r"\Eggs\Spam.py", "\\eggs", r"./Spam.py"), - (r"\eggs\spam.py", "\\Eggs", r"./spam.py"), - (r"\eggs\Spam.py", "\\Eggs", r"./Spam.py"), - # no-op - (r"\spam.py", r"\eggs", r"/spam.py"), - (r"C:\spam.py", r"C:\eggs", r"C:/spam.py"), - # TODO: Should these be supported. - (r"C:\spam.py", "\\", r"C:/spam.py"), - (r"\spam.py", "C:\\", r"/spam.py"), - # root-only - ("\\", "\\", "/"), - ("\\\\", "\\", "//"), - ("C:\\", "C:\\eggs", "C:/"), - ("C:\\", "C:\\", "C:/"), - (r"C:\spam.py", "D:\\", r"C:/spam.py"), - ] ) - for fileid, rootdir, _os_path, expected in tests: - pathsep = _os_path.sep - with self.subTest(rf"for {pathsep} (with rootdir {rootdir!r}): {fileid!r}"): - fixed = fix_fileid( - fileid, - rootdir, - _path_isabs=_os_path.isabs, - _normcase=_os_path.normcase, - _pathsep=pathsep, - ) - self.assertEqual(fixed, expected) - - -class ShlexUnsplitTests(unittest.TestCase): - def test_no_args(self): - argv = [] - joined = shlex_unsplit(argv) - - self.assertEqual(joined, "") - self.assertEqual(shlex.split(joined), argv) - - def test_one_arg(self): - argv = ["spam"] - joined = shlex_unsplit(argv) - - self.assertEqual(joined, "spam") - self.assertEqual(shlex.split(joined), argv) - - def test_multiple_args(self): - argv = [ - "-x", - "X", - "-xyz", - "spam", - "eggs", - ] - joined = shlex_unsplit(argv) - - self.assertEqual(joined, "-x X -xyz spam eggs") - self.assertEqual(shlex.split(joined), argv) - - def test_whitespace(self): - argv = [ - "-x", - "X Y Z", - "spam spam\tspam", - "eggs", - ] - joined = shlex_unsplit(argv) - - self.assertEqual(joined, "-x 'X Y Z' 'spam spam\tspam' eggs") - self.assertEqual(shlex.split(joined), argv) - - def test_quotation_marks(self): - argv = [ - "-x", - "''", - 'spam"spam"spam', - "ham'ham'ham", - "eggs", - ] - joined = shlex_unsplit(argv) - - self.assertEqual( - joined, - "-x ''\"'\"''\"'\"'' 'spam\"spam\"spam' 'ham'\"'\"'ham'\"'\"'ham' eggs", - ) - self.assertEqual(shlex.split(joined), argv) + + +@pytest.mark.parametrize( + ("path", "expected"), + [ + ("./spam.py", r".\spam.py"), + ("./some-dir", r".\some-dir"), + ("./some-dir/", ".\\some-dir\\"), + ("./some-dir/eggs", r".\some-dir\eggs"), + ("./some-dir/eggs/spam.py", r".\some-dir\eggs\spam.py"), + ("X/y/Z/a.B.c.PY", r"X\y\Z\a.B.c.PY"), + ("/", "\\"), + ("/spam", r"\spam"), + ("C:/spam", r"C:\spam"), + ("", "."), + (None, "."), + (".", "."), + ("..", ".."), + ("some-dir", "some-dir"), + ("spam.py", "spam.py"), + ], +) +def test_fix_path(path, expected): + fixed = fix_path(path, _pathsep=ntpath.sep) + assert fixed == expected + + unchanged = fix_path(path, _pathsep=posixpath.sep) + expected = "." if path is None or path == "" else path + assert unchanged == expected + + +@pytest.mark.parametrize( + ("path", "os_path", "expected"), + [ + ("spam.py", posixpath, "./spam.py"), + ("eggs/spam.py", posixpath, "./eggs/spam.py"), + ("eggs/spam/", posixpath, "./eggs/spam/"), + (r"\spam.py", posixpath, r"./\spam.py"), + ("spam.py", ntpath, r".\spam.py"), + (r"eggs\spam.py", ntpath, r".\eggs\spam.py"), + ("eggs\\spam\\", ntpath, ".\\eggs\\spam\\"), + ("/spam.py", ntpath, r"\spam.py"), # Note the fixed "/". + # absolute + ("/", posixpath, "/"), + ("/spam.py", posixpath, "/spam.py"), + ("\\", ntpath, "\\"), + (r"\spam.py", ntpath, r"\spam.py"), + (r"C:\spam.py", ntpath, r"C:\spam.py"), + # no-op + ("./spam.py", posixpath, "./spam.py"), + (r".\spam.py", ntpath, r".\spam.py"), + (".", posixpath, "."), + ("..", posixpath, ".."), + (".", ntpath, "."), + ("..", ntpath, ".."), + ], +) +def test_fix_relpath(path, os_path, expected): + fixed = fix_relpath( + path, + # Capture the loop variants as default parameters to make sure they + # don't change between iterations. + _fix_path=(lambda p, _sep=os_path.sep: fix_path(p, _pathsep=_sep)), + _path_isabs=os_path.isabs, + _pathsep=os_path.sep, + ) + assert fixed == expected + + +@pytest.mark.parametrize( + ("fileid", "os_path", "expected"), + [ + ("spam.py", posixpath, "./spam.py"), + ("eggs/spam.py", posixpath, "./eggs/spam.py"), + ("eggs/spam/", posixpath, "./eggs/spam/"), + # absolute (no-op) + ("/", posixpath, "/"), + ("//", posixpath, "//"), + ("/spam.py", posixpath, "/spam.py"), + # no-op + (None, posixpath, None), + ("", posixpath, ""), + (".", posixpath, "."), + ("./spam.py", posixpath, "./spam.py"), + (r"\spam.py", posixpath, r"./\spam.py"), + ("spam.py", ntpath, "./spam.py"), + ("eggs/spam.py", ntpath, "./eggs/spam.py"), + ("eggs/spam/", ntpath, "./eggs/spam/"), + # absolute (no-op) + ("/", ntpath, "/"), + ("//", ntpath, "//"), + ("/spam.py", ntpath, "/spam.py"), + # no-op + (None, ntpath, None), + ("", ntpath, ""), + (".", ntpath, "."), + ("./spam.py", ntpath, "./spam.py"), + (r"eggs\spam.py", ntpath, "./eggs/spam.py"), + ("eggs\\spam\\", ntpath, "./eggs/spam/"), + (r".\spam.py", ntpath, r"./spam.py"), + # absolute + (r"\spam.py", ntpath, "/spam.py"), + (r"C:\spam.py", ntpath, "C:/spam.py"), + ("\\", ntpath, "/"), + ("\\\\", ntpath, "//"), + ("C:\\\\", ntpath, "C://"), + ("C:/", ntpath, "C:/"), + ("C://", ntpath, "C://"), + ("C:/spam.py", ntpath, "C:/spam.py"), + ], +) +def test_fix_fileid(fileid, os_path, expected): + fixed = fix_fileid( + fileid, + _path_isabs=os_path.isabs, + _normcase=os_path.normcase, + _pathsep=os_path.sep, + ) + assert fixed == expected + + +@pytest.mark.parametrize( + ("fileid", "rootdir", "os_path", "expected"), + [ + ("spam.py", "/eggs", posixpath, "./spam.py"), + ("spam.py", r"\eggs", posixpath, "./spam.py"), + # absolute + ("/spam.py", "/", posixpath, "./spam.py"), + ("/eggs/spam.py", "/eggs", posixpath, "./spam.py"), + ("/eggs/spam.py", "/eggs/", posixpath, "./spam.py"), + # no-op + ("/spam.py", "/eggs", posixpath, "/spam.py"), + ("/spam.py", "/eggs/", posixpath, "/spam.py"), + # root-only (no-op) + ("/", "/", posixpath, "/"), + ("/", "/spam", posixpath, "/"), + ("//", "/", posixpath, "//"), + ("//", "//", posixpath, "//"), + ("//", "//spam", posixpath, "//"), + ("spam.py", "/eggs", ntpath, "./spam.py"), + ("spam.py", r"\eggs", ntpath, "./spam.py"), + # absolute + ("/spam.py", "/", ntpath, "./spam.py"), + ("/eggs/spam.py", "/eggs", ntpath, "./spam.py"), + ("/eggs/spam.py", "/eggs/", ntpath, "./spam.py"), + # no-op + ("/spam.py", "/eggs", ntpath, "/spam.py"), + ("/spam.py", "/eggs/", ntpath, "/spam.py"), + # root-only (no-op) + ("/", "/", ntpath, "/"), + ("/", "/spam", ntpath, "/"), + ("//", "/", ntpath, "//"), + ("//", "//", ntpath, "//"), + ("//", "//spam", ntpath, "//"), + # absolute + (r"\spam.py", "\\", ntpath, r"./spam.py"), + (r"C:\spam.py", "C:\\", ntpath, r"./spam.py"), + (r"\eggs\spam.py", r"\eggs", ntpath, r"./spam.py"), + (r"\eggs\spam.py", "\\eggs\\", ntpath, r"./spam.py"), + # normcase + (r"C:\spam.py", "c:\\", ntpath, r"./spam.py"), + (r"\Eggs\Spam.py", "\\eggs", ntpath, r"./Spam.py"), + (r"\eggs\spam.py", "\\Eggs", ntpath, r"./spam.py"), + (r"\eggs\Spam.py", "\\Eggs", ntpath, r"./Spam.py"), + # no-op + (r"\spam.py", r"\eggs", ntpath, r"/spam.py"), + (r"C:\spam.py", r"C:\eggs", ntpath, r"C:/spam.py"), + # TODO: Should these be supported. + (r"C:\spam.py", "\\", ntpath, r"C:/spam.py"), + (r"\spam.py", "C:\\", ntpath, r"/spam.py"), + # root-only + ("\\", "\\", ntpath, "/"), + ("\\\\", "\\", ntpath, "//"), + ("C:\\", "C:\\eggs", ntpath, "C:/"), + ("C:\\", "C:\\", ntpath, "C:/"), + (r"C:\spam.py", "D:\\", ntpath, r"C:/spam.py"), + ], +) +def test_fix_fileid_rootdir(fileid, rootdir, os_path, expected): + fixed = fix_fileid( + fileid, + rootdir, + _path_isabs=os_path.isabs, + _normcase=os_path.normcase, + _pathsep=os_path.sep, + ) + assert fixed == expected + + +def test_no_args(): + argv = [] + joined = shlex_unsplit(argv) + + assert joined == "" + assert shlex.split(joined) == argv + + +def test_one_arg(): + argv = ["spam"] + joined = shlex_unsplit(argv) + + assert joined == "spam" + assert shlex.split(joined) == argv + + +def test_multiple_args(): + argv = [ + "-x", + "X", + "-xyz", + "spam", + "eggs", + ] + joined = shlex_unsplit(argv) + + assert joined == "-x X -xyz spam eggs" + assert shlex.split(joined) == argv + + +def test_whitespace(): + argv = [ + "-x", + "X Y Z", + "spam spam\tspam", + "eggs", + ] + joined = shlex_unsplit(argv) + + assert joined == "-x 'X Y Z' 'spam spam\tspam' eggs" + assert shlex.split(joined) == argv + + +def test_quotation_marks(): + argv = [ + "-x", + "''", + 'spam"spam"spam', + "ham'ham'ham", + "eggs", + ] + joined = shlex_unsplit(argv) + + assert joined == "-x ''\"'\"''\"'\"'' 'spam\"spam\"spam' 'ham'\"'\"'ham'\"'\"'ham' eggs" + assert shlex.split(joined) == argv From 8b4a47e6de7e124cab3e1abce30ea2f865395037 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 7 Oct 2024 11:26:07 -0700 Subject: [PATCH 135/149] Fixes --- .../tests/testing_tools/adapter/test_util.py | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/python_files/tests/testing_tools/adapter/test_util.py b/python_files/tests/testing_tools/adapter/test_util.py index cfe56eba57ab..e93ecee02eb7 100644 --- a/python_files/tests/testing_tools/adapter/test_util.py +++ b/python_files/tests/testing_tools/adapter/test_util.py @@ -8,7 +8,6 @@ import posixpath import shlex import sys -import unittest import pytest @@ -117,12 +116,16 @@ def test_fix_path(path, expected): ("spam.py", ntpath, r".\spam.py"), (r"eggs\spam.py", ntpath, r".\eggs\spam.py"), ("eggs\\spam\\", ntpath, ".\\eggs\\spam\\"), - ("/spam.py", ntpath, r"\spam.py"), # Note the fixed "/". + ( + "/spam.py", + ntpath, + r".\\spam.py" if is_python313_or_later() else r"\spam.py", + ), # Note the fixed "/". # absolute ("/", posixpath, "/"), ("/spam.py", posixpath, "/spam.py"), - ("\\", ntpath, "\\"), - (r"\spam.py", ntpath, r"\spam.py"), + ("\\", ntpath, ".\\" if is_python313_or_later() else "\\"), + (r"\spam.py", ntpath, r".\\spam.py" if is_python313_or_later() else r"\spam.py"), (r"C:\spam.py", ntpath, r"C:\spam.py"), # no-op ("./spam.py", posixpath, "./spam.py"), @@ -165,9 +168,9 @@ def test_fix_relpath(path, os_path, expected): ("eggs/spam.py", ntpath, "./eggs/spam.py"), ("eggs/spam/", ntpath, "./eggs/spam/"), # absolute (no-op) - ("/", ntpath, "/"), + ("/", ntpath, ".//" if is_python313_or_later() else "/"), ("//", ntpath, "//"), - ("/spam.py", ntpath, "/spam.py"), + ("/spam.py", ntpath, ".//spam.py" if is_python313_or_later() else "/spam.py"), # no-op (None, ntpath, None), ("", ntpath, ""), @@ -177,9 +180,9 @@ def test_fix_relpath(path, os_path, expected): ("eggs\\spam\\", ntpath, "./eggs/spam/"), (r".\spam.py", ntpath, r"./spam.py"), # absolute - (r"\spam.py", ntpath, "/spam.py"), + (r"\spam.py", ntpath, ".//spam.py" if is_python313_or_later() else "/spam.py"), (r"C:\spam.py", ntpath, "C:/spam.py"), - ("\\", ntpath, "/"), + ("\\", ntpath, ".//" if is_python313_or_later() else "/"), ("\\\\", ntpath, "//"), ("C:\\\\", ntpath, "C://"), ("C:/", ntpath, "C:/"), From 0df192989798bac1cc8ba540e1472aaf6d4cde57 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 7 Oct 2024 11:29:40 -0700 Subject: [PATCH 136/149] Fix version --- python_files/tests/testing_tools/adapter/test_util.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python_files/tests/testing_tools/adapter/test_util.py b/python_files/tests/testing_tools/adapter/test_util.py index e93ecee02eb7..50f089361f0a 100644 --- a/python_files/tests/testing_tools/adapter/test_util.py +++ b/python_files/tests/testing_tools/adapter/test_util.py @@ -26,7 +26,7 @@ def is_python313_or_later(): - return sys.version_info >= (3, 1, 3) + return sys.version_info >= (3, 13) def test_isolated_imports(): From e8dd8c057b18e7a47a389c3144e9bce948862a84 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 7 Oct 2024 18:59:57 -0700 Subject: [PATCH 137/149] Fix paths --- python_files/testing_tools/adapter/util.py | 6 ++++++ .../tests/testing_tools/adapter/test_util.py | 12 ++++++------ 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/python_files/testing_tools/adapter/util.py b/python_files/testing_tools/adapter/util.py index 52c0fac757f8..56e3ebf9b1ae 100644 --- a/python_files/testing_tools/adapter/util.py +++ b/python_files/testing_tools/adapter/util.py @@ -102,6 +102,12 @@ def _resolve_relpath( if path.startswith("./"): return path[2:] if not _path_isabs(path): + if rootdir: + rootdir = rootdir.replace(_pathsep, "/") + if not rootdir.endswith("/"): + rootdir += "/" + if _normcase(path).startswith(_normcase(rootdir)): + return path[len(rootdir) :] return path # Deal with root-dir-as-fileid. diff --git a/python_files/tests/testing_tools/adapter/test_util.py b/python_files/tests/testing_tools/adapter/test_util.py index 50f089361f0a..295de15f0369 100644 --- a/python_files/tests/testing_tools/adapter/test_util.py +++ b/python_files/tests/testing_tools/adapter/test_util.py @@ -124,7 +124,7 @@ def test_fix_path(path, expected): # absolute ("/", posixpath, "/"), ("/spam.py", posixpath, "/spam.py"), - ("\\", ntpath, ".\\" if is_python313_or_later() else "\\"), + ("\\", ntpath, ".\\\\" if is_python313_or_later() else "\\"), (r"\spam.py", ntpath, r".\\spam.py" if is_python313_or_later() else r"\spam.py"), (r"C:\spam.py", ntpath, r"C:\spam.py"), # no-op @@ -225,11 +225,11 @@ def test_fix_fileid(fileid, os_path, expected): ("/eggs/spam.py", "/eggs", ntpath, "./spam.py"), ("/eggs/spam.py", "/eggs/", ntpath, "./spam.py"), # no-op - ("/spam.py", "/eggs", ntpath, "/spam.py"), - ("/spam.py", "/eggs/", ntpath, "/spam.py"), + ("/spam.py", "/eggs", ntpath, ".//spam.py" if is_python313_or_later() else "/spam.py"), + ("/spam.py", "/eggs/", ntpath, ".//spam.py" if is_python313_or_later() else "/spam.py"), # root-only (no-op) ("/", "/", ntpath, "/"), - ("/", "/spam", ntpath, "/"), + ("/", "/spam", ntpath, ".//" if is_python313_or_later() else "/"), ("//", "/", ntpath, "//"), ("//", "//", ntpath, "//"), ("//", "//spam", ntpath, "//"), @@ -244,11 +244,11 @@ def test_fix_fileid(fileid, os_path, expected): (r"\eggs\spam.py", "\\Eggs", ntpath, r"./spam.py"), (r"\eggs\Spam.py", "\\Eggs", ntpath, r"./Spam.py"), # no-op - (r"\spam.py", r"\eggs", ntpath, r"/spam.py"), + (r"\spam.py", r"\eggs", ntpath, ".//spam.py" if is_python313_or_later() else r"/spam.py"), (r"C:\spam.py", r"C:\eggs", ntpath, r"C:/spam.py"), # TODO: Should these be supported. (r"C:\spam.py", "\\", ntpath, r"C:/spam.py"), - (r"\spam.py", "C:\\", ntpath, r"/spam.py"), + (r"\spam.py", "C:\\", ntpath, ".//spam.py" if is_python313_or_later() else r"/spam.py"), # root-only ("\\", "\\", ntpath, "/"), ("\\\\", "\\", ntpath, "//"), From fb79afb38cfea80fb780b01f533e4b603c17d932 Mon Sep 17 00:00:00 2001 From: Luciana Abud <45497113+luabud@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:33:42 -0700 Subject: [PATCH 138/149] Add properties to GDPR tags (#24320) --- src/client/telemetry/pylance.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/client/telemetry/pylance.ts b/src/client/telemetry/pylance.ts index 70d901641881..4a79d1b2afa9 100644 --- a/src/client/telemetry/pylance.ts +++ b/src/client/telemetry/pylance.ts @@ -327,6 +327,7 @@ /* __GDPR__ "language_server/settings" : { "addimportexactmatchonly" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, + "aicodeactionsimplementabstractclasses" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "autoimportcompletions" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "autosearchpaths" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "callArgumentNameInlayHints" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, @@ -344,6 +345,7 @@ "intelliCodeEnabled" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "includeusersymbolsinautoimport" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "indexing" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, + "languageservermode" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "lspinteractivewindows" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "lspnotebooks" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, "movesymbol" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }, From 28c13a16eb71548fef2d6231dfa7b6b092a201d7 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Thu, 17 Oct 2024 21:34:07 -0700 Subject: [PATCH 139/149] Fix typo in class name (#24314) --- src/client/interpreter/display/progressDisplay.ts | 2 +- src/client/interpreter/serviceRegistry.ts | 4 ++-- .../interpreters/display/progressDisplay.unit.test.ts | 8 ++++---- src/test/interpreters/serviceRegistry.unit.test.ts | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/client/interpreter/display/progressDisplay.ts b/src/client/interpreter/display/progressDisplay.ts index d9e85b4caf44..4b2811043d2f 100644 --- a/src/client/interpreter/display/progressDisplay.ts +++ b/src/client/interpreter/display/progressDisplay.ts @@ -17,7 +17,7 @@ import { IComponentAdapter } from '../contracts'; // The parts of IComponentAdapter used here. @injectable() -export class InterpreterLocatorProgressStatubarHandler implements IExtensionSingleActivationService { +export class InterpreterLocatorProgressStatusBarHandler implements IExtensionSingleActivationService { public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: true }; private deferred: Deferred | undefined; diff --git a/src/client/interpreter/serviceRegistry.ts b/src/client/interpreter/serviceRegistry.ts index fa44038ec717..688ef20cf970 100644 --- a/src/client/interpreter/serviceRegistry.ts +++ b/src/client/interpreter/serviceRegistry.ts @@ -27,7 +27,7 @@ import { } from './configuration/types'; import { IActivatedEnvironmentLaunch, IInterpreterDisplay, IInterpreterHelper, IInterpreterService } from './contracts'; import { InterpreterDisplay } from './display'; -import { InterpreterLocatorProgressStatubarHandler } from './display/progressDisplay'; +import { InterpreterLocatorProgressStatusBarHandler } from './display/progressDisplay'; import { InterpreterHelper } from './helpers'; import { InterpreterPathCommand } from './interpreterPathCommand'; import { InterpreterService } from './interpreterService'; @@ -83,7 +83,7 @@ export function registerInterpreterTypes(serviceManager: IServiceManager): void serviceManager.addSingleton( IExtensionSingleActivationService, - InterpreterLocatorProgressStatubarHandler, + InterpreterLocatorProgressStatusBarHandler, ); serviceManager.addSingleton( diff --git a/src/test/interpreters/display/progressDisplay.unit.test.ts b/src/test/interpreters/display/progressDisplay.unit.test.ts index 77c5f16f4471..b1acecd44434 100644 --- a/src/test/interpreters/display/progressDisplay.unit.test.ts +++ b/src/test/interpreters/display/progressDisplay.unit.test.ts @@ -11,7 +11,7 @@ import { Commands } from '../../../client/common/constants'; import { createDeferred, Deferred } from '../../../client/common/utils/async'; import { Interpreters } from '../../../client/common/utils/localize'; import { IComponentAdapter } from '../../../client/interpreter/contracts'; -import { InterpreterLocatorProgressStatubarHandler } from '../../../client/interpreter/display/progressDisplay'; +import { InterpreterLocatorProgressStatusBarHandler } from '../../../client/interpreter/display/progressDisplay'; import { ProgressNotificationEvent, ProgressReportStage } from '../../../client/pythonEnvironments/base/locator'; import { noop } from '../../core'; @@ -41,7 +41,7 @@ suite('Interpreters - Display Progress', () => { }); test('Display discovering message when refreshing interpreters for the first time', async () => { const shell = mock(ApplicationShell); - const statusBar = new InterpreterLocatorProgressStatubarHandler(instance(shell), [], componentAdapter); + const statusBar = new InterpreterLocatorProgressStatusBarHandler(instance(shell), [], componentAdapter); when(shell.withProgress(anything(), anything())).thenResolve(); await statusBar.activate(); @@ -53,7 +53,7 @@ suite('Interpreters - Display Progress', () => { test('Display refreshing message when refreshing interpreters for the second time', async () => { const shell = mock(ApplicationShell); - const statusBar = new InterpreterLocatorProgressStatubarHandler(instance(shell), [], componentAdapter); + const statusBar = new InterpreterLocatorProgressStatusBarHandler(instance(shell), [], componentAdapter); when(shell.withProgress(anything(), anything())).thenResolve(); await statusBar.activate(); @@ -70,7 +70,7 @@ suite('Interpreters - Display Progress', () => { test('Progress message is hidden when loading has completed', async () => { const shell = mock(ApplicationShell); - const statusBar = new InterpreterLocatorProgressStatubarHandler(instance(shell), [], componentAdapter); + const statusBar = new InterpreterLocatorProgressStatusBarHandler(instance(shell), [], componentAdapter); when(shell.withProgress(anything(), anything())).thenResolve(); await statusBar.activate(); diff --git a/src/test/interpreters/serviceRegistry.unit.test.ts b/src/test/interpreters/serviceRegistry.unit.test.ts index bb488a49307d..a189696c2f82 100644 --- a/src/test/interpreters/serviceRegistry.unit.test.ts +++ b/src/test/interpreters/serviceRegistry.unit.test.ts @@ -35,7 +35,7 @@ import { IInterpreterService, } from '../../client/interpreter/contracts'; import { InterpreterDisplay } from '../../client/interpreter/display'; -import { InterpreterLocatorProgressStatubarHandler } from '../../client/interpreter/display/progressDisplay'; +import { InterpreterLocatorProgressStatusBarHandler } from '../../client/interpreter/display/progressDisplay'; import { InterpreterHelper } from '../../client/interpreter/helpers'; import { InterpreterService } from '../../client/interpreter/interpreterService'; import { registerTypes } from '../../client/interpreter/serviceRegistry'; @@ -68,7 +68,7 @@ suite('Interpreters - Service Registry', () => { [IInterpreterHelper, InterpreterHelper], [IInterpreterComparer, EnvironmentTypeComparer], - [IExtensionSingleActivationService, InterpreterLocatorProgressStatubarHandler], + [IExtensionSingleActivationService, InterpreterLocatorProgressStatusBarHandler], [IInterpreterAutoSelectionProxyService, InterpreterAutoSelectionProxyService], [IInterpreterAutoSelectionService, InterpreterAutoSelectionService], From 5e5a7ce7b6b516d4919d72a27dc18c9ec3992861 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Thu, 17 Oct 2024 21:34:33 -0700 Subject: [PATCH 140/149] add error message for missing pytest-cov while running coverage (#24288) this error message is more specific than the generic "doesn't recognize argument `--cov=.`" and will help point users in the right direction to knowing how to enable coverage. --- python_files/vscode_pytest/__init__.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/python_files/vscode_pytest/__init__.py b/python_files/vscode_pytest/__init__.py index ca06bf174418..028839b13212 100644 --- a/python_files/vscode_pytest/__init__.py +++ b/python_files/vscode_pytest/__init__.py @@ -67,6 +67,13 @@ def __init__(self, message): def pytest_load_initial_conftests(early_config, parser, args): # noqa: ARG001 + has_pytest_cov = early_config.pluginmanager.hasplugin("pytest_cov") + has_cov_arg = any("--cov" in arg for arg in args) + if has_cov_arg and not has_pytest_cov: + raise VSCodePytestError( + "\n \nERROR: pytest-cov is not installed, please install this before running pytest with coverage as pytest-cov is required. \n" + ) + global TEST_RUN_PIPE TEST_RUN_PIPE = os.getenv("TEST_RUN_PIPE") error_string = ( From e7860a54a1806c208d1e33931fab4fc8a4dfc7b7 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 21 Oct 2024 11:07:05 -0700 Subject: [PATCH 141/149] Restore `pixi` functionality only when Pixi is available (#24319) Fixes https://github.com/microsoft/vscode-python/issues/24310 --- .../common/process/pythonExecutionFactory.ts | 26 +- .../pixiActivationProvider.ts | 39 +-- src/client/common/terminal/helper.ts | 14 + src/client/extensionActivation.ts | 2 + src/client/interpreter/activation/service.ts | 6 + .../base/locators/lowLevel/pixiLocator.ts | 4 +- .../common/environmentManagers/pixi.ts | 291 +++++++++++------- .../pythonExecutionFactory.unit.test.ts | 7 + src/test/common/terminals/helper.unit.test.ts | 27 +- .../lowLevel/pixiLocator.unit.test.ts | 24 +- .../environmentManagers/pixi.unit.test.ts | 16 +- .../testing/common/testingAdapter.test.ts | 9 + 12 files changed, 266 insertions(+), 199 deletions(-) diff --git a/src/client/common/process/pythonExecutionFactory.ts b/src/client/common/process/pythonExecutionFactory.ts index d8401a603d03..efb05c3c9d12 100644 --- a/src/client/common/process/pythonExecutionFactory.ts +++ b/src/client/common/process/pythonExecutionFactory.ts @@ -25,7 +25,7 @@ import { import { IInterpreterAutoSelectionService } from '../../interpreter/autoSelection/types'; import { sleep } from '../utils/async'; import { traceError } from '../../logging'; -import { getPixiEnvironmentFromInterpreter } from '../../pythonEnvironments/common/environmentManagers/pixi'; +import { getPixi, getPixiEnvironmentFromInterpreter } from '../../pythonEnvironments/common/environmentManagers/pixi'; @injectable() export class PythonExecutionFactory implements IPythonExecutionFactory { @@ -80,16 +80,18 @@ export class PythonExecutionFactory implements IPythonExecutionFactory { } const processService: IProcessService = await this.processServiceFactory.create(options.resource); + if (await getPixi()) { + const pixiExecutionService = await this.createPixiExecutionService(pythonPath, processService); + if (pixiExecutionService) { + return pixiExecutionService; + } + } + const condaExecutionService = await this.createCondaExecutionService(pythonPath, processService); if (condaExecutionService) { return condaExecutionService; } - const pixiExecutionService = await this.createPixiExecutionService(pythonPath, processService); - if (pixiExecutionService) { - return pixiExecutionService; - } - const windowsStoreInterpreterCheck = this.pyenvs.isMicrosoftStoreInterpreter.bind(this.pyenvs); const env = (await windowsStoreInterpreterCheck(pythonPath)) @@ -122,16 +124,18 @@ export class PythonExecutionFactory implements IPythonExecutionFactory { processService.on('exec', this.logger.logProcess.bind(this.logger)); this.disposables.push(processService); + if (await getPixi()) { + const pixiExecutionService = await this.createPixiExecutionService(pythonPath, processService); + if (pixiExecutionService) { + return pixiExecutionService; + } + } + const condaExecutionService = await this.createCondaExecutionService(pythonPath, processService); if (condaExecutionService) { return condaExecutionService; } - const pixiExecutionService = await this.createPixiExecutionService(pythonPath, processService); - if (pixiExecutionService) { - return pixiExecutionService; - } - const env = createPythonEnv(pythonPath, processService, this.fileSystem); return createPythonService(processService, env); } diff --git a/src/client/common/terminal/environmentActivationProviders/pixiActivationProvider.ts b/src/client/common/terminal/environmentActivationProviders/pixiActivationProvider.ts index f9110f6be60c..1deaa56dd8ae 100644 --- a/src/client/common/terminal/environmentActivationProviders/pixiActivationProvider.ts +++ b/src/client/common/terminal/environmentActivationProviders/pixiActivationProvider.ts @@ -8,13 +8,7 @@ import { inject, injectable } from 'inversify'; import { Uri } from 'vscode'; import { IInterpreterService } from '../../../interpreter/contracts'; import { ITerminalActivationCommandProvider, TerminalShellType } from '../types'; -import { traceError } from '../../../logging'; -import { - getPixiEnvironmentFromInterpreter, - isNonDefaultPixiEnvironmentName, -} from '../../../pythonEnvironments/common/environmentManagers/pixi'; -import { exec } from '../../../pythonEnvironments/common/externalDependencies'; -import { splitLines } from '../../stringUtils'; +import { getPixiActivationCommands } from '../../../pythonEnvironments/common/environmentManagers/pixi'; @injectable() export class PixiActivationCommandProvider implements ITerminalActivationCommandProvider { @@ -37,38 +31,11 @@ export class PixiActivationCommandProvider implements ITerminalActivationCommand return this.getActivationCommandsForInterpreter(interpreter.path, targetShell); } - public async getActivationCommandsForInterpreter( + public getActivationCommandsForInterpreter( pythonPath: string, targetShell: TerminalShellType, ): Promise { - const pixiEnv = await getPixiEnvironmentFromInterpreter(pythonPath); - if (!pixiEnv) { - return undefined; - } - - const command = ['shell-hook', '--manifest-path', pixiEnv.manifestPath]; - if (isNonDefaultPixiEnvironmentName(pixiEnv.envName)) { - command.push('--environment'); - command.push(pixiEnv.envName); - } - - const pixiTargetShell = shellTypeToPixiShell(targetShell); - if (pixiTargetShell) { - command.push('--shell'); - command.push(pixiTargetShell); - } - - const shellHookOutput = await exec(pixiEnv.pixi.command, command, { - throwOnStdErr: false, - }).catch(traceError); - if (!shellHookOutput) { - return undefined; - } - - return splitLines(shellHookOutput.stdout, { - removeEmptyEntries: true, - trim: true, - }); + return getPixiActivationCommands(pythonPath, targetShell); } } diff --git a/src/client/common/terminal/helper.ts b/src/client/common/terminal/helper.ts index 9fcdd98bd289..d2b3bb7879af 100644 --- a/src/client/common/terminal/helper.ts +++ b/src/client/common/terminal/helper.ts @@ -22,6 +22,7 @@ import { TerminalActivationProviders, TerminalShellType, } from './types'; +import { isPixiEnvironment } from '../../pythonEnvironments/common/environmentManagers/pixi'; @injectable() export class TerminalHelper implements ITerminalHelper { @@ -143,6 +144,19 @@ export class TerminalHelper implements ITerminalHelper { ): Promise { const settings = this.configurationService.getSettings(resource); + const isPixiEnv = interpreter + ? interpreter.envType === EnvironmentType.Pixi + : await isPixiEnvironment(settings.pythonPath); + if (isPixiEnv) { + const activationCommands = interpreter + ? await this.pixi.getActivationCommandsForInterpreter(interpreter.path, terminalShellType) + : await this.pixi.getActivationCommands(resource, terminalShellType); + + if (Array.isArray(activationCommands)) { + return activationCommands; + } + } + const condaService = this.serviceContainer.get(IComponentAdapter); // If we have a conda environment, then use that. const isCondaEnvironment = interpreter diff --git a/src/client/extensionActivation.ts b/src/client/extensionActivation.ts index a4da35c88b9b..38f2d6a56277 100644 --- a/src/client/extensionActivation.ts +++ b/src/client/extensionActivation.ts @@ -54,6 +54,7 @@ import { StopWatch } from './common/utils/stopWatch'; import { registerReplCommands, registerReplExecuteOnEnter, registerStartNativeReplCommand } from './repl/replCommands'; import { registerTriggerForTerminalREPL } from './terminals/codeExecution/terminalReplWatcher'; import { registerPythonStartup } from './terminals/pythonStartup'; +import { registerPixiFeatures } from './pythonEnvironments/common/environmentManagers/pixi'; export async function activateComponents( // `ext` is passed to any extra activation funcs. @@ -100,6 +101,7 @@ export function activateFeatures(ext: ExtensionState, _components: Components): IInterpreterService, ); const pathUtils = ext.legacyIOC.serviceContainer.get(IPathUtils); + registerPixiFeatures(ext.disposables); registerAllCreateEnvironmentFeatures( ext.disposables, interpreterQuickPick, diff --git a/src/client/interpreter/activation/service.ts b/src/client/interpreter/activation/service.ts index 586bad0d765c..6b49444b3b3d 100644 --- a/src/client/interpreter/activation/service.ts +++ b/src/client/interpreter/activation/service.ts @@ -39,6 +39,7 @@ import { StopWatch } from '../../common/utils/stopWatch'; import { identifyShellFromShellPath } from '../../common/terminal/shellDetectors/baseShellDetector'; import { getSearchPathEnvVarNames } from '../../common/utils/exec'; import { cache } from '../../common/utils/decorators'; +import { getRunPixiPythonCommand } from '../../pythonEnvironments/common/environmentManagers/pixi'; const ENVIRONMENT_PREFIX = 'e8b39361-0157-4923-80e1-22d70d46dee6'; const CACHE_DURATION = 10 * 60 * 1000; @@ -252,6 +253,11 @@ export class EnvironmentActivationService implements IEnvironmentActivationServi // Using environment prefix isn't needed as the marker script already takes care of it. command = [...pythonArgv, ...args].map((arg) => arg.toCommandArgumentForPythonExt()).join(' '); } + } else if (interpreter?.envType === EnvironmentType.Pixi) { + const pythonArgv = await getRunPixiPythonCommand(interpreter.path); + if (pythonArgv) { + command = [...pythonArgv, ...args].map((arg) => arg.toCommandArgumentForPythonExt()).join(' '); + } } if (!command) { const activationCommands = await this.helper.getEnvironmentActivationShellCommands( diff --git a/src/client/pythonEnvironments/base/locators/lowLevel/pixiLocator.ts b/src/client/pythonEnvironments/base/locators/lowLevel/pixiLocator.ts index 7cdc78ec6f10..f4a3886a2120 100644 --- a/src/client/pythonEnvironments/base/locators/lowLevel/pixiLocator.ts +++ b/src/client/pythonEnvironments/base/locators/lowLevel/pixiLocator.ts @@ -6,17 +6,17 @@ import { asyncFilter } from '../../../../common/utils/arrayUtils'; import { chain, iterable } from '../../../../common/utils/async'; import { traceError, traceVerbose } from '../../../../logging'; import { getCondaInterpreterPath } from '../../../common/environmentManagers/conda'; -import { Pixi } from '../../../common/environmentManagers/pixi'; import { pathExists } from '../../../common/externalDependencies'; import { PythonEnvKind } from '../../info'; import { IPythonEnvsIterator, BasicEnvInfo } from '../../locator'; import { FSWatcherKind, FSWatchingLocator } from './fsWatchingLocator'; +import { getPixi } from '../../../common/environmentManagers/pixi'; /** * Returns all virtual environment locations to look for in a workspace. */ async function getVirtualEnvDirs(root: string): Promise { - const pixi = await Pixi.getPixi(); + const pixi = await getPixi(); const envDirs = (await pixi?.getEnvList(root)) ?? []; return asyncFilter(envDirs, pathExists); } diff --git a/src/client/pythonEnvironments/common/environmentManagers/pixi.ts b/src/client/pythonEnvironments/common/environmentManagers/pixi.ts index 32db66932385..6abf26f830fb 100644 --- a/src/client/pythonEnvironments/common/environmentManagers/pixi.ts +++ b/src/client/pythonEnvironments/common/environmentManagers/pixi.ts @@ -5,12 +5,17 @@ import * as path from 'path'; import { readJSON } from 'fs-extra'; -import { OSType, getOSType, getUserHomeDir } from '../../../common/utils/platform'; -import { exec, getPythonSetting, onDidChangePythonSetting, pathExists, pathExistsSync } from '../externalDependencies'; +import which from 'which'; +import { getUserHomeDir } from '../../../common/utils/platform'; +import { exec, getPythonSetting, onDidChangePythonSetting, pathExists } from '../externalDependencies'; import { cache } from '../../../common/utils/decorators'; -import { isTestExecution } from '../../../common/constants'; import { traceVerbose, traceWarn } from '../../../logging'; import { OUTPUT_MARKER_SCRIPT } from '../../../common/process/internal/scripts'; +import { isWindows } from '../../../common/platform/platformService'; +import { IDisposableRegistry } from '../../../common/types'; +import { getWorkspaceFolderPaths } from '../../../common/vscodeApis/workspaceApis'; +import { isTestExecution } from '../../../common/constants'; +import { TerminalShellType } from '../../../common/terminal/types'; export const PIXITOOLPATH_SETTING_KEY = 'pixiToolPath'; @@ -63,94 +68,31 @@ export async function isPixiEnvironment(interpreterPath: string): Promise { + try { + return await which('pixi', { all: true }); + } catch { + // Ignore errors + } + return []; +} + /** Wraps the "pixi" utility, and exposes its functionality. */ export class Pixi { - /** - * Locating pixi binary can be expensive, since it potentially involves spawning or - * trying to spawn processes; so we only do it once per session. - */ - private static pixiPromise: Promise | undefined; - /** * Creates a Pixi service corresponding to the corresponding "pixi" command. * * @param command - Command used to run pixi. This has the same meaning as the * first argument of spawn() - i.e. it can be a full path, or just a binary name. */ - constructor(public readonly command: string) { - onDidChangePythonSetting(PIXITOOLPATH_SETTING_KEY, () => { - Pixi.pixiPromise = undefined; - }); - } - - /** - * Returns a Pixi instance corresponding to the binary which can be used to run commands for the cwd. - * - * Pixi commands can be slow and so can be bottleneck to overall discovery time. So trigger command - * execution as soon as possible. To do that we need to ensure the operations before the command are - * performed synchronously. - */ - public static async getPixi(): Promise { - if (Pixi.pixiPromise === undefined || isTestExecution()) { - Pixi.pixiPromise = Pixi.locate(); - } - return Pixi.pixiPromise; - } - - private static async locate(): Promise { - // First thing this method awaits on should be pixi command execution, hence perform all operations - // before that synchronously. - - traceVerbose(`Getting pixi`); - // Produce a list of candidate binaries to be probed by exec'ing them. - function* getCandidates() { - // Read the pixi location from the settings. - try { - const customPixiToolPath = getPythonSetting(PIXITOOLPATH_SETTING_KEY); - if (customPixiToolPath && customPixiToolPath !== 'pixi') { - // If user has specified a custom pixi path, use it first. - yield customPixiToolPath; - } - } catch (ex) { - traceWarn(`Failed to get pixi setting`, ex); - } - - // Check unqualified filename, in case it's on PATH. - yield 'pixi'; - - // Check the default installation location - const home = getUserHomeDir(); - if (home) { - const defaultpixiToolPath = path.join(home, '.pixi', 'bin', 'pixi'); - if (pathExistsSync(defaultpixiToolPath)) { - yield defaultpixiToolPath; - } - } - } - - // Probe the candidates, and pick the first one that exists and does what we need. - for (const pixiToolPath of getCandidates()) { - traceVerbose(`Probing pixi binary: ${pixiToolPath}`); - const pixi = new Pixi(pixiToolPath); - const pixiVersion = await pixi.getVersion(); - if (pixiVersion !== undefined) { - traceVerbose(`Found pixi ${pixiVersion} via filesystem probing: ${pixiToolPath}`); - return pixi; - } - traceVerbose(`Failed to find pixi: ${pixiToolPath}`); - } - - // Didn't find anything. - traceVerbose(`No pixi binary found`); - return undefined; - } + constructor(public readonly command: string) {} /** * Retrieves list of Python environments known to this pixi for the specified directory. @@ -187,29 +129,6 @@ export class Pixi { } } - /** - * Runs `pixi --version` and returns the version part of the output. - */ - @cache(30_000, true, 10_000) - public async getVersion(): Promise { - try { - const versionOutput = await exec(this.command, ['--version'], { - throwOnStdErr: false, - }); - if (!versionOutput || !versionOutput.stdout) { - return undefined; - } - const versionParts = versionOutput.stdout.split(' '); - if (versionParts.length < 2) { - return undefined; - } - return versionParts[1].trim(); - } catch (error) { - traceVerbose(`Failed to get pixi version`, error); - return undefined; - } - } - /** * Returns the command line arguments to run `python` within a specific pixi environment. * @param manifestPath The path to the manifest file used by pixi. @@ -240,9 +159,62 @@ export class Pixi { // eslint-disable-next-line class-methods-use-this async getPixiEnvironmentMetadata(envDir: string): Promise { const pixiPath = path.join(envDir, 'conda-meta/pixi'); - const result: PixiEnvMetadata | undefined = await readJSON(pixiPath).catch(traceVerbose); - return result; + try { + const result: PixiEnvMetadata | undefined = await readJSON(pixiPath); + return result; + } catch (e) { + traceVerbose(`Failed to get pixi environment metadata for ${envDir}`, e); + } + return undefined; + } +} + +async function getPixiTool(): Promise { + let pixi = getPythonSetting(PIXITOOLPATH_SETTING_KEY); + + if (!pixi || pixi === 'pixi' || !(await pathExists(pixi))) { + pixi = undefined; + const paths = await findPixiOnPath(); + for (const p of paths) { + if (await pathExists(p)) { + pixi = p; + break; + } + } + } + + if (!pixi) { + // Check the default installation location + const home = getUserHomeDir(); + if (home) { + const pixiToolPath = path.join(home, '.pixi', 'bin', isWindows() ? 'pixi.exe' : 'pixi'); + if (await pathExists(pixiToolPath)) { + pixi = pixiToolPath; + } + } + } + + return pixi ? new Pixi(pixi) : undefined; +} + +/** + * Locating pixi binary can be expensive, since it potentially involves spawning or + * trying to spawn processes; so we only do it once per session. + */ +let _pixi: Promise | undefined; + +/** + * Returns a Pixi instance corresponding to the binary which can be used to run commands for the cwd. + * + * Pixi commands can be slow and so can be bottleneck to overall discovery time. So trigger command + * execution as soon as possible. To do that we need to ensure the operations before the command are + * performed synchronously. + */ +export function getPixi(): Promise { + if (_pixi === undefined || isTestExecution()) { + _pixi = getPixiTool(); } + return _pixi; } export type PixiEnvironmentInfo = { @@ -253,6 +225,12 @@ export type PixiEnvironmentInfo = { envName?: string; }; +function isPixiProjectDir(pixiProjectDir: string): boolean { + const paths = getWorkspaceFolderPaths().map((f) => path.normalize(f)); + const normalized = path.normalize(pixiProjectDir); + return paths.some((p) => p === normalized); +} + /** * Given the location of an interpreter, try to deduce information about the environment in which it * resides. @@ -262,16 +240,13 @@ export type PixiEnvironmentInfo = { */ export async function getPixiEnvironmentFromInterpreter( interpreterPath: string, - pixi?: Pixi, ): Promise { if (!interpreterPath) { return undefined; } const prefix = getPrefixFromInterpreterPath(interpreterPath); - - // Find the pixi executable for the project - pixi = pixi || (await Pixi.getPixi()); + const pixi = await getPixi(); if (!pixi) { traceVerbose(`could not find a pixi interpreter for the interpreter at ${interpreterPath}`); return undefined; @@ -304,30 +279,108 @@ export async function getPixiEnvironmentFromInterpreter( envsDir = path.dirname(prefix); dotPixiDir = path.dirname(envsDir); pixiProjectDir = path.dirname(dotPixiDir); + if (!isPixiProjectDir(pixiProjectDir)) { + traceVerbose(`could not determine the pixi project directory for the interpreter at ${interpreterPath}`); + return undefined; + } // Invoke pixi to get information about the pixi project pixiInfo = await pixi.getPixiInfo(pixiProjectDir); + + if (!pixiInfo || !pixiInfo.project_info) { + traceWarn(`failed to determine pixi project information for the interpreter at ${interpreterPath}`); + return undefined; + } + + return { + interpreterPath, + pixi, + pixiVersion: pixiInfo.version, + manifestPath: pixiInfo.project_info.manifest_path, + envName, + }; } catch (error) { traceWarn('Error processing paths or getting Pixi Info:', error); } - if (!pixiInfo || !pixiInfo.project_info) { - traceWarn(`failed to determine pixi project information for the interpreter at ${interpreterPath}`); - return undefined; - } - - return { - interpreterPath, - pixi, - pixiVersion: pixiInfo.version, - manifestPath: pixiInfo.project_info.manifest_path, - envName, - }; + return undefined; } /** * Returns true if the given environment name is *not* the default environment. */ export function isNonDefaultPixiEnvironmentName(envName?: string): envName is string { - return envName !== undefined && envName !== 'default'; + return envName !== 'default'; +} + +export function registerPixiFeatures(disposables: IDisposableRegistry): void { + disposables.push( + onDidChangePythonSetting(PIXITOOLPATH_SETTING_KEY, () => { + _pixi = getPixiTool(); + }), + ); +} + +/** + * Returns the `pixi run` command + */ +export async function getRunPixiPythonCommand(pythonPath: string): Promise { + const pixiEnv = await getPixiEnvironmentFromInterpreter(pythonPath); + if (!pixiEnv) { + return undefined; + } + + const args = [ + pixiEnv.pixi.command.toCommandArgumentForPythonExt(), + 'run', + '--manifest-path', + pixiEnv.manifestPath.toCommandArgumentForPythonExt(), + ]; + if (isNonDefaultPixiEnvironmentName(pixiEnv.envName)) { + args.push('--environment'); + args.push(pixiEnv.envName.toCommandArgumentForPythonExt()); + } + + args.push('python'); + return args; +} + +export async function getPixiActivationCommands( + pythonPath: string, + _targetShell?: TerminalShellType, +): Promise { + const pixiEnv = await getPixiEnvironmentFromInterpreter(pythonPath); + if (!pixiEnv) { + return undefined; + } + + const args = [ + pixiEnv.pixi.command.toCommandArgumentForPythonExt(), + 'shell', + '--manifest-path', + pixiEnv.manifestPath.toCommandArgumentForPythonExt(), + ]; + if (isNonDefaultPixiEnvironmentName(pixiEnv.envName)) { + args.push('--environment'); + args.push(pixiEnv.envName.toCommandArgumentForPythonExt()); + } + + // const pixiTargetShell = shellTypeToPixiShell(targetShell); + // if (pixiTargetShell) { + // args.push('--shell'); + // args.push(pixiTargetShell); + // } + + // const shellHookOutput = await exec(pixiEnv.pixi.command, args, { + // throwOnStdErr: false, + // }).catch(traceError); + // if (!shellHookOutput) { + // return undefined; + // } + + // return splitLines(shellHookOutput.stdout, { + // removeEmptyEntries: true, + // trim: true, + // }); + return [args.join(' ')]; } diff --git a/src/test/common/process/pythonExecutionFactory.unit.test.ts b/src/test/common/process/pythonExecutionFactory.unit.test.ts index dd0061b79d63..0981c59e78bb 100644 --- a/src/test/common/process/pythonExecutionFactory.unit.test.ts +++ b/src/test/common/process/pythonExecutionFactory.unit.test.ts @@ -89,6 +89,7 @@ suite('Process - PythonExecutionFactory', () => { let autoSelection: IInterpreterAutoSelectionService; let interpreterPathExpHelper: IInterpreterPathService; let getPixiEnvironmentFromInterpreterStub: sinon.SinonStub; + let getPixiStub: sinon.SinonStub; const pythonPath = 'path/to/python'; setup(() => { sinon.stub(Conda, 'getConda').resolves(new Conda('conda')); @@ -97,6 +98,9 @@ suite('Process - PythonExecutionFactory', () => { getPixiEnvironmentFromInterpreterStub = sinon.stub(pixi, 'getPixiEnvironmentFromInterpreter'); getPixiEnvironmentFromInterpreterStub.resolves(undefined); + getPixiStub = sinon.stub(pixi, 'getPixi'); + getPixiStub.resolves(undefined); + activationHelper = mock(EnvironmentActivationService); processFactory = mock(ProcessServiceFactory); configService = mock(ConfigurationService); @@ -142,6 +146,9 @@ suite('Process - PythonExecutionFactory', () => { when(serviceContainer.tryGet(IInterpreterService)).thenReturn( instance(interpreterService), ); + when(serviceContainer.get(IConfigurationService)).thenReturn( + instance(configService), + ); factory = new PythonExecutionFactory( instance(serviceContainer), instance(activationHelper), diff --git a/src/test/common/terminals/helper.unit.test.ts b/src/test/common/terminals/helper.unit.test.ts index e4a0ab9bd3e8..864188b7c7b4 100644 --- a/src/test/common/terminals/helper.unit.test.ts +++ b/src/test/common/terminals/helper.unit.test.ts @@ -211,8 +211,8 @@ suite('Terminal Service helpers', () => { const cmd = await helper.getEnvironmentActivationCommands(anything(), resource); expect(cmd).to.equal(condaActivationCommands); - verify(pythonSettings.pythonPath).once(); - verify(condaService.isCondaEnvironment(pythonPath)).once(); + verify(pythonSettings.pythonPath).atLeast(1); + verify(condaService.isCondaEnvironment(pythonPath)).atLeast(1); verify(condaActivationProvider.getActivationCommands(resource, anything())).once(); }); test('Activation command must return undefined if none of the proivders support the shell', async () => { @@ -231,8 +231,8 @@ suite('Terminal Service helpers', () => { ); expect(cmd).to.equal(undefined, 'Command must be undefined'); - verify(pythonSettings.pythonPath).once(); - verify(condaService.isCondaEnvironment(pythonPath)).once(); + verify(pythonSettings.pythonPath).atLeast(1); + verify(condaService.isCondaEnvironment(pythonPath)).atLeast(1); verify(bashActivationProvider.isShellSupported(anything())).atLeast(1); verify(nushellActivationProvider.isShellSupported(anything())).atLeast(1); verify(pyenvActivationProvider.isShellSupported(anything())).atLeast(1); @@ -255,8 +255,8 @@ suite('Terminal Service helpers', () => { const cmd = await helper.getEnvironmentActivationCommands(anything(), resource); expect(cmd).to.deep.equal(expectCommand); - verify(pythonSettings.pythonPath).once(); - verify(condaService.isCondaEnvironment(pythonPath)).once(); + verify(pythonSettings.pythonPath).atLeast(1); + verify(condaService.isCondaEnvironment(pythonPath)).atLeast(1); verify(bashActivationProvider.isShellSupported(anything())).atLeast(1); verify(bashActivationProvider.getActivationCommands(resource, anything())).once(); verify(nushellActivationProvider.isShellSupported(anything())).atLeast(1); @@ -287,7 +287,7 @@ suite('Terminal Service helpers', () => { const cmd = await helper.getEnvironmentActivationCommands(anything(), resource); expect(cmd).to.deep.equal(expectCommand); - verify(pythonSettings.pythonPath).once(); + verify(pythonSettings.pythonPath).atLeast(1); verify(condaService.isCondaEnvironment(pythonPath)).once(); verify(bashActivationProvider.isShellSupported(anything())).atLeast(1); verify(bashActivationProvider.getActivationCommands(resource, anything())).never(); @@ -313,7 +313,7 @@ suite('Terminal Service helpers', () => { const cmd = await helper.getEnvironmentActivationCommands(anything(), resource); expect(cmd).to.deep.equal(expectCommand); - verify(pythonSettings.pythonPath).once(); + verify(pythonSettings.pythonPath).atLeast(1); verify(condaService.isCondaEnvironment(pythonPath)).once(); verify(bashActivationProvider.isShellSupported(anything())).atLeast(1); verify(nushellActivationProvider.isShellSupported(anything())).atLeast(1); @@ -340,7 +340,7 @@ suite('Terminal Service helpers', () => { const cmd = await helper.getEnvironmentActivationCommands(anything(), resource); expect(cmd).to.deep.equal(expectCommand); - verify(pythonSettings.pythonPath).once(); + verify(pythonSettings.pythonPath).atLeast(1); verify(condaService.isCondaEnvironment(pythonPath)).once(); verify(bashActivationProvider.getActivationCommands(resource, anything())).once(); verify(cmdActivationProvider.getActivationCommands(resource, anything())).once(); @@ -387,8 +387,13 @@ suite('Terminal Service helpers', () => { ); expect(cmd).to.equal(undefined, 'Command must be undefined'); - verify(pythonSettings.pythonPath).times(interpreter ? 0 : 1); - verify(condaService.isCondaEnvironment(pythonPath)).times(interpreter ? 0 : 1); + if (interpreter) { + verify(pythonSettings.pythonPath).never(); + verify(condaService.isCondaEnvironment(pythonPath)).never(); + } else { + verify(pythonSettings.pythonPath).atLeast(1); + verify(condaService.isCondaEnvironment(pythonPath)).atLeast(1); + } verify(bashActivationProvider.isShellSupported(shellToExpect)).atLeast(1); verify(pyenvActivationProvider.isShellSupported(anything())).never(); verify(pipenvActivationProvider.isShellSupported(anything())).never(); diff --git a/src/test/pythonEnvironments/base/locators/lowLevel/pixiLocator.unit.test.ts b/src/test/pythonEnvironments/base/locators/lowLevel/pixiLocator.unit.test.ts index 6bb147b41832..b55f61c3a771 100644 --- a/src/test/pythonEnvironments/base/locators/lowLevel/pixiLocator.unit.test.ts +++ b/src/test/pythonEnvironments/base/locators/lowLevel/pixiLocator.unit.test.ts @@ -17,12 +17,15 @@ suite('Pixi Locator', () => { let getPythonSetting: sinon.SinonStub; let getOSType: sinon.SinonStub; let locator: PixiLocator; + let pathExistsStub: sinon.SinonStub; suiteSetup(() => { getPythonSetting = sinon.stub(externalDependencies, 'getPythonSetting'); getPythonSetting.returns('pixi'); getOSType = sinon.stub(platformUtils, 'getOSType'); exec = sinon.stub(externalDependencies, 'exec'); + pathExistsStub = sinon.stub(externalDependencies, 'pathExists'); + pathExistsStub.resolves(true); }); suiteTeardown(() => sinon.restore()); @@ -38,7 +41,7 @@ suite('Pixi Locator', () => { getOSType.returns(osType); locator = new PixiLocator(projectDir); - exec.callsFake(makeExecHandler({ pixiPath: 'pixi', cwd: projectDir })); + exec.callsFake(makeExecHandler({ cwd: projectDir })); const iterator = locator.iterEnvs(); const actualEnvs = await getEnvs(iterator); @@ -66,26 +69,15 @@ suite('Pixi Locator', () => { test('project with multiple environments', async () => { getOSType.returns(platformUtils.OSType.Linux); - exec.callsFake(makeExecHandler({ pixiPath: 'pixi', cwd: projectDirs.multiEnv.path })); + exec.callsFake(makeExecHandler({ cwd: projectDirs.multiEnv.path })); locator = new PixiLocator(projectDirs.multiEnv.path); const iterator = locator.iterEnvs(); const actualEnvs = await getEnvs(iterator); - const expectedEnvs = [ - createBasicEnv( - PythonEnvKind.Pixi, - path.join(projectDirs.multiEnv.info.environments_info[1].prefix, 'bin/python'), - undefined, - projectDirs.multiEnv.info.environments_info[1].prefix, - ), - createBasicEnv( - PythonEnvKind.Pixi, - path.join(projectDirs.multiEnv.info.environments_info[2].prefix, 'bin/python'), - undefined, - projectDirs.multiEnv.info.environments_info[2].prefix, - ), - ]; + const expectedEnvs = projectDirs.multiEnv.info.environments_info.map((info) => + createBasicEnv(PythonEnvKind.Pixi, path.join(info.prefix, 'bin/python'), undefined, info.prefix), + ); assertBasicEnvsEqual(actualEnvs, expectedEnvs); }); }); diff --git a/src/test/pythonEnvironments/common/environmentManagers/pixi.unit.test.ts b/src/test/pythonEnvironments/common/environmentManagers/pixi.unit.test.ts index d6b283c69fd3..0cbc6b25145c 100644 --- a/src/test/pythonEnvironments/common/environmentManagers/pixi.unit.test.ts +++ b/src/test/pythonEnvironments/common/environmentManagers/pixi.unit.test.ts @@ -4,7 +4,7 @@ import * as sinon from 'sinon'; import { ExecutionResult, ShellOptions } from '../../../../client/common/process/types'; import * as externalDependencies from '../../../../client/pythonEnvironments/common/externalDependencies'; import { TEST_LAYOUT_ROOT } from '../commonTestConstants'; -import { Pixi } from '../../../../client/pythonEnvironments/common/environmentManagers/pixi'; +import { getPixi } from '../../../../client/pythonEnvironments/common/environmentManagers/pixi'; export type PixiCommand = { cmd: 'info --json' } | { cmd: '--version' } | { cmd: null }; @@ -105,10 +105,12 @@ export function makeExecHandler(verify: VerifyOptions = {}) { suite('Pixi binary is located correctly', async () => { let exec: sinon.SinonStub; let getPythonSetting: sinon.SinonStub; + let pathExists: sinon.SinonStub; setup(() => { getPythonSetting = sinon.stub(externalDependencies, 'getPythonSetting'); exec = sinon.stub(externalDependencies, 'exec'); + pathExists = sinon.stub(externalDependencies, 'pathExists'); }); teardown(() => { @@ -117,10 +119,16 @@ suite('Pixi binary is located correctly', async () => { const testPath = async (pixiPath: string, verify = true) => { getPythonSetting.returns(pixiPath); + pathExists.returns(pixiPath !== 'pixi'); // If `verify` is false, don’t verify that the command has been called with that path exec.callsFake(makeExecHandler(verify ? { pixiPath } : undefined)); - const pixi = await Pixi.getPixi(); - expect(pixi?.command).to.equal(pixiPath); + const pixi = await getPixi(); + + if (pixiPath === 'pixi') { + expect(pixi).to.equal(undefined); + } else { + expect(pixi?.command).to.equal(pixiPath); + } }; test('Return a Pixi instance in an empty directory', () => testPath('pixiPath', false)); @@ -133,7 +141,7 @@ suite('Pixi binary is located correctly', async () => { exec.callsFake((_file: string, _args: string[], _options: ShellOptions) => Promise.reject(new Error('Command failed')), ); - const pixi = await Pixi.getPixi(); + const pixi = await getPixi(); expect(pixi?.command).to.equal(undefined); }); }); diff --git a/src/test/testing/common/testingAdapter.test.ts b/src/test/testing/common/testingAdapter.test.ts index dcd45b2e56bc..8a1891962429 100644 --- a/src/test/testing/common/testingAdapter.test.ts +++ b/src/test/testing/common/testingAdapter.test.ts @@ -7,6 +7,7 @@ import * as path from 'path'; import * as assert from 'assert'; import * as fs from 'fs'; import * as os from 'os'; +import * as sinon from 'sinon'; import { PytestTestDiscoveryAdapter } from '../../../client/testing/testController/pytest/pytestDiscoveryAdapter'; import { ITestController, ITestResultResolver } from '../../../client/testing/testController/common/types'; import { IPythonExecutionFactory } from '../../../client/common/process/types'; @@ -22,6 +23,7 @@ import { TestProvider } from '../../../client/testing/types'; import { PYTEST_PROVIDER, UNITTEST_PROVIDER } from '../../../client/testing/common/constants'; import { IEnvironmentVariablesProvider } from '../../../client/common/variables/types'; import { createTypeMoq } from '../../mocks/helper'; +import * as pixi from '../../../client/pythonEnvironments/common/environmentManagers/pixi'; suite('End to End Tests: test adapters', () => { let resultResolver: ITestResultResolver; @@ -32,6 +34,7 @@ suite('End to End Tests: test adapters', () => { let workspaceUri: Uri; let testOutputChannel: typeMoq.IMock; let testController: TestController; + let getPixiStub: sinon.SinonStub; const unittestProvider: TestProvider = UNITTEST_PROVIDER; const pytestProvider: TestProvider = PYTEST_PROVIDER; const rootPathSmallWorkspace = path.join( @@ -104,6 +107,9 @@ suite('End to End Tests: test adapters', () => { }); setup(async () => { + getPixiStub = sinon.stub(pixi, 'getPixi'); + getPixiStub.resolves(undefined); + // create objects that were injected configService = serviceContainer.get(IConfigurationService); pythonExecFactory = serviceContainer.get(IPythonExecutionFactory); @@ -130,6 +136,9 @@ suite('End to End Tests: test adapters', () => { // Whatever you need to return }); }); + teardown(() => { + sinon.restore(); + }); suiteTeardown(async () => { // remove symlink const dest = rootPathDiscoverySymlink; From 40b29bf2beac97b77540ebeb96236aac652b78fb Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 21 Oct 2024 11:07:22 -0700 Subject: [PATCH 142/149] Fix for duplication of python envs (#24321) Fixes https://github.com/microsoft/vscode-python/issues/24318 --- src/client/pythonEnvironments/nativeAPI.ts | 6 ++++-- .../pythonEnvironments/nativeAPI.unit.test.ts | 21 +++++++++++++++++++ 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/src/client/pythonEnvironments/nativeAPI.ts b/src/client/pythonEnvironments/nativeAPI.ts index 31ad80608283..7e2f7aa3515b 100644 --- a/src/client/pythonEnvironments/nativeAPI.ts +++ b/src/client/pythonEnvironments/nativeAPI.ts @@ -384,10 +384,12 @@ class NativePythonEnvironments implements IDiscoveryAPI, Disposable { const info = toPythonEnvInfo(native); if (info) { const old = this._envs.find((item) => item.executable.filename === info.executable.filename); - if (old && hasChanged(old, info)) { + if (old) { this._envs = this._envs.filter((item) => item.executable.filename !== info.executable.filename); this._envs.push(info); - this._onChanged.fire({ type: FileChangeType.Changed, old, new: info, searchLocation }); + if (hasChanged(old, info)) { + this._onChanged.fire({ type: FileChangeType.Changed, old, new: info, searchLocation }); + } } else { this._envs.push(info); this._onChanged.fire({ type: FileChangeType.Created, new: info, searchLocation }); diff --git a/src/test/pythonEnvironments/nativeAPI.unit.test.ts b/src/test/pythonEnvironments/nativeAPI.unit.test.ts index f7f956c7a20e..008d19b4738d 100644 --- a/src/test/pythonEnvironments/nativeAPI.unit.test.ts +++ b/src/test/pythonEnvironments/nativeAPI.unit.test.ts @@ -239,6 +239,27 @@ suite('Native Python API', () => { assert.deepEqual(actual, [expectedConda1]); }); + test('Ensure no duplication on resolve', async () => { + mockFinder + .setup((f) => f.refresh()) + .returns(() => { + async function* generator() { + yield* [conda1]; + } + return generator(); + }) + .verifiable(typemoq.Times.once()); + mockFinder + .setup((f) => f.resolve(typemoq.It.isAny())) + .returns(() => Promise.resolve(conda)) + .verifiable(typemoq.Times.once()); + + await api.triggerRefresh(); + await api.resolveEnv('/home/user/.conda/envs/conda_python/python'); + const actual = api.getEnvs(); + assert.deepEqual(actual, [expectedConda1]); + }); + test('Conda environment with no python', async () => { mockFinder .setup((f) => f.refresh()) From 205a19e951f44f618d69b4586e331d6373738bd4 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 28 Oct 2024 11:58:38 -0700 Subject: [PATCH 143/149] Update VS Code engine and `@types/vscode` for APIs (#24335) --- pythonExtensionApi/package-lock.json | 40 +++++++++++++++------------- pythonExtensionApi/package.json | 38 +++++++++++++------------- 2 files changed, 40 insertions(+), 38 deletions(-) diff --git a/pythonExtensionApi/package-lock.json b/pythonExtensionApi/package-lock.json index ef6914e0e786..e9ceaca73490 100644 --- a/pythonExtensionApi/package-lock.json +++ b/pythonExtensionApi/package-lock.json @@ -1,28 +1,29 @@ { "name": "@vscode/python-extension", - "version": "1.0.5", + "version": "1.0.6", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@vscode/python-extension", - "version": "1.0.5", + "version": "1.0.6", "license": "MIT", "devDependencies": { - "@types/vscode": "^1.78.0", + "@types/vscode": "^1.93.0", "source-map": "^0.8.0-beta.0", - "typescript": "5.0.4" + "typescript": "~5.2" }, "engines": { "node": ">=18.17.1", - "vscode": "^1.78.0" + "vscode": "^1.93.0" } }, "node_modules/@types/vscode": { - "version": "1.80.0", - "resolved": "https://registry.npmjs.org/@types/vscode/-/vscode-1.80.0.tgz", - "integrity": "sha512-qK/CmOdS2o7ry3k6YqU4zD3R2AYlJfbwBoSbKpBoP+GpXNE+0NEgJOli4n0bm0diK5kfBnchgCEj4igQz/44Hg==", - "dev": true + "version": "1.94.0", + "resolved": "https://registry.npmjs.org/@types/vscode/-/vscode-1.94.0.tgz", + "integrity": "sha512-UyQOIUT0pb14XSqJskYnRwD2aG0QrPVefIfrW1djR+/J4KeFQ0i1+hjZoaAmeNf3Z2jleK+R2hv+EboG/m8ruw==", + "dev": true, + "license": "MIT" }, "node_modules/lodash.sortby": { "version": "4.7.0", @@ -61,16 +62,17 @@ } }, "node_modules/typescript": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.0.4.tgz", - "integrity": "sha512-cW9T5W9xY37cc+jfEnaUvX91foxtHkza3Nw3wkoF4sSlKn0MONdkdEndig/qPBWXNkmplh3NzayQzCiHM4/hqw==", + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz", + "integrity": "sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==", "dev": true, + "license": "Apache-2.0", "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" }, "engines": { - "node": ">=12.20" + "node": ">=14.17" } }, "node_modules/webidl-conversions": { @@ -93,9 +95,9 @@ }, "dependencies": { "@types/vscode": { - "version": "1.80.0", - "resolved": "https://registry.npmjs.org/@types/vscode/-/vscode-1.80.0.tgz", - "integrity": "sha512-qK/CmOdS2o7ry3k6YqU4zD3R2AYlJfbwBoSbKpBoP+GpXNE+0NEgJOli4n0bm0diK5kfBnchgCEj4igQz/44Hg==", + "version": "1.94.0", + "resolved": "https://registry.npmjs.org/@types/vscode/-/vscode-1.94.0.tgz", + "integrity": "sha512-UyQOIUT0pb14XSqJskYnRwD2aG0QrPVefIfrW1djR+/J4KeFQ0i1+hjZoaAmeNf3Z2jleK+R2hv+EboG/m8ruw==", "dev": true }, "lodash.sortby": { @@ -129,9 +131,9 @@ } }, "typescript": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.0.4.tgz", - "integrity": "sha512-cW9T5W9xY37cc+jfEnaUvX91foxtHkza3Nw3wkoF4sSlKn0MONdkdEndig/qPBWXNkmplh3NzayQzCiHM4/hqw==", + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz", + "integrity": "sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==", "dev": true }, "webidl-conversions": { diff --git a/pythonExtensionApi/package.json b/pythonExtensionApi/package.json index 9e58f1a2400c..1f2462604e97 100644 --- a/pythonExtensionApi/package.json +++ b/pythonExtensionApi/package.json @@ -1,21 +1,21 @@ { "name": "@vscode/python-extension", "description": "An API facade for the Python extension in VS Code", - "version": "1.0.5", + "version": "1.0.6", "author": { - "name": "Microsoft Corporation" + "name": "Microsoft Corporation" }, "keywords": [ "Python", - "VSCode", - "API" - ], - "main": "./out/main.js", - "types": "./out/main.d.ts", - "engines": { - "node": ">=18.17.1", - "vscode": "^1.78.0" - }, + "VSCode", + "API" + ], + "main": "./out/main.js", + "types": "./out/main.d.ts", + "engines": { + "node": ">=18.17.1", + "vscode": "^1.93.0" + }, "license": "MIT", "homepage": "https://github.com/microsoft/vscode-python/tree/main/pythonExtensionApi", "repository": { @@ -26,18 +26,18 @@ "url": "https://github.com/Microsoft/vscode-python/issues" }, "devDependencies": { - "typescript": "5.0.4", - "@types/vscode": "^1.78.0", + "typescript": "~5.2", + "@types/vscode": "^1.93.0", "source-map": "^0.8.0-beta.0" }, "scripts": { "prepublishOnly": "echo \"⛔ Can only publish from a secure pipeline ⛔\" && node ../build/fail", - "prepack": "npm run all:publish", - "compile": "node ./node_modules/typescript/lib/tsc.js -b ./tsconfig.json", - "clean": "node ../node_modules/rimraf/bin.js out", - "lint": "node ../node_modules/eslint/bin/eslint.js --ext ts src", - "all": "npm run clean && npm run compile", + "prepack": "npm run all:publish", + "compile": "node ./node_modules/typescript/lib/tsc.js -b ./tsconfig.json", + "clean": "node ../node_modules/rimraf/bin.js out", + "lint": "node ../node_modules/eslint/bin/eslint.js --ext ts src", + "all": "npm run clean && npm run compile", "formatTypings": "node ../node_modules/eslint/bin/eslint.js --fix ./out/main.d.ts", - "all:publish": "git clean -xfd . && npm install && npm run compile && npm run formatTypings" + "all:publish": "git clean -xfd . && npm install && npm run compile && npm run formatTypings" } } From b428ba534b50d935dfad7bc35424bacf02731d7e Mon Sep 17 00:00:00 2001 From: Maple Date: Tue, 29 Oct 2024 02:59:43 +0800 Subject: [PATCH 144/149] update jedi dependencies to add python 3.13 support (#24330) Once at a time I switched to jedi language server but find it didn't work. I checked the error and find that the error was: ``` File "***data\extensions\ms-python.python-2024.16.1-universal\python_files\lib\jedilsp\jedi\inference\__init__.py", line 91, in __init__ self.grammar = environment.get_grammar() ~~~~~~~~~~~~~~~~~~~~~~~^^ File "***data\extensions\ms-python.python-2024.16.1-universal\python_files\lib\jedilsp\jedi\cache.py", line 112, in wrapper result = method(self, *args, **kwargs) File "***data\extensions\ms-python.python-2024.16.1-universal\python_files\lib\jedilsp\jedi\api\environment.py", line 37, in get_grammar return parso.load_grammar(version=version_string) ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^ File "***data\extensions\ms-python.python-2024.16.1-universal\python_files\lib\jedilsp\parso\grammar.py", line 264, in load_grammar raise NotImplementedError(message) NotImplementedError: Python version 3.13 is currently not supported. ``` I tracked down and find that parso 0.8.4 added python3.13 support So the dependencies needs to be updated --- .../jedilsp_requirements/requirements.txt | 80 ++++++++----------- 1 file changed, 32 insertions(+), 48 deletions(-) diff --git a/python_files/jedilsp_requirements/requirements.txt b/python_files/jedilsp_requirements/requirements.txt index 657f3d5af90b..210170796cbf 100644 --- a/python_files/jedilsp_requirements/requirements.txt +++ b/python_files/jedilsp_requirements/requirements.txt @@ -1,69 +1,53 @@ -# -# This file is autogenerated by pip-compile with Python 3.8 -# by the following command: -# -# pip-compile --generate-hashes 'python_files\jedilsp_requirements\requirements.in' -# -attrs==23.1.0 \ - --hash=sha256:1f28b4522cdc2fb4256ac1a020c78acf9cba2c6b461ccd2c126f3aa8e8335d04 \ - --hash=sha256:6279836d581513a26f1bf235f9acd333bc9115683f14f7e8fae46c98fc50e015 +# This file was autogenerated by uv via the following command: +# uv pip compile --generate-hashes python_files\jedilsp_requirements\requirements.in +attrs==24.2.0 \ + --hash=sha256:5cfb1b9148b5b086569baec03f20d7b6bf3bcacc9a42bebf87ffaaca362f6346 \ + --hash=sha256:81921eb96de3191c8258c199618104dd27ac608d9366f5e35d011eae1867ede2 # via # cattrs # lsprotocol -cattrs==23.1.2 \ - --hash=sha256:b2bb14311ac17bed0d58785e5a60f022e5431aca3932e3fc5cc8ed8639de50a4 \ - --hash=sha256:db1c821b8c537382b2c7c66678c3790091ca0275ac486c76f3c8f3920e83c657 +cattrs==24.1.2 \ + --hash=sha256:67c7495b760168d931a10233f979b28dc04daf853b30752246f4f8471c6d68d0 \ + --hash=sha256:8028cfe1ff5382df59dd36474a86e02d817b06eaf8af84555441bac915d2ef85 # via # jedi-language-server # lsprotocol -docstring-to-markdown==0.12 \ - --hash=sha256:40004224b412bd6f64c0f3b85bb357a41341afd66c4b4896709efa56827fb2bb \ - --hash=sha256:7df6311a887dccf9e770f51242ec002b19f0591994c4783be49d24cdc1df3737 + # pygls +docstring-to-markdown==0.15 \ + --hash=sha256:27afb3faedba81e34c33521c32bbd258d7fbb79eedf7d29bc4e81080e854aec0 \ + --hash=sha256:e146114d9c50c181b1d25505054a8d0f7a476837f0da2c19f07e06eaed52b73d # via jedi-language-server -exceptiongroup==1.1.3 \ - --hash=sha256:097acd85d473d75af5bb98e41b61ff7fe35efe6675e4f9370ec6ec5126d160e9 \ - --hash=sha256:343280667a4585d195ca1cf9cef84a4e178c4b6cf2274caef9859782b567d5e3 +exceptiongroup==1.2.2 \ + --hash=sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b \ + --hash=sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc # via cattrs -importlib-metadata==6.8.0 \ - --hash=sha256:3ebb78df84a805d7698245025b975d9d67053cd94c79245ba4b3eb694abe68bb \ - --hash=sha256:dbace7892d8c0c4ac1ad096662232f831d4e64f4c4545bd53016a3e9d4654743 - # via typeguard jedi==0.19.1 \ --hash=sha256:cf0496f3651bc65d7174ac1b7d043eff454892c708a87d1b683e57b569927ffd \ --hash=sha256:e983c654fe5c02867aef4cdfce5a2fbb4a50adc0af145f70504238f18ef5e7e0 # via jedi-language-server -jedi-language-server==0.41.1 \ - --hash=sha256:3f15ca5cc28e728564f7d63583e171b418025582447ce023512e3f2b2d71ebae \ - --hash=sha256:ca9b3e7f48b70f0988d85ffde4f01dd1ab94c8e0f69e8c6424e6657117b44f91 - # via -r requirements.in -lsprotocol==2023.0.0b1 \ - --hash=sha256:ade2cd0fa0ede7965698cb59cd05d3adbd19178fd73e83f72ef57a032fbb9d62 \ - --hash=sha256:f7a2d4655cbd5639f373ddd1789807450c543341fa0a32b064ad30dbb9f510d4 +jedi-language-server==0.41.4 \ + --hash=sha256:53c6ce0eae5e332e5f6d76acf8d8c9cf33eae8191d31cc37913773127cd09f28 \ + --hash=sha256:af010173f9f62dfcd3b3f4e2ea0ea3020fb4285c9b6b18b481aa978f28b5a36a + # via -r python_files/jedilsp_requirements/requirements.in +lsprotocol==2023.0.1 \ + --hash=sha256:c75223c9e4af2f24272b14c6375787438279369236cd568f596d4951052a60f2 \ + --hash=sha256:cc5c15130d2403c18b734304339e51242d3018a05c4f7d0f198ad6e0cd21861d # via # jedi-language-server # pygls -parso==0.8.3 \ - --hash=sha256:8c07be290bb59f03588915921e29e8a50002acaf2cdc5fa0e0114f91709fafa0 \ - --hash=sha256:c001d4636cd3aecdaf33cbb40aebb59b094be2a74c556778ef5576c175e19e75 +parso==0.8.4 \ + --hash=sha256:a418670a20291dacd2dddc80c377c5c3791378ee1e8d12bffc35420643d43f18 \ + --hash=sha256:eb3a7b58240fb99099a345571deecc0f9540ea5f4dd2fe14c2a99d6b281ab92d # via jedi -pygls==1.0.2 \ - --hash=sha256:6d278d29fa6559b0f7a448263c85cb64ec6e9369548b02f1a7944060848b21f9 \ - --hash=sha256:888ed63d1f650b4fc64d603d73d37545386ec533c0caac921aed80f80ea946a4 +pygls==1.3.1 \ + --hash=sha256:140edceefa0da0e9b3c533547c892a42a7d2fd9217ae848c330c53d266a55018 \ + --hash=sha256:6e00f11efc56321bdeb6eac04f6d86131f654c7d49124344a9ebb968da3dd91e # via - # -r requirements.in + # -r python_files/jedilsp_requirements/requirements.in # jedi-language-server -typeguard==3.0.2 \ - --hash=sha256:bbe993854385284ab42fd5bd3bee6f6556577ce8b50696d6cb956d704f286c8e \ - --hash=sha256:fee5297fdb28f8e9efcb8142b5ee219e02375509cd77ea9d270b5af826358d5a - # via pygls -typing-extensions==4.8.0 \ - --hash=sha256:8f92fc8806f9a6b641eaa5318da32b44d401efaac0f6678c9bc448ba3605faa0 \ - --hash=sha256:df8e4339e9cb77357558cbdbceca33c303714cf861d1eef15e1070055ae8b7ef +typing-extensions==4.12.2 \ + --hash=sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d \ + --hash=sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8 # via # cattrs # jedi-language-server - # typeguard -zipp==3.19.1 \ - --hash=sha256:2828e64edb5386ea6a52e7ba7cdb17bb30a73a858f5eb6eb93d8d36f5ea26091 \ - --hash=sha256:35427f6d5594f4acf82d25541438348c26736fa9b3afa2754bcd63cdb99d8e8f - # via importlib-metadata From d440bc1cee23fb75372810042f3a7ce145867ae4 Mon Sep 17 00:00:00 2001 From: Anthony Kim <62267334+anthonykim1@users.noreply.github.com> Date: Mon, 28 Oct 2024 13:38:25 -0700 Subject: [PATCH 145/149] disable shell integration for 3.13 (#24341) Resolves: https://github.com/microsoft/vscode-python/issues/24339 --------- Co-authored-by: Karthik Nadig --- python_files/pythonrc.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/python_files/pythonrc.py b/python_files/pythonrc.py index 2595143feade..5791bb3967c0 100644 --- a/python_files/pythonrc.py +++ b/python_files/pythonrc.py @@ -4,6 +4,7 @@ import readline original_ps1 = ">>> " +use_shell_integration = sys.version_info < (3, 13) class REPLHooks: @@ -72,5 +73,5 @@ def __str__(self): return result -if sys.platform != "win32": +if sys.platform != "win32" and use_shell_integration: sys.ps1 = PS1() From 3115887b4698067edc8c52b9b2b2eea78b2999ae Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 28 Oct 2024 15:05:44 -0700 Subject: [PATCH 146/149] Update main version for release (#24338) --- build/azure-pipeline.stable.yml | 2 +- package-lock.json | 17 +++++++++-------- package.json | 2 +- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/build/azure-pipeline.stable.yml b/build/azure-pipeline.stable.yml index 5f7536efbe2a..97c2b8fec736 100644 --- a/build/azure-pipeline.stable.yml +++ b/build/azure-pipeline.stable.yml @@ -103,7 +103,7 @@ extends: project: 'Monaco' definition: 593 buildVersionToDownload: 'latestFromBranch' - branchName: 'refs/heads/release/2024.14' + branchName: 'refs/heads/release/2024.18' targetPath: '$(Build.SourcesDirectory)/python-env-tools/bin' artifactName: 'bin-$(vsceTarget)' itemPattern: | diff --git a/package-lock.json b/package-lock.json index 492696acd558..dc5f5e0553e7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "python", - "version": "2024.17.0-dev", + "version": "2024.18.0-rc", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "python", - "version": "2024.17.0-dev", + "version": "2024.18.0-rc", "license": "MIT", "dependencies": { "@iarna/toml": "^2.2.5", @@ -5161,10 +5161,11 @@ "dev": true }, "node_modules/elliptic": { - "version": "6.5.7", - "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.7.tgz", - "integrity": "sha512-ESVCtTwiA+XhY3wyh24QqRGBoP3rEdDUl3EDUUo9tft074fi19IrdpH7hLCMMP3CIj7jb3W96rn8lt/BqIlt5Q==", + "version": "6.6.0", + "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.6.0.tgz", + "integrity": "sha512-dpwoQcLc/2WLQvJvLRHKZ+f9FgOdjnq11rurqwekGQygGPsYSK29OMMD2WalatiqQ+XGFDglTNixpPfI+lpaAA==", "dev": true, + "license": "MIT", "dependencies": { "bn.js": "^4.11.9", "brorand": "^1.1.0", @@ -18639,9 +18640,9 @@ "dev": true }, "elliptic": { - "version": "6.5.7", - "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.7.tgz", - "integrity": "sha512-ESVCtTwiA+XhY3wyh24QqRGBoP3rEdDUl3EDUUo9tft074fi19IrdpH7hLCMMP3CIj7jb3W96rn8lt/BqIlt5Q==", + "version": "6.6.0", + "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.6.0.tgz", + "integrity": "sha512-dpwoQcLc/2WLQvJvLRHKZ+f9FgOdjnq11rurqwekGQygGPsYSK29OMMD2WalatiqQ+XGFDglTNixpPfI+lpaAA==", "dev": true, "requires": { "bn.js": "^4.11.9", diff --git a/package.json b/package.json index d4c36905d1e3..1c7689f6969e 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "python", "displayName": "Python", "description": "Python language support with extension access points for IntelliSense (Pylance), Debugging (Python Debugger), linting, formatting, refactoring, unit tests, and more.", - "version": "2024.17.0-dev", + "version": "2024.18.0-rc", "featureFlags": { "usingNewInterpreterStorage": true }, From fdfe2a6a735ae62cfa146ef83134e7d6a7912811 Mon Sep 17 00:00:00 2001 From: Karthik Nadig Date: Mon, 28 Oct 2024 15:30:25 -0700 Subject: [PATCH 147/149] Update main to next pre-release (#24344) --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index dc5f5e0553e7..ee84bfc6dc99 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "python", - "version": "2024.18.0-rc", + "version": "2024.19.0-dev", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "python", - "version": "2024.18.0-rc", + "version": "2024.19.0-dev", "license": "MIT", "dependencies": { "@iarna/toml": "^2.2.5", diff --git a/package.json b/package.json index 1c7689f6969e..712643d33706 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "python", "displayName": "Python", "description": "Python language support with extension access points for IntelliSense (Pylance), Debugging (Python Debugger), linting, formatting, refactoring, unit tests, and more.", - "version": "2024.18.0-rc", + "version": "2024.19.0-dev", "featureFlags": { "usingNewInterpreterStorage": true }, From 9b182dab096796f392e8a24b68fa5a3aaf3421b1 Mon Sep 17 00:00:00 2001 From: Raymond Zhao <7199958+rzhao271@users.noreply.github.com> Date: Tue, 29 Oct 2024 14:05:39 -0700 Subject: [PATCH 148/149] fix: upgrade settings to preview (#24354) --- package.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/package.json b/package.json index 712643d33706..ec1498d813f2 100644 --- a/package.json +++ b/package.json @@ -592,8 +592,8 @@ "native" ], "tags": [ - "experimental", - "onExP" + "onExP", + "preview" ], "scope": "machine", "type": "string" @@ -675,8 +675,8 @@ "scope": "resource", "type": "boolean", "tags": [ - "experimental", - "onExP" + "onExP", + "preview" ] }, "python.REPL.provideVariables": { From c6c1e8b24d57b4f729e9f6a988ed1ef97d001aa7 Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Wed, 30 Oct 2024 16:10:16 +1100 Subject: [PATCH 149/149] Jupyter API to get Env associated with Notebooks --- pythonExtensionApi/src/main.ts | 4 +- src/client/api.ts | 6 +- src/client/api/types.ts | 4 +- src/client/environmentApi.ts | 18 +++++ src/client/jupyter/jupyterIntegration.ts | 83 +++++++++++++++++++++++- src/test/environmentApi.unit.test.ts | 16 ++++- 6 files changed, 121 insertions(+), 10 deletions(-) diff --git a/pythonExtensionApi/src/main.ts b/pythonExtensionApi/src/main.ts index 154ffbbd857a..2173245cbb28 100644 --- a/pythonExtensionApi/src/main.ts +++ b/pythonExtensionApi/src/main.ts @@ -227,9 +227,9 @@ export type EnvironmentsChangeEvent = { export type ActiveEnvironmentPathChangeEvent = EnvironmentPath & { /** - * Workspace folder the environment changed for. + * Resource the environment changed for. */ - readonly resource: WorkspaceFolder | undefined; + readonly resource: Resource | undefined; }; /** diff --git a/src/client/api.ts b/src/client/api.ts index 899326647808..bf04a331a8b6 100644 --- a/src/client/api.ts +++ b/src/client/api.ts @@ -15,7 +15,7 @@ import { IConfigurationService, Resource } from './common/types'; import { getDebugpyLauncherArgs } from './debugger/extension/adapter/remoteLaunchers'; import { IInterpreterService } from './interpreter/contracts'; import { IServiceContainer, IServiceManager } from './ioc/types'; -import { JupyterExtensionIntegration } from './jupyter/jupyterIntegration'; +import { JupyterExtensionIntegration, JupyterExtensionPythonEnvironments, type JupyterPythonEnvironmentApi } from './jupyter/jupyterIntegration'; import { traceError } from './logging'; import { IDiscoveryAPI } from './pythonEnvironments/base/locator'; import { buildEnvironmentApi } from './environmentApi'; @@ -33,11 +33,13 @@ export function buildApi( const configurationService = serviceContainer.get(IConfigurationService); const interpreterService = serviceContainer.get(IInterpreterService); serviceManager.addSingleton(JupyterExtensionIntegration, JupyterExtensionIntegration); + serviceManager.addSingleton(JupyterExtensionPythonEnvironments, JupyterExtensionPythonEnvironments); serviceManager.addSingleton( TensorboardExtensionIntegration, TensorboardExtensionIntegration, ); const jupyterIntegration = serviceContainer.get(JupyterExtensionIntegration); + const jupyterPythonEnvApi = serviceContainer.get(JupyterExtensionPythonEnvironments); const tensorboardIntegration = serviceContainer.get( TensorboardExtensionIntegration, ); @@ -146,7 +148,7 @@ export function buildApi( stop: (client: BaseLanguageClient): Promise => client.stop(), getTelemetryReporter: () => getTelemetryReporter(), }, - environments: buildEnvironmentApi(discoveryApi, serviceContainer), + environments: buildEnvironmentApi(discoveryApi, serviceContainer, jupyterPythonEnvApi), }; // In test environment return the DI Container. diff --git a/src/client/api/types.ts b/src/client/api/types.ts index 4e67334121fb..95556aacbd90 100644 --- a/src/client/api/types.ts +++ b/src/client/api/types.ts @@ -227,9 +227,9 @@ export type EnvironmentsChangeEvent = { export type ActiveEnvironmentPathChangeEvent = EnvironmentPath & { /** - * Workspace folder the environment changed for. + * Resource the environment changed for. */ - readonly resource: WorkspaceFolder | undefined; + readonly resource: Resource | undefined; }; /** diff --git a/src/client/environmentApi.ts b/src/client/environmentApi.ts index 6c4b5cf94d92..b729405e2b12 100644 --- a/src/client/environmentApi.ts +++ b/src/client/environmentApi.ts @@ -33,6 +33,7 @@ import { } from './api/types'; import { buildEnvironmentCreationApi } from './pythonEnvironments/creation/createEnvApi'; import { EnvironmentKnownCache } from './environmentKnownCache'; +import type { JupyterPythonEnvironmentApi } from './jupyter/jupyterIntegration'; type ActiveEnvironmentChangeEvent = { resource: WorkspaceFolder | undefined; @@ -115,6 +116,7 @@ function filterUsingVSCodeContext(e: PythonEnvInfo) { export function buildEnvironmentApi( discoveryApi: IDiscoveryAPI, serviceContainer: IServiceContainer, + jupyterPythonEnvsApi: JupyterPythonEnvironmentApi, ): PythonExtension['environments'] { const interpreterPathService = serviceContainer.get(IInterpreterPathService); const configService = serviceContainer.get(IConfigurationService); @@ -206,6 +208,14 @@ export function buildEnvironmentApi( }), onEnvironmentsChanged, onEnvironmentVariablesChanged, + jupyterPythonEnvsApi.onDidChangePythonEnvironment((e) => { + const jupyterEnv = environmentApi.getActiveEnvironmentPath(e); + onDidActiveInterpreterChangedEvent.fire({ + id: jupyterEnv.id, + path: jupyterEnv.path, + resource: e, + }); + }, undefined), ); if (!knownCache!) { knownCache = initKnownCache(); @@ -224,6 +234,14 @@ export function buildEnvironmentApi( getActiveEnvironmentPath(resource?: Resource) { sendApiTelemetry('getActiveEnvironmentPath'); resource = resource && 'uri' in resource ? resource.uri : resource; + const jupyterEnv = resource ? jupyterPythonEnvsApi.getPythonEnvironment(resource) : undefined; + if (jupyterEnv) { + traceVerbose('Python Environment returned from Jupyter', resource?.fsPath, jupyterEnv.id); + return { + id: jupyterEnv.id, + path: jupyterEnv.path, + }; + } const path = configService.getSettings(resource).pythonPath; const id = path === 'python' ? 'DEFAULT_PYTHON' : getEnvID(path); return { diff --git a/src/client/jupyter/jupyterIntegration.ts b/src/client/jupyter/jupyterIntegration.ts index 69583b744da9..d920fa808053 100644 --- a/src/client/jupyter/jupyterIntegration.ts +++ b/src/client/jupyter/jupyterIntegration.ts @@ -6,7 +6,7 @@ import { inject, injectable, named } from 'inversify'; import { dirname } from 'path'; -import { Extension, Memento, Uri } from 'vscode'; +import { EventEmitter, Extension, Memento, Uri, workspace, type Event } from 'vscode'; import type { SemVer } from 'semver'; import { IContextKeyManager, IWorkspaceService } from '../common/application/types'; import { JUPYTER_EXTENSION_ID, PYLANCE_EXTENSION_ID } from '../common/constants'; @@ -23,6 +23,7 @@ import { PylanceApi } from '../activation/node/pylanceApi'; import { ExtensionContextKey } from '../common/application/contextKeys'; import { getDebugpyPath } from '../debugger/pythonDebugger'; import type { Environment } from '../api/types'; +import { DisposableBase } from '../common/utils/resourceLifecycle'; type PythonApiForJupyterExtension = { /** @@ -170,3 +171,83 @@ export class JupyterExtensionIntegration { } } } + + +export interface JupyterPythonEnvironmentApi { + /** + * This event is triggered when the environment associated with a Jupyter Notebook or Interactive Window changes. + * The Uri in the event is the Uri of the Notebook/IW. + */ + onDidChangePythonEnvironment: Event; + /** + * Returns the EnvironmentPath to the Python environment associated with a Jupyter Notebook or Interactive Window. + * If the Uri is not associated with a Jupyter Notebook or Interactive Window, then this method returns undefined. + * @param uri + */ + getPythonEnvironment( + uri: Uri, + ): + | undefined + | { + /** + * The ID of the environment. + */ + readonly id: string; + /** + * Path to environment folder or path to python executable that uniquely identifies an environment. Environments + * lacking a python executable are identified by environment folder paths, whereas other envs can be identified + * using python executable path. + */ + readonly path: string; + }; +} + +// eslint-disable-next-line max-classes-per-file + +@injectable() +export class JupyterExtensionPythonEnvironments extends DisposableBase implements JupyterPythonEnvironmentApi { + private jupyterExtension?: JupyterPythonEnvironmentApi; + + private readonly _onDidChangePythonEnvironment = this._register(new EventEmitter()); + + public readonly onDidChangePythonEnvironment = this._onDidChangePythonEnvironment.event; + + constructor( + @inject(IExtensions) private readonly extensions: IExtensions, + ) { + super(); + } + + public getPythonEnvironment(uri: Uri): undefined | + { + /** + * The ID of the environment. + */ + readonly id: string; + /** + * Path to environment folder or path to python executable that uniquely identifies an environment. Environments + * lacking a python executable are identified by environment folder paths, whereas other envs can be identified + * using python executable path. + */ + readonly path: string; + } { + return isJupyterResource(uri) ? this.getJupyterApi()?.getPythonEnvironment(uri) : undefined; + } + + private getJupyterApi(){ + if (!this.jupyterExtension) { + const api = this.extensions.getExtension(JUPYTER_EXTENSION_ID)?.exports; + if (!api) { + return undefined; + } + this.jupyterExtension = api; + this._register(api.onDidChangePythonEnvironment(this._onDidChangePythonEnvironment.fire, this._onDidChangePythonEnvironment)); + } + return this.jupyterExtension; + } +} + +function isJupyterResource(resource: Uri): boolean { + // Jupyter extension only deals with Notebooks and Interactive Windows. + return resource.fsPath.endsWith('.ipynb') || workspace.notebookDocuments.some((item) => item.uri.toString() === resource.toString()); +} diff --git a/src/test/environmentApi.unit.test.ts b/src/test/environmentApi.unit.test.ts index 012e1a0bfc69..2e5d13161f7b 100644 --- a/src/test/environmentApi.unit.test.ts +++ b/src/test/environmentApi.unit.test.ts @@ -38,6 +38,7 @@ import { EnvironmentsChangeEvent, PythonExtension, } from '../client/api/types'; +import { JupyterPythonEnvironmentApi } from '../client/jupyter/jupyterIntegration'; suite('Python Environment API', () => { const workspacePath = 'path/to/workspace'; @@ -80,7 +81,6 @@ suite('Python Environment API', () => { onDidChangeRefreshState = new EventEmitter(); onDidChangeEnvironments = new EventEmitter(); onDidChangeEnvironmentVariables = new EventEmitter(); - serviceContainer.setup((s) => s.get(IExtensions)).returns(() => extensions.object); serviceContainer.setup((s) => s.get(IInterpreterPathService)).returns(() => interpreterPathService.object); serviceContainer.setup((s) => s.get(IConfigurationService)).returns(() => configService.object); @@ -94,8 +94,13 @@ suite('Python Environment API', () => { discoverAPI.setup((d) => d.onProgress).returns(() => onDidChangeRefreshState.event); discoverAPI.setup((d) => d.onChanged).returns(() => onDidChangeEnvironments.event); discoverAPI.setup((d) => d.getEnvs()).returns(() => []); + const onDidChangePythonEnvironment = new EventEmitter(); + const jupyterApi: JupyterPythonEnvironmentApi = { + onDidChangePythonEnvironment: onDidChangePythonEnvironment.event, + getPythonEnvironment: (_uri: Uri) => undefined, + }; - environmentApi = buildEnvironmentApi(discoverAPI.object, serviceContainer.object); + environmentApi = buildEnvironmentApi(discoverAPI.object, serviceContainer.object, jupyterApi); }); teardown(() => { @@ -323,7 +328,12 @@ suite('Python Environment API', () => { }, ]; discoverAPI.setup((d) => d.getEnvs()).returns(() => envs); - environmentApi = buildEnvironmentApi(discoverAPI.object, serviceContainer.object); + const onDidChangePythonEnvironment = new EventEmitter(); + const jupyterApi: JupyterPythonEnvironmentApi = { + onDidChangePythonEnvironment: onDidChangePythonEnvironment.event, + getPythonEnvironment: (_uri: Uri) => undefined, + }; + environmentApi = buildEnvironmentApi(discoverAPI.object, serviceContainer.object, jupyterApi); const actual = environmentApi.known; const actualEnvs = actual?.map((a) => (a as EnvironmentReference).internal); assert.deepEqual(