Add shortcut to filter experiments to starred (#2170)

* add shortcut to filter experiments by starred * self review
iterative · Aug 10, 2022 · 7f1f3de · 7f1f3de
1 parent a4b4bbd
commit 7f1f3de
Show file tree

Hide file tree

Showing 9 changed files with 72 additions and 7 deletions.
diff --git a/extension/package.json b/extension/package.json
@@ -100,6 +100,12 @@
         "category": "DVC",
         "icon": "$(add)"
       },
+      {
+        "title": "%command.addStarredExperimentsTableFilter%",
+        "command": "dvc.addStarredExperimentsTableFilter",
+        "category": "DVC",
+        "icon": "$(star-full)"
+      },
       {
         "title": "%command.addTarget%",
         "command": "dvc.addTarget",
@@ -547,6 +553,10 @@
           "command": "dvc.addExperimentsTableSort",
           "when": "dvc.commands.available && dvc.project.available"
         },
+        {
+          "command": "dvc.addStarredExperimentsTableFilter",
+          "when": "dvc.commands.available && dvc.project.available"
+        },
         {
           "command": "dvc.addTarget",
           "when": "false"
@@ -1014,6 +1024,11 @@
           "group": "inline",
           "when": "view == dvc.views.experimentsFilterByTree && dvc.commands.available && viewItem == dvcRoot"
         },
+        {
+          "command": "dvc.addStarredExperimentsTableFilter",
+          "group": "inline",
+          "when": "view == dvc.views.experimentsFilterByTree && dvc.commands.available && viewItem == dvcRoot"
+        },
         {
           "command": "dvc.views.experimentsFilterByTree.removeFilter",
           "group": "inline",
@@ -1221,10 +1236,15 @@
           "when": "view == dvc.views.experimentsFilterByTree",
           "group": "navigation@1"
         },
+        {
+          "command": "dvc.addStarredExperimentsTableFilter",
+          "when": "view == dvc.views.experimentsFilterByTree",
+          "group": "navigation@2"
+        },
         {
           "command": "dvc.views.experimentsFilterByTree.removeAllFilters",
           "when": "view == dvc.views.experimentsFilterByTree && dvc.experiments.filtered",
-          "group": "navigation@2"
+          "group": "navigation@3"
         },
         {
           "command": "dvc.showPlots",

diff --git a/extension/package.nls.json b/extension/package.nls.json
@@ -3,6 +3,7 @@
   "description": "Machine learning experiment management with tracking, plots, and data versioning.",
   "command.addExperimentsTableFilter": "Add Filter To Experiments Table",
   "command.addExperimentsTableSort": "Add Or Update Sort On Experiments Table",
+  "command.addStarredExperimentsTableFilter": "Filter Experiments Table to Starred",
   "command.addTarget": "Add Target",
   "command.applyExperiment": "Apply Experiment To Workspace",
   "command.branchExperiment": "Create New Branch From Experiment",

diff --git a/extension/src/commands/external.ts b/extension/src/commands/external.ts
@@ -44,6 +44,7 @@ export enum RegisteredCommands {
   EXPERIMENT_COLUMNS_SELECT = 'dvc.views.experimentsColumnsTree.selectColumns',
   EXPERIMENT_DISABLE_AUTO_APPLY_FILTERS = 'dvc.views.experimentsTree.disableAutoApplyFilters',
   EXPERIMENT_FILTER_ADD = 'dvc.addExperimentsTableFilter',
+  EXPERIMENT_FILTER_ADD_STARRED = 'dvc.addStarredExperimentsTableFilter',
   EXPERIMENT_FILTER_REMOVE = 'dvc.views.experimentsFilterByTree.removeFilter',
   EXPERIMENT_FILTERS_REMOVE = 'dvc.removeExperimentsTableFilters',
   EXPERIMENT_FILTERS_REMOVE_ALL = 'dvc.views.experimentsFilterByTree.removeAllFilters',

diff --git a/extension/src/experiments/commands/register.ts b/extension/src/experiments/commands/register.ts
@@ -188,6 +188,11 @@ const registerExperimentQuickPickCommands = (
     (dvcRoot?: string) => experiments.addFilter(dvcRoot)
   )
 
+  internalCommands.registerExternalCommand(
+    RegisteredCommands.EXPERIMENT_FILTER_ADD_STARRED,
+    (dvcRoot?: string) => experiments.addStarredFilter(dvcRoot)
+  )
+
   internalCommands.registerExternalCommand(
     RegisteredCommands.EXPERIMENT_FILTERS_REMOVE,
     () => experiments.removeFilters()

diff --git a/extension/src/experiments/index.ts b/extension/src/experiments/index.ts
@@ -18,6 +18,7 @@ import { askToDisableAutoApplyFilters } from './toast'
 import { Experiment, ColumnType, TableData } from './webview/contract'
 import { WebviewMessages } from './webview/messages'
 import { DecorationProvider } from './model/decorationProvider'
+import { starredFilter } from './model/filterBy/constants'
 import { ResourceLocator } from '../resourceLocator'
 import { AvailableCommands, InternalCommands } from '../commands/internal'
 import { ExperimentsOutput } from '../cli/reader'
@@ -233,6 +234,11 @@ export class Experiments extends BaseRepository<TableData> {
     return this.notifyChanged()
   }
 
+  public addStarredFilter() {
+    this.experiments.addFilter(starredFilter)
+    return this.notifyChanged()
+  }
+
   public async removeFilter(id: string) {
     const response = await this.checkAutoApplyFilters(id)
     if (response === Response.CANCEL) {

diff --git a/extension/src/experiments/model/filterBy/constants.ts b/extension/src/experiments/model/filterBy/constants.ts
@@ -0,0 +1,7 @@
+import { Operator } from '.'
+
+export const starredFilter = {
+  operator: Operator.IS_TRUE,
+  path: 'starred',
+  value: undefined
+}
diff --git a/extension/src/experiments/workspace.ts b/extension/src/experiments/workspace.ts
@@ -72,6 +72,14 @@ export class WorkspaceExperiments extends BaseWorkspaceWebviews<
     return this.getRepository(dvcRoot).addFilter()
   }
 
+  public async addStarredFilter(overrideRoot?: string) {
+    const dvcRoot = await this.getDvcRoot(overrideRoot)
+    if (!dvcRoot) {
+      return
+    }
+    return this.getRepository(dvcRoot).addStarredFilter()
+  }
+
   public async removeFilters() {
     const dvcRoot = await this.getFocusedOrOnlyOrPickProject()
     if (!dvcRoot) {

diff --git a/extension/src/telemetry/constants.ts b/extension/src/telemetry/constants.ts
@@ -112,6 +112,7 @@ export interface IEventNamePropertyMapping {
   [EventName.EXPERIMENT_BRANCH]: undefined
   [EventName.EXPERIMENT_COLUMNS_SELECT]: undefined
   [EventName.EXPERIMENT_FILTER_ADD]: undefined
+  [EventName.EXPERIMENT_FILTER_ADD_STARRED]: undefined
   [EventName.EXPERIMENT_FILTER_REMOVE]: undefined
   [EventName.EXPERIMENT_FILTERS_REMOVE]: undefined
   [EventName.EXPERIMENT_FILTERS_REMOVE_ALL]: undefined

diff --git a/extension/src/test/suite/experiments/model/filterBy/tree.test.ts b/extension/src/test/suite/experiments/model/filterBy/tree.test.ts
@@ -33,6 +33,7 @@ import {
   ExperimentsFilterByTree,
   FilterItem
 } from '../../../../../experiments/model/filterBy/tree'
+import { starredFilter } from '../../../../../experiments/model/filterBy/constants'
 
 suite('Experiments Filter By Tree Test Suite', () => {
   const disposable = Disposable.fn()
@@ -479,12 +480,6 @@ suite('Experiments Filter By Tree Test Suite', () => {
         'getFocusedOrOnlyOrPickProject'
       ).returns(dvcDemoPath)
 
-      const starredFilter = {
-        operator: Operator.IS_TRUE,
-        path: 'starred',
-        value: undefined
-      }
-
       await addFilterViaQuickInput(experiments, starredFilter)
 
       const [workspace, main] = rowsFixture
@@ -513,5 +508,26 @@ suite('Experiments Filter By Tree Test Suite', () => {
 
       expect(messageSpy).to.be.calledWith(filteredTableData)
     }).timeout(WEBVIEW_TEST_TIMEOUT)
+
+    it('should provide a shortcut to filter to starred experiments', async () => {
+      const { experiments, experimentsModel } = buildExperiments(disposable)
+
+      await experiments.isReady()
+
+      stub(WorkspaceExperiments.prototype, 'getRepository').returns(experiments)
+      stub(
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        (WorkspaceExperiments as any).prototype,
+        'getFocusedOrOnlyOrPickProject'
+      ).returns(dvcDemoPath)
+
+      const mockAddFilter = stub(experimentsModel, 'addFilter')
+
+      await commands.executeCommand(
+        RegisteredCommands.EXPERIMENT_FILTER_ADD_STARRED
+      )
+
+      expect(mockAddFilter).to.be.calledWith(starredFilter)
+    })
   })
 })