noibu-react-native 0.0.1 → 0.0.3

package/README.md

@@ -29,12 +29,14 @@ npm install noibu-react-native --save
 
 ## Usage
 
-Wrap your root App component into SDK ErrorBoundary:
+Call a setup method and wrap your root App component into SDK ErrorBoundary:
 
 ```jsx
 import React from 'react';
 import { View, Text } from 'react-native';
-import { ErrorBoundary } from 'noibu-react-native';
+import { ErrorBoundary, setupNoibu } from 'noibu-react-native';
+
+setupNoibu({ domain: 'react-native-app.myshop.com' })
 
 export default function App() {
   return (
@@ -53,7 +55,7 @@ export default function App() {
 }
 ```
 
-That's it! First time the module is imported, it runs an init and starts listening to errors.
+That's it! First time the module is set up, it runs an init and starts listening to errors.
 
 ## Configuration
 
@@ -95,19 +97,19 @@ const AlertHelpCode = () => {
 };
 ```
 
-#### `addCustomAttribute(name: string, value: string) => string`
+#### `addCustomAttribute(name: string, value: string) => Promise<string>`
 
 Adds a custom attribute to the session.
 
 - `@param {string} name` - Name of a custom attribute.
 - `@param {any} value` - It's value, should be a JSON.stringify-able type.
-- `@returns {string}` - A success message, or validation failure cause.
+- `@returns {Promise<string>}` - A success message, or validation failure cause.
 
 ```js
 import { NoibuJS } from 'noibu-react-native';
 
-NoibuJS.addCustomAttribute('myNameIs', 'Jeff'); // SUCCESS
-NoibuJS.addCustomAttribute('veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLong', 'Jeff'); // NAME_TOO_LONG
+NoibuJS.addCustomAttribute('myNameIs', 'Jeff'); // Promise<SUCCESS>
+NoibuJS.addCustomAttribute('veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLong', 'Jeff'); // Promise<NAME_TOO_LONG>
 ```
 
 #### `addError(customError: Error) => string`

package/dist/api/clientConfig.js

@@ -1,6 +1,6 @@
 import uuid from 'react-native-uuid';
 import { MAX_METROPLEX_SOCKET_INNACTIVE_TIME, DISABLED_STATUS_KEY, CLIENT_UNLOCK_TIME_KEY, SEVERITY_WARN, LAST_ACTIVE_TIME_KEY, CURRENT_PAGE_VISIT_COUNT_KEY, NOIBU_BROWSER_ID_KYWRD, BROWSER_ID_KEY, PV_SEQ_NUM_RESET_TIME_MINUTES, SEVERITY_ERROR, JS_ENV, PAGE_VISIT_ID_KEY, MAX_PAGEVISIT_VISITED, CLIENT_LOCK_TIME_MINUTES, GET_SCRIPT_ID, MAX_COLLECT_ERROR_LOG } from '../constants.js';
-import { stringifyJSON, getUserAgent, asString, makeRequest } from '../utils/function.js';
+import { stringifyJSON, getUserAgent, asString, getProperGlobalUrl, makeRequest } from '../utils/function.js';
 import Storage from '../storage/storage.js';
 
 /** @module ClientConfig */
@@ -14,9 +14,10 @@ import Storage from '../storage/storage.js';
 class ClientConfig {
   /**
    * Creates a ClientConfig singleton instance
-   * @param  {} noibuErrorURL
+   * @param {string} noibuErrorURL
+   * @param {string} customerDomain
    */
-  constructor(noibuErrorURL) {
+  constructor(noibuErrorURL, customerDomain) {
     // sets up this.browserId, this.disabledStatus
     this.pageVisitId = uuid.v4();
     // variables stored in storage
@@ -36,16 +37,18 @@ class ClientConfig {
     // variables for checking if the socket is inactive
     // used a class variables in order to be changed in testing
     this.maxSocketInactiveTime = MAX_METROPLEX_SOCKET_INNACTIVE_TIME;
+
+    this.customerDomain = customerDomain;
   }
 
   /** Configures the singleton instance */
-  static configureInstance(noibuErrorURL) {
+  static configureInstance({ noibuErrorURL, customerDomain }) {
     if (!this.instance) {
       // Set this.noibuErrorURL preemptively in case ClientConfig isn't able to be
       // configured properly and throws an error.
       // This will ensure we get the expected error POST request at the correct URL.
       this.noibuErrorURL = noibuErrorURL;
-      this.instance = new ClientConfig(noibuErrorURL);
+      this.instance = new ClientConfig(noibuErrorURL, customerDomain);
       this.instance.noibuErrorURL = noibuErrorURL;
     }
   }
@@ -64,14 +67,14 @@ class ClientConfig {
 
   /** lockClient will disable the client script for a single pagevisit for
    * duration given in minuntes */
-  lockClient(duration, msg) {
+  async lockClient(duration, msg) {
     const expiryTime = new Date();
     expiryTime.setMinutes(expiryTime.getMinutes() + duration);
 
-    const noibuLSObject = this._getClientState();
+    const noibuLSObject = await this._getClientState();
     noibuLSObject[DISABLED_STATUS_KEY] = true;
     noibuLSObject[CLIENT_UNLOCK_TIME_KEY] = expiryTime;
-    this._storeBrowserData(noibuLSObject);
+    await this._storeBrowserData(noibuLSObject);
     this.postNoibuErrorAndOptionallyDisableClient(msg, true, SEVERITY_WARN);
   }
 
@@ -81,23 +84,23 @@ class ClientConfig {
   }
 
   /**  Updates the config object to store the given last active time */
-  updateLastActiveTime(lastActiveTime) {
+  async updateLastActiveTime(lastActiveTime) {
     this.lastActiveTime = lastActiveTime;
-    const newConfigData = this._getLsObject();
+    const newConfigData = await this._getLsObject();
     newConfigData[LAST_ACTIVE_TIME_KEY] = lastActiveTime;
-    this._storeBrowserData(newConfigData);
+    await this._storeBrowserData(newConfigData);
   }
 
   /**  Gets the current page visit sequence number that should be used */
-  getPageVisitSeq() {
-    if (this._pageVisitSeqNeedsReset()) {
+  async getPageVisitSeq() {
+    if (await this._pageVisitSeqNeedsReset()) {
       // Reset the page visit sequence number to zero and store the next seq number in storage
       this.pageVisitSeq = 0;
-      const newConfigData = this._getLsObject();
+      const newConfigData = await this._getLsObject();
       newConfigData[CURRENT_PAGE_VISIT_COUNT_KEY] = this.pageVisitSeq + 1;
       // Update the last active time since we are actively requesting the seq
       newConfigData[LAST_ACTIVE_TIME_KEY] = new Date();
-      this._storeBrowserData(newConfigData);
+      await this._storeBrowserData(newConfigData);
     }
 
     return this.pageVisitSeq;
@@ -115,9 +118,9 @@ class ClientConfig {
    * LastActiveTime: DATE OBJ
    * }
    */
-  _getLsObject() {
+  async _getLsObject() {
     const storage = Storage.getInstance();
-    const storedConfig = storage.load(NOIBU_BROWSER_ID_KYWRD);
+    const storedConfig = await storage.load(NOIBU_BROWSER_ID_KYWRD);
 
     // first time browsing since noibu was installed
     if (!storedConfig) {
@@ -148,8 +151,8 @@ class ClientConfig {
   /**
    * Check if we have surpased the last active time and the page visit seq number needs resetting
    */
-  _pageVisitSeqNeedsReset() {
-    const noibuLSObject = this._getClientState();
+  async _pageVisitSeqNeedsReset() {
+    const noibuLSObject = await this._getClientState();
     const someTimeAgo = new Date();
     someTimeAgo.setMinutes(
       someTimeAgo.getMinutes() - PV_SEQ_NUM_RESET_TIME_MINUTES,
@@ -161,11 +164,11 @@ class ClientConfig {
    * _setupStorageVars will set all class variables that depend
    * on the storage's value.
    */
-  _setupStorageVars() {
+  async _setupStorageVars() {
     const storage = Storage.getInstance();
-    if (!storage.isAvailable()) {
+    if (!(await storage.isAvailable())) {
       this.postNoibuErrorAndOptionallyDisableClient(
-        `Storage is unavailable, disabling client. ${storage.getDiagnoseInfo()}`,
+        `Storage is unavailable, disabling client. ${await storage.getDiagnoseInfo()}`,
         true,
         SEVERITY_ERROR,
       );
@@ -173,10 +176,10 @@ class ClientConfig {
     }
 
     // getting the current content of the storage
-    const noibuLSObject = this._getClientState();
+    const noibuLSObject = await this._getClientState();
 
     // Check if we have surpased the last active time and reset the sequence number if so
-    if (this._pageVisitSeqNeedsReset()) {
+    if (await this._pageVisitSeqNeedsReset()) {
       noibuLSObject[CURRENT_PAGE_VISIT_COUNT_KEY] = 0;
     }
 
@@ -216,7 +219,7 @@ class ClientConfig {
     }
 
     // we now check if we successfully saved the data
-    const savedData = this._storeBrowserData(noibuLSObject);
+    const savedData = await this._storeBrowserData(noibuLSObject);
 
     // if the browser is null, we cannot access the storage or an
     // error happened, thus we disable collect.
@@ -237,8 +240,8 @@ class ClientConfig {
    * Get it from storage if the expiry date is not in the past
    * Generate a brand new one if the expiry date is in the past
    */
-  _getClientState() {
-    const newConfigData = this._getLsObject();
+  async _getClientState() {
+    const newConfigData = await this._getLsObject();
 
     // if the lock expired, we remove the lock period and enable the client
     if (
@@ -247,7 +250,7 @@ class ClientConfig {
     ) {
       newConfigData[CLIENT_UNLOCK_TIME_KEY] = null;
       newConfigData[DISABLED_STATUS_KEY] = false;
-      this._storeBrowserData(newConfigData);
+      await this._storeBrowserData(newConfigData);
     }
     // return the stored browserId
     return newConfigData;
@@ -257,9 +260,8 @@ class ClientConfig {
    * _generateAndStoreData generates brand new data and then proceeds to store
    * it.
    */
-  _generateAndStoreData() {
-    const data = this._storeBrowserData(this._generateNewBrowserData());
-    return data;
+  async _generateAndStoreData() {
+    return this._storeBrowserData(this._generateNewBrowserData());
   }
 
   /**
@@ -288,25 +290,24 @@ class ClientConfig {
    * _storeBrowserData will store the passed object in storage.
    * @param  {} data the data to be stored
    */
-  _storeBrowserData(data) {
+  async _storeBrowserData(data) {
     const storage = Storage.getInstance();
     try {
-      storage.save(NOIBU_BROWSER_ID_KYWRD, stringifyJSON(data));
+      await storage.save(NOIBU_BROWSER_ID_KYWRD, stringifyJSON(data));
       return data;
     } catch (e) {
       this.postNoibuErrorAndOptionallyDisableClient(
         `Error writing browser data to storage, disabling client: ${e.message}, ` +
-          `${storage.getDiagnoseInfo()}`,
+          `${await storage.getDiagnoseInfo()}`,
         true,
         SEVERITY_ERROR,
       );
       // sending empty fields if we encountered errors while storing in the LS
-      const invalidData = {
+      return {
         [DISABLED_STATUS_KEY]: true,
         [BROWSER_ID_KEY]: null,
         [CURRENT_PAGE_VISIT_COUNT_KEY]: 0,
       };
-      return invalidData;
     }
   }
 
@@ -352,10 +353,10 @@ class ClientConfig {
       const expiryTime = new Date();
       expiryTime.setMinutes(expiryTime.getMinutes() + 10); // 10 minutes lock
 
-      const noibuLSObject = this._getClientState();
+      const noibuLSObject = await this._getClientState();
       noibuLSObject[DISABLED_STATUS_KEY] = true;
       noibuLSObject[CLIENT_UNLOCK_TIME_KEY] = expiryTime;
-      this._storeBrowserData(noibuLSObject);
+      await this._storeBrowserData(noibuLSObject);
       this.isClientDisabled = true;
       // end of lock
       // overriding the message to be an alert that we are shutting collect off.
@@ -365,15 +366,24 @@ class ClientConfig {
     }
 
     const errorContent = {
-      url: (global.location && global.location.href) || '',
+      url: getProperGlobalUrl(),
       err_msg: errMsg,
       sev: severity,
     };
     const headers = {
       'content-type': 'application/json',
+      'User-Agent': await getUserAgent(),
     };
 
-    if (!keepAlive) {
+    if (keepAlive) {
+      global.fetch(this.noibuErrorURL, {
+        method: 'POST',
+        headers,
+        body: stringifyJSON(errorContent),
+        // keep alive outlives the current page, its the same as beacon
+        keepalive: true,
+      });
+    } else {
       makeRequest(
         'POST',
         this.noibuErrorURL,
@@ -384,14 +394,6 @@ class ClientConfig {
       ).catch(() => {
         // we do nothing and let this error silently fail
       });
-    } else {
-      fetch(this.noibuErrorURL, {
-        method: 'POST',
-        headers,
-        body: stringifyJSON(errorContent),
-        // keep alive outlives the current page, its the same as beacon
-        keepalive: true,
-      });
     }
 
     // only increment if this was an actual error, not a warning or otherwise

package/dist/api/helpCode.js

@@ -32,8 +32,8 @@ class HelpCode {
    * @returns {Promise<string>} Promise object representing the help code request.
    * @throws {string} Throws an error if the noibu connection is unavailable.
    */
-  requestHelpCode() {
-    if (this.requestContext != null) {
+  async requestHelpCode() {
+    if (this.requestContext !== null) {
       return this.requestContext.promise;
     }
 
@@ -50,7 +50,7 @@ class HelpCode {
 
     this.requestContext = context;
 
-    const result = this._sendRequest();
+    const result = await this._sendRequest();
 
     if (result === false) {
       this.requestContext = null;

package/dist/api/inputManager.js

@@ -54,7 +54,7 @@ class InputManager {
    * gets the sdk object that will be assigned to a window variable
    * @returns {{
    *    requestHelpCode: (alert?: boolean) => Promise<string>,
-   *    addCustomAttribute: (name: string, value: string) => string,
+   *    addCustomAttribute: (name: string, value: string) => Promise<string>,
    *    addError: (customError: Error) => string,
    *    addJsSdkError: (customError: string, errorSource: string) => string
    * }}
@@ -157,7 +157,7 @@ class InputManager {
    * @param  {} name
    * @param  {} value
    */
-  _addCustomAttribute(name, value) {
+  async _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;
@@ -176,7 +176,7 @@ class InputManager {
     }
 
     this.customIDs[name] = value;
-    MetroplexSocket.getInstance().sendMessage(META_DATA_METROPLEX_TYPE, {
+    await MetroplexSocket.getInstance().sendMessage(META_DATA_METROPLEX_TYPE, {
       [PAGE_VISIT_META_DATA_ATT_NAME]: {
         [CUSTOM_ID_NAME_TYPE]: name,
         [CUSTOM_ID_VALUE_TYPE]: value,
@@ -225,8 +225,8 @@ class InputManager {
    * @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);
+  _requestHelpCode() {
+    return HelpCode.getInstance().requestHelpCode();
   }
 }
 

package/dist/api/metroplexSocket.js

@@ -1,7 +1,7 @@
 import uuid from 'react-native-uuid';
-import { getProperGlobalUrl, getMaxSubstringAllowed, getUserAgent, stringifyJSON, getUserLanguage } from '../utils/function.js';
+import { getProperGlobalUrl, getUserAgent, stringifyJSON, getUserLanguage } from '../utils/function.js';
 import { addSafeEventListener } from '../utils/eventlistener.js';
-import { GET_METROPLEX_BASE_SOCKET_URL, METROPLEX_FRAG_ROUTE, GET_METROPLEX_POST_URL, METROPLEX_RETRY_FREQUENCY, META_DATA_METROPLEX_TYPE, PAGE_VISIT_META_DATA_ATT_NAME, HTTP_DATA_METROPLEX_TYPE, PAGE_VISIT_HTTP_DATA_ATT_NAME, VIDEO_METROPLEX_TYPE, PAGE_VISIT_VID_FRAG_ATT_NAME, PV_METROPLEX_TYPE, PAGE_VISIT_PART_ATT_NAME, SEQ_NUM_ATT_NAME, WORK_REQUEST_ATT_NAME, PV_EVENTS_ATT_NAME, TYPE_ATT_NAME, USERSTEP_EVENT_TYPE, GET_MAX_METROPLEX_RECONNECTION_NUMBER, MAX_METROPLEX_CONNECTION_COUNT, GET_METROPLEX_CONSECUTIVE_CONNECTION_DELAY, END_AT_ATT_NAME, SEVERITY_ERROR, OK_SOCKET_MESSAGE, CLOSE_CONNECTION_FORCEFULLY, BLOCK_SOCKET_MESSAGE, STOP_STORING_PV_SOCKET_MESSAGE, STOP_STORING_VID_SOCKET_MESSAGE, MAX_BEACON_PAYLOAD_SIZE, PAGE_VISIT_INFORMATION_ATT_NAME, VIDEO_PART_COUNT_ATT_NAME, IS_LAST_ATT_NAME, SEVERITY_WARN, JS_ENV, BROWSER_ID_ATT_NAME, PV_ID_ATT_NAME, VER_ATT_NAME, CURRENT_PV_VERSION, PV_SEQ_ATT_NAME, ON_URL_ATT_NAME, REF_URL_ATT_NAME, STARTED_AT_ATT_NAME, CONN_COUNT_ATT_NAME, COLLECT_VER_ATT_NAME, CURRENT_NOIBUJS_VERSION, SCRIPT_ID_ATT_NAME, GET_SCRIPT_ID, SCRIPT_INSTANCE_ID_ATT_NAME, METROPLEX_SOCKET_INSTANCE_ID_ATT_NAME, SOCKET_INSTANCE_ID_ATT_NAME, LANG_ATT_NAME, HELP_CODE_ATT_NAME } from '../constants.js';
+import { GET_METROPLEX_BASE_SOCKET_URL, METROPLEX_FRAG_ROUTE, GET_METROPLEX_POST_URL, METROPLEX_RETRY_FREQUENCY, META_DATA_METROPLEX_TYPE, PAGE_VISIT_META_DATA_ATT_NAME, HTTP_DATA_METROPLEX_TYPE, PAGE_VISIT_HTTP_DATA_ATT_NAME, VIDEO_METROPLEX_TYPE, PAGE_VISIT_VID_FRAG_ATT_NAME, PV_METROPLEX_TYPE, PAGE_VISIT_PART_ATT_NAME, SEQ_NUM_ATT_NAME, WORK_REQUEST_ATT_NAME, PV_EVENTS_ATT_NAME, TYPE_ATT_NAME, USERSTEP_EVENT_TYPE, GET_MAX_METROPLEX_RECONNECTION_NUMBER, MAX_METROPLEX_CONNECTION_COUNT, GET_METROPLEX_CONSECUTIVE_CONNECTION_DELAY, END_AT_ATT_NAME, SEVERITY_ERROR, OK_SOCKET_MESSAGE, CLOSE_CONNECTION_FORCEFULLY, BLOCK_SOCKET_MESSAGE, STOP_STORING_PV_SOCKET_MESSAGE, STOP_STORING_VID_SOCKET_MESSAGE, MAX_BEACON_PAYLOAD_SIZE, PAGE_VISIT_INFORMATION_ATT_NAME, VIDEO_PART_COUNT_ATT_NAME, IS_LAST_ATT_NAME, SEVERITY_WARN, BROWSER_ID_ATT_NAME, PV_ID_ATT_NAME, VER_ATT_NAME, CURRENT_PV_VERSION, PV_SEQ_ATT_NAME, ON_URL_ATT_NAME, REF_URL_ATT_NAME, STARTED_AT_ATT_NAME, CONN_COUNT_ATT_NAME, COLLECT_VER_ATT_NAME, CURRENT_NOIBUJS_VERSION, SCRIPT_ID_ATT_NAME, GET_SCRIPT_ID, SCRIPT_INSTANCE_ID_ATT_NAME, METROPLEX_SOCKET_INSTANCE_ID_ATT_NAME, SOCKET_INSTANCE_ID_ATT_NAME, LANG_ATT_NAME, HELP_CODE_ATT_NAME } from '../constants.js';
 import ClientConfig from './clientConfig.js';
 import StoredMetrics from './storedMetrics.js';
 import StoredPageVisit from './storedPageVisit.js';
@@ -59,10 +59,7 @@ class MetroplexSocket {
     // current page visit has the real initial onURL. Fragments and SPA's
     // can change the URL without reloading the page.
     this.initialURL = getProperGlobalUrl();
-    this.initialReferingURL =
-      global.document && global.document.referrer
-        ? getMaxSubstringAllowed(global.document.referrer)
-        : '';
+    this.initialReferingURL = '';
     this.sessionTimestamp = new Date();
 
     // latest time that we received a confirmation message from metroplex
@@ -164,9 +161,9 @@ class MetroplexSocket {
    * Queues the message if the connection isn't open yet.
    * @param  {} type
    * @param  {} payload
-   * @returns {boolean} true if message was sent succefully, false otherwise
+   * @returns {Promise<boolean>} true if message was sent succefully, false otherwise
    */
-  sendMessage(type, payload) {
+  async sendMessage(type, payload) {
     // if we have a lock on this specific type, we dont send it
     if (
       type in this.metroplexTypeLock ||
@@ -186,7 +183,7 @@ class MetroplexSocket {
       this.retryMessageQueue.push({ payload: payloadData, type });
       StoredPageVisit.getInstance().checkAndStoreRetryQueue(
         this.retryMessageQueue,
-        this.getPageInformation(),
+        await this.getPageInformation(),
       );
     }
 
@@ -264,7 +261,7 @@ class MetroplexSocket {
     });
     this.socketInstanceId = uuid.v4();
 
-    this.socket.onerror = () => {
+    this.socket.onerror = e => {
       // use for metrics
       // there is no useful error message/description from this event
     };
@@ -395,23 +392,21 @@ class MetroplexSocket {
       this.sessionLength = delta;
     }
 
-    const endTime = new Date(
-      this.sessionTimestamp.getTime() + delta,
-    ).toISOString();
-
     // Assigning this value here is much better than copying the whole object.
     // eslint-disable-next-line no-param-reassign
-    payload[END_AT_ATT_NAME] = endTime;
+    payload[END_AT_ATT_NAME] = new Date(
+      this.sessionTimestamp.getTime() + delta,
+    ).toISOString();
   }
 
   /** open handler for socket */
-  _onSocketOpen() {
+  async _onSocketOpen() {
     // if we are not connected, we do not send any messages
     if (!this.isConnected() || ClientConfig.getInstance().isClientDisabled) {
       return;
     }
 
-    this._sendSocketMessage(this.getPageInformation());
+    this._sendSocketMessage(await this.getPageInformation());
     // Set this to allow normal page visit and video frag messages to be sent
     this.pageVisitInfoSent = true;
     this.currentConnectionAttempts = 0;
@@ -631,7 +626,7 @@ class MetroplexSocket {
    * will try to empty both the queues with beacons.
    * @param  {} maxMessageSize
    */
-  postFullPageVisit(maxMessageSize) {
+  async postFullPageVisit(maxMessageSize) {
     if (this.retryMessageQueue.length === 0) {
       return;
     }
@@ -645,14 +640,14 @@ class MetroplexSocket {
 
     let currentMsgPayloadSize = 0;
     let currentCompletePv = {
-      [PAGE_VISIT_INFORMATION_ATT_NAME]: this.getPageInformation(),
+      [PAGE_VISIT_INFORMATION_ATT_NAME]: await this.getPageInformation(),
       [PAGE_VISIT_PART_ATT_NAME]: [],
       [PAGE_VISIT_VID_FRAG_ATT_NAME]: [],
       [PAGE_VISIT_HTTP_DATA_ATT_NAME]: [],
       [VIDEO_PART_COUNT_ATT_NAME]: this.connectionCount,
     };
     currentCompletePv[PAGE_VISIT_INFORMATION_ATT_NAME][IS_LAST_ATT_NAME] = true;
-
+    const pageInfo = await this.getPageInformation();
     this.retryMessageQueue.forEach(msg => {
       // can't use two variables types in obj deconstruction
       // eslint-disable-next-line  prefer-const
@@ -677,9 +672,9 @@ class MetroplexSocket {
 
         // resetting currentCompletePv, since we need to keep adding
         // events to a blank object to send to metroplex.
-        // retain the video part count so we don't overwrite anything
+        // retain the video part count, so we don't overwrite anything
         currentCompletePv = {
-          [PAGE_VISIT_INFORMATION_ATT_NAME]: this.getPageInformation(),
+          [PAGE_VISIT_INFORMATION_ATT_NAME]: pageInfo,
           [PAGE_VISIT_PART_ATT_NAME]: [],
           [PAGE_VISIT_VID_FRAG_ATT_NAME]: [],
           [PAGE_VISIT_HTTP_DATA_ATT_NAME]: [],
@@ -765,30 +760,23 @@ class MetroplexSocket {
    * will send a message to metroplex via a post request that will outlive the current page
    * @param  {} msg
    */
-  postMessage(msg) {
+  async postMessage(msg) {
     const updatedMsg = msg;
 
     // ensure a unique video part number each call
     updatedMsg[VIDEO_PART_COUNT_ATT_NAME] += 1;
 
-    // we use the beacon api in testing since the version of chromium we are using
-    // does not support the keepalive flag
-    if (JS_ENV() === 'test') {
-      navigator.sendBeacon(this.postURL, stringifyJSON(updatedMsg));
-      // we only write to the pv route if the fetch api is enabled in the current browser
-      // and we need to fetch api to set the application/json header for metroplex
-    } else if (global.fetch) {
-      // we send the remainder elements
-      fetch(this.postURL, {
-        method: 'POST',
-        headers: {
-          'content-type': 'application/json',
-        },
-        body: stringifyJSON(updatedMsg),
-        // keep alive outlives the current page, its the same as beacon
-        keepalive: true,
-      });
-    }
+    // we send the remainder elements
+    global.fetch(this.postURL, {
+      method: 'POST',
+      headers: {
+        'content-type': 'application/json',
+        'User-Agent': await getUserAgent(),
+      },
+      body: stringifyJSON(updatedMsg),
+      // keep alive outlives the current page, its the same as beacon
+      keepalive: true,
+    });
   }
 
   /**
@@ -832,12 +820,12 @@ class MetroplexSocket {
   }
 
   /** will get page information, calling this will increase the connection count */
-  getPageInformation() {
+  async getPageInformation() {
     const pvi = {
       [BROWSER_ID_ATT_NAME]: ClientConfig.getInstance().browserId,
       [PV_ID_ATT_NAME]: ClientConfig.getInstance().pageVisitId,
       [VER_ATT_NAME]: CURRENT_PV_VERSION,
-      [PV_SEQ_ATT_NAME]: ClientConfig.getInstance().getPageVisitSeq(),
+      [PV_SEQ_ATT_NAME]: await ClientConfig.getInstance().getPageVisitSeq(),
       [ON_URL_ATT_NAME]: this.initialURL,
       [REF_URL_ATT_NAME]: this.initialReferingURL,
       [STARTED_AT_ATT_NAME]: this.sessionTimestamp.toISOString(),

package/dist/api/storedMetrics.js

@@ -1,13 +1,13 @@
 import { BROWSER_ID_ATT_NAME, PV_ID_ATT_NAME, COLLECT_VER_ATT_NAME, CURRENT_NOIBUJS_VERSION, VER_ATT_NAME, CURRENT_METRICS_VERSION, EXP_VIDEO_LENGTH_ATT_NAME, PV_EXP_VF_SEQ_ATT_NAME, PV_EXP_PART_COUNTER_ATT_NAME, PV_EXP_HTTP_DATA_SEQ_ATT_NAME, PV_HTTP_PAYLOADS_COLLECTED_ATT_NAME, PV_HTTP_PAYLOADS_DROPPED_OVERSIZE_ATT_NAME, PV_HTTP_PAYLOADS_DROPPED_TYPE_ATT_NAME, PV_HTTP_REQUESTS_DROPPED_OVER_LIMIT, VIDEO_CLICKS_ATT_NAME, PV_CLICKS_ATT_NAME, DID_CUT_PV_ATT_NAME, DID_CUT_VID_ATT_NAME, DID_START_VID_ATT_NAME, HTTP_COUNT_EXPECTED_ATT_NAME, ERR_COUNT_EXPECTED_ATT_NAME, ON_URL_ATT_NAME, GET_METROPLEX_METRICS_URL } from '../constants.js';
 import ClientConfig from './clientConfig.js';
-import { stringifyJSON } from '../utils/function.js';
+import { getProperGlobalUrl, getUserAgent, stringifyJSON } from '../utils/function.js';
 import { addSafeEventListener } from '../utils/eventlistener.js';
 
 /** @module StoredMetrics */
 
 /**
  * This class holds the final page visit and video frag metrics. It flushes
- * them to local storage and then finally sends them to Metroplex via the post
+ * them to storage and then finally sends them to Metroplex via the post
  * route when the next page is loaded
  */
 class StoredMetrics {
@@ -35,7 +35,10 @@ class StoredMetrics {
     this._setupListeners();
   }
 
-  /** gets the singleton instance */
+  /**
+   * gets the singleton instance
+   * @returns {StoredMetrics}
+   */
   static getInstance() {
     if (!this.instance) {
       this.instance = new StoredMetrics();
@@ -148,9 +151,8 @@ class StoredMetrics {
   }
 
   /** posts the metrics to metroplex using the beacon API
-   * @param  {} eventName
    */
-  postMetrics(eventName) {
+  async postMetrics() {
     // Create a new object to write to local storage that doesnt have the timeout and flush members.
     const lsMetrics = {
       // metadata
@@ -177,24 +179,18 @@ class StoredMetrics {
       [DID_START_VID_ATT_NAME]: this.didStartVideo,
       [HTTP_COUNT_EXPECTED_ATT_NAME]: this.httpCount,
       [ERR_COUNT_EXPECTED_ATT_NAME]: this.errCount,
-      [ON_URL_ATT_NAME]:
-        (global.document &&
-          global.document.location &&
-          global.document.location.href) ||
-        'http://localhost',
+      [ON_URL_ATT_NAME]: getProperGlobalUrl(), // todo implement navigation
     };
-
-    if (global.fetch) {
-      global.fetch(GET_METROPLEX_METRICS_URL(), {
-        method: 'POST',
-        headers: {
-          'content-type': 'application/json',
-        },
-        body: stringifyJSON(lsMetrics),
-        // keep alive outlives the current page, its the same as beacon
-        keepalive: true,
-      });
-    }
+    global.fetch(GET_METROPLEX_METRICS_URL(), {
+      method: 'POST',
+      headers: {
+        'content-type': 'application/json',
+        'User-Agent': await getUserAgent(),
+      },
+      body: stringifyJSON(lsMetrics),
+      // keep alive outlives the current page, its the same as beacon
+      keepalive: true,
+    });
   }
 }