<!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>[49537] trunk/src: Site Health: Validate the test result data format in JS before using it.</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/49537">49537</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/49537","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-11-08 09:50:07 +0000 (Sun, 08 Nov 2020)</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'>Site Health: Validate the test result data format in JS before using it.

This will discard any invalid responses instead of causing fatal errors.

It also makes badges optional, on the same basis as actions are optional. They are expected, but there may be situations where they are not present.

Props Clorith, dogwithblog, kraftbj, whyisjake, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/50145">#50145</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjs_enqueuesadminsitehealthjs">trunk/src/js/_enqueues/admin/site-health.js</a></li>
<li><a href="#trunksrcwpadminsitehealthphp">trunk/src/wp-admin/site-health.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjs_enqueuesadminsitehealthjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/_enqueues/admin/site-health.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/_enqueues/admin/site-health.js       2020-11-07 21:57:54 UTC (rev 49536)
+++ trunk/src/js/_enqueues/admin/site-health.js 2020-11-08 09:50:07 UTC (rev 49537)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,6 +66,57 @@
</span><span class="cx" style="display: block; padding: 0 10px">        } );
</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">+         * Validates the Site Health test result format.
+        *
+        * @since 5.6.0
+        *
+        * @param {Object} issue
+        *
+        * @return {boolean}
+        */
+       function validateIssueData( issue ) {
+               // Expected minimum format of a valid SiteHealth test response.
+               var minimumExpected = {
+                               test: 'string',
+                               label: 'string',
+                               description: 'string'
+                       },
+                       passed = true,
+                       key, value, subKey, subValue;
+
+               // If the issue passed is not an object, return a `false` state early.
+               if ( 'object' !== typeof( issue ) ) {
+                       return false;
+               }
+
+               // Loop over expected data and match the data types.
+               for ( key in minimumExpected ) {
+                       value = minimumExpected[ key ];
+
+                       if ( 'object' === typeof( value ) ) {
+                               for ( subKey in value ) {
+                                       subValue = value[ subKey ];
+
+                                       if ( 'undefined' === typeof( issue[ key ] ) ||
+                                               'undefined' === typeof( issue[ key ][ subKey ] ) ||
+                                               subValue !== typeof( issue[ key ][ subKey ] )
+                                       ) {
+                                               passed = false;
+                                       }
+                               }
+                       } else {
+                               if ( 'undefined' === typeof( issue[ key ] ) ||
+                                       value !== typeof( issue[ key ] )
+                               ) {
+                                       passed = false;
+                               }
+                       }
+               }
+
+               return passed;
+       }
+
+       /**
</ins><span class="cx" style="display: block; padding: 0 10px">          * Appends a new issue to the issue list.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 5.2.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -78,6 +129,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        heading,
</span><span class="cx" style="display: block; padding: 0 10px">                        count;
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                /*
+                * Validate the issue data format before using it.
+                * If the output is invalid, discard it.
+                */
+               if ( ! validateIssueData( issue ) ) {
+                       return false;
+               }
+
</ins><span class="cx" style="display: block; padding: 0 10px">                 SiteHealth.site_status.issues[ issue.status ]++;
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                count = SiteHealth.site_status.issues[ issue.status ];
</span></span></pre></div>
<a id="trunksrcwpadminsitehealthphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/site-health.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/site-health.php        2020-11-07 21:57:54 UTC (rev 49536)
+++ trunk/src/wp-admin/site-health.php  2020-11-08 09:50:07 UTC (rev 49537)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -144,7 +144,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">        <h4 class="health-check-accordion-heading">
</span><span class="cx" style="display: block; padding: 0 10px">                <button aria-expanded="false" class="health-check-accordion-trigger" aria-controls="health-check-accordion-block-{{ data.test }}" type="button">
</span><span class="cx" style="display: block; padding: 0 10px">                        <span class="title">{{ data.label }}</span>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        <span class="badge {{ data.badge.color }}">{{ data.badge.label }}</span>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 <# if ( data.badge ) { #>
+                               <span class="badge {{ data.badge.color }}">{{ data.badge.label }}</span>
+                       <# } #>
</ins><span class="cx" style="display: block; padding: 0 10px">                         <span class="icon"></span>
</span><span class="cx" style="display: block; padding: 0 10px">                </button>
</span><span class="cx" style="display: block; padding: 0 10px">        </h4>
</span></span></pre>
</div>
</div>

</body>
</html>