[Workflow] Made GraphvizDumper supports StateMachine #20497

HeahDude · 2016-11-12T09:58:14Z

Q	A
Branch?	master
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	~
License	MIT
Doc PR	~

Before:

After:

xabbuh · 2016-11-12T10:07:33Z

src/Symfony/Component/Workflow/Dumper/GraphvizDumper.php

@@ -126,21 +126,20 @@ private function addTransitions(array $transitions)
    private function findEdges(Definition $definition)
    {
        $dotEdges = array();
+        $foundEdge = function ($from, $to, $direction) use (&$dotEdges) {


$foundEdge is not really a good name for what the function is doing imo.

$addEdge?

xabbuh · 2016-11-12T10:07:52Z

Can we add a test to prevent regressions?

stof · 2016-11-12T20:23:11Z

This indeed needs tests to be accepted

Status: needs work

HeahDude · 2016-11-14T01:31:01Z

Fixed now, the problem came from the way transitions are configured for state machines.

Status: needs review

stof · 2016-11-14T08:58:14Z

src/Symfony/Component/Workflow/Dumper/GraphvizDumper.php

@@ -84,7 +84,7 @@ private function findTransitions(Definition $definition)
        $transitions = array();

        foreach ($definition->getTransitions() as $transition) {
-            $transitions[] = array(
+            $transitions[$transition->getName()] = array(


looks wrong to me. Transition names are not unique in the definition (the only requirement is that transition starting from a given node have unique names)

@stof This is what this key is about, removing duplicated transition names, since they generate useless code in the dot file.

If they have the same name, they have different from/to, so they should both be rendered on the graph separately (otherwise, the graph will lie).

Btw, for a finite state machine, we could change the graph to render transitions as edges directly (optionally, as rendering the graph in workflow mode is still useful), as they are known to have a single from and a single to

If they have the same name, they have different from/to, so they should both be rendered on the graph separately (otherwise, the graph will lie).

That not true for the way state machines have been implemented. It splits the transition that has many tos in many transitions with the same name.

See https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php#L416.

@HeahDude But this class is also able to dump Workflow graph.

stof · 2016-11-14T08:58:51Z

src/Symfony/Component/Workflow/Dumper/GraphvizDumper.php

-                    'to' => $transition->getName(),
-                    'direction' => 'from',
-                );
+                $getEdge($from, $transition->getName(), 'from');


getEdge is a weird name, as it does not get anything. It adds something

Ok l'll change it to addName, it seems you all agree with that :)

lyrixx · 2016-11-14T09:30:28Z

src/Symfony/Component/Workflow/Dumper/GraphvizDumper.php

@@ -126,21 +126,20 @@ private function addTransitions(array $transitions)
    private function findEdges(Definition $definition)
    {
        $dotEdges = array();
+        $getEdge = function ($from, $to, $direction) use (&$dotEdges) {
+            $dotEdges[$from.$to.$direction] = array(


This kind of "hash" could collide.

They should, this is the point of it.

the thing is that your dumping of the StateMachine graph does not represent the workflow being defined by the state machine, as you represent a single transition with multiple input and output instead of several transitions (the fact that the DI config of the StateMachine allows to define these transitions in a shorted way by grouping them does not mean they are the same transition in the StateMachine)
Your dumping is lying about the actual workflow being run.
The bug in the GraphvizDumper currently is that it uses transition names to identify them in the dot file, while they are not unique identifiers anymore (they were at the time the dumper was written).

Btw, this is why I said we should have another dumper being tailored only at state machines, and dumping them into a graph being more readable. This graph would represent transitions as edges on the graph (which is not possible in generic workflows, as transitions can have multiple input and output). But I would make this another dumper, or an option in this dumper, because dumping the StateMachine as a generic workflow graph can be useful too.

Alright! Thank you again for your explanation, I'll work on that soon!

Btw, this is why I said we should have another dumper being tailored only at state machines, and dumping them into a graph being more readable

👍

lyrixx · 2016-11-21T16:23:00Z

@HeahDude I took care of this in #20583

HeahDude · 2016-11-21T20:00:11Z

Awesome thanks! Closing then.

This PR was merged into the 3.3-dev branch. Discussion ---------- [Workflow] Fixed graphviz dumper for state machine | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #20497 | License | MIT | Doc PR | ~ --- Before: ![before](https://cloud.githubusercontent.com/assets/408368/20490801/77cc0abe-b00f-11e6-8094-f4d428d5acde.png) After: ![after](https://cloud.githubusercontent.com/assets/408368/20490809/7d21a4b0-b00f-11e6-8de2-c5021fe2d4e0.png) --- Script: ```php <?php require __DIR__.'/vendor/autoload.php'; use Symfony\Component\Workflow\Definition; use Symfony\Component\Workflow\Dumper\StateMachineGraphvizDumper; use Symfony\Component\Workflow\Marking; use Symfony\Component\Workflow\StateMachine; use Symfony\Component\Workflow\Transition; $places = array('a', 'b', 'c', 'd'); $transitions[] = new Transition('t1', 'a', 'b'); $transitions[] = new Transition('t1', 'd', 'b'); $transitions[] = new Transition('t2', 'b', 'c'); $transitions[] = new Transition('t3', 'b', 'd'); $definition = new Definition($places, $transitions); $marking = new Marking(['d' => 1]); echo (new StateMachineGraphvizDumper())->dump($definition, $marking); ``` Commits ------- 1e92e02 [Workflow] Fixed graphviz dumper for state machine

This PR was submitted for the master branch but it was merged into the 3.2 branch instead (closes #20583). Discussion ---------- [Workflow] Fixed graphviz dumper for state machine | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #20497 | License | MIT | Doc PR | ~ --- Before: ![before](https://cloud.githubusercontent.com/assets/408368/20490801/77cc0abe-b00f-11e6-8094-f4d428d5acde.png) After: ![after](https://cloud.githubusercontent.com/assets/408368/20490809/7d21a4b0-b00f-11e6-8de2-c5021fe2d4e0.png) --- Script: ```php <?php require __DIR__.'/vendor/autoload.php'; use Symfony\Component\Workflow\Definition; use Symfony\Component\Workflow\Dumper\StateMachineGraphvizDumper; use Symfony\Component\Workflow\Marking; use Symfony\Component\Workflow\StateMachine; use Symfony\Component\Workflow\Transition; $places = array('a', 'b', 'c', 'd'); $transitions[] = new Transition('t1', 'a', 'b'); $transitions[] = new Transition('t1', 'd', 'b'); $transitions[] = new Transition('t2', 'b', 'c'); $transitions[] = new Transition('t3', 'b', 'd'); $definition = new Definition($places, $transitions); $marking = new Marking(['d' => 1]); echo (new StateMachineGraphvizDumper())->dump($definition, $marking); ``` Commits ------- 330c069 [Workflow] Fixed graphviz dumper for state machine

carsonbot added Status: Needs Review Workflow Bug labels Nov 12, 2016

xabbuh reviewed Nov 12, 2016

View reviewed changes

javiereguiluz added this to the 3.2 milestone Nov 12, 2016

HeahDude mentioned this pull request Nov 12, 2016

Added docs for Workflow component symfony/symfony-docs#6871

Closed

carsonbot added Status: Needs Work and removed Status: Needs Review labels Nov 12, 2016

[Workflow] Fixed dumping StateMachine with GraphvizDumper

d40e38d

HeahDude force-pushed the fix-workflow-dump branch from 6a4abe1 to d40e38d Compare November 14, 2016 01:29

carsonbot added Status: Needs Review and removed Status: Needs Work labels Nov 14, 2016

HeahDude changed the title ~~[Workflow] Fixed duplicated edges in GraphvizDumper~~ [Workflow] Made GraphvizDumper supports StateMachine Nov 14, 2016

stof reviewed Nov 14, 2016

View reviewed changes

lyrixx reviewed Nov 14, 2016

View reviewed changes

lyrixx mentioned this pull request Nov 21, 2016

[Workflow] Fixed graphviz dumper for state machine #20583

Merged

HeahDude closed this Nov 21, 2016

HeahDude deleted the fix-workflow-dump branch November 26, 2016 11:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workflow] Made GraphvizDumper supports StateMachine #20497

[Workflow] Made GraphvizDumper supports StateMachine #20497

HeahDude commented Nov 12, 2016

xabbuh Nov 12, 2016

ro0NL Nov 13, 2016

xabbuh commented Nov 12, 2016

stof commented Nov 12, 2016

HeahDude commented Nov 14, 2016

stof Nov 14, 2016

HeahDude Nov 14, 2016

stof Nov 14, 2016

HeahDude Nov 14, 2016 •

edited

Loading

lyrixx Nov 14, 2016

stof Nov 14, 2016

HeahDude Nov 14, 2016

lyrixx Nov 14, 2016

HeahDude Nov 14, 2016

stof Nov 14, 2016

HeahDude Nov 14, 2016

lyrixx Nov 14, 2016

lyrixx commented Nov 21, 2016 •

edited

Loading

HeahDude commented Nov 21, 2016

[Workflow] Made GraphvizDumper supports StateMachine #20497

[Workflow] Made GraphvizDumper supports StateMachine #20497

Conversation

HeahDude commented Nov 12, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xabbuh commented Nov 12, 2016

stof commented Nov 12, 2016

HeahDude commented Nov 14, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HeahDude Nov 14, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lyrixx commented Nov 21, 2016 • edited Loading

HeahDude commented Nov 21, 2016

HeahDude Nov 14, 2016 •

edited

Loading

lyrixx commented Nov 21, 2016 •

edited

Loading