fix(platform): do not consume body when inspecting HttpIncomingMessage#6321
Open
xianjianlf2 wants to merge 1 commit into
Open
fix(platform): do not consume body when inspecting HttpIncomingMessage#6321xianjianlf2 wants to merge 1 commit into
xianjianlf2 wants to merge 1 commit into
Conversation
`HttpIncomingMessage.inspect` eagerly read the body via `Effect.runSync` on `self.text` / `self.json`. For a streamed, one-shot body this invokes the underlying source read (e.g. `Response.text()`), which locks/consumes the `ReadableStream`. As a result, merely logging or `toJSON`-ing an `HttpClientResponse` (or server request) with a streamed body caused subsequent `response.stream` reads to fail with `TypeError: Invalid state: ReadableStream is locked`. Make `inspect` side-effect free by no longer reading the body. Closes Effect-TS#5341
xianjianlf2
had a problem deploying
to
release-queue
GitHub Actions
Error
🦋 Changeset detectedLatest commit: f7d40c0 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
IMax153
added
the
3.0
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Problem
Logging or
toJSON-ing anHttpClientResponsewhose body is being streamed locks the underlyingReadableStream, so a laterresponse.streamread fails withTypeError: Invalid state: ReadableStream is locked(#5341).Root cause
HttpIncomingMessage.inspect()eagerly read the body viaEffect.runSync(self.text/self.json). For a one-shot streamed body this consumes and locks the stream. Note thatself.textis async, so therunSynccall actually always threw and the "body" value was swallowed anyway — the read was a pure destructive side effect.Fix
Make
inspect()side-effect free: it no longer reads the body. AnInspectable.toJSONmust not consume a one-shot resource simply by being logged.Testing
Added a test in
packages/platform/test/HttpClient.test.ts("logging a streamed response does not lock its body") — red before, green after. FullHttpClient.test.tsandtsc -bpass. Changeset included.Closes #5341