Generic Profiling story to wrap any component #5341
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a Profiling feature for our story book tests.
It also implements a new CI job : front-sb-test-performance, that only runs stories suffixed with
.perf.stories.tsx
How it works
It allows to wrap any component into an array of React Profiler components that will run tests many times to have the most replicable average render time possible.
It is simply used by calling the new
getProfilingStory
util.Internally it creates a defined number of tests, separated by an arbitrary waiting time to allow the CPU to give more stable results.
It will do 3 warm-up and 3 finishing runs of tests because the first and last renders are always a bit erratic, so we want to measure only the runs in-between.
On the UI side it gives a table of results :
On the programmatic side, it stores the result in a div that can then be parsed by the play fonction of storybook, to expect a defined threshold.