Merge pull request #455 from coderoad/fix/error-messages

move error messages to client

Author: ShMcK

errors/FailedToConnectToGitRepo.md

@@ -3,6 +3,5 @@ export { default as onTutorialConfigNew } from './onTutorialConfigNew'
 export { default as onTutorialConfigContinue } from './onTutorialConfigContinue'
 export { default as onValidateSetup } from './onValidateSetup'
 export { default as onRunReset } from './onRunReset'
-export { default as onErrorPage } from './onErrorPage'
 export { runTest } from './onTest'
 export { onOpenLogs } from './onOpenLogs'

errors/GitNotFound.md

@@ -28,9 +28,6 @@ let sendToClient = (action: T.Action): void => {
 // This makes it easier to pass the send
 // function throughout the codebase
 export const send = (action: T.Action): void => {
-  // load error page if error action is triggered
-  actions.onErrorPage(action)
-
   logger(`EXT TO CLIENT: "${typeof action === 'string' ? action : action.type}"`)
 
   if (action) sendToClient(action)

errors/GitProjectAlreadyExists.md

@@ -0,0 +1,12 @@
+{
+  "FailedToConnectToGitRepo": "### Failed to Connect to Git Repo\n\nThere are several possible causes:\n\n- you may not be connected to the internet or have an unstable connection.\n- you may not have access permission to the remote tutorial repo.\n- the remote tutorial repo may not exist at the provided location",
+  "GitNotFound": "### Git Not Found\n\nMake sure you have Git installed.\n\nSee the [Git docs](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) for help.",
+  "GitProjectAlreadyExists": "### Git Remote Already Exists\n\nHave you started this tutorial before in this workspace? The Git remote already exists.\n\nConsider deleting your `.git` folder and restarting.",
+  "GitRemoteAlreadyExists": "### Git Project Already Exists\n\nCodeRoad requires an empty Git project.\n\nOpen a new workspace to start a tutorial.",
+  "MissingTutorialDependency": "### Missing Tutorial Dependency\n\nThe tutorial cannot run because it a dependency is not yet installed. Install the dependency and click \"Check Again\".",
+  "NoWorkspaceFound": "### Open a Workspace Folder\n\nCodeRoad requires a workspace folder to run. Open a new workspace and re-launch CodeRoad.",
+  "UnknownError": "### Unknown Error\n\nSorry! An unknown error occurred.\n\nPlease help out by posting an issue at github.com/coderoad/coderoad-vscode/issues/new/choose!",
+  "UnmetExtensionVersion": "### Unmet Extension Version\n\nVSCode extension version is below requirements. Update VSCode to use CodeRoad.",
+  "UnmetTutorialDependency": "### Unmet Tutorial Dependency\n\nTutorial cannot run because a dependency version doesn't match. Install the correct dependency and click \"Check Again\".",
+  "WorkspaceNotEmpty": "### Select An Empty VSCode Workspace\n\nStart a project in an empty folder.\n\nOnce selected, the extension will close and need to be re-started."
+}

errors/GitRemoteAlreadyExists.md

@@ -1,10 +1,12 @@
 import * as T from 'typings'
 import * as TT from 'typings/tutorial'
+import * as E from 'typings/error'
 import { assign, send } from 'xstate'
 import * as selectors from '../../selectors'
 import getStepNext from './utils/stepNext'
 import getNext from './utils/getNext'
 import logger from 'services/logger'
+import errors from '../../errors/en.json'
 
 export const setStart = assign({
   env: (context: T.MachineContext, event: T.MachineEvent) => {
@@ -73,8 +75,23 @@ export const reset = assign({
 
 export const setError = assign({
   error: (context: T.MachineContext, event: T.MachineEvent): any => {
-    const message: string | null = event.payload.error
-    return message
+    const error: string | null | E.ErrorMessage = event.payload.error
+    if (error) {
+      if (typeof error === 'string') {
+        console.log(`ERROR: ${error}`)
+        return error
+      } else if (error.type) {
+        const errorMessage = errors[error.type]
+        const content = errorMessage || ''
+        const message = `${content}\n\n${error.message || ''}`
+        console.log(`ERROR: ${message}`)
+        return {
+          ...error,
+          message,
+        }
+      }
+    }
+    return null
   },
 })