QueryCheckerTreeWalker: support logging instead of throwing exception

Author: JanTvrdik

composer.json

@@ -7,7 +7,8 @@
     "require": {
         "php": "^8.1",
         "doctrine/dbal": "^4.2",
-        "doctrine/orm": "^3.2"
+        "doctrine/orm": "^3.2",
+        "psr/log": "^1.0 || ^2.0 || ^3.0"
     },
     "require-dev": {
         "editorconfig-checker/editorconfig-checker": "^10.6.0",

src/QueryCheckerTreeWalker.php

@@ -22,7 +22,10 @@
 use Doctrine\ORM\Query\AST\SelectStatement;
 use Doctrine\ORM\Query\AST\WhereClause;
 use Doctrine\ORM\Query\TreeWalkerAdapter;
+use Psr\Log\LoggerInterface;
 use ShipMonk\DoctrineQueryChecker\Exception\LogicException;
+use Throwable;
+use WeakReference;
 use function array_map;
 use function class_exists;
 use function implode;
@@ -38,6 +41,19 @@
 class QueryCheckerTreeWalker extends TreeWalkerAdapter
 {
 
+    /**
+     * @var WeakReference<LoggerInterface>|null
+     */
+    private static ?WeakReference $logger = null;
+
+    /**
+     * When logger is set, exceptions are logged instead of thrown.
+     */
+    public static function setLogger(?LoggerInterface $logger): void
+    {
+        self::$logger = $logger !== null ? WeakReference::create($logger) : null;
+    }
+
     public function walkSelectStatement(SelectStatement $selectStatement): void
     {
         if ($selectStatement->whereClause !== null) {
@@ -161,13 +177,15 @@ protected function verifyInputParameterType(
 
         $compatibleTypeNames = array_map(self::typeToName(...), $compatibleTypes);
 
-        throw new LogicException(sprintf(
-            'QueryCheckerTreeWalker: Parameter "%s" is of type "%s", but expected one of: ["%s"] (because it\'s used in expression with %s)',
-            $inputParameter->name,
-            self::typeToName($inputParameterType),
-            implode('", "', $compatibleTypeNames),
-            $pathExpression->field !== null ? "{$pathExpression->identificationVariable}.{$pathExpression->field}" : $pathExpression->identificationVariable,
-        ));
+        $this->processException(
+            new LogicException(sprintf(
+                'QueryCheckerTreeWalker: Parameter "%s" is of type "%s", but expected one of: ["%s"] (because it\'s used in expression with %s)',
+                $inputParameter->name,
+                self::typeToName($inputParameterType),
+                implode('", "', $compatibleTypeNames),
+                $pathExpression->field !== null ? "{$pathExpression->identificationVariable}.{$pathExpression->field}" : $pathExpression->identificationVariable,
+            )),
+        );
     }
 
     private static function typeToName(string|Type|ParameterType|ArrayParameterType|null $type): string
@@ -274,7 +292,7 @@ protected function isEntity(object $object): bool
         $realClassName = $markerOffset === false ? $className : substr($className, $markerOffset + strlen($proxyMarker) + 2);
 
         if (!class_exists($realClassName)) {
-            throw new LogicException(sprintf('QueryCheckerTreeWalker: Class "%s" does not exist', $realClassName));
+            return false;
         }
 
         return !$this->getEntityManager()->getMetadataFactory()->isTransient($realClassName);
@@ -312,4 +330,15 @@ protected function getEntityManager(): EntityManagerInterface
         return $this->_getQuery()->getEntityManager();
     }
 
+    protected function processException(Throwable $e): void
+    {
+        $logger = self::$logger?->get();
+
+        if ($logger === null) {
+            throw $e;
+        }
+
+        $logger->error($e->getMessage(), ['exception' => $e]);
+    }
+
 }

tests/Lib/TestCase.php

@@ -26,6 +26,7 @@ protected function setUp(): void
     {
         parent::setUp();
         $this->entityManager = null;
+        QueryCheckerTreeWalker::setLogger(null);
     }
 
     /**

tests/QueryCheckerTreeWalkerTest.php

@@ -6,8 +6,10 @@
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Query\Expr;
 use PHPUnit\Framework\Attributes\DataProvider;
+use Psr\Log\LoggerInterface;
 use Ramsey\Uuid\Doctrine\UuidType;
 use ShipMonk\DoctrineQueryChecker\Exception\LogicException;
+use ShipMonk\DoctrineQueryChecker\QueryCheckerTreeWalker;
 use ShipMonkTests\DoctrineQueryChecker\Fixture\Entity\SimpleTestEntity;
 use ShipMonkTests\DoctrineQueryChecker\Fixture\Entity\SimpleTestEntityWithUuid;
 use ShipMonkTests\DoctrineQueryChecker\Fixture\Entity\TestEntityWithManyFieldTypes;
@@ -309,4 +311,43 @@ public static function provideWrongParameterTypesData(): iterable
         ];
     }
 
+    public function testWillUseLoggerIfAvailable(): void
+    {
+        $logger = self::createMock(LoggerInterface::class);
+        $logger->expects(self::once())
+            ->method('error')
+            ->with(
+                'QueryCheckerTreeWalker: Parameter "value" is of type "float", but expected one of: ["boolean"] (because it\'s used in expression with e.booleanField)',
+                self::arrayHasKey('exception'),
+            );
+
+        QueryCheckerTreeWalker::setLogger($logger);
+
+        $this->getEntityManager()->createQueryBuilder()
+            ->select('e')
+            ->from(TestEntityWithManyFieldTypes::class, 'e')
+            ->andWhere('e.booleanField = :value')
+            ->setParameter('value', 123.4)
+            ->getQuery()
+            ->setQueryCache(new NullAdapter())
+            ->getResult();
+
+        QueryCheckerTreeWalker::setLogger(null);
+
+        self::assertException(
+            LogicException::class,
+            'QueryCheckerTreeWalker: Parameter "value" is of type "float", but expected one of: ["boolean"] (because it\'s used in expression with e.booleanField)',
+            function (): void {
+                $this->getEntityManager()->createQueryBuilder()
+                    ->select('e')
+                    ->from(TestEntityWithManyFieldTypes::class, 'e')
+                    ->andWhere('e.booleanField = :value')
+                    ->setParameter('value', 123.4)
+                    ->getQuery()
+                    ->setQueryCache(new NullAdapter())
+                    ->getResult();
+            },
+        );
+    }
+
 }