[POC] [Workflow] Made StateMachine supports only single state marking #20491

HeahDude · 2016-11-11T17:06:42Z

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

Since StateMachine cannot be in one place at the time it does not make sense to allow multiple marking. Actually we default to the right SingleStateMarkingStore, but we can't prevent it with any interface.

This PR makes Marking and MarkingStore abstract so any implementation can use the component mechanisms by defining a marking strategy using Marking constants in the MarkingStore constructor.

Hence we need two marking classes SingleStateMarking and MultipleStateMarking so every internal piece of the workflow knows how to behave regarding marking.

Also we only need one PropertyAccessMarkingStore which use the same decency for its logic but can handle both strategies.

Most of the abstract class are public and can easily be overridden.

Wdyt?

stof · 2016-11-12T09:15:39Z

This prevents using any other custom implementation of the MarkingStore return astate with a single place, so -1 for that.

xabbuh · 2016-11-12T09:41:09Z

Maybe we could think about introducing dedicated marker interfaces for marking stores that support or do not support multiple states at the same time.

HeahDude · 2016-11-12T09:46:07Z

Ok I think I've got an idea.

Status: needs work

HeahDude · 2016-11-12T19:25:17Z

Ok I've updated the PR and the description, I'm finishing some tests, but this is ready to review as POC.

Maybe it will inspire someone for something better :)

stof · 2016-11-12T20:13:24Z

src/Symfony/Component/Workflow/MarkingStore/AbstractMarkingStore.php

+     * @param object             $subject A subject
+     * @param SingleStateMarking $marking
+     *
+     * @return SingleStateMarking The marking


setters have no reason to return the marking (the return value is ignored anyway)

stof · 2016-11-12T20:15:19Z

src/Symfony/Component/Workflow/MultipleStateMarking.php

+            return;
+        }
+
+        $this->places[$place] = $this->places[$place] + 1;


+= 1 or ++

stof · 2016-11-12T20:15:44Z

src/Symfony/Component/Workflow/Registry.php

@@ -30,6 +30,14 @@ public function add(Workflow $workflow, $className)
        $this->workflows[] = array($workflow, $className);
    }

+    /**
+     * @param      $subject
+     * @param null $workflowName


wrong phpdoc

stof · 2016-11-12T20:16:32Z

src/Symfony/Component/Workflow/SingleStateMarking.php

+        if ($place) {
+            $this->mark($place);
+        } else {
+            $this->place = array();


useless as the property is already initialized

stof · 2016-11-12T20:17:57Z

@lyrixx could you have a look at this one ?

HeahDude · 2016-11-12T20:47:07Z

@stof thank you for your comments, they're now addressed, ~~I might have fixed another bug~~ in 2289c55 EDIT: and c4599fc add a new feature for multiple tokens by place.

This can be very powerful to handle votes, or deal with weighted places in events.

I'm gonna add an event by default for workflow to guard if more than 1. Wdyt?

HeahDude · 2016-11-12T20:57:15Z

Reviewing my code on GH, I think it might be worth having Marking and MarkingStore abstract and get rid of the interfaces.

HeahDude · 2016-11-13T19:09:02Z

I've updated this PR so it has only one clean commit and a better description.

Status: needs review

HeahDude · 2016-11-13T19:18:41Z

Failures unrelated.

ro0NL · 2016-11-13T19:31:33Z

src/Symfony/Component/Workflow/SingleStateMarking.php

+class SingleStateMarking extends Marking
+{
+    /**
+     * @param mixed $place A scalar as only place or null


Should be string|null

ro0NL · 2016-11-13T19:32:09Z

src/Symfony/Component/Workflow/SingleStateMarking.php

+    public function __construct($place = null)
+    {
+        if (null !== $place && !is_scalar($place)) {
+            throw new InvalidArgumentException(sprintf('"%s" instances only accept scalar or null as single place, but got "%s".', __CLASS__, is_object($place) ? get_class($place) : gettype($place)));


Not sure this safeguard is actually needed.

ro0NL · 2016-11-13T19:33:25Z

src/Symfony/Component/Workflow/SingleStateMarking.php

+            throw new InvalidArgumentException(sprintf('"%s" instances only accept scalar or null as single place, but got "%s".', __CLASS__, is_object($place) ? get_class($place) : gettype($place)));
+        }
+
+        if ($place) {


Should be if(null !== $place) {

ro0NL · 2016-11-13T19:39:17Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

-            } elseif (isset($workflow['marking_store']['service'])) {
-                $markingStoreDefinition = new Reference($workflow['marking_store']['service']);
+
+                $markingStrategy = 'state_machine' === $type ? 'single_state' : $workflow['marking_store']['type'];


$markingStrategy = 'state_machine' === $type ? Marking::STRATEGY_SINGLE_STATE : Marking::STRATEGY_MULTIPLE_STATE;?

ro0NL · 2016-11-13T19:40:05Z

src/Symfony/Component/Workflow/Exception/InvalidMarkingException.php

+     */
+    public function __construct($expectedClass, $marking)
+    {
+        $this->message = sprintf('Marking must be an instance of "%", but got "%"', $expectedClass, is_object($marking) ? get_class($marking) : gettype($marking));


parent::__construct(...)

ro0NL · 2016-11-13T19:41:11Z

src/Symfony/Component/Workflow/Marking.php

 {
-    private $places = array();
+    const STRATEGY_SINGLE_STATE = 'single_state';


These constants belong to the MarkingStore class imo.

ro0NL · 2016-11-13T19:45:01Z

src/Symfony/Component/Workflow/Marking.php

 */
-class Marking
+abstract class Marking


Not sure this class is really needed.. why not a pointer interface and 2 final implementations instead?

lyrixx · 2016-11-14T09:43:40Z

@ro0NL Hi. Thanks for your review, But this is a POC. So please don't comment about CS / PHPDocs etc... @HeahDude will fix all those tiny details later if the PR is accepted.

lyrixx · 2016-11-14T09:55:00Z

Hello @HeahDude

I understand why you made this PR and I agree a pitfall may exist for newcomers.

But I don't like your current implementation:

1/ There are too many code added, it adds too many complexity
2/ You renamed place into state, this is wrong

It could be solved in the full stack framework in a simpler way: just check the framework type with the type marking store type.
It will not solve all errors since it's possible to use a custom service for the marking store. But I think if people implement a custom marking store, they know what they are doing.

I don't implemented what I said, because it's not perfect and because the default configuration is error proof.

If you can find a much simpler solution to implement this kind of validation in the composant, I will be glad to merge it. but for now I'm -1

HeahDude · 2016-11-14T10:03:51Z

@lyrixx I understand. Thank you for your feedback, I'll try to look at it again with this in mind :)

HeahDude · 2016-11-14T12:31:08Z

I'll come with something else :)

Status: needs work

lyrixx · 2016-12-13T15:55:47Z

I'm sorry, but I have to close this PR as the current implementation is too complex
(I have talked with @HeahDude IRL about this PR)

carsonbot added the Status: Needs Work label Nov 12, 2016

HeahDude changed the title ~~[Workflow] Made StateMachine supports only SingleStateMarkingStore~~ [POC] [Workflow] Made StateMachine supports only SingleStateMarkingStore Nov 12, 2016

HeahDude changed the title ~~[POC] [Workflow] Made StateMachine supports only SingleStateMarkingStore~~ [POC] [Workflow] Made StateMachine supports only single state marking Nov 12, 2016

stof reviewed Nov 12, 2016

View reviewed changes

HeahDude force-pushed the fix-state-machine-constructor branch 2 times, most recently from 39ae224 to 08dbffb Compare November 13, 2016 18:54

[Workflow] Made StateMachine supports only SingleStateMarkingStore

7c47114

HeahDude force-pushed the fix-state-machine-constructor branch from 08dbffb to 7c47114 Compare November 13, 2016 18:57

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

HeahDude mentioned this pull request Nov 13, 2016

[PoC] [Workflow] Allowed using multiple tokens by places #20508

Closed

ro0NL reviewed Nov 13, 2016

View reviewed changes

lyrixx added the Workflow label Nov 14, 2016

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

nicolas-grekas added this to the 3.x milestone Dec 6, 2016

lyrixx closed this Dec 13, 2016

nicolas-grekas modified the milestones: 3.x, 3.3 Mar 24, 2017

HeahDude deleted the fix-state-machine-constructor branch November 24, 2018 13:21

Uh oh!

[POC] [Workflow] Made StateMachine supports only single state marking #20491

[POC] [Workflow] Made StateMachine supports only single state marking #20491

Uh oh!

Conversation

HeahDude commented Nov 11, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stof commented Nov 12, 2016

Uh oh!

xabbuh commented Nov 12, 2016

Uh oh!

HeahDude commented Nov 12, 2016

Uh oh!

HeahDude commented Nov 12, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stof commented Nov 12, 2016

Uh oh!

HeahDude commented Nov 12, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

HeahDude commented Nov 12, 2016

Uh oh!

HeahDude commented Nov 13, 2016

Uh oh!

HeahDude commented Nov 13, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lyrixx commented Nov 14, 2016

Uh oh!

lyrixx commented Nov 14, 2016

Uh oh!

HeahDude commented Nov 14, 2016

Uh oh!

HeahDude commented Nov 14, 2016

Uh oh!

lyrixx commented Dec 13, 2016

Uh oh!

Uh oh!

HeahDude commented Nov 11, 2016 •

edited

Loading

HeahDude commented Nov 12, 2016 •

edited

Loading