controllers/site_metadata: Add banner_message field

Author: Turbo87

src/controllers/site_metadata.rs

@@ -15,6 +15,9 @@ pub struct MetadataResponse<'a> {
 
     /// Whether the crates.io service is in read-only mode.
     pub read_only: bool,
+
+    /// Optional banner message to display on all pages.
+    pub banner_message: Option<&'a str>,
 }
 
 /// Get crates.io metadata.
@@ -37,6 +40,7 @@ pub async fn get_site_metadata(state: AppState) -> impl IntoResponse {
         deployed_sha,
         commit: deployed_sha,
         read_only,
+        banner_message: state.config.banner_message.as_deref(),
     })
     .into_response()
 }

src/tests/routes/mod.rs

@@ -19,5 +19,6 @@ pub mod me;
 pub mod metrics;
 mod private;
 pub mod session;
+mod site_metadata;
 pub mod summary;
 pub mod users;

src/tests/routes/site_metadata.rs

@@ -0,0 +1,17 @@
+use crate::tests::util::{RequestHelper, TestApp};
+use insta::{assert_json_snapshot, assert_snapshot};
+
+#[tokio::test(flavor = "multi_thread")]
+async fn site_metadata_includes_banner_message() {
+    let (_app, anon) = TestApp::init()
+        .with_config(|config| {
+            config.db.primary.read_only_mode = true;
+            config.banner_message = Some("Test banner message".to_string());
+        })
+        .empty()
+        .await;
+
+    let response = anon.get::<()>("/api/v1/site_metadata").await;
+    assert_snapshot!(response.status(), @"200 OK");
+    assert_json_snapshot!(response.json());
+}

src/tests/routes/snapshots/crates_io__tests__routes__site_metadata__site_metadata_includes_banner_message-2.snap

@@ -0,0 +1,10 @@
+---
+source: src/tests/routes/site_metadata.rs
+expression: response.json()
+---
+{
+  "banner_message": "Test banner message",
+  "commit": "unknown",
+  "deployed_sha": "unknown",
+  "read_only": true
+}