Changeset 57843

Timestamp:

03/15/2024 02:57:47 PM (5 months ago)

Author:

swissspidy

Message:

Interactivity API: Do not print state if it’s an empty array.

This prunes stores and configurations that are empty arrays, as stores are expected to be JSON objects.
By not printing empty configurations, less redundant data is serialized into the HTML.

Reviewed by gziolo.
Merges [57841] to the to the 6.5 branch.

Props jonsurrell, luisherranz, darerodz, gziolo, swissspidy.
Fixes #60761.

Location:

branches/6.5

Files:

• . (modified) (1 prop)
• src/wp-includes/interactivity-api/class-wp-interactivity-api.php (modified) (1 diff)
• tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php (modified) (1 diff)

branches/6.5/src/wp-includes/interactivity-api/class-wp-interactivity-api.php

@@ -141 +141 @@
      */
     public function print_client_interactivity_data() {
-        $store      = array();
-        $has_state  = ! empty( $this->state_data );
-        $has_config = ! empty( $this->config_data );
-
-        if ( $has_state || $has_config ) {
-            if ( $has_config ) {
-                $store['config'] = $this->config_data;
-            }
-            if ( $has_state ) {
-                $store['state'] = $this->state_data;
-            }
+        if ( empty( $this->state_data ) && empty( $this->config_data ) ) {
+            return;
+        }
+
+        $interactivity_data = array();
+
+        $config = array();
+        foreach ( $this->config_data as $key => $value ) {
+            if ( ! empty( $value ) ) {
+                $config[ $key ] = $value;
+            }
+        }
+        if ( ! empty( $config ) ) {
+            $interactivity_data['config'] = $config;
+        }
+
+        $state = array();
+        foreach ( $this->state_data as $key => $value ) {
+            if ( ! empty( $value ) ) {
+                $state[ $key ] = $value;
+            }
+        }
+        if ( ! empty( $state ) ) {
+            $interactivity_data['state'] = $state;
+        }
+
+        if ( ! empty( $interactivity_data ) ) {
             wp_print_inline_script_tag(
                 wp_json_encode(
-                    $store,
+                    $,
                     JSON_HEX_TAG | JSON_HEX_AMP
                 ),

branches/6.5/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php

@@ -237 +237 @@
     }
 
-
+    /**
+     * Tests that empty state objects are pruned from printed data.
+     *
+     * @ticket 60761
+     *
+     * @covers ::print_client_interactivity_data
+     */
+    public function test_state_not_printed_when_empty_array() {
+        $this->interactivity->state( 'pluginWithEmptyState_prune', array() );
+        $this->interactivity->state( 'pluginWithState_include', array( 'value' => 'excellent' ) );
+        $printed_script = get_echo( array( $this->interactivity, 'print_client_interactivity_data' ) );
+        $expected       = <<<'SCRIPT_TAG'
+<script type="application/json" id="wp-interactivity-data">
+{"state":{"pluginWithState_include":{"value":"excellent"}}}
+</script>
+
+SCRIPT_TAG;
+
+        $this->assertSame( $expected, $printed_script );
+    }
+
+    /**
+     * Tests that data consisting of only empty state objects is not printed.
+     *
+     * @ticket 60761
+     *
+     * @covers ::print_client_interactivity_data
+     */
+    public function test_state_not_printed_when_only_empty_arrays() {
+        $this->interactivity->state( 'pluginWithEmptyState_prune', array() );
+        $printed_script = get_echo( array( $this->interactivity, 'print_client_interactivity_data' ) );
+        $this->assertSame( '', $printed_script );
+    }
+
+    /**
+     * Tests that nested empty state objects are printed correctly.
+     *
+     * @ticket 60761
+     *
+     * @covers ::print_client_interactivity_data
+     */
+    public function test_state_printed_correctly_with_nested_empty_array() {
+        $this->interactivity->state( 'myPlugin', array( 'emptyArray' => array() ) );
+        $printed_script = get_echo( array( $this->interactivity, 'print_client_interactivity_data' ) );
+        $expected       = <<<'SCRIPT_TAG'
+<script type="application/json" id="wp-interactivity-data">
+{"state":{"myPlugin":{"emptyArray":[]}}}
+</script>
+
+SCRIPT_TAG;
+
+        $this->assertSame( $expected, $printed_script );
+    }
+
+    /**
+     * Tests that empty config objects are pruned from printed data.
+     *
+     * @ticket 60761
+     *
+     * @covers ::print_client_interactivity_data
+     */
+    public function test_config_not_printed_when_empty_array() {
+        $this->interactivity->config( 'pluginWithEmptyConfig_prune', array() );
+        $this->interactivity->config( 'pluginWithConfig_include', array( 'value' => 'excellent' ) );
+        $printed_script = get_echo( array( $this->interactivity, 'print_client_interactivity_data' ) );
+        $expected       = <<<'SCRIPT_TAG'
+<script type="application/json" id="wp-interactivity-data">
+{"config":{"pluginWithConfig_include":{"value":"excellent"}}}
+</script>
+
+SCRIPT_TAG;
+
+        $this->assertSame( $expected, $printed_script );
+    }
+
+    /**
+     * Tests that data consisting of only empty config objects is not printed.
+     *
+     * @ticket 60761
+     *
+     * @covers ::print_client_interactivity_data
+     */
+    public function test_config_not_printed_when_only_empty_arrays() {
+        $this->interactivity->config( 'pluginWithEmptyConfig_prune', array() );
+        $printed_script = get_echo( array( $this->interactivity, 'print_client_interactivity_data' ) );
+        $this->assertSame( '', $printed_script );
+    }
+
+    /**
+     * Tests that nested empty config objects are printed correctly.
+     *
+     * @ticket 60761
+     *
+     * @covers ::print_client_interactivity_data
+     */
+    public function test_config_printed_correctly_with_nested_empty_array() {
+        $this->interactivity->config( 'myPlugin', array( 'emptyArray' => array() ) );
+        $printed_script = get_echo( array( $this->interactivity, 'print_client_interactivity_data' ) );
+        $expected       = <<<'SCRIPT_TAG'
+<script type="application/json" id="wp-interactivity-data">
+{"config":{"myPlugin":{"emptyArray":[]}}}
+</script>
+
+SCRIPT_TAG;
+
+        $this->assertSame( $expected, $printed_script );
+    }
 
     /**