noibu-react-native 0.2.2 → 0.2.3

package/README.md

@@ -166,7 +166,7 @@ NoibuJS.addJsSdkError(new Error('My Error'), 'myModule.js');
 
 ## License
 
-Copyright 2023 Noibu.com
+Copyright 2024 Noibu.com
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
 

package/dist/api/clientConfig.js

@@ -1,3 +1,4 @@
+import { __awaiter } from 'tslib';
 import uuid from 'react-native-uuid';
 import { MAX_METROPLEX_SOCKET_INNACTIVE_TIME, SEVERITY, NOIBU_BROWSER_ID_KYWRD, PV_SEQ_NUM_RESET_TIME_MINUTES, JS_ENV, MAX_PAGEVISIT_VISITED, CLIENT_LOCK_TIME_MINUTES, GET_SCRIPT_ID, GET_DEVICE_ENV, MAX_COLLECT_ERROR_LOG } from '../constants.js';
 import { stringifyJSON, getMaxSubstringAllowed, getUserAgent, makeRequest } from '../utils/function.js';
@@ -5,7 +6,6 @@ import Storage from '../storage/storage.js';
 import { noibuLog } from '../utils/log.js';
 import { unwrapNoibuWrapped } from '../utils/object.js';
 
-/** @module ClientConfig */
 /**
  * Singleton class to manage the client configuration
  * this class will be responsible for controlling the disabled
@@ -13,25 +13,11 @@ import { unwrapNoibuWrapped } from '../utils/object.js';
  * storing and retrieval.
  */
 class ClientConfig {
-    pageVisitId;
-    browserId;
-    pageVisitSeq;
-    lastActiveTime;
-    noibuErrorURL;
-    cltErrorPostCounter;
-    maxSocketInactiveTime;
-    locationBreadcrumbs = [];
-    static instance;
-    static noibuErrorURL;
-    customerDomain;
-    isClientDisabled;
-    listOfUrlsToCollectHttpDataFrom;
-    enableHttpDataCollection;
-    blockedElements;
     /**
      * Creates a ClientConfig singleton instance
      */
     constructor(noibuErrorURL, customerConfig) {
+        this.locationBreadcrumbs = [];
         // sets up this.browserId, this.disabledStatus
         this.pageVisitId = uuid.v4();
         // variables stored in storage
@@ -56,13 +42,15 @@ class ClientConfig {
         this.blockedElements = customerConfig.blockedElements;
     }
     /** Configures the singleton instance */
-    static async configureInstance({ noibuErrorURL, customerConfig, }) {
-        if (!this.instance) {
-            ClientConfig.noibuErrorURL = noibuErrorURL;
-            this.instance = new ClientConfig(noibuErrorURL, customerConfig);
-            // sets up this.browserId, this.isClientDisabled, this.pageVisitSeq
-            await this.instance._setupStorageVars();
-        }
+    static configureInstance(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ noibuErrorURL, customerConfig, }) {
+            if (!this.instance) {
+                ClientConfig.noibuErrorURL = noibuErrorURL;
+                this.instance = new ClientConfig(noibuErrorURL, customerConfig);
+                // sets up this.browserId, this.isClientDisabled, this.pageVisitSeq
+                yield this.instance._setupStorageVars();
+            }
+        });
     }
     /**
      * gets the singleton instance
@@ -75,38 +63,44 @@ class ClientConfig {
     }
     /** lockClient will disable the client script for a single pagevisit for
      * duration given in minuntes */
-    async lockClient(duration, msg) {
-        const expiryTime = new Date();
-        expiryTime.setMinutes(expiryTime.getMinutes() + duration);
-        const noibuLSObject = await this._getClientState();
-        noibuLSObject.DisabledStatus = true;
-        noibuLSObject.ClientUnlockTime = expiryTime;
-        await this._storeBrowserData(noibuLSObject);
-        await this.postNoibuErrorAndOptionallyDisableClient(msg, true, SEVERITY.warn);
+    lockClient(duration, msg) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const expiryTime = new Date();
+            expiryTime.setMinutes(expiryTime.getMinutes() + duration);
+            const noibuLSObject = yield this._getClientState();
+            noibuLSObject.DisabledStatus = true;
+            noibuLSObject.ClientUnlockTime = expiryTime;
+            yield this._storeBrowserData(noibuLSObject);
+            yield this.postNoibuErrorAndOptionallyDisableClient(msg, true, SEVERITY.warn);
+        });
     }
     /** Locks the client until the next page loads */
     lockClientUntilNextPage(msg) {
         return this.postNoibuErrorAndOptionallyDisableClient(msg, true, SEVERITY.warn);
     }
     /**  Updates the config object to store the given last active time */
-    async updateLastActiveTime(lastActiveTime) {
-        this.lastActiveTime = lastActiveTime;
-        const newConfigData = await this._getLsObject();
-        newConfigData.LastActive = lastActiveTime;
-        await this._storeBrowserData(newConfigData);
+    updateLastActiveTime(lastActiveTime) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.lastActiveTime = lastActiveTime;
+            const newConfigData = yield this._getLsObject();
+            newConfigData.LastActive = lastActiveTime;
+            yield this._storeBrowserData(newConfigData);
+        });
     }
     /**  Gets the current page visit sequence number that should be used */
-    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 = await this._getLsObject();
-            newConfigData.CurrentPageVisitCount = this.pageVisitSeq + 1;
-            // Update the last active time since we are actively requesting the seq
-            newConfigData.LastActive = new Date();
-            await this._storeBrowserData(newConfigData);
-        }
-        return this.pageVisitSeq;
+    getPageVisitSeq() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (yield this._pageVisitSeqNeedsReset()) {
+                // Reset the page visit sequence number to zero and store the next seq number in storage
+                this.pageVisitSeq = 0;
+                const newConfigData = yield this._getLsObject();
+                newConfigData.CurrentPageVisitCount = this.pageVisitSeq + 1;
+                // Update the last active time since we are actively requesting the seq
+                newConfigData.LastActive = new Date();
+                yield this._storeBrowserData(newConfigData);
+            }
+            return this.pageVisitSeq;
+        });
     }
     /**
      *  Returns the client config object from storage or generates a new one
@@ -120,95 +114,101 @@ class ClientConfig {
      * LastActiveTime: DATE OBJ
      * }
      */
-    async _getLsObject() {
-        const storage = Storage.getInstance();
-        const storedConfig = await storage.load(NOIBU_BROWSER_ID_KYWRD);
-        // first time browsing since noibu was installed
-        if (!storedConfig) {
-            return this._generateAndStoreData();
-        }
-        let parsedConfig = {};
-        try {
-            parsedConfig = JSON.parse(storedConfig);
-        }
-        catch (e) {
-            return this._generateAndStoreData();
-        }
-        // checking if it's a valid object. The CLIENT_UNLOCK_TIME_KEY doesn't have to exist
-        // since it's not written to the storage object when set to null.
-        if (!(parsedConfig.BrowserId &&
-            Boolean(parsedConfig.DisabledStatus) === parsedConfig.DisabledStatus &&
-            parsedConfig.CurrentPageVisitCount &&
-            parsedConfig.LastActive)) {
-            return this._generateAndStoreData();
-        }
-        return parsedConfig;
+    _getLsObject() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const storage = Storage.getInstance();
+            const storedConfig = yield storage.load(NOIBU_BROWSER_ID_KYWRD);
+            // first time browsing since noibu was installed
+            if (!storedConfig) {
+                return this._generateAndStoreData();
+            }
+            let parsedConfig = {};
+            try {
+                parsedConfig = JSON.parse(storedConfig);
+            }
+            catch (e) {
+                return this._generateAndStoreData();
+            }
+            // checking if it's a valid object. The CLIENT_UNLOCK_TIME_KEY doesn't have to exist
+            // since it's not written to the storage object when set to null.
+            if (!(parsedConfig.BrowserId &&
+                Boolean(parsedConfig.DisabledStatus) === parsedConfig.DisabledStatus &&
+                parsedConfig.CurrentPageVisitCount &&
+                parsedConfig.LastActive)) {
+                return this._generateAndStoreData();
+            }
+            return parsedConfig;
+        });
     }
     /**
      * Check if we have surpassed the last active time and the page visit seq number needs resetting
      */
-    async _pageVisitSeqNeedsReset() {
-        const noibuLSObject = await this._getClientState();
-        const someTimeAgo = new Date();
-        someTimeAgo.setMinutes(someTimeAgo.getMinutes() - PV_SEQ_NUM_RESET_TIME_MINUTES);
-        if (!noibuLSObject.LastActive) {
-            return true;
-        }
-        return new Date(noibuLSObject.LastActive) < someTimeAgo;
+    _pageVisitSeqNeedsReset() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const noibuLSObject = yield this._getClientState();
+            const someTimeAgo = new Date();
+            someTimeAgo.setMinutes(someTimeAgo.getMinutes() - PV_SEQ_NUM_RESET_TIME_MINUTES);
+            if (!noibuLSObject.LastActive) {
+                return true;
+            }
+            return new Date(noibuLSObject.LastActive) < someTimeAgo;
+        });
     }
     /**
      * _setupStorageVars will set all class variables that depend
      * on the storage's value.
      */
-    async _setupStorageVars() {
-        const storage = Storage.getInstance();
-        if (!(await storage.isAvailable())) {
-            void this.postNoibuErrorAndOptionallyDisableClient(`Storage is unavailable, disabling client. ${await storage.getDiagnoseInfo()}`, true, SEVERITY.error);
-            return;
-        }
-        // getting the current content of the storage
-        const noibuLSObject = await this._getClientState();
-        // Check if we have surpased the last active time and reset the sequence number if so
-        if (await this._pageVisitSeqNeedsReset()) {
-            noibuLSObject.CurrentPageVisitCount = 0;
-        }
-        this.browserId = noibuLSObject.BrowserId;
-        noibuLog('ClientConfig - _setupStorageVars', { noibuLSObject });
-        this.pageVisitSeq = noibuLSObject.CurrentPageVisitCount;
-        this.isClientDisabled = noibuLSObject.DisabledStatus;
-        // If the client has been disabled just return.
-        // Calling _getClientState() above performs the disabled expirey check
-        if (this.isClientDisabled)
-            return;
-        // Update the LS object values before storing it for the next page visit
-        noibuLSObject.CurrentPageVisitCount += 1;
-        noibuLSObject.LastActive = new Date();
-        // Expose page visit ID in storage for use by Trailbreaker video tests
-        // This will be done for the testvideo and lambdavideo bundles used by Trailbreaker
-        if (JS_ENV().includes('video')) {
-            noibuLSObject.pvId = this.pageVisitId;
-        }
-        // if we have reached the max page visits for a browser id then
-        // we disabled collect for 45 minutes
-        if (noibuLSObject.CurrentPageVisitCount >= MAX_PAGEVISIT_VISITED) {
-            // if we bust the max pagevisit visited limit we lock the client for 45 minutes
-            // since its probably a bot.
-            const expiryTime = new Date();
-            expiryTime.setMinutes(expiryTime.getMinutes() + CLIENT_LOCK_TIME_MINUTES);
-            // setting the lock time
-            noibuLSObject.ClientUnlockTime = expiryTime;
-            noibuLSObject.DisabledStatus = true;
-            await this.postNoibuErrorAndOptionallyDisableClient(`Hit max page visits, disabling client for ${CLIENT_LOCK_TIME_MINUTES}mins`, true, SEVERITY.error);
-        }
-        // we now check if we successfully saved the data
-        const savedData = await this._storeBrowserData(noibuLSObject);
-        // if the browser is null, we cannot access the storage or an
-        // error happened, thus we disable collect.
-        if (!savedData.BrowserId) {
-            // we do not set a lock expiry date here since we cannot store to storage
-            void this.postNoibuErrorAndOptionallyDisableClient(`Null browser in storage, disabling client`, true, SEVERITY.error);
-            this.browserId = '';
-        }
+    _setupStorageVars() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const storage = Storage.getInstance();
+            if (!(yield storage.isAvailable())) {
+                void this.postNoibuErrorAndOptionallyDisableClient(`Storage is unavailable, disabling client. ${yield storage.getDiagnoseInfo()}`, true, SEVERITY.error);
+                return;
+            }
+            // getting the current content of the storage
+            const noibuLSObject = yield this._getClientState();
+            // Check if we have surpased the last active time and reset the sequence number if so
+            if (yield this._pageVisitSeqNeedsReset()) {
+                noibuLSObject.CurrentPageVisitCount = 0;
+            }
+            this.browserId = noibuLSObject.BrowserId;
+            noibuLog('ClientConfig - _setupStorageVars', { noibuLSObject });
+            this.pageVisitSeq = noibuLSObject.CurrentPageVisitCount;
+            this.isClientDisabled = noibuLSObject.DisabledStatus;
+            // If the client has been disabled just return.
+            // Calling _getClientState() above performs the disabled expirey check
+            if (this.isClientDisabled)
+                return;
+            // Update the LS object values before storing it for the next page visit
+            noibuLSObject.CurrentPageVisitCount += 1;
+            noibuLSObject.LastActive = new Date();
+            // Expose page visit ID in storage for use by Trailbreaker video tests
+            // This will be done for the testvideo and lambdavideo bundles used by Trailbreaker
+            if (JS_ENV().includes('video')) {
+                noibuLSObject.pvId = this.pageVisitId;
+            }
+            // if we have reached the max page visits for a browser id then
+            // we disabled collect for 45 minutes
+            if (noibuLSObject.CurrentPageVisitCount >= MAX_PAGEVISIT_VISITED) {
+                // if we bust the max pagevisit visited limit we lock the client for 45 minutes
+                // since its probably a bot.
+                const expiryTime = new Date();
+                expiryTime.setMinutes(expiryTime.getMinutes() + CLIENT_LOCK_TIME_MINUTES);
+                // setting the lock time
+                noibuLSObject.ClientUnlockTime = expiryTime;
+                noibuLSObject.DisabledStatus = true;
+                yield this.postNoibuErrorAndOptionallyDisableClient(`Hit max page visits, disabling client for ${CLIENT_LOCK_TIME_MINUTES}mins`, true, SEVERITY.error);
+            }
+            // we now check if we successfully saved the data
+            const savedData = yield this._storeBrowserData(noibuLSObject);
+            // if the browser is null, we cannot access the storage or an
+            // error happened, thus we disable collect.
+            if (!savedData.BrowserId) {
+                // we do not set a lock expiry date here since we cannot store to storage
+                void this.postNoibuErrorAndOptionallyDisableClient(`Null browser in storage, disabling client`, true, SEVERITY.error);
+                this.browserId = '';
+            }
+        });
     }
     /**
      *   Function will get the Noibu Storage Object
@@ -216,24 +216,28 @@ 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
      */
-    async _getClientState() {
-        const newConfigData = await this._getLsObject();
-        // if the lock expired, we remove the lock period and enable the client
-        if (newConfigData.ClientUnlockTime &&
-            new Date(newConfigData.ClientUnlockTime) <= new Date()) {
-            newConfigData.ClientUnlockTime = undefined;
-            newConfigData.DisabledStatus = false;
-            await this._storeBrowserData(newConfigData);
-        }
-        // return the stored browserId
-        return newConfigData;
+    _getClientState() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const newConfigData = yield this._getLsObject();
+            // if the lock expired, we remove the lock period and enable the client
+            if (newConfigData.ClientUnlockTime &&
+                new Date(newConfigData.ClientUnlockTime) <= new Date()) {
+                newConfigData.ClientUnlockTime = undefined;
+                newConfigData.DisabledStatus = false;
+                yield this._storeBrowserData(newConfigData);
+            }
+            // return the stored browserId
+            return newConfigData;
+        });
     }
     /**
      * _generateAndStoreData generates brand new data and then proceeds to store
      * it.
      */
-    async _generateAndStoreData() {
-        return this._storeBrowserData(this._generateNewBrowserData());
+    _generateAndStoreData() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this._storeBrowserData(this._generateNewBrowserData());
+        });
     }
     /**
      * _generateNewBrowserData will create new data to be stored in storage
@@ -257,17 +261,19 @@ class ClientConfig {
      * _storeBrowserData will store the passed object in storage.
      * @param  {} data the data to be stored
      */
-    async _storeBrowserData(data) {
-        const storage = Storage.getInstance();
-        try {
-            await storage.save(NOIBU_BROWSER_ID_KYWRD, stringifyJSON(data));
-            return data;
-        }
-        catch (e) {
-            await this.postNoibuErrorAndOptionallyDisableClient(`Error writing browser data to storage, disabling client: ${e.message}, ${await storage.getDiagnoseInfo()}`, true, SEVERITY.error);
-            // sending empty fields if we encountered errors while storing in the LS
-            return this._generateNewBrowserData();
-        }
+    _storeBrowserData(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const storage = Storage.getInstance();
+            try {
+                yield storage.save(NOIBU_BROWSER_ID_KYWRD, stringifyJSON(data));
+                return data;
+            }
+            catch (e) {
+                yield this.postNoibuErrorAndOptionallyDisableClient(`Error writing browser data to storage, disabling client: ${e.message}, ${yield storage.getDiagnoseInfo()}`, true, SEVERITY.error);
+                // sending empty fields if we encountered errors while storing in the LS
+                return this._generateNewBrowserData();
+            }
+        });
     }
     /** sets current breadcrumbs to be reconstructed into global url */
     set currentLocationBreadcrumbs(newValue) {
@@ -290,73 +296,75 @@ class ClientConfig {
      * and disable the client if required
      * severity expects one of the SEVERITY_x level constants, or else error will be used
      */
-    async postNoibuErrorAndOptionallyDisableClient(errorMsg, disableClient, severity, keepAlive = false) {
-        noibuLog('postNoibuErrorAndOptionallyDisableClient', {
-            errorMsg,
-            disableClient,
-            severity,
-            keepAlive,
-        });
-        if (this.isClientDisabled) {
-            return;
-        }
-        if (disableClient) {
-            this.isClientDisabled = true;
-        }
-        if (severity === SEVERITY.warn) {
-            // don't log warning messages by default, as a cost savings
-            return;
-        }
-        const collectError = {
-            browserId: this.browserId || '',
-            pageVisitId: this.pageVisitId,
-            scriptId: GET_SCRIPT_ID(),
-            ua: await getUserAgent(),
-            deviceEnv: GET_DEVICE_ENV(),
-            error: stringifyJSON(errorMsg),
-        };
-        // if the page visits sends more errors than the
-        // allowed threshold we disable the client
-        if (this.cltErrorPostCounter >= MAX_COLLECT_ERROR_LOG) {
-            // we disable the client for 10 minute if we sent too many logs
-            // we manually lock the client to not cause an infinite loop
-            const expiryTime = new Date();
-            expiryTime.setMinutes(expiryTime.getMinutes() + 10); // 10 minutes lock
-            const noibuLSObject = await this._getClientState();
-            noibuLSObject.DisabledStatus = true;
-            noibuLSObject.ClientUnlockTime = expiryTime;
-            await this._storeBrowserData(noibuLSObject);
-            this.isClientDisabled = true;
-            // end of lock
-            // overriding the message to be an alert that we are shutting collect off.
-            collectError.error = `Shutting collect off, we reached the maximum limit of collect errors sent.`;
-        }
-        const errorContent = {
-            url: this.globalUrl,
-            err_msg: collectError,
-            sev: severity,
-        };
-        const headers = {
-            'content-type': 'application/json',
-        };
-        if (!keepAlive) {
-            makeRequest('POST', this.noibuErrorURL, errorContent, headers, 2000, false).catch(() => {
-                // we do nothing and let this error silently fail
-            });
-        }
-        else {
-            void unwrapNoibuWrapped(fetch)(this.noibuErrorURL, {
-                method: 'POST',
-                headers,
-                body: stringifyJSON(errorContent),
-                // keep alive outlives the current page, its the same as beacon
-                keepalive: true,
+    postNoibuErrorAndOptionallyDisableClient(errorMsg_1, disableClient_1, severity_1) {
+        return __awaiter(this, arguments, void 0, function* (errorMsg, disableClient, severity, keepAlive = false) {
+            noibuLog('postNoibuErrorAndOptionallyDisableClient', {
+                errorMsg,
+                disableClient,
+                severity,
+                keepAlive,
             });
-        }
-        // only increment if this was an actual error, not a warning or otherwise
-        if (severity === SEVERITY.error) {
-            this.cltErrorPostCounter += 1;
-        }
+            if (this.isClientDisabled) {
+                return;
+            }
+            if (disableClient) {
+                this.isClientDisabled = true;
+            }
+            if (severity === SEVERITY.warn) {
+                // don't log warning messages by default, as a cost savings
+                return;
+            }
+            const collectError = {
+                browserId: this.browserId || '',
+                pageVisitId: this.pageVisitId,
+                scriptId: GET_SCRIPT_ID(),
+                ua: yield getUserAgent(),
+                deviceEnv: GET_DEVICE_ENV(),
+                error: stringifyJSON(errorMsg),
+            };
+            // if the page visits sends more errors than the
+            // allowed threshold we disable the client
+            if (this.cltErrorPostCounter >= MAX_COLLECT_ERROR_LOG) {
+                // we disable the client for 10 minute if we sent too many logs
+                // we manually lock the client to not cause an infinite loop
+                const expiryTime = new Date();
+                expiryTime.setMinutes(expiryTime.getMinutes() + 10); // 10 minutes lock
+                const noibuLSObject = yield this._getClientState();
+                noibuLSObject.DisabledStatus = true;
+                noibuLSObject.ClientUnlockTime = expiryTime;
+                yield this._storeBrowserData(noibuLSObject);
+                this.isClientDisabled = true;
+                // end of lock
+                // overriding the message to be an alert that we are shutting collect off.
+                collectError.error = `Shutting collect off, we reached the maximum limit of collect errors sent.`;
+            }
+            const errorContent = {
+                url: this.globalUrl,
+                err_msg: collectError,
+                sev: severity,
+            };
+            const headers = {
+                'content-type': 'application/json',
+            };
+            if (!keepAlive) {
+                makeRequest('POST', this.noibuErrorURL, errorContent, headers, 2000, false).catch(() => {
+                    // we do nothing and let this error silently fail
+                });
+            }
+            else {
+                void unwrapNoibuWrapped(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
+            if (severity === SEVERITY.error) {
+                this.cltErrorPostCounter += 1;
+            }
+        });
     }
     /**
      * Returns true if the page visit is considered to be inactive