@crimson-education/browser-logger 3.0.0 → 3.0.1

package/lib/utils.d.ts

@@ -1,10 +1,10 @@
-import { IReporter, Metadata } from './types';
-/**
- * Recursively filter reporter metadata.
- * @param metadata Deep Metadata to filter.
- * @param reporter Reporter with filter config.
- * @param prefix Prefix for recusring nested metadata.
- * @returns Filtered metadata.
- */
-export declare function filterReporterMetadata<TMetadata extends Metadata | undefined>(metadata: TMetadata, reporter: Pick<IReporter, 'ignoreMetadataPatterns'>, prefix?: string): TMetadata;
+import { IReporter, Metadata } from './types';
+/**
+ * Recursively filter reporter metadata.
+ * @param metadata Deep Metadata to filter.
+ * @param reporter Reporter with filter config.
+ * @param prefix Prefix for recusring nested metadata.
+ * @returns Filtered metadata.
+ */
+export declare function filterReporterMetadata<TMetadata extends Metadata | undefined>(metadata: TMetadata, reporter: Pick<IReporter, 'ignoreMetadataPatterns'>, prefix?: string): TMetadata;
 //# sourceMappingURL=utils.d.ts.map

package/lib/utils.js

@@ -1,32 +1,32 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterReporterMetadata = void 0;
-/**
- * Recursively filter reporter metadata.
- * @param metadata Deep Metadata to filter.
- * @param reporter Reporter with filter config.
- * @param prefix Prefix for recusring nested metadata.
- * @returns Filtered metadata.
- */
-function filterReporterMetadata(metadata, reporter, prefix) {
-    const ignorePatterns = reporter.ignoreMetadataPatterns;
-    // No metadata, or no patterns.
-    if (metadata === undefined || !ignorePatterns) {
-        return metadata;
-    }
-    const entries = Object.entries(metadata);
-    return Object.fromEntries(entries
-        .filter(([key]) => {
-        const fullKey = prefix ? prefix + key : key;
-        return !ignorePatterns.some((pattern) => typeof pattern === 'string' ? pattern === fullKey : pattern.test(fullKey));
-    })
-        .map(([key, value]) => {
-        if (typeof value === 'object' && value !== null) {
-            const fullKey = prefix ? prefix + key : key;
-            return [key, filterReporterMetadata(value, reporter, `${fullKey}.`)];
-        }
-        return [key, value];
-    }));
-}
-exports.filterReporterMetadata = filterReporterMetadata;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterReporterMetadata = void 0;
+/**
+ * Recursively filter reporter metadata.
+ * @param metadata Deep Metadata to filter.
+ * @param reporter Reporter with filter config.
+ * @param prefix Prefix for recusring nested metadata.
+ * @returns Filtered metadata.
+ */
+function filterReporterMetadata(metadata, reporter, prefix) {
+    const ignorePatterns = reporter.ignoreMetadataPatterns;
+    // No metadata, or no patterns.
+    if (metadata === undefined || !ignorePatterns) {
+        return metadata;
+    }
+    const entries = Object.entries(metadata);
+    return Object.fromEntries(entries
+        .filter(([key]) => {
+        const fullKey = prefix ? prefix + key : key;
+        return !ignorePatterns.some((pattern) => typeof pattern === 'string' ? pattern === fullKey : pattern.test(fullKey));
+    })
+        .map(([key, value]) => {
+        if (typeof value === 'object' && value !== null) {
+            const fullKey = prefix ? prefix + key : key;
+            return [key, filterReporterMetadata(value, reporter, `${fullKey}.`)];
+        }
+        return [key, value];
+    }));
+}
+exports.filterReporterMetadata = filterReporterMetadata;
 //# sourceMappingURL=utils.js.map

package/lib/utils.test.d.ts

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=utils.test.d.ts.map

package/lib/utils.test.js

@@ -1,32 +1,32 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("./utils");
-describe('utils', () => {
-    describe('filterReporterMetadata', () => {
-        it('should remove attributes which match the ignore patterns', () => {
-            const inputAttributeMap = {
-                includeme: '5',
-                excludeme: 'false',
-                differentProp: 'boo',
-                deep: {
-                    includeme: '5',
-                    excludeme: 'false',
-                    deepExcludeStr: 'boo',
-                    deepExcludeRegex: 'boo',
-                },
-            };
-            const filtered = (0, utils_1.filterReporterMetadata)(inputAttributeMap, {
-                ignoreMetadataPatterns: [/excludeme/g, /Prop/g, 'deep.deepExcludeStr', /deep\.deepExcludeRegex/g],
-            });
-            expect(filtered.includeme).toBeTruthy();
-            expect(filtered.excludeme).toBeFalsy();
-            expect(filtered.differentProp).toBeFalsy();
-            // deep
-            expect(filtered.deep.includeme).toBeTruthy();
-            expect(filtered.deep.excludeme).toBeFalsy();
-            expect(filtered.deep.deepExcludeStr).toBeFalsy();
-            expect(filtered.deep.deepExcludeRegex).toBeFalsy();
-        });
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("./utils");
+describe('utils', () => {
+    describe('filterReporterMetadata', () => {
+        it('should remove attributes which match the ignore patterns', () => {
+            const inputAttributeMap = {
+                includeme: '5',
+                excludeme: 'false',
+                differentProp: 'boo',
+                deep: {
+                    includeme: '5',
+                    excludeme: 'false',
+                    deepExcludeStr: 'boo',
+                    deepExcludeRegex: 'boo',
+                },
+            };
+            const filtered = (0, utils_1.filterReporterMetadata)(inputAttributeMap, {
+                ignoreMetadataPatterns: [/excludeme/g, /Prop/g, 'deep.deepExcludeStr', /deep\.deepExcludeRegex/g],
+            });
+            expect(filtered.includeme).toBeTruthy();
+            expect(filtered.excludeme).toBeFalsy();
+            expect(filtered.differentProp).toBeFalsy();
+            // deep
+            expect(filtered.deep.includeme).toBeTruthy();
+            expect(filtered.deep.excludeme).toBeFalsy();
+            expect(filtered.deep.deepExcludeStr).toBeFalsy();
+            expect(filtered.deep.deepExcludeRegex).toBeFalsy();
+        });
+    });
+});
 //# sourceMappingURL=utils.test.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crimson-education/browser-logger",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "An abstract logger and reporting utility for browser environments",
   "scripts": {
     "prepack": "npm run build",

package/src/reporters/amplifyReporter.ts

@@ -14,6 +14,8 @@ import { logger } from '../logger';
 /* eslint-disable @typescript-eslint/no-unused-vars */
 type AttributeMap = Record<string, string[] | string | null>;
 
+type AmplifyAutoTrackSource = 'pageView' | 'event' | 'session';
+
 export interface AmplifyReporterConfig extends ReporterConfigBase {
   /**
    * AWS Region for Amplify.
@@ -54,6 +56,11 @@ export interface AmplifyReporterConfig extends ReporterConfigBase {
    * To keep it simple we define that the web session is active when the page is not hidden and inactive when the page is hidden.
    */
   autoTrackSessions?: boolean;
+  /**
+   * Optional function to run before autotracked analytics events are sent out.
+   * The returned metadata is attached to the event.
+   */
+  beforeAutoTrack?(source: AmplifyAutoTrackSource): Metadata | undefined;
 
   /**
    * The data tag prefix to use for attributing HTML elements. Defaults to data-analytics-
@@ -92,6 +99,11 @@ export function amplifyReporter(info: ServiceInfo, config: AmplifyReporterConfig
     });
   }
 
+  const wrapAutoTrackMiddleware = (source: AmplifyAutoTrackSource) => {
+    const { beforeAutoTrack } = config;
+    return typeof beforeAutoTrack === 'function' ? () => beforeAutoTrack(source) ?? {} : undefined;
+  };
+
   const allMetadata = asAttributeMap({
     appName: info.service,
     service: info.service,
@@ -103,19 +115,27 @@ export function amplifyReporter(info: ServiceInfo, config: AmplifyReporterConfig
   Analytics.configure({
     region: config.region,
     appId: config.analyticsAppId,
-    autoSessionRecord: config.autoTrackSessions,
     endpoint: {
       attributes: allMetadata,
     },
     ...config.buffering,
   });
 
+  // Session autotracking is enabled by default for backwards compatibility reasons, so we _must_
+  // call this unconditionally to ensure we opt out of session tracking when `autoTrackSessions` isn't set
+  // See: https://docs.amplify.aws/lib/analytics/autotrack/q/platform/js/#session-tracking
+  Analytics.autoTrack('session', {
+    enable: config.autoTrackSessions === true,
+    attributes: wrapAutoTrackMiddleware('session'),
+  });
+
   if (config.autoTrackPageViews) {
     Analytics.autoTrack('pageView', {
       enable: true,
       eventName: 'pageView',
       type: 'SPA',
       provider: 'AWSPinpoint',
+      attributes: wrapAutoTrackMiddleware('pageView'),
     });
   }
 
@@ -123,6 +143,7 @@ export function amplifyReporter(info: ServiceInfo, config: AmplifyReporterConfig
     Analytics.autoTrack('event', {
       enable: true,
       selectorPrefix: config.selectorPrefix ?? 'data-analytics-',
+      attributes: wrapAutoTrackMiddleware('event'),
     });
   }