Patch CLI incompatible onboarding path (#2992)

Author: mattseddon

extension/src/cli/dvc/constants.ts

@@ -1,9 +1,5 @@
 import { join } from 'path'
 
-export const MIN_CLI_VERSION = '2.30.0'
-export const LATEST_TESTED_CLI_VERSION = '2.38.0'
-export const MAX_CLI_VERSION = '3'
-
 export const UNEXPECTED_ERROR_CODE = 255
 
 export const TEMP_PLOTS_DIR = join('.dvc', 'tmp', 'plots')

extension/src/cli/dvc/contract.ts

@@ -1,5 +1,9 @@
 import { Plot } from '../../plots/webview/contract'
 
+export const MIN_CLI_VERSION = '2.30.0'
+export const LATEST_TESTED_CLI_VERSION = '2.38.0'
+export const MAX_CLI_VERSION = '3'
+
 type ErrorContents = { type: string; msg: string }
 
 export type DvcError = { error: ErrorContents }

extension/src/cli/dvc/discovery.ts

@@ -2,7 +2,7 @@ import {
   LATEST_TESTED_CLI_VERSION,
   MAX_CLI_VERSION,
   MIN_CLI_VERSION
-} from './constants'
+} from './contract'
 import { CliCompatible, isVersionCompatible } from './version'
 import { IExtension } from '../../interfaces'
 import { Toast } from '../../vscode/toast'

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

@@ -4,10 +4,10 @@ import {
   ParsedSemver,
   CliCompatible
 } from './version'
-import { MIN_CLI_VERSION, LATEST_TESTED_CLI_VERSION } from './constants'
+import { MIN_CLI_VERSION, LATEST_TESTED_CLI_VERSION } from './contract'
 
-jest.mock('./constants', () => ({
-  ...jest.requireActual('./constants'),
+jest.mock('./contract', () => ({
+  ...jest.requireActual('./contract'),
   LATEST_TESTED_CLI_VERSION: '2.11.1',
   MIN_CLI_VERSION: '2.9.4'
 }))

extension/src/cli/dvc/version.ts

@@ -2,7 +2,7 @@ import {
   MAX_CLI_VERSION,
   LATEST_TESTED_CLI_VERSION,
   MIN_CLI_VERSION
-} from './constants'
+} from './contract'
 
 export enum CliCompatible {
   NO_BEHIND_MIN_VERSION = 'no-behind-min-version',

extension/src/extension.ts

@@ -170,7 +170,7 @@ export class Extension extends Disposable implements IExtension {
         this.resourceLocator.dvcIcon,
         () => this.initProject(),
         () => this.showExperiments(this.dvcRoots[0]),
-        () => this.getAvailable(),
+        () => this.getCliCompatible(),
         () => this.hasRoots(),
         () => this.experiments.getHasData()
       )
@@ -544,6 +544,10 @@ export class Extension extends Disposable implements IExtension {
     )
   }
 
+  private getCliCompatible() {
+    return this.cliCompatible
+  }
+
   private changeSetupStep() {
     this.setup.sendDataToWebview()
   }

extension/src/setup.test.ts

@@ -23,7 +23,7 @@ import {
   LATEST_TESTED_CLI_VERSION,
   MAX_CLI_VERSION,
   MIN_CLI_VERSION
-} from './cli/dvc/constants'
+} from './cli/dvc/contract'
 import { extractSemver, ParsedSemver } from './cli/dvc/version'
 import { delay } from './util/time'
 import { Title } from './vscode/title'

extension/src/setup/index.ts

@@ -15,7 +15,7 @@ export class Setup extends BaseRepository<TSetupData> {
 
   private webviewMessages: WebviewMessages
   private showExperiments: () => void
-  private getCliAccessible: () => boolean
+  private getCliCompatible: () => boolean | undefined
   private getHasRoots: () => boolean
   private getHasData: () => boolean | undefined
 
@@ -24,7 +24,7 @@ export class Setup extends BaseRepository<TSetupData> {
     webviewIcon: Resource,
     initProject: () => void,
     showExperiments: () => void,
-    getCliAccessible: () => boolean,
+    getCliCompatible: () => boolean | undefined,
     getHasRoots: () => boolean,
     getHasData: () => boolean | undefined
   ) {
@@ -36,7 +36,7 @@ export class Setup extends BaseRepository<TSetupData> {
       this.sendDataToWebview()
     }
     this.showExperiments = showExperiments
-    this.getCliAccessible = getCliAccessible
+    this.getCliCompatible = getCliCompatible
     this.getHasRoots = getHasRoots
     this.getHasData = getHasData
   }
@@ -50,13 +50,13 @@ export class Setup extends BaseRepository<TSetupData> {
   }
 
   public async sendDataToWebview() {
-    const cliAccessible = this.getCliAccessible()
+    const cliCompatible = this.getCliCompatible()
     const projectInitialized = this.getHasRoots()
     const hasData = this.getHasData()
 
     if (
       this.webview?.isVisible &&
-      cliAccessible &&
+      cliCompatible &&
       projectInitialized &&
       hasData
     ) {
@@ -68,7 +68,7 @@ export class Setup extends BaseRepository<TSetupData> {
     const pythonBinPath = await findPythonBinForInstall()
 
     this.webviewMessages.sendWebviewMessage(
-      cliAccessible,
+      cliCompatible,
       projectInitialized,
       isPythonExtensionInstalled(),
       getBinDisplayText(pythonBinPath),

extension/src/setup/webview/contract.ts

@@ -1,5 +1,5 @@
 export type SetupData = {
-  cliAccessible: boolean
+  cliCompatible: boolean | undefined
   hasData: boolean | undefined
   isPythonExtensionInstalled: boolean
   projectInitialized: boolean

extension/src/setup/webview/messages.ts

@@ -25,14 +25,14 @@ export class WebviewMessages {
   }
 
   public sendWebviewMessage(
-    cliAccessible: boolean,
+    cliCompatible: boolean | undefined,
     projectInitialized: boolean,
     isPythonExtensionInstalled: boolean,
     pythonBinPath: string | undefined,
     hasData: boolean | undefined
   ) {
     this.getWebview()?.show({
-      cliAccessible,
+      cliCompatible,
       hasData,
       isPythonExtensionInstalled,
       projectInitialized,