-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ref(nextjs): Use flush code from
withSentry in all backend wrappers (…
…#5814) When deployed to Vercel, nextjs apps have their route handlers converted to AWS lambdas, which use the vercel node runtime. In this runtime, AWS's [`callbackWaitsForEmptyEventLoop` context option](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-context.html) is [set to `false`](https://github.com/vercel/fun/blob/6329dcbd3f7d99a519cbbd6ac615fec4b46fc28e/src/runtimes/nodejs/bootstrap.ts#L122). As a result, it's possible for a route-handling lambda to be shut down before events have finished sending to Sentry. To ensure that this doesn't happen, in `withSentry` we wrap `res.end`, so that it flushes all of our events before the response marks itself as finished. This extracts that logic into its own module, so that it can also be used in the other `withSentryX` wrappers (`withSentryServerSideProps` and the like).
- Loading branch information
1 parent
f767905
commit 186bcda
Showing
6 changed files
with
89 additions
and
87 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| import { flush } from '@sentry/node'; | ||
| import { Transaction } from '@sentry/types'; | ||
| import { fill, logger } from '@sentry/utils'; | ||
| import { ServerResponse } from 'http'; | ||
|
|
||
| import { ResponseEndMethod, WrappedResponseEndMethod } from '../types'; | ||
|
|
||
| /** | ||
| * Wrap `res.end()` so that it closes the transaction and flushes events before letting the request finish. | ||
| * | ||
| * Note: This wraps a sync method with an async method. While in general that's not a great idea in terms of keeping | ||
| * things in the right order, in this case it's safe, because the native `.end()` actually *is* (effectively) async, and | ||
| * its run actually *is* (literally) awaited, just manually so (which reflects the fact that the core of the | ||
| * request/response code in Node by far predates the introduction of `async`/`await`). When `.end()` is done, it emits | ||
| * the `prefinish` event, and only once that fires does request processing continue. See | ||
| * https://github.com/nodejs/node/commit/7c9b607048f13741173d397795bac37707405ba7. | ||
| * | ||
| * Also note: `res.end()` isn't called until *after* all response data and headers have been sent, so blocking inside of | ||
| * `end` doesn't delay data getting to the end user. See | ||
| * https://nodejs.org/api/http.html#responseenddata-encoding-callback. | ||
| * | ||
| * @param transaction The transaction tracing request handling | ||
| * @param res: The request's corresponding response | ||
| */ | ||
| export function autoEndTransactionOnResponseEnd(transaction: Transaction, res: ServerResponse): void { | ||
| const wrapEndMethod = (origEnd: ResponseEndMethod): WrappedResponseEndMethod => { | ||
| return async function sentryWrappedEnd(this: ServerResponse, ...args: unknown[]) { | ||
| await finishTransaction(transaction, this); | ||
| await flushQueue(); | ||
|
|
||
| return origEnd.call(this, ...args); | ||
| }; | ||
| }; | ||
|
|
||
| // Prevent double-wrapping | ||
| if (!(res.end as WrappedResponseEndMethod).__sentry_original__) { | ||
| fill(res, 'end', wrapEndMethod); | ||
| } | ||
| } | ||
|
|
||
| /** Finish the given response's transaction and set HTTP status data */ | ||
| export async function finishTransaction(transaction: Transaction | undefined, res: ServerResponse): Promise<void> { | ||
| if (transaction) { | ||
| transaction.setHttpStatus(res.statusCode); | ||
|
|
||
| // If any open spans are set to finish when the response ends, it sets up a race condition between their `finish` | ||
| // calls and the transaction's `finish` call - and any spans which lose the race will get dropped from the | ||
| // transaction. To prevent this, push `transaction.finish` to the next event loop so that it's guaranteed to lose | ||
| // the race, and wait for it to be done before flushing events. | ||
| const transactionFinished: Promise<void> = new Promise(resolve => { | ||
| setImmediate(() => { | ||
| transaction.finish(); | ||
| resolve(); | ||
| }); | ||
| }); | ||
| await transactionFinished; | ||
| } | ||
| } | ||
|
|
||
| /** Flush the event queue to ensure that events get sent to Sentry before the response is finished and the lambda ends */ | ||
| export async function flushQueue(): Promise<void> { | ||
| try { | ||
| __DEBUG_BUILD__ && logger.log('Flushing events...'); | ||
| await flush(2000); | ||
| __DEBUG_BUILD__ && logger.log('Done flushing events'); | ||
| } catch (e) { | ||
| __DEBUG_BUILD__ && logger.log('Error while flushing events:\n', e); | ||
| } | ||
| } |
This file contains 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
This file contains 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
This file contains 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
This file contains 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