bug #60194 [Workflow] Fix dispatch of entered event when the subject is already in this marking (lyrixx)

nicolas-grekas · nicolas-grekas · commit c11061c382a1 · 2025-04-14T14:36:40.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Workflow] Fix dispatch of entered event when the subject is already in this marking | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #57924 | License | MIT This was wrong: symfony/symfony#37813 Commits ------- 7db98c9fbe1 [Workflow] Fix dispatch of entered event when the subject is already in this marking
diff --git a/Tests/WorkflowTest.php b/Tests/WorkflowTest.php
@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\Workflow\Definition;
+use Symfony\Component\Workflow\Event\EnteredEvent;
 use Symfony\Component\Workflow\Event\Event;
 use Symfony\Component\Workflow\Event\GuardEvent;
 use Symfony\Component\Workflow\Event\TransitionEvent;
@@ -685,6 +686,44 @@ public function testEventDefaultInitialContext()
         $workflow->apply($subject, 't1');
     }
 
+    public function testEventWhenAlreadyInThisPlace()
+    {
+        // ┌──────┐     ┌──────────────────────┐     ┌───┐     ┌─────────────┐     ┌───┐
+        // │ init │ ──▶ │ from_init_to_a_and_b │ ──▶ │ B │ ──▶ │ from_b_to_c │ ──▶ │ C │
+        // └──────┘     └──────────────────────┘     └───┘     └─────────────┘     └───┘
+        //                         │
+        //                         │
+        //                         ▼
+        //                     ┌───────────────────────────────┐
+        //                     │               A               │
+        //                     └───────────────────────────────┘
+        $definition = new Definition(
+            ['init', 'A', 'B', 'C'],
+            [
+                new Transition('from_init_to_a_and_b', 'init', ['A', 'B']),
+                new Transition('from_b_to_c', 'B', 'C'),
+            ],
+        );
+
+        $subject = new Subject();
+        $dispatcher = new EventDispatcher();
+        $name = 'workflow_name';
+        $workflow = new Workflow($definition, new MethodMarkingStore(), $dispatcher, $name);
+
+        $calls = [];
+        $listener = function (Event $event) use (&$calls) {
+            $calls[] = $event;
+        };
+        $dispatcher->addListener("workflow.$name.entered.A", $listener);
+
+        $workflow->apply($subject, 'from_init_to_a_and_b');
+        $workflow->apply($subject, 'from_b_to_c');
+
+        $this->assertCount(1, $calls);
+        $this->assertInstanceOf(EnteredEvent::class, $calls[0]);
+        $this->assertSame('from_init_to_a_and_b', $calls[0]->getTransition()->getName());
+    }
+
     public function testMarkingStateOnApplyWithEventDispatcher()
     {
         $definition = new Definition(range('a', 'f'), [new Transition('t', range('a', 'c'), range('d', 'f'))]);
diff --git a/Workflow.php b/Workflow.php
@@ -391,7 +391,13 @@ private function entered(object $subject, ?Transition $transition, Marking $mark
         $this->dispatcher->dispatch($event, WorkflowEvents::ENTERED);
         $this->dispatcher->dispatch($event, sprintf('workflow.%s.entered', $this->name));
 
-        foreach ($marking->getPlaces() as $placeName => $nbToken) {
+        $placeNames = [];
+        if ($transition) {
+            $placeNames = $transition->getTos();
+        } elseif ($this->definition->getInitialPlaces()) {
+            $placeNames = $this->definition->getInitialPlaces();
+        }
+        foreach ($placeNames as $placeName) {
             $this->dispatcher->dispatch($event, sprintf('workflow.%s.entered.%s', $this->name, $placeName));
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -391,7 +391,13 @@ private function entered(object $subject, ?Transition $transition, Marking $mark`
`391`	`391`	`$this->dispatcher->dispatch($event, WorkflowEvents::ENTERED);`
`392`	`392`	`$this->dispatcher->dispatch($event, sprintf('workflow.%s.entered', $this->name));`
`393`	`393`
`394`		`- foreach ($marking->getPlaces() as $placeName => $nbToken) {`
	`394`	`+ $placeNames = [];`
	`395`	`+ if ($transition) {`
	`396`	`+ $placeNames = $transition->getTos();`
	`397`	`+ } elseif ($this->definition->getInitialPlaces()) {`
	`398`	`+ $placeNames = $this->definition->getInitialPlaces();`
	`399`	`+ }`
	`400`	`+ foreach ($placeNames as $placeName) {`
`395`	`401`	`$this->dispatcher->dispatch($event, sprintf('workflow.%s.entered.%s', $this->name, $placeName));`
`396`	`402`	`}`
`397`	`403`	`}`