Skip to content
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

Add response stream errorhandling in edge-function-runtime #41102

Merged
merged 4 commits into from Oct 6, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 0 additions & 17 deletions packages/next/server/body-streams.ts
Expand Up @@ -17,23 +17,6 @@ export function requestToBodyStream(
})
}

export function bodyStreamToNodeStream(
bodyStream: ReadableStream<Uint8Array>
): Readable {
const reader = bodyStream.getReader()
return Readable.from(
(async function* () {
while (true) {
const { done, value } = await reader.read()
if (done) {
return
}
yield value
}
})()
)
}

function replaceRequestBody<T extends IncomingMessage>(
base: T,
stream: Readable
Expand Down
20 changes: 11 additions & 9 deletions packages/next/server/dev/next-dev-server.ts
Expand Up @@ -978,16 +978,18 @@ export default class DevServer extends Server {
try {
return await super.run(req, res, parsedUrl)
} catch (error) {
res.statusCode = 500
const err = getProperError(error)
try {
this.logErrorWithOriginalStack(err).catch(() => {})
return await this.renderError(err, req, res, pathname!, {
__NEXT_PAGE: (isError(err) && err.page) || pathname || '',
})
} catch (internalErr) {
console.error(internalErr)
res.body('Internal Server Error').send()
this.logErrorWithOriginalStack(err).catch(() => {})
if (!res.sent) {
res.statusCode = 500
try {
return await this.renderError(err, req, res, pathname!, {
__NEXT_PAGE: (isError(err) && err.page) || pathname || '',
})
} catch (internalErr) {
console.error(internalErr)
res.body('Internal Server Error').send()
}
}
}
}
Expand Down
16 changes: 12 additions & 4 deletions packages/next/server/next-server.ts
Expand Up @@ -68,6 +68,7 @@ import { ParsedUrl, parseUrl } from '../shared/lib/router/utils/parse-url'
import { parse as nodeParseUrl } from 'url'
import * as Log from '../build/output/log'
import loadRequireHook from '../build/webpack/require-hook'
import { consumeUint8ArrayReadableStream } from 'next/dist/compiled/edge-runtime'

import BaseServer, {
Options,
Expand Down Expand Up @@ -95,7 +96,7 @@ import { getCustomRoute, stringifyQuery } from './server-route-utils'
import { urlQueryToSearchParams } from '../shared/lib/router/utils/querystring'
import { removeTrailingSlash } from '../shared/lib/router/utils/remove-trailing-slash'
import { getNextPathnameInfo } from '../shared/lib/router/utils/get-next-pathname-info'
import { bodyStreamToNodeStream, getClonableBody } from './body-streams'
import { getClonableBody } from './body-streams'
import { checkIsManualRevalidate } from './api-utils'
import { shouldUseReactRoot, isTargetLikeServerless } from './utils'
import ResponseCache from './response-cache'
Expand Down Expand Up @@ -2122,9 +2123,16 @@ export default class NextNodeServer extends BaseServer {

if (result.response.body) {
// TODO(gal): not sure that we always need to stream
bodyStreamToNodeStream(result.response.body).pipe(
(params.res as NodeNextResponse).originalResponse
)
const nodeResStream = (params.res as NodeNextResponse).originalResponse
try {
for await (const chunk of consumeUint8ArrayReadableStream(
result.response.body
)) {
nodeResStream.write(chunk)
}
} finally {
nodeResStream.end()
}
} else {
;(params.res as NodeNextResponse).originalResponse.end()
}
Expand Down
14 changes: 14 additions & 0 deletions test/integration/edge-runtime-streaming-error/pages/api/test.js
@@ -0,0 +1,14 @@
export const config = {
runtime: 'experimental-edge',
}
export default function () {
return new Response(
new ReadableStream({
start(ctr) {
ctr.enqueue(new TextEncoder().encode('hello'))
ctr.enqueue(true)
ctr.close()
},
})
)
}
@@ -0,0 +1,81 @@
import stripAnsi from 'next/dist/compiled/strip-ansi'
import {
fetchViaHTTP,
findPort,
killApp,
launchApp,
nextBuild,
nextStart,
waitFor,
} from 'next-test-utils'
import path from 'path'
import { remove } from 'fs-extra'

const appDir = path.join(__dirname, '..')

function test(context: ReturnType<typeof createContext>) {
return async () => {
const res = await fetchViaHTTP(context.appPort, '/api/test')
expect(await res.text()).toEqual('hello')
expect(res.status).toBe(200)
await waitFor(200)
const santizedOutput = stripAnsi(context.output)
expect(santizedOutput).toMatch(
new RegExp(`TypeError: This ReadableStream did not return bytes.`, 'm')
)
expect(santizedOutput).not.toContain('webpack-internal:')
}
}

function createContext() {
const ctx = {
output: '',
appPort: -1,
app: undefined,
handler: {
onStdout(msg) {
this.output += msg
},
onStderr(msg) {
this.output += msg
},
},
}
ctx.handler.onStderr = ctx.handler.onStderr.bind(ctx)
ctx.handler.onStdout = ctx.handler.onStdout.bind(ctx)
return ctx
}

describe('dev mode', () => {
const context = createContext()

beforeAll(async () => {
context.appPort = await findPort()
context.app = await launchApp(appDir, context.appPort, {
...context.handler,
env: { __NEXT_TEST_WITH_DEVTOOL: 1 },
})
})

afterAll(() => killApp(context.app))

it('logs the error correctly', test(context))
})

describe('production mode', () => {
const context = createContext()

beforeAll(async () => {
await remove(path.join(appDir, '.next'))
await nextBuild(appDir, undefined, {
stderr: true,
stdout: true,
})
context.appPort = await findPort()
context.app = await nextStart(appDir, context.appPort, {
...context.handler,
})
})
afterAll(() => killApp(context.app))
it('logs the error correctly', test(context))
})