feat(auth): Paginate API keys listing

- [x] Update tests
- [x] Use Pagination helpers to paginate API keys

fixes #2442

meilisearch-http/src/routes/api_key.rs

@@ -1,18 +1,19 @@
 use std::str;
-use uuid::Uuid;
 
 use actix_web::{web, HttpRequest, HttpResponse};
-
-use meilisearch_auth::{error::AuthControllerError, Action, AuthController, Key};
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
 use time::OffsetDateTime;
+use uuid::Uuid;
+
+use meilisearch_auth::{error::AuthControllerError, Action, AuthController, Key};
+use meilisearch_error::{Code, ResponseError};
 
 use crate::extractors::{
     authentication::{policies::*, GuardedData},
     sequential_extractor::SeqHandler,
 };
-use meilisearch_error::{Code, ResponseError};
+use crate::routes::Pagination;
 
 pub fn configure(cfg: &mut web::ServiceConfig) {
     cfg.service(
@@ -46,20 +47,21 @@ pub async fn create_api_key(
 
 pub async fn list_api_keys(
     auth_controller: GuardedData<ActionPolicy<{ actions::KEYS_GET }>, AuthController>,
-    _req: HttpRequest,
+    paginate: web::Query<Pagination>,
 ) -> Result<HttpResponse, ResponseError> {
-    let res = tokio::task::spawn_blocking(move || -> Result<_, AuthControllerError> {
+    let page_view = tokio::task::spawn_blocking(move || -> Result<_, AuthControllerError> {
         let keys = auth_controller.list_keys()?;
-        let res: Vec<_> = keys
-            .into_iter()
-            .map(|k| KeyView::from_key(k, &auth_controller))
-            .collect();
-        Ok(res)
+        let page_view = paginate.auto_paginate_sized(
+            keys.into_iter()
+                .map(|k| KeyView::from_key(k, &auth_controller)),
+        );
+
+        Ok(page_view)
     })
     .await
     .map_err(|e| ResponseError::from_msg(e.to_string(), Code::Internal))??;
 
-    Ok(HttpResponse::Ok().json(KeyListView::from(res)))
+    Ok(HttpResponse::Ok().json(page_view))
 }
 
 pub async fn get_api_key(
@@ -156,14 +158,3 @@ impl KeyView {
         }
     }
 }
-
-#[derive(Debug, Serialize)]
-struct KeyListView {
-    results: Vec<KeyView>,
-}
-
-impl From<Vec<KeyView>> for KeyListView {
-    fn from(results: Vec<KeyView>) -> Self {
-        Self { results }
-    }
-}

meilisearch-http/tests/auth/api_keys.rs

@@ -673,42 +673,46 @@ async fn list_api_keys() {
     assert_eq!(200, code, "{:?}", &response);
 
     let expected_response = json!({ "results":
-    [
-        {
-            "description": "Indexing API key",
-            "indexes": ["products"],
-            "actions": [
-                "search",
-                "documents.add",
-                "documents.get",
-                "documents.delete",
-                "indexes.create",
-                "indexes.get",
-                "indexes.update",
-                "indexes.delete",
-                "tasks.get",
-                "settings.get",
-                "settings.update",
-                "stats.get",
-                "dumps.create",
-            ],
-            "expiresAt": "2050-11-13T00:00:00Z"
-        },
-        {
-            "name": "Default Search API Key",
-            "description": "Use it to search from the frontend",
-            "indexes": ["*"],
-            "actions": ["search"],
-            "expiresAt": serde_json::Value::Null,
-        },
-        {
-            "name": "Default Admin API Key",
-            "description": "Use it for anything that is not a search operation. Caution! Do not expose it on a public frontend",
-            "indexes": ["*"],
-            "actions": ["*"],
-            "expiresAt": serde_json::Value::Null,
-        }
-    ]});
+        [
+            {
+                "description": "Indexing API key",
+                "indexes": ["products"],
+                "actions": [
+                    "search",
+                    "documents.add",
+                    "documents.get",
+                    "documents.delete",
+                    "indexes.create",
+                    "indexes.get",
+                    "indexes.update",
+                    "indexes.delete",
+                    "tasks.get",
+                    "settings.get",
+                    "settings.update",
+                    "stats.get",
+                    "dumps.create",
+                ],
+                "expiresAt": "2050-11-13T00:00:00Z"
+            },
+            {
+                "name": "Default Search API Key",
+                "description": "Use it to search from the frontend",
+                "indexes": ["*"],
+                "actions": ["search"],
+                "expiresAt": serde_json::Value::Null,
+            },
+            {
+                "name": "Default Admin API Key",
+                "description": "Use it for anything that is not a search operation. Caution! Do not expose it on a public frontend",
+                "indexes": ["*"],
+                "actions": ["*"],
+                "expiresAt": serde_json::Value::Null,
+            }
+        ],
+        "limit": 20,
+        "offset": 0,
+        "total": 3,
+    });
 
     assert_json_include!(actual: response, expected: expected_response);
 }