<!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>[10293] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/libs/site-search/jetpack-search.php: Plugin Directory: Search: Retry search queries when a API->ES timeout is encountered.</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="http://meta.trac.wordpress.org/changeset/10293">10293</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/10293","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-09-29 00:37:30 +0000 (Tue, 29 Sep 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'>Plugin Directory: Search: Retry search queries when a API->ES timeout is encountered.
The volume of affected queries is low, but high enough that it's annoying on WordPress.org error logging.
This simply retries the query when the error rates are low (ie. ES is probably not unresponsive/overloaded, and the network isn't having issues) which means this shouldn't exacerbate any real errors.
Hopefully quietens the PHP Warnings related to Search timeouts, and fixes search results for the 1 in a million end-users who we didn't have a stale cache for.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorylibssitesearchjetpacksearchphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/libs/site-search/jetpack-search.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorylibssitesearchjetpacksearchphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/libs/site-search/jetpack-search.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/libs/site-search/jetpack-search.php 2020-09-28 03:09:47 UTC (rev 10292)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/libs/site-search/jetpack-search.php 2020-09-29 00:37:30 UTC (rev 10293)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -193,7 +193,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Determine whether or not the recent error volume is low enough to allow a fresh API call.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function error_volume_is_low() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // This cache key keeps a global-ish count of recent errors (per memcache instance).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // This cache key keeps a global-ish count of recent errors.
</ins><span class="cx" style="display: block; padding: 0 10px"> // Used for random exponential backoff when errors start to pile up, as they will if there is a network outage for example.
</span><span class="cx" style="display: block; padding: 0 10px"> $error_volume = max( $this->get_error_volume(), 0 ); // >= 0
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -250,7 +250,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If the error volume is high, there's a proportionally lower chance that we'll actually attempt to hit the API.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->error_volume_is_low() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $request = wp_remote_post( $service_url, array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $service_args = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'headers' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'Content-Type' => 'application/json',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -257,7 +257,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'timeout' => 10,
</span><span class="cx" style="display: block; padding: 0 10px"> 'user-agent' => 'WordPress.org/jetpack_search',
</span><span class="cx" style="display: block; padding: 0 10px"> 'body' => $json_es_args,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ );
+ $request = wp_remote_post( $service_url, $service_args );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> trigger_error( 'Plugin directory search: skipping search due to high error volume', E_USER_WARNING );
</span><span class="cx" style="display: block; padding: 0 10px"> // Hopefully we still have a cached response to return
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -264,6 +265,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $response;
</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">+ // Retry 400 responses if the error volume is still low.
+ // These 400's are not bad requests but rather timeouts between the API and ES
+ if ( 400 === wp_remote_retrieve_response_code( $request ) ) {
+ // Bump the error counter
+ $this->increment_error_volume();
+
+ if ( $this->error_volume_is_low() ) {
+ $request = wp_remote_post( $service_url, $service_args );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // If there's a network or HTTP error, we'll intentionally leave the temporary lock to expire in a few seconds.
</span><span class="cx" style="display: block; padding: 0 10px"> // Other requests during that window will use the stale cached value. We'll try another remote request once this lock expires.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $request ) || 200 != wp_remote_retrieve_response_code( $request ) ) {
</span></span></pre>
</div>
</div>
</body>
</html>