Website: Default to the kitchen sink extension bundle

Many reported issues are caused by Playground defaulting to the "light" PHP build. It saves 6MB of initial downloads, but it confuses new users with issues like [broken image editing](#1190). This PR changes the PHP bundle loaded by default to the "kitchen sink" one that ships with PHP extensions like finfo, GD, libxml. ## Testing instructions * Confirm the e2e tests passed. * Go to local Playground * Visit "/phpinfo.php" in Playground, confirm libxml is enabled (the output should contain --enable-xmlreader) * Open Playground configuration modal, uncheck the additional PHP extensions, confirm your choice * Confirm phpinfo.php now reports libxmls is disabled * Interact with that modal again, turn on the PHP extensions, confirm libxml is loaded again CC @flexseth @dmsnell @bgrgicak @brandonpayton
WordPress · Apr 3, 2024 · 99ba52b · 99ba52b · flexseth · Apr 3, 2024
1 parent d0a0726
commit 99ba52b
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 23 deletions.
diff --git a/packages/docs/site/docs/08-query-api/01-index.md b/packages/docs/site/docs/08-query-api/01-index.md
@@ -26,7 +26,7 @@ You can go ahead and try it out. The Playground will automatically install the t
 | `php`                  | `8.0`                                           | Loads the specified PHP version. Supported values: `7.0`, `7.1`, `7.2`, `7.3`, `7.4`, `8.0`, `8.1`, `8.2`, `8.3`, `latest`                                                                                                                                                                                                                                     |
 | `wp`                   | `latest`                                        | Loads the specified WordPress version. Supported values: `6.0`, `6.1`, `6.2`, `6.3`, `6.4`, `latest`, `nightly`, `beta`                                                                                                                                                                                                                                        |
 | `blueprint-url`        |                                                 | The URL of the Blueprint that will be used to configure this Playground instance.                                                                                                                                                                                                                                                                              |
-| `php-extension-bundle` |                                                 | Loads a bundle of PHP extensions. Supported bundles: `kitchen-sink` (for gd, mbstring, iconv, openssl, libxml, xml, dom, simplexml, xmlreader, xmlwriter)                                                                                                                                                                                                      |
+| `php-extension-bundle` |                                                 | Loads a bundle of PHP extensions. Supported bundles: `kitchen-sink` (for finfo, gd, mbstring, iconv, openssl, libxml, xml, dom, simplexml, xmlreader, xmlwriter), `light` (saves 6MB of downloads, loads none of the above extensions)                                                                                                                         |
 | `networking`           | `yes` or `no`                                   | Enables or disables the networking support for Playground. Defaults to `no`                                                                                                                                                                                                                                                                                    |
 | `plugin`               |                                                 | Installs the specified plugin. Use the plugin name from the plugins directory URL, e.g. for a URL like `https://wordpress.org/plugins/wp-lazy-loading/`, the plugin name would be `wp-lazy-loading`. You can pre-install multiple plugins by saying `plugin=coblocks&plugin=wp-lazy-loading&…`. Installing a plugin automatically logs the user in as an admin |
 | `theme`                |                                                 | Installs the specified theme. Use the theme name from the themes directory URL, e.g. for a URL like `https://wordpress.org/themes/disco/`, the theme name would be `disco`. Installing a theme automatically logs the user in as an admin                                                                                                                      |

diff --git a/packages/docs/site/docs/09-blueprints-api/03-data-format.md b/packages/docs/site/docs/09-blueprints-api/03-data-format.md
@@ -57,7 +57,8 @@ The `preferredVersions` property, unsurprisingly, declares the preferred of PHP
 
 The `phpExtensionBundles` property is an array of PHP extension bundles to load. The following bundles are supported:
 
--   `kitchen-sink`: Installs `gd`, `mbstring`, `iconv`, `openssl`, `libxml`, `xml`, `dom`, `simplexml`, `xmlreader`, `xmlwriter`
+-   `kitchen-sink`: Default choice. Installs `gd`, `mbstring`, `iconv`, `openssl`, `libxml`, `xml`, `dom`, `simplexml`, `xmlreader`, `xmlwriter`
+-   `light`: Saves 6MB of downloads, loads none of the above extensions.
 
 ## Features
 

diff --git a/packages/playground/blueprints/public/blueprint-schema.json b/packages/playground/blueprints/public/blueprint-schema.json
@@ -334,7 +334,7 @@
 		},
 		"SupportedPHPExtensionBundle": {
 			"type": "string",
-			"const": "kitchen-sink"
+			"enum": ["kitchen-sink", "light"]
 		},
 		"StepDefinition": {
 			"type": "object",

diff --git a/packages/playground/blueprints/src/lib/compile.ts b/packages/playground/blueprints/src/lib/compile.ts
@@ -134,6 +134,15 @@ export function compileBlueprint(
 		});
 	}
 
+	if (!blueprint.phpExtensionBundles) {
+		blueprint.phpExtensionBundles = [];
+	}
+	// Default to the "kitchen sink" PHP extensions bundle if no
+	// other bundles are specified.
+	if (blueprint.phpExtensionBundles.length === 0) {
+		blueprint.phpExtensionBundles.push('kitchen-sink');
+	}
+
 	/**
 	 * Download WP-CLI. {{{
 	 * Hardcoding this in the compilt() function is a temporary solution
@@ -145,9 +154,6 @@ export function compileBlueprint(
 		(step) => typeof step === 'object' && step?.step === 'wp-cli'
 	);
 	if (wpCliStepIndex !== undefined && wpCliStepIndex > -1) {
-		if (!blueprint.phpExtensionBundles) {
-			blueprint.phpExtensionBundles = [];
-		}
 		if (!blueprint.phpExtensionBundles.includes('kitchen-sink')) {
 			blueprint.phpExtensionBundles.push('kitchen-sink');
 			console.warn(

diff --git a/packages/playground/website/cypress/e2e/query-api.cy.ts b/packages/playground/website/cypress/e2e/query-api.cy.ts
@@ -43,12 +43,26 @@ describe('Query API', () => {
 	});
 
 	describe('option `php-extension-bundle`', () => {
-		it('should load the specified PHP extensions', () => {
+		it('should load XMLWriter with the kitchen sink extension bundle', () => {
 			cy.visit('/?php-extension-bundle=kitchen-sink&url=/phpinfo.php');
 			cy.wordPressDocument()
 				.its('body')
 				.should('contain', '--enable-xmlwriter');
 		});
+
+		it('should not load XMLWriter with the light extension bundle', () => {
+			cy.visit('/?php-extension-bundle=light&url=/phpinfo.php');
+			cy.wordPressDocument()
+				.its('body')
+				.should('contain', '--disable-xmlwriter');
+		});
+
+		it('should default to the light extension bundle', () => {
+			cy.visit('/?url=/phpinfo.php');
+			cy.wordPressDocument()
+				.its('body')
+				.should('contain', '--disable-xmlwriter');
+		});
 	});
 
 	describe('option `networking`', () => {
@@ -73,9 +87,7 @@ describe('Query API', () => {
 		 * @see https://github.com/WordPress/wordpress-playground/pull/1045
 		 */
 		it('should enable networking when requested AND the kitchen sink extension bundle is enabled', () => {
-			cy.visit(
-				'/?php-extension-bundle=kitchen-sink&networking=yes&url=/wp-admin/plugin-install.php'
-			);
+			cy.visit('/?networking=yes&url=/wp-admin/plugin-install.php');
 			cy.wordPressDocument()
 				.find('.plugin-card')
 				.should('have.length.above', 4);

diff --git a/packages/playground/website/src/lib/resolve-blueprint.ts b/packages/playground/website/src/lib/resolve-blueprint.ts
@@ -56,15 +56,6 @@ export async function resolveBlueprint() {
 		if (query.get('networking') === 'yes') {
 			features['networking'] = true;
 		}
-		let extensionBundles = query.getAll('php-extension-bundle') || [];
-		if (!extensionBundles.length) {
-			extensionBundles = ['kitchen-sink'];
-		} else if (
-			extensionBundles.length === 1 &&
-			extensionBundles[0] === 'light'
-		) {
-			extensionBundles = [];
-		}
 		blueprint = makeBlueprint({
 			php: query.get('php') || '8.0',
 			wp: query.get('wp') || 'latest',
@@ -74,7 +65,7 @@ export async function resolveBlueprint() {
 			features,
 			plugins: query.getAll('plugin'),
 			landingPage: query.get('url') || undefined,
-			phpExtensionBundles: extensionBundles,
+			phpExtensionBundles: query.getAll('php-extension-bundle') || [],
 			importSite: query.get('import-site') || undefined,
 			importContent: query.get('import-content') || undefined,
 		});

diff --git a/packages/playground/website/src/main.tsx b/packages/playground/website/src/main.tsx
@@ -60,9 +60,7 @@ const currentConfiguration: PlaygroundConfiguration = {
 	wp: blueprint.preferredVersions?.wp || 'latest',
 	php: resolveVersion(blueprint.preferredVersions?.php, SupportedPHPVersions),
 	storage: storage || 'none',
-	withExtensions: blueprint.phpExtensionBundles
-		? blueprint.phpExtensionBundles.length > 0
-		: false,
+	withExtensions: blueprint.phpExtensionBundles?.[0] !== 'light',
 	withNetworking: blueprint.features?.networking || false,
 	resetSite: false,
 };