Update data when an event is fired for a parent directory (events grouped in Codespaces) (#2892)

Author: mattseddon

extension/src/data/index.ts

@@ -1,3 +1,4 @@
+import { relative } from 'path'
 import { EventEmitter, Event } from 'vscode'
 import {
   createFileSystemWatcher,
@@ -8,6 +9,7 @@ import { InternalCommands } from '../commands/internal'
 import { ExperimentsOutput, PlotsOutputOrError } from '../cli/dvc/contract'
 import { uniqueValues } from '../util/array'
 import { DeferredDisposable } from '../class/deferred'
+import { isSameOrChild } from '../fileSystem'
 
 export abstract class BaseData<
   T extends { data: PlotsOutputOrError; revs: string[] } | ExperimentsOutput
@@ -68,9 +70,12 @@ export abstract class BaseData<
   private watchFiles() {
     return this.dispose.track(
       createFileSystemWatcher(getRelativePattern(this.dvcRoot, '**'), path => {
+        const relPath = relative(this.dvcRoot, path)
         if (
-          this.getWatchedFiles().some(watchedRelPath =>
-            path.endsWith(watchedRelPath)
+          this.getWatchedFiles().some(
+            watchedRelPath =>
+              path.endsWith(watchedRelPath) ||
+              isSameOrChild(relPath, watchedRelPath)
           )
         ) {
           this.managedUpdate(path)

extension/src/fileSystem/index.test.ts

@@ -1,4 +1,4 @@
-import { join, resolve } from 'path'
+import { join, relative, resolve } from 'path'
 import { ensureDirSync, remove } from 'fs-extra'
 import * as FileSystem from '.'
 import { dvcDemoPath } from '../test/util'
@@ -108,6 +108,21 @@ describe('isSameOrChild', () => {
       false
     )
   })
+
+  it('should work for relative paths', () => {
+    const relPath = relative(
+      '/workspaces/magnetic-tiles-defect',
+      '/workspaces/magnetic-tiles-defect/training/plots'
+    )
+
+    expect(
+      isSameOrChild(relPath, 'training/plots/metrics/train/loss.tsv')
+    ).toBe(true)
+
+    expect(
+      isSameOrChild(relPath, './training/plots/metrics/train/loss.tsv')
+    ).toBe(true)
+  })
 })
 
 describe('getModifiedTime', () => {

extension/src/test/suite/plots/data/index.test.ts

@@ -18,6 +18,8 @@ import {
   InternalCommands
 } from '../../../../commands/internal'
 import { fireWatcher } from '../../../../fileSystem/watcher'
+import { getProcessPlatform } from '../../../../env'
+import { removeDir } from '../../../../fileSystem'
 
 suite('Plots Data Test Suite', () => {
   const disposable = Disposable.fn()
@@ -140,7 +142,8 @@ suite('Plots Data Test Suite', () => {
 
     it('should collect files and watch them for updates', async () => {
       const mockNow = getMockNow()
-      const watchedFile = join('training', 'metrics.json')
+      const parentDirectory = 'training'
+      const watchedFile = join(parentDirectory, 'metrics.json')
 
       const mockExecuteCommand = (command: CommandId) => {
         if (command === AvailableCommands.IS_EXPERIMENT_RUNNING) {
@@ -211,13 +214,38 @@ suite('Plots Data Test Suite', () => {
 
       const managedUpdateSpy = spy(data, 'managedUpdate')
       const dataUpdatedEvent = new Promise(resolve =>
-        data.onDidUpdate(() => resolve(undefined))
+        disposable.track(data.onDidUpdate(() => resolve(undefined)))
       )
 
       await fireWatcher(join(dvcDemoPath, watchedFile))
       await dataUpdatedEvent
 
-      expect(managedUpdateSpy).to.be.called
+      expect(
+        managedUpdateSpy,
+        'should update data when an event is fired for a watched file'
+      ).to.be.called
+      managedUpdateSpy.resetHistory()
+
+      bypassProcessManagerDebounce(mockNow, 2)
+
+      const secondDataUpdatedEvent = new Promise(resolve =>
+        disposable.track(data.onDidUpdate(() => resolve(undefined)))
+      )
+
+      const absParentDirectory = join(dvcDemoPath, parentDirectory)
+
+      if (getProcessPlatform() === 'win32') {
+        removeDir(absParentDirectory)
+      } else {
+        await fireWatcher(absParentDirectory)
+      }
+
+      await secondDataUpdatedEvent
+
+      expect(
+        managedUpdateSpy,
+        'should update data when an event is fired for a parent directory'
+      ).to.be.called
     })
   })
 })