feat: add resource and navigation event filtering

src/plugins/event-plugins/NavigationPlugin.ts

@@ -12,24 +12,16 @@ export const NAVIGATION_EVENT_PLUGIN_ID = 'navigation';
 const NAVIGATION = 'navigation';
 const LOAD = 'load';
 
-export type PartialNavigationPluginConfig = PartialPerformancePluginConfig;
-
-export type NavigationPluginConfig = PerformancePluginConfig;
-
-export const defaultNavigationPluginConfig = {
-    ...defaultPerformancePluginConfig
-};
-
 /**
  * This plugin records performance timing events generated during every page load/re-load activity.
  * Paint, resource and performance event types make sense only if all or none are included.
  * For RUM, these event types are inter-dependent. So they are recorded under one plugin.
  */
 export class NavigationPlugin extends InternalPlugin {
-    private config: NavigationPluginConfig;
-    constructor(config?: PartialNavigationPluginConfig) {
+    private config: PerformancePluginConfig;
+    constructor(config?: PartialPerformancePluginConfig) {
         super(NAVIGATION_EVENT_PLUGIN_ID);
-        this.config = { ...defaultNavigationPluginConfig, ...config };
+        this.config = { ...defaultPerformancePluginConfig, ...config };
     }
 
     enable(): void {

src/plugins/event-plugins/ResourcePlugin.ts

@@ -17,36 +17,15 @@ export const RESOURCE_EVENT_PLUGIN_ID = 'resource';
 const RESOURCE = 'resource';
 const LOAD = 'load';
 
-export type PartialResourcePluginConfig = {
-    recordAllTypes?: ResourceType[];
-    sampleTypes?: ResourceType[];
-} & PartialPerformancePluginConfig;
-
-export type ResourcePluginConfig = {
-    recordAllTypes: ResourceType[];
-    sampleTypes: ResourceType[];
-} & PerformancePluginConfig;
-
-export const defaultResourcePluginConfig = {
-    recordAllTypes: [ResourceType.DOCUMENT, ResourceType.SCRIPT],
-    sampleTypes: [
-        ResourceType.STYLESHEET,
-        ResourceType.IMAGE,
-        ResourceType.FONT,
-        ResourceType.OTHER
-    ],
-    ...defaultPerformancePluginConfig
-};
-
 /**
  * This plugin records resource performance timing events generated during every page load/re-load.
  */
 export class ResourcePlugin extends InternalPlugin {
-    private config: ResourcePluginConfig;
+    private config: PerformancePluginConfig;
 
-    constructor(config?: PartialResourcePluginConfig) {
+    constructor(config?: PartialPerformancePluginConfig) {
         super(RESOURCE_EVENT_PLUGIN_ID);
-        this.config = { ...defaultResourcePluginConfig, ...config };
+        this.config = { ...defaultPerformancePluginConfig, ...config };
     }
 
     enable(): void {

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

@@ -7,14 +7,12 @@ import {
     mockPerformanceObjectWith,
     putRumEventsDocument
 } from '../../../test-utils/mock-data';
-import {
-    NavigationPlugin,
-    PartialNavigationPluginConfig
-} from '../NavigationPlugin';
+import { NavigationPlugin } from '../NavigationPlugin';
 import { context, record } from '../../../test-utils/test-utils';
 import { PERFORMANCE_NAVIGATION_EVENT_TYPE } from '../../utils/constant';
+import { PartialPerformancePluginConfig } from 'plugins/utils/performance-utils';
 
-const buildNavigationPlugin = (config?: PartialNavigationPluginConfig) => {
+const buildNavigationPlugin = (config?: PartialPerformancePluginConfig) => {
     return new NavigationPlugin(config);
 };
 

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

@@ -11,7 +11,7 @@ import {
     putRumEventsGammaDocument,
     dataPlaneDocument
 } from '../../../test-utils/mock-data';
-import { PartialResourcePluginConfig, ResourcePlugin } from '../ResourcePlugin';
+import { ResourcePlugin } from '../ResourcePlugin';
 import { mockRandom } from 'jest-mock-random';
 import {
     context,
@@ -23,8 +23,9 @@ import {
 import { PERFORMANCE_RESOURCE_EVENT_TYPE } from '../../utils/constant';
 import { ResourceEvent } from '../../../events/resource-event';
 import { PluginContext } from '../../types';
+import { PartialPerformancePluginConfig } from 'plugins/utils/performance-utils';
 
-const buildResourcePlugin = (config?: PartialResourcePluginConfig) => {
+const buildResourcePlugin = (config?: PartialPerformancePluginConfig) => {
     return new ResourcePlugin(config);
 };
 

src/plugins/utils/__tests__/performance-utils.test.ts

@@ -1,4 +1,4 @@
-import { defaultPerformanceIgnore } from '../performance-utils';
+import { defaultIgnore } from '../performance-utils';
 import {
     mockPerformanceEntry,
     mockPerformanceNavigationTiming,
@@ -12,71 +12,71 @@ describe('performance-utils', () => {
                 name: 'chrome-extension://localhost',
                 entryType: 'resource'
             });
-            const result = defaultPerformanceIgnore(mockEntry);
+            const result = defaultIgnore(mockEntry);
             expect(result).toBe(true);
         });
         test('when resource entry is PerformanceEntry and has http URL schema then entry is not ignored', () => {
             const mockEntry = mockPerformanceEntry({
                 name: 'http://localhost',
                 entryType: 'resource'
             });
-            const result = defaultPerformanceIgnore(mockEntry);
+            const result = defaultIgnore(mockEntry);
             expect(result).toBe(false);
         });
         test('when resource entry is PerformanceEntry and has https URL schema then entry is not ignored', () => {
             const mockEntry = mockPerformanceEntry({
                 name: 'https://localhost',
                 entryType: 'resource'
             });
-            const result = defaultPerformanceIgnore(mockEntry);
+            const result = defaultIgnore(mockEntry);
             expect(result).toBe(false);
         });
 
         test('when entry is PerformanceResourceTiming and has non-http(s) URL-schema then entry is ignored', () => {
             const mockEntry = mockPerformanceResourceTiming({
                 name: 'chrome-extension://localhost'
             });
-            const result = defaultPerformanceIgnore(mockEntry);
+            const result = defaultIgnore(mockEntry);
             expect(result).toBe(true);
         });
 
         test('when entry is PerformanceResourceTiming and has http URL schema then the entry is not ignored', () => {
             const mockEntry = mockPerformanceResourceTiming({
                 name: 'http://localhost'
             });
-            const result = defaultPerformanceIgnore(mockEntry);
+            const result = defaultIgnore(mockEntry);
             expect(result).toBe(false);
         });
 
         test('when entry is PerformanceResourceTiming and has https URL schema then entry is not ignored', () => {
             const mockEntry = mockPerformanceResourceTiming({
                 name: 'https://localhost'
             });
-            const result = defaultPerformanceIgnore(mockEntry);
+            const result = defaultIgnore(mockEntry);
             expect(result).toBe(false);
         });
 
         test('when entry is PerformanceNavigationTiming and has non-http(s) URL schema request then entry is not ignored', () => {
             const mockEntry = mockPerformanceNavigationTiming({
                 name: 'chrome-extension://localhost'
             });
-            const result = defaultPerformanceIgnore(mockEntry);
+            const result = defaultIgnore(mockEntry);
             expect(result).toBe(false);
         });
 
         test('when entry is PerformanceNavigationTiming and has http URL schema then entry is not ignored', () => {
             const mockEntry = mockPerformanceNavigationTiming({
                 name: 'http://localhost'
             });
-            const result = defaultPerformanceIgnore(mockEntry);
+            const result = defaultIgnore(mockEntry);
             expect(result).toBe(false);
         });
 
         test('when entry is PerformanceNavigationTiming and has https URL schema then entry is not ignored', () => {
             const mockEntry = mockPerformanceNavigationTiming({
                 name: 'https://localhost'
             });
-            const result = defaultPerformanceIgnore(mockEntry);
+            const result = defaultIgnore(mockEntry);
             expect(result).toBe(false);
         });
     });

src/plugins/utils/performance-utils.ts

@@ -1,17 +1,30 @@
-export const defaultPerformanceIgnore = (entry: PerformanceEntry) =>
+import { ResourceType } from '../../utils/common-utils';
+
+export const defaultIgnore = (entry: PerformanceEntry) =>
     entry.entryType === 'resource' && !/^https?:/.test(entry.name);
 
 export type PartialPerformancePluginConfig = {
-    ignore?: (event: PerformanceEntry) => any;
     eventLimit?: number;
+    ignore?: (event: PerformanceEntry) => any;
+    recordAllTypes?: ResourceType[];
+    sampleTypes?: ResourceType[];
 };
 
 export type PerformancePluginConfig = {
-    ignore: (event: PerformanceEntry) => any;
     eventLimit: number;
+    ignore: (event: PerformanceEntry) => any;
+    recordAllTypes: ResourceType[];
+    sampleTypes: ResourceType[];
 };
 
 export const defaultPerformancePluginConfig = {
-    ignore: defaultPerformanceIgnore,
-    eventLimit: 10
+    eventLimit: 10,
+    ignore: defaultIgnore,
+    recordAllTypes: [ResourceType.DOCUMENT, ResourceType.SCRIPT],
+    sampleTypes: [
+        ResourceType.STYLESHEET,
+        ResourceType.IMAGE,
+        ResourceType.FONT,
+        ResourceType.OTHER
+    ]
 };