Direct users to setup webview from warning popups (#2990)

* direct to setup webview from all CLI unavailable popups

* fix show setup underneath show plots button

Author: mattseddon

extension/package.json

@@ -1355,7 +1355,7 @@
       },
       {
         "view": "dvc.views.webviews",
-        "contents": "[Show Experiments](command:dvc.showSetupWebview)\n[Show Plots](command:dvc.showSetupdWebview)\n[Show Experiments and Plots](command:dvc.showSetupWebview)",
+        "contents": "[Show Experiments](command:dvc.showSetup)\n[Show Plots](command:dvc.showSetup)\n[Show Experiments and Plots](command:dvc.showSetup)",
         "when": "!dvc.commands.available || !dvc.project.available || !dvc.project.hasData"
       },
       {

extension/src/cli/dvc/discovery.ts

@@ -46,13 +46,13 @@ const warnUserCLIInaccessible = async (
 
   const response = await Toast.warnWithOptions(
     warningText,
-    Response.SETUP_WORKSPACE,
+    Response.SHOW_SETUP,
     Response.NEVER
   )
 
   switch (response) {
-    case Response.SETUP_WORKSPACE:
-      return extension.setupWorkspace()
+    case Response.SHOW_SETUP:
+      return extension.showSetup()
     case Response.NEVER:
       return setUserConfigValue(ConfigKey.DO_NOT_SHOW_CLI_UNAVAILABLE, true)
   }
@@ -77,7 +77,7 @@ const warnUser = (
   cliCompatible: CliCompatible,
   version: string | undefined
 ): void => {
-  if (!extension.hasRoots()) {
+  if (!extension.shouldWarnUserIfCLIUnavailable()) {
     return
   }
   switch (cliCompatible) {
@@ -154,11 +154,11 @@ const tryGlobalFallbackVersion = async (
   const tryGlobal = await getVersionDetails(extension, cwd, true)
   const { cliCompatible, isAvailable, isCompatible, version } = tryGlobal
 
-  if (extension.hasRoots() && !isCompatible) {
+  if (extension.shouldWarnUserIfCLIUnavailable() && !isCompatible) {
     warnUserCLIInaccessibleAnywhere(extension, version)
   }
   if (
-    extension.hasRoots() &&
+    extension.shouldWarnUserIfCLIUnavailable() &&
     cliCompatible === CliCompatible.YES_MINOR_VERSION_AHEAD_OF_TESTED
   ) {
     warnAheadOfLatestTested()

extension/src/commands/external.ts

@@ -92,5 +92,5 @@ export enum RegisteredCommands {
   TRACKED_EXPLORER_OPEN_TO_THE_SIDE = 'dvc.openToTheSide',
   TRACKED_EXPLORER_SELECT_FOR_COMPARE = 'dvc.selectForCompare',
 
-  SETUP_WEBVIEW_SHOW = 'dvc.showSetupWebview'
+  SETUP_SHOW = 'dvc.showSetup'
 }

extension/src/extension.ts

@@ -274,7 +274,7 @@ export class Extension extends Disposable implements IExtension {
     )
 
     this.internalCommands.registerExternalCommand(
-      RegisteredCommands.SETUP_WEBVIEW_SHOW,
+      RegisteredCommands.SETUP_SHOW,
       async () => {
         await this.setup.showWebview()
       }
@@ -341,39 +341,12 @@ export class Extension extends Disposable implements IExtension {
     this.watchForVenvChanges()
   }
 
-  public async setupWorkspace() {
-    const stopWatch = new StopWatch()
-    try {
-      const previousCliPath = this.config.getCliPath()
-      const previousPythonPath = this.config.getPythonBinPath()
-
-      const completed = await setupWorkspace(() =>
-        this.config.setPythonAndNotifyIfChanged()
-      )
-      sendTelemetryEvent(
-        RegisteredCommands.EXTENSION_SETUP_WORKSPACE,
-        { completed },
-        {
-          duration: stopWatch.getElapsedTime()
-        }
-      )
-
-      const executionDetailsUnchanged =
-        this.config.getCliPath() === previousPythonPath &&
-        this.config.getPythonBinPath() === previousCliPath
-
-      if (completed && !this.cliAccessible && executionDetailsUnchanged) {
-        this.workspaceChanged.fire()
-      }
+  public async showSetup() {
+    return await this.setup.showWebview()
+  }
 
-      return completed
-    } catch (error: unknown) {
-      return sendTelemetryEventAndThrow(
-        RegisteredCommands.EXTENSION_SETUP_WORKSPACE,
-        error as Error,
-        stopWatch.getElapsedTime()
-      )
-    }
+  public shouldWarnUserIfCLIUnavailable() {
+    return this.hasRoots() && !this.setup.isFocused()
   }
 
   public async isPythonExtensionUsed() {
@@ -479,6 +452,41 @@ export class Extension extends Disposable implements IExtension {
     setContextValue('dvc.commands.available', available)
   }
 
+  private async setupWorkspace() {
+    const stopWatch = new StopWatch()
+    try {
+      const previousCliPath = this.config.getCliPath()
+      const previousPythonPath = this.config.getPythonBinPath()
+
+      const completed = await setupWorkspace(() =>
+        this.config.setPythonAndNotifyIfChanged()
+      )
+      sendTelemetryEvent(
+        RegisteredCommands.EXTENSION_SETUP_WORKSPACE,
+        { completed },
+        {
+          duration: stopWatch.getElapsedTime()
+        }
+      )
+
+      const executionDetailsUnchanged =
+        this.config.getCliPath() === previousPythonPath &&
+        this.config.getPythonBinPath() === previousCliPath
+
+      if (completed && !this.cliAccessible && executionDetailsUnchanged) {
+        this.workspaceChanged.fire()
+      }
+
+      return completed
+    } catch (error: unknown) {
+      return sendTelemetryEventAndThrow(
+        RegisteredCommands.EXTENSION_SETUP_WORKSPACE,
+        error as Error,
+        stopWatch.getElapsedTime()
+      )
+    }
+  }
+
   private setProjectAvailability() {
     const available = this.hasRoots()
     setContextValue('dvc.project.available', available)

extension/src/interfaces.ts

@@ -7,7 +7,8 @@ export interface IExtension {
   hasRoots: () => boolean
   isPythonExtensionUsed: () => Promise<boolean>
 
-  setupWorkspace: () => void
+  showSetup: () => void
+  shouldWarnUserIfCLIUnavailable: () => boolean
 
   initialize: () => Promise<void[]>
   resetMembers: () => void