Merge pull request #228 from coderoad/verify-git-installed-on-startup

validate git installed on startup

Author: ShMcK

src/channel/index.ts

@@ -8,6 +8,7 @@ import tutorialConfig from '../actions/tutorialConfig'
 import { COMMANDS } from '../editor/commands'
 import logger from '../services/logger'
 import Context from './context'
+import { version as gitVersion } from '../services/git'
 import { openWorkspace, checkWorkspaceEmpty } from '../services/workspace'
 
 interface Channel {
@@ -106,13 +107,21 @@ class Channel implements Channel {
         // update the current stepId on startup
         vscode.commands.executeCommand(COMMANDS.SET_CURRENT_STEP, action.payload)
         return
-      case 'EDITOR_CHECK_WORKSPACE':
+      case 'EDITOR_VALIDATE_SETUP':
+        // 1. check workspace is selected
         const isEmptyWorkspace = await checkWorkspaceEmpty(this.workspaceRoot.uri.path)
-        if (isEmptyWorkspace) {
-          this.send({ type: 'IS_EMPTY_WORKSPACE' })
-        } else {
+        if (!isEmptyWorkspace) {
           this.send({ type: 'NOT_EMPTY_WORKSPACE' })
+          return
+        }
+        // 2. check Git is installed.
+        // Should wait for workspace before running otherwise requires access to root folder
+        const isGitInstalled = await gitVersion()
+        if (!isGitInstalled) {
+          this.send({ type: 'GIT_NOT_INSTALLED' })
+          return
         }
+        this.send({ type: 'SETUP_VALIDATED' })
         return
       case 'EDITOR_REQUEST_WORKSPACE':
         console.log('request workspace')

src/services/git/index.ts

@@ -69,7 +69,7 @@ export async function clear(): Promise<void> {
   throw new Error('Error cleaning up current unsaved work')
 }
 
-export async function version(): Promise<string | boolean> {
+export async function version(): Promise<string | null> {
   const { stdout, stderr } = await node.exec('git --version')
   if (!stderr) {
     const match = stdout.match(/^git version (\d+\.)?(\d+\.)?(\*|\d+)/)
@@ -79,10 +79,7 @@ export async function version(): Promise<string | boolean> {
       return `${major}${minor}${patch}`
     }
   }
-  const message = 'Git not installed. Please install Git'
-  const error = new Error(message)
-  onError(error)
-  throw error
+  return null
 }
 
 async function init(): Promise<void> {
@@ -95,12 +92,6 @@ async function init(): Promise<void> {
 }
 
 export async function initIfNotExists(): Promise<void> {
-  const hasGit = await version()
-
-  if (!hasGit) {
-    throw new Error('Git must be installed')
-  }
-
   const hasGitInit = node.exists('.git')
   if (!hasGitInit) {
     await init()

typings/index.d.ts

@@ -72,8 +72,9 @@ export interface MachineStateSchema {
         Error: {}
         LoadStoredTutorial: {}
         Start: {}
-        CheckEmptyWorkspace: {}
+        ValidateSetup: {}
         NonEmptyWorkspace: {}
+        GitNotInstalled: {}
         SelectTutorial: {}
         SetupNewTutorial: {}
       }

web-app/src/Routes.tsx

@@ -7,6 +7,7 @@ import SelectTutorialPage from './containers/SelectTutorial'
 import CompletedPage from './containers/Tutorial/CompletedPage'
 import LevelSummaryPage from './containers/Tutorial/LevelPage'
 import SelectEmptyWorkspace from './containers/Check/SelectWorkspace'
+import GitInstalled from './containers/Check/GitInstalled'
 
 const Routes = () => {
   const { context, send, Router, Route } = useRouter()
@@ -26,6 +27,9 @@ const Routes = () => {
         <Route path={['Setup.NonEmptyWorkspace', 'Setup.RequestEmptyWorkspace']}>
           <SelectEmptyWorkspace send={send} />
         </Route>
+        <Route path="Setup.GitNotInstalled">
+          <GitInstalled send={send} />
+        </Route>
         <Route path="Setup.Error">
           <LoadingPage text="Error" context={context} />
         </Route>

web-app/src/containers/Check/GitInstalled.tsx

@@ -0,0 +1,36 @@
+import * as React from 'react'
+import * as T from 'typings'
+import { css, jsx } from '@emotion/core'
+import Button from '../../components/Button'
+
+const styles = {
+  container: {
+    padding: '1rem',
+  },
+}
+
+type Props = {
+  send: (action: T.Action) => void
+}
+
+const GitInstalled = (props: Props) => {
+  const onTryAgain = () => props.send({ type: 'TRY_AGAIN' })
+  return (
+    <div css={styles.container}>
+      <h3>Git Not Installed</h3>
+      <p>
+        Git is required for CodeRun to run. Git is a free open-source distributed version control system. Basically, Git
+        helps you easily save your file system changes.
+      </p>
+      <p>
+        <a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">Learn how to install Git</a>
+      </p>
+      <br />
+      <Button type="secondary" onClick={onTryAgain}>
+        Check Again
+      </Button>
+    </div>
+  )
+}
+
+export default GitInstalled

web-app/src/services/state/actions/editor.ts

@@ -72,9 +72,9 @@ export default (editorSend: any) => ({
   clearStorage(): void {
     editorSend({ type: 'TUTORIAL_CLEAR' })
   },
-  checkEmptyWorkspace() {
+  validateSetup() {
     editorSend({
-      type: 'EDITOR_CHECK_WORKSPACE',
+      type: 'EDITOR_VALIDATE_SETUP',
     })
   },
   requestWorkspaceSelect() {

web-app/src/services/state/machine.ts

@@ -55,18 +55,19 @@ export const createMachine = (options: any) => {
             },
             Start: {
               on: {
-                NEW_TUTORIAL: 'CheckEmptyWorkspace',
+                NEW_TUTORIAL: 'ValidateSetup',
                 CONTINUE_TUTORIAL: {
                   target: '#tutorial-level',
                   actions: ['continueConfig'],
                 },
               },
             },
-            CheckEmptyWorkspace: {
-              onEntry: ['checkEmptyWorkspace'],
+            ValidateSetup: {
+              onEntry: ['validateSetup'],
               on: {
-                IS_EMPTY_WORKSPACE: 'SelectTutorial',
                 NOT_EMPTY_WORKSPACE: 'NonEmptyWorkspace',
+                GIT_NOT_INSTALLED: 'GitNotInstalled',
+                SETUP_VALIDATED: 'SelectTutorial',
               },
             },
             NonEmptyWorkspace: {
@@ -75,7 +76,13 @@ export const createMachine = (options: any) => {
                   target: 'NonEmptyWorkspace',
                   actions: 'requestWorkspaceSelect',
                 },
-                WORKSPACE_LOADED: 'CheckEmptyWorkspace',
+                WORKSPACE_LOADED: 'ValidateSetup',
+              },
+            },
+            // validation 2: git installed
+            GitNotInstalled: {
+              on: {
+                TRY_AGAIN: 'ValidateSetup',
               },
             },
             SelectTutorial: {