Skip to content

Ensure edge runtime Pages API/App Route handlers AbortSignal aborts on client disconnect #51727

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

Merged
merged 6 commits into from
Jun 28, 2023
Merged
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
7 changes: 7 additions & 0 deletions packages/next/src/server/next-server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ import { filterReqHeaders } from './lib/server-ipc/utils'
import { createRequestResponseMocks } from './lib/mock-request'
import chalk from 'next/dist/compiled/chalk'
import { NEXT_RSC_UNION_QUERY } from '../client/components/app-router-headers'
import { signalFromNodeRequest } from './web/spec-extension/adapters/next-request'

export * from './base-server'

Expand Down Expand Up @@ -2342,6 +2343,9 @@ export default class NextNodeServer extends BaseServer {
url: url,
page: page,
body: getRequestMeta(params.request, '__NEXT_CLONABLE_BODY'),
signal: signalFromNodeRequest(
(params.request as NodeNextRequest).originalRequest
),
},
useCache: true,
onWarning: params.onWarning,
Expand Down Expand Up @@ -2851,6 +2855,9 @@ export default class NextNodeServer extends BaseServer {
...(params.params && { params: params.params }),
},
body: getRequestMeta(params.req, '__NEXT_CLONABLE_BODY'),
signal: signalFromNodeRequest(
(params.req as NodeNextRequest).originalRequest
),
},
useCache: true,
onWarning: params.onWarning,
Expand Down
1 change: 1 addition & 0 deletions packages/next/src/server/web/adapter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ export async function adapter(
ip: params.request.ip,
method: params.request.method,
nextConfig: params.request.nextConfig,
signal: params.request.signal,
},
})

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
import type { BaseNextRequest } from '../../../base-http'
import type { NodeNextRequest } from '../../../base-http/node'
import type { WebNextRequest } from '../../../base-http/web'
import type { IncomingMessage } from 'node:http'

import { getRequestMeta } from '../../../request-meta'
import { fromNodeOutgoingHttpHeaders } from '../../utils'
import { NextRequest } from '../request'

export function signalFromNodeRequest(request: IncomingMessage) {
const { errored } = request
if (errored) return AbortSignal.abort(errored)
const controller = new AbortController()
request.on('error', (e) => {
controller.abort(e)
})
return controller.signal
}

export class NextRequestAdapter {
public static fromBaseNextRequest(request: BaseNextRequest): NextRequest {
// TODO: look at refining this check
Expand Down Expand Up @@ -46,6 +57,7 @@ export class NextRequestAdapter {
headers: fromNodeOutgoingHttpHeaders(request.headers),
// @ts-expect-error - see https://github.com/whatwg/fetch/pull/1457
duplex: 'half',
signal: signalFromNodeRequest(request.originalRequest),
// geo
// ip
// nextConfig
Expand All @@ -65,6 +77,7 @@ export class NextRequestAdapter {
headers: fromNodeOutgoingHttpHeaders(request.headers),
// @ts-expect-error - see https://github.com/whatwg/fetch/pull/1457
duplex: 'half',
signal: request.request.signal,
// geo
// ip
// nextConfig
Expand Down
3 changes: 2 additions & 1 deletion packages/next/src/server/web/spec-extension/request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export class NextRequest extends Request {
nextUrl: NextURL
}

constructor(input: URL | RequestInfo, init: RequestInit = {}) {
constructor(input: URL | RequestInfo, init: RequestInit) {
const url =
typeof input !== 'string' && 'url' in input ? input.url : String(input)
validateURL(url)
Expand Down Expand Up @@ -111,4 +111,5 @@ export interface RequestInit extends globalThis.RequestInit {
i18n?: I18NConfig | null
trailingSlash?: boolean
}
signal?: AbortSignal
}
1 change: 1 addition & 0 deletions packages/next/src/server/web/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export interface RequestData {
}
url: string
body?: ReadableStream<Uint8Array>
signal: AbortSignal
}

export type NodejsRequestData = Omit<RequestData, 'body'> & {
Expand Down