Merge branch 'main' into show-exp-show-error

Author: mattseddon

CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.0] - 2023-06-09
+
+### 🚀 New Features and Enhancements
+
+- Add PYTHONPATH to environment variables if the Python extension makes it available [#4045](https://github.com/iterative/vscode-dvc/pull/4045) by [@mattseddon](https://github.com/mattseddon)
+
+### 🐛 Bug Fixes
+
+- fix(plots): correct the empty screen link to the dvc docs [#4068](https://github.com/iterative/vscode-dvc/pull/4068) by [@shcheklein](https://github.com/shcheklein)
+
+### 🔨 Maintenance
+
+- Fix failing tests [#4070](https://github.com/iterative/vscode-dvc/pull/4070) by [@mattseddon](https://github.com/mattseddon)
+
 ## [0.9.6] - 2023-06-08
 
 ### 🚀 New Features and Enhancements

README.md

@@ -127,13 +127,12 @@ This extension augments VS Code in the following ways:
 Open the Command Palette (`F1` or ⇧⌃P on Windows/Linux or ⇧⌘P on macOS) and type
 in one of the following commands:
 
-| Command                    | Description                                                                                                                 |
-| -------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| `DVC: Get Started`         | Open the extension's walkthrough. Which details all of the current features and provides links to extra learning resources. |
-| `View: Show DVC`           | Open the extension's view container.                                                                                        |
-| `DVC: Setup The Workspace` | Activate the extension's workspace setup wizard.                                                                            |
-| `DVC: Show Experiments`    | Show an interactive version of DVC's `exp show` [command](https://dvc.org/doc/command-reference/exp/show).                  |
-| `DVC: Show Plots`          | Show an interactive version of DVC's `plots diff` [command](https://dvc.org/doc/command-reference/plots/diff).              |
+| Command                 | Description                                                                                                    |
+| ----------------------- | -------------------------------------------------------------------------------------------------------------- |
+| `DVC: Show Setup`       | Show the extension's setup page. Which can be used to setup the DVC project, view the walkthrough and more.    |
+| `View: Show DVC`        | Open the extension's view container.                                                                           |
+| `DVC: Show Experiments` | Show an interactive version of DVC's `exp show` [command](https://dvc.org/doc/command-reference/exp/show).     |
+| `DVC: Show Plots`       | Show an interactive version of DVC's `plots diff` [command](https://dvc.org/doc/command-reference/plots/diff). |
 
 Learn more about the extension's [commands].
 

extension/package.json

@@ -9,7 +9,7 @@
   "extensionDependencies": [
     "vscode.git"
   ],
-  "version": "0.9.6",
+  "version": "1.0.0",
   "license": "Apache-2.0",
   "readme": "./README.md",
   "repository": {
@@ -1651,7 +1651,7 @@
     "vscode-languageclient": "8.1.0"
   },
   "devDependencies": {
-    "@swc/core": "1.3.61",
+    "@swc/core": "1.3.62",
     "@swc/jest": "0.2.26",
     "@types/chai": "4.3.5",
     "@types/chai-as-promised": "7.1.5",
@@ -1675,9 +1675,9 @@
     "@types/vscode": "1.64.0",
     "@vscode/test-electron": "2.3.2",
     "@vscode/vsce": "2.19.0",
-    "@wdio/cli": "8.10.6",
-    "@wdio/local-runner": "8.10.6",
-    "@wdio/mocha-framework": "8.10.6",
+    "@wdio/cli": "8.10.7",
+    "@wdio/local-runner": "8.10.7",
+    "@wdio/mocha-framework": "8.10.7",
     "@wdio/spec-reporter": "8.10.6",
     "chai": "4.3.7",
     "chai-as-promised": "7.1.1",
@@ -1695,9 +1695,9 @@
     "ts-loader": "9.4.3",
     "vscode-uri": "3.0.7",
     "wdio-vscode-service": "5.1.0",
-    "webdriverio": "8.10.6",
-    "webpack": "5.85.0",
-    "webpack-cli": "5.1.1"
+    "webdriverio": "8.10.7",
+    "webpack": "5.85.1",
+    "webpack-cli": "5.1.3"
   },
   "peerDependencies": {
     "typescript": "*"

extension/src/extensions/python.ts

@@ -68,6 +68,10 @@ export const getOnDidChangePythonEnvironmentVariables = async () => {
 
 export const isPythonExtensionInstalled = () => isInstalled(PYTHON_EXTENSION_ID)
 
+export const createPythonEnv = () => {
+  void commands.executeCommand('python.createEnvironment')
+}
+
 export const selectPythonInterpreter = () => {
   void commands.executeCommand('python.setInterpreter')
 }

extension/src/setup/index.ts

@@ -13,7 +13,11 @@ import { validateTokenInput } from './inputBox'
 import { findPythonBinForInstall } from './autoInstall'
 import { run, runWithRecheck, runWorkspace } from './runner'
 import { isStudioAccessToken } from './token'
-import { pickFocusedProjects } from './quickPick'
+import {
+  PYTHON_EXTENSION_ACTION,
+  pickFocusedProjects,
+  pickPythonExtensionAction
+} from './quickPick'
 import { ViewKey } from '../webview/constants'
 import { BaseRepository } from '../webview/repository'
 import { Resource } from '../resourceLocator'
@@ -56,6 +60,7 @@ import { Title } from '../vscode/title'
 import { getDVCAppDir } from '../util/appdirs'
 import { getOptions } from '../cli/dvc/options'
 import { isAboveLatestTestedVersion } from '../cli/dvc/version'
+import { createPythonEnv, selectPythonInterpreter } from '../extensions/python'
 
 export class Setup
   extends BaseRepository<TSetupData>
@@ -414,7 +419,8 @@ export class Setup
     const webviewMessages = new WebviewMessages(
       () => this.getWebview(),
       () => this.initializeGit(),
-      (offline: boolean) => this.updateStudioOffline(offline)
+      (offline: boolean) => this.updateStudioOffline(offline),
+      () => this.updatePythonEnvironment()
     )
     this.dispose.track(
       this.onDidReceivedWebviewMessage(message =>
@@ -506,6 +512,18 @@ export class Setup
     }
   }
 
+  private async updatePythonEnvironment() {
+    const value = await pickPythonExtensionAction()
+
+    if (!value) {
+      return
+    }
+
+    return value === PYTHON_EXTENSION_ACTION.CREATE_ENV
+      ? createPythonEnv()
+      : selectPythonInterpreter()
+  }
+
   private needsGitCommit(needsGitInit: boolean) {
     if (needsGitInit) {
       return true

extension/src/setup/quickPick.test.ts

@@ -1,12 +1,17 @@
 import { join } from 'path'
-import { pickFocusedProjects } from './quickPick'
-import { quickPickManyValues } from '../vscode/quickPick'
+import {
+  PYTHON_EXTENSION_ACTION,
+  pickFocusedProjects,
+  pickPythonExtensionAction
+} from './quickPick'
+import { quickPickManyValues, quickPickValue } from '../vscode/quickPick'
 import { Toast } from '../vscode/toast'
 import { Title } from '../vscode/title'
 
 jest.mock('../vscode/quickPick')
 
 const mockedQuickPickManyValues = jest.mocked(quickPickManyValues)
+const mockedQuickValue = jest.mocked(quickPickValue)
 
 const mockedToast = jest.mocked(Toast)
 const mockedShowError = jest.fn()
@@ -55,3 +60,28 @@ describe('pickFocusedProjects', () => {
     )
   })
 })
+
+describe('pickPythonExtensionAction', () => {
+  it('should call a quick pick with the correct values', () => {
+    void pickPythonExtensionAction()
+
+    expect(mockedQuickValue).toHaveBeenCalledWith(
+      [
+        {
+          description: 'Create an environment',
+          label: 'Create',
+          value: PYTHON_EXTENSION_ACTION.CREATE_ENV
+        },
+        {
+          description: 'Choose from already created environments',
+          label: 'Select',
+          value: PYTHON_EXTENSION_ACTION.SET_INTERPRETER
+        }
+      ],
+      {
+        placeHolder: 'Select or Create a Python Environment',
+        title: Title.UPDATE_PYTHON_ENVIRONMENT
+      }
+    )
+  })
+})

extension/src/setup/quickPick.ts

@@ -1,8 +1,13 @@
 import { sortCollectedArray } from '../util/array'
-import { quickPickManyValues } from '../vscode/quickPick'
+import { quickPickManyValues, quickPickValue } from '../vscode/quickPick'
 import { Title } from '../vscode/title'
 import { Toast } from '../vscode/toast'
 
+export enum PYTHON_EXTENSION_ACTION {
+  CREATE_ENV = 1,
+  SET_INTERPRETER = 2
+}
+
 export const pickFocusedProjects = async (
   projects: string[],
   currentProjects: string[]
@@ -26,3 +31,24 @@ export const pickFocusedProjects = async (
 
   return sortCollectedArray(values)
 }
+
+export const pickPythonExtensionAction = (): Thenable<
+  PYTHON_EXTENSION_ACTION | undefined
+> => {
+  const options = [
+    {
+      description: 'Create an environment',
+      label: 'Create',
+      value: PYTHON_EXTENSION_ACTION.CREATE_ENV
+    },
+    {
+      description: 'Choose from already created environments',
+      label: 'Select',
+      value: PYTHON_EXTENSION_ACTION.SET_INTERPRETER
+    }
+  ]
+  return quickPickValue<PYTHON_EXTENSION_ACTION>(options, {
+    placeHolder: 'Select or Create a Python Environment',
+    title: Title.UPDATE_PYTHON_ENVIRONMENT
+  })
+}

extension/src/setup/webview/messages.ts

@@ -8,7 +8,6 @@ import {
 import { BaseWebview } from '../../webview'
 import { sendTelemetryEvent } from '../../telemetry'
 import { EventName } from '../../telemetry/constants'
-import { selectPythonInterpreter } from '../../extensions/python'
 import { autoInstallDvc, autoUpgradeDvc } from '../autoInstall'
 import {
   RegisteredCliCommands,
@@ -20,15 +19,18 @@ export class WebviewMessages {
   private readonly getWebview: () => BaseWebview<TSetupData> | undefined
   private readonly initializeGit: () => void
   private readonly updateStudioOffline: (offline: boolean) => Promise<void>
+  private readonly updatePythonEnv: () => Promise<void>
 
   constructor(
     getWebview: () => BaseWebview<TSetupData> | undefined,
     initializeGit: () => void,
-    updateStudioOffline: (shareLive: boolean) => Promise<void>
+    updateStudioOffline: (shareLive: boolean) => Promise<void>,
+    updatePythonEnv: () => Promise<void>
   ) {
     this.getWebview = getWebview
     this.initializeGit = initializeGit
     this.updateStudioOffline = updateStudioOffline
+    this.updatePythonEnv = updatePythonEnv
   }
 
   public sendWebviewMessage(data: SetupData) {
@@ -49,8 +51,8 @@ export class WebviewMessages {
         return commands.executeCommand(RegisteredCommands.EXTENSION_GET_STARTED)
       case MessageFromWebviewType.SHOW_SCM_PANEL:
         return this.showScmForCommit()
-      case MessageFromWebviewType.SELECT_PYTHON_INTERPRETER:
-        return this.selectPythonInterpreter()
+      case MessageFromWebviewType.UPDATE_PYTHON_ENVIRONMENT:
+        return this.updatePythonEnvironment()
       case MessageFromWebviewType.INSTALL_DVC:
         return this.installDvc()
       case MessageFromWebviewType.UPGRADE_DVC:
@@ -101,13 +103,13 @@ export class WebviewMessages {
     return commands.executeCommand('workbench.view.scm')
   }
 
-  private selectPythonInterpreter() {
+  private updatePythonEnvironment() {
     sendTelemetryEvent(
-      EventName.VIEWS_SETUP_SELECT_PYTHON_INTERPRETER,
+      EventName.VIEWS_SETUP_UPDATE_PYTHON_ENVIRONMENT,
       undefined,
       undefined
     )
-    return selectPythonInterpreter()
+    return this.updatePythonEnv()
   }
 
   private upgradeDvc() {

extension/src/telemetry/constants.ts

@@ -86,9 +86,9 @@ export const EventName = Object.assign(
     VIEWS_SETUP_FOCUS_CHANGED: 'views.setup.focusChanged',
     VIEWS_SETUP_INIT_GIT: 'views.setup.initializeGit',
     VIEWS_SETUP_INSTALL_DVC: 'views.setup.installDvc',
-    VIEWS_SETUP_SELECT_PYTHON_INTERPRETER:
-      'views.setup.selectPythonInterpreter',
     VIEWS_SETUP_SHOW_SCM_FOR_COMMIT: 'views.setup.showScmForCommit',
+    VIEWS_SETUP_UPDATE_PYTHON_ENVIRONMENT:
+      'views.setup.updatePythonEnvironment',
     VIEWS_SETUP_UPGRADE_DVC: 'view.setup.upgradeDvc',
 
     VIEWS_TERMINAL_CLOSED: 'views.terminal.closed',
@@ -279,7 +279,7 @@ export interface IEventNamePropertyMapping {
   [EventName.VIEWS_SETUP_CLOSE]: undefined
   [EventName.VIEWS_SETUP_CREATED]: undefined
   [EventName.VIEWS_SETUP_FOCUS_CHANGED]: undefined
-  [EventName.VIEWS_SETUP_SELECT_PYTHON_INTERPRETER]: undefined
+  [EventName.VIEWS_SETUP_UPDATE_PYTHON_ENVIRONMENT]: undefined
   [EventName.VIEWS_SETUP_SHOW_SCM_FOR_COMMIT]: undefined
   [EventName.VIEWS_SETUP_INIT_GIT]: undefined
   [EventName.VIEWS_SETUP_INSTALL_DVC]: undefined

extension/src/test/cli/util.ts

@@ -11,6 +11,7 @@ import { DOT_DVC } from '../../cli/dvc/constants'
 
 const config = {
   getCliPath: () => '',
+  getPYTHONPATH: () => undefined,
   getPythonBinPath: () => getVenvBinPath(TEMP_DIR, ENV_DIR, 'python')
 } as Config