-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
ref(nextjs): [Experiment] Automatically wrap API route handlers #3469
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| // there's apparently no way to get at this with `import` | ||
| // TODO - really? | ||
| // eslint-disable-next-line @typescript-eslint/no-var-requires | ||
| const Module = require('module'); | ||
|
|
||
| import { NextApiHandler } from 'next'; | ||
|
|
||
| import * as Sentry from '../index.server'; | ||
|
|
||
| type ModuleObject = { | ||
| _compile: (code: string, filename: string) => void; | ||
| exports: { default: unknown }; | ||
| }; | ||
|
|
||
| type LoaderContext = { resource: string; loaders: Loader[] }; | ||
| type Loader = { options: LoaderOptions; path: string }; | ||
| type LoaderOptions = { sdkPath: string }; | ||
|
|
||
| type WrappedNextApiHandler = NextApiHandler; // purely for ease of reading | ||
|
|
||
| /** | ||
| * Replace the API route handler in the given code with a wrapped version. | ||
| * | ||
| * @param this Context data passed to the loader | ||
| * @param rawInput The stringified code we're modifying | ||
| * @returns Modified stringified code | ||
| */ | ||
| export default function load(this: LoaderContext, rawInput: string): string { | ||
| const options = getOptions(this.loaders) as LoaderOptions; | ||
|
|
||
| // Wherever this is running, it can't seem to resolve the Sentry SDK when referred to by | ||
| // name (which it will have to do below when it compiles the stringified code into an actual module). Fortunately, | ||
| // we're able to do so from within our config file, so we just pass the absolute path through in `options` | ||
| const origCode = rawInput.replace('@sentry/nextjs', options.sdkPath); | ||
|
|
||
| // `module.parent` comes back as `null` rather than `undefined` when there is no parent, but the `Module` constructor | ||
| // below needs `undefined` instead. Because reasons. (We need to ignore the deprecation warning because `parent` may | ||
| // be deprecated, but the `Module` constructor still uses it as of 16.1.0. See | ||
| // https://github.com/nodejs/node/blob/26e318a321a872bc0f41e60706bb49381684afb2/lib/internal/modules/cjs/loader.js#L168.) | ||
| // eslint-disable-next-line deprecation/deprecation | ||
| const parent = module.parent || undefined; | ||
| // It's unclear what this does for us, if anything | ||
| const filename = 'lookIMadeAModule'; | ||
|
|
||
| // Compile the stringified code into an actual Module object so we can grab its default export (the route handler) for | ||
| // wrapping | ||
| const routeModule = new Module(filename, parent) as ModuleObject; | ||
| routeModule._compile(origCode, filename); | ||
| const origHandler = routeModule.exports.default; | ||
|
|
||
| if (typeof origHandler !== 'function') { | ||
| // eslint-disable-next-line no-console | ||
| console.warn(`[Sentry] Could not wrap ${this.resource} for error handling. Default export is not a function.`); | ||
| return rawInput; | ||
| } | ||
|
|
||
| // Wrap the route handler in a try/catch to catch any errors which it generates | ||
| const newHandler = makeWrappedRequestHandler(origHandler as NextApiHandler); | ||
|
|
||
| // Ultimately we have to return a string, and we need the wrapped handler to take the place of the original one (as | ||
| // the default export) so literally substitute it in | ||
| let newCode = origCode.replace(origHandler.toString(), newHandler.toString()); | ||
|
|
||
| // The new function we just subbed in is, character for character, the code written below as the return value of | ||
| // `makeWrappedRequestHandler`, which means we have to define `origHandler`, since its code has now been replaced | ||
| newCode = `${newCode}\n\nconst origHandler = ${origHandler.toString()}`; | ||
|
|
||
| return newCode; | ||
| } | ||
|
|
||
| /** Extract the options for this loader out of the array of loaders in scope */ | ||
| function getOptions(loaders: Loader[]): LoaderOptions | undefined { | ||
| for (const loader of loaders) { | ||
| if (loader.path.includes('nextjs/dist/utils/api-wrapping-loader')) { | ||
| return loader.options; | ||
| } | ||
| } | ||
| // we shouldn't ever get here - one of the given loaders should be this loader | ||
| return undefined; | ||
| } | ||
|
|
||
| /** Wrap the given request handler for error-catching purposes */ | ||
| function makeWrappedRequestHandler(origHandler: NextApiHandler): WrappedNextApiHandler { | ||
| // TODO are there any overloads we need to worry about? | ||
| return async (req, res) => { | ||
| try { | ||
| return await origHandler(req, res); | ||
| } catch (err) { | ||
| if (Sentry !== undefined) { | ||
| Sentry.withScope(scope => { | ||
| scope.addEventProcessor(event => Sentry.Handlers.parseRequest(event, req)); | ||
| Sentry.captureException(err); | ||
| }); | ||
| Sentry.flush(2000).catch(() => { | ||
| // Never throws | ||
| }); | ||
| } else { | ||
| // eslint-disable-next-line no-console | ||
| console.warn('[Sentry] SDK is disabled. Please make sure to initialize Sentry in `sentry.server.config.js`.'); | ||
| } | ||
| throw err; | ||
| } | ||
| }; | ||
| } |
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.