mirror of
https://github.com/hanzoai/next.js.git
synced 2026-10-30 14:46:38 +00:00
Jiachi LiuandGitHub
c9daf1fc8c
### What - After adding a new API `onRequestError()` and a few fixes on `register()` for `instrumentation.js`, it's time to promote it as stable API. - Add warning `"experimental.instrumentationHook is no longer needed to be configured in Next.js"` when you configure a `instrumentationHook` option in next.config.js Related PRs #67539, #67671, #67703, #67848, #67859, #67856, #67805, #68616, #68672, #68764, #68845 #68976, #68983 Closes NDX-89
113 lines
3.6 KiB
TypeScript
113 lines
3.6 KiB
TypeScript
import { nextTestSetup } from 'e2e-utils'
|
|
import { check } from 'next-test-utils'
|
|
import path from 'path'
|
|
|
|
const describeCase = (
|
|
caseName: string,
|
|
callback: (context: ReturnType<typeof nextTestSetup>) => void
|
|
) => {
|
|
describe(caseName, () => {
|
|
const context = nextTestSetup({
|
|
files: path.join(__dirname, caseName),
|
|
skipDeployment: true,
|
|
})
|
|
if (context.skipped) return
|
|
|
|
callback(context)
|
|
})
|
|
}
|
|
describe('Instrumentation Hook', () => {
|
|
describeCase('with-esm-import', ({ next }) => {
|
|
it('with-esm-import should run the instrumentation hook', async () => {
|
|
await next.render('/')
|
|
await check(
|
|
() => next.cliOutput,
|
|
/register in instrumentation\.js is running/
|
|
)
|
|
})
|
|
})
|
|
|
|
describeCase('with-middleware', ({ next }) => {
|
|
it('with-middleware should run the instrumentation hook', async () => {
|
|
await next.render('/')
|
|
await check(() => next.cliOutput, /instrumentation hook on the edge/)
|
|
})
|
|
})
|
|
|
|
describeCase('with-edge-api', ({ next }) => {
|
|
it('with-edge-api should run the instrumentation hook', async () => {
|
|
await next.render('/api')
|
|
await check(() => next.cliOutput, /instrumentation hook on the edge/)
|
|
})
|
|
})
|
|
|
|
describeCase('with-edge-page', ({ next }) => {
|
|
it('with-edge-page should run the instrumentation hook', async () => {
|
|
await next.render('/')
|
|
await check(() => next.cliOutput, /instrumentation hook on the edge/)
|
|
})
|
|
})
|
|
|
|
describeCase('with-node-api', ({ next }) => {
|
|
it('with-node-api should run the instrumentation hook', async () => {
|
|
await check(() => next.cliOutput, /instrumentation hook on nodejs/)
|
|
})
|
|
})
|
|
|
|
describeCase('with-node-page', ({ next }) => {
|
|
it('with-node-page should run the instrumentation hook', async () => {
|
|
await check(() => next.cliOutput, /instrumentation hook on nodejs/)
|
|
})
|
|
})
|
|
|
|
describeCase('with-async-node-page', ({ next }) => {
|
|
it('with-async-node-page should run the instrumentation hook', async () => {
|
|
const page = await next.render('/')
|
|
expect(page).toContain('Node - finished: true')
|
|
})
|
|
})
|
|
|
|
describeCase('with-async-edge-page', ({ next }) => {
|
|
it('with-async-edge-page should run the instrumentation hook', async () => {
|
|
const page = await next.render('/')
|
|
expect(page).toContain('Edge - finished: true')
|
|
})
|
|
})
|
|
|
|
describeCase('general', ({ next, isNextDev }) => {
|
|
it('should not overlap with a instrumentation page', async () => {
|
|
const page = await next.render('/instrumentation')
|
|
expect(page).toContain('Hello')
|
|
})
|
|
if (isNextDev) {
|
|
// TODO: Implement handling for changing the instrument file.
|
|
it.skip('should reload the server when the instrumentation hook changes', async () => {
|
|
await next.render('/')
|
|
await next.patchFile(
|
|
'./instrumentation.js',
|
|
`export function register() {console.log('toast')}`
|
|
)
|
|
await check(() => next.cliOutput, /toast/)
|
|
await next.renameFile(
|
|
'./instrumentation.js',
|
|
'./instrumentation.js.bak'
|
|
)
|
|
await check(
|
|
() => next.cliOutput,
|
|
/The instrumentation file has been removed/
|
|
)
|
|
await next.patchFile(
|
|
'./instrumentation.js.bak',
|
|
`export function register() {console.log('bread')}`
|
|
)
|
|
await next.renameFile(
|
|
'./instrumentation.js.bak',
|
|
'./instrumentation.js'
|
|
)
|
|
await check(() => next.cliOutput, /The instrumentation file was added/)
|
|
await check(() => next.cliOutput, /bread/)
|
|
})
|
|
}
|
|
})
|
|
})
|