Changeset 48069 for trunk/tests/phpunit/tests/rest-api/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/tests/phpunit/tests/rest-api/rest-block-renderer-controller.php (modified) (7 diffs)

trunk/tests/phpunit/tests/rest-api/rest-block-renderer-controller.php

@@ -48 +48 @@
 
     /**
+     * Non dynamic block name.
+     *
+     * @since 5.5.0
+     *
+     * @var string
+     */
+    protected static $non_dynamic_block_name = 'core/non-dynamic';
+
+    /**
      * Test API user's ID.
      *
@@ -118 +127 @@
         $this->register_test_block();
         $this->register_post_context_test_block();
+        $this->register_non_dynamic_block();
         parent::setUp();
     }
@@ -129 +139 @@
         WP_Block_Type_Registry::get_instance()->unregister( self::$block_name );
         WP_Block_Type_Registry::get_instance()->unregister( self::$context_block_name );
+        WP_Block_Type_Registry::get_instance()->unregister( self::$non_dynamic_block_name );
         parent::tearDown();
     }
@@ -177 +188 @@
 
     /**
+     * Registers the non-dynamic block name.
+     *
+     * @since 5.5.0
+     */
+    protected function register_non_dynamic_block() {
+        register_block_type( self::$non_dynamic_block_name );
+    }
+
+    /**
      * Test render callback.
      *
@@ -211 +231 @@
 
         $routes = rest_get_server()->get_routes();
-        foreach ( $dynamic_block_names as $dynamic_block_name ) {
-            $this->assertArrayHasKey( self::$rest_api_route . "(?P<name>$dynamic_block_name)", $routes );
-        }
+        $this->assertArrayHasKey( self::$rest_api_route . '(?P<name>[a-z0-9-]+/[a-z0-9-]+)', $routes );
     }
 
@@ -262 +280 @@
         $response = rest_get_server()->dispatch( $request );
 
-        $this->assertErrorResponse( 'rest_no_route', $response, 404 );
+        $this->assertErrorResponse( 'block_invalid', $response, 404 );
     }
 
@@ -512 +530 @@
 
     /**
+     * @ticket 48079
+     */
+    public function test_get_item_non_dynamic_block() {
+        wp_set_current_user( self::$user_id );
+        $request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$non_dynamic_block_name );
+
+        $request->set_param( 'context', 'edit' );
+        $response = rest_get_server()->dispatch( $request );
+
+        $this->assertErrorResponse( 'block_invalid', $response, 404 );
+    }
+
+    /**
      * Get item schema.
      *