[8.1] Add support for comma-delimited list encoding in query

Co-authored-by: Seth Michael Larson <[email protected]>

Author: github-actions[bot]

elastic_enterprise_search/_async/client/enterprise_search.py

@@ -17,7 +17,7 @@
 
 import typing as t
 
-from ..._utils import _rewrite_parameters
+from ..._utils import _quote_query_form, _rewrite_parameters
 from ._base import BaseClient
 
 
@@ -94,7 +94,7 @@ async def get_stats(
         """
         __query: t.Dict[str, t.Any] = {}
         if include is not None:
-            __query["include"] = include
+            __query["include"] = _quote_query_form("include", include)
         __headers = {"accept": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
             "GET", "/api/ent/v1/internal/stats", params=__query, headers=__headers

elastic_enterprise_search/_sync/client/enterprise_search.py

@@ -17,7 +17,7 @@
 
 import typing as t
 
-from ..._utils import _rewrite_parameters
+from ..._utils import _quote_query_form, _rewrite_parameters
 from ._base import BaseClient
 
 
@@ -94,7 +94,7 @@ def get_stats(
         """
         __query: t.Dict[str, t.Any] = {}
         if include is not None:
-            __query["include"] = include
+            __query["include"] = _quote_query_form("include", include)
         __headers = {"accept": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "GET", "/api/ent/v1/internal/stats", params=__query, headers=__headers

elastic_enterprise_search/_utils.py

@@ -300,6 +300,12 @@ def _quote_query_deep_object(
             yield from _quote_query_deep_object(f"{prefix}[{key}]", val)
 
 
+def _quote_query_form(key: str, value: t.Union[t.List[str], t.Tuple[str, ...]]) -> str:
+    if not isinstance(value, (tuple, list)):
+        raise ValueError(f"{key!r} must be of type list or tuple")
+    return ",".join(map(str, value))
+
+
 def _merge_kwargs_no_duplicates(
     kwargs: t.Dict[str, t.Any], values: t.Dict[str, t.Any]
 ) -> None:

tests/client/enterprise_search/cassettes/test_get_stats.yaml

@@ -51,7 +51,7 @@ interactions:
       connection:
       - keep-alive
     method: GET
-    uri: https://my-deployment-c6095a.ent.us-central1.gcp.cloud.es.io/api/ent/v1/internal/stats?include%5B%5D=connectors&include%5B%5D=queues
+    uri: https://my-deployment-c6095a.ent.us-central1.gcp.cloud.es.io/api/ent/v1/internal/stats?include=connectors,queues
   response:
     body:
       string: '{"connectors":{"alive":true,"pool":{"extract_worker_pool":{"running":true,"queue_depth":0,"size":1,"busy":1,"idle":0,"total_scheduled":1,"total_completed":0},"subextract_worker_pool":{"running":true,"queue_depth":0,"size":0,"busy":0,"idle":0,"total_scheduled":0,"total_completed":0},"publish_worker_pool":{"running":true,"queue_depth":0,"size":0,"busy":0,"idle":0,"total_scheduled":0,"total_completed":0}},"job_store":{"waiting":0,"working":0,"job_types":{"full":0,"incremental":0,"delete":0,"permissions":0}}},"queues":{"engine_destroyer":{"pending":0},"process_crawl":{"pending":0},"mailer":{"pending":0},"failed":[]}}'

tests/server/test_enterprise_search.py

@@ -16,5 +16,33 @@
 #  under the License.
 
 
+import pytest
+
+from elastic_enterprise_search import EnterpriseSearch
+
+
 def test_get_version(ent_search):
     assert set(ent_search.get_version()) == {"number", "build_hash", "build_date"}
+
+
+@pytest.mark.parametrize("include", [["app", "queues"], ("app", "queues")])
+def test_get_stats_include(ent_search: EnterpriseSearch, include):
+    with pytest.raises(ValueError) as e:
+        ent_search.get_stats(include="queues")
+    assert str(e.value) == "'include' must be of type list or tuple"
+
+    resp = ent_search.get_stats()
+    assert resp.meta.status == 200
+    assert set(resp.body.keys()) == {
+        "app",
+        "cluster_uuid",
+        "connectors",
+        "crawler",
+        "http",
+        "product_usage",
+        "queues",
+    }
+
+    resp = ent_search.get_stats(include=include)
+    assert resp.meta.status == 200
+    assert set(resp.body.keys()) == {"app", "queues"}