bug #51675 [Messenger] Fix cloned TraceableStack not unstacking the stack independently (krciga22)

nicolas-grekas · nicolas-grekas · commit aa56d07cbfa8 · 2023-09-20T16:19:37.000+02:00
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [Messenger] Fix cloned TraceableStack not unstacking the stack independently | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #51564 | License | MIT | Doc PR | symfony/symfony-docs#...  Fixed a bug with cloned `TraceableStack` not unstacking the stack independently from the original due to the __clone() method not yet being implemented. Clones of `StackMiddleware` currently unstack the stack independently, but not `TraceableStack`. Commits ------- b91bdc6 [Messenger] Fix cloned TraceableStack not unstacking the stack independently
diff --git a/src/Symfony/Component/Messenger/Middleware/TraceableMiddleware.php b/src/Symfony/Component/Messenger/Middleware/TraceableMiddleware.php
@@ -94,4 +94,9 @@ public function stop(): void
         }
         $this->currentEvent = null;
     }
+
+    public function __clone()
+    {
+        $this->stack = clone $this->stack;
+    }
 }
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/TraceableMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/TraceableMiddlewareTest.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Messenger\Middleware\StackInterface;
 use Symfony\Component\Messenger\Middleware\StackMiddleware;
 use Symfony\Component\Messenger\Middleware\TraceableMiddleware;
+use Symfony\Component\Messenger\Middleware\TraceableStack;
 use Symfony\Component\Messenger\Test\Middleware\MiddlewareTestCase;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Stopwatch\Stopwatch;
@@ -140,4 +141,92 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
         $traced->handle($envelope, new StackMiddleware(new \ArrayIterator([null, $middleware])));
         $this->assertSame(1, $middleware->calls);
     }
+
+    public function testClonedTraceableStackUnstacksIndependently()
+    {
+        // import TraceableStack
+        class_exists(TraceableMiddleware::class);
+
+        $stackMiddleware = new StackMiddleware([
+            null,
+            $this->createMock(MiddlewareInterface::class),
+            $this->createMock(MiddlewareInterface::class),
+        ]);
+
+        $stopwatch = $this->createMock(Stopwatch::class);
+
+        $traceableStack = new TraceableStack($stackMiddleware, $stopwatch, 'command_bus', 'messenger.middleware');
+        $clonedStack = clone $traceableStack;
+
+        $traceableStackMiddleware1 = $traceableStack->next();
+        $traceableStackMiddleware2 = $traceableStack->next();
+        $traceableStackTail = $traceableStack->next();
+        self::assertSame($stackMiddleware, $traceableStackTail);
+
+        // unstack clonedStack independently
+        $clonedStackMiddleware1 = $clonedStack->next();
+        self::assertSame($traceableStackMiddleware1, $clonedStackMiddleware1);
+        self::assertNotSame($traceableStackMiddleware2, $clonedStackMiddleware1);
+
+        $clonedStackMiddleware2 = $clonedStack->next();
+        self::assertSame($traceableStackMiddleware2, $clonedStackMiddleware2);
+
+        $clonedStackTail = $clonedStack->next();
+        self::assertNotSame($stackMiddleware, $clonedStackTail, 'stackMiddleware was also cloned');
+    }
+
+    public function testClonedTraceableStackUsesSameStopwatch()
+    {
+        // import TraceableStack
+        class_exists(TraceableMiddleware::class);
+
+        $middlewareIterable = [null, $this->createMock(MiddlewareInterface::class)];
+
+        $stackMiddleware = new StackMiddleware($middlewareIterable);
+
+        $stopwatch = $this->createMock(Stopwatch::class);
+        $stopwatch->expects($this->exactly(2))->method('isStarted')->willReturn(true);
+
+        $startSeries = [
+            [$this->matches('"%sMiddlewareInterface%s" on "command_bus"'), 'messenger.middleware'],
+            [$this->identicalTo('Tail on "command_bus"'), 'messenger.middleware'],
+            [$this->matches('"%sMiddlewareInterface%s" on "command_bus"'), 'messenger.middleware'],
+            [$this->identicalTo('Tail on "command_bus"'), 'messenger.middleware'],
+        ];
+        $stopwatch->expects($this->exactly(4))
+            ->method('start')
+            ->willReturnCallback(function (string $name, string $category = null) use (&$startSeries) {
+                [$constraint, $expectedCategory] = array_shift($startSeries);
+
+                $constraint->evaluate($name);
+                $this->assertSame($expectedCategory, $category);
+
+                return $this->createMock(StopwatchEvent::class);
+            })
+        ;
+
+        $stopSeries = [
+            $this->matches('"%sMiddlewareInterface%s" on "command_bus"'),
+            $this->matches('"%sMiddlewareInterface%s" on "command_bus"'),
+        ];
+        $stopwatch->expects($this->exactly(2))
+            ->method('stop')
+            ->willReturnCallback(function (string $name) use (&$stopSeries) {
+                $constraint = array_shift($stopSeries);
+                $constraint->evaluate($name);
+
+                return $this->createMock(StopwatchEvent::class);
+            })
+        ;
+
+        $traceableStack = new TraceableStack($stackMiddleware, $stopwatch, 'command_bus', 'messenger.middleware');
+        $clonedStack = clone $traceableStack;
+
+        // unstack the stacks independently
+        $traceableStack->next();
+        $traceableStack->next();
+
+        $clonedStack->next();
+        $clonedStack->next();
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -94,4 +94,9 @@ public function stop(): void`
`94`	`94`	`}`
`95`	`95`	`$this->currentEvent = null;`
`96`	`96`	`}`
	`97`	`+`
	`98`	`+ public function __clone()`
	`99`	`+ {`
	`100`	`+ $this->stack = clone $this->stack;`
	`101`	`+ }`
`97`	`102`	`}`