feat: add edge middleware support to ntl dev
#1546
Merged
Conversation
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
✅ Deploy Preview for netlify-plugin-nextjs-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for netlify-plugin-nextjs-export-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for netlify-plugin-nextjs-nx-monorepo-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for next-hp-edge-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
github-actions
bot
added
the
type: feature
✅ Deploy Preview for next-plugin-rsc-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for netlify-plugin-nextjs-next-auth-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for next-i18next-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for next-plugin-edge-middleware ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for netlify-plugin-nextjs-static-root-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for next-plugin-canary ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for nextjs-plugin-custom-routes-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
ascorbic
commented
Aug 18, 2022
| @@ -58,6 +55,16 @@ export async function middleware(req: NextRequest) { | |||
| response.headers.set('x-modified-in-rewrite', 'true') | |||
| } | |||
|
|
|||
| if (pathname.startsWith('/shows/redirectme')) { | |||
There was a problem hiding this comment.
Redirects weren't working, so this is a test for the fix
ascorbic
commented
Aug 18, 2022
| @@ -58,6 +55,16 @@ export async function middleware(req: NextRequest) { | |||
| response.headers.set('x-modified-in-rewrite', 'true') | |||
| } | |||
|
|
|||
| if (pathname.startsWith('/shows/redirectme')) { | |||
There was a problem hiding this comment.
Redirects were broken, so these are the added tests
ascorbic
commented
Aug 18, 2022
eduardoboucas
approved these changes
Aug 18, 2022
| _inputs, | ||
| meta: { events?: Set<string> } = {}, | ||
| ): NetlifyPlugin & { onPreDev?: NetlifyPlugin['onPreBuild'] } => { | ||
| if (!meta?.events?.has('onPreDev')) { |
| import { writeDevEdgeFunction } from './edge' | ||
| import { patchNextFiles } from './files' | ||
|
|
||
| // The types haven't been updated yet |
Merged
2 tasks
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.
Summary
Adds support for running middleware using edge functions with
ntl dev.When
next devis run, it doesn't emit any of the compiled files that we need to run middleware via our normal edge function. This means that currently we need to runntl buildbeforentl dev, and changes would require a recompiled. This is not good DX: we want to be able to runntl devwithout building or linking the site, and have it update middleware when it is changed.In this PR this is implemented with a special dev-only edge function which runs the middleware directly, rather than via the Next server. While importing the middleware.ts file directly works in simple cases, it breaks if the middleware imports anything else, because the imports won't be Deno-compatible. We handle this by running
esbuild --watchon the middleware, and importing the compiled middleware. It still works if the middleware hasn't been created yet because esbuild will compile it when it is.The wrapper edge function checks at request time whether the compiled middleware exists. If not, it just silently returns as there is no middleware. If it does exist then it dynamically imports it, then executes it. This means that it will always have the latest version without needing to reload the edge function.
The edge function is generated in a new
onDevhook, which also spawnsesbuild. A regular build will delete the dev edge function to ensure it's never deployed, and the dev hook deletes the production edge functions to ensure they don't conflict.This needs e2e tests, which will follow later: #1553
Test plan
demos/middleware/netlify.tomlto switch plugin package namesnpm iandntl devin middleware demoRelevant links (GitHub issues, Notion docs, etc.) or a picture of cute animal
Standard checks:
🧪 Once merged, make sure to update the version if needed and that it was published correctly.