문제해결 흐름 따라가기

Ky 1.8.0 hang

Github

Ky 1.8.0 hang

Updated

Apr 19, 2025

이슈에서 ky가 멈춘다는 이슈가 이미 열려있었고, 어떤 문제가 있었는지 확인했다.

이 코멘트(GitHubKy 1.8.0 hang · Issue #690 · sindresorhus/ky

Ky 1.8.0 hang · Issue #690 · sindresorhus/ky

We are experiencing a hang in Ky 1.8.0 that is a first for us. We have a pretty straightforward ky.post(url, {json: someObj}) that works fine in 1.7.5. We tested under node 18 and node 22. We can r...

GitHub

)에서 귀중한 힌트를 얻을 수 있었다.

(async function () {
	let r = new Request('https://example.org', {
		method: 'POST',
		body: 'body',
	})
	let clone = r.clone()
	// Consuming the body of the cloned request allows the original request to be cloned
	// await clone.text()

	if (!r.bodyUsed) {
		await r.body?.cancel()
		// The promise never completes if the request was cloned but the original body never consumed
		console.log('done')
	}
})()

그렇다면 이 문제를 어떻게 해결할 수 있을까?

아무리 Node.js 자체의 버그로 인한 문제라고 하여도, ky라이브러리가 멈추는 버그는 막아야 한다고 생각했다. 그래서 다음과 같이 이에 대한 우회 방법을 PR(

Fix hang on stream request cleanup in Node.js

Github

Fix hang on stream request cleanup in Node.js

Updated

Sep 27, 2025

)로 작성하였다.

arrayBuffuer(): 버퍼를 모두 “소비”하는 것.

cancel(): 버퍼를 모두 “제거”하는 것.

PR 리뷰 반영

1. Node.js에서 연관 이슈 찾고 없으면 만들기.

2. arrayBuffer()를 Node.js환경에서만 적용시키기.

Node.js에서 연관 이슈 찾기

Node.js 런타임에서 ReadableStream 본문을 가진 Request 객체가 복제되고(내부적으로 tee()를 통해 두 개의 스트림 분기 생성), 이 두 분기 중 어느 쪽도 소비되지 않은 상태(즉, 둘 다 읽지 않은 원시 상태)에서 한 분기에 대해 await request.body.cancel()을 호출하면 절대 이행되지 않는 프로미스가 반환됩니다. 이 무기한 대기 상태는 스트림 사양을 위반하며 ky 라이브러리에서 관찰된 멈춤(hang) 현상의 직접적인 원인입니다.

1. body.clone() 메서드가 내부적으로 정말 tee()를 호출하고 있는지

2. tee()로 분기된 스트림들을 모두 cancel()을 해줘야 하는지

nodejs/undici

WHATWG

그 중에서도 Stream과 관련된 스펙인 Streams Standard

Streams Standard

This specification provides APIs for creating, composing, and consuming streams of data that map efficiently to low-level I/O primitives.

에서 tee() 메서드의 내용을 살펴보았다.

이 읽기 가능한 스트림을 tee 처리하여, 두 개의 새로운 ReadableStream 인스턴스로 구성된 브랜치를 담은 2요소 배열을 반환합니다.

스트림을 tee 처리하면 해당 스트림이 잠금(lock) 상태가 되어, 다른 소비자가 리더(reader)를 획득할 수 없게 됩니다. 스트림을 취소(cancel)하려면 두 브랜치를 모두 취소해야 합니다. 그러면 조합된 취소 이유가 스트림의 기본 소스(underlying source)로 전파됩니다.

만약 이 스트림이 읽기 가능한 바이트 스트림(readable byte stream)이라면, 각 브랜치는 각 청크(chunk)의 개별 복사본을 받게 됩니다. 그렇지 않은 경우, 각 브랜치에서 보이는 청크는 동일한 객체입니다. 만약 청크가 불변(immutable)이 아니라면, 이는 두 브랜치 간에 간섭을 일으킬 수 있습니다.

진짜 문제 제시 및 반영

	.finally(async () => {
		const originalRequest = ky._originalRequest;

		// Cancel both the original and cloned request bodies to prevent hanging.
		if (originalRequest && !originalRequest.bodyUsed && !ky.request.bodyUsed) {
			await Promise.all([
				originalRequest.body?.cancel(), ky.request.body?.cancel(),
			]);
		}
	}) as ResponsePromise;

.finally(async () => {
    const originalRequest = ky._originalRequest;
    const cleanupPromises = [];

    // Add the original request's stream to the cleanup list if it was never used.
    if (originalRequest && !originalRequest.bodyUsed) {
        cleanupPromises.push(originalRequest.body?.cancel());
    }

    // Add the cloned request's stream to the cleanup list if it was never used.
    if (!ky.request.bodyUsed) {
        cleanupPromises.push(ky.request.body?.cancel());
    }

    // Await all cancellations concurrently.
    if (cleanupPromises.length > 0) {
        await Promise.all(cleanupPromises);
    }
})

후기