Changeset 54671 for branches/6.1/tests/phpunit/tests/rest-api/rest-block-type-controller.php

Timestamp:

10/24/2022 02:30:20 PM (3 years ago)

Author:

Bernhard Reiter

Message:

Blocks: Allow arrays for deprecated asset types in block registration.

In register_block_type, continue to allow passing arrays as the editor_script, script, view_script, editor_style, and style arguments. Note that those fields were soft-deprecated in favor of their _handles counterparts in [54155], which would allow specifying multiple items. At the same time, the deprecated fields were limited to string or null.

However, this broke existing code that passed an array as one of those arguments. For backwards compatibility, this change thus restores the previous behavior. It is implemented in WP_Block_Type as a pair of __get() and __set() methods that wrap around the corresponding _handles members, which are arrays of strings.

It also affects the REST API endpoint for block types. The latter’s schema has never allowed for anything other than string or null for any of those fields. For this reason, it now returns the first element of the array stored in the corresponding _handles member in WP_Block_Type.

Follow-up [54155].
Props nendeb55, costdev, gziolo, spacedmonkey, mukesh27, sergeybiryukov, audrasjb.
Merges [54670] to the 6.1 branch.
Fixes #56707.

File:

• branches/6.1/tests/phpunit/tests/rest-api/rest-block-type-controller.php (modified) (1 diff)

branches/6.1/tests/phpunit/tests/rest-api/rest-block-type-controller.php

@@ -337 +337 @@
         $this->assertNull( $data['editor_style'] );
         $this->assertNull( $data['style'] );
+    }
+
+    /**
+     * @ticket 56733
+     */
+    public function test_get_item_deprecated() {
+        $block_type = 'fake/deprecated';
+        $settings   = array(
+            'editor_script' => 'hello_world',
+            'script'        => 'gutenberg',
+            'view_script'   => 'foo_bar',
+            'editor_style'  => 'guten_tag',
+            'style'         => 'out_of_style',
+        );
+        register_block_type( $block_type, $settings );
+        wp_set_current_user( self::$admin_id );
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/block-types/' . $block_type );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+        $this->assertSameSets(
+            array( 'hello_world' ),
+            $data['editor_script_handles'],
+            "Endpoint doesn't return correct array for editor_script_handles."
+        );
+        $this->assertSameSets(
+            array( 'gutenberg' ),
+            $data['script_handles'],
+            "Endpoint doesn't return correct array for script_handles."
+        );
+        $this->assertSameSets(
+            array( 'foo_bar' ),
+            $data['view_script_handles'],
+            "Endpoint doesn't return correct array for view_script_handles."
+        );
+        $this->assertSameSets(
+            array( 'guten_tag' ),
+            $data['editor_style_handles'],
+            "Endpoint doesn't return correct array for editor_style_handles."
+        );
+        $this->assertSameSets(
+            array( 'out_of_style' ),
+            $data['style_handles'],
+            "Endpoint doesn't return correct array for style_handles."
+        );
+        // Deprecated properties.
+        $this->assertSame(
+            'hello_world',
+            $data['editor_script'],
+            "Endpoint doesn't return correct string for editor_script."
+        );
+        $this->assertSame(
+            'gutenberg',
+            $data['script'],
+            "Endpoint doesn't return correct string for script."
+        );
+        $this->assertSame(
+            'foo_bar',
+            $data['view_script'],
+            "Endpoint doesn't return correct string for view_script."
+        );
+        $this->assertSame(
+            'guten_tag',
+            $data['editor_style'],
+            "Endpoint doesn't return correct string for editor_style."
+        );
+        $this->assertSame(
+            'out_of_style',
+            $data['style'],
+            "Endpoint doesn't return correct string for style."
+        );
+    }
+
+    /**
+     * @ticket 56733
+     */
+    public function test_get_item_deprecated_with_arrays() {
+        $block_type = 'fake/deprecated-with-arrays';
+        $settings   = array(
+            'editor_script' => array( 'hello', 'world' ),
+            'script'        => array( 'gutenberg' ),
+            'view_script'   => array( 'foo', 'bar' ),
+            'editor_style'  => array( 'guten', 'tag' ),
+            'style'         => array( 'out', 'of', 'style' ),
+        );
+        register_block_type( $block_type, $settings );
+        wp_set_current_user( self::$admin_id );
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/block-types/' . $block_type );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+        $this->assertSameSets(
+            $settings['editor_script'],
+            $data['editor_script_handles'],
+            "Endpoint doesn't return correct array for editor_script_handles."
+        );
+        $this->assertSameSets(
+            $settings['script'],
+            $data['script_handles'],
+            "Endpoint doesn't return correct array for script_handles."
+        );
+        $this->assertSameSets(
+            $settings['view_script'],
+            $data['view_script_handles'],
+            "Endpoint doesn't return correct array for view_script_handles."
+        );
+        $this->assertSameSets(
+            $settings['editor_style'],
+            $data['editor_style_handles'],
+            "Endpoint doesn't return correct array for editor_style_handles."
+        );
+        $this->assertSameSets(
+            $settings['style'],
+            $data['style_handles'],
+            "Endpoint doesn't return correct array for style_handles."
+        );
+        // Deprecated properties.
+        // Since the schema only allows strings or null (but no arrays), we return the first array item.
+        // Deprecated properties.
+        $this->assertSame(
+            'hello',
+            $data['editor_script'],
+            "Endpoint doesn't return first array element for editor_script."
+        );
+        $this->assertSame(
+            'gutenberg',
+            $data['script'],
+            "Endpoint doesn't return first array element for script."
+        );
+        $this->assertSame(
+            'foo',
+            $data['view_script'],
+            "Endpoint doesn't return first array element for view_script."
+        );
+        $this->assertSame(
+            'guten',
+            $data['editor_style'],
+            "Endpoint doesn't return first array element for editor_style."
+        );
+        $this->assertSame(
+            'out',
+            $data['style'],
+            "Endpoint doesn't return first array element for style."
+        );
     }