fix(mongodb): add LoggerAwareTrait and ManagerRegistryAwareTrait, improve logging support for filters

Author: soyuka

src/Doctrine/Common/Filter/LoggerAwareInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Common\Filter;
+
+use Psr\Log\LoggerInterface;
+
+interface LoggerAwareInterface
+{
+    public function hasLogger(): bool;
+
+    public function getLogger(): LoggerInterface;
+
+    public function setLogger(LoggerInterface $logger): void;
+}

src/Doctrine/Common/Filter/LoggerAwareTrait.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Common\Filter;
+
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+
+trait LoggerAwareTrait
+{
+    private ?LoggerInterface $logger = null;
+
+    public function hasLogger(): bool
+    {
+        return $this->logger instanceof LoggerInterface;
+    }
+
+    public function getLogger(): LoggerInterface
+    {
+        return $this->logger ??= new NullLogger();
+    }
+
+    public function setLogger(LoggerInterface $logger): void
+    {
+        $this->logger = $logger;
+    }
+}

src/Doctrine/Common/Filter/ManagerRegistryAwareTrait.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Common\Filter;
+
+use ApiPlatform\Metadata\Exception\RuntimeException;
+use Doctrine\Persistence\ManagerRegistry;
+
+trait ManagerRegistryAwareTrait
+{
+    private ?ManagerRegistry $managerRegistry = null;
+
+    public function hasManagerRegistry(): bool
+    {
+        return $this->managerRegistry instanceof ManagerRegistry;
+    }
+
+    public function getManagerRegistry(): ManagerRegistry
+    {
+        if (!$this->hasManagerRegistry()) {
+            throw new RuntimeException('ManagerRegistry must be initialized before accessing it.');
+        }
+
+        return $this->managerRegistry;
+    }
+
+    public function setManagerRegistry(ManagerRegistry $managerRegistry): void
+    {
+        $this->managerRegistry = $managerRegistry;
+    }
+}

src/Doctrine/Odm/Extension/ParameterExtension.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Doctrine\Odm\Extension;
 
+use ApiPlatform\Doctrine\Common\Filter\LoggerAwareInterface;
 use ApiPlatform\Doctrine\Common\Filter\ManagerRegistryAwareInterface;
 use ApiPlatform\Doctrine\Common\ParameterValueExtractorTrait;
 use ApiPlatform\Doctrine\Odm\Filter\AbstractFilter;
@@ -22,6 +23,7 @@
 use Doctrine\Bundle\MongoDBBundle\ManagerRegistry;
 use Doctrine\ODM\MongoDB\Aggregation\Builder;
 use Psr\Container\ContainerInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Reads operation parameters and execute its filter.
@@ -35,6 +37,7 @@ final class ParameterExtension implements AggregationCollectionExtensionInterfac
     public function __construct(
         private readonly ContainerInterface $filterLocator,
         private readonly ?ManagerRegistry $managerRegistry = null,
+        private readonly ?LoggerInterface $logger = null,
     ) {
     }
 
@@ -67,6 +70,10 @@ private function applyFilter(Builder $aggregationBuilder, ?string $resourceClass
                 $filter->setManagerRegistry($this->managerRegistry);
             }
 
+            if ($this->logger && $filter instanceof LoggerAwareInterface && !$filter->hasLogger()) {
+                $filter->setLogger($this->logger);
+            }
+
             if ($filter instanceof AbstractFilter && !$filter->getProperties()) {
                 $propertyKey = $parameter->getProperty() ?? $parameter->getKey();
 

src/Doctrine/Odm/Filter/IriFilter.php

@@ -13,38 +13,63 @@
 
 namespace ApiPlatform\Doctrine\Odm\Filter;
 
+use ApiPlatform\Doctrine\Common\Filter\ManagerRegistryAwareInterface;
+use ApiPlatform\Doctrine\Common\Filter\ManagerRegistryAwareTrait;
 use ApiPlatform\Doctrine\Common\Filter\OpenApiFilterTrait;
 use ApiPlatform\Metadata\BackwardCompatibleFilterDescriptionTrait;
 use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\ParameterProviderFilterInterface;
 use ApiPlatform\State\ParameterProvider\IriConverterParameterProvider;
 use Doctrine\ODM\MongoDB\Aggregation\Builder;
+use Doctrine\ODM\MongoDB\DocumentManager;
 
 /**
  * @author Vincent Amstoutz <[email protected]>
  */
-final class IriFilter implements FilterInterface, OpenApiParameterFilterInterface, ParameterProviderFilterInterface
+final class IriFilter implements FilterInterface, OpenApiParameterFilterInterface, ParameterProviderFilterInterface, ManagerRegistryAwareInterface
 {
     use BackwardCompatibleFilterDescriptionTrait;
+    use ManagerRegistryAwareTrait;
     use OpenApiFilterTrait;
 
     public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void
     {
         $parameter = $context['parameter'];
+        $property = $parameter->getProperty();
         $value = $parameter->getValue();
 
-        $isIterable = is_iterable($value);
-        if ($isIterable) {
-            $ids = array_map(static fn (object $object) => $object->getId(), iterator_to_array($value));
-        } else {
-            $ids = \is_object($value) ? $value->getId() : $value;
+        $documentManager = $this->getManagerRegistry()?->getManagerForClass($resourceClass);
+
+        if (!$documentManager instanceof DocumentManager) {
+            return;
+        }
+
+        $classMetadata = $documentManager->getClassMetadata($resourceClass);
+
+        if (!$classMetadata->hasReference($property)) {
+            return;
+        }
+
+        $method = $classMetadata->isCollectionValuedAssociation($property) ? 'includesReferenceTo' : 'references';
+
+        if (is_iterable($value)) {
+            $match = $aggregationBuilder->match();
+            $or = $match->expr();
+
+            foreach ($value as $v) {
+                $or->addOr($match->expr()->field($property)->{$method}($v));
+            }
+
+            $match->addAnd($or);
+
+            return;
         }
 
         $aggregationBuilder
             ->match()
-            ->field('id')
-            ->{$isIterable ? 'in' : 'equals'}($ids);
+            ->field($property)
+            ->{$method}($value);
     }
 
     public static function getParameterProvider(): string

src/Doctrine/Orm/Extension/ParameterExtension.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Doctrine\Orm\Extension;
 
+use ApiPlatform\Doctrine\Common\Filter\LoggerAwareInterface;
 use ApiPlatform\Doctrine\Common\Filter\ManagerRegistryAwareInterface;
 use ApiPlatform\Doctrine\Common\ParameterValueExtractorTrait;
 use ApiPlatform\Doctrine\Orm\Filter\AbstractFilter;
@@ -23,6 +24,7 @@
 use Doctrine\ORM\QueryBuilder;
 use Doctrine\Persistence\ManagerRegistry;
 use Psr\Container\ContainerInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Reads operation parameters and execute its filter.
@@ -36,6 +38,7 @@ final class ParameterExtension implements QueryCollectionExtensionInterface, Que
     public function __construct(
         private readonly ContainerInterface $filterLocator,
         private readonly ?ManagerRegistry $managerRegistry = null,
+        private readonly ?LoggerInterface $logger = null,
     ) {
     }
 
@@ -68,6 +71,10 @@ private function applyFilter(QueryBuilder $queryBuilder, QueryNameGeneratorInter
                 $filter->setManagerRegistry($this->managerRegistry);
             }
 
+            if ($this->logger && $filter instanceof LoggerAwareInterface && !$filter->hasLogger()) {
+                $filter->setLogger($this->logger);
+            }
+
             if ($filter instanceof AbstractFilter && !$filter->getProperties()) {
                 $propertyKey = $parameter->getProperty() ?? $parameter->getKey();
 

src/Symfony/Bundle/Resources/config/doctrine_mongodb_odm.xml

@@ -138,6 +138,7 @@
         <service id="api_platform.doctrine_mongodb.odm.extension.parameter_extension" class="ApiPlatform\Doctrine\Odm\Extension\ParameterExtension" public="false">
             <argument type="service" id="api_platform.filter_locator" />
             <argument type="service" id="doctrine_mongodb" on-invalid="null"/>
+            <argument type="service" id="logger" on-invalid="null"/>
             <tag name="api_platform.doctrine_mongodb.odm.aggregation_extension.collection" priority="32" />
             <tag name="api_platform.doctrine_mongodb.odm.aggregation_extension.item"/>
         </service>

src/Symfony/Bundle/Resources/config/doctrine_orm.xml

@@ -151,6 +151,7 @@
         <service id="api_platform.doctrine.orm.extension.parameter_extension" class="ApiPlatform\Doctrine\Orm\Extension\ParameterExtension" public="false">
             <argument type="service" id="api_platform.filter_locator" />
             <argument type="service" id="doctrine" on-invalid="null"/>
+            <argument type="service" id="logger" on-invalid="null"/>
             <tag name="api_platform.doctrine.orm.query_extension.collection" priority="-16" />
             <tag name="api_platform.doctrine.orm.query_extension.item" priority="-9" />
         </service>