Unverified Commit 04ceba43 authored by Houssein Djirdeh's avatar Houssein Djirdeh Committed by GitHub

Adds first input delay performance metric (#8884)

* measures fid

* updates typings, fixes logic, updates per review comments

* update to es5

* separate clearMeasures

* use relayer

* creates fid polyfll render helper + simplifies measure

* switch to dynamic import

* creates fid experimental flag

* removes unecessary time-to-first-input metric

* removes hydration measure removes

* default flag to false
Co-authored-by: 's avatarJoe Haddad <joe.haddad@zeit.co>
parent 0ccce727
...@@ -822,6 +822,9 @@ export default async function getBaseWebpackConfig( ...@@ -822,6 +822,9 @@ export default async function getBaseWebpackConfig(
'process.env.__NEXT_ROUTER_BASEPATH': JSON.stringify( 'process.env.__NEXT_ROUTER_BASEPATH': JSON.stringify(
config.experimental.basePath config.experimental.basePath
), ),
'process.env.__NEXT_FID_POLYFILL': JSON.stringify(
config.experimental.measureFid
),
...(isServer ...(isServer
? { ? {
// Fix bad-actors in the npm ecosystem (e.g. `node-formidable`) // Fix bad-actors in the npm ecosystem (e.g. `node-formidable`)
......
...@@ -345,7 +345,18 @@ function markHydrateComplete() { ...@@ -345,7 +345,18 @@ function markHydrateComplete() {
'beforeRender' 'beforeRender'
) )
performance.measure('Next.js-hydration', 'beforeRender', 'afterHydrate') performance.measure('Next.js-hydration', 'beforeRender', 'afterHydrate')
if (onPerfEntry) { if (onPerfEntry) {
if (process.env.__NEXT_FID_POLYFILL) {
import('../next-server/lib/fid-measure')
.then(mod => {
mod.default(onPerfEntry)
})
.catch(err => {
console.error('Error measuring First Input Delay', err)
})
}
performance.getEntriesByName('Next.js-hydration').forEach(onPerfEntry) performance.getEntriesByName('Next.js-hydration').forEach(onPerfEntry)
performance.getEntriesByName('beforeRender').forEach(onPerfEntry) performance.getEntriesByName('beforeRender').forEach(onPerfEntry)
} }
...@@ -375,6 +386,9 @@ function markRenderComplete() { ...@@ -375,6 +386,9 @@ function markRenderComplete() {
.forEach(onPerfEntry) .forEach(onPerfEntry)
} }
clearMarks() clearMarks()
;['Next.js-route-change-to-render', 'Next.js-render'].forEach(measure =>
performance.clearMeasures(measure)
)
} }
function clearMarks() { function clearMarks() {
...@@ -384,12 +398,6 @@ function clearMarks() { ...@@ -384,12 +398,6 @@ function clearMarks() {
'afterRender', 'afterRender',
'routeChange', 'routeChange',
].forEach(mark => performance.clearMarks(mark)) ].forEach(mark => performance.clearMarks(mark))
;[
'Next.js-before-hydration',
'Next.js-hydration',
'Next.js-route-change-to-render',
'Next.js-render',
].forEach(measure => performance.clearMeasures(measure))
} }
function AppContainer({ children }) { function AppContainer({ children }) {
......
/* global hydrationMetrics */
export default onPerfEntry => {
hydrationMetrics.onInputDelay((delay, event) => {
const hydrationMeasures = performance.getEntriesByName(
'Next.js-hydration',
'measure'
)
if (hydrationMeasures.length > 0) {
const { startTime, duration } = hydrationMeasures[0]
const hydrateEnd = startTime + duration
if (event.timeStamp > hydrateEnd) {
onPerfEntry({
name: 'first-input-delay-after-hydration',
startTime: event.timeStamp,
duration: delay,
})
} else {
onPerfEntry({
name: 'first-input-delay-before-hydration',
startTime: event.timeStamp,
duration: delay,
})
}
}
})
}
/**
* This is a modified version of the First Input Delay polyfill
* https://github.com/GoogleChromeLabs/first-input-delay
*
* It checks for a first input before and after hydration
*/
type DelayCallback = (delay: number, event: Event) => void
type addEventListener = (
type: string,
listener: EventListener,
listenerOpts: EventListenerOptions
) => void
type removeEventListener = addEventListener
function fidPolyfill(
addEventListener: addEventListener,
removeEventListener: removeEventListener
) {
var firstInputEvent: Event
var firstInputDelay: number
var firstInputTimeStamp: number
var callbacks: DelayCallback[] = []
var listenerOpts = { passive: true, capture: true }
var startTimeStamp = +new Date()
var pointerup = 'pointerup'
var pointercancel = 'pointercancel'
function onInputDelay(callback: DelayCallback) {
callbacks.push(callback)
reportInputDelayIfRecordedAndValid()
}
function recordInputDelay(delay: number, evt: Event) {
firstInputEvent = evt
firstInputDelay = delay
firstInputTimeStamp = +new Date()
reportInputDelayIfRecordedAndValid()
}
function reportInputDelayIfRecordedAndValid() {
var hydrationMeasures = performance.getEntriesByName(
'Next.js-hydration',
'measure'
)
var firstInputStart = firstInputTimeStamp - startTimeStamp
if (
firstInputDelay >= 0 &&
firstInputDelay < firstInputStart &&
(hydrationMeasures.length === 0 ||
hydrationMeasures[0].startTime < firstInputStart)
) {
callbacks.forEach(function(callback) {
callback(firstInputDelay, firstInputEvent)
})
// If the app is already hydrated, that means the first "post-hydration" input
// has been measured and listeners can be removed
if (hydrationMeasures.length > 0) {
eachEventType(removeEventListener)
callbacks = []
}
}
}
function onPointerDown(delay: number, evt: Event) {
function onPointerUp() {
recordInputDelay(delay, evt)
}
function onPointerCancel() {
removePointerEventListeners()
}
function removePointerEventListeners() {
removeEventListener(pointerup, onPointerUp, listenerOpts)
removeEventListener(pointercancel, onPointerCancel, listenerOpts)
}
addEventListener(pointerup, onPointerUp, listenerOpts)
addEventListener(pointercancel, onPointerCancel, listenerOpts)
}
function onInput(evt: Event) {
if (evt.cancelable) {
var isEpochTime = evt.timeStamp > 1e12
var now = isEpochTime ? +new Date() : performance.now()
var delay = now - evt.timeStamp
if (evt.type === 'pointerdown') {
onPointerDown(delay, evt)
} else {
recordInputDelay(delay, evt)
}
}
}
function eachEventType(callback: addEventListener | removeEventListener) {
var eventTypes = [
'click',
'mousedown',
'keydown',
'touchstart',
'pointerdown',
]
eventTypes.forEach(function(eventType) {
callback(eventType, onInput, listenerOpts)
})
}
eachEventType(addEventListener)
var context = self as any
context['hydrationMetrics'] = context['hydrationMetrics'] || {}
context['hydrationMetrics']['onInputDelay'] = onInputDelay
}
export default fidPolyfill
...@@ -55,6 +55,7 @@ const defaultConfig: { [key: string]: any } = { ...@@ -55,6 +55,7 @@ const defaultConfig: { [key: string]: any } = {
basePath: '', basePath: '',
sassOptions: {}, sassOptions: {},
pageEnv: false, pageEnv: false,
measureFid: false,
}, },
future: { future: {
excludeDefaultMomentLocales: false, excludeDefaultMomentLocales: false,
......
...@@ -13,6 +13,7 @@ import { ...@@ -13,6 +13,7 @@ import {
DocumentInitialProps, DocumentInitialProps,
DocumentProps, DocumentProps,
} from '../next-server/lib/utils' } from '../next-server/lib/utils'
import fidPolyfill from '../next-server/lib/fid'
import { cleanAmpPath } from '../next-server/server/utils' import { cleanAmpPath } from '../next-server/server/utils'
import { htmlEscapeJsonString } from '../server/htmlescape' import { htmlEscapeJsonString } from '../server/htmlescape'
...@@ -278,6 +279,20 @@ export class Head extends Component< ...@@ -278,6 +279,20 @@ export class Head extends Component<
}) })
} }
getFidPolyfill(): JSX.Element | null {
if (!process.env.__NEXT_FID_POLYFILL) {
return null
}
return (
<script
dangerouslySetInnerHTML={{
__html: `(${fidPolyfill})(addEventListener, removeEventListener)`,
}}
/>
)
}
render() { render() {
const { const {
styles, styles,
...@@ -517,6 +532,7 @@ export class Head extends Component< ...@@ -517,6 +532,7 @@ export class Head extends Component<
{styles || null} {styles || null}
</> </>
)} )}
{this.getFidPolyfill()}
{React.createElement(React.Fragment, {}, ...(headTags || []))} {React.createElement(React.Fragment, {}, ...(headTags || []))}
</head> </head>
) )
......
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