Feature/output channel (coderoad#557)

* send src logs to output channel

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

* send logs from client to ext channel

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

* cleanup onTutorialConfigContinue log

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

* clean up test fail logs

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

* cleanup init logs

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

* update logging across app

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

* only log non-trusted security warnings

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

* clenaup error messages

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

* cleanup action logs

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

Author: ShMcK

src/actions/onOpenLogs.ts

@@ -1,5 +1,5 @@
 import * as T from 'typings'
-import { showOutput } from '../services/testRunner/output'
+import { showOutput } from '../services/logger/output'
 
 export const onOpenLogs = async (action: T.Action): Promise<void> => {
   const channel = action.payload.channel

src/actions/onRunReset.ts

@@ -4,6 +4,7 @@ import Context from '../services/context/context'
 import reset from '../services/reset'
 import * as hooks from '../services/hooks'
 import getCommitHashByPosition from '../services/reset/lastHash'
+import logger from '../services/logger'
 
 type ResetAction = {
   type: 'LATEST' | 'POSITION'
@@ -22,7 +23,7 @@ const onRunReset = async (action: ResetAction, context: Context): Promise<void>
   const branch = tutorial?.config.repo.branch
 
   if (!branch) {
-    console.error('No repo branch found for tutorial')
+    logger('Error: No repo branch found for tutorial')
     return
   }
 

src/actions/onTutorialConfigContinue.ts

@@ -8,7 +8,7 @@ import logger from '../services/logger'
 import { setupWebhook } from '../services/hooks/webhooks'
 
 const onTutorialConfigContinue = async (action: T.Action, context: Context): Promise<void> => {
-  logger('onTutorialConfigContinue', action)
+  logger(`Continuing tutorial from progress: ${JSON.stringify(action.payload)}`)
   try {
     const tutorialToContinue: TT.Tutorial | null = context.tutorial.get()
     if (!tutorialToContinue) {

src/channel.ts

@@ -28,7 +28,14 @@ class Channel implements Channel {
     // action may be an object.type or plain string
     const actionType: string = typeof action === 'string' ? action : action.type
 
-    logger(`EXT RECEIVED: "${actionType}"`)
+    if (actionType === 'CLIENT_LOG') {
+      // logs in web client are not easily visible
+      // it's simpler to log to the "CodeRoad (Logs)" channel
+      logger(action.payload)
+      return
+    }
+
+    logger(actionType)
 
     switch (actionType) {
       case 'EDITOR_STARTUP':

src/commands.ts

@@ -21,15 +21,15 @@ interface CreateCommandProps {
 }
 
 let sendToClient = (action: T.Action): void => {
-  // function is replaced when webclient loads
+  // function is replaced when webview mounts
 }
 
 // This makes it easier to pass the send
 // function throughout the codebase
 export const send = (action: T.Action): void => {
-  logger(`EXT TO CLIENT: "${typeof action === 'string' ? action : action.type}"`)
-
-  if (action) sendToClient(action)
+  // log send of event to client
+  logger(`${typeof action === 'string' ? action : action.type}`)
+  sendToClient(action)
 }
 
 export const createCommands = (commandProps: CreateCommandProps): { [key: string]: any } => {
@@ -75,7 +75,7 @@ export const createCommands = (commandProps: CreateCommandProps): { [key: string
       }
       testRunner = createTestRunner(data, {
         onSuccess: (position: T.Position) => {
-          logger('test pass position', position)
+          logger(`Test pass position: ${JSON.stringify(position)}`)
           // send test pass message back to client
           channel.context.position.set({ ...position, complete: true })
           send({ type: 'TEST_PASS', payload: { position: { ...position, complete: true } } })
@@ -91,7 +91,7 @@ export const createCommands = (commandProps: CreateCommandProps): { [key: string
         },
         onRun: (position: T.Position) => {
           // send test run message back to client
-          send({ type: 'TEST_RUNNING', payload: { position } })
+          send({ type: 'START_TEST', payload: { position } })
         },
         onLoadSubtasks: ({ summary }) => {
           send({ type: 'LOAD_SUBTASK_RESULTS', payload: { summary } })

src/environment.ts

@@ -10,9 +10,6 @@ export type Env = 'test' | 'local' | 'development' | 'production'
 // @ts-ignore
 export const NODE_ENV: Env = process.env.NODE_ENV || 'development'
 
-// toggle logging
-export const LOG = (process.env.CODEROAD_ENABLE_LOG || '').toLowerCase() === 'true'
-
 // error logging tool
 export const INSTRUMENTATION_KEY = '6ff37c76-72f3-48e3-a1b9-d5636f519b7b'
 

src/services/git/index.ts

@@ -9,14 +9,14 @@ const stashAllFiles = async (): Promise<never | void> => {
   // stash files including untracked (eg. newly created file)
   const { stderr } = await exec({ command: `git stash --include-untracked` })
   if (stderr) {
-    console.error(stderr)
+    logger(`Error: ${stderr}`)
     throw new Error('Error stashing files')
   }
 }
 
 const cherryPickCommit = async (commit: string, count = 0): Promise<never | void> => {
   if (count > 1) {
-    console.warn('cherry-pick failed')
+    logger('cherry-pick failed')
     return
   }
   try {
@@ -26,8 +26,8 @@ const cherryPickCommit = async (commit: string, count = 0): Promise<never | void
     if (!stdout) {
       throw new Error('No cherry-pick output')
     }
-  } catch (error) {
-    console.log('cherry-pick-commit failed')
+  } catch (error: any) {
+    logger(`cherry-pick-commit failed: ${error.message}`)
     // stash all files if cherry-pick fails
     await stashAllFiles()
     return cherryPickCommit(commit, ++count)
@@ -50,10 +50,10 @@ export function loadCommit(commit: string): Promise<never | void> {
 export async function saveCommit(message: string): Promise<never | void> {
   const { stdout, stderr } = await exec({ command: `git commit -am '${message}'` })
   if (stderr) {
-    console.error(stderr)
+    logger(`Error: ${stderr}`)
     throw new Error('Error saving progress to Git')
   }
-  logger(['save with commit & continue stdout', stdout])
+  logger(`Commit saved: ${stdout}`)
 }
 
 export async function clear(): Promise<Error | void> {
@@ -63,9 +63,9 @@ export async function clear(): Promise<Error | void> {
     if (!stderr) {
       return
     }
-    console.error(stderr)
-  } catch (error) {
-    console.error(error)
+    logger(`Error: ${stderr}`)
+  } catch (error: any) {
+    logger(`Error: ${error.message}`)
   }
   throw new Error('Error cleaning up current unsaved work')
 }
@@ -127,7 +127,7 @@ export async function addRemote(repo: string): Promise<never | void> {
 
     // validate the response is acceptable
     if (!alreadyExists && !successfulNewBranch) {
-      console.error(stderr)
+      logger(`Error: ${stderr}`)
       throw new Error('Error adding git remote')
     }
   }
@@ -142,7 +142,8 @@ export async function checkRemoteExists(): Promise<boolean> {
     // string match on remote output
     // TODO improve the specificity of this regex
     return !!stdout.match(gitOrigin)
-  } catch (error) {
+  } catch (error: any) {
+    logger(`Warn: ${error.message}`)
     return false
   }
 }
@@ -168,8 +169,9 @@ export async function loadCommitHistory(): Promise<string[]> {
     }
     // string match on remote output
     return stdout.split('\n')
-  } catch (error) {
+  } catch (error: any) {
     // likely no git setup or no commits
+    logger(`Warn: ${error.message}`)
     return []
   }
 }
@@ -189,8 +191,8 @@ export async function getCommitMessage(hash: string): Promise<string | null> {
     }
     // string match on remote output
     return stdout
-  } catch (error) {
-    logger('error', error)
+  } catch (error: any) {
+    logger(`Error: ${error.message}`)
     // likely no git commit message found
     return null
   }
@@ -204,8 +206,8 @@ export async function commitsExistsByMessage(message: string): Promise<boolean>
       return false
     }
     return !!stdout.length
-  } catch (error) {
-    logger('error', error)
+  } catch (error: any) {
+    logger(`Error: ${error.message}`)
     // likely no commit found
     return false
   }

src/services/hooks/utils/openFiles.ts

@@ -1,5 +1,6 @@
 import { join } from 'path'
 import * as vscode from 'vscode'
+import logger from '../../logger'
 
 const openFiles = async (files: string[] = []): Promise<void> => {
   if (!files.length) {
@@ -16,7 +17,7 @@ const openFiles = async (files: string[] = []): Promise<void> => {
       const doc = await vscode.workspace.openTextDocument(absoluteFilePath)
       await vscode.window.showTextDocument(doc, vscode.ViewColumn.One)
     } catch (error: any) {
-      console.log(`Failed to open file ${filePath}: ${error.message}`)
+      logger(`Failed to open file ${filePath}: ${error.message}`)
     }
   }
 }

src/services/hooks/utils/runCommands.ts

@@ -1,5 +1,6 @@
 import { exec } from '../../node'
 import { send } from '../../../commands'
+import logger from '../../logger'
 
 const runCommands = async (commands: string[] = []): Promise<void> => {
   if (!commands.length) {
@@ -14,9 +15,9 @@ const runCommands = async (commands: string[] = []): Promise<void> => {
     let result: { stdout: string; stderr: string }
     try {
       result = await exec({ command })
-      console.log(result)
+      logger(`Command output: ${JSON.stringify(result)}`)
     } catch (error: any) {
-      console.error(`Command failed: ${error.message}`)
+      logger(`Command failed: ${error.message}`)
       send({ type: 'COMMAND_FAIL', payload: { process: { ...process, status: 'FAIL' } } })
       return
     }

src/services/logger/index.ts

@@ -1,18 +1,15 @@
-import { LOG } from '../../environment'
+import { getOutputChannel } from './output'
 
 export type Log = any
 
+const logChannel = getOutputChannel('CodeRoad (Logs)')
+
 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) {
     if (typeof message === 'object') {
-      console.log(JSON.stringify(message))
+      logChannel.appendLine(message)
     } else {
-      console.log(message)
+      logChannel.appendLine(message)
     }
   }
 }