Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2025-03-02 22:37:50 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1872690 - Add doc for service worker performance tests. r=sparky,dom-worker-reviewers,smaug

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D197513
This commit is contained in:
Joshua Marshall 2024-01-15 15:45:08 +00:00
parent 1e44a7a5a7
commit 03343bf403
2 changed files with 71 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
dom/docs/workersAndStorage/PerformanceTesting.rst Normal file
View File

@ -0,0 +1,70 @@
================================
Service Worker Performance Tests
================================
Our performance tests are mochitests running in the `mozperftest
<https://firefox-source-docs.mozilla.org/testing/perfdocs/mozperftest.html>`_
harness. Tests reside under `dom/serviceworkers/test/performance
<https://searchfox.org/mozilla-central/source/dom/serviceworkers/test/performance>`_,
itemized in perftest.toml. Beyond the standard mochitest machinery,
performance tests define a ``perfMetadata`` variable at the top level, and call:
``info("perfMetrics", JSON.stringify(metrics));``
to report their results, where *metrics* is a map from testpoint name to scalar
numeric value. See the `performance scripts documentation
<https://firefox-source-docs.mozilla.org/testing/perfdocs/writing.html#mochitest>`_
for more.
They can be run via mach perftest, or as normal mochitests via mach test.
(Currently we can’t run the full manifest, see `bug 1865852
<https://bugzilla.mozilla.org/show_bug.cgi?id=1865852>`_.)
Adding new tests
================
Add files to `perftest.toml
<https://searchfox.org/mozilla-central/source/dom/serviceworkers/test/performance/perftest.toml>`_
as usual for mochitests.
Modify linux.yml, macosx.yml, and windows.yml under `taskcluster/ci/perftest
<https://searchfox.org/mozilla-central/source/taskcluster/ci/perftest>`_.
Currently, each test needs to be added individually to the run command (`here
<https://searchfox.org/mozilla-central/rev/91cc8848427fdbbeb324e6ca56a0d08d32d3c308/taskcluster/ci/perftest/linux.yml#121-149>`_,
for example). kind.yml can be ignored–it provides some defaults.
Modify the documentation using:
``$ ./mach lint -l perfdocs . --fix --warnings --outgoing``
There's currently a `bug <https://bugzilla.mozilla.org/show_bug.cgi?id=1872613>`_
which will likely cause the command to fail. Running it a second time should
succeed.
Staging tests in try jobs
=========================
``$ ./mach try fuzzy --full``
Look for ``‘service-worker`` to find things like:
| >perftest-windows-service-worker
| >perftest-macosx-service-worker
| >perftest-linux-service-worker
|
Results
=======
Results can be found in treeherder on `mozilla-central
<https://treeherder.mozilla.org/jobs?repo=mozilla-central&searchStr=perftest>`_
and `autoland
<https://treeherder.mozilla.org/jobs?repo=autoland&searchStr=perftest>`_. Look
for linux-sw, macosx-sw, and win-sw (`example
<https://treeherder.mozilla.org/perfherder/graphs?series=mozilla-central,4967140,1,15&selected=4967140,1814245176>`_).
These symbol names are defined in the .yml files under taskcluster/ci/perftest.
Contacts
========
| `Joshua Marshall <https://people.mozilla.org/p/jmarshall>`_ (DOM LWS)
| `Gregory Mierzwinski <https://people.mozilla.org/p/sparky>`_ (Performance Tools)

1
dom/docs/workersAndStorage/index.rst
View File

@ -7,4 +7,5 @@ These linked pages contain design documents for the Workers & Storage implementa
:maxdepth: 1
CodeStyle
PerformanceTesting
WorkerLifeCycleAndWorkerRefs