noibu-react-native 0.2.2 → 0.2.4

package/dist/utils/function.js

@@ -1,6 +1,7 @@
+import { __awaiter } from 'tslib';
 import { Platform } from 'react-native';
 import { parseStack } from './stacktrace-parser.js';
-import { MAX_STRING_LENGTH, MAX_BEACON_PAYLOAD_SIZE, REQUIRED_DATA_PROCESSING_URLS, PII_EMAIL_PATTERN, PII_REDACTION_REPLACEMENT_STRING, PII_DIGIT_PATTERN, DEFAULT_STACK_FRAME_FIELD_VALUE } from '../constants.js';
+import { MAX_STRING_LENGTH, MAX_BEACON_PAYLOAD_SIZE, REQUIRED_DATA_PROCESSING_URLS, PII_EMAIL_PATTERN, PII_REDACTION_REPLACEMENT_STRING, PII_DIGIT_PATTERN, JS_STACK_LINE_ATT_NAME, DEFAULT_STACK_FRAME_FIELD_VALUE, JS_STACK_METHOD_ATT_NAME, JS_STACK_FILE_ATT_NAME } from '../constants.js';
 import { noibuLog } from './log.js';
 import { unwrapNoibuWrapped } from './object.js';
 
@@ -8,9 +9,9 @@ import { unwrapNoibuWrapped } from './object.js';
  * Returns a stack trace frame with default filed values
  */
 const getDefaultFrame = () => ({
-    line: DEFAULT_STACK_FRAME_FIELD_VALUE,
-    mname: DEFAULT_STACK_FRAME_FIELD_VALUE,
-    file: DEFAULT_STACK_FRAME_FIELD_VALUE,
+    [JS_STACK_LINE_ATT_NAME]: DEFAULT_STACK_FRAME_FIELD_VALUE,
+    [JS_STACK_METHOD_ATT_NAME]: DEFAULT_STACK_FRAME_FIELD_VALUE,
+    [JS_STACK_FILE_ATT_NAME]: DEFAULT_STACK_FRAME_FIELD_VALUE,
 });
 /**
  * returns a string that satisfies a max length
@@ -27,7 +28,6 @@ function getMaxSubstringAllowed(stringToVerify, length = MAX_STRING_LENGTH) {
 }
 /**
  * Processes the raw stack frames and creates a readable stack in a safe manner
- * @param {StackFrame[]} rawFrames
  */
 function processFrames(rawFrames) {
     return rawFrames.map(frame => {
@@ -60,13 +60,7 @@ function processFrames(rawFrames) {
  * @param errObj error to extract stack from
  */
 function getJSStack(errObj) {
-    let frames = [
-        {
-            line: DEFAULT_STACK_FRAME_FIELD_VALUE,
-            mname: DEFAULT_STACK_FRAME_FIELD_VALUE,
-            file: DEFAULT_STACK_FRAME_FIELD_VALUE,
-        },
-    ];
+    let frames = [getDefaultFrame()];
     // if the errObj type is not an object or null
     // return a default frame
     if (typeof errObj !== 'object' || !errObj || !errObj.stack) {
@@ -85,10 +79,9 @@ function getJSStack(errObj) {
 /**
  * Checks if possiblyStacktrace has any stack frames present
  */
-function isStackTrace(possiblyStacktrace) {
+function isStackTrace(_possiblyStacktrace) {
     try {
-        // todo disable temporary
-        // return parseStack(possiblyStacktrace).length > 0;
+        // todo implement for react native
         return false;
     }
     catch (e) {
@@ -126,52 +119,54 @@ function stringifyJSON(jsonObject) {
  * @param timeout
  * @param sendAndForget
  */
-async function makeRequest(method, url, data, headers, timeout, sendAndForget) {
-    const ua = Object.keys(headers).findLast(k => k.toLowerCase() === 'user-agent');
-    const headersWithUa = { ...headers };
-    if (!headers[ua]) {
-        headersWithUa['User-Agent'] = await getUserAgent();
-    }
-    // a send-and-forget request is made by using the beacon API (fetch + keepalive)
-    if (sendAndForget) {
-        const stringData = stringifyJSON(data);
-        const currentPayloadSize = new Blob([stringData]).size;
-        // if we have a large object or fetch is not available, we skip sending the message
-        if (currentPayloadSize > MAX_BEACON_PAYLOAD_SIZE) {
-            return Promise.resolve();
+function makeRequest(method, url, data, headers, timeout, sendAndForget) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const ua = Object.keys(headers).findLast(k => k.toLowerCase() === 'user-agent');
+        const headersWithUa = Object.assign({}, headers);
+        if (!headers[ua]) {
+            headersWithUa['User-Agent'] = yield getUserAgent();
         }
-        return unwrapNoibuWrapped(fetch)(url, {
-            method: 'POST',
-            headers: headersWithUa,
-            body: stringifyJSON(data),
-            // keep alive outlives the current page, its the same as beacon
-            keepalive: true,
-        });
-    }
-    return new Promise((resolve, reject) => {
-        const xhr = new XMLHttpRequest();
-        xhr.open(method, url);
-        xhr.timeout = timeout;
-        Object.keys(headersWithUa).forEach(header => {
-            xhr.setRequestHeader(header, headers[header]);
-        });
-        xhr.onload = () => {
-            if (xhr.status >= 200 && xhr.status < 300) {
-                resolve(xhr.response);
+        // a send-and-forget request is made by using the beacon API (fetch + keepalive)
+        if (sendAndForget) {
+            const stringData = stringifyJSON(data);
+            const currentPayloadSize = new Blob([stringData]).size;
+            // if we have a large object or fetch is not available, we skip sending the message
+            if (currentPayloadSize > MAX_BEACON_PAYLOAD_SIZE) {
+                return Promise.resolve();
             }
-            else {
+            return unwrapNoibuWrapped(fetch)(url, {
+                method: 'POST',
+                headers: headersWithUa,
+                body: stringifyJSON(data),
+                // keep alive outlives the current page, its the same as beacon
+                keepalive: true,
+            });
+        }
+        return new Promise((resolve, reject) => {
+            const xhr = new XMLHttpRequest();
+            xhr.open(method, url);
+            xhr.timeout = timeout;
+            Object.keys(headersWithUa).forEach(header => {
+                xhr.setRequestHeader(header, headers[header]);
+            });
+            xhr.onload = () => {
+                if (xhr.status >= 200 && xhr.status < 300) {
+                    resolve(xhr.response);
+                }
+                else {
+                    reject(new Error(`Custom Request failed: ${xhr.statusText}`));
+                }
+            };
+            xhr.onerror = () => {
                 reject(new Error(`Custom Request failed: ${xhr.statusText}`));
+            };
+            if (data) {
+                xhr.send(stringifyJSON(data));
             }
-        };
-        xhr.onerror = () => {
-            reject(new Error(`Custom Request failed: ${xhr.statusText}`));
-        };
-        if (data) {
-            xhr.send(stringifyJSON(data));
-        }
-        else {
-            xhr.send();
-        }
+            else {
+                xhr.send();
+            }
+        });
     });
 }
 /**
@@ -190,20 +185,22 @@ let userAgentCache = '';
  * Fakes the user agent retrieval, since there are no good libraries that support both expo and plain RN
  * caches the result for the session
  */
-async function getUserAgent() {
-    if (userAgentCache) {
+function getUserAgent() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (userAgentCache) {
+            return userAgentCache;
+        }
+        noibuLog('getUserAgent start');
+        if (Platform.OS === 'android') {
+            const { Brand, Model, Release } = Platform.constants;
+            userAgentCache = `Mozilla/5.0 (Linux; Android ${Release}; ${Brand} ${Model}; React Native ${Platform.Version}) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Mobile Safari/537.36`;
+        }
+        else if (Platform.OS === 'ios') {
+            userAgentCache = `Mozilla/5.0 (iPhone; CPU iPhone OS ${Platform.constants.osVersion} like Mac OS X; React Native ${Platform.Version}) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.1 Mobile/15E148 Safari/604.1`;
+        }
+        noibuLog('getUserAgent end', { userAgentCache });
         return userAgentCache;
-    }
-    noibuLog('getUserAgent start');
-    if (Platform.OS === 'android') {
-        const { Brand, Model, Release } = Platform.constants;
-        userAgentCache = `Mozilla/5.0 (Linux; Android ${Release}; ${Brand} ${Model}; React Native ${Platform.Version}) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Mobile Safari/537.36`;
-    }
-    else if (Platform.OS === 'ios') {
-        userAgentCache = `Mozilla/5.0 (iPhone; CPU iPhone OS ${Platform.constants.osVersion} like Mac OS X; React Native ${Platform.Version}) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.1 Mobile/15E148 Safari/604.1`;
-    }
-    noibuLog('getUserAgent end', { userAgentCache });
-    return userAgentCache;
+    });
 }
 /**
  * isInvalidURLConfig will verify that Collect is being initializes with
@@ -272,14 +269,50 @@ function isInstanceOf(instance, type) {
 /**
  * To grab the video recorder type based on the device we run the app on.
  */
-async function getVideoRecorderType() {
-    if (Platform.OS === 'android') {
-        return 'AndroidNative';
+function getVideoRecorderType() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (Platform.OS === 'android') {
+            return 'AndroidNative';
+        }
+        if (Platform.OS === 'ios') {
+            return 'IOSNative';
+        }
+        return '';
+    });
+}
+/** String.trim, but safe */
+function safeTrim(text) {
+    if (typeof text !== 'string') {
+        return '';
     }
-    if (Platform.OS === 'ios') {
-        return 'IOSNative';
+    return text.trim();
+}
+/**
+ * Tries to get the stack trace from the given error object and returns it.
+ * If the error object does not have a stack trace, an empty string is returned.
+ *
+ * @param {Error} error - The error object from which to retrieve the stack trace.
+ * @returns {string} The stack trace of the error, if available. Otherwise, an empty string is returned.
+ */
+function tryGetStackTrace(error) {
+    let result = '';
+    try {
+        if (error && error.stack) {
+            result = `(stack: ${error.stack})`;
+        }
     }
-    return '';
+    catch (_a) {
+        // non-standard property - that's fine
+    }
+    return result;
+}
+/**
+ * Checks whether the given value is a string or an instance of String.
+ * @param {*} value - The value to be checked.
+ * @returns {boolean} Returns true if the value is a string or an instance of String, otherwise returns false.
+ */
+function isString(value) {
+    return typeof value === 'string' || value instanceof String;
 }
 
-export { asString, getJSStack, getMaxSubstringAllowed, getUserAgent, getVideoRecorderType, isInstanceOf, isInvalidURLConfig, isNoibuJSAlreadyLoaded, isStackTrace, isValidURL, makeRequest, maskTextInput, processFrames, stringifyJSON };
+export { asString, getJSStack, getMaxSubstringAllowed, getUserAgent, getVideoRecorderType, isInstanceOf, isInvalidURLConfig, isNoibuJSAlreadyLoaded, isStackTrace, isString, isValidURL, makeRequest, maskTextInput, processFrames, safeTrim, stringifyJSON, tryGetStackTrace };

package/dist/utils/object.js

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/ban-types */
 /** @module Object */
 /**
  * Replaces an attribute value found in an object with another value
@@ -51,9 +52,7 @@ function unwrapNoibuWrapped(anything) {
  * Checks whether the prototype's property is writeable. If it is not,
  * checks whether the property can be made writeable. If it can, it is
  * set to writeable.
- * @param {object} proto
- * @param {string} property
- * @returns {boolean} Whether the property on the prototype is (or is now) writeable
+ * returns Whether the property on the prototype is (or is now) writeable
  */
 const propWriteableOrMadeWriteable = (proto, property) => {
     if (!proto ||
@@ -65,9 +64,9 @@ const propWriteableOrMadeWriteable = (proto, property) => {
     // has under the open property
     const propDescriptor = Object.getOwnPropertyDescriptor(proto, property);
     // Checking if the open property is read-only
-    if (!propDescriptor?.writable) {
+    if (!(propDescriptor === null || propDescriptor === void 0 ? void 0 : propDescriptor.writable)) {
         // Checking if we can write to it
-        if (propDescriptor?.configurable) {
+        if (propDescriptor === null || propDescriptor === void 0 ? void 0 : propDescriptor.configurable) {
             // Making it writable to wrap it
             Object.defineProperty(proto, property, {
                 writable: true,
@@ -117,5 +116,59 @@ const iterateObjectRecursively = (instance, visit, limit = { depth: 5 }) => {
     };
     iterate(instance, 1);
 };
+const safeEntries = (obj) => {
+    const collection = [];
+    if (!obj) {
+        return collection;
+    }
+    if (obj instanceof Headers) {
+        obj.forEach((value, key) => {
+            collection.push([key, value]);
+        });
+    }
+    else if (typeof obj === 'object') {
+        collection.push(...Object.entries(obj));
+    }
+    return collection;
+};
+/**
+ * Determines if the given instance is iterable.
+ * An object is considered iterable if it has a method whose key is `Symbol.iterator`.
+ * This method checks if `instance[Symbol.iterator]` is a function, and if so, returns `true`.
+ * If `instance` is `null` or `undefined`, or if accessing `instance[Symbol.iterator]` throws an error,
+ * this method returns `false`.
+ */
+function isIterable(instance) {
+    if (!instance) {
+        return false;
+    }
+    try {
+        return typeof instance[Symbol.iterator] === 'function';
+    }
+    catch (e) {
+        return false;
+    }
+}
+/**
+ * Replaces the behaviour of Object.fromEntries() as it is not supported on all browsers
+ * @param {Iterable} entries The iterable to parse into an object
+ * @returns An object containing the same key/values as the iterable passed
+ */
+const safeFromEntries = (entries) => {
+    if (!isIterable(entries)) {
+        return {};
+    }
+    const obj = {};
+    try {
+        // eslint-disable-next-line no-restricted-syntax
+        for (const [key, value] of entries) {
+            obj[key] = value;
+        }
+    }
+    catch (e) {
+        // noting we can do - give up
+    }
+    return obj;
+};
 
-export { iterateObjectRecursively, propWriteableOrMadeWriteable, replace, unwrapNoibuWrapped };
+export { iterateObjectRecursively, propWriteableOrMadeWriteable, replace, safeEntries, safeFromEntries, unwrapNoibuWrapped };

package/dist/utils/piiRedactor.js

@@ -0,0 +1,98 @@
+import { iterateObjectRecursively } from './object.js';
+import { HTTP_PII_BLOCKING_PATTERNS, PII_REDACTION_REPLACEMENT_STRING } from '../constants.js';
+import { stringifyJSON } from './function.js';
+
+const fuzzyFieldsToRedact = [
+    'password',
+    'address',
+    'credit',
+    'postal',
+    'token',
+    'phone',
+    'mobile',
+    'expiry',
+    'account',
+    'email',
+];
+const exactFieldsToRedact = [
+    'firstname',
+    'lastname',
+    'street',
+    'fullname',
+    'creditcard',
+    'postcode',
+    'zipcode',
+    'city',
+    'town',
+    'county',
+    'cc',
+    'cardtype',
+    'cardnumber',
+    'email',
+];
+/**
+ * Redacts one string, returns redacted value or false if nothing to redact
+ */
+function shouldRedact(field) {
+    // check for exact and fuzzy matches
+    return (exactFieldsToRedact.some(v => field === v) ||
+        fuzzyFieldsToRedact.some(v => field.indexOf(v) >= 0));
+}
+/**
+ * Try to parse content as a JSON object and
+ * iterate it recursively removing PII.
+ * Returns original content if nothing was changes or error is thrown.
+ * @param {String} content
+ */
+function tryParseObjectAndRemovePII(content) {
+    const first = content[0];
+    const isParsable = first === '{' || first === '[';
+    if (!isParsable) {
+        return content;
+    }
+    let redacted = false;
+    try {
+        const instance = JSON.parse(content);
+        iterateObjectRecursively(instance, (current, property) => {
+            if (typeof property !== 'string') {
+                return undefined;
+            }
+            const propertyLowerCase = property.toLowerCase();
+            const shouldRedactField = shouldRedact(propertyLowerCase);
+            if (shouldRedactField) {
+                redacted = true;
+                return PII_REDACTION_REPLACEMENT_STRING;
+            }
+            return undefined;
+        });
+        return redacted ? stringifyJSON(instance) : content;
+    }
+    catch (e) {
+        return content;
+    }
+}
+/**
+ * Takes a string and redacts any PII we're able to detect
+ *
+ * content - the string from which we want to redact PII
+ * returns the string with any PII we're able to detect redacted.
+ */
+function removePII(content) {
+    /* eslint-disable no-param-reassign */
+    // In order to be fail-safe, let's return null if we won't be able to remove PII.
+    if (typeof content !== 'string') {
+        return '';
+    }
+    if (!content.length) {
+        return content;
+    }
+    content = tryParseObjectAndRemovePII(content);
+    // Go through each of the PII matching patterns
+    HTTP_PII_BLOCKING_PATTERNS.forEach(pattern => {
+        // Replace all matches with the appropriate number of asterisks
+        content = content.replace(pattern, PII_REDACTION_REPLACEMENT_STRING);
+    });
+    return content;
+}
+
+export { removePII, shouldRedact };

package/dist/utils/polyfills.js

@@ -0,0 +1,24 @@
+var _a, _b;
+/**
+ * In case Promise.all is not available, use this polyfill
+ */
+const promiseAll = ((_b = (_a = Promise === null || Promise === void 0 ? void 0 : Promise.all) === null || _a === void 0 ? void 0 : _a.bind) === null || _b === void 0 ? void 0 : _b.call(_a, Promise)) ||
+    ((values) => {
+        return new Promise(function (resolve, reject) {
+            const result = [];
+            let total = 0;
+            values.forEach((item, index) => {
+                Promise.resolve(item)
+                    .then(res => {
+                    result[index] = res;
+                    total += 1;
+                    if (total === values.length) {
+                        resolve(result);
+                    }
+                })
+                    .catch(reject);
+            });
+        });
+    });
+
+export { promiseAll };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "noibu-react-native",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "targetNjsVersion": "1.0.104",
   "description": "React-Native SDK for NoibuJS to collect errors in React-Native applications",
   "main": "dist/entry/index.js",
@@ -18,6 +18,7 @@
     "build:dev": "node ./build.watch.js",
     "prepare": "npm run clean; npm run build;",
     "test": "jest --coverage --passWithNoTests",
+    "tsc": "tsc",
     "lint": "eslint src -c .eslintrc.json --ext js,ts,jsx,tsx",
     "lint_output": "eslint src -c .eslintrc.json --ext js,ts,jsx,tsx -f json > eslint_report.json",
     "codecov": "codecov"
@@ -38,13 +39,12 @@
     "@react-native-async-storage/async-storage": "^1.19.0",
     "fflate": "^0.8.2",
     "react": ">=16.13.1 <=18",
-    "react-native": "^0.63.0",
+    "react-native": ">=0.63.0",
     "react-native-navigation": ">=2.29.0",
     "react-native-url-polyfill": "^1.3.0",
     "react-native-uuid": "^2.0.1"
   },
   "devDependencies": {
-    "@babel/preset-env": "^7.24.8",
     "@jest/globals": "^29.7.0",
     "@react-native-async-storage/async-storage": "1.19.0",
     "@rollup/plugin-commonjs": "^25.0.0",
@@ -56,9 +56,9 @@
     "@types/jest": "^29.5.1",
     "@types/node": "^20.2.3",
     "@types/react": "16.14.62",
-    "@types/react-native": "0.63.50",
     "@types/react-test-renderer": "^18.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.59.6",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
     "babel-jest": "^29.7.0",
     "babel-plugin-transform-flow-strip-types": "^6.22.0",
     "codecov": "^3.8.3",
@@ -72,12 +72,12 @@
     "jest": "^29.7.0",
     "prettier": "^2.8.8",
     "react": "16.13.1",
-    "react-native": "^0.63.0",
-    "react-native-navigation": "2.29.0",
+    "react-native": "0.63.0",
+    "react-native-navigation": "^7.40.3",
     "react-native-url-polyfill": "1.3.0",
     "react-native-uuid": "2.0.1",
     "rimraf": "^5.0.1",
-    "rollup": "^3.24.0",
+    "rollup": "^4.27.4",
     "rollup-plugin-dotenv": "^0.5.0",
     "ts-jest": "^29.2.3",
     "typescript": "^5.5.3"

package/dist/monitors/appNavigationMonitor.d.ts

@@ -1,22 +0,0 @@
-/**
- * Attaches corresponding listener to the passed navigation integration
- */
-export declare class AppNavigationMonitor {
-    private static instance;
-    /**
-     * guesses which navigation is used in app, and registers a listener if found
-     */
-    constructor();
-    /**
-     * handler for updating navigation breadcrumbs and notifying metro of location change
-     */
-    onNavigation(breadcrumbs: string[]): void;
-    /**
-     * Gets the singleton instance
-     */
-    static getInstance(): AppNavigationMonitor;
-    /**
-     * Called when the event needs to be emitted
-     */
-    private reportLocationChange;
-}

package/dist/monitors/clickMonitor.d.ts

@@ -1,44 +0,0 @@
-/** Monitors the clicks which we capture and later process */
-export class ClickMonitor {
-    /** gets the singleton instance
-     * @returns {ClickMonitor}
-     */
-    static getInstance(): ClickMonitor;
-    /**
-     * Gets selectors to prevent those elements from being recorded
-     */
-    static getBlockedElements(): string[];
-    textCapturedWhiteListRegex: RegExp;
-    htmlIDAllowListRegex: RegExp;
-    /** Starts monitoring clicks on every Press-able component */
-    monitorClicks(): void;
-    /**
-     * Handles a single click event
-     * @param  {{ _targetInst: RNNode }} event
-     */
-    _onClickHandle(event: {
-        _targetInst: RNNode;
-    }): void;
-    /** Gets the textual content from an element, if any
-     * @param  {} element
-     */
-    _getTextualContentFromEl(element: any): string;
-    /** Parse and trim text
-     * @param  {} text
-     */
-    _trimText(text: any): any;
-    /**
-     * Recursively parses element's inner content and masks blocked css classes
-     * @param {NReactNative.Node} element
-     * @param {String} text
-     * @param {Number} textLimit
-     * @param {Object} counter
-     */
-    _parseInnerContent(element: NReactNative.Node, text: string, textLimit: number, counter: Object): string;
-    /**
-     * normalize value and append to the resulting text if not empty
-     * @param {String} text
-     * @param {Array.<any>} values
-     */
-    _parseAndAppendText(text: string, values: Array<any>): string;
-}