Middleware attribute

[xepozz]

Q	A
Is bugfix?	❌
New feature?	✔️
Breaks BC?	❌

It allows users to use middlewares like the following:

<?php

declare(strict_types=1);

namespace Yiisoft\Middleware\Dispatcher\Tests\Support;

use Nyholm\Psr7\Response;
use Psr\Http\Message\ResponseInterface;
use Yiisoft\Middleware\Dispatcher\Attribute\Middleware;

final class TestController
{
    public function index(): ResponseInterface
    {
        return new Response(200, ['test' => 'yii']);
    }

    #[Middleware([
        'class' => ResponseMiddleware::class,
        '__construct()' => [200],
    ])]
    public function error(): ResponseInterface
    {
        return new Response(404);
    }

    #[Middleware([
        'class' => SetHeaderMiddleware::class,
        '__construct()' => ['x-test1', 'yii1'],
    ])]
    #[Middleware([
        'class' => SetHeaderMiddleware::class,
        '__construct()' => ['x-test2', 'yii2'],
    ])]
    #[Middleware([
        'class' => SetHeaderMiddleware::class,
        '__construct()' => ['x-test3', 'yii3'],
    ])]
    public function severalMiddlewares(): ResponseInterface
    {
        return new Response(404);
    }
}

[what-the-diff]

PR Summary

• Introduction of New Middleware Class
  A new file was added which introduces a new class called Middleware. This class has a public property $definition, likely defining key aspects of the middleware.

• Enhancements to MiddlewareFactory Class
  Various improvements have been made to the MiddlewareFactory class. A method to set the $eventDispatcher property has been added, as well as a method for creating a new class that works with a callback and other properties. Both these new methods are then incorporated in existing ones to ensure improved functionality.

• Addition of New Test Cases
  A new test case was added for creating middleware from a controller class and action name. This will allow us to more thoroughly validate the accuracy of these processes.

• Creation of ResponseMiddleware and SetHeaderMiddleware Classes
  Two new classes were added that implement 'MiddlewareInterface'. These likely provide new functionalities related to handling responses and setting headers.

• Additions to TestController Class
  The TestController class has been improved by adding new methods. The error method includes a middleware attribute, while the severalMiddlewares method incorporates multiple middleware attributes. This is anticipated to optimize the testing capabilities within the system.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (91d8895) to head (89a00da).
⚠️ Report is 12 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff             @@
##              master       #93   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
- Complexity       109       116    +7     
===========================================
  Files              8         9    +1     
  Lines            291       300    +9     
===========================================
+ Hits             291       300    +9     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[samdark]

Interesting approach.

[vjik]

Why drop "readonly"?

[xepozz]

It was written before the rector changes

[vjik]

Suggest major refactoring...

1) Mark MiddlewareFactory as internal
2) Create MiddlewareFactory in constructor and replace private MiddlewareFactory $middlewareFactory, to:

private ContainerInterface $container,
private ?ParametersResolverInterface $parametersResolver = null

3. Pass currently instance of dispatcher to MiddlewareFactory constructor.

It's allow use MiddlewareDispatcher::withMiddlewares() into MiddlewareFactory.

[xepozz]

There are no reasons to make MiddlewareFactory internal

[vjik]

Agree with internal. But 2 and 3 is actual. MiddlewareFactory methods withEventDispatcher() and hasEventDispatcher() looks strange.