Changeset 11728

Timestamp:

04/01/2022 03:30:53 AM (3 years ago)

Author:

dd32

Message:

Plugin Directory: Stats Report: Fix the first request to the HelpScout API endpoints.

• The first non-cached request to the HelpScout API failed to use the proper Authorization header format, due to a missing BEARER prefix.
• Increased the API timeout for HelpScout to 15s, although it probably doesn't need it.
• Make it more obvious that something is wrong with the HelpScout details, by returning 0's for all numbers, rather than just one or two of them.

See #4306.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• admin/tools/class-stats-report.php (modified) (1 diff)
• clients/class-helpscout.php (modified) (4 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin/tools/class-stats-report.php

@@ -171 +171 @@
         $email_report    = HelpScout::api( '/v2/reports/email', $api_payload );
 
+        // If any of the API's are unavailable, make it obvious that the requests have failed, but returning 0's for everything.
+        if ( ! $company_report || ! $mailbox_overall || ! $email_report ) {
+            $company_report = $mailbox_overall = $email_report = false;
+        }
+
         $stats['helpscout_queue_total_conversations']     = $mailbox_overall->current->totalConversations ?? 0;
         $stats['helpscout_queue_new_conversations']       = $mailbox_overall->current->newConversations ?? 0;
         $stats['helpscout_queue_customers']               = $mailbox_overall->current->customers ?? 0;
         $stats['helpscout_queue_conversations_per_day']   = $mailbox_overall->current->conversationsPerDay ?? 0;
-        $stats['helpscout_queue_busiest_day']             = gmdate( 'l', strtotime( 'Sunday +' . $mailbox_overall->busiestDay->day . ' days' ) ); // Hacky? but works
+        $stats['helpscout_queue_busiest_day']             = gmdate( 'l', strtotime( 'Sunday +' . ( $mailbox_overall->busiestDay->day ?? 0 ) . ' days' ) ); // Hacky? but works
         $stats['helpscout_queue_messages_received']       = $mailbox_overall->current->messagesReceived ?? 0;
         $stats['helpscout_queue_replies_sent']            = $company_report->current->totalReplies;

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/clients/class-helpscout.php

@@ -9 +9 @@
 class HelpScout {
     const API_BASE = 'https://api.helpscout.net';
+
+    /**
+     * The HTTP timeout for the HelpScout API.
+     */
+    const TIMEOUT = 15;
 
     public static function api( $url, $args = null, $method = 'GET' ) {
@@ -33 +38 @@
                     'Authorization' => self::get_auth_string(),
                 ],
+                'timeout' => self::TIMEOUT,
                 'body'    => ( 'POST' === $method && $args ) ? $args : null,
             )
@@ -52 +58 @@
             self::API_BASE . '/v2/oauth2/token',
             array(
-                'body' => array(
+                'timeout' => self::TIMEOUT,
+                'body'    => array(
                     'grant_type'    => 'client_credentials',
                     'client_id'     => HELPSCOUT_APP_ID,
@@ -72 +79 @@
         set_site_transient( __CLASS__ . 'get_auth_token', [ 'exp' => time() + $expiry, 'token' => $token ], $expiry );
 
-        return $token;
+        return 'BEARER ' . $token;
     }