fix(projecthub-rest-api): drop page size (#406)

## 📝 Description

Removed the `page_size` query parameter due to inconsistent behavior.
Pagination now relies on the default `page_size` and the `page`
parameter only.

Retained only the `x-page` and `x-has-more` response headers, which are
sufficient for paginated iteration.

Related [task](renderedtext/tasks#7953).

## ✅ Checklist
- [x] I have tested this change
- [x] ~This change requires documentation update~ - N/A

Author: dexyk

projecthub-rest-api/config/config.exs

@@ -10,7 +10,8 @@ config :projecthub, http_port: 4000
 config :projecthub,
   projecthub_grpc_endpoint: "0.0.0.0:50051",
   organization_grpc_endpoint: "0.0.0.0:50051",
-  rbac_grpc_endpoint: "0.0.0.0:50051"
+  rbac_grpc_endpoint: "0.0.0.0:50051",
+  projects_page_size: 500
 
 config :projecthub, :enviroment, config_env()
 

projecthub-rest-api/config/runtime.exs

@@ -17,5 +17,6 @@ if config_env() == :prod do
   config :projecthub,
     projecthub_grpc_endpoint: System.fetch_env!("INTERNAL_API_URL_PROJECT"),
     organization_grpc_endpoint: System.fetch_env!("INTERNAL_API_URL_ORGANIZATION"),
-    rbac_grpc_endpoint: System.fetch_env!("INTERNAL_API_URL_RBAC")
+    rbac_grpc_endpoint: System.fetch_env!("INTERNAL_API_URL_RBAC"),
+    projects_page_size: System.get_env("PROJECTS_PAGE_SIZE", "500") |> String.to_integer()
 end

projecthub-rest-api/config/test.exs

@@ -7,3 +7,5 @@ config :junit_formatter,
   print_report_file: true,
   include_filename?: true,
   include_file_line?: true
+
+config :projecthub, :projects_page_size, 2

projecthub-rest-api/lib/projecthub/http_api.ex

@@ -40,11 +40,9 @@ defmodule Projecthub.HttpApi do
 
   get "/api/#{@version}/projects" do
     case list_projects(conn) do
-      {:ok, {projects, page, page_size, total, has_more}} ->
+      {:ok, {projects, page, has_more}} ->
         conn
         |> put_resp_header("x-page", Integer.to_string(page))
-        |> put_resp_header("x-page-size", Integer.to_string(page_size))
-        |> put_resp_header("x-total-count", Integer.to_string(total))
         |> put_resp_header("x-has-more", to_string(has_more))
         |> send_resp(200, Poison.encode!(projects))
 
@@ -694,23 +692,22 @@ defmodule Projecthub.HttpApi do
     org_id = conn.assigns.org_id
     restricted = Organization.restricted?(org_id)
 
-    with {:ok, page} <- parse_int(conn.params, "page", 1, 1_000_000, 1),
-         {:ok, page_size} <- parse_int(conn.params, "page_size", 1, 500, 500) do
-      do_list_projects(conn, org_id, restricted, page, page_size)
-    else
-      {:error, reason} ->
-        {:error, reason}
+    case parse_int(conn.params, "page", 1, 100, 1) do
+      {:ok, page} -> do_list_projects(conn, org_id, restricted, page)
+      {:error, reason} -> {:error, reason}
     end
   end
 
-  defp do_list_projects(conn, org_id, restricted, page, page_size) do
+  defp page_size, do: Application.get_env(:projecthub, :projects_page_size, 500)
+
+  defp do_list_projects(conn, org_id, restricted, page) do
     req =
       InternalApi.Projecthub.ListRequest.new(
         metadata: Utils.construct_req_meta(conn),
         pagination:
           InternalApi.Projecthub.PaginationRequest.new(
             page: page,
-            page_size: page_size
+            page_size: page_size()
           )
       )
 
@@ -728,8 +725,13 @@ defmodule Projecthub.HttpApi do
           |> Enum.map(&Map.merge(&1, %{"apiVersion" => @version, "kind" => "Project"}))
 
         total = Map.get(res.pagination || %{}, :total_entries, 0)
-        has_more = (page - 1) * page_size + length(projects) < total
-        {:ok, {projects, page, page_size, total, has_more}}
+        has_more = (page - 1) * page_size() + length(res.projects) < total
+
+        if total < (page - 1) * page_size() do
+          {:ok, {[], page, false}}
+        else
+          {:ok, {projects, page, has_more}}
+        end
 
       :NOT_FOUND ->
         {:error, :not_found}

projecthub-rest-api/test/projecthub/http_api_test.exs

@@ -292,16 +292,15 @@ defmodule Projecthub.HttpApi.Test do
       p1 = create("project1", p1_id)
       p2 = create("project2", p2_id)
       p3 = create("project3", p3_id)
+      page_size = Application.get_env(:projecthub, :projects_page_size)
 
       FunRegistry.set!(FakeServices.RbacService, :list_accessible_projects, fn _, _ ->
         InternalApi.RBAC.ListAccessibleProjectsResponse.new(project_ids: [p1_id, p2_id, p3_id])
       end)
 
       FunRegistry.set!(FakeServices.ProjectService, :list, fn req, _ ->
         alias InternalApi.Projecthub, as: PH
-        # Simulate pagination
         page = req.pagination.page
-        page_size = req.pagination.page_size
         all_projects = [p1, p2, p3]
         projects = Enum.slice(all_projects, (page - 1) * page_size, page_size)
 
@@ -327,30 +326,50 @@ defmodule Projecthub.HttpApi.Test do
     test "returns correct pagination headers for /projects" do
       {:ok, response} =
         HTTPoison.get(
-          "http://localhost:#{@port}/api/#{@version}/projects?page=1&page_size=2",
+          "http://localhost:#{@port}/api/#{@version}/projects?page=1",
           @headers
         )
 
       assert response.status_code == 200
       assert response.headers |> Enum.any?(fn {k, v} -> k == "x-page" and v == "1" end)
-      assert response.headers |> Enum.any?(fn {k, v} -> k == "x-page-size" and v == "2" end)
-      assert response.headers |> Enum.any?(fn {k, v} -> k == "x-total-count" and v == "3" end)
       assert response.headers |> Enum.any?(fn {k, v} -> k == "x-has-more" and v == "true" end)
       projects = Poison.decode!(response.body)
       assert length(projects) == 2
+
+      {:ok, response2} =
+        HTTPoison.get(
+          "http://localhost:#{@port}/api/#{@version}/projects?page=2",
+          @headers
+        )
+
+      assert response2.status_code == 200
+      assert response2.headers |> Enum.any?(fn {k, v} -> k == "x-page" and v == "2" end)
+      assert response2.headers |> Enum.any?(fn {k, v} -> k == "x-has-more" and v == "false" end)
+      projects2 = Poison.decode!(response2.body)
+      assert length(projects2) == 1
+
+      {:ok, response3} =
+        HTTPoison.get(
+          "http://localhost:#{@port}/api/#{@version}/projects?page=3",
+          @headers
+        )
+
+      assert response3.status_code == 200
+      assert response3.headers |> Enum.any?(fn {k, v} -> k == "x-page" and v == "3" end)
+      assert response3.headers |> Enum.any?(fn {k, v} -> k == "x-has-more" and v == "false" end)
+      projects3 = Poison.decode!(response3.body)
+      assert Enum.empty?(projects3)
     end
 
     test "returns correct pagination headers for /projects when there are no more projects" do
       {:ok, response} =
         HTTPoison.get(
-          "http://localhost:#{@port}/api/#{@version}/projects?page=2&page_size=2",
+          "http://localhost:#{@port}/api/#{@version}/projects?page=2",
           @headers
         )
 
       assert response.status_code == 200
       assert response.headers |> Enum.any?(fn {k, v} -> k == "x-page" and v == "2" end)
-      assert response.headers |> Enum.any?(fn {k, v} -> k == "x-page-size" and v == "2" end)
-      assert response.headers |> Enum.any?(fn {k, v} -> k == "x-total-count" and v == "3" end)
       assert response.headers |> Enum.any?(fn {k, v} -> k == "x-has-more" and v == "false" end)
       projects = Poison.decode!(response.body)
       assert length(projects) == 1
@@ -371,7 +390,7 @@ defmodule Projecthub.HttpApi.Test do
 
       {:ok, response} =
         HTTPoison.get(
-          "http://localhost:#{@port}/api/#{@version}/projects?page=10&page_size=2",
+          "http://localhost:#{@port}/api/#{@version}/projects?page=10",
           @headers
         )
 
@@ -401,7 +420,7 @@ defmodule Projecthub.HttpApi.Test do
 
       {:ok, response} =
         HTTPoison.get(
-          "http://localhost:#{@port}/api/#{@version}/projects?page=foo&page_size=bar",
+          "http://localhost:#{@port}/api/#{@version}/projects?page=foo",
           @headers
         )
 
@@ -411,29 +430,18 @@ defmodule Projecthub.HttpApi.Test do
     test "returns 400 on negative page" do
       {:ok, response} =
         HTTPoison.get(
-          "http://localhost:#{@port}/api/#{@version}/projects?page=-1&page_size=2",
+          "http://localhost:#{@port}/api/#{@version}/projects?page=-1",
           @headers
         )
 
       assert response.status_code == 400
       assert Poison.decode!(response.body)["message"] =~ "page must be at least 1"
     end
 
-    test "returns 400 on zero page_size" do
-      {:ok, response} =
-        HTTPoison.get(
-          "http://localhost:#{@port}/api/#{@version}/projects?page=1&page_size=0",
-          @headers
-        )
-
-      assert response.status_code == 400
-      assert Poison.decode!(response.body)["message"] =~ "page_size must be at least 1"
-    end
-
     test "returns 400 on too large page" do
       {:ok, response} =
         HTTPoison.get(
-          "http://localhost:#{@port}/api/#{@version}/projects?page=9999&page_size=2",
+          "http://localhost:#{@port}/api/#{@version}/projects?page=9999",
           @headers
         )
 
@@ -443,28 +451,6 @@ defmodule Projecthub.HttpApi.Test do
         assert Poison.decode!(response.body)["message"] =~ "page must be at most"
       end
     end
-
-    test "returns 400 on too large page_size" do
-      {:ok, response} =
-        HTTPoison.get(
-          "http://localhost:#{@port}/api/#{@version}/projects?page=1&page_size=9999",
-          @headers
-        )
-
-      assert response.status_code == 400
-      assert Poison.decode!(response.body)["message"] =~ "page_size must be at most"
-    end
-
-    test "returns 400 on non-numeric page_size" do
-      {:ok, response} =
-        HTTPoison.get(
-          "http://localhost:#{@port}/api/#{@version}/projects?page=1&page_size=abc",
-          @headers
-        )
-
-      assert response.status_code == 400
-      assert Poison.decode!(response.body)["message"] =~ "page_size must be a number"
-    end
   end
 
   describe "GET /api/<version>/projects/:name with authorized user" do
@@ -1828,7 +1814,7 @@ defmodule Projecthub.HttpApi.Test do
 
   def create(name, id) do
     alias InternalApi.Projecthub.Project
-    alias InternalApi.Projecthub.Project.Spec.{Repository, Visibility, PermissionType}
+    alias InternalApi.Projecthub.Project.Spec.{PermissionType, Repository, Visibility}
 
     Project.new(
       metadata: Project.Metadata.new(name: name, id: id),