@crimson-education/browser-logger 5.0.1 → 5.0.3

package/src/reporters/amplifyReporter.ts

@@ -1,344 +0,0 @@
-import { Auth } from '@aws-amplify/auth';
-import { Analytics } from '@aws-amplify/analytics';
-import { Endpoint, FinalizeRequestMiddleware } from '@aws-sdk/types';
-import { HttpRequest } from '@aws-sdk/protocol-http';
-import { PinpointClient, ServiceInputTypes, ServiceOutputTypes } from '@aws-sdk/client-pinpoint';
-
-import {
-  IReporter,
-  Metadata,
-  ReporterBreadcrumb,
-  ReporterConfigBase,
-  ReporterEvent,
-  ReportUser,
-  ServiceInfo,
-} from '../types';
-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.
-   */
-  region: string;
-  /**
-   * The Identity Pool Id to use for reporting, if set to false, Auth.configure is not called.
-   * This must be called manually for the reporter to work.
-   */
-  identityPoolId: string | false;
-  /**
-   * 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.
-   */
-  userPoolId?: string;
-  /**
-   * The Cognito Web Client Id to configure in Auth.configure.
-   * If you are using Cognito, it is better to set identityPoolId to false and configure Auth manually.
-   */
-  userPoolWebClientId?: string;
-
-  /**
-   * If you want to track which page/url in your webapp is the most frequently viewed one, you can use this feature.
-   * It will automatically send events containing url information when the page is visited.
-   */
-  autoTrackPageViews?: boolean;
-  /**
-   * If you want to track user interactions with elements on the page, you can use this feature.
-   * All you need to do is attach the specified selectors to your dom element and turn on the auto tracking.
-   */
-  autoTrackEvents?: boolean;
-  /**
-   * A web session can be defined in different ways.
-   * 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-
-   */
-  selectorPrefix?: string;
-
-  /**
-   * Modify how the reporter sends events to Amplify.
-   */
-  buffering?: AmplifyReporterBufferingConfig;
-}
-
-/**
- * Configuration options for the buffering behavior of Pinpoint's event tracker.
- *
- * @see https://docs.amplify.aws/lib/analytics/getting-started/q/platform/js/#set-up-existing-analytics-backend
- */
-type AmplifyReporterBufferingConfig = {
-  /** Number of items to buffer for sending. */
-  bufferSize?: number;
-  /** Number of events sent each time Pinpoint flushes. */
-  flushSize?: number;
-  /** Interval Pinpoint flushes analytics events. Measured in milliseconds. */
-  flushInterval?: number;
-  /** The maximum number of times Pinpoint will retry to send an event. */
-  resendLimit?: number;
-};
-
-export function amplifyReporter(info: ServiceInfo, config: AmplifyReporterConfig): IReporter {
-  if (config.identityPoolId !== false) {
-    Auth.configure({
-      region: config.region,
-      identityPoolId: config.identityPoolId,
-      userPoolId: config.userPoolId,
-      userPoolWebClientId: config.userPoolWebClientId,
-    });
-  }
-
-  const wrapAutoTrackMiddleware = (source: AmplifyAutoTrackSource) => {
-    const { beforeAutoTrack } = config;
-    return typeof beforeAutoTrack === 'function' ? () => beforeAutoTrack(source) ?? {} : undefined;
-  };
-
-  const allMetadata = asAttributeMap({
-    appName: info.service,
-    service: info.service,
-    domain: window.location.host,
-    environment: info.environment,
-    version: info.version,
-  });
-
-  Analytics.configure({
-    region: config.region,
-    appId: config.analyticsAppId,
-    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'),
-    });
-  }
-
-  if (config.autoTrackEvents) {
-    Analytics.autoTrack('event', {
-      enable: true,
-      selectorPrefix: config.selectorPrefix ?? 'data-analytics-',
-      attributes: wrapAutoTrackMiddleware('event'),
-    });
-  }
-
-  if (config.proxyUrl) {
-    installPinpointProxy(new URL(config.proxyUrl));
-  }
-
-  const reporter: IReporter = {
-    trackEvent: function (event: ReporterEvent): void {
-      Analytics.record({
-        name: event.message,
-        attributes: asAttributeMap(
-          {
-            ...event.metadata,
-            ...event.tags,
-          },
-          false,
-        ) as Record<string, string>,
-        metrics: event.metrics,
-      }).catch(() => {
-        // Swallow; see: https://crimsonhq.slack.com/archives/G4UN6Q4KF/p1648599302847539
-      });
-    },
-    addBreadcrumb: function (breadcrumb: ReporterBreadcrumb): void {
-      reporter.trackEvent({
-        message: breadcrumb.message,
-        metadata: {
-          category: breadcrumb.category,
-          ...breadcrumb.metadata,
-        },
-      });
-    },
-    addMetadata: function (metadata: Metadata): void {
-      Object.assign(allMetadata, asAttributeMap(metadata, true));
-      Analytics.updateEndpoint({
-        attributes: allMetadata,
-      }).catch(() => {
-        // Swallow; see: https://crimsonhq.slack.com/archives/G4UN6Q4KF/p1648599302847539
-      });
-    },
-    setUser: function (user: ReportUser | null): void {
-      const userMetadata = user
-        ? asAttributeMap({
-            userId: user.id,
-          })
-        : {};
-      Object.assign(allMetadata, asAttributeMap(userMetadata, true));
-      Analytics.updateEndpoint({
-        userId: user?.id ?? '',
-        attributes: allMetadata,
-        userAttributes: user
-          ? asAttributeMap({
-              id: user.id,
-              email: user.email,
-              name: user.name ?? user.email,
-              username: user.username,
-            })
-          : {},
-      }).catch(() => {
-        // Swallow; see: https://crimsonhq.slack.com/archives/G4UN6Q4KF/p1648599302847539
-      });
-    },
-    setRouteName: function (routeName: string): void {
-      reporter.addMetadata({ routeName });
-    },
-    setPageName: function (pageName: string): void {
-      reporter.addMetadata({ pageName });
-    },
-  };
-
-  return reporter;
-}
-
-/**
- * Pinpoint has strict attribute name and value length limits
- */
-export function asAttributeMap(values: Record<string, unknown>, groupValues = true): AttributeMap {
-  const attributeMap = buildAttributeMap(values, undefined, groupValues);
-
-  const checkedEntries = Object.entries(attributeMap).map(([key, value]) => {
-    const truncatedKey = key.length > 50 ? `___${key.slice(-47)}` : key;
-    const truncatedValue = Array.isArray(value)
-      ? value?.map((val) => val.slice(0, 100)) ?? null
-      : value?.slice(0, 100) ?? null;
-
-    return [truncatedKey, truncatedValue];
-  });
-
-  // Pinpoint only accepts 40 attributes
-  if (checkedEntries.length > 40) {
-    logger.error(`Amplify only allows 40 attributes per event, truncating to 40 attributes`, {
-      attributes: checkedEntries,
-    });
-    checkedEntries.length = 40;
-  }
-
-  return Object.fromEntries(checkedEntries);
-}
-
-/**
- * Pinpoint expects `endpoint.attributes` and `endpoint.userAttributes` to have
- * values which are string arrays. This function takes in an object and ensures
- * all of its values are of type `string[]` to appease Pinpoint.
- */
-export function buildAttributeMap(
-  values: Record<string, any>,
-  parentKey: string | undefined = undefined,
-  groupValues = true,
-): AttributeMap {
-  const valuesWithStringArrays: AttributeMap = {};
-
-  Object.entries(values).forEach(([key, value]) => {
-    const combinedKey = parentKey ? [parentKey, key].join('.') : key;
-
-    if (!value) {
-      valuesWithStringArrays[combinedKey] = null;
-    } else if (groupValues && Array.isArray(value)) {
-      valuesWithStringArrays[combinedKey] = value.map((element) =>
-        typeof element === 'string' ? element : JSON.stringify(element),
-      );
-    } else if (typeof value === 'object') {
-      const flattenedAttribute = buildAttributeMap(value, combinedKey, groupValues);
-      Object.assign(valuesWithStringArrays, flattenedAttribute);
-    } else {
-      const stringValue = typeof value === 'string' ? value : JSON.stringify(value);
-      valuesWithStringArrays[combinedKey] = groupValues ? [stringValue] : stringValue;
-    }
-  });
-
-  return valuesWithStringArrays;
-}
-
-function installPinpointProxy(proxyUrl: URL) {
-  // No public API for overriding where the Pinpoint client sends events to... 🤮
-  // In theory you can pass in an `endpoint` to the Pinpoint client's constructor like any other AWS
-  // client, but Amplify's analytics doesn't expose anything we can use to get an endpoint threaded
-  // down to the Pinpoint client's constructor.
-  //
-  // The Pinpoint client _also_ isn't available synchronously because it is instantiated when events
-  // get sent out, and then reconfigured 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;
-  if (!provider || typeof provider._initClients !== 'function') {
-    logger.error(
-      'Installation of the Pinpoint proxy failed. This likely means the internals of the @aws-amplify/analytics package have changed.',
-    );
-    return;
-  }
-
-  const originalInitClients = provider._initClients;
-  const requestMiddleware: FinalizeRequestMiddleware<ServiceInputTypes, ServiceOutputTypes> =
-    (next) => async (args) => {
-      const pinpointClient = provider.pinpointClient as PinpointClient | undefined;
-
-      if (pinpointClient && proxyUrl.pathname !== '/' && HttpRequest.isInstance(args.request)) {
-        // Add proxyUrl.pathname to final request url if it was provided
-        const shouldStripSlash = proxyUrl.pathname.endsWith('/');
-        args.request.path = `${proxyUrl.pathname}${args.request.path.slice(shouldStripSlash ? 1 : 0)}`;
-
-        // Wrap request body so the proxy has signing info
-        if (typeof args.request.body === 'string') {
-          const credentials = await pinpointClient.config.credentials();
-          args.request.body = JSON.stringify({
-            credentials,
-            data: JSON.parse(args.request.body),
-          });
-        }
-      }
-
-      return next(args);
-    };
-
-  provider._initClients = async (credentials: unknown) => {
-    const result = await originalInitClients.call(provider, 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.remove(requestMiddleware);
-      pinpointClient.middlewareStack.add(requestMiddleware, { step: 'finalizeRequest' });
-    }
-    return result;
-  };
-}