fix(nestjs): do not make SentryTraced() decorated functions async #12879
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicohrubec
approved these changes
Jul 11, 2024
mydea
pushed a commit
that referenced
this pull request
Jul 11, 2024
This PR adds the external contributor to the CHANGELOG.md file, so that they are credited for their contribution. See #12879
This was referenced Aug 7, 2024
This was referenced Aug 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before submitting a pull request, please take a look at our
Contributing guidelines and verify:
yarn lint) & (yarn test).The
SentryTraced()decorator in the@sentry/nestjspackage (introduced in #12721) stealthily turns any decorated function asynchronous.We experienced issues on a production Nest app due to this - it's a bit sneaky because the Typescript compiler doesn't understand (or check at all?) that the decorator changes the function signature.
There was a test written to check sync support, but since the tests are end-to-end and always go through a first layer of async functions, the returned
Promise<>from the supposedly sync test function was just unwrapped later without any issues.This PR:
testSpanDecoratorSyncto fail if the decorated test function is not syncasyncThank you!