paularmstrong/react-component-benchmark

React Component Benchmark

This project aims to provide a method for gathering benchmarks of component tree mount, update, and unmount timings.

Please note that the values returned are estimates. Since this project does not hook into the React renderer directly, the values gathered are not 100% accurate and may vary slightly because they're taken from a wrapping component. That being said, running a large sample set should give you a confident benchmark metric.

Motivation

Historically, React has provided react-addons-perf in order to help gain insight into the performance of mounting, updating, and unmounting components. Unfortunately, as of React 16, it has been deprecated. Additionally, before deprecation, it was not usable in production React builds, making it less useful for many applications.

Usage

See the examples directory for ideas on how you might integrate this into your own project, whether in your user-interface or your automated tests.

Quick Start

import { Benchmark } from 'react-component-benchmark';

function MyComponentBenchmark() {
	const ref = React.useRef();

	const handleComplete = React.useCallback((results) => {
		console.log(results);
	}, []);

	const handleStart = () => {
		ref.current.start();
	};

	return (
		<div>
			<button onClick={handleStart}>Run</button>
			<Benchmark
				component={MyComponent}
				componentProps={componentProps}
				onComplete={handleComplete}
				ref={ref}
				samples={50}
				timeout={10000}
				type="mount"
			/>
		</div>
	);
}

In tests

See examples/tests for various test integrations.

Build a UI

• Demo: https://react-component-benchmark.vercel.app/
  • See, edit, and fork the code from paularmstrong/react-component-benchmark-example or codesandbox
  • You can also do the same using Preact! https://codesandbox.io/s/react-component-benchmark-preact-69inw

Benchmark props

Results

Note: All times and timestamps are in milliseconds. High resolution times provided when available.

ComputedResult