Skip to content

feat: allow next middleware to use edge cache #2947

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/build/functions/edge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,10 @@ const buildHandlerDefinition = (
const functionName = name.endsWith('middleware')
? 'Next.js Middleware Handler'
: `Next.js Edge Handler: ${page}`
const cache = name.endsWith('middleware') ? undefined : ('manual' as const)
const cache =
!process.env.NEXT_MIDDLEWARE_CACHE && name.endsWith('middleware')
? undefined
: ('manual' as const)
const generator = `${ctx.pluginName}@${ctx.pluginVersion}`

return augmentMatchers(matchers, ctx).map((matcher) => ({
Expand Down
12 changes: 12 additions & 0 deletions tests/fixtures/middleware-edge-cache/app/layout.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
export const metadata = {
title: 'Simple Next App',
description: 'Description for Simple Next App',
}

export default function RootLayout({ children }) {
return (
<html lang="en">
<body>{children}</body>
</html>
)
}
7 changes: 7 additions & 0 deletions tests/fixtures/middleware-edge-cache/app/page.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export default function Home() {
return (
<main>
<h1>Home</h1>
</main>
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export default function EdgeCached() {
return (
<main>
<h1>If middleware works, we shoudn't get here</h1>
</main>
)
}
12 changes: 12 additions & 0 deletions tests/fixtures/middleware-edge-cache/app/test/next/page.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { headers } from 'next/headers'

export default function Page() {
const headersList = headers()
const message = headersList.get('x-hello-from-middleware-req')

return (
<main>
<h1>Message from middleware: {message}</h1>
</main>
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export default function EdgeUncached() {
return (
<main>
<h1>If middleware works, we shoudn't get here</h1>
</main>
)
}
38 changes: 38 additions & 0 deletions tests/fixtures/middleware-edge-cache/middleware.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import type { NextRequest } from 'next/server'
import { NextResponse } from 'next/server'

export function middleware(request: NextRequest) {
const response = getResponse(request)

response.headers.append('Deno' in globalThis ? 'x-deno' : 'x-node', Date.now().toString())
response.headers.set('x-hello-from-middleware-res', 'hello')

return response
}

const getResponse = (request: NextRequest) => {
const requestHeaders = new Headers(request.headers)

requestHeaders.set('x-hello-from-middleware-req', 'hello')

if (request.nextUrl.pathname === '/test/cached') {
return NextResponse.next({
request: {
headers: new Headers({
...requestHeaders,
'netlify-cdn-cache-control': 's-maxage=31536000, durable',
}),
},
})
}

if (request.nextUrl.pathname === '/test/uncached') {
return NextResponse.next({
request: {
headers: requestHeaders,
},
})
}

return NextResponse.json({ error: 'Error' }, { status: 500 })
}
9 changes: 9 additions & 0 deletions tests/fixtures/middleware-edge-cache/next.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/** @type {import('next').NextConfig} */
const nextConfig = {
output: 'standalone',
eslint: {
ignoreDuringBuilds: true,
},
}

module.exports = nextConfig
15 changes: 15 additions & 0 deletions tests/fixtures/middleware-edge-cache/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "middleware-edge-cache",
"version": "0.1.0",
"private": true,
"scripts": {
"postinstall": "next build",
"dev": "next dev",
"build": "next build"
},
"dependencies": {
"next": "latest",
"react": "18.2.0",
"react-dom": "18.2.0"
}
}
36 changes: 36 additions & 0 deletions tests/integration/edge-handler.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -625,4 +625,40 @@ describe('page router', () => {
expect(bodyFr.nextUrlPathname).toBe('/json')
expect(bodyFr.nextUrlLocale).toBe('fr')
})

test<FixtureTestContext>('should use edge caching', async (ctx) => {
vi.stubEnv('NEXT_MIDDLEWARE_CACHE', 'true')

await createFixture('middleware-edge-cache', ctx)
await runPlugin(ctx)
const origin = await LocalServer.run(async (req, res) => {
res.write(
JSON.stringify({
url: req.url,
headers: req.headers,
}),
)
res.end()
})
ctx.cleanup?.push(() => origin.stop())

const response = await invokeEdgeFunction(ctx, {
functions: ['___netlify-edge-handler-middleware'],
origin,
url: `/test/cached`,
})
expect(response.status).toBe(200)

expect(response.headers.has('netlify-cdn-cache-control')).toBeTruthy()
expect(response.headers.get('netlify-cdn-cache-control')).toBe('s-maxage=31536000, durable')

const responseUncached = await invokeEdgeFunction(ctx, {
functions: ['___netlify-edge-handler-middleware'],
origin,
url: `/test/uncached`,
})
expect(responseUncached.status).toBe(200)

expect(responseUncached.headers.has('netlify-cdn-cache-control')).toBeFalsy()
})
})