From bcad715ce67bc73a7927c941d1e7f02a82d638c2 Mon Sep 17 00:00:00 2001 From: Matthew Phillips Date: Thu, 21 Sep 2023 20:55:05 +0800 Subject: [PATCH 1/2] Ensure cookies are attached when middleware changes the Response (#8612) * Ensure cookies are attached when middleware changes the Response * fix test --- .changeset/curvy-owls-rest.md | 5 +++++ packages/astro/src/core/cookies/index.ts | 2 +- packages/astro/src/core/cookies/response.ts | 4 ++++ packages/astro/src/core/middleware/callMiddleware.ts | 12 ++++++++++-- .../test/fixtures/middleware space/src/middleware.js | 8 ++++++++ .../src/pages/return-response-cookies.astro | 8 ++++++++ packages/astro/test/middleware.test.js | 6 ++++++ 7 files changed, 42 insertions(+), 3 deletions(-) create mode 100644 .changeset/curvy-owls-rest.md create mode 100644 packages/astro/test/fixtures/middleware space/src/pages/return-response-cookies.astro diff --git a/.changeset/curvy-owls-rest.md b/.changeset/curvy-owls-rest.md new file mode 100644 index 000000000..41bd9a22e --- /dev/null +++ b/.changeset/curvy-owls-rest.md @@ -0,0 +1,5 @@ +--- +'astro': patch +--- + +Ensure cookies are attached when middleware changes the Response diff --git a/packages/astro/src/core/cookies/index.ts b/packages/astro/src/core/cookies/index.ts index f3c7b6d61..c55d060c4 100644 --- a/packages/astro/src/core/cookies/index.ts +++ b/packages/astro/src/core/cookies/index.ts @@ -1,2 +1,2 @@ export { AstroCookies } from './cookies.js'; -export { attachCookiesToResponse, getSetCookiesFromResponse } from './response.js'; +export { attachCookiesToResponse, responseHasCookies, getSetCookiesFromResponse } from './response.js'; diff --git a/packages/astro/src/core/cookies/response.ts b/packages/astro/src/core/cookies/response.ts index 8dc35e8c7..013f836bf 100644 --- a/packages/astro/src/core/cookies/response.ts +++ b/packages/astro/src/core/cookies/response.ts @@ -6,6 +6,10 @@ export function attachCookiesToResponse(response: Response, cookies: AstroCookie Reflect.set(response, astroCookiesSymbol, cookies); } +export function responseHasCookies(response: Response): boolean { + return Reflect.has(response, astroCookiesSymbol); +} + function getFromResponse(response: Response): AstroCookies | undefined { let cookies = Reflect.get(response, astroCookiesSymbol); if (cookies != null) { diff --git a/packages/astro/src/core/middleware/callMiddleware.ts b/packages/astro/src/core/middleware/callMiddleware.ts index 1725fd38d..bb0871405 100644 --- a/packages/astro/src/core/middleware/callMiddleware.ts +++ b/packages/astro/src/core/middleware/callMiddleware.ts @@ -7,6 +7,7 @@ import type { } from '../../@types/astro.js'; import { AstroError, AstroErrorData } from '../errors/index.js'; import type { Environment } from '../render/index.js'; +import { attachCookiesToResponse, responseHasCookies } from '../cookies/index.js'; /** * Utility function that is in charge of calling the middleware. @@ -82,7 +83,7 @@ export async function callMiddleware( if (value instanceof Response === false) { throw new AstroError(AstroErrorData.MiddlewareNotAResponse); } - return value as R; + return ensureCookiesAttached(apiContext, value as Response); } else { /** * Here we handle the case where `next` was called and returned nothing. @@ -105,11 +106,18 @@ export async function callMiddleware( throw new AstroError(AstroErrorData.MiddlewareNotAResponse); } else { // Middleware did not call resolve and returned a value - return value as R; + return ensureCookiesAttached(apiContext, value as Response); } }); } +function ensureCookiesAttached(apiContext: APIContext, response: Response): Response { + if(apiContext.cookies !== undefined && !responseHasCookies(response)) { + attachCookiesToResponse(response, apiContext.cookies); + } + return response; +} + function isEndpointOutput(endpointResult: any): endpointResult is EndpointOutput { return ( !(endpointResult instanceof Response) && diff --git a/packages/astro/test/fixtures/middleware space/src/middleware.js b/packages/astro/test/fixtures/middleware space/src/middleware.js index eeb902fb8..b2e5c7e2d 100644 --- a/packages/astro/test/fixtures/middleware space/src/middleware.js +++ b/packages/astro/test/fixtures/middleware space/src/middleware.js @@ -24,6 +24,14 @@ const first = defineMiddleware(async (context, next) => { const /** @type {string} */ html = await newResponse.text(); const newhtml = html.replace('

testing

', '

it works

'); return new Response(newhtml, { status: 200, headers: response.headers }); + } else if(context.url.pathname === '/return-response-cookies') { + const response = await next(); + const html = await response.text(); + + return new Response(html, { + status: 200, + headers: response.headers + }); } else { if (context.url.pathname === '/') { context.cookies.set('foo', 'bar'); diff --git a/packages/astro/test/fixtures/middleware space/src/pages/return-response-cookies.astro b/packages/astro/test/fixtures/middleware space/src/pages/return-response-cookies.astro new file mode 100644 index 000000000..a3583b590 --- /dev/null +++ b/packages/astro/test/fixtures/middleware space/src/pages/return-response-cookies.astro @@ -0,0 +1,8 @@ +--- +Astro.cookies.set("astro", "cookie", { + httpOnly: true, + path: "/", + sameSite: "strict", + maxAge: 1704085200, +}); +--- diff --git a/packages/astro/test/middleware.test.js b/packages/astro/test/middleware.test.js index 81f167647..d3cb83310 100644 --- a/packages/astro/test/middleware.test.js +++ b/packages/astro/test/middleware.test.js @@ -79,6 +79,12 @@ describe('Middleware in DEV mode', () => { let html = await res.text(); expect(html).to.contain('

it works

'); }); + + it('should forward cookies set in a component when the middleware returns a new response', async () => { + let res = await fixture.fetch('/return-response-cookies'); + let headers = res.headers; + expect(headers.get('set-cookie')).to.not.equal(null); + }); }); describe('Middleware in PROD mode, SSG', () => { From a576ba9c37523098f4af7cbcc04c91f5c15c02a2 Mon Sep 17 00:00:00 2001 From: matthewp Date: Thu, 21 Sep 2023 12:58:10 +0000 Subject: [PATCH 2/2] [ci] format --- packages/astro/src/core/cookies/index.ts | 6 +++++- packages/astro/src/core/middleware/callMiddleware.ts | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/astro/src/core/cookies/index.ts b/packages/astro/src/core/cookies/index.ts index c55d060c4..c8869f9ae 100644 --- a/packages/astro/src/core/cookies/index.ts +++ b/packages/astro/src/core/cookies/index.ts @@ -1,2 +1,6 @@ export { AstroCookies } from './cookies.js'; -export { attachCookiesToResponse, responseHasCookies, getSetCookiesFromResponse } from './response.js'; +export { + attachCookiesToResponse, + getSetCookiesFromResponse, + responseHasCookies, +} from './response.js'; diff --git a/packages/astro/src/core/middleware/callMiddleware.ts b/packages/astro/src/core/middleware/callMiddleware.ts index bb0871405..40513c152 100644 --- a/packages/astro/src/core/middleware/callMiddleware.ts +++ b/packages/astro/src/core/middleware/callMiddleware.ts @@ -5,9 +5,9 @@ import type { MiddlewareHandler, MiddlewareNext, } from '../../@types/astro.js'; +import { attachCookiesToResponse, responseHasCookies } from '../cookies/index.js'; import { AstroError, AstroErrorData } from '../errors/index.js'; import type { Environment } from '../render/index.js'; -import { attachCookiesToResponse, responseHasCookies } from '../cookies/index.js'; /** * Utility function that is in charge of calling the middleware. @@ -112,7 +112,7 @@ export async function callMiddleware( } function ensureCookiesAttached(apiContext: APIContext, response: Response): Response { - if(apiContext.cookies !== undefined && !responseHasCookies(response)) { + if (apiContext.cookies !== undefined && !responseHasCookies(response)) { attachCookiesToResponse(response, apiContext.cookies); } return response;