noibu-react-native 0.0.1

package/dist/api/inputManager.js

@@ -0,0 +1,233 @@
+import { NOIBUJS_SDK_REQUEST_HELP_CODE, NOIBUJS_SDK_ADD_ID_FUNCTION, NOIBUJS_SDK_ADD_ERROR_FUNCTION, NOIBUJS_SDK_ADD_ERROR_FROM_JS_FMW_FUNCTION, MAX_CUSTOM_ERRORS_PER_PAGEVISIT, REACT_ERROR_EVENT_TYPE, VUE_ERROR_EVENT_TYPE, MAX_CUSTOM_IDS_PER_PAGEVISIT, META_DATA_METROPLEX_TYPE, PAGE_VISIT_META_DATA_ATT_NAME, CUSTOM_ID_NAME_TYPE, CUSTOM_ID_VALUE_TYPE, CUSTOM_ERROR_EVENT_TYPE } from '../constants.js';
+import MetroplexSocket from './metroplexSocket.js';
+import { saveErrorToPagevisit } from '../pageVisit/pageVisitEventError/pageVisitEventError.js';
+import HelpCode from './helpCode.js';
+
+/** @module InputManager */
+
+/** this class controls the input that customers can inject into
+ * our script via the NoibuJS SDK
+ */
+class InputManager {
+  /**
+   * Creates a new InputManager
+   */
+  constructor() {
+    this.customIDs = {};
+    this.customErrorsCount = 0;
+
+    this.TOO_MANY_IDS_ADDED_MSG = 'TOO_MANY_IDS_ADDED';
+    this.ID_NAME_ALREADY_ADDED_MSG = 'ID_NAME_ALREADY_ADDED';
+    this.NAME_TOO_LONG_MSG = 'NAME_TOO_LONG';
+    this.VALUE_TOO_LONG_MSG = 'VALUE_TOO_LONG';
+    this.INVALID_NAME_TYPE_MSG = 'INVALID_NAME_TYPE';
+    this.INVALID_VALUE_TYPE_MSG = 'INVALID_VALUE_TYPE';
+    this.NAME_HAS_NO_LENGTH_MSG = 'NAME_HAS_NO_LENGTH';
+    this.VALUE_HAS_NO_LENGTH_MSG = 'VALUE_HAS_NO_LENGTH';
+    this.SUCCESS_MSG = 'SUCCESS';
+    this.ERROR_HAS_NO_MSG_MSG = 'ERROR_HAS_NO_MSG';
+    this.ERROR_HAS_NO_STACK_MSG = 'ERROR_HAS_NO_STACK';
+    this.NULL_CUSTOM_ERR_MSG = 'NULL_CUSTOM_ERROR';
+    this.ERROR_ALREADY_RECEIVED_MSG = 'ERROR_ALREADY_RECEIVED';
+    this.INVALID_ERROR_SOURCE_MSG = 'INVALID_ERROR_SOURCE_MSG';
+    this.TOO_MANY_ERRORS_RECEIVED_PER_PAGEVISIT_MSG =
+      'TOO_MANY_ERRORS_RECEIVED_PER_PAGEVISIT';
+  }
+
+  /** gets the singleton instance */
+  static getInstance() {
+    if (!this.instance) {
+      this.instance = new InputManager();
+    }
+
+    return this.instance;
+  }
+
+  /** exposes functions to the window of the browser for the clients
+   * to interact with on their end
+   */
+  exposeFunctions() {
+    return this._getSDKWindowObject();
+  }
+
+  /**
+   * gets the sdk object that will be assigned to a window variable
+   * @returns {{
+   *    requestHelpCode: (alert?: boolean) => Promise<string>,
+   *    addCustomAttribute: (name: string, value: string) => string,
+   *    addError: (customError: Error) => string,
+   *    addJsSdkError: (customError: string, errorSource: string) => string
+   * }}
+   */
+  _getSDKWindowObject() {
+    return {
+      // adding all the functions and binding the current context
+      // so that we can use the exposed function as if they are running`
+      // in the noibujs script
+      [NOIBUJS_SDK_REQUEST_HELP_CODE]: this._requestHelpCode.bind(this),
+      [NOIBUJS_SDK_ADD_ID_FUNCTION]: this._addCustomAttribute.bind(this),
+      [NOIBUJS_SDK_ADD_ERROR_FUNCTION]: this._addCustomError.bind(this),
+      [NOIBUJS_SDK_ADD_ERROR_FROM_JS_FMW_FUNCTION]:
+        this._addErrorFromJSSdk.bind(this),
+    };
+  }
+
+  /**
+   * validates the custom error that was passed
+   * @param  {} customError
+   */
+  _validateCustomError(customError) {
+    // customError cannot be null
+    if (!customError) {
+      return this.NULL_CUSTOM_ERR_MSG;
+    }
+
+    // making sure we have the message and stack to create an error signature
+    if (!customError.message) {
+      return this.ERROR_HAS_NO_MSG_MSG;
+    }
+
+    if (!customError.stack) {
+      return this.ERROR_HAS_NO_STACK_MSG;
+    }
+
+    return this.SUCCESS_MSG;
+  }
+
+  /**
+   * Validates and sets the custom error to our internal trackers
+   * @param  {} customError
+   */
+  _validateAndSetCustomError(customError) {
+    // we cap the number of errors allowed to be sent
+    if (this.customErrorsCount >= MAX_CUSTOM_ERRORS_PER_PAGEVISIT) {
+      return this.TOO_MANY_ERRORS_RECEIVED_PER_PAGEVISIT_MSG;
+    }
+
+    // need to validate first before we start operating with the received
+    // data
+    const validationResult = this._validateCustomError(customError);
+    if (validationResult !== this.SUCCESS_MSG) {
+      return validationResult;
+    }
+
+    this.customErrorsCount += 1;
+    return this.SUCCESS_MSG;
+  }
+
+  /**
+   * adds an error from a JS Sdk to the session
+   * @param  {} customError
+   */
+  _addErrorFromJSSdk(customError, errorSource) {
+    const validationAndSettingResult =
+      this._validateAndSetCustomError(customError);
+    if (validationAndSettingResult !== this.SUCCESS_MSG) {
+      return validationAndSettingResult;
+    }
+
+    // we only support two sdks today, increase this list as we add more
+    if (
+      errorSource !== REACT_ERROR_EVENT_TYPE &&
+      errorSource !== VUE_ERROR_EVENT_TYPE
+    ) {
+      return this.INVALID_ERROR_SOURCE_MSG;
+    }
+
+    saveErrorToPagevisit(errorSource, { error: customError });
+    return validationAndSettingResult;
+  }
+
+  /**
+   * adds a custom Error to the session
+   * @param  {} customError
+   */
+  _addCustomError(customError) {
+    const validationAndSettingResult =
+      this._validateAndSetCustomError(customError);
+    if (validationAndSettingResult !== this.SUCCESS_MSG) {
+      return validationAndSettingResult;
+    }
+    saveErrorToPagevisit(CUSTOM_ERROR_EVENT_TYPE, { error: customError });
+    return validationAndSettingResult;
+  }
+
+  /**
+   * adds a custom id to the session
+   * @param  {} name
+   * @param  {} value
+   */
+  _addCustomAttribute(name, value) {
+    // we return if we are over the limit of ids
+    if (Object.keys(this.customIDs).length >= MAX_CUSTOM_IDS_PER_PAGEVISIT) {
+      return this.TOO_MANY_IDS_ADDED_MSG;
+    }
+
+    // need to validate first before we start operating with the received
+    // data
+    const validationResult = this._validateCustomIDInput(name, value);
+    if (validationResult !== this.SUCCESS_MSG) {
+      return validationResult;
+    }
+
+    // we do not want to keep sending something that was already sent
+    if (name in this.customIDs) {
+      return this.ID_NAME_ALREADY_ADDED_MSG;
+    }
+
+    this.customIDs[name] = value;
+    MetroplexSocket.getInstance().sendMessage(META_DATA_METROPLEX_TYPE, {
+      [PAGE_VISIT_META_DATA_ATT_NAME]: {
+        [CUSTOM_ID_NAME_TYPE]: name,
+        [CUSTOM_ID_VALUE_TYPE]: value,
+      },
+    });
+
+    return this.SUCCESS_MSG;
+  }
+
+  /**
+   * validation function for customer input
+   * @param  {} name
+   * @param  {} value
+   */
+  _validateCustomIDInput(name, value) {
+    // all ids need to be strings and less than 50 chars and more than 0 chars
+    if (typeof name !== 'string') {
+      return this.INVALID_NAME_TYPE_MSG;
+    }
+
+    if (typeof value !== 'string') {
+      return this.INVALID_VALUE_TYPE_MSG;
+    }
+
+    if (value.length > 50) {
+      return this.VALUE_TOO_LONG_MSG;
+    }
+
+    if (name.length > 50) {
+      return this.NAME_TOO_LONG_MSG;
+    }
+
+    if (value.length === 0) {
+      return this.VALUE_HAS_NO_LENGTH_MSG;
+    }
+
+    if (name.length === 0) {
+      return this.NAME_HAS_NO_LENGTH_MSG;
+    }
+
+    return this.SUCCESS_MSG;
+  }
+
+  /**
+   * Requests a help code from the HelpCode instance.
+   * @param {boolean} [alertUser=true] - Whether to alert the user about the help code request.
+   * @returns {Promise<string>} A promise that resolves with the requested help code.
+   */
+  _requestHelpCode(alertUser = true) {
+    return HelpCode.getInstance().requestHelpCode(alertUser);
+  }
+}
+
+export { InputManager as default };