Errors miss useful stack traces

[oleg-codaio]

Describe the bug

When using stripe-node, API errors seem to lose the full stack trace, making it hard to debug and find the code that triggered a particular error.

For instance, if I make a bad customers.retrieve() call (with an invalid customer ID), I get an error with the following stack trace:

Error: No such customer: 'some_fake_id'
    at Function.generate (/somedir/node_modules/.pnpm/[email protected]/node_modules/stripe/lib/Error.js:38:24)
    at res.toJSON.then.StripeAPIError.message (/somedir/node_modules/.pnpm/[email protected]/node_modules/stripe/lib/RequestSender.js:104:43)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)

To Reproduce

1. Trigger a failing Stripe network request, such as customers.retrieve
2. Observe the thrown error's stack trace

Expected behavior

I'd expect the stack trace to contain the stack up to where the Stripe API request was made. Instead, I only get a partial internal stack.

Code snippets

No response

OS

macOS

Node version

Node v16.17.1

Library version

11.7.0

API version

2022-11-15

Additional context

See also: #118

[oleg-codaio]

To leave some notes on a proposed fix, I think the issue is that async stack traces don't work due to use of .then() directly on Promises, instead of await:

stripe-node/src/RequestSender.ts

Lines 144 to 152 in 3dc8c54

	if (statusCode === 401) {
	err = new StripeAuthenticationError(jsonResponse.error);
	} else if (statusCode === 403) {
	err = new StripePermissionError(jsonResponse.error);
	} else if (statusCode === 429) {
	err = new StripeRateLimitError(jsonResponse.error);
	} else {
	err = StripeError.generate(jsonResponse.error);
	}

One solution is to save the original stack trace when the call is made via new Error().stack, then splat it into the stack of any thrown error later. This would have a small penalty of constructing stack traces on every Stripe request (which I'd imagine pales in comparison to the actual network request), so if that's a concern then this could be made optional too.

[anniel-stripe]

Hi, thanks for submitting a bug report! I'm going to close this issue as a duplicate of #1542, where this problem is being tracked. #1066 also raises this issue, and the discussion there gives workarounds there that might work for you in the meantime.

One solution is to save the original stack trace when the call is made via new Error().stack, then splat it into the stack of any thrown error later. This would have a small penalty of constructing stack traces on every Stripe request (which I'd imagine pales in comparison to the actual network request), so if that's a concern then this could be made optional too.

The overhead from constructing stack traces is a definitely a concern here - we'd like to approach supporting async stack traces by actually converting our logic to be async, which is more than a quick fix.