Add route name to expression invalid return type exception (#106)

Author: HypeMC

src/Exception/InvalidIfExpressionResultException.php

@@ -6,12 +6,13 @@
 
 final class InvalidIfExpressionResultException extends \TypeError implements PurgatoryException
 {
-    private const MESSAGE = 'Expected return value of "if" expression (%s) to be boolean, got %s.';
+    private const MESSAGE = 'Expected the return value of "if" expression (%s) for route "%s" to be boolean, got %s.';
 
     public function __construct(
+        public readonly string $routeName,
         public readonly string $expression,
         public readonly mixed $result,
     ) {
-        parent::__construct(\sprintf(self::MESSAGE, $expression, get_debug_type($result)));
+        parent::__construct(\sprintf(self::MESSAGE, $expression, $routeName, get_debug_type($result)));
     }
 }

src/RouteProvider/AbstractEntityRouteProvider.php

@@ -75,7 +75,7 @@ private function processValidSubscriptions(Subscriptions $subscriptions, array $
             if (isset($subscription['if'])) {
                 $result = $this->getExpressionLanguage()->evaluate($subscription['if'], ['obj' => $entity]);
                 if (!\is_bool($result)) {
-                    throw new InvalidIfExpressionResultException($subscription['if'], $result);
+                    throw new InvalidIfExpressionResultException($subscription['routeName'], $subscription['if'], $result);
                 }
 
                 if (!$result) {

tests/RouteProvider/UpdatedEntityRouteProviderTest.php

@@ -365,12 +365,12 @@ public function testRouteParamsWithRawValuesAndEnumValues(): void
         self::assertSame(['name' => 'foo_route', 'params' => ['foo' => 'case3']], (array) $routes[5]);
     }
 
-    #[TestWith([null, 'Expected return value of "if" expression (obj.val) to be boolean, got null.'])]
-    #[TestWith([1, 'Expected return value of "if" expression (obj.val) to be boolean, got int.'])]
-    #[TestWith([0.0, 'Expected return value of "if" expression (obj.val) to be boolean, got float.'])]
-    #[TestWith(['false', 'Expected return value of "if" expression (obj.val) to be boolean, got string.'])]
-    #[TestWith([[true], 'Expected return value of "if" expression (obj.val) to be boolean, got array.'])]
-    #[TestWith([new \stdClass(), 'Expected return value of "if" expression (obj.val) to be boolean, got stdClass.'])]
+    #[TestWith([null, 'Expected the return value of "if" expression (obj.val) for route "foo_route" to be boolean, got null.'])]
+    #[TestWith([1, 'Expected the return value of "if" expression (obj.val) for route "foo_route" to be boolean, got int.'])]
+    #[TestWith([0.0, 'Expected the return value of "if" expression (obj.val) for route "foo_route" to be boolean, got float.'])]
+    #[TestWith(['false', 'Expected the return value of "if" expression (obj.val) for route "foo_route" to be boolean, got string.'])]
+    #[TestWith([[true], 'Expected the return value of "if" expression (obj.val) for route "foo_route" to be boolean, got array.'])]
+    #[TestWith([new \stdClass(), 'Expected the return value of "if" expression (obj.val) for route "foo_route" to be boolean, got stdClass.'])]
     public function testExceptionIsThrownOnInvalidIfReturnType(mixed $ifResult, string $expectedMessage): void
     {
         $configurationLoader = $this->createMock(ConfigurationLoaderInterface::class);