mirror of
https://github.com/hanzoai/next.js.git
synced 2026-09-24 17:00:51 +00:00
Hendrik LiebauandGitHub
ddfc90df92
x-ref: [Flakiness Metrics](https://app.datadoghq.com/ci/test-runs?query=test_level%3Atest%20env%3Aci%20%40git.repository.id%3Agithub.com%2Fvercel%2Fnext.js%20%40test.service%3Anextjs%20%40test.status%3Afail%20%40test.name%3A%22streaming%20responses%20cancel%20inner%20stream%20after%20disconnect%20edge%20pages%20api%20cancels%20stream%20making%20progress%22&agg_m=count&agg_m_source=base&agg_t=count¤tTab=overview&eventStack=&fromUser=false&index=citest&start=1728463943572&end=1729068743572&paused=false) In #71163, we added to the `Streamable` handling the case where the request might already be aborted before the response was sent or had a chance to be consumed. For the "cancels stream making progress" however, the request may not be aborted, and instead only the response is destroyed, leading to the `cancel` method of the `Streamable` being called, but not the `abort` method. To handle all cases, we're now resolving the `finished` promise of the `Streamable` when either `abort` or `cancel` are called.
89 lines
2.7 KiB
TypeScript
89 lines
2.7 KiB
TypeScript
import { nextTestSetup } from 'e2e-utils'
|
|
import { sleep } from './sleep'
|
|
import { get } from 'http'
|
|
|
|
describe('streaming responses cancel inner stream after disconnect', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
})
|
|
|
|
function prime(url: string, noData?: boolean) {
|
|
return new Promise<void>((resolve, reject) => {
|
|
url = new URL(url, next.url).href
|
|
|
|
// There's a bug in node-fetch v2 where aborting the fetch will never abort
|
|
// the connection, because the body is a transformed stream that doesn't
|
|
// close the connection stream.
|
|
// https://github.com/node-fetch/node-fetch/pull/670
|
|
const req = get(url, async (res) => {
|
|
while (true) {
|
|
const value = res.read(1)
|
|
if (value) break
|
|
await sleep(5)
|
|
}
|
|
|
|
res.destroy()
|
|
resolve()
|
|
})
|
|
req.on('error', reject)
|
|
req.end()
|
|
|
|
if (noData) {
|
|
req.on('error', (e) => {
|
|
// Swallow the "socket hang up" message that happens if you abort
|
|
// before the a response connection is received.
|
|
if ((e as any).code !== 'ECONNRESET') {
|
|
throw e
|
|
}
|
|
})
|
|
|
|
setTimeout(() => {
|
|
req.abort()
|
|
resolve()
|
|
}, 100)
|
|
}
|
|
})
|
|
}
|
|
|
|
describe.each([
|
|
['middleware', '/middleware'],
|
|
['edge app route handler', '/edge-route'],
|
|
['node app route handler', '/node-route'],
|
|
['edge pages api', '/api/edge-api'],
|
|
['node pages api', '/api/node-api'],
|
|
])('%s', (_name, path) => {
|
|
beforeAll(async () => {
|
|
// Trigger compilation of the route so that compilation time does not
|
|
// factor into the actual test requests.
|
|
await next.fetch(path + '?compile')
|
|
})
|
|
|
|
it('cancels stream making progress', async () => {
|
|
// If the stream is making regular progress, then we'll eventually hit
|
|
// the break because `res.destroyed` is true.
|
|
await prime(path + '?write=25')
|
|
const res = await next.fetch(path)
|
|
const i = await res.text()
|
|
expect(i).toMatch(/\d+/)
|
|
}, 2500)
|
|
|
|
it('cancels stalled stream', async () => {
|
|
// If the stream is stalled, we'll never hit the `res.destroyed` break
|
|
// point, so this ensures we handle it with an out-of-band cancellation.
|
|
await prime(path + '?write=1')
|
|
const res = await next.fetch(path)
|
|
const i = await res.text()
|
|
expect(i).toBe('1')
|
|
}, 2500)
|
|
|
|
it('cancels stream that never sent data', async () => {
|
|
// If the client has never sent any data (including headers), then we
|
|
// haven't even established the response object yet.
|
|
await prime(path + '?write=0', true)
|
|
const res = await next.fetch(path)
|
|
const i = await res.text()
|
|
expect(i).toBe('0')
|
|
}, 2500)
|
|
})
|
|
})
|