Dev: Only one WordPress

[kraftbj]

For unit testing, we often use WorDBless, a variant of WordPress that does not require database setup. Except, we include it a lot so there are a lot of copies of WordPress within the repo when fully installed.

Before and after the changes proposed below (conducted in clean directories on my M1 with composer's cache cleared)

Before:
1st run of jetpack install --all: Between 2m 57s and 3m 17s
2nd run: 56s
Size: (du of monorepo with du of .git subtracted): 5.1 GB

After:
1st run: Between 1m 20s and 1m 52s
2nd run: 55s
Size: 2.7 GB

Proposed changes:

• Remove inclusion of the WorDBless package in packages that did not use it for testing.
• Add a new test-environment package to serve as the WorDBless loader for monorepo projects.
• Replaced all inclusion of WorDBless package in individual packages with the new test-environment, updated bootstraps.
• Added a new tools/php-test-env package that will install WorDBless once in that directory.
• Updated monorepo root to install/update tools/php-test-env when itself is installed/updated (so jetpack install --all, -r will cover it.

In short, this changes the packages consumed by individual projects to use the internal test-environment. This ensure it is easy to modify all in the future and required little change to each individual package.

The test-environment loads a class that loads the test-php-env autoloader and loads WorDBless.

The test-php-env quasi-package does a singular install of WorDBless.

Other solution investigated was having the test-environment package directly require WorDBless, but that meant it would be re-installed every time test-environment was installed. No gain (at least) to install time, but it would have ended up with only one copy of WP.

Other information:

• Have you written new tests for your changes, if applicable?
• Have you checked the E2E test CI results, and verified that your changes do not break them?
• Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

None yet.

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

• jetpack install -r (at least) and jetpack install a package that uses worDBLess, like packages/admin-ui
• jetpack test phh packages/admin-ui

Does it still run the test successfully?

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  
• ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

---

Follow this PR Review Process:

1. Ensure all required checks appearing at the bottom of this PR are passing.
2. Choose a review path based on your changes:
   • A. Team Review: add the "[Status] Needs Team Review" label
     • For most changes, including minor cross-team impacts.
     • Example: Updating a team-specific component or a small change to a shared library.
   • B. Crew Review: add the "[Status] Needs Review" label
     • For significant changes to core functionality.
     • Example: Major updates to a shared library or complex features.
   • C. Both: Start with Team, then request Crew
     • For complex changes or when you need extra confidence.
     • Example: Refactor affecting multiple systems.
3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

---

Beta plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

• WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
• WoA releases happen weekly.
• Releases to self-hosted sites happen monthly. The next release is scheduled for February 4, 2025 (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Backup plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Boost plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Search plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Social plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Starter Plugin plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Protect plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Videopress plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Mu Wpcom plugin:

• Next scheduled release: WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Inspect plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Wpcomsh plugin:

• Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Automattic For agencies client plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Classic Theme helper plugin plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

[github-actions]

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

• To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the try/one-wordpress-to-rule-them-all branch.

  • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

• To test on Simple, run the following command on your sandbox:

  bin/jetpack-downloader test jetpack try/one-wordpress-to-rule-them-all
  

  bin/jetpack-downloader test jetpack-mu-wpcom-plugin try/one-wordpress-to-rule-them-all
  

Interested in more tips and information?

• In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
• Read more about our development workflow here: PCYsg-eg0-p2
• Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

[anomiex]

Saw this in a list and the title piqued my curiosity 😀

I wonder if the packages/test-environment package is really needed. It seems to do about the same thing as just sticking something like this in each consumer's bootstrap.php would.

require dirname( __DIR__, 5 ) . '/tools/php-test-env/vendor/autoload.php';
\WorDBless\Load::load();

(vary the 5 as needed based on the directory structure). The one added require seems less boilerplate than a whole extra package that in the end does the same thing.

If you still want the additional error handling, make a tools/php-test-env/load.php file to require instead. 🤷

[anomiex]

This probably needs to go after the bit just below that's clearing the Composer cache if we want WorDBless nightlies.

You'll probably also need to put code like this before this bit too for that case.

jetpack/.github/workflows/tests.yml

Lines 199 to 209 in d1a3fa1

	if [[ "$WP_BRANCH" == 'trunk' || "$WP_BRANCH" == 'previous' ]]; then
	VER=$(composer --format=json --working-dir="$DIR" show | jq -r '.installed[] | select( .name == "roots/wordpress" ) | .version')
	if [[ -n "$VER" ]]; then
	INSVER=$WORDPRESS_TAG
	[[ "$WORDPRESS_TAG" == 'trunk' ]] && INSVER="dev-main as $VER"
	echo "Supposed to run tests against WordPress $WORDPRESS_TAG, so setting roots/wordpress and roots/wordpress-no-content to \"$INSVER\""
	# Composer seems to sometimes have issues with deleting the wordpress dir on its own, so do it manually first.
	rm -rf "$DIR/wordpress"
	composer --working-dir="$DIR" require --dev roots/wordpress="$INSVER" roots/wordpress-no-content="$INSVER"
	fi
	fi

(and could probably get rid of it there then)