Enable user to move from Global to Auto without reloading the window (#2974)

* Enable user to move from Global to Auto without reloading the window

* use set python and notify if changed to trigger setup

Author: mattseddon

extension/src/config.ts

@@ -43,6 +43,17 @@ export class Config extends DeferredDisposable {
     return this.pythonBinPath
   }
 
+  public async setPythonBinPath() {
+    this.pythonBinPath = await this.getConfigOrExtensionPythonBinPath()
+    return this.deferred.resolve()
+  }
+
+  public async setPythonAndNotifyIfChanged() {
+    const oldPath = this.pythonBinPath
+    this.pythonBinPath = await this.getConfigOrExtensionPythonBinPath()
+    this.notifyIfChanged(oldPath, this.pythonBinPath)
+  }
+
   public unsetPythonBinPath() {
     this.pythonBinPath = undefined
   }
@@ -55,11 +66,6 @@ export class Config extends DeferredDisposable {
     return getConfigValue(ConfigKey.PYTHON_PATH) || (await getPythonBinPath())
   }
 
-  private async setPythonBinPath() {
-    this.pythonBinPath = await this.getConfigOrExtensionPythonBinPath()
-    return this.deferred.resolve()
-  }
-
   private async onDidChangePythonExecutionDetails() {
     this.pythonExecutionDetailsListener?.dispose()
     const onDidChangePythonExecutionDetails =
@@ -95,12 +101,6 @@ export class Config extends DeferredDisposable {
     )
   }
 
-  private async setPythonAndNotifyIfChanged() {
-    const oldPath = this.pythonBinPath
-    this.pythonBinPath = await this.getConfigOrExtensionPythonBinPath()
-    this.notifyIfChanged(oldPath, this.pythonBinPath)
-  }
-
   private notifyIfChanged(
     oldPath: string | undefined,
     newPath: string | undefined

extension/src/extension.ts

@@ -338,7 +338,9 @@ export class Extension extends Disposable implements IExtension {
       const previousCliPath = this.config.getCliPath()
       const previousPythonPath = this.config.getPythonBinPath()
 
-      const completed = await setupWorkspace()
+      const completed = await setupWorkspace(() =>
+        this.config.setPythonAndNotifyIfChanged()
+      )
       sendTelemetryEvent(
         RegisteredCommands.EXTENSION_SETUP_WORKSPACE,
         { completed },
@@ -507,8 +509,18 @@ export class Extension extends Disposable implements IExtension {
     return createFileSystemWatcher(
       disposable => this.dispose.track(disposable),
       '**/dvc{,.exe}',
-      path => {
-        if (path && (!this.cliAccessible || !this.cliCompatible)) {
+      async path => {
+        if (!path) {
+          return
+        }
+
+        const previousPythonBinPath = this.config.getPythonBinPath()
+        await this.config.setPythonBinPath()
+
+        const trySetupWithVenv =
+          previousPythonBinPath !== this.config.getPythonBinPath()
+
+        if (!this.cliAccessible || !this.cliCompatible || trySetupWithVenv) {
           setup(this)
         }
       }

extension/src/setup.test.ts

@@ -79,6 +79,8 @@ const mockedSetRoots = jest.fn()
 const mockedSetupWorkspace = jest.fn()
 const mockedUnsetPythonBinPath = jest.fn()
 
+const mockedSetConfigToUsePythonExtension = jest.fn()
+
 const mockedQuickPickYesOrNo = jest.mocked(quickPickYesOrNo)
 const mockedQuickPickValue = jest.mocked(quickPickValue)
 const mockedSetConfigValue = jest.mocked(setConfigValue)
@@ -105,7 +107,7 @@ describe('setupWorkspace', () => {
   it('should present two options if the python extension is installed (Auto & Global)', async () => {
     mockedQuickPickValue.mockResolvedValueOnce(undefined)
 
-    await setupWorkspace()
+    await setupWorkspace(mockedSetConfigToUsePythonExtension)
 
     expect(mockedQuickPickValue).toHaveBeenCalledTimes(1)
     expect(mockedQuickPickValue).toHaveBeenCalledWith(
@@ -123,7 +125,7 @@ describe('setupWorkspace', () => {
   it('should present two options if the python extension is NOT installed (Manual & Global)', async () => {
     mockedExtensions.all = []
 
-    await setupWorkspace()
+    await setupWorkspace(mockedSetConfigToUsePythonExtension)
 
     expect(mockedQuickPickValue).toHaveBeenCalledTimes(1)
     expect(mockedQuickPickValue).toHaveBeenCalledWith(
@@ -141,9 +143,10 @@ describe('setupWorkspace', () => {
   it('should set the dvc path and python path options to undefined if the CLI is being auto detected inside a virtual environment', async () => {
     mockedQuickPickValue.mockResolvedValueOnce(2)
 
-    await setupWorkspace()
+    await setupWorkspace(mockedSetConfigToUsePythonExtension)
 
     expect(mockedQuickPickValue).toHaveBeenCalledTimes(1)
+    expect(mockedSetConfigToUsePythonExtension).toHaveBeenCalledTimes(1)
     expect(mockedSetConfigValue).toHaveBeenCalledWith(
       ConfigKey.DVC_PATH,
       undefined
@@ -158,7 +161,7 @@ describe('setupWorkspace', () => {
     mockedQuickPickValue.mockResolvedValueOnce(1)
     mockedQuickPickOneOrInput.mockResolvedValueOnce(undefined)
 
-    await setupWorkspace()
+    await setupWorkspace(mockedSetConfigToUsePythonExtension)
 
     expect(mockedQuickPickValue).toHaveBeenCalledTimes(1)
     expect(mockedQuickPickOneOrInput).toHaveBeenCalledTimes(1)
@@ -173,8 +176,9 @@ describe('setupWorkspace', () => {
     mockedQuickPickOneOrInput.mockResolvedValueOnce('pick')
     mockedPickFile.mockResolvedValueOnce(mockedPythonPath)
 
-    await setupWorkspace()
+    await setupWorkspace(mockedSetConfigToUsePythonExtension)
 
+    expect(mockedSetConfigToUsePythonExtension).not.toHaveBeenCalled()
     expect(mockedQuickPickValue).toHaveBeenCalledTimes(1)
     expect(mockedQuickPickYesOrNo).toHaveBeenCalledTimes(2)
     expect(mockedQuickPickOneOrInput).toHaveBeenCalledTimes(1)
@@ -190,7 +194,7 @@ describe('setupWorkspace', () => {
   it('should return without setting any options if the dialog is cancelled at the virtual environment step', async () => {
     mockedQuickPickValue.mockResolvedValueOnce(undefined)
 
-    await setupWorkspace()
+    await setupWorkspace(mockedSetConfigToUsePythonExtension)
 
     expect(mockedQuickPickValue).toHaveBeenCalledTimes(1)
     expect(mockedSetConfigValue).not.toHaveBeenCalled()
@@ -208,7 +212,7 @@ describe('setupWorkspace', () => {
       .mockResolvedValueOnce(mockedPythonPath)
       .mockResolvedValueOnce(mockedDvcPath)
 
-    await setupWorkspace()
+    await setupWorkspace(mockedSetConfigToUsePythonExtension)
 
     expect(mockedQuickPickValue).toHaveBeenCalledTimes(1)
     expect(mockedQuickPickYesOrNo).toHaveBeenCalledTimes(2)
@@ -229,7 +233,7 @@ describe('setupWorkspace', () => {
     mockedQuickPickValue.mockResolvedValueOnce(1)
     mockedQuickPickOneOrInput.mockResolvedValueOnce(undefined)
 
-    await setupWorkspace()
+    await setupWorkspace(mockedSetConfigToUsePythonExtension)
 
     expect(mockedQuickPickValue).toHaveBeenCalledTimes(1)
     expect(mockedQuickPickYesOrNo).not.toHaveBeenCalled()
@@ -247,7 +251,7 @@ describe('setupWorkspace', () => {
     mockedQuickPickOneOrInput.mockResolvedValueOnce('pick')
     mockedPickFile.mockResolvedValueOnce(mockedDvcPath)
 
-    await setupWorkspace()
+    await setupWorkspace(mockedSetConfigToUsePythonExtension)
 
     expect(mockedQuickPickValue).toHaveBeenCalledTimes(1)
     expect(mockedQuickPickYesOrNo).toHaveBeenCalledTimes(2)

extension/src/setup.ts

@@ -129,29 +129,47 @@ const quickPickVenvOption = () => {
   })
 }
 
-const selectInterpreter = async (usesVenv: number) => {
+const manuallySelectInterpreter = async () => {
+  const interpreterSet = await enterPathOrPickFile(
+    ConfigKey.PYTHON_PATH,
+    'Python Interpreter'
+  )
+  if (!interpreterSet) {
+    return false
+  }
+  return pickVenvOptions()
+}
+
+const selectInterpreter = async (
+  usesVenv: number,
+  setConfigToUsePythonExtension: () => Promise<void>
+) => {
   if (usesVenv === 1) {
-    return enterPathOrPickFile(ConfigKey.PYTHON_PATH, 'Python Interpreter')
+    return manuallySelectInterpreter()
   }
 
   await Promise.all([
     setConfigPath(ConfigKey.PYTHON_PATH, undefined),
     setConfigPath(ConfigKey.DVC_PATH, undefined)
   ])
 
+  await setConfigToUsePythonExtension()
+
   selectPythonInterpreter()
-  return false
+  return true
 }
 
-export const setupWorkspace = async (): Promise<boolean> => {
+export const setupWorkspace = async (
+  setConfigToUsePythonExtension: () => Promise<void>
+): Promise<boolean> => {
   const usesVenv = await quickPickVenvOption()
 
   if (usesVenv === undefined) {
     return false
   }
 
   if (usesVenv) {
-    return (await selectInterpreter(usesVenv)) ? pickVenvOptions() : false
+    return selectInterpreter(usesVenv, setConfigToUsePythonExtension)
   }
 
   return pickCliPath()