Skip to content

[DX] ADR usage #8153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 29 commits into from
Closed
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
c8050b1
Adding the ADR approach.
Guikingone Jul 14, 2017
0d0d4cc
Update service.rst
Guikingone Jul 14, 2017
7359837
Update service.rst
Guikingone Jul 14, 2017
885e696
Update service.rst
Guikingone Jul 14, 2017
220021e
Update service.rst
Guikingone Jul 14, 2017
1fda263
Update service.rst
Guikingone Jul 14, 2017
11c77c7
Update service.rst
Guikingone Jul 14, 2017
d21feb2
Update service.rst
Guikingone Jul 15, 2017
a449220
Update service.rst
Guikingone Jul 17, 2017
6d1ed62
Update service.rst
Guikingone Jul 17, 2017
a81b625
Update service.rst
Guikingone Aug 3, 2017
8444e98
Added the dedicated file and link from service.rst
Guikingone Aug 3, 2017
a93fa6c
Update adr.rst
Guikingone Aug 3, 2017
97bcbac
Update adr.rst
Guikingone Aug 3, 2017
72c2c74
Update service.rst
Guikingone Aug 3, 2017
666a89f
Update adr.rst
Guikingone Aug 3, 2017
c8625fb
Update adr.rst
Guikingone Aug 5, 2017
0d2022a
Corrected the index typo.
Guikingone Aug 5, 2017
582f4bf
Update adr.rst
Guikingone Aug 5, 2017
a237312
Update adr.rst
Guikingone Aug 6, 2017
cd46501
Update adr.rst
Guikingone Aug 16, 2017
24416f5
Update adr.rst
Guikingone Sep 12, 2017
dc6ddc6
Update adr.rst
Guikingone Oct 16, 2017
f1aad20
Update adr.rst
Guikingone Oct 16, 2017
16c8472
Update adr.rst
Guikingone Oct 16, 2017
eca9a0a
[ADD](Responder classe)[!P2]
Guikingone Nov 24, 2017
aa0a207
[FIX](Syntax)[!P2]
Guikingone Nov 24, 2017
551aed6
[FIX](ADR Repository)[!P2]
Guikingone Nov 24, 2017
3dacc68
fix(typo): fix on typo and space.
Guikingone Jan 24, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 170 additions & 0 deletions controller/adr.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
.. index::
single: Action Domain Responder approach

How to implement the ADR pattern
================================

In Symfony, you're used to implement the MVC pattern and extending the default :class:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Symfony has never promoted the MVC pattern (at least, not since version 2). Instead, we are presenting Symfony as being a Request/Response framework where the controller converts a Request to a Response via a Controller.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, my apologies for this words, the meaning of my "text" was to clearly say that a lot of developers use Symfony with MVC and that using this pattern is way more used than just transforming a Request into Response (which is handled by the framework in a certain way, the actual transformation occurs in the controller).

class.
Since the 3.3 update, Symfony is capable of using natively the ADR approach.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it is worth it to add a link to https://github.com/pmjones/adr


Updating your configuration
---------------------------

As the framework evolve, you must update the services.yml file in order to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"evolves"

use the latest features of the DependencyInjection component, this way, here's the updates::

# ...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can be removed?


services:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to add xml and PHP versions too.

_defaults:
autowire: true
autoconfigure: true
public: false

# Allow to load every actions
AppBundle\Action\:
resource: '../../src/AppBundle/Action/'
public: true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This behavior has been modified for 3.3, now all the services tagged with controller.service_arguments are public by definition and according to #8415 we can remove it so.


Once the file is updated, delete your Controller folder and create an Action class using the ADR principles, i.e::

<?php

namespace AppBundle\Action;

use Twig\Environment;
use Symfony\Component\HttpFoundation\Response;

final class HelloAction
{
private $twig;

public function __construct(Environment $twig)
{
$this->twig = $twig;
}
Copy link
Member

@yceruto yceruto Sep 12, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thinking again about this approach, if we have just one method/controller, shouldn't be simpler inject the required dependencies into __invoke() directly? Thus, we are avoiding define one property per service argument, if so the action service needs to be tagged with controller.service_arguments.

After

final class HelloAction
{
    public function __invoke(Environment $twig): Response
    {
         return new Response($twig->render('default/index.html.twig'));
    }
}


public function __invoke(): Response
{
return new Response($this->twig->render('default/index.html.twig'));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Response class is missing a use statement.

}
}

.. tip::

As described in the DependencyInjection doc, you must use the __construct() injection
approach, this way, your class is easier to update and keep in sync with any framework internal
services.

By default, we define the class with the final keyword because this class shouldn't be extended,
the logic is pretty simple to understand as you understand the ADR pattern, in fact, the 'Action'
is linked to a single request and his dependencies are linked to this precise Action.

.. tip::

By using the final approach and the private visibility (inside the container), our class
is faster to return and easier to keep out of the framework logic.

Once this is done, you can define the routes like before using multiples approaches:

.. configuration-block::

.. code-block:: php-annotations

# src/AppBundle/Action/HelloAction.php
// ...

/**
* @Route("/hello", name="hello")
*/
final class HelloAction
{
// ...
}

.. code-block:: yaml

# app/config/routing.yml
hello:
path: /hello
defaults: { _controller: AppBundle\Action\HelloAction }

.. code-block:: xml

<!-- app/config/routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/routing
http://symfony.com/schema/routing/routing-1.0.xsd">

<route id="hello" path="/hello">
<default key="_controller">AppBundle\Action\HelloAction</default>
</route>

</routes>

.. code-block:: php

// app/config/routing.php
use AppBundle\Action\HelloAction

$collection->add('hello', new Route('/hello', array(
'_controller' => HelloAction::class,
)));

Accessing the request
---------------------

As you can imagine, as the logic evolve, your class is capable of accessing
the request from simple method injection like this ::

<?php

use Symfony\Component\HttpFoundation\Request;
// ...

public function __invoke(Request $request): Response
{
return new Response($this->twig->render('default/index.html.twig'));
}
}

Like you can easily imagine, the :class:`Symfony\\Component\\Httpfoundation\\RequestStack` is the best option to gain access to the request, using this approach, a simple update is recommended and the access to request parameters is way easier::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it better ?

Copy link
Member

@yceruto yceruto Aug 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using the Request from simple method still works in ADR approach, no sure it is the best sample :/


<?php

namespace AppBundle\Action;

use Twig\Environment;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\RequestStack;

final class HelloAction
{
private $requestStack;

private $twig;

public function __construct(RequestStack $requestStack, Environment $twig)
{
$this->requestStack = $requestStack
$this->twig = $twig;
}

public function __invoke(): Response
{
$data = $this->requestStack->getCurrentRequest()->get('id');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$data is not used, you should at least pass it to the view.


return new Response($this->twig->render('default/index.html.twig', array('data' => $data));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think PHP7 is assumed in the doc

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think we should use the [] syntax?

}
}

Final thought
-------------

Keep in mind that this approach can be completely different from what you're used to use, in order to
keep your code clean and easy to maintain, we recommend to use this approach only if your code is
decoupled from the internal framework logic (like with Clean Architecture approach) or if you start a new
project and need to keep the logic linked to your business rules.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand this last paragraph and the supposed benefits. I don't see how this approach or what you refer to the old one is cleaner or easier. I don't understand why this approach is more decoupled than the other one. I'm not saying this is good or bad, just that from a beginner's perspective, the benefits are not very clear.

5 changes: 5 additions & 0 deletions controller/service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,11 @@ If your controller implements the ``__invoke()`` method - popular with the
Action-Domain-Response (ADR) pattern, you can simply refer to the service id
(``AppBundle\Controller\HelloController`` or ``app.hello_controller`` for example).

As this approach is evolving faster and can be easily transposed into Symfony, we recommend
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is it evolving?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At this stage, not so much, like before, there's was an error in the real sense of my words, ADR still young and the "logic" keep evolving with time and usage by the developers, the true meaning was to say that using ADR still a "WIP" in Symfony and as the "logic" of ADR still evolving by the feedbacks of the developers, his implementation inside Symfony can be modified with future evolution of the framework or pattern.

In fact, it was possible since Symfony 3.1 when recompiling the container (or like @dunglas do it, by injecting the classes as controllers and mapping the return of each one of them) but using it in production is way easier since 3.3 and 3.4 (and even easier in 4.0)

you to read the following part:

* :doc:`/controller/adr`

Alternatives to base Controller Methods
---------------------------------------

Expand Down