Use correct OpenSearch mappings for date + time attribute types

composer.json

@@ -18,7 +18,7 @@
   "minimum-stability": "dev",
   "require": {
     "php": "~8.2.0 || ~8.3.0 ",
-    "pimcore/pimcore": "^11.2.0",
+    "pimcore/pimcore": "^11.3.0",
     "pimcore/static-resolver-bundle": "^1.4.0",
     "pimcore/opensearch-client": "^1.0.0",
     "doctrine/orm": "^2.17.2",

config/services/search/data-object/field-definition-adapters.yml

@@ -18,7 +18,6 @@ services:
             - { name: "pimcore.generic_data_index.data-object.search_index_field_definition", type: "language" }
             - { name: "pimcore.generic_data_index.data-object.search_index_field_definition", type: "languagemultiselect" }
             - { name: "pimcore.generic_data_index.data-object.search_index_field_definition", type: "password" }
-            - { name: "pimcore.generic_data_index.data-object.search_index_field_definition", type: "time" }
             - { name: "pimcore.generic_data_index.data-object.search_index_field_definition", type: "user" }
             - { name: "pimcore.generic_data_index.data-object.search_index_field_definition", type: "firstname" }
             - { name: "pimcore.generic_data_index.data-object.search_index_field_definition", type: "lastname" }
@@ -35,9 +34,22 @@ services:
         shared: false
         tags:
             - { name: "pimcore.generic_data_index.data-object.search_index_field_definition", type: "date" }
+
+    Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\OpenSearch\DataObject\FieldDefinitionAdapter\DatetimeAdapter:
+        shared: false
+        tags:
             - { name: "pimcore.generic_data_index.data-object.search_index_field_definition", type: "datetime" }
+
+    Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\OpenSearch\DataObject\FieldDefinitionAdapter\DateRangeAdapter:
+        shared: false
+        tags:
             - { name: "pimcore.generic_data_index.data-object.search_index_field_definition", type: "dateRange" }
 
+    Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\OpenSearch\DataObject\FieldDefinitionAdapter\TimeAdapter:
+        shared: false
+        tags:
+            - { name: "pimcore.generic_data_index.data-object.search_index_field_definition", type: "time" }
+
     Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\OpenSearch\DataObject\FieldDefinitionAdapter\LocalizedFieldsAdapter:
         shared: false
         tags:

src/Model/OpenSearch/Query/DateFilter.php

@@ -98,7 +98,9 @@ public function isEmpty(): bool
 
     public function getParams(): array
     {
-        $params = [];
+        $params = [
+            'format' => "yyyy-MM-dd'T'HH:mm:ssz",
+        ];
         if ($this->onDate) {
             $params['gte'] = $this->getStartOfDay($this->onDate)->format(DateTimeInterface::ATOM);
             $params['lte'] =  $this->getEndOfDay($this->onDate)->format(DateTimeInterface::ATOM);

src/SearchIndexAdapter/OpenSearch/DataObject/FieldDefinitionAdapter/DateAdapter.php

@@ -16,7 +16,10 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\OpenSearch\DataObject\FieldDefinitionAdapter;
 
+use Carbon\Carbon;
+use DateTimeInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\OpenSearch\AttributeType;
+use Pimcore\Model\DataObject\ClassDefinition\Data\Date;
 
 /**
  * @internal
@@ -27,6 +30,26 @@ public function getIndexMapping(): array
     {
         return [
             'type' => AttributeType::DATE->value,
+            'format' => $this->respectTimezone() ? 'strict_date_time_no_millis' : 'strict_date',
         ];
     }
+
+    public function normalize(mixed $value): ?string
+    {
+        if ($value instanceof Carbon) {
+            return $value->format($this->respectTimezone() ? DateTimeInterface::ATOM : 'Y-m-d');
+        }
+
+        return null;
+    }
+
+    private function respectTimezone(): bool
+    {
+        $fieldDefinition = $this->getFieldDefinition();
+        if (!$fieldDefinition instanceof Date) {
+            return false;
+        }
+
+        return $fieldDefinition->getColumnType() === 'bigint(20)';
+    }
 }

src/SearchIndexAdapter/OpenSearch/DataObject/FieldDefinitionAdapter/DateRangeAdapter.php

@@ -0,0 +1,68 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\OpenSearch\DataObject\FieldDefinitionAdapter;
+
+use Carbon\CarbonInterface;
+use Carbon\CarbonPeriod;
+use DateTimeInterface;
+use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\OpenSearch\AttributeType;
+
+/**
+ * @internal
+ */
+final class DateRangeAdapter extends AbstractAdapter
+{
+    public function getIndexMapping(): array
+    {
+        return [
+            'type' => AttributeType::OBJECT->value,
+            'properties' => [
+                'start' => [
+                    'type' => AttributeType::DATE->value,
+                    'format' => 'strict_date_time_no_millis',
+                ],
+                'end' => [
+                    'type' => AttributeType::DATE->value,
+                    'format' => 'strict_date_time_no_millis',
+                ],
+            ],
+        ];
+    }
+
+    public function normalize(mixed $value): ?array
+    {
+        if ($value instanceof CarbonPeriod) {
+            if ($value->getEndDate()) {
+                return [
+                    'start' => $this->formatDate($value->getStartDate()),
+                    'end' => $this->formatDate($value->getEndDate()),
+                ];
+            }
+
+            return [
+                'start' => $this->formatDate($value->getStartDate()),
+            ];
+        }
+
+        return null;
+    }
+
+    private function formatDate(?CarbonInterface $date): ?string
+    {
+        return $date?->format(DateTimeInterface::ATOM);
+    }
+}

src/SearchIndexAdapter/OpenSearch/DataObject/FieldDefinitionAdapter/DatetimeAdapter.php

@@ -0,0 +1,55 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\OpenSearch\DataObject\FieldDefinitionAdapter;
+
+use Carbon\Carbon;
+use DateTimeInterface;
+use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\OpenSearch\AttributeType;
+use Pimcore\Model\DataObject\ClassDefinition\Data\Datetime;
+
+/**
+ * @internal
+ */
+final class DatetimeAdapter extends AbstractAdapter
+{
+    public function getIndexMapping(): array
+    {
+        return [
+            'type' => AttributeType::DATE->value,
+            'format' => $this->respectTimezone() ? 'strict_date_time_no_millis' : 'strict_date_hour_minute_second',
+        ];
+    }
+
+    public function normalize(mixed $value): ?string
+    {
+        if ($value instanceof Carbon) {
+            return $value->format($this->respectTimezone() ? DateTimeInterface::ATOM : 'Y-m-d\TH:i:s');
+        }
+
+        return null;
+    }
+
+    private function respectTimezone(): bool
+    {
+        $fieldDefinition = $this->getFieldDefinition();
+        if (!$fieldDefinition instanceof Datetime) {
+            return false;
+        }
+
+        return $fieldDefinition->isRespectTimezone();
+    }
+}

src/SearchIndexAdapter/OpenSearch/DataObject/FieldDefinitionAdapter/TimeAdapter.php

@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\OpenSearch\DataObject\FieldDefinitionAdapter;
+
+use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\OpenSearch\AttributeType;
+
+/**
+ * @internal
+ */
+final class TimeAdapter extends AbstractAdapter
+{
+    public function getIndexMapping(): array
+    {
+        return [
+            'type' => AttributeType::DATE->value,
+            'format' => 'strict_hour_minute',
+        ];
+    }
+}

tests/Functional/Search/Modifier/Filter/FieldTypeFiltersTest.php

@@ -85,7 +85,7 @@ public function testMultiSelectFilter()
         $this->assertIdArrayEquals([], $searchResult->getIds());
     }
 
-    public function testDateFilter()
+    public function testDateFilterAsset()
     {
         $asset1 = TestHelper::createImageAsset()
             ->addMetadata('testDate', 'date', strtotime('2020-01-01'))
@@ -104,46 +104,104 @@ public function testDateFilter()
         /** @var SearchProviderInterface $searchProvider */
         $searchProvider = $this->tester->grabService(SearchProviderInterface::class);
 
-        $elementSearch = $searchProvider
+        $assetSearch = $searchProvider
             ->createAssetSearch()
-            ->addModifier(new DateFilter('testDate', Carbon::create('2019', 12, 31)))
-        ;
-        $searchResult = $searchService->search($elementSearch);
+            ->addModifier(new DateFilter('testDate', Carbon::create('2019', 12, 31)));
+        $searchResult = $searchService->search($assetSearch);
         $this->assertIdArrayEquals([$asset1->getId(), $asset2->getId(), $asset3->getId()], $searchResult->getIds());
 
-        $elementSearch = $searchProvider
+        $assetSearch = $searchProvider
             ->createAssetSearch()
-            ->addModifier(new DateFilter('testDate', Carbon::create('2019', 12, 31), Carbon::create('2020', 1, 15)))
-        ;
-        $searchResult = $searchService->search($elementSearch);
+            ->addModifier(new DateFilter('testDate', Carbon::create('2019', 12, 31), Carbon::create('2020', 1, 15)));
+        $searchResult = $searchService->search($assetSearch);
         $this->assertIdArrayEquals([$asset1->getId()], $searchResult->getIds());
 
-        $elementSearch = $searchProvider
+        $assetSearch = $searchProvider
             ->createAssetSearch()
-            ->addModifier(new DateFilter('testDate', null, null, Carbon::create('2020', 2, 2)))
-        ;
-        $searchResult = $searchService->search($elementSearch);
+            ->addModifier(new DateFilter('testDate', null, null, Carbon::create('2020', 2, 2)));
+        $searchResult = $searchService->search($assetSearch);
         $this->assertIdArrayEquals([$asset2->getId()], $searchResult->getIds());
 
-        $elementSearch = $searchProvider
+        $assetSearch = $searchProvider
             ->createAssetSearch()
-            ->addModifier(new DateFilter('testDate', null, null, Carbon::create('2020', 2, 2), false))
-        ;
-        $searchResult = $searchService->search($elementSearch);
+            ->addModifier(new DateFilter('testDate', null, null, Carbon::create('2020', 2, 2), false));
+        $searchResult = $searchService->search($assetSearch);
         $this->assertIdArrayEquals([], $searchResult->getIds());
 
-        $elementSearch = $searchProvider
+        $assetSearch = $searchProvider
             ->createAssetSearch()
-            ->addModifier(new DateFilter('standard_fields.testDate.default', null, null, Carbon::create('2020', 2, 2), true, false))
-        ;
-        $searchResult = $searchService->search($elementSearch);
+            ->addModifier(new DateFilter('standard_fields.testDate.default', null, null, Carbon::create('2020', 2, 2), true, false));
+        $searchResult = $searchService->search($assetSearch);
         $this->assertIdArrayEquals([$asset2->getId()], $searchResult->getIds());
 
-        $elementSearch = $searchProvider
+        $assetSearch = $searchProvider
             ->createAssetSearch()
-            ->addModifier(new DateFilter('testDate', null, null, Carbon::create('2020', 2, 2), true, false))
+            ->addModifier(new DateFilter('testDate', null, null, Carbon::create('2020', 2, 2), true, false));
+        $searchResult = $searchService->search($assetSearch);
+        $this->assertIdArrayEquals([], $searchResult->getIds());
+    }
+
+    public function testDateFilterDataObject()
+    {
+        $dataObject1 = TestHelper::createEmptyObject()
+            ->setDate(Carbon::create('2020', 1, 1))
+            ->save();
+
+        $dataObject2 = TestHelper::createEmptyObject()
+            ->setDate(Carbon::create('2020', 2, 2, 12))
+            ->save();
+
+        $dataObject3 = TestHelper::createEmptyObject()
+            ->setDate(Carbon::create('2020', 3, 3))
+            ->save();
+
+        /** @var DataObjectSearchServiceInterface $searchService */
+        $searchService = $this->tester->grabService('generic-data-index.test.service.data-object-search-service');
+        /** @var SearchProviderInterface $searchProvider */
+        $searchProvider = $this->tester->grabService(SearchProviderInterface::class);
+
+        $dataObjectSearch = $searchProvider
+            ->createDataObjectSearch()
+            ->setClassDefinition($dataObject1->getClass())
+            ->addModifier(new DateFilter('date', Carbon::create('2019', 12, 31)))
         ;
-        $searchResult = $searchService->search($elementSearch);
+        $searchResult = $searchService->search($dataObjectSearch);
+        $this->assertIdArrayEquals([$dataObject1->getId(), $dataObject2->getId(), $dataObject3->getId()], $searchResult->getIds());
+
+        $dataObjectSearch = $searchProvider
+            ->createDataObjectSearch()
+            ->addModifier(new DateFilter('date', Carbon::create('2019', 12, 31), Carbon::create('2020', 1, 15)))
+        ;
+        $searchResult = $searchService->search($dataObjectSearch);
+        $this->assertIdArrayEquals([$dataObject1->getId()], $searchResult->getIds());
+
+        $dataObjectSearch = $searchProvider
+            ->createDataObjectSearch()
+            ->addModifier(new DateFilter('date', null, null, Carbon::create('2020', 2, 2)))
+        ;
+        $searchResult = $searchService->search($dataObjectSearch);
+        $this->assertIdArrayEquals([$dataObject2->getId()], $searchResult->getIds());
+
+        $dataObjectSearch = $searchProvider
+            ->createDataObjectSearch()
+            ->setClassDefinition($dataObject1->getClass())
+            ->addModifier(new DateFilter('date', null, null, Carbon::create('2020', 2, 2), false))
+        ;
+        $searchResult = $searchService->search($dataObjectSearch);
+        $this->assertIdArrayEquals([], $searchResult->getIds());
+
+        $dataObjectSearch = $searchProvider
+            ->createDataObjectSearch()
+            ->addModifier(new DateFilter('standard_fields.date', null, null, Carbon::create('2020', 2, 2), true, false))
+        ;
+        $searchResult = $searchService->search($dataObjectSearch);
+        $this->assertIdArrayEquals([$dataObject2->getId()], $searchResult->getIds());
+
+        $dataObjectSearch = $searchProvider
+            ->createDataObjectSearch()
+            ->addModifier(new DateFilter('date', null, null, Carbon::create('2020', 2, 2), true, false))
+        ;
+        $searchResult = $searchService->search($dataObjectSearch);
         $this->assertIdArrayEquals([], $searchResult->getIds());
 
     }