Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add multi-select versions of exp push #3792

Merged
merged 1 commit into from
May 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -511,6 +511,12 @@
"category": "DVC",
"icon": "$(repo-push)"
},
{
"title": "Push",
"command": "dvc.views.experimentsTree.pushExperiment",
"category": "DVC",
"icon": "$(repo-push)"
},
{
"title": "Show Logs",
"command": "dvc.views.experiments.showLogs",
Expand Down Expand Up @@ -863,6 +869,14 @@
"command": "dvc.views.experiments.branchExperiment",
"when": "false"
},
{
"command": "dvc.views.experiments.pushExperiment",
"when": "false"
},
{
"command": "dvc.views.experimentsTree.pushExperiment",
"when": "false"
},
{
"command": "dvc.views.experiments.queueExperiment",
"when": "false"
Expand All @@ -887,10 +901,6 @@
"command": "dvc.views.experiments.resetAndRunCheckpointExperiment",
"when": "false"
},
{
"command": "dvc.views.experiments.pushExperiment",
"when": "false"
},
{
"command": "dvc.views.experiments.showLogs",
"when": "false"
Expand Down Expand Up @@ -1152,7 +1162,7 @@
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem =~ /^(experiment|queued)$/ && !dvc.experiment.running"
},
{
"command": "dvc.views.experiments.pushExperiment",
"command": "dvc.views.experimentsTree.pushExperiment",
"group": "1_share@0",
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem == experiment && !dvc.experiment.running"
},
Expand Down
6 changes: 3 additions & 3 deletions extension/src/experiments/commands/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ const convertUrlTextToLink = (stdout: string) => {

export const getPushExperimentCommand =
(internalCommands: InternalCommands, setup: Setup) =>
({ dvcRoot, id }: { dvcRoot: string; id: string }) => {
({ dvcRoot, ids }: { dvcRoot: string; ids: string[] }) => {
const studioAccessToken = setup.getStudioAccessToken()
if (
!(
Expand All @@ -58,14 +58,14 @@ export const getPushExperimentCommand =
return Toast.showProgress('exp push', async progress => {
progress.report({ increment: 0 })

progress.report({ increment: 25, message: `Pushing ${id}...` })
progress.report({ increment: 25, message: `Pushing ${ids.join(' ')}...` })

const remainingProgress = 75

const stdout = await internalCommands.executeCommand(
AvailableCommands.EXP_PUSH,
dvcRoot,
id
...ids
)

progress.report({
Expand Down
23 changes: 11 additions & 12 deletions extension/src/experiments/model/collect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -328,10 +328,10 @@ export const collectExperiments = (
return acc
}

type DeletableExperimentAccumulator = { [dvcRoot: string]: Set<string> }
type ExperimentTypesAccumulator = { [dvcRoot: string]: Set<string> }

const initializeAccumulatorRoot = (
acc: DeletableExperimentAccumulator,
acc: ExperimentTypesAccumulator,
dvcRoot: string
) => {
if (!acc[dvcRoot]) {
Expand All @@ -340,12 +340,12 @@ const initializeAccumulatorRoot = (
}

const collectExperimentItem = (
acc: DeletableExperimentAccumulator,
deletable: Set<string>,
acc: ExperimentTypesAccumulator,
types: Set<string>,
experimentItem: ExperimentItem
) => {
const { dvcRoot, type, id, label } = experimentItem
if (!deletable.has(type)) {
if (!types.has(type)) {
return
}
initializeAccumulatorRoot(acc, dvcRoot)
Expand All @@ -357,18 +357,17 @@ const collectExperimentItem = (
acc[dvcRoot].add(id)
}

export const collectDeletable = (
experimentItems: (string | ExperimentItem)[]
): DeletableExperimentAccumulator => {
const deletable = new Set([ExperimentType.EXPERIMENT, ExperimentType.QUEUED])

const acc: DeletableExperimentAccumulator = {}
export const collectExperimentType = (
experimentItems: (string | ExperimentItem)[],
types: Set<ExperimentType>
): ExperimentTypesAccumulator => {
const acc: ExperimentTypesAccumulator = {}
for (const experimentItem of experimentItems) {
if (typeof experimentItem === 'string') {
continue
}

collectExperimentItem(acc, deletable, experimentItem)
collectExperimentItem(acc, types, experimentItem)
}

return acc
Expand Down
56 changes: 38 additions & 18 deletions extension/src/experiments/model/tree.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
Uri
} from 'vscode'
import { ExperimentType } from '.'
import { collectDeletable, ExperimentItem } from './collect'
import { collectExperimentType, ExperimentItem } from './collect'
import { MAX_SELECTED_EXPERIMENTS } from './status'
import { getDataFromColumnPaths } from './util'
import { WorkspaceExperiments } from '../workspace'
Expand Down Expand Up @@ -69,7 +69,7 @@ export class ExperimentsTree
this.experiments = experiments
this.resourceLocator = resourceLocator

this.registerWorkaroundCommand()
this.registerWorkaroundCommands()

this.updateDescriptionOnChange()
}
Expand Down Expand Up @@ -123,24 +123,44 @@ export class ExperimentsTree
)
}

private registerWorkaroundCommand() {
private registerWorkaroundCommands() {
const callCommandWithSelected = async (
command:
| RegisteredCliCommands.EXPERIMENT_VIEW_REMOVE
| RegisteredCliCommands.EXPERIMENT_VIEW_PUSH,
experimentItem: ExperimentItem | string,
types: ExperimentType[]
) => {
const selected = [
...this.getSelectedExperimentItems(),
experimentItem
] as (string | ExperimentItem)[]

const acc = collectExperimentType(selected, new Set(types))

for (const [dvcRoot, ids] of Object.entries(acc)) {
await commands.executeCommand(command, { dvcRoot, ids: [...ids] })
}
}

commands.registerCommand(
'dvc.views.experimentsTree.removeExperiment',
async experimentItem => {
const selected = [
...this.getSelectedExperimentItems(),
experimentItem
] as (string | ExperimentItem)[]

const deletable = collectDeletable(selected)

for (const [dvcRoot, ids] of Object.entries(deletable)) {
await commands.executeCommand(
RegisteredCliCommands.EXPERIMENT_VIEW_REMOVE,
{ dvcRoot, ids }
)
}
}
(experimentItem: ExperimentItem) =>
callCommandWithSelected(
RegisteredCliCommands.EXPERIMENT_VIEW_REMOVE,
experimentItem,
[ExperimentType.EXPERIMENT, ExperimentType.QUEUED]
)
)

commands.registerCommand(
'dvc.views.experimentsTree.pushExperiment',
(experimentItem: ExperimentItem) =>
callCommandWithSelected(
RegisteredCliCommands.EXPERIMENT_VIEW_PUSH,
experimentItem,
[ExperimentType.EXPERIMENT]
)
)
}

Expand Down
2 changes: 1 addition & 1 deletion extension/src/experiments/webview/messages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ export class WebviewMessages {
case MessageFromWebviewType.PUSH_EXPERIMENT:
return commands.executeCommand(
RegisteredCliCommands.EXPERIMENT_VIEW_PUSH,
{ dvcRoot: this.dvcRoot, id: message.payload }
{ dvcRoot: this.dvcRoot, ids: message.payload }
)

case MessageFromWebviewType.SHOW_EXPERIMENT_LOGS:
Expand Down
4 changes: 2 additions & 2 deletions extension/src/test/suite/experiments/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,7 @@ suite('Experiments Test Suite', () => {
)

mockMessageReceived.fire({
payload: mockExpId,
payload: [mockExpId],
type: MessageFromWebviewType.PUSH_EXPERIMENT
})

Expand Down Expand Up @@ -712,7 +712,7 @@ suite('Experiments Test Suite', () => {
)

mockMessageReceived.fire({
payload: mockExpId,
payload: [mockExpId],
type: MessageFromWebviewType.PUSH_EXPERIMENT
})

Expand Down
94 changes: 94 additions & 0 deletions extension/src/test/suite/experiments/model/tree.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { ExperimentType } from '../../../../experiments/model'
import { UNSELECTED } from '../../../../experiments/model/status'
import {
bypassProcessManagerDebounce,
bypassProgressCloseDelay,
getFirstArgOfLastCall,
getMockNow,
getTimeSafeDisposer,
Expand Down Expand Up @@ -345,6 +346,99 @@ suite('Experiments Tree Test Suite', () => {
)
})

it('should be able to push an experiment with dvc.views.experimentsTree.pushExperiment', async () => {
bypassProgressCloseDelay()
const mockExperimentId = 'exp-to-push'
const mockExperiment = {
dvcRoot: dvcDemoPath,
id: mockExperimentId,
type: ExperimentType.EXPERIMENT
}

const mockExpPush = stub(DvcExecutor.prototype, 'expPush').resolves('')

stubPrivatePrototypeMethod(
ExperimentsTree,
'getSelectedExperimentItems'
).returns([mockExperiment])

await commands.executeCommand(
'dvc.views.experimentsTree.pushExperiment',
mockExperiment
)

expect(mockExpPush).to.be.calledWithExactly(dvcDemoPath, mockExperimentId)
})

it('should be able to push the provided experiment with dvc.views.experimentsTree.pushExperiment (if no experiments are selected)', async () => {
bypassProgressCloseDelay()
const mockExperiment = 'exp-to-push'

const mockExpPush = stub(DvcExecutor.prototype, 'expPush').resolves('')

stubPrivatePrototypeMethod(
ExperimentsTree,
'getSelectedExperimentItems'
).returns([])

await commands.executeCommand(
'dvc.views.experimentsTree.pushExperiment',
{
dvcRoot: dvcDemoPath,
id: mockExperiment,
type: ExperimentType.EXPERIMENT
}
)

expect(mockExpPush).to.be.calledWithExactly(dvcDemoPath, mockExperiment)
})

it('should be able to push multiple experiments with dvc.views.experimentsTree.pushExperiment', async () => {
bypassProgressCloseDelay()
const mockFirstExperimentId = 'first-exp-pushed'
const mockSecondExperimentId = 'second-exp-pushed'
const mockQueuedExperimentLabel = 'queued-excluded'

const mockExpPush = stub(DvcExecutor.prototype, 'expPush').resolves('')

stubPrivatePrototypeMethod(
ExperimentsTree,
'getSelectedExperimentItems'
).returns([
dvcDemoPath,
{
dvcRoot: dvcDemoPath,
label: mockQueuedExperimentLabel,
type: ExperimentType.QUEUED
},
{
dvcRoot: dvcDemoPath,
id: mockFirstExperimentId,
type: ExperimentType.EXPERIMENT
},
{
dvcRoot: dvcDemoPath,
id: 'workspace-excluded',
type: ExperimentType.WORKSPACE
}
])

await commands.executeCommand(
'dvc.views.experimentsTree.pushExperiment',
{
dvcRoot: dvcDemoPath,
id: mockSecondExperimentId,
type: ExperimentType.EXPERIMENT
}
)

expect(mockExpPush).to.be.calledWithExactly(
dvcDemoPath,
mockFirstExperimentId,
mockSecondExperimentId
)
})

it('should be able to apply an experiment to the workspace with dvc.views.experiments.applyExperiment', async () => {
const { experiments } = buildExperiments(disposable)

Expand Down
2 changes: 1 addition & 1 deletion extension/src/webview/contract.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ export type MessageFromWebview =
| { type: MessageFromWebviewType.SHOW_EXPERIMENT_LOGS; payload: string }
| {
type: MessageFromWebviewType.PUSH_EXPERIMENT
payload: string
payload: string[]
}
| {
type: MessageFromWebviewType.REMOVE_COLUMN_SORT
Expand Down
Loading