2024-01-04 01:07:25 +03:00
|
|
|
import { getJestConfig } from '@storybook/test-runner';
|
2023-09-19 05:07:38 +03:00
|
|
|
|
Generic Profiling story to wrap any component (#5341)
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 :
<img width="515" alt="image"
src="https://github.com/twentyhq/twenty/assets/26528466/273d2d91-26da-437a-890e-778cb6c1f993">
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.
```tsx
play: async ({ canvasElement }) => {
await findByTestId(
canvasElement,
'profiling-session-finished',
{},
{ timeout: 60000 },
);
const profilingReport = getProfilingReportFromDocument(canvasElement);
if (!isDefined(profilingReport)) {
return;
}
const p95result = profilingReport?.total.p95;
expect(
p95result,
`Component render time is more than p95 threshold (${p95ThresholdInMs}ms)`,
).toBeLessThan(p95ThresholdInMs);
},
```
2024-05-15 14:50:02 +03:00
|
|
|
const MINUTES_IN_MS = 60 * 1000;
|
|
|
|
|
|
2023-09-19 05:07:38 +03:00
|
|
|
/**
|
|
|
|
|
* @type {import('@jest/types').Config.InitialOptions}
|
|
|
|
|
*/
|
2023-12-10 18:22:43 +03:00
|
|
|
export default {
|
2023-09-19 05:07:38 +03:00
|
|
|
// The default configuration comes from @storybook/test-runner
|
|
|
|
|
...getJestConfig(),
|
|
|
|
|
/** Add your own overrides below
|
|
|
|
|
* @see https://jestjs.io/docs/configuration
|
|
|
|
|
*/
|
2024-05-24 19:53:37 +03:00
|
|
|
testTimeout: 5 * MINUTES_IN_MS,
|
2024-01-04 01:07:25 +03:00
|
|
|
};
|
