1653326 - Add documentation about individual mozperftest tests to perfdocs

Status: RESOLVED FIXED

(Testing :: Performance, task, P3)

Description

[Greg Mierzwinski [:sparky]]

This bug is for adding the metadata information from each individual mozperftest test into perfdocs. This will involve modifying the framework gatherer and removing the static-file limitation.

Comment 1

[Myeongjun Go]

Hello Sparky :)
My questions may be extensive. But, I need checking.
What is individual mozperftest test mean? I think, That is Browsertime, raptor or and so on?
And I wonder what metadata information is.

Comment 2

[Greg Mierzwinski [:sparky]]

Hi Jun :)

So this task is only related to mozperftest: https://searchfox.org/mozilla-central/source/python/mozperftest

You will have to make some gathering functions within the mozperftest gather to make use of this function: https://searchfox.org/mozilla-central/source/python/mozperftest/mozperftest/runner.py#127-131

The ScriptInfo object will hold the metadata information of the tests that need documentation (you will have to pass it each test file which you can find in the source tree by searching for files that start with perftest_*).

If you want to test out what the docs look like you can run ./mach perftest --flavor doc python/mozperftest/mozperftest/tests/data/samples/perftest_example.js (make sure you run ./mach build and/or ./mach bootstrap beforehand).

In this task, you'll have to extract information from the ScriptInfo object, and build test descriptions with it (you will also need to make changes to the config.yml file within python/mozperftest/perfdocs).

Let me know if there's any other questions :)

Comment 3

[Myeongjun Go]

Hello Sparky :)
I have questions and I need checking.

I found file that start with perftest_*. [0]
If I gather metadata information, Should It make each doc files?
e.g)
perftest_http3_youtube_watch_scroll.rst
perftest_politico_link.rst

And When I only look at content, I don't know clearly why config.yml be changed. [1]
Because I think It doesn't add suites.
Can you guide me roughly why config.yml needed to change?

[0] (There are a few examples)
./netwerk/test/perf/perftest_http3_youtube_watch_scroll.js
./netwerk/test/perf/perftest_http3_facebook_scroll.js
./netwerk/test/perf/perftest_http3_cloudflareblog.js
...
./testing/performance/perftest_politico_link.js
./testing/performance/perftest_bbc_link.js
./testing/performance/perftest_jsconf_cold.js
./browser/base/content/test/perftest_browser_xhtml_dom.js
...

[1]
https://searchfox.org/mozilla-central/source/python/mozperftest/perfdocs/config.yml

Comment 4

[Greg Mierzwinski [:sparky]]

We discussed this at our last perfdocs meeting. :myeongjun, let me know if there's any other questions :)

Comment 5

[Myeongjun Go]

Attachment: Bug 1653326 - [perfdocs] Add documentation about individual mozperftest tests to perfdocs r=sparky

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1314bfb5ce9a
[perfdocs] Add documentation about individual mozperftest tests to perfdocs r=sparky,perftest-reviewers

Comment 7

[Andreea Pavel [:apavel]]

https://hg.mozilla.org/mozilla-central/rev/1314bfb5ce9a