controllers/krate/versions: Extract ListQueryParams struct

Author: Turbo87

src/controllers/helpers/pagination.rs

@@ -7,6 +7,7 @@ use crate::util::errors::{bad_request, AppResult};
 use crate::util::HeaderMapExt;
 use std::num::NonZeroU32;
 
+use axum::extract::FromRequestParts;
 use base64::{engine::general_purpose, Engine};
 use diesel::pg::Pg;
 use diesel::prelude::*;
@@ -55,19 +56,20 @@ impl PaginationOptions {
     }
 }
 
-#[derive(Debug, Deserialize, utoipa::IntoParams)]
+#[derive(Debug, Deserialize, FromRequestParts, utoipa::IntoParams)]
+#[from_request(via(axum::extract::Query))]
 #[into_params(parameter_in = Query)]
 pub struct PaginationQueryParams {
     /// The page number to request.
     ///
     /// This parameter is mutually exclusive with `seek` and not supported for
     /// all requests.
     #[param(value_type = Option<u32>, minimum = 1)]
-    page: Option<NonZeroU32>,
+    pub page: Option<NonZeroU32>,
 
     /// The number of items to request per page.
     #[param(value_type = Option<u32>, minimum = 1)]
-    per_page: Option<NonZeroU32>,
+    pub per_page: Option<NonZeroU32>,
 
     /// The seek key to request.
     ///
@@ -76,7 +78,7 @@ pub struct PaginationQueryParams {
     ///
     /// The seek key can usually be found in the `meta.next_page` field of
     /// paginated responses.
-    seek: Option<String>,
+    pub seek: Option<String>,
 }
 
 pub(crate) struct PaginationOptionsBuilder {

src/controllers/krate/versions.rs

@@ -1,5 +1,6 @@
 //! Endpoint for versions of a crate
 
+use axum::extract::{FromRequestParts, Query};
 use axum_extra::json;
 use axum_extra::response::ErasedJson;
 use diesel::dsl::not;
@@ -11,48 +12,75 @@ use indexmap::{IndexMap, IndexSet};
 use std::str::FromStr;
 
 use crate::app::AppState;
-use crate::controllers::helpers::pagination::{encode_seek, Page, PaginationOptions};
+use crate::controllers::helpers::pagination::{
+    encode_seek, Page, PaginationOptions, PaginationQueryParams,
+};
 use crate::controllers::krate::CratePath;
 use crate::models::{User, Version, VersionOwnerAction};
 use crate::schema::{users, versions};
 use crate::util::errors::{bad_request, AppResult, BoxedAppError};
 use crate::util::RequestUtils;
 use crate::views::EncodableVersion;
 
+#[derive(Debug, Deserialize, FromRequestParts, utoipa::IntoParams)]
+#[from_request(via(Query))]
+#[into_params(parameter_in = Query)]
+pub struct ListQueryParams {
+    /// Additional data to include in the response.
+    ///
+    /// Valid values: `release_tracks`.
+    ///
+    /// Defaults to no additional data.
+    ///
+    /// This parameter expects a comma-separated list of values.
+    include: Option<String>,
+
+    /// The sort order of the versions.
+    ///
+    /// Valid values: `date`, and `semver`.
+    ///
+    /// Defaults to `semver`.
+    sort: Option<String>,
+}
+
 /// List all versions of a crate.
 #[utoipa::path(
     get,
     path = "/api/v1/crates/{name}/versions",
-    params(CratePath),
+    params(CratePath, ListQueryParams, PaginationQueryParams),
     tag = "versions",
     responses((status = 200, description = "Successful Response")),
 )]
-pub async fn list_versions(state: AppState, path: CratePath, req: Parts) -> AppResult<ErasedJson> {
+pub async fn list_versions(
+    state: AppState,
+    path: CratePath,
+    params: ListQueryParams,
+    pagination: PaginationQueryParams,
+    req: Parts,
+) -> AppResult<ErasedJson> {
     let mut conn = state.db_read().await?;
 
     let crate_id = path.load_crate_id(&mut conn).await?;
 
-    let mut pagination = None;
-    let params = req.query();
     // To keep backward compatibility, we paginate only if per_page is provided
-    if params.get("per_page").is_some() {
-        pagination = Some(
+    let pagination = match pagination.per_page {
+        Some(_) => Some(
             PaginationOptions::builder()
                 .enable_seek(true)
                 .enable_pages(false)
                 .gather(&req)?,
-        );
-    }
+        ),
+        None => None,
+    };
 
-    let include = req
-        .query()
-        .get("include")
-        .map(|mode| ShowIncludeMode::from_str(mode))
+    let include = params
+        .include
+        .map(|mode| ShowIncludeMode::from_str(&mode))
         .transpose()?
         .unwrap_or_default();
 
     // Sort by semver by default
-    let versions_and_publishers = match params.get("sort").map(|s| s.to_lowercase()).as_deref() {
+    let versions_and_publishers = match params.sort.map(|s| s.to_lowercase()).as_deref() {
         Some("date") => {
             list_by_date(crate_id, pagination.as_ref(), include, &req, &mut conn).await?
         }

src/snapshots/crates_io__openapi__tests__openapi_snapshot.snap

@@ -830,6 +830,70 @@ snapshot_kind: text
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "description": "Additional data to include in the response.\n\nValid values: `release_tracks`.\n\nDefaults to no additional data.\n\nThis parameter expects a comma-separated list of values.",
+            "in": "query",
+            "name": "include",
+            "required": false,
+            "schema": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          {
+            "description": "The sort order of the versions.\n\nValid values: `date`, and `semver`.\n\nDefaults to `semver`.",
+            "in": "query",
+            "name": "sort",
+            "required": false,
+            "schema": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          {
+            "description": "The page number to request.\n\nThis parameter is mutually exclusive with `seek` and not supported for\nall requests.",
+            "in": "query",
+            "name": "page",
+            "required": false,
+            "schema": {
+              "format": "int32",
+              "minimum": 1,
+              "type": [
+                "integer",
+                "null"
+              ]
+            }
+          },
+          {
+            "description": "The number of items to request per page.",
+            "in": "query",
+            "name": "per_page",
+            "required": false,
+            "schema": {
+              "format": "int32",
+              "minimum": 1,
+              "type": [
+                "integer",
+                "null"
+              ]
+            }
+          },
+          {
+            "description": "The seek key to request.\n\nThis parameter is mutually exclusive with `page` and not supported for\nall requests.\n\nThe seek key can usually be found in the `meta.next_page` field of\npaginated responses.",
+            "in": "query",
+            "name": "seek",
+            "required": false,
+            "schema": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
           }
         ],
         "responses": {