refactor: Make default pagesToExclude value explicit (#180)

Author: Reno

docs/configuration.md

@@ -29,7 +29,7 @@ For example, the config object may look similar to the following:
 | guestRoleArn | String | `undefined` | The ARN of the AWS IAM role that will be assumed during anonymous authorization.<br/><br/>When this field is set (along with `identityPoolId`), the web client will attempt to retrieve temporary AWS credentials through Cognito using `AssumeRoleWithWebIdentity`. If this field is not set, you must forward credentials to the web client using the `setAwsCredentials` command. |
 | identityPoolId | String | `undefined` | The Amazon Cognito Identity Pool ID that will be used during anonymous authorization.<br/><br/>When this field is set (along with `guestRoleArn`), the web client will attempt to retrieve temporary AWS credentials through Cognito using `AssumeRoleWithWebIdentity`. If this field is not set, you must forward credentials to the web client using the `setAwsCredentials` command. |
 | pageIdFormat | String | `'PATH'` | The portion of the `window.location` that will be used as the page ID. Options include `PATH`, `HASH` and `PATH_AND_HASH`.<br/><br/>For example, consider the URL `https://amazonaws.com/home?param=true#content`<br/><br/>`PATH`: `/home`<br/>`HASH`: `#content`<br/>`PATH_AND_HASH`: `/home#content` |
-| pagesToInclude | RegExp[] | `[]` | A list of regular expressions which specify the `window.location` values for which the web client will record data. Pages are matched using the `RegExp.test()` function.<br/><br/>For example, when `pagesToInclude: [ /\/home/ ]`, then data from `https://amazonaws.com/home` will be included,  and `https://amazonaws.com/` will not be included. |
+| pagesToInclude | RegExp[] | `[/.*/]` | A list of regular expressions which specify the `window.location` values for which the web client will record data, unless explicitly excluded by `pagesToExclude`. Pages are matched using the `RegExp.test()` function.<br/><br/>For example, when `pagesToInclude: [ /\/home/ ]`, then data from `https://amazonaws.com/home` will be included,  and `https://amazonaws.com/` will not be included. |
 | pagesToExclude | RegExp[] | `[]` | A list of regular expressions which specify the `window.location` values for which the web client will record data. Pages are matched using the `RegExp.test()` function.<br/><br/>For example, when `pagesToExclude: [ /\/home/ ]`, then data from `https://amazonaws.com/home` will be excluded,  and `https://amazonaws.com/` will not be excluded. |
 | recordResourceUrl | Boolean | `true` | When this field is `false`, the web client will not record the URLs of resources downloaded by your application.<br/><br/> Some types of resources (e.g., profile images) may be referenced by URLs which contain PII. If this applies to your application, you must set this field to `false` to comply with CloudWatch RUM's shared responsibility model. |
 | routeChangeComplete | Number | `100` | The interval (in milliseconds) for which when no HTTP or DOM activity has been observed, an active route change is marked as complete. Note that `routeChangeComplete` must be strictly less than `routeChangeTimeout`. |

src/event-cache/EventCache.ts

@@ -218,19 +218,14 @@ export class EventCache {
      */
     private isCurrentUrlAllowed() {
         const location = document.location.toString();
+        const exclude = this.config.pagesToExclude.some((re) =>
+            re.test(location)
+        );
 
-        if (
-            this.config.pagesToExclude.length > 0 &&
-            this.config.pagesToExclude.some((re) => re.test(location))
-        ) {
-            return false;
-        }
+        const include = this.config.pagesToInclude.some((re) =>
+            re.test(location)
+        );
 
-        if (
-            !this.config.pagesToInclude.length ||
-            this.config.pagesToInclude.some((re) => re.test(location))
-        ) {
-            return true;
-        }
+        return include && !exclude;
     }
 }

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

@@ -203,10 +203,7 @@ describe('EventCache tests', () => {
         // Init
         const EVENT1_SCHEMA = 'com.amazon.rum.event1';
         const eventCache: EventCache = Utils.createEventCache({
-            ...DEFAULT_CONFIG,
-            ...{
-                pagesToInclude: [/.*/]
-            }
+            ...DEFAULT_CONFIG
         });
         const expectedEvents: RumEvent[] = [
             {

src/orchestration/Orchestration.ts

@@ -122,7 +122,7 @@ export const defaultConfig = (cookieAttributes: CookieAttributes): Config => {
         eventPluginsToLoad: [],
         pageIdFormat: PageIdFormatEnum.Path,
         pagesToExclude: [],
-        pagesToInclude: [],
+        pagesToInclude: [/.*/],
         recordResourceUrl: true,
         retries: 2,
         routeChangeComplete: 100,

src/orchestration/__tests__/Orchestration.test.ts

@@ -157,7 +157,7 @@ describe('Orchestration tests', () => {
             eventPluginsToLoad: [],
             pageIdFormat: PageIdFormatEnum.Path,
             pagesToExclude: [],
-            pagesToInclude: [],
+            pagesToInclude: [/.*/],
             recordResourceUrl: true,
             retries: 2,
             routeChangeComplete: 100,