Fix HttpResponseBodyInit to support Node.js Readable streams #410
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #409 -
@azure/functions@4.11.1breaks HTTP streaming with Node.jsReadablestreams.Root Cause Analysis
PR #405 (commit
81f6e9a) removed thelib.DOMdependency by replacing theBodyInittype with a locally definedHttpResponseBodyInittype. However, this new type definition only included Web API types (ReadableStream,Blob,ArrayBuffer, etc.) and did not include Node.js nativeReadablestreams.This caused TypeScript compilation errors for users who pass Node.js
Readablestreams as HTTP response bodies:Why this worked in v4.11.0: In v4.11.0,
bodywas typed asBodyInitfrom lib.DOM. However, in user projects without lib.DOM enabled,BodyInitresolved toany, allowing any type includingReadable. The v4.11.1 change to an explicit union type surfaced this incompatibility.Why this is type-only fix: Testing confirms that Node.js 20+
Responseconstructor natively accepts Node.jsReadablestreams (via undici), so no runtime conversion is needed.Changes
types/http.d.ts:
Readablefromstreammodule to importsReadableto theHttpResponseBodyInitunion typeTesting
ResponseacceptsReadabledirectly:new Response(readable)works in Node.js 20+