chore: rename config aws:releaseId to releaseId (#593)

Author: williazz

docs/configuration.md

@@ -19,7 +19,7 @@ For example, the config object may look similar to the following:
 | Field Name | Type | Default | Description |
 | --- | --- | --- | --- |
 | allowCookies | Boolean | `false` | Enable the web client to set and read two cookies: a session cookie named `cwr_s` and a user cookie named `cwr_u`.<br/><br/>`cwr_s` stores session data including an anonymous session ID (uuid v4) created by the web client. This allows CloudWatch RUM to compute sessionized metrics like errors per session.<br/><br/>`cwr_u` stores an anonymous user ID (uuid v4) created by the web client. This allows CloudWatch RUM to count return visitors.<br/><br/>`true`: the web client will use cookies<br/>`false`: the web client will not use cookies. |
-| aws:releaseId | string | `undefined` | The application release id used to find a matching source map, if any. Must match regex `^[a-zA-Z0-9_\-:/\.]{1,200}$`, including size limit 200 |
+| releaseId | String | `undefined` | The releaseId will be used to retrieve source map(s), if any, when RUM service unminifies JavaScript error stack traces. It should be unique to each application release and match regex ^[a-zA-Z0-9_\-:/\.]{1,200}$, including size limit of 200. |
 | cookieAttributes | [CookieAttributes](#cookieattributes) | `{ domain: window.location.hostname, path: '/', sameSite: 'Strict', secure: true, unique: false } ` | Cookie attributes are applied to all cookies stored by the web client, including `cwr_s` and `cwr_u`. |
 | sessionAttributes | [MetadataAttributes](#metadataattributes) | `{}` | Session attributes will be added the metadata of all events in the session. |
 | disableAutoPageView | Boolean | `false` | When this field is `false`, the web client will automatically record page views.<br/><br/>By default, the web client records page views when (1) the page first loads and (2) the browser's [history API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) is called. The page ID is `window.location.pathname`.<br/><br/>In some cases, the web client's instrumentation will not record the desired page ID. In this case, the web client's page view automation must be disabled using the `disableAutoPageView` configuration, and the application must be instrumented to record page views using the `recordPageView` command. |

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

@@ -127,7 +127,7 @@ describe('EventCache tests', () => {
                 allowCookies: false,
                 sessionLengthSeconds: 0
             },
-            'aws:releaseId': '5.2.1'
+            releaseId: '5.2.1'
         };
 
         const eventCache: EventCache = Utils.createEventCache(config);

src/orchestration/Orchestration.ts

@@ -109,7 +109,7 @@ export type PartialCookieAttributes = Partial<CookieAttributes>;
 
 export interface Config {
     allowCookies: boolean;
-    'aws:releaseId'?: string;
+    releaseId?: string;
     batchLimit: number;
     client: string;
     clientBuilder?: ClientBuilder;

src/sessions/SessionManager.ts

@@ -276,7 +276,7 @@ export class SessionManager {
             // This client is used exclusively in web applications.
             platformType: WEB_PLATFORM_TYPE,
             domain: window.location.hostname,
-            'aws:releaseId': this.config['aws:releaseId']
+            'aws:releaseId': this.config.releaseId
         };
     }
 

src/sessions/__tests__/SessionManager.test.ts

@@ -848,14 +848,14 @@ describe('SessionManager tests', () => {
     });
 
     test('when initiated with aws:releaseId then it is in the attributes', async () => {
-        const awsReleaseId = '2.1.7';
+        const releaseId = '2.1.7';
         const sessionManager = defaultSessionManager({
             ...DEFAULT_CONFIG,
-            'aws:releaseId': awsReleaseId
+            releaseId
         });
 
         const actualSessionAttributes = sessionManager.getAttributes();
-        expect(actualSessionAttributes['aws:releaseId']).toBe(awsReleaseId);
+        expect(actualSessionAttributes['aws:releaseId']).toBe(releaseId);
     });
 
     test('when initiated without aws:releaseId then it is NOT in the attributes', async () => {