at-jet 0.7.2

High-performance HTTP + Protobuf API framework for mobile services
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
//! HTTP Server implementation for AT-Jet

use {crate::{error::{JetError,
                     Result},
             middleware::{RequestIdLayer,
                          smart_trace_layer}},
     axum::Router,
     std::net::SocketAddr,
     tokio::net::TcpListener,
     tower_http::{compression::CompressionLayer,
                  cors::{Any,
                         CorsLayer}},
     tracing::info};

#[cfg(feature = "metrics")]
use {crate::{metrics::{MetricsGuard,
                       metrics_router},
             middleware::HttpMetricsLayer},
     std::sync::Arc};

/// AT-Jet HTTP Server
///
/// A high-performance HTTP server optimized for Protobuf APIs.
///
/// # Example
///
/// ```rust,no_run
/// use at_jet::prelude::*;
///
/// #[tokio::main]
/// async fn main() -> anyhow::Result<()> {
///     let server = JetServer::new()
///         .route("/api/health", get(health_check))
///         .with_cors()
///         .with_compression()
///         .with_tracing();
///
///     server.serve("0.0.0.0:8080").await?;
///     Ok(())
/// }
///
/// async fn health_check() -> &'static str {
///     "OK"
/// }
/// ```
pub struct JetServer {
  router:              Router,
  cors_layer:          Option<CorsLayer>,
  compression_enabled: bool,
  tracing_enabled:     bool,
  request_id_enabled:  bool,
}

impl JetServer {
  /// Create a new JetServer instance
  pub fn new() -> Self {
    Self {
      router:              Router::new(),
      cors_layer:          None,
      compression_enabled: false,
      tracing_enabled:     false,
      request_id_enabled:  false,
    }
  }

  /// Add a route to the server
  ///
  /// # Example
  ///
  /// ```rust,ignore
  /// use at_jet::prelude::*;
  ///
  /// let server = JetServer::new()
  ///     .route("/api/users", get(list_users).post(create_user))
  ///     .route("/api/users/:id", get(get_user).delete(delete_user));
  /// ```
  pub fn route(mut self, path: &str, method_router: axum::routing::MethodRouter) -> Self {
    self.router = self.router.route(path, method_router);
    self
  }

  /// Merge another router into this server
  pub fn merge(mut self, router: Router) -> Self {
    self.router = self.router.merge(router);
    self
  }

  /// Nest a router under a path prefix
  ///
  /// # Example
  ///
  /// ```rust,ignore
  /// use at_jet::prelude::*;
  ///
  /// let api_routes = Router::new()
  ///     .route("/users", get(list_users))
  ///     .route("/posts", get(list_posts));
  ///
  /// let server = JetServer::new()
  ///     .nest("/api/v1", api_routes);
  /// ```
  pub fn nest(mut self, path: &str, router: Router) -> Self {
    self.router = self.router.nest(path, router);
    self
  }

  /// Enable CORS with permissive defaults (suitable for development)
  ///
  /// This allows any origin, method, and header. For production,
  /// use `with_cors_config()` for fine-grained control.
  ///
  /// # Example
  ///
  /// ```rust,ignore
  /// let server = JetServer::new()
  ///     .route("/api/users", get(list_users))
  ///     .with_cors();  // Allow all origins (development only)
  /// ```
  pub fn with_cors(mut self) -> Self {
    self.cors_layer = Some(CorsLayer::new().allow_origin(Any).allow_methods(Any).allow_headers(Any));
    self
  }

  /// Enable CORS with custom configuration (recommended for production)
  ///
  /// # Example
  ///
  /// ```rust,ignore
  /// use tower_http::cors::{CorsLayer, AllowOrigin};
  /// use http::{HeaderValue, Method};
  ///
  /// let cors = CorsLayer::new()
  ///     .allow_origin([
  ///         "https://app.example.com".parse::<HeaderValue>().unwrap(),
  ///         "https://admin.example.com".parse::<HeaderValue>().unwrap(),
  ///     ])
  ///     .allow_methods([Method::GET, Method::POST, Method::PUT, Method::DELETE])
  ///     .allow_headers([http::header::CONTENT_TYPE, http::header::AUTHORIZATION])
  ///     .allow_credentials(true)
  ///     .max_age(Duration::from_secs(3600));
  ///
  /// let server = JetServer::new()
  ///     .route("/api/users", get(list_users))
  ///     .with_cors_config(cors);
  /// ```
  pub fn with_cors_config(mut self, cors: CorsLayer) -> Self {
    self.cors_layer = Some(cors);
    self
  }

  /// Enable response compression (gzip)
  pub fn with_compression(mut self) -> Self {
    self.compression_enabled = true;
    self
  }

  /// Enable request ID generation and propagation.
  ///
  /// Each request gets a unique ID (from incoming `X-Request-Id` header or generated UUID v4).
  /// The ID is recorded on the tracing span (appears in logs), stored in request extensions
  /// (accessible via `Extension<RequestId>`), and returned in the response `X-Request-Id` header.
  ///
  /// **Note**: For the request ID to appear in log lines, enable tracing as well
  /// (`.with_tracing().with_request_id()`). The tracing layer must be added before
  /// the request ID layer so the span exists when the ID is recorded.
  ///
  /// # Example
  ///
  /// ```rust,ignore
  /// let server = JetServer::new()
  ///     .route("/api/users", get(list_users))
  ///     .with_tracing()
  ///     .with_request_id();
  /// ```
  pub fn with_request_id(mut self) -> Self {
    self.request_id_enabled = true;
    self
  }

  /// Enable request/response tracing
  ///
  /// This adds detailed logging for HTTP requests including:
  /// - Request method, URI, and version
  /// - Response status code
  /// - Request duration
  ///
  /// Requires a tracing subscriber to be initialized.
  ///
  /// # Example
  ///
  /// ```rust,ignore
  /// use tracing_subscriber::EnvFilter;
  ///
  /// // Initialize tracing subscriber
  /// tracing_subscriber::fmt()
  ///     .with_env_filter(EnvFilter::from_default_env())
  ///     .init();
  ///
  /// let server = JetServer::new()
  ///     .route("/api/users", get(list_users))
  ///     .with_tracing();
  /// ```
  pub fn with_tracing(mut self) -> Self {
    self.tracing_enabled = true;
    self
  }

  /// Enable Prometheus metrics with HTTP request instrumentation.
  ///
  /// This is a convenience method that:
  /// 1. Merges a metrics scrape endpoint at the given `path`
  /// 2. Adds an [`HttpMetricsLayer`] that records request count, duration, and active requests
  ///
  /// Requires the `metrics` feature to be enabled.
  ///
  /// # Example
  ///
  /// ```rust,ignore
  /// use at_jet::prelude::*;
  /// use std::sync::Arc;
  ///
  /// let guard = init_metrics(&MetricsConfig::default()).unwrap();
  ///
  /// let server = JetServer::new()
  ///     .route("/health", get(|| async { "OK" }))
  ///     .with_metrics(Arc::new(guard), "/metrics")
  ///     .with_tracing();
  /// ```
  #[cfg(feature = "metrics")]
  pub fn with_metrics(self, guard: Arc<MetricsGuard>, path: &str) -> Self {
    self.merge(metrics_router(guard, path)).layer(HttpMetricsLayer::new())
  }

  /// Add a custom middleware layer to the server
  ///
  /// This method allows you to add any tower-compatible middleware layer.
  ///
  /// # Example - Request Timeout
  ///
  /// ```rust,ignore
  /// use std::time::Duration;
  /// use tower_http::timeout::TimeoutLayer;
  ///
  /// let server = JetServer::new()
  ///     .route("/api/users", get(list_users))
  ///     .layer(TimeoutLayer::new(Duration::from_secs(30)));
  /// ```
  ///
  /// # Example - Custom Authentication Middleware
  ///
  /// ```rust,ignore
  /// use axum::{middleware, http::Request, response::Response};
  ///
  /// async fn auth_middleware<B>(
  ///     request: Request<B>,
  ///     next: axum::middleware::Next<B>,
  /// ) -> Response {
  ///     // Check authentication here
  ///     next.run(request).await
  /// }
  ///
  /// let server = JetServer::new()
  ///     .route("/api/users", get(list_users))
  ///     .layer(middleware::from_fn(auth_middleware));
  /// ```
  pub fn layer<L>(mut self, layer: L) -> Self
  where
    L: tower::Layer<axum::routing::Route> + Clone + Send + 'static,
    L::Service: tower::Service<axum::extract::Request, Response = axum::response::Response, Error = std::convert::Infallible>
      + Clone
      + Send
      + 'static,
    <L::Service as tower::Service<axum::extract::Request>>::Future: Send + 'static, {
    self.router = self.router.layer(layer);
    self
  }

  /// Get the router for advanced customization
  pub fn into_router(self) -> Router {
    self.router
  }

  /// Start the server
  ///
  /// # Arguments
  ///
  /// * `addr` - Address to bind to (e.g., "0.0.0.0:8080")
  ///
  /// # Example
  ///
  /// ```rust,no_run
  /// use at_jet::prelude::*;
  ///
  /// #[tokio::main]
  /// async fn main() -> anyhow::Result<()> {
  ///     let server = JetServer::new()
  ///         .route("/health", get(|| async { "OK" }));
  ///
  ///     server.serve("0.0.0.0:8080").await?;
  ///     Ok(())
  /// }
  /// ```
  pub async fn serve(self, addr: &str) -> Result<()> {
    let mut router = self.router;

    // Apply middleware layers
    if let Some(cors) = self.cors_layer {
      router = router.layer(cors);
    }

    if self.compression_enabled {
      router = router.layer(CompressionLayer::new());
    }

    // Request ID layer must be applied BEFORE tracing layer, so that in tower's
    // reverse-order execution, TraceLayer (outer) creates the span first, then
    // RequestIdLayer (inner) can record the request_id on the existing span.
    if self.request_id_enabled {
      router = router.layer(RequestIdLayer::new());
    }

    if self.tracing_enabled {
      router = router.layer(smart_trace_layer());
    }

    let addr: SocketAddr = addr
      .parse()
      .map_err(|e| JetError::ServerBind(format!("Invalid address: {}", e)))?;

    let listener = TcpListener::bind(addr)
      .await
      .map_err(|e| JetError::ServerBind(format!("Failed to bind: {}", e)))?;

    info!("AT-Jet server listening on {}", addr);

    axum::serve(listener, router)
      .await
      .map_err(|e| JetError::ServerBind(format!("Server error: {}", e)))?;

    Ok(())
  }

  /// Start the server with graceful shutdown on Ctrl+C.
  ///
  /// Unlike `serve()`, this method:
  /// 1. Spawns the server on a background task
  /// 2. Waits for SIGINT (Ctrl+C)
  /// 3. Returns cleanly when shutdown signal is received
  pub async fn serve_with_shutdown(self, addr: &str) -> Result<()> {
    let mut router = self.router;

    if let Some(cors) = self.cors_layer {
      router = router.layer(cors);
    }

    if self.compression_enabled {
      router = router.layer(CompressionLayer::new());
    }

    if self.request_id_enabled {
      router = router.layer(RequestIdLayer::new());
    }

    if self.tracing_enabled {
      router = router.layer(smart_trace_layer());
    }

    let addr: SocketAddr = addr
      .parse()
      .map_err(|e| JetError::ServerBind(format!("Invalid address: {}", e)))?;

    let listener = TcpListener::bind(addr)
      .await
      .map_err(|e| JetError::ServerBind(format!("Failed to bind: {}", e)))?;

    info!("AT-Jet server listening on {}", addr);

    let http_handle = tokio::spawn(async move { axum::serve(listener, router).await });

    tokio::select! {
      _ = tokio::signal::ctrl_c() => {
        info!("Received shutdown signal");
      }
      result = http_handle => {
        match result {
          | Ok(Ok(())) => info!("HTTP server exited"),
          | Ok(Err(e)) => tracing::error!(error = %e, "HTTP server failed"),
          | Err(e) => tracing::error!(error = %e, "HTTP server task panicked"),
        }
      }
    }

    Ok(())
  }

  /// Print a startup banner to stderr before tracing is initialized.
  ///
  /// **Deprecated**: Use [`crate::startup::StartupBanner`] instead, which provides
  /// section dividers, a closing footer, and a builder API.
  ///
  /// # Arguments
  /// * `service_name` - Name of the service
  /// * `version` - Version string
  /// * `extras` - Additional key-value pairs to display (e.g., environment, config source)
  #[deprecated(since = "0.8.0", note = "Use StartupBanner from at_jet::startup instead")]
  pub fn print_banner(service_name: &str, version: &str, extras: &[(&str, &str)]) {
    let mut banner = crate::startup::StartupBanner::new(service_name, version);
    for (key, value) in extras {
      banner = banner.kv(key, value);
    }
    banner.print();
  }
}

impl Default for JetServer {
  fn default() -> Self {
    Self::new()
  }
}