Add query_params to FT.PROFILE (#2198)

* ft.profile query_params

* fix pr comments

* type hints

Author: dvora-h

redis/commands/search/commands.py

@@ -1,6 +1,6 @@
 import itertools
 import time
-from typing import Dict, Union
+from typing import Dict, Optional, Union
 
 from redis.client import Pipeline
 
@@ -363,7 +363,11 @@ def info(self):
         it = map(to_string, res)
         return dict(zip(it, it))
 
-    def get_params_args(self, query_params: Dict[str, Union[str, int, float]]):
+    def get_params_args(
+        self, query_params: Union[Dict[str, Union[str, int, float]], None]
+    ):
+        if query_params is None:
+            return []
         args = []
         if len(query_params) > 0:
             args.append("params")
@@ -383,8 +387,7 @@ def _mk_query_args(self, query, query_params: Dict[str, Union[str, int, float]])
             raise ValueError(f"Bad query type {type(query)}")
 
         args += query.get_args()
-        if query_params is not None:
-            args += self.get_params_args(query_params)
+        args += self.get_params_args(query_params)
 
         return args, query
 
@@ -459,8 +462,7 @@ def aggregate(
             cmd = [CURSOR_CMD, "READ", self.index_name] + query.build_args()
         else:
             raise ValueError("Bad query", query)
-        if query_params is not None:
-            cmd += self.get_params_args(query_params)
+        cmd += self.get_params_args(query_params)
 
         raw = self.execute_command(*cmd)
         return self._get_aggregate_result(raw, query, has_cursor)
@@ -485,16 +487,22 @@ def _get_aggregate_result(self, raw, query, has_cursor):
 
         return AggregateResult(rows, cursor, schema)
 
-    def profile(self, query, limited=False):
+    def profile(
+        self,
+        query: Union[str, Query, AggregateRequest],
+        limited: bool = False,
+        query_params: Optional[Dict[str, Union[str, int, float]]] = None,
+    ):
         """
         Performs a search or aggregate command and collects performance
         information.
 
         ### Parameters
 
-        **query**: This can be either an `AggregateRequest`, `Query` or
-        string.
+        **query**: This can be either an `AggregateRequest`, `Query` or string.
         **limited**: If set to True, removes details of reader iterator.
+        **query_params**: Define one or more value parameters.
+        Each parameter has a name and a value.
 
         """
         st = time.time()
@@ -509,6 +517,7 @@ def profile(self, query, limited=False):
         elif isinstance(query, Query):
             cmd[2] = "SEARCH"
             cmd += query.get_args()
+            cmd += self.get_params_args(query_params)
         else:
             raise ValueError("Must provide AggregateRequest object or " "Query object.")
 
@@ -907,8 +916,7 @@ async def aggregate(
             cmd = [CURSOR_CMD, "READ", self.index_name] + query.build_args()
         else:
             raise ValueError("Bad query", query)
-        if query_params is not None:
-            cmd += self.get_params_args(query_params)
+        cmd += self.get_params_args(query_params)
 
         raw = await self.execute_command(*cmd)
         return self._get_aggregate_result(raw, query, has_cursor)

tests/test_search.py

@@ -1519,6 +1519,30 @@ def test_profile_limited(client):
     assert len(res.docs) == 3  # check also the search result
 
 
+@pytest.mark.redismod
+@skip_ifmodversion_lt("2.4.3", "search")
+def test_profile_query_params(modclient: redis.Redis):
+    modclient.flushdb()
+    modclient.ft().create_index(
+        (
+            VectorField(
+                "v", "HNSW", {"TYPE": "FLOAT32", "DIM": 2, "DISTANCE_METRIC": "L2"}
+            ),
+        )
+    )
+    modclient.hset("a", "v", "aaaaaaaa")
+    modclient.hset("b", "v", "aaaabaaa")
+    modclient.hset("c", "v", "aaaaabaa")
+    query = "*=>[KNN 2 @v $vec]"
+    q = Query(query).return_field("__v_score").sort_by("__v_score", True).dialect(2)
+    res, det = modclient.ft().profile(q, query_params={"vec": "aaaaaaaa"})
+    assert det["Iterators profile"]["Counter"] == 2.0
+    assert det["Iterators profile"]["Type"] == "VECTOR"
+    assert res.total == 2
+    assert "a" == res.docs[0].id
+    assert "0" == res.docs[0].__getattribute__("__v_score")
+
+
 @pytest.mark.redismod
 @skip_ifmodversion_lt("2.4.3", "search")
 def test_vector_field(modclient):