feat: allow customization of default attributes (#430)

Co-authored-by: Jeff Hackshaw <[email protected]>
Co-authored-by: Quinn Hanam <[email protected]>

Author: 3 people

docs/configuration.md

@@ -67,8 +67,7 @@ custom attributes with the `aws:` prefix, or they may be overwritten by future
 versions of the CloudWatch RUM web client.
 
 The RUM web client also records a set of [default
-attributes](https://github.com/aws-observability/aws-rum-web/blob/main/src/event-schemas/meta-data.json).
-You cannot overwrite default attributes with custom attributes.
+attributes](https://github.com/aws-observability/aws-rum-web/blob/main/src/event-schemas/meta-data.json). Overriding default attributes can have unintended consequences in the Cloudwatch RUM console.
 
 | Field Name | Type | Default | Description |
 | --- | --- | --- | --- |

src/event-cache/__tests__/EventCache.integ.test.ts

@@ -75,7 +75,7 @@ describe('EventCache tests', () => {
         });
     });
 
-    test('meta data contains default attributes not overridden from custom attributes', async () => {
+    test('default meta data can be overriden by custom attributes', async () => {
         // Init
         const EVENT1_SCHEMA = 'com.amazon.rum.event1';
         const config = {
@@ -88,7 +88,8 @@ describe('EventCache tests', () => {
                     domain: 'overridden.console.aws.amazon.com',
                     browserLanguage: 'en-UK',
                     browserName: 'Chrome',
-                    deviceType: 'Mac'
+                    deviceType: 'Mac',
+                    platformType: 'other'
                 }
             }
         };
@@ -99,10 +100,10 @@ describe('EventCache tests', () => {
             'aws:client': INSTALL_MODULE,
             'aws:clientVersion': WEB_CLIENT_VERSION,
             domain: 'overridden.console.aws.amazon.com',
-            browserLanguage: 'en-US',
-            browserName: 'WebKit',
-            deviceType: 'desktop',
-            platformType: 'web',
+            browserLanguage: 'en-UK',
+            browserName: 'Chrome',
+            deviceType: 'Mac',
+            platformType: 'other',
             pageId: '/console/home'
         };
 

src/sessions/SessionManager.ts

@@ -139,9 +139,7 @@ export class SessionManager {
     public addSessionAttributes(sessionAttributes: {
         [k: string]: string | number | boolean;
     }) {
-        this.attributes = { ...sessionAttributes, ...this.attributes };
-        this.attributes.domain =
-            (sessionAttributes.domain as string) || this.attributes.domain;
+        this.attributes = { ...this.attributes, ...sessionAttributes };
     }
 
     public getUserId(): string {

src/sessions/__tests__/SessionManager.test.ts

@@ -810,16 +810,40 @@ describe('SessionManager tests', () => {
     });
 
     test('when domain is in custom session attributes then domain is overridden', async () => {
+        // Init
         const sessionManager = defaultSessionManager({
             ...DEFAULT_CONFIG
         });
 
-        sessionManager.addSessionAttributes({
-            domain: 'overridden'
+        const sessionAttributes = {
+            domain: 'preferred.domain'
+        };
+
+        sessionManager.addSessionAttributes(sessionAttributes);
+
+        const actualSessionAttributes = sessionManager.getAttributes();
+
+        // Assert
+        expect(actualSessionAttributes.domain).toEqual(
+            sessionAttributes.domain
+        );
+    });
+
+    test('when custom session attributes have the same key as built in attributies then custom session attributes are used', async () => {
+        // Init
+        const sessionManager = defaultSessionManager({
+            ...DEFAULT_CONFIG
         });
 
+        const sessionAttributes = {
+            title: 'override'
+        };
+
+        sessionManager.addSessionAttributes(sessionAttributes);
+
         const actualSessionAttributes = sessionManager.getAttributes();
 
-        expect(actualSessionAttributes.domain).toEqual('overridden');
+        // Assert
+        expect(actualSessionAttributes.title).toEqual(sessionAttributes.title);
     });
 });