Changeset 55459

Timestamp:

03/03/2023 08:37:10 PM (3 years ago)

Author:

joemcgill

Message:

Build/Test Tools: Add a performance measurement workflow.

This adds a new GitHub Action workflow that measures a set of performance metrics on every commit, so we can track changes in the performance of WordPress over time and more easily identify changes that are responsible for significant performance improvements or regressions during development cycles.

The workflow measures the homepage of a classic theme (Twenty Twenty-One) and a block theme (Twenty Twenty-Three) set up with demo content from the Theme Test Data project. Using the e2e testing framework, it makes 20 requests and records the median value of the following Server Timing metrics, generated by an mu-plugin installed as part of this workflow:

• Total server response time
• Server time before templates are loaded
• Server time during template rendering

In addition to measuring the performance metrics of the current commit, it also records performance metrics of a consistent version of WordPress (6.1.1) to be used as a baseline measurement in order to remove variance caused by the GitHub workers themselves from our reporting.

The measurements are collected and displayed at ​https://www.codevitals.run/project/wordpress.

Props adamsilverstein, mukesh27, flixos90, youknowriad, oandregal, desrosj, costdev, swissspidy.
Fixes #57687.

Location:

trunk

Files:

• .github/workflows/performance.yml (added)
• .gitignore (modified) (1 diff)
• package.json (modified) (1 diff)
• tests/performance (added)
• tests/performance/config (added)
• tests/performance/config/bootstrap.js (added)
• tests/performance/jest.config.js (added)
• tests/performance/log-results.js (added)
• tests/performance/results.js (added)
• tests/performance/run-tests.js (added)
• tests/performance/specs (added)
• tests/performance/specs/home-block-theme.test.js (added)
• tests/performance/specs/home-classic-theme.test.js (added)
• tests/performance/utils.js (added)
• tests/performance/wp-content (added)
• tests/performance/wp-content/mu-plugins (added)
• tests/performance/wp-content/mu-plugins/server-timing.php (added)

trunk/.gitignore

@@ -15 +15 @@
 /tests/phpunit/data/.trac-ticket-cache*
 /tests/qunit/compiled.html
+/tests/performance/**/*.test.results.json
 /src/.wp-tests-version
 /node_modules

trunk/package.json

@@ -177 +177 @@
         "env:logs": "node ./tools/local-env/scripts/docker.js logs",
         "env:pull": "node ./tools/local-env/scripts/docker.js pull",
+        "test:performance": "node ./tests/performance/run-tests.js",
         "test:php": "node ./tools/local-env/scripts/docker.js run -T php composer update -W && node ./tools/local-env/scripts/docker.js run php ./vendor/bin/phpunit",
         "test:e2e": "node ./tests/e2e/run-tests.js",