@crimson-education/browser-logger 3.0.2 → 3.0.3-pinpoint-proxy.1

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.2",
+  "version": "3.0.3-pinpoint-proxy.1",
   "description": "An abstract logger and reporting utility for browser environments",
   "scripts": {
     "prepack": "npm run build",

package/src/reporters/amplifyReporter.ts

@@ -1,3 +1,9 @@
+import { Auth } from '@aws-amplify/auth';
+import { Analytics } from '@aws-amplify/analytics';
+import { Endpoint } from '@aws-sdk/types';
+import { HttpRequest } from '@aws-sdk/protocol-http';
+import { PinpointClient } from '@aws-sdk/client-pinpoint';
+
 import {
   IReporter,
   Metadata,
@@ -7,8 +13,6 @@ import {
   ReportUser,
   ServiceInfo,
 } from '../types';
-import { Auth } from '@aws-amplify/auth';
-import { Analytics } from '@aws-amplify/analytics';
 import { logger } from '../logger';
 
 /* eslint-disable @typescript-eslint/no-unused-vars */
@@ -30,6 +34,8 @@ export interface AmplifyReporterConfig extends ReporterConfigBase {
    * The Pinpoint App Id to report to.
    */
   analyticsAppId: string;
+  /** Optional proxy URL */
+  proxyUrl?: string;
   /**
    * The Cognito User Pool to configure in Auth.configure.
    * If you are using Cognito, it is better to set identityPoolId to false and configure Auth manually.
@@ -147,6 +153,49 @@ export function amplifyReporter(info: ServiceInfo, config: AmplifyReporterConfig
     });
   }
 
+  if (config.proxyUrl) {
+    // No public API for overriding where the Pinpoint client sends events to... 🤮
+    // Pinpoint client isn't available synchronously because it is instantiated when events get sent out,
+    // and then reinstantiated whenever the API credentials change. We need to hook `_initClients` to ensure
+    // that the Pinpoint client being used is always patched with our custom endpoint.
+    const provider = (Analytics.getPluggable('AWSPinpoint') as any)?.pinpointClient as any;
+    if (provider) {
+      const proxyUrl = new URL(config.proxyUrl);
+      if (typeof provider._initClients === 'function') {
+        const originalInitClients = provider._initClients;
+        provider._initClients = async (credentials: unknown) => {
+          const result = await originalInitClients._initClients(credentials);
+          const pinpointClient = provider.pinpointClient as PinpointClient | undefined;
+
+          if (pinpointClient) {
+            pinpointClient.config.endpoint = (): Promise<Endpoint> =>
+              Promise.resolve({
+                hostname: proxyUrl.hostname,
+                // Passing proxyUrl.pathname here doesn't work; it gets overridden
+                path: '/',
+                port: undefined,
+                protocol: proxyUrl.protocol,
+              });
+
+            pinpointClient.middlewareStack.add(
+              (next) => (args) => {
+                // Add proxyUrl.pathname to final request url if it was provided
+                if (proxyUrl.pathname !== '/' && HttpRequest.isInstance(args.request)) {
+                  const shouldStripSlash = proxyUrl.pathname.startsWith('/');
+                  args.request.path = `${proxyUrl.pathname}${args.request.path.slice(shouldStripSlash ? 1 : 0)}`;
+                }
+
+                return next(args);
+              },
+              { step: 'finalizeRequest' },
+            );
+          }
+          return result;
+        };
+      }
+    }
+  }
+
   const reporter: IReporter = {
     trackEvent: function (event: ReporterEvent): void {
       Analytics.record({