Merge pull request #441 from thePanz/patch-1

Improve exception messages for topic-subscribers

Author: makasim

pkg/enqueue-bundle/DependencyInjection/Compiler/ExtractProcessorTagSubscriptionsTrait.php

@@ -83,7 +83,16 @@ protected function extractSubscriptions(ContainerBuilder $container, $processorS
 
         if (is_subclass_of($processorClass, TopicSubscriberInterface::class)) {
             /** @var TopicSubscriberInterface $processorClass */
-            foreach ($processorClass::getSubscribedTopics() as $topicName => $params) {
+            $topics = $processorClass::getSubscribedTopics();
+            if (!is_array($topics)) {
+                throw new \LogicException(sprintf(
+                    'Topic subscriber configuration is invalid for "%s::getSubscribedTopics()": expected array, got %s.',
+                    $processorClass,
+                    gettype($topics)
+                ));
+            }
+
+            foreach ($topics as $topicName => $params) {
                 if (is_string($params)) {
                     $data[] = [
                         'topicName' => $params,
@@ -102,7 +111,8 @@ protected function extractSubscriptions(ContainerBuilder $container, $processorS
                     ];
                 } else {
                     throw new \LogicException(sprintf(
-                        'Topic subscriber configuration is invalid. "%s"',
+                        'Topic subscriber configuration is invalid for "%s::getSubscribedTopics()". "%s"',
+                        $processorClass,
                         json_encode($processorClass::getSubscribedTopics())
                     ));
                 }

pkg/enqueue-bundle/Tests/Unit/DependencyInjection/Compiler/BuildClientRoutingPassTest.php

@@ -254,7 +254,7 @@ public function testShouldThrowExceptionWhenTopicSubscriberConfigurationIsInvali
         $pass = new BuildClientRoutingPass();
 
         $this->expectException(\LogicException::class);
-        $this->expectExceptionMessage('Topic subscriber configuration is invalid. "[12345]"');
+        $this->expectExceptionMessage('Topic subscriber configuration is invalid');
 
         $pass->process($container);
     }

pkg/enqueue-bundle/Tests/Unit/DependencyInjection/Compiler/BuildProcessorRegistryPassTest.php

@@ -180,7 +180,7 @@ public function testShouldBuildRouteFromSubscriberIfProcessorNameSpecified()
     public function testShouldThrowExceptionWhenTopicSubscriberConfigurationIsInvalid()
     {
         $this->expectException(\LogicException::class);
-        $this->expectExceptionMessage('Topic subscriber configuration is invalid. "[12345]"');
+        $this->expectExceptionMessage('Topic subscriber configuration is invalid');
 
         $container = $this->createContainerBuilder();
 

pkg/enqueue-bundle/Tests/Unit/DependencyInjection/Compiler/BuildTopicMetaSubscribersPassTest.php

@@ -302,7 +302,7 @@ public function testShouldThrowExceptionWhenTopicSubscriberConfigurationIsInvali
         $pass = new BuildTopicMetaSubscribersPass();
 
         $this->expectException(\LogicException::class);
-        $this->expectExceptionMessage('Topic subscriber configuration is invalid. "[12345]"');
+        $this->expectExceptionMessage('Topic subscriber configuration is invalid');
 
         $pass->process($container);
     }