feature #31785 [Messenger] Deprecate passing a bus locator to ConsumeMessagesCommand's constructor (chalasr)

fabpot · fabpot · commit c8f3cef35c1d · 2019-06-01T16:38:00.000+03:00
This PR was merged into the 4.4 branch. Discussion ---------- [Messenger] Deprecate passing a bus locator to ConsumeMessagesCommand's constructor | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a Continuation of #31748 Commits ------- 1409338 [Messenger] Deprecate passing a bus locator to ConsumeMessagesCommand constructor
diff --git a/UPGRADE-4.4.md b/UPGRADE-4.4.md
@@ -4,7 +4,7 @@ UPGRADE FROM 4.3 to 4.4
 HttpKernel
 ----------
 
-* The `DebugHandlersListener` class has been marked as `final`
+ * The `DebugHandlersListener` class has been marked as `final`
 
 DependencyInjection
 -------------------
@@ -25,13 +25,19 @@ DependencyInjection
        factory: ['@factory_service', method]
    ```
 
+Messenger
+---------
+
+ * Deprecated passing a `ContainerInterface` instance as first argument of the `ConsumeMessagesCommand` constructor,
+   pass a `RoutableMessageBus`  instance instead.
+
 MonologBridge
 --------------
 
-* The `RouteProcessor` has been marked final.
+ * The `RouteProcessor` has been marked final.
 
 TwigBridge
 ----------
 
  * Deprecated to pass `$rootDir` and `$fileLinkFormatter` as 5th and 6th argument respectively to the 
-   `DebugCommand::__construct()` method, swap the variables position.
+   `DebugCommand::__construct()` method, swap the variables position.
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -269,6 +269,8 @@ Messenger
 ---------
 
  * The `LoggingMiddleware` class has been removed, pass a logger to `SendMessageMiddleware` instead.
+ * Passing a `ContainerInterface` instance as first argument of the `ConsumeMessagesCommand` constructor now
+   throws as `\TypeError`, pass a `RoutableMessageBus`  instance instead.
 
 Monolog
 -------
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+4.4.0
+-----
+
+ * Deprecated passing a `ContainerInterface` instance as first argument of the `ConsumeMessagesCommand` constructor,
+   pass a `RoutableMessageBus`  instance instead.
+
 4.3.0
 -----
 
diff --git a/src/Symfony/Component/Messenger/Command/ConsumeMessagesCommand.php b/src/Symfony/Component/Messenger/Command/ConsumeMessagesCommand.php
@@ -54,8 +54,8 @@ class ConsumeMessagesCommand extends Command
      */
     public function __construct($routableBus, ContainerInterface $receiverLocator, LoggerInterface $logger = null, array $receiverNames = [], /* ContainerInterface */ $retryStrategyLocator = null, EventDispatcherInterface $eventDispatcher = null)
     {
-        // to be deprecated in 4.4
         if ($routableBus instanceof ContainerInterface) {
+            @trigger_error(sprintf('Passing a "%s" instance as first argument to "%s()" is deprecated since Symfony 4.4, pass a "%s" instance instead.', ContainerInterface::class, __METHOD__, RoutableMessageBus::class), E_USER_DEPRECATED);
             $routableBus = new RoutableMessageBus($routableBus);
         }
 
diff --git a/src/Symfony/Component/Messenger/Tests/Command/ConsumeMessagesCommandTest.php b/src/Symfony/Component/Messenger/Tests/Command/ConsumeMessagesCommandTest.php
@@ -27,7 +27,7 @@ class ConsumeMessagesCommandTest extends TestCase
 {
     public function testConfigurationWithDefaultReceiver()
     {
-        $command = new ConsumeMessagesCommand($this->createMock(ServiceLocator::class), $this->createMock(ServiceLocator::class), null, ['amqp']);
+        $command = new ConsumeMessagesCommand($this->createMock(RoutableMessageBus::class), $this->createMock(ServiceLocator::class), null, ['amqp']);
         $inputArgument = $command->getDefinition()->getArgument('receivers');
         $this->assertFalse($inputArgument->isRequired());
         $this->assertSame(['amqp'], $inputArgument->getDefault());
@@ -98,6 +98,10 @@ public function testRunWithBusOption()
         $this->assertContains('[OK] Consuming messages from transports "dummy-receiver"', $tester->getDisplay());
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation Passing a "Psr\Container\ContainerInterface" instance as first argument to "Symfony\Component\Messenger\Command\ConsumeMessagesCommand::__construct()" is deprecated since Symfony 4.4, pass a "Symfony\Component\Messenger\RoutableMessageBus" instance instead.
+     */
     public function testBasicRunWithBusLocator()
     {
         $envelope = new Envelope(new \stdClass(), [new BusNameStamp('dummy-bus')]);
@@ -130,6 +134,10 @@ public function testBasicRunWithBusLocator()
         $this->assertContains('[OK] Consuming messages from transports "dummy-receiver"', $tester->getDisplay());
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation Passing a "Psr\Container\ContainerInterface" instance as first argument to "Symfony\Component\Messenger\Command\ConsumeMessagesCommand::__construct()" is deprecated since Symfony 4.4, pass a "Symfony\Component\Messenger\RoutableMessageBus" instance instead.
+     */
     public function testRunWithBusOptionAndBusLocator()
     {
         $envelope = new Envelope(new \stdClass());

Original file line number	Diff line number	Diff line change
`@@ -54,8 +54,8 @@ class ConsumeMessagesCommand extends Command`
`54`	`54`	`*/`
`55`	`55`	`public function __construct($routableBus, ContainerInterface $receiverLocator, LoggerInterface $logger = null, array $receiverNames = [], /* ContainerInterface */ $retryStrategyLocator = null, EventDispatcherInterface $eventDispatcher = null)`
`56`	`56`	`{`
`57`		`- // to be deprecated in 4.4`
`58`	`57`	`if ($routableBus instanceof ContainerInterface) {`
	`58`	`+ @trigger_error(sprintf('Passing a "%s" instance as first argument to "%s()" is deprecated since Symfony 4.4, pass a "%s" instance instead.', ContainerInterface::class, __METHOD__, RoutableMessageBus::class), E_USER_DEPRECATED);`
`59`	`59`	`$routableBus = new RoutableMessageBus($routableBus);`
`60`	`60`	`}`
`61`	`61`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ class ConsumeMessagesCommandTest extends TestCase`
`27`	`27`	`{`
`28`	`28`	`public function testConfigurationWithDefaultReceiver()`
`29`	`29`	`{`
`30`		`- $command = new ConsumeMessagesCommand($this->createMock(ServiceLocator::class), $this->createMock(ServiceLocator::class), null, ['amqp']);`
	`30`	`+ $command = new ConsumeMessagesCommand($this->createMock(RoutableMessageBus::class), $this->createMock(ServiceLocator::class), null, ['amqp']);`
`31`	`31`	`$inputArgument = $command->getDefinition()->getArgument('receivers');`
`32`	`32`	`$this->assertFalse($inputArgument->isRequired());`
`33`	`33`	`$this->assertSame(['amqp'], $inputArgument->getDefault());`
`@@ -98,6 +98,10 @@ public function testRunWithBusOption()`
`98`	`98`	`$this->assertContains('[OK] Consuming messages from transports "dummy-receiver"', $tester->getDisplay());`
`99`	`99`	`}`
`100`	`100`
	`101`	`+ /**`
	`102`	`+ * @group legacy`
	`103`	`+ * @expectedDeprecation Passing a "Psr\Container\ContainerInterface" instance as first argument to "Symfony\Component\Messenger\Command\ConsumeMessagesCommand::__construct()" is deprecated since Symfony 4.4, pass a "Symfony\Component\Messenger\RoutableMessageBus" instance instead.`
	`104`	`+ */`
`101`	`105`	`public function testBasicRunWithBusLocator()`
`102`	`106`	`{`
`103`	`107`	`$envelope = new Envelope(new \stdClass(), [new BusNameStamp('dummy-bus')]);`
`@@ -130,6 +134,10 @@ public function testBasicRunWithBusLocator()`
`130`	`134`	`$this->assertContains('[OK] Consuming messages from transports "dummy-receiver"', $tester->getDisplay());`
`131`	`135`	`}`
`132`	`136`
	`137`	`+ /**`
	`138`	`+ * @group legacy`
	`139`	`+ * @expectedDeprecation Passing a "Psr\Container\ContainerInterface" instance as first argument to "Symfony\Component\Messenger\Command\ConsumeMessagesCommand::__construct()" is deprecated since Symfony 4.4, pass a "Symfony\Component\Messenger\RoutableMessageBus" instance instead.`
	`140`	`+ */`
`133`	`141`	`public function testRunWithBusOptionAndBusLocator()`
`134`	`142`	`{`
`135`	`143`	`$envelope = new Envelope(new \stdClass());`