Skip to content

Commit 30659a9

Browse files
mattseddonmattseddon
authored
Drop commit/experiment support for modify and run/queue (only workspace supported as a base) (#4094)
1 parent e15dd7b commit 30659a9

File tree

16 files changed

+178
-253
lines changed

16 files changed

+178
-253
lines changed

‎extension/package.json‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -267,29 +267,29 @@
267267
"icon": "$(cloud-upload)"
268268
},
269269
{
270-
"title": "Modify Experiment Param(s) and Queue",
271-
"command": "dvc.modifyExperimentParamsAndQueue",
270+
"title": "Modify Workspace Param(s) and Queue",
271+
"command": "dvc.modifyWorkspaceParamsAndQueue",
272272
"category": "DVC",
273273
"icon": {
274274
"dark": "resources/dark/queue-experiment.svg",
275275
"light": "resources/light/queue-experiment.svg"
276276
}
277277
},
278278
{
279-
"title": "Modify Experiment Param(s) and Resume",
280-
"command": "dvc.modifyExperimentParamsAndResume",
279+
"title": "Modify Workspace Param(s) and Resume",
280+
"command": "dvc.modifyWorkspaceParamsAndResume",
281281
"category": "DVC",
282282
"icon": "$(debug-continue-small)"
283283
},
284284
{
285-
"title": "Modify Experiment Param(s) and Run",
286-
"command": "dvc.modifyExperimentParamsAndRun",
285+
"title": "Modify Workspace Param(s) and Run",
286+
"command": "dvc.modifyWorkspaceParamsAndRun",
287287
"category": "DVC",
288288
"icon": "$(play)"
289289
},
290290
{
291-
"title": "Modify Experiment Param(s) and Run",
292-
"command": "dvc.modifyExperimentParamsResetAndRun",
291+
"title": "Modify Workspace Param(s) and Run",
292+
"command": "dvc.modifyWorkspaceParamsResetAndRun",
293293
"category": "DVC",
294294
"icon": "$(play)"
295295
},
@@ -789,19 +789,19 @@
789789
"when": "false"
790790
},
791791
{
792-
"command": "dvc.modifyExperimentParamsAndQueue",
792+
"command": "dvc.modifyWorkspaceParamsAndQueue",
793793
"when": "dvc.commands.available && dvc.project.available && !dvc.experiment.running.workspace"
794794
},
795795
{
796-
"command": "dvc.modifyExperimentParamsAndRun",
796+
"command": "dvc.modifyWorkspaceParamsAndRun",
797797
"when": "dvc.commands.available && dvc.project.available && !dvc.experiment.running.workspace && !dvc.experiment.checkpoints"
798798
},
799799
{
800-
"command": "dvc.modifyExperimentParamsAndResume",
800+
"command": "dvc.modifyWorkspaceParamsAndResume",
801801
"when": "dvc.commands.available && dvc.project.available && !dvc.experiment.running.workspace && dvc.experiment.checkpoints"
802802
},
803803
{
804-
"command": "dvc.modifyExperimentParamsResetAndRun",
804+
"command": "dvc.modifyWorkspaceParamsResetAndRun",
805805
"when": "dvc.commands.available && dvc.project.available && !dvc.experiment.running.workspace && dvc.experiment.checkpoints"
806806
},
807807
{
@@ -1238,22 +1238,22 @@
12381238
{
12391239
"command": "dvc.views.experiments.runExperiment",
12401240
"group": "2_modify@1",
1241-
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem =~ /^(workspace|commit|experiment|queued)$/ && !dvc.experiment.running.workspace && !dvc.experiment.checkpoints"
1241+
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem == workspace && !dvc.experiment.running.workspace && !dvc.experiment.checkpoints"
12421242
},
12431243
{
12441244
"command": "dvc.views.experiments.resetAndRunCheckpointExperiment",
12451245
"group": "2_modify@1",
1246-
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem =~ /^(workspace|commit|experiment|queued)$/ && !dvc.experiment.running.workspace && dvc.experiment.checkpoints"
1246+
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem == workspace && !dvc.experiment.running.workspace && dvc.experiment.checkpoints"
12471247
},
12481248
{
12491249
"command": "dvc.views.experiments.resumeCheckpointExperiment",
12501250
"group": "2_modify@2",
1251-
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem =~ /^(workspace|commit|experiment|queued)$/ && !dvc.experiment.running.workspace && dvc.experiment.checkpoints"
1251+
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem == workspace && !dvc.experiment.running.workspace && dvc.experiment.checkpoints"
12521252
},
12531253
{
12541254
"command": "dvc.views.experiments.queueExperiment",
12551255
"group": "2_modify@3",
1256-
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem =~ /^(workspace|commit|experiment|queued)$/ && !dvc.experiment.running.workspace"
1256+
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem == workspace && !dvc.experiment.running.workspace"
12571257
}
12581258
],
12591259
"view/title": [
@@ -1308,22 +1308,22 @@
13081308
"group": "navigation@4"
13091309
},
13101310
{
1311-
"command": "dvc.modifyExperimentParamsAndRun",
1311+
"command": "dvc.modifyWorkspaceParamsAndRun",
13121312
"when": "view == dvc.views.experimentsTree && !dvc.experiment.running.workspace && !dvc.experiment.checkpoints",
13131313
"group": "2_modify@1"
13141314
},
13151315
{
1316-
"command": "dvc.modifyExperimentParamsAndResume",
1316+
"command": "dvc.modifyWorkspaceParamsAndResume",
13171317
"when": "view == dvc.views.experimentsTree && !dvc.experiment.running.workspace && dvc.experiment.checkpoints",
13181318
"group": "2_modify@1"
13191319
},
13201320
{
1321-
"command": "dvc.modifyExperimentParamsResetAndRun",
1321+
"command": "dvc.modifyWorkspaceParamsResetAndRun",
13221322
"when": "view == dvc.views.experimentsTree && !dvc.experiment.running.workspace && dvc.experiment.checkpoints",
13231323
"group": "2_modify@2"
13241324
},
13251325
{
1326-
"command": "dvc.modifyExperimentParamsAndQueue",
1326+
"command": "dvc.modifyWorkspaceParamsAndQueue",
13271327
"when": "view == dvc.views.experimentsTree && !dvc.experiment.running.workspace",
13281328
"group": "2_modify@3"
13291329
},
@@ -1553,12 +1553,12 @@
15531553
{
15541554
"id": "dvc.runExperiments",
15551555
"title": "Running Experiments",
1556-
"description": "Explore a few ways you can run or queue a new experiment.\n[Run an Experiment](command:dvc.modifyExperimentParamsAndRun)",
1556+
"description": "Explore a few ways you can run or queue a new experiment.\n[Run an Experiment](command:dvc.modifyWorkspaceParamsAndRun)",
15571557
"media": {
15581558
"markdown": "resources/walkthrough/run-experiments.md"
15591559
},
15601560
"completionEvents": [
1561-
"onCommand:dvc.modifyExperimentParamsAndRun"
1561+
"onCommand:dvc.modifyWorkspaceParamsAndRun"
15621562
]
15631563
},
15641564
{

‎extension/src/commands/external.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ export enum RegisteredCliCommands {
2323
EXPERIMENT_VIEW_RUN = 'dvc.views.experiments.runExperiment',
2424
EXPERIMENT_VIEW_RESET_AND_RUN = 'dvc.views.experiments.resetAndRunCheckpointExperiment',
2525

26-
MODIFY_EXPERIMENT_PARAMS_AND_QUEUE = 'dvc.modifyExperimentParamsAndQueue',
27-
MODIFY_EXPERIMENT_PARAMS_AND_RESUME = 'dvc.modifyExperimentParamsAndResume',
28-
MODIFY_EXPERIMENT_PARAMS_AND_RUN = 'dvc.modifyExperimentParamsAndRun',
29-
MODIFY_EXPERIMENT_PARAMS_RESET_AND_RUN = 'dvc.modifyExperimentParamsResetAndRun',
26+
MODIFY_WORKSPACE_PARAMS_AND_QUEUE = 'dvc.modifyWorkspaceParamsAndQueue',
27+
MODIFY_WORKSPACE_PARAMS_AND_RESUME = 'dvc.modifyWorkspaceParamsAndResume',
28+
MODIFY_WORKSPACE_PARAMS_AND_RUN = 'dvc.modifyWorkspaceParamsAndRun',
29+
MODIFY_WORKSPACE_PARAMS_RESET_AND_RUN = 'dvc.modifyWorkspaceParamsResetAndRun',
3030

3131
ADD_TARGET = 'dvc.addTarget',
3232
CHECKOUT = 'dvc.checkout',

‎extension/src/experiments/commands/register.ts‎

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -28,64 +28,61 @@ const registerExperimentCwdCommands = (
2828
)
2929

3030
internalCommands.registerExternalCliCommand(
31-
RegisteredCliCommands.MODIFY_EXPERIMENT_PARAMS_AND_QUEUE,
32-
() => experiments.modifyExperimentParamsAndQueue()
31+
RegisteredCliCommands.MODIFY_WORKSPACE_PARAMS_AND_QUEUE,
32+
() => experiments.modifyWorkspaceParamsAndQueue()
3333
)
3434

3535
internalCommands.registerExternalCliCommand(
3636
RegisteredCliCommands.EXPERIMENT_VIEW_QUEUE,
37-
({ dvcRoot, id }: ExperimentDetails) =>
38-
experiments.modifyExperimentParamsAndQueue(dvcRoot, id)
37+
({ dvcRoot }: ExperimentDetails) =>
38+
experiments.modifyWorkspaceParamsAndQueue(dvcRoot)
3939
)
4040

41-
const modifyExperimentParamsAndRun = () =>
42-
experiments.modifyExperimentParamsAndRun(AvailableCommands.EXPERIMENT_RUN)
41+
const modifyWorkspaceParamsAndRun = () =>
42+
experiments.modifyWorkspaceParamsAndRun(AvailableCommands.EXPERIMENT_RUN)
4343

4444
internalCommands.registerExternalCliCommand(
45-
RegisteredCliCommands.MODIFY_EXPERIMENT_PARAMS_AND_RESUME,
46-
modifyExperimentParamsAndRun
45+
RegisteredCliCommands.MODIFY_WORKSPACE_PARAMS_AND_RESUME,
46+
modifyWorkspaceParamsAndRun
4747
)
4848

4949
internalCommands.registerExternalCliCommand(
50-
RegisteredCliCommands.MODIFY_EXPERIMENT_PARAMS_AND_RUN,
51-
modifyExperimentParamsAndRun
50+
RegisteredCliCommands.MODIFY_WORKSPACE_PARAMS_AND_RUN,
51+
modifyWorkspaceParamsAndRun
5252
)
5353

54-
const modifyExperimentParamsAndRunFromView = ({
55-
dvcRoot,
56-
id
54+
const modifyWorkspaceParamsAndRunFromView = ({
55+
dvcRoot
5756
}: ExperimentDetails) =>
58-
experiments.modifyExperimentParamsAndRun(
57+
experiments.modifyWorkspaceParamsAndRun(
5958
AvailableCommands.EXPERIMENT_RUN,
60-
dvcRoot,
61-
id
59+
dvcRoot
6260
)
6361

6462
internalCommands.registerExternalCliCommand(
6563
RegisteredCliCommands.EXPERIMENT_VIEW_RESUME,
66-
modifyExperimentParamsAndRunFromView
64+
modifyWorkspaceParamsAndRunFromView
6765
)
6866

6967
internalCommands.registerExternalCliCommand(
7068
RegisteredCliCommands.EXPERIMENT_VIEW_RUN,
71-
modifyExperimentParamsAndRunFromView
69+
modifyWorkspaceParamsAndRunFromView
7270
)
7371

7472
internalCommands.registerExternalCliCommand(
75-
RegisteredCliCommands.MODIFY_EXPERIMENT_PARAMS_RESET_AND_RUN,
73+
RegisteredCliCommands.MODIFY_WORKSPACE_PARAMS_RESET_AND_RUN,
7674
() =>
77-
experiments.modifyExperimentParamsAndRun(
75+
experiments.modifyWorkspaceParamsAndRun(
7876
AvailableCommands.EXPERIMENT_RESET_AND_RUN
7977
)
8078
)
8179

8280
internalCommands.registerExternalCliCommand(
8381
RegisteredCliCommands.EXPERIMENT_VIEW_RESET_AND_RUN,
84-
({ dvcRoot, id }: ExperimentDetails) =>
85-
experiments.modifyExperimentParamsAndRun(
82+
({ dvcRoot }: ExperimentDetails) =>
83+
experiments.modifyWorkspaceParamsAndRun(
8684
AvailableCommands.EXPERIMENT_RESET_AND_RUN,
87-
dvcRoot,
88-
id
85+
dvcRoot
8986
)
9087
)
9188

‎extension/src/experiments/index.ts‎

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -393,13 +393,8 @@ export class Experiments extends BaseRepository<TableData> {
393393
)
394394
}
395395

396-
public async pickAndModifyParams(overrideId?: string) {
397-
const id = await this.getExperimentId(overrideId)
398-
if (!id) {
399-
return
400-
}
401-
402-
const params = this.experiments.getExperimentParams(id)
396+
public pickAndModifyParams() {
397+
const params = this.experiments.getWorkspaceParams()
403398

404399
if (!params) {
405400
return
@@ -439,11 +434,10 @@ export class Experiments extends BaseRepository<TableData> {
439434
return this.experiments.getRevisionIds()
440435
}
441436

442-
public async modifyExperimentParamsAndRun(
443-
commandId: ModifiedExperimentAndRunCommandId,
444-
experimentId?: string
437+
public async modifyWorkspaceParamsAndRun(
438+
commandId: ModifiedExperimentAndRunCommandId
445439
) {
446-
const paramsToModify = await this.pickAndModifyParams(experimentId)
440+
const paramsToModify = await this.pickAndModifyParams()
447441
if (!paramsToModify) {
448442
return
449443
}
@@ -456,8 +450,8 @@ export class Experiments extends BaseRepository<TableData> {
456450
return this.notifyChanged()
457451
}
458452

459-
public async modifyExperimentParamsAndQueue(experimentId?: string) {
460-
const paramsToModify = await this.pickAndModifyParams(experimentId)
453+
public async modifyWorkspaceParamsAndQueue() {
454+
const paramsToModify = await this.pickAndModifyParams()
461455
if (!paramsToModify) {
462456
return
463457
}

‎extension/src/experiments/model/index.test.ts‎

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -335,38 +335,14 @@ describe('ExperimentsModel', () => {
335335
])
336336
})
337337

338-
it('should fetch commit params', () => {
339-
const model = new ExperimentsModel('', buildMockMemento())
340-
model.transformAndSet(outputFixture, ...DEFAULT_DATA)
341-
342-
const commitParams = model.getExperimentParams('main')
343-
expect(definedAndNonEmpty(commitParams)).toBe(true)
344-
})
345-
346338
it('should fetch workspace params', () => {
347339
const model = new ExperimentsModel('', buildMockMemento())
348340
model.transformAndSet(outputFixture, ...DEFAULT_DATA)
349341

350-
const workspaceParams = model.getExperimentParams(EXPERIMENT_WORKSPACE_ID)
342+
const workspaceParams = model.getWorkspaceParams()
351343
expect(definedAndNonEmpty(workspaceParams)).toBe(true)
352344
})
353345

354-
it("should fetch an experiment's params", () => {
355-
const model = new ExperimentsModel('', buildMockMemento())
356-
model.transformAndSet(outputFixture, ...DEFAULT_DATA)
357-
358-
const experimentParams = model.getExperimentParams('exp-e7a67')
359-
expect(definedAndNonEmpty(experimentParams)).toBe(true)
360-
})
361-
362-
it("should fetch an empty array if the experiment's params cannot be found", () => {
363-
const model = new ExperimentsModel('', buildMockMemento())
364-
model.transformAndSet(outputFixture, ...DEFAULT_DATA)
365-
366-
const noParams = model.getExperimentParams('not-an-experiment')
367-
expect(definedAndNonEmpty(noParams)).toBe(false)
368-
})
369-
370346
it('should set the number of commits to show correctly', () => {
371347
const model = new ExperimentsModel('', buildMockMemento())
372348

‎extension/src/experiments/model/index.ts‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -345,10 +345,8 @@ export class ExperimentsModel extends ModelWithPersistence {
345345
return errors
346346
}
347347

348-
public getExperimentParams(id: string) {
349-
const params = this.getCombinedList().find(
350-
experiment => experiment.id === id
351-
)?.params
348+
public getWorkspaceParams() {
349+
const params = this.workspace.params
352350

353351
return collectFlatExperimentParams(params)
354352
}

‎extension/src/experiments/webview/messages.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,20 +117,20 @@ export class WebviewMessages {
117117
RegisteredCliCommands.EXPERIMENT_VIEW_BRANCH,
118118
{ dvcRoot: this.dvcRoot, id: message.payload }
119119
)
120-
case MessageFromWebviewType.MODIFY_EXPERIMENT_PARAMS_AND_QUEUE:
120+
case MessageFromWebviewType.MODIFY_WORKSPACE_PARAMS_AND_QUEUE:
121121
return commands.executeCommand(
122122
RegisteredCliCommands.EXPERIMENT_VIEW_QUEUE,
123-
{ dvcRoot: this.dvcRoot, id: message.payload }
123+
{ dvcRoot: this.dvcRoot }
124124
)
125-
case MessageFromWebviewType.MODIFY_EXPERIMENT_PARAMS_AND_RUN:
125+
case MessageFromWebviewType.MODIFY_WORKSPACE_PARAMS_AND_RUN:
126126
return commands.executeCommand(
127127
RegisteredCliCommands.EXPERIMENT_VIEW_RUN,
128-
{ dvcRoot: this.dvcRoot, id: message.payload }
128+
{ dvcRoot: this.dvcRoot }
129129
)
130-
case MessageFromWebviewType.MODIFY_EXPERIMENT_PARAMS_RESET_AND_RUN:
130+
case MessageFromWebviewType.MODIFY_WORKSPACE_PARAMS_RESET_AND_RUN:
131131
return commands.executeCommand(
132132
RegisteredCliCommands.EXPERIMENT_VIEW_RESET_AND_RUN,
133-
{ dvcRoot: this.dvcRoot, id: message.payload }
133+
{ dvcRoot: this.dvcRoot }
134134
)
135135

136136
case MessageFromWebviewType.REMOVE_EXPERIMENT:

‎extension/src/experiments/workspace.ts‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,9 @@ export class WorkspaceExperiments extends BaseWorkspaceWebviews<
173173
return this.runCommand(AvailableCommands.EXP_REMOVE, cwd, ...ids)
174174
}
175175

176-
public async modifyExperimentParamsAndRun(
176+
public async modifyWorkspaceParamsAndRun(
177177
commandId: ModifiedExperimentAndRunCommandId,
178-
overrideRoot?: string,
179-
overrideId?: string
178+
overrideRoot?: string
180179
) {
181180
const cwd = await this.getDvcRoot(overrideRoot)
182181
if (!cwd) {
@@ -193,13 +192,10 @@ export class WorkspaceExperiments extends BaseWorkspaceWebviews<
193192
return
194193
}
195194

196-
return await repository.modifyExperimentParamsAndRun(commandId, overrideId)
195+
return await repository.modifyWorkspaceParamsAndRun(commandId)
197196
}
198197

199-
public async modifyExperimentParamsAndQueue(
200-
overrideRoot?: string,
201-
overrideId?: string
202-
) {
198+
public async modifyWorkspaceParamsAndQueue(overrideRoot?: string) {
203199
const cwd = await this.getDvcRoot(overrideRoot)
204200
if (!cwd) {
205201
return
@@ -213,7 +209,7 @@ export class WorkspaceExperiments extends BaseWorkspaceWebviews<
213209
return
214210
}
215211

216-
return await repository.modifyExperimentParamsAndQueue(overrideId)
212+
return await repository.modifyWorkspaceParamsAndQueue()
217213
}
218214

219215
public async getCwdThenRun(commandId: CommandId) {

0 commit comments

Comments
 (0)