Changeset 6833

Timestamp:

03/07/2018 01:45:38 AM (8 years ago)

Author:

iandunn

Message:

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).

Location:

sites/trunk/wordcamp.org/public_html/wp-content/plugins

Files:

• wordcamp-qbo-client/wordcamp-qbo-client.php (modified) (1 diff)
• wordcamp-qbo/wordcamp-qbo.php (modified) (5 diffs)

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-qbo-client/wordcamp-qbo-client.php

@@ -91 +91 @@
          */
         public static function get_classes() {
-                $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;
+                return get_site_option( 'wordcamp_qbo_classes' );
         }
 

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-qbo/wordcamp-qbo.php

@@ -36 +36 @@
         public static function load() {
                 add_action( 'plugins_loaded', array( __CLASS__, 'plugins_loaded' ) );
+                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' );
+                }
         }
 
@@ -84 +89 @@
                         'methods' => 'GET, POST',
                         'callback' => array( __CLASS__, 'rest_callback_expense' ),
-                ) );
-
-                register_rest_route( 'wordcamp-qbo/v1', '/classes', array(
-                        'methods' => 'GET',
-                        'callback' => array( __CLASS__, 'rest_callback_classes' ),
                 ) );
 
@@ -225 +225 @@
 
         /**
-         * REST: /classes
-         *
-         * @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.
-         *
-         * @uses get_transient, set_transient
-         *
-         * @return array An array of class IDs as keys, names as values.
-         */
-        private static function _get_classes() {
-                $cache_key = md5( 'wordcamp-qbo:classes' );
-                $cache = get_transient( $cache_key );
-
-                if ( $cache !== false )
-                        return $cache;
+         * Update the cached QBO classes ("communities").
+         *
+         * These are stored in an option rather than a transient, because:
+         *
+         * 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.
+         */
+        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;
+                }
 
                 self::load_options();
@@ -276 +269 @@
 
                 if ( is_wp_error( $response ) || wp_remote_retrieve_response_code( $response ) !== 200 ) {
-                        return new WP_Error( 'error', 'Could not fetch classes.' );
+                        return;
                 }
 
                 $body = json_decode( wp_remote_retrieve_body( $response ), true );
                 if ( empty( $body ) ) {
-                        return new WP_Error( 'error', 'Could not fetch classes body.' );
+                        return;
                 }
 
@@ -289 +282 @@
                 }
 
+                if ( empty ( $class ) ) {
+                        return;
+                }
+
                 asort( $classes );
 
-                set_transient( $cache_key, $classes, 12 * HOUR_IN_SECONDS );
-                return $classes;
+                update_site_option( 'wordcamp_qbo_classes', $classes );
         }