wp now: activate plugin and theme the first time

packages/playground/blueprints/src/lib/steps/activate-plugin.ts

@@ -1,9 +1,9 @@
 import { StepHandler } from '.';
-import { asDOM } from './common';
 
 export interface ActivatePluginStep {
 	step: 'activatePlugin';
-	plugin: string;
+	/* Path to the plugin file relative to the plugins directory. */
+	pluginPath: string;
 }
 
 /**
@@ -14,22 +14,26 @@ export interface ActivatePluginStep {
  */
 export const activatePlugin: StepHandler<ActivatePluginStep> = async (
 	playground,
-	{ plugin },
+	{ pluginPath },
 	progress
 ) => {
-	progress?.tracker.setCaption(`Activating ${plugin}`);
-	const pluginsPage = asDOM(
-		await playground.request({
-			url: '/wp-admin/plugins.php',
-		})
+	progress?.tracker.setCaption(`Activating ${pluginPath}`);
+	const requiredFiles = [
+		`${playground.documentRoot}/wp-load.php`,
+		`${playground.documentRoot}/wp-admin/includes/plugin.php`,
+	];
+	const requiredFilesExist = requiredFiles.every((file) =>
+		playground.fileExists(file)
 	);
-
-	const link = pluginsPage.querySelector(
-		`tr[data-slug="${plugin}"] a`
-	)! as HTMLAnchorElement;
-	const href = link.attributes.getNamedItem('href')!.value;
-
-	await playground.request({
-		url: '/wp-admin/' + href,
+	if (!requiredFilesExist) {
+		throw new Error(
+			`Required WordPress files do not exist: ${requiredFiles.join(', ')}`
+		);
+	}
+	await playground.run({
+		code: `<?php
+      ${requiredFiles.map((file) => `require_once( '${file}' );`).join('\n')}
+      activate_plugin('${pluginPath}');
+      `,
 	});
 };

packages/playground/blueprints/src/lib/steps/activate-theme.ts

@@ -0,0 +1,32 @@
+import { StepHandler } from '.';
+
+export interface ActivateThemeStep {
+	step: 'activateTheme';
+	themeFolderName: string;
+}
+
+/**
+ * Activates a WordPress theme in the Playground.
+ *
+ * @param playground The playground client.
+ * @param themeFolderName The theme folder name.
+ */
+export const activateTheme: StepHandler<ActivateThemeStep> = async (
+	playground,
+	{ themeFolderName },
+	progress
+) => {
+	progress?.tracker.setCaption(`Activating ${themeFolderName}`);
+	const wpLoadPath = `${playground.documentRoot}/wp-load.php`;
+	if (!playground.fileExists(wpLoadPath)) {
+		throw new Error(
+			`Required WordPress file does not exist: ${wpLoadPath}`
+		);
+	}
+	await playground.run({
+		code: `<?php
+      require_once( '${wpLoadPath}' );
+      switch_theme( '${themeFolderName}' );
+      `,
+	});
+};

packages/playground/blueprints/src/lib/steps/handlers.ts

@@ -1,4 +1,5 @@
 export { activatePlugin } from './activate-plugin';
+export { activateTheme } from './activate-theme';
 export { applyWordPressPatches } from './apply-wordpress-patches';
 export {
 	rm,

packages/playground/blueprints/src/lib/steps/index.ts

@@ -26,6 +26,7 @@ import {
 	WriteFileStep,
 } from './client-methods';
 import { DefineWpConfigConstsStep } from './define-wp-config-consts';
+import { ActivateThemeStep } from './activate-theme';
 import { DefineVirtualWpConfigConstsStep } from './define-virtual-wp-config-consts';
 
 export type Step = GenericStep<FileReference>;
@@ -38,6 +39,7 @@ export type StepDefinition = Step & {
 
 export type GenericStep<Resource> =
 	| ActivatePluginStep
+	| ActivateThemeStep
 	| ApplyWordPressPatchesStep
 	| CpStep
 	| DefineWpConfigConstsStep

packages/wp-now/src/tests/mode-examples/theme/style.css

@@ -1,5 +1,5 @@
 /*
-Theme Name: Twenty Twenty
+Theme Name: Yolo Theme
 Text Domain: twentytwenty
 Version: 2.2
 Tested up to: 6.2

packages/wp-now/src/tests/wp-now.spec.ts

@@ -384,4 +384,103 @@ describe('Test starting different modes', () => {
 
 		expectRequiredRootFiles(requiredFiles, wpNowOptions.documentRoot, php);
 	});
+
+	/**
+	 * Test that startWPNow in "plugin" mode auto installs the plugin.
+	 */
+	test('startWPNow auto installs the plugin', async () => {
+		const projectPath = path.join(tmpExampleDirectory, 'plugin');
+		const options = await getWpNowConfig({ path: projectPath });
+		const { php } = await startWPNow(options);
+		const codeIsPluginActivePhp = `<?php
+    require_once('${php.documentRoot}/wp-load.php');
+    require_once('${php.documentRoot}/wp-admin/includes/plugin.php');
+
+    if (is_plugin_active('plugin/sample-plugin.php')) {
+      echo 'plugin/sample-plugin.php is active';
+    }
+    `;
+		const isPluginActive = await php.run({
+			code: codeIsPluginActivePhp,
+		});
+
+		expect(isPluginActive.text).toContain(
+			'plugin/sample-plugin.php is active'
+		);
+	});
+
+	/**
+	 * Test that startWPNow in "plugin" mode does not auto install the plugin the second time.
+	 */
+	test('startWPNow auto installs the plugin', async () => {
+		const projectPath = path.join(tmpExampleDirectory, 'plugin');
+		const options = await getWpNowConfig({ path: projectPath });
+		const { php } = await startWPNow(options);
+		const deactivatePluginPhp = `<?php
+    require_once('${php.documentRoot}/wp-load.php');
+    require_once('${php.documentRoot}/wp-admin/includes/plugin.php');
+    deactivate_plugins('plugin/sample-plugin.php');
+    `;
+		await php.run({ code: deactivatePluginPhp });
+		// Run startWPNow a second time.
+		const { php: phpSecondTime } = await startWPNow(options);
+		const codeIsPluginActivePhp = `<?php
+    require_once('${php.documentRoot}/wp-load.php');
+    require_once('${php.documentRoot}/wp-admin/includes/plugin.php');
+
+    if (is_plugin_active('plugin/sample-plugin.php')) {
+      echo 'plugin/sample-plugin.php is active';
+    } else {
+      echo 'plugin not active';
+    }
+    `;
+		const isPluginActive = await phpSecondTime.run({
+			code: codeIsPluginActivePhp,
+		});
+
+		expect(isPluginActive.text).toContain('plugin not active');
+	});
+
+	/**
+	 * Test that startWPNow in "theme" mode auto activates the theme.
+	 */
+	test('startWPNow auto installs the theme', async () => {
+		const projectPath = path.join(tmpExampleDirectory, 'theme');
+		const options = await getWpNowConfig({ path: projectPath });
+		const { php } = await startWPNow(options);
+		const codeActiveThemeNamePhp = `<?php
+    require_once('${php.documentRoot}/wp-load.php');
+    echo wp_get_theme()->get('Name');
+    `;
+		const themeName = await php.run({
+			code: codeActiveThemeNamePhp,
+		});
+
+		expect(themeName.text).toContain('Yolo Theme');
+	});
+
+	/**
+	 * Test that startWPNow in "theme" mode does not auto activate the theme the second time.
+	 */
+	test('startWPNow auto installs the theme', async () => {
+		const projectPath = path.join(tmpExampleDirectory, 'theme');
+		const options = await getWpNowConfig({ path: projectPath });
+		const { php } = await startWPNow(options);
+		const switchThemePhp = `<?php
+    require_once('${php.documentRoot}/wp-load.php');
+    switch_theme('twentytwentythree');
+    `;
+		await php.run({ code: switchThemePhp });
+		// Run startWPNow a second time.
+		const { php: phpSecondTime } = await startWPNow(options);
+		const codeActiveThemeNamePhp = `<?php
+    require_once('${php.documentRoot}/wp-load.php');
+    echo wp_get_theme()->get('Name');
+    `;
+		const themeName = await phpSecondTime.run({
+			code: codeActiveThemeNamePhp,
+		});
+
+		expect(themeName.text).toContain('Twenty Twenty-Three');
+	});
 });

packages/wp-now/src/wp-now.ts

@@ -12,14 +12,20 @@ import {
 	downloadSqliteIntegrationPlugin,
 	downloadWordPress,
 } from './download';
+import {
+	activatePlugin,
+	activateTheme,
+	defineVirtualWpConfigConsts,
+	login,
+} from '@wp-playground/blueprints';
 import { WPNowOptions, WPNowMode } from './config';
-import { defineVirtualWpConfigConsts, login } from '@wp-playground/blueprints';
 import {
 	isPluginDirectory,
 	isThemeDirectory,
 	isWpContentDirectory,
 	isWordPressDirectory,
 	isWordPressDevelopDirectory,
+	getPluginFile,
 } from './wp-playground-wordpress';
 import { output } from './output';
 
@@ -65,6 +71,7 @@ export default async function startWPNow(
 	await downloadWordPress(options.wordPressVersion);
 	await downloadSqliteIntegrationPlugin();
 	await downloadMuPlugins();
+	const isFirstTimeProject = !fs.existsSync(options.wpContentPath);
 	switch (options.mode) {
 		case WPNowMode.WP_CONTENT:
 			await runWpContentMode(php, options);
@@ -87,6 +94,14 @@ export default async function startWPNow(
 		username: 'admin',
 		password: 'password',
 	});
+
+	if (
+		isFirstTimeProject &&
+		[WPNowMode.PLUGIN, WPNowMode.THEME].includes(options.mode)
+	) {
+		await activatePluginOrTheme(php, options);
+	}
+
 	return {
 		php,
 		options,
@@ -232,6 +247,19 @@ async function initWordPress(
 	return { initializeDefaultDatabase };
 }
 
+async function activatePluginOrTheme(
+	php: NodePHP,
+	{ projectPath, mode }: WPNowOptions
+) {
+	if (mode === WPNowMode.PLUGIN) {
+		const pluginFile = getPluginFile(projectPath);
+		await activatePlugin(php, { pluginPath: pluginFile });
+	} else if (mode === WPNowMode.THEME) {
+		const themeFolderName = path.basename(projectPath);
+		await activateTheme(php, { themeFolderName });
+	}
+}
+
 function mountMuPlugins(php: NodePHP, vfsDocumentRoot: string) {
 	php.mount(
 		path.join(WP_NOW_PATH, 'mu-plugins'),

packages/wp-now/src/wp-playground-wordpress/get-plugin-file.ts

@@ -0,0 +1,39 @@
+import fs from 'fs-extra';
+import path, { basename } from 'path';
+import { readFileHead } from './read-file-head';
+
+/**
+ * Sorts the files in the given array using a heuristic.
+ * The plugin file usually has the same name as the project folder.
+ * @param files The files to sort.
+ * @returns The sorted files.
+ */
+function heuristicSort(files: string[], projectPath: string) {
+	const heuristicsBestGuess = `${basename(projectPath)}.php`;
+	const heuristicsBestGuessIndex = files.indexOf(heuristicsBestGuess);
+	if (heuristicsBestGuessIndex !== -1) {
+		files.splice(heuristicsBestGuessIndex, 1);
+		files.unshift(heuristicsBestGuess);
+	}
+	return files;
+}
+
+/**
+ *
+ * @param projectPath The path to the plugin.
+ * @returns Path to the plugin file relative to the plugins directory.
+ */
+export function getPluginFile(projectPath: string) {
+	const files = heuristicSort(fs.readdirSync(projectPath), projectPath);
+	for (const file of files) {
+		if (file.endsWith('.php')) {
+			const fileContent = readFileHead(path.join(projectPath, file));
+			const pluginNameRegex =
+				/^(?:[ \t]*<\?php)?[ \t/*#@]*Plugin Name:(.*)$/im;
+			if (pluginNameRegex.test(fileContent)) {
+				return path.join(path.basename(projectPath), file);
+			}
+		}
+	}
+	return null;
+}

packages/wp-now/src/wp-playground-wordpress/index.ts

@@ -4,3 +4,5 @@ export * from './is-theme-directory';
 export * from './is-wp-content-directory';
 export * from './is-wordpress-directory';
 export * from './is-wordpress-develop-directory';
+export * from './get-plugin-file';
+export * from './read-file-head';

packages/wp-now/src/wp-playground-wordpress/is-plugin-directory.ts

@@ -1,5 +1,4 @@
-import fs from 'fs-extra';
-import path from 'path';
+import { getPluginFile } from './get-plugin-file';
 
 /**
  * Checks if the given path is a WordPress plugin.
@@ -8,17 +7,6 @@ import path from 'path';
  * @returns A boolean value indicating whether the project is a WordPress plugin.
  */
 export function isPluginDirectory(projectPath: string): Boolean {
-	const files = fs.readdirSync(projectPath);
-	for (const file of files) {
-		if (file.endsWith('.php')) {
-			const fileContent = fs.readFileSync(
-				path.join(projectPath, file),
-				'utf8'
-			);
-			if (fileContent.toLowerCase().includes('plugin name:')) {
-				return true;
-			}
-		}
-	}
-	return false;
+	const pluginFile = getPluginFile(projectPath);
+	return pluginFile !== null;
 }

packages/wp-now/src/wp-playground-wordpress/is-theme-directory.ts

@@ -1,5 +1,6 @@
 import fs from 'fs-extra';
 import path from 'path';
+import { readFileHead } from './read-file-head';
 
 /**
  * Checks if the given path is a WordPress theme directory.
@@ -12,9 +13,7 @@ export function isThemeDirectory(projectPath: string): Boolean {
 	if (!styleCSSExists) {
 		return false;
 	}
-	const styleCSS = fs.readFileSync(
-		path.join(projectPath, 'style.css'),
-		'utf-8'
-	);
-	return styleCSS.includes('Theme Name:');
+	const styleCSS = readFileHead(path.join(projectPath, 'style.css'));
+	const themeNameRegex = /^(?:[ \t]*<\?php)?[ \t/*#@]*Theme Name:(.*)$/im;
+	return themeNameRegex.test(styleCSS);
 }

packages/wp-now/src/wp-playground-wordpress/read-file-head.ts

@@ -0,0 +1,17 @@
+import fs from 'fs-extra';
+
+/**
+ *
+ * @param filePath The path to the file to read.
+ * @param length The number of bytes to read from the file. By default 8KB.
+ * @returns The first `length` bytes of the file as string.
+ * @see https://developer.wordpress.org/reference/functions/get_file_data/
+ */
+export function readFileHead(filePath: string, length = 8192) {
+	const buffer = Buffer.alloc(length);
+	const fd = fs.openSync(filePath, 'r');
+	fs.readSync(fd, buffer, 0, buffer.length, 0);
+	const fileContentBuffer = buffer.toString('utf8');
+	fs.closeSync(fd);
+	return fileContentBuffer.toString();
+}