Handlers are _named operations_, which can be exposed via routes.

Each domain module that exposes handlers does so through a `handlers` child module, ideally as a top-level symbol that can be plugged directly into Axum's `MethodRouter`. Modules could make exceptions to this - kill the doctrinaire inside yourself, after all - but none of the API modules that actually exist need such exceptions, and consistency is useful.

The related details of request types, URL types, response types, errors, &c &c are then organized into modules under `handlers`, along with their respective tests.

3 files changed, 166 insertions, 0 deletions

diff --git a/src/boot/handlers/boot/mod.rs b/src/boot/handlers/boot/mod.rs
new file mode 100644
index 0000000..010f57b
--- /dev/null
+++ b/src/boot/handlers/boot/mod.rs
@@ -0,0 +1,30 @@
+use axum::{
+    extract::{Json, State},
+    response::{self, IntoResponse},
+};
+
+use crate::{app::App, boot::Snapshot, error::Internal, token::extract::Identity, user::User};
+
+#[cfg(test)]
+mod test;
+
+pub async fn handler(State(app): State<App>, identity: Identity) -> Result<Response, Internal> {
+    let snapshot = app.boot().snapshot().await?;
+    Ok(Response {
+        user: identity.user,
+        snapshot,
+    })
+}
+
+#[derive(serde::Serialize)]
+pub struct Response {
+    pub user: User,
+    #[serde(flatten)]
+    pub snapshot: Snapshot,
+}
+
+impl IntoResponse for Response {
+    fn into_response(self) -> response::Response {
+        Json(self).into_response()
+    }
+}
diff --git a/src/boot/handlers/boot/test.rs b/src/boot/handlers/boot/test.rs
new file mode 100644
index 0000000..0a7622b
--- /dev/null
+++ b/src/boot/handlers/boot/test.rs
@@ -0,0 +1,133 @@
+use axum::extract::State;
+
+use crate::test::fixtures;
+
+#[tokio::test]
+async fn returns_identity() {
+    let app = fixtures::scratch_app().await;
+
+    let viewer = fixtures::identity::fictitious();
+    let response = super::handler(State(app), viewer.clone())
+        .await
+        .expect("boot always succeeds");
+
+    assert_eq!(viewer.user, response.user);
+}
+
+#[tokio::test]
+async fn includes_logins() {
+    let app = fixtures::scratch_app().await;
+    let spectator = fixtures::user::create(&app, &fixtures::now()).await;
+
+    let viewer = fixtures::identity::fictitious();
+    let response = super::handler(State(app), viewer)
+        .await
+        .expect("boot always succeeds");
+
+    assert!(response.snapshot.users.contains(&spectator));
+}
+
+#[tokio::test]
+async fn includes_channels() {
+    let app = fixtures::scratch_app().await;
+    let channel = fixtures::channel::create(&app, &fixtures::now()).await;
+
+    let viewer = fixtures::identity::fictitious();
+    let response = super::handler(State(app), viewer)
+        .await
+        .expect("boot always succeeds");
+
+    assert!(response.snapshot.channels.contains(&channel));
+}
+
+#[tokio::test]
+async fn includes_messages() {
+    let app = fixtures::scratch_app().await;
+    let sender = fixtures::user::create(&app, &fixtures::now()).await;
+    let channel = fixtures::channel::create(&app, &fixtures::now()).await;
+    let message = fixtures::message::send(&app, &channel, &sender, &fixtures::now()).await;
+
+    let viewer = fixtures::identity::fictitious();
+    let response = super::handler(State(app), viewer)
+        .await
+        .expect("boot always succeeds");
+
+    assert!(response.snapshot.messages.contains(&message));
+}
+
+#[tokio::test]
+async fn excludes_expired_messages() {
+    let app = fixtures::scratch_app().await;
+    let sender = fixtures::user::create(&app, &fixtures::ancient()).await;
+    let channel = fixtures::channel::create(&app, &fixtures::ancient()).await;
+    let expired_message =
+        fixtures::message::send(&app, &channel, &sender, &fixtures::ancient()).await;
+
+    app.messages()
+        .expire(&fixtures::now())
+        .await
+        .expect("expiry never fails");
+
+    let viewer = fixtures::identity::fictitious();
+    let response = super::handler(State(app), viewer)
+        .await
+        .expect("boot always succeeds");
+
+    assert!(!response.snapshot.messages.contains(&expired_message));
+}
+
+#[tokio::test]
+async fn excludes_deleted_messages() {
+    let app = fixtures::scratch_app().await;
+    let sender = fixtures::user::create(&app, &fixtures::now()).await;
+    let channel = fixtures::channel::create(&app, &fixtures::now()).await;
+    let deleted_message = fixtures::message::send(&app, &channel, &sender, &fixtures::now()).await;
+
+    app.messages()
+        .delete(&sender, &deleted_message.id, &fixtures::now())
+        .await
+        .expect("deleting valid message succeeds");
+
+    let viewer = fixtures::identity::fictitious();
+    let response = super::handler(State(app), viewer)
+        .await
+        .expect("boot always succeeds");
+
+    assert!(!response.snapshot.messages.contains(&deleted_message));
+}
+
+#[tokio::test]
+async fn excludes_expired_channels() {
+    let app = fixtures::scratch_app().await;
+    let expired_channel = fixtures::channel::create(&app, &fixtures::ancient()).await;
+
+    app.channels()
+        .expire(&fixtures::now())
+        .await
+        .expect("expiry never fails");
+
+    let viewer = fixtures::identity::fictitious();
+    let response = super::handler(State(app), viewer)
+        .await
+        .expect("boot always succeeds");
+
+    assert!(!response.snapshot.channels.contains(&expired_channel));
+}
+
+#[tokio::test]
+async fn excludes_deleted_channels() {
+    let app = fixtures::scratch_app().await;
+    let deleted_channel = fixtures::channel::create(&app, &fixtures::now()).await;
+
+    app.channels()
+        .delete(&deleted_channel.id, &fixtures::now())
+        .await
+        .expect("deleting a valid channel succeeds");
+
+    let viewer = fixtures::identity::fictitious();
+    let response = super::handler(State(app), viewer)
+        .await
+        .expect("boot always succeeds");
+
+    assert!(!response.snapshot.channels.contains(&deleted_channel));
+}
diff --git a/src/boot/handlers/mod.rs b/src/boot/handlers/mod.rs
new file mode 100644
index 0000000..194c4a9
--- /dev/null
+++ b/src/boot/handlers/mod.rs
@@ -0,0 +1,3 @@
+mod boot;
+
+pub use boot::handler as boot;