Reset TestTransport on ensureKernelShutdown (#90)

* Reset TestTransport on ensureKernelShutdown * Test * Fix typo * Set lowest deps
zenstruck · Sep 26, 2024 · d9d711b · d9d711b
1 parent f0088cc
commit d9d711b
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 2 deletions.
diff --git a/composer.json b/composer.json
@@ -14,7 +14,7 @@
     "require": {
         "php": ">=8.1",
         "symfony/deprecation-contracts": "^2.2|^3.0",
-        "symfony/framework-bundle": "^5.4|^6.0|^7.0",
+        "symfony/framework-bundle": "^5.4.44|^6.0|^7.0",
         "symfony/messenger": "^5.4|^6.0|^7.0",
         "zenstruck/assert": "^1.0"
     },

diff --git a/src/InteractsWithMessenger.php b/src/InteractsWithMessenger.php
@@ -47,6 +47,17 @@ final protected static function _enableMessagesCollection(): void
         TestBus::enableMessagesCollection();
     }
 
+    /**
+     * @internal
+     *
+     * @before
+     */
+    #[Before]
+    final protected static function _disableResetOnKernelShutdown(): void
+    {
+        TestTransport::disableResetOnKernelShutdown();
+    }
+
     /**
      * @internal
      *
@@ -71,6 +82,17 @@ final protected static function _resetMessengerTransports(): void
         TestBus::resetAll();
     }
 
+    /**
+     * @internal
+     *
+     * @after
+     */
+    #[After]
+    final protected static function _enableResetOnKernelShutdown(): void
+    {
+        TestTransport::enableResetOnKernelShutdown();
+    }
+
     /**
      * @deprecated use transport() instead
      */

diff --git a/src/Transport/TestTransport.php b/src/Transport/TestTransport.php
@@ -77,6 +77,7 @@ final class TestTransport implements TransportInterface, ListableReceiverInterfa
 
     // this setting applies to all transports
     private static bool $enableMessagesCollection = true;
+    private static bool $resetOnKernelShutdownEnabled = true;
 
     /**
      * @internal
@@ -411,6 +412,25 @@ public function supportsDelayStamp(): bool
         return $this->clock && self::$supportDelayStamp[$this->name];
     }
 
+    public function resetOnKernelShutdown(): void
+    {
+        if (!self::$resetOnKernelShutdownEnabled) {
+            return;
+        }
+
+        $this->reset();
+    }
+
+    public static function enableResetOnKernelShutdown(): void
+    {
+        self::$resetOnKernelShutdownEnabled = true;
+    }
+
+    public static function disableResetOnKernelShutdown(): void
+    {
+        self::$resetOnKernelShutdownEnabled = false;
+    }
+
     /**
      * @param array<string, Envelope[]> $messagesCollection
      */

diff --git a/src/ZenstruckMessengerTestBundle.php b/src/ZenstruckMessengerTestBundle.php
@@ -62,15 +62,18 @@ public function process(ContainerBuilder $container): void
 
         foreach ($container->findTaggedServiceIds('messenger.receiver') as $id => $tags) {
             $name = $id;
+            $transport = $container->getDefinition($name);
 
-            if (!$class = $container->getDefinition($name)->getClass()) {
+            if (!$class = $transport->getClass()) {
                 continue;
             }
 
             if (!\is_a($class, TransportInterface::class, true)) {
                 continue;
             }
 
+            $transport->addTag('kernel.reset', ['method' => 'resetOnKernelShutdown', 'on_invalid' => 'ignore']);
+
             foreach ($tags as $tag) {
                 if (isset($tag['alias'])) {
                     $name = $tag['alias'];

diff --git a/tests/TransportsAreResetCorrectly/NotInteractsWithMessengerBeforeTest.php b/tests/TransportsAreResetCorrectly/NotInteractsWithMessengerBeforeTest.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Messenger\MessageBusInterface;
 use Zenstruck\Messenger\Test\Tests\Fixture\Messenger\MessageA;
 use Zenstruck\Messenger\Test\Tests\Fixture\Messenger\MessageAHandler;
+use Zenstruck\Messenger\Test\Transport\TestTransport;
 use Zenstruck\Messenger\Test\Transport\TestTransportRegistry;
 
 /**
@@ -24,6 +25,12 @@
  */
 class NotInteractsWithMessengerBeforeTest extends KernelTestCase
 {
+    public static function setUpBeforeClass(): void
+    {
+        // Reset to default value to emulate first test in suite behavior
+        TestTransport::enableMessagesCollection();
+    }
+
     /**
      * @test
      */