d697a50c55
* Switch to ESM * Switch to NPM instead of Yarn * Switch to the native Node test runner * Drop the `buble` compiler * Drop `xtend`, use `Object.assign` instead * Drop `lodash.isequal`, use `fast-deep-equal` instead
Benchmarks
Benchmarks help us catch performance regressions and improve performance.
Running a Benchmark
Start the benchmark server
MAPBOX_ACCESS_TOKEN={YOUR MAPBOX ACCESS TOKEN} npm run start-bench
Open a benchmark runner page
Writing a Benchmark
Good benchmarks
- are precise (i.e. running it multiple times returns roughly the same result)
- operate in a way that mimics real-world usage
- use a large quantity of diverse real-world data
- are conceptually simple
Benchmarks are implemented as a function that returns an instance of Evented.
createBenchmark(options: {
accessToken: string;
createMap: (options: {
width: number;
height: number;
... // supports all options for the Map constructor
}):Map
}): Evented
The instance of Evented may fire any number of log and error events. The
instance of Evented must fire exactly one end event.
log
Fire the log event to report benchmark progress to the user.
{
message: string;
color: string = 'blue'; // name of a Mapbox base color https://mapbox.com/base/styling/color
}
If your benchmark has a notion of running multiple "samples", you might emit
one log event per sample.
benchmark.fire('log', {
message: 'Finished sample ' + i + ' in ' + formatNumber(time) + ' ms'
});
These events have no machine-semantic meaning.
end
Fire the end event to indicate the benchmark has finished running and report
its results.
These events have both human-readable results (message) and machine-readable results (score). Smaller scores are "better."
{
message: string;
score: number;
}
benchmark.fire('end', {
message: 'Average time is ' + formatNumber(averageTime)) + 'ms',
score: averageTime
});
error
Fire the error event to indicate the benchmark has encountered an error.
{
error: Error;
}