Sentry `normalizeDepth` not working

[calvintwr]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Self-hosted/on-premise

Which package are you using?

@sentry/node

SDK Version

7.7.0 & 7.12.0

Framework Version

No response

Link to Sentry event

https://sentry.io/organizations/test-x5i/issues/3554317560/?project=6711662&query=is%3Aunresolved

Steps to Reproduce

1. Set up Sentry with normalizeDepth property:

Sentry.init({
    environment: 'test',
    dsn: <My DSN...>,
    normalizeDepth: 10
})

2. Use either Sentry.captureException(someObjectWithDeepKeys) or any custom Error that has deep keys.

Expected Result

Sentry should show 10 levels.

Actual Result

Only shows the default 3 levels:

[Lms24]

Hi @calvintwr, thanks for writing in!

I was abele to reproduce this and I believe the problem is where we normalize and serialize the deep object and put it into the __serialized__ property of the event that's sent to Sentry:

sentry-javascript/packages/node/src/eventbuilder.ts

Line 66 in 70883aa

scope.setExtra('__serialized__', normalizeToSize(exception));

The function normalizeToSize accepts an optional depth argument but we don't pass this argument to it. Therefore it falls back to the default value of three.

sentry-javascript/packages/utils/src/normalize.ts

Lines 45 to 60 in 70883aa

	export function normalizeToSize<T>(
	// eslint-disable-next-line @typescript-eslint/no-explicit-any
	object: { [key: string]: any },
	// Default Node.js REPL depth
	depth: number = 3,
	// 100kB, as 200kB is max payload size, so half sounds reasonable
	maxSize: number = 100 * 1024,
	): T {
	const normalized = normalize(object, depth);
	if (jsonSize(normalized) > maxSize) {
	return normalizeToSize(object, depth - 1, maxSize);
	}
	return normalized as T;
	}

I think fixing this would be simple but I wanna check with the team first to see if this was intentional. There might be implications or reasons for why we don't pass the normalizeDepth property here. A quick check through our git history revealed that we never passed the property to this function.

[calvintwr]

Great turnaround time. Thanks much! @Lms24