fix: Add safeguards for addToTrace (#1490)

Author: ellisong

docs/warning-codes.md

@@ -120,4 +120,6 @@
 ### 59
 `Session replay harvested before a session trace payload could be sent. This could be problematic for replays that rely on a trace`
 ### 60
-`Session trace aborted`
+`Session trace aborted`
+### 61
+`Timestamps must be non-negative and end time cannot be before start time.`

src/loaders/api/addToTrace.js

@@ -4,6 +4,7 @@
  */
 import { originTime } from '../../common/constants/runtime'
 import { handle } from '../../common/event-emitter/handle'
+import { warn } from '../../common/util/console'
 import { FEATURE_NAMES } from '../features/features'
 import { ADD_TO_TRACE } from './constants'
 import { setupAPI } from './sharedHandlers'
@@ -20,6 +21,11 @@ export function setupAddToTraceAPI (agent) {
       t: 'api'
     }
 
+    if (report.s < 0 || report.e < 0 || report.e < report.s) {
+      warn(61, { start: report.s, end: report.e })
+      return
+    }
+
     handle('bstApi', [report], undefined, FEATURE_NAMES.sessionTrace, agent.ee)
   }, agent)
 }

tests/components/api.test.js

@@ -154,6 +154,40 @@ describe('API tests', () => {
         const payload = handleModule.handle.mock.calls.find(callArr => callArr[0] === 'bstApi')[1][0]
         expect(payload.e - payload.s).toEqual(1000) // end - start was 1000ms apart in API call
       })
+
+      test('should return error code for negative timestamps', () => {
+        agent.addToTrace({
+          name: 'Event Name',
+          start: Date.now(),
+          end: -1000,
+          origin: 'Origin of event'
+        })
+
+        expect(console.debug).toHaveBeenCalledTimes(1)
+        expect(console.debug).toHaveBeenLastCalledWith(expect.stringContaining('New Relic Warning: https://github.com/newrelic/newrelic-browser-agent/blob/main/docs/warning-codes.md#61'), expect.any(Object))
+
+        agent.addToTrace({
+          name: 'Event Name',
+          start: -1234,
+          end: Date.now() + 1000,
+          origin: 'Origin of event'
+        })
+
+        expect(console.debug).toHaveBeenCalledTimes(2)
+        expect(console.debug).toHaveBeenLastCalledWith(expect.stringContaining('New Relic Warning: https://github.com/newrelic/newrelic-browser-agent/blob/main/docs/warning-codes.md#61'), expect.any(Object))
+      })
+
+      test('should return error code for end time before start time', () => {
+        agent.addToTrace({
+          name: 'Event Name',
+          start: Date.now() + 2000,
+          end: Date.now() + 1000,
+          origin: 'Origin of event'
+        })
+
+        expect(console.debug).toHaveBeenCalled()
+        expect(console.debug).toHaveBeenLastCalledWith(expect.stringContaining('New Relic Warning: https://github.com/newrelic/newrelic-browser-agent/blob/main/docs/warning-codes.md#61'), expect.any(Object))
+      })
     })
 
     describe('addRelease', () => {