feat(grid+grid-state+gridpoints): split out endpoints and state crates from grid

Author: johnbchron

Cargo.lock

@@ -0,0 +1,23 @@
+[package]
+name = "grid-state"
+version = "0.1.0"
+
+edition = "2024"
+license-file.workspace = true
+
+[dependencies]
+auth-domain = { path = "../auth-domain" }
+domain = { path = "../domain" }
+metrics-domain = { path = "../metrics-domain" }
+tower-sessions-db-store = { path = "../tower-sessions-db-store" }
+
+db = { workspace = true }
+
+axum.workspace = true
+leptos = { workspace = true, features = [ "ssr", "tracing" ] }
+
+gethostname = { version = "1.1" }
+miette.workspace = true
+
+[lints]
+workspace = true

crates/grid-state/Cargo.toml

@@ -1,3 +1,5 @@
+//! App state for the grid service.
+
 use std::sync::Arc;
 
 use auth_domain::AuthDomainService;
@@ -11,13 +13,17 @@ use metrics_domain::MetricsService;
 use miette::{Context, IntoDiagnostic, Result};
 use tower_sessions_db_store::DatabaseStore as DatabaseSessionStore;
 
+/// Metadata for a node serving the grid service.
 #[derive(Debug)]
 pub struct NodeMeta {
+  /// A string descriptor of the node's environment (dev, staging, prod, etc.).
   pub environment: String,
+  /// The name of the node host.
   pub host_name:   String,
 }
 
 impl NodeMeta {
+  /// Collect [`NodeMeta`] from the runtime environment.
   pub fn from_env() -> miette::Result<Self> {
     let env = std::env::var("GRID_ENV")
       .into_diagnostic()
@@ -34,17 +40,25 @@ impl NodeMeta {
   }
 }
 
+/// The state of a running grid service.
 #[derive(Clone, Debug, FromRef)]
 pub struct AppState {
+  /// The auth domain service.
   pub auth_domain:    AuthDomainService,
+  /// The prime domain service.
   pub domain:         DomainService,
+  /// The metrics domain service.
   pub metrics_domain: MetricsService,
+  /// The user session store.
   pub session_store:  DatabaseSessionStore,
+  /// Options for leptos.
   pub leptos_options: LeptosOptions,
+  /// The node metadata.
   pub node_meta:      Arc<NodeMeta>,
 }
 
 impl AppState {
+  /// Builds the [`AppState`].
   pub async fn build() -> Result<Self> {
     let (org_db, user_db, store_db, entry_db, cache_db, session_db) = {
       let url = std::env::var("POSTGRES_URL")

crates/grid/src/app_state.rs crates/grid-state/src/lib.rscrates/grid/src/app_state.rs renamed to crates/grid-state/src/lib.rs

@@ -10,6 +10,8 @@ publish = false
 auth-domain = { path = "../auth-domain" }
 domain = { path = "../domain" }
 drop-stream = { path = "../drop-stream" }
+grid-state = { path = "../grid-state" }
+gridpoints = { path = "../gridpoints" }
 metrics-domain = { path = "../metrics-domain" }
 site-app = { path = "../site-app", default-features = false, features = [ "ssr" ] }
 tower-sessions-db-store = { path = "../tower-sessions-db-store" }

crates/grid/Cargo.toml

@@ -5,10 +5,9 @@ use axum::{
   http::Uri,
   response::IntoResponse,
 };
+use grid_state::AppState;
 use leptos::prelude::provide_context;
 
-use crate::app_state::AppState;
-
 #[axum::debug_handler]
 pub async fn leptos_routes_handler(
   auth_session: AuthSession,

crates/grid/src/handlers.rs

@@ -2,17 +2,15 @@
 
 //! The server-side entrypoint for Rambit.
 
-mod app_state;
 mod args;
-mod endpoints;
 mod handlers;
 mod middleware;
 mod tracing_subscribers;
-mod util_traits;
 
 use axum::{Router, handler::Handler, routing::post};
 use axum_login::AuthManagerLayerBuilder;
 use clap::Parser;
+use grid_state::AppState;
 use leptos_axum::LeptosRoutes;
 use miette::{Context, IntoDiagnostic, Result};
 use tower_http::{
@@ -25,7 +23,6 @@ use tower_sessions::{
 };
 
 use self::{
-  app_state::AppState,
   args::CliArgs,
   handlers::{
     leptos_fallback_handler, leptos_routes_handler, server_fn_handler,
@@ -60,7 +57,7 @@ async fn main() -> Result<()> {
 
   // build router
   let router = Router::new()
-    .nest("/api/v1", self::endpoints::router())
+    .nest("/api/v1", gridpoints::router())
     .leptos_routes_with_handler(routes, leptos_routes_handler)
     .route("/api/sfn/{*fn_name}", post(server_fn_handler))
     .fallback(

crates/grid/src/main.rs

@@ -1,5 +1,6 @@
 use std::sync::Arc;
 
+use grid_state::NodeMeta;
 use http::header::{ORIGIN, USER_AGENT};
 use metrics_domain::{
   MetricsService,
@@ -10,8 +11,6 @@ use metrics_domain::{
 };
 use tower_http::trace::{DefaultOnRequest, OnRequest};
 
-use crate::app_state::NodeMeta;
-
 #[derive(Clone, Debug)]
 pub struct MetricReporterOnRequest {
   inner:          DefaultOnRequest,

crates/grid/src/middleware/on_request_metric_reporter.rs

@@ -1,5 +1,6 @@
 use std::sync::Arc;
 
+use grid_state::NodeMeta;
 use http::header::CONTENT_LENGTH;
 use metrics_domain::{
   MetricsService,
@@ -10,8 +11,6 @@ use metrics_domain::{
 };
 use tower_http::trace::{DefaultOnResponse, OnResponse};
 
-use crate::app_state::NodeMeta;
-
 #[derive(Clone, Debug)]
 pub struct MetricReporterOnResponse {
   inner:          DefaultOnResponse,

crates/grid/src/middleware/on_response_metric_reporter.rs

@@ -0,0 +1,23 @@
+[package]
+name = "gridpoints"
+version = "0.1.0"
+
+edition = "2024"
+license-file.workspace = true
+
+[dependencies]
+auth-domain = { path = "../auth-domain" }
+domain = { path = "../domain" }
+drop-stream = { path = "../drop-stream" }
+grid-state = { path = "../grid-state" }
+
+axum.workspace = true
+http = { version = "1" }
+serde.workspace = true
+serde_json.workspace = true
+tracing.workspace = true
+
+http-body-util = { version = "0.1.3" }
+
+[lints]
+workspace = true