status feature added with new ci cd

Author: hnlearndev

.github/workflows/ci-cd.yaml

@@ -41,6 +41,11 @@ jobs:
           POSTGRES_DB: devdb
         ports:
           - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
     env:
       DATABASE_URL: postgres://devuser:devpassword@localhost:5432/devdb
       DB_HOST: localhost
@@ -63,6 +68,13 @@ jobs:
             sleep 1
           done
 
+        - name: Wait for Postgres (fallback)
+          run: |
+            for i in {1..30}; do
+              nc -z localhost 5432 && break
+              sleep 1
+            done
+
       - name: Run migrations
         run: sqlx migrate run --database-url $DATABASE_URL
 

Cargo.toml

@@ -38,6 +38,7 @@ axum-extra = { version = "0.10.1", features = ["cookie"], optional = true }
 rand = { version = "0.9.2", optional = true }
 base64 = { version = "0.22", optional = true }
 governor = { version = "0.10.1", optional = true }
+reqwest = { version = "0.12", features = ["json", "rustls-tls"], optional = false }
 
 [features]
 hydrate = [

README.md

@@ -4,7 +4,11 @@ The final product is [williannguyen.com](https://williannguyen.com).
 
 Full personal reflection on this project can be found on this [post](https://williannguyen.com/posts/4).
 
-PS: It works. If it does not, please dm me. Thank you for your helps.
+**PS**:
+
+There is a regular status service to check that the website should work. This is one of the feature can be seen in the source code. If it does not, please dm me. Thank you for your helps.
+
+![Website Status](https://img.shields.io/endpoint?url=https://williannguyen.com/status-badge)
 
 ## ARCHITECTURE OVERVIEW
 
@@ -88,20 +92,25 @@ However, the industry-graded architecture is purposely used to study fullstack t
     │       ├── cors.rs                 # Cross-Origin Resource Sharing
     │       └── security_headers.rs     # Security headers middleware
     ├── models.rs           # Data model coordinator
-    ├── models/
-    │   └── subscriber.rs   # Newsletter subscriber model
-    ├── repositories.rs     # Data access coordinator
-    ├── repositories/
-    │   └── subscriber.rs   # Database queries & data access
-    ├── services.rs         # Business logic coordinator
-    ├── services/
-    │   └── subscriber.rs   # Newsletter business logic
-    ├── handlers.rs         # Request handler coordinator
-    ├── handlers/
-    │   └── subscriber.rs   # HTTP request/response handling
-    ├── routes.rs           # API route coordinator
-    └── routes/
-        └── subscriber.rs   # Newsletter API endpoints
+  ├── models/
+  │   ├── subscriber.rs   # Newsletter subscriber model
+  │   └── status.rs       # Status badge model (for shields.io)
+  ├── repositories.rs     # Data access coordinator
+  ├── repositories/
+  │   ├── subscriber.rs   # Database queries & data access
+  │   └── status.rs       # Status badge logic (checks and aggregates status)
+  ├── services.rs         # Business logic coordinator
+  ├── services/
+  │   ├── subscriber.rs   # Newsletter business logic
+  │   └── status.rs       # Status badge update logic (periodic background updater)
+  ├── handlers.rs         # Request handler coordinator
+  ├── handlers/
+  │   ├── subscriber.rs   # HTTP request/response handling
+  │   └── status.rs       # Status badge API handler (serves cached status)
+  ├── routes.rs           # API route coordinator
+  └── routes/
+    ├── subscriber.rs   # Newsletter API endpoints
+    └── status.rs       # Status badge API endpoint (`/status-badge` for shields.io)
 ```
 
 ### 🏘️ Backend Layer Relationships

src/server.rs

@@ -12,18 +12,27 @@ use crate::app::shell;
 use crate::server::{
     db::{config, pool, state::AppState},
     middleware::global_layer::{cors_layer, security_headers},
-    routes::subscriber::subscriber_routes,
+    models::status::StatusBadge,
+    routes::{status::status_routes, subscriber::subscriber_routes},
+    services::status::StatusService,
 };
 use axum::{Router, middleware::from_fn};
 use leptos::prelude::*;
 use leptos_axum::{LeptosRoutes, generate_route_list};
+use std::sync::{Arc, Mutex};
 use std::time::Duration;
 use tower_http::{compression::CompressionLayer, timeout::TimeoutLayer, trace::TraceLayer};
 use tracing_subscriber::{EnvFilter, fmt, layer::SubscriberExt, util::SubscriberInitExt};
 
 /// Main server run function - called by main.rs
 #[cfg(feature = "ssr")]
 pub async fn run() {
+    // Shared status state
+    let status: Arc<Mutex<StatusBadge>> = Arc::new(Mutex::new(StatusBadge::unknown()));
+
+    // Start periodic status monitor
+    StatusService::start_status_monitor(status.clone());
+
     // Load environment variables from .env file
     dotenvy::dotenv().ok();
 
@@ -64,7 +73,8 @@ pub async fn run() {
         })
         .fallback(leptos_axum::file_and_error_handler(shell))
         .with_state(leptos_options.clone())
-        .merge(subscriber_routes().with_state(app_state));
+        .merge(subscriber_routes().with_state(app_state))
+        .merge(status_routes(status));
 
     // Start the server
     let listener = tokio::net::TcpListener::bind(&addr).await.unwrap();

src/server/handlers.rs

@@ -1 +1,2 @@
+pub mod status;
 pub mod subscriber;

src/server/handlers/status.rs

@@ -0,0 +1,8 @@
+use crate::server::models::status::StatusBadge;
+use crate::server::services::status::StatusData;
+use axum::{Json, extract::State};
+
+pub async fn status_badge(State(status): State<StatusData>) -> Json<StatusBadge> {
+    let data = status.lock().unwrap().clone();
+    Json(data)
+}

src/server/handlers/subscriber.rs

@@ -1,7 +1,7 @@
 use crate::server::db::state::AppState;
 use crate::server::services::subscriber::SubscriberService;
 use crate::shared::dto::SubscribeResponse;
-use axum::{Json, extract::State};
+use axum::{Json, extract::State, http::StatusCode};
 use serde::Deserialize;
 
 /// DTO for incoming subscription requests
@@ -17,7 +17,7 @@ pub struct SubscribeRequest {
 pub async fn subscribe_handler(
     State(app_state): State<AppState>,
     Json(request): Json<SubscribeRequest>,
-) -> Result<Json<SubscribeResponse>, axum::http::StatusCode> {
+) -> Result<Json<SubscribeResponse>, StatusCode> {
     match SubscriberService::subscribe(
         &app_state.db_pool,
         request.email,
@@ -43,7 +43,7 @@ pub async fn subscribe_handler(
                     message: "You're already subscribed with this email address.".to_string(),
                 }));
             }
-            Err(axum::http::StatusCode::INTERNAL_SERVER_ERROR)
+            Err(StatusCode::INTERNAL_SERVER_ERROR)
         }
     }
 }

src/server/models.rs

@@ -1 +1,2 @@
+pub mod status;
 pub mod subscriber;

src/server/models/status.rs

@@ -0,0 +1,9 @@
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct StatusBadge {
+    pub schema_version: u8,
+    pub label: String,
+    pub message: String,
+    pub color: String,
+}

src/server/repositories.rs

@@ -1 +1,2 @@
+pub mod status;
 pub mod subscriber;