<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[57843] branches/6.5/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php: Interactivity API: Do not print state if it's an empty array.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/57843">57843</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/57843","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-03-15 14:57:47 +0000 (Fri, 15 Mar 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/changeset/57841">[57841]</a> to the to the 6.5 branch.
Props jonsurrell, luisherranz, darerodz, gziolo, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/60761">#60761</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches65srcwpincludesinteractivityapiclasswpinteractivityapiphp">branches/6.5/src/wp-includes/interactivity-api/class-wp-interactivity-api.php</a></li>
<li><a href="#branches65testsphpunittestsinteractivityapiwpInteractivityAPIphp">branches/6.5/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches65">branches/6.5/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/6.5
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/6.5 2024-03-15 13:38:36 UTC (rev 57842)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/6.5 2024-03-15 14:57:47 UTC (rev 57843)
</ins><a id="branches65"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/6.5</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.8:51889
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:57791-57792,57804-57806,57809,57814,57817,57824,57826-57827,57831-57832,57835
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:57791-57792,57804-57806,57809,57814,57817,57824,57826-57827,57831-57832,57835,57841
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches65srcwpincludesinteractivityapiclasswpinteractivityapiphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.5/src/wp-includes/interactivity-api/class-wp-interactivity-api.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.5/src/wp-includes/interactivity-api/class-wp-interactivity-api.php 2024-03-15 13:38:36 UTC (rev 57842)
+++ branches/6.5/src/wp-includes/interactivity-api/class-wp-interactivity-api.php 2024-03-15 14:57:47 UTC (rev 57843)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -140,20 +140,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function print_client_interactivity_data() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $store = array();
- $has_state = ! empty( $this->state_data );
- $has_config = ! empty( $this->config_data );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $this->state_data ) && empty( $this->config_data ) ) {
+ return;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $has_state || $has_config ) {
- if ( $has_config ) {
- $store['config'] = $this->config_data;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $interactivity_data = array();
+
+ $config = array();
+ foreach ( $this->config_data as $key => $value ) {
+ if ( ! empty( $value ) ) {
+ $config[ $key ] = $value;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $has_state ) {
- $store['state'] = $this->state_data;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
+ if ( ! empty( $config ) ) {
+ $interactivity_data['config'] = $config;
+ }
+
+ $state = array();
+ foreach ( $this->state_data as $key => $value ) {
+ if ( ! empty( $value ) ) {
+ $state[ $key ] = $value;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
+ if ( ! empty( $state ) ) {
+ $interactivity_data['state'] = $state;
+ }
+
+ if ( ! empty( $interactivity_data ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_print_inline_script_tag(
</span><span class="cx" style="display: block; padding: 0 10px"> wp_json_encode(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $store,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $interactivity_data,
</ins><span class="cx" style="display: block; padding: 0 10px"> JSON_HEX_TAG | JSON_HEX_AMP
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre></div>
<a id="branches65testsphpunittestsinteractivityapiwpInteractivityAPIphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.5/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.5/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php 2024-03-15 13:38:36 UTC (rev 57842)
+++ branches/6.5/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php 2024-03-15 14:57:47 UTC (rev 57843)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -236,9 +236,115 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( 'config' => array( 'myPlugin' => array( 'a' => 1 ) ) ), $result );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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>
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+SCRIPT_TAG;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( $expected, $printed_script );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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 );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Tests that special characters in the initial state and configuration are
</span><span class="cx" style="display: block; padding: 0 10px"> * properly escaped.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre>
</div>
</div>
</body>
</html>