spikard 0.4.0-x64-mingw-ucrt

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.
Files changed (138) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +1 -0
  3. data/README.md +659 -0
  4. data/ext/spikard_rb/Cargo.toml +17 -0
  5. data/ext/spikard_rb/extconf.rb +10 -0
  6. data/ext/spikard_rb/src/lib.rs +6 -0
  7. data/lib/spikard/app.rb +405 -0
  8. data/lib/spikard/background.rb +27 -0
  9. data/lib/spikard/config.rb +396 -0
  10. data/lib/spikard/converters.rb +13 -0
  11. data/lib/spikard/handler_wrapper.rb +113 -0
  12. data/lib/spikard/provide.rb +214 -0
  13. data/lib/spikard/response.rb +173 -0
  14. data/lib/spikard/schema.rb +243 -0
  15. data/lib/spikard/sse.rb +111 -0
  16. data/lib/spikard/streaming_response.rb +44 -0
  17. data/lib/spikard/testing.rb +221 -0
  18. data/lib/spikard/upload_file.rb +131 -0
  19. data/lib/spikard/version.rb +5 -0
  20. data/lib/spikard/websocket.rb +59 -0
  21. data/lib/spikard.rb +43 -0
  22. data/sig/spikard.rbs +366 -0
  23. data/vendor/bundle/ruby/3.4.0/gems/diff-lcs-1.6.2/mise.toml +5 -0
  24. data/vendor/bundle/ruby/3.4.0/gems/rake-compiler-dock-1.10.0/build/buildkitd.toml +2 -0
  25. data/vendor/crates/spikard-bindings-shared/Cargo.toml +63 -0
  26. data/vendor/crates/spikard-bindings-shared/examples/config_extraction.rs +139 -0
  27. data/vendor/crates/spikard-bindings-shared/src/config_extractor.rs +561 -0
  28. data/vendor/crates/spikard-bindings-shared/src/conversion_traits.rs +194 -0
  29. data/vendor/crates/spikard-bindings-shared/src/di_traits.rs +246 -0
  30. data/vendor/crates/spikard-bindings-shared/src/error_response.rs +403 -0
  31. data/vendor/crates/spikard-bindings-shared/src/handler_base.rs +274 -0
  32. data/vendor/crates/spikard-bindings-shared/src/lib.rs +25 -0
  33. data/vendor/crates/spikard-bindings-shared/src/lifecycle_base.rs +298 -0
  34. data/vendor/crates/spikard-bindings-shared/src/lifecycle_executor.rs +637 -0
  35. data/vendor/crates/spikard-bindings-shared/src/response_builder.rs +309 -0
  36. data/vendor/crates/spikard-bindings-shared/src/test_client_base.rs +248 -0
  37. data/vendor/crates/spikard-bindings-shared/src/validation_helpers.rs +355 -0
  38. data/vendor/crates/spikard-bindings-shared/tests/comprehensive_coverage.rs +502 -0
  39. data/vendor/crates/spikard-bindings-shared/tests/error_response_edge_cases.rs +389 -0
  40. data/vendor/crates/spikard-bindings-shared/tests/handler_base_integration.rs +413 -0
  41. data/vendor/crates/spikard-core/Cargo.toml +40 -0
  42. data/vendor/crates/spikard-core/src/bindings/mod.rs +3 -0
  43. data/vendor/crates/spikard-core/src/bindings/response.rs +133 -0
  44. data/vendor/crates/spikard-core/src/debug.rs +63 -0
  45. data/vendor/crates/spikard-core/src/di/container.rs +726 -0
  46. data/vendor/crates/spikard-core/src/di/dependency.rs +273 -0
  47. data/vendor/crates/spikard-core/src/di/error.rs +118 -0
  48. data/vendor/crates/spikard-core/src/di/factory.rs +538 -0
  49. data/vendor/crates/spikard-core/src/di/graph.rs +545 -0
  50. data/vendor/crates/spikard-core/src/di/mod.rs +192 -0
  51. data/vendor/crates/spikard-core/src/di/resolved.rs +411 -0
  52. data/vendor/crates/spikard-core/src/di/value.rs +283 -0
  53. data/vendor/crates/spikard-core/src/errors.rs +39 -0
  54. data/vendor/crates/spikard-core/src/http.rs +153 -0
  55. data/vendor/crates/spikard-core/src/lib.rs +29 -0
  56. data/vendor/crates/spikard-core/src/lifecycle.rs +422 -0
  57. data/vendor/crates/spikard-core/src/metadata.rs +397 -0
  58. data/vendor/crates/spikard-core/src/parameters.rs +723 -0
  59. data/vendor/crates/spikard-core/src/problem.rs +310 -0
  60. data/vendor/crates/spikard-core/src/request_data.rs +189 -0
  61. data/vendor/crates/spikard-core/src/router.rs +249 -0
  62. data/vendor/crates/spikard-core/src/schema_registry.rs +183 -0
  63. data/vendor/crates/spikard-core/src/type_hints.rs +304 -0
  64. data/vendor/crates/spikard-core/src/validation/error_mapper.rs +689 -0
  65. data/vendor/crates/spikard-core/src/validation/mod.rs +459 -0
  66. data/vendor/crates/spikard-http/Cargo.toml +58 -0
  67. data/vendor/crates/spikard-http/examples/sse-notifications.rs +147 -0
  68. data/vendor/crates/spikard-http/examples/websocket-chat.rs +91 -0
  69. data/vendor/crates/spikard-http/src/auth.rs +247 -0
  70. data/vendor/crates/spikard-http/src/background.rs +1562 -0
  71. data/vendor/crates/spikard-http/src/bindings/mod.rs +3 -0
  72. data/vendor/crates/spikard-http/src/bindings/response.rs +1 -0
  73. data/vendor/crates/spikard-http/src/body_metadata.rs +8 -0
  74. data/vendor/crates/spikard-http/src/cors.rs +490 -0
  75. data/vendor/crates/spikard-http/src/debug.rs +63 -0
  76. data/vendor/crates/spikard-http/src/di_handler.rs +1878 -0
  77. data/vendor/crates/spikard-http/src/handler_response.rs +532 -0
  78. data/vendor/crates/spikard-http/src/handler_trait.rs +861 -0
  79. data/vendor/crates/spikard-http/src/handler_trait_tests.rs +284 -0
  80. data/vendor/crates/spikard-http/src/lib.rs +524 -0
  81. data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +149 -0
  82. data/vendor/crates/spikard-http/src/lifecycle.rs +428 -0
  83. data/vendor/crates/spikard-http/src/middleware/mod.rs +285 -0
  84. data/vendor/crates/spikard-http/src/middleware/multipart.rs +930 -0
  85. data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +541 -0
  86. data/vendor/crates/spikard-http/src/middleware/validation.rs +287 -0
  87. data/vendor/crates/spikard-http/src/openapi/mod.rs +309 -0
  88. data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +535 -0
  89. data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +867 -0
  90. data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +678 -0
  91. data/vendor/crates/spikard-http/src/query_parser.rs +369 -0
  92. data/vendor/crates/spikard-http/src/response.rs +399 -0
  93. data/vendor/crates/spikard-http/src/server/handler.rs +1557 -0
  94. data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +98 -0
  95. data/vendor/crates/spikard-http/src/server/mod.rs +806 -0
  96. data/vendor/crates/spikard-http/src/server/request_extraction.rs +630 -0
  97. data/vendor/crates/spikard-http/src/server/routing_factory.rs +497 -0
  98. data/vendor/crates/spikard-http/src/sse.rs +961 -0
  99. data/vendor/crates/spikard-http/src/testing/form.rs +14 -0
  100. data/vendor/crates/spikard-http/src/testing/multipart.rs +60 -0
  101. data/vendor/crates/spikard-http/src/testing/test_client.rs +285 -0
  102. data/vendor/crates/spikard-http/src/testing.rs +377 -0
  103. data/vendor/crates/spikard-http/src/websocket.rs +831 -0
  104. data/vendor/crates/spikard-http/tests/background_behavior.rs +918 -0
  105. data/vendor/crates/spikard-http/tests/common/handlers.rs +308 -0
  106. data/vendor/crates/spikard-http/tests/common/mod.rs +21 -0
  107. data/vendor/crates/spikard-http/tests/di_integration.rs +202 -0
  108. data/vendor/crates/spikard-http/tests/doc_snippets.rs +4 -0
  109. data/vendor/crates/spikard-http/tests/lifecycle_execution.rs +1135 -0
  110. data/vendor/crates/spikard-http/tests/multipart_behavior.rs +688 -0
  111. data/vendor/crates/spikard-http/tests/server_config_builder.rs +324 -0
  112. data/vendor/crates/spikard-http/tests/sse_behavior.rs +728 -0
  113. data/vendor/crates/spikard-http/tests/websocket_behavior.rs +724 -0
  114. data/vendor/crates/spikard-rb/Cargo.toml +43 -0
  115. data/vendor/crates/spikard-rb/build.rs +199 -0
  116. data/vendor/crates/spikard-rb/src/background.rs +63 -0
  117. data/vendor/crates/spikard-rb/src/config/mod.rs +5 -0
  118. data/vendor/crates/spikard-rb/src/config/server_config.rs +283 -0
  119. data/vendor/crates/spikard-rb/src/conversion.rs +459 -0
  120. data/vendor/crates/spikard-rb/src/di/builder.rs +105 -0
  121. data/vendor/crates/spikard-rb/src/di/mod.rs +413 -0
  122. data/vendor/crates/spikard-rb/src/handler.rs +612 -0
  123. data/vendor/crates/spikard-rb/src/integration/mod.rs +3 -0
  124. data/vendor/crates/spikard-rb/src/lib.rs +1857 -0
  125. data/vendor/crates/spikard-rb/src/lifecycle.rs +275 -0
  126. data/vendor/crates/spikard-rb/src/metadata/mod.rs +5 -0
  127. data/vendor/crates/spikard-rb/src/metadata/route_extraction.rs +427 -0
  128. data/vendor/crates/spikard-rb/src/runtime/mod.rs +5 -0
  129. data/vendor/crates/spikard-rb/src/runtime/server_runner.rs +326 -0
  130. data/vendor/crates/spikard-rb/src/server.rs +283 -0
  131. data/vendor/crates/spikard-rb/src/sse.rs +231 -0
  132. data/vendor/crates/spikard-rb/src/testing/client.rs +404 -0
  133. data/vendor/crates/spikard-rb/src/testing/mod.rs +7 -0
  134. data/vendor/crates/spikard-rb/src/testing/sse.rs +143 -0
  135. data/vendor/crates/spikard-rb/src/testing/websocket.rs +221 -0
  136. data/vendor/crates/spikard-rb/src/websocket.rs +233 -0
  137. data/vendor/crates/spikard-rb/tests/magnus_ffi_tests.rs +14 -0
  138. metadata +213 -0
@@ -0,0 +1,961 @@
1
+ //! Server-Sent Events (SSE) support for Spikard
2
+ //!
3
+ //! Provides SSE streaming with event generation and lifecycle management.
4
+
5
+ use axum::{
6
+ extract::State,
7
+ response::{
8
+ IntoResponse,
9
+ sse::{Event, KeepAlive, Sse},
10
+ },
11
+ };
12
+ use futures_util::stream;
13
+ use serde_json::Value;
14
+ use std::{convert::Infallible, sync::Arc, time::Duration};
15
+ use tracing::{debug, error, info};
16
+
17
+ /// SSE event producer trait
18
+ ///
19
+ /// Implement this trait to create custom Server-Sent Event (SSE) producers for your application.
20
+ /// The producer generates events that are streamed to connected clients.
21
+ ///
22
+ /// # Understanding SSE
23
+ ///
24
+ /// Server-Sent Events (SSE) provide one-way communication from server to client over HTTP.
25
+ /// Unlike WebSocket, SSE uses standard HTTP and automatically handles reconnection.
26
+ /// Use SSE when you need to push data to clients without bidirectional communication.
27
+ ///
28
+ /// # Implementing the Trait
29
+ ///
30
+ /// You must implement the `next_event` method to generate events. The `on_connect` and
31
+ /// `on_disconnect` methods are optional lifecycle hooks.
32
+ ///
33
+ /// # Example
34
+ ///
35
+ /// ```ignore
36
+ /// use spikard_http::sse::{SseEventProducer, SseEvent};
37
+ /// use serde_json::json;
38
+ /// use std::time::Duration;
39
+ /// use tokio::time::sleep;
40
+ ///
41
+ /// struct CounterProducer {
42
+ /// limit: usize,
43
+ /// }
44
+ ///
45
+ /// #[async_trait]
46
+ /// impl SseEventProducer for CounterProducer {
47
+ /// async fn next_event(&self) -> Option<SseEvent> {
48
+ /// static COUNTER: std::sync::atomic::AtomicUsize = std::sync::atomic::AtomicUsize::new(0);
49
+ ///
50
+ /// let count = COUNTER.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
51
+ /// if count < self.limit {
52
+ /// Some(SseEvent::new(json!({"count": count})))
53
+ /// } else {
54
+ /// None
55
+ /// }
56
+ /// }
57
+ ///
58
+ /// async fn on_connect(&self) {
59
+ /// println!("Client connected");
60
+ /// }
61
+ ///
62
+ /// async fn on_disconnect(&self) {
63
+ /// println!("Client disconnected");
64
+ /// }
65
+ /// }
66
+ /// ```
67
+ pub trait SseEventProducer: Send + Sync {
68
+ /// Generate the next event
69
+ ///
70
+ /// Called repeatedly to produce the event stream. Should return `Some(event)` when
71
+ /// an event is ready to send, or `None` when the stream should end.
72
+ ///
73
+ /// # Returns
74
+ /// * `Some(event)` - Event to send to the client
75
+ /// * `None` - Stream complete, connection will close
76
+ fn next_event(&self) -> impl std::future::Future<Output = Option<SseEvent>> + Send;
77
+
78
+ /// Called when a client connects to the SSE endpoint
79
+ ///
80
+ /// Optional lifecycle hook invoked when a new SSE connection is established.
81
+ /// Default implementation does nothing.
82
+ fn on_connect(&self) -> impl std::future::Future<Output = ()> + Send {
83
+ async {}
84
+ }
85
+
86
+ /// Called when a client disconnects from the SSE endpoint
87
+ ///
88
+ /// Optional lifecycle hook invoked when an SSE connection is closed (either by the
89
+ /// client or the stream ending). Default implementation does nothing.
90
+ fn on_disconnect(&self) -> impl std::future::Future<Output = ()> + Send {
91
+ async {}
92
+ }
93
+ }
94
+
95
+ /// An individual SSE event
96
+ ///
97
+ /// Represents a single Server-Sent Event to be sent to a connected client.
98
+ /// Events can have an optional type, ID, and retry timeout for advanced scenarios.
99
+ ///
100
+ /// # Fields
101
+ ///
102
+ /// * `event_type` - Optional event type string (used for client-side event filtering)
103
+ /// * `data` - JSON data payload to send to the client
104
+ /// * `id` - Optional event ID (clients can use this to resume after disconnect)
105
+ /// * `retry` - Optional retry timeout in milliseconds (tells client when to reconnect)
106
+ ///
107
+ /// # SSE Format
108
+ ///
109
+ /// Events are serialized to the following text format:
110
+ /// ```text
111
+ /// event: event_type
112
+ /// data: {"json":"value"}
113
+ /// id: event-123
114
+ /// retry: 3000
115
+ /// ```
116
+ #[derive(Debug, Clone)]
117
+ pub struct SseEvent {
118
+ /// Event type (optional)
119
+ pub event_type: Option<String>,
120
+ /// Event data (JSON value)
121
+ pub data: Value,
122
+ /// Event ID (optional, for client-side reconnection)
123
+ pub id: Option<String>,
124
+ /// Retry timeout in milliseconds (optional)
125
+ pub retry: Option<u64>,
126
+ }
127
+
128
+ impl SseEvent {
129
+ /// Create a new SSE event with data only
130
+ ///
131
+ /// Creates a minimal event with just the data payload. Use builder methods
132
+ /// to add optional fields.
133
+ ///
134
+ /// # Arguments
135
+ /// * `data` - JSON value to send to the client
136
+ ///
137
+ /// # Example
138
+ ///
139
+ /// ```ignore
140
+ /// use serde_json::json;
141
+ /// use spikard_http::sse::SseEvent;
142
+ ///
143
+ /// let event = SseEvent::new(json!({"status": "connected"}));
144
+ /// ```
145
+ pub fn new(data: Value) -> Self {
146
+ Self {
147
+ event_type: None,
148
+ data,
149
+ id: None,
150
+ retry: None,
151
+ }
152
+ }
153
+
154
+ /// Create a new SSE event with an event type and data
155
+ ///
156
+ /// Creates an event with a type field. Clients can filter events by type
157
+ /// in their event listener.
158
+ ///
159
+ /// # Arguments
160
+ /// * `event_type` - String identifying the event type (e.g., "update", "error")
161
+ /// * `data` - JSON value to send to the client
162
+ ///
163
+ /// # Example
164
+ ///
165
+ /// ```ignore
166
+ /// use serde_json::json;
167
+ /// use spikard_http::sse::SseEvent;
168
+ ///
169
+ /// let event = SseEvent::with_type("update", json!({"count": 42}));
170
+ /// // Client can listen with: eventSource.addEventListener("update", ...)
171
+ /// ```
172
+ pub fn with_type(event_type: impl Into<String>, data: Value) -> Self {
173
+ Self {
174
+ event_type: Some(event_type.into()),
175
+ data,
176
+ id: None,
177
+ retry: None,
178
+ }
179
+ }
180
+
181
+ /// Set the event ID for client-side reconnection support
182
+ ///
183
+ /// Sets an ID that clients can use to resume from this point if they disconnect.
184
+ /// The client sends this ID back in the `Last-Event-ID` header when reconnecting.
185
+ ///
186
+ /// # Arguments
187
+ /// * `id` - Unique identifier for this event
188
+ ///
189
+ /// # Example
190
+ ///
191
+ /// ```ignore
192
+ /// use serde_json::json;
193
+ /// use spikard_http::sse::SseEvent;
194
+ ///
195
+ /// let event = SseEvent::new(json!({"count": 1}))
196
+ /// .with_id("event-1");
197
+ /// ```
198
+ pub fn with_id(mut self, id: impl Into<String>) -> Self {
199
+ self.id = Some(id.into());
200
+ self
201
+ }
202
+
203
+ /// Set the retry timeout for client reconnection
204
+ ///
205
+ /// Sets the time in milliseconds clients should wait before attempting to reconnect
206
+ /// if the connection is lost. The client browser will automatically handle reconnection.
207
+ ///
208
+ /// # Arguments
209
+ /// * `retry_ms` - Retry timeout in milliseconds
210
+ ///
211
+ /// # Example
212
+ ///
213
+ /// ```ignore
214
+ /// use serde_json::json;
215
+ /// use spikard_http::sse::SseEvent;
216
+ ///
217
+ /// let event = SseEvent::new(json!({"data": "value"}))
218
+ /// .with_retry(5000); // Reconnect after 5 seconds
219
+ /// ```
220
+ pub fn with_retry(mut self, retry_ms: u64) -> Self {
221
+ self.retry = Some(retry_ms);
222
+ self
223
+ }
224
+
225
+ /// Convert to Axum's SSE Event
226
+ fn into_axum_event(self) -> Result<Event, serde_json::Error> {
227
+ let json_data = serde_json::to_string(&self.data)?;
228
+
229
+ let mut event = Event::default().data(json_data);
230
+
231
+ if let Some(event_type) = self.event_type {
232
+ event = event.event(event_type);
233
+ }
234
+
235
+ if let Some(id) = self.id {
236
+ event = event.id(id);
237
+ }
238
+
239
+ if let Some(retry) = self.retry {
240
+ event = event.retry(Duration::from_millis(retry));
241
+ }
242
+
243
+ Ok(event)
244
+ }
245
+ }
246
+
247
+ /// SSE state shared across connections
248
+ ///
249
+ /// Contains the event producer and optional JSON schema for validating
250
+ /// events. This state is shared among all connections to the same SSE endpoint.
251
+ pub struct SseState<P: SseEventProducer> {
252
+ /// The event producer implementation
253
+ producer: Arc<P>,
254
+ /// Optional JSON Schema for validating outgoing events
255
+ event_schema: Option<Arc<jsonschema::Validator>>,
256
+ }
257
+
258
+ impl<P: SseEventProducer> Clone for SseState<P> {
259
+ fn clone(&self) -> Self {
260
+ Self {
261
+ producer: Arc::clone(&self.producer),
262
+ event_schema: self.event_schema.clone(),
263
+ }
264
+ }
265
+ }
266
+
267
+ impl<P: SseEventProducer + 'static> SseState<P> {
268
+ /// Create new SSE state with an event producer
269
+ ///
270
+ /// Creates a new state without event validation schema.
271
+ /// Events are not validated.
272
+ ///
273
+ /// # Arguments
274
+ /// * `producer` - The event producer implementation
275
+ ///
276
+ /// # Example
277
+ ///
278
+ /// ```ignore
279
+ /// let state = SseState::new(MyProducer);
280
+ /// ```
281
+ pub fn new(producer: P) -> Self {
282
+ Self {
283
+ producer: Arc::new(producer),
284
+ event_schema: None,
285
+ }
286
+ }
287
+
288
+ /// Create new SSE state with an event producer and optional event schema
289
+ ///
290
+ /// Creates a new state with optional JSON schema for validating outgoing events.
291
+ /// If a schema is provided and an event fails validation, it is silently dropped.
292
+ ///
293
+ /// # Arguments
294
+ /// * `producer` - The event producer implementation
295
+ /// * `event_schema` - Optional JSON schema for validating events
296
+ ///
297
+ /// # Returns
298
+ /// * `Ok(state)` - Successfully created state
299
+ /// * `Err(msg)` - Invalid schema provided
300
+ ///
301
+ /// # Example
302
+ ///
303
+ /// ```ignore
304
+ /// use serde_json::json;
305
+ ///
306
+ /// let event_schema = json!({
307
+ /// "type": "object",
308
+ /// "properties": {
309
+ /// "count": {"type": "integer"}
310
+ /// }
311
+ /// });
312
+ ///
313
+ /// let state = SseState::with_schema(MyProducer, Some(event_schema))?;
314
+ /// ```
315
+ pub fn with_schema(producer: P, event_schema: Option<serde_json::Value>) -> Result<Self, String> {
316
+ let event_validator = if let Some(schema) = event_schema {
317
+ Some(Arc::new(
318
+ jsonschema::validator_for(&schema).map_err(|e| format!("Invalid event schema: {}", e))?,
319
+ ))
320
+ } else {
321
+ None
322
+ };
323
+
324
+ Ok(Self {
325
+ producer: Arc::new(producer),
326
+ event_schema: event_validator,
327
+ })
328
+ }
329
+ }
330
+
331
+ /// SSE endpoint handler
332
+ ///
333
+ /// This is the main entry point for SSE connections. Use this as an Axum route
334
+ /// handler by passing it to an Axum router's `.route()` method with `get()`.
335
+ ///
336
+ /// The handler establishes a connection and streams events from the producer to
337
+ /// the client using the Server-Sent Events protocol (text/event-stream).
338
+ ///
339
+ /// # Arguments
340
+ /// * `State(state)` - Application state containing the event producer and optional schema
341
+ ///
342
+ /// # Returns
343
+ /// A streaming response with the `text/event-stream` content type
344
+ ///
345
+ /// # Example
346
+ ///
347
+ /// ```ignore
348
+ /// use axum::{Router, routing::get, extract::State};
349
+ ///
350
+ /// let state = SseState::new(MyProducer);
351
+ /// let router = Router::new()
352
+ /// .route("/events", get(sse_handler::<MyProducer>))
353
+ /// .with_state(state);
354
+ ///
355
+ /// // Client usage:
356
+ /// // const eventSource = new EventSource('/events');
357
+ /// // eventSource.onmessage = (e) => console.log(e.data);
358
+ /// ```
359
+ pub async fn sse_handler<P: SseEventProducer + 'static>(State(state): State<SseState<P>>) -> impl IntoResponse {
360
+ info!("SSE client connected");
361
+
362
+ state.producer.on_connect().await;
363
+
364
+ let producer = Arc::clone(&state.producer);
365
+ let event_schema = state.event_schema.clone();
366
+ let stream = stream::unfold((producer, event_schema), |(producer, event_schema)| async move {
367
+ match producer.next_event().await {
368
+ Some(sse_event) => {
369
+ debug!("Sending SSE event: {:?}", sse_event.event_type);
370
+
371
+ if let Some(validator) = &event_schema
372
+ && !validator.is_valid(&sse_event.data)
373
+ {
374
+ error!("SSE event validation failed");
375
+ return Some((
376
+ Ok::<_, Infallible>(Event::default().data("validation_error")),
377
+ (producer, event_schema),
378
+ ));
379
+ }
380
+
381
+ match sse_event.into_axum_event() {
382
+ Ok(event) => Some((Ok::<_, Infallible>(event), (producer, event_schema))),
383
+ Err(e) => {
384
+ error!("Failed to serialize SSE event: {}", e);
385
+ None
386
+ }
387
+ }
388
+ }
389
+ None => {
390
+ info!("SSE stream ended");
391
+ None
392
+ }
393
+ }
394
+ });
395
+
396
+ let sse_response =
397
+ Sse::new(stream).keep_alive(KeepAlive::new().interval(Duration::from_secs(15)).text("keep-alive"));
398
+
399
+ sse_response.into_response()
400
+ }
401
+
402
+ #[cfg(test)]
403
+ mod tests {
404
+ use super::*;
405
+ use std::sync::Arc;
406
+ use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
407
+
408
+ // ============================================================================
409
+ // Test Producers
410
+ // ============================================================================
411
+
412
+ struct TestProducer {
413
+ count: AtomicUsize,
414
+ }
415
+
416
+ impl SseEventProducer for TestProducer {
417
+ async fn next_event(&self) -> Option<SseEvent> {
418
+ let count = self.count.fetch_add(1, Ordering::Relaxed);
419
+ if count < 3 {
420
+ Some(SseEvent::new(serde_json::json!({
421
+ "message": format!("Event {}", count)
422
+ })))
423
+ } else {
424
+ None
425
+ }
426
+ }
427
+ }
428
+
429
+ /// Producer that tracks connect/disconnect lifecycle
430
+ struct LifecycleProducer {
431
+ connect_count: Arc<AtomicUsize>,
432
+ disconnect_count: Arc<AtomicUsize>,
433
+ event_count: AtomicUsize,
434
+ }
435
+
436
+ impl LifecycleProducer {
437
+ fn new(connect: Arc<AtomicUsize>, disconnect: Arc<AtomicUsize>) -> Self {
438
+ Self {
439
+ connect_count: connect,
440
+ disconnect_count: disconnect,
441
+ event_count: AtomicUsize::new(0),
442
+ }
443
+ }
444
+ }
445
+
446
+ impl SseEventProducer for LifecycleProducer {
447
+ async fn next_event(&self) -> Option<SseEvent> {
448
+ let idx: usize = self.event_count.fetch_add(1, Ordering::Relaxed);
449
+ if idx < 2 {
450
+ Some(SseEvent::new(serde_json::json!({"event": idx})))
451
+ } else {
452
+ None
453
+ }
454
+ }
455
+
456
+ async fn on_connect(&self) {
457
+ self.connect_count.fetch_add(1, Ordering::Relaxed);
458
+ }
459
+
460
+ async fn on_disconnect(&self) {
461
+ self.disconnect_count.fetch_add(1, Ordering::Relaxed);
462
+ }
463
+ }
464
+
465
+ /// Producer for multiline event testing
466
+ struct MultilineProducer {
467
+ sent: AtomicBool,
468
+ }
469
+
470
+ impl SseEventProducer for MultilineProducer {
471
+ async fn next_event(&self) -> Option<SseEvent> {
472
+ let was_sent: bool = self.sent.swap(true, Ordering::Relaxed);
473
+ if !was_sent {
474
+ Some(SseEvent::new(serde_json::json!({
475
+ "text": "line1\nline2\nline3"
476
+ })))
477
+ } else {
478
+ None
479
+ }
480
+ }
481
+ }
482
+
483
+ /// Producer for special characters testing
484
+ struct SpecialCharsProducer {
485
+ sent: AtomicBool,
486
+ }
487
+
488
+ impl SseEventProducer for SpecialCharsProducer {
489
+ async fn next_event(&self) -> Option<SseEvent> {
490
+ let was_sent: bool = self.sent.swap(true, Ordering::Relaxed);
491
+ if !was_sent {
492
+ Some(SseEvent::new(serde_json::json!({
493
+ "data": "special: \"quotes\", \\ backslash, \t tab, \r\n crlf"
494
+ })))
495
+ } else {
496
+ None
497
+ }
498
+ }
499
+ }
500
+
501
+ /// Producer for large payload testing
502
+ struct LargePayloadProducer {
503
+ sent: AtomicBool,
504
+ }
505
+
506
+ impl SseEventProducer for LargePayloadProducer {
507
+ async fn next_event(&self) -> Option<SseEvent> {
508
+ let was_sent: bool = self.sent.swap(true, Ordering::Relaxed);
509
+ if !was_sent {
510
+ // Create a 100KB payload
511
+ let large_string: String = "x".repeat(100_000);
512
+ Some(SseEvent::new(serde_json::json!({
513
+ "payload": large_string
514
+ })))
515
+ } else {
516
+ None
517
+ }
518
+ }
519
+ }
520
+
521
+ /// Producer that sends many events rapidly
522
+ struct RapidEventProducer {
523
+ event_count: usize,
524
+ current: AtomicUsize,
525
+ }
526
+
527
+ impl RapidEventProducer {
528
+ fn new(count: usize) -> Self {
529
+ Self {
530
+ event_count: count,
531
+ current: AtomicUsize::new(0),
532
+ }
533
+ }
534
+ }
535
+
536
+ impl SseEventProducer for RapidEventProducer {
537
+ async fn next_event(&self) -> Option<SseEvent> {
538
+ let idx: usize = self.current.fetch_add(1, Ordering::Relaxed);
539
+ if idx < self.event_count {
540
+ Some(SseEvent::new(serde_json::json!({
541
+ "id": idx,
542
+ "data": format!("event_{}", idx)
543
+ })))
544
+ } else {
545
+ None
546
+ }
547
+ }
548
+ }
549
+
550
+ /// Producer with all event fields populated
551
+ struct FullFieldProducer {
552
+ sent: AtomicBool,
553
+ }
554
+
555
+ impl SseEventProducer for FullFieldProducer {
556
+ async fn next_event(&self) -> Option<SseEvent> {
557
+ let was_sent: bool = self.sent.swap(true, Ordering::Relaxed);
558
+ if !was_sent {
559
+ Some(
560
+ SseEvent::with_type(
561
+ "counter_update",
562
+ serde_json::json!({
563
+ "count": 42,
564
+ "status": "active"
565
+ }),
566
+ )
567
+ .with_id("event-123")
568
+ .with_retry(5000),
569
+ )
570
+ } else {
571
+ None
572
+ }
573
+ }
574
+ }
575
+
576
+ /// Producer that ends immediately (keep-alive test)
577
+ struct NoEventProducer;
578
+
579
+ impl SseEventProducer for NoEventProducer {
580
+ async fn next_event(&self) -> Option<SseEvent> {
581
+ None
582
+ }
583
+ }
584
+
585
+ // ============================================================================
586
+ // Tests: Event Creation & Formatting
587
+ // ============================================================================
588
+
589
+ #[test]
590
+ fn test_sse_event_creation_minimal() {
591
+ let event: SseEvent = SseEvent::new(serde_json::json!({"test": "data"}));
592
+ assert!(event.event_type.is_none());
593
+ assert!(event.id.is_none());
594
+ assert!(event.retry.is_none());
595
+ }
596
+
597
+ #[test]
598
+ fn test_sse_event_with_all_fields() {
599
+ let event: SseEvent = SseEvent::with_type("update", serde_json::json!({"count": 42}))
600
+ .with_id("event-001")
601
+ .with_retry(3000);
602
+
603
+ assert_eq!(event.event_type, Some("update".to_string()));
604
+ assert_eq!(event.id, Some("event-001".to_string()));
605
+ assert_eq!(event.retry, Some(3000));
606
+ }
607
+
608
+ #[test]
609
+ fn test_sse_event_builder_pattern() {
610
+ let event: SseEvent = SseEvent::with_type("notification", serde_json::json!({"text": "hello"}))
611
+ .with_id("notif-456")
612
+ .with_retry(5000);
613
+
614
+ assert_eq!(event.event_type, Some("notification".to_string()));
615
+ assert_eq!(event.id, Some("notif-456".to_string()));
616
+ assert_eq!(event.retry, Some(5000));
617
+ }
618
+
619
+ #[test]
620
+ fn test_sse_event_multiline_data() {
621
+ let event: SseEvent = SseEvent::new(serde_json::json!({
622
+ "text": "line1\nline2\nline3"
623
+ }));
624
+
625
+ assert!(event.data.is_object());
626
+ let text: Option<&str> = event.data.get("text").and_then(|v| v.as_str());
627
+ assert_eq!(text, Some("line1\nline2\nline3"));
628
+ }
629
+
630
+ #[test]
631
+ fn test_sse_event_special_characters() {
632
+ let event: SseEvent = SseEvent::new(serde_json::json!({
633
+ "data": "special: \"quotes\", \\ backslash"
634
+ }));
635
+
636
+ assert!(event.data.is_object());
637
+ }
638
+
639
+ #[test]
640
+ fn test_sse_event_large_payload() {
641
+ let large_string: String = "x".repeat(100_000);
642
+ let event: SseEvent = SseEvent::new(serde_json::json!({
643
+ "payload": large_string.clone()
644
+ }));
645
+
646
+ let payload_field: Option<&str> = event.data.get("payload").and_then(|v| v.as_str());
647
+ assert_eq!(payload_field.map(|s| s.len()), Some(100_000));
648
+ }
649
+
650
+ #[test]
651
+ fn test_sse_event_into_axum_event_conversion() {
652
+ let event: SseEvent = SseEvent::new(serde_json::json!({"msg": "test"}));
653
+ let axum_event: Result<axum::response::sse::Event, serde_json::Error> = event.into_axum_event();
654
+ assert!(axum_event.is_ok());
655
+ }
656
+
657
+ #[test]
658
+ fn test_sse_event_into_axum_with_all_fields() {
659
+ let event: SseEvent = SseEvent::with_type("event", serde_json::json!({"id": 1}))
660
+ .with_id("123")
661
+ .with_retry(5000);
662
+
663
+ let axum_event: Result<axum::response::sse::Event, serde_json::Error> = event.into_axum_event();
664
+ assert!(axum_event.is_ok());
665
+ }
666
+
667
+ // ============================================================================
668
+ // Tests: Stream Lifecycle
669
+ // ============================================================================
670
+
671
+ #[test]
672
+ fn test_sse_state_creation() {
673
+ let producer: TestProducer = TestProducer {
674
+ count: AtomicUsize::new(0),
675
+ };
676
+ let state: SseState<TestProducer> = SseState::new(producer);
677
+ let cloned: SseState<TestProducer> = state.clone();
678
+ assert!(Arc::ptr_eq(&state.producer, &cloned.producer));
679
+ }
680
+
681
+ #[test]
682
+ fn test_sse_state_with_schema_valid() {
683
+ let producer: TestProducer = TestProducer {
684
+ count: AtomicUsize::new(0),
685
+ };
686
+ let schema: serde_json::Value = serde_json::json!({
687
+ "type": "object",
688
+ "properties": {
689
+ "message": {"type": "string"}
690
+ }
691
+ });
692
+
693
+ let result: Result<SseState<TestProducer>, String> = SseState::with_schema(producer, Some(schema));
694
+ assert!(result.is_ok());
695
+ }
696
+
697
+ #[test]
698
+ fn test_sse_state_with_invalid_schema() {
699
+ let producer: TestProducer = TestProducer {
700
+ count: AtomicUsize::new(0),
701
+ };
702
+ let invalid_schema: serde_json::Value = serde_json::json!({
703
+ "type": "not-a-valid-type"
704
+ });
705
+
706
+ let result: Result<SseState<TestProducer>, String> = SseState::with_schema(producer, Some(invalid_schema));
707
+ assert!(result.is_err());
708
+ }
709
+
710
+ #[test]
711
+ fn test_sse_state_with_schema_none() {
712
+ let producer: TestProducer = TestProducer {
713
+ count: AtomicUsize::new(0),
714
+ };
715
+ let result: Result<SseState<TestProducer>, String> = SseState::with_schema(producer, None);
716
+ assert!(result.is_ok());
717
+ }
718
+
719
+ // ============================================================================
720
+ // Tests: Connection Lifecycle Hooks
721
+ // ============================================================================
722
+
723
+ #[tokio::test]
724
+ async fn test_sse_lifecycle_on_connect_called() {
725
+ let connect_count: Arc<AtomicUsize> = Arc::new(AtomicUsize::new(0));
726
+ let disconnect_count: Arc<AtomicUsize> = Arc::new(AtomicUsize::new(0));
727
+
728
+ let producer: LifecycleProducer =
729
+ LifecycleProducer::new(Arc::clone(&connect_count), Arc::clone(&disconnect_count));
730
+
731
+ producer.on_connect().await;
732
+ assert_eq!(connect_count.load(Ordering::Relaxed), 1);
733
+ }
734
+
735
+ #[tokio::test]
736
+ async fn test_sse_lifecycle_on_disconnect_called() {
737
+ let connect_count: Arc<AtomicUsize> = Arc::new(AtomicUsize::new(0));
738
+ let disconnect_count: Arc<AtomicUsize> = Arc::new(AtomicUsize::new(0));
739
+
740
+ let producer: LifecycleProducer =
741
+ LifecycleProducer::new(Arc::clone(&connect_count), Arc::clone(&disconnect_count));
742
+
743
+ producer.on_disconnect().await;
744
+ assert_eq!(disconnect_count.load(Ordering::Relaxed), 1);
745
+ }
746
+
747
+ // ============================================================================
748
+ // Tests: Event Ordering & Delivery
749
+ // ============================================================================
750
+
751
+ #[tokio::test]
752
+ async fn test_sse_event_ordering_preserved() {
753
+ let producer: RapidEventProducer = RapidEventProducer::new(10);
754
+
755
+ let mut last_idx: i32 = -1;
756
+ for _ in 0..10 {
757
+ if let Some(event) = producer.next_event().await {
758
+ if let Some(id) = event.data.get("id").and_then(|v| v.as_i64()) {
759
+ assert!(id as i32 > last_idx, "Event ordering violated");
760
+ last_idx = id as i32;
761
+ }
762
+ }
763
+ }
764
+ }
765
+
766
+ #[tokio::test]
767
+ async fn test_sse_rapid_event_sending() {
768
+ let producer: RapidEventProducer = RapidEventProducer::new(100);
769
+
770
+ let mut count: usize = 0;
771
+ loop {
772
+ match producer.next_event().await {
773
+ Some(_event) => count += 1,
774
+ None => break,
775
+ }
776
+ }
777
+
778
+ assert_eq!(count, 100);
779
+ }
780
+
781
+ // ============================================================================
782
+ // Tests: Edge Cases & Error Handling
783
+ // ============================================================================
784
+
785
+ #[test]
786
+ fn test_sse_event_with_empty_data_object() {
787
+ let event: SseEvent = SseEvent::new(serde_json::json!({}));
788
+ assert!(event.data.is_object());
789
+ }
790
+
791
+ #[test]
792
+ fn test_sse_event_with_nested_data() {
793
+ let event: SseEvent = SseEvent::new(serde_json::json!({
794
+ "nested": {
795
+ "deep": {
796
+ "value": "found"
797
+ }
798
+ }
799
+ }));
800
+
801
+ let deep_value: Option<&str> = event
802
+ .data
803
+ .get("nested")
804
+ .and_then(|v| v.get("deep"))
805
+ .and_then(|v| v.get("value"))
806
+ .and_then(|v| v.as_str());
807
+
808
+ assert_eq!(deep_value, Some("found"));
809
+ }
810
+
811
+ #[tokio::test]
812
+ async fn test_sse_producer_stream_ends_cleanly() {
813
+ let producer: NoEventProducer = NoEventProducer;
814
+
815
+ let event1: Option<SseEvent> = producer.next_event().await;
816
+ assert!(event1.is_none());
817
+
818
+ let event2: Option<SseEvent> = producer.next_event().await;
819
+ assert!(event2.is_none());
820
+ }
821
+
822
+ #[test]
823
+ fn test_sse_event_clone() {
824
+ let original: SseEvent = SseEvent::with_type("test", serde_json::json!({"data": "test"}))
825
+ .with_id("id-1")
826
+ .with_retry(2000);
827
+
828
+ let cloned: SseEvent = original.clone();
829
+
830
+ assert_eq!(cloned.event_type, original.event_type);
831
+ assert_eq!(cloned.id, original.id);
832
+ assert_eq!(cloned.retry, original.retry);
833
+ assert_eq!(cloned.data, original.data);
834
+ }
835
+
836
+ #[test]
837
+ fn test_sse_event_debug_impl() {
838
+ let event: SseEvent = SseEvent::new(serde_json::json!({"msg": "debug"}));
839
+ let debug_str: String = format!("{:?}", event);
840
+ assert!(debug_str.contains("SseEvent"));
841
+ }
842
+
843
+ // ============================================================================
844
+ // Tests: Concurrent Stream Handling
845
+ // ============================================================================
846
+
847
+ #[tokio::test]
848
+ async fn test_sse_multiple_producers_independent() {
849
+ let producer1: TestProducer = TestProducer {
850
+ count: AtomicUsize::new(0),
851
+ };
852
+ let producer2: TestProducer = TestProducer {
853
+ count: AtomicUsize::new(0),
854
+ };
855
+
856
+ let _event1: Option<SseEvent> = producer1.next_event().await;
857
+ let _event2: Option<SseEvent> = producer2.next_event().await;
858
+
859
+ let count1: usize = producer1.count.load(Ordering::Relaxed);
860
+ let count2: usize = producer2.count.load(Ordering::Relaxed);
861
+
862
+ assert_eq!(count1, 1);
863
+ assert_eq!(count2, 1);
864
+ }
865
+
866
+ // ============================================================================
867
+ // Tests: Validation & Schema
868
+ // ============================================================================
869
+
870
+ #[test]
871
+ fn test_sse_state_cloning_preserves_schema() {
872
+ let producer: TestProducer = TestProducer {
873
+ count: AtomicUsize::new(0),
874
+ };
875
+ let schema: serde_json::Value = serde_json::json!({
876
+ "type": "object",
877
+ "properties": {
878
+ "message": {"type": "string"}
879
+ }
880
+ });
881
+
882
+ let state: SseState<TestProducer> =
883
+ SseState::with_schema(producer, Some(schema)).expect("schema should be valid");
884
+ let cloned: SseState<TestProducer> = state.clone();
885
+
886
+ assert!(Arc::ptr_eq(&state.producer, &cloned.producer));
887
+ match (&state.event_schema, &cloned.event_schema) {
888
+ (Some(s1), Some(s2)) => {
889
+ assert!(Arc::ptr_eq(s1, s2));
890
+ }
891
+ _ => panic!("Schema should be preserved in clone"),
892
+ }
893
+ }
894
+
895
+ // ============================================================================
896
+ // Tests: Payload & Data Integrity
897
+ // ============================================================================
898
+
899
+ #[tokio::test]
900
+ async fn test_sse_large_payload_integrity() {
901
+ let producer: LargePayloadProducer = LargePayloadProducer {
902
+ sent: AtomicBool::new(false),
903
+ };
904
+
905
+ let event: Option<SseEvent> = producer.next_event().await;
906
+ assert!(event.is_some());
907
+
908
+ if let Some(evt) = event {
909
+ let payload: Option<&str> = evt.data.get("payload").and_then(|v| v.as_str());
910
+ assert_eq!(payload.map(|s| s.len()), Some(100_000));
911
+ }
912
+ }
913
+
914
+ #[tokio::test]
915
+ async fn test_sse_multiline_data_preservation() {
916
+ let producer: MultilineProducer = MultilineProducer {
917
+ sent: AtomicBool::new(false),
918
+ };
919
+
920
+ let event: Option<SseEvent> = producer.next_event().await;
921
+ assert!(event.is_some());
922
+
923
+ if let Some(evt) = event {
924
+ let text: Option<&str> = evt.data.get("text").and_then(|v| v.as_str());
925
+ assert_eq!(text, Some("line1\nline2\nline3"));
926
+ }
927
+ }
928
+
929
+ #[tokio::test]
930
+ async fn test_sse_special_chars_in_payload() {
931
+ let producer: SpecialCharsProducer = SpecialCharsProducer {
932
+ sent: AtomicBool::new(false),
933
+ };
934
+
935
+ let event: Option<SseEvent> = producer.next_event().await;
936
+ assert!(event.is_some());
937
+
938
+ if let Some(evt) = event {
939
+ let data: Option<&str> = evt.data.get("data").and_then(|v| v.as_str());
940
+ assert!(data.is_some());
941
+ assert!(data.unwrap().contains("quotes"));
942
+ }
943
+ }
944
+
945
+ #[tokio::test]
946
+ async fn test_sse_full_event_fields_together() {
947
+ let producer: FullFieldProducer = FullFieldProducer {
948
+ sent: AtomicBool::new(false),
949
+ };
950
+
951
+ let event: Option<SseEvent> = producer.next_event().await;
952
+ assert!(event.is_some());
953
+
954
+ if let Some(evt) = event {
955
+ assert_eq!(evt.event_type, Some("counter_update".to_string()));
956
+ assert_eq!(evt.id, Some("event-123".to_string()));
957
+ assert_eq!(evt.retry, Some(5000));
958
+ assert_eq!(evt.data.get("count").and_then(|v| v.as_i64()), Some(42));
959
+ }
960
+ }
961
+ }