File size: 4,903 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
import { nextTestSetup } from 'e2e-utils'
import { retry } from 'next-test-utils'
import path from 'path'
describe('Instrumentation Client Hook', () => {
const testCases = [
{
name: 'With src folder',
appDir: 'app-with-src',
shouldLog: false,
},
{
name: 'App Router',
appDir: 'app-router',
shouldLog: true,
},
{
name: 'Pages Router',
appDir: 'pages-router',
shouldLog: false,
},
]
testCases.forEach(({ name, appDir, shouldLog }) => {
describe(name, () => {
const { next, isNextDev } = nextTestSetup({
files: path.join(__dirname, appDir),
})
it(`should execute instrumentation-client from ${name.toLowerCase()} before hydration`, async () => {
const browser = await next.browser('/')
const instrumentationTime = await browser.eval(
`window.__INSTRUMENTATION_CLIENT_EXECUTED_AT`
)
const hydrationTime = await browser.eval(`window.__NEXT_HYDRATED_AT`)
expect(instrumentationTime).toBeDefined()
expect(hydrationTime).toBeDefined()
expect(instrumentationTime).toBeLessThan(hydrationTime)
expect(
(await browser.log()).some((log) =>
log.message.startsWith(
'[Client Instrumentation Hook] Slow execution detected'
)
)
).toBe(isNextDev && shouldLog)
})
})
})
describe('onRouterTransitionStart', () => {
const { next } = nextTestSetup({
files: path.join(__dirname, 'app-router'),
})
function filterNavigationStartLogs(logs: Array<{ message: string }>) {
const result = []
for (const log of logs) {
if (log.message.startsWith('[Router Transition Start]')) {
result.push(log.message)
}
}
return result
}
it('onRouterTransitionStart fires at the start of a navigation', async () => {
const browser = await next.browser('/')
const linkToSomePage = await browser.elementByCss('a[href="/some-page"]')
await linkToSomePage.click()
await browser.elementById('some-page')
const linkToHome = await browser.elementByCss('a[href="/"]')
await linkToHome.click()
await browser.elementById('home')
expect(filterNavigationStartLogs(await browser.log())).toEqual([
'[Router Transition Start] [push] /some-page',
'[Router Transition Start] [push] /',
])
})
it('onRouterTransitionStart fires at the start of a back/forward navigation', async () => {
const browser = await next.browser('/')
const linkToSomePage = await browser.elementByCss('a[href="/some-page"]')
await linkToSomePage.click()
await browser.elementById('some-page')
await browser.back()
await browser.elementById('home')
await browser.forward()
await browser.elementById('some-page')
expect(filterNavigationStartLogs(await browser.log())).toEqual([
'[Router Transition Start] [push] /some-page',
'[Router Transition Start] [traverse] /',
'[Router Transition Start] [traverse] /some-page',
])
})
})
describe('HMR in development mode', () => {
const { next, isNextDev } = nextTestSetup({
files: path.join(__dirname, 'app-router'),
})
if (isNextDev) {
it('should reload instrumentation-client when modified', async () => {
const browser = await next.browser('/')
const initialTime = await browser.eval(
`window.__INSTRUMENTATION_CLIENT_EXECUTED_AT`
)
expect(initialTime).toBeDefined()
// Modify the instrumentation-client.ts file
const instrumentationPath = 'instrumentation-client.ts'
const originalContent = await next.readFile(instrumentationPath)
await next.patchFile(
instrumentationPath,
`
window.__INSTRUMENTATION_CLIENT_EXECUTED_AT = Date.now();
window.__INSTRUMENTATION_CLIENT_UPDATED = true;
`
)
await retry(async () => {
// Check if the updated instrumentation client was executed
const updatedFlag = await browser.eval(
`window.__INSTRUMENTATION_CLIENT_UPDATED`
)
expect(updatedFlag).toBe(true)
// Verify new execution time
const newTime = await browser.eval(
`window.__INSTRUMENTATION_CLIENT_EXECUTED_AT`
)
expect(newTime).toBeDefined()
expect(newTime).toBeGreaterThan(initialTime)
})
// Restore the original file
await next.patchFile(instrumentationPath, originalContent)
})
} else {
// Add a dummy test when not in dev mode
it('skips tests in non-dev mode', () => {
console.log(
'Skipping instrumentation-client-hook tests in non-dev mode'
)
})
}
})
})
|