diff --git a/.env-example b/.env-example index 1dd8fcb..4fb30b8 100644 --- a/.env-example +++ b/.env-example @@ -1 +1,2 @@ -DATABASE_URL="mysql://username:password@host:port/database_name" \ No newline at end of file +DATABASE_URL="mysql://username:password@host:port/database_name" +APP_ENVIRONMENT="dev" diff --git a/src/main.rs b/src/main.rs index af7aa27..36cb00a 100644 --- a/src/main.rs +++ b/src/main.rs @@ -2,6 +2,7 @@ use axum::http::header::{AUTHORIZATION, CONTENT_TYPE}; use axum::http::{HeaderName, HeaderValue}; use f5a_services::routes; use f5a_services::shared::context::AppContext; +use f5a_services::shared::env::AppEnvironment; use f5a_services::shared::trace::RequestIdSpan; use sea_orm::Database; use std::sync::Arc; @@ -44,7 +45,12 @@ async fn main() { conn: Arc::new(conn), }; - let router = routes::router() + let app_env: AppEnvironment = env::var("APP_ENVIRONMENT") + .ok() + .and_then(|v| v.parse().ok()) + .unwrap_or_default(); + + let router = routes::router(app_env) .with_state(app_ctx) .layer(service_layers) .layer( diff --git a/src/routes.rs b/src/routes.rs index 717b2f1..e58c3ce 100644 --- a/src/routes.rs +++ b/src/routes.rs @@ -2,7 +2,7 @@ use utoipa::OpenApi; use utoipa_axum::{router::OpenApiRouter, routes}; use utoipa_swagger_ui::SwaggerUi; -use crate::{root, shared::context::AppContext, users}; +use crate::{root, shared::context::AppContext, shared::env::AppEnvironment, users}; #[derive(OpenApi)] #[openapi( @@ -36,7 +36,7 @@ Currently no authentication required (internal service). )] pub struct ApiDoc; -pub fn router() -> axum::Router { +pub fn router(app_env: AppEnvironment) -> axum::Router { let (router, api) = OpenApiRouter::with_openapi(ApiDoc::openapi()) .routes(routes!(root::http::handlers::root_handler)) .routes(routes!( @@ -51,5 +51,9 @@ pub fn router() -> axum::Router { )) .split_for_parts(); - router.merge(SwaggerUi::new("/swagger-ui").url("/apidoc/openapi.json", api)) + if app_env.is_swagger_ui_enabled() { + router.merge(SwaggerUi::new("/swagger-ui").url("/apidoc/openapi.json", api)) + } else { + router + } } diff --git a/src/shared/env.rs b/src/shared/env.rs new file mode 100644 index 0000000..ff0745f --- /dev/null +++ b/src/shared/env.rs @@ -0,0 +1,27 @@ +use std::str::FromStr; + +#[derive(Debug, Clone, PartialEq, Default)] +pub enum AppEnvironment { + #[default] + Dev, + Prod, +} + +impl AppEnvironment { + pub fn is_swagger_ui_enabled(&self) -> bool { + matches!(self, Self::Dev) + } +} + +impl FromStr for AppEnvironment { + type Err = String; + fn from_str(s: &str) -> Result { + match s { + "dev" => Ok(Self::Dev), + "prod" => Ok(Self::Prod), + _ => Err(format!( + "invalid APP_ENVIRONMENT: {s}, expected 'dev' or 'prod'" + )), + } + } +} diff --git a/src/shared/mod.rs b/src/shared/mod.rs index 301672b..4d369e2 100644 --- a/src/shared/mod.rs +++ b/src/shared/mod.rs @@ -1,4 +1,5 @@ pub mod context; +pub mod env; pub mod error; pub mod pagination; pub mod response; diff --git a/src/shared/response/bad_request.rs b/src/shared/response/bad_request.rs index 5aecec8..ea11a8a 100644 --- a/src/shared/response/bad_request.rs +++ b/src/shared/response/bad_request.rs @@ -38,7 +38,7 @@ impl IntoFields for ValidationErrors { Field::new(&field_name, field_message, &error.code) })); - fields.sort_by(|a, b| a.field.to_lowercase().cmp(&b.field.to_lowercase())); + fields.sort_by_key(|a| a.field.to_lowercase()); fields } diff --git a/tests/setup/mod.rs b/tests/setup/mod.rs index db5eb0d..9b69fae 100644 --- a/tests/setup/mod.rs +++ b/tests/setup/mod.rs @@ -1,5 +1,6 @@ use std::sync::Arc; +use f5a_services::shared::env::AppEnvironment; use f5a_services::{routes, shared::context::AppContext}; use sea_orm::{ConnectionTrait, Database, DatabaseConnection}; @@ -28,7 +29,7 @@ impl TestContext { } pub fn configure(&self) -> axum::Router { - routes::router().with_state(AppContext { + routes::router(AppEnvironment::Dev).with_state(AppContext { conn: Arc::clone(&self.db), }) } diff --git a/tests/users/detail.rs b/tests/users/detail.rs index a988651..311d3cc 100644 --- a/tests/users/detail.rs +++ b/tests/users/detail.rs @@ -29,7 +29,7 @@ async fn test_read_user_detail() { let value = res.into_value::().await; assert_eq!(value.id, 1); assert_eq!(value.username, "idesoftd"); - assert_eq!(value.disabled, true); + assert!(value.disabled); } #[tokio::test] diff --git a/tests/users/migrations.rs b/tests/users/migrations.rs index a6759a6..7c77390 100644 --- a/tests/users/migrations.rs +++ b/tests/users/migrations.rs @@ -4,7 +4,7 @@ use sea_orm::{ActiveModelTrait, ActiveValue, ConnectionTrait, DbErr}; pub async fn insert_idesoft_user( conn: &impl ConnectionTrait, ) -> Result { - let created_at = NaiveDate::from_ymd_opt(2026, 03, 19) + let created_at = NaiveDate::from_ymd_opt(2026, 3, 19) .and_then(|date| date.and_hms_opt(10, 10, 10)) .unwrap(); @@ -23,7 +23,7 @@ pub async fn insert_idesoft_user( pub async fn insert_blue_bird_user( conn: &impl ConnectionTrait, ) -> Result { - let created_at = NaiveDate::from_ymd_opt(2026, 03, 19) + let created_at = NaiveDate::from_ymd_opt(2026, 3, 19) .and_then(|date| date.and_hms_opt(10, 10, 10)) .unwrap(); diff --git a/tests/users/paginated.rs b/tests/users/paginated.rs index 36cd6bf..fe4bc14 100644 --- a/tests/users/paginated.rs +++ b/tests/users/paginated.rs @@ -33,7 +33,7 @@ async fn it_reads_paginated_users() { assert_eq!(value.len(), 1); assert_eq!(value[0].username, "chameleon"); assert_eq!(value[0].id, 3); - assert_eq!(value[0].disabled, false); + assert!(!value[0].disabled); // assert for page 1 let app: axum::Router = ctx.configure(); @@ -47,7 +47,7 @@ async fn it_reads_paginated_users() { assert_eq!(value.len(), 1); assert_eq!(value[0].username, "bluebird"); assert_eq!(value[0].id, 2); - assert_eq!(value[0].disabled, false); + assert!(!value[0].disabled); // assert for page 2 let app: axum::Router = ctx.configure(); @@ -61,7 +61,7 @@ async fn it_reads_paginated_users() { assert_eq!(value.len(), 1); assert_eq!(value[0].username, "idesoftd"); assert_eq!(value[0].id, 1); - assert_eq!(value[0].disabled, true); + assert!(value[0].disabled); // assert for page 3 let app: axum::Router = ctx.configure();