Merge pull request #142 from mairo744/update/php-84-fix

gsteel · web-flow · commit 89d74b582723 · 2025-08-04T23:10:04.000+01:00
Fix failing tests on PHP 8.4 (follow-up to mezzio-swoole#137)
diff --git a/.laminas-ci.json b/.laminas-ci.json
@@ -1,5 +1,6 @@
 {
-    "extensions": [
-        "inotify"
-    ]
+    "extensions": [],
+    "ignore_php_platform_requirements": {
+        "8.4": true
+    }
 }
diff --git a/.laminas-ci/pre-install.sh b/.laminas-ci/pre-install.sh
@@ -4,4 +4,12 @@ JOB=$3
 PHP_VERSION=$(echo "${JOB}" | jq -r '.php')
 
 apt update
-apt install -y "php${PHP_VERSION}-swoole"
+
+# Build package list
+PACKAGES="php${PHP_VERSION}-swoole"
+if [ "$PHP_VERSION" != "8.4" ]; then
+    PACKAGES="$PACKAGES php${PHP_VERSION}-inotify"
+fi
+
+# Install all packages at once
+apt install -y $PACKAGES
diff --git a/composer.json b/composer.json
@@ -35,7 +35,7 @@
     "extra": {
     },
     "require": {
-        "php": "~8.2.0 || ~8.3.0",
+        "php": "~8.2.0 || ~8.3.0 || ~8.4.0",
         "dflydev/fig-cookies": "^2.0.1 || ^3.0",
         "laminas/laminas-cli": "^1.8",
         "laminas/laminas-diactoros": "^2.25.2 || ^3.0",
@@ -56,7 +56,7 @@
         "laminas/laminas-servicemanager": "^3.20",
         "phpunit/phpunit": "^10.5",
         "psalm/plugin-phpunit": "^0.18.4",
-        "swoole/ide-helper": "^5.0.3",
+        "swoole/ide-helper": "^6.0",
         "vimeo/psalm": "^5.19"
     },
     "suggest": {
diff --git a/composer.lock b/composer.lock
diff --git a/docs/book/how_it_works.md b/docs/book/how_it_works.md
diff --git a/docs/book/intro.md b/docs/book/intro.md
diff --git a/docs/book/logging.md b/docs/book/logging.md
diff --git a/docs/book/static-resources.md b/docs/book/static-resources.md
diff --git a/docs/book/v2/hot-code-reload.md b/docs/book/v2/hot-code-reload.md
@@ -55,7 +55,7 @@ that Swoole will not reload any of the following:
 
 - New routes
 - New pipeline middleware
-- The `Application` instance, _or any delegators used to modify it_.
+- The `Application` instance, *or any delegators used to modify it*.
 - The Swoole HTTP server itself.
 
 This limitation exists because the hot code reload features use the
diff --git a/docs/book/v2/static-resources.md b/docs/book/v2/static-resources.md
@@ -23,7 +23,7 @@ then checks to see if the file exists in the document root. If it does, it will
 serve it.
 
 <!-- markdownlint-disable-next-line header-increment -->
-> ### Disabling static resources
+> ## Disabling static resources
 >
 > - Since 2.1.0
 >
diff --git a/docs/book/v2/table.md b/docs/book/v2/table.md
@@ -10,7 +10,7 @@ tables by extending the `Swoole\Table` class, defining the appropriate columns
 and table size inside of the constructor.
 
 <!-- markdownlint-disable-next-line header-increment -->
-> ### Initialize the Table Within the Constructor
+> ## Initialize the Table Within the Constructor
 >
 > You **must** call your table's `create()` method, and this **must** be done
 > prior to initializing any worker processes; if you fail to do so, your table
diff --git a/docs/book/v3/cookbook/static-resource-listener-removal.md b/docs/book/v3/cookbook/static-resource-listener-removal.md
@@ -27,4 +27,3 @@ return [
     // ...
 ];
 ```
-
diff --git a/docs/book/v3/cookbook/swoole-not-starting.md b/docs/book/v3/cookbook/swoole-not-starting.md
@@ -38,7 +38,7 @@ $aggregator = new ConfigAggregator([
 ```
 
 Note the position of the `Mezzio\Swoole\ConfigProvider::class` entry at the top.
-This can happen if you have previously removed the original entry from the `config/config.php` as provided by the skeleton project, or if you hand-crafted your `config/config.php` file`, and then later used `composer require mezzio/mezzio-swoole`, as the [component installer](https://docs.laminas.dev/laminas-component-installer/) injects at the start of the aggregator definition.
+This can happen if you have previously removed the original entry from the `config/config.php` as provided by the skeleton project, or if you hand-crafted your `config/config.php` file, and then later used `composer require mezzio/mezzio-swoole`, as the [component installer](https://docs.laminas.dev/laminas-component-installer/) injects at the start of the aggregator definition.
 
 The mezzio-swoole package provides a custom implementation of an [HTTP Handler Runner](https://docs.laminas.dev/laminas-httphandlerrunner/).
 Because it defines the _same service name_ as the one provided by laminas/laminas-httphandlerrunner, the mezzio-swoole `ConfigProvider` must appear _later_ during aggregation to ensure it takes precedence:
diff --git a/docs/book/v3/events.md b/docs/book/v3/events.md
@@ -243,18 +243,18 @@ We define the following listeners for the specified events.
 All events and listeners are in the `Mezzio\Swoole\Event` namespace.
 
 - `ServerStartEvent`:
-  - `ServerStartListener`: initializes the master and manager PIDs, sets the working directory, sets the master process name, and logs that the server has started.
+    - `ServerStartListener`: initializes the master and manager PIDs, sets the working directory, sets the master process name, and logs that the server has started.
 - `WorkerStartEvent`:
-  - `WorkerStartListener`: sets the working directory, sets the worker process name, and logs the worker has started.
-  - `HotCodeReloaderWorkerStartListener`: initiates a hot code reload within the worker.
+    - `WorkerStartListener`: sets the working directory, sets the worker process name, and logs the worker has started.
+    - `HotCodeReloaderWorkerStartListener`: initiates a hot code reload within the worker.
 - `RequestEvent`
-  - `RequestHandlerRequestListener`: marshals a PSR-7 request from the Swoole HTTP request, passes it to the application request handler to generate a PSR-7 response, marshals and sends the Swoole HTTP Response from the PSR-7 response, and logs the request.
+    - `RequestHandlerRequestListener`: marshals a PSR-7 request from the Swoole HTTP request, passes it to the application request handler to generate a PSR-7 response, marshals and sends the Swoole HTTP Response from the PSR-7 response, and logs the request.
     If an error occurs marshaling the PSR-7 request, it will generate a PSR-7 error response, emit it, and log the request.
     In both cases, it marks the `responseSent()` in the event, stopping propagation.
-  - `StaticResourceRequestListener`: attempts to process a static resource request; if it was able, it sends the Swoole HTTP Response, logs the access, and marks the `responseSent()` in the event, stopping propagation.
-    Otherwise, it returns, allowing the next listener to handle the event.
+    - `StaticResourceRequestListener`: attempts to process a static resource request; if it was able, it sends the Swoole HTTP Response, logs the access, and marks the `responseSent()` in the event, stopping propagation.
+      Otherwise, it returns, allowing the next listener to handle the event.
 - `ServerShutdownEvent`:
-  - `ServerShutdownListener`: destroys the master and manager PIDs, all worker processes, and logs the server shutdown.
+    - `ServerShutdownListener`: destroys the master and manager PIDs, all worker processes, and logs the server shutdown.
 
 > ### Short-circuiting
 >
diff --git a/docs/book/v3/hot-code-reload.md b/docs/book/v3/hot-code-reload.md
@@ -62,7 +62,7 @@ that Swoole will not reload any of the following:
 
 - New routes
 - New pipeline middleware
-- The `Application` instance, _or any delegators used to modify it_.
+- The `Application` instance, *or any delegators used to modify it*.
 - The Swoole HTTP server itself.
 
 This limitation exists because the hot code reload features use the
diff --git a/docs/book/v3/table.md b/docs/book/v3/table.md
@@ -10,7 +10,7 @@ tables by extending the `Swoole\Table` class, defining the appropriate columns
 and table size inside of the constructor.
 
 <!-- markdownlint-disable-next-line header-increment-->
-> ### Initialize the Table Within the Constructor
+> ## Initialize the Table Within the Constructor
 >
 > You **must** call your table's `create()` method, and this **must** be done
 > prior to initializing any worker processes; if you fail to do so, your table
diff --git a/docs/book/v4/cookbook/static-resource-listener-removal.md b/docs/book/v4/cookbook/static-resource-listener-removal.md
@@ -27,4 +27,3 @@ return [
     // ...
 ];
 ```
-
diff --git a/docs/book/v4/cookbook/swoole-not-starting.md b/docs/book/v4/cookbook/swoole-not-starting.md
@@ -38,7 +38,7 @@ $aggregator = new ConfigAggregator([
 ```
 
 Note the position of the `Mezzio\Swoole\ConfigProvider::class` entry at the top.
-This can happen if you have previously removed the original entry from the `config/config.php` as provided by the skeleton project, or if you hand-crafted your `config/config.php` file`, and then later used `composer require mezzio/mezzio-swoole`, as the [component installer](https://docs.laminas.dev/laminas-component-installer/) injects at the start of the aggregator definition.
+This can happen if you have previously removed the original entry from the `config/config.php` as provided by the skeleton project, or if you hand-crafted your `config/config.php` file, and then later used `composer require mezzio/mezzio-swoole`, as the [component installer](https://docs.laminas.dev/laminas-component-installer/) injects at the start of the aggregator definition.
 
 The mezzio-swoole package provides a custom implementation of an [HTTP Handler Runner](https://docs.laminas.dev/laminas-httphandlerrunner/).
 Because it defines the _same service name_ as the one provided by laminas/laminas-httphandlerrunner, the mezzio-swoole `ConfigProvider` must appear _later_ during aggregation to ensure it takes precedence:
diff --git a/docs/book/v4/events.md b/docs/book/v4/events.md
@@ -243,18 +243,18 @@ We define the following listeners for the specified events.
 All events and listeners are in the `Mezzio\Swoole\Event` namespace.
 
 - `ServerStartEvent`:
-  - `ServerStartListener`: initializes the master and manager PIDs, sets the working directory, sets the master process name, and logs that the server has started.
+    - `ServerStartListener`: initializes the master and manager PIDs, sets the working directory, sets the master process name, and logs that the server has started.
 - `WorkerStartEvent`:
-  - `WorkerStartListener`: sets the working directory, sets the worker process name, and logs the worker has started.
-  - `HotCodeReloaderWorkerStartListener`: initiates a hot code reload within the worker.
+    - `WorkerStartListener`: sets the working directory, sets the worker process name, and logs the worker has started.
+    - `HotCodeReloaderWorkerStartListener`: initiates a hot code reload within the worker.
 - `RequestEvent`
-  - `RequestHandlerRequestListener`: marshals a PSR-7 request from the Swoole HTTP request, passes it to the application request handler to generate a PSR-7 response, marshals and sends the Swoole HTTP Response from the PSR-7 response, and logs the request.
+    - `RequestHandlerRequestListener`: marshals a PSR-7 request from the Swoole HTTP request, passes it to the application request handler to generate a PSR-7 response, marshals and sends the Swoole HTTP Response from the PSR-7 response, and logs the request.
     If an error occurs marshaling the PSR-7 request, it will generate a PSR-7 error response, emit it, and log the request.
     In both cases, it marks the `responseSent()` in the event, stopping propagation.
-  - `StaticResourceRequestListener`: attempts to process a static resource request; if it was able, it sends the Swoole HTTP Response, logs the access, and marks the `responseSent()` in the event, stopping propagation.
-    Otherwise, it returns, allowing the next listener to handle the event.
+    - `StaticResourceRequestListener`: attempts to process a static resource request; if it was able, it sends the Swoole HTTP Response, logs the access, and marks the `responseSent()` in the event, stopping propagation.
+      Otherwise, it returns, allowing the next listener to handle the event.
 - `ServerShutdownEvent`:
-  - `ServerShutdownListener`: destroys the master and manager PIDs, all worker processes, and logs the server shutdown.
+    - `ServerShutdownListener`: destroys the master and manager PIDs, all worker processes, and logs the server shutdown.
 
 > ### Short-circuiting
 >
diff --git a/docs/book/v4/hot-code-reload.md b/docs/book/v4/hot-code-reload.md
@@ -62,7 +62,7 @@ that Swoole will not reload any of the following:
 
 - New routes
 - New pipeline middleware
-- The `Application` instance, _or any delegators used to modify it_.
+- The `Application` instance, *or any delegators used to modify it*.
 - The Swoole HTTP server itself.
 
 This limitation exists because the hot code reload features use the
diff --git a/docs/book/v4/table.md b/docs/book/v4/table.md
@@ -10,7 +10,7 @@ tables by extending the `Swoole\Table` class, defining the appropriate columns
 and table size inside of the constructor.
 
 <!-- markdownlint-disable-next-line header-increment-->
-> ### Initialize the Table Within the Constructor
+> ## Initialize the Table Within the Constructor
 >
 > You **must** call your table's `create()` method, and this **must** be done
 > prior to initializing any worker processes; if you fail to do so, your table
diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -77,12 +77,6 @@
         <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/Http/Server.php" />
         <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/Http2/Client.php" />
         <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/Iterator.php" />
-        <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/MySQL.php" />
-        <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/MySQL/Exception.php" />
-        <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/MySQL/Statement.php" />
-        <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/PostgreSQL.php" />
-        <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/PostgreSQLStatement.php" />
-        <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/Redis.php" />
         <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/Scheduler.php" />
         <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/Socket.php" />
         <file name="vendor/swoole/ide-helper/src/swoole/Swoole/Coroutine/Socket/Exception.php" />
diff --git a/src/HttpServerFactory.php b/src/HttpServerFactory.php
@@ -111,7 +111,7 @@ public function __invoke(ContainerInterface $container): SwooleHttpServer
 
         $enableCoroutine = $swooleConfig['enable_coroutine'] ?? false;
         if ($enableCoroutine && method_exists(SwooleRuntime::class, 'enableCoroutine')) {
-            SwooleRuntime::enableCoroutine(true);
+            SwooleRuntime::enableCoroutine();
         }
 
         $httpServer    = new SwooleHttpServer($host, $port, $mode, $protocol);
diff --git a/test/SwooleRequestHandlerRunnerTest.php b/test/SwooleRequestHandlerRunnerTest.php
@@ -21,12 +21,14 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Psr\EventDispatcher\EventDispatcherInterface;
+use ReflectionProperty;
 use Swoole\Http\Request as SwooleHttpRequest;
 use Swoole\Http\Response as SwooleHttpResponse;
 use Swoole\Http\Server as SwooleHttpServer;
 
 use function random_int;
 
+use const PHP_VERSION_ID;
 use const SWOOLE_BASE;
 use const SWOOLE_PROCESS;
 
@@ -78,7 +80,11 @@ public function testConstructorRaisesExceptionWhenManagerPidIsNotZero(): void
 
     public function testRunRegistersExpectedHttpServerListenersAndStartsServerWhenInBaseMode(): void
     {
-        $this->httpServer->mode = SWOOLE_BASE;
+        if (PHP_VERSION_ID >= 80300) {
+            $reflection = new ReflectionProperty($this->httpServer, 'mode');
+            $reflection->setValue($this->httpServer, SWOOLE_BASE);
+        }
+
         $this->httpServer
             ->expects($this->exactly(10))
             ->method('on')
@@ -104,7 +110,12 @@ public function testRunRegistersExpectedHttpServerListenersAndStartsServerWhenIn
 
     public function testRunRegistersExpectedHttpServerListenersAndStartsServerWhenInProcessMode(): void
     {
-        $this->httpServer->mode = SWOOLE_PROCESS;
+        if (PHP_VERSION_ID >= 80200 && PHP_VERSION_ID < 80300) {
+            $this->markTestSkipped('Test relies on modifying readonly properties, which is not allowed in PHP 8.2+');
+        }
+
+        $reflection = new ReflectionProperty($this->httpServer, 'mode');
+        $reflection->setValue($this->httpServer, SWOOLE_PROCESS);
         $this->httpServer
             ->expects($this->exactly(12))
             ->method('on')

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`		`- "extensions": [`
`3`		`- "inotify"`
`4`		`- ]`
	`2`	`+ "extensions": [],`
	`3`	`+ "ignore_php_platform_requirements": {`
	`4`	`+ "8.4": true`
	`5`	`+ }`
`5`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ then checks to see if the file exists in the document root. If it does, it will`
`23`	`23`	`serve it.`
`24`	`24`
`25`	`25`	`<!-- markdownlint-disable-next-line header-increment -->`
`26`		`-> ### Disabling static resources`
	`26`	`+> ## Disabling static resources`
`27`	`27`	`>`
`28`	`28`	`> - Since 2.1.0`
`29`	`29`	`>`