fix(core): Improve safeJoin usage in console logging integration

[AbhiPrasad]

resolves #16657

Background

In the consoleLoggingIntegration (which sends logs to Sentry from console calls), we use a utility called safeJoin to join together the console args.

sentry-javascript/packages/core/src/utils/string.ts

Lines 68 to 94 in b94f652

	export function safeJoin(input: unknown[], delimiter?: string): string {
	if (!Array.isArray(input)) {
	return '';
	}
	const output = [];
	// eslint-disable-next-line @typescript-eslint/prefer-for-of
	for (let i = 0; i < input.length; i++) {
	const value = input[i];
	try {
	// This is a hack to fix a Vue3-specific bug that causes an infinite loop of
	// console warnings. This happens when a Vue template is rendered with
	// an undeclared variable, which we try to stringify, ultimately causing
	// Vue to issue another warning which repeats indefinitely.
	// see: https://github.com/getsentry/sentry-javascript/pull/8981
	if (isVueViewModel(value)) {
	output.push('[VueViewModel]');
	} else {
	output.push(String(value));
	}
	} catch (e) {
	output.push('[value cannot be serialized]');
	}
	}
	return output.join(delimiter);
	}

This utility calls String(value) to convert items to a string, which results in objects and arrays being turned into the dreaded [Object Object] or [Array].

sentry-javascript/packages/core/src/utils/string.ts

Line 86 in b94f652

output.push(String(value));

A user wrote in with feedback that this was annoying, and I agree!

Solution

Instead of using String(value) I chose to create a new helper that uses JSON.stringify(normalize(X)), which should result in the entire object or array being properly shown. This required me to grab normalizeDepth and normalizeMaxBreadth from the client options, but that feels fine because it's easily explainable to users.

I added tests to validate this.

Next Steps

We should really refactor our overall safeJoin usage. This should be safe in breadcrumbs, but will be a breaking change in capture-console as it'll cause issue grouping changes if console calls are being captured as messages/errors.

[RulaKhaled]

nice