Data object search service - order by key vs. order by index (#205)

* Add new modifier to sort results by tree index

* Apply php-cs-fixer changes

---------

Co-authored-by: lukmzig <[email protected]>

Author: lukmzig

config/pimcore/config.yaml

@@ -209,6 +209,8 @@ pimcore_generic_data_index:
               normalizer: generic_data_index_sort_normalizer
         classDefinitionIcon:
           type: keyword
+        index:
+          type: integer
       asset:
         mimetype:
           type: keyword

doc/04_Searching_For_Data_In_Index/05_Search_Modifiers/README.md

@@ -59,6 +59,7 @@ If multiple sort modifiers are added to the search, the order of the modifiers i
 | [OrderByFullPath](https://github.com/pimcore/generic-data-index-bundle/blob/1.x/src/Model/Search/Modifier/Sort/Tree/OrderByFullPath.php)     | Tree related sorting   | Order by full path (including element key)                                                                                                                                                                                                                                                                                                                                          |
 | [OrderByField](https://github.com/pimcore/generic-data-index-bundle/blob/1.x/src/Model/Search/Modifier/Sort/OrderByField.php)                | Field based sorting    | Order by given field name.<br/>If `$enablePqlFieldNameResolution` is set to true (default) [Pimcore Query Language](https://github.com/pimcore/generic-data-index-bundle/blob/1.x/src/Model/Search/Modifier/Sort/OrderByField.php) field name resolution logic is enabled. Therefore it's possible to use short field names then instead of specifying the full path in OpenSearch. |
 | [OrderByPageNumber](https://github.com/pimcore/generic-data-index-bundle/blob/1.x/src/Model/Search/Modifier/Sort/Tree/OrderByPageNumber.php) | Search related sorting | Use inverted search for large amounts of data (this modifier is added to the search when there are at least 1000 results by default, and page number is above the half of total pages. Furthermore, existing sorting has to be already applied.)                                                                                                                                    |
+| [OrderByIndexField](https://github.com/pimcore/generic-data-index-bundle/blob/1.x/src/Model/Search/Modifier/Sort/Tree/OrderByIndexField.php) | Search related sorting | Order by object tree index for custom tree sorting. This modifier is currently applied only for data objects!                                                                                                                                                                                                                                                                       |
 
 ### Aggregations
 

src/Enum/SearchIndex/FieldCategory/SystemField.php

@@ -33,6 +33,7 @@ enum SystemField: string
     case PUBLISHED = 'published';
     case TYPE = 'type';
     case KEY = 'key';
+    case INDEX = 'index';
     case PATH = 'path';
     case FULL_PATH = 'fullPath';
     case PATH_LEVELS = 'pathLevels';

src/Model/Search/DataObject/SearchResult/DataObjectSearchResultItem.php

@@ -31,6 +31,8 @@ class DataObjectSearchResultItem implements ElementSearchResultItemInterface
 
     private string $key;
 
+    private int $index;
+
     private bool $published;
 
     private string $path;
@@ -116,6 +118,18 @@ public function setKey(string $key): DataObjectSearchResultItem
         return $this;
     }
 
+    public function getIndex(): int
+    {
+        return $this->index;
+    }
+
+    public function setIndex(int $index): DataObjectSearchResultItem
+    {
+        $this->index = $index;
+
+        return $this;
+    }
+
     public function isPublished(): bool
     {
         return $this->published;

src/Model/Search/Modifier/Sort/Tree/OrderByIndexField.php

@@ -0,0 +1,28 @@
+<?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\Model\Search\Modifier\Sort\Tree;
+
+use Pimcore\Bundle\GenericDataIndexBundle\Enum\Search\SortDirection;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\SearchModifierInterface;
+
+final readonly class OrderByIndexField implements SearchModifierInterface
+{
+    public function getDirection(): SortDirection
+    {
+        return  SortDirection::ASC;
+    }
+}

src/SearchIndexAdapter/OpenSearch/DataObject/IndexIconUpdateService.php

@@ -26,7 +26,7 @@
  */
 final readonly class IndexIconUpdateService implements IndexIconUpdateServiceInterface
 {
-    public function __construct(private  Client $openSearchClient)
+    public function __construct(private Client $openSearchClient)
     {
     }
 

src/SearchIndexAdapter/OpenSearch/Search/Modifier/Sort/TreeSortHandlers.php

@@ -22,8 +22,10 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Model\OpenSearch\Modifier\SearchModifierContextInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\OpenSearch\Sort\FieldSort;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\OpenSearch\Sort\FieldSortList;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\DataObject\DataObjectSearch;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Sort\OrderByPageNumber;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Sort\Tree\OrderByFullPath;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Sort\Tree\OrderByIndexField;
 use Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\SearchIndexServiceInterface;
 
 /**
@@ -93,6 +95,24 @@ public function handleSortByPageNumber(
         }
     }
 
+    #[AsSearchModifierHandler]
+    public function handleIndexSort(
+        OrderByIndexField $indexSort,
+        SearchModifierContextInterface $context
+    ): void {
+        if (!$context->getOriginalSearch() instanceof DataObjectSearch) {
+            return;
+        }
+
+        $context->getSearch()
+            ->addSort(
+                new FieldSort(
+                    SystemField::INDEX->getPath(),
+                    $indexSort->getDirection()->value
+                )
+            );
+    }
+
     private function getInvertedSortList(array $sortListItems): array
     {
         $invertedSortList = [];

src/Service/Serializer/Denormalizer/Search/DataObjectSearchResultDenormalizer.php

@@ -59,6 +59,7 @@ public function denormalize(
             ->setType(SystemField::TYPE->getData($data))
             ->setPublished($published)
             ->setKey(SystemField::KEY->getData($data))
+            ->setIndex(SystemField::INDEX->getData($data))
             ->setPath(SystemField::PATH->getData($data))
             ->setFullPath(SystemField::FULL_PATH->getData($data))
             ->setUserOwner(SystemField::USER_OWNER->getData($data) ?? 0)

src/Service/Serializer/Normalizer/DataObjectNormalizer.php

@@ -107,6 +107,7 @@ private function normalizeSystemFields(AbstractObject $dataObject, bool $skipLaz
             SystemField::MODIFICATION_DATE->value => $this->formatTimestamp($dataObject->getModificationDate()),
             SystemField::TYPE->value => $dataObject->getType(),
             SystemField::KEY->value => $dataObject->getKey(),
+            SystemField::INDEX->value => $dataObject->getIndex(),
             SystemField::PATH->value => $dataObject->getPath(),
             SystemField::FULL_PATH->value => $dataObject->getRealFullPath(),
             SystemField::USER_OWNER->value => $dataObject->getUserOwner(),