<!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>[8287] sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins: WordCamp: More improvements to error handling/logging</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 { white-space: pre-line; 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/8287">8287</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/8287","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coreymckrill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-02-20 01:06:00 +0000 (Wed, 20 Feb 2019)</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: More improvements to error handling/logging
* Rename 0-slack.php to 0-error-handling.php, since that file's only
purpose is to load the Slack library for error handling purposes
anyway.
* Move all of the error handling stuff from wcorg-misc.php to
0-error-handling.php. There's enough of it to warrant a separate file,
and this way it all gets loaded before the rest of the mu-plugins
so it can potentially catch errors there as well.
* Run the custom error handler and shutdown function in other
environments besides production, as long as the SANDBOX_SLACK_USERNAME
constant is defined. This way the errors will be sent to the sandbox
owner's Slack account, rather than the log channel.
* In the shutdown function, only send the error to Slack if it is one
of the types of errors that can't be handled in the custom error
handler.
* Modify the layout and contents of error messages sent to Slack to make
them easier to parse when skimming through backscroll.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentmupluginswcorgmiscphp">sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/wcorg-misc.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentmuplugins0errorhandlingphp">sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/0-error-handling.php</a></li>
</ul>
<h3>Removed Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentmuplugins0slackphp">sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/0-slack.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentmuplugins0errorhandlingphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/0-error-handling.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/mu-plugins/0-error-handling.php (rev 0)
+++ sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/0-error-handling.php 2019-02-20 01:06:00 UTC (rev 8287)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,236 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+defined( 'WPINC' ) or die();
+
+define( 'ERROR_RATE_LIMITING_DIR', '/tmp/error_limiting' );
+
+if ( is_readable( __DIR__ . '/includes/slack/send.php' ) ) {
+ require_once( __DIR__ . '/includes/slack/send.php' );
+}
+
+set_error_handler( 'send_error_to_slack' );
+register_shutdown_function( 'send_fatal_to_slack' );
+
+/**
+ * Error handler to send errors to Slack.
+ *
+ * Note: This should always return false so that default error handling still occurs as well.
+ *
+ * @todo We should consider splitting the functionality here into two or more separate functions.
+ * This way logging errors to files could be separate from sending messages to Slack. This would
+ * also potentially allow us to load the error logging part earlier, before WP functions
+ * are available.
+ *
+ * @param int $err_no
+ * @param string $err_msg
+ * @param string $file
+ * @param int $line
+ *
+ * @return bool
+ */
+function send_error_to_slack( $err_no, $err_msg, $file, $line ) {
+ if ( ! defined( 'WORDCAMP_ENVIRONMENT' )
+ || ( 'production' !== WORDCAMP_ENVIRONMENT && ! defined( 'SANDBOX_SLACK_USERNAME' ) )
+ ) {
+ return false;
+ }
+
+ if ( ! init_error_handling() ) {
+ return false;
+ }
+
+ // Checks to see if the error-throwing expression is prepended with the @ control operator.
+ // See https://secure.php.net/manual/en/function.set-error-handler.php
+ if ( 0 === error_reporting() ) {
+ return false;
+ }
+
+ $error_safelist = [
+ E_ERROR,
+ E_CORE_ERROR,
+ E_COMPILE_ERROR,
+ E_USER_ERROR,
+ E_WARNING,
+ E_PARSE,
+ E_CORE_WARNING,
+ E_COMPILE_WARNING,
+ E_USER_WARNING,
+ E_NOTICE,
+ E_USER_NOTICE,
+ E_STRICT,
+ E_DEPRECATED,
+ E_USER_DEPRECATED,
+ ];
+
+ if ( ! in_array( $err_no, $error_safelist ) ) {
+ return false;
+ }
+
+ // Always use constants in the keys here to avoid path disclosure.
+ $error_ignorelist = [
+ // See https://core.trac.wordpress.org/ticket/29204
+ ABSPATH . 'wp-includes/SimplePie/Registry.php:215' => 'Non-static method WP_Feed_Cache::create() should not be called statically',
+ ];
+
+ if ( isset( $error_ignorelist[ "$file:$line" ] ) && false !== strpos( $err_msg, $error_ignorelist[ "$file:$line" ] ) ) {
+ return false;
+ }
+
+ $err_key = substr( base64_encode("$file-$line-$err_no" ), -254 ); // Max file length for ubuntu is 255.
+ $error_file = ERROR_RATE_LIMITING_DIR . "/$err_key";
+ $data = array(
+ 'last_reported_at' => time(),
+ 'error_count' => 0, // since last reported.
+ );
+ $messages = explode( 'Stack trace:', $err_msg, 2 );
+ $pretext = $messages[0] ?: '';
+ $stack_trace = ( ! empty( $messages[1] ) ) ? trim( sanitize_text_field( $messages[1] ) ) : '';
+ $footer = '';
+
+ if ( ! file_exists( $error_file ) ) {
+ file_put_contents( $error_file, wp_json_encode( $data ) );
+ } else {
+ $data = json_decode( file_get_contents( $error_file ), true );
+ $data['error_count'] += 1;
+ $time_elapsed = time() - $data['last_reported_at'];
+
+ if ( $time_elapsed > 600 ) {
+ $data['last_reported_at'] = time();
+ $data['error_count'] = 0;
+ file_put_contents( $error_file, wp_json_encode( $data ) );
+
+ $footer .= "Occurred *${data['error_count']} time(s)* since last reported";
+ } else {
+ file_put_contents( $error_file, wp_json_encode( $data ) );
+ return false;
+ }
+ }
+
+ $domain = esc_url( get_site_url() );
+ $page_slug = sanitize_text_field( untrailingslashit( $_SERVER['REQUEST_URI'] ) ) ?: '/';
+
+ switch( $err_no ) {
+ case E_ERROR:
+ case E_CORE_ERROR:
+ case E_COMPILE_ERROR :
+ case E_USER_ERROR:
+ default:
+ $color = '#ff0000'; // Red.
+ break;
+ case E_WARNING:
+ case E_PARSE:
+ case E_CORE_WARNING:
+ case E_COMPILE_WARNING:
+ case E_USER_WARNING:
+ $color = '#ffa500'; // Orange.
+ break;
+ case E_NOTICE:
+ case E_USER_NOTICE:
+ case E_STRICT:
+ case E_DEPRECATED:
+ case E_USER_DEPRECATED:
+ $color = '#ffff00'; // Yellow.
+ break;
+ }
+
+ $fields = [
+ [
+ 'title' => 'Domain',
+ 'value' => $domain,
+ 'short' => false,
+ ],
+ [
+ 'title' => 'Page',
+ 'value' => $page_slug,
+ 'short' => false,
+ ],
+ [
+ 'title' => 'File',
+ 'value' => "$file:$line",
+ 'short' => false,
+ ],
+ ];
+
+ if ( $stack_trace ) {
+ $fields[] = [
+ 'title' => 'Stack Trace',
+ 'value' => $stack_trace,
+ 'short' => false,
+ ];
+ }
+
+ $attachment = array(
+ 'fallback' => $pretext,
+ 'pretext' => $pretext,
+ 'color' => $color,
+ 'author_name' => 'WordCamp Logger',
+ 'fields' => $fields,
+ 'footer' => $footer,
+ );
+
+ $send = new \Dotorg\Slack\Send( SLACK_ERROR_REPORT_URL );
+ $send->add_attachment( $attachment );
+
+ if ( 'production' === WORDCAMP_ENVIRONMENT ) {
+ $send->send( WORDCAMP_LOGS_SLACK_CHANNEL );
+ } else {
+ $send->send( SANDBOX_SLACK_USERNAME );
+ }
+
+ return false;
+}
+
+/**
+ * Shutdown handler for catching fatal errors and sending them to Slack.
+ *
+ * Some error types cannot be handled directly by a custom error handler. However, we can catch them during shutdown
+ * and redirect them to the custom handler callback.
+ */
+function send_fatal_to_slack() {
+ $error = error_get_last();
+
+ // See https://secure.php.net/manual/en/function.set-error-handler.php
+ $unhandled_error_types = [ E_ERROR, E_PARSE, E_CORE_ERROR, E_CORE_WARNING, E_COMPILE_ERROR, E_COMPILE_WARNING ];
+
+ if ( ! empty( $error ) && in_array( $error['type'], $unhandled_error_types, true ) ) {
+ send_error_to_slack( $error['type'], $error['message'], $error['file'], $error['line'] );
+ }
+}
+
+/**
+ * Check and create filesystem dirs to manage rate limiting in error handling.
+ *
+ * For legacy bugs we are doing rate limiting via filesystem. We would be investigating to see if we can instead use memcache to rate limit sometime in the future.
+ *
+ * @return bool Return true if file permissions etc are present
+ */
+function init_error_handling() {
+ if ( ! file_exists( ERROR_RATE_LIMITING_DIR ) ) {
+ mkdir( ERROR_RATE_LIMITING_DIR );
+ }
+
+ return is_dir( ERROR_RATE_LIMITING_DIR ) && is_writeable( ERROR_RATE_LIMITING_DIR );
+}
+
+/**
+ * Remove temporary error rate limiting files.
+ *
+ * Function `send_error_to_slack` above also creates a bunch of files in /tmp/error_limiting folder in order to rate limit the notification.
+ * This function will be used as a cron to clear these error_limiting files periodically.
+ */
+function handle_clear_error_rate_limiting_files() {
+ if ( ! init_error_handling() ) {
+ return;
+ }
+
+ foreach ( new DirectoryIterator( ERROR_RATE_LIMITING_DIR ) as $file_info ) {
+ if ( ! $file_info->isDot() ) {
+ unlink( $file_info->getPathname() );
+ }
+ }
+}
+
+if ( ! wp_next_scheduled( 'clear_error_rate_limiting_files' ) ) {
+ wp_schedule_event( time(), 'daily', 'clear_error_rate_limiting_files' );
+}
+
+add_action( 'clear_error_rate_limiting_files', 'handle_clear_error_rate_limiting_files' );
</ins></span></pre></div>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentmuplugins0slackphp"></a>
<div class="delfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Deleted: sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/0-slack.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/mu-plugins/0-slack.php 2019-02-20 00:12:56 UTC (rev 8286)
+++ sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/0-slack.php 2019-02-20 01:06:00 UTC (rev 8287)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,11 +0,0 @@
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-<?php
-
-/*
- * Load the Slack includes early so they'll be available to send fatal errors.
- */
-
-defined( 'WPINC' ) or die();
-
-if( is_readable( __DIR__ . '/includes/slack/send.php' ) ) {
- require_once( __DIR__ . '/includes/slack/send.php' );
-}
</del></span></pre></div>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentmupluginswcorgmiscphp"></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/mu-plugins/wcorg-misc.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/mu-plugins/wcorg-misc.php 2019-02-20 00:12:56 UTC (rev 8286)
+++ sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/wcorg-misc.php 2019-02-20 01:06:00 UTC (rev 8287)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -442,156 +442,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'map_meta_cap', 'wcorg_central_modify_export_caps', 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-define( 'ERROR_RATE_LIMITING_DIR', '/tmp/error_limiting' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check and create filesystem dirs to manage rate limiting in error handling.
- * For legacy bugs we are doing rate limiting via filesystem. We would be investigating to see if we can instead use memcache to rate limit sometime in the future.
- *
- * @return bool Return true if file permissions etc are present
- */
-function init_error_handling() {
- if ( ! file_exists( ERROR_RATE_LIMITING_DIR ) ) {
- mkdir( ERROR_RATE_LIMITING_DIR );
- }
-
- return is_dir( ERROR_RATE_LIMITING_DIR ) && is_writeable( ERROR_RATE_LIMITING_DIR );
-}
-
-/**
- * Error handler to send errors to slack. Always return false.
- */
-function send_error_to_slack( $err_no, $err_msg, $file, $line ) {
- if ( ! init_error_handling() ) {
- return false;
- }
-
- // Checks to see if the error-throwing expression is prepended with the @ control operator.
- // See https://secure.php.net/manual/en/function.set-error-handler.php
- if ( 0 === error_reporting() ) {
- error_clear_last();
-
- return false;
- }
-
- $error_safelist = [
- E_ERROR,
- E_USER_ERROR,
- E_CORE_ERROR,
- E_COMPILE_ERROR,
- E_PARSE,
- E_NOTICE,
- E_DEPRECATED,
- E_WARNING,
- ];
-
- if ( ! in_array( $err_no, $error_safelist ) ) {
- return false;
- }
-
- // Always use constants in the keys here to avoid path disclosure.
- $error_ignorelist = [
- // See https://core.trac.wordpress.org/ticket/29204
- ABSPATH . 'wp-includes/SimplePie/Registry.php:215' => 'Non-static method WP_Feed_Cache::create() should not be called statically',
- ];
-
- if ( isset( $error_ignorelist[ "$file:$line" ] ) && false !== strpos( $err_msg, $error_ignorelist[ "$file:$line" ] ) ) {
- return false;
- }
-
- // Max file length for ubuntu system is 255.
- $err_key = substr( base64_encode("$file-$line-$err_no" ), -254 );
-
- $error_file = ERROR_RATE_LIMITING_DIR . "/$err_key";
-
- $text = '';
-
- $data = array(
- 'last_reported_at' => time(),
- 'error_count' => 0, // since last reported.
- );
-
- if ( ! file_exists( $error_file ) ) {
- $text = 'Error occured. ';
- file_put_contents( $error_file, wp_json_encode( $data ) );
- } else {
- $data = json_decode( file_get_contents( $error_file ), true );
- $data['error_count'] += 1;
- $time_elasped = time() - $data['last_reported_at'];
-
- if ( $time_elasped > 600 ) {
- $text = "Still happening. Happened ${data['error_count']} time(s) since last reported. ";
- $data['last_reported_at'] = time();
- $data['error_count'] = 0;
-
- file_put_contents( $error_file, wp_json_encode( $data ) );
- } else {
- file_put_contents( $error_file, wp_json_encode( $data ) );
- return false;
- }
- }
-
- $domain = get_site_url();
- $page_slug = esc_html( trim( $_SERVER['REQUEST_URI'], '/' ) );
- $text = $text . "Message : \"$err_msg\" occurred on \"$file:$line\" \n Domain: $domain \n Page: $page_slug \n Error type: $err_no";
-
- $message = array(
- 'fallback' => $text,
- 'color' => '#ff0000',
- 'pretext' => "Error on \"$file:$line\" ",
- 'author_name' => $domain,
- 'text' => $text,
- );
-
- $send = new \Dotorg\Slack\Send( SLACK_ERROR_REPORT_URL );
- $send->add_attachment( $message );
-
- $send->send( WORDCAMP_LOGS_SLACK_CHANNEL );
-
- return false;
-}
-
-/**
- * Shutdown handler which forwards errors to slack.
- */
-function send_fatal_to_slack() {
- $error = error_get_last();
- if ( ! $error ) {
- return;
- }
-
- return send_error_to_slack( $error['type'], $error['message'], $error['file'], $error['line'] );
-}
-
-if ( 'production' === WORDCAMP_ENVIRONMENT ) {
- register_shutdown_function( 'send_fatal_to_slack' );
- set_error_handler( 'send_error_to_slack', E_ERROR );
-}
-
-/**
- * Function `send_error_to_slack` above also creates a bunch of files in /tmp/error_limiting folder in order to rate limit the notification.
- * This function will be used as a cron to clear these error_limiting files periodically.
- */
-function handle_clear_error_rate_limiting_files() {
- if ( ! init_error_handling() ) {
- return;
- }
-
- foreach ( new DirectoryIterator( ERROR_RATE_LIMITING_DIR ) as $file_info ) {
- if ( ! $file_info->isDot() ) {
- unlink( $file_info->getPathname() );
- }
- }
-
-}
-
-add_action( 'clear_error_rate_limiting_files', 'handle_clear_error_rate_limiting_files' );
-
-if ( ! wp_next_scheduled( 'clear_error_rate_limiting_files' ) ) {
- wp_schedule_event( time(), 'daily', 'clear_error_rate_limiting_files' );
-}
-
-/**
</del><span class="cx" style="display: block; padding: 0 10px"> * Allow individual site administrators to activate and deactivate optional plugins.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $required_capabilities The primitive capabilities that are required to perform the requested meta
</span></span></pre>
</div>
</div>
</body>
</html>