Commit 5929e9da authored by Prateek Bhatnagar's avatar Prateek Bhatnagar Committed by Joe Haddad

Add `unstable_onPerformanceData` helper for performance entries (#8480)

* Performance relayer for client side performance

* adding paint metrics

* fixing titles

* fixing route change measure

* accessing exports without loop

* adding more tests

* renaming the method

* adds experimental prefix to method name

* applying the suggested patch

* Update index.js
parent 923547c0
...@@ -75,7 +75,7 @@ let webpackHMR ...@@ -75,7 +75,7 @@ let webpackHMR
export let router export let router
export let ErrorComponent export let ErrorComponent
let Component let Component
let App let App, onPerfEntry
class Container extends React.Component { class Container extends React.Component {
componentDidCatch (err, info) { componentDidCatch (err, info) {
...@@ -139,7 +139,13 @@ export default async ({ webpackHMR: passedWebpackHMR } = {}) => { ...@@ -139,7 +139,13 @@ export default async ({ webpackHMR: passedWebpackHMR } = {}) => {
if (process.env.NODE_ENV === 'development') { if (process.env.NODE_ENV === 'development') {
webpackHMR = passedWebpackHMR webpackHMR = passedWebpackHMR
} }
App = await pageLoader.loadPage('/_app') const { page: app, mod } = await pageLoader.loadPageScript('/_app')
App = app
if (mod && mod.unstable_onPerformanceData) {
onPerfEntry = function ({ name, startTime, value }) {
mod.unstable_onPerformanceData({ name, startTime, value })
}
}
let initialErr = err let initialErr = err
...@@ -243,6 +249,13 @@ function renderReactElement (reactEl, domEl) { ...@@ -243,6 +249,13 @@ function renderReactElement (reactEl, domEl) {
} else { } else {
ReactDOM.render(reactEl, domEl, markRenderComplete) ReactDOM.render(reactEl, domEl, markRenderComplete)
} }
relayPaintMetrics()
}
function relayPaintMetrics () {
if (onPerfEntry) {
performance.getEntriesByType('paint').forEach(onPerfEntry)
}
} }
function markHydrateComplete () { function markHydrateComplete () {
...@@ -256,7 +269,10 @@ function markHydrateComplete () { ...@@ -256,7 +269,10 @@ function markHydrateComplete () {
'beforeRender' 'beforeRender'
) )
performance.measure('Next.js-hydration', 'beforeRender', 'afterHydrate') performance.measure('Next.js-hydration', 'beforeRender', 'afterHydrate')
if (onPerfEntry) {
performance.getEntriesByName('Next.js-hydration').forEach(onPerfEntry)
performance.getEntriesByName('beforeRender').forEach(onPerfEntry)
}
clearMarks() clearMarks()
} }
...@@ -276,7 +292,12 @@ function markRenderComplete () { ...@@ -276,7 +292,12 @@ function markRenderComplete () {
'beforeRender' 'beforeRender'
) )
performance.measure('Next.js-render', 'beforeRender', 'afterRender') performance.measure('Next.js-render', 'beforeRender', 'afterRender')
if (onPerfEntry) {
performance.getEntriesByName('Next.js-render').forEach(onPerfEntry)
performance
.getEntriesByName('Next.js-route-change-to-render')
.forEach(onPerfEntry)
}
clearMarks() clearMarks()
} }
...@@ -284,12 +305,12 @@ function clearMarks () { ...@@ -284,12 +305,12 @@ function clearMarks () {
;['beforeRender', 'afterHydrate', 'afterRender', 'routeChange'].forEach( ;['beforeRender', 'afterHydrate', 'afterRender', 'routeChange'].forEach(
mark => performance.clearMarks(mark) mark => performance.clearMarks(mark)
) )
;[
/* 'Next.js-before-hydration',
* TODO: uncomment the following line when we have a way to 'Next.js-hydration',
* expose this to user code. 'Next.js-route-change-to-render',
*/ 'Next.js-render'
// performance.clearMeasures() ].forEach(measure => performance.clearMeasures(measure))
} }
function AppContainer ({ children }) { function AppContainer ({ children }) {
......
...@@ -59,25 +59,29 @@ export default class PageLoader { ...@@ -59,25 +59,29 @@ export default class PageLoader {
} }
loadPage (route) { loadPage (route) {
return this.loadPageScript(route).then(v => v.page)
}
loadPageScript (route) {
route = this.normalizeRoute(route) route = this.normalizeRoute(route)
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const fire = ({ error, page }) => { const fire = ({ error, page, mod }) => {
this.pageRegisterEvents.off(route, fire) this.pageRegisterEvents.off(route, fire)
delete this.loadingRoutes[route] delete this.loadingRoutes[route]
if (error) { if (error) {
reject(error) reject(error)
} else { } else {
resolve(page) resolve({ page, mod })
} }
} }
// If there's a cached version of the page, let's use it. // If there's a cached version of the page, let's use it.
const cachedPage = this.pageCache[route] const cachedPage = this.pageCache[route]
if (cachedPage) { if (cachedPage) {
const { error, page } = cachedPage const { error, page, mod } = cachedPage
error ? reject(error) : resolve(page) error ? reject(error) : resolve({ page, mod })
return return
} }
......
/* global localStorage */
/* eslint-disable camelcase */
import App from 'next/app'
export default class MyApp extends App {}
/*
Method is experimental and will eventually be handled in a Next.js plugin
*/
export function unstable_onPerformanceData (data) {
localStorage.setItem(data.name, data.value || data.startTime)
}
export default () => {
return <h1>Hello!</h1>
}
/* eslint-env jest */
/* global jasmine */
import { join } from 'path'
import webdriver from 'next-webdriver'
import { killApp, findPort, launchApp } from 'next-test-utils'
const appDir = join(__dirname, '../')
let appPort
let server
jasmine.DEFAULT_TIMEOUT_INTERVAL = 1000 * 60 * 2
describe('Analytics relayer', () => {
beforeAll(async () => {
appPort = await findPort()
server = await launchApp(appDir, appPort)
})
afterAll(() => killApp(server))
it('Relays the data to user code', async () => {
const browser = await webdriver(appPort, '/')
await browser.waitForElementByCss('h1')
const h1Text = await browser.elementByCss('h1').text()
const data = parseFloat(
await browser.eval('localStorage.getItem("Next.js-hydration")')
)
const firstPaint = parseFloat(
await browser.eval('localStorage.getItem("first-paint")')
)
const firstContentfulPaint = parseFloat(
await browser.eval('localStorage.getItem("first-contentful-paint")')
)
expect(h1Text).toMatch(/Hello!/)
expect(data).not.toBeNaN()
expect(data).toBeGreaterThan(0)
expect(firstPaint).not.toBeNaN()
expect(firstPaint).toBeGreaterThan(0)
expect(firstContentfulPaint).not.toBeNaN()
expect(firstContentfulPaint).toBeGreaterThan(0)
await browser.close()
})
})
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