Changeset 48069 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-controller.php

Timestamp:

06/17/2020 03:20:02 AM (5 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Only register one block renderer route.

Every block has a different set of attributes. These attributes are specified as a JSON Schema object. Previously, every block registered its own block renderer route using its attributes for the schema. This allowed for the attributes to be validated using the built in endpoint validation rules. It had the unfortunate side effect, however, of creating a large number of nearly identical REST API routes, one for each dynamic block. Each registered route has a performance impact. As the number of server side blocks goes up, this becomes more and more of an issue.

Now, we register a single block renderer route and dynamically validate the attributes based on the selected block.

Fixes #48079.
Props gziolo, TimothyBlynJacobs.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-controller.php (modified) (2 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-controller.php

@@ -35 +35 @@
      */
     public function register_routes() {
-        $block_types = WP_Block_Type_Registry::get_instance()->get_all_registered();
-
-        foreach ( $block_types as $block_type ) {
-            if ( ! $block_type->is_dynamic() ) {
-                continue;
-            }
-
-            register_rest_route(
-                $this->namespace,
-                '/' . $this->rest_base . '/(?P<name>' . $block_type->name . ')',
+        register_rest_route(
+            $this->namespace,
+            '/' . $this->rest_base . '/(?P<name>[a-z0-9-]+/[a-z0-9-]+)',
+            array(
+                'args'   => array(
+                    'name' => array(
+                        'description' => __( 'Unique registered name for the block.' ),
+                        'type'        => 'string',
+                    ),
+                ),
                 array(
-                    'args'   => array(
-                        'name' => array(
-                            'description' => __( 'Unique registered name for the block.' ),
-                            'type'        => 'string',
+                    'methods'             => array( WP_REST_Server::READABLE, WP_REST_Server::CREATABLE ),
+                    'callback'            => array( $this, 'get_item' ),
+                    'permission_callback' => array( $this, 'get_item_permissions_check' ),
+                    'args'                => array(
+                        'context'    => $this->get_context_param( array( 'default' => 'view' ) ),
+                        'attributes' => array(
+                            'description'       => __( 'Attributes for the block' ),
+                            'type'              => 'object',
+                            'default'           => array(),
+                            'validate_callback' => static function ( $value, $request ) {
+                                $block = WP_Block_Type_Registry::get_instance()->get_registered( $request['name'] );
+
+                                if ( ! $block ) {
+                                    // This will get rejected in ::get_item().
+                                    return true;
+                                }
+
+                                $schema = array(
+                                    'type'                 => 'object',
+                                    'properties'           => $block->get_attributes(),
+                                    'additionalProperties' => false,
+                                );
+
+                                return rest_validate_value_from_schema( $value, $schema );
+                            },
+                        ),
+                        'post_id'    => array(
+                            'description' => __( 'ID of the post context.' ),
+                            'type'        => 'integer',
                         ),
                     ),
-                    array(
-                        'methods'             => array( WP_REST_Server::READABLE, WP_REST_Server::CREATABLE ),
-                        'callback'            => array( $this, 'get_item' ),
-                        'permission_callback' => array( $this, 'get_item_permissions_check' ),
-                        'args'                => array(
-                            'context'    => $this->get_context_param( array( 'default' => 'view' ) ),
-                            'attributes' => array(
-                                /* translators: %s: The name of the block. */
-                                'description'          => sprintf( __( 'Attributes for %s block' ), $block_type->name ),
-                                'type'                 => 'object',
-                                'additionalProperties' => false,
-                                'properties'           => $block_type->get_attributes(),
-                                'default'              => array(),
-                            ),
-                            'post_id'    => array(
-                                'description' => __( 'ID of the post context.' ),
-                                'type'        => 'integer',
-                            ),
-                        ),
-                    ),
-                    'schema' => array( $this, 'get_public_item_schema' ),
-                )
-            );
-        }
+                ),
+                'schema' => array( $this, 'get_public_item_schema' ),
+            )
+        );
     }
 
@@ -137 +142 @@
             setup_postdata( $post );
         }
-        $registry = WP_Block_Type_Registry::get_instance();
-
-        if ( null === $registry->get_registered( $request['name'] ) ) {
+
+        $registry   = WP_Block_Type_Registry::get_instance();
+        $registered = $registry->get_registered( $request['name'] );
+
+        if ( null === $registered || ! $registered->is_dynamic() ) {
             return new WP_Error(
                 'block_invalid',