<!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>[51358] trunk: Multisite: Log error/warnings/notices from `ms-files.php`.</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="https://core.trac.wordpress.org/changeset/51358">51358</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/51358","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-07-06 20:20:51 +0000 (Tue, 06 Jul 2021)</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'>Multisite: Log error/warnings/notices from `ms-files.php`.
Previously errors were not displayed or logged, but the original intention was only to prevent them from being displayed. Hiding them from logs makes problems like <a href="https://core.trac.wordpress.org/ticket/53492">#53492</a> much harder to debug.
This makes the handling of errors in `ms-files` consistent with the REST API, `admin-ajax`, and XML-RPC.
Props iandunn, johnjamesjacoby.
Fixes <a href="https://core.trac.wordpress.org/ticket/53493">#53493</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesloadphp">trunk/src/wp-includes/load.php</a></li>
<li><a href="#trunksrcwpincludesmsfilesphp">trunk/src/wp-includes/ms-files.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsloadwpDebugModephp">trunk/tests/phpunit/tests/load/wpDebugMode.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesloadphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/load.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/load.php 2021-07-06 19:12:23 UTC (rev 51357)
+++ trunk/src/wp-includes/load.php 2021-07-06 20:20:51 UTC (rev 51358)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -415,7 +415,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * When `WP_DEBUG_LOG` is true, errors will be logged to `wp-content/debug.log`.
</span><span class="cx" style="display: block; padding: 0 10px"> * When `WP_DEBUG_LOG` is a valid path, errors will be logged to the specified file.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Errors are never displayed for XML-RPC, REST, and Ajax requests.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Errors are never displayed for XML-RPC, REST, `ms-files.php`, and Ajax requests.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.1.0 `WP_DEBUG_LOG` can be a file path.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -481,7 +481,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> error_reporting( E_CORE_ERROR | E_CORE_WARNING | E_COMPILE_ERROR | E_ERROR | E_WARNING | E_PARSE | E_USER_ERROR | E_USER_WARNING | E_RECOVERABLE_ERROR );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( defined( 'XMLRPC_REQUEST' ) || defined( 'REST_REQUEST' ) || ( defined( 'WP_INSTALLING' ) && WP_INSTALLING ) || wp_doing_ajax() || wp_is_json_request() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ defined( 'XMLRPC_REQUEST' ) || defined( 'REST_REQUEST' ) || defined( 'MS_FILES_REQUEST' ) ||
+ ( defined( 'WP_INSTALLING' ) && WP_INSTALLING ) ||
+ wp_doing_ajax() || wp_is_json_request() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> ini_set( 'display_errors', 0 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesmsfilesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/ms-files.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/ms-files.php 2021-07-06 19:12:23 UTC (rev 51357)
+++ trunk/src/wp-includes/ms-files.php 2021-07-06 20:20:51 UTC (rev 51358)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,6 +8,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @subpackage Multisite
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+define( 'MS_FILES_REQUEST', true );
</ins><span class="cx" style="display: block; padding: 0 10px"> define( 'SHORTINIT', true );
</span><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __DIR__ ) . '/wp-load.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,8 +18,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> ms_file_constants();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-error_reporting( 0 );
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( '1' == $current_blog->archived || '1' == $current_blog->spam || '1' == $current_blog->deleted ) {
</span><span class="cx" style="display: block; padding: 0 10px"> status_header( 404 );
</span><span class="cx" style="display: block; padding: 0 10px"> die( '404 — File not found.' );
</span></span></pre></div>
<a id="trunktestsphpunittestsloadwpDebugModephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/load/wpDebugMode.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/load/wpDebugMode.php (rev 0)
+++ trunk/tests/phpunit/tests/load/wpDebugMode.php 2021-07-06 20:20:51 UTC (rev 51358)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,62 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Unit tests for `wp_debug_mode()`.
+ *
+ * @package WordPress
+ * @subpackage UnitTests
+ * @since 5.9.0
+ */
+
+/**
+ * Class Test_WP_Debug_Mode.
+ *
+ * @group load.php
+ * @group wp-debug-mode
+ * @covers ::wp_debug_mode
+ *
+ * @since 5.9.0
+ */
+class Test_WP_Debug_Mode extends WP_UnitTestCase {
+ /**
+ * Test: `wp_debug_mode()` should log, but not display, errors for `ms-files.php`.
+ *
+ * @ticket 53493
+ *
+ * @since 5.9.0
+ */
+ public function test_ms_files_logs_but_doesnt_display_errors() {
+ /*
+ * Global constants can't be mocked in PHPUnit, so this can only run with the expected
+ * values already set in `wp-tests-config.php`. Unfortunately, that means it won't run in
+ * automated workflows, but it's still useful when testing locally.
+ *
+ * It may be possible to enable automated workflows by mocking `define()`, or by setting up
+ * addition automated flows that initialize the tests with different values for the constants.
+ * At the moment, though, neither of those seem to provide enough benefit to justify the time
+ * investment.
+ *
+ * @link https://theaveragedev.com/mocking-constants-in-tests/
+ */
+ if ( true !== WP_DEBUG || true !== WP_DEBUG_DISPLAY || true !== WP_DEBUG_LOG ) {
+ $this->markTestSkipped( 'Test requires setting `WP_DEBUG_*` constants in `wp-tests-config.php` to expected values.' );
+ }
+
+ // `display_errors` should be _on_ because of `WP_DEBUG_DISPLAY`.
+ wp_debug_mode();
+
+ $this->assertSame( E_ALL, (int) ini_get( 'error_reporting' ) );
+ $this->assertSame( '1', ini_get( 'display_errors' ) );
+ $this->assertSame( '1', ini_get( 'log_errors' ) );
+ $this->assertStringContainsString( 'debug.log', ini_get( 'error_log' ) );
+
+ // `display_errors` should be _off_ now, because of `MS_FILES_REQUEST`.
+ define( 'MS_FILES_REQUEST', true );
+ wp_debug_mode();
+
+ $this->assertSame( E_ALL, (int) ini_get( 'error_reporting' ) );
+ $this->assertSame( '0', ini_get( 'display_errors' ) );
+ $this->assertSame( '1', ini_get( 'log_errors' ) );
+ $this->assertStringContainsString( 'debug.log', ini_get( 'error_log' ) );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/load/wpDebugMode.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>