Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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/calm-headers-transform.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@effect/platform": patch
---

Add `HttpClientRequest.removeHeader` and `HttpClientRequest.updateHeaders`.
18 changes: 18 additions & 0 deletions packages/platform/src/HttpClientRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,24 @@ export const setHeaders: {
(self: HttpClientRequest, input: Headers.Input): HttpClientRequest
} = internal.setHeaders

/**
* @since 1.0.0
* @category combinators
*/
export const updateHeaders: {
(f: (headers: Headers.Headers) => Headers.Headers): (self: HttpClientRequest) => HttpClientRequest
(self: HttpClientRequest, f: (headers: Headers.Headers) => Headers.Headers): HttpClientRequest
} = internal.updateHeaders

/**
* @since 1.0.0
* @category combinators
*/
export const removeHeader: {
(key: string): (self: HttpClientRequest) => HttpClientRequest
(self: HttpClientRequest, key: string): HttpClientRequest
} = internal.removeHeader

/**
* @since 1.0.0
* @category combinators
Expand Down
25 changes: 25 additions & 0 deletions packages/platform/src/internal/httpClientRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,31 @@ export const setHeaders = dual<
self.body
))

/** @internal */
export const updateHeaders = dual<
(
f: (headers: Headers.Headers) => Headers.Headers
) => (self: ClientRequest.HttpClientRequest) => ClientRequest.HttpClientRequest,
(
self: ClientRequest.HttpClientRequest,
f: (headers: Headers.Headers) => Headers.Headers
) => ClientRequest.HttpClientRequest
>(2, (self, f) =>
makeInternal(
self.method,
self.url,
self.urlParams,
self.hash,
f(self.headers),
self.body
))

/** @internal */
export const removeHeader = dual<
(key: string) => (self: ClientRequest.HttpClientRequest) => ClientRequest.HttpClientRequest,
(self: ClientRequest.HttpClientRequest, key: string) => ClientRequest.HttpClientRequest
>(2, (self, key) => updateHeaders(self, Headers.remove(key)))

const stringOrRedacted = (value: string | Redacted.Redacted): string =>
typeof value === "string" ? value : Redacted.value(value)

Expand Down
31 changes: 31 additions & 0 deletions packages/platform/test/HttpClient.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,37 @@ describe("HttpClient", () => {
})
})

describe("ClientRequest headers", () => {
it("removeHeader removes a header without mutating the original request", () => {
const original = HttpClientRequest.get("https://example.com").pipe(
HttpClientRequest.setHeaders({
"Content-Length": "5",
"X-Test": "ok"
})
)
const request = original.pipe(HttpClientRequest.removeHeader("CONTENT-LENGTH"))

deepStrictEqual({ ...request.headers }, { "x-test": "ok" })
deepStrictEqual({ ...original.headers }, { "content-length": "5", "x-test": "ok" })
})

it("updateHeaders transforms the complete header set", () => {
const original = HttpClientRequest.get("https://example.com").pipe(
HttpClientRequest.setHeaders({
"Content-Length": "5",
"X-Test": "ok"
})
)
const request = HttpClientRequest.updateHeaders(
original,
(headers) => pipe(headers, Headers.remove("content-length"), Headers.set("x-next", "yes"))
)

deepStrictEqual({ ...request.headers }, { "x-test": "ok", "x-next": "yes" })
deepStrictEqual({ ...original.headers }, { "content-length": "5", "x-test": "ok" })
})
})

it.effect("matchStatus", () =>
Effect.gen(function*() {
const jp = yield* JsonPlaceholder
Expand Down