Merge branch 'integration/typescript' into PLAT-13701-int-range

Author: AnastasiiaSvietlova

packages/core/package.json

@@ -9,7 +9,6 @@
       "import": "./dist/index.mjs",
       "default": "./dist/index.cjs"
     },
-    "./lib/json-payload": "./src/lib/json-payload.js",
     "./lib/es-utils/assign": "./src/lib/es-utils/assign.js",
     "./lib/es-utils/includes": "./src/lib/es-utils/includes.js",
     "./lib/es-utils/filter": "./src/lib/es-utils/filter.js",

packages/core/src/common.ts

@@ -60,16 +60,6 @@ export interface Logger {
   error: (...args: any[]) => void
 }
 
-export interface EventPayload {
-  apiKey: string
-  notifier: {
-    name: string
-    version: string
-    url: string
-  }
-  events: Event[]
-}
-
 export interface SessionPayload {
   notifier: {
     name: string
@@ -169,7 +159,8 @@ export interface Notifier {
 }
 
 export interface EventDeliveryPayload {
-  apiKey: string
+  apiKey?: string
+  payloadVersion?: string
   notifier: Notifier
   events: Event[]
 }
@@ -184,6 +175,7 @@ export interface SessionDeliveryPayload {
     user?: User
   }>
 }
+
 export interface Delivery {
   sendEvent(payload: EventDeliveryPayload, cb: (err?: Error | null) => void): void
   sendSession(session: SessionDeliveryPayload, cb: (err?: Error | null) => void): void
@@ -206,4 +198,4 @@ export interface BugsnagError {
   errorMessage: string
   type: string
   stacktrace: Stackframe[]
-}
+}

packages/core/src/index.ts

@@ -4,6 +4,7 @@ export { default as Event } from './event'
 export { default as Session } from './session'
 export { default as schema } from './config'
 export { default as cloneClient } from './lib/clone-client'
+export { default as jsonPayload } from './lib/json-payload'
 export { default as intRange } from './lib/validators/int-range'
 
 export * from './common'

packages/core/src/lib/json-payload.d.ts

@@ -0,0 +1,37 @@
+import jsonStringify from '@bugsnag/safe-json-stringify'
+import type { EventDeliveryPayload, SessionDeliveryPayload } from "../common";
+
+type RedactedKey = string | RegExp
+
+interface JsonPayload {
+  event: (event: EventDeliveryPayload, redactedKeys?: RedactedKey[]) => string
+  session: (session: SessionDeliveryPayload, redactedKeys?: RedactedKey[]) => string
+}
+
+const EVENT_REDACTION_PATHS = [
+  'events.[].metaData',
+  'events.[].breadcrumbs.[].metaData',
+  'events.[].request'
+]
+
+const jsonPayload: JsonPayload = {
+  event: (event, redactedKeys) => {
+    let payload = jsonStringify(event, null, null, { redactedPaths: EVENT_REDACTION_PATHS, redactedKeys })
+    if (payload.length > 10e5) {
+      event.events[0]._metadata = {
+        notifier:
+`WARNING!
+Serialized payload was ${payload.length / 10e5}MB (limit = 1MB)
+metadata was removed`
+      }
+      payload = jsonStringify(event, null, null, { redactedPaths: EVENT_REDACTION_PATHS, redactedKeys })
+    }
+    return payload
+  },
+  session: (session): string => {
+    const payload = jsonStringify(session, null, null)
+    return payload
+  }
+}
+
+export default jsonPayload

packages/core/src/lib/json-payload.js

@@ -0,0 +1,11 @@
+declare module '@bugsnag/safe-json-stringify' {
+    export default function stringify(
+        value: any,
+        replacer?: null | ((this: any, key: string, value: any) => any), 
+        space?: null | string | number,
+        options?: {
+            redactedKeys?: Array<string | RegExp>;
+            redactedPaths?: string[];
+        }
+    ): string;
+}

packages/core/src/lib/json-payload.ts

@@ -1,8 +1,11 @@
+import type { EventDeliveryPayload, SessionDeliveryPayload } from '../../src/common'
+import Event from '../../src/event'
 import jsonPayload from '../../src/lib/json-payload'
+import Session from '../../src/session'
 
 function makeBigObject () {
-  var big: Record<string, string> = {}
-  var i = 0
+  const big: Record<string, string> = {}
+  let i = 0
   while (JSON.stringify(big).length < 2 * 10e5) {
     big['entry' + i] = 'long repetitive string'.repeat(1000)
     i++
@@ -12,91 +15,61 @@ function makeBigObject () {
 
 describe('jsonPayload.event', () => {
   it('safe stringifies the payload and redacts values from certain paths of the supplied keys', () => {
+    const event = new Event('CheckoutError', 'Failed load tickets')
+    event.setUser('123', 'jim@bugsnag.com', 'Jim Bug')
+    event.request = { apiKey: '245b39ebd3cd3992e85bffc81c045924' }
+
     expect(jsonPayload.event({
-      api_key: 'd145b8e5afb56516423bc4d605e45442',
-      events: [
-        {
-          errorMessage: 'Failed load tickets',
-          errorClass: 'CheckoutError',
-          user: {
-            name: 'Jim Bug',
-            email: 'jim@bugsnag.com'
-          },
-          request: {
-            api_key: '245b39ebd3cd3992e85bffc81c045924'
-          }
-        }
-      ]
-    }, ['api_key'])).toBe('{"api_key":"d145b8e5afb56516423bc4d605e45442","events":[{"errorMessage":"Failed load tickets","errorClass":"CheckoutError","user":{"name":"Jim Bug","email":"jim@bugsnag.com"},"request":{"api_key":"[REDACTED]"}}]}')
+      apiKey: 'd145b8e5afb56516423bc4d605e45442',
+      notifier: { name: 'Bugsnag', version: '1.0.0', url: 'https://bugsnag.com' },
+      events: [event]
+    }, ['apiKey'])).toBe('{"apiKey":"d145b8e5afb56516423bc4d605e45442","notifier":{"name":"Bugsnag","version":"1.0.0","url":"https://bugsnag.com"},"events":[{"payloadVersion":"4","exceptions":[{"errorClass":"CheckoutError","errorMessage":"Failed load tickets","type":"browserjs","stacktrace":[],"message":"Failed load tickets"}],"severity":"warning","unhandled":false,"severityReason":{"type":"handledException"},"app":{},"device":{},"request":{"apiKey":"[REDACTED]"},"breadcrumbs":[],"metaData":{},"user":{"id":"123","email":"jim@bugsnag.com","name":"Jim Bug"},"featureFlags":[]}]}')
   })
 
   it('strips the metaData of the first event if the payload is too large', () => {
-    const payload = {
-      api_key: 'd145b8e5afb56516423bc4d605e45442',
-      events: [
-        {
-          errorMessage: 'Failed load tickets',
-          errorClass: 'CheckoutError',
-          user: {
-            name: 'Jim Bug',
-            email: 'jim@bugsnag.com'
-          },
-          request: {
-            api_key: '245b39ebd3cd3992e85bffc81c045924'
-          },
-          _metadata: {}
-        }
-      ]
-    }
+    const event = new Event('CheckoutError', 'Failed load tickets')
+    event.setUser('123', 'jim@bugsnag.com', 'Jim Bug')
+    event.request = { apiKey: '245b39ebd3cd3992e85bffc81c045924' }
+    event._metadata = { 'big thing': makeBigObject() }
 
-    payload.events[0]._metadata = { 'big thing': makeBigObject() }
+    const payload: EventDeliveryPayload = {
+      apiKey: 'd145b8e5afb56516423bc4d605e45442',
+      notifier: { name: 'Bugsnag', version: '1.0.0', url: 'https://bugsnag.com' },
+      events: [event]
+    }
 
-    expect(jsonPayload.event(payload)).toBe('{"api_key":"d145b8e5afb56516423bc4d605e45442","events":[{"errorMessage":"Failed load tickets","errorClass":"CheckoutError","user":{"name":"Jim Bug","email":"jim@bugsnag.com"},"request":{"api_key":"245b39ebd3cd3992e85bffc81c045924"},"_metadata":{"notifier":"WARNING!\\nSerialized payload was 2.003435MB (limit = 1MB)\\nmetadata was removed"}}]}')
+    expect(jsonPayload.event(payload)).toBe('{"apiKey":"d145b8e5afb56516423bc4d605e45442","notifier":{"name":"Bugsnag","version":"1.0.0","url":"https://bugsnag.com"},"events":[{"payloadVersion":"4","exceptions":[{"errorClass":"CheckoutError","errorMessage":"Failed load tickets","type":"browserjs","stacktrace":[],"message":"Failed load tickets"}],"severity":"warning","unhandled":false,"severityReason":{"type":"handledException"},"app":{},"device":{},"request":{"apiKey":"245b39ebd3cd3992e85bffc81c045924"},"breadcrumbs":[],"metaData":{"notifier":"WARNING!\\nSerialized payload was 2.003764MB (limit = 1MB)\\nmetadata was removed"},"user":{"id":"123","email":"jim@bugsnag.com","name":"Jim Bug"},"featureFlags":[]}]}')
   })
 
   it('does not attempt to strip any other data paths from the payload to reduce the size', () => {
+    const event1 = new Event('CheckoutError', 'Failed load tickets')
+    event1.setUser('123', 'jim@bugsnag.com', 'Jim Bug')
+    event1.request = { apiKey: '245b39ebd3cd3992e85bffc81c045924' }
+    
+    // Second event metadata should not be stripped, only the first
+    const event2 = new Event('APIError', 'Request failed')
+    event2._metadata = { 'big thing': makeBigObject() }
+    
     const payload = {
-      api_key: 'd145b8e5afb56516423bc4d605e45442',
-      events: [
-        {
-          errorMessage: 'Failed load tickets',
-          errorClass: 'CheckoutError',
-          user: {
-            name: 'Jim Bug',
-            email: 'jim@bugsnag.com'
-          },
-          _metadata: {}
-        },
-        {
-          errorMessage: 'Request failed',
-          errorClass: 'APIError',
-          _metadata: {}
-        }
-      ]
+      apiKey: 'd145b8e5afb56516423bc4d605e45442',
+      notifier: { name: 'Bugsnag', version: '1.0.0', url: 'https://bugsnag.com' },
+      events: [event1, event2]
     }
-    payload.events[1]._metadata = { 'big thing': makeBigObject() }
 
     expect(jsonPayload.event(payload).length).toBeGreaterThan(10e5)
   })
 })
 
 describe('jsonPayload.session', () => {
   it('safe stringifies the payload', () => {
-    expect(jsonPayload.session({
-      api_key: 'd145b8e5afb56516423bc4d605e45442',
-      events: [
-        {
-          errorMessage: 'Failed load tickets',
-          errorClass: 'CheckoutError',
-          user: {
-            name: 'Jim Bug',
-            email: 'jim@bugsnag.com'
-          },
-          request: {
-            api_key: '245b39ebd3cd3992e85bffc81c045924'
-          }
-        }
-      ]
-    }, ['api_key'])).toBe('{"api_key":"d145b8e5afb56516423bc4d605e45442","events":[{"errorMessage":"Failed load tickets","errorClass":"CheckoutError","user":{"name":"Jim Bug","email":"jim@bugsnag.com"},"request":{"api_key":"245b39ebd3cd3992e85bffc81c045924"}}]}')
+    const session = new Session('123', new Date('2012-12-21T00:00:00.0000Z'))
+    const sessionPayload: SessionDeliveryPayload = {
+      app: { version: '1.0.0' },
+      device: { id: '123' },
+      notifier: { name: 'Bugsnag', version: '1.0.0', url: 'https://bugsnag.com' },
+      sessions: [session]
+    }
+
+    expect(jsonPayload.session(sessionPayload)).toBe('{"app":{"version":"1.0.0"},"device":{"id":"123"},"notifier":{"name":"Bugsnag","version":"1.0.0","url":"https://bugsnag.com"},"sessions":[{"id":"123","startedAt":"2012-12-21T00:00:00.000Z","events":{"handled":0,"unhandled":0}}]}')
   })
 })

packages/core/src/safe-json-stringify.d.ts

@@ -9,5 +9,5 @@
     "emitDeclarationOnly": true,
     "declarationDir": "dist/types",
   },
-  "include": ["src/**/*.ts", "src/**/*.js"]
+  "include": ["src/**/*.ts", "src/**/*.js", "safe-json-stringify.d.ts"]
 }

packages/core/test/lib/json-payload.test.ts

@@ -1,5 +1,5 @@
 const { createHash } = require('crypto')
-const payload = require('@bugsnag/core/lib/json-payload')
+const { jsonPayload } = require('@bugsnag/core')
 const PayloadQueue = require('./queue')
 const PayloadDeliveryLoop = require('./payload-loop')
 const NetworkStatus = require('@bugsnag/electron-network-status')
@@ -74,9 +74,9 @@ const delivery = (client, filestore, net, app) => {
   const statusUpdater = new NetworkStatus(stateManagerPlugin, net, app)
   const { queues } = initRedelivery(filestore.getPaths(), statusUpdater, client._logger, send)
 
-  const hash = payload => {
+  const hash = jsonPayload => {
     const h = createHash('sha1')
-    h.update(payload)
+    h.update(jsonPayload)
     return h.digest('hex')
   }
 
@@ -91,7 +91,7 @@ const delivery = (client, filestore, net, app) => {
 
       let body, opts
       try {
-        body = payload.event(event, client._config.redactedKeys)
+        body = jsonPayload.event(event, client._config.redactedKeys)
         opts = {
           url,
           method: 'POST',
@@ -131,7 +131,7 @@ const delivery = (client, filestore, net, app) => {
 
       let body, opts
       try {
-        body = payload.session(session, client._config.redactedKeys)
+        body = jsonPayload.session(session, client._config.redactedKeys)
         opts = {
           url,
           method: 'POST',