Merge pull request #313 from bugsnag/ip-option

Add option to prevent IP collection

browser/config.js

@@ -6,5 +6,10 @@ module.exports = {
     },
     message: '(string) releaseStage should be set',
     validate: value => typeof value === 'string' && value.length
+  },
+  collectUserIp: {
+    defaultValue: () => true,
+    message: '(boolean) collectUserIp should true/false',
+    validate: value => value === true || value === false
   }
 }

browser/index.js

@@ -19,7 +19,8 @@ const plugins = {
   'navigation breadcrumbs': require('./plugins/navigation-breadcrumbs'),
   'interaction breadcrumbs': require('./plugins/interaction-breadcrumbs'),
   'inline script content': require('./plugins/inline-script-content'),
-  'sessions': require('./plugins/sessions')
+  'sessions': require('./plugins/sessions'),
+  'ip': require('./plugins/ip')
 }
 
 const transports = {
@@ -72,6 +73,7 @@ module.exports = (opts, userPlugins = []) => {
   bugsnag.use(plugins['inline script content'])
   bugsnag.use(plugins['throttle'])
   bugsnag.use(plugins['sessions'])
+  bugsnag.use(plugins['ip'])
 
   // optional browser-specific plugins
 

browser/plugins/ip.js

@@ -0,0 +1,12 @@
+/*
+ * Prevent collection of user IPs
+ */
+module.exports = {
+  init: (client) => {
+    if (client.config.collectUserIp) return
+    client.config.beforeSend.push(report => {
+      report.user = { id: '[NOT COLLECTED]', ...report.user }
+      report.request = { clientIp: '[NOT COLLECTED]', ...report.request }
+    })
+  }
+}

browser/plugins/test/ip.test.js

@@ -0,0 +1,55 @@
+// magical jasmine globals
+const { describe, it, expect } = global
+
+const plugin = require('../ip')
+
+const Client = require('../../../base/client')
+const schema = { ...require('../../../base/config').schema, ...require('../../config') }
+const VALID_NOTIFIER = { name: 't', version: '0', url: 'http://' }
+
+describe('plugin: ip', () => {
+  it('does nothing when collectUserIp=true', () => {
+    const client = new Client(VALID_NOTIFIER, schema)
+    const payloads = []
+    client.configure({ apiKey: 'API_KEY_YEAH' })
+    client.use(plugin)
+
+    client.transport({ sendReport: (logger, config, payload) => payloads.push(payload) })
+    client.notify(new Error('noooo'), {
+      beforeSend: report => { report.request = { 'some': 'detail' } }
+    })
+
+    expect(payloads.length).toEqual(1)
+    expect(payloads[0].events[0].request).toEqual({ 'some': 'detail' })
+  })
+
+  it('doesn’t overwrite an existing user id', () => {
+    const client = new Client(VALID_NOTIFIER, schema)
+    const payloads = []
+    client.configure({ apiKey: 'API_KEY_YEAH', collectUserIp: false })
+    client.use(plugin)
+
+    client.user = { id: 'foobar' }
+
+    client.transport({ sendReport: (logger, config, payload) => payloads.push(payload) })
+    client.notify(new Error('noooo'))
+
+    expect(payloads.length).toEqual(1)
+    expect(payloads[0].events[0].user).toEqual({ id: 'foobar' })
+    expect(payloads[0].events[0].request).toEqual({ clientIp: '[NOT COLLECTED]' })
+  })
+
+  it('redacts user IP if none is provided', () => {
+    const client = new Client(VALID_NOTIFIER, schema)
+    const payloads = []
+    client.configure({ apiKey: 'API_KEY_YEAH', collectUserIp: false })
+    client.use(plugin)
+
+    client.transport({ sendReport: (logger, config, payload) => payloads.push(payload) })
+    client.notify(new Error('noooo'))
+
+    expect(payloads.length).toEqual(1)
+    expect(payloads[0].events[0].user).toEqual({ id: '[NOT COLLECTED]' })
+    expect(payloads[0].events[0].request).toEqual({ clientIp: '[NOT COLLECTED]' })
+  })
+})