feat(front): add service account list download button

- Add service account list download button
- Implement export endpoint at ServiceAccountController
- Add org scope check on download button

Author: Marcos Filipe

front/assets/js/service_accounts/components/ServiceAccountsList.tsx

@@ -72,15 +72,22 @@ export const ServiceAccountsList = ({
             <div className="b">Service Accounts</div>
           </div>
         </div>
-        {config.permissions.canManage && (
-          <button
-            className="btn btn-primary flex items-center"
-            onClick={onCreateNew}
-          >
-            <span className="material-symbols-outlined mr2">smart_toy</span>
-            Create Service Account
-          </button>
-        )}
+        <div className="flex">
+          {config.isOrgScope && (
+            <a aria-label="Download service accounts as CSV" title="Download service accounts as CSV" className="pointer flex items-center btn-secondary btn nowrap mr2" href={config.urls.export}>
+              <span className="material-symbols-outlined ">download</span>
+            </a>
+          )}
+          {config.permissions.canManage && (
+            <button
+              className="btn btn-primary flex items-center"
+              onClick={onCreateNew}
+            >
+              <span className="material-symbols-outlined mr2">smart_toy</span>
+              Create Service Account
+            </button>
+          )}
+        </div>
       </div>
 
       {serviceAccounts.length === 0 ? (

front/assets/js/service_accounts/config.ts

@@ -19,6 +19,7 @@ export class AppConfig {
       urls: {
         list: `/service_accounts`,
         create: `/service_accounts`,
+        export: `/service_accounts/export`,
         update: (id: string) => `/service_accounts/${id}`,
         delete: (id: string) => `/service_accounts/${id}`,
         regenerateToken: (id: string) =>

front/assets/js/service_accounts/types.ts

@@ -59,6 +59,7 @@ export interface Config {
   urls: {
     list: string;
     create: string;
+    export: string;
     update: (id: string) => string;
     delete: (id: string) => string;
     regenerateToken: (id: string) => string;

front/lib/front_web/controllers/service_account_controller.ex

@@ -138,4 +138,61 @@ defmodule FrontWeb.ServiceAccountController do
         |> json(%{error: message})
     end
   end
+
+  def export(conn, _params) do
+    org_id = conn.assigns.organization_id
+
+    data =
+      Stream.unfold(1, fn
+        nil ->
+          nil
+
+        page ->
+          case Models.ServiceAccount.list(org_id, page) do
+            {:ok, {service_accounts, total_pages}} ->
+              {service_accounts, next_valid_page_or_nil(total_pages, page)}
+
+            _ ->
+              nil
+          end
+      end)
+      |> Enum.flat_map(& &1)
+      |> Enum.map(fn e ->
+        %{
+          "id" => e.id,
+          "org_id" => e.org_id,
+          "creator_id" => e.creator_id,
+          "name" => e.name,
+          "description" => e.description,
+          "deactivated" => e.deactivated,
+          "created_at" => e.created_at,
+          "updated_at" => e.created_at
+        }
+      end)
+      |> CSV.encode(
+        headers: [
+          "id",
+          "org_id",
+          "creator_id",
+          "name",
+          "description",
+          "deactivated",
+          "created_at",
+          "updated_at"
+        ]
+      )
+      |> Enum.to_list()
+
+    send_download(conn, {:binary, data}, filename: "service_accounts.csv")
+  end
+
+  defp next_valid_page_or_nil(total_pages, page) do
+    next_page_no = page + 1
+
+    if next_page_no <= total_pages do
+      next_page_no
+    else
+      nil
+    end
+  end
 end

front/lib/front_web/router.ex

@@ -176,6 +176,7 @@ defmodule FrontWeb.Router do
     scope "/service_accounts" do
       get("/", ServiceAccountController, :index)
       post("/", ServiceAccountController, :create)
+      get("/export", ServiceAccountController, :export)
       get("/:id", ServiceAccountController, :show)
       put("/:id", ServiceAccountController, :update)
       delete("/:id", ServiceAccountController, :delete)

front/test/front_web/controllers/service_account_controller_test.exs

@@ -268,6 +268,21 @@ defmodule FrontWeb.ServiceAccountControllerTest do
     end
   end
 
+  describe "GET /service_accounts/export" do
+    test "requires service_accounts.view permission", %{
+      conn: conn,
+      org_id: org_id,
+      user_id: user_id
+    } do
+      Support.Stubs.PermissionPatrol.remove_all_permissions()
+      Support.Stubs.PermissionPatrol.add_permissions(org_id, user_id, ["organization.view"])
+
+      conn = get(conn, "/service_accounts/export")
+
+      assert html_response(conn, 404) =~ "Page not found"
+    end
+  end
+
   describe "PUT /service_accounts/:id" do
     setup %{org_id: org_id, user_id: user_id} do
       Support.Stubs.PermissionPatrol.add_permissions(org_id, user_id, [