Skip to content
Open
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/fix-url-params-percent-encoding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@effect/platform": patch
---

Preserve percent-encoding (`%20`) in `Url.modifyUrlParams` and `Url.setUrlParams`. Previously these functions used `URLSearchParams.toString()` which converts spaces to `+` per the `application/x-www-form-urlencoded` spec, silently mutating URLs. Added `UrlParams.toStringPercent` using RFC 3986 percent-encoding for URL context, while keeping the existing `toString` for form body encoding.
4 changes: 2 additions & 2 deletions packages/platform/src/Url.ts
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ export const setUrlParams: {
(url: URL, urlParams: UrlParams.UrlParams): URL
} = dual(2, (url: URL, searchParams: UrlParams.UrlParams) =>
mutate(url, (url) => {
url.search = UrlParams.toString(searchParams)
url.search = UrlParams.toStringPercent(searchParams)
}))

/**
Expand Down Expand Up @@ -320,5 +320,5 @@ export const modifyUrlParams: {
} = dual(2, (url: URL, f: (urlParams: UrlParams.UrlParams) => UrlParams.UrlParams) =>
mutate(url, (url) => {
const params = f(UrlParams.fromInput(url.searchParams))
url.search = UrlParams.toString(params)
url.search = UrlParams.toStringPercent(params)
}))
11 changes: 11 additions & 0 deletions packages/platform/src/UrlParams.ts
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,17 @@ export const makeUrl = (url: string, params: UrlParams, hash: Option.Option<stri
*/
export const toString = (self: UrlParams): string => new URLSearchParams(self as any).toString()

/**
* Encode url params using percent-encoding (RFC 3986) instead of the
* `application/x-www-form-urlencoded` format used by `URLSearchParams`.
* This preserves `%20` for spaces rather than converting them to `+`.
*
* @since 1.0.0
* @category conversions
*/
export const toStringPercent = (self: UrlParams): string =>
self.map(([key, value]) => `${encodeURIComponent(key)}=${encodeURIComponent(value)}`).join("&")

const baseUrl = (): string | undefined => {
if (
"location" in globalThis &&
Expand Down
Loading