mycelium-api 8.3.1-rc.1

use crate::{dtos::MyceliumProfileData, rest::shared::PaginationParams};

use actix_web::{delete, get, patch, post, web, HttpResponse, Responder};
use myc_core::{
    domain::dtos::error_code::ErrorCode,
    use_cases::role_scoped::system_manager::error_codes::{
        delete_error_code, get_error_code, list_error_codes,
        register_error_code, update_error_code_message_and_details,
    },
};
use myc_diesel::repositories::SqlAppModule;
use myc_http_tools::{
    utils::HttpJsonResponse,
    wrappers::default_response_to_http_response::{
        fetch_many_response_kind, handle_mapped_error,
    },
};
use mycelium_base::entities::FetchResponseKind;
use serde::Deserialize;
use shaku::HasComponent;
use utoipa::{IntoParams, ToSchema};

// ? ---------------------------------------------------------------------------
// ? Configure application
// ? ---------------------------------------------------------------------------

pub fn configure(config: &mut web::ServiceConfig) {
    config
        .service(register_error_code_url)
        .service(list_error_codes_url)
        .service(get_error_code_url)
        .service(update_error_code_message_and_details_url)
        .service(delete_error_code_url);
}

// ? ---------------------------------------------------------------------------
// ? Define API structs
// ? ---------------------------------------------------------------------------

#[derive(Deserialize, ToSchema)]
#[serde(rename_all = "camelCase")]
pub struct CreateErrorCodeBody {
    prefix: String,
    message: String,
    details: Option<String>,
    is_internal: bool,
}

#[derive(Deserialize, ToSchema, IntoParams)]
#[serde(rename_all = "camelCase")]
pub struct ListErrorCodesParams {
    prefix: Option<String>,
    code: Option<i32>,
    is_internal: Option<bool>,
}

#[derive(Deserialize, ToSchema)]
#[serde(rename_all = "camelCase")]
pub struct UpdateErrorCodeMessageAndDetailsBody {
    message: String,
    details: Option<String>,
}

// ? ---------------------------------------------------------------------------
// ? Define API paths
// ? ---------------------------------------------------------------------------

/// Register a new error code.
///
/// This action is restricted to manager users.
#[utoipa::path(
    post,
    operation_id = "register_error_code",
    request_body = CreateErrorCodeBody,
    responses(
        (
            status = 500,
            description = "Unknown internal server error.",
            body = HttpJsonResponse,
        ),
        (
            status = 403,
            description = "Forbidden.",
            body = HttpJsonResponse,
        ),
        (
            status = 401,
            description = "Unauthorized.",
            body = HttpJsonResponse,
        ),
        (
            status = 400,
            description = "Error code already exists.",
            body = HttpJsonResponse,
        ),
        (
            status = 201,
            description = "Error code created.",
            body = ErrorCode,
        ),
    ),
)]
#[post("")]
pub async fn register_error_code_url(
    body: web::Json<CreateErrorCodeBody>,
    profile: MyceliumProfileData,
    app_module: web::Data<SqlAppModule>,
) -> impl Responder {
    match register_error_code(
        profile.to_profile(),
        body.prefix.to_owned(),
        body.message.to_owned(),
        body.details.to_owned(),
        body.is_internal.to_owned(),
        Box::new(&*app_module.resolve_ref()),
    )
    .await
    {
        Ok(account) => HttpResponse::Created().json(account),
        Err(err) => handle_mapped_error(err),
    }
}

/// List available error codes.
///
/// List accounts with pagination. The `records` field contains a vector of
/// `ErrorCode` model.
///
#[utoipa::path(
    get,
    operation_id = "list_error_codes",
    params(
        ListErrorCodesParams,
        PaginationParams,
    ),
    responses(
        (
            status = 500,
            description = "Unknown internal server error.",
            body = HttpJsonResponse,
        ),
        (
            status = 403,
            description = "Forbidden.",
            body = HttpJsonResponse,
        ),
        (
            status = 401,
            description = "Unauthorized.",
            body = HttpJsonResponse,
        ),
        (
            status = 204,
            description = "Not found.",
        ),
        (
            status = 200,
            description = "Fetching success.",
            body = [ErrorCode],
        ),
    ),
)]
#[get("")]
pub async fn list_error_codes_url(
    info: web::Query<ListErrorCodesParams>,
    page: web::Query<PaginationParams>,
    profile: MyceliumProfileData,
    app_module: web::Data<SqlAppModule>,
) -> impl Responder {
    match list_error_codes(
        profile.to_profile(),
        info.prefix.to_owned(),
        info.code.to_owned(),
        info.is_internal.to_owned(),
        page.page_size.to_owned(),
        page.skip.to_owned(),
        Box::new(&*app_module.resolve_ref()),
    )
    .await
    {
        Ok(res) => fetch_many_response_kind(res),
        Err(err) => handle_mapped_error(err),
    }
}

/// Get an error code.
///
/// Get error code by prefix and code.
///
#[utoipa::path(
    get,
    operation_id = "get_error_code",
    params(
        ("prefix" = String, Path, description = "The error prefix."),
        ("code" = i32, Path, description = "The error code."),
    ),
    responses(
        (
            status = 500,
            description = "Unknown internal server error.",
            body = HttpJsonResponse,
        ),
        (
            status = 204,
            description = "Not found.",
        ),
        (
            status = 403,
            description = "Forbidden.",
            body = HttpJsonResponse,
        ),
        (
            status = 401,
            description = "Unauthorized.",
            body = HttpJsonResponse,
        ),
        (
            status = 200,
            description = "Fetching success.",
            body = ErrorCode,
        ),
    ),
)]
#[get("/prefixes/{prefix}/codes/{code}")]
pub async fn get_error_code_url(
    path: web::Path<(String, i32)>,
    profile: MyceliumProfileData,
    app_module: web::Data<SqlAppModule>,
) -> impl Responder {
    let (prefix, code) = path.into_inner();

    match get_error_code(
        profile.to_profile(),
        prefix.to_owned(),
        code.to_owned(),
        Box::new(&*app_module.resolve_ref()),
    )
    .await
    {
        Err(err) => handle_mapped_error(err),
        Ok(res) => match res {
            FetchResponseKind::NotFound(_) => {
                HttpResponse::NoContent().finish()
            }
            FetchResponseKind::Found(error_code) => {
                HttpResponse::Ok().json(error_code)
            }
        },
    }
}

/// Update an error code.
///
/// Update error code message and details.
///
#[utoipa::path(
    patch,
    operation_id = "update_error_code_message_and_details",
    params(
        ("prefix" = String, Path, description = "The error prefix."),
        ("code" = i32, Path, description = "The error code."),
    ),
    request_body = UpdateErrorCodeMessageAndDetailsBody,
    responses(
        (
            status = 500,
            description = "Unknown internal server error.",
            body = HttpJsonResponse,
        ),
        (
            status = 403,
            description = "Forbidden.",
            body = HttpJsonResponse,
        ),
        (
            status = 401,
            description = "Unauthorized.",
            body = HttpJsonResponse,
        ),
        (
            status = 400,
            description = "Error code not updated.",
            body = HttpJsonResponse,
        ),
        (
            status = 202,
            description = "Error code updated.",
            body = ErrorCode,
        ),
    ),
)]
#[patch("/prefixes/{prefix}/codes/{code}")]
pub async fn update_error_code_message_and_details_url(
    path: web::Path<(String, i32)>,
    body: web::Json<UpdateErrorCodeMessageAndDetailsBody>,
    profile: MyceliumProfileData,
    app_module: web::Data<SqlAppModule>,
) -> impl Responder {
    let (prefix, code) = path.into_inner();

    match update_error_code_message_and_details(
        profile.to_profile(),
        prefix,
        code,
        body.message.to_owned(),
        body.details.to_owned(),
        Box::new(&*app_module.resolve_ref()),
        Box::new(&*app_module.resolve_ref()),
    )
    .await
    {
        Err(err) => handle_mapped_error(err),
        Ok(res) => HttpResponse::Accepted().json(res),
    }
}

/// Delete an error code.
///
/// Delete error code by prefix and code.
///
#[utoipa::path(
    delete,
    operation_id = "delete_error_code",
    params(
        ("prefix" = String, Path, description = "The error prefix."),
        ("code" = i32, Path, description = "The error code."),
    ),
    responses(
        (
            status = 500,
            description = "Unknown internal server error.",
            body = HttpJsonResponse,
        ),
        (
            status = 403,
            description = "Forbidden.",
            body = HttpJsonResponse,
        ),
        (
            status = 401,
            description = "Unauthorized.",
            body = HttpJsonResponse,
        ),
        (
            status = 400,
            description = "Error code not deleted.",
            body = HttpJsonResponse,
        ),
        (
            status = 204,
            description = "Error code deleted.",
        ),
    ),
)]
#[delete("/prefixes/{prefix}/codes/{code}")]
pub async fn delete_error_code_url(
    path: web::Path<(String, i32)>,
    profile: MyceliumProfileData,
    app_module: web::Data<SqlAppModule>,
) -> impl Responder {
    let (prefix, code) = path.into_inner();

    match delete_error_code(
        profile.to_profile(),
        prefix,
        code,
        Box::new(&*app_module.resolve_ref()),
    )
    .await
    {
        Err(err) => handle_mapped_error(err),
        Ok(_) => HttpResponse::NoContent().finish(),
    }
}