PHP 8.4 support (#157)

cnizzardini · web-flow · commit a5d1a79fa4a4 · 2025-10-29T18:36:58.000-04:00
* Remove ResponseModifier that has been deprecated since Cake 5.0.0

* Handle deprecations introduce in cakephp/authentication 3.3.0

* Rename argument to $middlewareQueue to match interface.

* Temp composer update for testing

* better CI for lower/upper bounds between cakephp versions

* wip

* wip

* fix debugkit dev dependency version constraint

* Handle BC with CakePHP 5.0

* continue dealing with this damn thing

* update composer settings
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -124,7 +124,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: ['~5.0', '~5.1']
+        version: ['~5.0.0', '~5.2']
     steps:
       - name: Checkout
         uses: actions/checkout@v2
diff --git a/composer.json b/composer.json
@@ -14,7 +14,6 @@
         "cakephp/migrations": "^4.0",
         "cakephp/plugin-installer": "^1.3",
         "cnizzardini/cakephp-swagger-bake": "^3.0",
-        "kcs/class-finder": "^0.3",
         "mixerapi/core": "^2.0",
         "mobiledetect/mobiledetectlib": "^2.8"
     },
@@ -24,7 +23,7 @@
         "cakephp/authentication": "^3.0",
         "cakephp/bake": "^3.0",
         "cakephp/cakephp-codesniffer": "^4.2",
-        "cakephp/debug_kit": "5.x-dev",
+        "cakephp/debug_kit": "^5.0",
         "dereuromark/cakephp-ide-helper": "^2.0",
         "firebase/php-jwt": "^6.2",
         "friendsofcake/search": "^7.0",
diff --git a/plugins/bake/tests/test_app/src/Application.php b/plugins/bake/tests/test_app/src/Application.php
@@ -11,9 +11,9 @@
 
 class Application extends BaseApplication
 {
-    public function middleware(MiddlewareQueue $middleware): MiddlewareQueue
+    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
     {
-        return $middleware;
+        return $middlewareQueue;
     }
 
     public function bootstrap(): void
diff --git a/plugins/collection-view/tests/test_app/src/Application.php b/plugins/collection-view/tests/test_app/src/Application.php
@@ -11,9 +11,9 @@
 
 class Application extends BaseApplication
 {
-    public function middleware(MiddlewareQueue $middleware): MiddlewareQueue
+    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
     {
-        return $middleware->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
+        return $middlewareQueue->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
     }
 
     public function bootstrap(): void
diff --git a/plugins/crud/tests/TestCase/ControllerTest.php b/plugins/crud/tests/TestCase/ControllerTest.php
@@ -45,6 +45,7 @@ public function test_view(): void
 
     public function test_add(): void
     {
+        $this->disableErrorHandlerMiddleware();
         $this->configRequest([
             'headers' => ['Content-Type' => 'application/json']
         ]);
diff --git a/plugins/crud/tests/test_app/src/Application.php b/plugins/crud/tests/test_app/src/Application.php
@@ -11,9 +11,9 @@
 
 class Application extends BaseApplication
 {
-    public function middleware(MiddlewareQueue $middleware): MiddlewareQueue
+    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
     {
-        return $middleware->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
+        return $middlewareQueue->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
     }
 
     public function bootstrap(): void
diff --git a/plugins/exception-render/tests/test_app/src/Application.php b/plugins/exception-render/tests/test_app/src/Application.php
@@ -11,9 +11,9 @@
 
 class Application extends BaseApplication
 {
-    public function middleware(MiddlewareQueue $middleware): MiddlewareQueue
+    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
     {
-        return $middleware->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
+        return $middlewareQueue->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
     }
 
     public function bootstrap(): void
diff --git a/plugins/hal-view/src/Plugin.php b/plugins/hal-view/src/Plugin.php
@@ -5,14 +5,13 @@
 
 use Cake\Core\BasePlugin;
 use Cake\Core\PluginApplicationInterface;
-use MixerApi\Core\Response\ResponseModifier;
 
 class Plugin extends BasePlugin
 {
     /**
      * Plugin name.
      *
-     * @var string
+     * @var string|null
      */
     protected ?string $name = 'MixerApi/HalView';
 
@@ -44,23 +43,12 @@ class Plugin extends BasePlugin
      */
     protected bool $routesEnabled = false;
 
-    /**
-     * @var string
-     */
-    private const EXT = 'haljson';
-
-    /**
-     * @var string
-     */
-    private const VIEW_CLASS = 'MixerApi/HalView.HalJson';
-
     /**
      * @param \Cake\Core\PluginApplicationInterface $app PluginApplicationInterface
      * @return void
      */
     public function bootstrap(PluginApplicationInterface $app): void
     {
         parent::bootstrap($app);
-        (new ResponseModifier(self::EXT, self::VIEW_CLASS))->listen();
     }
 }
diff --git a/plugins/hal-view/tests/test_app/src/Application.php b/plugins/hal-view/tests/test_app/src/Application.php
@@ -11,9 +11,9 @@
 
 class Application extends BaseApplication
 {
-    public function middleware(MiddlewareQueue $middleware): MiddlewareQueue
+    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
     {
-        return $middleware->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
+        return $middlewareQueue->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
     }
 
     public function bootstrap(): void
diff --git a/plugins/json-ld-view/tests/test_app/src/Application.php b/plugins/json-ld-view/tests/test_app/src/Application.php
@@ -11,9 +11,9 @@
 
 class Application extends BaseApplication
 {
-    public function middleware(MiddlewareQueue $middleware): MiddlewareQueue
+    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
     {
-        return $middleware->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
+        return $middlewareQueue->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
     }
 
     public function bootstrap(): void
diff --git a/plugins/jwt-auth/tests/test_app/src/Application.php b/plugins/jwt-auth/tests/test_app/src/Application.php
@@ -35,18 +35,13 @@ public function bootstrap(): void
     /**
      * @inheritDoc
      */
-    public function middleware(MiddlewareQueue $middleware): MiddlewareQueue
+    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
     {
-        $middleware->add(new ErrorHandlerMiddleware(Configure::read('Error')))
+        return $middlewareQueue->add(new ErrorHandlerMiddleware(Configure::read('Error')))
             // Other middleware that CakePHP provides.
             ->add(new RoutingMiddleware($this))
             ->add(new BodyParserMiddleware())
-
-            // Add the AuthenticationMiddleware. It should be
-            // after routing and body parser.
             ->add(new AuthenticationMiddleware($this));
-
-        return $middleware;
     }
 
     /**
@@ -98,44 +93,45 @@ public function getAuthenticationService(ServerRequestInterface $request): Authe
                 AbstractIdentifier::CREDENTIAL_USERNAME => 'email',
                 AbstractIdentifier::CREDENTIAL_PASSWORD => 'password',
             ],
-            'loginUrl' => '/test/login.json'
+            'loginUrl' => '/test/login.json',
+            'identifier' => [
+                'Authentication.Password' => [
+                    'fields' => [
+                        AbstractIdentifier::CREDENTIAL_USERNAME => 'email',
+                        AbstractIdentifier::CREDENTIAL_PASSWORD => 'password',
+                    ],
+                    'resolver' => [
+                        'className' => 'Authentication.Orm',
+                        'userModel' => 'Users',
+                    ],
+                    'passwordHasher' => [
+                        'className' => 'Authentication.Fallback',
+                        'hashers' => [
+                            'Authentication.Default',
+                            [
+                                'className' => 'Authentication.Legacy',
+                                'hashType' => 'md5',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
         ]);
 
-        $service->loadIdentifier('Authentication.JwtSubject');
-
         if (str_starts_with(haystack: $config->getAlg(), needle: 'HS')) {
             $service->loadAuthenticator('Authentication.Jwt', [
                 'secretKey' => $config->getSecret(),
                 'algorithm' => $config->getAlg(),
+                'identifier' => 'Authentication.JwtSubject',
             ]);
         } else if (str_starts_with(haystack: $config->getAlg(), needle: 'RS')) {
             $service->loadAuthenticator('Authentication.Jwt', [
                 'jwks' => (new JwkSet)->getKeySet(),
                 'algorithm' => $config->getAlg(),
+                'identifier' => 'Authentication.JwtSubject',
             ]);
         }
 
-        $service->loadIdentifier('Authentication.Password', [
-            'fields' => [
-                AbstractIdentifier::CREDENTIAL_USERNAME => 'email',
-                AbstractIdentifier::CREDENTIAL_PASSWORD => 'password',
-            ],
-            'resolver' => [
-                'className' => 'Authentication.Orm',
-                'userModel' => 'Users',
-            ],
-            'passwordHasher' => [
-                'className' => 'Authentication.Fallback',
-                'hashers' => [
-                    'Authentication.Default',
-                    [
-                        'className' => 'Authentication.Legacy',
-                        'hashType' => 'md5',
-                    ],
-                ],
-            ],
-        ]);
-
         return $service;
     }
 }
diff --git a/plugins/mixerapi/assets/app.php b/plugins/mixerapi/assets/app.php
@@ -109,9 +109,9 @@
          * Duration will be set to '+2 minutes' in bootstrap.php when debug = true
          * If you set 'className' => 'Null' core cache will be disabled.
          */
-        '_cake_core_' => [
+        '_cake_translations_' => [
             'className' => FileEngine::class,
-            'prefix' => 'myapp_cake_core_',
+            'prefix' => 'myapp_cake_translations_',
             'path' => CACHE . 'persistent' . DS,
             'serialize' => true,
             'duration' => '+1 years',
diff --git a/plugins/mixerapi/tests/test_app/src/Application.php b/plugins/mixerapi/tests/test_app/src/Application.php
@@ -10,9 +10,9 @@
 
 class Application extends BaseApplication
 {
-    public function middleware(MiddlewareQueue $middleware): MiddlewareQueue
+    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
     {
-        return $middleware->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
+        return $middlewareQueue->add(new RoutingMiddleware($this))->add(new BodyParserMiddleware());
     }
 
     public function bootstrap(): void
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -1,6 +1,7 @@
 <?php
 declare(strict_types=1);
 
+use Cake\Cache\Cache;
 use Cake\Core\Configure;
 use Cake\TestSuite\Fixture\SchemaLoader;
 
@@ -35,3 +36,16 @@
  */
 putenv('DB_DSN=sqlite:///:memory:');
 (new SchemaLoader())->loadInternalFile(__DIR__ . DS . 'schema.php');
+
+// @todo: Remove when support for CakePHP 5.0 is dropped
+if (!Cache::getConfig('_cake_core_')) {
+    Cache::setConfig([
+        '_cake_core_' => [
+            'engine' => 'File',
+            'prefix' => 'cake_core_',
+            'serialize' => true,
+            'path' => CACHE,
+        ],
+    ]);
+}
+

Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,9 @@`
`11`	`11`
`12`	`12`	`class Application extends BaseApplication`
`13`	`13`	`{`
`14`		`- public function middleware(MiddlewareQueue $middleware): MiddlewareQueue`
	`14`	`+ public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue`
`15`	`15`	`{`
`16`		`- return $middleware;`
	`16`	`+ return $middlewareQueue;`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`public function bootstrap(): void`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ public function test_view(): void`
`45`	`45`
`46`	`46`	`public function test_add(): void`
`47`	`47`	`{`
	`48`	`+ $this->disableErrorHandlerMiddleware();`
`48`	`49`	`$this->configRequest([`
`49`	`50`	`'headers' => ['Content-Type' => 'application/json']`
`50`	`51`	`]);`