Prevent unnecessary CLI calls in the integration test suite (#2934)

* prevent unnecessary CLI calls in the integration test suite

* flush sneaky extra watchers

Author: mattseddon

extension/src/experiments/data/index.ts

@@ -66,10 +66,6 @@ export class ExperimentsData extends BaseData<ExperimentsOutput> {
     return this.notifyChanged(data)
   }
 
-  public forceUpdate() {
-    return this.processManager.forceRunQueued()
-  }
-
   protected collectFiles(data: ExperimentsOutput) {
     this.collectedFiles = collectFiles(data, this.collectedFiles)
   }

extension/src/experiments/index.ts

@@ -163,10 +163,6 @@ export class Experiments extends BaseRepository<TableData> {
     return this.cliData.managedUpdate()
   }
 
-  public forceUpdate() {
-    return this.cliData.forceUpdate()
-  }
-
   public async setState(data: ExperimentsOutput) {
     const dvcLiveOnly = await checkSignalFile(
       join(this.dvcRoot, DVCLIVE_ONLY_RUNNING_SIGNAL_FILE)

extension/src/processManager.ts

@@ -55,17 +55,6 @@ export class ProcessManager extends Disposable {
     return this.runQueued()
   }
 
-  public async forceRunQueued(): Promise<void> {
-    const next = this.getNextFromQueue()
-    if (!next) {
-      return
-    }
-
-    const { process } = this.processes[next]
-    await Promise.all([process(), this.setLastStarted(next)])
-    return this.forceRunQueued()
-  }
-
   public isOngoingOrQueued(name: string) {
     return this.isOngoing(name) || this.isQueued(name)
   }
@@ -92,7 +81,7 @@ export class ProcessManager extends Disposable {
 
   private runQueued(): Promise<void> {
     const next = this.getNextFromQueue()
-    if (!next) {
+    if (!next || this.dispose.disposed) {
       return Promise.resolve()
     }
 

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

@@ -2,11 +2,11 @@ import { afterEach, beforeEach, describe, it, suite } from 'mocha'
 import { EventEmitter, RelativePattern } from 'vscode'
 import { expect } from 'chai'
 import { stub, restore, spy } from 'sinon'
-import { Disposable } from '../../../../extension'
 import {
   bypassProcessManagerDebounce,
   getFirstArgOfCall,
   getMockNow,
+  getSafeWatcherDisposer,
   stubPrivateMemberMethod
 } from '../../util'
 import { dvcDemoPath, getTestWorkspaceFolder } from '../../../util'
@@ -27,14 +27,14 @@ import { gitPath } from '../../../../cli/git/constants'
 import { getGitPath } from '../../../../fileSystem'
 
 suite('Experiments Data Test Suite', () => {
-  const disposable = Disposable.fn()
+  const disposable = getSafeWatcherDisposer()
 
   beforeEach(() => {
     restore()
   })
 
   afterEach(() => {
-    disposable.dispose()
+    return disposable.disposeAndFlush()
   })
 
   describe('ExperimentsData', () => {

extension/src/test/suite/experiments/model/tree.test.ts

@@ -12,12 +12,12 @@ import {
   window
 } from 'vscode'
 import { addFilterViaQuickInput } from './filterBy/util'
-import { Disposable } from '../../../../extension'
 import { ExperimentsModel, ExperimentType } from '../../../../experiments/model'
 import { UNSELECTED } from '../../../../experiments/model/status'
 import {
   experimentsUpdatedEvent,
   getFirstArgOfLastCall,
+  getSafeWatcherDisposer,
   spyOnPrivateMethod,
   stubPrivatePrototypeMethod
 } from '../../util'
@@ -55,14 +55,14 @@ import { ExperimentItem } from '../../../../experiments/model/collect'
 import { EXPERIMENT_WORKSPACE_ID } from '../../../../cli/dvc/contract'
 
 suite('Experiments Tree Test Suite', () => {
-  const disposable = Disposable.fn()
+  const disposable = getSafeWatcherDisposer()
 
   beforeEach(() => {
     restore()
   })
 
   afterEach(() => {
-    disposable.dispose()
+    return disposable.disposeAndFlush()
   })
 
   // eslint-disable-next-line sonarjs/cognitive-complexity

extension/src/test/suite/experiments/util.ts

@@ -10,7 +10,8 @@ import {
   buildDependencies,
   buildInternalCommands,
   buildMockData,
-  mockDisposable
+  mockDisposable,
+  SafeWatcherDisposer
 } from '../util'
 import {
   ExperimentsOutput,
@@ -95,7 +96,7 @@ export const buildExperiments = (
   }
 }
 
-export const buildMultiRepoExperiments = (disposer: Disposer) => {
+export const buildMultiRepoExperiments = (disposer: SafeWatcherDisposer) => {
   const {
     internalCommands,
     experiments: mockExperiments,
@@ -126,7 +127,7 @@ export const buildMultiRepoExperiments = (disposer: Disposer) => {
   return { experiments, internalCommands, messageSpy, workspaceExperiments }
 }
 
-export const buildSingleRepoExperiments = (disposer: Disposer) => {
+export const buildSingleRepoExperiments = (disposer: SafeWatcherDisposer) => {
   const {
     internalCommands,
     gitReader,
@@ -153,6 +154,7 @@ export const buildSingleRepoExperiments = (disposer: Disposer) => {
 
   return { messageSpy, workspaceExperiments }
 }
+
 const buildExperimentsDataDependencies = (disposer: Disposer) => {
   const mockCreateFileSystemWatcher = stub(
     Watcher,
@@ -164,7 +166,7 @@ const buildExperimentsDataDependencies = (disposer: Disposer) => {
   return { internalCommands, mockCreateFileSystemWatcher, mockExperimentShow }
 }
 
-export const buildExperimentsData = (disposer: Disposer) => {
+export const buildExperimentsData = (disposer: SafeWatcherDisposer) => {
   const { internalCommands, mockExperimentShow, mockCreateFileSystemWatcher } =
     buildExperimentsDataDependencies(disposer)
 

extension/src/test/suite/experiments/workspace.test.ts

@@ -12,7 +12,12 @@ import { Disposable } from '../../../extension'
 import { Experiments } from '../../../experiments'
 import * as QuickPick from '../../../vscode/quickPick'
 import { DvcExecutor } from '../../../cli/dvc/executor'
-import { closeAllEditors, getInputBoxEvent, mockDuration } from '../util'
+import {
+  closeAllEditors,
+  getInputBoxEvent,
+  getSafeWatcherDisposer,
+  mockDuration
+} from '../util'
 import { dvcDemoPath } from '../../util'
 import { RegisteredCliCommands } from '../../../commands/external'
 import * as Telemetry from '../../../telemetry'
@@ -30,15 +35,14 @@ import { GitExecutor } from '../../../cli/git/executor'
 import { EXPERIMENT_WORKSPACE_ID } from '../../../cli/dvc/contract'
 
 suite('Workspace Experiments Test Suite', () => {
-  const disposable = Disposable.fn()
+  const disposable = getSafeWatcherDisposer()
 
   beforeEach(() => {
     restore()
   })
 
   afterEach(() => {
-    disposable.dispose()
-    return closeAllEditors()
+    return Promise.all([closeAllEditors(), disposable.disposeAndFlush()])
   })
 
   const onDidChangeIsWebviewFocused = (

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

@@ -6,6 +6,7 @@ import { window, commands, workspace, Uri } from 'vscode'
 import {
   closeAllEditors,
   configurationChangeEvent,
+  mockDisposable,
   mockDuration,
   quickPickInitialized,
   selectQuickPickItem
@@ -23,6 +24,7 @@ import {
   RegisteredCommands
 } from '../../commands/external'
 import * as Setup from '../../setup'
+import * as Watcher from '../../fileSystem/watcher'
 import * as Telemetry from '../../telemetry'
 import { EventName } from '../../telemetry/constants'
 import { OutputChannel } from '../../vscode/outputChannel'
@@ -447,6 +449,7 @@ suite('Extension Test Suite', () => {
     })
 
     it('should set the dvc.cli.incompatible context value', async () => {
+      stub(Watcher, 'createFileSystemWatcher').returns(mockDisposable)
       stub(DvcReader.prototype, 'expShow').resolves({
         [EXPERIMENT_WORKSPACE_ID]: { baseline: {} }
       })

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

@@ -2,23 +2,26 @@ import { afterEach, beforeEach, describe, it, suite } from 'mocha'
 import { stub, restore } from 'sinon'
 import { expect } from 'chai'
 import { RelativePattern } from 'vscode'
-import { Disposable } from '../../../../extension'
 import { FileSystemData } from '../../../../fileSystem/data'
 import { dvcDemoPath, getTestWorkspaceFolder } from '../../../util'
 import * as FileSystem from '../../../../fileSystem'
 import * as Watcher from '../../../../fileSystem/watcher'
-import { getFirstArgOfCall, mockDisposable } from '../../util'
+import {
+  getFirstArgOfCall,
+  getSafeWatcherDisposer,
+  mockDisposable
+} from '../../util'
 import { join } from '../../../util/path'
 
 suite('File System Data Test Suite', () => {
-  const disposable = Disposable.fn()
+  const disposable = getSafeWatcherDisposer()
 
   beforeEach(() => {
     restore()
   })
 
   afterEach(() => {
-    disposable.dispose()
+    return disposable.disposeAndFlush()
   })
 
   describe('FileSystemData', () => {

extension/src/test/suite/getStarted/index.test.ts

@@ -23,8 +23,10 @@ suite('GetStarted Test Suite', () => {
 
   describe('Get Started', () => {
     it('should handle a initialize project message from the webview', async () => {
-      const { messageSpy, getStarted, mockInitializeProject } =
-        await buildGetStarted(disposable, true)
+      const { messageSpy, getStarted, mockInitializeProject } = buildGetStarted(
+        disposable,
+        true
+      )
 
       const webview = await getStarted.showWebview()
       await webview.isReady()
@@ -40,8 +42,10 @@ suite('GetStarted Test Suite', () => {
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
     it('should handle a open experiments message from the webview', async () => {
-      const { messageSpy, getStarted, mockOpenExperiments } =
-        await buildGetStarted(disposable, true)
+      const { messageSpy, getStarted, mockOpenExperiments } = buildGetStarted(
+        disposable,
+        true
+      )
 
       const webview = await getStarted.showWebview()
       await webview.isReady()
@@ -57,7 +61,7 @@ suite('GetStarted Test Suite', () => {
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
     it('should log an error message if the message from the webview is anything else than initialize project', async () => {
-      const { messageSpy, getStarted } = await buildGetStarted(disposable)
+      const { messageSpy, getStarted } = buildGetStarted(disposable)
 
       const webview = await getStarted.showWebview()
       await webview.isReady()