Remove unnecessary 'transformParsedResponse' function

Author: MacFJA

src/Exception/UnexpectedServerResponseException.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright MacFJA
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+namespace MacFJA\RediSearch\Exception;
+
+use function is_string;
+use UnexpectedValueException;
+
+class UnexpectedServerResponseException extends UnexpectedValueException
+{
+    /** @var mixed */
+    private $response;
+
+    /**
+     * @param mixed $response
+     */
+    public function __construct($response, ?string $message = null)
+    {
+        $this->response = $response;
+        $additional = '';
+        if (is_string($message)) {
+            $additional = ': '.$message;
+        }
+        parent::__construct('Unexpected response from the Redis server'.$additional);
+    }
+
+    /**
+     * @codeCoverageIgnore
+     *
+     * @return mixed
+     */
+    public function getResponse()
+    {
+        return $this->response;
+    }
+}

src/Redis/Command/AbstractCommand.php

@@ -63,16 +63,6 @@ public function setRediSearchVersion(string $rediSearchVersion): Command
         return $this;
     }
 
-    /**
-     * @param array<mixed>|float|int|mixed|string $data
-     *
-     * @return mixed|string
-     */
-    public function parseResponse($data)
-    {
-        return $this->transformParsedResponse($data);
-    }
-
     /**
      * @return array<float|int|string>
      */
@@ -99,20 +89,22 @@ public function getArguments(): array
     }
 
     /**
-     * @return array<string>
-     */
-    abstract protected function getRequiredOptions(): array;
-
-    /**
-     * @param mixed $data
+     * @codeCoverageIgnore
+     *
+     * @param array<mixed>|float|int|mixed|string $data
      *
      * @return mixed
      */
-    protected function transformParsedResponse($data)
+    public function parseResponse($data)
     {
         return $data;
     }
 
+    /**
+     * @return array<string>
+     */
+    abstract protected function getRequiredOptions(): array;
+
     /**
      * @return array<string>
      */

src/Redis/Command/Aggregate.php

@@ -22,6 +22,8 @@
 namespace MacFJA\RediSearch\Redis\Command;
 
 use function assert;
+use function is_array;
+use MacFJA\RediSearch\Exception\UnexpectedServerResponseException;
 use MacFJA\RediSearch\Redis\Command\AggregateCommand\ApplyOption;
 use MacFJA\RediSearch\Redis\Command\AggregateCommand\GroupByOption;
 use MacFJA\RediSearch\Redis\Command\AggregateCommand\LimitOption;
@@ -33,10 +35,11 @@
 use MacFJA\RediSearch\Redis\Command\Option\NumberedOption;
 use MacFJA\RediSearch\Redis\Response\AggregateResponseItem;
 use MacFJA\RediSearch\Redis\Response\ArrayResponseTrait;
+use MacFJA\RediSearch\Redis\Response\CursorResponse;
 use MacFJA\RediSearch\Redis\Response\PaginatedResponse;
 
 /**
- * @method CursorResponse|PaginatedResponse<AggregateResponseItem> parseResponse(mixed $data)
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Aggregate extends AbstractCommand implements PaginatedCommand
 {
@@ -180,13 +183,18 @@ public function getSize(): ?int
         return $limit->getSize();
     }
 
-    protected function getRequiredOptions(): array
+    /**
+     * @param array|mixed|string $data
+     *
+     * @return CursorResponse|PaginatedResponse<AggregateResponseItem>
+     * @phpstan-return CursorResponse|PaginatedResponse
+     */
+    public function parseResponse($data)
     {
-        return ['index', 'query'];
-    }
+        if (!is_array($data)) {
+            throw new UnexpectedServerResponseException($data);
+        }
 
-    protected function transformParsedResponse($data)
-    {
         if (true === $this->options['cursor']->getDataOfOption('enabled')) {
             return CursorRead::transformResponse(
                 $data,
@@ -206,4 +214,9 @@ protected function transformParsedResponse($data)
 
         return new PaginatedResponse($this, $totalCount, $items);
     }
+
+    protected function getRequiredOptions(): array
+    {
+        return ['index', 'query'];
+    }
 }

src/Redis/Command/CursorRead.php

@@ -25,16 +25,14 @@
 use function count;
 use function is_array;
 use function is_int;
+use MacFJA\RediSearch\Exception\UnexpectedServerResponseException;
 use MacFJA\RediSearch\Redis\Command\Option\FlagOption;
 use MacFJA\RediSearch\Redis\Command\Option\NamedOption;
 use MacFJA\RediSearch\Redis\Command\Option\NamelessOption;
 use MacFJA\RediSearch\Redis\Response\AggregateResponseItem;
 use MacFJA\RediSearch\Redis\Response\ArrayResponseTrait;
 use MacFJA\RediSearch\Redis\Response\CursorResponse;
 
-/**
- * @method CursorResponse parseResponse(mixed $data)
- */
 class CursorRead extends AbstractCommand
 {
     use ArrayResponseTrait;
@@ -102,18 +100,27 @@ public static function transformResponse(array $data, ?int $count, string $index
         return new CursorResponse($cursorId, $totalCount, $items, $size, $index, $rediSearchVersion);
     }
 
-    protected function getRequiredOptions(): array
+    /**
+     * @param array|mixed $data
+     *
+     * @return CursorResponse
+     */
+    public function parseResponse($data)
     {
-        return ['type', 'index', 'cursor'];
-    }
+        if (!is_array($data)) {
+            throw new UnexpectedServerResponseException($data);
+        }
 
-    protected function transformParsedResponse($data)
-    {
         return self::transformResponse(
             $data,
             $this->options['count']->getValue(),
             $this->options['index']->getValue(),
             $this->getRediSearchVersion()
         );
     }
+
+    protected function getRequiredOptions(): array
+    {
+        return ['type', 'index', 'cursor'];
+    }
 }

src/Redis/Command/Info.php

@@ -21,12 +21,11 @@
 
 namespace MacFJA\RediSearch\Redis\Command;
 
+use function is_array;
+use MacFJA\RediSearch\Exception\UnexpectedServerResponseException;
 use MacFJA\RediSearch\Redis\Command\Option\NamelessOption;
 use MacFJA\RediSearch\Redis\Response\InfoResponse;
 
-/**
- * @method InfoResponse parseResponse(mixed $data)
- */
 class Info extends AbstractCommand
 {
     public function __construct(string $rediSearchVersion = self::MIN_IMPLEMENTED_VERSION)
@@ -48,13 +47,22 @@ public function getId(): string
         return 'FT.INFO';
     }
 
-    protected function getRequiredOptions(): array
+    /**
+     * @param array|mixed $data
+     *
+     * @return InfoResponse
+     */
+    public function parseResponse($data)
     {
-        return ['index'];
+        if (!is_array($data)) {
+            throw new UnexpectedServerResponseException($data);
+        }
+
+        return new InfoResponse($data);
     }
 
-    protected function transformParsedResponse($data)
+    protected function getRequiredOptions(): array
     {
-        return new InfoResponse($data);
+        return ['index'];
     }
 }

src/Redis/Command/Search.php

@@ -23,8 +23,8 @@
 
 use function assert;
 use function count;
-use InvalidArgumentException;
 use function is_array;
+use MacFJA\RediSearch\Exception\UnexpectedServerResponseException;
 use MacFJA\RediSearch\Redis\Command\Option\CustomValidatorOption as CV;
 use MacFJA\RediSearch\Redis\Command\Option\FlagOption;
 use MacFJA\RediSearch\Redis\Command\Option\NamedOption;
@@ -302,15 +302,15 @@ public function getSize(): ?int
     /**
      * @param mixed $data
      *
-     * @return mixed|PaginatedResponse
+     * @return PaginatedResponse
      *
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @SuppressWarnings(PHPMD.NPathComplexity)
      */
-    public function transformParsedResponse($data)
+    public function parseResponse($data)
     {
         if (!is_array($data)) {
-            return $data;
+            throw new UnexpectedServerResponseException($data);
         }
 
         $totalCount = array_shift($data);
@@ -329,7 +329,7 @@ public function transformParsedResponse($data)
 
         $documents = array_chunk($data, $chunkSize);
 
-        $items = array_map(static function ($document) use ($useSortKeys, $usePayloads, $useScores, $noContent) {
+        $items = array_map(static function ($document) use ($data, $useSortKeys, $usePayloads, $useScores, $noContent) {
             $hash = array_shift($document) ?? '';
             $score = true === $useScores ? (float) array_shift($document) : null;
             $payload = true === $usePayloads ? array_shift($document) : null;
@@ -338,7 +338,7 @@ public function transformParsedResponse($data)
             $fields = [];
             if (false === $noContent) {
                 if (!(1 === count($document))) {
-                    throw new InvalidArgumentException();
+                    throw new UnexpectedServerResponseException($data, 'Incomplete response');
                 }
                 $rawData = reset($document);
                 assert(is_array($rawData));

src/Redis/Command/SpellCheck.php

@@ -22,16 +22,14 @@
 namespace MacFJA\RediSearch\Redis\Command;
 
 use function is_array;
+use MacFJA\RediSearch\Exception\UnexpectedServerResponseException;
 use MacFJA\RediSearch\Redis\Command\Option\CustomValidatorOption;
 use MacFJA\RediSearch\Redis\Command\Option\NamedOption;
 use MacFJA\RediSearch\Redis\Command\Option\NamelessOption;
 use MacFJA\RediSearch\Redis\Command\SpellCheckCommand\TermsOption;
 use MacFJA\RediSearch\Redis\Response\SpellCheckResponseItem;
 use Respect\Validation\Validator;
 
-/**
- * @method array<SpellCheckResponseItem> parseResponse(mixed $data)
- */
 class SpellCheck extends AbstractCommand
 {
     public function __construct(string $rediSearchVersion = self::MIN_IMPLEMENTED_VERSION)
@@ -83,20 +81,15 @@ public function getId(): string
         return 'FT.SPELLCHECK';
     }
 
-    protected function getRequiredOptions(): array
-    {
-        return ['index', 'query'];
-    }
-
     /**
      * @param mixed $data
      *
-     * @return mixed|SpellCheckResponseItem[]
+     * @return SpellCheckResponseItem[]
      */
-    protected function transformParsedResponse($data)
+    public function parseResponse($data)
     {
         if (!is_array($data)) {
-            return $data;
+            throw new UnexpectedServerResponseException($data);
         }
 
         $items = array_map(static function (array $group) {
@@ -113,4 +106,9 @@ protected function transformParsedResponse($data)
 
         return array_filter($items);
     }
+
+    protected function getRequiredOptions(): array
+    {
+        return ['index', 'query'];
+    }
 }

src/Redis/Command/SugGet.php

@@ -22,17 +22,14 @@
 namespace MacFJA\RediSearch\Redis\Command;
 
 use function count;
-use InvalidArgumentException;
 use function is_array;
+use MacFJA\RediSearch\Exception\UnexpectedServerResponseException;
 use MacFJA\RediSearch\Redis\Command\Option\CustomValidatorOption as CV;
 use MacFJA\RediSearch\Redis\Command\Option\FlagOption;
 use MacFJA\RediSearch\Redis\Command\Option\NamedOption;
 use MacFJA\RediSearch\Redis\Command\Option\NamelessOption;
 use MacFJA\RediSearch\Redis\Response\SuggestionResponseItem;
 
-/**
- * @method array<SuggestionResponseItem> parseResponse(mixed $data)
- */
 class SugGet extends AbstractCommand
 {
     public function __construct(string $rediSearchVersion = self::MIN_IMPLEMENTED_VERSION)
@@ -100,12 +97,12 @@ public function getId(): string
     /**
      * @param mixed $data
      *
-     * @return mixed|SuggestionResponseItem[]
+     * @return SuggestionResponseItem[]
      */
-    public function transformParsedResponse($data)
+    public function parseResponse($data)
     {
         if (!is_array($data)) {
-            return $data;
+            throw new UnexpectedServerResponseException($data);
         }
 
         $useScores = $this->options['scores']->isActive();
@@ -117,12 +114,12 @@ public function transformParsedResponse($data)
 
         $documents = array_chunk($data, $chunkSize);
 
-        return array_map(static function ($document) use ($usePayloads, $useScores) {
+        return array_map(static function ($document) use ($data, $usePayloads, $useScores) {
             $payload = true === $usePayloads ? array_pop($document) : null;
             $score = true === $useScores ? (float) array_pop($document) : null;
 
             if (!(1 === count($document))) {
-                throw new InvalidArgumentException();
+                throw new UnexpectedServerResponseException($data, 'Incomplete response');
             }
             $value = reset($document);