Show a setup screen when project has no commits (#3253)

* add an extra step to our setup that shows if a user has initialized git and dvc but still has no commits
* take off notification that appears after dvc initializes

Author: julieg18

extension/src/cli/git/constants.ts

@@ -19,10 +19,12 @@ export enum Command {
   LS_FILES = 'ls-files',
   PUSH = 'push',
   RESET = 'reset',
-  REV_PARSE = 'rev-parse'
+  REV_PARSE = 'rev-parse',
+  REV_LIST = 'rev-list'
 }
 
 export enum Flag {
+  ALL = '--all',
   DIRECTORIES = '-d',
   DIRECTORY = '--directory',
   DOT = '.',

extension/src/cli/git/reader.ts

@@ -31,6 +31,19 @@ export class GitReader extends GitCli {
     return !!output
   }
 
+  public async hasNoCommits(cwd: string) {
+    const options = getOptions(
+      cwd,
+      Command.REV_LIST,
+      Flag.NUMBER,
+      '1',
+      Flag.ALL
+    )
+    const output = await this.executeProcess(options)
+
+    return !output
+  }
+
   public async getCommitMessages(cwd: string, sha: string): Promise<string> {
     const options = getOptions(
       cwd,

extension/src/setup/index.ts

@@ -43,7 +43,6 @@ import { EventName } from '../telemetry/constants'
 import { WorkspaceScale } from '../telemetry/collect'
 import { gitPath } from '../cli/git/constants'
 import { DOT_DVC } from '../cli/dvc/constants'
-import { Toast } from '../vscode/toast'
 
 export type SetupWebviewWebview = BaseWebview<TSetupData>
 
@@ -241,17 +240,21 @@ export class Setup
 
     const canGitInitialize = await this.canGitInitialize(needsGitInitialized)
 
+    const needsGitCommit =
+      needsGitInitialized || (await this.needsGitCommit(needsGitInitialized))
+
     const pythonBinPath = await findPythonBinForInstall()
 
-    this.webviewMessages.sendWebviewMessage(
-      this.cliCompatible,
-      needsGitInitialized,
+    this.webviewMessages.sendWebviewMessage({
       canGitInitialize,
+      cliCompatible: this.cliCompatible,
+      hasData,
+      isPythonExtensionInstalled: isPythonExtensionInstalled(),
+      needsGitCommit,
+      needsGitInitialized,
       projectInitialized,
-      isPythonExtensionInstalled(),
-      getBinDisplayText(pythonBinPath),
-      hasData
-    )
+      pythonBinPath: getBinDisplayText(pythonBinPath)
+    })
   }
 
   private createWebviewMessageHandler() {
@@ -311,9 +314,6 @@ export class Setup
     const root = getFirstWorkspaceFolder()
     if (root) {
       await this.dvcExecutor.init(root)
-      void Toast.infoWithOptions(
-        'Initialized DVC repository. You can now [commit the changes to git](command:workbench.view.scm).'
-      )
     }
   }
 
@@ -354,6 +354,18 @@ export class Setup
     }
   }
 
+  private needsGitCommit(needsGitInit: boolean) {
+    if (needsGitInit) {
+      return true
+    }
+
+    const cwd = getFirstWorkspaceFolder()
+    if (!cwd) {
+      return true
+    }
+    return this.gitReader.hasNoCommits(cwd)
+  }
+
   private registerCommands(internalCommands: InternalCommands) {
     internalCommands.registerExternalCliCommand(
       RegisteredCliCommands.INIT,

extension/src/setup/webview/contract.ts

@@ -4,6 +4,7 @@ export type SetupData = {
   hasData: boolean | undefined
   isPythonExtensionInstalled: boolean
   needsGitInitialized: boolean | undefined
+  needsGitCommit: boolean
   projectInitialized: boolean
   pythonBinPath: string | undefined
 }

extension/src/setup/webview/messages.ts

@@ -27,20 +27,31 @@ export class WebviewMessages {
     this.initializeGit = initializeGit
   }
 
-  public sendWebviewMessage(
-    cliCompatible: boolean | undefined,
-    needsGitInitialized: boolean | undefined,
-    canGitInitialize: boolean,
-    projectInitialized: boolean,
-    isPythonExtensionInstalled: boolean,
-    pythonBinPath: string | undefined,
+  public sendWebviewMessage({
+    cliCompatible,
+    needsGitInitialized,
+    canGitInitialize,
+    needsGitCommit,
+    projectInitialized,
+    isPythonExtensionInstalled,
+    pythonBinPath,
+    hasData
+  }: {
+    cliCompatible: boolean | undefined
+    needsGitInitialized: boolean | undefined
+    canGitInitialize: boolean
+    projectInitialized: boolean
+    needsGitCommit: boolean
+    isPythonExtensionInstalled: boolean
+    pythonBinPath: string | undefined
     hasData: boolean | undefined
-  ) {
+  }) {
     void this.getWebview()?.show({
       canGitInitialize,
       cliCompatible,
       hasData,
       isPythonExtensionInstalled,
+      needsGitCommit,
       needsGitInitialized,
       projectInitialized,
       pythonBinPath
@@ -57,6 +68,8 @@ export class WebviewMessages {
         return this.initializeDvc()
       case MessageFromWebviewType.INITIALIZE_GIT:
         return this.initializeGit()
+      case MessageFromWebviewType.SHOW_SCM_PANEL:
+        return commands.executeCommand('workbench.view.scm')
       case MessageFromWebviewType.SELECT_PYTHON_INTERPRETER:
         return this.selectPythonInterpreter()
       case MessageFromWebviewType.INSTALL_DVC:

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

@@ -138,6 +138,23 @@ suite('Setup Test Suite', () => {
       expect(mockExecuteCommand).to.be.calledWithExactly(setInterpreterCommand)
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
+    it('should handle a show source control panel message from the webview', async () => {
+      const { messageSpy, setup, mockExecuteCommand } = buildSetup(disposable)
+      const showScmPanelCommand = 'workbench.view.scm'
+
+      const webview = await setup.showWebview()
+      await webview.isReady()
+
+      const mockMessageReceived = getMessageReceivedEmitter(webview)
+
+      messageSpy.resetHistory()
+      mockMessageReceived.fire({
+        type: MessageFromWebviewType.SHOW_SCM_PANEL
+      })
+
+      expect(mockExecuteCommand).to.be.calledWithExactly(showScmPanelCommand)
+    }).timeout(WEBVIEW_TEST_TIMEOUT)
+
     it('should handle a setup the workspace message from the webview', async () => {
       const { messageSpy, setup, mockExecuteCommand } = buildSetup(disposable)
 
@@ -222,6 +239,7 @@ suite('Setup Test Suite', () => {
         cliCompatible: undefined,
         hasData: false,
         isPythonExtensionInstalled: false,
+        needsGitCommit: true,
         needsGitInitialized: true,
         projectInitialized: false,
         pythonBinPath: undefined
@@ -258,6 +276,7 @@ suite('Setup Test Suite', () => {
         cliCompatible: true,
         hasData: false,
         isPythonExtensionInstalled: false,
+        needsGitCommit: true,
         needsGitInitialized: true,
         projectInitialized: false,
         pythonBinPath: undefined
@@ -269,6 +288,7 @@ suite('Setup Test Suite', () => {
         disposable,
         false,
         true,
+        false,
         false
       )
 
@@ -299,12 +319,56 @@ suite('Setup Test Suite', () => {
         cliCompatible: true,
         hasData: false,
         isPythonExtensionInstalled: false,
+        needsGitCommit: false,
         needsGitInitialized: false,
         projectInitialized: false,
         pythonBinPath: undefined
       })
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
+    it('should send the expected message to the webview when there is no commits in the git repository', async () => {
+      const { config, setup, messageSpy } = buildSetup(
+        disposable,
+        false,
+        false,
+        false,
+        true
+      )
+
+      await config.isReady()
+
+      setup.setCliCompatible(true)
+      setup.setAvailable(true)
+      await setup.setRoots()
+
+      messageSpy.restore()
+      const mockSendMessage = stub(BaseWebview.prototype, 'show')
+
+      const messageSent = new Promise(resolve =>
+        mockSendMessage.callsFake(data => {
+          resolve(undefined)
+          return Promise.resolve(!!data)
+        })
+      )
+
+      const webview = await setup.showWebview()
+      await webview.isReady()
+
+      await messageSent
+
+      expect(mockSendMessage).to.be.calledOnce
+      expect(mockSendMessage).to.be.calledWithExactly({
+        canGitInitialize: false,
+        cliCompatible: true,
+        hasData: false,
+        isPythonExtensionInstalled: false,
+        needsGitCommit: true,
+        needsGitInitialized: false,
+        projectInitialized: true,
+        pythonBinPath: undefined
+      })
+    }).timeout(WEBVIEW_TEST_TIMEOUT)
+
     it('should setup the appropriate watchers', async () => {
       const { setup, mockRunSetup, onDidChangeWorkspace } =
         await buildSetupWithWatchers(disposable)

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

@@ -28,14 +28,16 @@ export const TEMP_DIR = join(dvcDemoPath, 'temp-empty-watcher-dir')
 const buildSetupDependencies = (
   disposer: Disposer,
   mockDvcRoot: string | undefined,
-  mockGitRoot: string | undefined
+  mockGitRoot: string | undefined,
+  noGitCommits = true
 ) => {
   const mockEmitter = disposer.track(new EventEmitter())
   const mockEvent = mockEmitter.event
 
   const mockRoot = stub().resolves(mockDvcRoot)
   const mockVersion = stub().resolves(MIN_CLI_VERSION)
   const mockGetGitRepositoryRoot = stub().resolves(mockGitRoot)
+  const mockHasNoCommits = stub().resolves(noGitCommits)
 
   const mockInitializeDvc = fake()
   const mockInitializeGit = fake()
@@ -67,6 +69,7 @@ const buildSetupDependencies = (
     } as unknown as GitExecutor,
     mockGitReader: {
       getGitRepositoryRoot: mockGetGitRepositoryRoot,
+      hasNoCommits: mockHasNoCommits,
       onDidCompleteProcess: mockEvent,
       onDidStartProcess: mockEvent
     } as unknown as GitReader,
@@ -87,7 +90,8 @@ export const buildSetup = (
   disposer: Disposer,
   hasData = false,
   noDvcRoot = true,
-  noGitRoot = true
+  noGitRoot = true,
+  noGitCommits = true
 ) => {
   const { config, messageSpy, resourceLocator } = buildDependencies(disposer)
 
@@ -108,7 +112,7 @@ export const buildSetup = (
     mockInternalCommands,
     mockRunSetup,
     mockVersion
-  } = buildSetupDependencies(disposer, mockDvcRoot, mockGitRoot)
+  } = buildSetupDependencies(disposer, mockDvcRoot, mockGitRoot, noGitCommits)
   stub(FileSystem, 'findDvcRootPaths').resolves(
     [mockDvcRoot].filter(Boolean) as string[]
   )

extension/src/webview/contract.ts

@@ -52,6 +52,7 @@ export enum MessageFromWebviewType {
   CHECK_CLI_COMPATIBLE = 'check-cli-compatible',
   INITIALIZE_DVC = 'initialize-dvc',
   INITIALIZE_GIT = 'initialize-git',
+  SHOW_SCM_PANEL = 'show-scm-panel',
   INSTALL_DVC = 'install-dvc',
   SETUP_WORKSPACE = 'setup-workspace'
 }
@@ -192,6 +193,7 @@ export type MessageFromWebview =
   | { type: MessageFromWebviewType.CHECK_CLI_COMPATIBLE }
   | { type: MessageFromWebviewType.INITIALIZE_DVC }
   | { type: MessageFromWebviewType.INITIALIZE_GIT }
+  | { type: MessageFromWebviewType.SHOW_SCM_PANEL }
   | { type: MessageFromWebviewType.INSTALL_DVC }
   | { type: MessageFromWebviewType.SETUP_WORKSPACE }
 

webview/src/setup/components/App.tsx

@@ -8,6 +8,7 @@ import { CliIncompatible } from './CliIncompatible'
 import { CliUnavailable } from './CliUnavailable'
 import { ProjectUninitialized } from './ProjectUninitialized'
 import { NoData } from './NoData'
+import { NeedsGitCommit } from './NeedsGitCommit'
 import { useVsCodeMessaging } from '../../shared/hooks/useVsCodeMessaging'
 import { sendMessage } from '../../shared/vscode'
 import { EmptyState } from '../../shared/components/emptyState/EmptyState'
@@ -24,6 +25,7 @@ export const App: React.FC = () => {
   const [canGitInitialize, setCanGitInitialized] = useState<
     boolean | undefined
   >(false)
+  const [needsGitCommit, setNeedsGitCommit] = useState<boolean>(false)
   const [pythonBinPath, setPythonBinPath] = useState<string | undefined>(
     undefined
   )
@@ -39,6 +41,7 @@ export const App: React.FC = () => {
         setHasData(data.data.hasData)
         setIsPythonExtensionInstalled(data.data.isPythonExtensionInstalled)
         setNeedsGitInitialized(data.data.needsGitInitialized)
+        setNeedsGitCommit(data.data.needsGitCommit)
         setProjectInitialized(data.data.projectInitialized)
         setPythonBinPath(data.data.pythonBinPath)
       },
@@ -48,6 +51,7 @@ export const App: React.FC = () => {
         setHasData,
         setIsPythonExtensionInstalled,
         setNeedsGitInitialized,
+        setNeedsGitCommit,
         setProjectInitialized,
         setPythonBinPath
       ]
@@ -70,6 +74,10 @@ export const App: React.FC = () => {
     })
   }
 
+  const showScmPanel = () => {
+    sendMessage({ type: MessageFromWebviewType.SHOW_SCM_PANEL })
+  }
+
   const installDvc = () => {
     sendMessage({ type: MessageFromWebviewType.INSTALL_DVC })
   }
@@ -109,6 +117,10 @@ export const App: React.FC = () => {
     )
   }
 
+  if (needsGitCommit) {
+    return <NeedsGitCommit showScmPanel={showScmPanel} />
+  }
+
   if (hasData === undefined) {
     return <EmptyState>Loading Project...</EmptyState>
   }

webview/src/setup/components/NeedsGitCommit.tsx

@@ -0,0 +1,20 @@
+import React from 'react'
+import { EmptyState } from '../../shared/components/emptyState/EmptyState'
+import { Button } from '../../shared/components/button/Button'
+
+type NeedsGitCommitProps = { showScmPanel: () => void }
+
+export const NeedsGitCommit: React.FC<NeedsGitCommitProps> = ({
+  showScmPanel
+}) => (
+  <EmptyState>
+    <div>
+      <h1>No Git commits detected</h1>
+      <p>
+        At least one commit is required to enable DVC&apos;s experiments and
+        plots functionality.
+      </p>
+      <Button text="Create a Commit" onClick={showScmPanel} />
+    </div>
+  </EmptyState>
+)