@crimson-education/browser-logger 5.0.0-beta.17 → 5.0.0-beta.19

package/src/reporters/logReporter.ts

@@ -1,86 +0,0 @@
-import { logger, globalMetadata as globalLogMetadata } from '../logger';
-import { IReporter, LogLevel, ReporterConfigBase, ServiceInfo } from '../types';
-
-export interface LogReporterConfig extends ReporterConfigBase {
-  /**
-   * The fallback log level to apply to all trackEvent calls (if the event's level is not set).
-   * Defaults to info.
-   */
-  trackEventDefaultLevel?: LogLevel;
-  /**
-   * The log level to apply to all addBreadcrumb calls.
-   * Defaults to info.
-   */
-  addBreadcrumbLevel?: LogLevel;
-  /**
-   * The log level to apply to all setRouteName calls.
-   * Defaults to debug.
-   */
-  setRouteNameLevel?: LogLevel;
-  /**
-   * The log level to apply to all setPageName calls.
-   * Defaults to debug.
-   */
-  setPageNameLevel?: LogLevel;
-  /**
-   * The log level to apply to all recordSession calls.
-   * Defaults to debug.
-   */
-  recordSessionLevel?: LogLevel;
-  /**
-   * The log level to apply to all recordSessionStop calls.
-   * Defaults to debug.
-   */
-  recordSessionStopLevel?: LogLevel;
-}
-
-export function logReporter(info: ServiceInfo, config: LogReporterConfig) {
-  const reporter: IReporter = {
-    ...config,
-    trackEvent(event) {
-      // config.trackEventLevel and config.level overrides event.level here, as it is an override, while config.trackEventDefaultLevel is a fallback.
-      const level = event.level ?? config.trackEventDefaultLevel ?? LogLevel.Info;
-      logger.log(level, event.message, {
-        ...(event.metadata ?? {}),
-        ...(event.metrics ?? {}),
-        ...(event.tags ?? {}),
-      });
-    },
-    addBreadcrumb(breadcrumb) {
-      const level = config.addBreadcrumbLevel ?? LogLevel.Info;
-      logger.log(level, breadcrumb.message, {
-        ...(breadcrumb.metadata ?? {}),
-        category: breadcrumb.category,
-      });
-    },
-    addMetadata(metadata) {
-      Object.assign(globalLogMetadata, metadata);
-    },
-    setUser(user) {
-      Object.assign(globalLogMetadata, { user });
-    },
-    setRouteName(routeName) {
-      Object.assign(globalLogMetadata, { routeName });
-      const level = config.setRouteNameLevel ?? LogLevel.Debug;
-      logger.log(level, `Route changed to ${routeName}`);
-    },
-    setPageName(pageName) {
-      Object.assign(globalLogMetadata, { pageName });
-      const level = config.setPageNameLevel ?? LogLevel.Debug;
-      logger.log(level, `Page changed to ${pageName}`);
-    },
-    reportError(error, metadata) {
-      logger.error(typeof error === 'string' ? error : error.message, { ...metadata, error });
-    },
-    recordSession() {
-      const level = config.recordSessionLevel ?? LogLevel.Debug;
-      logger.log(level, 'Recording Session');
-    },
-    recordSessionStop() {
-      const level = config.recordSessionStopLevel ?? LogLevel.Debug;
-      logger.log(level, 'Recording Session Stopping');
-    },
-  };
-
-  return reporter;
-}

package/src/types/index.ts

@@ -1,2 +0,0 @@
-export * from './logger';
-export * from './reporter';

package/src/types/logger.ts

@@ -1,85 +0,0 @@
-export type Metadata = Record<string, any>;
-
-/**
- * Options to Customize the Logger
- */
-export type LoggerOptions = {
-  /**
-   * The min log level for events to be sent to the logger.
-   */
-  logLevel?: LogLevel;
-
-  /**
-   * Metadata to add to all logs.
-   */
-  metadata?: Metadata;
-};
-
-export enum LogLevel {
-  Debug = 'debug',
-  Info = 'info',
-  Warn = 'warn',
-  Error = 'error',
-}
-
-export interface LogLevelMethod {
-  (message: string, metadata?: Metadata): ILogger;
-  (message: string, ...meta: any[]): ILogger;
-  (message: any): ILogger;
-}
-
-export interface LogMethod {
-  (level: LogLevel, message: string, metadata?: Metadata): ILogger;
-  (level: LogLevel, message: string, ...meta: any[]): ILogger;
-  (level: LogLevel, message: any): ILogger;
-  (message: Record<string, any>): ILogger;
-}
-
-export interface Profiler {
-  logger: ILogger;
-  done(info?: { message?: string; level?: LogLevel; metadata?: Metadata }): boolean;
-}
-
-export type StructuredLog = {
-  level: LogLevel;
-  message: any;
-  [key: string]: any;
-};
-
-export interface LogTransportConfigBase {
-  /**
-   * The min log level for logs to be sent.
-   */
-  logLevel?: LogLevel;
-
-  /**
-   * Ignore specific metadata keys from being sent.
-   * This can be a regular expression, or a string to exact match.
-   * This is useful to prevent data of no use for the logger, or if the data keys are too long.
-   */
-  ignoreMetadataPatterns?: (string | RegExp)[];
-}
-
-/**
- * A logger interface that is used to transport logs to a destination
- */
-export interface ILogTransport extends LogTransportConfigBase {
-  /**
-   * Inbound log event to transport.
-   */
-  log: (logInfo: StructuredLog) => void;
-}
-
-/**
- * A Logger is a service that can receive log messages.
- */
-export interface ILogger {
-  startTimer(): Profiler;
-  child(metadata?: Metadata, name?: string): ILogger;
-
-  log: LogMethod;
-  debug: LogLevelMethod;
-  info: LogLevelMethod;
-  warn: LogLevelMethod;
-  error: LogLevelMethod;
-}

package/src/types/reporter.ts

@@ -1,180 +0,0 @@
-import { AmplifyReporterConfig } from '../reporters/amplifyReporter';
-import { DatadogReporterConfig } from '../reporters/datadogReporter';
-import { GTMReporterConfig } from '../reporters/gtmReporter';
-import { LogReporterConfig } from '../reporters/logReporter';
-import { LogLevel, Metadata } from './logger';
-
-export type ReporterConfigurations = {
-  /**
-   * Log reporter configuration.
-   * If not set, it will default to everything enabled.
-   */
-  log?: boolean | LogReporterConfig;
-
-  /**
-   * Datadog reporter configuration.
-   * If not set, the datadog reporter will not be used.
-   */
-  datadog?: DatadogReporterConfig;
-
-  /**
-   * Amplify/Pinpoint reporter configuration.
-   * If not set, the amplify reporter will not be used.
-   */
-  amplify?: AmplifyReporterConfig;
-
-  /**
-   *  Google Tag Manager reporter configuration.
-   * If not set, the gtm reporter will not be used.
-   */
-  gtm?: true | GTMReporterConfig;
-};
-
-export type ReporterType = keyof ReporterConfigurations;
-
-export type Metrics = Record<string, number>;
-
-export type ServiceInfo = {
-  /** The Application's name. */
-  service: string;
-  /** The Application's Environment */
-  environment: string;
-  /** The Application's Version. */
-  version: string;
-  /**
-   * Default metadata to add to Reporter events.
-   */
-  defaultMetadata?: Metadata;
-  /**
-   * The min log level for logs to be sent to the logger.
-   */
-  logLevel?: LogLevel;
-  /**
-   * The min event level for events to be sent to reporters.
-   */
-  eventLevel?: LogLevel;
-};
-
-export type ReportUser = {
-  id: string;
-  email?: string;
-  username?: string;
-  name?: string;
-  [key: string]: string | undefined;
-};
-
-export type ReportError = Error | string;
-
-export interface ReporterFilters {
-  /**
-   * Send only to these Reporters.
-   */
-  toReporters?: ReporterType[];
-  /**
-   * Don't send to these Reporters.
-   */
-  excludeReporters?: ReporterType[];
-}
-
-export interface ReporterEvent extends ReporterFilters {
-  /**
-   * The Severity of this event.
-   */
-  level?: LogLevel;
-  /**
-   * The event message/name.
-   */
-  message: string;
-  /**
-   * Event metadata.
-   */
-  metadata?: Metadata | undefined;
-  /**
-   * Event tags, if supported by the Reporter. (Otherwise, they will be added to metadata)
-   */
-  tags?: Metadata | undefined;
-  /**
-   * Event metrics, if supported by the Reporter. (Otherwise, they will be added to metadata)
-   * Metrics are numbers, and are used for aggregations.
-   */
-  metrics?: Metrics | undefined;
-}
-
-export interface TrackedReporterEvent extends ReporterEvent {
-  /**
-   * The time this event was created.
-   */
-  occurred: Date;
-}
-
-export interface ReporterBreadcrumb extends ReporterFilters {
-  /**
-   * The breadcrumb event message/name.
-   */
-  message: string;
-  /**
-   * The category of this breadcrumb (Useful for filtering out in specific reporters).
-   */
-  category?: string | undefined;
-  /**
-   * Breadcrumb metadata.
-   */
-  metadata?: Metadata | undefined;
-}
-
-export interface ReporterFlag {
-  name: string;
-  value: any;
-}
-
-export interface ReporterConfigBase {
-  /**
-   * Enable/Disable reporter endpoints from being called.
-   */
-  endpoints?: {
-    trackEvent?: boolean;
-    addMetadata?: boolean;
-    addBreadcrumb?: boolean;
-    setUser?: boolean;
-    setRouteName?: boolean;
-    setPageName?: boolean;
-    reportError?: boolean;
-    reportFeatureFlag?: boolean;
-    recordSession?: boolean;
-    recordSessionStop?: boolean;
-  };
-
-  /**
-   * The min event level for events to be sent to the reporter.
-   */
-  eventLevel?: LogLevel;
-
-  /**
-   * Categories of breadcrumbs to ignore sending to the reporter.
-   * This is useful to prevent data of no use for that reporter.
-   */
-  ignoreBreadcrumbCategories?: string[];
-
-  /**
-   * Ignore specific metadata keys from being sent to the reporter.
-   * This can be a regular expression, or a string to exact match.
-   * This is useful to prevent data of no use for the reporter, or if the data keys are too long.
-   */
-  ignoreMetadataPatterns?: (string | RegExp)[];
-}
-
-/**
- * A Reporter is a service that can receive Analytics data.
- */
-export interface IReporter extends ReporterConfigBase {
-  trackEvent(event: ReporterEvent): void;
-  addBreadcrumb(breadcrumb: ReporterBreadcrumb): void;
-  addMetadata(metadata: Metadata): void;
-  setUser(user: ReportUser | null): void;
-  setRouteName(routeName: string): void;
-  setPageName(pageName: string): void;
-  reportError?(error: ReportError, metadata?: Metadata): void;
-  reportFeatureFlag?(flag: ReporterFlag): void;
-  recordSession?(): void;
-  recordSessionStop?(): void;
-}

package/src/utils.test.ts

@@ -1,32 +0,0 @@
-import { filterReporterMetadata } from './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 = 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();
-    });
-  });
-});

package/src/utils.ts

@@ -1,42 +0,0 @@
-import { IReporter, Metadata } from './types';
-
-/**
- * Recursively filter reporter metadata.
- * @param metadata Deep Metadata to filter.
- * @param reporter Reporter with filter config.
- * @param prefix Prefix for recusring nested metadata.
- * @returns Filtered metadata.
- */
-export function filterReporterMetadata<TMetadata extends Metadata | undefined>(
-  metadata: TMetadata,
-  reporter: Pick<IReporter, 'ignoreMetadataPatterns'>,
-  prefix?: string,
-  depth = 0,
-  maxDepth = 10,
-): TMetadata {
-  const ignorePatterns = reporter.ignoreMetadataPatterns;
-
-  // No metadata, or no patterns.
-  if (metadata === undefined || !ignorePatterns || depth > maxDepth) {
-    return metadata;
-  }
-
-  const entries = Object.entries(metadata);
-
-  return Object.fromEntries(
-    entries
-      .filter(([key]) => {
-        const fullKey = prefix ? prefix + key : key;
-        return !ignorePatterns.some((pattern) =>
-          typeof pattern === 'string' ? pattern === fullKey : pattern.test(fullKey),
-        );
-      })
-      .map(([key, value]) => {
-        if (typeof value === 'object' && value !== null) {
-          const fullKey = prefix ? prefix + key : key;
-          return [key, filterReporterMetadata(value, reporter, `${fullKey}.`, depth + 1, maxDepth)];
-        }
-        return [key, value];
-      }),
-  ) as TMetadata;
-}