forked from vercel/next.js
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add response stream errorhandling in edge-function-runtime (vercel#41102
) The behaviour of edge-function-runtime in the case of an error was not identical to the edge-runtime. If a type other than "Uint8Array" is written to the Response stream a unhandledreject is raised and logged. The current implementations(nodejs) accepts also Buffers and Strings which causes that a Application Developer things our stream implementation is broken if it is executed as worker. We introduced a helper function to consume the response stream and write the "Uint8Array" stream chunks to the server implementation. Due to the complication that the error side effect is emitted via the unhandledrejection handler it is almost impossible to test --- jest does not allow testing of the unhandlerejections. We tested extendsiveliy the helper in the edge-runtime so that this PR integrates just the consuming function. ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have a helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have a helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes by running `pnpm lint` - [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md) Co-authored-by: JJ Kasper <jj@jjsweb.site>
- Loading branch information
Showing
5 changed files
with
118 additions
and
30 deletions.
There are no files selected for viewing
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
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
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
14 changes: 14 additions & 0 deletions
14
test/integration/edge-runtime-streaming-error/pages/api/test.js
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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() | ||
}, | ||
}) | ||
) | ||
} |
81 changes: 81 additions & 0 deletions
81
test/integration/edge-runtime-streaming-error/test/index.test.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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)) | ||
}) |