Merge pull request #1072 from bugsnag/anonymous-device-id

[PLAT-5050] Add anonymous device ID

Author: imjoehaines

Diff for: CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## TBD
 
+### Added
+
+- (browser): Attach an anonymous device ID to error reports and sessions when the new `generateAnonymousId` option is enabled. [#1072](https://github.com/bugsnag/bugsnag-js/pull/1072)
+
 ### Changed
 
 - (react-native): Allow plugins to be set in the JS layer. [#1064](https://github.com/bugsnag/bugsnag-js/pull/1064)

Diff for: packages/browser/test/index.test.ts

@@ -131,7 +131,8 @@ describe('browser notifier', () => {
       logger: undefined,
       redactedKeys: ['foo', /bar/],
       collectUserIp: true,
-      maxEvents: 10
+      maxEvents: 10,
+      generateAnonymousId: false
     })
 
     Bugsnag.notify(new Error('123'), (event) => {

Diff for: packages/browser/types/bugsnag.d.ts

@@ -3,6 +3,7 @@ import { Client, Config, BugsnagStatic } from '@bugsnag/core'
 interface BrowserConfig extends Config {
   maxEvents?: number
   collectUserIp?: boolean
+  generateAnonymousId?: boolean
 }
 
 interface BrowserBugsnagStatic extends BugsnagStatic {

Diff for: packages/plugin-browser-device/device.js

@@ -1,4 +1,28 @@
+const cuid = require('@bugsnag/cuid')
 const assign = require('@bugsnag/core/lib/es-utils/assign')
+const BUGSNAG_ANONYMOUS_ID_KEY = 'bugsnag-anonymous-id'
+
+const getDeviceId = () => {
+  try {
+    const storage = window.localStorage
+
+    let id = storage.getItem(BUGSNAG_ANONYMOUS_ID_KEY)
+
+    // If we get an ID, make sure it looks like a valid cuid. The length can
+    // fluctuate slightly, so some leeway is built in
+    if (id && /^c[a-z0-9]{20,32}$/.test(id)) {
+      return id
+    }
+
+    id = cuid()
+
+    storage.setItem(BUGSNAG_ANONYMOUS_ID_KEY, id)
+
+    return id
+  } catch (err) {
+    // If localStorage is not available (e.g. because it's disabled) then give up
+  }
+}
 
 /*
  * Automatically detects browser device details
@@ -19,6 +43,10 @@ module.exports = (nav = navigator, screen = window.screen) => ({
           : 'portrait'
     }
 
+    if (client._config.generateAnonymousId) {
+      device.id = getDeviceId()
+    }
+
     client.addOnSession(session => {
       session.device = assign({}, session.device, device)
     })
@@ -31,5 +59,12 @@ module.exports = (nav = navigator, screen = window.screen) => ({
         { time: new Date() }
       )
     }, true)
+  },
+  configSchema: {
+    generateAnonymousId: {
+      validate: value => value === true || value === false,
+      defaultValue: () => true,
+      message: 'should be true|false'
+    }
   }
 })