chore: update middleware docs wording #799
Merged
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
github-actions
bot
added
the
type: chore
ascorbic
commented
Nov 15, 2021
Comment on lines
+50
to
67
| There is a bug in Next.js `<=12.0.3` that causes a proxy loop if you try to rewrite to a URL with a host other than | ||
| localhost. This bug is fixed in version `12.0.4`. If you are using Next.js `<=12.0.3`, you can work around the bug by | ||
| ensuring that when rewriting a request you either use a relative path, or manually set the host to `localhost` if | ||
| returning a URL object. For example: | ||
|
|
||
| ```typescript | ||
| export function middleware(req: NextRequest) { | ||
| // Change the `nextUrl` property in some way | ||
| req.nextUrl = req.nextUrl.replace('something', 'somethingelse') | ||
| // ...then rewrite to the changed URL | ||
| return NextResponse.rewrite(req.nextUrl) | ||
| } | ||
| ``` | ||
| const rewrittenUrl = req.nextUrl | ||
|
|
||
| ...then you need to set the `nextUrl.host` to `localhost`: | ||
| // Change the URL in some way | ||
| // ... | ||
|
|
||
| ```typescript | ||
| export function middleware(req: NextRequest) { | ||
| // Change the `nextUrl` property in some way | ||
| req.nextUrl = req.nextUrl.replace('something', 'somethingelse') | ||
| req.nextUrl.host = 'localhost' | ||
| // Before returning the URL, set the host to localhost | ||
| rewrittenUrl.host = 'localhost' | ||
|
|
||
| // ...then rewrite to the changed URL | ||
| return NextResponse.rewrite(req.nextUrl) | ||
| return NextResponse.rewrite(rewrittenUrl) | ||
| } |
There was a problem hiding this comment.
These are the only content changes
tiffafoo
approved these changes
Nov 15, 2021
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.
Some small updates to the new middleware docs, to reflect the fact that the fix has been released in next@canary
The PR also includes formatting changes: only the "Caveats" section has content changes