fix: pass params as query params for get/head requests (#593)

Co-authored-by: Andrew Smith <[email protected]>

Author: abhishekg999

infra/init.sql

@@ -77,6 +77,12 @@ as $function$
     select * from countries;
 $function$;
 
+create or replace function public.search_countries_by_name(search_name text)
+    returns setof countries
+    language sql
+as $function$
+    select * from countries where nicename ilike '%' || search_name || '%';
+$function$;
 
 create table
   orchestral_sections (id int8 primary key, name text);

postgrest/_async/client.py

@@ -133,6 +133,15 @@ def rpc(
 
         headers = Headers({"Prefer": f"count={count}"}) if count else Headers()
 
+        if method in ("HEAD", "GET"):
+            return AsyncRPCFilterRequestBuilder[Any](
+                self.session,
+                f"/rpc/{func}",
+                method,
+                headers,
+                QueryParams(params),
+                json={},
+            )
         # the params here are params to be sent to the RPC and not the queryparams!
         return AsyncRPCFilterRequestBuilder[Any](
             self.session, f"/rpc/{func}", method, headers, QueryParams(), json=params

postgrest/_sync/client.py

@@ -133,6 +133,15 @@ def rpc(
 
         headers = Headers({"Prefer": f"count={count}"}) if count else Headers()
 
+        if method in ("HEAD", "GET"):
+            return SyncRPCFilterRequestBuilder[Any](
+                self.session,
+                f"/rpc/{func}",
+                method,
+                headers,
+                QueryParams(params),
+                json={},
+            )
         # the params here are params to be sent to the RPC and not the queryparams!
         return SyncRPCFilterRequestBuilder[Any](
             self.session, f"/rpc/{func}", method, headers, QueryParams(), json=params

postgrest/base_request_builder.py

@@ -660,7 +660,11 @@ def select(
         """
         method, params, headers, json = pre_select(*columns, count=None)
         self.params = self.params.add("select", params.get("select"))
-        self.headers["Prefer"] = "return=representation"
+        if self.headers.get("Prefer"):
+            self.headers["Prefer"] += ",return=representation"
+        else:
+            self.headers["Prefer"] = "return=representation"
+
         return self
 
     def single(self) -> Self:

tests/_sync/test_filter_request_builder_integration.py

@@ -476,6 +476,48 @@ def test_rpc_with_range():
     ]
 
 
+def test_rpc_post_with_args():
+    res = (
+        rest_client()
+        .rpc("search_countries_by_name", {"search_name": "Alban"})
+        .select("nicename, iso")
+        .execute()
+    )
+    assert res.data == [{"nicename": "Albania", "iso": "AL"}]
+
+
+def test_rpc_get_with_args():
+    res = (
+        rest_client()
+        .rpc("search_countries_by_name", {"search_name": "Alger"}, get=True)
+        .select("nicename, iso")
+        .execute()
+    )
+    assert res.data == [{"nicename": "Algeria", "iso": "DZ"}]
+
+
+def test_rpc_get_with_count():
+    res = (
+        rest_client()
+        .rpc("search_countries_by_name", {"search_name": "Al"}, get=True, count="exact")
+        .select("nicename")
+        .execute()
+    )
+    assert res.count == 2
+    assert res.data == [{"nicename": "Albania"}, {"nicename": "Algeria"}]
+
+
+def test_rpc_head_count():
+    res = (
+        rest_client()
+        .rpc("search_countries_by_name", {"search_name": "Al"}, head=True, count="exact")
+        .execute()
+    )
+
+    assert res.count == 2
+    assert res.data == []
+
+
 def test_order():
     res = (
         rest_client()