1729671 - Update performance-tests-overview.html to mention the new memory devtools metrics tests

Status: RESOLVED FIXED

(DevTools :: Documentation, task, P3)

Description

[Julian Descottes [:jdescottes]]

We added new performance metrics tests in Bug 1727571, we should update the documentation accordingly as it might be used by sheriffs.

See current version at https://firefox-source-docs.mozilla.org/devtools/tests/performance-tests-overview.html

See code at https://searchfox.org/mozilla-central/rev/a166f59fba89fc70ebfab287f4edb8e05ed4f6da/devtools/docs/tests/performance-tests-overview.md#59-69

Each new suite needs to be documented:

• content-process:reload
• content-total-after-gc
• parent-process:reload
• parent-process:target
• parent-process:toolbox
• reload-content-total-after-gc
• reload-total-after-gc
• reload:content-process
• reload:parent-process
• target-total-after-gc
• target:parent-process
• toolbox-total-after-gc
• toolbox:parent-process

I think that's too much, we should probably try to come up with more global test suite names.

Comment 1

[Julian Descottes [:jdescottes]]

Alex, what do you think about using a single suite name, eg devtools-allocations, and pushing the rest of the information in the test name?

Comment 2

[Alexandre Poirot [:ochameau]]

Sure, we can tweak that.

The list you provided looks outdated.
We should be having:

• ${recordName}:parent-process (suite)
  • objects-with-no-stacks (subtests)
  • objects-with-stacks
  • memory
• ${recordName}:content-process (only for reload)
  • objects-with-no-stacks
  • objects-with-stacks
  • memory
    That doesn't reduce the number of suites, but if you start refering to them, let's use the final names.

Also, note that we shouldn't overthink about these tests, we may drop PERFHERDER integration in favor of assertions:

is (leakCount, 0, "no leak");

It will only stay perf tests if we are not able to reliably fix all the leaks.

Comment 3

[Julian Descottes [:jdescottes]]

Oh I was looking at https://treeherder.mozilla.org/perfherder/tests?framework=12, but it must be showing outdated information.

So that means we only have

• toolbox:parent-process
• target:parent-process
• reload:parent-process
• reload:content-process

and remove total-after-gc

I'll update the doc quickly that's not too much.

Comment 4

[BugBot [:suhaib / :marco/ :calixte]]

The Bugbug bot thinks this bug should belong to the 'DevTools::Performance Tools (Profiler/Timeline)' component, and is moving the bug to that component. Please revert this change in case you think the bot is wrong.

Comment 5

[Julian Descottes [:jdescottes]]

Attachment: Bug 1729671 - [devtools] Update performance-tests-overview.html for new allocations devtools tests

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/9e1e6b87e563
[devtools] Update performance-tests-overview.html for new allocations devtools tests r=ochameau

Comment 7

[Andreea Pavel [:apavel]]

https://hg.mozilla.org/mozilla-central/rev/9e1e6b87e563