Changeset 41316

Timestamp:

08/25/2017 06:11:04 PM (8 years ago)

Author:

iandunn

Message:

Dashboard: Discontinue nonessential logging of Events API requests.

These log entries are only useful when troubleshooting unexpected results from the API, which is not common. The vast majority of users are better served by not having their logs cluttered with noise.

For the rare situations where troubleshooting is necessary, it can be achieved by a plugin (see #41217 for an example).

Props Howdy_McGee, dd32.
Fixes #41217.

File:

• trunk/src/wp-admin/includes/class-wp-community-events.php (modified) (5 diffs)

trunk/src/wp-admin/includes/class-wp-community-events.php

@@ -99 +99 @@
         $response_body  = json_decode( wp_remote_retrieve_body( $response ), true );
         $response_error = null;
-        $debugging_info = compact( 'api_url', 'request_args', 'response_code', 'response_body' );
 
         if ( is_wp_error( $response ) ) {
@@ -117 +116 @@
 
         if ( is_wp_error( $response_error ) ) {
-            $this->maybe_log_events_response( $response_error->get_error_message(), $debugging_info );
-
             return $response_error;
         } else {
@@ -158 +155 @@
             $response_body = $this->format_event_data_time( $response_body );
 
-            // Avoid bloating the log with all the event data, but keep the count.
-            $debugging_info['response_body']['events'] = count( $debugging_info['response_body']['events'] ) . ' events trimmed.';
-
-            $this->maybe_log_events_response( 'Valid response received', $debugging_info );
-
             return $response_body;
         }
@@ -419 +411 @@
      * Logs responses to Events API requests.
      *
-     * All responses are logged when debugging, even if they're not WP_Errors.
-     * Debugging info is still needed for "successful" responses, because
-     * the API might have returned a different location than the one the user
-     * intended to receive. In those cases, knowing the exact `request_url` is
-     * critical.
-     *
-     * Errors are logged instead of being triggered, to avoid breaking the JSON
-     * response when called from AJAX handlers and `display_errors` is enabled.
-     *
-     * @since 4.8.0
+     * @since 4.8.0
+     * @deprecated 4.9.0 Use a plugin instead. See #41217 for an example.
      *
      * @param string $message A description of what occurred.
@@ -435 +419 @@
      */
     protected function maybe_log_events_response( $message, $details ) {
+        _deprecated_function( __METHOD__, '4.9.0' );
+
         if ( ! WP_DEBUG_LOG ) {
             return;