Merge pull request #3 from stitchng/develop

Develop

CHANGELOG.md

@@ -1,3 +1,10 @@
+<a name="0.2.0"></a>
+# 0.2.0 (2019-03-12)
+
+- Fixed Error (Session is not instatiated)
+- Changed middleware type/category to **Global Middleware**
+- Updated dependency `@bugsnag/js` from _5.0.1_ to _6.0.0_ in the package.json file
+
 <a name="0.1.5"></a>
 # 0.1.5 (2019-03-05)
 

README.md

@@ -103,7 +103,7 @@ MIT
 
 ```bash
 
-	npm run lint
+    npm run lint
 
     npm run test
 

instructions.md

@@ -10,12 +10,12 @@ const providers = [
 
 ## Registering middleware
 
-Register the following middleware inside `start/kernel.js` file.
+Register the following middleware inside `start/kernel.js` file. Place the bugsnag middleware after the 'Adonis/Middleware/AuthInit' middleware
 
 ```js
-const serverMiddleware = [
-  'Adonis/Middleware/Static',
+const globalMiddleware = [
   ...
+  'Adonis/Middleware/AuthInit',
   'Adonis/Middleware/BugSnagUser'
 ]
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "adonisjs-bugsnag",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "description": "BugSnag addon/plugin package for AdonisJS 4.0+ apps",
   "main": "index.js",
   "files": [
@@ -44,7 +44,7 @@
   },
   "dependencies": {
     "@adonisjs/generic-exceptions": "^2.0.1",
-    "@bugsnag/js": "^5.0.1",
+    "@bugsnag/js": "^6.0.0",
     "debug": "^3.1.2"
   },
   "devDependencies": {

providers/BugSnagProvider.js

@@ -17,7 +17,7 @@ class BugSnagProvider extends ServiceProvider {
 
     this.app.bind('Adonis/Middleware/BugSnagUser', (app) => {
       let BugSnagUser = require('../src/BugSnag/Middleware/BugSnagUser')
-      return new BugSnagUser(app.use('Adonis/Src/Config'))
+      return new BugSnagUser(this.app.use('Adonis/Addons/BugSnag'))
     })
   }
 }

src/BugSnag/Middleware/BugSnagUser.js

@@ -1,16 +1,23 @@
 'use strict'
 
 class BugSnagUser {
-  constructor (Config) {
-    this.appSecret = Config.get('app.appKey')
+  constructor (bugsnag) {
+    this.notifierWrapper = bugsnag
   }
 
-  async handle ({ request, auth }, next) {
-    let _user = await (typeof (auth.getUser) === 'function' ? auth.getUser() : Promise.resolve(null))
+  async handle ({ request, session, auth }, next) {
+    try {
+      let _user = await (typeof (auth.getUser) === 'function' ? auth.getUser() : Promise.resolve(null))
 
-    request.user = _user
+      this.notifierWrapper.setAuthUser(_user)
+      this.notifierWrapper.setContext(request, session)
+    } catch (err) {
+      ;
+    }
 
     await next()
+
+    // this.notifierWrapper.leaveBreadcrumb('"name"', '{metaData}', '"type"', 'timestamp')
   }
 }
 

src/BugSnag/index.js

@@ -20,25 +20,27 @@ class BugSnagAPIClient {
     }
   }
 
-  setAuthUser (user) {
+  setAuthUser (user = null) {
     this.notifier.user = user
   }
 
-  setContext (request) {
+  setContext (request = {}, session = {}) {
     this.notifier.context = {
-      routeName: typeof request.currentRoute === 'function' ? request.currentRoute() : { middleware: [], verb: [] }
+      route: typeof request.currentRoute === 'function' ? request.currentRoute() : {},
+      cookies: typeof request.cookies === 'function' ? request.cookies() : {},
+      session: typeof session.all === 'function' ? session.all() : {}
     }
   }
 
-  addMetaData (metaData) {
+  addMetaData (metaData = {}) {
     this.notifier.metaData = metaData
   }
 
-  notify (error, request, metaData, extraMetaData) {
-    if (request.user) {
-      this.setAuthUser(request.user)
-    }
+  setDevice (device = {}) {
+    this.notifier.device = device
+  }
 
+  notify (error, request, metaData, extraMetaData) {
     if (metaData) {
       this.addMetaData(metaData)
     }

test/bugsnagnotifier.spec.js

@@ -33,6 +33,8 @@ test.group('AdonisJS BugSnag Test(s)', (group) => {
     const AdonisBugSnagNotifierInstance = new BugSnag(BugSnagJSNotifierStub, this.config, this.helpers, this.env)
 
     assert.isTrue(typeof AdonisBugSnagNotifierInstance.setAuthUser === 'function')
+    assert.isTrue(typeof AdonisBugSnagNotifierInstance.setContext === 'function')
+    assert.isTrue(typeof AdonisBugSnagNotifierInstance.setDevice === 'function')
     assert.isTrue(typeof AdonisBugSnagNotifierInstance.addMetaData === 'function')
     assert.isTrue(typeof AdonisBugSnagNotifierInstance.notify === 'function')
     assert.isTrue(AdonisBugSnagNotifierInstance.notifier !== null)
@@ -68,4 +70,28 @@ test.group('AdonisJS BugSnag Test(s)', (group) => {
     assert.isTrue(!!AdonisBugSnagNotifierInstance.notifier.report)
     assert.deepEqual(AdonisBugSnagNotifierInstance.notifier.report.request, { url: 'https://127.0.0.1:333/dashboard/user' })
   })
+
+  test('device and context method works as expected', (assert) => {
+    this.config.set('bugsnag.apiKey', 'q24cd5317608c5353de0794576ee015q')
+    this.config.set('bugsnag.trackViaSession', false)
+    this.env.set('NODE_ENV', 'development')
+
+    const request = {
+      url: () => 'https://127.0.0.1:333/dashboard/user',
+      cookies: () => ({ oid: 11 }),
+      user: null
+    }
+
+    const session = {
+      all: () => ({ locked: 0 })
+    }
+
+    const AdonisBugSnagNotifierInstance = new BugSnag(BugSnagJSNotifierStub, this.config, this.helpers, this.env)
+    AdonisBugSnagNotifierInstance.setContext(request, session)
+    AdonisBugSnagNotifierInstance.setDevice({ os: 'Linux Darwin' })
+
+    assert.isTrue(!!AdonisBugSnagNotifierInstance.notifier.context)
+    assert.deepEqual(AdonisBugSnagNotifierInstance.notifier.context.session, { locked: 0 })
+    assert.deepEqual(AdonisBugSnagNotifierInstance.notifier.device, { os: 'Linux Darwin' })
+  })
 })

test/middleware.spec.js

@@ -10,19 +10,42 @@
 */
 
 const test = require('japa')
-const { Config, setupResolver } = require('@adonisjs/sink')
-// const { resolver } = require('@adonisjs/fold')
+const path = require('path')
+const { Config, Env, Helpers } = require('@adonisjs/sink')
+const { ioc } = require('@adonisjs/fold')
+const NotifierStub = require('./setup/notifier-stub.js')
 const BugSnagMiddleware = require('../src/BugSnag/Middleware/BugSnagUser.js')
+const BugSnag = require('../src/BugSnag/index.js')
 
 test.group('AdonisJS BugSnag Middleware Test(s)', (group) => {
   group.before(() => {
-    setupResolver()
+    ioc.singleton('Adonis/Src/Config', () => {
+      let config = new Config()
+      config.set('bugsnag.apiKey', 'q24cd5317608c5353de0794576ee015q')
+      config.set('bugsnag.trackViaSession', false)
+      return config
+    })
+
+    ioc.singleton('Adonis/Src/Env', () => {
+      let env = new Env()
+      env.set('NODE_ENV', 'development')
+      return env
+    })
+
+    ioc.singleton('Adonis/Src/Helpers', () => {
+      let helpers = new Helpers(path.join(__dirname, '..'))
+      return helpers
+    })
   })
 
   test('setup the request user upon handling', async (assert) => {
     const request = {
       url: () => 'https://127.0.0.1:333/dashboard/user',
-      cookie: () => {}
+      cookies: () => ({ _gd1: 'opened' })
+    }
+
+    const session = {
+      all: () => ({ adonis_auth: '1' })
     }
 
     const auth = {
@@ -31,16 +54,20 @@ test.group('AdonisJS BugSnag Middleware Test(s)', (group) => {
       }
     }
 
-    const context = { request, auth }
-    const middleware = new BugSnagMiddleware(new Config())
+    const context = { request, auth, session }
+    const bugsnag = new BugSnag(NotifierStub, ioc.use('Adonis/Src/Config'), ioc.use('Adonis/Src/Helpers'), ioc.use('Adonis/Src/Env'))
+    const middleware = new BugSnagMiddleware(bugsnag)
 
     middleware
       .handle(context, async function () {
         return true
       })
       .then(() => {
-        assert.isTrue(!!request.user)
-        assert.equal(request.user.id, 1)
+        assert.isTrue(!!bugsnag.notifier.user)
+        assert.isTrue(!!bugsnag.notifier.context)
+        assert.isTrue(!!bugsnag.notifier.context.session)
+        assert.deepEqual(bugsnag.notifier.context.cookies, { _gd1: 'opened' })
+        assert.equal(bugsnag.notifier.user.id, 1)
       })
   })
 })

test/provider.spec.js

@@ -0,0 +1,48 @@
+'use strict'
+
+/*
+ * adonis-bugsnag
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+
+const test = require('japa')
+const path = require('path')
+const { Config, Env, Helpers } = require('@adonisjs/sink')
+const { ioc } = require('@adonisjs/fold')
+const BugSnagMiddleware = require('../src/BugSnag/Middleware/BugSnagUser.js')
+const BugSnagProvider = require('../providers/BugSnagProvider.js')
+const BugSnag = require('../src/BugSnag/index.js')
+
+test.group('AdonisJS BugSnag Provider Test(s)', (group) => {
+  group.before(() => {
+    ioc.singleton('Adonis/Src/Config', () => {
+      let config = new Config()
+      config.set('bugsnag.apiKey', 'q24cd5317608c5353de0794576ee015q')
+      config.set('bugsnag.trackViaSession', false)
+      return config
+    })
+
+    ioc.singleton('Env', () => {
+      let env = new Env()
+      env.set('NODE_ENV', 'development')
+      return env
+    })
+
+    ioc.singleton('Helpers', () => {
+      let helpers = new Helpers(path.join(__dirname, '..'))
+      return helpers
+    })
+  })
+
+  test('provider instance registers instance(s) as expected', async (assert) => {
+    let provider = new BugSnagProvider(ioc)
+    provider.register()
+
+    assert.instanceOf(ioc.use('Adonis/Addons/BugSnag'), BugSnag)
+    assert.instanceOf(ioc.use('Adonis/Middleware/BugSnagUser'), BugSnagMiddleware)
+  })
+})