Add (manual) refresh plots command to tree and palette (#1868)

* add refresh all plots to plots tree and command palette

* add integration test

Author: mattseddon

extension/package.json

@@ -471,6 +471,12 @@
         "command": "dvc.views.plotsPathsTree.selectPlots",
         "category": "DVC",
         "icon": "$(list-filter)"
+      },
+      {
+        "title": "%command.views.plotsPathsTree.refreshPlots%",
+        "command": "dvc.views.plotsPathsTree.refreshPlots",
+        "category": "DVC",
+        "icon": "$(refresh)"
       }
     ],
     "configuration": {
@@ -778,6 +784,10 @@
         {
           "command": "dvc.views.plotsPathsTree.selectPlots",
           "when": "dvc.commands.available && dvc.project.available"
+        },
+        {
+          "command": "dvc.views.plotsPathsTree.refreshPlots",
+          "when": "dvc.commands.available && dvc.project.available"
         }
       ],
       "scm/title": [
@@ -1058,6 +1068,11 @@
           "command": "dvc.views.plotsPathsTree.selectPlots",
           "group": "inline",
           "when": "view == dvc.views.plotsPathsTree && dvc.commands.available && viewItem == dvcRoot"
+        },
+        {
+          "command": "dvc.views.plotsPathsTree.refreshPlots",
+          "group": "inline",
+          "when": "view == dvc.views.plotsPathsTree && dvc.commands.available && viewItem == dvcRoot"
         }
       ],
       "view/title": [
@@ -1210,6 +1225,11 @@
           "command": "dvc.views.plotsPathsTree.selectPlots",
           "when": "view == dvc.views.plotsPathsTree",
           "group": "navigation@2"
+        },
+        {
+          "command": "dvc.views.plotsPathsTree.refreshPlots",
+          "when": "view == dvc.views.plotsPathsTree",
+          "group": "navigation@3"
         }
       ]
     },

extension/package.nls.json

@@ -67,6 +67,7 @@
   "command.views.experimentsTree.resetAndRunCheckpointExperiment": "Modify Param(s), Reset and Run",
   "command.views.experimentsTree.selectExperiments": "Select Experiments to Display in Plots",
   "command.views.plotsPathsTree.selectPlots": "Select Plots to Display",
+  "command.views.plotsPathsTree.refreshPlots": "Refresh Plots for Selected Experiments",
   "config.doNotRecommendRedHatExtension.description": "Do not prompt to install the Red Hat YAML extension to assist with DVC YAML schema validation.",
   "config.doNotRecommendRedHatExtension.title": "Do not prompt to install the Red Hat YAML extension.",
   "config.doNotShowCliUnavailable.description": "Do not warn when the workspace contains a DVC project but the CLI is inaccessible.",

extension/src/commands/external.ts

@@ -57,6 +57,7 @@ export enum RegisteredCommands {
   PLOTS_PATH_TOGGLE = 'dvc.views.plotsPathsTree.toggleStatus',
   PLOTS_SHOW = 'dvc.showPlots',
   PLOTS_SELECT = 'dvc.views.plotsPathsTree.selectPlots',
+  PLOTS_REFRESH = 'dvc.views.plotsPathsTree.refreshPlots',
 
   EXTENSION_CHECK_CLI_COMPATIBLE = 'dvc.checkCLICompatible',
   EXTENSION_GET_STARTED = 'dvc.getStarted',

extension/src/plots/commands/register.ts

@@ -17,4 +17,9 @@ export const registerPlotsCommands = (
     RegisteredCommands.PLOTS_SELECT,
     (dvcRoot?: string) => plots.selectPlots(dvcRoot)
   )
+
+  internalCommands.registerExternalCommand(
+    RegisteredCommands.PLOTS_REFRESH,
+    (dvcRoot?: string) => plots.refresh(dvcRoot)
+  )
 }

extension/src/plots/index.ts

@@ -125,6 +125,16 @@ export class Plots extends BaseRepository<TPlotsData> {
     return this.notifyChanged()
   }
 
+  public refreshPlots() {
+    Toast.infoWithOptions(
+      'Attempting to refresh plots for selected experiments.'
+    )
+    for (const { revision } of this.plots?.getSelectedRevisionDetails() || []) {
+      this.plots?.setupManualRefresh(revision)
+    }
+    this.data.managedUpdate()
+  }
+
   public getChildPaths(path: string) {
     return this.paths?.getChildren(path) || []
   }

extension/src/plots/workspace.ts

@@ -39,6 +39,14 @@ export class WorkspacePlots extends BaseWorkspaceWebviews<Plots, PlotsData> {
     return plots
   }
 
+  public async refresh(overrideRoot?: string) {
+    const dvcRoot = await this.getDvcRoot(overrideRoot)
+    if (!dvcRoot) {
+      return
+    }
+    return this.getRepository(dvcRoot).refreshPlots()
+  }
+
   public async selectPlots(overrideRoot?: string) {
     const dvcRoot = await this.getDvcRoot(overrideRoot)
     if (!dvcRoot) {

extension/src/telemetry/constants.ts

@@ -142,6 +142,7 @@ export interface IEventNamePropertyMapping {
   [EventName.PLOTS_PATH_TOGGLE]: undefined
   [EventName.PLOTS_SHOW]: undefined
   [EventName.PLOTS_SELECT]: undefined
+  [EventName.PLOTS_REFRESH]: undefined
 
   [EventName.ADD_TARGET]: undefined
   [EventName.CHECKOUT_TARGET]: undefined

extension/src/test/suite/plots/paths/tree.test.ts

@@ -128,5 +128,32 @@ suite('Plots Paths Tree Test Suite', () => {
         template: templatePlotsFixture
       })
     }).timeout(WEBVIEW_TEST_TIMEOUT)
+
+    it('should be able to refresh revision data for all plots using dvc.views.plotsPathsTree.refreshPlots', async () => {
+      const { data, mockPlotsDiff, plots } = await buildPlots(
+        disposable,
+        plotsDiffFixture
+      )
+
+      await plots.showWebview()
+
+      const dataUpdated = new Promise(resolve =>
+        disposable.track(data.onDidUpdate(() => resolve(undefined)))
+      )
+      mockPlotsDiff.resetHistory()
+
+      await commands.executeCommand(RegisteredCommands.PLOTS_REFRESH)
+      await dataUpdated
+
+      expect(mockPlotsDiff).to.be.calledOnce
+      expect(mockPlotsDiff).to.be.calledWithExactly(
+        dvcDemoPath,
+        '1ba7bcd',
+        '42b8736',
+        '4fb124a',
+        'main',
+        'workspace'
+      )
+    }).timeout(WEBVIEW_TEST_TIMEOUT)
   })
 })