V7: Rename filters -> redacted keys

CHANGELOG.md

@@ -33,6 +33,7 @@
 - Add static `Bugsnag` client interface [#685](https://github.com/bugsnag/bugsnag-js/pull/685)
 - Add `getUser()` and `setUser()` methods to `Session` [#692](https://github.com/bugsnag/bugsnag-js/pull/692)
 - Ensure automatic context is not used when `setContext(null)` has been called [#694](https://github.com/bugsnag/bugsnag-js/pull/694)
+- Rename `filters` option to `redactedKeys` [#704](https://github.com/bugsnag/bugsnag-js/pull/704)
 
 ## 6.5.1 (2020-01-08)
 

packages/browser/types/test/fixtures/all-options.ts

@@ -25,7 +25,7 @@ Bugsnag.init({
   user: null,
   metadata: {},
   logger: undefined,
-  filters: ["foo",/bar/],
+  redactedKeys: ["foo",/bar/],
   collectUserIp: true,
   maxEvents: 10
 })

packages/core/config.js

@@ -114,7 +114,7 @@ module.exports.schema = {
         true
       ))
   },
-  filters: {
+  redactedKeys: {
     defaultValue: () => ['password'],
     message: 'should be an array of strings|regexes',
     validate: value =>

packages/core/types/common.d.ts

@@ -14,7 +14,7 @@ export interface Config {
   enabledBreadcrumbTypes?: BreadcrumbType[];
   enabledReleaseStages?: string[];
   endpoints?: { notify: string; sessions: string };
-  filters?: Array<string | RegExp>;
+  redactedKeys?: Array<string | RegExp>;
   onBreadcrumb?: OnBreadcrumbCallback | OnBreadcrumbCallback[];
   onError?: OnErrorCallback | OnErrorCallback[];
   onSession?: OnSessionCallback | OnSessionCallback[];

packages/delivery-expo/delivery.js

@@ -41,7 +41,7 @@ module.exports = (client, fetch = global.fetch) => {
 
       let body, opts
       try {
-        body = payload.event(event, client._config.filters)
+        body = payload.event(event, client._config.redactedKeys)
         opts = {
           method: 'POST',
           headers: {
@@ -71,7 +71,7 @@ module.exports = (client, fetch = global.fetch) => {
 
       let body, opts
       try {
-        body = payload.session(session, client._config.filters)
+        body = payload.session(session, client._config.redactedKeys)
         opts = {
           method: 'POST',
           headers: {

packages/delivery-expo/test/delivery.test.js

@@ -66,7 +66,7 @@ describe('delivery: expo', () => {
       const config = {
         apiKey: 'aaaaaaaa',
         endpoints: { notify: `http://0.0.0.0:${server.address().port}/notify/` },
-        filters: []
+        redactedKeys: []
       }
       delivery({ _config: config, _logger: noopLogger }, fetch).sendEvent(payload, (err) => {
         expect(err).toBe(null)
@@ -100,7 +100,7 @@ describe('delivery: expo', () => {
       const config = {
         apiKey: 'aaaaaaaa',
         endpoints: { notify: 'blah', sessions: `http://0.0.0.0:${server.address().port}/sessions/` },
-        filters: []
+        redactedKeys: []
       }
       delivery({ _config: config, _logger: noopLogger }, fetch).sendSession(payload, (err) => {
         expect(err).toBe(null)
@@ -136,7 +136,7 @@ describe('delivery: expo', () => {
     const config = {
       apiKey: 'aaaaaaaa',
       endpoints: { notify: 'http://0.0.0.0:9999/notify/' },
-      filters: []
+      redactedKeys: []
     }
     let didLog = false
     const log = () => { didLog = true }
@@ -170,7 +170,7 @@ describe('delivery: expo', () => {
       const config = {
         apiKey: 'aaaaaaaa',
         endpoints: { notify: `http://0.0.0.0:${server.address().port}/notify/` },
-        filters: []
+        redactedKeys: []
       }
       let didLog = false
       const log = () => { didLog = true }
@@ -202,7 +202,7 @@ describe('delivery: expo', () => {
     const config = {
       apiKey: 'aaaaaaaa',
       endpoints: { sessions: 'http://0.0.0.0:9999/sessions/' },
-      filters: []
+      redactedKeys: []
     }
     let didLog = false
     const log = () => { didLog = true }
@@ -238,7 +238,7 @@ describe('delivery: expo', () => {
       const config = {
         apiKey: 'aaaaaaaa',
         endpoints: { notify: `http://0.0.0.0:${server.address().port}/notify/` },
-        filters: []
+        redactedKeys: []
       }
       let didLog = false
       const log = () => { didLog = true }
@@ -276,7 +276,7 @@ describe('delivery: expo', () => {
       const config = {
         apiKey: 'aaaaaaaa',
         endpoints: { notify: `http://0.0.0.0:${server.address().port}/notify/` },
-        filters: []
+        redactedKeys: []
       }
       let didLog = false
       const log = () => { didLog = true }
@@ -306,7 +306,7 @@ describe('delivery: expo', () => {
     const config = {
       apiKey: 'aaaaaaaa',
       endpoints: { notify: 'https://some-address.com' },
-      filters: []
+      redactedKeys: []
     }
     delivery({ _config: config, _logger: noopLogger }, fetch).sendEvent(payload, (err) => {
       expect(err).not.toBeTruthy()
@@ -388,7 +388,7 @@ describe('delivery: expo', () => {
     const config = {
       apiKey: 'aaaaaaaa',
       endpoints: { notify: 'http://some-address.com' },
-      filters: []
+      redactedKeys: []
     }
     let n = 0
     const _done = () => {

packages/delivery-node/delivery.js

@@ -18,7 +18,7 @@ module.exports = (client) => ({
           'Bugsnag-Payload-Version': '4',
           'Bugsnag-Sent-At': isoDate()
         },
-        body: payload.event(event, client._config.filters),
+        body: payload.event(event, client._config.redactedKeys),
         agent: client._config.agent
       }, (err, body) => _cb(err))
     } catch (e) {
@@ -40,7 +40,7 @@ module.exports = (client) => ({
           'Bugsnag-Payload-Version': '1',
           'Bugsnag-Sent-At': isoDate()
         },
-        body: payload.session(session, client._config.filters),
+        body: payload.session(session, client._config.redactedKeys),
         agent: client._config.agent
       }, err => _cb(err))
     } catch (e) {

packages/delivery-node/test/delivery.test.js

@@ -34,7 +34,7 @@ describe('delivery:node', () => {
       const config = {
         apiKey: 'aaaaaaaa',
         endpoints: { notify: `http://0.0.0.0:${server.address().port}/notify/` },
-        filters: []
+        redactedKeys: []
       }
       delivery({ _logger: {}, _config: config }).sendEvent(payload, (err) => {
         expect(err).toBe(null)
@@ -62,7 +62,7 @@ describe('delivery:node', () => {
       const config = {
         apiKey: 'aaaaaaaa',
         endpoints: { notify: 'blah', sessions: `http://0.0.0.0:${server.address().port}/sessions/` },
-        filters: []
+        redactedKeys: []
       }
       delivery({ _logger: {}, _config: config }).sendSession(payload, (err) => {
         expect(err).toBe(null)
@@ -86,7 +86,7 @@ describe('delivery:node', () => {
     const config = {
       apiKey: 'aaaaaaaa',
       endpoints: { notify: 'http://0.0.0.0:9999/notify/' },
-      filters: []
+      redactedKeys: []
     }
     let didLog = false
     const log = () => { didLog = true }
@@ -109,7 +109,7 @@ describe('delivery:node', () => {
       const config = {
         apiKey: 'aaaaaaaa',
         endpoints: { notify: `http://0.0.0.0:${server.address().port}/notify/` },
-        filters: []
+        redactedKeys: []
       }
       let didLog = false
       const log = () => { didLog = true }
@@ -134,7 +134,7 @@ describe('delivery:node', () => {
       const config = {
         apiKey: 'aaaaaaaa',
         endpoints: { notify: `http://0.0.0.0:${server.address().port}/notify/` },
-        filters: []
+        redactedKeys: []
       }
       let didLog = false
       const log = () => { didLog = true }

packages/delivery-x-domain-request/delivery.js

@@ -11,7 +11,7 @@ module.exports = (client, win = window) => ({
     req.open('POST', url)
     setTimeout(() => {
       try {
-        req.send(payload.event(event, client._config.filters))
+        req.send(payload.event(event, client._config.redactedKeys))
       } catch (e) {
         client._logger.error(e)
         cb(e)
@@ -27,7 +27,7 @@ module.exports = (client, win = window) => ({
     req.open('POST', url)
     setTimeout(() => {
       try {
-        req.send(payload.session(session, client._config.filters))
+        req.send(payload.session(session, client._config.redactedKeys))
       } catch (e) {
         this._logger.error(e)
         cb(e)

packages/delivery-x-domain-request/test/delivery.test.js

@@ -28,7 +28,7 @@ describe('delivery:XDomainRequest', () => {
     const config = {
       apiKey: 'aaaaaaaa',
       endpoints: { notify: '/echo/' },
-      filters: []
+      redactedKeys: []
     }
     delivery({ logger: {}, _config: config }, window).sendEvent(payload, (err) => {
       expect(err).toBe(null)
@@ -67,7 +67,7 @@ describe('delivery:XDomainRequest', () => {
     const config = {
       apiKey: 'aaaaaaaa',
       endpoints: { notify: '/echo/', sessions: '/sessions/' },
-      filters: []
+      redactedKeys: []
     }
     delivery({ logger: {}, _config: config }, window).sendSession(payload, (err) => {
       expect(err).toBe(null)

packages/delivery-xml-http-request/delivery.js

@@ -14,7 +14,7 @@ module.exports = (client, win = window) => ({
       req.setRequestHeader('Bugsnag-Api-Key', event.apiKey || client._config.apiKey)
       req.setRequestHeader('Bugsnag-Payload-Version', '4')
       req.setRequestHeader('Bugsnag-Sent-At', isoDate())
-      req.send(payload.event(event, client._config.filters))
+      req.send(payload.event(event, client._config.redactedKeys))
     } catch (e) {
       client._logger.error(e)
     }
@@ -31,7 +31,7 @@ module.exports = (client, win = window) => ({
       req.setRequestHeader('Bugsnag-Api-Key', client._config.apiKey)
       req.setRequestHeader('Bugsnag-Payload-Version', '1')
       req.setRequestHeader('Bugsnag-Sent-At', isoDate())
-      req.send(payload.session(session, client._config.filters))
+      req.send(payload.session(session, client._config.redactedKeys))
     } catch (e) {
       client._logger.error(e)
     }

packages/delivery-xml-http-request/test/delivery.test.js

@@ -33,7 +33,7 @@ describe('delivery:XMLHttpRequest', () => {
     const config = {
       apiKey: 'aaaaaaaa',
       endpoints: { notify: '/echo/' },
-      filters: []
+      redactedKeys: []
     }
     delivery({ logger: {}, _config: config }, { XMLHttpRequest }).sendEvent(payload, (err) => {
       expect(err).toBe(null)
@@ -79,7 +79,7 @@ describe('delivery:XMLHttpRequest', () => {
     const config = {
       apiKey: 'aaaaaaaa',
       endpoints: { notify: '/', sessions: '/echo/' },
-      filters: []
+      redactedKeys: []
     }
     delivery({ _config: config, logger: {} }, { XMLHttpRequest }).sendSession(payload, (err) => {
       expect(err).toBe(null)

packages/expo/types/test/fixtures/all-options.ts

@@ -25,5 +25,5 @@ Bugsnag.init({
   user: null,
   metadata: {},
   logger: undefined,
-  filters: ["foo",/bar/]
+  redactedKeys: ["foo",/bar/]
 })

test/browser/features/fixtures/redaction/script/b.html

@@ -9,7 +9,7 @@
       Bugsnag.init({
         apiKey: API_KEY,
         endpoints: { notify: ENDPOINT, sessions: '/noop' },
-        filters: [ 'api_key', 'secret' ]
+        redactedKeys: [ 'api_key', 'secret' ]
       })
     </script>
   </head>

test/browser/features/fixtures/redaction/script/c.html

@@ -9,7 +9,7 @@
       Bugsnag.init({
         apiKey: API_KEY,
         endpoints: { notify: ENDPOINT, sessions: '/noop' },
-        filters: [ 'stacktrace', 'secret' ]
+        redactedKeys: [ 'stacktrace', 'secret' ]
       })
     </script>
   </head>

test/browser/features/fixtures/redaction/script/d.html

@@ -9,7 +9,7 @@
       Bugsnag.init({
         apiKey: API_KEY,
         endpoints: { notify: ENDPOINT, sessions: '/noop' },
-        filters: [ /details\d/ ]
+        redactedKeys: [ /details\d/ ]
       })
     </script>
   </head>