chore: ignore query params that start with underscore

lib/ae_mdw_web/plugs/paginated_plug.ex

@@ -34,7 +34,7 @@ defmodule AeMdwWeb.Plugs.PaginatedPlug do
 
   @spec call(Conn.t(), opts()) :: Conn.t()
   def call(
-        %Conn{params: params, query_params: query_params, assigns: %{state: state}} = conn,
+        %Conn{params: params, query_params: _query_params, assigns: %{state: state}} = conn,
         opts
       ) do
     txi_scope? = Keyword.get(opts, :txi_scope?, true)
@@ -55,7 +55,7 @@ defmodule AeMdwWeb.Plugs.PaginatedPlug do
       |> assign(:order_by, order_by)
       |> assign(:scope, scope)
       |> assign(:offset, {limit, page})
-      |> assign(:query, Map.drop(query_params, @pagination_params))
+      |> clean_query()
     else
       {:error, error_msg} ->
         conn
@@ -252,4 +252,11 @@ defmodule AeMdwWeb.Plugs.PaginatedPlug do
   defp generate_range(_state, scope_type, first, last) do
     {scope_type, first..last}
   end
+
+  defp clean_query(%Conn{query_params: query_params} = conn) do
+    query_params
+    |> Map.drop(@pagination_params)
+    |> Map.reject(fn {key, _val} -> String.starts_with?(key, "_") end)
+    |> then(&assign(conn, :query, &1))
+  end
 end

test/ae_mdw_web/plugs/paginated_plug_test.exs

@@ -148,6 +148,33 @@ defmodule AeMdwWeb.Plugs.PaginatedPlugTest do
                |> PaginatedPlug.call([])
                |> json_response(400)
     end
+
+    test "it ignores query_params starting with _", %{conn: conn} do
+      store = empty_store()
+
+      assert %{pagination: {:forward, false, 10, false}, query: first_query} =
+               conn
+               |> with_store(store)
+               |> put_query(%{"_ignore_me" => "20", "direction" => "forward"})
+               |> PaginatedPlug.call([])
+               |> get_assigns()
+
+      assert map_size(first_query) == 0
+
+      assert %{pagination: {:forward, false, 10, false}, query: %{"id" => 1} = second_query} =
+               conn
+               |> with_store(store)
+               |> put_query(%{
+                 "_ignore_me" => "20",
+                 "direction" => "forward",
+                 "limit" => "10",
+                 "id" => 1
+               })
+               |> PaginatedPlug.call([])
+               |> get_assigns()
+
+      assert map_size(second_query) == 1
+    end
   end
 
   defp put_query(conn, query), do: %Conn{conn | params: query, query_params: query}