add HttpClient.followRedirects api (#3123)

Co-authored-by: Tim Smart <[email protected]>

.changeset/tricky-parents-relate.md

@@ -0,0 +1,5 @@
+---
+"@effect/platform": patch
+---
+
+add HttpClient.followRedirects api

packages/platform-node/test/HttpClient.test.ts

@@ -58,6 +58,20 @@ const JsonPlaceholderLive = Layer.effect(JsonPlaceholder, makeJsonPlaceholder)
  expect(response).toContain("Google")
  }).pipe(Effect.provide(layer)))
 
+ it.effect("google followRedirects", () =>
+ Effect.gen(function*(_) {
+ const client = (yield* HttpClient.HttpClient).pipe(
+ HttpClient.followRedirects()
+ )
+ const response = yield* _(
+ HttpClientRequest.get("http://google.com/"),
+ client,
+ Effect.flatMap((_) => _.text),
+ Effect.scoped
+ )
+ expect(response).toContain("Google")
+ }).pipe(Effect.provide(layer)))
+
  it.effect("google stream", () =>
  Effect.gen(function*(_) {
  const client = yield* _(HttpClient.HttpClient)

packages/platform/src/HttpClient.ts

@@ -465,6 +465,15 @@ export const withCookiesRef: {
  <E, R>(self: HttpClient.WithResponse<E, R>, ref: Ref<Cookies>): HttpClient.WithResponse<E, R>
 } = internal.withCookiesRef
 
+/**
+ * @since 1.0.0
+ * @category redirects
+ */
+export const followRedirects: {
+ (maxRedirects?: number | undefined): <E, R>(self: HttpClient.WithResponse<E, R>) => HttpClient.WithResponse<E, R>
+ <E, R>(self: HttpClient.WithResponse<E, R>, maxRedirects?: number | undefined): HttpClient.WithResponse<E, R>
+} = internal.followRedirects
+
 /**
  * @since 1.0.0
  * @category fiber refs

packages/platform/src/internal/httpClient.ts

@@ -748,3 +748,41 @@ export const withCookiesRef = dual<
  ))
  )
 )
+
+/** @internal */
+export const followRedirects = dual<
+ (
+ maxRedirects?: number | undefined
+ ) => <E, R>(self: Client.HttpClient.WithResponse<E, R>) => Client.HttpClient.WithResponse<E, R>,
+ <E, R>(
+ self: Client.HttpClient.WithResponse<E, R>,
+ maxRedirects?: number | undefined
+ ) => Client.HttpClient.WithResponse<E, R>
+>((args) => isClient(args[0]), <E, R>(
+ self: Client.HttpClient.WithResponse<E, R>,
+ maxRedirects?: number | undefined
+): Client.HttpClient.WithResponse<E, R> =>
+ make(
+ (request) => {
+ const loop = (
+ request: ClientRequest.HttpClientRequest,
+ redirects: number
+ ): Effect.Effect<ClientResponse.HttpClientResponse, E, R> =>
+ Effect.flatMap(
+ self.execute(Effect.succeed(request)),
+ (response) =>
+ response.status >= 300 && response.status < 400 && response.headers.location &&
+ redirects < (maxRedirects ?? 10)
+ ? loop(
+ internalRequest.setUrl(
+ request,
+ response.headers.location
+ ),
+ redirects + 1
+ )
+ : Effect.succeed(response)
+ )
+ return Effect.flatMap(request, (request) => loop(request, 0))
+ },
+ self.preprocess
+ ))