<!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>[49232] trunk/src/wp-admin/includes/class-wp-site-health.php: Site Health: Improve the reliability of asynchronous tests.</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/49232">49232</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/49232","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-10-20 14:48:50 +0000 (Tue, 20 Oct 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: Improve the reliability of asynchronous tests.

This change adds additional logic to catch HTTP failures that do not return a `WP_Error` object (for example, a wp-json REST API error error).

This also fixes instances where REST API callbacks performed from cron do not work due to a lack of authentication by introducing a direct callback route that asynchronous tests can register.

Props dd32, clorith, timothyblynjacobs.
Fixes <a href="https://core.trac.wordpress.org/ticket/51547">#51547</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpsitehealthphp">trunk/src/wp-admin/includes/class-wp-site-health.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpsitehealthphp"></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/includes/class-wp-site-health.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-site-health.php      2020-10-20 14:39:49 UTC (rev 49231)
+++ trunk/src/wp-admin/includes/class-wp-site-health.php        2020-10-20 14:48:50 UTC (rev 49232)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2155,19 +2155,22 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        ),
</span><span class="cx" style="display: block; padding: 0 10px">                        'async'  => array(
</span><span class="cx" style="display: block; padding: 0 10px">                                'dotorg_communication' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                        'label'    => __( 'Communication with WordPress.org' ),
-                                       'test'     => rest_url( 'wp-site-health/v1/tests/dotorg-communication' ),
-                                       'has_rest' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                 'label'             => __( 'Communication with WordPress.org' ),
+                                       'test'              => rest_url( 'wp-site-health/v1/tests/dotorg-communication' ),
+                                       'has_rest'          => true,
+                                       'async_direct_test' => array( WP_Site_Health::get_instance(), 'get_test_dotorg_communication' ),
</ins><span class="cx" style="display: block; padding: 0 10px">                                 ),
</span><span class="cx" style="display: block; padding: 0 10px">                                'background_updates'   => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                        'label'    => __( 'Background updates' ),
-                                       'test'     => rest_url( 'wp-site-health/v1/tests/background-updates' ),
-                                       'has_rest' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                 'label'             => __( 'Background updates' ),
+                                       'test'              => rest_url( 'wp-site-health/v1/tests/background-updates' ),
+                                       'has_rest'          => true,
+                                       'async_direct_test' => array( WP_Site_Health::get_instance(), 'get_test_background_updates' ),
</ins><span class="cx" style="display: block; padding: 0 10px">                                 ),
</span><span class="cx" style="display: block; padding: 0 10px">                                'loopback_requests'    => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                        'label'    => __( 'Loopback request' ),
-                                       'test'     => rest_url( 'wp-site-health/v1/tests/loopback-requests' ),
-                                       'has_rest' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                 'label'             => __( 'Loopback request' ),
+                                       'test'              => rest_url( 'wp-site-health/v1/tests/loopback-requests' ),
+                                       'has_rest'          => true,
+                                       'async_direct_test' => array( WP_Site_Health::get_instance(), 'get_test_loopback_requests' ),
</ins><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2204,10 +2207,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">                 *         Plugins and themes are encouraged to prefix test identifiers with their slug
</span><span class="cx" style="display: block; padding: 0 10px">                 *         to avoid any collisions between tests.
</span><span class="cx" style="display: block; padding: 0 10px">                 *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                 *         @type string  $label       A friendly label for your test to identify it by.
-                *         @type mixed   $test        A callable to perform a direct test, or a string AJAX action to be
-                *                                    called to perform an async test.
-                *         @type boolean $has_rest    Optional. Denote if `$test` has a REST API endpoint.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+          *         @type string   $label              A friendly label for your test to identify it by.
+                *         @type mixed    $test               A callable to perform a direct test, or a string AJAX action to be
+                *                                            called to perform an async test.
+                *         @type boolean  $has_rest           Optional. Denote if `$test` has a REST API endpoint.
+                *         @type callable $async_direct_test  A manner of directly calling the test marked as asynchronous, as
+                *                                            the scheduled event can not authenticate, and endpoints may require
+                *                                            authentication.
</ins><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2550,10 +2556,18 @@
</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">                foreach ( $tests['async'] as $test ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                        // Local endpoints may require authentication, so asynchronous tests can pass a direct test runner as well.
+                       if ( ! empty( $test['async_direct_test'] ) && is_callable( $test['async_direct_test'] ) ) {
+                               // This test is callable, do so and continue to the next asynchronous check.
+                               $results[] = $this->perform_test( $test['async_direct_test'] );
+                               continue;
+                       }
+
</ins><span class="cx" style="display: block; padding: 0 10px">                         if ( is_string( $test['test'] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                // Check if this test has a REST API endpoint.
</ins><span class="cx" style="display: block; padding: 0 10px">                                 if ( isset( $test['has_rest'] ) && $test['has_rest'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                        $result_fetch = wp_remote_post(
-                                               rest_url( $test['test'] ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                 $result_fetch = wp_remote_get(
+                                               $test['test'],
</ins><span class="cx" style="display: block; padding: 0 10px">                                                 array(
</span><span class="cx" style="display: block; padding: 0 10px">                                                        'body' => array(
</span><span class="cx" style="display: block; padding: 0 10px">                                                                '_wpnonce' => wp_create_nonce( 'wp_rest' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2572,7 +2586,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                if ( ! is_wp_error( $result_fetch ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         if ( ! is_wp_error( $result_fetch ) && 200 === wp_remote_retrieve_response_code( $result_fetch ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px">                                         $result = json_decode( wp_remote_retrieve_body( $result_fetch ), true );
</span><span class="cx" style="display: block; padding: 0 10px">                                } else {
</span><span class="cx" style="display: block; padding: 0 10px">                                        $result = false;
</span></span></pre>
</div>
</div>

</body>
</html>