<!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>[6800] sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-meetup-client.php: WordCamp Utilities: Add internal method for redundant remote get requests</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 { 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/6800">6800</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/6800","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coreymckrill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-02-28 00:22:39 +0000 (Wed, 28 Feb 2018)</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'>WordCamp Utilities: Add internal method for redundant remote get requests
This replaces `wcorg_redundant_remote_get` with a method that doesn't have
other WordCamp-specific dependencies so that the Meetup client can more easily
be used in other environments.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentmupluginsutilitiesclassmeetupclientphp">sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-meetup-client.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentmupluginsutilitiesclassmeetupclientphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-meetup-client.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-meetup-client.php 2018-02-28 00:04:48 UTC (rev 6799)
+++ sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-meetup-client.php 2018-02-28 00:22:39 UTC (rev 6800)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -58,7 +58,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> while ( $request_url ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $request_url = $this->sign_request_url( $request_url );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response = wcorg_redundant_remote_get( $request_url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $response = $this->tenacious_remote_get( $request_url );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 200 === wp_remote_retrieve_response_code( $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $body = json_decode( wp_remote_retrieve_body( $response ), true );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -114,7 +114,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request_url = $this->sign_request_url( $request_url );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response = wcorg_redundant_remote_get( $request_url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $response = $this->tenacious_remote_get( $request_url );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 200 === wp_remote_retrieve_response_code( $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $count_header = wp_remote_retrieve_header( $response, 'X-Total-Count' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,6 +141,63 @@
</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">+ * Wrapper for `wp_remote_get` to retry requests that fail temporarily for various reasons.
+ *
+ * Based on `wcorg_redundant_remote_get`.
+ *
+ * @param string $url
+ * @param array $args
+ *
+ * @return array|\WP_Error
+ */
+ protected function tenacious_remote_get( $url, $args = array() ) {
+ $attempt_count = 0;
+ $max_attempts = 3;
+
+ // Response codes that should break the loop. See https://www.meetup.com/meetup_api/docs/#errors
+ // TODO are there others?
+ $breaking_codes = array(
+ 200, // Ok.
+ 400, // Bad request.
+ 401, // Unauthorized (invalid key).
+ 429, // Too many requests (rate-limited).
+ );
+
+ while ( $attempt_count < $max_attempts ) {
+ $response = wp_remote_get( $url, $args );
+ $response_code = wp_remote_retrieve_response_code( $response );
+
+ if ( in_array( $response_code, $breaking_codes, true ) || is_wp_error( $response ) ) {
+ break;
+ }
+
+ $attempt_count ++;
+
+ /**
+ * Action: Fires when tenacious_remote_get fails a request attempt.
+ *
+ * Note that the request parameter includes the request URL that contains a query string for the API key.
+ * This should be redacted before outputting anywhere public.
+ *
+ * @param array $response
+ * @param array $request
+ * @param int $attempt_count
+ * @param int $max_attempts
+ */
+ do_action( 'meetup_client_tenacious_remote_get_attempt', $response, compact( 'url', 'args' ), $attempt_count, $max_attempts );
+
+ if ( $attempt_count < $max_attempts ) {
+ $retry_after = wp_remote_retrieve_header( $response, 'retry-after' ) ?: 5;
+ $wait = min( $retry_after * $attempt_count, 30 );
+
+ sleep( $wait );
+ }
+ }
+
+ return $response;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Sign a request URL with our API key.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $request_url
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -212,24 +269,41 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Extract error information from an API response and add it to our error handler.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $response
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array|\WP_Error $response
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return void
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function handle_error_response( $response ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data = json_decode( wp_remote_retrieve_body( $response ), true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_wp_error( $response ) ) {
+ $codes = $response->get_error_codes();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $codes as $code ) {
+ $messages = $response->get_error_messages( $code );
+
+ foreach ( $messages as $message ) {
+ $this->error->add( $code, $message );
+ }
+ }
+
+ return;
+ }
+
+ $response_code = wp_remote_retrieve_response_code( $response );
+ $data = json_decode( wp_remote_retrieve_body( $response ), true );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $data['errors'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $data['errors'] as $error ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->error->add( $error['code'], $error['message'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( isset( $data['code'] ) && isset( $data['details'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->error->add( $data['code'], $data['details'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( $response_code ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->error->add(
</span><span class="cx" style="display: block; padding: 0 10px"> 'http_response_code',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_remote_retrieve_response_code( $response ) . ': ' . print_r( $data, true )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sprintf( 'HTTP Status: %d', absint( $response_code ) )
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ $this->error->add( 'unknown_error', 'There was an unknown error.' );
</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">@@ -290,7 +364,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieve data about events associated with one particular group.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group_slug The slug/urlname of a group.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Optional. Additional request parameters.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. Additional request parameters.
</ins><span class="cx" style="display: block; padding: 0 10px"> * See https://www.meetup.com/meetup_api/docs/:urlname/events/
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array|\WP_Error
</span></span></pre>
</div>
</div>
</body>
</html>