<!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>[59105] trunk: Code Modernization: Fix trigger_error() with E_USER_ERROR deprecation in Text_Diff::_check().</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/59105">59105</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/59105","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-09-27 17:51:49 +0000 (Fri, 27 Sep 2024)</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'>Code Modernization: Fix trigger_error() with E_USER_ERROR deprecation in Text_Diff::_check().
PHP 8.4 deprecates the use of `trigger_errror()` with `E_USER_ERROR` as the error level, as there are a number of gotchas to this way of creating a `Fatal Error` (`finally` blocks not executing, destructors not executing). The recommended replacements are either to use exceptions or to do a hard `exit`.
This is an unmaintained external dependency; thus, the fix is made in the WP specific copy of the dependency.
Now, there were basically three options:
* Silence the deprecation until PHP 9.0 and delay properly solving this until then.
This would lead to an awkward solution, as prior to PHP 8.0, error silencing would apply to all errors, while, as of PHP 8.0, it will no longer apply to fatal errors.
It also would only buy us some time and wouldn't actually solve anything.
* Use `exit($status)`.
This would make the code untestable and would disable handling of these errors via custom error handlers, which makes this an undesirable solution.
* Throw an exception.
This makes for the most elegant solution with the least BC-breaking impact.
The third option is implemented which:
* Introduces a new `Text_Exception` class.
* Starts using that in the `Text_Diff::_check()` method in all applicable places.
* Adds tests for the first two error conditions.
References:
* https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_passing_e_user_error_to_trigger_error
* https://www.php.net/manual/en/migration80.incompatible.php
Follow-up to <a href="https://core.trac.wordpress.org/changeset/59070">[59070]</a>, <a href="https://core.trac.wordpress.org/changeset/52978">[52978]</a>, <a href="https://core.trac.wordpress.org/changeset/7747">[7747]</a>.
Props jrf.
See <a href="https://core.trac.wordpress.org/ticket/62061">#62061</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesTextDiffphp">trunk/src/wp-includes/Text/Diff.php</a></li>
<li><a href="#trunksrcwpincludeswpdiffphp">trunk/src/wp-includes/wp-diff.php</a></li>
<li><a href="#trunktestsphpunittestsdiffText_Diff_Check_Testphp">trunk/tests/phpunit/tests/diff/Text_Diff_Check_Test.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesTextExceptionphp">trunk/src/wp-includes/Text/Exception.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesTextDiffphp"></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/Text/Diff.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/Text/Diff.php 2024-09-27 16:35:16 UTC (rev 59104)
+++ trunk/src/wp-includes/Text/Diff.php 2024-09-27 17:51:49 UTC (rev 59105)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -260,24 +260,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function _check($from_lines, $to_lines)
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="cx" style="display: block; padding: 0 10px"> if (serialize($from_lines) != serialize($this->getOriginal())) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- trigger_error("Reconstructed original does not match", E_USER_ERROR);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ throw new Text_Exception("Reconstructed original does not match");
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if (serialize($to_lines) != serialize($this->getFinal())) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- trigger_error("Reconstructed final does not match", E_USER_ERROR);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ throw new Text_Exception("Reconstructed final does not match");
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $rev = $this->reverse();
</span><span class="cx" style="display: block; padding: 0 10px"> if (serialize($to_lines) != serialize($rev->getOriginal())) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- trigger_error("Reversed original does not match", E_USER_ERROR);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ throw new Text_Exception("Reversed original does not match");
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if (serialize($from_lines) != serialize($rev->getFinal())) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- trigger_error("Reversed final does not match", E_USER_ERROR);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ throw new Text_Exception("Reversed final does not match");
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $prevtype = null;
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ($this->_edits as $edit) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ($prevtype !== null && $edit instanceof $prevtype) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- trigger_error("Edit sequence is non-optimal", E_USER_ERROR);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ throw new Text_Exception("Edit sequence is non-optimal");
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $prevtype = get_class($edit);
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesTextExceptionphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/Text/Exception.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/Text/Exception.php (rev 0)
+++ trunk/src/wp-includes/Text/Exception.php 2024-09-27 17:51:49 UTC (rev 59105)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,11 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Exception for errors from the Text_Diff package.
+ *
+ * {@internal This is a WP native addition to the external Text_Diff package.}
+ *
+ * @package WordPress
+ * @subpackage Text_Diff
+ */
+
+class Text_Exception extends Exception {}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/src/wp-includes/Text/Exception.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><a id="trunksrcwpincludeswpdiffphp"></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/wp-diff.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/wp-diff.php 2024-09-27 16:35:16 UTC (rev 59104)
+++ trunk/src/wp-includes/wp-diff.php 2024-09-27 17:51:49 UTC (rev 59105)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,6 +15,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/Text/Diff/Renderer.php';
</span><span class="cx" style="display: block; padding: 0 10px"> /** Text_Diff_Renderer_inline class */
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/Text/Diff/Renderer/inline.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** Text_Exception class */
+ require ABSPATH . WPINC . '/Text/Exception.php';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/class-wp-text-diff-renderer-table.php';
</span></span></pre></div>
<a id="trunktestsphpunittestsdiffText_Diff_Check_Testphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/diff/Text_Diff_Check_Test.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/diff/Text_Diff_Check_Test.php 2024-09-27 16:35:16 UTC (rev 59104)
+++ trunk/tests/phpunit/tests/diff/Text_Diff_Check_Test.php 2024-09-27 17:51:49 UTC (rev 59105)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,6 +23,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public static function set_up_before_class() {
</span><span class="cx" style="display: block; padding: 0 10px"> require_once ABSPATH . 'wp-includes/Text/Diff.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ require_once ABSPATH . 'wp-includes/Text/Exception.php';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -34,4 +35,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $diff = new Text_Diff( 'auto', array( self::FILE_A, self::FILE_B ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( $diff->_check( self::FILE_A, self::FILE_B ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ public function test_check_throws_exception_when_from_is_not_same_as_original() {
+ $this->expectException( Text_Exception::class );
+ $this->expectExceptionMessage( 'Reconstructed original does not match' );
+
+ $diff = new Text_Diff( 'auto', array( self::FILE_A, self::FILE_B ) );
+ $diff->_check( self::FILE_B, self::FILE_B );
+ }
+
+ public function test_check_throws_exception_when_to_is_not_same_as_final() {
+ $this->expectException( Text_Exception::class );
+ $this->expectExceptionMessage( 'Reconstructed final does not match' );
+
+ $diff = new Text_Diff( 'auto', array( self::FILE_A, self::FILE_B ) );
+ $diff->_check( self::FILE_A, self::FILE_A );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>