arc-web 0.3.0

Arc framework runtime: Actix/Tera web machinery, event-sourcing wiring, and the application builder seam.
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
use crate::helpers::config::DatabaseDriver;
use crate::helpers::es_stack;
use crate::helpers::rate_limit;
use crate::http::middlewares::rate_limit_middleware::GlobalRateLimit;
use crate::websocket::server::WsServer;
use crate::{AggregateRegistration, AppState, ProjectorReg};
use actix::prelude::*;
use actix_session::storage::CookieSessionStore;
use actix_session::{config::PersistentSession, SessionMiddleware};
use actix_web::cookie::{time::Duration, Key, SameSite};
use actix_web::middleware::{Compress, NormalizePath};
use actix_web::web::ServiceConfig;
use actix_web::{web, App, HttpServer};
use std::env;
use std::io;
use std::sync::Mutex;
use tracing::{info, warn};

use arc_core::access_log::{AccessLogger, NoOpAccessLogger};
use arc_core::aggregate::Aggregate;
use arc_core::command_bus::{CommandBus, SnapshotPolicy};
#[cfg(feature = "nats")]
use arc_core::event_bus::TwoLaneEventBus;
use arc_core::event_bus::{EventBus, InProcessEventBus};
use arc_core::projection::{ProjectionEngine, ProjectionEngineHandler};
use arc_core::session::SessionStore;
#[cfg(feature = "nats")]
use arc_es_nats::NatsEventBus;
use arc_es_sqlite::SqliteSessionStore;
use std::sync::Arc;

type RoutesFn = dyn Fn(&mut ServiceConfig) + Send + Sync + 'static;

type AppDataFn = dyn Fn(&mut ServiceConfig) + Send + Sync + 'static;

/// Type-erased Actix application data for one registered aggregate. The
/// captured closure retains the concrete `web::Data<CommandBus<A>>` type so
/// Actix can later satisfy handlers requesting that exact bus.
pub(crate) struct BuiltAggregateRuntime {
    configure: Arc<AppDataFn>,
}

impl BuiltAggregateRuntime {
    fn new<A: Aggregate + 'static>(
        command_bus: CommandBus<A>,
        read_model_store: Arc<dyn arc_core::read_model_store::ReadModelStore>,
        projection_engine: Arc<ProjectionEngine>,
    ) -> Self {
        let command_bus_data = web::Data::new(command_bus);
        let read_model_store_data = web::Data::from(read_model_store);
        let projection_engine_data = web::Data::from(projection_engine);

        Self {
            configure: Arc::new(move |cfg| {
                cfg.app_data(command_bus_data.clone())
                    .app_data(read_model_store_data.clone())
                    .app_data(projection_engine_data.clone());
            }),
        }
    }

    fn configure(&self, cfg: &mut ServiceConfig) {
        (self.configure)(cfg);
    }
}

/// Build the typed runtime for one aggregate registration.
pub(crate) async fn build_aggregate_runtime<A: Aggregate + 'static>(
    projectors: Vec<ProjectorReg>,
    snapshot_policy: Option<SnapshotPolicy>,
) -> io::Result<BuiltAggregateRuntime> {
    let driver = DatabaseDriver::from_env();
    let db_url = crate::helpers::config::database_url();
    let stores = es_stack::build_stores(driver, &db_url)
        .await
        .map_err(|error| io::Error::other(format!("failed to initialize stores: {error}")))?;
    let read_model_store = stores.read_model_store.clone();

    let mut projection_engine = ProjectionEngine::new(stores.projection_event_store);
    for reg in projectors {
        projection_engine.register_projector(reg.projector, read_model_store.clone(), reg.view);
    }
    let projection_engine = Arc::new(projection_engine);

    let event_bus_mode = event_bus_mode();
    let mut event_bus = build_event_bus(&event_bus_mode).await;
    if event_bus_mode == EventBusMode::InProcess {
        event_bus
            .subscribe(Box::new(ProjectionEngineHandler::new(
                projection_engine.clone(),
            )))
            .await
            .map_err(|error| {
                io::Error::other(format!("failed to subscribe projection engine: {error}"))
            })?;

        if let Err(error) = projection_engine.rebuild_all().await {
            tracing::error!(
                aggregate_type = A::aggregate_type(),
                error = ?error,
                "ProjectionEngine.rebuild_all failed at startup"
            );
        } else {
            info!(
                aggregate_type = A::aggregate_type(),
                "Projections rebuilt from event store"
            );
        }
    } else {
        info!(
            aggregate_type = A::aggregate_type(),
            "EVENT_BUS=nats selected; Benthos owns durable projection and event-handler delivery"
        );
    }

    let command_bus = es_stack::apply_snapshot_policy(
        CommandBus::<A>::new(stores.command_event_store, event_bus),
        snapshot_policy,
    );

    Ok(BuiltAggregateRuntime::new(
        command_bus,
        read_model_store,
        projection_engine,
    ))
}

/// Starts the Actix-Web HTTP server with every registered aggregate.
pub(crate) async fn run(
    app_url: String,
    app_port: u16,
    registrations: Vec<AggregateRegistration>,
    routes: Arc<RoutesFn>,
) -> io::Result<()> {
    crate::check_database_health();

    let secret_key = Key::from(
        env::var("SECRET_KEY")
            .expect("SECRET_KEY must be set")
            .as_bytes(),
    );

    let app_env = env::var("APP_ENV").unwrap_or_else(|_| "development".to_string());
    let is_production = app_env == "production";

    let session_domain = env::var("SESSION_DOMAIN").ok();

    let same_site_str = env::var("SESSION_SAME_SITE").unwrap_or_else(|_| "Lax".to_string());
    let same_site = match same_site_str.as_str() {
        "Strict" => SameSite::Strict,
        "None" => SameSite::None,
        _ => SameSite::Lax,
    };

    info!(
        environment = app_env,
        secure = is_production,
        same_site = ?same_site,
        domain = ?session_domain,
        "Configuring session middleware"
    );

    if !is_production && app_url == "0.0.0.0" {
        warn!(
            "Running in development mode with 0.0.0.0 - sessions will work across network. \
            Ensure APP_ENV=production for production deployments!"
        );
    }

    let ws_server = WsServer::new().start();

    let login_rate_limiter = rate_limit::create_rate_limiter();
    let global_rate_limiter = rate_limit::create_global_rate_limiter();

    let driver = DatabaseDriver::from_env();
    info!(driver = driver.as_str(), "Selected database driver");

    let mut aggregate_runtimes = Vec::with_capacity(registrations.len());
    for registration in registrations {
        info!(
            aggregate_type = registration.aggregate_type,
            "Registering aggregate runtime"
        );
        aggregate_runtimes.push(
            (registration.build)(registration.projectors, registration.snapshot_policy).await?,
        );
    }
    let aggregate_runtimes = Arc::new(aggregate_runtimes);

    // Default to NoOpAccessLogger for non-regulated deployments. Production
    // PHI/PCI deployments swap this for a JetStream- or DB-backed sink.
    let access_logger: Arc<dyn AccessLogger> = Arc::new(NoOpAccessLogger);
    let access_logger_data = web::Data::from(access_logger);

    // Server-side JWT session registry. SQLite-only today; under a non-SQLite
    // primary driver it keeps its own local SQLite database.
    let session_db_url = crate::helpers::config::session_store_url(driver);
    if !driver.is_file_backed() {
        warn!(
            session_db_url = session_db_url,
            "JWT session registry is SQLite-backed; Postgres session store is not yet implemented"
        );
    }
    let session_store_impl = SqliteSessionStore::new(&session_db_url)
        .await
        .expect("Failed to init session store");
    let session_store: Arc<dyn SessionStore> = Arc::new(session_store_impl);
    let session_store_data = web::Data::from(session_store);

    HttpServer::new(move || {
        let mut session_middleware =
            SessionMiddleware::builder(CookieSessionStore::default(), secret_key.clone())
                .cookie_name("arc_session".to_string())
                .cookie_http_only(true)
                .cookie_same_site(same_site)
                .session_lifecycle(PersistentSession::default().session_ttl(Duration::hours(24)));

        if is_production {
            session_middleware = session_middleware.cookie_secure(true);
        } else {
            session_middleware = session_middleware.cookie_secure(false);
        }

        if let Some(ref domain) = session_domain {
            session_middleware = session_middleware.cookie_domain(Some(domain.clone()));
        }

        let routes = routes.clone();
        let aggregate_runtimes = aggregate_runtimes.clone();

        App::new()
            .wrap(tracing_actix_web::TracingLogger::default())
            .wrap(GlobalRateLimit)
            .wrap(Compress::default())
            .wrap(session_middleware.build())
            .wrap(NormalizePath::trim())
            .app_data(web::Data::new(global_rate_limiter.clone()))
            .app_data(web::Data::new(login_rate_limiter.clone()))
            .app_data(web::Data::new(AppState {
                app_name: Mutex::from(env::var("APP_NAME").unwrap_or_else(|_| "".to_string())),
            }))
            .app_data(access_logger_data.clone())
            .app_data(session_store_data.clone())
            .app_data(web::Data::new(ws_server.clone()))
            .configure(move |cfg| {
                for runtime in aggregate_runtimes.iter() {
                    runtime.configure(cfg);
                }
                routes.as_ref()(cfg);
            })
    })
    .bind((app_url, app_port))?
    .run()
    .await
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum EventBusMode {
    InProcess,
    Nats,
}

fn event_bus_mode() -> EventBusMode {
    let event_bus = env::var("EVENT_BUS")
        .unwrap_or_else(|_| "inprocess".to_string())
        .to_ascii_lowercase();

    match event_bus.as_str() {
        "inprocess" => EventBusMode::InProcess,
        "nats" => EventBusMode::Nats,
        other => {
            warn!(
                event_bus = other,
                "Unknown EVENT_BUS value; falling back to inprocess"
            );
            EventBusMode::InProcess
        }
    }
}

async fn build_event_bus(mode: &EventBusMode) -> Box<dyn EventBus> {
    match mode {
        EventBusMode::InProcess => Box::new(InProcessEventBus::new()),
        EventBusMode::Nats => build_nats_event_bus().await,
    }
}

#[cfg(feature = "nats")]
async fn build_nats_event_bus() -> Box<dyn EventBus> {
    let nats_url = env::var("NATS_URL").unwrap_or_else(|_| "nats://127.0.0.1:4222".to_string());
    let nats_stream = env::var("NATS_STREAM").unwrap_or_else(|_| "EVENTS".to_string());
    let async_bus = Arc::new(
        NatsEventBus::new(&nats_url, &nats_stream)
            .await
            .expect("Failed to initialize NATS event bus"),
    );

    info!(
        nats_url = nats_url,
        nats_stream = nats_stream,
        "Using NATS JetStream event bus"
    );

    Box::new(TwoLaneEventBus::with_async_bus(async_bus))
}

#[cfg(not(feature = "nats"))]
async fn build_nats_event_bus() -> Box<dyn EventBus> {
    warn!("EVENT_BUS=nats requested without the nats cargo feature; falling back to inprocess");
    Box::new(InProcessEventBus::new())
}

#[cfg(test)]
mod tests {
    use super::*;
    use actix_web::{post, test, App, HttpResponse};
    use arc_core::aggregate::{Aggregate, Command};
    use arc_core::command_bus::CommandContext;
    use arc_core::event::Event;
    use arc_core::event_store::{EventStore, InMemoryEventStore};
    use arc_core::projection::{ProjectionError, ProjectionResult, Projector};
    use arc_core::read_model_store::{InMemoryReadModelStore, ReadModelStore, Upsert};
    use async_trait::async_trait;
    use serde_json::json;
    use thiserror::Error;

    #[derive(Debug, Error)]
    #[error("command failed")]
    struct AggregateError;

    macro_rules! aggregate {
        ($aggregate:ident, $command:ident, $aggregate_type:literal, $event_type:literal) => {
            #[derive(Default)]
            struct $aggregate {
                version: i64,
            }

            struct $command {
                id: String,
            }

            impl Command for $command {
                fn aggregate_id(&self) -> &str {
                    &self.id
                }
            }

            #[async_trait]
            impl Aggregate for $aggregate {
                type Command = $command;
                type Event = ();
                type Error = AggregateError;

                fn aggregate_type() -> &'static str {
                    $aggregate_type
                }

                fn version(&self) -> i64 {
                    self.version
                }

                async fn handle(&self, command: Self::Command) -> Result<Vec<Event>, Self::Error> {
                    Ok(vec![Event::new(
                        Self::aggregate_type(),
                        command.id,
                        self.version + 1,
                        $event_type,
                        json!({}),
                    )])
                }

                fn apply(&mut self, event: &Event) {
                    self.version = event.sequence;
                }
            }
        };
    }

    aggregate!(ProductAggregate, CreateProduct, "Product", "ProductCreated");
    aggregate!(OrderAggregate, PlaceOrder, "Order", "OrderPlaced");

    struct RecordingProjector {
        event_type: &'static str,
        table: &'static str,
    }

    #[async_trait]
    impl Projector for RecordingProjector {
        fn name(&self) -> &str {
            self.table
        }

        fn handles(&self) -> Vec<String> {
            vec![self.event_type.to_string()]
        }

        async fn apply(&self, event: &Event, store: &dyn ReadModelStore) -> ProjectionResult<()> {
            store
                .upsert(Upsert::new(
                    self.table,
                    &event.aggregate_id,
                    json!({
                        "id": event.aggregate_id.clone(),
                        "version": event.sequence,
                    }),
                ))
                .await
                .map_err(|error| ProjectionError::other(error.to_string()))
        }
    }

    async fn runtime<A: Aggregate + 'static>(
        event_store: InMemoryEventStore,
        read_model_store: Arc<InMemoryReadModelStore>,
        event_type: &'static str,
        table: &'static str,
    ) -> BuiltAggregateRuntime {
        let mut engine = ProjectionEngine::new(Box::new(event_store.clone()));
        engine.register_projector(
            Box::new(RecordingProjector { event_type, table }),
            read_model_store.clone(),
            table,
        );
        let engine = Arc::new(engine);
        let mut bus = InProcessEventBus::new();
        bus.subscribe(Box::new(ProjectionEngineHandler::new(engine.clone())))
            .await
            .unwrap();
        let command_bus = CommandBus::<A>::new(Box::new(event_store), Box::new(bus));
        BuiltAggregateRuntime::new(command_bus, read_model_store, engine)
    }

    #[post("/products")]
    async fn create_product(bus: web::Data<CommandBus<ProductAggregate>>) -> HttpResponse {
        bus.dispatch(
            CreateProduct {
                id: "shared-id".to_string(),
            },
            CommandContext::for_actor("test"),
        )
        .await
        .unwrap();
        HttpResponse::Created().finish()
    }

    #[post("/orders")]
    async fn place_order(bus: web::Data<CommandBus<OrderAggregate>>) -> HttpResponse {
        bus.dispatch(
            PlaceOrder {
                id: "shared-id".to_string(),
            },
            CommandContext::for_actor("test"),
        )
        .await
        .unwrap();
        HttpResponse::Created().finish()
    }

    #[actix_web::test]
    async fn injects_two_typed_command_buses_and_keeps_streams_separate() {
        let event_store = InMemoryEventStore::new();
        let read_model_store = Arc::new(InMemoryReadModelStore::new());
        let products = runtime::<ProductAggregate>(
            event_store.clone(),
            read_model_store.clone(),
            "ProductCreated",
            "products_view",
        )
        .await;
        let orders = runtime::<OrderAggregate>(
            event_store.clone(),
            read_model_store.clone(),
            "OrderPlaced",
            "orders_view",
        )
        .await;

        let app = test::init_service(App::new().configure(move |cfg| {
            products.configure(cfg);
            orders.configure(cfg);
            cfg.service(create_product).service(place_order);
        }))
        .await;

        let product_response = test::call_service(
            &app,
            test::TestRequest::post().uri("/products").to_request(),
        )
        .await;
        let order_response =
            test::call_service(&app, test::TestRequest::post().uri("/orders").to_request()).await;
        assert!(product_response.status().is_success());
        assert!(order_response.status().is_success());

        assert_eq!(
            event_store
                .load_stream("Product", "shared-id")
                .await
                .unwrap()
                .len(),
            1
        );
        assert_eq!(
            event_store
                .load_stream("Order", "shared-id")
                .await
                .unwrap()
                .len(),
            1
        );
        assert!(read_model_store
            .get("products_view", "shared-id")
            .await
            .unwrap()
            .is_some());
        assert!(read_model_store
            .get("orders_view", "shared-id")
            .await
            .unwrap()
            .is_some());
    }
}