Add remove experiment queue command

extension/package.json

@@ -212,6 +212,11 @@
         "command": "dvc.removeExperiment",
         "category": "DVC"
       },
+      {
+        "title": "%command.removeExperimentQueue%",
+        "command": "dvc.removeExperimentQueue",
+        "category": "DVC"
+      },
       {
         "title": "%command.removeExperimentsTableFilters%",
         "command": "dvc.removeExperimentsTableFilters",
@@ -496,6 +501,10 @@
           "command": "dvc.removeExperiment",
           "when": "dvc.commands.available && dvc.project.available"
         },
+        {
+          "command": "dvc.removeExperimentQueue",
+          "when": "dvc.commands.available && dvc.project.available"
+        },
         {
           "command": "dvc.removeExperimentsTableFilters",
           "when": "dvc.commands.available && dvc.project.available"

extension/package.nls.json

@@ -30,6 +30,7 @@
   "command.queueExperimentFromExisting": "Queue Experiment From Existing",
   "command.queueExperiment": "Queue Experiment",
   "command.removeExperiment": "Remove Experiment",
+  "command.removeExperimentQueue": "Remove All Queued Experiments",
   "command.removeExperimentsTableFilters": "Remove Filter(s) From Experiments Table",
   "command.removeExperimentsTableSorts": "Remove Sort(s) From Experiments Table",
   "command.removeTarget": "Remove",

extension/src/cli/executor.test.ts

@@ -320,6 +320,24 @@ describe('CliExecutor', () => {
     })
   })
 
+  describe('experimentRemoveQueue', () => {
+    it('should call createProcess with the correct parameters to remove all existing queued experiments from the workspace', async () => {
+      const cwd = __dirname
+      const stdout = ''
+      mockedCreateProcess.mockReturnValueOnce(getMockedProcess(stdout))
+
+      const output = await cliExecutor.experimentRemoveQueue(cwd)
+      expect(output).toStrictEqual(stdout)
+
+      expect(mockedCreateProcess).toBeCalledWith({
+        args: ['exp', 'remove', '--queue'],
+        cwd,
+        env: mockedEnv,
+        executable: 'dvc'
+      })
+    })
+  })
+
   describe('experimentRunQueue', () => {
     it('should call createProcess with the correct parameters to queue an experiment for later execution', async () => {
       const cwd = __dirname

extension/src/cli/executor.ts

@@ -17,6 +17,7 @@ export const autoRegisteredCommands = {
   EXPERIMENT_GARBAGE_COLLECT: 'experimentGarbageCollect',
   EXPERIMENT_QUEUE: 'experimentRunQueue',
   EXPERIMENT_REMOVE: 'experimentRemove',
+  EXPERIMENT_REMOVE_QUEUE: 'experimentRemoveQueue',
   INIT: 'init',
   MOVE: 'move',
   PULL: 'pull',
@@ -83,6 +84,10 @@ export class CliExecutor extends Cli {
     )
   }
 
+  public experimentRemoveQueue(cwd: string) {
+    return this.experimentRemove(cwd, ExperimentFlag.QUEUE)
+  }
+
   public experimentRunQueue(cwd: string, ...args: Args) {
     return this.executeExperimentProcess(
       cwd,

extension/src/commands/external.ts

@@ -3,6 +3,7 @@ export enum RegisteredCliCommands {
   EXPERIMENT_BRANCH = 'dvc.branchExperiment',
   EXPERIMENT_GARBAGE_COLLECT = 'dvc.experimentGarbageCollect',
   EXPERIMENT_REMOVE = 'dvc.removeExperiment',
+  EXPERIMENT_REMOVE_QUEUE = 'dvc.removeExperimentQueue',
   EXPERIMENT_RUN = 'dvc.runExperiment',
   EXPERIMENT_RUN_QUEUED = 'dvc.runQueuedExperiments',
   EXPERIMENT_RUN_RESET = 'dvc.runResetExperiment',

extension/src/experiments/commands/register.ts

@@ -26,6 +26,12 @@ const registerExperimentCwdCommands = (
         experiments.queueExperimentFromExisting()
       )
   )
+
+  internalCommands.registerExternalCliCommand(
+    RegisteredCliCommands.EXPERIMENT_REMOVE_QUEUE,
+    () =>
+      experiments.getCwdThenReport(AvailableCommands.EXPERIMENT_REMOVE_QUEUE)
+  )
 }
 
 const registerExperimentNameCommands = (

extension/src/telemetry/constants.ts

@@ -81,6 +81,7 @@ export interface IEventNamePropertyMapping {
   [EventName.EXPERIMENT_GARBAGE_COLLECT]: undefined
   [EventName.EXPERIMENT_METRICS_AND_PARAMS_TOGGLE]: undefined
   [EventName.EXPERIMENT_REMOVE]: undefined
+  [EventName.EXPERIMENT_REMOVE_QUEUE]: undefined
   [EventName.EXPERIMENT_RUN]: undefined
   [EventName.EXPERIMENT_RUN_QUEUED]: undefined
   [EventName.EXPERIMENT_RUN_RESET]: undefined

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

@@ -387,4 +387,34 @@ suite('Workspace Experiments Test Suite', () => {
       expect(mockExperimentRemove).to.be.calledWith(dvcDemoPath, mockExperiment)
     })
   })
+
+  describe('dvc.removeExperimentQueue', () => {
+    it('should remove all queued experiments from the selected repository', async () => {
+      const { experiments } = buildExperiments(disposable)
+
+      await experiments.isReady()
+
+      stub(
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        (WorkspaceExperiments as any).prototype,
+        'getOnlyOrPickProject'
+      ).returns(dvcDemoPath)
+      stub(
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        (WorkspaceExperiments as any).prototype,
+        'getRepository'
+      ).returns(experiments)
+
+      const mockExperimentRemove = stub(
+        CliExecutor.prototype,
+        'experimentRemove'
+      )
+
+      await commands.executeCommand(
+        RegisteredCliCommands.EXPERIMENT_REMOVE_QUEUE
+      )
+
+      expect(mockExperimentRemove).to.be.calledWith(dvcDemoPath, '--queue')
+    })
+  })
 })