Skip to content

fix(platform): document and surface redirect behavior for HttpClient.followRedirects #6235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tim-smart merged 4 commits into from
Oct 21, 2026
+16 −1
Merged

fix(platform): document and surface redirect behavior for HttpClient.followRedirects #6235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0455205
fix(platform): document and surface redirect behavior for HttpClient.…
mvanhorn May 16, 2026
19cad69
test(platform): revert followRedirects test changes for docs-only PR
effect-bot Oct 21, 2026
bd838cf
docs(platform): tighten followRedirects redirect docs and changeset
effect-bot Oct 21, 2026
9dcc39e
docs(platform): tighten followRedirects wording and changeset
effect-bot Oct 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fuzzy-chairs-taste.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@effect/platform": patch
---

Document that `HttpClient.followRedirects` only sees redirects from `FetchHttpClient` when `FetchHttpClient.RequestInit` sets `redirect: "manual"`.
5 changes: 5 additions & 0 deletions packages/platform/src/FetchHttpClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ import * as internal from "./internal/fetchHttpClient.js"
export class Fetch extends Context.Tag(internal.fetchTagKey)<Fetch, typeof globalThis.fetch>() {}

/**
* Additional `RequestInit` options passed to `fetch`.
*
* Set `redirect: "manual"` when using `HttpClient.followRedirects`, otherwise
* `fetch` follows redirects itself.
*
* @since 1.0.0
* @category tags
*/
Expand Down
7 changes: 6 additions & 1 deletion packages/platform/src/HttpClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,12 @@ export const withCookiesRef: {
} = internal.withCookiesRef

/**
* Follows HTTP redirects up to a specified number of times.
* Follows HTTP redirects up to `maxRedirects` times (default `10`).
*
* `FetchHttpClient` lets `fetch` follow redirects itself, so none reach this
* client. To handle them here, provide `FetchHttpClient.RequestInit` with
* `{ redirect: "manual" }`. Browsers return opaque responses for manual
* redirects, so they cannot be followed there.
*
* @since 1.0.0
* @category redirects
Expand Down
Loading