Rename assertMessageCount to seeDispatchedMessageCount

In this module the assert* prefix is reserved for direct ports of Symfony's
own test assertions (assertEmailCount, assertResponseIsSuccessful, ...).
Messenger has no upstream Symfony web-test assertion, so the count check should
follow the module-native see* idiom, matching its Messenger-based siblings
(seeEmailIsSent, seeNotificationIsSent). Drop the assert-only $message
parameter accordingly and keep the methods in alphabetical order.

Author: TavoNiievez

src/Codeception/Module/Symfony/MessengerAssertionsTrait.php

@@ -15,32 +15,6 @@
 
 trait MessengerAssertionsTrait
 {
-    /**
-     * Asserts that the given number of messages were dispatched through the Messenger buses.
-     * Optionally pass a bus name (e.g. `messenger.bus.default`) to only count messages dispatched on that bus.
-     *
-     * ```php
-     * <?php
-     * $I->assertMessageCount(1);
-     * $I->assertMessageCount(2, 'messenger.bus.default');
-     * ```
-     */
-    public function assertMessageCount(int $expectedCount, ?string $bus = null, string $message = ''): void
-    {
-        $messages = $this->grabMessengerCollector(__FUNCTION__)->getMessages($bus);
-
-        $this->assertCount(
-            $expectedCount,
-            $messages,
-            $message !== '' ? $message : sprintf(
-                'Expected %d message(s) to be dispatched%s, but %d were.',
-                $expectedCount,
-                $this->busSuffix($bus),
-                count($messages),
-            ),
-        );
-    }
-
     /**
      * Asserts that **no** message of the given class was dispatched through the Messenger buses.
      * Optionally restrict the check to a single bus.
@@ -82,6 +56,32 @@ public function grabDispatchedMessageClasses(?string $bus = null): array
         return $this->getDispatchedMessageClasses(__FUNCTION__, $bus);
     }
 
+    /**
+     * Asserts that the given number of messages were dispatched through the Messenger buses.
+     * Optionally pass a bus name (e.g. `messenger.bus.default`) to only count messages dispatched on that bus.
+     *
+     * ```php
+     * <?php
+     * $I->seeDispatchedMessageCount(1);
+     * $I->seeDispatchedMessageCount(2, 'messenger.bus.default');
+     * ```
+     */
+    public function seeDispatchedMessageCount(int $expectedCount, ?string $bus = null): void
+    {
+        $messages = $this->grabMessengerCollector(__FUNCTION__)->getMessages($bus);
+
+        $this->assertCount(
+            $expectedCount,
+            $messages,
+            sprintf(
+                'Expected %d message(s) to be dispatched%s, but %d were.',
+                $expectedCount,
+                $this->busSuffix($bus),
+                count($messages),
+            ),
+        );
+    }
+
     /**
      * Asserts that at least one message of the given class was dispatched through the Messenger buses.
      * Optionally restrict the check to a single bus.

tests/MessengerAssertionsTest.php

@@ -13,13 +13,13 @@ final class MessengerAssertionsTest extends CodeceptTestCase
 {
     use MessengerAssertionsTrait;
 
-    public function testAssertMessageCount(): void
+    public function testSeeDispatchedMessageCount(): void
     {
         $this->client->request('GET', '/dispatch-message');
 
-        $this->assertMessageCount(1);
-        $this->assertMessageCount(1, 'messenger.bus.default');
-        $this->assertMessageCount(0, 'non.existent.bus');
+        $this->seeDispatchedMessageCount(1);
+        $this->seeDispatchedMessageCount(1, 'messenger.bus.default');
+        $this->seeDispatchedMessageCount(0, 'non.existent.bus');
     }
 
     public function testSeeMessageDispatched(): void
@@ -53,7 +53,7 @@ public function testNoMessagesDispatched(): void
     {
         $this->client->request('GET', '/');
 
-        $this->assertMessageCount(0);
+        $this->seeDispatchedMessageCount(0);
         $this->assertSame([], $this->grabDispatchedMessageClasses());
     }
 }