Show the setup instead of original webview if needed (command palette) (#3256)

* Show the setup instead of original webview if needed (command palette)

* Fix test

* Use executeCommand and clean up package.json

* Try adding tests

* Get tests to work

* Use registered commands

* Make testing easier

Author: sroy3

extension/package.json

@@ -1353,13 +1353,7 @@
     "viewsWelcome": [
       {
         "view": "dvc.views.webviews",
-        "contents": "[Show Experiments](command:dvc.showExperiments)\n[Show Plots](command:dvc.showPlots)\n[Show Experiments and Plots](command:dvc.showExperimentsAndPlots)",
-        "when": "dvc.commands.available && dvc.project.available && dvc.project.hasData"
-      },
-      {
-        "view": "dvc.views.webviews",
-        "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"
+        "contents": "[Show Experiments](command:dvc.showExperiments)\n[Show Plots](command:dvc.showPlots)\n[Show Experiments and Plots](command:dvc.showExperimentsAndPlots)"
       },
       {
         "view": "dvc.views.welcome",

extension/src/commands/util.ts

@@ -0,0 +1,11 @@
+import { commands } from 'vscode'
+import { RegisteredCommands } from './external'
+import { Setup } from '../setup'
+import { Context } from '../vscode/context'
+
+export const showSetupOrExecuteCommand =
+  <T>(setup: Setup, callback: (context: Context) => Promise<T | undefined>) =>
+  (context: Context) =>
+    setup.shouldBeShown()
+      ? commands.executeCommand(RegisteredCommands.SETUP_SHOW)
+      : callback(context)

extension/src/experiments/commands/register.ts

@@ -12,6 +12,8 @@ import {
 } from '../../commands/external'
 import { Title } from '../../vscode/title'
 import { Context, getDvcRootFromContext } from '../../vscode/context'
+import { Setup } from '../../setup'
+import { showSetupOrExecuteCommand } from '../../commands/util'
 
 type ExperimentDetails = { dvcRoot: string; id: string }
 
@@ -280,7 +282,8 @@ const registerExperimentQuickPickCommands = (
 
 const registerExperimentRunCommands = (
   experiments: WorkspaceExperiments,
-  internalCommands: InternalCommands
+  internalCommands: InternalCommands,
+  setup: Setup
 ): void => {
   internalCommands.registerExternalCliCommand(
     RegisteredCliCommands.EXPERIMENT_RUN,
@@ -317,20 +320,22 @@ const registerExperimentRunCommands = (
 
   internalCommands.registerExternalCommand(
     RegisteredCommands.EXPERIMENT_SHOW,
-    (context: Context) =>
+    showSetupOrExecuteCommand(setup, context =>
       experiments.showWebview(getDvcRootFromContext(context))
+    )
   )
 }
 
 export const registerExperimentCommands = (
   experiments: WorkspaceExperiments,
-  internalCommands: InternalCommands
+  internalCommands: InternalCommands,
+  setup: Setup
 ) => {
   registerExperimentCwdCommands(experiments, internalCommands)
   registerExperimentNameCommands(experiments, internalCommands)
   registerExperimentInputCommands(experiments, internalCommands)
   registerExperimentQuickPickCommands(experiments, internalCommands)
-  registerExperimentRunCommands(experiments, internalCommands)
+  registerExperimentRunCommands(experiments, internalCommands, setup)
 
   internalCommands.registerExternalCommand(
     RegisteredCommands.EXPERIMENT_AUTO_APPLY_FILTERS,

extension/src/extension.ts

@@ -185,11 +185,19 @@ export class Extension extends Disposable {
       )
     )
 
-    registerExperimentCommands(this.experiments, this.internalCommands)
-    registerPlotsCommands(this.plots, this.internalCommands)
+    registerExperimentCommands(
+      this.experiments,
+      this.internalCommands,
+      this.setup
+    )
+    registerPlotsCommands(this.plots, this.internalCommands, this.setup)
     this.internalCommands.registerExternalCommand(
       RegisteredCommands.EXPERIMENT_AND_PLOTS_SHOW,
       async (context: VsCodeContext) => {
+        if (this.setup.shouldBeShown()) {
+          await commands.executeCommand(RegisteredCommands.SETUP_SHOW)
+          return
+        }
         const dvcRoot = getDvcRootFromContext(context)
         await this.experiments.showWebview(dvcRoot, ViewColumn.Active)
         await this.plots.showWebview(dvcRoot, ViewColumn.Beside)

extension/src/plots/commands/register.ts

@@ -1,15 +1,20 @@
 import { RegisteredCommands } from '../../commands/external'
 import { InternalCommands } from '../../commands/internal'
+import { showSetupOrExecuteCommand } from '../../commands/util'
+import { Setup } from '../../setup'
 import { Context, getDvcRootFromContext } from '../../vscode/context'
 import { WorkspacePlots } from '../workspace'
 
 export const registerPlotsCommands = (
   plots: WorkspacePlots,
-  internalCommands: InternalCommands
+  internalCommands: InternalCommands,
+  setup: Setup
 ) => {
   internalCommands.registerExternalCommand(
     RegisteredCommands.PLOTS_SHOW,
-    (context: Context) => plots.showWebview(getDvcRootFromContext(context))
+    showSetupOrExecuteCommand(setup, context =>
+      plots.showWebview(getDvcRootFromContext(context))
+    )
   )
 
   internalCommands.registerExternalCommand(

extension/src/setup/index.ts

@@ -220,21 +220,20 @@ export class Setup
     return this.sendDataToWebview()
   }
 
-  public async sendDataToWebview() {
-    const projectInitialized = this.hasRoots()
-    const hasData = this.getHasData()
+  public shouldBeShown() {
+    return !this.cliCompatible || !this.hasRoots() || !this.getHasData()
+  }
 
-    if (
-      this.webview?.isVisible &&
-      this.cliCompatible &&
-      projectInitialized &&
-      hasData
-    ) {
+  public async sendDataToWebview() {
+    if (this.webview?.isVisible && !this.shouldBeShown()) {
       this.getWebview()?.dispose()
       this.showExperiments()
       return
     }
 
+    const projectInitialized = this.hasRoots()
+    const hasData = this.getHasData()
+
     const needsGitInitialized =
       !projectInitialized && !!(await this.needsGitInit())
 

extension/src/test/suite/experiments/index.test.ts

@@ -73,6 +73,7 @@ import { ConfigKey } from '../../../vscode/config'
 import { EXPERIMENT_WORKSPACE_ID } from '../../../cli/dvc/contract'
 import * as Time from '../../../util/time'
 import { AvailableCommands } from '../../../commands/internal'
+import { Setup } from '../../../setup'
 import * as FileSystem from '../../../fileSystem'
 import * as ProcessExecution from '../../../processExecution'
 
@@ -1025,6 +1026,8 @@ suite('Experiments Test Suite', () => {
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
     it('should be able to handle a message to compare experiments plots', async () => {
+      const mockShouldBeShown = stub(Setup.prototype, 'shouldBeShown')
+      mockShouldBeShown.returns(false)
       const { experiments, experimentsModel } = buildExperiments(disposable)
       const mockShowPlots = stub(WorkspacePlots.prototype, 'showWebview')
 

extension/src/test/suite/experiments/util.ts

@@ -136,6 +136,7 @@ export const buildMultiRepoExperiments = (disposer: SafeWatcherDisposer) => {
 
 export const buildSingleRepoExperiments = (disposer: SafeWatcherDisposer) => {
   const {
+    config,
     internalCommands,
     gitReader,
     messageSpy,
@@ -159,7 +160,13 @@ export const buildSingleRepoExperiments = (disposer: SafeWatcherDisposer) => {
 
   void experiments.setState(expShowFixture)
 
-  return { messageSpy, workspaceExperiments }
+  return {
+    config,
+    internalCommands,
+    messageSpy,
+    resourceLocator,
+    workspaceExperiments
+  }
 }
 
 const buildExperimentsDataDependencies = (disposer: Disposer) => {

extension/src/test/suite/experiments/workspace.test.ts

@@ -1,6 +1,6 @@
 import { afterEach, beforeEach, describe, it, suite } from 'mocha'
 import { expect } from 'chai'
-import { stub, restore, SinonStub, match } from 'sinon'
+import { stub, restore, SinonStub, match, spy } from 'sinon'
 import { window, commands, QuickPickItem, Uri } from 'vscode'
 import {
   buildExperiments,
@@ -19,7 +19,10 @@ import {
   mockDuration
 } from '../util'
 import { dvcDemoPath } from '../../util'
-import { RegisteredCliCommands } from '../../../commands/external'
+import {
+  RegisteredCliCommands,
+  RegisteredCommands
+} from '../../../commands/external'
 import * as Telemetry from '../../../telemetry'
 import { DvcRunner } from '../../../cli/dvc/runner'
 import { Param } from '../../../experiments/model/modify/collect'
@@ -35,6 +38,8 @@ import { GitExecutor } from '../../../cli/git/executor'
 import { EXPERIMENT_WORKSPACE_ID } from '../../../cli/dvc/contract'
 import { formatDate } from '../../../util/date'
 import { DvcReader } from '../../../cli/dvc/reader'
+import { Setup } from '../../../setup'
+import { WorkspaceExperiments } from '../../../experiments/workspace'
 
 suite('Workspace Experiments Test Suite', () => {
   const disposable = getTimeSafeDisposer()
@@ -932,4 +937,52 @@ suite('Workspace Experiments Test Suite', () => {
       expect(mockExperimentRemove).to.be.calledWith(dvcDemoPath, '--queue')
     })
   })
+
+  describe('dvc.showExperiments', () => {
+    it('should show the setup if it should be shown', async () => {
+      const executeCommandSpy = spy(commands, 'executeCommand')
+
+      stub(Setup.prototype, 'shouldBeShown').returns(true)
+
+      await commands.executeCommand(RegisteredCommands.EXPERIMENT_SHOW)
+
+      expect(executeCommandSpy).to.have.been.calledWithMatch('dvc.showSetup')
+    })
+
+    it('should not show the experiments webview if the setup should be shown', async () => {
+      const showPlotsWebviewSpy = stub(
+        WorkspaceExperiments.prototype,
+        'showWebview'
+      )
+      stub(Setup.prototype, 'shouldBeShown').returns(true)
+
+      await commands.executeCommand(RegisteredCommands.EXPERIMENT_SHOW)
+
+      expect(showPlotsWebviewSpy).not.to.be.called
+    })
+
+    it('should not show the setup if it should not be shown', async () => {
+      const executeCommandSpy = spy(commands, 'executeCommand')
+
+      stub(WorkspaceExperiments.prototype, 'showWebview').resolves()
+
+      stub(Setup.prototype, 'shouldBeShown').returns(false)
+
+      await commands.executeCommand(RegisteredCommands.EXPERIMENT_SHOW)
+
+      expect(executeCommandSpy).not.to.be.calledWith('dvc.showSetup')
+    })
+
+    it('should show the experiments webview if the setup should not be shown', async () => {
+      const showPlotsWebviewSpy = stub(
+        WorkspaceExperiments.prototype,
+        'showWebview'
+      ).resolves()
+      stub(Setup.prototype, 'shouldBeShown').returns(false)
+
+      await commands.executeCommand(RegisteredCommands.EXPERIMENT_SHOW)
+
+      expect(showPlotsWebviewSpy).to.be.called
+    })
+  })
 })

extension/src/test/suite/plots/util.ts

@@ -109,6 +109,23 @@ export const buildPlots = async (
   }
 }
 
+export const buildWorkspacePlots = (disposer: Disposer) => {
+  const { config, internalCommands, messageSpy, resourceLocator } =
+    buildDependencies(disposer)
+
+  const workspacePlots = disposer.track(
+    new WorkspacePlots(internalCommands, buildMockMemento())
+  )
+
+  return {
+    config,
+    internalCommands,
+    messageSpy,
+    resourceLocator,
+    workspacePlots
+  }
+}
+
 export const getExpectedCheckpointPlotsData = (
   domain: string[],
   range: Color[]