Changeset 9107

Timestamp:

08/17/2019 12:35:04 AM (6 years ago)

Author:

coreymckrill

Message:

Official WordPress Events: Tweak Meetup client to try to avoid auth token probs

This attempts to avoid the scenario where the client has somehow stored an
oauth token that is expired/invalid, and keeps using it for requests anyway.
Now it will try to detect when the token it has isn't working and refresh it
without breaking the current request cycle.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/meetup

Files:

• class-api-client.php (modified) (5 diffs)
• class-meetup-client.php (modified) (4 diffs)
• class-meetup-oauth2-client.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/meetup/class-api-client.php

@@ -37 +37 @@
      */
     protected $breaking_response_codes = [];
+
+    /**
+     * @var string|null The URL for the current request being attempted.
+     */
+    protected $current_request_url = null;
+
+    /**
+     * @var array|null The args for the current request being attempted.
+     */
+    protected $current_request_args = null;
 
     /**
@@ -86 +96 @@
         }
 
+        // Set current request in state so it can be manipulated between request attempts if necessary.
+        $this->current_request_url  = $url;
+        $this->current_request_args = $args;
+
         while ( $attempt_count < $max_attempts ) {
-            $response      = wp_remote_request( $url, $args );
+            $response      = wp_remote_request( $this->current_request_url, $this->current_request_args );
             $response_code = wp_remote_retrieve_response_code( $response );
 
@@ -118 +132 @@
              * @param int   $max_attempts
              */
-            do_action( 'api_client_tenacious_remote_request_attempt', $response, compact( 'url', 'args' ), $attempt_count, $max_attempts );
+            do_action(
+                'api_client_tenacious_remote_request_attempt',
+                $response,
+                array(
+                    'url'  => $this->current_request_url,
+                    'args' => $this->current_request_args,
+                ),
+                $attempt_count,
+                $max_attempts
+            );
 
             if ( $attempt_count < $max_attempts ) {
@@ -129 +152 @@
             }
         }
+
+        // Reset current request.
+        $this->current_request_url  = null;
+        $this->current_request_args = null;
 
         if ( $attempt_count === $max_attempts && ( 200 !== $response_code || is_wp_error( $response ) ) ) {
@@ -225 +252 @@
 
     /**
+     * Merge two error objects into one, new error object.
+     *
+     * @param WP_Error $error1 An error object.
+     * @param WP_Error $error2 An error object.
+     *
+     * @return WP_Error The combined errors of the two parameters.
+     */
+    protected function merge_errors( WP_Error $error1, WP_Error $error2 ) {
+        $codes = $error2->get_error_codes();
+
+        foreach ( $codes as $code ) {
+            $messages = $error2->get_error_messages( $code );
+
+            foreach ( $messages as $message ) {
+                $error1->add( $code, $message );
+            }
+        }
+
+        return $error1;
+    }
+
+    /**
      * Outputs a message when the command is run from the PHP command line.
      *

sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/meetup/class-meetup-client.php

@@ -73 +73 @@
         );
 
+        $this->debug = $settings['debug'];
+
+        if ( $this->debug ) {
+            self::cli_message( "Meetup Client debug is on. Results will be truncated." );
+        }
+
         $this->oauth_client = new Meetup_OAuth2_Client;
-        $this->debug        = $settings['debug'];
-
-        if ( $this->debug ) {
-            self::cli_message( "Meetup Client debug is ON. Results will be truncated." );
+
+        if ( ! empty( $this->oauth_client->error->get_error_messages() ) ) {
+            $this->error = $this->merge_errors( $this->error, $this->oauth_client->error );
+        }
+
+        add_action( 'api_client_tenacious_remote_request_attempt', array( $this, 'maybe_reset_oauth_token' ) );
+    }
+
+    /**
+     * Attempt to fix authorization errors before they permanently fail.
+     *
+     * Hooked to `api_client_tenacious_remote_request_attempt` so that a request that has failed due to an invalid
+     * oauth token can be retried after resetting the token.
+     *
+     * @param array $response
+     *
+     * @return void
+     */
+    public function maybe_reset_oauth_token( $response ) {
+        $code = wp_remote_retrieve_response_code( $response );
+        $body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+        if ( 400 === $code && ! empty( $body['error'] ) && 'invalid_grant' === $body['error'] ) {
+            $this->oauth_client->reset_oauth_token();
+
+            if ( ! empty( $this->oauth_client->error->get_error_messages() ) ) {
+                $this->error = $this->merge_errors( $this->error, $this->oauth_client->error );
+            }
+
+            // Reset the request headers, so that they include the new oauth token.
+            $this->current_request_args = $this->get_request_args();
         }
     }
@@ -123 +156 @@
                 $request_url = $this->get_next_url( $response );
             } else {
-                $this->handle_error_response( $response );
+                $this->handle_error_response( $response, $request_url );
                 break;
             }
@@ -168 +201 @@
             }
         } else {
-            $this->handle_error_response( $response );
+            $this->handle_error_response( $response, $request_url );
         }
 
@@ -295 +328 @@
                 );
             }
+        } elseif ( isset( $data['error'], $data['error_description'] ) ) {
+            $this->error->add(
+                $data['error'],
+                $data['error_description']
+            );
         } elseif ( isset( $data['code'] ) && isset( $data['details'] ) ) {
             $this->error->add(

sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/meetup/class-meetup-oauth2-client.php

@@ -97 +97 @@
             ),
         ) );
+
+        // Pre-cache the oauth token.
+        $this->get_oauth_token();
     }
 
@@ -308 +311 @@
 
         return $oauth_token;
+    }
+
+    /**
+     * Un-cache any existing oauth token and request a new one.
+     *
+     * This also resets the error property so that it has a clean slate when it attempts to request a new token.
+     *
+     * Useful if a token stops working during a batch of requests :/
+     *
+     * @return void
+     */
+    public function reset_oauth_token() {
+        delete_site_option( self::SITE_OPTION_KEY_OAUTH );
+
+        $this->oauth_token = array();
+        $this->error       = new WP_Error();
+
+        $this->get_oauth_token();
     }