Add DVC and Git initialization watcher (#3025)

Author: mattseddon

extension/src/cli/dvc/constants.ts

@@ -1,10 +1,11 @@
 import { join } from 'path'
 
 export const UNEXPECTED_ERROR_CODE = 255
+export const DOT_DVC = '.dvc'
 
-export const TEMP_PLOTS_DIR = join('.dvc', 'tmp', 'plots')
+export const TEMP_PLOTS_DIR = join(DOT_DVC, 'tmp', 'plots')
 export const DVCLIVE_ONLY_RUNNING_SIGNAL_FILE = join(
-  '.dvc',
+  DOT_DVC,
   'tmp',
   'exps',
   'run',

extension/src/cli/dvc/reader.test.ts

@@ -1,7 +1,7 @@
 import { join } from 'path'
 import { EventEmitter } from 'vscode'
 import { Disposable, Disposer } from '@hediet/std/disposable'
-import { UNEXPECTED_ERROR_CODE } from './constants'
+import { DOT_DVC, UNEXPECTED_ERROR_CODE } from './constants'
 import { EXPERIMENT_WORKSPACE_ID } from './contract'
 import { DvcReader } from './reader'
 import { CliResult, CliStarted } from '..'
@@ -168,7 +168,7 @@ describe('CliReader', () => {
           'diff',
           'HEAD',
           '-o',
-          join('.dvc', 'tmp', 'plots'),
+          join(DOT_DVC, 'tmp', 'plots'),
           '--split',
           JSON_FLAG
         ],

extension/src/experiments/data/index.ts

@@ -13,11 +13,11 @@ import {
 import { AvailableCommands, InternalCommands } from '../../commands/internal'
 import { ExperimentsOutput } from '../../cli/dvc/contract'
 import { BaseData } from '../../data'
-import { ExperimentFlag } from '../../cli/dvc/constants'
+import { DOT_DVC, ExperimentFlag } from '../../cli/dvc/constants'
 import { gitPath } from '../../cli/git/constants'
 import { getGitPath } from '../../fileSystem'
 
-export const QUEUED_EXPERIMENT_PATH = join('.dvc', 'tmp', 'exps')
+export const QUEUED_EXPERIMENT_PATH = join(DOT_DVC, 'tmp', 'exps')
 
 export class ExperimentsData extends BaseData<ExperimentsOutput> {
   constructor(
@@ -36,7 +36,7 @@ export class ExperimentsData extends BaseData<ExperimentsOutput> {
         },
         { name: 'fullUpdate', process: () => this.update() }
       ],
-      ['dvc.lock', 'dvc.yaml', 'params.yaml', '.dvc']
+      ['dvc.lock', 'dvc.yaml', 'params.yaml', DOT_DVC]
     )
 
     this.watchExpGitRefs()

extension/src/fileSystem/index.test.ts

@@ -9,6 +9,7 @@ import {
   getModifiedTime
 } from '.'
 import { dvcDemoPath } from '../test/util'
+import { DOT_DVC } from '../cli/dvc/constants'
 
 jest.mock('../cli/dvc/reader')
 
@@ -26,7 +27,7 @@ describe('findDvcRootPaths', () => {
   it('should find multiple roots if available one directory below the given folder', async () => {
     const parentDir = resolve(dvcDemoPath, '..')
     const mockDvcRoot = join(parentDir, 'mockDvc')
-    ensureDirSync(join(mockDvcRoot, '.dvc'))
+    ensureDirSync(join(mockDvcRoot, DOT_DVC))
 
     const dvcRoots = await findDvcRootPaths(parentDir)
 

extension/src/fileSystem/index.ts

@@ -17,6 +17,7 @@ import { gitPath } from '../cli/git/constants'
 import { createValidInteger } from '../util/number'
 import { processExists } from '../processExecution'
 import { getFirstWorkspaceFolder } from '../vscode/workspaceFolders'
+import { DOT_DVC } from '../cli/dvc/constants'
 
 export const exists = (path: string): boolean => existsSync(path)
 
@@ -43,13 +44,11 @@ export const findSubRootPaths = async (
 }
 
 export const findDvcRootPaths = async (cwd: string): Promise<string[]> => {
-  const dotDir = '.dvc'
-
-  if (isDirectory(join(cwd, dotDir))) {
+  if (isDirectory(join(cwd, DOT_DVC))) {
     return [cwd]
   }
 
-  const subRoots = await findSubRootPaths(cwd, '.dvc')
+  const subRoots = await findSubRootPaths(cwd, DOT_DVC)
 
   if (definedAndNonEmpty(subRoots)) {
     return subRoots
@@ -120,7 +119,7 @@ export type PartialDvcYaml = {
 export const isAnyDvcYaml = (path?: string): boolean =>
   !!(
     path &&
-    (extname(path) === '.dvc' ||
+    (extname(path) === DOT_DVC ||
       basename(path) === 'dvc.lock' ||
       basename(path) === 'dvc.yaml')
   )

extension/src/repository/model/index.ts

@@ -23,6 +23,7 @@ import { Disposable } from '../../class/dispose'
 import { sameContents } from '../../util/array'
 import { Data } from '../data'
 import { isDirectory } from '../../fileSystem'
+import { DOT_DVC } from '../../cli/dvc/constants'
 
 export class RepositoryModel extends Disposable {
   private readonly dvcRoot: string
@@ -156,7 +157,7 @@ export class RepositoryModel extends Disposable {
       ),
       untracked: [...untracked]
         .filter(
-          path => extname(path) !== '.dvc' && basename(path) !== '.gitignore'
+          path => extname(path) !== DOT_DVC && basename(path) !== '.gitignore'
         )
         .map(path => ({
           contextValue: SourceControlDataStatus.UNTRACKED,

extension/src/repository/model/tree.ts

@@ -46,6 +46,7 @@ import {
   getErrorTooltip
 } from '../../tree'
 import { getWorkspaceFolders } from '../../vscode/workspaceFolders'
+import { DOT_DVC } from '../../cli/dvc/constants'
 
 export class RepositoriesTree
   extends Disposable
@@ -174,7 +175,7 @@ export class RepositoriesTree
   }
 
   private getDataPlaceholder({ fsPath }: { fsPath: string }): string {
-    return fsPath.trim() + '.dvc'
+    return fsPath.trim() + DOT_DVC
   }
 
   private getContextValue({ fsPath }: Uri, isDirectory: boolean): string {

extension/src/setup/index.ts

@@ -1,4 +1,5 @@
 import { Event, EventEmitter, ViewColumn, commands } from 'vscode'
+import { Disposable, Disposer } from '@hediet/std/disposable'
 import isEmpty from 'lodash.isempty'
 import { SetupData as TSetupData } from './webview/contract'
 import { WebviewMessages } from './webview/messages'
@@ -35,9 +36,14 @@ import { WorkspaceExperiments } from '../experiments/workspace'
 import { DvcRunner } from '../cli/dvc/runner'
 import { sendTelemetryEvent, sendTelemetryEventAndThrow } from '../telemetry'
 import { StopWatch } from '../util/time'
-import { createFileSystemWatcher } from '../fileSystem/watcher'
+import {
+  createFileSystemWatcher,
+  getRelativePattern
+} from '../fileSystem/watcher'
 import { EventName } from '../telemetry/constants'
 import { WorkspaceScale } from '../telemetry/collect'
+import { gitPath } from '../cli/git/constants'
+import { DOT_DVC } from '../cli/dvc/constants'
 
 export type SetupWebviewWebview = BaseWebview<TSetupData>
 
@@ -74,6 +80,8 @@ export class Setup
   private cliAccessible = false
   private cliCompatible: boolean | undefined
 
+  private dotFolderWatcher?: Disposer
+
   constructor(
     stopWatch: StopWatch,
     config: Config,
@@ -143,6 +151,7 @@ export class Setup
     )
     this.watchForVenvChanges()
     this.watchExecutionDetailsForChanges()
+    this.watchDotFolderForChanges()
     this.watchPathForChanges(stopWatch)
   }
 
@@ -280,13 +289,16 @@ export class Setup
   private setProjectAvailability() {
     const available = this.hasRoots()
     setContextValue('dvc.project.available', available)
+    if (available && this.dotFolderWatcher && !this.dotFolderWatcher.disposed) {
+      this.dispose.untrack(this.dotFolderWatcher)
+      this.dotFolderWatcher.dispose()
+    }
   }
 
   private async initializeDvc() {
     const root = getFirstWorkspaceFolder()
     if (root) {
       await this.dvcExecutor.init(root)
-      this.workspaceChanged.fire()
     }
   }
 
@@ -324,7 +336,6 @@ export class Setup
     const cwd = getFirstWorkspaceFolder()
     if (cwd) {
       this.gitExecutor.init(cwd)
-      this.workspaceChanged.fire()
     }
   }
 
@@ -449,12 +460,46 @@ export class Setup
           previousPythonBinPath !== this.config.getPythonBinPath()
 
         if (!this.cliAccessible || !this.cliCompatible || trySetupWithVenv) {
-          run(this)
+          this.workspaceChanged.fire()
         }
       }
     )
   }
 
+  private watchDotFolderForChanges() {
+    const cwd = getFirstWorkspaceFolder()
+
+    if (!cwd) {
+      return
+    }
+
+    const disposer = Disposable.fn()
+    this.dotFolderWatcher = disposer
+    this.dispose.track(this.dotFolderWatcher)
+
+    return createFileSystemWatcher(
+      disposable => disposer.track(disposable),
+      getRelativePattern(cwd, '**'),
+      path => this.dotFolderListener(disposer, path)
+    )
+  }
+
+  private dotFolderListener(disposer: Disposer, path: string) {
+    if (
+      !(path && (path.endsWith(gitPath.DOT_GIT) || path.includes(DOT_DVC))) ||
+      disposer.disposed
+    ) {
+      return
+    }
+
+    if (path.includes(DOT_DVC)) {
+      this.dispose.untrack(disposer)
+      disposer.dispose()
+    }
+
+    return this.workspaceChanged.fire()
+  }
+
   private async getEventProperties() {
     return {
       ...(this.cliAccessible ? await this.collectWorkspaceScale() : {}),

extension/src/test/cli/util.ts

@@ -7,6 +7,7 @@ import { exists } from '../../fileSystem'
 import { getVenvBinPath } from '../../python/path'
 import { dvcDemoPath } from '../util'
 import { GitExecutor } from '../../cli/git/executor'
+import { DOT_DVC } from '../../cli/dvc/constants'
 
 const config = {
   getCliPath: () => '',
@@ -26,7 +27,7 @@ export const initializeDemoRepo = (): Promise<string> => {
 }
 
 export const initializeEmptyRepo = async (): Promise<string> => {
-  if (exists(join(TEMP_DIR, '.dvc'))) {
+  if (exists(join(TEMP_DIR, DOT_DVC))) {
     return ''
   }
 

extension/src/test/suite/extension.test.ts

@@ -343,33 +343,6 @@ suite('Extension Test Suite', () => {
     })
   })
 
-  describe('dvc.init', () => {
-    it('should be able to run dvc.init without error', async () => {
-      const mockInit = stub(DvcExecutor.prototype, 'init').resolves('')
-      const mockSetup = stub(Setup, 'run')
-      const mockSetupCalled = new Promise(resolve =>
-        mockSetup.callsFake(() => {
-          resolve(undefined)
-          return Promise.resolve(undefined)
-        })
-      )
-
-      await commands.executeCommand(RegisteredCliCommands.INIT)
-      await mockSetupCalled
-      expect(mockInit).to.be.calledOnce
-      expect(mockSetup).to.be.calledOnce
-
-      mockInit.resetHistory()
-      mockSetup.resetHistory()
-      stub(WorkspaceFolders, 'getFirstWorkspaceFolder').returns(undefined)
-
-      await commands.executeCommand(RegisteredCliCommands.INIT)
-
-      expect(mockInit).not.to.be.called
-      expect(mockSetup).not.to.be.called
-    })
-  })
-
   describe('dvc.showCommands', () => {
     it('should show all of the dvc commands without error', async () => {
       await expect(