[Sortable] Resolve Column Type when fetching Max Position from Database (#2462)

* Resolve Column Type when fetching Max Position from Database

In SQLite it makes a difference if date columns are queried with '00:00:00' as timestring or without. MySQL seems to ignore the time completely. Unfortunately there is an asymmetry between SQL Types and PHP Objects: 'date' and 'datetime' Column point both to a DateTime Object in PHP. Therefore, we cannot derive the column type from the PHP Object. Luckily we can ask the ClassMetadata in Doctrine for the right type.

* Fix CS

* Update tests/Gedmo/Sortable/Fixture/ItemWithDateColumn.php

Co-authored-by: Fran Moreno <[email protected]>

* Update tests/Gedmo/Sortable/Fixture/ItemWithDateColumn.php

Co-authored-by: Fran Moreno <[email protected]>

* Update tests/Gedmo/Sortable/Fixture/ItemWithDateColumn.php

Co-authored-by: Fran Moreno <[email protected]>

* Update tests/Gedmo/Sortable/Fixture/ItemWithDateColumn.php

Co-authored-by: Fran Moreno <[email protected]>

* Update tests/Gedmo/Sortable/Fixture/ItemWithDateColumn.php

Co-authored-by: Fran Moreno <[email protected]>

* Add Type Hints

* Add Changelog entry

* Update tests/Gedmo/Sortable/SortableGroupTest.php

Co-authored-by: Fran Moreno <[email protected]>

* Save some CPU cycles by reducing amount of generated test data

* Simplify Test by removing unnecessary Group Members

Co-authored-by: Fran Moreno <[email protected]>

Author: dritter

CHANGELOG.md

@@ -24,6 +24,10 @@ a release.
 - [NestedSet] childrenQueryBuilder() to allow specifying sort order separately for each field
 - [NestedSet] Added option to reorder only direct children in reorder() method
 
+### Sortable
+#### Fixed
+- [SortableGroup] Fix sorting date columns in SQLite (#2462).
+
 ## [3.7.0] - 2022-05-17
 ## Added
 - Add support for doctrine/persistence 3

src/Sortable/Mapping/Event/Adapter/ORM.php

@@ -35,7 +35,7 @@ public function getMaxPosition(array $config, $meta, $groups)
         $qb = $em->createQueryBuilder();
         $qb->select('MAX(n.'.$config['position'].')')
            ->from($config['useObjectClass'], 'n');
-        $this->addGroupWhere($qb, $groups);
+        $this->addGroupWhere($qb, $meta, $groups);
         $query = $qb->getQuery();
         $query->useQueryCache(false);
         $query->disableResultCache();
@@ -108,15 +108,15 @@ public function updatePositions($relocation, $delta, $config)
         $q->getSingleScalarResult();
     }
 
-    private function addGroupWhere(QueryBuilder $qb, iterable $groups): void
+    private function addGroupWhere(QueryBuilder $qb, ClassMetadata $metadata, iterable $groups): void
     {
         $i = 1;
         foreach ($groups as $group => $value) {
             if (null === $value) {
                 $qb->andWhere($qb->expr()->isNull('n.'.$group));
             } else {
                 $qb->andWhere('n.'.$group.' = :group__'.$i);
-                $qb->setParameter('group__'.$i, $value);
+                $qb->setParameter('group__'.$i, $value, $metadata->getTypeOfField($group));
             }
             ++$i;
         }

tests/Gedmo/Sortable/Fixture/ItemWithDateColumn.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of the Doctrine Behavioral Extensions package.
+ * (c) Gediminas Morkevicius <[email protected]> http://www.gediminasm.org
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gedmo\Tests\Sortable\Fixture;
+
+use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\Mapping as ORM;
+use Gedmo\Mapping\Annotation as Gedmo;
+use Gedmo\Sortable\Entity\Repository\SortableRepository;
+
+/**
+ * @ORM\Entity(repositoryClass="Gedmo\Sortable\Entity\Repository\SortableRepository")
+ */
+#[ORM\Entity(repositoryClass: SortableRepository::class)]
+class ItemWithDateColumn
+{
+    /**
+     * @var int|null
+     *
+     * @ORM\Id
+     * @ORM\GeneratedValue
+     * @ORM\Column(type="integer")
+     */
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column(type: Types::INTEGER)]
+    private $id;
+
+    /**
+     * @var int
+     *
+     * @Gedmo\SortablePosition
+     * @ORM\Column(type="integer")
+     */
+    #[Gedmo\SortablePosition]
+    #[ORM\Column(type: Types::INTEGER)]
+    private $position = 0;
+
+    /**
+     * @var \DateTime|null
+     *
+     * @Gedmo\SortableGroup
+     * @ORM\Column(type="date")
+     */
+    #[Gedmo\SortableGroup]
+    #[ORM\Column(type: Types::DATE_MUTABLE)]
+    private $date;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function setId(?int $id): void
+    {
+        $this->id = $id;
+    }
+
+    public function getPosition(): int
+    {
+        return $this->position;
+    }
+
+    public function setPosition(int $position): void
+    {
+        $this->position = $position;
+    }
+
+    public function getDate(): ?\DateTime
+    {
+        return $this->date;
+    }
+
+    public function setDate(?\DateTime $date): void
+    {
+        $this->date = $date;
+    }
+}

tests/Gedmo/Sortable/SortableGroupTest.php

@@ -15,6 +15,7 @@
 use Gedmo\Sortable\SortableListener;
 use Gedmo\Tests\Sortable\Fixture\Category;
 use Gedmo\Tests\Sortable\Fixture\Item;
+use Gedmo\Tests\Sortable\Fixture\ItemWithDateColumn;
 use Gedmo\Tests\Sortable\Fixture\Transport\Bus;
 use Gedmo\Tests\Sortable\Fixture\Transport\Car;
 use Gedmo\Tests\Sortable\Fixture\Transport\Engine;
@@ -36,6 +37,7 @@ final class SortableGroupTest extends BaseTestCaseORM
     public const RESERVATION = Reservation::class;
     public const ITEM = Item::class;
     public const CATEGORY = Category::class;
+    public const ITEM_WITH_DATE_COLUMN = ItemWithDateColumn::class;
 
     public const SEATS = 3;
 
@@ -239,6 +241,34 @@ public function testShouldBeAbleToChangeGroupAndPosition(): void
         static::assertSame(30, $position);
     }
 
+    public function testChangePositionWithDateColumn(): void
+    {
+        for ($i = 0; $i < 6; ++$i) {
+            $object = new ItemWithDateColumn();
+            $today = new \DateTime('2022-05-22');
+            $object->setDate($today);
+            $object->setPosition($i);
+            $this->em->persist($object);
+        }
+        $this->em->flush();
+
+        $repo = $this->em->getRepository(self::ITEM_WITH_DATE_COLUMN);
+
+        /** @var ItemWithDateColumn $testItem */
+        $testItem = $repo->findOneBy(['id' => 5]);
+        $testItem->setPosition(1);
+
+        $this->em->persist($testItem);
+        $this->em->flush();
+
+        /** @var ItemWithDateColumn $freshItem */
+        $freshItem = $repo->findOneBy(['id' => 5]);
+        /** @var ItemWithDateColumn $freshPreviousItem */
+        $freshPreviousItem = $repo->findOneBy(['id' => 2]);
+        static::assertSame(1, $freshItem->getPosition());
+        static::assertSame(2, $freshPreviousItem->getPosition());
+    }
+
     protected function getUsedEntityFixtures(): array
     {
         return [
@@ -249,6 +279,7 @@ protected function getUsedEntityFixtures(): array
             self::RESERVATION,
             self::ITEM,
             self::CATEGORY,
+            self::ITEM_WITH_DATE_COLUMN,
         ];
     }