Feat/dynamic sidebar api refactor (#1707)

* feat: add sync_sidebar router

* feat: change ID default to NoSet

* chore: address code review feedback

Author: ztygod

ceres/src/model/dynamic_sidebar.rs

@@ -44,3 +44,26 @@ pub struct UpdateSidebarPayload {
     pub visible: Option<bool>,
     pub order_index: Option<i32>,
 }
+
+#[derive(Clone, Debug, ToSchema, Serialize, Deserialize)]
+pub struct SidebarSyncPayload {
+    pub id: Option<i32>,
+    pub public_id: String,
+    pub label: String,
+    pub href: String,
+    pub visible: bool,
+    pub order_index: i32,
+}
+
+impl From<SidebarSyncPayload> for jupiter::model::sidebar_dto::SidebarSyncDto {
+    fn from(value: SidebarSyncPayload) -> Self {
+        Self {
+            id: value.id,
+            public_id: value.public_id,
+            label: value.label,
+            href: value.href,
+            visible: value.visible,
+            order_index: value.order_index,
+        }
+    }
+}

jupiter/src/model/mod.rs

@@ -3,3 +3,4 @@ pub mod common;
 pub mod conv_dto;
 pub mod issue_dto;
 pub mod merge_queue_dto;
+pub mod sidebar_dto;

jupiter/src/model/sidebar_dto.rs

@@ -0,0 +1,9 @@
+#[derive(Debug, Clone)]
+pub struct SidebarSyncDto {
+    pub id: Option<i32>,
+    pub public_id: String,
+    pub label: String,
+    pub href: String,
+    pub visible: bool,
+    pub order_index: i32,
+}

jupiter/src/storage/dynamic_sidebar_storage.rs

@@ -1,12 +1,15 @@
 use std::ops::Deref;
 
-use crate::storage::base_storage::{BaseStorage, StorageConnector};
+use crate::{
+    model::sidebar_dto::SidebarSyncDto,
+    storage::base_storage::{BaseStorage, StorageConnector},
+};
 use callisto::dynamic_sidebar;
 use common::errors::MegaError;
 use sea_orm::{
     ActiveModelTrait,
     ActiveValue::{NotSet, Set},
-    EntityTrait, QueryOrder,
+    EntityTrait, QueryOrder, TransactionTrait,
 };
 
 #[derive(Clone)]
@@ -118,4 +121,57 @@ impl DynamicSidebarStorage {
 
         Ok(model)
     }
+
+    pub async fn sync_sidebar(
+        &self,
+        items: Vec<SidebarSyncDto>,
+    ) -> Result<Vec<dynamic_sidebar::Model>, MegaError> {
+        if items.is_empty() {
+            return Ok(Vec::new());
+        }
+
+        // Begin a transaction
+        let txn = self.get_connection().begin().await?;
+
+        let mut res_models = Vec::with_capacity(items.len());
+
+        for item in items {
+            if let Some(id) = item.id {
+                // Update existing menu item
+                if let Some(model) = dynamic_sidebar::Entity::find_by_id(id).one(&txn).await? {
+                    let mut active_model: dynamic_sidebar::ActiveModel = model.into();
+
+                    active_model.public_id = Set(item.public_id);
+                    active_model.label = Set(item.label);
+                    active_model.href = Set(item.href);
+                    active_model.visible = Set(item.visible);
+                    active_model.order_index = Set(item.order_index);
+
+                    let updated = active_model.update(&txn).await?;
+                    res_models.push(updated);
+                } else {
+                    return Err(MegaError::Other(format!(
+                        "Sidebar with id `{id}` not found"
+                    )));
+                }
+            } else {
+                // Insert new menu item
+                let active_model = dynamic_sidebar::ActiveModel {
+                    id: NotSet,
+                    public_id: Set(item.public_id),
+                    label: Set(item.label),
+                    href: Set(item.href),
+                    visible: Set(item.visible),
+                    order_index: Set(item.order_index),
+                };
+                let inserted = active_model.insert(&txn).await?;
+                res_models.push(inserted);
+            }
+        }
+
+        // Commit the transaction
+        txn.commit().await?;
+
+        Ok(res_models)
+    }
 }

mono/src/api/router/dynamic_sidebar_router.rs

@@ -3,7 +3,7 @@ use axum::{
     extract::{Path, State},
 };
 use ceres::model::dynamic_sidebar::{
-    CreateSidebarPayload, SidebarMenuListRes, SidebarRes, UpdateSidebarPayload,
+    CreateSidebarPayload, SidebarMenuListRes, SidebarRes, SidebarSyncPayload, UpdateSidebarPayload,
 };
 use common::model::CommonResult;
 use utoipa_axum::{router::OpenApiRouter, routes};
@@ -20,7 +20,8 @@ pub fn routers() -> OpenApiRouter<MonoApiServiceState> {
             .routes(routes!(sidebar_menu_list))
             .routes(routes!(new_sidebar))
             .routes(routes!(update_sidebar_by_id))
-            .routes(routes!(delete_sidebar_by_id)),
+            .routes(routes!(delete_sidebar_by_id))
+            .routes(routes!(sync_sidebar)),
     )
 }
 
@@ -106,6 +107,38 @@ async fn update_sidebar_by_id(
     Ok(Json(CommonResult::success(Some(res.into()))))
 }
 
+/// Sync sidebar menus
+#[utoipa::path(
+    post,
+    path = "/sync",
+    request_body = Vec<SidebarSyncPayload>,
+    responses(
+        (status = 200, body = CommonResult<Vec<SidebarRes>>, content_type = "application/json")
+    ),
+    tag = SIDEBAR_TAG,
+    description = "Sync sidebar menus. \
+Each `public_id` and `order_index` must be unique across all sidebar items. \
+The operation will fail if: \
+- A new item has a `public_id` that already exists \
+- An update tries to set a `public_id` to one that's already in use by another item \
+- Multiple items in the payload have the same `order_index` \
+- An update tries to set an `order_index` that's already in use \
+The transaction will be rolled back if any of these constraints are violated."
+)]
+async fn sync_sidebar(
+    state: State<MonoApiServiceState>,
+    Json(payloads): Json<Vec<SidebarSyncPayload>>,
+) -> Result<Json<CommonResult<Vec<SidebarRes>>>, ApiError> {
+    let res = state
+        .dynamic_sidebar_stg()
+        .sync_sidebar(payloads.into_iter().map(|item| item.into()).collect())
+        .await?;
+
+    Ok(Json(CommonResult::success(Some(
+        res.into_iter().map(|item| item.into()).collect(),
+    ))))
+}
+
 /// Delete sidebar menu
 #[utoipa::path(
     delete,