PHP 8.6 | Returning a value from a constructor is deprecated

[jrfnl]

As can be seen in this build, multiple tests are failing on PHP 8.6 with a "Deprecated: Returning a value from a constructor is deprecated" error.

This is related to the following PHP 8.6 RFC: https://wiki.php.net/rfc/deprecate-return-value-from-construct

The class constructors in the fixture code for these tests do not return or yield, so the error is caused by something in the wiring of Patchwork.

This needs investigation & fixing.

---

Detailed test failures

1) /home/runner/work/patchwork/patchwork/tests/anonymous-class-attribute.phpt
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'===DONE==='
+'Deprecated: Returning a value from a constructor is deprecated in /home/runner/work/patchwork/patchwork/tests/includes/AnonymousClassAttribute.php on line 6\n
+===DONE==='

/home/runner/work/patchwork/patchwork/tests/anonymous-class-attribute.phpt:21

2) /home/runner/work/patchwork/patchwork/tests/apply-scheduled-patches-only-once.phpt
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'===DONE==='
+'Deprecated: Returning a value from a constructor is deprecated in /home/runner/work/patchwork/patchwork/tests/includes/NamedObject.php on line 8\n
+===DONE==='

/home/runner/work/patchwork/patchwork/tests/apply-scheduled-patches-only-once.phpt:30

3) /home/runner/work/patchwork/patchwork/tests/closure-this.phpt
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'===DONE==='
+'Deprecated: Returning a value from a constructor is deprecated in /home/runner/work/patchwork/patchwork/tests/includes/NamedObject.php on line 8\n
+===DONE==='

--- Expected
+++ Actual
@@ @@
-'===DONE==='
+'Deprecated: Returning a value from a constructor is deprecated in /home/runner/work/patchwork/patchwork/tests/includes/RedefinitionOfNew.php on line 38\n
+===DONE==='

/home/runner/work/patchwork/patchwork/tests/redefine-new.phpt:19

9) /home/runner/work/patchwork/patchwork/tests/redefinition-new-anonymous-class-with-attribute.phpt
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'===DONE==='
+'Deprecated: Returning a value from a constructor is deprecated in /home/runner/work/patchwork/patchwork/tests/includes/AnonymousClassAttribute.php on line 6\n
+===DONE==='

/home/runner/work/patchwork/patchwork/tests/redefinition-new-anonymous-class-with-attribute.phpt:23

11) /home/runner/work/patchwork/patchwork/tests/stack-inspection.phpt
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'===DONE==='
+'Deprecated: Returning a value from a constructor is deprecated in /home/runner/work/patchwork/patchwork/tests/includes/NamedObject.php on line 8\n
+===DONE==='

/home/runner/work/patchwork/patchwork/tests/stack-inspection.phpt:45

---

[antecedent]

I think it is this: the RFC states that the deprecation notice shows up at compile time, whenever a return <expression>; statement is encountered inside a constructor – no matter if that statement is actually ever executed. (The RFC also says that bare return; statements without an expression are still fine.) Therefore, Patchwork must not inject any return <expression>; statements into constructors; but for the time being, it actually does. Currently, when it comes to injecting code into function (method) bodies, Patchwork will treat a constructor like an ordinary method.

This seems similar to #64, where adding a void return type caused the same kind of trouble. I will try to adapt the fix from that issue.

[antecedent]

The tests now seem to be failing on another case, require-missing.phpt. The reason seems unrelated, probably a change in PHP's error messages.

[jrfnl]

The tests now seem to be failing on another case, require-missing.phpt. The reason seems unrelated, probably a change in PHP's error messages.

Yes, it is (a change in PHP's error messages). I'd not created a PR to handle that yet as I know there is still some discussion ongoing about the precise wording of the updated error message, so fixing this now would be premature.