fix: ignore PutRumEvents for PerformanceResource events (#712)

Author: williazz

package-lock.json

@@ -99,7 +99,7 @@
         "npm-run-all": "^4.1.5",
         "prettier": "2.8.4",
         "standard-version": "^9.3.2",
-        "testcafe": "^3.3.0",
+        "testcafe": "^3.7.2",
         "testcafe-reporter-html": "^1.4.6",
         "testcafe-reporter-json": "^1.0.0",
         "ts-jest": "^29.0.3",

package.json

@@ -1,8 +1,7 @@
 import { InternalPlugin } from '../InternalPlugin';
 import {
     getResourceFileType,
-    isPutRumEventsCall,
-    shuffle
+    isPutRumEventsCall
 } from '../../utils/common-utils';
 import { ResourceEvent } from '../../events/resource-event';
 import { PERFORMANCE_RESOURCE_EVENT_TYPE } from '../utils/constant';
@@ -56,33 +55,27 @@ export class ResourcePlugin extends InternalPlugin {
     };
 
     recordPerformanceEntries = (list: PerformanceEntryList) => {
-        const recordAll: PerformanceEntry[] = [];
-        const sample: PerformanceEntry[] = [];
-
-        list.filter((e) => e.entryType === RESOURCE)
-            .filter((e) => !this.config.ignore(e))
-            .forEach((event) => {
-                const { name, initiatorType } =
-                    event as PerformanceResourceTiming;
-                const type = getResourceFileType(name, initiatorType);
-                if (this.config.recordAllTypes.includes(type)) {
-                    recordAll.push(event);
-                } else if (this.config.sampleTypes.includes(type)) {
-                    sample.push(event);
-                }
-            });
+        list.forEach((event) => {
+            if (event.entryType !== RESOURCE || this.config.ignore(event)) {
+                // ignore
+                return;
+            }
 
-        // Record all events for resources in recordAllTypes
-        recordAll.forEach((r) =>
-            this.recordResourceEvent(r as PerformanceResourceTiming)
-        );
+            const { name, initiatorType } = event as PerformanceResourceTiming;
+            const type = getResourceFileType(name, initiatorType);
 
-        // Record events from resources in sample until we hit the resource limit
-        shuffle(sample);
-        while (sample.length > 0 && this.eventCount < this.config.eventLimit) {
-            this.recordResourceEvent(sample.pop() as PerformanceResourceTiming);
-            this.eventCount++;
-        }
+            if (this.config.recordAllTypes.includes(type)) {
+                // Record all events for resources in recordAllTypes
+                this.recordResourceEvent(event as PerformanceResourceTiming);
+            } else if (
+                this.config.sampleTypes.includes(type) &&
+                this.eventCount < this.config.eventLimit
+            ) {
+                // Record sample types
+                this.recordResourceEvent(event as PerformanceResourceTiming);
+                this.eventCount++;
+            }
+        });
     };
 
     recordResourceEvent = ({

src/plugins/event-plugins/ResourcePlugin.ts

@@ -34,9 +34,6 @@ describe('ResourcePlugin tests', () => {
     });
 
     test('When resource event is present then event is recorded', async () => {
-        // Setup
-        mockRandom(0); // Retain order in shuffle
-
         const plugin: ResourcePlugin = buildResourcePlugin();
 
         // Run
@@ -60,9 +57,6 @@ describe('ResourcePlugin tests', () => {
     });
 
     test('when recordResourceUrl is false then the resource name is not recorded', async () => {
-        // Setup
-        mockRandom(0); // Retain order in shuffle
-
         const plugin: ResourcePlugin = buildResourcePlugin();
         const mockContext = Object.assign({}, context, {
             config: { ...DEFAULT_CONFIG, recordResourceUrl: false }
@@ -162,28 +156,15 @@ describe('ResourcePlugin tests', () => {
         const plugin: ResourcePlugin = buildResourcePlugin({ eventLimit: 4 });
 
         // Run
-        mockRandom(0.99); // Retain order in shuffle
-        plugin.load(context);
-        mockRandom(0); // Reverse order in shuffle
         plugin.load(context);
 
         // Assert
         expect(record.mock.calls[0][1]).toEqual(
-            expect.objectContaining({
-                targetUrl: imageResourceEventB.name
-            })
-        );
-        expect(record.mock.calls[1][1]).toEqual(
             expect.objectContaining({
                 targetUrl: imageResourceEventA.name
             })
         );
-        expect(record.mock.calls[2][1]).toEqual(
-            expect.objectContaining({
-                targetUrl: imageResourceEventA.name
-            })
-        );
-        expect(record.mock.calls[3][1]).toEqual(
+        expect(record.mock.calls[1][1]).toEqual(
             expect.objectContaining({
                 targetUrl: imageResourceEventB.name
             })

src/plugins/event-plugins/__tests__/ResourcePlugin.test.ts

@@ -166,10 +166,10 @@ export const createDocumentResource = (url: string) => {
 };
 
 export const putRumEventsDocument = createDocumentResource(
-    'https://dataplane.rum.us-west-2.amazonaws.com/application/aa17a42c-e737-48f7-adaf-2e0905f48073/events'
+    'https://dataplane.rum.us-west-2.amazonaws.com/appmonitors/aa17a42c-e737-48f7-adaf-2e0905f48073'
 );
 export const putRumEventsGammaDocument = createDocumentResource(
-    'https://dataplane.rum.us-west-2.amazonaws.com/gamma/application/aa17a42c-e737-48f7-adaf-2e0905f48073/events'
+    'https://dataplane.rum.us-west-2.amazonaws.com/gamma/appmonitors/aa17a42c-e737-48f7-adaf-2e0905f48073'
 );
 export const dataPlaneDocument = createDocumentResource(
     'https://dataplane.rum.us-west-2.amazonaws.com/user'

src/test-utils/mock-data.ts

@@ -109,7 +109,7 @@ describe('Common utils tests', () => {
     test('when url is has endpoint host and path then it is a PutRumEvents call', async () => {
         const endpointHost = 'dataplane.rum.us-west-2.amazonaws.com';
         const resourceUrl =
-            'https://dataplane.rum.us-west-2.amazonaws.com/gamma/application/aa17a42c-e737-48f7-adaf-2e0905f48073/events';
+            'https://dataplane.rum.us-west-2.amazonaws.com/gamma/appmonitors/aa17a42c-e737-48f7-adaf-2e0905f48073/events';
         expect(utils.isPutRumEventsCall(resourceUrl, endpointHost)).toBe(true);
     });
 
@@ -130,8 +130,15 @@ describe('Common utils tests', () => {
     test('when url is invalid then it is not a PutRumEvents call', async () => {
         const endpointHost = 'dataplane.rum.us-west-2.amazonaws.com';
         const resourceUrl =
-            'dataplane.rum.us-west-2.amazonaws.com/gamma/application/aa17a42c-e737-48f7-adaf-2e0905f48073/events';
+            'dataplane.rum.us-west-2.amazonaws.com/gamma/appmonitors/aa17a42c-e737-48f7-adaf-2e0905f48073/events';
         expect(() => new URL(endpointHost)).toThrowError();
         expect(utils.isPutRumEventsCall(resourceUrl, endpointHost)).toBe(false);
     });
+
+    test('when url has endpoint host, correct path and query params then it is a PutRumEvents call', async () => {
+        const endpointHost = 'dataplane.rum.us-east-1.amazonaws.com';
+        const resourceUrl =
+            'https://dataplane.rum.us-east-1.amazonaws.com/appmonitors/00000000-0000-0000-0000-000000000000?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=<content-sha256>&X-Amz-Credential=<access-key>%2F20251120%2Fus-east-1%2Frum%2Faws4_request&X-Amz-Date=20251120T161054Z&X-Amz-Expires=60';
+        expect(utils.isPutRumEventsCall(resourceUrl, endpointHost)).toBe(true);
+    });
 });

src/utils/__tests__/common-utils.test.ts

@@ -90,15 +90,6 @@ const extensions = [
     }
 ];
 
-export const shuffle = (a: any[]) => {
-    for (let i = a.length - 1; i > 0; i--) {
-        const j = Math.floor(Math.random() * (i + 1));
-        const v = a[i];
-        a[i] = a[j];
-        a[j] = v;
-    }
-};
-
 export const getResourceFileType = (
     url: string,
     initiatorType?: string
@@ -225,7 +216,7 @@ export const isLongTaskSupported = () => {
 
 /** PutRumEvents regex pattern */
 const putRumEventsPattern =
-    /.*\/application\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/events/;
+    /\/appmonitors\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/;
 
 export const isPutRumEventsCall = (
     url: string,