Unverified Commit 0910e8b8 authored by Javi Velasco's avatar Javi Velasco Committed by GitHub

New Middleware API signature (#30282)

Co-authored-by: 's avatarSteven <steven@ceriously.com>
parent 4782cace
...@@ -475,9 +475,6 @@ export default class DevServer extends Server { ...@@ -475,9 +475,6 @@ export default class DevServer extends Server {
}): Promise<FetchEventResult | null> { }): Promise<FetchEventResult | null> {
try { try {
const result = await super.runMiddleware(params) const result = await super.runMiddleware(params)
result?.promise.catch((error) =>
this.logErrorWithOriginalStack(error, 'unhandledRejection', 'client')
)
result?.waitUntil.catch((error) => result?.waitUntil.catch((error) =>
this.logErrorWithOriginalStack(error, 'unhandledRejection', 'client') this.logErrorWithOriginalStack(error, 'unhandledRejection', 'client')
) )
......
...@@ -102,6 +102,7 @@ import isError from '../lib/is-error' ...@@ -102,6 +102,7 @@ import isError from '../lib/is-error'
import { getMiddlewareInfo } from './require' import { getMiddlewareInfo } from './require'
import { parseUrl as simpleParseUrl } from '../shared/lib/router/utils/parse-url' import { parseUrl as simpleParseUrl } from '../shared/lib/router/utils/parse-url'
import { MIDDLEWARE_ROUTE } from '../lib/constants' import { MIDDLEWARE_ROUTE } from '../lib/constants'
import { NextResponse } from './web/spec-extension/response'
import { run } from './web/sandbox' import { run } from './web/sandbox'
import type { FetchEventResult } from './web/types' import type { FetchEventResult } from './web/types'
import type { MiddlewareManifest } from '../build/webpack/plugins/middleware-plugin' import type { MiddlewareManifest } from '../build/webpack/plugins/middleware-plugin'
...@@ -621,6 +622,9 @@ export default class Server { ...@@ -621,6 +622,9 @@ export default class Server {
} }
} }
const subreq = params.request.headers[`x-middleware-subrequest`]
const subrequests = typeof subreq === 'string' ? subreq.split(':') : []
let result: FetchEventResult | null = null let result: FetchEventResult | null = null
for (const middleware of this.middleware || []) { for (const middleware of this.middleware || []) {
...@@ -639,6 +643,14 @@ export default class Server { ...@@ -639,6 +643,14 @@ export default class Server {
serverless: this._isLikeServerless, serverless: this._isLikeServerless,
}) })
if (subrequests.includes(middlewareInfo.name)) {
result = {
response: NextResponse.next(),
waitUntil: Promise.resolve(),
}
continue
}
result = await run({ result = await run({
name: middlewareInfo.name, name: middlewareInfo.name,
paths: middlewareInfo.paths, paths: middlewareInfo.paths,
...@@ -656,10 +668,6 @@ export default class Server { ...@@ -656,10 +668,6 @@ export default class Server {
}) })
if (!this.renderOpts.dev) { if (!this.renderOpts.dev) {
result.promise.catch((error) => {
console.error(`Uncaught: middleware error after responding`, error)
})
result.waitUntil.catch((error) => { result.waitUntil.catch((error) => {
console.error(`Uncaught: middleware waitUntil errored`, error) console.error(`Uncaught: middleware waitUntil errored`, error)
}) })
......
import type { RequestData, FetchEventResult } from './types' import type { RequestData, FetchEventResult } from './types'
import { DeprecationError } from './error'
import { fromNodeHeaders } from './utils' import { fromNodeHeaders } from './utils'
import { NextFetchEvent } from './spec-extension/fetch-event' import { NextFetchEvent } from './spec-extension/fetch-event'
import { NextRequest } from './spec-extension/request' import { NextRequest, RequestInit } from './spec-extension/request'
import { NextResponse } from './spec-extension/response' import { NextResponse } from './spec-extension/response'
import { waitUntilSymbol, responseSymbol } from './spec-compliant/fetch-event' import { waitUntilSymbol } from './spec-compliant/fetch-event'
export async function adapter(params: { export async function adapter(params: {
handler: (event: NextFetchEvent) => void | Promise<void> handler: (request: NextRequest, event: NextFetchEvent) => Promise<Response>
request: RequestData request: RequestData
}): Promise<FetchEventResult> { }): Promise<FetchEventResult> {
const url = params.request.url.startsWith('/') const url = params.request.url.startsWith('/')
? `https://${params.request.headers.host}${params.request.url}` ? `https://${params.request.headers.host}${params.request.url}`
: params.request.url : params.request.url
const event = new NextFetchEvent( const request = new NextRequestHint(url, {
new NextRequest(url, { geo: params.request.geo,
geo: params.request.geo, headers: fromNodeHeaders(params.request.headers),
headers: fromNodeHeaders(params.request.headers), ip: params.request.ip,
ip: params.request.ip, method: params.request.method,
method: params.request.method, nextConfig: params.request.nextConfig,
nextConfig: params.request.nextConfig, page: params.request.page,
page: params.request.page, })
})
)
const handled = params.handler(event) const event = new NextFetchEvent(request)
const original = await event[responseSymbol] const original = await params.handler(request, event)
return { return {
promise: Promise.resolve(handled),
response: original || NextResponse.next(), response: original || NextResponse.next(),
waitUntil: Promise.all(event[waitUntilSymbol]), waitUntil: Promise.all(event[waitUntilSymbol]),
} }
} }
class NextRequestHint extends NextRequest {
constructor(input: Request | string, init: RequestInit = {}) {
super(input, init)
}
get request() {
throw new DeprecationError()
}
respondWith() {
throw new DeprecationError()
}
waitUntil() {
throw new DeprecationError()
}
}
export class DeprecationError extends Error {
constructor() {
super(`Middleware now accepts an async API directly with the form:
export function middleware(request, event) {
return new Response("Hello " + request.url)
}
`)
}
}
import type { RequestData, FetchEventResult } from '../types' import type { RequestData, FetchEventResult, NodeHeaders } from '../types'
import { Blob, File, FormData } from 'next/dist/compiled/formdata-node' import { Blob, File, FormData } from 'next/dist/compiled/formdata-node'
import { dirname } from 'path' import { dirname } from 'path'
import { ReadableStream } from 'next/dist/compiled/web-streams-polyfill' import { ReadableStream } from 'next/dist/compiled/web-streams-polyfill'
...@@ -57,7 +57,20 @@ export async function run(params: { ...@@ -57,7 +57,20 @@ export async function run(params: {
}, },
Crypto: polyfills.Crypto, Crypto: polyfills.Crypto,
crypto: new polyfills.Crypto(), crypto: new polyfills.Crypto(),
fetch, fetch: (input: RequestInfo, init: RequestInit = {}) => {
const url = getFetchURL(input, params.request.headers)
init.headers = getFetchHeaders(params.name, init)
if (isRequestLike(input)) {
return fetch(url, {
...init,
headers: {
...Object.fromEntries(input.headers),
...Object.fromEntries(init.headers),
},
})
}
return fetch(url, init)
},
File, File,
FormData, FormData,
process: { env: { ...process.env } }, process: { env: { ...process.env } },
...@@ -168,3 +181,29 @@ function sandboxRequire(referrer: string, specifier: string) { ...@@ -168,3 +181,29 @@ function sandboxRequire(referrer: string, specifier: string) {
module.loaded = true module.loaded = true
return module.exports return module.exports
} }
function getFetchHeaders(middleware: string, init: RequestInit) {
const headers = new Headers(init.headers ?? {})
const prevsub = headers.get(`x-middleware-subrequest`) || ''
const value = prevsub.split(':').concat(middleware).join(':')
headers.set(`x-middleware-subrequest`, value)
headers.set(`user-agent`, `Next.js Middleware`)
return headers
}
function getFetchURL(input: RequestInfo, headers: NodeHeaders = {}): string {
const initurl = isRequestLike(input) ? input.url : input
if (initurl.startsWith('/')) {
const host = headers.host?.toString()
const localhost =
host === '127.0.0.1' ||
host === 'localhost' ||
host?.startsWith('localhost:')
return `${localhost ? 'http' : 'https'}://${host}${initurl}`
}
return initurl
}
function isRequestLike(obj: unknown): obj is Request {
return Boolean(obj && typeof obj === 'object' && 'url' in obj)
}
import { DeprecationError } from '../error'
import { FetchEvent } from '../spec-compliant/fetch-event' import { FetchEvent } from '../spec-compliant/fetch-event'
import { NextRequest } from './request' import { NextRequest } from './request'
...@@ -7,4 +8,8 @@ export class NextFetchEvent extends FetchEvent { ...@@ -7,4 +8,8 @@ export class NextFetchEvent extends FetchEvent {
super(request) super(request)
this.request = request this.request = request
} }
respondWith() {
throw new DeprecationError()
}
} }
...@@ -91,7 +91,7 @@ export class NextRequest extends Request { ...@@ -91,7 +91,7 @@ export class NextRequest extends Request {
} }
} }
interface RequestInit extends globalThis.RequestInit { export interface RequestInit extends globalThis.RequestInit {
geo?: { geo?: {
city?: string city?: string
country?: string country?: string
......
...@@ -26,7 +26,6 @@ export interface RequestData { ...@@ -26,7 +26,6 @@ export interface RequestData {
} }
export interface FetchEventResult { export interface FetchEventResult {
promise: Promise<any>
response: Response response: Response
waitUntil: Promise<any> waitUntil: Promise<any>
} }
import { NextResponse } from 'next/server' import { NextResponse } from 'next/server'
export function middleware(event) { export async function middleware(request) {
const url = event.request.nextUrl const url = request.nextUrl
if (url.pathname === '/redirect-with-basepath' && !url.basePath) { if (url.pathname === '/redirect-with-basepath' && !url.basePath) {
url.basePath = '/root' url.basePath = '/root'
event.respondWith(NextResponse.redirect(url)) return NextResponse.redirect(url)
} }
if (url.pathname === '/redirect-with-basepath') { if (url.pathname === '/redirect-with-basepath') {
url.pathname = '/about' url.pathname = '/about'
event.respondWith(NextResponse.rewrite(url)) return NextResponse.rewrite(url)
} }
} }
export function middleware(event) { export function middleware(request) {
event.respondWith( return new Response(null, {
new Response(null, { headers: {
headers: { 'req-url-basepath': request.nextUrl.basePath,
'req-url-basepath': event.request.nextUrl.basePath, 'req-url-pathname': request.nextUrl.pathname,
'req-url-pathname': event.request.nextUrl.pathname, 'req-url-params': JSON.stringify(request.page.params),
'req-url-params': JSON.stringify(event.request.page.params), 'req-url-page': request.page.name,
'req-url-page': event.request.page.name, 'req-url-query': request.nextUrl.searchParams.get('foo'),
'req-url-query': event.request.nextUrl.searchParams.get('foo'), 'req-url-locale': request.nextUrl.locale,
'req-url-locale': event.request.nextUrl.locale, },
}, })
})
)
} }
export function middleware(event) { export async function middleware(request) {
event.respondWith(handleRequest(event)) const url = request.nextUrl
}
async function handleRequest(event) {
const url = event.request.nextUrl
if (url.searchParams.get('foo') === 'bar') { if (url.searchParams.get('foo') === 'bar') {
url.pathname = '/redirects/new-home' url.pathname = '/redirects/new-home'
......
...@@ -2,71 +2,74 @@ import { createElement } from 'react' ...@@ -2,71 +2,74 @@ import { createElement } from 'react'
import { renderToString } from 'react-dom/server.browser' import { renderToString } from 'react-dom/server.browser'
import { NextResponse } from 'next/server' import { NextResponse } from 'next/server'
export async function middleware(event) { export async function middleware(request, ev) {
// eslint-disable-next-line no-undef // eslint-disable-next-line no-undef
const { readable, writable } = new TransformStream() const { readable, writable } = new TransformStream()
const url = event.request.nextUrl const url = request.nextUrl
const writer = writable.getWriter() const writer = writable.getWriter()
const encoder = new TextEncoder() const encoder = new TextEncoder()
const next = NextResponse.next() const next = NextResponse.next()
// Sends a header
if (url.pathname === '/responses/header') {
next.headers.set('x-first-header', 'valid')
event.respondWith(next)
}
// Header based on query param // Header based on query param
if (url.searchParams.get('nested-header') === 'true') { if (url.searchParams.get('nested-header') === 'true') {
next.headers.set('x-nested-header', 'valid') next.headers.set('x-nested-header', 'valid')
event.respondWith(next) }
// Sends a header
if (url.pathname === '/responses/header') {
next.headers.set('x-first-header', 'valid')
return next
} }
// Streams a basic response // Streams a basic response
if (url.pathname === '/responses/stream-a-response') { if (url.pathname === '/responses/stream-a-response') {
event.respondWith(new Response(readable)) ev.waitUntil(
writer.write(encoder.encode('this is a streamed ')) (async () => {
writer.write(encoder.encode('response')) writer.write(encoder.encode('this is a streamed '))
writer.close() writer.write(encoder.encode('response'))
return writer.close()
})()
)
return new Response(readable)
} }
if (url.pathname === '/responses/bad-status') { if (url.pathname === '/responses/bad-status') {
event.respondWith( return new Response('Auth required', {
new Response('Auth required', { headers: { 'WWW-Authenticate': 'Basic realm="Secure Area"' },
headers: { 'WWW-Authenticate': 'Basic realm="Secure Area"' }, status: 401,
status: 401, })
})
)
} }
if (url.pathname === '/responses/stream-long') { if (url.pathname === '/responses/stream-long') {
event.respondWith(new Response(readable)) ev.waitUntil(
writer.write(encoder.encode('this is a streamed '.repeat(10))) (async () => {
await sleep(2000) writer.write(encoder.encode('this is a streamed '.repeat(10)))
writer.write(encoder.encode('after 2 seconds '.repeat(10))) await sleep(2000)
await sleep(2000) writer.write(encoder.encode('after 2 seconds '.repeat(10)))
writer.write(encoder.encode('after 4 seconds '.repeat(10))) await sleep(2000)
await sleep(2000) writer.write(encoder.encode('after 4 seconds '.repeat(10)))
writer.close() await sleep(2000)
return writer.close()
})()
)
return new Response(readable)
} }
// Sends response // Sends response
if (url.pathname === '/responses/send-response') { if (url.pathname === '/responses/send-response') {
return event.respondWith(new Response(JSON.stringify({ message: 'hi!' }))) return new Response(JSON.stringify({ message: 'hi!' }))
} }
// Render React component // Render React component
if (url.pathname === '/responses/react') { if (url.pathname === '/responses/react') {
return event.respondWith( return new Response(
new Response( renderToString(
renderToString( createElement(
createElement( 'h1',
'h1', {},
{}, 'SSR with React! Hello, ' + url.searchParams.get('name')
'SSR with React! Hello, ' + url.searchParams.get('name')
)
) )
) )
) )
...@@ -74,21 +77,27 @@ export async function middleware(event) { ...@@ -74,21 +77,27 @@ export async function middleware(event) {
// Stream React component // Stream React component
if (url.pathname === '/responses/react-stream') { if (url.pathname === '/responses/react-stream') {
event.respondWith(new Response(readable)) ev.waitUntil(
writer.write( (async () => {
encoder.encode(renderToString(createElement('h1', {}, 'I am a stream'))) writer.write(
) encoder.encode(
await sleep(500) renderToString(createElement('h1', {}, 'I am a stream'))
writer.write( )
encoder.encode( )
renderToString(createElement('p', {}, 'I am another stream')) await sleep(500)
) writer.write(
encoder.encode(
renderToString(createElement('p', {}, 'I am another stream'))
)
)
writer.close()
})()
) )
writer.close()
return return new Response(readable)
} }
event.respondWith(next) return next
} }
function sleep(time) { function sleep(time) {
......
import { NextResponse } from 'next/server' import { NextResponse } from 'next/server'
export function middleware(event) { export async function middleware(request) {
const url = event.request.nextUrl const url = request.nextUrl
if (url.pathname === '/rewrites/rewrite-to-ab-test') { if (url.pathname === '/rewrites/rewrite-to-ab-test') {
let bucket = event.request.cookies.bucket let bucket = request.cookies.bucket
if (!bucket) { if (!bucket) {
bucket = Math.random() >= 0.5 ? 'a' : 'b' bucket = Math.random() >= 0.5 ? 'a' : 'b'
const response = NextResponse.rewrite(`/rewrites/${bucket}`) const response = NextResponse.rewrite(`/rewrites/${bucket}`)
response.cookie('bucket', bucket) response.cookie('bucket', bucket)
return event.respondWith(response) return response
} }
return event.respondWith(NextResponse.rewrite(`/rewrites/${bucket}`)) return NextResponse.rewrite(`/rewrites/${bucket}`)
} }
if (url.pathname === '/rewrites/rewrite-me-to-about') { if (url.pathname === '/rewrites/rewrite-me-to-about') {
return event.respondWith(NextResponse.rewrite('/rewrites/about')) return NextResponse.rewrite('/rewrites/about')
} }
if (url.pathname === '/rewrites/rewrite-me-to-vercel') { if (url.pathname === '/rewrites/rewrite-me-to-vercel') {
return event.respondWith(NextResponse.rewrite('https://vercel.com')) return NextResponse.rewrite('https://vercel.com')
} }
if (url.pathname === '/rewrites/rewrite-me-without-hard-navigation') { if (url.pathname === '/rewrites/rewrite-me-without-hard-navigation') {
url.pathname = '/rewrites/about' url.pathname = '/rewrites/about'
url.searchParams.set('middleware', 'foo') url.searchParams.set('middleware', 'foo')
event.respondWith(NextResponse.rewrite(url)) return NextResponse.rewrite(url)
} }
} }
...@@ -309,21 +309,21 @@ function responseTests(locale = '') { ...@@ -309,21 +309,21 @@ function responseTests(locale = '') {
expect($('.title').text()).toBe('Hello World') expect($('.title').text()).toBe('Hello World')
}) })
it(`${locale} should respond with a header`, async () => { it(`${locale} should respond with 2 nested headers`, async () => {
const res = await fetchViaHTTP( const res = await fetchViaHTTP(
context.appPort, context.appPort,
`${locale}/responses/header` `${locale}/responses/header?nested-header=true`
) )
expect(res.headers.get('x-first-header')).toBe('valid') expect(res.headers.get('x-first-header')).toBe('valid')
expect(res.headers.get('x-nested-header')).toBe('valid')
}) })
it(`${locale} should respond with 2 nested headers`, async () => { it(`${locale} should respond with a header`, async () => {
const res = await fetchViaHTTP( const res = await fetchViaHTTP(
context.appPort, context.appPort,
`${locale}/responses/header?nested-header=true` `${locale}/responses/header`
) )
expect(res.headers.get('x-first-header')).toBe('valid') expect(res.headers.get('x-first-header')).toBe('valid')
expect(res.headers.get('x-nested-header')).toBe('valid')
}) })
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment