include possible meta keys and taxonomies on the schema

Author: jorgefilipecosta

src/wp-includes/abilities/class-wp-post-type-abilities.php

@@ -143,11 +143,11 @@ private static function build_get_input_schema( WP_Post_Type $post_type_object )
 		$query_properties = array(
 			'tax'  => self::build_query_group_schema(
 				__( 'Taxonomy query to filter posts by taxonomy terms.' ),
-				self::build_tax_clause_schema()
+				self::build_tax_clause_schema( $slug )
 			),
 			'meta' => self::build_query_group_schema(
 				__( 'Meta query to filter posts by post meta values.' ),
-				self::build_meta_clause_schema()
+				self::build_meta_clause_schema( $slug )
 			),
 			'date' => self::build_date_query_schema(),
 		);
@@ -310,17 +310,25 @@ private static function build_query_group_schema( string $description, array $le
 	 *
 	 * @since 7.0.0
 	 *
+	 * @param string $post_type_slug The post type slug.
 	 * @return array The JSON schema for a taxonomy query clause.
 	 */
-	private static function build_tax_clause_schema(): array {
+	private static function build_tax_clause_schema( string $post_type_slug ): array {
+		$allowed_taxonomies = self::get_allowed_taxonomies( $post_type_slug );
+
+		$taxonomy_schema = array(
+			'type'        => 'string',
+			'description' => __( 'Taxonomy slug to query.' ),
+		);
+		if ( ! empty( $allowed_taxonomies ) ) {
+			$taxonomy_schema['enum'] = $allowed_taxonomies;
+		}
+
 		return array(
 			'type'                 => 'object',
 			'required'             => array( 'taxonomy', 'terms' ),
 			'properties'           => array(
-				'taxonomy'         => array(
-					'type'        => 'string',
-					'description' => __( 'Taxonomy slug to query.' ),
-				),
+				'taxonomy'         => $taxonomy_schema,
 				'terms'            => array(
 					'type'        => 'array',
 					'description' => __( 'Taxonomy terms to match.' ),
@@ -352,17 +360,25 @@ private static function build_tax_clause_schema(): array {
 	 *
 	 * @since 7.0.0
 	 *
+	 * @param string $post_type_slug The post type slug.
 	 * @return array The JSON schema for a meta query clause.
 	 */
-	private static function build_meta_clause_schema(): array {
+	private static function build_meta_clause_schema( string $post_type_slug ): array {
+		$allowed_meta_keys = self::get_allowed_meta_keys( $post_type_slug );
+
+		$key_schema = array(
+			'type'        => 'string',
+			'description' => __( 'Meta key to query.' ),
+		);
+		if ( ! empty( $allowed_meta_keys ) ) {
+			$key_schema['enum'] = $allowed_meta_keys;
+		}
+
 		return array(
 			'type'                 => 'object',
 			'required'             => array( 'key' ),
 			'properties'           => array(
-				'key'     => array(
-					'type'        => 'string',
-					'description' => __( 'Meta key to query.' ),
-				),
+				'key'     => $key_schema,
 				'value'   => array(
 					'type'        => array( 'string', 'integer', 'array' ),
 					'description' => __( 'Meta value to match. Use an array for BETWEEN, NOT BETWEEN, IN, and NOT IN comparisons.' ),

tests/phpunit/tests/abilities-api/wpPostTypeAbilitiesRest.php

@@ -45,6 +45,14 @@ class Tests_Abilities_API_WpPostTypeAbilitiesRest extends WP_Test_REST_TestCase
 	 * @param WP_UnitTest_Factory $factory Test factory.
 	 */
 	public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ): void {
+		// Unregister any existing abilities and categories to start fresh.
+		foreach ( wp_get_abilities() as $ability ) {
+			wp_unregister_ability( $ability->get_name() );
+		}
+		foreach ( wp_get_ability_categories() as $category ) {
+			wp_unregister_ability_category( $category->get_slug() );
+		}
+
 		// Ensure core abilities are registered.
 		remove_action( 'wp_abilities_api_categories_init', '_unhook_core_ability_categories_registration', 1 );
 		remove_action( 'wp_abilities_api_init', '_unhook_core_abilities_registration', 1 );
@@ -198,6 +206,43 @@ public function set_up(): void {
 				'show_in_abilities' => true,
 			)
 		);
+
+		// Unregister all existing abilities so we can re-register with updated schema.
+		foreach ( wp_get_abilities() as $ability ) {
+			wp_unregister_ability( $ability->get_name() );
+		}
+
+		// Remove core abilities registration to prevent ALL abilities from being registered
+		// when we only want to re-register post type abilities with updated schema.
+		remove_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
+
+		// Simulate the init action to allow re-registration without "doing it wrong" warning.
+		$this->simulate_doing_wp_abilities_init_action();
+
+		// Re-register all post type abilities so the schema includes the meta keys enum.
+		WP_Post_Type_Abilities::register();
+
+		// Clean up the simulated action.
+		$this->end_simulated_wp_abilities_init_action();
+	}
+
+	/**
+	 * Simulates the `wp_abilities_api_init` action.
+	 *
+	 * This makes `doing_action('wp_abilities_api_init')` return true without
+	 * firing all hooks registered on that action.
+	 */
+	private function simulate_doing_wp_abilities_init_action(): void {
+		global $wp_current_filter;
+		$wp_current_filter[] = 'wp_abilities_api_init';
+	}
+
+	/**
+	 * Ends the simulated `wp_abilities_api_init` action.
+	 */
+	private function end_simulated_wp_abilities_init_action(): void {
+		global $wp_current_filter;
+		array_pop( $wp_current_filter );
 	}
 
 	/**
@@ -628,7 +673,8 @@ public function test_meta_query_with_invalid_key_returns_error(): void {
 		$this->assertSame( 400, $response->get_status() );
 
 		$data = $response->get_data();
-		$this->assertSame( 'invalid_meta_key', $data['code'] );
+		// Schema validation catches invalid meta keys.
+		$this->assertSame( 'ability_invalid_input', $data['code'] );
 	}
 
 	/**
@@ -692,7 +738,8 @@ public function test_tax_query_with_non_public_taxonomy_returns_error(): void {
 		$this->assertSame( 400, $response->get_status() );
 
 		$data = $response->get_data();
-		$this->assertSame( 'invalid_taxonomy', $data['code'] );
+		// Schema validation catches non-public taxonomies.
+		$this->assertSame( 'ability_invalid_input', $data['code'] );
 
 		// Clean up.
 		unregister_taxonomy( 'private_tax' );