Add mongodb date_immutable filter support

.github/workflows/ci.yml

@@ -522,7 +522,6 @@ jobs:
       - name: Update project dependencies
         run: |
           composer update --no-interaction --no-progress --ansi
-          composer why doctrine/reflection
       # - name: Require Symfony Uid
       #   run: composer require symfony/uid --dev --no-interaction --no-progress --ansi
       - name: Install PHPUnit

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.7.0
+
+* MongoDB: `date_immutable` support (#3940)
+
 ## 2.6.1
 
 * Fix defaults when using attributes (#3978)

composer.json

@@ -37,7 +37,7 @@
         "doctrine/common": "^2.11 || ^3.0",
         "doctrine/data-fixtures": "^1.2.2",
         "doctrine/doctrine-bundle": "^1.12 || ^2.0",
-        "doctrine/mongodb-odm": "^2.0",
+        "doctrine/mongodb-odm": "^2.1",
         "doctrine/mongodb-odm-bundle": "^4.0",
         "doctrine/orm": "^2.6.4 || ^3.0",
         "elasticsearch/elasticsearch": "^6.0 || ^7.0",
@@ -86,7 +86,7 @@
     },
     "conflict": {
         "doctrine/common": "<2.7",
-        "doctrine/mongodb-odm": "<2.0",
+        "doctrine/mongodb-odm": "<2.1",
         "doctrine/persistence": "<1.3"
     },
     "suggest": {

features/doctrine/date_filter.feature

@@ -506,7 +506,6 @@ Feature: Date filter on collections
     And the JSON node "hydra:member[0].dateIncludeNullBeforeAndAfter" should be equal to "2015-04-02T00:00:00+00:00"
     And the JSON node "hydra:member[1].dateIncludeNullBeforeAndAfter" should be null
 
-  @!mongodb
   @createSchema
   Scenario: Get collection filtered by date that is an immutable date variant
     Given there are 30 dummyimmutabledate objects with dummyDate

src/Bridge/Doctrine/MongoDbOdm/Filter/DateFilter.php

@@ -34,6 +34,7 @@ class DateFilter extends AbstractFilter implements DateFilterInterface
 
     public const DOCTRINE_DATE_TYPES = [
         MongoDbType::DATE => true,
+        MongoDbType::DATE_IMMUTABLE => true,
     ];
 
     /**

src/Bridge/Doctrine/MongoDbOdm/Filter/SearchFilter.php

@@ -202,6 +202,7 @@ protected function getType(string $doctrineType): string
             case MongoDbType::BOOLEAN:
                 return 'bool';
             case MongoDbType::DATE:
+            case MongoDbType::DATE_IMMUTABLE:
                 return \DateTimeInterface::class;
             case MongoDbType::FLOAT:
                 return 'float';

src/Bridge/Doctrine/MongoDbOdm/PropertyInfo/DoctrineExtractor.php

@@ -92,6 +92,8 @@ public function getTypes($class, $property, array $context = [])
             switch ($typeOfField) {
                 case MongoDbType::DATE:
                     return [new Type(Type::BUILTIN_TYPE_OBJECT, $nullable, 'DateTime')];
+                case MongoDbType::DATE_IMMUTABLE:
+                    return [new Type(Type::BUILTIN_TYPE_OBJECT, $nullable, 'DateTimeImmutable')];
                 case MongoDbType::HASH:
                     return [new Type(Type::BUILTIN_TYPE_ARRAY, $nullable, null, true)];
                 case MongoDbType::COLLECTION:

tests/Behat/DoctrineContext.php

@@ -45,6 +45,7 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\DummyDtoOutputSameClass as DummyDtoOutputSameClassDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\DummyFriend as DummyFriendDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\DummyGroup as DummyGroupDocument;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\DummyImmutableDate as DummyImmutableDateDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\DummyMercure as DummyMercureDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\DummyOffer as DummyOfferDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\DummyProduct as DummyProductDocument;
@@ -1270,7 +1271,7 @@ public function thereAreDummyImmutableDateObjectsWithDummyDate(int $nb)
     {
         for ($i = 1; $i <= $nb; ++$i) {
             $date = new \DateTimeImmutable(sprintf('2015-04-%d', $i), new \DateTimeZone('UTC'));
-            $dummy = new DummyImmutableDate();
+            $dummy = $this->buildDummyImmutableDate();
             $dummy->dummyDate = $date;
 
             $this->manager->persist($dummy);
@@ -1801,6 +1802,14 @@ private function buildDummyDate()
         return $this->isOrm() ? new DummyDate() : new DummyDateDocument();
     }
 
+    /**
+     * @return DummyImmutableDate|DummyImmutableDateDocument
+     */
+    private function buildDummyImmutableDate()
+    {
+        return $this->isOrm() ? new DummyImmutableDate() : new DummyImmutableDateDocument();
+    }
+
     /**
      * @return DummyDifferentGraphQlSerializationGroup|DummyDifferentGraphQlSerializationGroupDocument
      */

tests/Bridge/Doctrine/MongoDbOdm/PropertyInfo/DoctrineExtractorTest.php

@@ -52,6 +52,7 @@ public function testGetProperties(): void
                 'binUuidRfc4122',
                 'timestamp',
                 'date',
+                'dateImmutable',
                 'float',
                 'bool',
                 'boolean',
@@ -141,6 +142,7 @@ public function typesProvider(): array
             ['binUuidRfc4122', [new Type(Type::BUILTIN_TYPE_STRING)]],
             ['timestamp', [new Type(Type::BUILTIN_TYPE_STRING)]],
             ['date', [new Type(Type::BUILTIN_TYPE_OBJECT, false, 'DateTime')]],
+            ['dateImmutable', [new Type(Type::BUILTIN_TYPE_OBJECT, false, 'DateTimeImmutable')]],
             ['float', [new Type(Type::BUILTIN_TYPE_FLOAT)]],
             ['bool', [new Type(Type::BUILTIN_TYPE_BOOL)]],
             ['boolean', [new Type(Type::BUILTIN_TYPE_BOOL)]],

tests/Bridge/Doctrine/MongoDbOdm/PropertyInfo/Fixtures/DoctrineDummy.php

@@ -91,6 +91,11 @@ class DoctrineDummy
      */
     private $date;
 
+    /**
+     * @Field(type="date_immutable")
+     */
+    private $dateImmutable;
+
     /**
      * @Field(type="float")
      */

tests/Fixtures/TestBundle/Document/DummyImmutableDate.php

@@ -0,0 +1,53 @@
+<?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\Core\Tests\Fixtures\TestBundle\Document;
+
+use ApiPlatform\Core\Annotation\ApiResource;
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+
+/**
+ * Dummy Date Immutable.
+ *
+ * @ApiResource(attributes={
+ *     "filters"={"my_dummy_immutable_date.mongodb.date"}
+ * })
+ *
+ * @ODM\Document
+ */
+class DummyImmutableDate
+{
+    /**
+     * @var int The id
+     *
+     * @ODM\Id(strategy="INCREMENT", type="integer")
+     */
+    private $id;
+
+    /**
+     * @var \DateTimeImmutable The dummy date
+     *
+     * @ODM\Field(type="date_immutable")
+     */
+    public $dummyDate;
+
+    /**
+     * Get id.
+     *
+     * @return int
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+}

tests/Fixtures/app/config/config_mongodb.yml

@@ -60,6 +60,10 @@ services:
         parent:    'api_platform.doctrine_mongodb.odm.date_filter'
         arguments: [ { 'dummyDate': ~ } ]
         tags:      [ { name: 'api_platform.filter', id: 'my_dummy_date.mongodb.date' } ]
+    app.my_dummy_immutable_date_resource.mongodb.date_filter:
+        parent:    'api_platform.doctrine_mongodb.odm.date_filter'
+        arguments: [ { 'dummyDate': ~ } ]
+        tags:      [ { name: 'api_platform.filter', id: 'my_dummy_immutable_date.mongodb.date' } ]
     app.related_dummy_to_friend_resource.mongodb.search_filter:
         parent:    'api_platform.doctrine_mongodb.odm.search_filter'
         arguments: [ { 'name': 'ipartial', 'description': 'ipartial' } ]