Merge pull request #80 from ShMcK/feature/sentry

Feature/sentry

Author: ShMcK

package-lock.json

@@ -31,6 +31,8 @@
     "watch": "tsc -watch -p ./"
   },
   "dependencies": {
+    "@sentry/electron": "^1.2.0",
+    "@sentry/node": "^5.11.0",
     "chokidar": "^3.3.0",
     "dotenv": "^8.2.0",
     "jsdom": "^15.2.1"
@@ -48,6 +50,7 @@
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.9.0",
     "eslint-plugin-prettier": "^3.1.2",
+    "graphql": "^14.5.8",
     "prettier": "^1.19.1",
     "ts-jest": "^24.3.0",
     "typescript": "^3.7.4",

package.json

@@ -4,6 +4,7 @@ import * as git from '../services/git'
 import loadWatchers from './utils/loadWatchers'
 import openFiles from './utils/openFiles'
 import runCommands from './utils/runCommands'
+import onError from '../services/sentry/onError'
 
 const setupActions = async (
   workspaceRoot: vscode.WorkspaceFolder,
@@ -16,7 +17,7 @@ const setupActions = async (
   if (commits) {
     for (const commit of commits) {
       // TODO handle git errors
-      await git.loadCommit(commit)
+      await git.loadCommit(commit).catch(onError)
     }
   }
 
@@ -27,7 +28,7 @@ const setupActions = async (
   loadWatchers(watchers || [], workspaceRoot.uri)
 
   // 4. run command
-  await runCommands(commands || [], send)
+  await runCommands(commands || [], send).catch(onError)
 }
 
 export default setupActions

src/actions/setupActions.ts

@@ -2,14 +2,15 @@ import * as T from 'typings'
 import * as vscode from 'vscode'
 import * as git from '../services/git'
 import setupActions from './setupActions'
+import onError from '../services/sentry/onError'
 
 const solutionActions = async (
   workspaceRoot: vscode.WorkspaceFolder,
   stepActions: T.StepActions,
   send: (action: T.Action) => void,
 ): Promise<void> => {
   await git.clear()
-  return setupActions(workspaceRoot, stepActions, send)
+  return setupActions(workspaceRoot, stepActions, send).catch(onError)
 }
 
 export default solutionActions

src/actions/solutionActions.ts

@@ -4,6 +4,7 @@ import * as vscode from 'vscode'
 import { COMMANDS } from '../editor/commands'
 import languageMap from '../editor/languageMap'
 import * as git from '../services/git'
+import onError from '../services/sentry/onError'
 
 interface TutorialConfigParams {
   config: T.TutorialConfig
@@ -13,13 +14,14 @@ interface TutorialConfigParams {
 
 const tutorialConfig = async (
   { config, alreadyConfigured }: TutorialConfigParams,
-  onError: (msg: T.ErrorMessage) => void,
+  handleError: (msg: T.ErrorMessage) => void,
 ) => {
   if (!alreadyConfigured) {
     // setup git, add remote
     await git.initIfNotExists().catch(error => {
+      onError(new Error('Git not found'))
       // failed to setup git
-      onError({
+      handleError({
         title: error.message,
         description:
           'Be sure you install Git. See the docs for help https://git-scm.com/book/en/v2/Getting-Started-Installing-Git',
@@ -28,7 +30,8 @@ const tutorialConfig = async (
 
     // TODO if remote not already set
     await git.setupRemote(config.repo.uri).catch(error => {
-      onError({ title: error.message, description: 'Remove your current Git project and restarting' })
+      onError(error)
+      handleError({ title: error.message, description: 'Remove your current Git project and restarting' })
     })
   }
 

src/actions/tutorialConfig.ts

@@ -3,10 +3,14 @@ require('dotenv').config({
 })
 
 interface Environment {
+  VERSION: string
+  NODE_ENV: string
   LOG: boolean
 }
 
 const environment: Environment = {
+  VERSION: process.env.VERSION || 'unknown',
+  NODE_ENV: process.env.NODE_ENV || 'production',
   LOG: (process.env.LOG || '').toLowerCase() === 'true',
 }
 

src/environment.ts

@@ -1,3 +1,6 @@
+// init error logging
+import './services/sentry/init'
+
 import Editor from './editor'
 
 // vscode editor

src/extension.ts

@@ -1,5 +1,6 @@
 import node from '../node'
 import logger from '../logger'
+import onError from '../sentry/onError'
 
 const gitOrigin = 'coderoad'
 
@@ -76,13 +77,18 @@ export async function version(): Promise<string | boolean> {
       return `${major}${minor}${patch}`
     }
   }
-  throw new Error('Git not installed. Please install Git')
+  const message = 'Git not installed. Please install Git'
+  const error = new Error(message)
+  onError(error)
+  throw error
 }
 
 async function init(): Promise<void> {
   const { stderr } = await node.exec('git init')
   if (stderr) {
-    throw new Error('Error initializing Git')
+    const error = new Error('Error initializing Git')
+    onError(error)
+    throw error
   }
 }
 

src/services/git/index.ts

@@ -3,6 +3,7 @@ import * as fs from 'fs'
 import { join } from 'path'
 import { promisify } from 'util'
 import * as vscode from 'vscode'
+import onError from '../sentry/onError'
 
 const asyncExec = promisify(cpExec)
 
@@ -12,7 +13,9 @@ class Node {
     // set workspace root for node executions
     const workspaceRoots: vscode.WorkspaceFolder[] | undefined = vscode.workspace.workspaceFolders
     if (!workspaceRoots || !workspaceRoots.length) {
-      throw new Error('No workspace root path')
+      const error = new Error('No workspace root path')
+      onError(error)
+      throw error
     }
     const workspaceRoot: vscode.WorkspaceFolder = workspaceRoots[0]
     this.workspaceRootPath = workspaceRoot.uri.path

src/services/node/index.ts

@@ -0,0 +1,7 @@
+import { init } from '@sentry/node'
+import environment from '../../environment'
+
+init({
+  dsn: 'https://df4a6ae19e8b44ed9a87ae4432dab9df@sentry.io/1889368',
+  environment: environment.NODE_ENV,
+})