@openobserve/browser-core 0.3.4 → 0.4.0-beta.1

package/cjs/tools/serialisation/sanitize.js

@@ -1,188 +1,132 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitize = sanitize;
-const display_1 = require("../display");
-const byteUtils_1 = require("../utils/byteUtils");
-const jsonStringify_1 = require("./jsonStringify");
-// The maximum size of a single event is 256KiB. By default, we ensure that user-provided data
-// going through sanitize fits inside our events, while leaving room for other contexts, metadata, ...
-const SANITIZE_DEFAULT_MAX_CHARACTER_COUNT = 220 * byteUtils_1.ONE_KIBI_BYTE;
-// Symbol for the root element of the JSONPath used for visited objects
-const JSON_PATH_ROOT_ELEMENT = '$';
-// When serializing (using JSON.stringify) a key of an object, { key: 42 } gets wrapped in quotes as "key".
-// With the separator (:), we need to add 3 characters to the count.
+const require_display = require("../display.js");
+const require_byteUtils = require("../utils/byteUtils.js");
+const require_jsonStringify = require("./jsonStringify.js");
+//#region src/tools/serialisation/sanitize.ts
+const SANITIZE_DEFAULT_MAX_CHARACTER_COUNT = 220 * require_byteUtils.ONE_KIBI_BYTE;
+const JSON_PATH_ROOT_ELEMENT = "$";
 const KEY_DECORATION_LENGTH = 3;
 function sanitize(source, maxCharacterCount = SANITIZE_DEFAULT_MAX_CHARACTER_COUNT) {
-    // Unbind any toJSON function we may have on [] or {} prototypes
-    const restoreObjectPrototypeToJson = (0, jsonStringify_1.detachToJsonMethod)(Object.prototype);
-    const restoreArrayPrototypeToJson = (0, jsonStringify_1.detachToJsonMethod)(Array.prototype);
-    // Initial call to sanitizeProcessor - will populate containerQueue if source is an Array or a plain Object
-    const containerQueue = [];
-    const visitedObjectsWithPath = new WeakMap();
-    const sanitizedData = sanitizeProcessor(source, JSON_PATH_ROOT_ELEMENT, undefined, containerQueue, visitedObjectsWithPath);
-    const serializedSanitizedData = JSON.stringify(sanitizedData);
-    let accumulatedCharacterCount = serializedSanitizedData ? serializedSanitizedData.length : 0;
-    if (accumulatedCharacterCount > maxCharacterCount) {
-        warnOverCharacterLimit(maxCharacterCount, 'discarded', source);
-        return undefined;
-    }
-    while (containerQueue.length > 0 && accumulatedCharacterCount < maxCharacterCount) {
-        const containerToProcess = containerQueue.shift();
-        let separatorLength = 0; // 0 for the first element, 1 for subsequent elements
-        // Arrays and Objects have to be handled distinctly to ensure
-        // we do not pick up non-numerical properties from Arrays
-        if (Array.isArray(containerToProcess.source)) {
-            for (let key = 0; key < containerToProcess.source.length; key++) {
-                const targetData = sanitizeProcessor(containerToProcess.source[key], containerToProcess.path, key, containerQueue, visitedObjectsWithPath);
-                if (targetData !== undefined) {
-                    accumulatedCharacterCount += JSON.stringify(targetData).length;
-                }
-                else {
-                    // When an element of an Array (targetData) is undefined, it is serialized as null:
-                    // JSON.stringify([undefined]) => '[null]' - This accounts for 4 characters
-                    accumulatedCharacterCount += 4;
-                }
-                accumulatedCharacterCount += separatorLength;
-                separatorLength = 1;
-                if (accumulatedCharacterCount > maxCharacterCount) {
-                    warnOverCharacterLimit(maxCharacterCount, 'truncated', source);
-                    break;
-                }
-                ;
-                containerToProcess.target[key] = targetData;
-            }
-        }
-        else {
-            for (const key in containerToProcess.source) {
-                if (Object.prototype.hasOwnProperty.call(containerToProcess.source, key)) {
-                    const targetData = sanitizeProcessor(containerToProcess.source[key], containerToProcess.path, key, containerQueue, visitedObjectsWithPath);
-                    // When a property of an object has an undefined value, it will be dropped during serialization:
-                    // JSON.stringify({a:undefined}) => '{}'
-                    if (targetData !== undefined) {
-                        accumulatedCharacterCount +=
-                            JSON.stringify(targetData).length + separatorLength + key.length + KEY_DECORATION_LENGTH;
-                        separatorLength = 1;
-                    }
-                    if (accumulatedCharacterCount > maxCharacterCount) {
-                        warnOverCharacterLimit(maxCharacterCount, 'truncated', source);
-                        break;
-                    }
-                    ;
-                    containerToProcess.target[key] = targetData;
-                }
-            }
-        }
-    }
-    // Rebind detached toJSON functions
-    restoreObjectPrototypeToJson();
-    restoreArrayPrototypeToJson();
-    return sanitizedData;
+	const restoreObjectPrototypeToJson = require_jsonStringify.detachToJsonMethod(Object.prototype);
+	const restoreArrayPrototypeToJson = require_jsonStringify.detachToJsonMethod(Array.prototype);
+	try {
+		const containerQueue = [];
+		const visitedObjectsWithPath = /* @__PURE__ */ new WeakMap();
+		const sanitizedData = sanitizeProcessor(source, JSON_PATH_ROOT_ELEMENT, void 0, containerQueue, visitedObjectsWithPath);
+		const serializedSanitizedData = JSON.stringify(sanitizedData);
+		let accumulatedCharacterCount = serializedSanitizedData ? serializedSanitizedData.length : 0;
+		if (accumulatedCharacterCount > maxCharacterCount) {
+			warnOverCharacterLimit(maxCharacterCount, "discarded", source);
+			return;
+		}
+		while (containerQueue.length > 0 && accumulatedCharacterCount < maxCharacterCount) {
+			const containerToProcess = containerQueue.shift();
+			let separatorLength = 0;
+			if (Array.isArray(containerToProcess.source)) for (let key = 0; key < containerToProcess.source.length; key++) {
+				const targetData = sanitizeProcessor(containerToProcess.source[key], containerToProcess.path, key, containerQueue, visitedObjectsWithPath);
+				if (targetData !== void 0) accumulatedCharacterCount += JSON.stringify(targetData).length;
+				else accumulatedCharacterCount += 4;
+				accumulatedCharacterCount += separatorLength;
+				separatorLength = 1;
+				if (accumulatedCharacterCount > maxCharacterCount) {
+					warnOverCharacterLimit(maxCharacterCount, "truncated", source);
+					break;
+				}
+				containerToProcess.target[key] = targetData;
+			}
+			else for (const key in containerToProcess.source) if (Object.prototype.hasOwnProperty.call(containerToProcess.source, key)) {
+				const targetData = sanitizeProcessor(containerToProcess.source[key], containerToProcess.path, key, containerQueue, visitedObjectsWithPath);
+				if (targetData !== void 0) {
+					accumulatedCharacterCount += JSON.stringify(targetData).length + separatorLength + key.length + KEY_DECORATION_LENGTH;
+					separatorLength = 1;
+				}
+				if (accumulatedCharacterCount > maxCharacterCount) {
+					warnOverCharacterLimit(maxCharacterCount, "truncated", source);
+					break;
+				}
+				containerToProcess.target[key] = targetData;
+			}
+		}
+		return sanitizedData;
+	} finally {
+		restoreObjectPrototypeToJson();
+		restoreArrayPrototypeToJson();
+	}
 }
 /**
- * Internal function to factorize the process common to the
- * initial call to sanitize, and iterations for Arrays and Objects
- *
- */
+* Internal function to factorize the process common to the
+* initial call to sanitize, and iterations for Arrays and Objects
+*
+*/
 function sanitizeProcessor(source, parentPath, key, queue, visitedObjectsWithPath) {
-    // Start by handling toJSON, as we want to sanitize its output
-    const sourceToSanitize = tryToApplyToJSON(source);
-    if (!sourceToSanitize || typeof sourceToSanitize !== 'object') {
-        return sanitizePrimitivesAndFunctions(sourceToSanitize);
-    }
-    const sanitizedSource = sanitizeObjects(sourceToSanitize);
-    if (sanitizedSource !== '[Object]' && sanitizedSource !== '[Array]' && sanitizedSource !== '[Error]') {
-        return sanitizedSource;
-    }
-    // Handle potential cyclic references
-    // We need to use source as sourceToSanitize could be a reference to a new object
-    // At this stage, we know the source is an object type
-    const sourceAsObject = source;
-    if (visitedObjectsWithPath.has(sourceAsObject)) {
-        return `[Reference seen at ${visitedObjectsWithPath.get(sourceAsObject)}]`;
-    }
-    // Add processed source to queue
-    const currentPath = key !== undefined ? `${parentPath}.${key}` : parentPath;
-    const target = Array.isArray(sourceToSanitize) ? [] : {};
-    visitedObjectsWithPath.set(sourceAsObject, currentPath);
-    queue.push({ source: sourceToSanitize, target, path: currentPath });
-    return target;
+	const sourceToSanitize = tryToApplyToJSON(source);
+	if (!sourceToSanitize || typeof sourceToSanitize !== "object") return sanitizePrimitivesAndFunctions(sourceToSanitize);
+	const sanitizedSource = sanitizeObjects(sourceToSanitize);
+	if (sanitizedSource !== "[Object]" && sanitizedSource !== "[Array]" && sanitizedSource !== "[Error]") return sanitizedSource;
+	const sourceAsObject = source;
+	if (visitedObjectsWithPath.has(sourceAsObject)) return `[Reference seen at ${visitedObjectsWithPath.get(sourceAsObject)}]`;
+	const currentPath = key !== void 0 ? `${parentPath}.${key}` : parentPath;
+	const target = Array.isArray(sourceToSanitize) ? [] : {};
+	visitedObjectsWithPath.set(sourceAsObject, currentPath);
+	queue.push({
+		source: sourceToSanitize,
+		target,
+		path: currentPath
+	});
+	return target;
 }
 /**
- * Handles sanitization of simple, non-object types
- *
- */
+* Handles sanitization of simple, non-object types
+*
+*/
 function sanitizePrimitivesAndFunctions(value) {
-    // BigInt cannot be serialized by JSON.stringify(), convert it to a string representation
-    if (typeof value === 'bigint') {
-        return `[BigInt] ${value.toString()}`;
-    }
-    // Functions cannot be serialized by JSON.stringify(). Moreover, if a faulty toJSON is present, it needs to be converted
-    // so it won't prevent stringify from serializing later
-    if (typeof value === 'function') {
-        return `[Function] ${value.name || 'unknown'}`;
-    }
-    // JSON.stringify() does not serialize symbols.
-    if (typeof value === 'symbol') {
-        return `[Symbol] ${value.description || value.toString()}`;
-    }
-    return value;
+	if (typeof value === "bigint") return `[BigInt] ${value.toString()}`;
+	if (typeof value === "function") return `[Function] ${value.name || "unknown"}`;
+	if (typeof value === "symbol") return `[Symbol] ${value.description || value.toString()}`;
+	return value;
 }
 /**
- * Handles sanitization of object types
- *
- * LIMITATIONS
- * - If a class defines a toStringTag Symbol, it will fall in the catch-all method and prevent enumeration of properties.
- * To avoid this, a toJSON method can be defined.
- */
+* Handles sanitization of object types
+*
+* LIMITATIONS
+* - If a class defines a toStringTag Symbol, it will fall in the catch-all method and prevent enumeration of properties.
+* To avoid this, a toJSON method can be defined.
+*/
 function sanitizeObjects(value) {
-    try {
-        if (value instanceof Event) {
-            return sanitizeEvent(value);
-        }
-        if (value instanceof RegExp) {
-            return `[RegExp] ${value.toString()}`;
-        }
-        // Handle all remaining object types in a generic way
-        const result = Object.prototype.toString.call(value);
-        const match = result.match(/\[object (.*)\]/);
-        if (match && match[1]) {
-            return `[${match[1]}]`;
-        }
-    }
-    catch (_a) {
-        // If the previous serialization attempts failed, and we cannot convert using
-        // Object.prototype.toString, declare the value unserializable
-    }
-    return '[Unserializable]';
+	try {
+		if (value instanceof Event) return sanitizeEvent(value);
+		if (value instanceof RegExp) return `[RegExp] ${value.toString()}`;
+		const match = Object.prototype.toString.call(value).match(/\[object (.*)\]/);
+		if (match?.[1]) return `[${match[1]}]`;
+	} catch {}
+	return "[Unserializable]";
 }
 function sanitizeEvent(event) {
-    return {
-        type: event.type,
-        isTrusted: event.isTrusted,
-        currentTarget: event.currentTarget ? sanitizeObjects(event.currentTarget) : null,
-        target: event.target ? sanitizeObjects(event.target) : null,
-    };
+	return {
+		type: event.type,
+		isTrusted: event.isTrusted,
+		currentTarget: event.currentTarget ? sanitizeObjects(event.currentTarget) : null,
+		target: event.target ? sanitizeObjects(event.target) : null
+	};
 }
 /**
- * Checks if a toJSON function exists and tries to execute it
- *
- */
+* Checks if a toJSON function exists and tries to execute it
+*
+*/
 function tryToApplyToJSON(value) {
-    const object = value;
-    if (object && typeof object.toJSON === 'function') {
-        try {
-            return object.toJSON();
-        }
-        catch (_a) {
-            // If toJSON fails, we continue by trying to serialize the value manually
-        }
-    }
-    return value;
+	const object = value;
+	if (object && typeof object.toJSON === "function") try {
+		return object.toJSON();
+	} catch {}
+	return value;
 }
 /**
- * Helper function to display the warning when the accumulated character count is over the limit
- */
+* Helper function to display the warning when the accumulated character count is over the limit
+*/
 function warnOverCharacterLimit(maxCharacterCount, changeType, source) {
-    display_1.display.warn(`The data provided has been ${changeType} as it is over the limit of ${maxCharacterCount} characters:`, source);
+	require_display.display.warn(`The data provided has been ${changeType} as it is over the limit of ${maxCharacterCount} characters:`, source);
 }
+//#endregion
+exports.SANITIZE_DEFAULT_MAX_CHARACTER_COUNT = SANITIZE_DEFAULT_MAX_CHARACTER_COUNT;
+exports.sanitize = sanitize;
+
 //# sourceMappingURL=sanitize.js.map

package/cjs/tools/serialisation/sanitize.js.map

@@ -1 +1 @@
-{"version":3,"file":"sanitize.js","sourceRoot":"","sources":["../../../src/tools/serialisation/sanitize.ts"],"names":[],"mappings":";;AAuDA,4BAsFC;AA7ID,wCAAoC;AACpC,kDAAkD;AAGlD,mDAAoD;AAuBpD,8FAA8F;AAC9F,sGAAsG;AACtG,MAAM,oCAAoC,GAAG,GAAG,GAAG,yBAAa,CAAA;AAEhE,uEAAuE;AACvE,MAAM,sBAAsB,GAAG,GAAG,CAAA;AAElC,2GAA2G;AAC3G,oEAAoE;AACpE,MAAM,qBAAqB,GAAG,CAAC,CAAA;AAmB/B,SAAgB,QAAQ,CAAC,MAAe,EAAE,iBAAiB,GAAG,oCAAoC;IAChG,gEAAgE;IAChE,MAAM,4BAA4B,GAAG,IAAA,kCAAkB,EAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IACzE,MAAM,2BAA2B,GAAG,IAAA,kCAAkB,EAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IAEvE,2GAA2G;IAC3G,MAAM,cAAc,GAAgC,EAAE,CAAA;IACtD,MAAM,sBAAsB,GAAG,IAAI,OAAO,EAAkB,CAAA;IAC5D,MAAM,aAAa,GAAG,iBAAiB,CACrC,MAA8B,EAC9B,sBAAsB,EACtB,SAAS,EACT,cAAc,EACd,sBAAsB,CACvB,CAAA;IACD,MAAM,uBAAuB,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAA;IAC7D,IAAI,yBAAyB,GAAG,uBAAuB,CAAC,CAAC,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IAE5F,IAAI,yBAAyB,GAAG,iBAAiB,EAAE,CAAC;QAClD,sBAAsB,CAAC,iBAAiB,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;QAC9D,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,OAAO,cAAc,CAAC,MAAM,GAAG,CAAC,IAAI,yBAAyB,GAAG,iBAAiB,EAAE,CAAC;QAClF,MAAM,kBAAkB,GAAG,cAAc,CAAC,KAAK,EAAG,CAAA;QAClD,IAAI,eAAe,GAAG,CAAC,CAAA,CAAC,qDAAqD;QAE7E,6DAA6D;QAC7D,yDAAyD;QACzD,IAAI,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7C,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,kBAAkB,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;gBAChE,MAAM,UAAU,GAAG,iBAAiB,CAClC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,EAC9B,kBAAkB,CAAC,IAAI,EACvB,GAAG,EACH,cAAc,EACd,sBAAsB,CACvB,CAAA;gBAED,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;oBAC7B,yBAAyB,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,MAAM,CAAA;gBAChE,CAAC;qBAAM,CAAC;oBACN,mFAAmF;oBACnF,2EAA2E;oBAC3E,yBAAyB,IAAI,CAAC,CAAA;gBAChC,CAAC;gBACD,yBAAyB,IAAI,eAAe,CAAA;gBAC5C,eAAe,GAAG,CAAC,CAAA;gBACnB,IAAI,yBAAyB,GAAG,iBAAiB,EAAE,CAAC;oBAClD,sBAAsB,CAAC,iBAAiB,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;oBAC9D,MAAK;gBACP,CAAC;gBACD,CAAC;gBAAC,kBAAkB,CAAC,MAAuB,CAAC,GAAG,CAAC,GAAG,UAAU,CAAA;YAChE,CAAC;QACH,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,GAAG,IAAI,kBAAkB,CAAC,MAAM,EAAE,CAAC;gBAC5C,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;oBACzE,MAAM,UAAU,GAAG,iBAAiB,CAClC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,EAC9B,kBAAkB,CAAC,IAAI,EACvB,GAAG,EACH,cAAc,EACd,sBAAsB,CACvB,CAAA;oBACD,gGAAgG;oBAChG,wCAAwC;oBACxC,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;wBAC7B,yBAAyB;4BACvB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,eAAe,GAAG,GAAG,CAAC,MAAM,GAAG,qBAAqB,CAAA;wBAC1F,eAAe,GAAG,CAAC,CAAA;oBACrB,CAAC;oBACD,IAAI,yBAAyB,GAAG,iBAAiB,EAAE,CAAC;wBAClD,sBAAsB,CAAC,iBAAiB,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;wBAC9D,MAAK;oBACP,CAAC;oBACD,CAAC;oBAAC,kBAAkB,CAAC,MAAkB,CAAC,GAAG,CAAC,GAAG,UAAU,CAAA;gBAC3D,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,mCAAmC;IACnC,4BAA4B,EAAE,CAAA;IAC9B,2BAA2B,EAAE,CAAA;IAE7B,OAAO,aAAa,CAAA;AACtB,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CACxB,MAA4B,EAC5B,UAAkB,EAClB,GAAgC,EAChC,KAAkC,EAClC,sBAA+C;IAE/C,8DAA8D;IAC9D,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAEjD,IAAI,CAAC,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE,CAAC;QAC9D,OAAO,8BAA8B,CAAC,gBAAgB,CAAC,CAAA;IACzD,CAAC;IAED,MAAM,eAAe,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAA;IACzD,IAAI,eAAe,KAAK,UAAU,IAAI,eAAe,KAAK,SAAS,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QACrG,OAAO,eAAe,CAAA;IACxB,CAAC;IAED,qCAAqC;IACrC,iFAAiF;IACjF,sDAAsD;IACtD,MAAM,cAAc,GAAG,MAAgB,CAAA;IACvC,IAAI,sBAAsB,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;QAC/C,OAAO,sBAAsB,sBAAsB,CAAC,GAAG,CAAC,cAAc,CAAE,GAAG,CAAA;IAC7E,CAAC;IAED,gCAAgC;IAChC,MAAM,WAAW,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,UAAU,CAAA;IAC3E,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAE,EAAmB,CAAC,CAAC,CAAE,EAAc,CAAA;IACvF,sBAAsB,CAAC,GAAG,CAAC,cAAc,EAAE,WAAW,CAAC,CAAA;IACvD,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,gBAA0D,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAA;IAE7G,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;GAGG;AACH,SAAS,8BAA8B,CAAC,KAA6B;IACnE,yFAAyF;IACzF,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,YAAY,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAA;IACvC,CAAC;IACD,wHAAwH;IACxH,uDAAuD;IACvD,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,OAAO,cAAc,KAAK,CAAC,IAAI,IAAI,SAAS,EAAE,CAAA;IAChD,CAAC;IACD,+CAA+C;IAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAG9B,OAAO,YAAa,KAA+B,CAAC,WAAW,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAA;IACvF,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,KAAa;IACpC,IAAI,CAAC;QACH,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,OAAO,aAAa,CAAC,KAAK,CAAC,CAAA;QAC7B,CAAC;QAED,IAAI,KAAK,YAAY,MAAM,EAAE,CAAC;YAC5B,OAAO,YAAY,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAA;QACvC,CAAC;QAED,qDAAqD;QACrD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACpD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAA;QAC7C,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACtB,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,CAAA;QACxB,CAAC;IACH,CAAC;IAAC,WAAM,CAAC;QACP,6EAA6E;QAC7E,8DAA8D;IAChE,CAAC;IACD,OAAO,kBAAkB,CAAA;AAC3B,CAAC;AAED,SAAS,aAAa,CAAC,KAAY;IACjC,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAE,eAAe,CAAC,KAAK,CAAC,aAAa,CAAY,CAAC,CAAC,CAAC,IAAI;QAC5F,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAE,eAAe,CAAC,KAAK,CAAC,MAAM,CAAY,CAAC,CAAC,CAAC,IAAI;KACxE,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CAAC,KAA2B;IACnD,MAAM,MAAM,GAAG,KAA+B,CAAA;IAC9C,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QAClD,IAAI,CAAC;YACH,OAAO,MAAM,CAAC,MAAM,EAA0B,CAAA;QAChD,CAAC;QAAC,WAAM,CAAC;YACP,yEAAyE;QAC3E,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,iBAAyB,EAAE,UAAqC,EAAE,MAAe;IAC/G,iBAAO,CAAC,IAAI,CACV,8BAA8B,UAAU,+BAA+B,iBAAiB,cAAc,EACtG,MAAM,CACP,CAAA;AACH,CAAC"}
+{"version":3,"file":"sanitize.js","names":["ONE_KIBI_BYTE","detachToJsonMethod"],"sources":["../../../src/tools/serialisation/sanitize.ts"],"sourcesContent":["import { display } from '../display'\nimport { ONE_KIBI_BYTE } from '../utils/byteUtils'\nimport type { Context, ContextArray, ContextValue } from './context'\nimport type { ObjectWithToJsonMethod } from './jsonStringify'\nimport { detachToJsonMethod } from './jsonStringify'\n\n// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type\ntype PrimitivesAndFunctions = string | number | boolean | undefined | null | symbol | bigint | Function\ntype ExtendedContextValue = PrimitivesAndFunctions | ExtendedContext | ExtendedContextArray\ninterface ExtendedContext {\n  [key: string]: ExtendedContextValue\n}\ntype ExtendedContextArray = ExtendedContextValue[]\n\ninterface ContainerElementToProcess {\n  source: ExtendedContextArray | ExtendedContext\n  target: ContextArray | Context\n  path: string\n}\n\ninterface SanitizedEvent extends Context {\n  type: string\n  isTrusted: boolean\n  currentTarget: string | null | undefined\n  target: string | null | undefined\n}\n\n// The maximum size of a single event is 256KiB. By default, we ensure that user-provided data\n// going through sanitize fits inside our events, while leaving room for other contexts, metadata, ...\nexport const SANITIZE_DEFAULT_MAX_CHARACTER_COUNT = 220 * ONE_KIBI_BYTE\n\n// Symbol for the root element of the JSONPath used for visited objects\nconst JSON_PATH_ROOT_ELEMENT = '$'\n\n// When serializing (using JSON.stringify) a key of an object, { key: 42 } gets wrapped in quotes as \"key\".\n// With the separator (:), we need to add 3 characters to the count.\nconst KEY_DECORATION_LENGTH = 3\n\n/**\n * Ensures user-provided data is 'safe' for the SDK\n * - Deep clones data\n * - Removes cyclic references\n * - Transforms unserializable types to a string representation\n *\n * LIMITATIONS:\n * - Size is in characters, not byte count (may differ according to character encoding)\n * - Size does not take into account indentation that can be applied to JSON.stringify\n * - Non-numerical properties of Arrays are ignored. Same behavior as JSON.stringify\n *\n * @param source              - User-provided data meant to be serialized using JSON.stringify\n * @param maxCharacterCount   - Maximum number of characters allowed in serialized form\n */\nexport function sanitize(source: string, maxCharacterCount?: number): string | undefined\nexport function sanitize(source: Context, maxCharacterCount?: number): Context\nexport function sanitize(source: unknown, maxCharacterCount?: number): ContextValue\nexport function sanitize(source: unknown, maxCharacterCount = SANITIZE_DEFAULT_MAX_CHARACTER_COUNT) {\n  // Unbind any toJSON function we may have on [] or {} prototypes\n  const restoreObjectPrototypeToJson = detachToJsonMethod(Object.prototype)\n  const restoreArrayPrototypeToJson = detachToJsonMethod(Array.prototype)\n\n  try {\n    // Initial call to sanitizeProcessor - will populate containerQueue if source is an Array or a plain Object\n    const containerQueue: ContainerElementToProcess[] = []\n    const visitedObjectsWithPath = new WeakMap<object, string>()\n    const sanitizedData = sanitizeProcessor(\n      source as ExtendedContextValue,\n      JSON_PATH_ROOT_ELEMENT,\n      undefined,\n      containerQueue,\n      visitedObjectsWithPath\n    )\n    const serializedSanitizedData = JSON.stringify(sanitizedData)\n    let accumulatedCharacterCount = serializedSanitizedData ? serializedSanitizedData.length : 0\n\n    if (accumulatedCharacterCount > maxCharacterCount) {\n      warnOverCharacterLimit(maxCharacterCount, 'discarded', source)\n      return undefined\n    }\n\n    while (containerQueue.length > 0 && accumulatedCharacterCount < maxCharacterCount) {\n      const containerToProcess = containerQueue.shift()!\n      let separatorLength = 0 // 0 for the first element, 1 for subsequent elements\n\n      // Arrays and Objects have to be handled distinctly to ensure\n      // we do not pick up non-numerical properties from Arrays\n      if (Array.isArray(containerToProcess.source)) {\n        for (let key = 0; key < containerToProcess.source.length; key++) {\n          const targetData = sanitizeProcessor(\n            containerToProcess.source[key],\n            containerToProcess.path,\n            key,\n            containerQueue,\n            visitedObjectsWithPath\n          )\n\n          if (targetData !== undefined) {\n            accumulatedCharacterCount += JSON.stringify(targetData).length\n          } else {\n            // When an element of an Array (targetData) is undefined, it is serialized as null:\n            // JSON.stringify([undefined]) => '[null]' - This accounts for 4 characters\n            accumulatedCharacterCount += 4\n          }\n          accumulatedCharacterCount += separatorLength\n          separatorLength = 1\n          if (accumulatedCharacterCount > maxCharacterCount) {\n            warnOverCharacterLimit(maxCharacterCount, 'truncated', source)\n            break\n          }\n          ;(containerToProcess.target as ContextArray)[key] = targetData\n        }\n      } else {\n        for (const key in containerToProcess.source) {\n          if (Object.prototype.hasOwnProperty.call(containerToProcess.source, key)) {\n            const targetData = sanitizeProcessor(\n              containerToProcess.source[key],\n              containerToProcess.path,\n              key,\n              containerQueue,\n              visitedObjectsWithPath\n            )\n            // When a property of an object has an undefined value, it will be dropped during serialization:\n            // JSON.stringify({a:undefined}) => '{}'\n            if (targetData !== undefined) {\n              accumulatedCharacterCount +=\n                JSON.stringify(targetData).length + separatorLength + key.length + KEY_DECORATION_LENGTH\n              separatorLength = 1\n            }\n            if (accumulatedCharacterCount > maxCharacterCount) {\n              warnOverCharacterLimit(maxCharacterCount, 'truncated', source)\n              break\n            }\n            ;(containerToProcess.target as Context)[key] = targetData\n          }\n        }\n      }\n    }\n\n    return sanitizedData\n  } finally {\n    // Rebind detached toJSON functions\n    restoreObjectPrototypeToJson()\n    restoreArrayPrototypeToJson()\n  }\n}\n\n/**\n * Internal function to factorize the process common to the\n * initial call to sanitize, and iterations for Arrays and Objects\n *\n */\nfunction sanitizeProcessor(\n  source: ExtendedContextValue,\n  parentPath: string,\n  key: string | number | undefined,\n  queue: ContainerElementToProcess[],\n  visitedObjectsWithPath: WeakMap<object, string>\n) {\n  // Start by handling toJSON, as we want to sanitize its output\n  const sourceToSanitize = tryToApplyToJSON(source)\n\n  if (!sourceToSanitize || typeof sourceToSanitize !== 'object') {\n    return sanitizePrimitivesAndFunctions(sourceToSanitize)\n  }\n\n  const sanitizedSource = sanitizeObjects(sourceToSanitize)\n  if (sanitizedSource !== '[Object]' && sanitizedSource !== '[Array]' && sanitizedSource !== '[Error]') {\n    return sanitizedSource\n  }\n\n  // Handle potential cyclic references\n  // We need to use source as sourceToSanitize could be a reference to a new object\n  // At this stage, we know the source is an object type\n  const sourceAsObject = source as object\n  if (visitedObjectsWithPath.has(sourceAsObject)) {\n    return `[Reference seen at ${visitedObjectsWithPath.get(sourceAsObject)!}]`\n  }\n\n  // Add processed source to queue\n  const currentPath = key !== undefined ? `${parentPath}.${key}` : parentPath\n  const target = Array.isArray(sourceToSanitize) ? ([] as ContextArray) : ({} as Context)\n  visitedObjectsWithPath.set(sourceAsObject, currentPath)\n  queue.push({ source: sourceToSanitize, target, path: currentPath })\n\n  return target\n}\n\n/**\n * Handles sanitization of simple, non-object types\n *\n */\nfunction sanitizePrimitivesAndFunctions(value: PrimitivesAndFunctions) {\n  // BigInt cannot be serialized by JSON.stringify(), convert it to a string representation\n  if (typeof value === 'bigint') {\n    return `[BigInt] ${value.toString()}`\n  }\n  // Functions cannot be serialized by JSON.stringify(). Moreover, if a faulty toJSON is present, it needs to be converted\n  // so it won't prevent stringify from serializing later\n  if (typeof value === 'function') {\n    return `[Function] ${value.name || 'unknown'}`\n  }\n  // JSON.stringify() does not serialize symbols.\n  if (typeof value === 'symbol') {\n    // symbol.description is part of ES2019+\n    type symbolWithDescription = symbol & { description: string }\n    return `[Symbol] ${(value as symbolWithDescription).description || value.toString()}`\n  }\n\n  return value\n}\n\n/**\n * Handles sanitization of object types\n *\n * LIMITATIONS\n * - If a class defines a toStringTag Symbol, it will fall in the catch-all method and prevent enumeration of properties.\n * To avoid this, a toJSON method can be defined.\n */\nfunction sanitizeObjects(value: object): string | SanitizedEvent {\n  try {\n    if (value instanceof Event) {\n      return sanitizeEvent(value)\n    }\n\n    if (value instanceof RegExp) {\n      return `[RegExp] ${value.toString()}`\n    }\n\n    // Handle all remaining object types in a generic way\n    const result = Object.prototype.toString.call(value)\n    const match = result.match(/\\[object (.*)\\]/)\n    if (match?.[1]) {\n      return `[${match[1]}]`\n    }\n  } catch {\n    // If the previous serialization attempts failed, and we cannot convert using\n    // Object.prototype.toString, declare the value unserializable\n  }\n  return '[Unserializable]'\n}\n\nfunction sanitizeEvent(event: Event): SanitizedEvent {\n  return {\n    type: event.type,\n    isTrusted: event.isTrusted,\n    currentTarget: event.currentTarget ? (sanitizeObjects(event.currentTarget) as string) : null,\n    target: event.target ? (sanitizeObjects(event.target) as string) : null,\n  }\n}\n\n/**\n * Checks if a toJSON function exists and tries to execute it\n *\n */\nfunction tryToApplyToJSON(value: ExtendedContextValue) {\n  const object = value as ObjectWithToJsonMethod\n  if (object && typeof object.toJSON === 'function') {\n    try {\n      return object.toJSON() as ExtendedContextValue\n    } catch {\n      // If toJSON fails, we continue by trying to serialize the value manually\n    }\n  }\n\n  return value\n}\n\n/**\n * Helper function to display the warning when the accumulated character count is over the limit\n */\nfunction warnOverCharacterLimit(maxCharacterCount: number, changeType: 'discarded' | 'truncated', source: unknown) {\n  display.warn(\n    `The data provided has been ${changeType} as it is over the limit of ${maxCharacterCount} characters:`,\n    source\n  )\n}\n"],"mappings":";;;;AA6BA,MAAa,uCAAuC,MAAMA,kBAAAA;AAG1D,MAAM,yBAAyB;AAI/B,MAAM,wBAAwB;AAmB9B,SAAgB,SAAS,QAAiB,oBAAoB,sCAAsC;CAElG,MAAM,+BAA+BC,sBAAAA,mBAAmB,OAAO,SAAS;CACxE,MAAM,8BAA8BA,sBAAAA,mBAAmB,MAAM,SAAS;CAEtE,IAAI;EAEF,MAAM,iBAA8C,CAAC;EACrD,MAAM,yCAAyB,IAAI,QAAwB;EAC3D,MAAM,gBAAgB,kBACpB,QACA,wBACA,KAAA,GACA,gBACA,sBACF;EACA,MAAM,0BAA0B,KAAK,UAAU,aAAa;EAC5D,IAAI,4BAA4B,0BAA0B,wBAAwB,SAAS;EAE3F,IAAI,4BAA4B,mBAAmB;GACjD,uBAAuB,mBAAmB,aAAa,MAAM;GAC7D;EACF;EAEA,OAAO,eAAe,SAAS,KAAK,4BAA4B,mBAAmB;GACjF,MAAM,qBAAqB,eAAe,MAAM;GAChD,IAAI,kBAAkB;GAItB,IAAI,MAAM,QAAQ,mBAAmB,MAAM,GACzC,KAAK,IAAI,MAAM,GAAG,MAAM,mBAAmB,OAAO,QAAQ,OAAO;IAC/D,MAAM,aAAa,kBACjB,mBAAmB,OAAO,MAC1B,mBAAmB,MACnB,KACA,gBACA,sBACF;IAEA,IAAI,eAAe,KAAA,GACjB,6BAA6B,KAAK,UAAU,UAAU,CAAC,CAAC;SAIxD,6BAA6B;IAE/B,6BAA6B;IAC7B,kBAAkB;IAClB,IAAI,4BAA4B,mBAAmB;KACjD,uBAAuB,mBAAmB,aAAa,MAAM;KAC7D;IACF;IACC,mBAAoB,OAAwB,OAAO;GACtD;QAEA,KAAK,MAAM,OAAO,mBAAmB,QACnC,IAAI,OAAO,UAAU,eAAe,KAAK,mBAAmB,QAAQ,GAAG,GAAG;IACxE,MAAM,aAAa,kBACjB,mBAAmB,OAAO,MAC1B,mBAAmB,MACnB,KACA,gBACA,sBACF;IAGA,IAAI,eAAe,KAAA,GAAW;KAC5B,6BACE,KAAK,UAAU,UAAU,CAAC,CAAC,SAAS,kBAAkB,IAAI,SAAS;KACrE,kBAAkB;IACpB;IACA,IAAI,4BAA4B,mBAAmB;KACjD,uBAAuB,mBAAmB,aAAa,MAAM;KAC7D;IACF;IACC,mBAAoB,OAAmB,OAAO;GACjD;EAGN;EAEA,OAAO;CACT,UAAU;EAER,6BAA6B;EAC7B,4BAA4B;CAC9B;AACF;;;;;;AAOA,SAAS,kBACP,QACA,YACA,KACA,OACA,wBACA;CAEA,MAAM,mBAAmB,iBAAiB,MAAM;CAEhD,IAAI,CAAC,oBAAoB,OAAO,qBAAqB,UACnD,OAAO,+BAA+B,gBAAgB;CAGxD,MAAM,kBAAkB,gBAAgB,gBAAgB;CACxD,IAAI,oBAAoB,cAAc,oBAAoB,aAAa,oBAAoB,WACzF,OAAO;CAMT,MAAM,iBAAiB;CACvB,IAAI,uBAAuB,IAAI,cAAc,GAC3C,OAAO,sBAAsB,uBAAuB,IAAI,cAAc,EAAG;CAI3E,MAAM,cAAc,QAAQ,KAAA,IAAY,GAAG,WAAW,GAAG,QAAQ;CACjE,MAAM,SAAS,MAAM,QAAQ,gBAAgB,IAAK,CAAC,IAAsB,CAAC;CAC1E,uBAAuB,IAAI,gBAAgB,WAAW;CACtD,MAAM,KAAK;EAAE,QAAQ;EAAkB;EAAQ,MAAM;CAAY,CAAC;CAElE,OAAO;AACT;;;;;AAMA,SAAS,+BAA+B,OAA+B;CAErE,IAAI,OAAO,UAAU,UACnB,OAAO,YAAY,MAAM,SAAS;CAIpC,IAAI,OAAO,UAAU,YACnB,OAAO,cAAc,MAAM,QAAQ;CAGrC,IAAI,OAAO,UAAU,UAGnB,OAAO,YAAa,MAAgC,eAAe,MAAM,SAAS;CAGpF,OAAO;AACT;;;;;;;;AASA,SAAS,gBAAgB,OAAwC;CAC/D,IAAI;EACF,IAAI,iBAAiB,OACnB,OAAO,cAAc,KAAK;EAG5B,IAAI,iBAAiB,QACnB,OAAO,YAAY,MAAM,SAAS;EAKpC,MAAM,QADS,OAAO,UAAU,SAAS,KAAK,KAC3B,CAAC,CAAC,MAAM,iBAAiB;EAC5C,IAAI,QAAQ,IACV,OAAO,IAAI,MAAM,GAAG;CAExB,QAAQ,CAGR;CACA,OAAO;AACT;AAEA,SAAS,cAAc,OAA8B;CACnD,OAAO;EACL,MAAM,MAAM;EACZ,WAAW,MAAM;EACjB,eAAe,MAAM,gBAAiB,gBAAgB,MAAM,aAAa,IAAe;EACxF,QAAQ,MAAM,SAAU,gBAAgB,MAAM,MAAM,IAAe;CACrE;AACF;;;;;AAMA,SAAS,iBAAiB,OAA6B;CACrD,MAAM,SAAS;CACf,IAAI,UAAU,OAAO,OAAO,WAAW,YACrC,IAAI;EACF,OAAO,OAAO,OAAO;CACvB,QAAQ,CAER;CAGF,OAAO;AACT;;;;AAKA,SAAS,uBAAuB,mBAA2B,YAAuC,QAAiB;CACjH,gBAAA,QAAQ,KACN,8BAA8B,WAAW,8BAA8B,kBAAkB,eACzF,MACF;AACF"}

package/cjs/tools/serialisation/stringify.d.ts

@@ -0,0 +1,2 @@
+export declare function safeToString(value: unknown): string | undefined;
+export declare function safeStringify(value: unknown): string | undefined;

package/cjs/tools/serialisation/stringify.js

@@ -0,0 +1,18 @@
+const require_jsonStringify = require("./jsonStringify.js");
+const require_sanitize = require("./sanitize.js");
+//#region src/tools/serialisation/stringify.ts
+function safeToString(value) {
+	try {
+		return String(value);
+	} catch {}
+}
+function safeStringify(value) {
+	try {
+		return require_jsonStringify.jsonStringify(require_sanitize.sanitize(value));
+	} catch {}
+}
+//#endregion
+exports.safeStringify = safeStringify;
+exports.safeToString = safeToString;
+
+//# sourceMappingURL=stringify.js.map

package/cjs/tools/serialisation/stringify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringify.js","names":["jsonStringify","sanitize"],"sources":["../../../src/tools/serialisation/stringify.ts"],"sourcesContent":["import { jsonStringify } from './jsonStringify'\nimport { sanitize } from './sanitize'\n\nexport function safeToString(value: unknown): string | undefined {\n  try {\n    return String(value)\n  } catch {\n    // ignore\n  }\n}\n\nexport function safeStringify(value: unknown): string | undefined {\n  try {\n    return jsonStringify(sanitize(value))\n  } catch {\n    // ignore\n  }\n}\n"],"mappings":";;;AAGA,SAAgB,aAAa,OAAoC;CAC/D,IAAI;EACF,OAAO,OAAO,KAAK;CACrB,QAAQ,CAER;AACF;AAEA,SAAgB,cAAc,OAAoC;CAChE,IAAI;EACF,OAAOA,sBAAAA,cAAcC,iBAAAA,SAAS,KAAK,CAAC;CACtC,QAAQ,CAER;AACF"}