Skip to content

fix: support setting cookies from MiddlewareResponse #2027

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

Merged
merged 22 commits into from
Apr 4, 2023
Merged
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
8 changes: 8 additions & 0 deletions cypress/integration/middleware/standard.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ describe('Standard middleware', () => {
cy.getCookie('netlifyCookie').should('have.property', 'value', 'true')
})
})

// https://github.com/netlify/pillar-support/issues/350
it('MiddlewareResponse adds cookies', () => {
cy.request('/cookies/middleware').then((response) => {
cy.getCookie('middlewareCookie').should('have.property', 'value', 'true')
expect(response.headers).to.have.property('x-foo', 'bar')
})
})
})

describe('Middleware matchers', () => {
Expand Down
9 changes: 8 additions & 1 deletion demos/middleware/middleware.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@ export async function middleware(req: NextRequest) {
return request.rewrite('/api/hello')
}

if (pathname.startsWith('/cookies/middleware')) {
const response = await new MiddlewareRequest(req).next()
response.cookies.set('middlewareCookie', 'true')
response.headers.set('x-foo', 'bar')
return response
}

if (pathname.startsWith('/cookies')) {
response = NextResponse.next()
response.cookies.set('netlifyCookie', 'true')
Expand Down Expand Up @@ -129,8 +136,8 @@ export const config = {
matcher: [
'/api/:all*',
'/headers',
'/cookies/:path*',
{ source: '/static' },
{ source: '/cookies' },
{ source: '/matcher-cookie'},
{ source: '/shows/((?!99|88).*)' },
{
Expand Down
9 changes: 9 additions & 0 deletions demos/middleware/pages/cookies/middleware.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
const Cookies = () => {
return (
<div>
<p>The cookie "middlewareCookie" should be set to true</p>
</div>
)
}

export default Cookies
10 changes: 9 additions & 1 deletion packages/next/src/middleware/response.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,15 @@ export class MiddlewareResponse extends NextResponse {
private readonly dataTransforms: NextDataTransform[]
private readonly elementHandlers: Array<[selector: string, handlers: ElementHandlers]>
constructor(public originResponse: Response) {
super()
// we need to propagate the set-cookie header, so response.cookies.get works correctly
const initHeaders = new Headers()
if (originResponse.headers.has('set-cookie')) {
initHeaders.set('set-cookie', originResponse.headers.get('set-cookie'))
}

super(undefined, {
headers: initHeaders,
})

// These are private in Node when compiling, but we access them in Deno at runtime
Object.defineProperty(this, 'dataTransforms', {
Expand Down
11 changes: 11 additions & 0 deletions packages/runtime/src/templates/edge-shared/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,15 @@ export const addMiddlewareHeaders = async (
return response
}

interface ResponseCookies {
readonly _headers: Headers
}

interface MiddlewareResponse extends Response {
originResponse: Response
dataTransforms: NextDataTransform[]
elementHandlers: Array<[selector: string, handlers: ElementHandlers]>
get cookies(): ResponseCookies
}

interface MiddlewareRequest {
Expand Down Expand Up @@ -184,6 +189,12 @@ export const buildResponse = async ({
if (request.method === 'HEAD' || request.method === 'OPTIONS') {
return response.originResponse
}

// NextResponse doesn't set cookies onto the originResponse, so we need to copy them over
if (response.cookies._headers.has('set-cookie')) {
response.originResponse.headers.set('set-cookie', response.cookies._headers.get('set-cookie')!)
}

// If it's JSON we don't need to use the rewriter, we can just parse it
if (response.originResponse.headers.get('content-type')?.includes('application/json')) {
const props = await response.originResponse.json()
Expand Down