Fix prefixes index information + Syntax error detection

Author: MacFJA

src/Helper/RedisHelper.php

@@ -108,9 +108,9 @@ public static function buildQueryPartial(array $query, array $partials): array
     }
 
     /**
-     * @param array<float|int|string> $notKeyedArray
+     * @param array<float|int|mixed|string> $notKeyedArray
      *
-     * @return array<string,float|int|string>
+     * @return array<string,mixed>
      */
     public static function getPairs(array $notKeyedArray): array
     {

src/Index.php

@@ -24,6 +24,7 @@
 use function array_keys;
 use function array_map;
 use function array_merge;
+use function is_array;
 use function is_string;
 use MacFJA\RediSearch\Helper\DataHelper;
 use MacFJA\RediSearch\Helper\RedisHelper;
@@ -146,11 +147,20 @@ public function getStats(): InfoResult
         DataHelper::handleRawResult($result);
 
         $stats = RedisHelper::getPairs($result);
+        $definitions = RedisHelper::getPairs($stats['index_definition'] ?? []);
+        $definitions = array_map(function ($item) {
+            if (!is_array($item)) {
+                return (string) $item;
+            }
+
+            return $item;
+        }, $definitions);
+        $definitions['prefixes'] = array_map('strval', (array) ($definitions['prefixes'] ?? []));
 
         return new InfoResult(
             (string) $stats['index_name'],
             array_map('strval', (array) ($stats['index_options'] ?? [])),
-            array_map('strval', (array) ($stats['index_definition'] ?? [])),
+            $definitions,
             (array) ($stats['fields'] ?? []),
             (int) $stats['num_docs'],
             (int) $stats['max_doc_id'],

src/Index/InfoResult.php

@@ -23,7 +23,9 @@
 
 use function array_map;
 use function array_shift;
+use function assert;
 use function in_array;
+use function is_array;
 use MacFJA\RediSearch\Helper\DataHelper;
 use MacFJA\RediSearch\Helper\RedisHelper;
 use MacFJA\RediSearch\Index\Builder\Field;
@@ -45,7 +47,7 @@ class InfoResult
     /** @var array<string> */
     private $indexOptions = [];
 
-    /** @var array<string> */
+    /** @var array<array<string>|string> */
     private $definition = [];
 
     /** @var array<mixed> */
@@ -81,18 +83,26 @@ class InfoResult
     /**
      * InfoResult constructor.
      *
-     * @param array<string> $indexOptions
-     * @param array<string> $definition
-     * @param array<mixed>  $fields
-     * @param array<string> $stopWords
+     * @param array<string>               $indexOptions
+     * @param array<array<string>|string> $definition
+     * @param array<mixed>                $fields
+     * @param array<string>               $stopWords
      *
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(string $indexName, array $indexOptions, array $definition, array $fields, int $documentCount, int $maxDocumentId, int $termsCount, float $averageRecordSize, float $indexSize, int $indexBlockCount, bool $indexing, int $indexingFailureCount, float $percentIndexed, array $stopWords)
     {
+        /** @var array<string> $prefixes */
+        $prefixes = $definition['prefixes'] ?? [];
+        assert(is_array($prefixes));
+        unset($definition['prefixes']);
+        /** @var array<string> $definition */
         DataHelper::assertArrayOf($indexOptions, 'string');
         DataHelper::assertArrayOf($definition, 'string');
+        DataHelper::assertArrayOf($prefixes, 'string');
         DataHelper::assertArrayOf($stopWords, 'string');
+        $definition['prefixes'] = $prefixes;
+
         $this->indexName = $indexName;
         $this->indexOptions = $indexOptions;
         $this->definition = $definition;
@@ -123,7 +133,7 @@ public function getIndexOptions(): array
     }
 
     /**
-     * @return array<string>
+     * @return array<array<string>|string>
      */
     public function getDefinition(): array
     {

src/Search/Exception/SyntaxErrorException.php

@@ -0,0 +1,28 @@
+<?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\Search\Exception;
+
+use RuntimeException;
+
+class SyntaxErrorException extends RuntimeException
+{
+}