spikard 0.5.0 → 0.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +674 -674
- data/ext/spikard_rb/Cargo.toml +17 -17
- data/ext/spikard_rb/extconf.rb +13 -10
- data/ext/spikard_rb/src/lib.rs +6 -6
- data/lib/spikard/app.rb +405 -405
- data/lib/spikard/background.rb +27 -27
- data/lib/spikard/config.rb +396 -396
- data/lib/spikard/converters.rb +13 -13
- data/lib/spikard/handler_wrapper.rb +113 -113
- data/lib/spikard/provide.rb +214 -214
- data/lib/spikard/response.rb +173 -173
- data/lib/spikard/schema.rb +243 -243
- data/lib/spikard/sse.rb +111 -111
- data/lib/spikard/streaming_response.rb +44 -44
- data/lib/spikard/testing.rb +256 -256
- data/lib/spikard/upload_file.rb +131 -131
- data/lib/spikard/version.rb +5 -5
- data/lib/spikard/websocket.rb +59 -59
- data/lib/spikard.rb +43 -43
- data/sig/spikard.rbs +366 -366
- data/vendor/crates/spikard-bindings-shared/Cargo.toml +63 -63
- data/vendor/crates/spikard-bindings-shared/examples/config_extraction.rs +132 -132
- data/vendor/crates/spikard-bindings-shared/src/config_extractor.rs +752 -752
- data/vendor/crates/spikard-bindings-shared/src/conversion_traits.rs +194 -194
- data/vendor/crates/spikard-bindings-shared/src/di_traits.rs +246 -246
- data/vendor/crates/spikard-bindings-shared/src/error_response.rs +401 -401
- data/vendor/crates/spikard-bindings-shared/src/handler_base.rs +238 -238
- data/vendor/crates/spikard-bindings-shared/src/lib.rs +24 -24
- data/vendor/crates/spikard-bindings-shared/src/lifecycle_base.rs +292 -292
- data/vendor/crates/spikard-bindings-shared/src/lifecycle_executor.rs +616 -616
- data/vendor/crates/spikard-bindings-shared/src/response_builder.rs +305 -305
- data/vendor/crates/spikard-bindings-shared/src/test_client_base.rs +248 -248
- data/vendor/crates/spikard-bindings-shared/src/validation_helpers.rs +351 -351
- data/vendor/crates/spikard-bindings-shared/tests/comprehensive_coverage.rs +454 -454
- data/vendor/crates/spikard-bindings-shared/tests/error_response_edge_cases.rs +383 -383
- data/vendor/crates/spikard-bindings-shared/tests/handler_base_integration.rs +280 -280
- data/vendor/crates/spikard-core/Cargo.toml +40 -40
- data/vendor/crates/spikard-core/src/bindings/mod.rs +3 -3
- data/vendor/crates/spikard-core/src/bindings/response.rs +133 -133
- data/vendor/crates/spikard-core/src/debug.rs +127 -127
- data/vendor/crates/spikard-core/src/di/container.rs +702 -702
- data/vendor/crates/spikard-core/src/di/dependency.rs +273 -273
- data/vendor/crates/spikard-core/src/di/error.rs +118 -118
- data/vendor/crates/spikard-core/src/di/factory.rs +534 -534
- data/vendor/crates/spikard-core/src/di/graph.rs +506 -506
- data/vendor/crates/spikard-core/src/di/mod.rs +192 -192
- data/vendor/crates/spikard-core/src/di/resolved.rs +405 -405
- data/vendor/crates/spikard-core/src/di/value.rs +281 -281
- data/vendor/crates/spikard-core/src/errors.rs +69 -69
- data/vendor/crates/spikard-core/src/http.rs +415 -415
- data/vendor/crates/spikard-core/src/lib.rs +29 -29
- data/vendor/crates/spikard-core/src/lifecycle.rs +1186 -1186
- data/vendor/crates/spikard-core/src/metadata.rs +389 -389
- data/vendor/crates/spikard-core/src/parameters.rs +2525 -2525
- data/vendor/crates/spikard-core/src/problem.rs +344 -344
- data/vendor/crates/spikard-core/src/request_data.rs +1154 -1154
- data/vendor/crates/spikard-core/src/router.rs +510 -510
- data/vendor/crates/spikard-core/src/schema_registry.rs +183 -183
- data/vendor/crates/spikard-core/src/type_hints.rs +304 -304
- data/vendor/crates/spikard-core/src/validation/error_mapper.rs +696 -688
- data/vendor/crates/spikard-core/src/validation/mod.rs +457 -457
- data/vendor/crates/spikard-http/Cargo.toml +62 -64
- data/vendor/crates/spikard-http/examples/sse-notifications.rs +148 -148
- data/vendor/crates/spikard-http/examples/websocket-chat.rs +92 -92
- data/vendor/crates/spikard-http/src/auth.rs +296 -296
- data/vendor/crates/spikard-http/src/background.rs +1860 -1860
- data/vendor/crates/spikard-http/src/bindings/mod.rs +3 -3
- data/vendor/crates/spikard-http/src/bindings/response.rs +1 -1
- data/vendor/crates/spikard-http/src/body_metadata.rs +8 -8
- data/vendor/crates/spikard-http/src/cors.rs +1005 -1005
- data/vendor/crates/spikard-http/src/debug.rs +128 -128
- data/vendor/crates/spikard-http/src/di_handler.rs +1668 -1668
- data/vendor/crates/spikard-http/src/handler_response.rs +901 -901
- data/vendor/crates/spikard-http/src/handler_trait.rs +838 -830
- data/vendor/crates/spikard-http/src/handler_trait_tests.rs +290 -290
- data/vendor/crates/spikard-http/src/lib.rs +534 -534
- data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +230 -230
- data/vendor/crates/spikard-http/src/lifecycle.rs +1193 -1193
- data/vendor/crates/spikard-http/src/middleware/mod.rs +560 -540
- data/vendor/crates/spikard-http/src/middleware/multipart.rs +912 -912
- data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +513 -513
- data/vendor/crates/spikard-http/src/middleware/validation.rs +768 -735
- data/vendor/crates/spikard-http/src/openapi/mod.rs +309 -309
- data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +535 -535
- data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +1363 -1363
- data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +665 -665
- data/vendor/crates/spikard-http/src/query_parser.rs +793 -793
- data/vendor/crates/spikard-http/src/response.rs +720 -720
- data/vendor/crates/spikard-http/src/server/handler.rs +1650 -1650
- data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +234 -234
- data/vendor/crates/spikard-http/src/server/mod.rs +1593 -1502
- data/vendor/crates/spikard-http/src/server/request_extraction.rs +789 -770
- data/vendor/crates/spikard-http/src/server/routing_factory.rs +629 -599
- data/vendor/crates/spikard-http/src/sse.rs +1409 -1409
- data/vendor/crates/spikard-http/src/testing/form.rs +52 -52
- data/vendor/crates/spikard-http/src/testing/multipart.rs +64 -60
- data/vendor/crates/spikard-http/src/testing/test_client.rs +311 -283
- data/vendor/crates/spikard-http/src/testing.rs +406 -377
- data/vendor/crates/spikard-http/src/websocket.rs +1404 -1375
- data/vendor/crates/spikard-http/tests/background_behavior.rs +832 -832
- data/vendor/crates/spikard-http/tests/common/handlers.rs +309 -309
- data/vendor/crates/spikard-http/tests/common/mod.rs +26 -26
- data/vendor/crates/spikard-http/tests/di_integration.rs +192 -192
- data/vendor/crates/spikard-http/tests/doc_snippets.rs +5 -5
- data/vendor/crates/spikard-http/tests/lifecycle_execution.rs +1093 -1093
- data/vendor/crates/spikard-http/tests/multipart_behavior.rs +656 -656
- data/vendor/crates/spikard-http/tests/server_config_builder.rs +314 -314
- data/vendor/crates/spikard-http/tests/sse_behavior.rs +620 -620
- data/vendor/crates/spikard-http/tests/websocket_behavior.rs +663 -663
- data/vendor/crates/spikard-rb/Cargo.toml +48 -48
- data/vendor/crates/spikard-rb/build.rs +199 -199
- data/vendor/crates/spikard-rb/src/background.rs +63 -63
- data/vendor/crates/spikard-rb/src/config/mod.rs +5 -5
- data/vendor/crates/spikard-rb/src/config/server_config.rs +285 -285
- data/vendor/crates/spikard-rb/src/conversion.rs +554 -554
- data/vendor/crates/spikard-rb/src/di/builder.rs +100 -100
- data/vendor/crates/spikard-rb/src/di/mod.rs +375 -375
- data/vendor/crates/spikard-rb/src/handler.rs +618 -618
- data/vendor/crates/spikard-rb/src/integration/mod.rs +3 -3
- data/vendor/crates/spikard-rb/src/lib.rs +1806 -1810
- data/vendor/crates/spikard-rb/src/lifecycle.rs +275 -275
- data/vendor/crates/spikard-rb/src/metadata/mod.rs +5 -5
- data/vendor/crates/spikard-rb/src/metadata/route_extraction.rs +442 -447
- data/vendor/crates/spikard-rb/src/runtime/mod.rs +5 -5
- data/vendor/crates/spikard-rb/src/runtime/server_runner.rs +324 -324
- data/vendor/crates/spikard-rb/src/server.rs +305 -308
- data/vendor/crates/spikard-rb/src/sse.rs +231 -231
- data/vendor/crates/spikard-rb/src/testing/client.rs +538 -551
- data/vendor/crates/spikard-rb/src/testing/mod.rs +7 -7
- data/vendor/crates/spikard-rb/src/testing/sse.rs +143 -143
- data/vendor/crates/spikard-rb/src/testing/websocket.rs +608 -635
- data/vendor/crates/spikard-rb/src/websocket.rs +377 -374
- metadata +15 -1
|
@@ -1,64 +1,62 @@
|
|
|
1
|
-
[package]
|
|
2
|
-
name = "spikard-http"
|
|
3
|
-
version = "0.
|
|
4
|
-
edition = "2024"
|
|
5
|
-
authors = ["Na'aman Hirschfeld <nhirschfeld@gmail.com>"]
|
|
6
|
-
license = "MIT"
|
|
7
|
-
repository = "https://github.com/Goldziher/spikard"
|
|
8
|
-
homepage = "https://github.com/Goldziher/spikard"
|
|
9
|
-
description = "High-performance HTTP server for Spikard with tower-http middleware stack"
|
|
10
|
-
keywords = ["http", "server", "axum", "tower", "middleware"]
|
|
11
|
-
categories = ["web-programming::http-server", "web-programming"]
|
|
12
|
-
documentation = "https://docs.rs/spikard-http"
|
|
13
|
-
readme = "README.md"
|
|
14
|
-
|
|
15
|
-
[dependencies]
|
|
16
|
-
axum = { version = "0.8", features = ["multipart", "ws"]
|
|
17
|
-
tokio = { version = "1", features = ["full"] }
|
|
18
|
-
tokio-util = "0.7"
|
|
19
|
-
tower = "0.5"
|
|
20
|
-
tower-http = { version = "0.6.8", features = ["
|
|
21
|
-
tower_governor = "0.
|
|
22
|
-
jsonwebtoken =
|
|
23
|
-
utoipa =
|
|
24
|
-
utoipa-swagger-ui = { version = "
|
|
25
|
-
utoipa-redoc = { version = "
|
|
26
|
-
serde = { version = "1.0", features = ["derive"] }
|
|
27
|
-
serde_json = "1.0"
|
|
28
|
-
tracing = "0.1"
|
|
29
|
-
tracing-subscriber =
|
|
30
|
-
spikard-core = { path = "../spikard-core" }
|
|
31
|
-
futures-util = "0.3"
|
|
32
|
-
futures = "0.3"
|
|
33
|
-
jsonschema = { version = "0.37", default-features = false }
|
|
34
|
-
serde_qs = "0.15"
|
|
35
|
-
lazy_static = "1.5"
|
|
36
|
-
lru = "0.16"
|
|
37
|
-
regex = "1"
|
|
38
|
-
rustc-hash = "2.1"
|
|
39
|
-
urlencoding = "2.1"
|
|
40
|
-
url = "2.5"
|
|
41
|
-
mime = "0.3"
|
|
42
|
-
jiff = "0.2"
|
|
43
|
-
uuid = "1.19"
|
|
44
|
-
bytes = "1.11"
|
|
45
|
-
http-body-util = "0.1"
|
|
46
|
-
http-body = "1.0"
|
|
47
|
-
axum-test = { version = "18", features = ["ws"] }
|
|
48
|
-
anyhow = "1.0"
|
|
49
|
-
cookie = "0.18"
|
|
50
|
-
base64 = "0.22.1"
|
|
51
|
-
flate2 = { version = "=1.1.5", default-features = false, features = ["rust_backend"] }
|
|
52
|
-
brotli = "8.0"
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
[
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
doc-comment = "0.3"
|
|
64
|
-
tempfile = "3.23"
|
|
1
|
+
[package]
|
|
2
|
+
name = "spikard-http"
|
|
3
|
+
version = "0.6.1"
|
|
4
|
+
edition = "2024"
|
|
5
|
+
authors = ["Na'aman Hirschfeld <nhirschfeld@gmail.com>"]
|
|
6
|
+
license = "MIT"
|
|
7
|
+
repository = "https://github.com/Goldziher/spikard"
|
|
8
|
+
homepage = "https://github.com/Goldziher/spikard"
|
|
9
|
+
description = "High-performance HTTP server for Spikard with tower-http middleware stack"
|
|
10
|
+
keywords = ["http", "server", "axum", "tower", "middleware"]
|
|
11
|
+
categories = ["web-programming::http-server", "web-programming"]
|
|
12
|
+
documentation = "https://docs.rs/spikard-http"
|
|
13
|
+
readme = "README.md"
|
|
14
|
+
|
|
15
|
+
[dependencies]
|
|
16
|
+
axum = { version = "0.8", features = ["multipart", "ws"] }
|
|
17
|
+
tokio = { version = "1", features = ["full"] }
|
|
18
|
+
tokio-util = "0.7"
|
|
19
|
+
tower = "0.5"
|
|
20
|
+
tower-http = { version = "0.6.8", features = ["fs", "trace", "compression-gzip", "compression-br", "compression-deflate", "cors", "request-id", "limit", "timeout"] }
|
|
21
|
+
tower_governor = "0.5"
|
|
22
|
+
jsonwebtoken = "9.3"
|
|
23
|
+
utoipa = "5.3"
|
|
24
|
+
utoipa-swagger-ui = { version = "8.0", features = ["axum"] }
|
|
25
|
+
utoipa-redoc = { version = "5.0", features = ["axum"] }
|
|
26
|
+
serde = { version = "1.0", features = ["derive"] }
|
|
27
|
+
serde_json = "1.0"
|
|
28
|
+
tracing = "0.1"
|
|
29
|
+
tracing-subscriber = "0.3"
|
|
30
|
+
spikard-core = { path = "../spikard-core" }
|
|
31
|
+
futures-util = "0.3"
|
|
32
|
+
futures = "0.3"
|
|
33
|
+
jsonschema = { version = "0.37", default-features = false }
|
|
34
|
+
serde_qs = "0.15"
|
|
35
|
+
lazy_static = "1.5"
|
|
36
|
+
lru = "0.16"
|
|
37
|
+
regex = "1"
|
|
38
|
+
rustc-hash = "2.1"
|
|
39
|
+
urlencoding = "2.1"
|
|
40
|
+
url = "2.5"
|
|
41
|
+
mime = "0.3"
|
|
42
|
+
jiff = "0.2"
|
|
43
|
+
uuid = "1.19"
|
|
44
|
+
bytes = "1.11"
|
|
45
|
+
http-body-util = "0.1"
|
|
46
|
+
http-body = "1.0"
|
|
47
|
+
axum-test = { version = "18", features = ["ws"] }
|
|
48
|
+
anyhow = "1.0"
|
|
49
|
+
cookie = "0.18"
|
|
50
|
+
base64 = "0.22.1"
|
|
51
|
+
flate2 = { version = "=1.1.5", default-features = false, features = ["rust_backend"] }
|
|
52
|
+
brotli = "8.0"
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
[features]
|
|
56
|
+
default = []
|
|
57
|
+
di = ["spikard-core/di"]
|
|
58
|
+
|
|
59
|
+
[dev-dependencies]
|
|
60
|
+
chrono = "0.4"
|
|
61
|
+
doc-comment = "0.3"
|
|
62
|
+
tempfile = "3.24"
|
|
@@ -1,148 +1,148 @@
|
|
|
1
|
-
#![allow(clippy::pedantic, clippy::nursery, clippy::all)]
|
|
2
|
-
//! SSE Notifications Server Example
|
|
3
|
-
//!
|
|
4
|
-
//! Demonstrates Server-Sent Events support in Spikard matching the AsyncAPI notifications specification.
|
|
5
|
-
|
|
6
|
-
use axum::{Router, routing::get};
|
|
7
|
-
use chrono::Utc;
|
|
8
|
-
use serde::Serialize;
|
|
9
|
-
use serde_json::json;
|
|
10
|
-
use spikard_http::{SseEvent, SseEventProducer, SseState, sse_handler};
|
|
11
|
-
use std::sync::atomic::{AtomicUsize, Ordering};
|
|
12
|
-
use tokio::time::{Duration, sleep};
|
|
13
|
-
use tracing::info;
|
|
14
|
-
|
|
15
|
-
/// Notification event types matching AsyncAPI specification
|
|
16
|
-
#[derive(Debug, Clone, Serialize)]
|
|
17
|
-
#[serde(tag = "type")]
|
|
18
|
-
#[allow(clippy::enum_variant_names)]
|
|
19
|
-
enum Notification {
|
|
20
|
-
#[serde(rename = "system_alert")]
|
|
21
|
-
SystemAlert {
|
|
22
|
-
level: String,
|
|
23
|
-
message: String,
|
|
24
|
-
source: String,
|
|
25
|
-
timestamp: String,
|
|
26
|
-
},
|
|
27
|
-
#[serde(rename = "user_notification")]
|
|
28
|
-
UserNotification {
|
|
29
|
-
#[serde(rename = "userId")]
|
|
30
|
-
user_id: String,
|
|
31
|
-
title: String,
|
|
32
|
-
body: String,
|
|
33
|
-
priority: String,
|
|
34
|
-
timestamp: String,
|
|
35
|
-
},
|
|
36
|
-
#[serde(rename = "status_update")]
|
|
37
|
-
StatusUpdate {
|
|
38
|
-
service: String,
|
|
39
|
-
status: String,
|
|
40
|
-
message: Option<String>,
|
|
41
|
-
metadata: serde_json::Value,
|
|
42
|
-
timestamp: String,
|
|
43
|
-
},
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
/// Notification producer implementing SseEventProducer trait
|
|
47
|
-
struct NotificationProducer {
|
|
48
|
-
counter: AtomicUsize,
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
impl NotificationProducer {
|
|
52
|
-
fn new() -> Self {
|
|
53
|
-
Self {
|
|
54
|
-
counter: AtomicUsize::new(0),
|
|
55
|
-
}
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
fn create_notification(&self, index: usize) -> Notification {
|
|
59
|
-
let timestamp = Utc::now().to_rfc3339();
|
|
60
|
-
|
|
61
|
-
match index % 3 {
|
|
62
|
-
0 => Notification::SystemAlert {
|
|
63
|
-
level: "info".to_string(),
|
|
64
|
-
message: format!("System checkpoint {} reached", index),
|
|
65
|
-
source: "monitoring-system".to_string(),
|
|
66
|
-
timestamp,
|
|
67
|
-
},
|
|
68
|
-
1 => Notification::UserNotification {
|
|
69
|
-
user_id: format!("user_{}", index),
|
|
70
|
-
title: "New Update Available".to_string(),
|
|
71
|
-
body: format!("Version 1.{} is now available for download", index),
|
|
72
|
-
priority: "normal".to_string(),
|
|
73
|
-
timestamp,
|
|
74
|
-
},
|
|
75
|
-
_ => Notification::StatusUpdate {
|
|
76
|
-
service: "api-gateway".to_string(),
|
|
77
|
-
status: "operational".to_string(),
|
|
78
|
-
message: Some(format!("Health check {} passed", index)),
|
|
79
|
-
metadata: json!({
|
|
80
|
-
"response_time_ms": 50 + (index % 100),
|
|
81
|
-
"active_connections": 100 + (index % 50)
|
|
82
|
-
}),
|
|
83
|
-
timestamp,
|
|
84
|
-
},
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
impl SseEventProducer for NotificationProducer {
|
|
90
|
-
async fn next_event(&self) -> Option<SseEvent> {
|
|
91
|
-
sleep(Duration::from_secs(2)).await;
|
|
92
|
-
|
|
93
|
-
let count = self.counter.fetch_add(1, Ordering::Relaxed);
|
|
94
|
-
|
|
95
|
-
if count >= 10 {
|
|
96
|
-
info!("Completed sending 10 notifications");
|
|
97
|
-
return None;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
let notification = self.create_notification(count);
|
|
101
|
-
let event_type = match ¬ification {
|
|
102
|
-
Notification::SystemAlert { .. } => "system_alert",
|
|
103
|
-
Notification::UserNotification { .. } => "user_notification",
|
|
104
|
-
Notification::StatusUpdate { .. } => "status_update",
|
|
105
|
-
};
|
|
106
|
-
|
|
107
|
-
info!("Sending notification #{}: {}", count + 1, event_type);
|
|
108
|
-
|
|
109
|
-
let data = serde_json::to_value(notification).unwrap();
|
|
110
|
-
|
|
111
|
-
Some(
|
|
112
|
-
SseEvent::with_type(event_type, data)
|
|
113
|
-
.with_id(format!("event_{}", count))
|
|
114
|
-
.with_retry(3000),
|
|
115
|
-
)
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
async fn on_connect(&self) {
|
|
119
|
-
info!("Client connected to notifications stream");
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
async fn on_disconnect(&self) {
|
|
123
|
-
info!("Client disconnected from notifications stream");
|
|
124
|
-
}
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
#[tokio::main]
|
|
128
|
-
async fn main() {
|
|
129
|
-
tracing_subscriber::fmt()
|
|
130
|
-
.with_env_filter("info,sse_notifications=debug")
|
|
131
|
-
.init();
|
|
132
|
-
|
|
133
|
-
let producer = NotificationProducer::new();
|
|
134
|
-
let sse_state = SseState::new(producer);
|
|
135
|
-
|
|
136
|
-
let app = Router::new()
|
|
137
|
-
.route("/notifications", get(sse_handler::<NotificationProducer>))
|
|
138
|
-
.with_state(sse_state);
|
|
139
|
-
|
|
140
|
-
let addr = "127.0.0.1:8000";
|
|
141
|
-
info!("SSE notifications server listening on {}", addr);
|
|
142
|
-
info!("Connect at: http://{}/notifications", addr);
|
|
143
|
-
info!("Try: curl -N http://{}/notifications", addr);
|
|
144
|
-
|
|
145
|
-
let listener = tokio::net::TcpListener::bind(addr).await.expect("Failed to bind");
|
|
146
|
-
|
|
147
|
-
axum::serve(listener, app).await.expect("Server error");
|
|
148
|
-
}
|
|
1
|
+
#![allow(clippy::pedantic, clippy::nursery, clippy::all)]
|
|
2
|
+
//! SSE Notifications Server Example
|
|
3
|
+
//!
|
|
4
|
+
//! Demonstrates Server-Sent Events support in Spikard matching the AsyncAPI notifications specification.
|
|
5
|
+
|
|
6
|
+
use axum::{Router, routing::get};
|
|
7
|
+
use chrono::Utc;
|
|
8
|
+
use serde::Serialize;
|
|
9
|
+
use serde_json::json;
|
|
10
|
+
use spikard_http::{SseEvent, SseEventProducer, SseState, sse_handler};
|
|
11
|
+
use std::sync::atomic::{AtomicUsize, Ordering};
|
|
12
|
+
use tokio::time::{Duration, sleep};
|
|
13
|
+
use tracing::info;
|
|
14
|
+
|
|
15
|
+
/// Notification event types matching AsyncAPI specification
|
|
16
|
+
#[derive(Debug, Clone, Serialize)]
|
|
17
|
+
#[serde(tag = "type")]
|
|
18
|
+
#[allow(clippy::enum_variant_names)]
|
|
19
|
+
enum Notification {
|
|
20
|
+
#[serde(rename = "system_alert")]
|
|
21
|
+
SystemAlert {
|
|
22
|
+
level: String,
|
|
23
|
+
message: String,
|
|
24
|
+
source: String,
|
|
25
|
+
timestamp: String,
|
|
26
|
+
},
|
|
27
|
+
#[serde(rename = "user_notification")]
|
|
28
|
+
UserNotification {
|
|
29
|
+
#[serde(rename = "userId")]
|
|
30
|
+
user_id: String,
|
|
31
|
+
title: String,
|
|
32
|
+
body: String,
|
|
33
|
+
priority: String,
|
|
34
|
+
timestamp: String,
|
|
35
|
+
},
|
|
36
|
+
#[serde(rename = "status_update")]
|
|
37
|
+
StatusUpdate {
|
|
38
|
+
service: String,
|
|
39
|
+
status: String,
|
|
40
|
+
message: Option<String>,
|
|
41
|
+
metadata: serde_json::Value,
|
|
42
|
+
timestamp: String,
|
|
43
|
+
},
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/// Notification producer implementing SseEventProducer trait
|
|
47
|
+
struct NotificationProducer {
|
|
48
|
+
counter: AtomicUsize,
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
impl NotificationProducer {
|
|
52
|
+
fn new() -> Self {
|
|
53
|
+
Self {
|
|
54
|
+
counter: AtomicUsize::new(0),
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
fn create_notification(&self, index: usize) -> Notification {
|
|
59
|
+
let timestamp = Utc::now().to_rfc3339();
|
|
60
|
+
|
|
61
|
+
match index % 3 {
|
|
62
|
+
0 => Notification::SystemAlert {
|
|
63
|
+
level: "info".to_string(),
|
|
64
|
+
message: format!("System checkpoint {} reached", index),
|
|
65
|
+
source: "monitoring-system".to_string(),
|
|
66
|
+
timestamp,
|
|
67
|
+
},
|
|
68
|
+
1 => Notification::UserNotification {
|
|
69
|
+
user_id: format!("user_{}", index),
|
|
70
|
+
title: "New Update Available".to_string(),
|
|
71
|
+
body: format!("Version 1.{} is now available for download", index),
|
|
72
|
+
priority: "normal".to_string(),
|
|
73
|
+
timestamp,
|
|
74
|
+
},
|
|
75
|
+
_ => Notification::StatusUpdate {
|
|
76
|
+
service: "api-gateway".to_string(),
|
|
77
|
+
status: "operational".to_string(),
|
|
78
|
+
message: Some(format!("Health check {} passed", index)),
|
|
79
|
+
metadata: json!({
|
|
80
|
+
"response_time_ms": 50 + (index % 100),
|
|
81
|
+
"active_connections": 100 + (index % 50)
|
|
82
|
+
}),
|
|
83
|
+
timestamp,
|
|
84
|
+
},
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
impl SseEventProducer for NotificationProducer {
|
|
90
|
+
async fn next_event(&self) -> Option<SseEvent> {
|
|
91
|
+
sleep(Duration::from_secs(2)).await;
|
|
92
|
+
|
|
93
|
+
let count = self.counter.fetch_add(1, Ordering::Relaxed);
|
|
94
|
+
|
|
95
|
+
if count >= 10 {
|
|
96
|
+
info!("Completed sending 10 notifications");
|
|
97
|
+
return None;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
let notification = self.create_notification(count);
|
|
101
|
+
let event_type = match ¬ification {
|
|
102
|
+
Notification::SystemAlert { .. } => "system_alert",
|
|
103
|
+
Notification::UserNotification { .. } => "user_notification",
|
|
104
|
+
Notification::StatusUpdate { .. } => "status_update",
|
|
105
|
+
};
|
|
106
|
+
|
|
107
|
+
info!("Sending notification #{}: {}", count + 1, event_type);
|
|
108
|
+
|
|
109
|
+
let data = serde_json::to_value(notification).unwrap();
|
|
110
|
+
|
|
111
|
+
Some(
|
|
112
|
+
SseEvent::with_type(event_type, data)
|
|
113
|
+
.with_id(format!("event_{}", count))
|
|
114
|
+
.with_retry(3000),
|
|
115
|
+
)
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
async fn on_connect(&self) {
|
|
119
|
+
info!("Client connected to notifications stream");
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
async fn on_disconnect(&self) {
|
|
123
|
+
info!("Client disconnected from notifications stream");
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
#[tokio::main]
|
|
128
|
+
async fn main() {
|
|
129
|
+
tracing_subscriber::fmt()
|
|
130
|
+
.with_env_filter("info,sse_notifications=debug")
|
|
131
|
+
.init();
|
|
132
|
+
|
|
133
|
+
let producer = NotificationProducer::new();
|
|
134
|
+
let sse_state = SseState::new(producer);
|
|
135
|
+
|
|
136
|
+
let app = Router::new()
|
|
137
|
+
.route("/notifications", get(sse_handler::<NotificationProducer>))
|
|
138
|
+
.with_state(sse_state);
|
|
139
|
+
|
|
140
|
+
let addr = "127.0.0.1:8000";
|
|
141
|
+
info!("SSE notifications server listening on {}", addr);
|
|
142
|
+
info!("Connect at: http://{}/notifications", addr);
|
|
143
|
+
info!("Try: curl -N http://{}/notifications", addr);
|
|
144
|
+
|
|
145
|
+
let listener = tokio::net::TcpListener::bind(addr).await.expect("Failed to bind");
|
|
146
|
+
|
|
147
|
+
axum::serve(listener, app).await.expect("Server error");
|
|
148
|
+
}
|
|
@@ -1,92 +1,92 @@
|
|
|
1
|
-
#![allow(clippy::pedantic, clippy::nursery, clippy::all)]
|
|
2
|
-
//! WebSocket Chat Server Example
|
|
3
|
-
//!
|
|
4
|
-
//! Demonstrates WebSocket support in Spikard matching the AsyncAPI chat specification.
|
|
5
|
-
//! This server implements a simple chat system with three message types:
|
|
6
|
-
//! - chatMessage: User sends a chat message
|
|
7
|
-
//! - userJoined: User joins the chat
|
|
8
|
-
//! - userLeft: User leaves the chat
|
|
9
|
-
|
|
10
|
-
use axum::{Router, routing::get};
|
|
11
|
-
use serde::{Deserialize, Serialize};
|
|
12
|
-
use serde_json::Value;
|
|
13
|
-
use spikard_http::{WebSocketHandler, WebSocketState, websocket_handler};
|
|
14
|
-
use tracing::{info, warn};
|
|
15
|
-
|
|
16
|
-
/// Chat message types matching AsyncAPI specification
|
|
17
|
-
#[derive(Debug, Clone, Serialize, Deserialize)]
|
|
18
|
-
#[serde(tag = "type")]
|
|
19
|
-
#[allow(clippy::enum_variant_names)]
|
|
20
|
-
enum ChatMessage {
|
|
21
|
-
#[serde(rename = "message")]
|
|
22
|
-
ChatMessage {
|
|
23
|
-
user: String,
|
|
24
|
-
text: String,
|
|
25
|
-
timestamp: String,
|
|
26
|
-
},
|
|
27
|
-
#[serde(rename = "userJoined")]
|
|
28
|
-
UserJoined { user: String, timestamp: String },
|
|
29
|
-
#[serde(rename = "userLeft")]
|
|
30
|
-
UserLeft { user: String, timestamp: String },
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
/// Chat handler implementing WebSocketHandler trait
|
|
34
|
-
struct ChatHandler;
|
|
35
|
-
|
|
36
|
-
impl WebSocketHandler for ChatHandler {
|
|
37
|
-
async fn handle_message(&self, message: Value) -> Option<Value> {
|
|
38
|
-
match serde_json::from_value::<ChatMessage>(message.clone()) {
|
|
39
|
-
Ok(chat_msg) => {
|
|
40
|
-
match chat_msg {
|
|
41
|
-
ChatMessage::ChatMessage { ref user, ref text, .. } => {
|
|
42
|
-
info!("Chat message from {}: {}", user, text);
|
|
43
|
-
}
|
|
44
|
-
ChatMessage::UserJoined { ref user, .. } => {
|
|
45
|
-
info!("User joined: {}", user);
|
|
46
|
-
}
|
|
47
|
-
ChatMessage::UserLeft { ref user, .. } => {
|
|
48
|
-
info!("User left: {}", user);
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
Some(message)
|
|
53
|
-
}
|
|
54
|
-
Err(e) => {
|
|
55
|
-
warn!("Failed to parse chat message: {}", e);
|
|
56
|
-
Some(serde_json::json!({
|
|
57
|
-
"type": "error",
|
|
58
|
-
"message": format!("Invalid message format: {}", e)
|
|
59
|
-
}))
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
async fn on_connect(&self) {
|
|
65
|
-
info!("Client connected to chat");
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
async fn on_disconnect(&self) {
|
|
69
|
-
info!("Client disconnected from chat");
|
|
70
|
-
}
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
#[tokio::main]
|
|
74
|
-
async fn main() {
|
|
75
|
-
tracing_subscriber::fmt()
|
|
76
|
-
.with_env_filter("info,websocket_chat=debug")
|
|
77
|
-
.init();
|
|
78
|
-
|
|
79
|
-
let ws_state = WebSocketState::new(ChatHandler);
|
|
80
|
-
|
|
81
|
-
let app = Router::new()
|
|
82
|
-
.route("/chat", get(websocket_handler::<ChatHandler>))
|
|
83
|
-
.with_state(ws_state);
|
|
84
|
-
|
|
85
|
-
let addr = "127.0.0.1:8000";
|
|
86
|
-
info!("WebSocket chat server listening on {}", addr);
|
|
87
|
-
info!("Connect at: ws://{}/chat", addr);
|
|
88
|
-
|
|
89
|
-
let listener = tokio::net::TcpListener::bind(addr).await.expect("Failed to bind");
|
|
90
|
-
|
|
91
|
-
axum::serve(listener, app).await.expect("Server error");
|
|
92
|
-
}
|
|
1
|
+
#![allow(clippy::pedantic, clippy::nursery, clippy::all)]
|
|
2
|
+
//! WebSocket Chat Server Example
|
|
3
|
+
//!
|
|
4
|
+
//! Demonstrates WebSocket support in Spikard matching the AsyncAPI chat specification.
|
|
5
|
+
//! This server implements a simple chat system with three message types:
|
|
6
|
+
//! - chatMessage: User sends a chat message
|
|
7
|
+
//! - userJoined: User joins the chat
|
|
8
|
+
//! - userLeft: User leaves the chat
|
|
9
|
+
|
|
10
|
+
use axum::{Router, routing::get};
|
|
11
|
+
use serde::{Deserialize, Serialize};
|
|
12
|
+
use serde_json::Value;
|
|
13
|
+
use spikard_http::{WebSocketHandler, WebSocketState, websocket_handler};
|
|
14
|
+
use tracing::{info, warn};
|
|
15
|
+
|
|
16
|
+
/// Chat message types matching AsyncAPI specification
|
|
17
|
+
#[derive(Debug, Clone, Serialize, Deserialize)]
|
|
18
|
+
#[serde(tag = "type")]
|
|
19
|
+
#[allow(clippy::enum_variant_names)]
|
|
20
|
+
enum ChatMessage {
|
|
21
|
+
#[serde(rename = "message")]
|
|
22
|
+
ChatMessage {
|
|
23
|
+
user: String,
|
|
24
|
+
text: String,
|
|
25
|
+
timestamp: String,
|
|
26
|
+
},
|
|
27
|
+
#[serde(rename = "userJoined")]
|
|
28
|
+
UserJoined { user: String, timestamp: String },
|
|
29
|
+
#[serde(rename = "userLeft")]
|
|
30
|
+
UserLeft { user: String, timestamp: String },
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/// Chat handler implementing WebSocketHandler trait
|
|
34
|
+
struct ChatHandler;
|
|
35
|
+
|
|
36
|
+
impl WebSocketHandler for ChatHandler {
|
|
37
|
+
async fn handle_message(&self, message: Value) -> Option<Value> {
|
|
38
|
+
match serde_json::from_value::<ChatMessage>(message.clone()) {
|
|
39
|
+
Ok(chat_msg) => {
|
|
40
|
+
match chat_msg {
|
|
41
|
+
ChatMessage::ChatMessage { ref user, ref text, .. } => {
|
|
42
|
+
info!("Chat message from {}: {}", user, text);
|
|
43
|
+
}
|
|
44
|
+
ChatMessage::UserJoined { ref user, .. } => {
|
|
45
|
+
info!("User joined: {}", user);
|
|
46
|
+
}
|
|
47
|
+
ChatMessage::UserLeft { ref user, .. } => {
|
|
48
|
+
info!("User left: {}", user);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
Some(message)
|
|
53
|
+
}
|
|
54
|
+
Err(e) => {
|
|
55
|
+
warn!("Failed to parse chat message: {}", e);
|
|
56
|
+
Some(serde_json::json!({
|
|
57
|
+
"type": "error",
|
|
58
|
+
"message": format!("Invalid message format: {}", e)
|
|
59
|
+
}))
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
async fn on_connect(&self) {
|
|
65
|
+
info!("Client connected to chat");
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
async fn on_disconnect(&self) {
|
|
69
|
+
info!("Client disconnected from chat");
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
#[tokio::main]
|
|
74
|
+
async fn main() {
|
|
75
|
+
tracing_subscriber::fmt()
|
|
76
|
+
.with_env_filter("info,websocket_chat=debug")
|
|
77
|
+
.init();
|
|
78
|
+
|
|
79
|
+
let ws_state = WebSocketState::new(ChatHandler);
|
|
80
|
+
|
|
81
|
+
let app = Router::new()
|
|
82
|
+
.route("/chat", get(websocket_handler::<ChatHandler>))
|
|
83
|
+
.with_state(ws_state);
|
|
84
|
+
|
|
85
|
+
let addr = "127.0.0.1:8000";
|
|
86
|
+
info!("WebSocket chat server listening on {}", addr);
|
|
87
|
+
info!("Connect at: ws://{}/chat", addr);
|
|
88
|
+
|
|
89
|
+
let listener = tokio::net::TcpListener::bind(addr).await.expect("Failed to bind");
|
|
90
|
+
|
|
91
|
+
axum::serve(listener, app).await.expect("Server error");
|
|
92
|
+
}
|