Merge pull request #85 from apisearch-io/feature/multiquery

Added model for multiquery

Author: mmoreram

Query/Query.php

@@ -196,6 +196,13 @@ class Query implements HttpTransportable
      */
     private $metadata = [];
 
+    /**
+     * @var Query[]
+     *
+     * Sub queries
+     */
+    private $subqueries = [];
+
     /**
      * Construct.
      *
@@ -315,6 +322,21 @@ public static function createByUUIDs(array $uuids): self
         return $query;
     }
 
+    /**
+     * Create multiquery.
+     *
+     * @param Query[] $queries
+     *
+     * @return Query
+     */
+    public static function createMultiquery(array $queries)
+    {
+        $query = Query::createMatchAll();
+        $query->subqueries = $queries;
+
+        return $query;
+    }
+
     /**
      * Select fields.
      *
@@ -1303,33 +1325,59 @@ public function getUser(): ? User
     }
 
     /**
-     * Set metadata
+     * Set metadata.
      *
      * @param string $name
-     * @param mixed $value
+     * @param mixed  $value
      *
      * @return Query
      */
     public function setMetadataValue(
         string $name,
         $value
-    )
-    {
+    ): self {
         $this->metadata[$name] = $value;
 
         return $this;
     }
 
     /**
-     * Get metadata
+     * Get metadata.
      *
      * @return array
      */
-    public function getMetadata() : array
+    public function getMetadata(): array
     {
         return $this->metadata;
     }
 
+    /**
+     * Add subquery.
+     *
+     * @param string $name
+     * @param Query  $query
+     *
+     * @return Query
+     */
+    public function addSubQuery(
+        string $name,
+        Query $query
+    ): self {
+        $this->subqueries[$name] = $query;
+
+        return $this;
+    }
+
+    /**
+     * Get subqueries.
+     *
+     * @return Query[]
+     */
+    public function getSubqueries(): array
+    {
+        return $this->subqueries;
+    }
+
     /**
      * To array.
      *
@@ -1389,6 +1437,11 @@ public function toArray(): array
                 ? $this->user->toArray()
                 : null,
             'metadata' => $this->metadata,
+            'subqueries' => array_filter(
+                array_map(function (Query $query) {
+                    return $query->toArray();
+                }, $this->subqueries)
+            ),
             'items_promoted' => array_filter(
                 array_map(function (ItemUUID $itemUUID) {
                     return $itemUUID->toArray();
@@ -1461,6 +1514,10 @@ public static function createFromArray(array $array): self
             $query->user = User::createFromArray($array['user']);
         }
 
+        $query->subqueries = array_map(function (array $query) {
+            return Query::createFromArray($query);
+        }, $array['subqueries'] ?? []);
+
         return $query;
     }
 }

Repository/TransformableRepository.php

@@ -134,18 +134,37 @@ public function query(
             ->repository
             ->query($query, $parameters);
 
-        return Result::create(
-            $result->getQuery(),
-            $result->getTotalItems(),
-            $result->getTotalHits(),
-            $result->getAggregations(),
-            $result->getSuggests(),
-            $this
-                ->transformer
-                ->fromItems(
-                    $result->getItems()
-                )
-        );
+        return $this->applyTransformersToResult($result);
+    }
+
+    /**
+     * Apply transformers on Result.
+     *
+     * @param Result $result
+     *
+     * @return Result
+     */
+    private function applyTransformersToResult(Result $result): Result
+    {
+        return empty($result->getSubresults())
+            ? Result::create(
+                $result->getQuery(),
+                $result->getTotalItems(),
+                $result->getTotalHits(),
+                $result->getAggregations(),
+                $result->getSuggests(),
+                $this
+                    ->transformer
+                    ->fromItems(
+                        $result->getItems()
+                    )
+            )
+            : Result::createMultiResult(
+                $result->getQuery(),
+                array_map(function (Result $subresult) {
+                    return $this->applyTransformersToResult($subresult);
+                }, $result->getSubresults())
+            );
     }
 
     /**

Result/Result.php

@@ -73,6 +73,13 @@ class Result implements HttpTransportable
      */
     private $itemsGroupedByTypeCache;
 
+    /**
+     * @var Result[]
+     *
+     * Subresults
+     */
+    private $subresults = [];
+
     /**
      * Result constructor.
      *
@@ -123,6 +130,24 @@ public static function create(
         return $result;
     }
 
+    /**
+     * Create multiquery Result.
+     *
+     * @param Query    $query
+     * @param Result[] $subresults
+     *
+     * @return Result
+     */
+    public static function createMultiResult(
+        Query $query,
+        array $subresults
+    ) {
+        $result = new Result($query, 0, 0);
+        $result->subresults = $subresults;
+
+        return $result;
+    }
+
     /**
      * Add item.
      *
@@ -324,6 +349,16 @@ public function getTotalHits(): int
         return $this->totalHits;
     }
 
+    /**
+     * Get subresults.
+     *
+     * @return Result[]
+     */
+    public function getSubresults(): array
+    {
+        return $this->subresults;
+    }
+
     /**
      * To array.
      *
@@ -342,6 +377,9 @@ public function toArray(): array
                 ? $this->aggregations->toArray()
                 : null,
             'suggests' => $this->suggests,
+            'subresults' => array_map(function (Result $result) {
+                return $result->toArray();
+            }, $this->subresults),
         ], function ($element) {
             return
             !(
@@ -360,7 +398,7 @@ public function toArray(): array
      */
     public static function createFromArray(array $array): self
     {
-        return self::create(
+        $result = self::create(
             Query::createFromArray($array['query'] ?? []),
             $array['total_items'] ?? 0,
             $array['total_hits'] ?? 0,
@@ -372,5 +410,13 @@ public static function createFromArray(array $array): self
                 return Item::createFromArray($item);
             }, $array['items'] ?? [])
         );
+
+        $result->subresults = array_filter(
+            array_map(function (array $subresultAsArray) {
+                return Result::createFromArray($subresultAsArray);
+            }, $array['subresults'] ?? [])
+        );
+
+        return $result;
     }
 }

Tests/Query/QueryTest.php

@@ -151,7 +151,7 @@ public function testValues()
     }
 
     /**
-     * Test metadata
+     * Test metadata.
      */
     public function testMetadata()
     {
@@ -160,8 +160,24 @@ public function testMetadata()
         $query->setMetadataValue('b', ['b1', 'b2']);
         $this->assertEquals([
             'a' => 'a1',
-            'b' => ['b1', 'b2']
+            'b' => ['b1', 'b2'],
         ], $query->getMetadata());
         $this->assertEquals($query, HttpHelper::emulateHttpTransport($query));
     }
+
+    /**
+     * Test subqueries.
+     */
+    public function testSubqueries()
+    {
+        $query = Query::createMatchAll();
+        $query->addSubQuery('sub1', Query::create('sub1'));
+        $query->addSubQuery('sub2', Query::create('sub2'));
+        $query->addSubQuery('sub3', Query::create('sub3'));
+        $this->assertCount(3, $query->getSubqueries());
+        $subqueries = HttpHelper::emulateHttpTransport($query)->getSubqueries();
+        $this->assertEquals('sub1', $subqueries['sub1']->getQueryText());
+        $this->assertEquals('sub2', $subqueries['sub2']->getQueryText());
+        $this->assertEquals('sub3', $subqueries['sub3']->getQueryText());
+    }
 }

Tests/Result/ResultTest.php

@@ -21,6 +21,7 @@
 use Apisearch\Result\Aggregation;
 use Apisearch\Result\Aggregations;
 use Apisearch\Result\Result;
+use Apisearch\Tests\HttpHelper;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -193,4 +194,23 @@ public function testCreateFromArrayAllValues()
         $this->assertCount(2, $result->getItems());
         $this->assertEquals('product', $result->getFirstItem()->getType());
     }
+
+    /**
+     * Test multi result
+     */
+    public function testMultiResult()
+    {
+        $query = Query::createMatchAll();
+        $result = Result::createMultiResult($query, [
+            'res1' => Result::create($query, 10, 3, null, [], []),
+            'res2' => Result::create($query, 10, 4, null, [], []),
+            'res3' => Result::create($query, 10, 5, null, [], []),
+        ]);
+
+        $this->assertCount(3, $result->getSubresults());
+        $subqueries = HttpHelper::emulateHttpTransport($result)->getSubresults();
+        $this->assertEquals(3, $subqueries['res1']->getTotalHits());
+        $this->assertEquals(4, $subqueries['res2']->getTotalHits());
+        $this->assertEquals(5, $subqueries['res3']->getTotalHits());
+    }
 }