exp rename: Add exp rename to experiments table (#4616)

* Add initial experiment rename capability

* Adjust rename command to quickPick experiment name

* Update package.json

* Add version checking; Move rename to view commands

* Add automated tests for rename

* Update tests

* Update rename tests; Update warning message

Author: BradyJ27

extension/src/cli/dvc/constants.ts

@@ -89,6 +89,7 @@ export enum ExperimentSubCommand {
   GARBAGE_COLLECT = 'gc',
   PUSH = 'push',
   REMOVE = 'remove',
+  RENAME = 'rename',
   RUN = 'run'
 }
 

extension/src/cli/dvc/executor.test.ts

@@ -661,4 +661,25 @@ describe('CliExecutor', () => {
       )
     })
   })
+
+  describe('rename', () => {
+    it('should call createProcess with the correct parameters to rename the experiment', async () => {
+      const cwd = __dirname
+
+      const stdout = 'Experiment renamed successfully.'
+
+      mockedCreateProcess.mockReturnValueOnce(getMockedProcess(stdout))
+
+      const output = await dvcExecutor.expRename(cwd, 'old-name', 'new-name')
+
+      expect(output).toStrictEqual(stdout)
+
+      expect(mockedCreateProcess).toHaveBeenCalledWith({
+        args: ['exp', 'rename', 'old-name', 'new-name'],
+        cwd,
+        env: mockedEnv,
+        executable: 'dvc'
+      })
+    })
+  })
 })

extension/src/cli/dvc/executor.ts

@@ -21,6 +21,7 @@ export const autoRegisteredCommands = {
   EXP_QUEUE: 'expRunQueue',
   EXP_REMOVE: 'expRemove',
   EXP_REMOVE_QUEUE: 'expRemoveQueue',
+  EXP_RENAME: 'expRename',
   INIT: 'init',
   IS_SCM_COMMAND_RUNNING: 'isScmCommandRunning',
   MOVE: 'move',
@@ -90,6 +91,15 @@ export class DvcExecutor extends DvcCli {
     return this.expRemove(cwd, ExperimentFlag.QUEUE)
   }
 
+  public expRename(cwd: string, experimentName: string, newName: string) {
+    return this.executeExperimentProcess(
+      cwd,
+      ExperimentSubCommand.RENAME,
+      experimentName,
+      newName
+    )
+  }
+
   public expRunQueue(cwd: string, ...args: Args) {
     return this.executeExperimentProcess(
       cwd,

extension/src/cli/dvc/version.ts

@@ -18,21 +18,25 @@ export const extractSemver = (stdout: string): ParsedSemver | undefined => {
   return { major: Number(major), minor: Number(minor), patch: Number(patch) }
 }
 
-const checkCLIVersion = (currentSemVer: {
-  major: number
-  minor: number
-  patch: number
-}): CliCompatible => {
+const checkCLIVersion = (
+  currentSemVer: {
+    major: number
+    minor: number
+    patch: number
+  },
+  minSemVer = MIN_CLI_VERSION
+): CliCompatible => {
   const {
     major: currentMajor,
     minor: currentMinor,
     patch: currentPatch
   } = currentSemVer
+  minSemVer = minSemVer || MIN_CLI_VERSION
   const {
     major: minMajor,
     minor: minMinor,
     patch: minPatch
-  } = extractSemver(MIN_CLI_VERSION) as ParsedSemver
+  } = extractSemver(minSemVer) as ParsedSemver
 
   const isBehindMinVersion =
     currentMajor < minMajor ||
@@ -47,7 +51,8 @@ const checkCLIVersion = (currentSemVer: {
 }
 
 export const isVersionCompatible = (
-  version: string | undefined
+  version: string | undefined,
+  requiredVersion = MIN_CLI_VERSION
 ): CliCompatible => {
   if (!version) {
     return CliCompatible.NO_NOT_FOUND
@@ -64,6 +69,10 @@ export const isVersionCompatible = (
     return CliCompatible.NO_CANNOT_VERIFY
   }
 
+  if (requiredVersion) {
+    return checkCLIVersion(currentSemVer, requiredVersion)
+  }
+
   return checkCLIVersion(currentSemVer)
 }
 

extension/src/commands/external.ts

@@ -16,6 +16,7 @@ export enum RegisteredCliCommands {
   EXPERIMENT_VIEW_BRANCH = 'dvc.views.experiments.branchExperiment',
   EXPERIMENT_VIEW_PUSH = 'dvc.views.experiments.pushExperiment',
   EXPERIMENT_VIEW_REMOVE = 'dvc.views.experiments.removeExperiment',
+  EXPERIMENT_VIEW_RENAME = 'dvc.views.experiments.renameExperiment',
   EXPERIMENT_VIEW_SHOW_LOGS = 'dvc.views.experiments.showLogs',
 
   EXPERIMENT_VIEW_QUEUE = 'dvc.views.experiments.queueExperiment',

extension/src/experiments/commands/index.ts

@@ -17,6 +17,11 @@ export const getBranchExperimentCommand =
   (cwd: string, name: string, input: string) =>
     experiments.runCommand(AvailableCommands.EXP_BRANCH, cwd, name, input)
 
+export const getRenameExperimentCommand =
+  (experiments: WorkspaceExperiments) =>
+  (cwd: string, oldName: string, newName: string) =>
+    experiments.runCommand(AvailableCommands.EXP_RENAME, cwd, oldName, newName)
+
 const promptToAddStudioToken = async () => {
   const response = await Toast.askShowOrCloseOrNever(
     `Experiments can be automatically shared to [Studio](${STUDIO_URL}) by setting the studio.token in your config.`

extension/src/experiments/commands/register.ts

@@ -1,4 +1,8 @@
-import { getBranchExperimentCommand, getPushExperimentCommand } from '.'
+import {
+  getBranchExperimentCommand,
+  getPushExperimentCommand,
+  getRenameExperimentCommand
+} from '.'
 import { WorkspaceExperiments } from '../workspace'
 import { AvailableCommands, InternalCommands } from '../../commands/internal'
 import {
@@ -9,6 +13,10 @@ import { Title } from '../../vscode/title'
 import { Context, getDvcRootFromContext } from '../../vscode/context'
 import { Setup } from '../../setup'
 import { showSetupOrExecuteCommand } from '../../commands/util'
+import { CliCompatible, isVersionCompatible } from '../../cli/dvc/version'
+import { Toast } from '../../vscode/toast'
+import { Response } from '../../vscode/response'
+import { SetupSection } from '../../setup/webview/contract'
 
 type ExperimentDetails = { dvcRoot: string; id: string }
 
@@ -121,13 +129,46 @@ const registerExperimentNameCommands = (
 
 const registerExperimentInputCommands = (
   experiments: WorkspaceExperiments,
-  internalCommands: InternalCommands
+  internalCommands: InternalCommands,
+  setup: Setup
 ): void => {
   internalCommands.registerExternalCliCommand(
     RegisteredCliCommands.EXPERIMENT_BRANCH,
     () => experiments.createExperimentBranch()
   )
 
+  internalCommands.registerExternalCliCommand(
+    RegisteredCliCommands.EXPERIMENT_VIEW_RENAME,
+    async ({ dvcRoot, id }: ExperimentDetails) => {
+      const cliVersion = await setup.getCliVersion(dvcRoot)
+      const REQUIRED_CLI_VERSION = '3.22.0'
+
+      if (
+        !(
+          isVersionCompatible(cliVersion, REQUIRED_CLI_VERSION) ===
+          CliCompatible.YES
+        )
+      ) {
+        const response = await Toast.warnWithOptions(
+          'To rename experiments, you need DVC version 3.22.0 or greater. Please update your DVC installation.',
+          Response.SHOW_SETUP
+        )
+        if (response === Response.SHOW_SETUP) {
+          return setup.showSetup(SetupSection.DVC)
+        }
+        return
+      }
+
+      return experiments.getInputAndRun(
+        getRenameExperimentCommand(experiments),
+        Title.ENTER_NEW_EXPERIMENT_NAME,
+        id,
+        dvcRoot,
+        id
+      )
+    }
+  )
+
   internalCommands.registerExternalCliCommand(
     RegisteredCliCommands.EXPERIMENT_VIEW_BRANCH,
     ({ dvcRoot, id }: ExperimentDetails) =>
@@ -265,7 +306,7 @@ export const registerExperimentCommands = (
 ) => {
   registerExperimentCwdCommands(experiments, internalCommands)
   registerExperimentNameCommands(experiments, internalCommands)
-  registerExperimentInputCommands(experiments, internalCommands)
+  registerExperimentInputCommands(experiments, internalCommands, setup)
   registerExperimentQuickPickCommands(experiments, internalCommands, setup)
   registerExperimentRunCommands(experiments, internalCommands, setup)
 

extension/src/experiments/webview/messages.ts

@@ -134,6 +134,11 @@ export class WebviewMessages {
           RegisteredCliCommands.EXPERIMENT_VIEW_BRANCH,
           { dvcRoot: this.dvcRoot, id: message.payload }
         )
+      case MessageFromWebviewType.RENAME_EXPERIMENT:
+        return commands.executeCommand(
+          RegisteredCliCommands.EXPERIMENT_VIEW_RENAME,
+          { dvcRoot: this.dvcRoot, id: message.payload }
+        )
       case MessageFromWebviewType.MODIFY_WORKSPACE_PARAMS_AND_QUEUE:
         return commands.executeCommand(
           RegisteredCliCommands.EXPERIMENT_VIEW_QUEUE,

extension/src/telemetry/constants.ts

@@ -161,6 +161,7 @@ export interface IEventNamePropertyMapping {
   [EventName.EXPERIMENTS_REFRESH]: undefined
   [EventName.EXPERIMENT_REMOVE]: undefined
   [EventName.EXPERIMENT_REMOVE_QUEUE]: undefined
+  [EventName.EXPERIMENT_VIEW_RENAME]: undefined
   [EventName.EXPERIMENT_RESUME]: undefined
   [EventName.EXPERIMENT_RUN]: undefined
   [EventName.EXPERIMENT_RESET_AND_RUN]: undefined

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

@@ -561,6 +561,40 @@ suite('Experiments Test Suite', () => {
       )
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
+    it('should be able to handle a message to rename an experiment', async () => {
+      const { mockMessageReceived } =
+        await stubWorkspaceGettersWebview(disposable)
+
+      const mockNewExperimentName = 'new-experiment-name'
+      const inputEvent = getInputBoxEvent(mockNewExperimentName)
+
+      stub(Setup.prototype, 'getCliVersion').resolves('3.22.0')
+
+      const mockRenameExperiment = stub(DvcExecutor.prototype, 'expRename')
+
+      const mockRenameCalled = new Promise(resolve =>
+        mockRenameExperiment.callsFake(() => {
+          resolve(undefined)
+          return Promise.resolve('Renamed experiments:')
+        })
+      )
+
+      const mockExperimentId = 'exp-e7a67'
+
+      mockMessageReceived.fire({
+        payload: mockExperimentId,
+        type: MessageFromWebviewType.RENAME_EXPERIMENT
+      })
+
+      await Promise.all([inputEvent, mockRenameCalled])
+      expect(mockRenameExperiment).to.be.calledOnce
+      expect(mockRenameExperiment).to.be.calledWithExactly(
+        dvcDemoPath,
+        mockExperimentId,
+        mockNewExperimentName
+      )
+    }).timeout(WEBVIEW_TEST_TIMEOUT)
+
     it('should handle a message to show the logs of an experiment', async () => {
       const { experiments } = buildExperiments({ disposer: disposable })
       await experiments.isReady()