mirror of
https://github.com/hanzoai/next.js.git
synced 2026-10-30 14:46:38 +00:00
StevenandGitHub
02a06175e3
This PR stabilizes an experimental feature that was added in a previous PR https://github.com/vercel/next.js/pull/50470 It allows the user to set `deploymentId` in `next.config.js`, which is a unique identifier for a deployment that will be included in each request's query string or header. This PR is easier to review with whitespace hidden: https://github.com/vercel/next.js/pull/63198/files?w=1 Closes NEXT-2789
149 lines
4.0 KiB
TypeScript
149 lines
4.0 KiB
TypeScript
import { nextTestSetup } from 'e2e-utils'
|
|
import { check } from 'next-test-utils'
|
|
import { join } from 'node:path'
|
|
|
|
describe.each(['NEXT_DEPLOYMENT_ID', 'CUSTOM_DEPLOYMENT_ID'])(
|
|
'deployment-id-handling enabled with %s',
|
|
(envKey) => {
|
|
const deploymentId = Date.now() + ''
|
|
const { next } = nextTestSetup({
|
|
files: join(__dirname, 'app'),
|
|
env: {
|
|
[envKey]: deploymentId,
|
|
},
|
|
})
|
|
|
|
it.each([
|
|
{ urlPath: '/' },
|
|
{ urlPath: '/pages-edge' },
|
|
{ urlPath: '/from-app' },
|
|
{ urlPath: '/from-app/edge' },
|
|
])(
|
|
'should append dpl query to all assets correctly for $urlPath',
|
|
async ({ urlPath }) => {
|
|
const $ = await next.render$(urlPath)
|
|
|
|
expect($('#deploymentId').text()).toBe(deploymentId)
|
|
|
|
const scripts = Array.from($('script'))
|
|
expect(scripts.length).toBeGreaterThan(0)
|
|
|
|
for (const script of scripts) {
|
|
if (script.attribs.src) {
|
|
expect(script.attribs.src).toContain('dpl=' + deploymentId)
|
|
}
|
|
}
|
|
|
|
const links = Array.from($('link'))
|
|
expect(links.length).toBeGreaterThan(0)
|
|
|
|
for (const link of links) {
|
|
if (link.attribs.href) {
|
|
if (link.attribs.as === 'font') {
|
|
expect(link.attribs.href).not.toContain('dpl=' + deploymentId)
|
|
} else {
|
|
expect(link.attribs.href).toContain('dpl=' + deploymentId)
|
|
}
|
|
}
|
|
}
|
|
|
|
const browser = await next.browser(urlPath)
|
|
const requests = []
|
|
|
|
browser.on('request', (req) => {
|
|
requests.push(req.url())
|
|
})
|
|
|
|
await browser.elementByCss('#dynamic-import').click()
|
|
|
|
await check(
|
|
() => (requests.length > 0 ? 'success' : JSON.stringify(requests)),
|
|
'success'
|
|
)
|
|
|
|
try {
|
|
expect(
|
|
requests.every((item) => item.includes('dpl=' + deploymentId))
|
|
).toBe(true)
|
|
} finally {
|
|
require('console').error('requests', requests)
|
|
}
|
|
}
|
|
)
|
|
|
|
it.each([{ pathname: '/api/hello' }, { pathname: '/api/hello-app' }])(
|
|
'should have deployment id env available',
|
|
async ({ pathname }) => {
|
|
const res = await next.fetch(pathname)
|
|
|
|
expect(await res.json()).toEqual({
|
|
deploymentId,
|
|
})
|
|
}
|
|
)
|
|
}
|
|
)
|
|
describe('deployment-id-handling disabled', () => {
|
|
const deploymentId = Date.now() + ''
|
|
const { next } = nextTestSetup({
|
|
files: join(__dirname, 'app'),
|
|
})
|
|
it.each([
|
|
{ urlPath: '/' },
|
|
{ urlPath: '/pages-edge' },
|
|
{ urlPath: '/from-app' },
|
|
{ urlPath: '/from-app/edge' },
|
|
])(
|
|
'should not append dpl query to all assets for $urlPath',
|
|
async ({ urlPath }) => {
|
|
const $ = await next.render$(urlPath)
|
|
|
|
expect($('#deploymentId').text()).not.toBe(deploymentId)
|
|
|
|
const scripts = Array.from($('script'))
|
|
expect(scripts.length).toBeGreaterThan(0)
|
|
|
|
for (const script of scripts) {
|
|
if (script.attribs.src) {
|
|
expect(script.attribs.src).not.toContain('dpl=' + deploymentId)
|
|
}
|
|
}
|
|
|
|
const links = Array.from($('link'))
|
|
expect(links.length).toBeGreaterThan(0)
|
|
|
|
for (const link of links) {
|
|
if (link.attribs.href) {
|
|
if (link.attribs.as === 'font') {
|
|
expect(link.attribs.href).not.toContain('dpl=' + deploymentId)
|
|
} else {
|
|
expect(link.attribs.href).not.toContain('dpl=' + deploymentId)
|
|
}
|
|
}
|
|
}
|
|
|
|
const browser = await next.browser(urlPath)
|
|
const requests = []
|
|
|
|
browser.on('request', (req) => {
|
|
requests.push(req.url())
|
|
})
|
|
|
|
await browser.elementByCss('#dynamic-import').click()
|
|
|
|
await check(
|
|
() => (requests.length > 0 ? 'success' : JSON.stringify(requests)),
|
|
'success'
|
|
)
|
|
|
|
try {
|
|
expect(
|
|
requests.every((item) => !item.includes('dpl=' + deploymentId))
|
|
).toBe(true)
|
|
} finally {
|
|
require('console').error('requests', requests)
|
|
}
|
|
}
|
|
)
|
|
})
|