Exclude sub-project files from file and editor watchers (#4283)

* exclude sub project files from file and editor watchers

* refactor

* test and expand

Author: mattseddon

extension/src/data/index.ts

@@ -7,7 +7,7 @@ import { InternalCommands } from '../commands/internal'
 import { ExpShowOutput, PlotsOutputOrError } from '../cli/dvc/contract'
 import { uniqueValues } from '../util/array'
 import { DeferredDisposable } from '../class/deferred'
-import { isSameOrChild } from '../fileSystem'
+import { isPathInSubProject, isSameOrChild } from '../fileSystem'
 
 export type ExperimentsOutput = {
   availableNbCommits: { [branch: string]: number }
@@ -29,6 +29,7 @@ export abstract class BaseData<
   protected readonly internalCommands: InternalCommands
   protected collectedFiles: string[] = []
 
+  private readonly relSubProjects: string[]
   private readonly staticFiles: string[]
 
   private readonly updated: EventEmitter<T> = this.dispose.track(
@@ -39,6 +40,7 @@ export abstract class BaseData<
     dvcRoot: string,
     internalCommands: InternalCommands,
     updateProcesses: { name: string; process: () => Promise<unknown> }[],
+    subProjects: string[],
     staticFiles: string[] = []
   ) {
     super()
@@ -49,6 +51,9 @@ export abstract class BaseData<
     )
     this.internalCommands = internalCommands
     this.onDidUpdate = this.updated.event
+    this.relSubProjects = subProjects.map(subProject =>
+      relative(this.dvcRoot, subProject)
+    )
     this.staticFiles = staticFiles
 
     this.watchFiles()
@@ -78,20 +83,23 @@ export abstract class BaseData<
     return createFileSystemWatcher(
       disposable => this.dispose.track(disposable),
       getRelativePattern(this.dvcRoot, '**'),
-      path => {
-        const relPath = relative(this.dvcRoot, path)
-        if (
-          this.getWatchedFiles().some(
-            watchedRelPath =>
-              path.endsWith(watchedRelPath) ||
-              isSameOrChild(relPath, watchedRelPath)
-          )
-        ) {
-          void this.managedUpdate(path)
-        }
-      }
+      path => this.listener(path)
     )
   }
 
+  private listener(path: string) {
+    const relPath = relative(this.dvcRoot, path)
+    if (
+      this.getWatchedFiles().some(
+        watchedRelPath =>
+          path.endsWith(watchedRelPath) ||
+          isSameOrChild(relPath, watchedRelPath)
+      ) &&
+      !isPathInSubProject(relPath, this.relSubProjects)
+    ) {
+      void this.managedUpdate(path)
+    }
+  }
+
   abstract managedUpdate(path?: string): Promise<void>
 }

extension/src/experiments/context.ts

@@ -2,11 +2,13 @@ import { Event, EventEmitter, window } from 'vscode'
 import { Disposable, Disposer } from '@hediet/std/disposable'
 import { ContextKey, setContextValue } from '../vscode/context'
 import { standardizePossiblePath } from '../fileSystem/path'
+import { isPathInProject, isPathInSubProject } from '../fileSystem'
 
 const setContextOnDidChangeParamsFiles = (
   setActiveEditorContext: (paramsFileActive: boolean) => void,
   onDidChangeColumns: Event<void>,
-  getParamsFiles: () => Set<string>
+  getParamsFiles: () => Set<string>,
+  subProjects: string[]
 ): Disposable =>
   onDidChangeColumns(() => {
     const path = standardizePossiblePath(
@@ -16,7 +18,10 @@ const setContextOnDidChangeParamsFiles = (
       return
     }
 
-    if (!getParamsFiles().has(path) && !path.endsWith('dvc.yaml')) {
+    if (
+      (!getParamsFiles().has(path) && !path.endsWith('dvc.yaml')) ||
+      isPathInSubProject(path, subProjects)
+    ) {
       return
     }
     setActiveEditorContext(true)
@@ -25,7 +30,8 @@ const setContextOnDidChangeParamsFiles = (
 const setContextOnDidChangeActiveEditor = (
   setActiveEditorContext: (paramsFileActive: boolean) => void,
   dvcRoot: string,
-  getParamsFiles: () => Set<string>
+  getParamsFiles: () => Set<string>,
+  subProjects: string[]
 ): Disposable =>
   window.onDidChangeActiveTextEditor(event => {
     const path = standardizePossiblePath(event?.document.fileName)
@@ -34,7 +40,7 @@ const setContextOnDidChangeActiveEditor = (
       return
     }
 
-    if (!path.includes(dvcRoot)) {
+    if (!isPathInProject(path, dvcRoot, subProjects)) {
       return
     }
 
@@ -49,7 +55,8 @@ export const setContextForEditorTitleIcons = (
   disposer: (() => void) & Disposer,
   getParamsFiles: () => Set<string>,
   experimentsFileFocused: EventEmitter<string | undefined>,
-  onDidChangeColumns: Event<void>
+  onDidChangeColumns: Event<void>,
+  subProjects: string[]
 ): void => {
   const setActiveEditorContext = (experimentsFileActive: boolean) => {
     void setContextValue(
@@ -64,15 +71,17 @@ export const setContextForEditorTitleIcons = (
     setContextOnDidChangeParamsFiles(
       setActiveEditorContext,
       onDidChangeColumns,
-      getParamsFiles
+      getParamsFiles,
+      subProjects
     )
   )
 
   disposer.track(
     setContextOnDidChangeActiveEditor(
       setActiveEditorContext,
       dvcRoot,
-      getParamsFiles
+      getParamsFiles,
+      subProjects
     )
   )
 }

extension/src/experiments/data/index.ts

@@ -20,12 +20,14 @@ export class ExperimentsData extends BaseData<ExperimentsOutput> {
   constructor(
     dvcRoot: string,
     internalCommands: InternalCommands,
-    experiments: ExperimentsModel
+    experiments: ExperimentsModel,
+    subProjects: string[]
   ) {
     super(
       dvcRoot,
       internalCommands,
       [{ name: 'update', process: () => this.update() }],
+      subProjects,
       ['dvc.lock', 'dvc.yaml', 'params.yaml', DOT_DVC]
     )
 

extension/src/experiments/index.ts

@@ -111,6 +111,7 @@ export class Experiments extends BaseRepository<TableData> {
     selectBranches: (
       branchesSelected: string[]
     ) => Promise<string[] | undefined>,
+    subProjects: string[],
     data?: ExperimentsData
   ) {
     super(dvcRoot, resourceLocator.beaker)
@@ -143,7 +144,13 @@ export class Experiments extends BaseRepository<TableData> {
     )
 
     this.data = this.dispose.track(
-      data || new ExperimentsData(dvcRoot, internalCommands, this.experiments)
+      data ||
+        new ExperimentsData(
+          dvcRoot,
+          internalCommands,
+          this.experiments,
+          subProjects
+        )
     )
 
     this.dispose.track(this.data.onDidUpdate(data => this.setState(data)))
@@ -158,7 +165,7 @@ export class Experiments extends BaseRepository<TableData> {
 
     this.webviewMessages = this.createWebviewMessageHandler()
     this.setupInitialData()
-    this.watchActiveEditor()
+    this.watchActiveEditor(subProjects)
   }
 
   public update() {
@@ -600,13 +607,14 @@ export class Experiments extends BaseRepository<TableData> {
     )
   }
 
-  private watchActiveEditor() {
+  private watchActiveEditor(subProjects: string[]) {
     setContextForEditorTitleIcons(
       this.dvcRoot,
       this.dispose,
       () => this.columns.getParamsFiles(),
       this.experimentsFileFocused,
-      this.onDidChangeColumns
+      this.onDidChangeColumns,
+      subProjects
     )
   }
 

extension/src/experiments/workspace.ts

@@ -273,6 +273,7 @@ export class WorkspaceExperiments extends BaseWorkspaceWebviews<
 
   public createRepository(
     dvcRoot: string,
+    subProjects: string[],
     pipeline: WorkspacePipeline,
     resourceLocator: ResourceLocator
   ) {
@@ -283,7 +284,8 @@ export class WorkspaceExperiments extends BaseWorkspaceWebviews<
         pipeline.getRepository(dvcRoot),
         resourceLocator,
         this.workspaceState,
-        (branchesSelected: string[]) => this.selectBranches(branchesSelected)
+        (branchesSelected: string[]) => this.selectBranches(branchesSelected),
+        subProjects
       )
     )
 

extension/src/extension.ts

@@ -277,17 +277,26 @@ class Extension extends Disposable {
   public async initialize() {
     this.resetMembers()
 
+    const dvcRoots = this.getRoots()
+    const subProjects = this.getSubProjects()
+
     await Promise.all([
-      this.repositories.create(this.getRoots()),
-      this.repositoriesTree.initialize(this.getRoots()),
-      this.pipelines.create(this.getRoots())
+      this.repositories.create(dvcRoots, subProjects),
+      this.repositoriesTree.initialize(dvcRoots),
+      this.pipelines.create(dvcRoots, subProjects)
     ])
     this.experiments.create(
-      this.getRoots(),
+      dvcRoots,
+      subProjects,
       this.pipelines,
       this.resourceLocator
     )
-    this.plots.create(this.getRoots(), this.resourceLocator, this.experiments)
+    this.plots.create(
+      dvcRoots,
+      subProjects,
+      this.resourceLocator,
+      this.experiments
+    )
 
     return Promise.all([
       this.experiments.isReady(),
@@ -308,6 +317,10 @@ class Extension extends Disposable {
   private getRoots() {
     return this.setup.getRoots()
   }
+
+  private getSubProjects() {
+    return this.setup.getSubProjects()
+  }
 }
 
 let extension: undefined | Extension

extension/src/fileSystem/index.test.ts

@@ -16,7 +16,8 @@ import {
   getModifiedTime,
   findOrCreateDvcYamlFile,
   writeJson,
-  writeCsv
+  writeCsv,
+  isPathInProject
 } from '.'
 import { dvcDemoPath } from '../test/util'
 import { DOT_DVC } from '../cli/dvc/constants'
@@ -408,3 +409,52 @@ describe('findOrCreateDvcYamlFile', () => {
     )
   })
 })
+
+describe('isPathInProject', () => {
+  it('should return true if the path is in the project', () => {
+    const path = join(dvcDemoPath, 'dvc.yaml')
+    const dvcRoot = dvcDemoPath
+    const subProjects: string[] = []
+    expect(isPathInProject(path, dvcRoot, subProjects)).toBe(true)
+  })
+
+  it('should return false if the path is not in the project', () => {
+    const path = resolve(dvcDemoPath, '..', 'dvc.yaml')
+    const dvcRoot = dvcDemoPath
+    const subProjects: string[] = []
+    expect(isPathInProject(path, dvcRoot, subProjects)).toBe(false)
+  })
+
+  it('should return false if the path is the project', () => {
+    const path = dvcDemoPath
+    const dvcRoot = dvcDemoPath
+    const subProjects: string[] = []
+    expect(isPathInProject(path, dvcRoot, subProjects)).toBe(false)
+  })
+
+  it('should return false if the path is in the project but also in a sub-project', () => {
+    const path = join(dvcDemoPath, 'nested1', 'dvc.yaml')
+    const dvcRoot = dvcDemoPath
+    const subProjects: string[] = [join(dvcDemoPath, 'nested1')]
+    expect(isPathInProject(path, dvcRoot, subProjects)).toBe(false)
+  })
+
+  it('should return false if the path is in the project but also in one of many sub-projects', () => {
+    const path = join(dvcDemoPath, 'nested2', 'dvc.yaml')
+    const dvcRoot = dvcDemoPath
+    const subProjects: string[] = [
+      join(dvcDemoPath, 'nested1'),
+      join(dvcDemoPath, 'nested2'),
+      join(dvcDemoPath, 'nested3'),
+      join(dvcDemoPath, 'nested4')
+    ]
+    expect(isPathInProject(path, dvcRoot, subProjects)).toBe(false)
+  })
+
+  it('should return true if the path is in the project but not in a sub-project', () => {
+    const path = join(dvcDemoPath, 'nested1', 'dvc.yaml')
+    const dvcRoot = dvcDemoPath
+    const subProjects: string[] = [join(dvcDemoPath, 'nested2')]
+    expect(isPathInProject(path, dvcRoot, subProjects)).toBe(true)
+  })
+})

extension/src/fileSystem/index.ts

@@ -126,6 +126,20 @@ export const isSameOrChild = (root: string, path: string) => {
   return !rel.startsWith('..')
 }
 
+export const isPathInSubProject = (
+  path: string,
+  subProjects: string[]
+): boolean => subProjects.some(dvcRoot => path.startsWith(dvcRoot))
+
+export const isPathInProject = (
+  path: string | undefined,
+  dvcRoot: string,
+  subProjects: string[]
+): boolean =>
+  !!path?.startsWith(dvcRoot) &&
+  path !== dvcRoot &&
+  !isPathInSubProject(path, subProjects)
+
 export type Out =
   | string
   | Record<string, { checkpoint?: boolean; cache?: boolean }>