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.
Files changed (135) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +674 -674
  4. data/ext/spikard_rb/Cargo.toml +17 -17
  5. data/ext/spikard_rb/extconf.rb +13 -10
  6. data/ext/spikard_rb/src/lib.rs +6 -6
  7. data/lib/spikard/app.rb +405 -405
  8. data/lib/spikard/background.rb +27 -27
  9. data/lib/spikard/config.rb +396 -396
  10. data/lib/spikard/converters.rb +13 -13
  11. data/lib/spikard/handler_wrapper.rb +113 -113
  12. data/lib/spikard/provide.rb +214 -214
  13. data/lib/spikard/response.rb +173 -173
  14. data/lib/spikard/schema.rb +243 -243
  15. data/lib/spikard/sse.rb +111 -111
  16. data/lib/spikard/streaming_response.rb +44 -44
  17. data/lib/spikard/testing.rb +256 -256
  18. data/lib/spikard/upload_file.rb +131 -131
  19. data/lib/spikard/version.rb +5 -5
  20. data/lib/spikard/websocket.rb +59 -59
  21. data/lib/spikard.rb +43 -43
  22. data/sig/spikard.rbs +366 -366
  23. data/vendor/crates/spikard-bindings-shared/Cargo.toml +63 -63
  24. data/vendor/crates/spikard-bindings-shared/examples/config_extraction.rs +132 -132
  25. data/vendor/crates/spikard-bindings-shared/src/config_extractor.rs +752 -752
  26. data/vendor/crates/spikard-bindings-shared/src/conversion_traits.rs +194 -194
  27. data/vendor/crates/spikard-bindings-shared/src/di_traits.rs +246 -246
  28. data/vendor/crates/spikard-bindings-shared/src/error_response.rs +401 -401
  29. data/vendor/crates/spikard-bindings-shared/src/handler_base.rs +238 -238
  30. data/vendor/crates/spikard-bindings-shared/src/lib.rs +24 -24
  31. data/vendor/crates/spikard-bindings-shared/src/lifecycle_base.rs +292 -292
  32. data/vendor/crates/spikard-bindings-shared/src/lifecycle_executor.rs +616 -616
  33. data/vendor/crates/spikard-bindings-shared/src/response_builder.rs +305 -305
  34. data/vendor/crates/spikard-bindings-shared/src/test_client_base.rs +248 -248
  35. data/vendor/crates/spikard-bindings-shared/src/validation_helpers.rs +351 -351
  36. data/vendor/crates/spikard-bindings-shared/tests/comprehensive_coverage.rs +454 -454
  37. data/vendor/crates/spikard-bindings-shared/tests/error_response_edge_cases.rs +383 -383
  38. data/vendor/crates/spikard-bindings-shared/tests/handler_base_integration.rs +280 -280
  39. data/vendor/crates/spikard-core/Cargo.toml +40 -40
  40. data/vendor/crates/spikard-core/src/bindings/mod.rs +3 -3
  41. data/vendor/crates/spikard-core/src/bindings/response.rs +133 -133
  42. data/vendor/crates/spikard-core/src/debug.rs +127 -127
  43. data/vendor/crates/spikard-core/src/di/container.rs +702 -702
  44. data/vendor/crates/spikard-core/src/di/dependency.rs +273 -273
  45. data/vendor/crates/spikard-core/src/di/error.rs +118 -118
  46. data/vendor/crates/spikard-core/src/di/factory.rs +534 -534
  47. data/vendor/crates/spikard-core/src/di/graph.rs +506 -506
  48. data/vendor/crates/spikard-core/src/di/mod.rs +192 -192
  49. data/vendor/crates/spikard-core/src/di/resolved.rs +405 -405
  50. data/vendor/crates/spikard-core/src/di/value.rs +281 -281
  51. data/vendor/crates/spikard-core/src/errors.rs +69 -69
  52. data/vendor/crates/spikard-core/src/http.rs +415 -415
  53. data/vendor/crates/spikard-core/src/lib.rs +29 -29
  54. data/vendor/crates/spikard-core/src/lifecycle.rs +1186 -1186
  55. data/vendor/crates/spikard-core/src/metadata.rs +389 -389
  56. data/vendor/crates/spikard-core/src/parameters.rs +2525 -2525
  57. data/vendor/crates/spikard-core/src/problem.rs +344 -344
  58. data/vendor/crates/spikard-core/src/request_data.rs +1154 -1154
  59. data/vendor/crates/spikard-core/src/router.rs +510 -510
  60. data/vendor/crates/spikard-core/src/schema_registry.rs +183 -183
  61. data/vendor/crates/spikard-core/src/type_hints.rs +304 -304
  62. data/vendor/crates/spikard-core/src/validation/error_mapper.rs +696 -688
  63. data/vendor/crates/spikard-core/src/validation/mod.rs +457 -457
  64. data/vendor/crates/spikard-http/Cargo.toml +62 -64
  65. data/vendor/crates/spikard-http/examples/sse-notifications.rs +148 -148
  66. data/vendor/crates/spikard-http/examples/websocket-chat.rs +92 -92
  67. data/vendor/crates/spikard-http/src/auth.rs +296 -296
  68. data/vendor/crates/spikard-http/src/background.rs +1860 -1860
  69. data/vendor/crates/spikard-http/src/bindings/mod.rs +3 -3
  70. data/vendor/crates/spikard-http/src/bindings/response.rs +1 -1
  71. data/vendor/crates/spikard-http/src/body_metadata.rs +8 -8
  72. data/vendor/crates/spikard-http/src/cors.rs +1005 -1005
  73. data/vendor/crates/spikard-http/src/debug.rs +128 -128
  74. data/vendor/crates/spikard-http/src/di_handler.rs +1668 -1668
  75. data/vendor/crates/spikard-http/src/handler_response.rs +901 -901
  76. data/vendor/crates/spikard-http/src/handler_trait.rs +838 -830
  77. data/vendor/crates/spikard-http/src/handler_trait_tests.rs +290 -290
  78. data/vendor/crates/spikard-http/src/lib.rs +534 -534
  79. data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +230 -230
  80. data/vendor/crates/spikard-http/src/lifecycle.rs +1193 -1193
  81. data/vendor/crates/spikard-http/src/middleware/mod.rs +560 -540
  82. data/vendor/crates/spikard-http/src/middleware/multipart.rs +912 -912
  83. data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +513 -513
  84. data/vendor/crates/spikard-http/src/middleware/validation.rs +768 -735
  85. data/vendor/crates/spikard-http/src/openapi/mod.rs +309 -309
  86. data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +535 -535
  87. data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +1363 -1363
  88. data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +665 -665
  89. data/vendor/crates/spikard-http/src/query_parser.rs +793 -793
  90. data/vendor/crates/spikard-http/src/response.rs +720 -720
  91. data/vendor/crates/spikard-http/src/server/handler.rs +1650 -1650
  92. data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +234 -234
  93. data/vendor/crates/spikard-http/src/server/mod.rs +1593 -1502
  94. data/vendor/crates/spikard-http/src/server/request_extraction.rs +789 -770
  95. data/vendor/crates/spikard-http/src/server/routing_factory.rs +629 -599
  96. data/vendor/crates/spikard-http/src/sse.rs +1409 -1409
  97. data/vendor/crates/spikard-http/src/testing/form.rs +52 -52
  98. data/vendor/crates/spikard-http/src/testing/multipart.rs +64 -60
  99. data/vendor/crates/spikard-http/src/testing/test_client.rs +311 -283
  100. data/vendor/crates/spikard-http/src/testing.rs +406 -377
  101. data/vendor/crates/spikard-http/src/websocket.rs +1404 -1375
  102. data/vendor/crates/spikard-http/tests/background_behavior.rs +832 -832
  103. data/vendor/crates/spikard-http/tests/common/handlers.rs +309 -309
  104. data/vendor/crates/spikard-http/tests/common/mod.rs +26 -26
  105. data/vendor/crates/spikard-http/tests/di_integration.rs +192 -192
  106. data/vendor/crates/spikard-http/tests/doc_snippets.rs +5 -5
  107. data/vendor/crates/spikard-http/tests/lifecycle_execution.rs +1093 -1093
  108. data/vendor/crates/spikard-http/tests/multipart_behavior.rs +656 -656
  109. data/vendor/crates/spikard-http/tests/server_config_builder.rs +314 -314
  110. data/vendor/crates/spikard-http/tests/sse_behavior.rs +620 -620
  111. data/vendor/crates/spikard-http/tests/websocket_behavior.rs +663 -663
  112. data/vendor/crates/spikard-rb/Cargo.toml +48 -48
  113. data/vendor/crates/spikard-rb/build.rs +199 -199
  114. data/vendor/crates/spikard-rb/src/background.rs +63 -63
  115. data/vendor/crates/spikard-rb/src/config/mod.rs +5 -5
  116. data/vendor/crates/spikard-rb/src/config/server_config.rs +285 -285
  117. data/vendor/crates/spikard-rb/src/conversion.rs +554 -554
  118. data/vendor/crates/spikard-rb/src/di/builder.rs +100 -100
  119. data/vendor/crates/spikard-rb/src/di/mod.rs +375 -375
  120. data/vendor/crates/spikard-rb/src/handler.rs +618 -618
  121. data/vendor/crates/spikard-rb/src/integration/mod.rs +3 -3
  122. data/vendor/crates/spikard-rb/src/lib.rs +1806 -1810
  123. data/vendor/crates/spikard-rb/src/lifecycle.rs +275 -275
  124. data/vendor/crates/spikard-rb/src/metadata/mod.rs +5 -5
  125. data/vendor/crates/spikard-rb/src/metadata/route_extraction.rs +442 -447
  126. data/vendor/crates/spikard-rb/src/runtime/mod.rs +5 -5
  127. data/vendor/crates/spikard-rb/src/runtime/server_runner.rs +324 -324
  128. data/vendor/crates/spikard-rb/src/server.rs +305 -308
  129. data/vendor/crates/spikard-rb/src/sse.rs +231 -231
  130. data/vendor/crates/spikard-rb/src/testing/client.rs +538 -551
  131. data/vendor/crates/spikard-rb/src/testing/mod.rs +7 -7
  132. data/vendor/crates/spikard-rb/src/testing/sse.rs +143 -143
  133. data/vendor/crates/spikard-rb/src/testing/websocket.rs +608 -635
  134. data/vendor/crates/spikard-rb/src/websocket.rs +377 -374
  135. metadata +15 -1
@@ -1,1375 +1,1404 @@
1
- //! WebSocket support for Spikard
2
- //!
3
- //! Provides WebSocket connection handling with message validation and routing.
4
-
5
- use axum::{
6
- extract::{
7
- State,
8
- ws::{Message, WebSocket, WebSocketUpgrade},
9
- },
10
- response::IntoResponse,
11
- };
12
- use serde_json::Value;
13
- use std::sync::Arc;
14
- use tracing::{debug, error, info, warn};
15
-
16
- fn trace_ws(message: &str) {
17
- if std::env::var("SPIKARD_WS_TRACE").ok().as_deref() == Some("1") {
18
- eprintln!("[spikard-ws] {message}");
19
- }
20
- }
21
-
22
- /// WebSocket message handler trait
23
- ///
24
- /// Implement this trait to create custom WebSocket message handlers for your application.
25
- /// The handler processes JSON messages received from WebSocket clients and can optionally
26
- /// send responses back.
27
- ///
28
- /// # Implementing the Trait
29
- ///
30
- /// You must implement the `handle_message` method. The `on_connect` and `on_disconnect`
31
- /// methods are optional and provide lifecycle hooks.
32
- ///
33
- /// # Example
34
- ///
35
- /// ```ignore
36
- /// use spikard_http::websocket::WebSocketHandler;
37
- /// use serde_json::{json, Value};
38
- ///
39
- /// struct EchoHandler;
40
- ///
41
- /// #[async_trait]
42
- /// impl WebSocketHandler for EchoHandler {
43
- /// async fn handle_message(&self, message: Value) -> Option<Value> {
44
- /// // Echo the message back to the client
45
- /// Some(message)
46
- /// }
47
- ///
48
- /// async fn on_connect(&self) {
49
- /// println!("Client connected");
50
- /// }
51
- ///
52
- /// async fn on_disconnect(&self) {
53
- /// println!("Client disconnected");
54
- /// }
55
- /// }
56
- /// ```
57
- pub trait WebSocketHandler: Send + Sync {
58
- /// Handle incoming WebSocket message
59
- ///
60
- /// Called whenever a text message is received from a WebSocket client.
61
- /// Messages are automatically parsed as JSON.
62
- ///
63
- /// # Arguments
64
- /// * `message` - JSON value received from the client
65
- ///
66
- /// # Returns
67
- /// * `Some(value)` - JSON value to send back to the client
68
- /// * `None` - No response to send
69
- fn handle_message(&self, message: Value) -> impl std::future::Future<Output = Option<Value>> + Send;
70
-
71
- /// Called when a client connects to the WebSocket
72
- ///
73
- /// Optional lifecycle hook invoked when a new WebSocket connection is established.
74
- /// Default implementation does nothing.
75
- fn on_connect(&self) -> impl std::future::Future<Output = ()> + Send {
76
- async {}
77
- }
78
-
79
- /// Called when a client disconnects from the WebSocket
80
- ///
81
- /// Optional lifecycle hook invoked when a WebSocket connection is closed
82
- /// (either by the client or due to an error). Default implementation does nothing.
83
- fn on_disconnect(&self) -> impl std::future::Future<Output = ()> + Send {
84
- async {}
85
- }
86
- }
87
-
88
- /// WebSocket state shared across connections
89
- ///
90
- /// Contains the message handler and optional JSON schemas for validating
91
- /// incoming and outgoing messages. This state is shared among all connections
92
- /// to the same WebSocket endpoint.
93
- #[derive(Debug)]
94
- pub struct WebSocketState<H: WebSocketHandler> {
95
- /// The message handler implementation
96
- handler: Arc<H>,
97
- /// Optional JSON Schema for validating incoming messages
98
- message_schema: Option<Arc<jsonschema::Validator>>,
99
- /// Optional JSON Schema for validating outgoing responses
100
- response_schema: Option<Arc<jsonschema::Validator>>,
101
- }
102
-
103
- impl<H: WebSocketHandler> Clone for WebSocketState<H> {
104
- fn clone(&self) -> Self {
105
- Self {
106
- handler: Arc::clone(&self.handler),
107
- message_schema: self.message_schema.clone(),
108
- response_schema: self.response_schema.clone(),
109
- }
110
- }
111
- }
112
-
113
- impl<H: WebSocketHandler + 'static> WebSocketState<H> {
114
- /// Create new WebSocket state with a handler
115
- ///
116
- /// Creates a new state without message or response validation schemas.
117
- /// Messages and responses are not validated.
118
- ///
119
- /// # Arguments
120
- /// * `handler` - The message handler implementation
121
- ///
122
- /// # Example
123
- ///
124
- /// ```ignore
125
- /// let state = WebSocketState::new(MyHandler);
126
- /// ```
127
- pub fn new(handler: H) -> Self {
128
- Self {
129
- handler: Arc::new(handler),
130
- message_schema: None,
131
- response_schema: None,
132
- }
133
- }
134
-
135
- /// Create new WebSocket state with a handler and optional validation schemas
136
- ///
137
- /// Creates a new state with optional JSON schemas for validating incoming messages
138
- /// and outgoing responses. If a schema is provided and validation fails, the message
139
- /// or response is rejected.
140
- ///
141
- /// # Arguments
142
- /// * `handler` - The message handler implementation
143
- /// * `message_schema` - Optional JSON schema for validating client messages
144
- /// * `response_schema` - Optional JSON schema for validating handler responses
145
- ///
146
- /// # Returns
147
- /// * `Ok(state)` - Successfully created state
148
- /// * `Err(msg)` - Invalid schema provided
149
- ///
150
- /// # Example
151
- ///
152
- /// ```ignore
153
- /// use serde_json::json;
154
- ///
155
- /// let message_schema = json!({
156
- /// "type": "object",
157
- /// "properties": {
158
- /// "type": {"type": "string"},
159
- /// "data": {"type": "string"}
160
- /// }
161
- /// });
162
- ///
163
- /// let state = WebSocketState::with_schemas(
164
- /// MyHandler,
165
- /// Some(message_schema),
166
- /// None,
167
- /// )?;
168
- /// ```
169
- pub fn with_schemas(
170
- handler: H,
171
- message_schema: Option<serde_json::Value>,
172
- response_schema: Option<serde_json::Value>,
173
- ) -> Result<Self, String> {
174
- let message_validator = if let Some(schema) = message_schema {
175
- Some(Arc::new(
176
- jsonschema::validator_for(&schema).map_err(|e| format!("Invalid message schema: {}", e))?,
177
- ))
178
- } else {
179
- None
180
- };
181
-
182
- let response_validator = if let Some(schema) = response_schema {
183
- Some(Arc::new(
184
- jsonschema::validator_for(&schema).map_err(|e| format!("Invalid response schema: {}", e))?,
185
- ))
186
- } else {
187
- None
188
- };
189
-
190
- Ok(Self {
191
- handler: Arc::new(handler),
192
- message_schema: message_validator,
193
- response_schema: response_validator,
194
- })
195
- }
196
- }
197
-
198
- /// WebSocket upgrade handler
199
- ///
200
- /// This is the main entry point for WebSocket connections. Use this as an Axum route
201
- /// handler by passing it to an Axum router's `.route()` method with `get()`.
202
- ///
203
- /// # Arguments
204
- /// * `ws` - WebSocket upgrade from Axum
205
- /// * `State(state)` - Application state containing the handler and optional schemas
206
- ///
207
- /// # Returns
208
- /// An Axum response that upgrades the connection to WebSocket
209
- ///
210
- /// # Example
211
- ///
212
- /// ```ignore
213
- /// use axum::{Router, routing::get, extract::State};
214
- ///
215
- /// let state = WebSocketState::new(MyHandler);
216
- /// let router = Router::new()
217
- /// .route("/ws", get(websocket_handler::<MyHandler>))
218
- /// .with_state(state);
219
- /// ```
220
- pub async fn websocket_handler<H: WebSocketHandler + 'static>(
221
- ws: WebSocketUpgrade,
222
- State(state): State<WebSocketState<H>>,
223
- ) -> impl IntoResponse {
224
- ws.on_upgrade(move |socket| handle_socket(socket, state))
225
- }
226
-
227
- /// Handle an individual WebSocket connection
228
- async fn handle_socket<H: WebSocketHandler>(mut socket: WebSocket, state: WebSocketState<H>) {
229
- info!("WebSocket client connected");
230
- trace_ws("socket:connected");
231
-
232
- state.handler.on_connect().await;
233
- trace_ws("socket:on_connect:done");
234
-
235
- while let Some(msg) = socket.recv().await {
236
- match msg {
237
- Ok(Message::Text(text)) => {
238
- debug!("Received text message: {}", text);
239
- trace_ws(&format!("recv:text len={}", text.len()));
240
-
241
- match serde_json::from_str::<Value>(&text) {
242
- Ok(json_msg) => {
243
- trace_ws("recv:text:json-ok");
244
- if let Some(validator) = &state.message_schema
245
- && !validator.is_valid(&json_msg)
246
- {
247
- error!("Message validation failed");
248
- trace_ws("recv:text:validation-failed");
249
- let error_response = serde_json::json!({
250
- "error": "Message validation failed"
251
- });
252
- if let Ok(error_text) = serde_json::to_string(&error_response) {
253
- trace_ws(&format!("send:validation-error len={}", error_text.len()));
254
- let _ = socket.send(Message::Text(error_text.into())).await;
255
- }
256
- continue;
257
- }
258
-
259
- if let Some(response) = state.handler.handle_message(json_msg).await {
260
- trace_ws("handler:response:some");
261
- if let Some(validator) = &state.response_schema
262
- && !validator.is_valid(&response)
263
- {
264
- error!("Response validation failed");
265
- trace_ws("send:response:validation-failed");
266
- continue;
267
- }
268
-
269
- let response_text = serde_json::to_string(&response).unwrap_or_else(|_| "{}".to_string());
270
- let response_len = response_text.len();
271
-
272
- if let Err(e) = socket.send(Message::Text(response_text.into())).await {
273
- error!("Failed to send response: {}", e);
274
- trace_ws("send:response:error");
275
- break;
276
- }
277
- trace_ws(&format!("send:response len={}", response_len));
278
- } else {
279
- trace_ws("handler:response:none");
280
- }
281
- }
282
- Err(e) => {
283
- warn!("Failed to parse JSON message: {}", e);
284
- trace_ws("recv:text:json-error");
285
- let error_msg = serde_json::json!({
286
- "type": "error",
287
- "message": "Invalid JSON"
288
- });
289
- let error_text = serde_json::to_string(&error_msg).unwrap_or_else(|_| "{}".to_string());
290
- trace_ws(&format!("send:json-error len={}", error_text.len()));
291
- let _ = socket.send(Message::Text(error_text.into())).await;
292
- }
293
- }
294
- }
295
- Ok(Message::Binary(data)) => {
296
- debug!("Received binary message: {} bytes", data.len());
297
- trace_ws(&format!("recv:binary len={}", data.len()));
298
- if let Err(e) = socket.send(Message::Binary(data)).await {
299
- error!("Failed to send binary response: {}", e);
300
- trace_ws("send:binary:error");
301
- break;
302
- }
303
- trace_ws("send:binary:ok");
304
- }
305
- Ok(Message::Ping(data)) => {
306
- debug!("Received ping");
307
- trace_ws(&format!("recv:ping len={}", data.len()));
308
- if let Err(e) = socket.send(Message::Pong(data)).await {
309
- error!("Failed to send pong: {}", e);
310
- trace_ws("send:pong:error");
311
- break;
312
- }
313
- trace_ws("send:pong:ok");
314
- }
315
- Ok(Message::Pong(_)) => {
316
- debug!("Received pong");
317
- trace_ws("recv:pong");
318
- }
319
- Ok(Message::Close(_)) => {
320
- info!("Client closed connection");
321
- trace_ws("recv:close");
322
- break;
323
- }
324
- Err(e) => {
325
- error!("WebSocket error: {}", e);
326
- trace_ws(&format!("recv:error {}", e));
327
- break;
328
- }
329
- }
330
- }
331
-
332
- state.handler.on_disconnect().await;
333
- trace_ws("socket:on_disconnect:done");
334
- info!("WebSocket client disconnected");
335
- }
336
-
337
- #[cfg(test)]
338
- mod tests {
339
- use super::*;
340
- use std::sync::Mutex;
341
- use std::sync::atomic::{AtomicUsize, Ordering};
342
-
343
- #[derive(Debug)]
344
- struct EchoHandler;
345
-
346
- impl WebSocketHandler for EchoHandler {
347
- async fn handle_message(&self, message: Value) -> Option<Value> {
348
- Some(message)
349
- }
350
- }
351
-
352
- #[derive(Debug)]
353
- struct TrackingHandler {
354
- connect_count: Arc<AtomicUsize>,
355
- disconnect_count: Arc<AtomicUsize>,
356
- message_count: Arc<AtomicUsize>,
357
- messages: Arc<Mutex<Vec<Value>>>,
358
- }
359
-
360
- impl TrackingHandler {
361
- fn new() -> Self {
362
- Self {
363
- connect_count: Arc::new(AtomicUsize::new(0)),
364
- disconnect_count: Arc::new(AtomicUsize::new(0)),
365
- message_count: Arc::new(AtomicUsize::new(0)),
366
- messages: Arc::new(Mutex::new(Vec::new())),
367
- }
368
- }
369
- }
370
-
371
- impl WebSocketHandler for TrackingHandler {
372
- async fn handle_message(&self, message: Value) -> Option<Value> {
373
- self.message_count.fetch_add(1, Ordering::SeqCst);
374
- self.messages.lock().unwrap().push(message.clone());
375
- Some(message)
376
- }
377
-
378
- async fn on_connect(&self) {
379
- self.connect_count.fetch_add(1, Ordering::SeqCst);
380
- }
381
-
382
- async fn on_disconnect(&self) {
383
- self.disconnect_count.fetch_add(1, Ordering::SeqCst);
384
- }
385
- }
386
-
387
- #[derive(Debug)]
388
- struct SelectiveHandler;
389
-
390
- impl WebSocketHandler for SelectiveHandler {
391
- async fn handle_message(&self, message: Value) -> Option<Value> {
392
- if message.get("respond").is_some_and(|v| v.as_bool().unwrap_or(false)) {
393
- Some(serde_json::json!({"response": "acknowledged"}))
394
- } else {
395
- None
396
- }
397
- }
398
- }
399
-
400
- #[derive(Debug)]
401
- struct TransformHandler;
402
-
403
- impl WebSocketHandler for TransformHandler {
404
- async fn handle_message(&self, message: Value) -> Option<Value> {
405
- message.as_object().map_or(None, |obj| {
406
- let mut resp = obj.clone();
407
- resp.insert("processed".to_string(), Value::Bool(true));
408
- Some(Value::Object(resp))
409
- })
410
- }
411
- }
412
-
413
- #[test]
414
- fn test_websocket_state_creation() {
415
- let handler: EchoHandler = EchoHandler;
416
- let state: WebSocketState<EchoHandler> = WebSocketState::new(handler);
417
- let cloned: WebSocketState<EchoHandler> = state.clone();
418
- assert!(Arc::ptr_eq(&state.handler, &cloned.handler));
419
- }
420
-
421
- #[test]
422
- fn test_websocket_state_with_valid_schema() {
423
- let handler: EchoHandler = EchoHandler;
424
- let schema: serde_json::Value = serde_json::json!({
425
- "type": "object",
426
- "properties": {
427
- "type": {"type": "string"}
428
- }
429
- });
430
-
431
- let result: Result<WebSocketState<EchoHandler>, String> =
432
- WebSocketState::with_schemas(handler, Some(schema), None);
433
- assert!(result.is_ok());
434
- }
435
-
436
- #[test]
437
- fn test_websocket_state_with_invalid_schema() {
438
- let handler: EchoHandler = EchoHandler;
439
- let invalid_schema: serde_json::Value = serde_json::json!({
440
- "type": "not_a_real_type",
441
- "invalid": "schema"
442
- });
443
-
444
- let result: Result<WebSocketState<EchoHandler>, String> =
445
- WebSocketState::with_schemas(handler, Some(invalid_schema), None);
446
- assert!(result.is_err());
447
- if let Err(error_msg) = result {
448
- assert!(error_msg.contains("Invalid message schema"));
449
- }
450
- }
451
-
452
- #[test]
453
- fn test_websocket_state_with_both_schemas() {
454
- let handler: EchoHandler = EchoHandler;
455
- let message_schema: serde_json::Value = serde_json::json!({
456
- "type": "object",
457
- "properties": {"action": {"type": "string"}}
458
- });
459
- let response_schema: serde_json::Value = serde_json::json!({
460
- "type": "object",
461
- "properties": {"result": {"type": "string"}}
462
- });
463
-
464
- let result: Result<WebSocketState<EchoHandler>, String> =
465
- WebSocketState::with_schemas(handler, Some(message_schema), Some(response_schema));
466
- assert!(result.is_ok());
467
- let state: WebSocketState<EchoHandler> = result.unwrap();
468
- assert!(state.message_schema.is_some());
469
- assert!(state.response_schema.is_some());
470
- }
471
-
472
- #[test]
473
- fn test_websocket_state_cloning_preserves_schemas() {
474
- let handler: EchoHandler = EchoHandler;
475
- let schema: serde_json::Value = serde_json::json!({
476
- "type": "object",
477
- "properties": {"id": {"type": "integer"}}
478
- });
479
-
480
- let state: WebSocketState<EchoHandler> = WebSocketState::with_schemas(handler, Some(schema), None).unwrap();
481
- let cloned: WebSocketState<EchoHandler> = state.clone();
482
-
483
- assert!(cloned.message_schema.is_some());
484
- assert!(cloned.response_schema.is_none());
485
- assert!(Arc::ptr_eq(&state.handler, &cloned.handler));
486
- }
487
-
488
- #[tokio::test]
489
- async fn test_tracking_handler_lifecycle() {
490
- let handler: TrackingHandler = TrackingHandler::new();
491
- handler.on_connect().await;
492
- assert_eq!(handler.connect_count.load(Ordering::SeqCst), 1);
493
-
494
- let msg: Value = serde_json::json!({"test": "data"});
495
- let _response: Option<Value> = handler.handle_message(msg).await;
496
- assert_eq!(handler.message_count.load(Ordering::SeqCst), 1);
497
-
498
- handler.on_disconnect().await;
499
- assert_eq!(handler.disconnect_count.load(Ordering::SeqCst), 1);
500
- }
501
-
502
- #[tokio::test]
503
- async fn test_selective_handler_responds_conditionally() {
504
- let handler: SelectiveHandler = SelectiveHandler;
505
-
506
- let respond_msg: Value = serde_json::json!({"respond": true});
507
- let response1: Option<Value> = handler.handle_message(respond_msg).await;
508
- assert!(response1.is_some());
509
- assert_eq!(response1.unwrap(), serde_json::json!({"response": "acknowledged"}));
510
-
511
- let no_respond_msg: Value = serde_json::json!({"respond": false});
512
- let response2: Option<Value> = handler.handle_message(no_respond_msg).await;
513
- assert!(response2.is_none());
514
- }
515
-
516
- #[tokio::test]
517
- async fn test_transform_handler_modifies_message() {
518
- let handler: TransformHandler = TransformHandler;
519
- let original: Value = serde_json::json!({"name": "test"});
520
- let transformed: Option<Value> = handler.handle_message(original).await;
521
-
522
- assert!(transformed.is_some());
523
- let resp: Value = transformed.unwrap();
524
- assert_eq!(resp.get("name").unwrap(), "test");
525
- assert_eq!(resp.get("processed").unwrap(), true);
526
- }
527
-
528
- #[tokio::test]
529
- async fn test_echo_handler_preserves_json_types() {
530
- let handler: EchoHandler = EchoHandler;
531
-
532
- let messages: Vec<Value> = vec![
533
- serde_json::json!({"string": "value"}),
534
- serde_json::json!({"number": 42}),
535
- serde_json::json!({"float": 3.14}),
536
- serde_json::json!({"bool": true}),
537
- serde_json::json!({"null": null}),
538
- serde_json::json!({"array": [1, 2, 3]}),
539
- ];
540
-
541
- for msg in messages {
542
- let response: Option<Value> = handler.handle_message(msg.clone()).await;
543
- assert!(response.is_some());
544
- assert_eq!(response.unwrap(), msg);
545
- }
546
- }
547
-
548
- #[tokio::test]
549
- async fn test_tracking_handler_accumulates_messages() {
550
- let handler: TrackingHandler = TrackingHandler::new();
551
-
552
- let messages: Vec<Value> = vec![
553
- serde_json::json!({"id": 1}),
554
- serde_json::json!({"id": 2}),
555
- serde_json::json!({"id": 3}),
556
- ];
557
-
558
- for msg in messages {
559
- let _: Option<Value> = handler.handle_message(msg).await;
560
- }
561
-
562
- assert_eq!(handler.message_count.load(Ordering::SeqCst), 3);
563
- let stored: Vec<Value> = handler.messages.lock().unwrap().clone();
564
- assert_eq!(stored.len(), 3);
565
- assert_eq!(stored[0].get("id").unwrap(), 1);
566
- assert_eq!(stored[1].get("id").unwrap(), 2);
567
- assert_eq!(stored[2].get("id").unwrap(), 3);
568
- }
569
-
570
- #[tokio::test]
571
- async fn test_echo_handler_with_nested_json() {
572
- let handler: EchoHandler = EchoHandler;
573
- let nested: Value = serde_json::json!({
574
- "level1": {
575
- "level2": {
576
- "level3": {
577
- "value": "deeply nested"
578
- }
579
- }
580
- }
581
- });
582
-
583
- let response: Option<Value> = handler.handle_message(nested.clone()).await;
584
- assert!(response.is_some());
585
- assert_eq!(response.unwrap(), nested);
586
- }
587
-
588
- #[tokio::test]
589
- async fn test_echo_handler_with_large_array() {
590
- let handler: EchoHandler = EchoHandler;
591
- let large_array: Value = serde_json::json!({
592
- "items": (0..1000).collect::<Vec<i32>>()
593
- });
594
-
595
- let response: Option<Value> = handler.handle_message(large_array.clone()).await;
596
- assert!(response.is_some());
597
- assert_eq!(response.unwrap(), large_array);
598
- }
599
-
600
- #[tokio::test]
601
- async fn test_echo_handler_with_unicode() {
602
- let handler: EchoHandler = EchoHandler;
603
- let unicode_msg: Value = serde_json::json!({
604
- "emoji": "🚀",
605
- "chinese": "你好",
606
- "arabic": "مرحبا",
607
- "mixed": "Hello 世界 🌍"
608
- });
609
-
610
- let response: Option<Value> = handler.handle_message(unicode_msg.clone()).await;
611
- assert!(response.is_some());
612
- assert_eq!(response.unwrap(), unicode_msg);
613
- }
614
-
615
- #[test]
616
- fn test_websocket_state_schemas_are_independent() {
617
- let handler: EchoHandler = EchoHandler;
618
- let message_schema: serde_json::Value = serde_json::json!({"type": "object"});
619
- let response_schema: serde_json::Value = serde_json::json!({"type": "array"});
620
-
621
- let state: WebSocketState<EchoHandler> =
622
- WebSocketState::with_schemas(handler, Some(message_schema), Some(response_schema)).unwrap();
623
-
624
- let cloned: WebSocketState<EchoHandler> = state.clone();
625
-
626
- assert!(state.message_schema.is_some());
627
- assert!(state.response_schema.is_some());
628
- assert!(cloned.message_schema.is_some());
629
- assert!(cloned.response_schema.is_some());
630
- }
631
-
632
- #[test]
633
- fn test_message_schema_validation_with_required_field() {
634
- let handler: EchoHandler = EchoHandler;
635
- let message_schema: serde_json::Value = serde_json::json!({
636
- "type": "object",
637
- "properties": {"type": {"type": "string"}},
638
- "required": ["type"]
639
- });
640
-
641
- let state: WebSocketState<EchoHandler> =
642
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
643
-
644
- assert!(state.message_schema.is_some());
645
- assert!(state.response_schema.is_none());
646
-
647
- let valid_msg: Value = serde_json::json!({"type": "test"});
648
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
649
- assert!(validator.is_valid(&valid_msg));
650
-
651
- let invalid_msg: Value = serde_json::json!({"other": "field"});
652
- assert!(!validator.is_valid(&invalid_msg));
653
- }
654
-
655
- #[test]
656
- fn test_response_schema_validation_with_required_field() {
657
- let handler: EchoHandler = EchoHandler;
658
- let response_schema: serde_json::Value = serde_json::json!({
659
- "type": "object",
660
- "properties": {"status": {"type": "string"}},
661
- "required": ["status"]
662
- });
663
-
664
- let state: WebSocketState<EchoHandler> =
665
- WebSocketState::with_schemas(handler, None, Some(response_schema)).unwrap();
666
-
667
- assert!(state.message_schema.is_none());
668
- assert!(state.response_schema.is_some());
669
-
670
- let valid_response: Value = serde_json::json!({"status": "ok"});
671
- let validator: &jsonschema::Validator = state.response_schema.as_ref().unwrap();
672
- assert!(validator.is_valid(&valid_response));
673
-
674
- let invalid_response: Value = serde_json::json!({"other": "field"});
675
- assert!(!validator.is_valid(&invalid_response));
676
- }
677
-
678
- #[test]
679
- fn test_invalid_message_schema_returns_error() {
680
- let handler: EchoHandler = EchoHandler;
681
- let invalid_schema: serde_json::Value = serde_json::json!({
682
- "type": "invalid_type_value",
683
- "properties": {}
684
- });
685
-
686
- let result: Result<WebSocketState<EchoHandler>, String> =
687
- WebSocketState::with_schemas(handler, Some(invalid_schema), None);
688
-
689
- assert!(result.is_err());
690
- match result {
691
- Err(error_msg) => assert!(error_msg.contains("Invalid message schema")),
692
- Ok(_) => panic!("Expected error but got Ok"),
693
- }
694
- }
695
-
696
- #[test]
697
- fn test_invalid_response_schema_returns_error() {
698
- let handler: EchoHandler = EchoHandler;
699
- let invalid_schema: serde_json::Value = serde_json::json!({
700
- "type": "definitely_not_valid"
701
- });
702
-
703
- let result: Result<WebSocketState<EchoHandler>, String> =
704
- WebSocketState::with_schemas(handler, None, Some(invalid_schema));
705
-
706
- assert!(result.is_err());
707
- match result {
708
- Err(error_msg) => assert!(error_msg.contains("Invalid response schema")),
709
- Ok(_) => panic!("Expected error but got Ok"),
710
- }
711
- }
712
-
713
- #[tokio::test]
714
- async fn test_handler_returning_none_response() {
715
- let handler: SelectiveHandler = SelectiveHandler;
716
-
717
- let no_response_msg: Value = serde_json::json!({"respond": false});
718
- let result: Option<Value> = handler.handle_message(no_response_msg).await;
719
-
720
- assert!(result.is_none());
721
- }
722
-
723
- #[tokio::test]
724
- async fn test_handler_with_complex_schema_validation() {
725
- let handler: EchoHandler = EchoHandler;
726
- let message_schema: serde_json::Value = serde_json::json!({
727
- "type": "object",
728
- "properties": {
729
- "user": {
730
- "type": "object",
731
- "properties": {
732
- "id": {"type": "integer"},
733
- "name": {"type": "string"}
734
- },
735
- "required": ["id", "name"]
736
- },
737
- "action": {"type": "string"}
738
- },
739
- "required": ["user", "action"]
740
- });
741
-
742
- let state: WebSocketState<EchoHandler> =
743
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
744
-
745
- let valid_msg: Value = serde_json::json!({
746
- "user": {"id": 123, "name": "Alice"},
747
- "action": "create"
748
- });
749
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
750
- assert!(validator.is_valid(&valid_msg));
751
-
752
- let invalid_msg: Value = serde_json::json!({
753
- "user": {"id": "not_an_int", "name": "Bob"},
754
- "action": "create"
755
- });
756
- assert!(!validator.is_valid(&invalid_msg));
757
- }
758
-
759
- #[tokio::test]
760
- async fn test_tracking_handler_with_multiple_message_types() {
761
- let handler: TrackingHandler = TrackingHandler::new();
762
-
763
- let messages: Vec<Value> = vec![
764
- serde_json::json!({"type": "text", "content": "hello"}),
765
- serde_json::json!({"type": "image", "url": "http://example.com/image.png"}),
766
- serde_json::json!({"type": "video", "duration": 120}),
767
- ];
768
-
769
- for msg in messages {
770
- let _: Option<Value> = handler.handle_message(msg).await;
771
- }
772
-
773
- assert_eq!(handler.message_count.load(Ordering::SeqCst), 3);
774
- let stored: Vec<Value> = handler.messages.lock().unwrap().clone();
775
- assert_eq!(stored.len(), 3);
776
- assert_eq!(stored[0].get("type").unwrap(), "text");
777
- assert_eq!(stored[1].get("type").unwrap(), "image");
778
- assert_eq!(stored[2].get("type").unwrap(), "video");
779
- }
780
-
781
- #[tokio::test]
782
- async fn test_selective_handler_with_explicit_false() {
783
- let handler: SelectiveHandler = SelectiveHandler;
784
-
785
- let msg: Value = serde_json::json!({"respond": false, "data": "test"});
786
- let response: Option<Value> = handler.handle_message(msg).await;
787
-
788
- assert!(response.is_none());
789
- }
790
-
791
- #[tokio::test]
792
- async fn test_selective_handler_without_respond_field() {
793
- let handler: SelectiveHandler = SelectiveHandler;
794
-
795
- let msg: Value = serde_json::json!({"data": "test"});
796
- let response: Option<Value> = handler.handle_message(msg).await;
797
-
798
- assert!(response.is_none());
799
- }
800
-
801
- #[tokio::test]
802
- async fn test_transform_handler_with_empty_object() {
803
- let handler: TransformHandler = TransformHandler;
804
- let original: Value = serde_json::json!({});
805
- let transformed: Option<Value> = handler.handle_message(original).await;
806
-
807
- assert!(transformed.is_some());
808
- let resp: Value = transformed.unwrap();
809
- assert_eq!(resp.get("processed").unwrap(), true);
810
- assert_eq!(resp.as_object().unwrap().len(), 1);
811
- }
812
-
813
- #[tokio::test]
814
- async fn test_transform_handler_preserves_all_fields() {
815
- let handler: TransformHandler = TransformHandler;
816
- let original: Value = serde_json::json!({
817
- "field1": "value1",
818
- "field2": 42,
819
- "field3": true,
820
- "nested": {"key": "value"}
821
- });
822
- let transformed: Option<Value> = handler.handle_message(original.clone()).await;
823
-
824
- assert!(transformed.is_some());
825
- let resp: Value = transformed.unwrap();
826
- assert_eq!(resp.get("field1").unwrap(), "value1");
827
- assert_eq!(resp.get("field2").unwrap(), 42);
828
- assert_eq!(resp.get("field3").unwrap(), true);
829
- assert_eq!(resp.get("nested").unwrap(), &serde_json::json!({"key": "value"}));
830
- assert_eq!(resp.get("processed").unwrap(), true);
831
- }
832
-
833
- #[tokio::test]
834
- async fn test_transform_handler_with_non_object_input() {
835
- let handler: TransformHandler = TransformHandler;
836
-
837
- let array: Value = serde_json::json!([1, 2, 3]);
838
- let response1: Option<Value> = handler.handle_message(array).await;
839
- assert!(response1.is_none());
840
-
841
- let string: Value = serde_json::json!("not an object");
842
- let response2: Option<Value> = handler.handle_message(string).await;
843
- assert!(response2.is_none());
844
-
845
- let number: Value = serde_json::json!(42);
846
- let response3: Option<Value> = handler.handle_message(number).await;
847
- assert!(response3.is_none());
848
- }
849
-
850
- /// Test message validation failure with schema constraint
851
- #[test]
852
- fn test_message_schema_rejects_wrong_type() {
853
- let handler: EchoHandler = EchoHandler;
854
- let message_schema: serde_json::Value = serde_json::json!({
855
- "type": "object",
856
- "properties": {"id": {"type": "integer"}},
857
- "required": ["id"]
858
- });
859
-
860
- let state: WebSocketState<EchoHandler> =
861
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
862
-
863
- let invalid_msg: Value = serde_json::json!({"id": "not_an_integer"});
864
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
865
- assert!(!validator.is_valid(&invalid_msg));
866
- }
867
-
868
- /// Test response schema validation failure
869
- #[test]
870
- fn test_response_schema_rejects_invalid_type() {
871
- let handler: EchoHandler = EchoHandler;
872
- let response_schema: serde_json::Value = serde_json::json!({
873
- "type": "object",
874
- "properties": {"count": {"type": "integer"}},
875
- "required": ["count"]
876
- });
877
-
878
- let state: WebSocketState<EchoHandler> =
879
- WebSocketState::with_schemas(handler, None, Some(response_schema)).unwrap();
880
-
881
- let invalid_response: Value = serde_json::json!([1, 2, 3]);
882
- let validator: &jsonschema::Validator = state.response_schema.as_ref().unwrap();
883
- assert!(!validator.is_valid(&invalid_response));
884
- }
885
-
886
- /// Test message with multiple required fields missing
887
- #[test]
888
- fn test_message_missing_multiple_required_fields() {
889
- let handler: EchoHandler = EchoHandler;
890
- let message_schema: serde_json::Value = serde_json::json!({
891
- "type": "object",
892
- "properties": {
893
- "user_id": {"type": "integer"},
894
- "action": {"type": "string"},
895
- "timestamp": {"type": "string"}
896
- },
897
- "required": ["user_id", "action", "timestamp"]
898
- });
899
-
900
- let state: WebSocketState<EchoHandler> =
901
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
902
-
903
- let invalid_msg: Value = serde_json::json!({"other": "value"});
904
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
905
- assert!(!validator.is_valid(&invalid_msg));
906
-
907
- let partial_msg: Value = serde_json::json!({"user_id": 123});
908
- assert!(!validator.is_valid(&partial_msg));
909
- }
910
-
911
- /// Test deeply nested schema validation with required nested properties
912
- #[test]
913
- fn test_deeply_nested_schema_validation_failure() {
914
- let handler: EchoHandler = EchoHandler;
915
- let message_schema: serde_json::Value = serde_json::json!({
916
- "type": "object",
917
- "properties": {
918
- "metadata": {
919
- "type": "object",
920
- "properties": {
921
- "request": {
922
- "type": "object",
923
- "properties": {
924
- "id": {"type": "string"}
925
- },
926
- "required": ["id"]
927
- }
928
- },
929
- "required": ["request"]
930
- }
931
- },
932
- "required": ["metadata"]
933
- });
934
-
935
- let state: WebSocketState<EchoHandler> =
936
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
937
-
938
- let invalid_msg: Value = serde_json::json!({
939
- "metadata": {
940
- "request": {}
941
- }
942
- });
943
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
944
- assert!(!validator.is_valid(&invalid_msg));
945
- }
946
-
947
- /// Test array property validation with items constraint
948
- #[test]
949
- fn test_array_property_type_validation() {
950
- let handler: EchoHandler = EchoHandler;
951
- let message_schema: serde_json::Value = serde_json::json!({
952
- "type": "object",
953
- "properties": {
954
- "ids": {
955
- "type": "array",
956
- "items": {"type": "integer"}
957
- }
958
- }
959
- });
960
-
961
- let state: WebSocketState<EchoHandler> =
962
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
963
-
964
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
965
-
966
- let valid_msg: Value = serde_json::json!({"ids": [1, 2, 3]});
967
- assert!(validator.is_valid(&valid_msg));
968
-
969
- let invalid_msg: Value = serde_json::json!({"ids": [1, "two", 3]});
970
- assert!(!validator.is_valid(&invalid_msg));
971
-
972
- let invalid_msg2: Value = serde_json::json!({"ids": "not_an_array"});
973
- assert!(!validator.is_valid(&invalid_msg2));
974
- }
975
-
976
- /// Test enum/const property validation
977
- #[test]
978
- fn test_enum_property_validation() {
979
- let handler: EchoHandler = EchoHandler;
980
- let message_schema: serde_json::Value = serde_json::json!({
981
- "type": "object",
982
- "properties": {
983
- "status": {
984
- "type": "string",
985
- "enum": ["pending", "active", "completed"]
986
- }
987
- },
988
- "required": ["status"]
989
- });
990
-
991
- let state: WebSocketState<EchoHandler> =
992
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
993
-
994
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
995
-
996
- let valid_msg: Value = serde_json::json!({"status": "active"});
997
- assert!(validator.is_valid(&valid_msg));
998
-
999
- let invalid_msg: Value = serde_json::json!({"status": "unknown"});
1000
- assert!(!validator.is_valid(&invalid_msg));
1001
- }
1002
-
1003
- /// Test minimum/maximum constraints on numbers
1004
- #[test]
1005
- fn test_number_range_validation() {
1006
- let handler: EchoHandler = EchoHandler;
1007
- let message_schema: serde_json::Value = serde_json::json!({
1008
- "type": "object",
1009
- "properties": {
1010
- "age": {
1011
- "type": "integer",
1012
- "minimum": 0,
1013
- "maximum": 150
1014
- }
1015
- },
1016
- "required": ["age"]
1017
- });
1018
-
1019
- let state: WebSocketState<EchoHandler> =
1020
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1021
-
1022
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1023
-
1024
- let valid_msg: Value = serde_json::json!({"age": 25});
1025
- assert!(validator.is_valid(&valid_msg));
1026
-
1027
- let invalid_msg: Value = serde_json::json!({"age": -1});
1028
- assert!(!validator.is_valid(&invalid_msg));
1029
-
1030
- let invalid_msg2: Value = serde_json::json!({"age": 200});
1031
- assert!(!validator.is_valid(&invalid_msg2));
1032
- }
1033
-
1034
- /// Test string length constraints
1035
- #[test]
1036
- fn test_string_length_validation() {
1037
- let handler: EchoHandler = EchoHandler;
1038
- let message_schema: serde_json::Value = serde_json::json!({
1039
- "type": "object",
1040
- "properties": {
1041
- "username": {
1042
- "type": "string",
1043
- "minLength": 3,
1044
- "maxLength": 20
1045
- }
1046
- },
1047
- "required": ["username"]
1048
- });
1049
-
1050
- let state: WebSocketState<EchoHandler> =
1051
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1052
-
1053
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1054
-
1055
- let valid_msg: Value = serde_json::json!({"username": "alice"});
1056
- assert!(validator.is_valid(&valid_msg));
1057
-
1058
- let invalid_msg: Value = serde_json::json!({"username": "ab"});
1059
- assert!(!validator.is_valid(&invalid_msg));
1060
-
1061
- let invalid_msg2: Value =
1062
- serde_json::json!({"username": "this_is_a_very_long_username_over_twenty_characters"});
1063
- assert!(!validator.is_valid(&invalid_msg2));
1064
- }
1065
-
1066
- /// Test pattern (regex) validation
1067
- #[test]
1068
- fn test_pattern_validation() {
1069
- let handler: EchoHandler = EchoHandler;
1070
- let message_schema: serde_json::Value = serde_json::json!({
1071
- "type": "object",
1072
- "properties": {
1073
- "email": {
1074
- "type": "string",
1075
- "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
1076
- }
1077
- },
1078
- "required": ["email"]
1079
- });
1080
-
1081
- let state: WebSocketState<EchoHandler> =
1082
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1083
-
1084
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1085
-
1086
- let valid_msg: Value = serde_json::json!({"email": "user@example.com"});
1087
- assert!(validator.is_valid(&valid_msg));
1088
-
1089
- let invalid_msg: Value = serde_json::json!({"email": "user@example"});
1090
- assert!(!validator.is_valid(&invalid_msg));
1091
-
1092
- let invalid_msg2: Value = serde_json::json!({"email": "userexample.com"});
1093
- assert!(!validator.is_valid(&invalid_msg2));
1094
- }
1095
-
1096
- /// Test additionalProperties constraint
1097
- #[test]
1098
- fn test_additional_properties_validation() {
1099
- let handler: EchoHandler = EchoHandler;
1100
- let message_schema: serde_json::Value = serde_json::json!({
1101
- "type": "object",
1102
- "properties": {
1103
- "name": {"type": "string"}
1104
- },
1105
- "additionalProperties": false
1106
- });
1107
-
1108
- let state: WebSocketState<EchoHandler> =
1109
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1110
-
1111
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1112
-
1113
- let valid_msg: Value = serde_json::json!({"name": "Alice"});
1114
- assert!(validator.is_valid(&valid_msg));
1115
-
1116
- let invalid_msg: Value = serde_json::json!({"name": "Bob", "age": 30});
1117
- assert!(!validator.is_valid(&invalid_msg));
1118
- }
1119
-
1120
- /// Test oneOf constraint (mutually exclusive properties)
1121
- #[test]
1122
- fn test_one_of_constraint() {
1123
- let handler: EchoHandler = EchoHandler;
1124
- let message_schema: serde_json::Value = serde_json::json!({
1125
- "type": "object",
1126
- "oneOf": [
1127
- {
1128
- "properties": {"type": {"const": "text"}},
1129
- "required": ["type"]
1130
- },
1131
- {
1132
- "properties": {"type": {"const": "number"}},
1133
- "required": ["type"]
1134
- }
1135
- ]
1136
- });
1137
-
1138
- let state: WebSocketState<EchoHandler> =
1139
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1140
-
1141
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1142
-
1143
- let valid_msg: Value = serde_json::json!({"type": "text"});
1144
- assert!(validator.is_valid(&valid_msg));
1145
-
1146
- let invalid_msg: Value = serde_json::json!({"type": "unknown"});
1147
- assert!(!validator.is_valid(&invalid_msg));
1148
- }
1149
-
1150
- /// Test anyOf constraint (at least one match)
1151
- #[test]
1152
- fn test_any_of_constraint() {
1153
- let handler: EchoHandler = EchoHandler;
1154
- let message_schema: serde_json::Value = serde_json::json!({
1155
- "type": "object",
1156
- "properties": {
1157
- "value": {"type": ["string", "integer"]}
1158
- },
1159
- "required": ["value"]
1160
- });
1161
-
1162
- let state: WebSocketState<EchoHandler> =
1163
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1164
-
1165
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1166
-
1167
- let msg1: Value = serde_json::json!({"value": "text"});
1168
- assert!(validator.is_valid(&msg1));
1169
-
1170
- let msg2: Value = serde_json::json!({"value": 42});
1171
- assert!(validator.is_valid(&msg2));
1172
-
1173
- let invalid_msg: Value = serde_json::json!({"value": true});
1174
- assert!(!validator.is_valid(&invalid_msg));
1175
- }
1176
-
1177
- /// Test response validation with complex constraints
1178
- #[test]
1179
- fn test_response_schema_with_multiple_constraints() {
1180
- let handler: EchoHandler = EchoHandler;
1181
- let response_schema: serde_json::Value = serde_json::json!({
1182
- "type": "object",
1183
- "properties": {
1184
- "success": {"type": "boolean"},
1185
- "data": {
1186
- "type": "object",
1187
- "properties": {
1188
- "items": {
1189
- "type": "array",
1190
- "items": {"type": "object"},
1191
- "minItems": 1
1192
- }
1193
- },
1194
- "required": ["items"]
1195
- }
1196
- },
1197
- "required": ["success", "data"]
1198
- });
1199
-
1200
- let state: WebSocketState<EchoHandler> =
1201
- WebSocketState::with_schemas(handler, None, Some(response_schema)).unwrap();
1202
-
1203
- let validator: &jsonschema::Validator = state.response_schema.as_ref().unwrap();
1204
-
1205
- let valid_response: Value = serde_json::json!({
1206
- "success": true,
1207
- "data": {
1208
- "items": [{"id": 1}]
1209
- }
1210
- });
1211
- assert!(validator.is_valid(&valid_response));
1212
-
1213
- let invalid_response: Value = serde_json::json!({
1214
- "success": true,
1215
- "data": {
1216
- "items": []
1217
- }
1218
- });
1219
- assert!(!validator.is_valid(&invalid_response));
1220
-
1221
- let invalid_response2: Value = serde_json::json!({
1222
- "success": true
1223
- });
1224
- assert!(!validator.is_valid(&invalid_response2));
1225
- }
1226
-
1227
- /// Test null type validation
1228
- #[test]
1229
- fn test_null_value_validation() {
1230
- let handler: EchoHandler = EchoHandler;
1231
- let message_schema: serde_json::Value = serde_json::json!({
1232
- "type": "object",
1233
- "properties": {
1234
- "optional_field": {"type": ["string", "null"]},
1235
- "required_field": {"type": "string"}
1236
- },
1237
- "required": ["required_field"]
1238
- });
1239
-
1240
- let state: WebSocketState<EchoHandler> =
1241
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1242
-
1243
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1244
-
1245
- let msg1: Value = serde_json::json!({
1246
- "optional_field": null,
1247
- "required_field": "value"
1248
- });
1249
- assert!(validator.is_valid(&msg1));
1250
-
1251
- let msg2: Value = serde_json::json!({"required_field": "value"});
1252
- assert!(validator.is_valid(&msg2));
1253
-
1254
- let invalid_msg: Value = serde_json::json!({"required_field": null});
1255
- assert!(!validator.is_valid(&invalid_msg));
1256
- }
1257
-
1258
- /// Test schema with default values (they don't change validation)
1259
- #[test]
1260
- fn test_schema_with_defaults_still_validates() {
1261
- let handler: EchoHandler = EchoHandler;
1262
- let message_schema: serde_json::Value = serde_json::json!({
1263
- "type": "object",
1264
- "properties": {
1265
- "status": {
1266
- "type": "string",
1267
- "default": "pending"
1268
- }
1269
- }
1270
- });
1271
-
1272
- let state: WebSocketState<EchoHandler> =
1273
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1274
-
1275
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1276
-
1277
- let msg: Value = serde_json::json!({});
1278
- assert!(validator.is_valid(&msg));
1279
- }
1280
-
1281
- /// Test both message and response schema validation together
1282
- #[test]
1283
- fn test_both_schemas_validate_independently() {
1284
- let handler: EchoHandler = EchoHandler;
1285
- let message_schema: serde_json::Value = serde_json::json!({
1286
- "type": "object",
1287
- "properties": {"action": {"type": "string"}},
1288
- "required": ["action"]
1289
- });
1290
- let response_schema: serde_json::Value = serde_json::json!({
1291
- "type": "object",
1292
- "properties": {"result": {"type": "string"}},
1293
- "required": ["result"]
1294
- });
1295
-
1296
- let state: WebSocketState<EchoHandler> =
1297
- WebSocketState::with_schemas(handler, Some(message_schema), Some(response_schema)).unwrap();
1298
-
1299
- let msg_validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1300
- let resp_validator: &jsonschema::Validator = state.response_schema.as_ref().unwrap();
1301
-
1302
- let valid_msg: Value = serde_json::json!({"action": "test"});
1303
- let invalid_response: Value = serde_json::json!({"data": "oops"});
1304
-
1305
- assert!(msg_validator.is_valid(&valid_msg));
1306
- assert!(!resp_validator.is_valid(&invalid_response));
1307
-
1308
- let invalid_msg: Value = serde_json::json!({"data": "oops"});
1309
- let valid_response: Value = serde_json::json!({"result": "ok"});
1310
-
1311
- assert!(!msg_validator.is_valid(&invalid_msg));
1312
- assert!(resp_validator.is_valid(&valid_response));
1313
- }
1314
-
1315
- /// Test validation with very long/large payload
1316
- #[test]
1317
- fn test_validation_with_large_payload() {
1318
- let handler: EchoHandler = EchoHandler;
1319
- let message_schema: serde_json::Value = serde_json::json!({
1320
- "type": "object",
1321
- "properties": {
1322
- "items": {
1323
- "type": "array",
1324
- "items": {"type": "integer"}
1325
- }
1326
- },
1327
- "required": ["items"]
1328
- });
1329
-
1330
- let state: WebSocketState<EchoHandler> =
1331
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1332
-
1333
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1334
-
1335
- let mut items = Vec::new();
1336
- for i in 0..10_000 {
1337
- items.push(i);
1338
- }
1339
- let large_msg: Value = serde_json::json!({"items": items});
1340
-
1341
- assert!(validator.is_valid(&large_msg));
1342
- }
1343
-
1344
- /// Test validation error doesn't panic with invalid schema combinations
1345
- #[test]
1346
- fn test_mutually_exclusive_schema_properties() {
1347
- let handler: EchoHandler = EchoHandler;
1348
-
1349
- let message_schema: serde_json::Value = serde_json::json!({
1350
- "allOf": [
1351
- {
1352
- "type": "object",
1353
- "properties": {"a": {"type": "string"}},
1354
- "required": ["a"]
1355
- },
1356
- {
1357
- "type": "object",
1358
- "properties": {"b": {"type": "integer"}},
1359
- "required": ["b"]
1360
- }
1361
- ]
1362
- });
1363
-
1364
- let state: WebSocketState<EchoHandler> =
1365
- WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1366
-
1367
- let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1368
-
1369
- let valid_msg: Value = serde_json::json!({"a": "text", "b": 42});
1370
- assert!(validator.is_valid(&valid_msg));
1371
-
1372
- let invalid_msg: Value = serde_json::json!({"a": "text"});
1373
- assert!(!validator.is_valid(&invalid_msg));
1374
- }
1375
- }
1
+ //! WebSocket support for Spikard
2
+ //!
3
+ //! Provides WebSocket connection handling with message validation and routing.
4
+
5
+ use axum::{
6
+ extract::{
7
+ State,
8
+ ws::{Message, WebSocket, WebSocketUpgrade},
9
+ },
10
+ response::IntoResponse,
11
+ };
12
+ use serde_json::Value;
13
+ use std::sync::Arc;
14
+ use tracing::{debug, error, info, warn};
15
+
16
+ fn trace_ws(message: &str) {
17
+ if std::env::var("SPIKARD_WS_TRACE").ok().as_deref() == Some("1") {
18
+ eprintln!("[spikard-ws] {message}");
19
+ }
20
+ }
21
+
22
+ /// WebSocket message handler trait
23
+ ///
24
+ /// Implement this trait to create custom WebSocket message handlers for your application.
25
+ /// The handler processes JSON messages received from WebSocket clients and can optionally
26
+ /// send responses back.
27
+ ///
28
+ /// # Implementing the Trait
29
+ ///
30
+ /// You must implement the `handle_message` method. The `on_connect` and `on_disconnect`
31
+ /// methods are optional and provide lifecycle hooks.
32
+ ///
33
+ /// # Example
34
+ ///
35
+ /// ```ignore
36
+ /// use spikard_http::websocket::WebSocketHandler;
37
+ /// use serde_json::{json, Value};
38
+ ///
39
+ /// struct EchoHandler;
40
+ ///
41
+ /// #[async_trait]
42
+ /// impl WebSocketHandler for EchoHandler {
43
+ /// async fn handle_message(&self, message: Value) -> Option<Value> {
44
+ /// // Echo the message back to the client
45
+ /// Some(message)
46
+ /// }
47
+ ///
48
+ /// async fn on_connect(&self) {
49
+ /// println!("Client connected");
50
+ /// }
51
+ ///
52
+ /// async fn on_disconnect(&self) {
53
+ /// println!("Client disconnected");
54
+ /// }
55
+ /// }
56
+ /// ```
57
+ pub trait WebSocketHandler: Send + Sync {
58
+ /// Handle incoming WebSocket message
59
+ ///
60
+ /// Called whenever a text message is received from a WebSocket client.
61
+ /// Messages are automatically parsed as JSON.
62
+ ///
63
+ /// # Arguments
64
+ /// * `message` - JSON value received from the client
65
+ ///
66
+ /// # Returns
67
+ /// * `Some(value)` - JSON value to send back to the client
68
+ /// * `None` - No response to send
69
+ fn handle_message(&self, message: Value) -> impl std::future::Future<Output = Option<Value>> + Send;
70
+
71
+ /// Called when a client connects to the WebSocket
72
+ ///
73
+ /// Optional lifecycle hook invoked when a new WebSocket connection is established.
74
+ /// Default implementation does nothing.
75
+ fn on_connect(&self) -> impl std::future::Future<Output = ()> + Send {
76
+ async {}
77
+ }
78
+
79
+ /// Called when a client disconnects from the WebSocket
80
+ ///
81
+ /// Optional lifecycle hook invoked when a WebSocket connection is closed
82
+ /// (either by the client or due to an error). Default implementation does nothing.
83
+ fn on_disconnect(&self) -> impl std::future::Future<Output = ()> + Send {
84
+ async {}
85
+ }
86
+ }
87
+
88
+ /// WebSocket state shared across connections
89
+ ///
90
+ /// Contains the message handler and optional JSON schemas for validating
91
+ /// incoming and outgoing messages. This state is shared among all connections
92
+ /// to the same WebSocket endpoint.
93
+ #[derive(Debug)]
94
+ pub struct WebSocketState<H: WebSocketHandler> {
95
+ /// The message handler implementation
96
+ handler: Arc<H>,
97
+ /// Optional JSON Schema for validating incoming messages
98
+ message_schema: Option<Arc<jsonschema::Validator>>,
99
+ /// Optional JSON Schema for validating outgoing responses
100
+ response_schema: Option<Arc<jsonschema::Validator>>,
101
+ }
102
+
103
+ impl<H: WebSocketHandler> Clone for WebSocketState<H> {
104
+ fn clone(&self) -> Self {
105
+ Self {
106
+ handler: Arc::clone(&self.handler),
107
+ message_schema: self.message_schema.clone(),
108
+ response_schema: self.response_schema.clone(),
109
+ }
110
+ }
111
+ }
112
+
113
+ impl<H: WebSocketHandler + 'static> WebSocketState<H> {
114
+ /// Create new WebSocket state with a handler
115
+ ///
116
+ /// Creates a new state without message or response validation schemas.
117
+ /// Messages and responses are not validated.
118
+ ///
119
+ /// # Arguments
120
+ /// * `handler` - The message handler implementation
121
+ ///
122
+ /// # Example
123
+ ///
124
+ /// ```ignore
125
+ /// let state = WebSocketState::new(MyHandler);
126
+ /// ```
127
+ pub fn new(handler: H) -> Self {
128
+ Self {
129
+ handler: Arc::new(handler),
130
+ message_schema: None,
131
+ response_schema: None,
132
+ }
133
+ }
134
+
135
+ /// Create new WebSocket state with a handler and optional validation schemas
136
+ ///
137
+ /// Creates a new state with optional JSON schemas for validating incoming messages
138
+ /// and outgoing responses. If a schema is provided and validation fails, the message
139
+ /// or response is rejected.
140
+ ///
141
+ /// # Arguments
142
+ /// * `handler` - The message handler implementation
143
+ /// * `message_schema` - Optional JSON schema for validating client messages
144
+ /// * `response_schema` - Optional JSON schema for validating handler responses
145
+ ///
146
+ /// # Returns
147
+ /// * `Ok(state)` - Successfully created state
148
+ /// * `Err(msg)` - Invalid schema provided
149
+ ///
150
+ /// # Example
151
+ ///
152
+ /// ```ignore
153
+ /// use serde_json::json;
154
+ ///
155
+ /// let message_schema = json!({
156
+ /// "type": "object",
157
+ /// "properties": {
158
+ /// "type": {"type": "string"},
159
+ /// "data": {"type": "string"}
160
+ /// }
161
+ /// });
162
+ ///
163
+ /// let state = WebSocketState::with_schemas(
164
+ /// MyHandler,
165
+ /// Some(message_schema),
166
+ /// None,
167
+ /// )?;
168
+ /// ```
169
+ pub fn with_schemas(
170
+ handler: H,
171
+ message_schema: Option<serde_json::Value>,
172
+ response_schema: Option<serde_json::Value>,
173
+ ) -> Result<Self, String> {
174
+ let message_validator = if let Some(schema) = message_schema {
175
+ Some(Arc::new(
176
+ jsonschema::validator_for(&schema).map_err(|e| format!("Invalid message schema: {}", e))?,
177
+ ))
178
+ } else {
179
+ None
180
+ };
181
+
182
+ let response_validator = if let Some(schema) = response_schema {
183
+ Some(Arc::new(
184
+ jsonschema::validator_for(&schema).map_err(|e| format!("Invalid response schema: {}", e))?,
185
+ ))
186
+ } else {
187
+ None
188
+ };
189
+
190
+ Ok(Self {
191
+ handler: Arc::new(handler),
192
+ message_schema: message_validator,
193
+ response_schema: response_validator,
194
+ })
195
+ }
196
+
197
+ /// Invoke the connection hook for testing.
198
+ pub async fn on_connect(&self) {
199
+ self.handler.on_connect().await;
200
+ }
201
+
202
+ /// Invoke the disconnect hook for testing.
203
+ pub async fn on_disconnect(&self) {
204
+ self.handler.on_disconnect().await;
205
+ }
206
+
207
+ /// Validate and handle an incoming message without a socket transport.
208
+ pub async fn handle_message_validated(&self, message: Value) -> Result<Option<Value>, String> {
209
+ if let Some(validator) = &self.message_schema
210
+ && !validator.is_valid(&message)
211
+ {
212
+ return Err("Message validation failed".to_string());
213
+ }
214
+
215
+ let response = self.handler.handle_message(message).await;
216
+ if let Some(ref value) = response
217
+ && let Some(validator) = &self.response_schema
218
+ && !validator.is_valid(value)
219
+ {
220
+ return Ok(None);
221
+ }
222
+
223
+ Ok(response)
224
+ }
225
+ }
226
+
227
+ /// WebSocket upgrade handler
228
+ ///
229
+ /// This is the main entry point for WebSocket connections. Use this as an Axum route
230
+ /// handler by passing it to an Axum router's `.route()` method with `get()`.
231
+ ///
232
+ /// # Arguments
233
+ /// * `ws` - WebSocket upgrade from Axum
234
+ /// * `State(state)` - Application state containing the handler and optional schemas
235
+ ///
236
+ /// # Returns
237
+ /// An Axum response that upgrades the connection to WebSocket
238
+ ///
239
+ /// # Example
240
+ ///
241
+ /// ```ignore
242
+ /// use axum::{Router, routing::get, extract::State};
243
+ ///
244
+ /// let state = WebSocketState::new(MyHandler);
245
+ /// let router = Router::new()
246
+ /// .route("/ws", get(websocket_handler::<MyHandler>))
247
+ /// .with_state(state);
248
+ /// ```
249
+ pub async fn websocket_handler<H: WebSocketHandler + 'static>(
250
+ ws: WebSocketUpgrade,
251
+ State(state): State<WebSocketState<H>>,
252
+ ) -> impl IntoResponse {
253
+ ws.on_upgrade(move |socket| handle_socket(socket, state))
254
+ }
255
+
256
+ /// Handle an individual WebSocket connection
257
+ async fn handle_socket<H: WebSocketHandler>(mut socket: WebSocket, state: WebSocketState<H>) {
258
+ info!("WebSocket client connected");
259
+ trace_ws("socket:connected");
260
+
261
+ state.handler.on_connect().await;
262
+ trace_ws("socket:on_connect:done");
263
+
264
+ while let Some(msg) = socket.recv().await {
265
+ match msg {
266
+ Ok(Message::Text(text)) => {
267
+ debug!("Received text message: {}", text);
268
+ trace_ws(&format!("recv:text len={}", text.len()));
269
+
270
+ match serde_json::from_str::<Value>(&text) {
271
+ Ok(json_msg) => {
272
+ trace_ws("recv:text:json-ok");
273
+ if let Some(validator) = &state.message_schema
274
+ && !validator.is_valid(&json_msg)
275
+ {
276
+ error!("Message validation failed");
277
+ trace_ws("recv:text:validation-failed");
278
+ let error_response = serde_json::json!({
279
+ "error": "Message validation failed"
280
+ });
281
+ if let Ok(error_text) = serde_json::to_string(&error_response) {
282
+ trace_ws(&format!("send:validation-error len={}", error_text.len()));
283
+ let _ = socket.send(Message::Text(error_text.into())).await;
284
+ }
285
+ continue;
286
+ }
287
+
288
+ if let Some(response) = state.handler.handle_message(json_msg).await {
289
+ trace_ws("handler:response:some");
290
+ if let Some(validator) = &state.response_schema
291
+ && !validator.is_valid(&response)
292
+ {
293
+ error!("Response validation failed");
294
+ trace_ws("send:response:validation-failed");
295
+ continue;
296
+ }
297
+
298
+ let response_text = serde_json::to_string(&response).unwrap_or_else(|_| "{}".to_string());
299
+ let response_len = response_text.len();
300
+
301
+ if let Err(e) = socket.send(Message::Text(response_text.into())).await {
302
+ error!("Failed to send response: {}", e);
303
+ trace_ws("send:response:error");
304
+ break;
305
+ }
306
+ trace_ws(&format!("send:response len={}", response_len));
307
+ } else {
308
+ trace_ws("handler:response:none");
309
+ }
310
+ }
311
+ Err(e) => {
312
+ warn!("Failed to parse JSON message: {}", e);
313
+ trace_ws("recv:text:json-error");
314
+ let error_msg = serde_json::json!({
315
+ "type": "error",
316
+ "message": "Invalid JSON"
317
+ });
318
+ let error_text = serde_json::to_string(&error_msg).unwrap_or_else(|_| "{}".to_string());
319
+ trace_ws(&format!("send:json-error len={}", error_text.len()));
320
+ let _ = socket.send(Message::Text(error_text.into())).await;
321
+ }
322
+ }
323
+ }
324
+ Ok(Message::Binary(data)) => {
325
+ debug!("Received binary message: {} bytes", data.len());
326
+ trace_ws(&format!("recv:binary len={}", data.len()));
327
+ if let Err(e) = socket.send(Message::Binary(data)).await {
328
+ error!("Failed to send binary response: {}", e);
329
+ trace_ws("send:binary:error");
330
+ break;
331
+ }
332
+ trace_ws("send:binary:ok");
333
+ }
334
+ Ok(Message::Ping(data)) => {
335
+ debug!("Received ping");
336
+ trace_ws(&format!("recv:ping len={}", data.len()));
337
+ if let Err(e) = socket.send(Message::Pong(data)).await {
338
+ error!("Failed to send pong: {}", e);
339
+ trace_ws("send:pong:error");
340
+ break;
341
+ }
342
+ trace_ws("send:pong:ok");
343
+ }
344
+ Ok(Message::Pong(_)) => {
345
+ debug!("Received pong");
346
+ trace_ws("recv:pong");
347
+ }
348
+ Ok(Message::Close(_)) => {
349
+ info!("Client closed connection");
350
+ trace_ws("recv:close");
351
+ break;
352
+ }
353
+ Err(e) => {
354
+ error!("WebSocket error: {}", e);
355
+ trace_ws(&format!("recv:error {}", e));
356
+ break;
357
+ }
358
+ }
359
+ }
360
+
361
+ state.handler.on_disconnect().await;
362
+ trace_ws("socket:on_disconnect:done");
363
+ info!("WebSocket client disconnected");
364
+ }
365
+
366
+ #[cfg(test)]
367
+ mod tests {
368
+ use super::*;
369
+ use std::sync::Mutex;
370
+ use std::sync::atomic::{AtomicUsize, Ordering};
371
+
372
+ #[derive(Debug)]
373
+ struct EchoHandler;
374
+
375
+ impl WebSocketHandler for EchoHandler {
376
+ async fn handle_message(&self, message: Value) -> Option<Value> {
377
+ Some(message)
378
+ }
379
+ }
380
+
381
+ #[derive(Debug)]
382
+ struct TrackingHandler {
383
+ connect_count: Arc<AtomicUsize>,
384
+ disconnect_count: Arc<AtomicUsize>,
385
+ message_count: Arc<AtomicUsize>,
386
+ messages: Arc<Mutex<Vec<Value>>>,
387
+ }
388
+
389
+ impl TrackingHandler {
390
+ fn new() -> Self {
391
+ Self {
392
+ connect_count: Arc::new(AtomicUsize::new(0)),
393
+ disconnect_count: Arc::new(AtomicUsize::new(0)),
394
+ message_count: Arc::new(AtomicUsize::new(0)),
395
+ messages: Arc::new(Mutex::new(Vec::new())),
396
+ }
397
+ }
398
+ }
399
+
400
+ impl WebSocketHandler for TrackingHandler {
401
+ async fn handle_message(&self, message: Value) -> Option<Value> {
402
+ self.message_count.fetch_add(1, Ordering::SeqCst);
403
+ self.messages.lock().unwrap().push(message.clone());
404
+ Some(message)
405
+ }
406
+
407
+ async fn on_connect(&self) {
408
+ self.connect_count.fetch_add(1, Ordering::SeqCst);
409
+ }
410
+
411
+ async fn on_disconnect(&self) {
412
+ self.disconnect_count.fetch_add(1, Ordering::SeqCst);
413
+ }
414
+ }
415
+
416
+ #[derive(Debug)]
417
+ struct SelectiveHandler;
418
+
419
+ impl WebSocketHandler for SelectiveHandler {
420
+ async fn handle_message(&self, message: Value) -> Option<Value> {
421
+ if message.get("respond").is_some_and(|v| v.as_bool().unwrap_or(false)) {
422
+ Some(serde_json::json!({"response": "acknowledged"}))
423
+ } else {
424
+ None
425
+ }
426
+ }
427
+ }
428
+
429
+ #[derive(Debug)]
430
+ struct TransformHandler;
431
+
432
+ impl WebSocketHandler for TransformHandler {
433
+ async fn handle_message(&self, message: Value) -> Option<Value> {
434
+ message.as_object().map_or(None, |obj| {
435
+ let mut resp = obj.clone();
436
+ resp.insert("processed".to_string(), Value::Bool(true));
437
+ Some(Value::Object(resp))
438
+ })
439
+ }
440
+ }
441
+
442
+ #[test]
443
+ fn test_websocket_state_creation() {
444
+ let handler: EchoHandler = EchoHandler;
445
+ let state: WebSocketState<EchoHandler> = WebSocketState::new(handler);
446
+ let cloned: WebSocketState<EchoHandler> = state.clone();
447
+ assert!(Arc::ptr_eq(&state.handler, &cloned.handler));
448
+ }
449
+
450
+ #[test]
451
+ fn test_websocket_state_with_valid_schema() {
452
+ let handler: EchoHandler = EchoHandler;
453
+ let schema: serde_json::Value = serde_json::json!({
454
+ "type": "object",
455
+ "properties": {
456
+ "type": {"type": "string"}
457
+ }
458
+ });
459
+
460
+ let result: Result<WebSocketState<EchoHandler>, String> =
461
+ WebSocketState::with_schemas(handler, Some(schema), None);
462
+ assert!(result.is_ok());
463
+ }
464
+
465
+ #[test]
466
+ fn test_websocket_state_with_invalid_schema() {
467
+ let handler: EchoHandler = EchoHandler;
468
+ let invalid_schema: serde_json::Value = serde_json::json!({
469
+ "type": "not_a_real_type",
470
+ "invalid": "schema"
471
+ });
472
+
473
+ let result: Result<WebSocketState<EchoHandler>, String> =
474
+ WebSocketState::with_schemas(handler, Some(invalid_schema), None);
475
+ assert!(result.is_err());
476
+ if let Err(error_msg) = result {
477
+ assert!(error_msg.contains("Invalid message schema"));
478
+ }
479
+ }
480
+
481
+ #[test]
482
+ fn test_websocket_state_with_both_schemas() {
483
+ let handler: EchoHandler = EchoHandler;
484
+ let message_schema: serde_json::Value = serde_json::json!({
485
+ "type": "object",
486
+ "properties": {"action": {"type": "string"}}
487
+ });
488
+ let response_schema: serde_json::Value = serde_json::json!({
489
+ "type": "object",
490
+ "properties": {"result": {"type": "string"}}
491
+ });
492
+
493
+ let result: Result<WebSocketState<EchoHandler>, String> =
494
+ WebSocketState::with_schemas(handler, Some(message_schema), Some(response_schema));
495
+ assert!(result.is_ok());
496
+ let state: WebSocketState<EchoHandler> = result.unwrap();
497
+ assert!(state.message_schema.is_some());
498
+ assert!(state.response_schema.is_some());
499
+ }
500
+
501
+ #[test]
502
+ fn test_websocket_state_cloning_preserves_schemas() {
503
+ let handler: EchoHandler = EchoHandler;
504
+ let schema: serde_json::Value = serde_json::json!({
505
+ "type": "object",
506
+ "properties": {"id": {"type": "integer"}}
507
+ });
508
+
509
+ let state: WebSocketState<EchoHandler> = WebSocketState::with_schemas(handler, Some(schema), None).unwrap();
510
+ let cloned: WebSocketState<EchoHandler> = state.clone();
511
+
512
+ assert!(cloned.message_schema.is_some());
513
+ assert!(cloned.response_schema.is_none());
514
+ assert!(Arc::ptr_eq(&state.handler, &cloned.handler));
515
+ }
516
+
517
+ #[tokio::test]
518
+ async fn test_tracking_handler_lifecycle() {
519
+ let handler: TrackingHandler = TrackingHandler::new();
520
+ handler.on_connect().await;
521
+ assert_eq!(handler.connect_count.load(Ordering::SeqCst), 1);
522
+
523
+ let msg: Value = serde_json::json!({"test": "data"});
524
+ let _response: Option<Value> = handler.handle_message(msg).await;
525
+ assert_eq!(handler.message_count.load(Ordering::SeqCst), 1);
526
+
527
+ handler.on_disconnect().await;
528
+ assert_eq!(handler.disconnect_count.load(Ordering::SeqCst), 1);
529
+ }
530
+
531
+ #[tokio::test]
532
+ async fn test_selective_handler_responds_conditionally() {
533
+ let handler: SelectiveHandler = SelectiveHandler;
534
+
535
+ let respond_msg: Value = serde_json::json!({"respond": true});
536
+ let response1: Option<Value> = handler.handle_message(respond_msg).await;
537
+ assert!(response1.is_some());
538
+ assert_eq!(response1.unwrap(), serde_json::json!({"response": "acknowledged"}));
539
+
540
+ let no_respond_msg: Value = serde_json::json!({"respond": false});
541
+ let response2: Option<Value> = handler.handle_message(no_respond_msg).await;
542
+ assert!(response2.is_none());
543
+ }
544
+
545
+ #[tokio::test]
546
+ async fn test_transform_handler_modifies_message() {
547
+ let handler: TransformHandler = TransformHandler;
548
+ let original: Value = serde_json::json!({"name": "test"});
549
+ let transformed: Option<Value> = handler.handle_message(original).await;
550
+
551
+ assert!(transformed.is_some());
552
+ let resp: Value = transformed.unwrap();
553
+ assert_eq!(resp.get("name").unwrap(), "test");
554
+ assert_eq!(resp.get("processed").unwrap(), true);
555
+ }
556
+
557
+ #[tokio::test]
558
+ async fn test_echo_handler_preserves_json_types() {
559
+ let handler: EchoHandler = EchoHandler;
560
+
561
+ let messages: Vec<Value> = vec![
562
+ serde_json::json!({"string": "value"}),
563
+ serde_json::json!({"number": 42}),
564
+ serde_json::json!({"float": 3.14}),
565
+ serde_json::json!({"bool": true}),
566
+ serde_json::json!({"null": null}),
567
+ serde_json::json!({"array": [1, 2, 3]}),
568
+ ];
569
+
570
+ for msg in messages {
571
+ let response: Option<Value> = handler.handle_message(msg.clone()).await;
572
+ assert!(response.is_some());
573
+ assert_eq!(response.unwrap(), msg);
574
+ }
575
+ }
576
+
577
+ #[tokio::test]
578
+ async fn test_tracking_handler_accumulates_messages() {
579
+ let handler: TrackingHandler = TrackingHandler::new();
580
+
581
+ let messages: Vec<Value> = vec![
582
+ serde_json::json!({"id": 1}),
583
+ serde_json::json!({"id": 2}),
584
+ serde_json::json!({"id": 3}),
585
+ ];
586
+
587
+ for msg in messages {
588
+ let _: Option<Value> = handler.handle_message(msg).await;
589
+ }
590
+
591
+ assert_eq!(handler.message_count.load(Ordering::SeqCst), 3);
592
+ let stored: Vec<Value> = handler.messages.lock().unwrap().clone();
593
+ assert_eq!(stored.len(), 3);
594
+ assert_eq!(stored[0].get("id").unwrap(), 1);
595
+ assert_eq!(stored[1].get("id").unwrap(), 2);
596
+ assert_eq!(stored[2].get("id").unwrap(), 3);
597
+ }
598
+
599
+ #[tokio::test]
600
+ async fn test_echo_handler_with_nested_json() {
601
+ let handler: EchoHandler = EchoHandler;
602
+ let nested: Value = serde_json::json!({
603
+ "level1": {
604
+ "level2": {
605
+ "level3": {
606
+ "value": "deeply nested"
607
+ }
608
+ }
609
+ }
610
+ });
611
+
612
+ let response: Option<Value> = handler.handle_message(nested.clone()).await;
613
+ assert!(response.is_some());
614
+ assert_eq!(response.unwrap(), nested);
615
+ }
616
+
617
+ #[tokio::test]
618
+ async fn test_echo_handler_with_large_array() {
619
+ let handler: EchoHandler = EchoHandler;
620
+ let large_array: Value = serde_json::json!({
621
+ "items": (0..1000).collect::<Vec<i32>>()
622
+ });
623
+
624
+ let response: Option<Value> = handler.handle_message(large_array.clone()).await;
625
+ assert!(response.is_some());
626
+ assert_eq!(response.unwrap(), large_array);
627
+ }
628
+
629
+ #[tokio::test]
630
+ async fn test_echo_handler_with_unicode() {
631
+ let handler: EchoHandler = EchoHandler;
632
+ let unicode_msg: Value = serde_json::json!({
633
+ "emoji": "🚀",
634
+ "chinese": "你好",
635
+ "arabic": "مرحبا",
636
+ "mixed": "Hello 世界 🌍"
637
+ });
638
+
639
+ let response: Option<Value> = handler.handle_message(unicode_msg.clone()).await;
640
+ assert!(response.is_some());
641
+ assert_eq!(response.unwrap(), unicode_msg);
642
+ }
643
+
644
+ #[test]
645
+ fn test_websocket_state_schemas_are_independent() {
646
+ let handler: EchoHandler = EchoHandler;
647
+ let message_schema: serde_json::Value = serde_json::json!({"type": "object"});
648
+ let response_schema: serde_json::Value = serde_json::json!({"type": "array"});
649
+
650
+ let state: WebSocketState<EchoHandler> =
651
+ WebSocketState::with_schemas(handler, Some(message_schema), Some(response_schema)).unwrap();
652
+
653
+ let cloned: WebSocketState<EchoHandler> = state.clone();
654
+
655
+ assert!(state.message_schema.is_some());
656
+ assert!(state.response_schema.is_some());
657
+ assert!(cloned.message_schema.is_some());
658
+ assert!(cloned.response_schema.is_some());
659
+ }
660
+
661
+ #[test]
662
+ fn test_message_schema_validation_with_required_field() {
663
+ let handler: EchoHandler = EchoHandler;
664
+ let message_schema: serde_json::Value = serde_json::json!({
665
+ "type": "object",
666
+ "properties": {"type": {"type": "string"}},
667
+ "required": ["type"]
668
+ });
669
+
670
+ let state: WebSocketState<EchoHandler> =
671
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
672
+
673
+ assert!(state.message_schema.is_some());
674
+ assert!(state.response_schema.is_none());
675
+
676
+ let valid_msg: Value = serde_json::json!({"type": "test"});
677
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
678
+ assert!(validator.is_valid(&valid_msg));
679
+
680
+ let invalid_msg: Value = serde_json::json!({"other": "field"});
681
+ assert!(!validator.is_valid(&invalid_msg));
682
+ }
683
+
684
+ #[test]
685
+ fn test_response_schema_validation_with_required_field() {
686
+ let handler: EchoHandler = EchoHandler;
687
+ let response_schema: serde_json::Value = serde_json::json!({
688
+ "type": "object",
689
+ "properties": {"status": {"type": "string"}},
690
+ "required": ["status"]
691
+ });
692
+
693
+ let state: WebSocketState<EchoHandler> =
694
+ WebSocketState::with_schemas(handler, None, Some(response_schema)).unwrap();
695
+
696
+ assert!(state.message_schema.is_none());
697
+ assert!(state.response_schema.is_some());
698
+
699
+ let valid_response: Value = serde_json::json!({"status": "ok"});
700
+ let validator: &jsonschema::Validator = state.response_schema.as_ref().unwrap();
701
+ assert!(validator.is_valid(&valid_response));
702
+
703
+ let invalid_response: Value = serde_json::json!({"other": "field"});
704
+ assert!(!validator.is_valid(&invalid_response));
705
+ }
706
+
707
+ #[test]
708
+ fn test_invalid_message_schema_returns_error() {
709
+ let handler: EchoHandler = EchoHandler;
710
+ let invalid_schema: serde_json::Value = serde_json::json!({
711
+ "type": "invalid_type_value",
712
+ "properties": {}
713
+ });
714
+
715
+ let result: Result<WebSocketState<EchoHandler>, String> =
716
+ WebSocketState::with_schemas(handler, Some(invalid_schema), None);
717
+
718
+ assert!(result.is_err());
719
+ match result {
720
+ Err(error_msg) => assert!(error_msg.contains("Invalid message schema")),
721
+ Ok(_) => panic!("Expected error but got Ok"),
722
+ }
723
+ }
724
+
725
+ #[test]
726
+ fn test_invalid_response_schema_returns_error() {
727
+ let handler: EchoHandler = EchoHandler;
728
+ let invalid_schema: serde_json::Value = serde_json::json!({
729
+ "type": "definitely_not_valid"
730
+ });
731
+
732
+ let result: Result<WebSocketState<EchoHandler>, String> =
733
+ WebSocketState::with_schemas(handler, None, Some(invalid_schema));
734
+
735
+ assert!(result.is_err());
736
+ match result {
737
+ Err(error_msg) => assert!(error_msg.contains("Invalid response schema")),
738
+ Ok(_) => panic!("Expected error but got Ok"),
739
+ }
740
+ }
741
+
742
+ #[tokio::test]
743
+ async fn test_handler_returning_none_response() {
744
+ let handler: SelectiveHandler = SelectiveHandler;
745
+
746
+ let no_response_msg: Value = serde_json::json!({"respond": false});
747
+ let result: Option<Value> = handler.handle_message(no_response_msg).await;
748
+
749
+ assert!(result.is_none());
750
+ }
751
+
752
+ #[tokio::test]
753
+ async fn test_handler_with_complex_schema_validation() {
754
+ let handler: EchoHandler = EchoHandler;
755
+ let message_schema: serde_json::Value = serde_json::json!({
756
+ "type": "object",
757
+ "properties": {
758
+ "user": {
759
+ "type": "object",
760
+ "properties": {
761
+ "id": {"type": "integer"},
762
+ "name": {"type": "string"}
763
+ },
764
+ "required": ["id", "name"]
765
+ },
766
+ "action": {"type": "string"}
767
+ },
768
+ "required": ["user", "action"]
769
+ });
770
+
771
+ let state: WebSocketState<EchoHandler> =
772
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
773
+
774
+ let valid_msg: Value = serde_json::json!({
775
+ "user": {"id": 123, "name": "Alice"},
776
+ "action": "create"
777
+ });
778
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
779
+ assert!(validator.is_valid(&valid_msg));
780
+
781
+ let invalid_msg: Value = serde_json::json!({
782
+ "user": {"id": "not_an_int", "name": "Bob"},
783
+ "action": "create"
784
+ });
785
+ assert!(!validator.is_valid(&invalid_msg));
786
+ }
787
+
788
+ #[tokio::test]
789
+ async fn test_tracking_handler_with_multiple_message_types() {
790
+ let handler: TrackingHandler = TrackingHandler::new();
791
+
792
+ let messages: Vec<Value> = vec![
793
+ serde_json::json!({"type": "text", "content": "hello"}),
794
+ serde_json::json!({"type": "image", "url": "http://example.com/image.png"}),
795
+ serde_json::json!({"type": "video", "duration": 120}),
796
+ ];
797
+
798
+ for msg in messages {
799
+ let _: Option<Value> = handler.handle_message(msg).await;
800
+ }
801
+
802
+ assert_eq!(handler.message_count.load(Ordering::SeqCst), 3);
803
+ let stored: Vec<Value> = handler.messages.lock().unwrap().clone();
804
+ assert_eq!(stored.len(), 3);
805
+ assert_eq!(stored[0].get("type").unwrap(), "text");
806
+ assert_eq!(stored[1].get("type").unwrap(), "image");
807
+ assert_eq!(stored[2].get("type").unwrap(), "video");
808
+ }
809
+
810
+ #[tokio::test]
811
+ async fn test_selective_handler_with_explicit_false() {
812
+ let handler: SelectiveHandler = SelectiveHandler;
813
+
814
+ let msg: Value = serde_json::json!({"respond": false, "data": "test"});
815
+ let response: Option<Value> = handler.handle_message(msg).await;
816
+
817
+ assert!(response.is_none());
818
+ }
819
+
820
+ #[tokio::test]
821
+ async fn test_selective_handler_without_respond_field() {
822
+ let handler: SelectiveHandler = SelectiveHandler;
823
+
824
+ let msg: Value = serde_json::json!({"data": "test"});
825
+ let response: Option<Value> = handler.handle_message(msg).await;
826
+
827
+ assert!(response.is_none());
828
+ }
829
+
830
+ #[tokio::test]
831
+ async fn test_transform_handler_with_empty_object() {
832
+ let handler: TransformHandler = TransformHandler;
833
+ let original: Value = serde_json::json!({});
834
+ let transformed: Option<Value> = handler.handle_message(original).await;
835
+
836
+ assert!(transformed.is_some());
837
+ let resp: Value = transformed.unwrap();
838
+ assert_eq!(resp.get("processed").unwrap(), true);
839
+ assert_eq!(resp.as_object().unwrap().len(), 1);
840
+ }
841
+
842
+ #[tokio::test]
843
+ async fn test_transform_handler_preserves_all_fields() {
844
+ let handler: TransformHandler = TransformHandler;
845
+ let original: Value = serde_json::json!({
846
+ "field1": "value1",
847
+ "field2": 42,
848
+ "field3": true,
849
+ "nested": {"key": "value"}
850
+ });
851
+ let transformed: Option<Value> = handler.handle_message(original.clone()).await;
852
+
853
+ assert!(transformed.is_some());
854
+ let resp: Value = transformed.unwrap();
855
+ assert_eq!(resp.get("field1").unwrap(), "value1");
856
+ assert_eq!(resp.get("field2").unwrap(), 42);
857
+ assert_eq!(resp.get("field3").unwrap(), true);
858
+ assert_eq!(resp.get("nested").unwrap(), &serde_json::json!({"key": "value"}));
859
+ assert_eq!(resp.get("processed").unwrap(), true);
860
+ }
861
+
862
+ #[tokio::test]
863
+ async fn test_transform_handler_with_non_object_input() {
864
+ let handler: TransformHandler = TransformHandler;
865
+
866
+ let array: Value = serde_json::json!([1, 2, 3]);
867
+ let response1: Option<Value> = handler.handle_message(array).await;
868
+ assert!(response1.is_none());
869
+
870
+ let string: Value = serde_json::json!("not an object");
871
+ let response2: Option<Value> = handler.handle_message(string).await;
872
+ assert!(response2.is_none());
873
+
874
+ let number: Value = serde_json::json!(42);
875
+ let response3: Option<Value> = handler.handle_message(number).await;
876
+ assert!(response3.is_none());
877
+ }
878
+
879
+ /// Test message validation failure with schema constraint
880
+ #[test]
881
+ fn test_message_schema_rejects_wrong_type() {
882
+ let handler: EchoHandler = EchoHandler;
883
+ let message_schema: serde_json::Value = serde_json::json!({
884
+ "type": "object",
885
+ "properties": {"id": {"type": "integer"}},
886
+ "required": ["id"]
887
+ });
888
+
889
+ let state: WebSocketState<EchoHandler> =
890
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
891
+
892
+ let invalid_msg: Value = serde_json::json!({"id": "not_an_integer"});
893
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
894
+ assert!(!validator.is_valid(&invalid_msg));
895
+ }
896
+
897
+ /// Test response schema validation failure
898
+ #[test]
899
+ fn test_response_schema_rejects_invalid_type() {
900
+ let handler: EchoHandler = EchoHandler;
901
+ let response_schema: serde_json::Value = serde_json::json!({
902
+ "type": "object",
903
+ "properties": {"count": {"type": "integer"}},
904
+ "required": ["count"]
905
+ });
906
+
907
+ let state: WebSocketState<EchoHandler> =
908
+ WebSocketState::with_schemas(handler, None, Some(response_schema)).unwrap();
909
+
910
+ let invalid_response: Value = serde_json::json!([1, 2, 3]);
911
+ let validator: &jsonschema::Validator = state.response_schema.as_ref().unwrap();
912
+ assert!(!validator.is_valid(&invalid_response));
913
+ }
914
+
915
+ /// Test message with multiple required fields missing
916
+ #[test]
917
+ fn test_message_missing_multiple_required_fields() {
918
+ let handler: EchoHandler = EchoHandler;
919
+ let message_schema: serde_json::Value = serde_json::json!({
920
+ "type": "object",
921
+ "properties": {
922
+ "user_id": {"type": "integer"},
923
+ "action": {"type": "string"},
924
+ "timestamp": {"type": "string"}
925
+ },
926
+ "required": ["user_id", "action", "timestamp"]
927
+ });
928
+
929
+ let state: WebSocketState<EchoHandler> =
930
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
931
+
932
+ let invalid_msg: Value = serde_json::json!({"other": "value"});
933
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
934
+ assert!(!validator.is_valid(&invalid_msg));
935
+
936
+ let partial_msg: Value = serde_json::json!({"user_id": 123});
937
+ assert!(!validator.is_valid(&partial_msg));
938
+ }
939
+
940
+ /// Test deeply nested schema validation with required nested properties
941
+ #[test]
942
+ fn test_deeply_nested_schema_validation_failure() {
943
+ let handler: EchoHandler = EchoHandler;
944
+ let message_schema: serde_json::Value = serde_json::json!({
945
+ "type": "object",
946
+ "properties": {
947
+ "metadata": {
948
+ "type": "object",
949
+ "properties": {
950
+ "request": {
951
+ "type": "object",
952
+ "properties": {
953
+ "id": {"type": "string"}
954
+ },
955
+ "required": ["id"]
956
+ }
957
+ },
958
+ "required": ["request"]
959
+ }
960
+ },
961
+ "required": ["metadata"]
962
+ });
963
+
964
+ let state: WebSocketState<EchoHandler> =
965
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
966
+
967
+ let invalid_msg: Value = serde_json::json!({
968
+ "metadata": {
969
+ "request": {}
970
+ }
971
+ });
972
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
973
+ assert!(!validator.is_valid(&invalid_msg));
974
+ }
975
+
976
+ /// Test array property validation with items constraint
977
+ #[test]
978
+ fn test_array_property_type_validation() {
979
+ let handler: EchoHandler = EchoHandler;
980
+ let message_schema: serde_json::Value = serde_json::json!({
981
+ "type": "object",
982
+ "properties": {
983
+ "ids": {
984
+ "type": "array",
985
+ "items": {"type": "integer"}
986
+ }
987
+ }
988
+ });
989
+
990
+ let state: WebSocketState<EchoHandler> =
991
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
992
+
993
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
994
+
995
+ let valid_msg: Value = serde_json::json!({"ids": [1, 2, 3]});
996
+ assert!(validator.is_valid(&valid_msg));
997
+
998
+ let invalid_msg: Value = serde_json::json!({"ids": [1, "two", 3]});
999
+ assert!(!validator.is_valid(&invalid_msg));
1000
+
1001
+ let invalid_msg2: Value = serde_json::json!({"ids": "not_an_array"});
1002
+ assert!(!validator.is_valid(&invalid_msg2));
1003
+ }
1004
+
1005
+ /// Test enum/const property validation
1006
+ #[test]
1007
+ fn test_enum_property_validation() {
1008
+ let handler: EchoHandler = EchoHandler;
1009
+ let message_schema: serde_json::Value = serde_json::json!({
1010
+ "type": "object",
1011
+ "properties": {
1012
+ "status": {
1013
+ "type": "string",
1014
+ "enum": ["pending", "active", "completed"]
1015
+ }
1016
+ },
1017
+ "required": ["status"]
1018
+ });
1019
+
1020
+ let state: WebSocketState<EchoHandler> =
1021
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1022
+
1023
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1024
+
1025
+ let valid_msg: Value = serde_json::json!({"status": "active"});
1026
+ assert!(validator.is_valid(&valid_msg));
1027
+
1028
+ let invalid_msg: Value = serde_json::json!({"status": "unknown"});
1029
+ assert!(!validator.is_valid(&invalid_msg));
1030
+ }
1031
+
1032
+ /// Test minimum/maximum constraints on numbers
1033
+ #[test]
1034
+ fn test_number_range_validation() {
1035
+ let handler: EchoHandler = EchoHandler;
1036
+ let message_schema: serde_json::Value = serde_json::json!({
1037
+ "type": "object",
1038
+ "properties": {
1039
+ "age": {
1040
+ "type": "integer",
1041
+ "minimum": 0,
1042
+ "maximum": 150
1043
+ }
1044
+ },
1045
+ "required": ["age"]
1046
+ });
1047
+
1048
+ let state: WebSocketState<EchoHandler> =
1049
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1050
+
1051
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1052
+
1053
+ let valid_msg: Value = serde_json::json!({"age": 25});
1054
+ assert!(validator.is_valid(&valid_msg));
1055
+
1056
+ let invalid_msg: Value = serde_json::json!({"age": -1});
1057
+ assert!(!validator.is_valid(&invalid_msg));
1058
+
1059
+ let invalid_msg2: Value = serde_json::json!({"age": 200});
1060
+ assert!(!validator.is_valid(&invalid_msg2));
1061
+ }
1062
+
1063
+ /// Test string length constraints
1064
+ #[test]
1065
+ fn test_string_length_validation() {
1066
+ let handler: EchoHandler = EchoHandler;
1067
+ let message_schema: serde_json::Value = serde_json::json!({
1068
+ "type": "object",
1069
+ "properties": {
1070
+ "username": {
1071
+ "type": "string",
1072
+ "minLength": 3,
1073
+ "maxLength": 20
1074
+ }
1075
+ },
1076
+ "required": ["username"]
1077
+ });
1078
+
1079
+ let state: WebSocketState<EchoHandler> =
1080
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1081
+
1082
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1083
+
1084
+ let valid_msg: Value = serde_json::json!({"username": "alice"});
1085
+ assert!(validator.is_valid(&valid_msg));
1086
+
1087
+ let invalid_msg: Value = serde_json::json!({"username": "ab"});
1088
+ assert!(!validator.is_valid(&invalid_msg));
1089
+
1090
+ let invalid_msg2: Value =
1091
+ serde_json::json!({"username": "this_is_a_very_long_username_over_twenty_characters"});
1092
+ assert!(!validator.is_valid(&invalid_msg2));
1093
+ }
1094
+
1095
+ /// Test pattern (regex) validation
1096
+ #[test]
1097
+ fn test_pattern_validation() {
1098
+ let handler: EchoHandler = EchoHandler;
1099
+ let message_schema: serde_json::Value = serde_json::json!({
1100
+ "type": "object",
1101
+ "properties": {
1102
+ "email": {
1103
+ "type": "string",
1104
+ "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
1105
+ }
1106
+ },
1107
+ "required": ["email"]
1108
+ });
1109
+
1110
+ let state: WebSocketState<EchoHandler> =
1111
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1112
+
1113
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1114
+
1115
+ let valid_msg: Value = serde_json::json!({"email": "user@example.com"});
1116
+ assert!(validator.is_valid(&valid_msg));
1117
+
1118
+ let invalid_msg: Value = serde_json::json!({"email": "user@example"});
1119
+ assert!(!validator.is_valid(&invalid_msg));
1120
+
1121
+ let invalid_msg2: Value = serde_json::json!({"email": "userexample.com"});
1122
+ assert!(!validator.is_valid(&invalid_msg2));
1123
+ }
1124
+
1125
+ /// Test additionalProperties constraint
1126
+ #[test]
1127
+ fn test_additional_properties_validation() {
1128
+ let handler: EchoHandler = EchoHandler;
1129
+ let message_schema: serde_json::Value = serde_json::json!({
1130
+ "type": "object",
1131
+ "properties": {
1132
+ "name": {"type": "string"}
1133
+ },
1134
+ "additionalProperties": false
1135
+ });
1136
+
1137
+ let state: WebSocketState<EchoHandler> =
1138
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1139
+
1140
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1141
+
1142
+ let valid_msg: Value = serde_json::json!({"name": "Alice"});
1143
+ assert!(validator.is_valid(&valid_msg));
1144
+
1145
+ let invalid_msg: Value = serde_json::json!({"name": "Bob", "age": 30});
1146
+ assert!(!validator.is_valid(&invalid_msg));
1147
+ }
1148
+
1149
+ /// Test oneOf constraint (mutually exclusive properties)
1150
+ #[test]
1151
+ fn test_one_of_constraint() {
1152
+ let handler: EchoHandler = EchoHandler;
1153
+ let message_schema: serde_json::Value = serde_json::json!({
1154
+ "type": "object",
1155
+ "oneOf": [
1156
+ {
1157
+ "properties": {"type": {"const": "text"}},
1158
+ "required": ["type"]
1159
+ },
1160
+ {
1161
+ "properties": {"type": {"const": "number"}},
1162
+ "required": ["type"]
1163
+ }
1164
+ ]
1165
+ });
1166
+
1167
+ let state: WebSocketState<EchoHandler> =
1168
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1169
+
1170
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1171
+
1172
+ let valid_msg: Value = serde_json::json!({"type": "text"});
1173
+ assert!(validator.is_valid(&valid_msg));
1174
+
1175
+ let invalid_msg: Value = serde_json::json!({"type": "unknown"});
1176
+ assert!(!validator.is_valid(&invalid_msg));
1177
+ }
1178
+
1179
+ /// Test anyOf constraint (at least one match)
1180
+ #[test]
1181
+ fn test_any_of_constraint() {
1182
+ let handler: EchoHandler = EchoHandler;
1183
+ let message_schema: serde_json::Value = serde_json::json!({
1184
+ "type": "object",
1185
+ "properties": {
1186
+ "value": {"type": ["string", "integer"]}
1187
+ },
1188
+ "required": ["value"]
1189
+ });
1190
+
1191
+ let state: WebSocketState<EchoHandler> =
1192
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1193
+
1194
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1195
+
1196
+ let msg1: Value = serde_json::json!({"value": "text"});
1197
+ assert!(validator.is_valid(&msg1));
1198
+
1199
+ let msg2: Value = serde_json::json!({"value": 42});
1200
+ assert!(validator.is_valid(&msg2));
1201
+
1202
+ let invalid_msg: Value = serde_json::json!({"value": true});
1203
+ assert!(!validator.is_valid(&invalid_msg));
1204
+ }
1205
+
1206
+ /// Test response validation with complex constraints
1207
+ #[test]
1208
+ fn test_response_schema_with_multiple_constraints() {
1209
+ let handler: EchoHandler = EchoHandler;
1210
+ let response_schema: serde_json::Value = serde_json::json!({
1211
+ "type": "object",
1212
+ "properties": {
1213
+ "success": {"type": "boolean"},
1214
+ "data": {
1215
+ "type": "object",
1216
+ "properties": {
1217
+ "items": {
1218
+ "type": "array",
1219
+ "items": {"type": "object"},
1220
+ "minItems": 1
1221
+ }
1222
+ },
1223
+ "required": ["items"]
1224
+ }
1225
+ },
1226
+ "required": ["success", "data"]
1227
+ });
1228
+
1229
+ let state: WebSocketState<EchoHandler> =
1230
+ WebSocketState::with_schemas(handler, None, Some(response_schema)).unwrap();
1231
+
1232
+ let validator: &jsonschema::Validator = state.response_schema.as_ref().unwrap();
1233
+
1234
+ let valid_response: Value = serde_json::json!({
1235
+ "success": true,
1236
+ "data": {
1237
+ "items": [{"id": 1}]
1238
+ }
1239
+ });
1240
+ assert!(validator.is_valid(&valid_response));
1241
+
1242
+ let invalid_response: Value = serde_json::json!({
1243
+ "success": true,
1244
+ "data": {
1245
+ "items": []
1246
+ }
1247
+ });
1248
+ assert!(!validator.is_valid(&invalid_response));
1249
+
1250
+ let invalid_response2: Value = serde_json::json!({
1251
+ "success": true
1252
+ });
1253
+ assert!(!validator.is_valid(&invalid_response2));
1254
+ }
1255
+
1256
+ /// Test null type validation
1257
+ #[test]
1258
+ fn test_null_value_validation() {
1259
+ let handler: EchoHandler = EchoHandler;
1260
+ let message_schema: serde_json::Value = serde_json::json!({
1261
+ "type": "object",
1262
+ "properties": {
1263
+ "optional_field": {"type": ["string", "null"]},
1264
+ "required_field": {"type": "string"}
1265
+ },
1266
+ "required": ["required_field"]
1267
+ });
1268
+
1269
+ let state: WebSocketState<EchoHandler> =
1270
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1271
+
1272
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1273
+
1274
+ let msg1: Value = serde_json::json!({
1275
+ "optional_field": null,
1276
+ "required_field": "value"
1277
+ });
1278
+ assert!(validator.is_valid(&msg1));
1279
+
1280
+ let msg2: Value = serde_json::json!({"required_field": "value"});
1281
+ assert!(validator.is_valid(&msg2));
1282
+
1283
+ let invalid_msg: Value = serde_json::json!({"required_field": null});
1284
+ assert!(!validator.is_valid(&invalid_msg));
1285
+ }
1286
+
1287
+ /// Test schema with default values (they don't change validation)
1288
+ #[test]
1289
+ fn test_schema_with_defaults_still_validates() {
1290
+ let handler: EchoHandler = EchoHandler;
1291
+ let message_schema: serde_json::Value = serde_json::json!({
1292
+ "type": "object",
1293
+ "properties": {
1294
+ "status": {
1295
+ "type": "string",
1296
+ "default": "pending"
1297
+ }
1298
+ }
1299
+ });
1300
+
1301
+ let state: WebSocketState<EchoHandler> =
1302
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1303
+
1304
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1305
+
1306
+ let msg: Value = serde_json::json!({});
1307
+ assert!(validator.is_valid(&msg));
1308
+ }
1309
+
1310
+ /// Test both message and response schema validation together
1311
+ #[test]
1312
+ fn test_both_schemas_validate_independently() {
1313
+ let handler: EchoHandler = EchoHandler;
1314
+ let message_schema: serde_json::Value = serde_json::json!({
1315
+ "type": "object",
1316
+ "properties": {"action": {"type": "string"}},
1317
+ "required": ["action"]
1318
+ });
1319
+ let response_schema: serde_json::Value = serde_json::json!({
1320
+ "type": "object",
1321
+ "properties": {"result": {"type": "string"}},
1322
+ "required": ["result"]
1323
+ });
1324
+
1325
+ let state: WebSocketState<EchoHandler> =
1326
+ WebSocketState::with_schemas(handler, Some(message_schema), Some(response_schema)).unwrap();
1327
+
1328
+ let msg_validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1329
+ let resp_validator: &jsonschema::Validator = state.response_schema.as_ref().unwrap();
1330
+
1331
+ let valid_msg: Value = serde_json::json!({"action": "test"});
1332
+ let invalid_response: Value = serde_json::json!({"data": "oops"});
1333
+
1334
+ assert!(msg_validator.is_valid(&valid_msg));
1335
+ assert!(!resp_validator.is_valid(&invalid_response));
1336
+
1337
+ let invalid_msg: Value = serde_json::json!({"data": "oops"});
1338
+ let valid_response: Value = serde_json::json!({"result": "ok"});
1339
+
1340
+ assert!(!msg_validator.is_valid(&invalid_msg));
1341
+ assert!(resp_validator.is_valid(&valid_response));
1342
+ }
1343
+
1344
+ /// Test validation with very long/large payload
1345
+ #[test]
1346
+ fn test_validation_with_large_payload() {
1347
+ let handler: EchoHandler = EchoHandler;
1348
+ let message_schema: serde_json::Value = serde_json::json!({
1349
+ "type": "object",
1350
+ "properties": {
1351
+ "items": {
1352
+ "type": "array",
1353
+ "items": {"type": "integer"}
1354
+ }
1355
+ },
1356
+ "required": ["items"]
1357
+ });
1358
+
1359
+ let state: WebSocketState<EchoHandler> =
1360
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1361
+
1362
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1363
+
1364
+ let mut items = Vec::new();
1365
+ for i in 0..10_000 {
1366
+ items.push(i);
1367
+ }
1368
+ let large_msg: Value = serde_json::json!({"items": items});
1369
+
1370
+ assert!(validator.is_valid(&large_msg));
1371
+ }
1372
+
1373
+ /// Test validation error doesn't panic with invalid schema combinations
1374
+ #[test]
1375
+ fn test_mutually_exclusive_schema_properties() {
1376
+ let handler: EchoHandler = EchoHandler;
1377
+
1378
+ let message_schema: serde_json::Value = serde_json::json!({
1379
+ "allOf": [
1380
+ {
1381
+ "type": "object",
1382
+ "properties": {"a": {"type": "string"}},
1383
+ "required": ["a"]
1384
+ },
1385
+ {
1386
+ "type": "object",
1387
+ "properties": {"b": {"type": "integer"}},
1388
+ "required": ["b"]
1389
+ }
1390
+ ]
1391
+ });
1392
+
1393
+ let state: WebSocketState<EchoHandler> =
1394
+ WebSocketState::with_schemas(handler, Some(message_schema), None).unwrap();
1395
+
1396
+ let validator: &jsonschema::Validator = state.message_schema.as_ref().unwrap();
1397
+
1398
+ let valid_msg: Value = serde_json::json!({"a": "text", "b": 42});
1399
+ assert!(validator.is_valid(&valid_msg));
1400
+
1401
+ let invalid_msg: Value = serde_json::json!({"a": "text"});
1402
+ assert!(!validator.is_valid(&invalid_msg));
1403
+ }
1404
+ }