Throw when if expression returns non-boolean (#105)

Author: Brajk19

src/Exception/InvalidIfExpressionResultException.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sofascore\PurgatoryBundle\Exception;
+
+final class InvalidIfExpressionResultException extends \TypeError implements PurgatoryException
+{
+    private const MESSAGE = 'Expected return value of "if" expression (%s) to be boolean, got %s.';
+
+    public function __construct(
+        public readonly string $expression,
+        public readonly mixed $result,
+    ) {
+        parent::__construct(\sprintf(self::MESSAGE, $expression, get_debug_type($result)));
+    }
+}

src/RouteProvider/AbstractEntityRouteProvider.php

@@ -8,6 +8,7 @@
 use Sofascore\PurgatoryBundle\Cache\Configuration\Configuration;
 use Sofascore\PurgatoryBundle\Cache\Configuration\ConfigurationLoaderInterface;
 use Sofascore\PurgatoryBundle\Cache\Configuration\Subscriptions;
+use Sofascore\PurgatoryBundle\Exception\InvalidIfExpressionResultException;
 use Sofascore\PurgatoryBundle\Exception\LogicException;
 use Sofascore\PurgatoryBundle\Listener\Enum\Action;
 use Sofascore\PurgatoryBundle\RouteParamValueResolver\ValuesResolverInterface;
@@ -71,8 +72,15 @@ private function processValidSubscriptions(Subscriptions $subscriptions, array $
                 continue;
             }
 
-            if (isset($subscription['if']) && false === $this->getExpressionLanguage()->evaluate($subscription['if'], ['obj' => $entity])) {
-                continue;
+            if (isset($subscription['if'])) {
+                $result = $this->getExpressionLanguage()->evaluate($subscription['if'], ['obj' => $entity]);
+                if (!\is_bool($result)) {
+                    throw new InvalidIfExpressionResultException($subscription['if'], $result);
+                }
+
+                if (!$result) {
+                    continue;
+                }
             }
 
             $routeParamConfigs = $subscription['routeParams'] ?? [];

tests/RouteProvider/UpdatedEntityRouteProviderTest.php

@@ -6,13 +6,16 @@
 
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\RequiresMethod;
+use PHPUnit\Framework\Attributes\TestWith;
 use PHPUnit\Framework\TestCase;
+use Psr\Container\ContainerInterface;
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\CompoundValues;
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\EnumValues;
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\PropertyValues;
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\RawValues;
 use Sofascore\PurgatoryBundle\Cache\Configuration\Configuration;
 use Sofascore\PurgatoryBundle\Cache\Configuration\ConfigurationLoaderInterface;
+use Sofascore\PurgatoryBundle\Exception\InvalidIfExpressionResultException;
 use Sofascore\PurgatoryBundle\Exception\LogicException;
 use Sofascore\PurgatoryBundle\Listener\Enum\Action;
 use Sofascore\PurgatoryBundle\RouteParamValueResolver\CompoundValuesResolver;
@@ -27,6 +30,7 @@
 use Symfony\Component\DependencyInjection\ServiceLocator;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use Symfony\Component\PropertyAccess\PropertyAccess;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\PropertyAccess\PropertyPath;
 
 #[CoversClass(AbstractEntityRouteProvider::class)]
@@ -361,6 +365,43 @@ 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.'])]
+    public function testExceptionIsThrownOnInvalidIfReturnType(mixed $ifResult, string $expectedMessage): void
+    {
+        $configurationLoader = $this->createMock(ConfigurationLoaderInterface::class);
+        $configurationLoader->expects(self::once())
+            ->method('load')
+            ->willReturn(new Configuration([
+                'stdClass' => [
+                    [
+                        'routeName' => 'foo_route',
+                        'if' => 'obj.val',
+                    ],
+                ],
+            ]));
+
+        $expressionLanguage = $this->createMock(ExpressionLanguage::class);
+        $expressionLanguage->expects(self::once())
+            ->method('evaluate')
+            ->willReturn($ifResult);
+
+        $routeProvider = new UpdatedEntityRouteProvider(
+            configurationLoader: $configurationLoader,
+            expressionLanguage: $expressionLanguage,
+            routeParamValueResolverLocator: $this->createMock(ContainerInterface::class),
+            propertyAccessor: $this->createMock(PropertyAccessorInterface::class),
+        );
+
+        $this->expectException(InvalidIfExpressionResultException::class);
+        $this->expectExceptionMessage($expectedMessage);
+        [...$routeProvider->provideRoutesFor(Action::Update, new \stdClass(), [])];
+    }
+
     private function createRouteProvider(array $configuration, bool $withExpressionLang): UpdatedEntityRouteProvider
     {
         $configurationLoader = $this->createMock(ConfigurationLoaderInterface::class);