mirror of
https://github.com/hanzoai/next.js.git
synced 2026-10-30 14:46:38 +00:00
Hendrik LiebauandGitHub
649d302635
[Flakiness metrics](https://app.datadoghq.com/ci/test/runs?query=test_level%3Atest%20%40git.repository.id%3A%22github.com%2Fvercel%2Fnext.js%22%20%40test.status%3A%22fail%22%20%40test.name%3A%22basePath%20should%20use%20urls%20with%20basepath%20in%20router%20events%20for%20hash%20changes%22&agg_m=count&agg_m_source=base&agg_t=count¤tTab=overview&eventStack=&fromUser=false&index=citest&start=1773244604685&end=1773849404685&paused=false) After upgrading Playwright in #91250 (which brought some performance improvements), some tests are now exposed to be missing retries around assertions. `test/e2e/basepath/router-events.test.ts` is one of those tests, and this PR adds a `retry` around the event log assertion. We're also replacing the deprecated `check` utility with `retry` when waiting for the router to be ready.
136 lines
4.1 KiB
TypeScript
136 lines
4.1 KiB
TypeScript
import assert from 'assert'
|
|
import webdriver from 'next-webdriver'
|
|
import { nextTestSetup } from 'e2e-utils'
|
|
import { retry } from 'next-test-utils'
|
|
|
|
describe('basePath', () => {
|
|
const basePath = '/docs'
|
|
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
nextConfig: {
|
|
basePath,
|
|
onDemandEntries: {
|
|
// Make sure entries are not getting disposed.
|
|
maxInactiveAge: 1000 * 60 * 60,
|
|
},
|
|
},
|
|
})
|
|
|
|
it('should use urls with basepath in router events', async () => {
|
|
const browser = await webdriver(next.url, `${basePath}/hello`)
|
|
try {
|
|
await retry(() =>
|
|
expect(browser.eval('window.next.router.isReady')).resolves.toBe(true)
|
|
)
|
|
await browser.eval('window._clearEventLog()')
|
|
await browser
|
|
.elementByCss('#other-page-link')
|
|
.click()
|
|
.waitForElementByCss('#other-page-title')
|
|
|
|
const eventLog = await browser.eval('window._getEventLog()')
|
|
expect(
|
|
eventLog.filter((item) => item[1]?.endsWith('/other-page'))
|
|
).toEqual([
|
|
['routeChangeStart', `${basePath}/other-page`, { shallow: false }],
|
|
['beforeHistoryChange', `${basePath}/other-page`, { shallow: false }],
|
|
['routeChangeComplete', `${basePath}/other-page`, { shallow: false }],
|
|
])
|
|
} finally {
|
|
await browser.close()
|
|
}
|
|
})
|
|
|
|
it('should use urls with basepath in router events for hash changes', async () => {
|
|
const browser = await webdriver(next.url, `${basePath}/hello`)
|
|
try {
|
|
await retry(() =>
|
|
expect(browser.eval('window.next.router.isReady')).resolves.toBe(true)
|
|
)
|
|
await browser.eval('window._clearEventLog()')
|
|
await browser.elementByCss('#hash-change').click()
|
|
|
|
await retry(async () => {
|
|
const eventLog = await browser.eval('window._getEventLog()')
|
|
|
|
expect(eventLog).toEqual([
|
|
[
|
|
'hashChangeStart',
|
|
`${basePath}/hello#some-hash`,
|
|
{ shallow: false },
|
|
],
|
|
[
|
|
'hashChangeComplete',
|
|
`${basePath}/hello#some-hash`,
|
|
{ shallow: false },
|
|
],
|
|
])
|
|
})
|
|
} finally {
|
|
await browser.close()
|
|
}
|
|
})
|
|
|
|
it('should use urls with basepath in router events for cancelled routes', async () => {
|
|
const browser = await webdriver(next.url, `${basePath}/hello`)
|
|
try {
|
|
await retry(() =>
|
|
expect(browser.eval('window.next.router.isReady')).resolves.toBe(true)
|
|
)
|
|
await browser.eval('window._clearEventLog()')
|
|
|
|
await browser
|
|
.elementByCss('#slow-route')
|
|
.click()
|
|
.elementByCss('#other-page-link')
|
|
.click()
|
|
.waitForElementByCss('#other-page-title')
|
|
|
|
const eventLog = await browser.eval('window._getEventLog()')
|
|
expect(eventLog).toEqual([
|
|
['routeChangeStart', `${basePath}/slow-route`, { shallow: false }],
|
|
[
|
|
'routeChangeError',
|
|
'Route Cancelled',
|
|
true,
|
|
`${basePath}/slow-route`,
|
|
{ shallow: false },
|
|
],
|
|
['routeChangeStart', `${basePath}/other-page`, { shallow: false }],
|
|
['beforeHistoryChange', `${basePath}/other-page`, { shallow: false }],
|
|
['routeChangeComplete', `${basePath}/other-page`, { shallow: false }],
|
|
])
|
|
} finally {
|
|
await browser.close()
|
|
}
|
|
})
|
|
|
|
it('should use urls with basepath in router events for failed route change', async () => {
|
|
const browser = await webdriver(next.url, `${basePath}/hello`)
|
|
try {
|
|
await retry(() =>
|
|
expect(browser.eval('window.next.router.isReady')).resolves.toBe(true)
|
|
)
|
|
await browser.eval('window._clearEventLog()')
|
|
await browser.elementByCss('#error-route').click()
|
|
|
|
await retry(async () => {
|
|
const eventLog = await browser.eval('window._getEventLog()')
|
|
assert.deepEqual(eventLog, [
|
|
['routeChangeStart', `${basePath}/error-route`, { shallow: false }],
|
|
[
|
|
'routeChangeError',
|
|
'Failed to load static props',
|
|
null,
|
|
`${basePath}/error-route`,
|
|
{ shallow: false },
|
|
],
|
|
])
|
|
}, 10_000)
|
|
} finally {
|
|
await browser.close()
|
|
}
|
|
})
|
|
})
|