<!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>[6833] sites/trunk/wordcamp.org/public_html/wp-content/plugins: WordCamp QBO: Store classes in site option for reliability.</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/6833">6833</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/6833","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-03-07 01:45:38 +0000 (Wed, 07 Mar 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 QBO: Store classes in site option for reliability.
Storing it in a transient often causes the data to be empty when the QBO connection is unavailable.
This is also a good opportunity to remove some of the unnecessary "middle man" code from the `wordcamp-qbo-client` experiment, now that it's clear that the tangible drawbacks (lots of unnecessary, duplicated, unintuitive code) are worse than the intangible benefits (future-proofing for the unlikely event that we'll switch to a decentralized hosting model in the future).</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentpluginswordcampqbowordcampqbophp">sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-qbo/wordcamp-qbo.php</a></li>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentpluginswordcampqboclientwordcampqboclientphp">sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-qbo-client/wordcamp-qbo-client.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentpluginswordcampqbowordcampqbophp"></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/plugins/wordcamp-qbo/wordcamp-qbo.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/plugins/wordcamp-qbo/wordcamp-qbo.php 2018-03-07 01:38:52 UTC (rev 6832)
+++ sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-qbo/wordcamp-qbo.php 2018-03-07 01:45:38 UTC (rev 6833)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,6 +35,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function load() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'plugins_loaded', array( __CLASS__, 'plugins_loaded' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'wcqbo_prime_classes_cache', array( __CLASS__, 'prime_classes_cache' ) );
+
+ if ( ! wp_next_scheduled( 'wcqbo_prime_classes_cache' ) ) {
+ wp_schedule_event( time(), 'hourly', 'wcqbo_prime_classes_cache' );
+ }
</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">@@ -85,11 +90,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'callback' => array( __CLASS__, 'rest_callback_expense' ),
</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">- register_rest_route( 'wordcamp-qbo/v1', '/classes', array(
- 'methods' => 'GET',
- 'callback' => array( __CLASS__, 'rest_callback_classes' ),
- ) );
-
</del><span class="cx" style="display: block; padding: 0 10px"> register_rest_route( 'wordcamp-qbo/v1', '/invoice', array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'methods' => 'GET, POST',
</span><span class="cx" style="display: block; padding: 0 10px"> 'callback' => array( __CLASS__, 'rest_callback_invoice' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,31 +224,24 @@
</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">- * REST: /classes
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Update the cached QBO classes ("communities").
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_REST_Request $request
- */
- public static function rest_callback_classes( $request ) {
- if ( ! self::_is_valid_request( $request ) )
- return new WP_Error( 'unauthorized', 'Unauthorized', array( 'status' => 401 ) );
-
- return self::_get_classes();
- }
-
- /**
- * Get an array of available QBO classes.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * These are stored in an option rather than a transient, because:
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @uses get_transient, set_transient
- *
- * @return array An array of class IDs as keys, names as values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 1) The user shouldn't have to wait for an external HTTP request to complete before the page loads.
+ * 2) The connection is QBO is not reliable enough. For example, it expires every 180 days, and needs to be
+ * manually reconnected. When the transient expires during that timeframe, it cannot be renewed until the
+ * connection is re-established, and any functionality relying on this would be broken.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- private static function _get_classes() {
- $cache_key = md5( 'wordcamp-qbo:classes' );
- $cache = get_transient( $cache_key );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function prime_classes_cache() {
+ /*
+ * This isn't strictly needed right now, but it's future-proofing for when we eventually remove
+ * `wordcamp-qbo-client` and network-activate `wordcamp-qbo`.
+ */
+ if ( ! is_main_site() ) {
+ 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 ( $cache !== false )
- return $cache;
-
</del><span class="cx" style="display: block; padding: 0 10px"> self::load_options();
</span><span class="cx" style="display: block; padding: 0 10px"> $oauth = self::_get_oauth();
</span><span class="cx" style="display: block; padding: 0 10px"> $oauth->set_token( self::$options['auth']['oauth_token'], self::$options['auth']['oauth_token_secret'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -275,12 +268,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> Logger\log( 'remote_request', compact( 'args', 'response' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) || wp_remote_retrieve_response_code( $response ) !== 200 ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error( 'error', 'Could not fetch classes.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return;
</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"> $body = json_decode( wp_remote_retrieve_body( $response ), true );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $body ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error( 'error', 'Could not fetch classes body.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return;
</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"> $classes = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -288,10 +281,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $classes[ $class['Id'] ] = $class['Name'];
</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">+ if ( empty ( $class ) ) {
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> asort( $classes );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- set_transient( $cache_key, $classes, 12 * HOUR_IN_SECONDS );
- return $classes;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ update_site_option( 'wordcamp_qbo_classes', $classes );
</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></pre></div>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentpluginswordcampqboclientwordcampqboclientphp"></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/plugins/wordcamp-qbo-client/wordcamp-qbo-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/plugins/wordcamp-qbo-client/wordcamp-qbo-client.php 2018-03-07 01:38:52 UTC (rev 6832)
+++ sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-qbo-client/wordcamp-qbo-client.php 2018-03-07 01:45:38 UTC (rev 6833)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,37 +90,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Class IDs as keys, names as values.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get_classes() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $cache_key = md5( 'wordcamp-qbo-client:classes' );
- $cache = get_transient( $cache_key );
-
- if ( $cache !== false )
- return $cache;
-
- $request_url = esc_url_raw( self::$api_base . '/classes/' );
- $request_args = array(
- 'timeout' => self::REMOTE_REQUEST_TIMEOUT,
- 'headers' => array(
- 'Content-Type' => 'application/json',
- 'Authorization' => self::_get_auth_header( 'get', $request_url ),
- ),
- );
- $response = wp_remote_get( $request_url, $request_args );
-
- Logger\log( 'remote_request', compact( 'request_url', 'request_args', 'response' ) );
-
- $classes = array();
-
- if ( ! is_wp_error( $response ) && wp_remote_retrieve_response_code( $response ) == 200 ) {
- $body = json_decode( wp_remote_retrieve_body( $response ), true );
- if ( ! empty( $body ) && is_array( $body ) )
- $classes = $body;
- }
-
- if ( $classes ) {
- set_transient( $cache_key, $classes, 12 * HOUR_IN_SECONDS );
- }
-
- return $classes;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return get_site_option( 'wordcamp_qbo_classes' );
</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"> public static function metabox_quickbooks() {
</span></span></pre>
</div>
</div>
</body>
</html>