[Workflow] Add support for storing the marking in a property

lyrixx · lyrixx · commit 3c91773532e0 · 2023-07-27T10:36:07.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Add native return type to `Translator` and to `Application::reset()`
  * Deprecate the integration of Doctrine annotations, either uninstall the `doctrine/annotations` package or disable the integration by setting `framework.annotations` to `false`
+ * Add support for `PropertiesMarkingStore` in the workflow configuration
 
 6.3
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -403,11 +403,14 @@ private function addWorkflowSection(ArrayNodeDefinition $rootNode): void
                                     ->arrayNode('marking_store')
                                         ->children()
                                             ->enumNode('type')
-                                                ->values(['method'])
+                                                ->values(['method', 'properties'])
                                             ->end()
                                             ->scalarNode('property')
                                                 ->defaultValue('marking')
                                             ->end()
+                                            ->scalarNode('context_property')
+                                                ->defaultValue('markingContext')
+                                            ->end()
                                             ->scalarNode('service')
                                                 ->cannotBeEmpty()
                                             ->end()
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -998,12 +998,20 @@ private function registerWorkflowConfiguration(array $config, ContainerBuilder $
 
             // Create MarkingStore
             $markingStoreDefinition = null;
-            if (isset($workflow['marking_store']['type'])) {
+            $markingStoreType = $workflow['marking_store']['type'] ?? null;
+            if ('method' === $markingStoreType) {
                 $markingStoreDefinition = new ChildDefinition('workflow.marking_store.method');
                 $markingStoreDefinition->setArguments([
                     'state_machine' === $type, // single state
                     $workflow['marking_store']['property'],
                 ]);
+            } elseif ('properties' === $markingStoreType) {
+                $markingStoreDefinition = new ChildDefinition('workflow.marking_store.properties');
+                $markingStoreDefinition->setArguments([
+                    'state_machine' === $type, // single state
+                    $workflow['marking_store']['property'],
+                    $workflow['marking_store']['context_property'],
+                ]);
             } elseif (isset($workflow['marking_store']['service'])) {
                 $markingStoreDefinition = new Reference($workflow['marking_store']['service']);
             }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -443,11 +443,13 @@
         <xsd:attribute name="type" type="marking_store_type" />
         <xsd:attribute name="service" type="xsd:string" />
         <xsd:attribute name="property" type="xsd:string" />
+        <xsd:attribute name="context_property" type="xsd:string" />
     </xsd:complexType>
 
     <xsd:simpleType name="marking_store_type">
         <xsd:restriction base="xsd:string">
             <xsd:enumeration value="method" />
+            <xsd:enumeration value="properties" />
         </xsd:restriction>
     </xsd:simpleType>
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/workflow.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/workflow.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Workflow\EventListener\ExpressionLanguage;
 use Symfony\Component\Workflow\MarkingStore\MethodMarkingStore;
+use Symfony\Component\Workflow\MarkingStore\PropertiesMarkingStore;
 use Symfony\Component\Workflow\Registry;
 use Symfony\Component\Workflow\StateMachine;
 use Symfony\Component\Workflow\Workflow;
@@ -39,6 +40,8 @@
             ->abstract()
         ->set('workflow.marking_store.method', MethodMarkingStore::class)
             ->abstract()
+        ->set('workflow.marking_store.properties', PropertiesMarkingStore::class)
+            ->abstract()
         ->set('.workflow.registry', Registry::class)
         ->alias(Registry::class, '.workflow.registry')
             ->deprecate('symfony/workflow', '6.2', 'The "%alias_id%" alias is deprecated, inject the workflow directly.')
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/workflows.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/workflows.php
@@ -48,6 +48,11 @@
                 FrameworkExtensionTestCase::class,
             ],
             'initial_marking' => 'start',
+            'marking_store' => [
+                'type' => 'properties',
+                'property' => 'state',
+                'context_property' => 'stateContext',
+            ],
             'metadata' => [
                 'title' => 'workflow title',
             ],
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/workflows.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/workflows.xml
@@ -45,6 +45,7 @@
         <framework:workflow name="pull_request">
             <framework:audit-trail enabled="false"/>
             <framework:initial-marking>start</framework:initial-marking>
+            <framework:marking-store type="properties" property="state" context_property="stateContext" />
             <framework:support>Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection\FrameworkExtensionTestCase</framework:support>
             <framework:place name="start">
                 <framework:metadata>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/workflows.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/workflows.yml
@@ -35,6 +35,10 @@ framework:
             supports:
                 - Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection\FrameworkExtensionTestCase
             initial_marking: start
+            marking_store:
+                type: properties
+                property: state
+                context_property: stateContext
             metadata:
                 title: workflow title
             places:
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php
@@ -300,6 +300,7 @@ public function testWorkflows()
         $args = $container->getDefinition('workflow.article')->getArguments();
         $this->assertArrayHasKey('index_0', $args);
         $this->assertArrayHasKey('index_1', $args);
+        $this->assertNull($args['index_1']);
         $this->assertArrayHasKey('index_3', $args);
         $this->assertArrayHasKey('index_4', $args);
         $this->assertNull($args['index_4'], 'Workflows has eventsToDispatch=null');
@@ -333,6 +334,12 @@ public function testWorkflows()
 
         $this->assertTrue($container->hasDefinition('state_machine.pull_request'), 'State machine is registered as a service');
         $this->assertSame('state_machine.abstract', $container->getDefinition('state_machine.pull_request')->getParent());
+
+        $markingStoreDefinition = $container->getDefinition('state_machine.pull_request')->getArguments()['index_1'];
+        $this->assertInstanceOf(ChildDefinition::class, $markingStoreDefinition);
+        $this->assertSame('workflow.marking_store.properties', $markingStoreDefinition->getParent());
+        $this->assertSame([true, 'state', 'stateContext'], $markingStoreDefinition->getArguments());
+
         $this->assertTrue($container->hasDefinition('state_machine.pull_request.definition'), 'State machine definition is registered as a service');
 
         $this->assertSame(['workflow' => [['name' => 'pull_request']], 'workflow.state_machine' => [['name' => 'pull_request']]], $container->getDefinition('state_machine.pull_request')->getTags());
diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -99,7 +99,7 @@
         "symfony/twig-bundle": "<5.4",
         "symfony/validator": "<6.3",
         "symfony/web-profiler-bundle": "<5.4",
-        "symfony/workflow": "<5.4"
+        "symfony/workflow": "<6.4"
     },
     "autoload": {
         "psr-4": { "Symfony\\Bundle\\FrameworkBundle\\": "" },
diff --git a/src/Symfony/Component/Workflow/CHANGELOG.md b/src/Symfony/Component/Workflow/CHANGELOG.md
@@ -6,6 +6,8 @@ CHANGELOG
 
  * Add `with-metadata` option to the `workflow:dump` command to include places,
    transitions and workflow's metadata into dumped graph
+ * Add `PropertiesMarkingStore` to store marking directly to the subject's
+   properties
 
 6.2
 ---
diff --git a/src/Symfony/Component/Workflow/MarkingStore/MethodMarkingStore.php b/src/Symfony/Component/Workflow/MarkingStore/MethodMarkingStore.php
@@ -20,27 +20,24 @@
  * This store deals with a "single state" or "multiple state" Marking.
  *
  * "single state" Marking means a subject can be in one and only one state at
- * the same time. Use it with state machine.
+ * the same time. Use it with state machine. It uses a string to store the marking
  *
  * "multiple state" Marking means a subject can be in many states at the same
- * time. Use it with workflow.
+ * time. Use it with workflow. It uses an array to store the marking
  *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  */
 final class MethodMarkingStore implements MarkingStoreInterface
 {
-    private bool $singleState;
-    private string $property;
-
     /**
      * @param string $property Used to determine methods to call
      *                         The `getMarking` method will use `$subject->getProperty()`
      *                         The `setMarking` method will use `$subject->setProperty(string|array $places, array $context = array())`
      */
-    public function __construct(bool $singleState = false, string $property = 'marking')
-    {
-        $this->singleState = $singleState;
-        $this->property = $property;
+    public function __construct(
+        private bool $singleState = false,
+        private string $property = 'marking',
+    ) {
     }
 
     public function getMarking(object $subject): Marking
diff --git a/src/Symfony/Component/Workflow/MarkingStore/PropertiesMarkingStore.php b/src/Symfony/Component/Workflow/MarkingStore/PropertiesMarkingStore.php
@@ -0,0 +1,88 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Workflow\MarkingStore;
+
+use Symfony\Component\Workflow\Exception\LogicException;
+use Symfony\Component\Workflow\Marking;
+
+/**
+ * PropertiesMarkingStore stores the marking with a subject's properties.
+ *
+ * This store deals with a "single state" or "multiple state" Marking.
+ *
+ * "single state" Marking means a subject can be in one and only one state at
+ * the same time. Use it with state machine. It uses a string to store the marking
+ *
+ * "multiple state" Marking means a subject can be in many states at the same
+ * time. Use it with workflow. It uses an array to store the marking
+ *
+ * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ */
+final class PropertiesMarkingStore implements MarkingStoreInterface
+{
+    public function __construct(
+        private bool $singleState = false,
+        private string $property = 'marking',
+        private ?string $contextProperty = 'markingContext',
+    ) {
+    }
+
+    public function getMarking(object $subject): Marking
+    {
+        if (!property_exists($subject, $this->property)) {
+            throw new LogicException(sprintf('The property "%s::$%s" does not exist.', get_debug_type($subject), $this->property));
+        }
+
+        $marking = null;
+        try {
+            $marking = $subject->{$this->property};
+        } catch (\Error $e) {
+            $unInitializedPropertyMessage = sprintf('Typed property %s::$%s must not be accessed before initialization', get_debug_type($subject), $this->property);
+            if ($e->getMessage() !== $unInitializedPropertyMessage) {
+                throw $e;
+            }
+        }
+
+        if (null === $marking) {
+            return new Marking();
+        }
+
+        if ($this->singleState) {
+            $marking = [(string) $marking => 1];
+        } elseif (!\is_array($marking)) {
+            throw new LogicException(sprintf('The property "%s::$%s" did not return an array and the Workflow\'s Marking store is instantiated with $singleState=false.', get_debug_type($subject), $this->property));
+        }
+
+        return new Marking($marking);
+    }
+
+    public function setMarking(object $subject, Marking $marking, array $context = []): void
+    {
+        $marking = $marking->getPlaces();
+
+        if ($this->singleState) {
+            $marking = key($marking);
+        }
+
+        if (!property_exists($subject, $this->property)) {
+            throw new LogicException(sprintf('The property "%s::$%s" does not exist.', get_debug_type($subject), $this->property));
+        }
+        $subject->{$this->property} = $marking;
+
+        if (null !== $this->contextProperty) {
+            if (!property_exists($subject, $this->contextProperty)) {
+                throw new LogicException(sprintf('The property "%s::$%s" does not exist.', get_debug_type($subject), $this->contextProperty));
+            }
+            $subject->{$this->contextProperty} = $context;
+        }
+    }
+}
diff --git a/src/Symfony/Component/Workflow/Tests/MarkingStore/MethodMarkingStoreTest.php b/src/Symfony/Component/Workflow/Tests/MarkingStore/MethodMarkingStoreTest.php
@@ -29,9 +29,10 @@ public function testGetSetMarkingWithMultipleState()
 
         $marking->mark('first_place');
 
-        $markingStore->setMarking($subject, $marking);
+        $markingStore->setMarking($subject, $marking, ['foo' => 'bar']);
 
         $this->assertSame(['first_place' => 1], $subject->getMarking());
+        $this->assertSame(['foo' => 'bar'], $subject->getContext());
 
         $marking2 = $markingStore->getMarking($subject);
 
@@ -50,11 +51,12 @@ public function testGetSetMarkingWithSingleState()
 
         $marking->mark('first_place');
 
-        $markingStore->setMarking($subject, $marking);
+        $markingStore->setMarking($subject, $marking, ['foo' => 'bar']);
 
         $this->assertSame('first_place', $subject->getMarking());
 
         $marking2 = $markingStore->getMarking($subject);
+        $this->assertSame(['foo' => 'bar'], $subject->getContext());
 
         $this->assertEquals($marking, $marking2);
     }
diff --git a/src/Symfony/Component/Workflow/Tests/MarkingStore/PropertiesMarkingStoreTest.php b/src/Symfony/Component/Workflow/Tests/MarkingStore/PropertiesMarkingStoreTest.php
diff --git a/src/Symfony/Component/Workflow/Tests/SubjectWithProperties.php b/src/Symfony/Component/Workflow/Tests/SubjectWithProperties.php
