Hide remove all buttons from trees when there is nothing to remove (#2131)

Author: mattseddon

extension/package.json

@@ -1213,7 +1213,7 @@
         },
         {
           "command": "dvc.views.experimentsSortByTree.removeAllSorts",
-          "when": "view == dvc.views.experimentsSortByTree",
+          "when": "view == dvc.views.experimentsSortByTree && dvc.experiments.sorted",
           "group": "navigation@2"
         },
         {
@@ -1223,7 +1223,7 @@
         },
         {
           "command": "dvc.views.experimentsFilterByTree.removeAllFilters",
-          "when": "view == dvc.views.experimentsFilterByTree",
+          "when": "view == dvc.views.experimentsFilterByTree && dvc.experiments.filtered",
           "group": "navigation@2"
         },
         {

extension/src/context.ts

@@ -1,5 +1,6 @@
 import { Disposable } from './class/dispose'
 import { CliRunner } from './cli/runner'
+import { Experiments } from './experiments'
 import { WorkspaceExperiments } from './experiments/workspace'
 import { setContextValue } from './vscode/context'
 
@@ -25,25 +26,59 @@ export class Context extends Disposable {
       )
     )
 
+    this.onDidChangeExperiments()
+  }
+
+  private onDidChangeExperiments() {
     this.dispose.track(
       this.experiments.onDidChangeExperiments(() => {
-        this.setIsExperimentRunning()
+        const repositories: Experiments[] = []
+        for (const dvcRoot of this.experiments.getDvcRoots()) {
+          repositories.push(this.experiments.getRepository(dvcRoot))
+        }
+
+        this.setIsExperimentRunning(repositories)
+
+        this.setContextFromRepositories(
+          'dvc.experiments.filtered',
+          repositories,
+          (experiments: Experiments) => experiments.getFilters().length > 0
+        )
+
+        this.setContextFromRepositories(
+          'dvc.experiments.sorted',
+          repositories,
+          (experiments: Experiments) => experiments.getSorts().length > 0
+        )
       })
     )
   }
 
-  private setIsExperimentRunning() {
+  private setIsExperimentRunning(repositories: Experiments[] = []) {
+    const contextKey = 'dvc.experiment.running'
     if (this.cliRunner.isExperimentRunning()) {
-      setContextValue('dvc.experiment.running', true)
+      setContextValue(contextKey, true)
       return
     }
 
-    let hasRunning = false
-    for (const dvcRoot of this.experiments.getDvcRoots()) {
-      if (this.experiments.getRepository(dvcRoot).hasRunningExperiment()) {
-        hasRunning = true
+    this.setContextFromRepositories(
+      contextKey,
+      repositories,
+      (experiments: Experiments) => experiments.hasRunningExperiment()
+    )
+  }
+
+  private setContextFromRepositories(
+    contextKey: string,
+    repositories: Experiments[],
+    hasRequirement: (experiments: Experiments) => boolean
+  ) {
+    for (const experiments of repositories) {
+      if (hasRequirement(experiments)) {
+        setContextValue(contextKey, true)
+        return
       }
     }
-    setContextValue('dvc.experiment.running', hasRunning)
+    setContextValue(contextKey, false)
   }
 }

extension/src/test/suite/context.test.ts

@@ -7,6 +7,8 @@ import { commands, EventEmitter } from 'vscode'
 import { CliRunner } from '../../cli/runner'
 import { WorkspaceExperiments } from '../../experiments/workspace'
 import { Context } from '../../context'
+import { FilterDefinition } from '../../experiments/model/filterBy'
+import { SortDefinition } from '../../experiments/model/sortBy'
 
 suite('Context Test Suite', () => {
   const disposable = Disposable.fn()
@@ -58,6 +60,18 @@ suite('Context Test Suite', () => {
     }
   }
 
+  const buildMockExperiments = (
+    filters: FilterDefinition[] = [],
+    sorts: SortDefinition[] = [],
+    experimentRunning = false
+  ) => {
+    return {
+      getFilters: () => filters,
+      getSorts: () => sorts,
+      hasRunningExperiment: () => experimentRunning
+    }
+  }
+
   beforeEach(() => {
     restore()
   })
@@ -105,10 +119,10 @@ suite('Context Test Suite', () => {
       mockGetDvcRoots.returns([mockDvcRoot, mockOtherDvcRoot])
       mockGetRepository.callsFake(dvcRoot => {
         if (dvcRoot === mockDvcRoot) {
-          return { hasRunningExperiment: () => true }
+          return buildMockExperiments([], [], true)
         }
         if (dvcRoot === mockOtherDvcRoot) {
-          return { hasRunningExperiment: () => false }
+          return buildMockExperiments()
         }
       })
 
@@ -137,9 +151,7 @@ suite('Context Test Suite', () => {
 
       const mockDvcRoot = resolve('first', 'root')
       mockGetDvcRoots.returns([mockDvcRoot])
-      mockGetRepository.callsFake(() => {
-        return { hasRunningExperiment: () => false }
-      })
+      mockGetRepository.callsFake(() => buildMockExperiments())
 
       experimentsChanged.fire()
       await experimentsChangedEvent
@@ -150,5 +162,97 @@ suite('Context Test Suite', () => {
         false
       )
     })
+
+    it('should set the dvc.experiments.filtered context correctly depending on whether there are filters applied', async () => {
+      const {
+        executeCommandSpy,
+        experimentsChanged,
+        mockGetDvcRoots,
+        mockGetRepository,
+        onDidChangeExperiments
+      } = buildContext(false)
+
+      const firstExperimentsChangedEvent = new Promise(resolve =>
+        disposable.track(onDidChangeExperiments(() => resolve(undefined)))
+      )
+
+      const mockDvcRoot = resolve('mock', 'root')
+      mockGetDvcRoots.returns([mockDvcRoot])
+      mockGetRepository.callsFake(() => buildMockExperiments())
+
+      experimentsChanged.fire()
+      await firstExperimentsChangedEvent
+
+      expect(executeCommandSpy).to.be.calledWith(
+        'setContext',
+        'dvc.experiments.filtered',
+        false
+      )
+
+      executeCommandSpy.resetHistory()
+      mockGetRepository.resetBehavior()
+      mockGetRepository.callsFake(() =>
+        buildMockExperiments([{} as FilterDefinition])
+      )
+
+      const secondExperimentsChangedEvent = new Promise(resolve =>
+        disposable.track(onDidChangeExperiments(() => resolve(undefined)))
+      )
+
+      experimentsChanged.fire()
+      await secondExperimentsChangedEvent
+
+      expect(executeCommandSpy).to.be.calledWith(
+        'setContext',
+        'dvc.experiments.filtered',
+        true
+      )
+    })
+
+    it('should set the dvc.experiments.sorted context correctly depending on whether there are sorts applied', async () => {
+      const {
+        executeCommandSpy,
+        experimentsChanged,
+        mockGetDvcRoots,
+        mockGetRepository,
+        onDidChangeExperiments
+      } = buildContext(false)
+
+      const firstExperimentsChangedEvent = new Promise(resolve =>
+        disposable.track(onDidChangeExperiments(() => resolve(undefined)))
+      )
+
+      const mockDvcRoot = resolve('mock', 'root')
+      mockGetDvcRoots.returns([mockDvcRoot])
+      mockGetRepository.callsFake(() => buildMockExperiments())
+
+      experimentsChanged.fire()
+      await firstExperimentsChangedEvent
+
+      expect(executeCommandSpy).to.be.calledWith(
+        'setContext',
+        'dvc.experiments.sorted',
+        false
+      )
+
+      executeCommandSpy.resetHistory()
+      mockGetRepository.resetBehavior()
+      mockGetRepository.callsFake(() =>
+        buildMockExperiments([], [{} as SortDefinition])
+      )
+
+      const secondExperimentsChangedEvent = new Promise(resolve =>
+        disposable.track(onDidChangeExperiments(() => resolve(undefined)))
+      )
+
+      experimentsChanged.fire()
+      await secondExperimentsChangedEvent
+
+      expect(executeCommandSpy).to.be.calledWith(
+        'setContext',
+        'dvc.experiments.sorted',
+        true
+      )
+    })
   })
 })