chore(indexer) Refactor and simplify design of indexer

Author: IvanChepurnyi

Api/IndexAction.php

@@ -11,5 +11,6 @@
 interface IndexGenerationObserver
 {
     public function beforeGeneration(IndexScope $scope);
+
     public function afterGeneration(IndexScope $scope);
 }

Api/IndexGenerationObserver.php

@@ -8,14 +8,11 @@
 
 namespace MageOS\Indexer\Api;
 
-use MageOS\Indexer\Model\ArrayIndexRecordData;
-
 interface IndexGenerator
 {
-    public function generateRecord(
-        int $entityId,
-        IndexScope $indexScope,
-        IndexRecordData $indexRecordData,
-        IndexStorageWriter $indexStorageWriter
+    public function process(
+        IndexScope  $scope,
+        IndexRecord $record,
+        IndexWriter $writer
     );
 }

Api/IndexGenerator.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * Copyright © Mage-OS Team. All rights reserved.
+ * See LICENSE for license details.
+ */
+
+declare(strict_types=1);
+
+namespace MageOS\Indexer\Api;
+
+interface IndexRecord
+{
+    /**
+     * Lists all entity within index record
+     *
+     * @return int[]
+     */
+    public function listEntityIds(): iterable;
+
+    /**
+     * Retrieves entity field in specific scope
+     *
+     * Should return value from scopeId 0 if it does not exist for current scope
+     */
+    public function getInScope(int $entityId, int $scopeId, string $field): mixed;
+
+    /**
+     * Retrieves entity field in global scope
+     */
+    public function get(int $entityId, string $field): mixed;
+}

Api/IndexRecord.php

@@ -8,16 +8,16 @@
 
 namespace MageOS\Indexer\Api;
 
-interface IndexRecordDataLoader
+interface IndexRecordLoader
 {
     /**
      * Loads data into index record by entity id range
      */
     public function loadByRange(
-        IndexScope $indexScope,
-        IndexRecordMutableData $data,
-        int $minEntityId,
-        int $maxEntityId
+        IndexScope         $indexScope,
+        IndexRecordMutable $data,
+        int                $minEntityId,
+        int                $maxEntityId
     ): void;
 
     /**
@@ -26,8 +26,8 @@ public function loadByRange(
      * @param int[] $entityIds
      */
     public function loadByIds(
-        IndexScope $indexScope,
-        IndexRecordMutableData $data,
-        array $entityIds
+        IndexScope         $indexScope,
+        IndexRecordMutable $data,
+        array              $entityIds
     ): void;
 }

Api/IndexRecordData.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Copyright © Mage-OS Team. All rights reserved.
+ * See LICENSE for license details.
+ */
+
+declare(strict_types=1);
+
+namespace MageOS\Indexer\Api;
+
+/**
+ * Mutable API of index record
+ *
+ * It is used in loaders and is separated to make sure index generator
+ * does not rely on mutations
+ */
+interface IndexRecordMutable extends IndexRecord
+{
+    /**
+     * Sets data for entity record
+     *
+     * If set was not called, rest of the calls should be ignored
+     */
+    public function set(int $entityId, array $data): void;
+
+    /**
+     * Adds field value for existing entity record
+     *
+     * If no entity data is available, it should be ignored
+     */
+    public function add(int $entityId, string $field, mixed $value): void;
+
+    /**
+     * Appends record to array entity field
+     *
+     * If no entity data is available, it should be ignored
+     */
+    public function append(int $entityId, string $field, string $key, mixed $value): void;
+
+    /**
+     * Adds field value in scope for entity
+     *
+     * If no entity data is available, it should be ignored
+     */
+    public function addInScope(int $entityId, int $storeId, string $field, mixed $value): void;
+}

Api/IndexRecordDataLoader.php renamed to Api/IndexRecordLoader.php

@@ -8,6 +8,11 @@
 
 namespace MageOS\Indexer\Api;
 
+/**
+ * Provider of independent scope for indexer
+ *
+ *
+ */
 interface IndexScopeProvider
 {
     /**

Api/IndexRecordMutable.php

@@ -8,7 +8,20 @@
 
 namespace MageOS\Indexer\Api;
 
+/**
+ * Mapper of storages to scope
+ */
 interface IndexStorageMap
 {
-    public function getStorageName(array $row): string;
+    /**
+     * Returns index storage name based on current row
+     */
+    public function getStorageByRow(array $row): string;
+
+    /**
+     * Returns all index storage tables that match current index scope
+     *
+     * @return string[]
+     */
+    public function getStorageListByScope(IndexScope $scope): iterable;
 }

Api/IndexRecordMutableData.php

@@ -8,9 +8,17 @@
 
 namespace MageOS\Indexer\Api;
 
-interface IndexStorageWriter
+interface IndexStorageWriter extends IndexWriter
 {
-    public function add($row): void;
+    /**
+     * Clear index storage by entity ids
+     *
+     * @param int[] $entityIds
+     */
+    public function clear(array $entityIds): void;
 
+    /**
+     * Finalize indexation
+     */
     public function finish(): void;
 }

Api/IndexScopeProvider.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Copyright © Mage-OS Team. All rights reserved.
+ * See LICENSE for license details.
+ */
+
+declare(strict_types=1);
+
+namespace MageOS\Indexer\Api;
+
+/**
+ * Writer for index generator
+ *
+ * Should store generated index rows into items
+ */
+interface IndexWriter
+{
+    public function add($row): void;
+}

Api/IndexStorageMap.php

@@ -8,24 +8,17 @@
 
 namespace MageOS\Indexer\Model;
 
-use MageOS\Indexer\Api\IndexRecordMutableData;
-
+use MageOS\Indexer\Api\IndexRecordMutable;
 use Traversable;
 
-class ArrayIndexRecordData implements \IteratorAggregate, IndexRecordMutableData
+class ArrayIndexRecord implements IndexRecordMutable
 {
     public function __construct(
         private array $data = [],
         private array $scopeData = []
-    ) {
-
-    }
-
-    public function getIterator(): Traversable
+    )
     {
-        foreach ($this->data as $entityId => $item) {
-            yield $entityId;
-        }
+
     }
 
     public function reset(): void
@@ -34,22 +27,22 @@ public function reset(): void
         $this->scopeData = [];
     }
 
-    public function setValue(int $entityId, array $data): void
+    public function set(int $entityId, array $data): void
     {
         $this->data[$entityId] = $data;
     }
 
-    public function addValue(int $entityId, string $field, mixed $value): void
+    public function add(int $entityId, string $field, mixed $value): void
     {
         $this->data[$entityId][$field] = $value;
     }
 
-    public function extendValue(int $entityId, string $field, string $key, mixed $value): void
+    public function append(int $entityId, string $field, string $key, mixed $value): void
     {
         $this->data[$entityId][$field][$key] = $value;
     }
 
-    public function addScopeValue(int $entityId, int $storeId, string $field, mixed $value): void
+    public function addInScope(int $entityId, int $storeId, string $field, mixed $value): void
     {
         if (!isset($this->data[$entityId])) {
             return;
@@ -58,15 +51,22 @@ public function addScopeValue(int $entityId, int $storeId, string $field, mixed
         $this->scopeData[$entityId][$storeId][$field] = $value;
     }
 
-    public function getScopeValue(int $entityId, int $scopeId, string $field): mixed
+    public function getInScope(int $entityId, int $scopeId, string $field): mixed
     {
         return $this->scopeData[$entityId][$scopeId][$field]
             ?? $this->scopeData[$entityId][0][$field]
             ?? null;
     }
 
-    public function getValue(int $entityId, string $field): mixed
+    public function get(int $entityId, string $field): mixed
     {
         return $this->data[$entityId][$field] ?? null;
     }
+
+    public function listEntityIds(): iterable
+    {
+        foreach ($this->data as $entityId => $item) {
+            yield $entityId;
+        }
+    }
 }

Api/IndexStorageWriter.php

@@ -0,0 +1,17 @@
+<?php
+/**
+ * Copyright © Mage-OS Team. All rights reserved.
+ * See LICENSE for license details.
+ */
+
+declare(strict_types=1);
+
+namespace MageOS\Indexer\Model;
+
+class ArrayIndexRecordFactory
+{
+    public function create(): ArrayIndexRecord
+    {
+        return new ArrayIndexRecord();
+    }
+}