Document more TODOs

Author: adamziel

components/Blueprints/Runner.php

@@ -213,6 +213,7 @@ private function validateBlueprint(): void {
 		$v        = new Validator();
 		$is_valid = $v->validate( $this->blueprintArray );
 		if ( ! $is_valid ) {
+			print_r( $v->get_errors() );
 			throw new \Exception( 'Blueprint is invalid' );
 		}
 

components/Blueprints/SiteResolver/NewSiteResolver.php

@@ -184,6 +184,8 @@ static private function resolveWordPressZipUrl( Client $client, ?VersionConstrai
 			return 'https://wordpress.org/nightly-builds/wordpress-latest.zip';
 		}
 
+		// @TODO Support version numbers like 6.5.1 that don't show up in the default API response.
+		//       Use query params for filtering somehow?
 		$latestVersions = $client->fetch( 'https://api.wordpress.org/core/version-check/1.7/?channel=beta' )->json();
 		$latestVersions = array_filter( $latestVersions['offers'], function ( $v ) {
 			return $v['response'] === 'autoupdate';

components/Blueprints/VersionConstraint.php

@@ -39,7 +39,17 @@ public function satisfiedBy( string $version ): bool {
 			}
 		}
 		if ( $this->max !== null ) {
-			if ( version_compare( $version, $this->max, '>' ) ) {
+			// If max is set to 6.4 and the actual version is 6.4.1, we should still return true.
+			// To limit the minor version number, the user must specify it explicitly.
+			// @TODO: Don't append .999999. That's a hack. Consider all possible
+			//        WordPress and PHP version number strings and find a way of
+			//        meaningfully comparing them (or throw a warning if no meaningful
+			//        comparison can be made).
+			$max = $this->max;
+			if ( preg_match( '/^[0-9]+\.[0-9]+$/', $max ) ) {
+				$max = $max . '.999999';
+			}
+			if ( version_compare( $version, $max, '>' ) ) {
 				return false;
 			}
 		}

try-blueprints.php

@@ -1,14 +1,19 @@
 <?php
 
 /**
- * @TODO: Fast unzipping of remote Zip Files by iterating over the entries
- *        instead of skipping over to the end central directory index entry.
- * @TODO: Processing Zip Files without the Content-Length header.
- * @TODO: HTTP Cache support for remote files.
- * @TODO: Restrictions on supported step types, media files types, SQL queries types, etc.
+ * @TODO: A large test suite.
+ * @TODO: Client HTTP queue deadlock when we enqueued a lot of requests and need to fetch a small
+ *        ad-hoc resource such as a JSON list of translations.
+ * @TODO: Exception structure?
+ * @TODO: Blueprint JSON validation.
+ * @TODO: Support Zip Files without the Content-Length header.
  * @TODO: Add importMedia step to the specification.
  * @TODO: How to handle the default WordPress theme? Should it be preserved for new sites?
  *        What if we want to remove it? And what should be the semantics for existing sites?
+ * @TODO: Production-grade HTTP Cache support for remote files. Not the stopgap we have now.
+ * @TODO (low priority): Restrictions on supported step types, media files types, SQL queries types, etc.
+ * @TODO (low priority): Fast unzipping of remote Zip Files by iterating over the entries
+ *        instead of skipping over to the end central directory index entry.
  */
 
 namespace WordPress\Blueprints\Steps;
@@ -33,6 +38,13 @@
 		"themes" => [
 			"adventurer"
 		],
+		"wordpressVersion" => "6.5",
+		"phpVersion" => [
+			"min" => "8.0",
+			"max" => "8.4",
+			"recommended" => "8.2"
+		],
+		"activeTheme" => "twentytwentyfour",
 		"blueprintMeta" => [
 			"name" => "Full Featured Blueprint",
 			"description" => "A blueprint demonstrating most of the available features",
@@ -53,6 +65,39 @@
 				"supports" => ["title", "editor", "author", "thumbnail", "excerpt", "comments"]
 			]
 		],
+		// "muPlugins" => [
+		// 	"0-test" => [
+		// 		"filename" => "0-test.php",
+		// 		"content" => "<?php
+		// 			echo 'test';
+		// 		? >"
+		// 	]
+		// ],
+		"users" => [
+			[
+				"username" => "admin",
+				"password" => "password",
+				"email" => "adam@example.com",
+				"role" => "adamadamin"
+			]
+		],
+		"roles" => [
+			[
+				"name" => "adamadamin",
+				// @TODO: What's the correct way to set capabilities?
+				"capabilities" => ["manage_options"=>"manage_options"]
+			]
+		],
+		"siteOptions" => [
+			"blogname" => "Blueprint Demo Site",
+			"timezone_string" => "America/New_York",
+			"permalink_structure" => "/%year%/%monthnum%/%postname%/"
+		],
+		"siteLanguage" => "en_US",
+		"constants" => [
+			"WP_DEBUG" => true,
+			"SCRIPT_DEBUG" => true
+		],
 		"media" => [
 			"https://wordpress.org/files/2024/10/design-visual-6-7.png",
             [