Files
Tom Moor 620ef924a1 Improve log data sanitization (#14671)
* Improve log data sanitization

Extract the log sanitizer into its own module, match field names regardless of case and separators, extend the filtered fields, sanitize Sentry extras as a whole, keep serializable values such as dates, and apply the depth limit only to nested objects.

* Call toJSON once when sanitizing log data
2026-11-19 17:59:44 -05:00

94 lines
2.4 KiB
TypeScript

import { isArray, isObject } from "es-toolkit/compat";
/**
* Removes sensitive fields from data attached to logs and errors, and limits
* the depth of nested data.
*
* @param input the data to sanitize.
* @param level the current nesting level.
* @returns the sanitized data.
*/
export function sanitize<T>(input: T, level = 0): T {
// Errors have non-enumerable message/stack which are dropped by spreads
// and JSON serialization, so convert them to a plain object up-front.
if (input instanceof Error) {
return {
name: input.name,
message: input.message,
stack: input.stack,
} as unknown as T;
}
// Sanitize the serialized form of values such as dates, URLs and models,
// as this is what appears in the log output.
const value: unknown = hasToJSON(input) ? input.toJSON() : input;
return sanitizeValue(value, level) as T;
}
/**
* Sanitizes a value without calling its toJSON method, as JSON serialization
* only calls it once.
*
* @param input the value to sanitize.
* @param level the current nesting level.
* @returns the sanitized value.
*/
function sanitizeValue(input: unknown, level: number): unknown {
if (typeof input !== "object" || input === null) {
return input;
}
if (level > 3) {
return "[…]";
}
if (isArray(input)) {
return input.map((item) => sanitize(item, level + 1));
}
const output: Record<string, unknown> = { ...input };
for (const key of Object.keys(output)) {
output[key] = isSensitiveField(key)
? "[Filtered]"
: sanitize(output[key], level + 1);
}
return output;
}
const sensitiveFields = new Set([
"accesstoken",
"refreshtoken",
"token",
"password",
"content",
"verificationcode",
"deleteconfirmationcode",
"apikey",
"secret",
"authorization",
]);
/**
* Checks if a field name is sensitive, ignoring case, underscores and hyphens.
*
* @param key the field name to check.
* @returns true if the field should be filtered.
*/
function isSensitiveField(key: string): boolean {
return sensitiveFields.has(key.toLowerCase().replace(/[_-]/g, ""));
}
/**
* Checks if a value has a toJSON method.
*
* @param value the value to check.
* @returns true if the value has a toJSON method.
*/
function hasToJSON(value: unknown): value is { toJSON: () => unknown } {
return (
isObject(value) && "toJSON" in value && typeof value.toJSON === "function"
);
}