Issue 51564 - cloned TraceableStack operates differently than StackMiddleware

krciga22 · krciga22 · commit 9c71a0eebee5 · 2023-09-10T22:16:05.000-05:00
Tested fixing the issue by implementing __clone() for TraceableStack.
diff --git a/src/Symfony/Component/Messenger/Middleware/TraceableMiddleware.php b/src/Symfony/Component/Messenger/Middleware/TraceableMiddleware.php
@@ -88,4 +88,10 @@ public function stop(): void
         }
         $this->currentEvent = null;
     }
+
+    public function __clone(): void
+    {
+        $this->stack = clone $this->stack;
+        $this->stopwatch = clone $this->stopwatch;
+    }
 }
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/TraceableMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/TraceableMiddlewareTest.php
@@ -16,11 +16,14 @@
 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;
 use Symfony\Component\Stopwatch\StopwatchEvent;
 
+class_exists(TraceableMiddleware::class);
+
 /**
  * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
  */
@@ -140,4 +143,26 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
         $traced->handle($envelope, new StackMiddleware(new \ArrayIterator([null, $middleware])));
         $this->assertSame(1, $middleware->calls);
     }
+
+    public function testCloneTraceableStack(): void
+    {
+        $middlewareIterator = [
+            $this->createMock(MiddlewareInterface::class),
+            $this->createMock(MiddlewareInterface::class),
+        ];
+
+        $stack = new TraceableStack(
+            new StackMiddleware($middlewareIterator),
+            $this->createMock(Stopwatch::class),
+            'command.bus',
+            'test'
+        );
+
+        $clonedStack = clone $stack;
+
+        $nextFrame = $stack->next();
+        $clonedStackNextFrame = $clonedStack->next();
+
+        self::assertSame($nextFrame, $clonedStackNextFrame);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -88,4 +88,10 @@ public function stop(): void`
`88`	`88`	`}`
`89`	`89`	`$this->currentEvent = null;`
`90`	`90`	`}`
	`91`	`+`
	`92`	`+ public function __clone(): void`
	`93`	`+ {`
	`94`	`+ $this->stack = clone $this->stack;`
	`95`	`+ $this->stopwatch = clone $this->stopwatch;`
	`96`	`+ }`
`91`	`97`	`}`