Use DVCLive signal file to indicate that an experiment is running in the workspace (#2923)

* create signal file prototype

* rework use of signal file based on current implementation

* do not unnecessarily read file system in integration tests

Author: mattseddon

extension/package.json

@@ -1614,6 +1614,7 @@
     "lint-staged": "13.1.0",
     "mocha": "10.0.0",
     "mock-require": "3.0.3",
+    "process-exists": "4.1.0",
     "shx": "0.3.4",
     "sinon": "15.0.0",
     "sinon-chai": "3.7.0",

extension/src/cli/dvc/constants.ts

@@ -7,6 +7,14 @@ export const MAX_CLI_VERSION = '3'
 export const UNEXPECTED_ERROR_CODE = 255
 
 export const TEMP_PLOTS_DIR = join('.dvc', 'tmp', 'plots')
+export const DVCLIVE_ONLY_RUNNING_SIGNAL_FILE = join(
+  '.dvc',
+  'tmp',
+  'exps',
+  'run',
+  'DVCLIVE_ONLY'
+)
+
 export const NUM_OF_COMMITS_TO_SHOW = '3'
 
 export enum Command {

extension/src/experiments/index.ts

@@ -1,3 +1,4 @@
+import { join } from 'path'
 import {
   ConfigurationChangeEvent,
   Event,
@@ -40,6 +41,8 @@ import { createTypedAccumulator } from '../util/object'
 import { pickPaths } from '../path/selection/quickPick'
 import { Toast } from '../vscode/toast'
 import { ConfigKey } from '../vscode/config'
+import { checkSignalFile } from '../fileSystem'
+import { DVCLIVE_ONLY_RUNNING_SIGNAL_FILE } from '../cli/dvc/constants'
 
 export const ExperimentsScale = {
   ...omit(ColumnType, 'TIMESTAMP'),
@@ -165,9 +168,12 @@ export class Experiments extends BaseRepository<TableData> {
   }
 
   public async setState(data: ExperimentsOutput) {
+    const dvcLiveOnly = await checkSignalFile(
+      join(this.dvcRoot, DVCLIVE_ONLY_RUNNING_SIGNAL_FILE)
+    )
     await Promise.all([
       this.columns.transformAndSet(data),
-      this.experiments.transformAndSet(data)
+      this.experiments.transformAndSet(data, dvcLiveOnly)
     ])
 
     return this.notifyChanged(data)

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

@@ -8,11 +8,14 @@ import {
 
 describe('collectExperiments', () => {
   it('should return an empty array if no branches are present', () => {
-    const { branches } = collectExperiments({
-      [EXPERIMENT_WORKSPACE_ID]: {
-        baseline: {}
-      }
-    })
+    const { branches } = collectExperiments(
+      {
+        [EXPERIMENT_WORKSPACE_ID]: {
+          baseline: {}
+        }
+      },
+      false
+    )
     expect(branches).toStrictEqual([])
   })
 
@@ -34,8 +37,10 @@ describe('collectExperiments', () => {
       baseline: { data: { name: 'branchB' } }
     }
   }
-  const { branches, experimentsByBranch, workspace } =
-    collectExperiments(repoWithTwoBranches)
+  const { branches, experimentsByBranch, workspace } = collectExperiments(
+    repoWithTwoBranches,
+    false
+  )
 
   it('should define a workspace', () => {
     expect(workspace).toBeDefined()
@@ -77,7 +82,7 @@ describe('collectExperiments', () => {
       }
     }
   }
-  const acc = collectExperiments(repoWithNestedCheckpoints)
+  const acc = collectExperiments(repoWithNestedCheckpoints, false)
 
   it('should only list the tip as a top-level experiment', () => {
     const { experimentsByBranch } = acc
@@ -98,7 +103,7 @@ describe('collectExperiments', () => {
   })
 
   it('should handle the continuation of a modified checkpoint', () => {
-    const { checkpointsByTip } = collectExperiments(modifiedFixture)
+    const { checkpointsByTip } = collectExperiments(modifiedFixture, false)
 
     const modifiedCheckpointTip = checkpointsByTip
       .get('exp-01b3a')
@@ -154,7 +159,7 @@ describe('collectExperiments', () => {
         }
       }
     }
-    const acc = collectExperiments(repoWithNestedCheckpoints)
+    const acc = collectExperiments(repoWithNestedCheckpoints, false)
 
     const { experimentsByBranch, checkpointsByTip } = acc
     const [experiment] = experimentsByBranch.get('branchA') || []

extension/src/experiments/model/collect.ts

@@ -14,7 +14,8 @@ import {
   ExperimentFields,
   ExperimentsBranchOutput,
   ExperimentsOutput,
-  EXPERIMENT_WORKSPACE_ID
+  EXPERIMENT_WORKSPACE_ID,
+  ExperimentStatus
 } from '../../cli/dvc/contract'
 import { addToMapArray } from '../../util/map'
 import { uniqueValues } from '../../util/array'
@@ -311,17 +312,22 @@ const collectFromBranchesObject = (
 }
 
 export const collectExperiments = (
-  data: ExperimentsOutput
+  data: ExperimentsOutput,
+  dvcLiveOnly: boolean
 ): ExperimentsAccumulator => {
   const { workspace, ...branchesObject } = data
-  const workspaceId = EXPERIMENT_WORKSPACE_ID
 
   const workspaceBaseline = transformExperimentData(
-    workspaceId,
+    EXPERIMENT_WORKSPACE_ID,
     workspace.baseline,
-    workspaceId
+    EXPERIMENT_WORKSPACE_ID
   )
 
+  if (dvcLiveOnly) {
+    workspaceBaseline.executor = EXPERIMENT_WORKSPACE_ID
+    workspaceBaseline.status = ExperimentStatus.RUNNING
+  }
+
   const acc = new ExperimentsAccumulator(workspaceBaseline)
 
   collectFromBranchesObject(acc, branchesObject)