[Elements]: Add service to update siblings indexes after element update

.github/ci/files/composer.json

@@ -16,7 +16,7 @@
     "pimcore/generic-data-index-bundle": "@dev"
   },
   "require-dev": {
-    "codeception/codeception": "^5.0.10",
+    "codeception/codeception": "^5.3.2",
     "codeception/phpunit-wrapper": "^9",
     "codeception/module-asserts": "^2",
     "codeception/module-symfony": "^3.1.1",

.github/workflows/elastic-search-codeception.yaml

@@ -58,7 +58,7 @@ jobs:
 
         steps:
             -   name: "Checkout code"
-                uses: "actions/checkout@v2"
+                uses: "actions/checkout@v4"
                 with:
                     path: "bundles/pimcore/generic-data-index-bundle"
 

.github/workflows/open-search-codeception.yaml

@@ -61,7 +61,7 @@ jobs:
 
         steps:
             -   name: "Checkout code"
-                uses: "actions/checkout@v2"
+                uses: "actions/checkout@v4"
                 with:
                     path: "bundles/pimcore/generic-data-index-bundle"
 

composer.json

@@ -28,11 +28,11 @@
   },
   "require-dev": {
     "roave/security-advisories": "dev-latest",
-    "codeception/codeception": "^5.0.10",
+    "codeception/codeception": "^5.3.2",
     "codeception/phpunit-wrapper": "^9",
     "codeception/module-asserts": "^2",
     "codeception/module-symfony": "^3.1.1",
-    "phpstan/phpstan": "^1.10.5",
+    "phpstan/phpstan": "1.12.15",
     "phpstan/phpstan-symfony": "^1.2.20",
     "phpunit/phpunit": "10.2.7",
     "nyholm/psr7": "^1",

config/services/search/index.yaml

@@ -10,6 +10,9 @@ services:
     Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexEntityServiceInterface:
         class: Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexEntityService
 
+    Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexElementIndexServiceInterface:
+        class: Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexElementIndexService
+
     Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexUpdateServiceInterface:
         class: Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexUpdateService
 

src/EventSubscriber/DataObjectIndexUpdateSubscriber.php

@@ -13,15 +13,20 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\EventSubscriber;
 
+use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\ElementType;
 use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\IndexQueueOperation;
 use Pimcore\Bundle\GenericDataIndexBundle\Installer;
+use Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService\DataObject\SearchHelper;
+use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexElementIndexServiceInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexQueue\QueueMessagesDispatcher;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexQueue\SynchronousProcessingRelatedIdsServiceInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexQueue\SynchronousProcessingServiceInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexQueueServiceInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Traits\LoggerAwareTrait;
+use Pimcore\Bundle\StaticResolverBundle\Lib\Cache\RuntimeCacheResolverInterface;
 use Pimcore\Event\DataObjectEvents;
 use Pimcore\Event\Model\DataObjectEvent;
+use Pimcore\Model\DataObject\AbstractObject;
 use Pimcore\Model\DataObject\Service;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
@@ -35,7 +40,9 @@ final class DataObjectIndexUpdateSubscriber implements EventSubscriberInterface
     public function __construct(
         private readonly Installer $installer,
         private readonly IndexQueueServiceInterface $indexQueueService,
+        private readonly IndexElementIndexServiceInterface $indexElementIndexService,
         private readonly QueueMessagesDispatcher $queueMessagesDispatcher,
+        private readonly RuntimeCacheResolverInterface $runtimeCacheResolver,
         private readonly SynchronousProcessingServiceInterface $synchronousProcessing,
         private readonly SynchronousProcessingRelatedIdsServiceInterface $synchronousProcessingRelatedIds
     ) {
@@ -44,57 +51,77 @@ public function __construct(
     public static function getSubscribedEvents(): array
     {
         return [
+            DataObjectEvents::POST_ADD => 'addDataObject',
             DataObjectEvents::POST_UPDATE => 'updateDataObject',
-            DataObjectEvents::POST_ADD => 'updateDataObject',
             DataObjectEvents::POST_DELETE => 'deleteDataObject',
         ];
     }
 
+    public function addDataObject(DataObjectEvent $event): void
+    {
+        $this->updateData($event);
+    }
+
     public function updateDataObject(DataObjectEvent $event): void
     {
-        if (!$this->installer->isInstalled()) {
-            return;
+        $this->indexElementIndexService->updateSiblings($event->getObject(), ElementType::DATA_OBJECT->value);
+        if ($event->getObject()->getChildrenSortBy() === AbstractObject::OBJECT_CHILDREN_SORT_BY_INDEX) {
+            $this->indexElementIndexService->resetChildrenIndexBy($event->getObject());
         }
+        $this->updateData($event);
+    }
 
-        //do not update index when auto save or only saving version
-        if (
-            ($event->hasArgument('isAutoSave') && $event->getArgument('isAutoSave')) ||
-            ($event->hasArgument('saveVersionOnly') && $event->getArgument('saveVersionOnly'))
-        ) {
+    public function deleteDataObject(DataObjectEvent $event): void
+    {
+        if (!$this->installer->isInstalled()) {
             return;
         }
 
         $dataObject = $event->getObject();
-        Service::useInheritedValues(true, fn () =>
-            $this->indexQueueService
-                ->updateIndexQueue(
-                    $dataObject,
-                    IndexQueueOperation::UPDATE->value,
-                    $this->synchronousProcessing->isEnabled(),
-                    $dataObject->hasChildren(includingUnpublished: true),
-                    $this->synchronousProcessingRelatedIds->isEnabled() === false
-                )
-                ->commit()
-        );
-
+        $this->indexQueueService
+            ->updateIndexQueue(
+                $dataObject,
+                IndexQueueOperation::DELETE->value,
+                $this->synchronousProcessing->isEnabled(),
+                $dataObject->hasChildren(includingUnpublished: true)
+            )
+            ->commit();
         $this->queueMessagesDispatcher->dispatchQueueMessages();
     }
 
-    public function deleteDataObject(DataObjectEvent $event): void
+    private function updateData(DataObjectEvent $event): void
     {
         if (!$this->installer->isInstalled()) {
             return;
         }
 
+        //do not update index when auto save or only saving a version
+        if (
+            ($event->hasArgument('isAutoSave') && $event->getArgument('isAutoSave')) ||
+            ($event->hasArgument('saveVersionOnly') && $event->getArgument('saveVersionOnly'))
+        ) {
+            return;
+        }
+
         $dataObject = $event->getObject();
+        Service::useInheritedValues(true, fn () =>
         $this->indexQueueService
             ->updateIndexQueue(
                 $dataObject,
-                IndexQueueOperation::DELETE->value,
+                IndexQueueOperation::UPDATE->value,
                 $this->synchronousProcessing->isEnabled(),
-                $dataObject->hasChildren(includingUnpublished: true)
+                $dataObject->hasChildren(includingUnpublished: true),
+                $this->synchronousProcessingRelatedIds->isEnabled() === false
             )
-            ->commit();
+            ->commit()
+        );
+
         $this->queueMessagesDispatcher->dispatchQueueMessages();
+
+        //clear runtime cache for this object
+        $cacheKey = SearchHelper::OBJECT_SEARCH . '_' . $event->getObject()->getId();
+        if ($this->runtimeCacheResolver->isRegistered($cacheKey)) {
+            $this->runtimeCacheResolver->set($cacheKey, null);
+        }
     }
 }

src/EventSubscriber/DocumentIndexUpdateSubscriber.php

@@ -13,12 +13,16 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\EventSubscriber;
 
+use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\ElementType;
 use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\IndexQueueOperation;
 use Pimcore\Bundle\GenericDataIndexBundle\Installer;
+use Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService\Document\SearchHelper;
+use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexElementIndexServiceInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexQueue\QueueMessagesDispatcher;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexQueue\SynchronousProcessingRelatedIdsServiceInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexQueue\SynchronousProcessingServiceInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\IndexQueueServiceInterface;
+use Pimcore\Bundle\StaticResolverBundle\Lib\Cache\RuntimeCacheResolverInterface;
 use Pimcore\Event\DocumentEvents;
 use Pimcore\Event\Model\DocumentEvent;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -30,8 +34,10 @@
 {
     public function __construct(
         private IndexQueueServiceInterface $indexQueueService,
+        private IndexElementIndexServiceInterface $indexElementIndexService,
         private Installer $installer,
         private QueueMessagesDispatcher $queueMessagesDispatcher,
+        private RuntimeCacheResolverInterface $runtimeCacheResolver,
         private SynchronousProcessingServiceInterface $synchronousProcessing,
         private SynchronousProcessingRelatedIdsServiceInterface $synchronousProcessingRelatedIds
     ) {
@@ -40,13 +46,24 @@ public function __construct(
     public static function getSubscribedEvents(): array
     {
         return [
+            DocumentEvents::POST_ADD => 'addDocument',
             DocumentEvents::POST_UPDATE=> 'updateDocument',
-            DocumentEvents::POST_ADD => 'updateDocument',
             DocumentEvents::POST_DELETE => 'deleteDocument',
         ];
     }
 
+    public function addDocument(DocumentEvent $event): void
+    {
+        $this->updateData($event);
+    }
+
     public function updateDocument(DocumentEvent $event): void
+    {
+        $this->indexElementIndexService->updateSiblings($event->getDocument(), ElementType::DOCUMENT->value);
+        $this->updateData($event);
+    }
+
+    public function deleteDocument(DocumentEvent $event): void
     {
         if (!$this->installer->isInstalled()) {
             return;
@@ -55,28 +72,33 @@ public function updateDocument(DocumentEvent $event): void
         $this->indexQueueService
             ->updateIndexQueue(
                 element: $event->getDocument(),
-                operation: IndexQueueOperation::UPDATE->value,
-                processSynchronously: $this->synchronousProcessing->isEnabled(),
-                enqueueRelatedItemsAsync: $this->synchronousProcessingRelatedIds->isEnabled() === false
+                operation: IndexQueueOperation::DELETE->value,
+                processSynchronously: $this->synchronousProcessing->isEnabled()
             )
             ->commit();
-
         $this->queueMessagesDispatcher->dispatchQueueMessages();
     }
 
-    public function deleteDocument(DocumentEvent $event): void
+    private function updateData(DocumentEvent $event): void
     {
         if (!$this->installer->isInstalled()) {
             return;
         }
-
         $this->indexQueueService
             ->updateIndexQueue(
                 element: $event->getDocument(),
-                operation: IndexQueueOperation::DELETE->value,
-                processSynchronously: $this->synchronousProcessing->isEnabled()
+                operation: IndexQueueOperation::UPDATE->value,
+                processSynchronously: $this->synchronousProcessing->isEnabled(),
+                enqueueRelatedItemsAsync: $this->synchronousProcessingRelatedIds->isEnabled() === false
             )
             ->commit();
+
         $this->queueMessagesDispatcher->dispatchQueueMessages();
+
+        //clear runtime cache for this object
+        $cacheKey = SearchHelper::DOCUMENT_SEARCH . '_' . $event->getDocument()->getId();
+        if ($this->runtimeCacheResolver->isRegistered($cacheKey)) {
+            $this->runtimeCacheResolver->set($cacheKey, null);
+        }
     }
 }

src/SearchIndexAdapter/BulkOperationServiceInterface.php

@@ -27,6 +27,12 @@ public function add(
         bool $upsert = true
     ): void;
 
+    public function addUpdate(
+        string $indexName,
+        int $id,
+        array $updateData
+    ): void;
+
     public function addDeletion(
         string $indexName,
         int $id

src/SearchIndexAdapter/DefaultSearch/BulkOperationService.php

@@ -53,6 +53,23 @@ public function add(
         $this->bulkOperationData[] = $indexData;
     }
 
+    public function addUpdate(
+        string $indexName,
+        int $id,
+        array $updateData
+    ): void {
+        $this->bulkOperationData[] = [
+            'update' => [
+                '_index' => $indexName,
+                '_id' => $id,
+            ],
+        ];
+
+        $this->bulkOperationData[] = [
+            'doc' => $updateData,
+        ];
+    }
+
     public function addDeletion(
         string $indexName,
         int $id

src/Service/Search/SearchService/Asset/AssetSearchService.php

@@ -105,6 +105,9 @@ public function byId(
 
         try {
             $searchResult = $this->runtimeCacheResolver->load($cacheKey);
+            if ($searchResult === null) {
+                $searchResult = $this->searchAssetById($id, $user);
+            }
         } catch (Exception) {
             $searchResult = $this->searchAssetById($id, $user);
         }

src/Service/Search/SearchService/DataObject/DataObjectSearchService.php

@@ -108,6 +108,9 @@ public function byId(
 
         try {
             $searchResult = $this->runtimeCacheResolver->load($cacheKey);
+            if ($searchResult === null) {
+                $searchResult = $this->searchObjectById($id, $user);
+            }
         } catch (Exception) {
             $searchResult = $this->searchObjectById($id, $user);
         }

src/Service/Search/SearchService/Document/DocumentSearchService.php

@@ -105,6 +105,9 @@ public function byId(
 
         try {
             $searchResult = $this->runtimeCacheResolver->load($cacheKey);
+            if ($searchResult === null) {
+                $searchResult = $this->searchDocumentById($id, $user);
+            }
         } catch (Exception) {
             $searchResult = $this->searchDocumentById($id, $user);
         }

src/Service/Search/SearchService/Element/ElementSearchService.php

@@ -72,8 +72,11 @@ public function search(
         }
     }
 
-    public function byId(ElementType $elementType, int $id, ?User $user = null): ?ElementSearchResultItemInterface
-    {
+    public function byId(
+        ElementType $elementType,
+        int $id,
+        ?User $user = null
+    ): ?ElementSearchResultItemInterface {
         try {
             return match ($elementType) {
                 ElementType::DOCUMENT => $this->documentSearchService->byId($id, $user),

src/Service/Search/SearchService/Element/ElementSearchServiceInterface.php

@@ -34,5 +34,9 @@ public function search(
     /**
      * @throws ElementSearchException
      */
-    public function byId(ElementType $elementType, int $id, ?User $user = null): ?ElementSearchResultItemInterface;
+    public function byId(
+        ElementType $elementType,
+        int $id,
+        ?User $user = null
+    ): ?ElementSearchResultItemInterface;
 }