Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve performance testing #20802

Merged
merged 4 commits into from
Mar 12, 2020
Merged

Improve performance testing #20802

merged 4 commits into from
Mar 12, 2020

Conversation

sgomes
Copy link
Contributor

@sgomes sgomes commented Mar 11, 2020

Description

Performance testing for Gutenberg was being done using puppeteer, by instrumenting a browser instance, loading a page, and performing some typing. However, these times were being measured across the instrumented browser / host context switch; this meant that the numbers were potentially unreliable, since they were subject to unpredictable factors such as OS scheduling.

This PR performs the measurements within the instrumented browser instance, by relying on browser performance timings for the load / DOMContentLoaded numbers, and by using in-browser tracing for the typing event duration numbers.

The results won't be directly comparable to the previous way of testing, but they should be comparable between each other henceforth, assuming equivalent testing conditions (same machine, similar system load, etc.).

How has this been tested?

The intermediate trace files were loaded in Chrome's performance tab, and it was experimentally verified that the numbers in the generated results.json matched the duration of the events visible in the DevTools timeline.

Types of changes

Test-only bugfixes.

@sgomes sgomes added [Type] Performance Related to performance efforts [Package] E2E Tests /packages/e2e-tests labels Mar 11, 2020
@github-actions
Copy link

github-actions bot commented Mar 11, 2020

Size Change: +139 B (0%)

Total Size: 864 kB

Filename Size Change
build/block-editor/index.js 104 kB -158 B (0%)
build/block-editor/style-rtl.css 10.7 kB +16 B (0%)
build/block-editor/style.css 10.7 kB +18 B (0%)
build/block-library/index.js 116 kB +147 B (0%)
build/components/index.js 191 kB +116 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.01 kB 0 B
build/annotations/index.js 3.43 kB 0 B
build/api-fetch/index.js 3.39 kB 0 B
build/autop/index.js 2.58 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 6.02 kB 0 B
build/block-directory/style-rtl.css 760 B 0 B
build/block-directory/style.css 760 B 0 B
build/block-library/editor-rtl.css 7.23 kB 0 B
build/block-library/editor.css 7.24 kB 0 B
build/block-library/style-rtl.css 7.38 kB 0 B
build/block-library/style.css 7.39 kB 0 B
build/block-library/theme-rtl.css 669 B 0 B
build/block-library/theme.css 671 B 0 B
build/block-serialization-default-parser/index.js 1.65 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 57.7 kB 0 B
build/components/style-rtl.css 15.6 kB 0 B
build/components/style.css 15.6 kB 0 B
build/compose/index.js 5.75 kB 0 B
build/core-data/index.js 10.6 kB 0 B
build/data-controls/index.js 1.03 kB 0 B
build/data/index.js 8.22 kB 0 B
build/date/index.js 5.36 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 569 B 0 B
build/dom/index.js 3.06 kB 0 B
build/edit-post/index.js 91.3 kB 0 B
build/edit-post/style-rtl.css 8.64 kB 0 B
build/edit-post/style.css 8.64 kB 0 B
build/edit-site/index.js 4.64 kB 0 B
build/edit-site/style-rtl.css 2.48 kB 0 B
build/edit-site/style.css 2.48 kB 0 B
build/edit-widgets/index.js 4.44 kB 0 B
build/edit-widgets/style-rtl.css 2.58 kB 0 B
build/edit-widgets/style.css 2.58 kB 0 B
build/editor/editor-styles-rtl.css 381 B 0 B
build/editor/editor-styles.css 382 B 0 B
build/editor/index.js 43.8 kB 0 B
build/editor/style-rtl.css 3.98 kB 0 B
build/editor/style.css 3.97 kB 0 B
build/element/index.js 4.45 kB 0 B
build/escape-html/index.js 734 B 0 B
build/format-library/index.js 7.09 kB 0 B
build/format-library/style-rtl.css 502 B 0 B
build/format-library/style.css 502 B 0 B
build/hooks/index.js 1.92 kB 0 B
build/html-entities/index.js 622 B 0 B
build/i18n/index.js 3.49 kB 0 B
build/is-shallow-equal/index.js 710 B 0 B
build/keyboard-shortcuts/index.js 2.3 kB 0 B
build/keycodes/index.js 1.68 kB 0 B
build/list-reusable-blocks/index.js 2.99 kB 0 B
build/list-reusable-blocks/style-rtl.css 226 B 0 B
build/list-reusable-blocks/style.css 226 B 0 B
build/media-utils/index.js 4.85 kB 0 B
build/notices/index.js 1.57 kB 0 B
build/nux/index.js 3.01 kB 0 B
build/nux/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 0 B
build/plugins/index.js 2.54 kB 0 B
build/primitives/index.js 1.49 kB 0 B
build/priority-queue/index.js 780 B 0 B
build/redux-routine/index.js 2.84 kB 0 B
build/rich-text/index.js 14.3 kB 0 B
build/server-side-render/index.js 2.55 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.27 kB 0 B
build/url/index.js 4 kB 0 B
build/viewport/index.js 1.61 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.18 kB 0 B

compressed-size-action

@youknowriad
Copy link
Contributor

Run the tests a few times, the numbers seem consistent which is a good sign.

Capture d’écran 2020-03-11 à 7 26 16 PM

We may want to round that average number.

@sgomes
Copy link
Contributor Author

sgomes commented Mar 12, 2020

We may want to round that average number.

Added a commit applying rounding to the performance reporter.

item.dur &&
item.args &&
item.args.data &&
item.args.data.type === 'keypress';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that's enough, I know previously keydown was also a problem.

Capture d’écran 2020-03-12 à 11 16 51 AM

You can see in the screenshot that there's aa keydown and then a keypress. Both of these are gathered in a "Task". and after that there are "follow up async tasks).

Ideally, if we can meansure the three segments it would be great, I believe the most important thing is the sync behavior (keydown + keypress). A format like that might be best keydown+keypress ( follow-ups: xx ) eg: 25ms ( follow-ups: 40ms )

What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it will make much difference, since I expect the absolute values not to be as important as their evolution over time, and the keydown/keyup events don't seem to have a great deal of variability.

That said, for completeness sake, I added a commit where I calculate the sum of the three event durations for a total value for each virtual key press.

Copy link
Contributor Author

@sgomes sgomes Mar 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just noticed that you'd suggested separating out the values of the different event types in the output. Do you think that's necessary, or is the sum enough?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sum is enough for the first part (the synchronous work). I don't know though if it's possible somehow to compute the time spent in the asynchronous work. In the trace it's shown as separate from keydown, keyup, keypress event, it's shown as multiple small tasks.

I'd say, getting that value is less important but if we manage to get it, we shouldn't sum it with the rest.

does that make sense?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd argue that whether or not the async value is important depends on what you're trying to measure. If you're trying to measure input latency as perceived by the user, then the async value isn't important, as that work happens after the screen has updated and probably does not limit interactivity in any way, as the tasks are very short.

In any case, I suspect it would be extremely difficult to get that value, as there wouldn't be a good way of correlating the async work with the key events that triggered it.

Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@ellatrix @aduth do you have thoughts here?

Copy link
Member

@aduth aduth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't run it, but from code, changes looks good to me 👍

@youknowriad
Copy link
Contributor

Thanks @sgomes This is great.

@youknowriad youknowriad merged commit 7dda442 into master Mar 12, 2020
@youknowriad youknowriad deleted the update/improve-perf-testing branch March 12, 2020 14:29
@github-actions github-actions bot added this to the Gutenberg 7.8 milestone Mar 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] E2E Tests /packages/e2e-tests [Type] Performance Related to performance efforts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants