Unverified Commit 6f352357 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Ensure path can be specified for clearPreviewData (#40238)

As updated in https://github.com/vercel/next.js/pull/38313 this ensures the `path` option can also be passed to `clearPreviewData` to properly clear the preview cookies. 

## Bug

- [x] Related issues linked using `fixes #number`
- [x] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

Fixes: https://github.com/vercel/next.js/issues/39853
parent 6e273824
...@@ -2,6 +2,7 @@ import type { IncomingMessage } from 'http' ...@@ -2,6 +2,7 @@ import type { IncomingMessage } from 'http'
import type { BaseNextRequest } from '../base-http' import type { BaseNextRequest } from '../base-http'
import { NextApiRequest, NextApiResponse } from '../../shared/lib/utils' import { NextApiRequest, NextApiResponse } from '../../shared/lib/utils'
import type { CookieSerializeOptions } from 'next/dist/compiled/cookie'
export type NextApiRequestCookies = Partial<{ [key: string]: string }> export type NextApiRequestCookies = Partial<{ [key: string]: string }>
export type NextApiRequestQuery = Partial<{ [key: string]: string | string[] }> export type NextApiRequestQuery = Partial<{ [key: string]: string | string[] }>
...@@ -98,7 +99,10 @@ export const SYMBOL_PREVIEW_DATA = Symbol(COOKIE_NAME_PRERENDER_DATA) ...@@ -98,7 +99,10 @@ export const SYMBOL_PREVIEW_DATA = Symbol(COOKIE_NAME_PRERENDER_DATA)
export const SYMBOL_CLEARED_COOKIES = Symbol(COOKIE_NAME_PRERENDER_BYPASS) export const SYMBOL_CLEARED_COOKIES = Symbol(COOKIE_NAME_PRERENDER_BYPASS)
export function clearPreviewData<T>( export function clearPreviewData<T>(
res: NextApiResponse<T> res: NextApiResponse<T>,
options: {
path?: string
} = {}
): NextApiResponse<T> { ): NextApiResponse<T> {
if (SYMBOL_CLEARED_COOKIES in res) { if (SYMBOL_CLEARED_COOKIES in res) {
return res return res
...@@ -122,6 +126,9 @@ export function clearPreviewData<T>( ...@@ -122,6 +126,9 @@ export function clearPreviewData<T>(
sameSite: process.env.NODE_ENV !== 'development' ? 'none' : 'lax', sameSite: process.env.NODE_ENV !== 'development' ? 'none' : 'lax',
secure: process.env.NODE_ENV !== 'development', secure: process.env.NODE_ENV !== 'development',
path: '/', path: '/',
...(options.path !== undefined
? ({ path: options.path } as CookieSerializeOptions)
: undefined),
}), }),
serialize(COOKIE_NAME_PRERENDER_DATA, '', { serialize(COOKIE_NAME_PRERENDER_DATA, '', {
// To delete a cookie, set `expires` to a date in the past: // To delete a cookie, set `expires` to a date in the past:
...@@ -132,6 +139,9 @@ export function clearPreviewData<T>( ...@@ -132,6 +139,9 @@ export function clearPreviewData<T>(
sameSite: process.env.NODE_ENV !== 'development' ? 'none' : 'lax', sameSite: process.env.NODE_ENV !== 'development' ? 'none' : 'lax',
secure: process.env.NODE_ENV !== 'development', secure: process.env.NODE_ENV !== 'development',
path: '/', path: '/',
...(options.path !== undefined
? ({ path: options.path } as CookieSerializeOptions)
: undefined),
}), }),
]) ])
......
...@@ -494,7 +494,8 @@ export async function apiResolver( ...@@ -494,7 +494,8 @@ export async function apiResolver(
redirect(apiRes, statusOrUrl, url) redirect(apiRes, statusOrUrl, url)
apiRes.setPreviewData = (data, options = {}) => apiRes.setPreviewData = (data, options = {}) =>
setPreviewData(apiRes, data, Object.assign({}, apiContext, options)) setPreviewData(apiRes, data, Object.assign({}, apiContext, options))
apiRes.clearPreviewData = () => clearPreviewData(apiRes) apiRes.clearPreviewData = (options = {}) =>
clearPreviewData(apiRes, options)
apiRes.revalidate = ( apiRes.revalidate = (
urlPath: string, urlPath: string,
opts?: { opts?: {
......
...@@ -263,7 +263,11 @@ export type NextApiResponse<T = any> = ServerResponse & { ...@@ -263,7 +263,11 @@ export type NextApiResponse<T = any> = ServerResponse & {
path?: string path?: string
} }
) => NextApiResponse<T> ) => NextApiResponse<T>
clearPreviewData: () => NextApiResponse<T>
/**
* Clear preview data for Next.js' prerender mode
*/
clearPreviewData: (options?: { path?: string }) => NextApiResponse<T>
/** /**
* @deprecated `unstable_revalidate` has been renamed to `revalidate` * @deprecated `unstable_revalidate` has been renamed to `revalidate`
......
export default (req, res) => { export default (req, res) => {
res.clearPreviewData() res.clearPreviewData(
req.query.cookiePath
? {
path: req.query.cookiePath,
}
: undefined
)
res.status(200).end() res.status(200).end()
} }
...@@ -211,6 +211,38 @@ function runTests(startServer = nextStart) { ...@@ -211,6 +211,38 @@ function runTests(startServer = nextStart) {
expect(cookies[1]).not.toHaveProperty('Max-Age') expect(cookies[1]).not.toHaveProperty('Max-Age')
}) })
it('should return cookies to be expired on reset request with path specified', async () => {
const res = await fetchViaHTTP(
appPort,
'/api/reset',
{ cookiePath: '/blog' },
{ headers: { Cookie: previewCookieString } }
)
expect(res.status).toBe(200)
const cookies = res.headers
.get('set-cookie')
.replace(/(=(?!Lax)\w{3}),/g, '$1')
.split(',')
.map(cookie.parse)
expect(cookies.length).toBe(2)
expect(cookies[0]).toMatchObject({
Path: '/blog',
SameSite: 'None',
Expires: 'Thu 01 Jan 1970 00:00:00 GMT',
})
expect(cookies[0]).toHaveProperty('__prerender_bypass')
expect(cookies[0]).not.toHaveProperty('Max-Age')
expect(cookies[1]).toMatchObject({
Path: '/blog',
SameSite: 'None',
Expires: 'Thu 01 Jan 1970 00:00:00 GMT',
})
expect(cookies[1]).toHaveProperty('__next_preview_data')
expect(cookies[1]).not.toHaveProperty('Max-Age')
})
it('should pass undefined to API routes when not in preview', async () => { it('should pass undefined to API routes when not in preview', async () => {
const res = await fetchViaHTTP(appPort, `/api/read`) const res = await fetchViaHTTP(appPort, `/api/read`)
const json = await res.json() const json = await res.json()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment