à l'AperoPHP du 7 décembre, j'ai présenté la conférence suivante sur le composant Workflow de symfony avec les nouveautés de la 3.4 et de la 4.1

1. Le composant workflow
de Symfony, un truc
graphement bien.
Hamza Amrouche

2. Hamza Amrouche
Lead Dev Symfony chez Les-Tilleuls.coop
Core Team Api-Platform
Contributeur à Symfony
@cDaed
@Simperfit
Bureau étendu AFUP

3. Les-Tilleuls.coop
Une coopérative depuis 2011
Appartient à 100% à ses employés
22 coopérateurs, 97% de croissance en 2016
On recrute à Amiens, Lille, Paris et Londres:
jobs@les-tilleuls.coop

4. Qu’est-ce que le
composant Workflow ?

5. Quelle est son utilité ?

6. Place Transition
A t0
Place
B
Un workflow classique

7. A t0 C
Un workflow
B t1 D

8. A t0a C
Une machine à état
B t1 D
t0b

9. A
t0a
C
Une machine à état
B
t0b
D
t1

10. La définition du Workflow
$definition = new Definition([
'completion_in_progress',
'to_validate',
'pending_search',
'found',
'started',
'finished',
], [
new Transition('to_validate',
['completion_in_progress'],
['to_validate']),
// etc
], 'completion_in_progress');

11. La definition du Workflow
workflows:
project:
type: 'state_machine'
marking_store:
type: single_state
arguments:
- status
supports:
- AppBundleEntityProject
places:
- !php/const:AppBundleEntityProject::STATUS_CREATED
- !php/const:AppBundleEntityProject::STATUS_TO_VALIDATE
- !php/const:AppBundleEntityProject::STATUS_VALIDATED
transitions:
to_validate:
from: !php/const:AppBundleEntityProject::STATUS_CREATED
to: !php/const:AppBundleEntityProject::STATUS_TO_VALIDATE
validated:
from: !php/const:AppBundleEntityProject::STATUS_TO_VALIDATE
to: !php/const:AppBundleEntityProject::STATUS_VALIDATED

12. Le graphviz :
bin/console workflow:dump project | dot -Tpng -o etc/project-graph.png
http://graphviz.org/download/

13. Contexte Quotatis
Quotatis permet aux personnes qui souhaitent faire des
travaux de créer des projets, ceux-ci ont plusieurs états.
Pour atteindre ces états il y a des conditions, qui ne sont
remplies que si le projet est prêt.

14. Merci au Workflow !
Le composant nous permet de garantir que les projets
qui sont dans certains états ont bien passé toutes les
règles de validation.

15. Un workflow en prod
:

16. Le can()

17. Le apply()

18. Les events !

19. Les events !
public static function getSubscribedEvents(): array
{
return [
'workflow.project.enter.to_validate'=> ['assignUser'],
'workflow.project.entered.validated' => ['sendToLegacy'],
];
}

20. Le guard Event
use SymfonyComponentWorkflowEventGuardEvent;
use SymfonyComponentEventDispatcherEventSubscriberInterface;
class BlogPostReviewListener implements EventSubscriberInterface
{
public function guardReview(GuardEvent $event)
{
$post = $event->getSubject();
$title = $post->title;
if (empty($title)) {
// Posts with no title should not be allowed
$event->setBlocked(true);
}
}
public static function getSubscribedEvents()
{
return ['workflow.blogpost.guard.to_review' => ['guardReview']];
}
}

21. La vue
<h3>Actions</h3>
{% if workflow_can(post, 'publish') %}
<a href="...">Publish article</a>
{% endif %}

22. La vue
{# Or loop through the enabled transitions #}
{% for transition in workflow_transitions(post) %}
<a href="...">{{ transition.name }}</a>
{% endfor %}

23. L’utilisation au
quotidien

24. En mode API
On a plusieurs services qui mettent à jour le statut :
L’utilisateur à travers l’appli :
Scenario: As authenticated user, I can set the project's status to "to_validate"
Given I am authenticated as user
And there is a newly created project
When I set the project's status to "to_validate"
Then I should get a project
And the status should be "to_validate"
And I should be assigned to the project
La « Legacy » qui transforme le projet en « found » lorsque le projet a
trouvé son artisan.
L’API elle-même qui transforme le projet en « pending_search » lorsque
qu’un appel à l’api « Legacy » est fait.

25. En mode API
private function checkStatusWorkflow(Project $data)
{
$content = json_decode($request->getContent(), true);
if (null === $status = $content['status'] ?? null
|| $userProject->getStatus() === $status) {
return;
}
if (true === $this->projectWorkflow->can($data, $status)) {
$this->projectWorkflow->apply($data, $status);
return;
}
throw new BadRequestHttpException('status.not_in_workflow');
}

26. Petite Démo

28. 3.4 et 4.1

29. Une nouvelle interface…
Pour les gouverner tous !

31. À quoi ça sert ?

32. <?php
interface WorkflowInterface
{
public function getMarking($subject);
public function can($subject, $transitionName);
public function apply($subject, $transitionName);
public function getEnabledTransitions($subject);
public function getName();
public function getDefinition();
public function getMarkingStore();
}

33. Des questions ?
Maintenant :
…
Twitter : @cDaed

34. Merci à vous !
🍺🍺🍺🍺
Twitter : @cDaed

35. Merci à vous !
🍺🍺🍺🍺
Twitter : @cDaed
Les slides :