Set scm running context to false if command fails (#3727)

Author: mattseddon

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

@@ -1,14 +1,15 @@
 import { join } from 'path'
 import { EventEmitter } from 'vscode'
 import { Disposable, Disposer } from '@hediet/std/disposable'
-import { Flag, GcPreserveFlag } from './constants'
+import { Flag, GcPreserveFlag, UNEXPECTED_ERROR_CODE } from './constants'
 import { DvcExecutor } from './executor'
 import { CliResult, CliStarted } from '..'
 import { createProcess } from '../../process/execution'
 import { flushPromises, getMockedProcess } from '../../test/util/jest'
 import { getProcessEnv } from '../../env'
 import { Config } from '../../config'
 import { ContextKey, setContextValue } from '../../vscode/context'
+import { MaybeConsoleError } from '../error'
 
 jest.mock('vscode')
 jest.mock('@hediet/std/disposable')
@@ -92,6 +93,37 @@ describe('CliExecutor', () => {
         executable: 'dvc'
       })
     })
+
+    it('should set the correct context value if the command fails', async () => {
+      const cwd = __dirname
+      const relPath = join('data', 'MNIST', 'raw')
+      const unexpectedError = new Error(
+        'unexpected error - something something'
+      )
+      const unexpectedStderr = 'This is very unexpected'
+      ;(unexpectedError as MaybeConsoleError).exitCode = UNEXPECTED_ERROR_CODE
+      ;(unexpectedError as MaybeConsoleError).stderr = unexpectedStderr
+      mockedCreateProcess.mockImplementationOnce(() => {
+        throw unexpectedError
+      })
+
+      let error
+
+      try {
+        await dvcExecutor.add(cwd, relPath)
+      } catch (thrownError) {
+        error = thrownError
+      }
+
+      expect((error as MaybeConsoleError).stderr).toStrictEqual(
+        unexpectedStderr
+      )
+
+      expect(mockedSetContextValue).toHaveBeenLastCalledWith(
+        ContextKey.SCM_RUNNING,
+        false
+      )
+    })
   })
 
   describe('checkout', () => {

extension/src/cli/dvc/executor.ts

@@ -193,9 +193,14 @@ export class DvcExecutor extends DvcCli {
 
   private async blockAndExecuteProcess(cwd: string, ...args: Args) {
     this.setRunning(true)
-    const output = await this.executeDvcProcess(cwd, ...args)
-    this.setRunning(false)
-    return output
+    try {
+      const output = await this.executeDvcProcess(cwd, ...args)
+      this.setRunning(false)
+      return output
+    } catch (error) {
+      this.setRunning(false)
+      throw error
+    }
   }
 
   private setRunning(running: boolean) {