docs(nextjs): Add waitUntil workaround for Vercel functions#17061
Open
docs(nextjs): Add waitUntil workaround for Vercel functions#17061
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
384
to
394
| ); | ||
|
|
||
| waitUntil( | ||
| Sentry.startSpan( | ||
| { name: "webhook.process", op: "task" }, | ||
| () => processWebhook(data) | ||
| ) | ||
| ); | ||
|
|
||
| return Response.json({ received: true }); | ||
| } |
There was a problem hiding this comment.
Bug: The code example incorrectly shows after() and waitUntil() being used together, which will cause the wrapped processWebhook(data) function to execute twice for each request.
Severity: CRITICAL
Suggested Fix
The code example should be updated to show after() and waitUntil() as mutually exclusive alternatives. This can be achieved by providing separate code blocks or using tabs to let the user switch between the after() example and the waitUntil() example. Do not show both being called in the same function body.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: docs/platforms/javascript/guides/nextjs/tracing/index.mdx#L383-L394
Potential issue: The documentation for handling detached spans provides a code example
that simultaneously calls both `after()` and `waitUntil()` with the same
`processWebhook(data)` function. Since both `after()` and `waitUntil()` are designed to
execute a task after the response is sent, a developer copying this example would
inadvertently cause their webhook handler to run twice. This could lead to critical
production issues like duplicate payment charges, duplicate order creation, or redundant
notifications. The surrounding documentation text correctly presents these functions as
alternatives, but the code example is misleadingly structured.
Did we get this right? 👍 / 👎 to inform future reviews.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
DESCRIBE YOUR PR
A follow up to #16818 (comment) that also adds the usage of
waitUntilIS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES