a3s-boot 0.1.3

Adapter-first modular Rust web framework for A3S inspired by Nest.js
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
use crate::{
    BootApplication, BootError, HttpMethod, MessagePatternKind, OpenApiRouteMetadata,
    ProviderToken, Result, RouteVersioning, SerializationOptions,
};
use serde::de::DeserializeOwned;
use serde_json::Value;
use std::collections::BTreeMap;

/// Snapshot of a registered module and its local providers.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DiscoveredModule {
    pub name: String,
    pub provider_tokens: Vec<ProviderToken>,
}

/// Snapshot of a resolved HTTP route.
#[derive(Debug, Clone, PartialEq)]
pub struct DiscoveredRoute {
    pub method: HttpMethod,
    pub path: String,
    pub path_shape: String,
    pub path_params: Vec<String>,
    pub module_name: Option<String>,
    pub controller_prefix: Option<String>,
    pub openapi: OpenApiRouteMetadata,
    pub versioning: RouteVersioning,
    pub serialization: SerializationOptions,
    pub metadata: BTreeMap<String, Value>,
    pub validation_enabled: bool,
}

/// Snapshot of a resolved WebSocket gateway.
#[derive(Debug, Clone, PartialEq)]
pub struct DiscoveredGateway {
    pub path: String,
    pub path_shape: String,
    pub namespace: Option<String>,
    pub module_name: Option<String>,
    pub events: Vec<String>,
    pub metadata: BTreeMap<String, Value>,
    pub event_metadata: BTreeMap<String, BTreeMap<String, Value>>,
}

/// Snapshot of a resolved microservice message pattern.
#[derive(Debug, Clone, PartialEq)]
pub struct DiscoveredMessagePattern {
    pub pattern: String,
    pub kind: MessagePatternKind,
    pub module_name: Option<String>,
    pub metadata: BTreeMap<String, Value>,
}

/// Read-only module graph snapshot for diagnostics and Nest-style devtools.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ApplicationGraph {
    pub modules: Vec<ApplicationGraphModule>,
}

impl ApplicationGraph {
    pub fn module(&self, name: &str) -> Option<&ApplicationGraphModule> {
        self.modules.iter().find(|module| module.name == name)
    }

    pub fn imports_of(&self, name: &str) -> Vec<&ApplicationGraphModule> {
        let Some(module) = self.module(name) else {
            return Vec::new();
        };

        module
            .imports
            .iter()
            .filter_map(|import| self.module(import))
            .collect()
    }

    pub fn dependents_of(&self, name: &str) -> Vec<&ApplicationGraphModule> {
        self.modules
            .iter()
            .filter(|module| module.imports.iter().any(|import| import == name))
            .collect()
    }
}

/// One module node in an [`ApplicationGraph`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ApplicationGraphModule {
    pub name: String,
    pub imports: Vec<String>,
    pub provider_tokens: Vec<ProviderToken>,
    pub export_tokens: Vec<ProviderToken>,
    pub is_global: bool,
    pub route_prefix: Option<String>,
    pub route_count: usize,
    pub gateway_count: usize,
    pub message_pattern_count: usize,
}

/// Read-only discovery snapshot for a built Boot application.
#[derive(Debug, Clone, PartialEq)]
pub struct DiscoveryService {
    modules: Vec<DiscoveredModule>,
    routes: Vec<DiscoveredRoute>,
    gateways: Vec<DiscoveredGateway>,
    message_patterns: Vec<DiscoveredMessagePattern>,
    graph: ApplicationGraph,
}

impl DiscoveryService {
    pub fn from_app(app: &BootApplication) -> Result<Self> {
        let modules = discover_modules(app)?;
        let routes = discover_routes(app);
        let gateways = discover_gateways(app);
        let message_patterns = discover_message_patterns(app);
        let graph = discover_application_graph(app, &routes, &gateways, &message_patterns)?;

        Ok(Self {
            modules,
            routes,
            gateways,
            message_patterns,
            graph,
        })
    }

    pub fn modules(&self) -> &[DiscoveredModule] {
        &self.modules
    }

    pub fn routes(&self) -> &[DiscoveredRoute] {
        &self.routes
    }

    pub fn gateways(&self) -> &[DiscoveredGateway] {
        &self.gateways
    }

    pub fn message_patterns(&self) -> &[DiscoveredMessagePattern] {
        &self.message_patterns
    }

    pub fn graph(&self) -> &ApplicationGraph {
        &self.graph
    }

    pub fn module(&self, name: &str) -> Option<&DiscoveredModule> {
        self.modules.iter().find(|module| module.name == name)
    }

    pub fn modules_with_provider(&self, token: &ProviderToken) -> Vec<&DiscoveredModule> {
        self.modules
            .iter()
            .filter(|module| module.provider_tokens.contains(token))
            .collect()
    }

    pub fn routes_for_module(&self, module_name: &str) -> Vec<&DiscoveredRoute> {
        self.routes
            .iter()
            .filter(|route| route.module_name.as_deref() == Some(module_name))
            .collect()
    }

    pub fn routes_for_controller(&self, controller_prefix: &str) -> Vec<&DiscoveredRoute> {
        self.routes
            .iter()
            .filter(|route| route.controller_prefix.as_deref() == Some(controller_prefix))
            .collect()
    }

    pub fn gateways_for_module(&self, module_name: &str) -> Vec<&DiscoveredGateway> {
        self.gateways
            .iter()
            .filter(|gateway| gateway.module_name.as_deref() == Some(module_name))
            .collect()
    }

    pub fn message_patterns_for_module(&self, module_name: &str) -> Vec<&DiscoveredMessagePattern> {
        self.message_patterns
            .iter()
            .filter(|pattern| pattern.module_name.as_deref() == Some(module_name))
            .collect()
    }

    pub fn gateway(&self, path: &str) -> Option<&DiscoveredGateway> {
        self.gateways.iter().find(|gateway| gateway.path == path)
    }

    pub fn message_pattern(&self, pattern: &str) -> Option<&DiscoveredMessagePattern> {
        self.message_patterns
            .iter()
            .find(|message_pattern| message_pattern.pattern == pattern)
    }

    pub fn reflector(&self) -> Reflector {
        Reflector::new(self.clone())
    }
}

/// Metadata lookup helper over a discovery snapshot.
#[derive(Debug, Clone, PartialEq)]
pub struct Reflector {
    discovery: DiscoveryService,
}

impl Reflector {
    pub fn new(discovery: DiscoveryService) -> Self {
        Self { discovery }
    }

    pub fn from_app(app: &BootApplication) -> Result<Self> {
        Ok(Self::new(DiscoveryService::from_app(app)?))
    }

    pub fn discovery(&self) -> &DiscoveryService {
        &self.discovery
    }

    pub fn route(&self, method: HttpMethod, path: &str) -> Option<&DiscoveredRoute> {
        self.discovery
            .routes
            .iter()
            .find(|route| route.method == method && route.path == path)
    }

    pub fn openapi(&self, method: HttpMethod, path: &str) -> Option<&OpenApiRouteMetadata> {
        self.route(method, path).map(|route| &route.openapi)
    }

    pub fn metadata(&self, method: HttpMethod, path: &str) -> Option<&BTreeMap<String, Value>> {
        self.route(method, path).map(|route| &route.metadata)
    }

    pub fn metadata_value(&self, method: HttpMethod, path: &str, key: &str) -> Option<&Value> {
        self.metadata(method, path)
            .and_then(|metadata| metadata.get(key))
    }

    pub fn metadata_as<T>(&self, method: HttpMethod, path: &str, key: &str) -> Result<Option<T>>
    where
        T: DeserializeOwned,
    {
        let Some(value) = self.metadata_value(method, path, key) else {
            return Ok(None);
        };

        serde_json::from_value(value.clone())
            .map(Some)
            .map_err(|error| {
                BootError::Internal(format!(
                    "failed to deserialize route metadata `{key}`: {error}"
                ))
            })
    }

    pub fn operation_id(&self, method: HttpMethod, path: &str) -> Option<&str> {
        self.openapi(method, path)
            .and_then(|metadata| metadata.operation_id.as_deref())
    }

    pub fn routes_with_tag(&self, tag: &str) -> Vec<&DiscoveredRoute> {
        self.discovery
            .routes
            .iter()
            .filter(|route| route.openapi.tags.iter().any(|value| value == tag))
            .collect()
    }

    pub fn routes_with_metadata(&self, key: &str) -> Vec<&DiscoveredRoute> {
        self.discovery
            .routes
            .iter()
            .filter(|route| route.metadata.contains_key(key))
            .collect()
    }

    pub fn routes_with_metadata_value(&self, key: &str, value: &Value) -> Vec<&DiscoveredRoute> {
        self.discovery
            .routes
            .iter()
            .filter(|route| route.metadata.get(key) == Some(value))
            .collect()
    }

    pub fn gateway(&self, path: &str) -> Option<&DiscoveredGateway> {
        self.discovery.gateway(path)
    }

    pub fn gateway_metadata(&self, path: &str) -> Option<&BTreeMap<String, Value>> {
        self.gateway(path).map(|gateway| &gateway.metadata)
    }

    pub fn gateway_metadata_value(&self, path: &str, key: &str) -> Option<&Value> {
        self.gateway_metadata(path)
            .and_then(|metadata| metadata.get(key))
    }

    pub fn gateway_metadata_as<T>(&self, path: &str, key: &str) -> Result<Option<T>>
    where
        T: DeserializeOwned,
    {
        let Some(value) = self.gateway_metadata_value(path, key) else {
            return Ok(None);
        };

        serde_json::from_value(value.clone())
            .map(Some)
            .map_err(|error| {
                BootError::Internal(format!(
                    "failed to deserialize websocket gateway metadata `{key}`: {error}"
                ))
            })
    }

    pub fn gateway_event_metadata(
        &self,
        path: &str,
        event: &str,
    ) -> Option<&BTreeMap<String, Value>> {
        self.gateway(path)
            .and_then(|gateway| gateway.event_metadata.get(event))
    }

    pub fn gateway_event_metadata_value(
        &self,
        path: &str,
        event: &str,
        key: &str,
    ) -> Option<&Value> {
        self.gateway_event_metadata(path, event)
            .and_then(|metadata| metadata.get(key))
    }

    pub fn gateway_event_metadata_as<T>(
        &self,
        path: &str,
        event: &str,
        key: &str,
    ) -> Result<Option<T>>
    where
        T: DeserializeOwned,
    {
        let Some(value) = self.gateway_event_metadata_value(path, event, key) else {
            return Ok(None);
        };

        serde_json::from_value(value.clone())
            .map(Some)
            .map_err(|error| {
                BootError::Internal(format!(
                    "failed to deserialize websocket event metadata `{key}`: {error}"
                ))
            })
    }

    pub fn message_pattern(&self, pattern: &str) -> Option<&DiscoveredMessagePattern> {
        self.discovery.message_pattern(pattern)
    }

    pub fn message_pattern_metadata(&self, pattern: &str) -> Option<&BTreeMap<String, Value>> {
        self.message_pattern(pattern)
            .map(|message_pattern| &message_pattern.metadata)
    }

    pub fn message_pattern_metadata_value(&self, pattern: &str, key: &str) -> Option<&Value> {
        self.message_pattern_metadata(pattern)
            .and_then(|metadata| metadata.get(key))
    }

    pub fn message_pattern_metadata_as<T>(&self, pattern: &str, key: &str) -> Result<Option<T>>
    where
        T: DeserializeOwned,
    {
        let Some(value) = self.message_pattern_metadata_value(pattern, key) else {
            return Ok(None);
        };

        serde_json::from_value(value.clone())
            .map(Some)
            .map_err(|error| {
                BootError::Internal(format!(
                    "failed to deserialize message pattern metadata `{key}`: {error}"
                ))
            })
    }

    pub fn routes_for_module(&self, module_name: &str) -> Vec<&DiscoveredRoute> {
        self.discovery.routes_for_module(module_name)
    }

    pub fn routes_for_controller(&self, controller_prefix: &str) -> Vec<&DiscoveredRoute> {
        self.discovery.routes_for_controller(controller_prefix)
    }
}

fn discover_modules(app: &BootApplication) -> Result<Vec<DiscoveredModule>> {
    app.module_instances
        .iter()
        .map(|instance| {
            Ok(DiscoveredModule {
                name: instance.module.name().to_string(),
                provider_tokens: instance.module_ref.local_tokens()?,
            })
        })
        .collect()
}

fn discover_application_graph(
    app: &BootApplication,
    routes: &[DiscoveredRoute],
    gateways: &[DiscoveredGateway],
    message_patterns: &[DiscoveredMessagePattern],
) -> Result<ApplicationGraph> {
    let mut modules = Vec::new();

    for instance in &app.module_instances {
        let name = instance.module.name().to_string();
        let route_count = routes
            .iter()
            .filter(|route| route.module_name.as_deref() == Some(name.as_str()))
            .count();
        let gateway_count = gateways
            .iter()
            .filter(|gateway| gateway.module_name.as_deref() == Some(name.as_str()))
            .count();
        let message_pattern_count = message_patterns
            .iter()
            .filter(|pattern| pattern.module_name.as_deref() == Some(name.as_str()))
            .count();

        modules.push(ApplicationGraphModule {
            name,
            imports: instance.imports.clone(),
            provider_tokens: instance.module_ref.local_tokens()?,
            export_tokens: instance.exports.clone(),
            is_global: instance.is_global,
            route_prefix: instance.route_prefix.clone(),
            route_count,
            gateway_count,
            message_pattern_count,
        });
    }

    Ok(ApplicationGraph { modules })
}

fn discover_routes(app: &BootApplication) -> Vec<DiscoveredRoute> {
    app.routes()
        .iter()
        .map(|route| DiscoveredRoute {
            method: route.method(),
            path: route.path().to_string(),
            path_shape: route.path_shape(),
            path_params: route
                .path_param_names()
                .into_iter()
                .map(str::to_string)
                .collect(),
            module_name: route.module_name().map(str::to_string),
            controller_prefix: route.controller_prefix().map(str::to_string),
            openapi: route.openapi().clone(),
            versioning: route.versioning().clone(),
            serialization: route.serialization().clone(),
            metadata: route.metadata().clone(),
            validation_enabled: route.validation_enabled(),
        })
        .collect()
}

fn discover_gateways(app: &BootApplication) -> Vec<DiscoveredGateway> {
    app.gateways()
        .iter()
        .map(|gateway| DiscoveredGateway {
            path: gateway.path().to_string(),
            path_shape: gateway.path_shape(),
            namespace: gateway.namespace().map(str::to_string),
            module_name: gateway.module_name().map(str::to_string),
            events: gateway.events().into_iter().map(str::to_string).collect(),
            metadata: gateway.metadata().clone(),
            event_metadata: gateway
                .events()
                .into_iter()
                .filter_map(|event| {
                    gateway
                        .event_metadata(event)
                        .map(|metadata| (event.to_string(), metadata.clone()))
                })
                .collect(),
        })
        .collect()
}

fn discover_message_patterns(app: &BootApplication) -> Vec<DiscoveredMessagePattern> {
    app.message_patterns()
        .iter()
        .map(|pattern| DiscoveredMessagePattern {
            pattern: pattern.pattern().to_string(),
            kind: pattern.kind(),
            module_name: pattern.module_name().map(str::to_string),
            metadata: pattern.metadata().clone(),
        })
        .collect()
}