Enable sub-project selection in monorepos (#3030)

* auto-locate sub-projects inside of monorepos

* add config option to set focused projects inside of the workspace

* rewrite config description

* ensure focused projects are set on startup

* standardize test paths

* rename private method inside of setup

* update user facing text

Author: mattseddon

README.md

@@ -151,6 +151,7 @@ These are the VS Code [settings] available for the Extension:
 | `dvc.dvcPath`                          | Path or shell command to the DVC binary. Required unless Microsoft's [Python extension] is installed and the `dvc` package found in its environment.     |
 | `dvc.pythonPath`                       | Path to the desired Python interpreter to use with DVC. Should only be utilized when using a virtual environment without Microsoft's [Python extension]. |
 | `dvc.experimentsTableHeadMaxHeight`    | Maximum height of experiment table head rows.                                                                                                            |
+| `dvc.focusedProjects`                  | A subset of paths to the workspace's available DVC projects. Using this option will override project auto-discovery.                                     |
 | `dvc.doNotShowWalkthroughAfterInstall` | Do not prompt to show the Get Started page after installing. Useful for pre-configured development environments                                          |
 | `dvc.doNotRecommendRedHatExtension`    | Do not prompt to install the Red Hat YAML extension, which helps with DVC YAML schema validation (`dvc.yaml` and `.dvc` files).                          |
 | `dvc.doNotShowCliUnavailable`          | Do not warn when the workspace contains a DVC project but the DVC binary is unavailable.                                                                 |

extension/package.json

@@ -529,6 +529,16 @@
     "configuration": {
       "title": "DVC",
       "properties": {
+        "dvc.focusedProjects": {
+          "title": "%config.focusedProjects.title%",
+          "description": "%config.focusedProjects.description%",
+          "type": [
+            "string",
+            "array",
+            "null"
+          ],
+          "default": null
+        },
         "dvc.doNotRecommendRedHatExtension": {
           "title": "%config.doNotRecommendRedHatExtension.title%",
           "description": "%config.doNotRecommendRedHatExtension.description%",

extension/package.nls.json

@@ -75,6 +75,8 @@
   "command.views.experimentsTree.selectExperiments": "Select Experiments to Display in Plots",
   "command.views.plotsPathsTree.selectPlots": "Select Plots to Display",
   "command.views.plotsPathsTree.refreshPlots": "Refresh Plots for Selected Experiments",
+  "config.focusedProjects.description": "A subset of paths to the workspace's available DVC projects. Using this option will override project auto-discovery. Only absolute paths inside of the workspace will be included. All other DVC projects in the workspace will be ignored.",
+  "config.focusedProjects.title": "DVC project path(s) to include.",
   "config.doNotRecommendRedHatExtension.description": "Do not prompt to install the Red Hat YAML extension, which helps with DVC YAML schema validation.",
   "config.doNotRecommendRedHatExtension.title": "Do not recommend the YAML extension.",
   "config.doNotShowCliUnavailable.description": "Do not warn when the workspace contains a DVC project but the DVC binary is unavailable.",

extension/src/config.ts

@@ -1,33 +1,42 @@
-import { Disposable } from '@hediet/std/disposable'
 import { EventEmitter, Event, workspace } from 'vscode'
+import { Disposable } from '@hediet/std/disposable'
+import isEqual from 'lodash.isequal'
+import isEmpty from 'lodash.isempty'
 import {
   getOnDidChangePythonExecutionDetails,
   getPythonBinPath
 } from './extensions/python'
 import { ConfigKey, getConfigValue } from './vscode/config'
 import { DeferredDisposable } from './class/deferred'
 import { getOnDidChangeExtensions } from './vscode/extensions'
+import { standardizePath } from './fileSystem/path'
+import { getWorkspaceFolders } from './vscode/workspaceFolders'
+import { isSameOrChild } from './fileSystem'
 
 export class Config extends DeferredDisposable {
-  public readonly onDidChangeExecutionDetails: Event<void>
+  public readonly onDidChangeConfigurationDetails: Event<void>
 
   private pythonBinPath: string | undefined
 
   private dvcPath = this.getCliPath()
 
-  private readonly executionDetailsChanged: EventEmitter<void>
+  private focusedProjects: string[] | undefined
+
+  private readonly configurationDetailsChanged: EventEmitter<void>
 
   private pythonExecutionDetailsListener?: Disposable
   private readonly onDidChangeExtensionsEvent: Event<void>
 
   constructor(onDidChangeExtensionsEvent = getOnDidChangeExtensions()) {
     super()
 
-    this.executionDetailsChanged = this.dispose.track(new EventEmitter())
-    this.onDidChangeExecutionDetails = this.executionDetailsChanged.event
+    this.configurationDetailsChanged = this.dispose.track(new EventEmitter())
+    this.onDidChangeConfigurationDetails =
+      this.configurationDetailsChanged.event
     this.onDidChangeExtensionsEvent = onDidChangeExtensionsEvent
 
     this.setPythonBinPath()
+    this.setFocusedProjects()
 
     this.onDidChangePythonExecutionDetails()
     this.onDidChangeExtensions()
@@ -43,6 +52,10 @@ export class Config extends DeferredDisposable {
     return this.pythonBinPath
   }
 
+  public getFocusedProjects() {
+    return this.focusedProjects
+  }
+
   public async setPythonBinPath() {
     this.pythonBinPath = await this.getConfigOrExtensionPythonBinPath()
     return this.deferred.resolve()
@@ -97,16 +110,71 @@ export class Config extends DeferredDisposable {
         if (e.affectsConfiguration(ConfigKey.PYTHON_PATH)) {
           this.setPythonAndNotifyIfChanged()
         }
+        if (e.affectsConfiguration(ConfigKey.FOCUSED_PROJECTS)) {
+          this.setFocusedProjectsAndNotifyIfChanged()
+        }
       })
     )
   }
 
+  private setFocusedProjectsAndNotifyIfChanged() {
+    const oldFocusedProjects = this.focusedProjects
+    this.setFocusedProjects()
+    if (!isEqual(oldFocusedProjects, this.focusedProjects)) {
+      this.configurationDetailsChanged.fire()
+    }
+  }
+
+  private setFocusedProjects() {
+    this.focusedProjects = this.validateFocusedProjects()
+  }
+
+  private validateFocusedProjects() {
+    const focusedProjects = getConfigValue<string | string[] | undefined>(
+      ConfigKey.FOCUSED_PROJECTS
+    )
+
+    if (!focusedProjects) {
+      return undefined
+    }
+    const workspaceFolders = getWorkspaceFolders()
+
+    const validatedFocusedProjects = new Set<string>()
+
+    const paths = Array.isArray(focusedProjects)
+      ? focusedProjects
+      : ([focusedProjects].filter(Boolean) as string[])
+    for (const path of paths) {
+      this.collectValidFocusedProject(
+        validatedFocusedProjects,
+        path,
+        workspaceFolders
+      )
+    }
+    return validatedFocusedProjects.size > 0
+      ? [...validatedFocusedProjects].sort()
+      : undefined
+  }
+
+  private collectValidFocusedProject(
+    validatedFocusedProjects: Set<string>,
+    path: string,
+    workspaceFolders: string[]
+  ) {
+    const standardizedPath = standardizePath(path)
+    for (const workspaceFolder of workspaceFolders) {
+      if (isSameOrChild(workspaceFolder, standardizedPath)) {
+        validatedFocusedProjects.add(standardizedPath)
+      }
+    }
+  }
+
   private notifyIfChanged(
     oldPath: string | undefined,
     newPath: string | undefined
   ) {
     if (oldPath !== newPath) {
-      this.executionDetailsChanged.fire()
+      this.configurationDetailsChanged.fire()
     }
   }
 }

extension/src/fileSystem/index.test.ts

@@ -35,6 +35,25 @@ describe('findDvcRootPaths', () => {
 
     expect([...dvcRoots]).toStrictEqual([dvcDemoPath, mockDvcRoot])
   })
+
+  it('should find a mono-repo root as well as sub-roots if available one directory below the given folder', async () => {
+    const parentDir = dvcDemoPath
+    const mockFirstDvcRoot = join(parentDir, 'mockFirstDvc')
+    const mockSecondDvcRoot = join(parentDir, 'mockSecondDvc')
+    ensureDirSync(join(mockFirstDvcRoot, DOT_DVC))
+    ensureDirSync(join(mockSecondDvcRoot, DOT_DVC))
+
+    const dvcRoots = await findDvcRootPaths(parentDir)
+
+    remove(mockFirstDvcRoot)
+    remove(mockSecondDvcRoot)
+
+    expect([...dvcRoots]).toStrictEqual([
+      dvcDemoPath,
+      mockFirstDvcRoot,
+      mockSecondDvcRoot
+    ])
+  })
 })
 
 describe('findAbsoluteDvcRootPath', () => {

extension/src/fileSystem/index.ts

@@ -44,16 +44,18 @@ export const findSubRootPaths = async (
 }
 
 export const findDvcRootPaths = async (cwd: string): Promise<string[]> => {
+  const dvcRoots = []
+
   if (isDirectory(join(cwd, DOT_DVC))) {
-    return [cwd]
+    dvcRoots.push(cwd)
   }
 
   const subRoots = await findSubRootPaths(cwd, DOT_DVC)
 
   if (definedAndNonEmpty(subRoots)) {
-    return subRoots
+    dvcRoots.push(...subRoots)
   }
-  return []
+  return dvcRoots.sort()
 }
 
 export const findAbsoluteDvcRootPath = async (

extension/src/setup/index.ts

@@ -150,7 +150,7 @@ export class Setup
       })
     )
     this.watchForVenvChanges()
-    this.watchExecutionDetailsForChanges()
+    this.watchConfigurationDetailsForChanges()
     this.watchDotFolderForChanges()
     this.watchPathForChanges(stopWatch)
   }
@@ -273,7 +273,8 @@ export class Setup
   }
 
   private async findDvcRoots(cwd: string): Promise<string[]> {
-    const dvcRoots = await findDvcRootPaths(cwd)
+    const dvcRoots =
+      this.config.getFocusedProjects() || (await findDvcRootPaths(cwd))
     if (definedAndNonEmpty(dvcRoots)) {
       return dvcRoots
     }
@@ -400,9 +401,9 @@ export class Setup
     }
   }
 
-  private watchExecutionDetailsForChanges() {
+  private watchConfigurationDetailsForChanges() {
     this.dispose.track(
-      this.config.onDidChangeExecutionDetails(async () => {
+      this.config.onDidChangeConfigurationDetails(async () => {
         const stopWatch = new StopWatch()
         try {
           this.sendDataToWebview()