castled-js-sdk 0.0.3 → 0.0.5

package/src/features/core/metrics/errorReporting/providers/Bugsnag.js

@@ -1,240 +0,0 @@
-/* eslint-disable no-underscore-dangle */
-import ScriptLoader from '../../../../../utils/ScriptLoader';
-import { configToIntNames } from '../../../../../utils/config_to_integration_names';
-import {
-  ERROR_REPORTING_SERVICE_GLOBAL_KEY_NAME,
-  MAX_WAIT_FOR_INTEGRATION_LOAD,
-} from '../../../../../utils/constants';
-import { get } from '../../../../../utils/utils';
-
-// Using the Bugsnag integration version to avoid version issues
-const BUGSNAG_CDN_URL = 'https://d2wy8f7a9ursnm.cloudfront.net/v6/bugsnag.min.js';
-const BUGSNAG_VALID_MAJOR_VERSION = '6';
-const ERROR_REPORT_PROVIDER_NAME_BUGSNAG = 'rs-bugsnag';
-const BUGSNAG_LIB_INSTANCE_GLOBAL_KEY_NAME = 'bugsnag'; // For version 6 and bellow
-const BUGSNAG_LIB_V7_INSTANCE_GLOBAL_KEY_NAME = 'Bugsnag';
-const GLOBAL_LIBRARY_OBJECT_NAMES = [
-  BUGSNAG_LIB_V7_INSTANCE_GLOBAL_KEY_NAME,
-  BUGSNAG_LIB_INSTANCE_GLOBAL_KEY_NAME,
-];
-
-// This API key token is parsed in the CI pipeline
-const API_KEY = '__RS_BUGSNAG_API_KEY__';
-
-// Errors only from Below SDKs are allowed to reach Bugsnag
-const SDK_FILE_NAMES = [
-  'events.min.js',
-  'events-staging.min.js',
-  'events.js',
-  ...Object.keys(configToIntNames).map((intgName) => `${configToIntNames[intgName]}.min.js`),
-  ...Object.keys(configToIntNames).map(
-    (intgName) => `${configToIntNames[intgName]}-staging.min.js`,
-  ),
-  ...Object.keys(configToIntNames).map((intgName) => `${configToIntNames[intgName]}.js`),
-];
-const BUGSNAG_ERROR_FILE_ORIGIN_KEY = 'stacktrace.0.file';
-
-const getReleaseStage = () => {
-  const host = window.location.hostname;
-  const devHosts = ['www.rs-unit-test-host.com', 'localhost', '127.0.0.1', '[::1]'];
-
-  return host && devHosts.includes(host) ? 'development' : '__RS_BUGSNAG_RELEASE_STAGE__';
-};
-
-const isValidVersion = (globalLibInstance) => {
-  // For version 7
-  let version =
-    globalLibInstance &&
-    globalLibInstance._client &&
-    globalLibInstance._client._notifier &&
-    globalLibInstance._client._notifier.version;
-
-  // For versions older than 7
-  if (!version) {
-    let tempInstance = globalLibInstance({
-      apiKey: API_KEY,
-      releaseStage: 'version-test',
-      // eslint-disable-next-line func-names, object-shorthand
-      beforeSend: function () {
-        return false;
-      },
-    });
-    version = tempInstance.notifier && tempInstance.notifier.version;
-    tempInstance = undefined;
-  }
-
-  return version && version.charAt(0) === BUGSNAG_VALID_MAJOR_VERSION;
-};
-
-const isRudderSDKError = (event) => {
-  const errorOrigin = get(event, BUGSNAG_ERROR_FILE_ORIGIN_KEY);
-
-  if (!errorOrigin || typeof errorOrigin !== 'string') {
-    return false;
-  }
-
-  const srcFileName = errorOrigin.substring(errorOrigin.lastIndexOf('/') + 1);
-  return SDK_FILE_NAMES.includes(srcFileName);
-};
-
-const enhanceErrorEventMutator = (event, metadataSource) => {
-  event.updateMetaData('source', {
-    metadataSource,
-  });
-
-  const { errorMessage } = event;
-  // eslint-disable-next-line no-param-reassign
-  event.context = errorMessage;
-
-  // Hack for easily grouping the script load errors
-  // on the dashboard
-  if (errorMessage.includes('error in script loading')) {
-    // eslint-disable-next-line no-param-reassign
-    event.context = 'Script load failures';
-  }
-
-  // eslint-disable-next-line no-param-reassign
-  event.severity = 'error';
-};
-
-const loadBugsnagSDKScript = (name) => {
-  const isNotLoaded = GLOBAL_LIBRARY_OBJECT_NAMES.every(
-    (globalKeyName) => !Object.hasOwn(window, globalKeyName),
-  );
-
-  if (isNotLoaded) {
-    ScriptLoader(name, BUGSNAG_CDN_URL, {
-      isNonNativeSDK: 'true',
-      skipDatasetAttributes: true,
-    });
-  }
-};
-
-class BugsnagProvider {
-  constructor(sourceId, onClientReady) {
-    this.pluginName = ERROR_REPORT_PROVIDER_NAME_BUGSNAG;
-    this.sourceId = sourceId;
-    this.onClientReady = onClientReady;
-    this.initClientOnLibReadyInterval = undefined;
-    this.init();
-  }
-
-  /**
-   * The responsibility of this function is to check Bugsnag native SDK
-   * has been loaded or not in a certain interval.
-   * If already loaded initialize the SDK.
-   */
-  init() {
-    // Return if RS Bugsnag instance is already initialized
-    if (window.HtEventsGlobals && window.HtEventsGlobals[ERROR_REPORTING_SERVICE_GLOBAL_KEY_NAME]) {
-      return;
-    }
-
-    const apiKeyRegex = /{{.+}}/;
-    const isAPIKeyValid = !API_KEY.match(apiKeyRegex);
-
-    // If API key token is not parsed or invalid, don't proceed to initialize the client
-    if (!isAPIKeyValid) {
-      return;
-    }
-
-    /**
-     * This function will load the Bugsnag native SDK through CDN
-     * Once loaded it will be available in window.Bugsnag
-     */
-    loadBugsnagSDKScript(this.pluginName);
-
-    const globalBugsnagLibInstance = window[BUGSNAG_LIB_INSTANCE_GLOBAL_KEY_NAME];
-
-    // Initialize if SDK is loaded and has valid version else return if other version exists
-    if (typeof globalBugsnagLibInstance === 'function') {
-      if (isValidVersion(globalBugsnagLibInstance)) {
-        this.initClient();
-      }
-
-      return;
-    }
-
-    // Check if Bugsnag is loaded with valid version every '100'ms
-    this.initClientOnLibReadyInterval = setInterval(() => {
-      const globalBugsnagLibInstanceOnInterval = window[BUGSNAG_LIB_INSTANCE_GLOBAL_KEY_NAME];
-
-      if (typeof globalBugsnagLibInstanceOnInterval === 'function') {
-        if (isValidVersion(globalBugsnagLibInstanceOnInterval)) {
-          this.initClient();
-        }
-
-        clearInterval(this.initClientOnLibReadyInterval);
-      }
-    }, 100);
-
-    // Abort checking for the library after timeout expires
-    setTimeout(() => {
-      clearInterval(this.initClientOnLibReadyInterval);
-    }, MAX_WAIT_FOR_INTEGRATION_LOAD);
-  }
-
-  /**
-   * This function is to initialize the bugsnag with apiKey, SDK metadata
-   * and custom configuration for onError method.
-   * After initialization Bugsnag instance will be available in window.rsBugsnagClient
-   */
-  initClient() {
-    const globalBugsnagLibInstance = window[BUGSNAG_LIB_INSTANCE_GLOBAL_KEY_NAME];
-
-    this.client = globalBugsnagLibInstance({
-      apiKey: API_KEY,
-      appVersion: '__PACKAGE_VERSION__', // Set SDK version as the app version from build config
-      metaData: {
-        SDK: {
-          name: 'JS',
-          installType: '__MODULE_TYPE__',
-        },
-      },
-      beforeSend: this.onError(),
-      autoTrackSessions: false, // auto tracking sessions is disabled
-      collectUserIp: false, // collecting user's IP is disabled
-      enabledBreadcrumbTypes: ['error', 'log', 'user'],
-      maxEvents: 100,
-      releaseStage: getReleaseStage(),
-      networkBreadcrumbsEnabled: false,
-    });
-
-    this.onClientReady();
-  }
-
-  onError() {
-    const metadataSource = this.sourceId;
-
-    return (event) => {
-      try {
-        // Discard the event if it's not originated at the SDK
-        if (!isRudderSDKError(event)) {
-          return false;
-        }
-
-        enhanceErrorEventMutator(event, metadataSource);
-
-        return true;
-      } catch {
-        // Drop the error event if it couldn't be filtered as
-        // it is most likely a non-SDK error
-        return false;
-      }
-    };
-  }
-
-  notify(error) {
-    if (this.client) {
-      this.client.notify(error);
-    }
-  }
-
-  leaveBreadcrumb(error) {
-    if (this.client) {
-      this.client.leaveBreadcrumb(error);
-    }
-  }
-}
-
-export { ERROR_REPORT_PROVIDER_NAME_BUGSNAG, BugsnagProvider };

package/src/features/core/session/index.js

@@ -1,207 +0,0 @@
-/* eslint-disable consistent-return */
-/* eslint-disable class-methods-use-this */
-/* eslint-disable import/prefer-default-export */
-import Storage from '../../../utils/storage';
-import logger from '../../../utils/logUtil';
-import {
-  DEFAULT_SESSION_TIMEOUT,
-  MIN_SESSION_TIMEOUT,
-  MIN_SESSION_ID_LENGTH,
-} from '../../../utils/constants';
-import { countDigits } from '../../../utils/utils';
-import { handleError } from '../../../utils/errorHandler';
-
-class UserSession {
-  constructor() {
-    this.storage = Storage;
-    this.timeout = DEFAULT_SESSION_TIMEOUT;
-    // Fetch session information from storage if any or enable auto track
-    this.sessionInfo = this.storage.getSessionInfo() || { autoTrack: true };
-  }
-
-  /**
-   * A function to initialize session information
-   * @param {object} options    load call options
-   */
-  initialize(options) {
-    try {
-      /**
-       * By default this.autoTrack will be true
-       * Cases where this.autoTrack will be false:
-       * 1. User explicitly set autoTrack load option to false
-       * 2. When user is manually tracking the session
-       *
-       * Depending on the use case, this.autoTrack is set to true/false.
-       */
-      this.sessionInfo.autoTrack = !(
-        options?.sessions?.autoTrack === false || this.sessionInfo.manualTrack
-      );
-      /**
-       * Validate "timeout" input. Should be provided in milliseconds.
-       * Session timeout: By default, a session lasts until there's 30 minutes of inactivity,
-       * but you can configure this limit using "timeout" load option
-       */
-      if (options?.sessions && !isNaN(options.sessions.timeout)) {
-        const { timeout } = options.sessions;
-        // In case user provides 0 as the timeout, auto session tracking will be disabled
-        if (timeout === 0) {
-          logger.warn(
-            '[Session]:: Provided timeout value 0 will disable the auto session tracking feature.',
-          );
-          this.sessionInfo.autoTrack = false;
-        }
-        // In case user provides a setTimeout value greater than 0 but less than 10 seconds SDK will show a warning
-        // and will proceed with it
-        if (timeout > 0 && timeout < MIN_SESSION_TIMEOUT) {
-          logger.warn('[Session]:: It is not advised to set "timeout" less than 10 seconds');
-        }
-        this.timeout = timeout;
-      }
-      // If auto session tracking is enabled start the session tracking
-      if (this.sessionInfo.autoTrack) {
-        this.startAutoTracking();
-      } else if (this.sessionInfo.autoTrack === false && !this.sessionInfo.manualTrack) {
-        /**
-         * Use case:
-         * By default user session is enabled which means storage will have session data.
-         * In case user wanted to opt out and set auto track to false through load option,
-         * clear stored session info.
-         */
-        this.end();
-      }
-    } catch (e) {
-      handleError(e);
-    }
-  }
-
-  /**
-   * A function to validate current session and return true/false depending on that
-   * @param {number} timestamp
-   * @returns boolean
-   */
-  isValidSession(timestamp) {
-    return timestamp <= this.sessionInfo.expiresAt;
-  }
-
-  /**
-   * A function to generate session id
-   * @returns number
-   */
-  generateSessionId() {
-    return Date.now();
-  }
-
-  /**
-   * A function to check for existing session details and depending on that create a new session.
-   */
-  startAutoTracking() {
-    const timestamp = Date.now();
-    if (!this.isValidSession(timestamp)) {
-      this.sessionInfo = {};
-      this.sessionInfo.id = timestamp; // set the current timestamp
-      this.sessionInfo.expiresAt = timestamp + this.timeout; // set the expiry time of the session
-      this.sessionInfo.sessionStart = true;
-      this.sessionInfo.autoTrack = true;
-    }
-    this.storage.setSessionInfo(this.sessionInfo);
-  }
-
-  /**
-   * Function to validate user provided sessionId
-   * @param {number} sessionId
-   * @returns
-   */
-  validateSessionId(sessionId) {
-    if (typeof sessionId !== 'number' || sessionId % 1 !== 0) {
-      logger.error(`[Session]:: "sessionId" should only be a positive integer`);
-      return;
-    }
-    if (countDigits(sessionId) < MIN_SESSION_ID_LENGTH) {
-      logger.error(
-        `[Session]:: "sessionId" should at least be "${MIN_SESSION_ID_LENGTH}" digits long`,
-      );
-      return;
-    }
-    return sessionId;
-  }
-
-  /**
-   * A public method to start a session
-   * @param {number} sessionId     session identifier
-   * @returns
-   */
-  start(id) {
-    const sessionId = id ? this.validateSessionId(id) : this.generateSessionId();
-
-    this.sessionInfo = {
-      id: sessionId || this.generateSessionId(),
-      sessionStart: true,
-      manualTrack: true,
-    };
-    this.storage.setSessionInfo(this.sessionInfo);
-  }
-
-  /**
-   * A function to return current session id
-   * @returns string sessionId
-   */
-  getSessionId() {
-    if (
-      (this.sessionInfo.autoTrack && this.isValidSession(Date.now())) ||
-      this.sessionInfo.manualTrack
-    ) {
-      return this.sessionInfo.id;
-    }
-    return null;
-  }
-
-  /**
-   * A public method to end an ongoing session.
-   */
-  end() {
-    this.sessionInfo = {};
-    this.storage.removeSessionInfo();
-  }
-
-  /**
-   * A function get ongoing sessionId.
-   */
-  getSessionInfo() {
-    const session = {};
-    if (this.sessionInfo.autoTrack || this.sessionInfo.manualTrack) {
-      // renew or create a new auto-tracking session
-      if (this.sessionInfo.autoTrack) {
-        const timestamp = Date.now();
-        if (!this.isValidSession(timestamp)) {
-          this.startAutoTracking();
-        } else {
-          this.sessionInfo.expiresAt = timestamp + this.timeout; // set the expiry time of the session
-        }
-      }
-
-      if (this.sessionInfo.sessionStart) {
-        session.sessionStart = true;
-        this.sessionInfo.sessionStart = false;
-      }
-      session.sessionId = this.sessionInfo.id;
-      this.storage.setSessionInfo(this.sessionInfo);
-    }
-    return session;
-  }
-
-  /**
-   * Refresh session info on reset API call
-   */
-  reset() {
-    const { manualTrack, autoTrack } = this.sessionInfo;
-    if (autoTrack) {
-      this.sessionInfo = {};
-      this.startAutoTracking();
-    } else if (manualTrack) {
-      this.start();
-    }
-  }
-}
-
-const userSession = new UserSession();
-export { userSession as UserSession };

package/src/integrations/ActiveCampaign/browser.js

@@ -1,52 +0,0 @@
-/* eslint-disable class-methods-use-this */
-import { NAME } from './constants';
-import logger from '../../utils/logUtil';
-import { loadNativeSdk } from './nativeSdkLoader';
-import get from 'get-value';
-
-class ActiveCampaign {
-  constructor(config, analytics, destinationInfo) {
-    if (analytics.logLevel) {
-      logger.setLogLevel(analytics.logLevel);
-    }
-    this.actId = config.actid;
-    this.name = NAME;
-    ({
-      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
-      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
-      destinationId: this.destinationId,
-    } = destinationInfo ?? {});
-  }
-
-  init() {
-    logger.debug('===In init ActiveCampaign===');
-
-    if (!this.actId) {
-      logger.debug('actId missing');
-      return;
-    }
-    loadNativeSdk(this.actId);
-  }
-
-  isLoaded() {
-    logger.debug('===In isLoaded ActiveCampaign===');
-    return !!window.vgo;
-  }
-
-  isReady() {
-    logger.debug('===In isReady ActiveCampaign===');
-    return !!window.vgo;
-  }
-
-  page(htElement) {
-    const { message } = htElement;
-    const email = get(message, 'context.traits.email') || get(message, 'traits.email');
-
-    if (email) {
-      window.vgo('setEmail', email);
-    }
-    window.vgo('process');
-  }
-}
-
-export default ActiveCampaign;

package/src/integrations/ActiveCampaign/constants.js

@@ -1,14 +0,0 @@
-const NAME = 'ACTIVE_CAMPAIGN';
-const CNameMapping = {
-  'ActiveCampaign': NAME,
-  'Active Campaign': NAME,
-  'ACTIVE CAMPAIGN': NAME,
-  [NAME]: NAME,
-  'activecampaign': NAME,
-  'active campaign': NAME,
-  'Active campaign': NAME,
-  'active Campaign': NAME,
-  'active_campaign': NAME,
-};
-
-export { NAME, CNameMapping };

package/src/integrations/ActiveCampaign/index.js

@@ -1,3 +0,0 @@
-import ActiveCampaign from './browser';
-
-export { ActiveCampaign };

package/src/integrations/ActiveCampaign/nativeSdkLoader.js

@@ -1,24 +0,0 @@
-import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
-
-function loadNativeSdk(actId) {
-  (function (e, t, o, n, p, r, i) {
-    e.visitorGlobalObjectAlias = n;
-    e[e.visitorGlobalObjectAlias] =
-      e[e.visitorGlobalObjectAlias] ||
-      function () {
-        (e[e.visitorGlobalObjectAlias].q = e[e.visitorGlobalObjectAlias].q || []).push(arguments);
-      };
-    e[e.visitorGlobalObjectAlias].l = new Date().getTime();
-    r = t.createElement('script');
-    r.src = o;
-    r.async = true;
-    r.setAttribute('data-loader', LOAD_ORIGIN);
-    i = t.getElementsByTagName('script')[0];
-    i.parentNode.insertBefore(r, i);
-  })(window, document, 'https://diffuser-cdn.app-us1.com/diffuser/diffuser.js', 'vgo');
-  window.vgo('setAccount', actId);
-  window.vgo('setTrackByDefault', true);
-  window.vgo('process');
-}
-
-export { loadNativeSdk };