minor #29525 [Messenger] Make MessengerPass less strict when auto-register handlers (nicholasruunu)

sroze · sroze · commit 9793522f6e25 · 2019-04-06T12:29:02.000+02:00
This PR was merged into the 4.3-dev branch. Discussion ---------- [Messenger] Make MessengerPass less strict when auto-register handlers | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | License | MIT | Doc PR | not needed This allows you to auto-register handlers that have more than one argument, which is useful when having custom middleware to pass more parameters. #symfonyconhackday2018 Commits ------- 49ab2cd Make MessengerPass less strict when auto-register handlers
diff --git a/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php b/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php
@@ -201,11 +201,11 @@ private function guessHandledClasses(\ReflectionClass $handlerClass, string $ser
             throw new RuntimeException(sprintf('Invalid handler service "%s": class "%s" must have an "__invoke()" method.', $serviceId, $handlerClass->getName()));
         }
 
-        $parameters = $method->getParameters();
-        if (1 !== \count($parameters)) {
-            throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::__invoke()" must have exactly one argument corresponding to the message it handles.', $serviceId, $handlerClass->getName()));
+        if (0 === $method->getNumberOfRequiredParameters()) {
+            throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::__invoke()" requires at least one argument, first one being the message it handles.', $serviceId, $handlerClass->getName()));
         }
 
+        $parameters = $method->getParameters();
         if (!$type = $parameters[0]->getType()) {
             throw new RuntimeException(sprintf('Invalid handler service "%s": argument "$%s" of method "%s::__invoke()" must have a type-hint corresponding to the message class it handles.', $serviceId, $parameters[0]->getName(), $handlerClass->getName()));
         }
diff --git a/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php b/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php
@@ -405,7 +405,7 @@ public function testNotInvokableHandler()
 
     /**
      * @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
-     * @expectedExceptionMessage Invalid handler service "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentHandler": method "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentHandler::__invoke()" must have exactly one argument corresponding to the message it handles.
+     * @expectedExceptionMessage Invalid handler service "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentHandler": method "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentHandler::__invoke()" requires at least one argument, first one being the message it handles.
      */
     public function testMissingArgumentHandler()
     {

Original file line number	Diff line number	Diff line change
`@@ -201,11 +201,11 @@ private function guessHandledClasses(\ReflectionClass $handlerClass, string $ser`
`201`	`201`	`throw new RuntimeException(sprintf('Invalid handler service "%s": class "%s" must have an "__invoke()" method.', $serviceId, $handlerClass->getName()));`
`202`	`202`	`}`
`203`	`203`
`204`		`- $parameters = $method->getParameters();`
`205`		`- if (1 !== \count($parameters)) {`
`206`		`- throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::__invoke()" must have exactly one argument corresponding to the message it handles.', $serviceId, $handlerClass->getName()));`
	`204`	`+ if (0 === $method->getNumberOfRequiredParameters()) {`
	`205`	`+ throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::__invoke()" requires at least one argument, first one being the message it handles.', $serviceId, $handlerClass->getName()));`
`207`	`206`	`}`
`208`	`207`
	`208`	`+ $parameters = $method->getParameters();`
`209`	`209`	`if (!$type = $parameters[0]->getType()) {`
`210`	`210`	`throw new RuntimeException(sprintf('Invalid handler service "%s": argument "$%s" of method "%s::__invoke()" must have a type-hint corresponding to the message class it handles.', $serviceId, $parameters[0]->getName(), $handlerClass->getName()));`
`211`	`211`	`}`
Original file line number	Diff line number	Diff line change
`@@ -405,7 +405,7 @@ public function testNotInvokableHandler()`
`405`	`405`
`406`	`406`	`/**`
`407`	`407`	`* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException`
`408`		`- * @expectedExceptionMessage Invalid handler service "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentHandler": method "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentHandler::__invoke()" must have exactly one argument corresponding to the message it handles.`
	`408`	`+ * @expectedExceptionMessage Invalid handler service "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentHandler": method "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentHandler::__invoke()" requires at least one argument, first one being the message it handles.`
`409`	`409`	`*/`
`410`	`410`	`public function testMissingArgumentHandler()`
`411`	`411`	`{`