Blueprints: wp-cli step

[adamziel]

Adds a new step to the blueprints that allows to run WP-CLI commands.

Example:

{
	"landingPage": "/wp-admin/post.php",
	"login": true,
	"steps": [
		{
			"step": "wp-cli",
			"command": "wp post create --post_title='Test post' --post_excerpt='Some content' --no-color"
		}
	]
}

The command may also be an array of strings to ease dealing with quotes:

{
    "landingPage": "/wp-admin/post.php",
    "login": true,
    "steps": [
        {
            "step": "wp-cli",
            "command": ["wp", "post", "create", "--post_title=Test post", "--post_excerpt=Some content", "--no-color"]
        }
    ]
}

Trade-offs

• WP-CLI requires ~7MB of additional downloads: 1.4MB for the compressed WP-CLI.phar, and 5.6MB for the kitchen-sink PHP extensions bundle.

Implementation

• Whenever the Blueprints compiler finds a wp-cli step, it:
  • Downloads the wp-cli.phar file
  • Forces the kitchen-sink PHP extensions bundle as WP-CLI requires mbstring and iconv
• wp-cli.phar is shipped from playground.wordpress.net. Downloading the official release from raw.githubusercontent.com transfers 7MB, while downloading the pre-compressed version from playground.wordpress.net only transfers 1.4MB.
• playground.wordpress.net now always sets the PHP_SAPI constant to cli to ensure this check in WP-CLI passes: https://github.com/wp-cli/wp-cli-bundle/blob/970d0d4c22d4a89ca890def26ec82e559625abc6/php/boot-phar.php#L3-L10

Future work

• Minify wp-cli.phar to reduce its size even further. We can remove redundant whitespaces and comments, remove the JavaScript parser library that is unlikely to be useful in Playground, remove parts of the Composer library, and perhaps more. cc @schlessera @swissspidy @danielbachhuber
• Move the hardcoded WP-CLI-related parts of the Blueprint compile() function into a separate, modular function associated with the wp-cli step.

Testing instructions

• Confirm the CI checks pass
• Run the local dev server, click here, and confirm that a new post is created in the WordPress admin.

CC @dmsnell @bgrgicak @sejas @eliot-akira

[adamziel]

Let's only trigger this request if wp-cli.phar doesn't yet exist in VFS, or else running this Blueprint step in wp-now will always trigger fetch().

[adamziel]

The step works on the web. Let's figure out node.js in a follow-up PR.

[bgrgicak]

Great work on getting this out so fast!