clean up logs

Signed-off-by: shmck <shawn.j.mckay@gmail.com>

Author: ShMcK

src/channel/index.ts

@@ -310,7 +310,7 @@ class Channel implements Channel {
       case 'TEST_PASS':
         const tutorial = this.context.tutorial.get()
         if (!tutorial) {
-          throw new Error('Error with current tutorial')
+          throw new Error('ERROR: Tutorial not found in test run')
         }
         // update local storage stepProgress
         const progress = this.context.progress.setStepComplete(tutorial, action.payload.stepId)
@@ -321,7 +321,7 @@ class Channel implements Channel {
     // send message
     const sentToClient = await this.postMessage(action)
     if (!sentToClient) {
-      throw new Error(`Message post failure: ${JSON.stringify(action)}`)
+      throw new Error(`ERROR: Message post failure: ${JSON.stringify(action)}`)
     }
   }
 }

src/services/logger/index.ts

@@ -1,13 +1,19 @@
 import { LOG } from '../../environment'
 
-const logger = (message: string | string[]) => {
+export type Log = string | object
+
+const logger = (...messages: Log[]): void => {
   if (!LOG) {
     return
   }
-  if (Array.isArray(message)) {
-    message.forEach(console.log)
-  } else {
-    console.log(message)
+  // Inside vscode, you console.log does not allow more than 1 param
+  // to get around it, we can log with multiple log statements
+  for (const message of messages) {
+    if (typeof message === 'object') {
+      console.log(JSON.stringify(message))
+    } else {
+      console.log(message)
+    }
   }
 }
 

web-app/src/components/ErrorBoundary/index.tsx

@@ -10,8 +10,8 @@ class ErrorBoundary extends React.Component {
     // Display fallback UI
     this.setState({ errorMessage: error.message })
     // You can also log the error to an error reporting service
-    logger('ERROR in component:', JSON.stringify(error))
-    logger('ERROR info:', JSON.stringify(info))
+    logger('ERROR in component:', error)
+    logger('ERROR info:', info)
   }
 
   public render() {

web-app/src/components/Router/index.tsx

@@ -59,14 +59,14 @@ const useRouter = (): Output => {
       } else if (Array.isArray(path)) {
         pathMatch = path.some((p) => state.matches(p))
       } else {
-        throw new Error(`Invalid route path ${JSON.stringify(path)}`)
+        throw new Error(`ERROR: Invalid route path: ${JSON.stringify(path)}`)
       }
       if (pathMatch) {
         // @ts-ignore
         return child.props.children
       }
     }
-    const message = `No Route matches for ${JSON.stringify(state)}`
+    const message = `ERROR: No Route matches for ${JSON.stringify(state)}`
     onError(new Error(message))
     console.warn(message)
     return null

web-app/src/services/logger/index.ts

@@ -1,13 +1,19 @@
 import { LOG } from '../../environment'
 
-const logger = (...messages: string[]) => {
+export type Log = string | object
+
+const logger = (...messages: Log[]): void => {
   if (!LOG) {
     return
   }
   // Inside vscode, you console.log does not allow more than 1 param
   // to get around it, we can log with multiple log statements
   for (const message of messages) {
-    console.log(message)
+    if (typeof message === 'object') {
+      console.log(JSON.stringify(message))
+    } else {
+      console.log(message)
+    }
   }
 }