fix(rum-core): add extra check in applyFilters

Author: david-luna

.nvmrc

@@ -1 +1 @@
-20
+20.19.0

package.json

@@ -195,7 +195,6 @@
     "@elastic/apm-rum-vue": "file:packages/rum-vue"
   },
   "engines": {
-    "node": ">=12 <=16",
-    "npm": "6"
+    "node": "^20.19.0 || ^22.12.0 || >=24.0.0"
   }
 }

packages/rum-core/src/common/config-service.js

@@ -26,6 +26,7 @@
 import { getCurrentScript, setLabel, merge, extend, isUndefined } from './utils'
 import EventHandler from './event-handler'
 import { CONFIG_CHANGE, LOCAL_CONFIG_KEY } from './constants'
+import { __DEV__ } from '../state'
 
 function getConfigFromScript() {
   var script = getCurrentScript()
@@ -124,11 +125,23 @@ class Config {
   }
 
   applyFilters(data) {
-    for (var i = 0; i < this.filters.length; i++) {
-      data = this.filters[i](data)
-      if (!data) {
+    try {
+      for (var i = 0; i < this.filters.length; i++) {
+        data = this.filters[i](data)
+        if (!data) {
+          return
+        }
+      }
+      data.transactions = data.transactions.filter(t => t)
+      data.errors = data.errors.filter(e => e)
+      if (data.transactions.length === 0 && data.errors.length === 0) {
         return
       }
+    } catch (e) {
+      if (__DEV__) {
+        console.log('[Elastic APM] Error applying filters for RUM payload', e)
+      }
+      return
     }
     return data
   }

packages/rum-core/test/common/config-service.spec.js

@@ -68,29 +68,54 @@ describe('ConfigService', function () {
   })
 
   it('should addFilter correctly', function () {
+    var rawPayload = { transactions: [{}], errors: [{}] }
+    var filterPayload1 = { transactions: [{}, {}], errors: [{}, {}] }
+    var filterPayload2 = { transactions: [{}, {}, {}], errors: [{}, {}, {}] }
     expect(function () {
       configService.addFilter('test')
     }).toThrow()
 
     configService.addFilter(function (testArg) {
-      expect(testArg).toBe('hamid-test')
-      return 'hamid-test-1'
+      expect(testArg).toBe(rawPayload)
+      return filterPayload1
     })
 
     configService.addFilter(function (testArg) {
-      expect(testArg).toBe('hamid-test-1')
-      return 'hamid-test-2'
+      expect(testArg).toBe(filterPayload1)
+      return filterPayload2
     })
 
-    var result = configService.applyFilters('hamid-test')
-    expect(result).toBe('hamid-test-2')
+    var result = configService.applyFilters(rawPayload)
+    expect(result).toBe(filterPayload2)
 
     configService.addFilter(function () {})
     configService.addFilter(function () {
       throw new Error('Out of reach!')
     })
 
-    result = configService.applyFilters('hamid-test')
+    result = configService.applyFilters(payload)
+    expect(result).toBeUndefined()
+  })
+
+  it('should applyFilters without throwing', function () {
+    var rawPayload = { transactions: [{}], errors: [{}] }
+
+    configService.addFilter(function () {
+      throw new Error('Should now throw!')
+    })
+
+    var result = configService.applyFilters(rawPayload)
+    expect(result).toBeUndefined()
+  })
+
+  it('should applyFilters and filter empty payloads', function () {
+    var rawPayload = { transactions: [{}], errors: [{}] }
+
+    configService.addFilter(function () {
+      return { transactions: [], errors: [] }
+    })
+
+    var result = configService.applyFilters(rawPayload)
     expect(result).toBeUndefined()
   })
 

packages/rum/src/index.d.ts

@@ -187,7 +187,35 @@ interface ServiceFactory {
 }
 
 type FilterFn = (payload: Payload) => Payload | boolean | void
-type Payload = { [key: string]: any }
+// type Payload = { [key: string]: any }
+type SpanPayload = {
+  trace_id: string
+  transaction_id: string
+  parent_id: string
+  id: string
+  type: string
+  subtype: string
+  name: string
+}
+type TransactionPayload = {
+  trace_id: string
+  id: string
+  type: string
+  name: string
+  spans: SpanPayload[]
+}
+type ErrorPayload = {
+  id: string
+  exception: {
+    type: string
+    message: string
+  }
+}
+type Payload = {
+  transactions: TransactionPayload[]
+  errors: ErrorPayload[]
+  [key: string]: any
+}
 
 type TaskId = string | number
 type LabelValue = string | number | boolean