Bump min DVC version to 2.55.0 (live metrics for experiments running outside the workspace)

extension/src/cli/dvc/contract.ts

@@ -55,7 +55,7 @@ export enum ExperimentStatus {
   SUCCESS = 'Success'
 }
 
-export const EXPERIMENT_WORKSPACE_ID = 'workspace'
+export const EXPERIMENT_WORKSPACE_ID = 'workspace' as const
 
 export interface BaseExperimentFields {
   name?: string
@@ -69,13 +69,14 @@ export interface BaseExperimentFields {
 type Dep = { hash: null | string; size: null | number; nfiles: null | number }
 type Out = Dep & { use_cache: boolean; is_data_source: boolean }
 
+type Outs = RelPathObject<Out>
 export type Deps = RelPathObject<Dep>
 
 export interface ExperimentFields extends BaseExperimentFields {
-  params?: ValueTreeRoot
-  metrics?: ValueTreeRoot
-  deps?: Deps
-  outs?: RelPathObject<Out>
+  params?: ValueTreeRoot | null
+  metrics?: ValueTreeRoot | null
+  deps?: Deps | null
+  outs?: RelPathObject<Out> | null
   error?: ErrorContents
 }
 
@@ -96,6 +97,73 @@ export interface ExperimentsOutput {
   }
 }
 
+type ValueTreeOrError_ = { data: ValueTree } | DvcError
+type MetricsOrParams = RelPathObject<ValueTreeOrError_>
+
+type ExpStateData = {
+  rev: string
+  timestamp: string | null
+  params: MetricsOrParams | null
+  metrics: MetricsOrParams | null
+  deps: Deps | null
+  outs: Outs | null
+  meta: { has_checkpoints: boolean }
+}
+
+export const ExperimentExecutor = {
+  DVC_TASK: 'dvc-task',
+  [EXPERIMENT_WORKSPACE_ID]: EXPERIMENT_WORKSPACE_ID
+} as const
+
+export type Executor =
+  | {
+      state: ExperimentStatus.QUEUED
+      name: typeof ExperimentExecutor.DVC_TASK
+      local: {
+        root: null
+        log: null
+        pid: null
+        returncode: null
+        task_id: string
+      }
+    }
+  | {
+      state:
+        | ExperimentStatus.RUNNING
+        | ExperimentStatus.FAILED
+        | ExperimentStatus.SUCCESS
+      name: (typeof ExperimentExecutor)[keyof typeof ExperimentExecutor] | null
+      local: {
+        root: string
+        log: string
+        pid: number
+        task_id?: string
+        returncode: null | number
+      } | null
+    }
+  | null
+
+export type ExpWithError = {
+  rev: string
+  name?: string
+} & DvcError
+
+export type ExpState =
+  | {
+      rev: string
+      name?: string
+      data: ExpStateData
+    }
+  | ExpWithError
+
+export type ExpRange = {
+  revs: ExpState[]
+  name?: string
+  executor: Executor
+}
+
+export type ExpShowOutput = (ExpState & { experiments?: ExpRange[] | null })[]
+
 export interface PlotsData {
   [path: string]: Plot[]
 }

extension/src/experiments/columns/extract.ts

@@ -28,7 +28,7 @@ const extractFileMetricsOrParams = (
 }
 
 const extractMetricsOrParams = (
-  valueTreeRoot?: ValueTreeRoot
+  valueTreeRoot?: ValueTreeRoot | null
 ): { columns: MetricOrParamColumns; errors: string[] } | undefined => {
   if (!valueTreeRoot) {
     return
@@ -46,7 +46,7 @@ const extractMetricsOrParams = (
 }
 
 const extractDeps = (
-  columns?: Deps,
+  columns?: Deps | null,
   commit?: Experiment
 ): DepColumns | undefined => {
   if (!columns) {

extension/src/experiments/model/collect.ts

@@ -20,7 +20,13 @@ import {
   ExperimentsCommitOutput,
   ExperimentsOutput,
   EXPERIMENT_WORKSPACE_ID,
-  ExperimentStatus
+  ExperimentStatus,
+  ExpShowOutput,
+  ExpState,
+  ExpWithError,
+  ExperimentExecutor,
+  ExpRange,
+  Executor
 } from '../../cli/dvc/contract'
 import { addToMapArray } from '../../util/map'
 import { RegisteredCommands } from '../../commands/external'
@@ -274,7 +280,7 @@ const formatCommitMessage = (commit: string) => {
   return `${lines[0]}${lines.length > 1 ? ' ...' : ''}`
 }
 
-const getCommitMessages = (
+const getCommitData = (
   commitsOutput: string
 ): { [sha: string]: CommitData } => {
   if (!commitsOutput) {
@@ -291,7 +297,7 @@ const addDataToCommits = (
   commits: Experiment[],
   commitsOutput: string
 ): Experiment[] => {
-  const commitMessages = getCommitMessages(commitsOutput)
+  const commitMessages = getCommitData(commitsOutput)
   return commits.map(commit => {
     const { sha } = commit
     if (sha && commitMessages[sha]) {
@@ -329,6 +335,204 @@ export const collectExperiments = (
   return acc
 }
 
+const hasError = (expState: ExpState): expState is ExpWithError =>
+  !!(expState as { error?: unknown }).error
+
+const transformExpState = (experiment: Experiment, expState: ExpState) => {
+  const { rev } = expState
+
+  if (rev.length === 40) {
+    experiment.sha = rev
+  }
+
+  if (hasError(expState)) {
+    const error = expState.error.msg
+    experiment.error = error
+    return experiment
+  }
+
+  const { data } = expState
+  if (data) {
+    transformColumns(experiment, data)
+  }
+
+  return experiment
+}
+
+const addCommitData = (
+  baseline: Experiment,
+  commitData: { [sha: string]: CommitData } = {}
+): void => {
+  const { sha } = baseline
+  if (!sha) {
+    return
+  }
+
+  const commit = commitData[sha]
+
+  if (!commit) {
+    return
+  }
+  baseline.displayName = formatCommitMessage(commit.message)
+  baseline.commit = commit
+}
+
+const collectExpState = (
+  acc: ExperimentsAccumulator,
+  expState: ExpState,
+  commitData: { [sha: string]: CommitData }
+): string | undefined => {
+  const { rev, name } = expState
+  const id = name || rev
+  const label =
+    rev === EXPERIMENT_WORKSPACE_ID
+      ? EXPERIMENT_WORKSPACE_ID
+      : name || shortenForLabel(rev)
+
+  const experiment: Experiment = { id, label }
+
+  const baseline = transformExpState(experiment, expState)
+
+  if (rev === EXPERIMENT_WORKSPACE_ID && !name) {
+    acc.workspace = baseline
+    return
+  }
+
+  addCommitData(baseline, commitData)
+
+  acc.commits.push(baseline)
+  return id
+}
+
+const getExecutor = (experiment: Experiment): string => {
+  if ([experiment.executor, experiment.id].includes(EXPERIMENT_WORKSPACE_ID)) {
+    return EXPERIMENT_WORKSPACE_ID
+  }
+  return ExperimentExecutor.DVC_TASK
+}
+
+const collectExecutorInfo = (
+  acc: ExperimentsAccumulator,
+  experiment: Experiment,
+  executor: Executor
+): void => {
+  if (!executor) {
+    return
+  }
+
+  const { name, state } = executor
+
+  if (name && state === ExperimentStatus.RUNNING) {
+    experiment.executor = name
+  }
+  if (state && state !== ExperimentStatus.SUCCESS) {
+    experiment.status = state
+  }
+
+  if (experiment.status === ExperimentStatus.RUNNING) {
+    acc.runningExperiments.push({
+      executor: getExecutor(experiment),
+      id: experiment.id
+    })
+  }
+}
+
+const collectExpRange = (
+  acc: ExperimentsAccumulator,
+  baselineId: string,
+  expRange: ExpRange
+): void => {
+  const { revs, executor } = expRange
+  if (!revs?.length) {
+    return
+  }
+  const expState = revs[0]
+
+  const { name, rev } = expState
+
+  const experiment = transformExpState(
+    {
+      id: name || rev,
+      label:
+        rev === EXPERIMENT_WORKSPACE_ID
+          ? EXPERIMENT_WORKSPACE_ID
+          : shortenForLabel(rev)
+    },
+    expState
+  )
+
+  if (name) {
+    const displayName = `[${name}]`
+    experiment.displayName = displayName
+    experiment.logicalGroupName = displayName
+  }
+
+  collectExecutorInfo(acc, experiment, executor)
+
+  addToMapArray(acc.experimentsByCommit, baselineId, experiment)
+}
+
+const setWorkspaceAsRunning = (
+  acc: ExperimentsAccumulator,
+  dvcLiveOnly: boolean
+) => {
+  if (dvcLiveOnly) {
+    acc.workspace.executor = EXPERIMENT_WORKSPACE_ID
+    acc.workspace.status = ExperimentStatus.RUNNING
+    acc.runningExperiments.unshift({
+      executor: EXPERIMENT_WORKSPACE_ID,
+      id: EXPERIMENT_WORKSPACE_ID
+    })
+  }
+
+  if (
+    acc.runningExperiments.some(
+      ({ executor, id }) =>
+        executor === ExperimentExecutor[EXPERIMENT_WORKSPACE_ID] &&
+        id !== EXPERIMENT_WORKSPACE_ID
+    )
+  ) {
+    acc.workspace.executor = EXPERIMENT_WORKSPACE_ID
+    acc.workspace.status = ExperimentStatus.RUNNING
+    acc.runningExperiments.unshift({
+      executor: EXPERIMENT_WORKSPACE_ID,
+      id: EXPERIMENT_WORKSPACE_ID
+    })
+  }
+}
+
+export const collectExperiments_ = (
+  output: ExpShowOutput,
+  dvcLiveOnly: boolean,
+  commitsOutput: string
+): ExperimentsAccumulator => {
+  const acc: ExperimentsAccumulator = {
+    commits: [],
+    experimentsByCommit: new Map(),
+    runningExperiments: [],
+    workspace: { id: EXPERIMENT_WORKSPACE_ID, label: EXPERIMENT_WORKSPACE_ID }
+  }
+
+  const commitData = getCommitData(commitsOutput)
+
+  for (const expState of output) {
+    const baselineId = collectExpState(acc, expState, commitData)
+    const { experiments } = expState
+
+    if (!(baselineId && experiments?.length)) {
+      continue
+    }
+
+    for (const expRange of experiments) {
+      collectExpRange(acc, baselineId, expRange)
+    }
+  }
+
+  setWorkspaceAsRunning(acc, dvcLiveOnly)
+
+  return acc
+}
+
 type DeletableExperimentAccumulator = { [dvcRoot: string]: Set<string> }
 
 const initializeAccumulatorRoot = (

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

@@ -3,7 +3,9 @@ import { join } from 'path'
 import { commands } from 'vscode'
 import { ExperimentsModel } from '.'
 import outputFixture from '../../test/fixtures/expShow/base/output'
+import outputFixture_ from '../../test/fixtures/expShow/base/output_'
 import rowsFixture from '../../test/fixtures/expShow/base/rows'
+import rowsFixture_ from '../../test/fixtures/expShow/base/rows_'
 import deeplyNestedRowsFixture from '../../test/fixtures/expShow/deeplyNested/rows'
 import deeplyNestedOutputFixture from '../../test/fixtures/expShow/deeplyNested/output'
 import uncommittedDepsFixture from '../../test/fixtures/expShow/uncommittedDeps/output'
@@ -61,6 +63,12 @@ describe('ExperimentsModel', () => {
     expect(model.getRowData()).toStrictEqual(rowsFixture)
   })
 
+  it('should return the expected rows when given the output fixture_', () => {
+    const model = new ExperimentsModel('', buildMockMemento())
+    model.transformAndSet_(outputFixture_, false, '')
+    expect(model.getRowData()).toStrictEqual(rowsFixture_)
+  })
+
   it('should return the expected rows when given the survival fixture', () => {
     const model = new ExperimentsModel('', buildMockMemento())
     model.transformAndSet(survivalOutputFixture, false, '')