Allow configuring default constants in WP config

Author: JanJakes

packages/playground/cli/src/blueprints-v1/blueprints-v1-handler.ts

@@ -142,6 +142,7 @@ export class BlueprintsV1Handler {
 			mountsBeforeWpInstall,
 			mountsAfterWpInstall,
 			wordPressZip: wordPressZip && (await wordPressZip!.arrayBuffer()),
+			wpConfigDefaultConstants: this.args.wpConfigDefaultConstants,
 			sqliteIntegrationPluginZip:
 				await sqliteIntegrationPluginZip?.arrayBuffer(),
 			firstProcessId: 0,

packages/playground/cli/src/blueprints-v1/worker-thread-v1.ts

@@ -50,6 +50,7 @@ export type WorkerBootOptions = {
 export type PrimaryWorkerBootOptions = WorkerBootOptions & {
 	wpVersion?: string;
 	wordPressZip?: ArrayBuffer;
+	wpConfigDefaultConstants?: Record<string, string | number | boolean | null>;
 	sqliteIntegrationPluginZip?: ArrayBuffer;
 	dataSqlPath?: string;
 };
@@ -129,6 +130,7 @@ export class PlaygroundCliBlueprintV1Worker extends PHPWorker {
 		mountsAfterWpInstall,
 		phpVersion: php = RecommendedPHPVersion,
 		wordPressZip,
+		wpConfigDefaultConstants,
 		sqliteIntegrationPluginZip,
 		firstProcessId,
 		processIdSpaceLength,
@@ -182,6 +184,7 @@ export class PlaygroundCliBlueprintV1Worker extends PHPWorker {
 					wordPressZip !== undefined
 						? new File([wordPressZip], 'wordpress.zip')
 						: undefined,
+				wpConfigDefaultConstants,
 				sqliteIntegrationPluginZip:
 					sqliteIntegrationPluginZip !== undefined
 						? new File(

packages/playground/cli/src/blueprints-v2/worker-thread-v2.ts

@@ -27,7 +27,7 @@ import {
 	type ParsedBlueprintV2String,
 	type RawBlueprintV2Data,
 } from '@wp-playground/blueprints';
-import { bootRequestHandler } from '@wp-playground/wordpress';
+import { bootRequestHandler, ensureWpConfig } from '@wp-playground/wordpress';
 import { existsSync } from 'fs';
 import path from 'path';
 import { rootCertificates } from 'tls';
@@ -250,6 +250,17 @@ export class PlaygroundCliBlueprintV2Worker extends PHPWorker {
 			return;
 		}
 
+		/*
+		 * Add required constants to "wp-config.php" if they are not already defined.
+		 * This is needed, because some WordPress backups and exports may not include
+		 * definitions for some of the necessary constants.
+		 */
+		await ensureWpConfig(
+			primaryPhp,
+			primaryPhp.requestHandler!.documentRoot,
+			args.wpConfigDefaultConstants
+		);
+
 		await this.runBlueprintV2(args);
 	}
 

packages/playground/cli/src/run-cli.ts

@@ -153,6 +153,20 @@ export async function parseOptionsAndRunCLI() {
 				type: 'boolean',
 				default: false,
 			})
+			.option('wp-config-default-constants', {
+				describe:
+					'Configure default constant values to use in "wp-config.php", in case the constants are missing. Encoded as JSON string.',
+				type: 'string',
+				coerce: (value: string) => {
+					try {
+						return JSON.parse(value);
+					} catch (e /* eslint-disable-line @typescript-eslint/no-unused-vars */) {
+						throw new Error(
+							'Invalid JSON string for --wp-config-default-constants'
+						);
+					}
+				},
+			})
 			.option('skip-wordpress-setup', {
 				describe:
 					'Do not download, unzip, and install WordPress. Useful for mounting a pre-configured WordPress directory at /wordpress.',
@@ -420,6 +434,7 @@ export interface RunCLIArgs {
 	xdebug?: boolean;
 	experimentalDevtools?: boolean;
 	'experimental-blueprints-v2-runner'?: boolean;
+	wpConfigDefaultConstants?: Record<string, string | number | boolean | null>;
 
 	// --------- Blueprint V1 args -----------
 	skipWordPressSetup?: boolean;

packages/playground/wordpress/src/boot.ts

@@ -126,6 +126,10 @@ export interface BootWordPressOptions {
 	dataSqlPath?: string;
 	/** Zip with the WordPress installation to extract in /wordpress. */
 	wordPressZip?: File | Promise<File> | undefined;
+	/**
+	 * Default constant values to use in "wp-config.php", in case they are missing.
+	 */
+	wpConfigDefaultConstants?: Record<string, string | number | boolean | null>;
 	/** Preloaded SQLite integration plugin. */
 	sqliteIntegrationPluginZip?: File | Promise<File>;
 	/**
@@ -186,7 +190,11 @@ export async function bootWordPress(
 	 * This is needed, because some WordPress backups and exports may not include
 	 * definitions for some of the necessary constants.
 	 */
-	await ensureWpConfig(php, requestHandler.documentRoot);
+	await ensureWpConfig(
+		php,
+		requestHandler.documentRoot,
+		options.wpConfigDefaultConstants
+	);
 	// Run "before database" hooks to mount/copy more files in
 	if (options.hooks?.beforeDatabaseSetup) {
 		await options.hooks.beforeDatabaseSetup(php);

packages/playground/wordpress/src/test/wp-config.spec.ts

@@ -246,6 +246,40 @@ if ( ! defined( 'ABSPATH' ) ) {
 require_once ABSPATH . 'wp-settings.php';
 `);
 	});
+
+	it('should allow configuring default constants', async () => {
+		php.writeFile(
+			wpConfigPath,
+			`<?php
+			echo json_encode([
+				'DB_NAME' => DB_NAME,
+				'DB_USER' => DB_USER,
+				'CUSTOM_CONSTANT' => CUSTOM_CONSTANT,
+				'WP_DEBUG' => WP_DEBUG,
+			]);`
+		);
+
+		await ensureWpConfig(php, documentRoot, {
+			DB_NAME: 'custom-name',
+			CUSTOM_CONSTANT: 'custom-value',
+		});
+
+		const rewritten = php.readFileAsText(wpConfigPath);
+		expect(rewritten).toContain(`define( 'DB_NAME', 'custom-name' );`);
+		expect(rewritten).toContain(`define( 'DB_USER', 'wordpress' );`);
+		expect(rewritten).toContain(
+			`define( 'CUSTOM_CONSTANT', 'custom-value' );`
+		);
+		expect(rewritten).toContain(`define( 'WP_DEBUG', false );`);
+
+		const response = await php.run({ code: rewritten });
+		expect(response.json).toEqual({
+			DB_NAME: 'custom-name',
+			DB_USER: 'wordpress',
+			CUSTOM_CONSTANT: 'custom-value',
+			WP_DEBUG: false,
+		});
+	});
 });
 
 describe('defineWpConfigConstants', () => {

packages/playground/wordpress/src/wp-config.ts

@@ -14,7 +14,8 @@ import wpConfigTransformer from './wp-config-transformer.php?raw';
  */
 export async function ensureWpConfig(
 	php: UniversalPHP,
-	documentRoot: string
+	documentRoot: string,
+	defaultConstants: Record<string, string | number | boolean | null> = {}
 ): Promise<void> {
 	const wpConfigPath = joinPaths(documentRoot, 'wp-config.php');
 
@@ -35,6 +36,7 @@ export async function ensureWpConfig(
 		LOGGED_IN_SALT: 'put your unique phrase here',
 		NONCE_SALT: 'put your unique phrase here',
 		WP_DEBUG: false,
+		...defaultConstants,
 	};
 
 	/**
@@ -63,6 +65,11 @@ export async function ensureWpConfig(
 		);
 	}
 
+	// When we still don't have a wp-config.php file, there's nothing to be done.
+	if (!php.fileExists(wpConfigPath)) {
+		return;
+	}
+
 	// Ensure required constants are defined.
 	const js = phpVars({ wpConfigPath, constants: defaults });
 	const result = await php.run({