Skip to content

Commit

Permalink
docs: add a test description linking back to reassure docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adhorodyski committed Oct 16, 2023
1 parent 6151759 commit 4b2896b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions tests/perf-test/GooglePlacesUtils.perf-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,16 @@ const bigObjectToFind = {
'25doesnt-exist': 'long_name',
};

/**
* This function will be executed 20 times and the average time will be used on the comparison.
* It will fail based on the CI configuration around Reassure:
* @see /.github/workflows/reassurePerformanceTests.yml
*
* Max deviation on the duration is set to 20% at the time of writing.
*
* More on the measureFunction API:
* @see https://callstack.github.io/reassure/docs/api#measurefunction-function
*/
test('getAddressComponents on a big dataset', async () => {
await measureFunction(
() => {
Expand Down

0 comments on commit 4b2896b

Please sign in to comment.