fixup! fixup! editoast: work-schedules: add endpoints for easier edition and viewing

Author: eckter

editoast/src/views/operational_studies.rs

@@ -1,4 +1,5 @@
 use crate::models::prelude::*;
+use crate::models::work_schedules::WorkSchedule;
 use crate::models::Project;
 use crate::models::Scenario;
 use crate::models::Study;
@@ -58,4 +59,12 @@ impl Ordering {
             Ordering::LastModifiedDesc => Scenario::LAST_MODIFICATION.desc(),
         }
     }
+
+    pub fn as_work_schedule_ordering(&self) -> SortSetting<WorkSchedule> {
+        match *self {
+            Ordering::NameAsc => WorkSchedule::OBJ_ID.asc(),
+            Ordering::NameDesc => WorkSchedule::OBJ_ID.desc(),
+            _ => WorkSchedule::OBJ_ID.asc(),
+        }
+    }
 }

editoast/src/views/work_schedules.rs

@@ -5,12 +5,16 @@ use crate::models::prelude::*;
 use crate::models::work_schedules::WorkSchedule;
 use crate::models::work_schedules::WorkScheduleGroup;
 use crate::models::work_schedules::WorkScheduleType;
+use crate::views::operational_studies::Ordering;
+use crate::views::pagination::PaginationQueryParam;
+use crate::views::pagination::PaginationStats;
 use crate::views::path::projection::Intersection;
 use crate::views::path::projection::PathProjection;
 use crate::views::AuthenticationExt;
 use crate::views::AuthorizationError;
 use axum::extract::Json;
 use axum::extract::Path;
+use axum::extract::Query;
 use axum::extract::State;
 use axum::response::IntoResponse;
 use axum::Extension;
@@ -20,7 +24,8 @@ use derivative::Derivative;
 use editoast_authz::BuiltinRole;
 use editoast_derive::EditoastError;
 use editoast_models::DbConnectionPoolV2;
-use editoast_schemas::infra::{Direction, TrackRange};
+use editoast_schemas::infra::Direction;
+use editoast_schemas::infra::TrackRange;
 use serde::de::Error as SerdeError;
 use serde::Deserialize;
 use serde::Serialize;
@@ -29,6 +34,8 @@ use thiserror::Error;
 use utoipa::{IntoParams, ToSchema};
 use uuid::Uuid;
 
+use super::pagination::PaginatedList;
+
 crate::routes! {
     "/work_schedules" => {
         create,
@@ -469,20 +476,38 @@ async fn put_in_group(
     .await
 }
 
+#[derive(Serialize, ToSchema)]
+#[cfg_attr(test, derive(Deserialize))]
+struct GroupContentResponse {
+    #[schema(value_type = Vec<WorkSchedule>)]
+    results: Vec<WorkSchedule>,
+    #[serde(flatten)]
+    stats: PaginationStats,
+}
+
+#[derive(Debug, Clone, serde::Deserialize, utoipa::IntoParams)]
+#[into_params(parameter_in = Query)]
+pub struct WorkScheduleOrderingParam {
+    #[serde(default)]
+    pub ordering: Ordering,
+}
+
 #[utoipa::path(
     get, path = "",
     tag = "work_schedules",
-    params(WorkScheduleGroupIdParam),
+    params(PaginationQueryParam, WorkScheduleGroupIdParam, WorkScheduleOrderingParam),
     responses(
-        (status = 200, description = "The work schedules in the group", body = Vec<WorkSchedule>),
+        (status = 200, description = "The work schedules in the group", body = inline(GroupContentResponse)),
         (status = 404, description = "Work schedule group not found"),
     )
 )]
 async fn get_group(
     State(db_pool): State<DbConnectionPoolV2>,
     Extension(auth): AuthenticationExt,
     Path(WorkScheduleGroupIdParam { id: group_id }): Path<WorkScheduleGroupIdParam>,
-) -> Result<Json<Vec<WorkSchedule>>> {
+    Query(pagination_params): Query<PaginationQueryParam>,
+    Query(ordering_params): Query<WorkScheduleOrderingParam>,
+) -> Result<Json<GroupContentResponse>> {
     let authorized = auth
         .check_roles([BuiltinRole::WorkScheduleRead].into())
         .await
@@ -491,6 +516,14 @@ async fn get_group(
         return Err(AuthorizationError::Unauthorized.into());
     }
 
+    let ordering = ordering_params.ordering;
+    let settings = pagination_params
+        .validate(1000)?
+        .warn_page_size(100)
+        .into_selection_settings()
+        .filter(move || WorkSchedule::WORK_SCHEDULE_GROUP_ID.eq(group_id))
+        .order_by(move || ordering.as_work_schedule_ordering());
+
     let conn = &mut db_pool.get().await?;
 
     // Check that the group exists
@@ -499,11 +532,12 @@ async fn get_group(
     })
     .await?;
 
-    let selection_setting =
-        SelectionSettings::new().filter(move || WorkSchedule::WORK_SCHEDULE_GROUP_ID.eq(group_id));
-    let work_schedules = WorkSchedule::list(conn, selection_setting).await?;
+    let (work_schedules, stats) = WorkSchedule::list_paginated(conn, settings).await?;
 
-    Ok(Json(work_schedules))
+    Ok(Json(GroupContentResponse {
+        results: work_schedules,
+        stats,
+    }))
 }
 
 #[cfg(test)]
@@ -769,10 +803,11 @@ pub mod tests {
 
         // Get the content of the group
         let request = app.get(&work_schedule_url);
-        let work_schedules = app
+        let response = app
             .fetch(request)
             .assert_status(StatusCode::OK)
-            .json_into::<Vec<WorkSchedule>>();
+            .json_into::<GroupContentResponse>();
+        let work_schedules = response.results;
         assert_eq!(1, work_schedules.len());
         assert_eq!(ref_obj_id, work_schedules[0].obj_id);