Skip to content
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.

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

Allow setting cookies with special characters #978

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
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
16 changes: 14 additions & 2 deletions packages/cookies/src/serialize.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
import type { RequestCookie, ResponseCookie } from './types'

function maybeDecodeURIComponent(s: string) {
try {
return decodeURIComponent(s)
} catch {
return s
}
}

export function stringifyCookie(c: ResponseCookie | RequestCookie): string {
const attrs = [
'path' in c && c.path && `Path=${c.path}`,
Expand All @@ -19,7 +27,9 @@ export function stringifyCookie(c: ResponseCookie | RequestCookie): string {
].filter(Boolean)

const stringified = `${c.name}=${encodeURIComponent(c.value ?? '')}`
return attrs.length === 0 ? stringified : `${stringified}; ${attrs.join('; ')}`
return attrs.length === 0
? stringified
: `${stringified}; ${attrs.join('; ')}`
}

/** Parse a `Cookie` header value */
Expand Down Expand Up @@ -72,7 +82,9 @@ export function parseSetCookie(setCookie: string): undefined | ResponseCookie {
)
const cookie: ResponseCookie = {
name,
value: decodeURIComponent(value),
// parseCookie already decoded the value, so if the value contains special chars
// decoding it again will cause problems
value: maybeDecodeURIComponent(value),
domain,
...(expires && { expires: new Date(expires) }),
...(httponly && { httpOnly: true }),
Expand Down
8 changes: 8 additions & 0 deletions packages/cookies/test/response-cookies.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -262,3 +262,11 @@ test('splitting multiple set-cookie', () => {
expect(cookies2.get('foo')?.value).toBe(undefined)
expect(cookies2.get('fooz')?.value).toBe('barz')
})

test('cookie with special chars', () => {
const headers = new Headers()
const specialChars = 'bar 50%!@#$%^&*()_+'
headers.set('set-cookie', `foo=${encodeURIComponent(specialChars)}`)
const cookies = new ResponseCookies(headers)
expect(cookies.getAll()).toEqual([{ name: 'foo', value: specialChars }])
})