Update the Astro.cookies.set types to receive boolean and numbers (#5047)

matthewp · web-flow · commit 1e27992437aa · 2022-10-12T08:31:55.000-04:00
diff --git a/.changeset/witty-sheep-wave.md b/.changeset/witty-sheep-wave.md
@@ -0,0 +1,7 @@
+---
+'astro': patch
+---
+
+Update Astro.cookies.set types to allow booleans and numbers
+
+Note that booleans and numbers were already allowed, they just were not allowed by the type definitions.
diff --git a/packages/astro/src/core/cookies/cookies.ts b/packages/astro/src/core/cookies/cookies.ts
@@ -25,7 +25,7 @@ interface AstroCookieInterface {
 interface AstroCookiesInterface {
 	get(key: string): AstroCookieInterface;
 	has(key: string): boolean;
-	set(key: string, value: string | Record<string, any>, options?: AstroCookieSetOptions): void;
+	set(key: string, value: string | number | boolean | Record<string, any>, options?: AstroCookieSetOptions): void;
 	delete(key: string, options?: AstroCookieDeleteOptions): void;
 }
 
diff --git a/packages/astro/test/units/cookies/set.test.js b/packages/astro/test/units/cookies/set.test.js
@@ -45,6 +45,16 @@ describe('astro/src/core/cookies', () => {
 			expect(headers[0]).to.equal('one=2');
 		});
 
+		it('Can pass a boolean', () => {
+			let req = new Request('http://example.com/');
+			let cookies = new AstroCookies(req);
+			cookies.set('admin', true);
+			expect(cookies.get('admin').boolean()).to.equal(true);
+			let headers = Array.from(cookies.headers());
+			expect(headers).to.have.a.lengthOf(1);
+			expect(headers[0]).to.equal('admin=true');
+		});
+
 		it('Can get the value after setting', () => {
 			let req = new Request('http://example.com/');
 			let cookies = new AstroCookies(req);
diff --git a/packages/integrations/deno/test/basics.test.ts b/packages/integrations/deno/test/basics.test.ts
@@ -126,3 +126,20 @@ Deno.test({
 	sanitizeResources: false,
 	sanitizeOps: false,
 });
+
+Deno.test({
+	name: 'Astro.cookies',
+	permissions: defaultTestPermissions,
+	async fn() {
+		await startApp(async (baseUrl: URL) => {
+			const url = new URL('/admin', baseUrl);
+			const resp = await fetch(url, { redirect: 'manual' });
+			assertEquals(resp.status, 302);
+
+			const headers = resp.headers;
+			assertEquals(headers.get('set-cookie'), 'logged-in=false; Max-Age=77760000; Path=/');
+		});
+	},
+	sanitizeResources: false,
+	sanitizeOps: false,
+});
diff --git a/packages/integrations/deno/test/fixtures/basics/src/pages/admin.astro b/packages/integrations/deno/test/fixtures/basics/src/pages/admin.astro
@@ -0,0 +1,8 @@
+---
+Astro.cookies.set('logged-in', false, {
+	maxAge: 60 * 60 * 24 * 900,
+	path: '/'
+});
+
+return Astro.redirect('/login');
+---
diff --git a/packages/integrations/deno/test/fixtures/basics/src/pages/login.astro b/packages/integrations/deno/test/fixtures/basics/src/pages/login.astro
@@ -0,0 +1,10 @@
+---
+---
+<html>
+	<head>
+		<title>Testing</title>
+	</head>
+	<body>
+		<h1>Testing</h1>
+	</body>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ interface AstroCookieInterface {`
`25`	`25`	`interface AstroCookiesInterface {`
`26`	`26`	`get(key: string): AstroCookieInterface;`
`27`	`27`	`has(key: string): boolean;`
`28`		`- set(key: string, value: string \| Record<string, any>, options?: AstroCookieSetOptions): void;`
	`28`	`+ set(key: string, value: string \| number \| boolean \| Record<string, any>, options?: AstroCookieSetOptions): void;`
`29`	`29`	`delete(key: string, options?: AstroCookieDeleteOptions): void;`
`30`	`30`	`}`
`31`	`31`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,10 @@ @@
 +---
 +---
 +<html>
 +	<head>
 +		<title>Testing</title>
 +	</head>
 +	<body>
 +		<h1>Testing</h1>
 +	</body>
 +</html>