-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Astro.cookies implementation (#4876)
* Astro.cookies implementation * Remove unused var * Fix build * Add a changesetp * Remove spoken-word expires
- Loading branch information
Showing
32 changed files
with
943 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| 'astro': minor | ||
| '@astrojs/cloudflare': minor | ||
| '@astrojs/deno': minor | ||
| '@astrojs/netlify': minor | ||
| '@astrojs/node': minor | ||
| '@astrojs/vercel': minor | ||
| --- | ||
|
|
||
| Adds the Astro.cookies API | ||
|
|
||
| `Astro.cookies` is a new API for manipulating cookies in Astro components and API routes. | ||
|
|
||
| In Astro components, the new `Astro.cookies` object is a map-like object that allows you to get, set, delete, and check for a cookie's existence (`has`): | ||
|
|
||
| ```astro | ||
| --- | ||
| type Prefs = { | ||
| darkMode: boolean; | ||
| } | ||
| Astro.cookies.set<Prefs>('prefs', { darkMode: true }, { | ||
| expires: '1 month' | ||
| }); | ||
| const prefs = Astro.cookies.get<Prefs>('prefs').json(); | ||
| --- | ||
| <body data-theme={prefs.darkMode ? 'dark' : 'light'}> | ||
| ``` | ||
|
|
||
| Once you've set a cookie with Astro.cookies it will automatically be included in the outgoing response. | ||
|
|
||
| This API is also available with the same functionality in API routes: | ||
|
|
||
| ```js | ||
| export function post({ cookies }) { | ||
| cookies.set('loggedIn', false); | ||
|
|
||
| return new Response(null, { | ||
| status: 302, | ||
| headers: { | ||
| Location: '/login' | ||
| } | ||
| }); | ||
| } | ||
| ``` | ||
|
|
||
| See [the RFC](https://github.com/withastro/rfcs/blob/main/proposals/0025-cookie-management.md) to learn more. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,202 @@ | ||
| import type { CookieSerializeOptions } from 'cookie'; | ||
| import { parse, serialize } from 'cookie'; | ||
|
|
||
| interface AstroCookieSetOptions { | ||
| domain?: string; | ||
| expires?: Date; | ||
| httpOnly?: boolean; | ||
| maxAge?: number; | ||
| path?: string; | ||
| sameSite?: boolean | 'lax' | 'none' | 'strict'; | ||
| secure?: boolean; | ||
| } | ||
|
|
||
| interface AstroCookieDeleteOptions { | ||
| path?: string; | ||
| } | ||
|
|
||
| interface AstroCookieInterface { | ||
| value: string | undefined; | ||
| json(): Record<string, any>; | ||
| number(): number; | ||
| boolean(): boolean; | ||
| } | ||
|
|
||
| interface AstroCookiesInterface { | ||
| get(key: string): AstroCookieInterface; | ||
| has(key: string): boolean; | ||
| set(key: string, value: string | Record<string, any>, options?: AstroCookieSetOptions): void; | ||
| delete(key: string, options?: AstroCookieDeleteOptions): void; | ||
| } | ||
|
|
||
| const DELETED_EXPIRATION = new Date(0); | ||
| const DELETED_VALUE = 'deleted'; | ||
|
|
||
| class AstroCookie implements AstroCookieInterface { | ||
| constructor(public value: string | undefined) {} | ||
| json() { | ||
| if(this.value === undefined) { | ||
| throw new Error(`Cannot convert undefined to an object.`); | ||
| } | ||
| return JSON.parse(this.value); | ||
| } | ||
| number() { | ||
| return Number(this.value); | ||
| } | ||
| boolean() { | ||
| if(this.value === 'false') return false; | ||
| if(this.value === '0') return false; | ||
| return Boolean(this.value); | ||
| } | ||
| } | ||
|
|
||
| class AstroCookies implements AstroCookiesInterface { | ||
| #request: Request; | ||
| #requestValues: Record<string, string> | null; | ||
| #outgoing: Map<string, [string, string, boolean]> | null; | ||
| constructor(request: Request) { | ||
| this.#request = request; | ||
| this.#requestValues = null; | ||
| this.#outgoing = null; | ||
| } | ||
|
|
||
| /** | ||
| * Astro.cookies.delete(key) is used to delete a cookie. Using this method will result | ||
| * in a Set-Cookie header added to the response. | ||
| * @param key The cookie to delete | ||
| * @param options Options related to this deletion, such as the path of the cookie. | ||
| */ | ||
| delete(key: string, options?: AstroCookieDeleteOptions): void { | ||
| const serializeOptions: CookieSerializeOptions = { | ||
| expires: DELETED_EXPIRATION | ||
| }; | ||
|
|
||
| if(options?.path) { | ||
| serializeOptions.path = options.path; | ||
| } | ||
|
|
||
| // Set-Cookie: token=deleted; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT | ||
| this.#ensureOutgoingMap().set(key, [ | ||
| DELETED_VALUE, | ||
| serialize(key, DELETED_VALUE, serializeOptions), | ||
| false | ||
| ]); | ||
| } | ||
|
|
||
| /** | ||
| * Astro.cookies.get(key) is used to get a cookie value. The cookie value is read from the | ||
| * request. If you have set a cookie via Astro.cookies.set(key, value), the value will be taken | ||
| * from that set call, overriding any values already part of the request. | ||
| * @param key The cookie to get. | ||
| * @returns An object containing the cookie value as well as convenience methods for converting its value. | ||
| */ | ||
| get(key: string): AstroCookie { | ||
| // Check for outgoing Set-Cookie values first | ||
| if(this.#outgoing !== null && this.#outgoing.has(key)) { | ||
| let [serializedValue,, isSetValue] = this.#outgoing.get(key)!; | ||
| if(isSetValue) { | ||
| return new AstroCookie(serializedValue); | ||
| } else { | ||
| return new AstroCookie(undefined); | ||
| } | ||
| } | ||
|
|
||
| const values = this.#ensureParsed(); | ||
| const value = values[key]; | ||
| return new AstroCookie(value); | ||
| } | ||
|
|
||
| /** | ||
| * Astro.cookies.has(key) returns a boolean indicating whether this cookie is either | ||
| * part of the initial request or set via Astro.cookies.set(key) | ||
| * @param key The cookie to check for. | ||
| * @returns | ||
| */ | ||
| has(key: string): boolean { | ||
| if(this.#outgoing !== null && this.#outgoing.has(key)) { | ||
| let [,,isSetValue] = this.#outgoing.get(key)!; | ||
| return isSetValue; | ||
| } | ||
| const values = this.#ensureParsed(); | ||
| return !!values[key]; | ||
| } | ||
|
|
||
| /** | ||
| * Astro.cookies.set(key, value) is used to set a cookie's value. If provided | ||
| * an object it will be stringified via JSON.stringify(value). Additionally you | ||
| * can provide options customizing how this cookie will be set, such as setting httpOnly | ||
| * in order to prevent the cookie from being read in client-side JavaScript. | ||
| * @param key The name of the cookie to set. | ||
| * @param value A value, either a string or other primitive or an object. | ||
| * @param options Options for the cookie, such as the path and security settings. | ||
| */ | ||
| set(key: string, value: string | Record<string, any>, options?: AstroCookieSetOptions): void { | ||
| let serializedValue: string; | ||
| if(typeof value === 'string') { | ||
| serializedValue = value; | ||
| } else { | ||
| // Support stringifying JSON objects for convenience. First check that this is | ||
| // a plain object and if it is, stringify. If not, allow support for toString() overrides. | ||
| let toStringValue = value.toString(); | ||
| if(toStringValue === Object.prototype.toString.call(value)) { | ||
| serializedValue = JSON.stringify(value); | ||
| } else { | ||
| serializedValue = toStringValue; | ||
| } | ||
| } | ||
|
|
||
| const serializeOptions: CookieSerializeOptions = {}; | ||
| if(options) { | ||
| Object.assign(serializeOptions, options); | ||
| } | ||
|
|
||
| this.#ensureOutgoingMap().set(key, [ | ||
| serializedValue, | ||
| serialize(key, serializedValue, serializeOptions), | ||
| true | ||
| ]); | ||
| } | ||
|
|
||
| /** | ||
| * Astro.cookies.header() returns an iterator for the cookies that have previously | ||
| * been set by either Astro.cookies.set() or Astro.cookies.delete(). | ||
| * This method is primarily used by adapters to set the header on outgoing responses. | ||
| * @returns | ||
| */ | ||
| *headers(): Generator<string, void, unknown> { | ||
| if(this.#outgoing == null) return; | ||
| for(const [,value] of this.#outgoing) { | ||
| yield value[1]; | ||
| } | ||
| } | ||
|
|
||
| #ensureParsed(): Record<string, string> { | ||
| if(!this.#requestValues) { | ||
| this.#parse(); | ||
| } | ||
| if(!this.#requestValues) { | ||
| this.#requestValues = {}; | ||
| } | ||
| return this.#requestValues; | ||
| } | ||
|
|
||
| #ensureOutgoingMap(): Map<string, [string, string, boolean]> { | ||
| if(!this.#outgoing) { | ||
| this.#outgoing = new Map(); | ||
| } | ||
| return this.#outgoing; | ||
| } | ||
|
|
||
| #parse() { | ||
| const raw = this.#request.headers.get('cookie'); | ||
| if(!raw) { | ||
| return; | ||
| } | ||
|
|
||
| this.#requestValues = parse(raw); | ||
| } | ||
| } | ||
|
|
||
| export { | ||
| AstroCookies | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
|
|
||
| export { | ||
| AstroCookies | ||
| } from './cookies.js'; | ||
|
|
||
| export { | ||
| attachToResponse, | ||
| getSetCookiesFromResponse | ||
| } from './response.js'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| import type { AstroCookies } from './cookies'; | ||
|
|
||
| const astroCookiesSymbol = Symbol.for('astro.cookies'); | ||
|
|
||
| export function attachToResponse(response: Response, cookies: AstroCookies) { | ||
| Reflect.set(response, astroCookiesSymbol, cookies); | ||
| } | ||
|
|
||
| function getFromResponse(response: Response): AstroCookies | undefined { | ||
| let cookies = Reflect.get(response, astroCookiesSymbol); | ||
| if(cookies != null) { | ||
| return cookies as AstroCookies; | ||
| } else { | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| export function * getSetCookiesFromResponse(response: Response): Generator<string, void, unknown> { | ||
| const cookies = getFromResponse(response); | ||
| if(!cookies) { | ||
| return; | ||
| } | ||
| for(const headerValue of cookies.headers()) { | ||
| yield headerValue; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.