Unverified Commit 76d9ab8e authored by Sebastian "Sebbie" Silbermann's avatar Sebastian "Sebbie" Silbermann Committed by GitHub

[test] Improve React performance track tests (#81359)

parent 17c05b67
'use client'
import { useSyncExternalStore } from 'react'
const reactServerRequestsServerSnapshot: never[] = []
const ServerRequestsStore = {
subscribe:
typeof window === 'undefined'
? () => () => {}
: window.reactServerRequests.subscribe,
getSnapshot:
typeof window === 'undefined'
? () => []
: window.reactServerRequests.getSnapshot,
getServerSnapshot: () => reactServerRequestsServerSnapshot,
}
export function ReactServerRequests() {
const reactServerRequests = useSyncExternalStore(
ServerRequestsStore.subscribe,
ServerRequestsStore.getSnapshot,
ServerRequestsStore.getServerSnapshot
)
return (
<>
<p>{reactServerRequests.length} Server Request entries</p>
<ol>
{reactServerRequests.map((request, index) => (
<li key={index}>
<details>
<summary>
<strong>{request.name}</strong>
</summary>
<pre>{JSON.stringify(request.properties, null, 2)}</pre>
</details>
</li>
))}
</ol>
</>
)
}
import { ReactNode, Suspense } from 'react' import { ReactNode, Suspense } from 'react'
import { ReactServerRequests } from './ReactServerRequests'
import Link from 'next/link'
export default function Root({ children }: { children: ReactNode }) { export default function Root({ children }: { children: ReactNode }) {
return ( return (
<html> <html>
<body> <body style={{ display: 'flex', flexDirection: 'row', gap: '1rem' }}>
<Suspense>{children}</Suspense> <ul>
<li>
<Link href="/">Home</Link>
</li>
<li>
<Link href="/fetch">fetch</Link>
</li>
<li>
<Link href="/set-timeout">setTimeout</Link>
</li>
</ul>
<main>
<ReactServerRequests />
<Suspense fallback="Loading Server Requests">
<div data-react-server-requests-done />
{children}
</Suspense>
</main>
</body> </body>
</html> </html>
) )
......
const error = new Error('test')
export default function Page() { export default function Page() {
console.error(error) return <p>Hello, World!</p>
return <p>hello world</p>
} }
export {} export {}
type ReactServerRequests = Array<{
name: string
properties: any
}>
declare global { declare global {
interface Window { interface Window {
reactServerRequests: Array<{ reactServerRequests: {
name: string getSnapshot(): ReactServerRequests
properties: any subscribe(callback: () => void): () => void
}> }
} }
interface PerformanceEntry { interface PerformanceEntry {
...@@ -13,7 +18,22 @@ declare global { ...@@ -13,7 +18,22 @@ declare global {
} }
} }
window.reactServerRequests = [] let reactServerRequests: ReactServerRequests = []
const listeners = new Set<() => void>()
// The store implementation is just a local debugging aid.
// Assertions should happen on `getSnapshot` not on the UI.
window.reactServerRequests = {
getSnapshot: () => {
return reactServerRequests
},
subscribe: (callback) => {
listeners.add(callback)
return () => {
listeners.delete(callback)
}
},
}
// We're trying to mock how the Chrome DevTools performance panel will display // We're trying to mock how the Chrome DevTools performance panel will display
// React performance data. React might decide to use console.timeStamp instead // React performance data. React might decide to use console.timeStamp instead
...@@ -21,13 +41,20 @@ window.reactServerRequests = [] ...@@ -21,13 +41,20 @@ window.reactServerRequests = []
// logic may have to be adjusted when updating React. A change here, doesn't // logic may have to be adjusted when updating React. A change here, doesn't
// mean it's a breaking change in React nor Next.js. // mean it's a breaking change in React nor Next.js.
new PerformanceObserver((entries) => { new PerformanceObserver((entries) => {
const newRequests: ReactServerRequests = []
for (const entry of entries.getEntries()) { for (const entry of entries.getEntries()) {
if (entry.detail?.devtools?.track === 'Server Requests ⚛') { if (entry.detail?.devtools?.track === 'Server Requests ⚛') {
window.reactServerRequests.push({ newRequests.push({
name: entry.name, name: entry.name,
properties: entry.detail.devtools.properties, properties: entry.detail.devtools.properties,
}) })
} }
} }
console.log(window.reactServerRequests)
if (newRequests.length > 0) {
reactServerRequests = reactServerRequests.concat(newRequests)
for (const listener of listeners) {
listener()
}
}
}).observe({ entryTypes: ['measure'] }) }).observe({ entryTypes: ['measure'] })
...@@ -7,8 +7,9 @@ describe('react-performance-track', () => { ...@@ -7,8 +7,9 @@ describe('react-performance-track', () => {
it('should show setTimeout', async () => { it('should show setTimeout', async () => {
const browser = await next.browser('/set-timeout') const browser = await next.browser('/set-timeout')
await browser.elementByCss('[data-react-server-requests-done]')
const track = await browser.eval('window.reactServerRequests') const track = await browser.eval('window.reactServerRequests.getSnapshot()')
expect(track).toEqual([ expect(track).toEqual([
{ name: 'setTimeout', properties: [] }, { name: 'setTimeout', properties: [] },
{ name: 'setTimeout', properties: [] }, { name: 'setTimeout', properties: [] },
...@@ -17,9 +18,10 @@ describe('react-performance-track', () => { ...@@ -17,9 +18,10 @@ describe('react-performance-track', () => {
it('should show fetch', async () => { it('should show fetch', async () => {
const browser = await next.browser('/fetch') const browser = await next.browser('/fetch')
await browser.elementByCss('[data-react-server-requests-done]')
const track = await browser.eval('window.reactServerRequests') const track = await browser.eval('window.reactServerRequests.getSnapshot()')
// FIXME: Should show await fetch and await response.json() // FIXME: Should show await fetch
expect(track).toEqual([]) expect(track).toEqual([])
}) })
}) })
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment