Merge pull request #254 from coderoad/improve-logging

Improve logging

Author: ShMcK

src/actions/utils/loadWatchers.ts

@@ -1,7 +1,7 @@
 import * as chokidar from 'chokidar'
 import * as vscode from 'vscode'
 import { COMMANDS } from '../../editor/commands'
-import environment from '../../environment'
+import { WORKSPACE_ROOT } from '../../environment'
 
 // NOTE: vscode createFileWatcher doesn't seem to detect changes outside of vscode
 // such as `npm install` of a package. Went with chokidar instead
@@ -26,7 +26,7 @@ const loadWatchers = (watchers: string[]) => {
       // see how glob patterns are used in VSCode (not like a regex)
       // https://code.visualstudio.com/api/references/vscode-api#GlobPattern
       const fsWatcher: chokidar.FSWatcher = chokidar.watch(watcher, {
-        cwd: environment.WORKSPACE_ROOT,
+        cwd: WORKSPACE_ROOT,
         interval: 1000,
       })
 

src/actions/utils/openFiles.ts

@@ -20,7 +20,7 @@ const openFiles = async (files: string[]) => {
       // ensure the panel is redrawn on the right side first
       vscode.commands.executeCommand(COMMANDS.OPEN_WEBVIEW)
     } catch (error) {
-      console.log(`Failed to open file ${filePath}`, error)
+      console.log(`Failed to open file ${filePath}: ${error.message}`)
     }
   }
 }

src/actions/utils/runCommands.ts

@@ -15,7 +15,7 @@ const runCommands = async (commands: string[], send: (action: T.Action) => void)
     try {
       result = await exec(command)
     } catch (error) {
-      console.log(error)
+      console.log(`Test failed: ${error.message}`)
       send({ type: 'COMMAND_FAIL', payload: { process: { ...process, status: 'FAIL' } } })
       return
     }

src/channel/index.ts

@@ -14,7 +14,7 @@ import { openWorkspace, checkWorkspaceEmpty } from '../services/workspace'
 import { readFile } from 'fs'
 import { join } from 'path'
 import { promisify } from 'util'
-import environment from '../environment'
+import { WORKSPACE_ROOT } from '../environment'
 
 const readFileAsync = promisify(readFile)
 
@@ -45,12 +45,12 @@ class Channel implements Channel {
     const actionType: string = typeof action === 'string' ? action : action.type
     // const onError = (error: T.ErrorMessage) => this.send({ type: 'ERROR', payload: { error } })
 
-    // console.log(`ACTION: ${actionType}`)
+    logger(`EXT RECEIVED: "${actionType}"`)
 
     switch (actionType) {
       case 'EDITOR_STARTUP':
         // check if a workspace is open, otherwise nothing works
-        const noActiveWorksapce = !environment.WORKSPACE_ROOT.length
+        const noActiveWorksapce = !WORKSPACE_ROOT.length
         if (noActiveWorksapce) {
           const error: E.ErrorMessage = {
             type: 'NoWorkspaceFound',
@@ -260,7 +260,7 @@ class Channel implements Channel {
       })
 
       // log error to console for safe keeping
-      console.log(`ERROR:\n ${errorMarkdown}`)
+      logger(`ERROR:\n ${errorMarkdown}`)
 
       if (errorMarkdown) {
         // add a clearer error message for the user
@@ -270,6 +270,9 @@ class Channel implements Channel {
 
     // action may be an object.type or plain string
     const actionType: string = typeof action === 'string' ? action : action.type
+
+    logger(`EXT TO CLIENT: "${actionType}"`)
+
     switch (actionType) {
       case 'TEST_PASS':
         const tutorial = this.context.tutorial.get()

src/environment.ts

@@ -2,25 +2,22 @@ require('dotenv').config({
   path: './web-app/.env',
 })
 
-import * as vscode from 'vscode'
 import { getWorkspaceRoot } from './services/workspace'
 
-interface Environment {
-  VERSION: string
-  NODE_ENV: string
-  LOG: boolean
-  API_URL: string
-  SENTRY_DSN: string | null
-  WORKSPACE_ROOT: string
-}
+// CodeRoad version
+export const VERSION: string = process.env.npm_package_version || 'unknown'
 
-const environment: Environment = {
-  VERSION: process.env.VERSION || 'unknown',
-  NODE_ENV: process.env.NODE_ENV || 'production',
-  LOG: (process.env.LOG || '').toLowerCase() === 'true',
-  API_URL: process.env.REACT_APP_GQL_URI || '',
-  SENTRY_DSN: process.env.SENTRY_DSN || null,
-  WORKSPACE_ROOT: getWorkspaceRoot(),
-}
+// Node env
+export type Env = 'test' | 'local' | 'development' | 'production'
+// @ts-ignore
+export const NODE_ENV: Env = process.env.NODE_ENV || 'production'
 
-export default environment
+// toggle logging in development
+export const LOG: boolean =
+  (process.env.REACT_APP_LOG || '').toLowerCase() === 'true' && process.env.NODE_ENV !== 'production'
+
+// error logging tool
+export const SENTRY_DSN: string | null = process.env.SENTRY_DSN || null
+
+// uri path to the users project workspace
+export const WORKSPACE_ROOT: string = getWorkspaceRoot()

src/services/logger/index.ts

@@ -1,7 +1,7 @@
-import enviroment from '../../environment'
+import { LOG } from '../../environment'
 
 const logger = (message: string | string[]) => {
-  if (!enviroment.LOG) {
+  if (!LOG) {
     return
   }
   if (Array.isArray(message)) {

src/services/node/index.ts

@@ -2,16 +2,16 @@ import { exec as cpExec } from 'child_process'
 import * as fs from 'fs'
 import { join } from 'path'
 import { promisify } from 'util'
-import environment from '../../environment'
+import { WORKSPACE_ROOT } from '../../environment'
 
 const asyncExec = promisify(cpExec)
 
 export const exec = (cmd: string): Promise<{ stdout: string; stderr: string }> | never => {
   return asyncExec(cmd, {
-    cwd: environment.WORKSPACE_ROOT,
+    cwd: WORKSPACE_ROOT,
   })
 }
 
 export const exists = (...paths: string[]): boolean | never => {
-  return fs.existsSync(join(environment.WORKSPACE_ROOT, ...paths))
+  return fs.existsSync(join(WORKSPACE_ROOT, ...paths))
 }

src/services/sentry/init.ts

@@ -1,9 +1,9 @@
 import { init } from '@sentry/node'
-import environment from '../../environment'
+import { SENTRY_DSN, NODE_ENV } from '../../environment'
 
-if (environment.SENTRY_DSN) {
+if (SENTRY_DSN) {
   init({
-    dsn: environment.SENTRY_DSN,
-    environment: environment.NODE_ENV,
+    dsn: SENTRY_DSN,
+    environment: NODE_ENV,
   })
 }

src/services/sentry/onError.ts

@@ -1,11 +1,11 @@
 import * as sentry from '@sentry/node'
 // import { Scope } from '@sentry/hub'
-import environment from '../../environment'
+import { VERSION } from '../../environment'
 
 const onError = (error: Error) => {
   // set user scope https://docs.sentry.io/enriching-error-data/scopes/?platform=node
   sentry.withScope((scope: any) => {
-    scope.setTag('VERSION', environment.VERSION)
+    scope.setTag('VERSION', VERSION)
     // if (user) {
     //   scope.setUser({
     //     id: user.id,

src/services/workspace/index.ts

@@ -1,7 +1,7 @@
 import * as vscode from 'vscode'
 import * as fs from 'fs'
 import { promisify } from 'util'
-import environment from '../../environment'
+import { WORKSPACE_ROOT } from '../../environment'
 
 const readDir = promisify(fs.readdir)
 
@@ -13,7 +13,7 @@ export const openWorkspace = () => {
 export const checkWorkspaceEmpty = async () => {
   let files
   try {
-    files = await readDir(environment.WORKSPACE_ROOT)
+    files = await readDir(WORKSPACE_ROOT)
   } catch (error) {
     throw new Error('Failed to check workspace')
   }