feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
/* eslint-env jest */
|
|
|
|
|
|
|
|
import { Blob, File, FormData } from 'next/dist/compiled/formdata-node'
|
|
|
|
import { Crypto } from 'next/dist/server/web/sandbox/polyfills'
|
|
|
|
import { Response } from 'next/dist/server/web/spec-compliant/response'
|
|
|
|
import { Headers } from 'next/dist/server/web/spec-compliant/headers'
|
|
|
|
import * as streams from 'web-streams-polyfill/ponyfill'
|
|
|
|
|
|
|
|
beforeAll(() => {
|
|
|
|
global['Blob'] = Blob
|
|
|
|
global['crypto'] = new Crypto()
|
|
|
|
global['File'] = File
|
|
|
|
global['FormData'] = FormData
|
|
|
|
global['Headers'] = Headers
|
|
|
|
global['ReadableStream'] = streams.ReadableStream
|
|
|
|
global['TransformStream'] = streams.TransformStream
|
|
|
|
global['Response'] = Response
|
|
|
|
})
|
|
|
|
|
|
|
|
afterAll(() => {
|
|
|
|
delete global['Blob']
|
|
|
|
delete global['crypto']
|
|
|
|
delete global['File']
|
|
|
|
delete global['Headers']
|
|
|
|
delete global['FormData']
|
|
|
|
delete global['ReadableStream']
|
|
|
|
delete global['TransformStream']
|
|
|
|
})
|
|
|
|
|
|
|
|
it('reflect .set into `set-cookie`', async () => {
|
|
|
|
const { NextResponse } = await import(
|
|
|
|
'next/dist/server/web/spec-extension/response'
|
|
|
|
)
|
|
|
|
|
|
|
|
const response = new NextResponse()
|
|
|
|
|
2022-05-19 15:04:58 +02:00
|
|
|
expect(response.cookies.get('foo')).toBe(undefined)
|
|
|
|
expect(response.cookies.getWithOptions('foo')).toEqual({
|
|
|
|
value: undefined,
|
|
|
|
options: {},
|
|
|
|
})
|
|
|
|
|
|
|
|
response.cookies
|
|
|
|
.set('foo', 'bar', { path: '/test' })
|
|
|
|
.set('fooz', 'barz', { path: '/test2' })
|
|
|
|
|
|
|
|
expect(response.cookies.get('foo')).toBe('bar')
|
|
|
|
expect(response.cookies.get('fooz')).toBe('barz')
|
|
|
|
|
|
|
|
expect(response.cookies.getWithOptions('foo')).toEqual({
|
|
|
|
value: 'bar',
|
|
|
|
options: { Path: '/test' },
|
|
|
|
})
|
|
|
|
expect(response.cookies.getWithOptions('fooz')).toEqual({
|
|
|
|
value: 'barz',
|
|
|
|
options: { Path: '/test2' },
|
|
|
|
})
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
|
|
|
|
expect(Object.fromEntries(response.headers.entries())['set-cookie']).toBe(
|
2022-05-19 15:04:58 +02:00
|
|
|
'foo=bar; Path=/test, fooz=barz; Path=/test2'
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
)
|
|
|
|
})
|
|
|
|
|
|
|
|
it('reflect .delete into `set-cookie`', async () => {
|
|
|
|
const { NextResponse } = await import(
|
|
|
|
'next/dist/server/web/spec-extension/response'
|
|
|
|
)
|
|
|
|
|
|
|
|
const response = new NextResponse()
|
|
|
|
|
|
|
|
response.cookies.set('foo', 'bar')
|
|
|
|
expect(Object.fromEntries(response.headers.entries())['set-cookie']).toBe(
|
|
|
|
'foo=bar; Path=/'
|
|
|
|
)
|
2022-05-19 15:04:58 +02:00
|
|
|
|
|
|
|
expect(response.cookies.get('foo')).toBe('bar')
|
|
|
|
expect(response.cookies.getWithOptions('foo')).toEqual({
|
|
|
|
value: 'bar',
|
|
|
|
options: { Path: '/' },
|
|
|
|
})
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
|
|
|
|
response.cookies.set('fooz', 'barz')
|
|
|
|
expect(Object.fromEntries(response.headers.entries())['set-cookie']).toBe(
|
|
|
|
'foo=bar; Path=/, fooz=barz; Path=/'
|
|
|
|
)
|
2022-05-19 15:04:58 +02:00
|
|
|
|
|
|
|
expect(response.cookies.get('fooz')).toBe('barz')
|
|
|
|
expect(response.cookies.getWithOptions('fooz')).toEqual({
|
|
|
|
value: 'barz',
|
|
|
|
options: { Path: '/' },
|
|
|
|
})
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
|
|
|
|
const firstDelete = response.cookies.delete('foo')
|
|
|
|
expect(firstDelete).toBe(true)
|
|
|
|
expect(Object.fromEntries(response.headers.entries())['set-cookie']).toBe(
|
|
|
|
'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'
|
|
|
|
)
|
|
|
|
|
|
|
|
expect(response.cookies.get('foo')).toBe(undefined)
|
2022-05-19 15:04:58 +02:00
|
|
|
expect(response.cookies.getWithOptions('foo')).toEqual({
|
|
|
|
value: undefined,
|
|
|
|
options: {},
|
|
|
|
})
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
|
|
|
|
const secondDelete = response.cookies.delete('fooz')
|
|
|
|
expect(secondDelete).toBe(true)
|
2022-05-19 15:04:58 +02:00
|
|
|
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
expect(Object.fromEntries(response.headers.entries())['set-cookie']).toBe(
|
|
|
|
'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'
|
|
|
|
)
|
2022-05-19 15:04:58 +02:00
|
|
|
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
expect(response.cookies.get('fooz')).toBe(undefined)
|
2022-05-19 15:04:58 +02:00
|
|
|
expect(response.cookies.getWithOptions('fooz')).toEqual({
|
|
|
|
value: undefined,
|
|
|
|
options: {},
|
|
|
|
})
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
expect(response.cookies.size).toBe(0)
|
|
|
|
})
|
|
|
|
|
|
|
|
it('reflect .clear into `set-cookie`', async () => {
|
|
|
|
const { NextResponse } = await import(
|
|
|
|
'next/dist/server/web/spec-extension/response'
|
|
|
|
)
|
|
|
|
|
|
|
|
const response = new NextResponse()
|
|
|
|
|
|
|
|
response.cookies.clear()
|
|
|
|
expect(Object.fromEntries(response.headers.entries())['set-cookie']).toBe(
|
|
|
|
undefined
|
|
|
|
)
|
|
|
|
|
|
|
|
response.cookies.set('foo', 'bar')
|
|
|
|
expect(Object.fromEntries(response.headers.entries())['set-cookie']).toBe(
|
|
|
|
'foo=bar; Path=/'
|
|
|
|
)
|
2022-05-19 15:04:58 +02:00
|
|
|
|
|
|
|
expect(response.cookies.get('foo')).toBe('bar')
|
|
|
|
expect(response.cookies.getWithOptions('foo')).toEqual({
|
|
|
|
value: 'bar',
|
|
|
|
options: { Path: '/' },
|
|
|
|
})
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
|
|
|
|
response.cookies.set('fooz', 'barz')
|
|
|
|
expect(Object.fromEntries(response.headers.entries())['set-cookie']).toBe(
|
|
|
|
'foo=bar; Path=/, fooz=barz; Path=/'
|
|
|
|
)
|
|
|
|
|
|
|
|
response.cookies.clear()
|
|
|
|
expect(Object.fromEntries(response.headers.entries())['set-cookie']).toBe(
|
|
|
|
'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'
|
|
|
|
)
|
|
|
|
})
|
|
|
|
|
|
|
|
it('response.cookie does not modify options', async () => {
|
|
|
|
const { NextResponse } = await import(
|
|
|
|
'next/dist/server/web/spec-extension/response'
|
|
|
|
)
|
|
|
|
|
|
|
|
const options = { maxAge: 10000 }
|
|
|
|
const response = NextResponse.json(null)
|
|
|
|
response.cookies.set('cookieName', 'cookieValue', options)
|
|
|
|
expect(options).toEqual({ maxAge: 10000 })
|
|
|
|
})
|