Update naming. Add test for invalid filters.

Author: kinyoklion

packages/telemetry/browser-telemetry/__tests__/BrowserTelemetryImpl.test.ts

@@ -22,7 +22,7 @@ const defaultOptions: ParsedOptions = {
     },
     evaluations: true,
     flagChange: true,
-    breadcrumbFilters: [],
+    filters: [],
   },
   stack: {
     source: {
@@ -220,7 +220,7 @@ it('filters breadcrumbs using provided filters', () => {
       flagChange: false,
       http: { instrumentFetch: false, instrumentXhr: false },
       keyboardInput: false,
-      breadcrumbFilters: [
+      filters: [
         // Filter to remove breadcrumbs with id:2
         (breadcrumb) => {
           if (breadcrumb.type === 'custom' && breadcrumb.data?.id === 2) {
@@ -296,7 +296,7 @@ it('omits breadcrumb when a filter throws an exception', () => {
     ...defaultOptions,
     breadcrumbs: {
       ...defaultOptions.breadcrumbs,
-      breadcrumbFilters: [
+      filters: [
         () => {
           throw new Error('Filter error');
         },
@@ -335,7 +335,7 @@ it('omits breadcrumbs when a filter is not a function', () => {
     breadcrumbs: {
       ...defaultOptions.breadcrumbs,
       // @ts-ignore
-      breadcrumbFilters: ['potato'],
+      filters: ['potato'],
     },
   };
   const telemetry = new BrowserTelemetryImpl(options);

packages/telemetry/browser-telemetry/__tests__/options.test.ts

@@ -22,7 +22,7 @@ it('can set all options at once', () => {
       click: false,
       evaluations: false,
       flagChange: false,
-      breadcrumbFilters: [(breadcrumb) => breadcrumb],
+      filters: [(breadcrumb) => breadcrumb],
     },
     collectors: [new ErrorCollector(), new ErrorCollector()],
   });
@@ -39,7 +39,7 @@ it('can set all options at once', () => {
         instrumentFetch: true,
         instrumentXhr: true,
       },
-      breadcrumbFilters: expect.any(Array),
+      filters: expect.any(Array),
     },
     stack: {
       source: {
@@ -422,3 +422,19 @@ it('warns when breadcrumbs.http.customUrlFilter is not a function', () => {
     'The "breadcrumbs.http.customUrlFilter" must be a function. Received string',
   );
 });
+
+it('warns when filters is not an array', () => {
+  const outOptions = parse(
+    {
+      breadcrumbs: {
+        // @ts-ignore
+        filters: 'not an array',
+      },
+    },
+    mockLogger,
+  );
+  expect(outOptions.breadcrumbs.filters).toEqual([]);
+  expect(mockLogger.warn).toHaveBeenCalledWith(
+    'Config option "breadcrumbs.filters" should be of type array, got string, using default value',
+  );
+});

packages/telemetry/browser-telemetry/src/BrowserTelemetryImpl.ts

@@ -59,10 +59,7 @@ function applyBreadcrumbFilter(
   return breadcrumb === undefined ? undefined : filter(breadcrumb);
 }
 
-function applyBreadcrumbFilters(
-  breadcrumb: Breadcrumb,
-  filters: BreadcrumbFilter[],
-): Breadcrumb | undefined {
+function applyfilters(breadcrumb: Breadcrumb, filters: BreadcrumbFilter[]): Breadcrumb | undefined {
   try {
     return filters.reduce(
       (breadcrumbToFilter: Breadcrumb | undefined, filter: BreadcrumbFilter) =>
@@ -213,10 +210,7 @@ export default class BrowserTelemetryImpl implements BrowserTelemetry {
   }
 
   addBreadcrumb(breadcrumb: Breadcrumb): void {
-    const filtered = applyBreadcrumbFilters(
-      breadcrumb,
-      this._options.breadcrumbs.breadcrumbFilters,
-    );
+    const filtered = applyfilters(breadcrumb, this._options.breadcrumbs.filters);
     if (filtered !== undefined) {
       this._breadcrumbs.push(filtered);
       if (this._breadcrumbs.length > this._maxBreadcrumbs) {

packages/telemetry/browser-telemetry/src/api/Options.ts

@@ -152,7 +152,7 @@ export interface Options {
      * Example:
      * ```
      * // We want to redact any click events that include the message 'sneaky-button'
-     * breadcrumbFilters: [
+     * filters: [
      *   (breadcrumb) => {
      *     if(
      *       breadcrumb.class === 'ui' &&
@@ -173,7 +173,7 @@ export interface Options {
      * If any breadcrumbFilter cannot be executed, for example because it is not a function, then all breadcrumbs will
      * be excluded.
      */
-    breadcrumbFilters?: BreadcrumbFilter[];
+    filters?: BreadcrumbFilter[];
   };
 
   /**

packages/telemetry/browser-telemetry/src/options.ts

@@ -20,7 +20,7 @@ export function defaultOptions(): ParsedOptions {
         instrumentFetch: true,
         instrumentXhr: true,
       },
-      breadcrumbFilters: [],
+      filters: [],
     },
     stack: {
       source: {
@@ -170,10 +170,10 @@ export default function parse(options: Options, logger?: MinLogger): ParsedOptio
         checkBasic('boolean', 'breadcrumbs.keyboardInput', logger),
       ),
       http: parseHttp(options.breadcrumbs?.http, defaults.breadcrumbs.http, logger),
-      breadcrumbFilters: itemOrDefault(
-        options.breadcrumbs?.breadcrumbFilters,
-        defaults.breadcrumbs.breadcrumbFilters,
-        checkBasic('array', 'breadcrumbs.breadcrumbFilters', logger),
+      filters: itemOrDefault(
+        options.breadcrumbs?.filters,
+        defaults.breadcrumbs.filters,
+        checkBasic('array', 'breadcrumbs.filters', logger),
       ),
     },
     stack: parseStack(options.stack, defaults.stack),
@@ -287,7 +287,7 @@ export interface ParsedOptions {
     /**
      * Custom breadcrumb filters.
      */
-    breadcrumbFilters: BreadcrumbFilter[];
+    filters: BreadcrumbFilter[];
   };
 
   /**