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,457 +1,457 @@
1
- //! Request/response validation using JSON Schema
2
-
3
- pub mod error_mapper;
4
-
5
- use crate::debug_log_module;
6
- use jsonschema::Validator;
7
- use serde_json::Value;
8
- use std::sync::Arc;
9
-
10
- use self::error_mapper::{ErrorCondition, ErrorMapper};
11
-
12
- /// Schema validator that compiles and validates JSON Schema
13
- #[derive(Clone)]
14
- pub struct SchemaValidator {
15
- compiled: Arc<Validator>,
16
- schema: Value,
17
- }
18
-
19
- impl SchemaValidator {
20
- /// Create a new validator from a JSON Schema
21
- pub fn new(schema: Value) -> Result<Self, String> {
22
- let compiled = jsonschema::options()
23
- .with_draft(jsonschema::Draft::Draft202012)
24
- .should_validate_formats(true)
25
- .with_pattern_options(jsonschema::PatternOptions::regex())
26
- .build(&schema)
27
- .map_err(|e| {
28
- anyhow::anyhow!("Invalid JSON Schema")
29
- .context(format!("Schema compilation failed: {}", e))
30
- .to_string()
31
- })?;
32
-
33
- Ok(Self {
34
- compiled: Arc::new(compiled),
35
- schema,
36
- })
37
- }
38
-
39
- /// Get the underlying JSON Schema
40
- pub fn schema(&self) -> &Value {
41
- &self.schema
42
- }
43
-
44
- /// Pre-process data to convert file objects to strings for format: "binary" validation
45
- ///
46
- /// Files uploaded via multipart are converted to objects like:
47
- /// {"filename": "...", "size": N, "content": "...", "content_type": "..."}
48
- ///
49
- /// But schemas define them as: {"type": "string", "format": "binary"}
50
- ///
51
- /// This method recursively processes the data and converts file objects to their content strings
52
- /// so that validation passes, while preserving the original structure for handlers to use.
53
- fn preprocess_binary_fields(&self, data: &Value) -> Value {
54
- self.preprocess_value_with_schema(data, &self.schema)
55
- }
56
-
57
- #[allow(clippy::only_used_in_recursion)]
58
- fn preprocess_value_with_schema(&self, data: &Value, schema: &Value) -> Value {
59
- if let Some(schema_obj) = schema.as_object() {
60
- let is_string_type = schema_obj.get("type").and_then(|t| t.as_str()) == Some("string");
61
- let is_binary_format = schema_obj.get("format").and_then(|f| f.as_str()) == Some("binary");
62
-
63
- #[allow(clippy::collapsible_if)]
64
- if is_string_type && is_binary_format {
65
- if let Some(data_obj) = data.as_object() {
66
- if data_obj.contains_key("filename")
67
- && data_obj.contains_key("content")
68
- && data_obj.contains_key("size")
69
- && data_obj.contains_key("content_type")
70
- {
71
- return data_obj.get("content").unwrap_or(&Value::Null).clone();
72
- }
73
- }
74
- return data.clone();
75
- }
76
-
77
- #[allow(clippy::collapsible_if)]
78
- if schema_obj.get("type").and_then(|t| t.as_str()) == Some("array") {
79
- if let Some(items_schema) = schema_obj.get("items") {
80
- if let Some(data_array) = data.as_array() {
81
- let processed_array: Vec<Value> = data_array
82
- .iter()
83
- .map(|item| self.preprocess_value_with_schema(item, items_schema))
84
- .collect();
85
- return Value::Array(processed_array);
86
- }
87
- }
88
- }
89
-
90
- #[allow(clippy::collapsible_if)]
91
- if schema_obj.get("type").and_then(|t| t.as_str()) == Some("object") {
92
- if let Some(properties) = schema_obj.get("properties").and_then(|p| p.as_object()) {
93
- if let Some(data_obj) = data.as_object() {
94
- let mut processed_obj = serde_json::Map::new();
95
- for (key, value) in data_obj {
96
- if let Some(prop_schema) = properties.get(key) {
97
- processed_obj
98
- .insert(key.clone(), self.preprocess_value_with_schema(value, prop_schema));
99
- } else {
100
- processed_obj.insert(key.clone(), value.clone());
101
- }
102
- }
103
- return Value::Object(processed_obj);
104
- }
105
- }
106
- }
107
- }
108
-
109
- data.clone()
110
- }
111
-
112
- /// Validate JSON data against the schema
113
- pub fn validate(&self, data: &Value) -> Result<(), ValidationError> {
114
- let processed_data = self.preprocess_binary_fields(data);
115
-
116
- let validation_errors: Vec<_> = self.compiled.iter_errors(&processed_data).collect();
117
-
118
- if validation_errors.is_empty() {
119
- return Ok(());
120
- }
121
-
122
- let errors: Vec<ValidationErrorDetail> = validation_errors
123
- .into_iter()
124
- .map(|err| {
125
- let instance_path = err.instance_path().to_string();
126
- let schema_path_str = err.schema_path().as_str();
127
- let error_msg = err.to_string();
128
-
129
- let param_name = if schema_path_str.ends_with("/required") {
130
- let field_name = if let Some(start) = error_msg.find('"') {
131
- if let Some(end) = error_msg[start + 1..].find('"') {
132
- error_msg[start + 1..start + 1 + end].to_string()
133
- } else {
134
- "".to_string()
135
- }
136
- } else {
137
- "".to_string()
138
- };
139
-
140
- if !instance_path.is_empty() && instance_path.starts_with('/') && instance_path.len() > 1 {
141
- let base_path = &instance_path[1..];
142
- if !field_name.is_empty() {
143
- format!("{}/{}", base_path, field_name)
144
- } else {
145
- base_path.to_string()
146
- }
147
- } else if !field_name.is_empty() {
148
- field_name
149
- } else {
150
- "body".to_string()
151
- }
152
- } else if schema_path_str.contains("/additionalProperties") {
153
- if let Some(start) = error_msg.find('(') {
154
- if let Some(quote_start) = error_msg[start..].find('\'') {
155
- let abs_start = start + quote_start + 1;
156
- if let Some(quote_end) = error_msg[abs_start..].find('\'') {
157
- let property_name = error_msg[abs_start..abs_start + quote_end].to_string();
158
- if !instance_path.is_empty()
159
- && instance_path.starts_with('/')
160
- && instance_path.len() > 1
161
- {
162
- format!("{}/{}", &instance_path[1..], property_name)
163
- } else {
164
- property_name
165
- }
166
- } else {
167
- instance_path[1..].to_string()
168
- }
169
- } else {
170
- instance_path[1..].to_string()
171
- }
172
- } else if instance_path.starts_with('/') && instance_path.len() > 1 {
173
- instance_path[1..].to_string()
174
- } else {
175
- "body".to_string()
176
- }
177
- } else if instance_path.starts_with('/') && instance_path.len() > 1 {
178
- instance_path[1..].to_string()
179
- } else if instance_path.is_empty() {
180
- "body".to_string()
181
- } else {
182
- instance_path
183
- };
184
-
185
- let loc_parts: Vec<String> = if param_name.contains('/') {
186
- let mut parts = vec!["body".to_string()];
187
- parts.extend(param_name.split('/').map(|s| s.to_string()));
188
- parts
189
- } else if param_name == "body" {
190
- vec!["body".to_string()]
191
- } else {
192
- vec!["body".to_string(), param_name.clone()]
193
- };
194
-
195
- let input_value = if schema_path_str == "/required" {
196
- data.clone()
197
- } else {
198
- err.instance().clone().into_owned()
199
- };
200
-
201
- let schema_prop_path = if param_name.contains('/') {
202
- format!("/properties/{}", param_name.replace('/', "/properties/"))
203
- } else {
204
- format!("/properties/{}", param_name)
205
- };
206
-
207
- let mut error_condition = ErrorCondition::from_schema_error(schema_path_str, &error_msg);
208
-
209
- error_condition = match error_condition {
210
- ErrorCondition::TypeMismatch { .. } => {
211
- let expected_type = self
212
- .schema
213
- .pointer(&format!("{}/type", schema_prop_path))
214
- .and_then(|v| v.as_str())
215
- .unwrap_or("unknown")
216
- .to_string();
217
- ErrorCondition::TypeMismatch { expected_type }
218
- }
219
- ErrorCondition::AdditionalProperties { .. } => {
220
- let unexpected_field = if param_name.contains('/') {
221
- param_name.split('/').next_back().unwrap_or(&param_name).to_string()
222
- } else {
223
- param_name.clone()
224
- };
225
- ErrorCondition::AdditionalProperties {
226
- field: unexpected_field,
227
- }
228
- }
229
- other => other,
230
- };
231
-
232
- let (error_type, msg, ctx) =
233
- ErrorMapper::map_error(&error_condition, &self.schema, &schema_prop_path, &error_msg);
234
-
235
- ValidationErrorDetail {
236
- error_type,
237
- loc: loc_parts,
238
- msg,
239
- input: input_value,
240
- ctx,
241
- }
242
- })
243
- .collect();
244
-
245
- debug_log_module!("validation", "Returning {} validation errors", errors.len());
246
- for (i, error) in errors.iter().enumerate() {
247
- debug_log_module!(
248
- "validation",
249
- " Error {}: type={}, loc={:?}, msg={}, input={}, ctx={:?}",
250
- i,
251
- error.error_type,
252
- error.loc,
253
- error.msg,
254
- error.input,
255
- error.ctx
256
- );
257
- }
258
- #[allow(clippy::collapsible_if)]
259
- if crate::debug::is_enabled() {
260
- if let Ok(json_errors) = serde_json::to_value(&errors) {
261
- if let Ok(json_str) = serde_json::to_string_pretty(&json_errors) {
262
- debug_log_module!("validation", "Serialized errors:\n{}", json_str);
263
- }
264
- }
265
- }
266
-
267
- Err(ValidationError { errors })
268
- }
269
-
270
- /// Validate and parse JSON bytes
271
- pub fn validate_json(&self, json_bytes: &[u8]) -> Result<Value, ValidationError> {
272
- let value: Value = serde_json::from_slice(json_bytes).map_err(|e| ValidationError {
273
- errors: vec![ValidationErrorDetail {
274
- error_type: "json_parse_error".to_string(),
275
- loc: vec!["body".to_string()],
276
- msg: format!("Invalid JSON: {}", e),
277
- input: Value::Null,
278
- ctx: None,
279
- }],
280
- })?;
281
-
282
- self.validate(&value)?;
283
-
284
- Ok(value)
285
- }
286
- }
287
-
288
- /// Validation error containing one or more validation failures
289
- #[derive(Debug, Clone)]
290
- pub struct ValidationError {
291
- pub errors: Vec<ValidationErrorDetail>,
292
- }
293
-
294
- /// Individual validation error detail (FastAPI-compatible format)
295
- #[derive(Debug, Clone, serde::Serialize)]
296
- pub struct ValidationErrorDetail {
297
- #[serde(rename = "type")]
298
- pub error_type: String,
299
- pub loc: Vec<String>,
300
- pub msg: String,
301
- pub input: Value,
302
- #[serde(skip_serializing_if = "Option::is_none")]
303
- pub ctx: Option<Value>,
304
- }
305
-
306
- impl std::fmt::Display for ValidationError {
307
- fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
308
- write!(f, "Validation failed: {} errors", self.errors.len())
309
- }
310
- }
311
-
312
- impl std::error::Error for ValidationError {}
313
-
314
- #[cfg(test)]
315
- mod tests {
316
- use super::*;
317
- use serde_json::json;
318
-
319
- #[test]
320
- fn test_validator_creation() {
321
- let schema = json!({
322
- "type": "object",
323
- "properties": {
324
- "name": {"type": "string"},
325
- "age": {"type": "integer"}
326
- },
327
- "required": ["name"]
328
- });
329
-
330
- let validator = SchemaValidator::new(schema).unwrap();
331
- assert!(validator.compiled.is_valid(&json!({"name": "Alice", "age": 30})));
332
- }
333
-
334
- #[test]
335
- fn test_validation_success() {
336
- let schema = json!({
337
- "type": "object",
338
- "properties": {
339
- "email": {"type": "string", "format": "email"}
340
- }
341
- });
342
-
343
- let validator = SchemaValidator::new(schema).unwrap();
344
- let data = json!({"email": "test@example.com"});
345
-
346
- assert!(validator.validate(&data).is_ok());
347
- }
348
-
349
- #[test]
350
- fn test_validation_failure() {
351
- let schema = json!({
352
- "type": "object",
353
- "properties": {
354
- "age": {"type": "integer", "minimum": 0}
355
- },
356
- "required": ["age"]
357
- });
358
-
359
- let validator = SchemaValidator::new(schema).unwrap();
360
- let data = json!({"age": -5});
361
-
362
- assert!(validator.validate(&data).is_err());
363
- }
364
-
365
- #[test]
366
- fn test_validation_error_serialization() {
367
- let schema = json!({
368
- "type": "object",
369
- "properties": {
370
- "name": {
371
- "type": "string",
372
- "maxLength": 10
373
- }
374
- },
375
- "required": ["name"]
376
- });
377
-
378
- let validator = SchemaValidator::new(schema).unwrap();
379
- let data = json!({"name": "this_is_way_too_long"});
380
-
381
- let result = validator.validate(&data);
382
- assert!(result.is_err());
383
-
384
- let err = result.unwrap_err();
385
- assert_eq!(err.errors.len(), 1);
386
-
387
- let error_detail = &err.errors[0];
388
- assert_eq!(error_detail.error_type, "string_too_long");
389
- assert_eq!(error_detail.loc, vec!["body", "name"]);
390
- assert_eq!(error_detail.msg, "String should have at most 10 characters");
391
- assert_eq!(error_detail.input, Value::String("this_is_way_too_long".to_string()));
392
- assert_eq!(error_detail.ctx, Some(json!({"max_length": 10})));
393
-
394
- let json_output = serde_json::to_value(&err.errors).unwrap();
395
- println!(
396
- "Serialized JSON: {}",
397
- serde_json::to_string_pretty(&json_output).unwrap()
398
- );
399
-
400
- let serialized_error = &json_output[0];
401
- assert!(serialized_error.get("type").is_some());
402
- assert!(serialized_error.get("loc").is_some());
403
- assert!(serialized_error.get("msg").is_some());
404
- assert!(
405
- serialized_error.get("input").is_some(),
406
- "Missing 'input' field in serialized JSON!"
407
- );
408
- assert!(
409
- serialized_error.get("ctx").is_some(),
410
- "Missing 'ctx' field in serialized JSON!"
411
- );
412
-
413
- assert_eq!(
414
- serialized_error["input"],
415
- Value::String("this_is_way_too_long".to_string())
416
- );
417
- assert_eq!(serialized_error["ctx"], json!({"max_length": 10}));
418
- }
419
-
420
- #[test]
421
- fn test_exclusive_minimum() {
422
- let schema = json!({
423
- "$schema": "https://json-schema.org/draft/2020-12/schema",
424
- "type": "object",
425
- "required": ["id", "name", "price"],
426
- "properties": {
427
- "id": {
428
- "type": "integer"
429
- },
430
- "name": {
431
- "type": "string",
432
- "minLength": 3
433
- },
434
- "price": {
435
- "type": "number",
436
- "exclusiveMinimum": 0
437
- }
438
- }
439
- });
440
-
441
- let validator = SchemaValidator::new(schema).unwrap();
442
-
443
- let data = json!({
444
- "id": 1,
445
- "name": "X",
446
- "price": -10
447
- });
448
-
449
- let result = validator.validate(&data);
450
- eprintln!("Validation result: {:?}", result);
451
-
452
- assert!(result.is_err(), "Should have validation errors");
453
- let err = result.unwrap_err();
454
- eprintln!("Errors: {:?}", err.errors);
455
- assert_eq!(err.errors.len(), 2, "Should have 2 errors");
456
- }
457
- }
1
+ //! Request/response validation using JSON Schema
2
+
3
+ pub mod error_mapper;
4
+
5
+ use crate::debug_log_module;
6
+ use jsonschema::Validator;
7
+ use serde_json::Value;
8
+ use std::sync::Arc;
9
+
10
+ use self::error_mapper::{ErrorCondition, ErrorMapper};
11
+
12
+ /// Schema validator that compiles and validates JSON Schema
13
+ #[derive(Clone)]
14
+ pub struct SchemaValidator {
15
+ compiled: Arc<Validator>,
16
+ schema: Value,
17
+ }
18
+
19
+ impl SchemaValidator {
20
+ /// Create a new validator from a JSON Schema
21
+ pub fn new(schema: Value) -> Result<Self, String> {
22
+ let compiled = jsonschema::options()
23
+ .with_draft(jsonschema::Draft::Draft202012)
24
+ .should_validate_formats(true)
25
+ .with_pattern_options(jsonschema::PatternOptions::regex())
26
+ .build(&schema)
27
+ .map_err(|e| {
28
+ anyhow::anyhow!("Invalid JSON Schema")
29
+ .context(format!("Schema compilation failed: {}", e))
30
+ .to_string()
31
+ })?;
32
+
33
+ Ok(Self {
34
+ compiled: Arc::new(compiled),
35
+ schema,
36
+ })
37
+ }
38
+
39
+ /// Get the underlying JSON Schema
40
+ pub fn schema(&self) -> &Value {
41
+ &self.schema
42
+ }
43
+
44
+ /// Pre-process data to convert file objects to strings for format: "binary" validation
45
+ ///
46
+ /// Files uploaded via multipart are converted to objects like:
47
+ /// {"filename": "...", "size": N, "content": "...", "content_type": "..."}
48
+ ///
49
+ /// But schemas define them as: {"type": "string", "format": "binary"}
50
+ ///
51
+ /// This method recursively processes the data and converts file objects to their content strings
52
+ /// so that validation passes, while preserving the original structure for handlers to use.
53
+ fn preprocess_binary_fields(&self, data: &Value) -> Value {
54
+ self.preprocess_value_with_schema(data, &self.schema)
55
+ }
56
+
57
+ #[allow(clippy::only_used_in_recursion)]
58
+ fn preprocess_value_with_schema(&self, data: &Value, schema: &Value) -> Value {
59
+ if let Some(schema_obj) = schema.as_object() {
60
+ let is_string_type = schema_obj.get("type").and_then(|t| t.as_str()) == Some("string");
61
+ let is_binary_format = schema_obj.get("format").and_then(|f| f.as_str()) == Some("binary");
62
+
63
+ #[allow(clippy::collapsible_if)]
64
+ if is_string_type && is_binary_format {
65
+ if let Some(data_obj) = data.as_object() {
66
+ if data_obj.contains_key("filename")
67
+ && data_obj.contains_key("content")
68
+ && data_obj.contains_key("size")
69
+ && data_obj.contains_key("content_type")
70
+ {
71
+ return data_obj.get("content").unwrap_or(&Value::Null).clone();
72
+ }
73
+ }
74
+ return data.clone();
75
+ }
76
+
77
+ #[allow(clippy::collapsible_if)]
78
+ if schema_obj.get("type").and_then(|t| t.as_str()) == Some("array") {
79
+ if let Some(items_schema) = schema_obj.get("items") {
80
+ if let Some(data_array) = data.as_array() {
81
+ let processed_array: Vec<Value> = data_array
82
+ .iter()
83
+ .map(|item| self.preprocess_value_with_schema(item, items_schema))
84
+ .collect();
85
+ return Value::Array(processed_array);
86
+ }
87
+ }
88
+ }
89
+
90
+ #[allow(clippy::collapsible_if)]
91
+ if schema_obj.get("type").and_then(|t| t.as_str()) == Some("object") {
92
+ if let Some(properties) = schema_obj.get("properties").and_then(|p| p.as_object()) {
93
+ if let Some(data_obj) = data.as_object() {
94
+ let mut processed_obj = serde_json::Map::new();
95
+ for (key, value) in data_obj {
96
+ if let Some(prop_schema) = properties.get(key) {
97
+ processed_obj
98
+ .insert(key.clone(), self.preprocess_value_with_schema(value, prop_schema));
99
+ } else {
100
+ processed_obj.insert(key.clone(), value.clone());
101
+ }
102
+ }
103
+ return Value::Object(processed_obj);
104
+ }
105
+ }
106
+ }
107
+ }
108
+
109
+ data.clone()
110
+ }
111
+
112
+ /// Validate JSON data against the schema
113
+ pub fn validate(&self, data: &Value) -> Result<(), ValidationError> {
114
+ let processed_data = self.preprocess_binary_fields(data);
115
+
116
+ let validation_errors: Vec<_> = self.compiled.iter_errors(&processed_data).collect();
117
+
118
+ if validation_errors.is_empty() {
119
+ return Ok(());
120
+ }
121
+
122
+ let errors: Vec<ValidationErrorDetail> = validation_errors
123
+ .into_iter()
124
+ .map(|err| {
125
+ let instance_path = err.instance_path().to_string();
126
+ let schema_path_str = err.schema_path().as_str();
127
+ let error_msg = err.to_string();
128
+
129
+ let param_name = if schema_path_str.ends_with("/required") {
130
+ let field_name = if let Some(start) = error_msg.find('"') {
131
+ if let Some(end) = error_msg[start + 1..].find('"') {
132
+ error_msg[start + 1..start + 1 + end].to_string()
133
+ } else {
134
+ "".to_string()
135
+ }
136
+ } else {
137
+ "".to_string()
138
+ };
139
+
140
+ if !instance_path.is_empty() && instance_path.starts_with('/') && instance_path.len() > 1 {
141
+ let base_path = &instance_path[1..];
142
+ if !field_name.is_empty() {
143
+ format!("{}/{}", base_path, field_name)
144
+ } else {
145
+ base_path.to_string()
146
+ }
147
+ } else if !field_name.is_empty() {
148
+ field_name
149
+ } else {
150
+ "body".to_string()
151
+ }
152
+ } else if schema_path_str.contains("/additionalProperties") {
153
+ if let Some(start) = error_msg.find('(') {
154
+ if let Some(quote_start) = error_msg[start..].find('\'') {
155
+ let abs_start = start + quote_start + 1;
156
+ if let Some(quote_end) = error_msg[abs_start..].find('\'') {
157
+ let property_name = error_msg[abs_start..abs_start + quote_end].to_string();
158
+ if !instance_path.is_empty()
159
+ && instance_path.starts_with('/')
160
+ && instance_path.len() > 1
161
+ {
162
+ format!("{}/{}", &instance_path[1..], property_name)
163
+ } else {
164
+ property_name
165
+ }
166
+ } else {
167
+ instance_path[1..].to_string()
168
+ }
169
+ } else {
170
+ instance_path[1..].to_string()
171
+ }
172
+ } else if instance_path.starts_with('/') && instance_path.len() > 1 {
173
+ instance_path[1..].to_string()
174
+ } else {
175
+ "body".to_string()
176
+ }
177
+ } else if instance_path.starts_with('/') && instance_path.len() > 1 {
178
+ instance_path[1..].to_string()
179
+ } else if instance_path.is_empty() {
180
+ "body".to_string()
181
+ } else {
182
+ instance_path
183
+ };
184
+
185
+ let loc_parts: Vec<String> = if param_name.contains('/') {
186
+ let mut parts = vec!["body".to_string()];
187
+ parts.extend(param_name.split('/').map(|s| s.to_string()));
188
+ parts
189
+ } else if param_name == "body" {
190
+ vec!["body".to_string()]
191
+ } else {
192
+ vec!["body".to_string(), param_name.clone()]
193
+ };
194
+
195
+ let input_value = if schema_path_str == "/required" {
196
+ data.clone()
197
+ } else {
198
+ err.instance().clone().into_owned()
199
+ };
200
+
201
+ let schema_prop_path = if param_name.contains('/') {
202
+ format!("/properties/{}", param_name.replace('/', "/properties/"))
203
+ } else {
204
+ format!("/properties/{}", param_name)
205
+ };
206
+
207
+ let mut error_condition = ErrorCondition::from_schema_error(schema_path_str, &error_msg);
208
+
209
+ error_condition = match error_condition {
210
+ ErrorCondition::TypeMismatch { .. } => {
211
+ let expected_type = self
212
+ .schema
213
+ .pointer(&format!("{}/type", schema_prop_path))
214
+ .and_then(|v| v.as_str())
215
+ .unwrap_or("unknown")
216
+ .to_string();
217
+ ErrorCondition::TypeMismatch { expected_type }
218
+ }
219
+ ErrorCondition::AdditionalProperties { .. } => {
220
+ let unexpected_field = if param_name.contains('/') {
221
+ param_name.split('/').next_back().unwrap_or(&param_name).to_string()
222
+ } else {
223
+ param_name.clone()
224
+ };
225
+ ErrorCondition::AdditionalProperties {
226
+ field: unexpected_field,
227
+ }
228
+ }
229
+ other => other,
230
+ };
231
+
232
+ let (error_type, msg, ctx) =
233
+ ErrorMapper::map_error(&error_condition, &self.schema, &schema_prop_path, &error_msg);
234
+
235
+ ValidationErrorDetail {
236
+ error_type,
237
+ loc: loc_parts,
238
+ msg,
239
+ input: input_value,
240
+ ctx,
241
+ }
242
+ })
243
+ .collect();
244
+
245
+ debug_log_module!("validation", "Returning {} validation errors", errors.len());
246
+ for (i, error) in errors.iter().enumerate() {
247
+ debug_log_module!(
248
+ "validation",
249
+ " Error {}: type={}, loc={:?}, msg={}, input={}, ctx={:?}",
250
+ i,
251
+ error.error_type,
252
+ error.loc,
253
+ error.msg,
254
+ error.input,
255
+ error.ctx
256
+ );
257
+ }
258
+ #[allow(clippy::collapsible_if)]
259
+ if crate::debug::is_enabled() {
260
+ if let Ok(json_errors) = serde_json::to_value(&errors) {
261
+ if let Ok(json_str) = serde_json::to_string_pretty(&json_errors) {
262
+ debug_log_module!("validation", "Serialized errors:\n{}", json_str);
263
+ }
264
+ }
265
+ }
266
+
267
+ Err(ValidationError { errors })
268
+ }
269
+
270
+ /// Validate and parse JSON bytes
271
+ pub fn validate_json(&self, json_bytes: &[u8]) -> Result<Value, ValidationError> {
272
+ let value: Value = serde_json::from_slice(json_bytes).map_err(|e| ValidationError {
273
+ errors: vec![ValidationErrorDetail {
274
+ error_type: "json_parse_error".to_string(),
275
+ loc: vec!["body".to_string()],
276
+ msg: format!("Invalid JSON: {}", e),
277
+ input: Value::Null,
278
+ ctx: None,
279
+ }],
280
+ })?;
281
+
282
+ self.validate(&value)?;
283
+
284
+ Ok(value)
285
+ }
286
+ }
287
+
288
+ /// Validation error containing one or more validation failures
289
+ #[derive(Debug, Clone)]
290
+ pub struct ValidationError {
291
+ pub errors: Vec<ValidationErrorDetail>,
292
+ }
293
+
294
+ /// Individual validation error detail (FastAPI-compatible format)
295
+ #[derive(Debug, Clone, serde::Serialize)]
296
+ pub struct ValidationErrorDetail {
297
+ #[serde(rename = "type")]
298
+ pub error_type: String,
299
+ pub loc: Vec<String>,
300
+ pub msg: String,
301
+ pub input: Value,
302
+ #[serde(skip_serializing_if = "Option::is_none")]
303
+ pub ctx: Option<Value>,
304
+ }
305
+
306
+ impl std::fmt::Display for ValidationError {
307
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
308
+ write!(f, "Validation failed: {} errors", self.errors.len())
309
+ }
310
+ }
311
+
312
+ impl std::error::Error for ValidationError {}
313
+
314
+ #[cfg(test)]
315
+ mod tests {
316
+ use super::*;
317
+ use serde_json::json;
318
+
319
+ #[test]
320
+ fn test_validator_creation() {
321
+ let schema = json!({
322
+ "type": "object",
323
+ "properties": {
324
+ "name": {"type": "string"},
325
+ "age": {"type": "integer"}
326
+ },
327
+ "required": ["name"]
328
+ });
329
+
330
+ let validator = SchemaValidator::new(schema).unwrap();
331
+ assert!(validator.compiled.is_valid(&json!({"name": "Alice", "age": 30})));
332
+ }
333
+
334
+ #[test]
335
+ fn test_validation_success() {
336
+ let schema = json!({
337
+ "type": "object",
338
+ "properties": {
339
+ "email": {"type": "string", "format": "email"}
340
+ }
341
+ });
342
+
343
+ let validator = SchemaValidator::new(schema).unwrap();
344
+ let data = json!({"email": "test@example.com"});
345
+
346
+ assert!(validator.validate(&data).is_ok());
347
+ }
348
+
349
+ #[test]
350
+ fn test_validation_failure() {
351
+ let schema = json!({
352
+ "type": "object",
353
+ "properties": {
354
+ "age": {"type": "integer", "minimum": 0}
355
+ },
356
+ "required": ["age"]
357
+ });
358
+
359
+ let validator = SchemaValidator::new(schema).unwrap();
360
+ let data = json!({"age": -5});
361
+
362
+ assert!(validator.validate(&data).is_err());
363
+ }
364
+
365
+ #[test]
366
+ fn test_validation_error_serialization() {
367
+ let schema = json!({
368
+ "type": "object",
369
+ "properties": {
370
+ "name": {
371
+ "type": "string",
372
+ "maxLength": 10
373
+ }
374
+ },
375
+ "required": ["name"]
376
+ });
377
+
378
+ let validator = SchemaValidator::new(schema).unwrap();
379
+ let data = json!({"name": "this_is_way_too_long"});
380
+
381
+ let result = validator.validate(&data);
382
+ assert!(result.is_err());
383
+
384
+ let err = result.unwrap_err();
385
+ assert_eq!(err.errors.len(), 1);
386
+
387
+ let error_detail = &err.errors[0];
388
+ assert_eq!(error_detail.error_type, "string_too_long");
389
+ assert_eq!(error_detail.loc, vec!["body", "name"]);
390
+ assert_eq!(error_detail.msg, "String should have at most 10 characters");
391
+ assert_eq!(error_detail.input, Value::String("this_is_way_too_long".to_string()));
392
+ assert_eq!(error_detail.ctx, Some(json!({"max_length": 10})));
393
+
394
+ let json_output = serde_json::to_value(&err.errors).unwrap();
395
+ println!(
396
+ "Serialized JSON: {}",
397
+ serde_json::to_string_pretty(&json_output).unwrap()
398
+ );
399
+
400
+ let serialized_error = &json_output[0];
401
+ assert!(serialized_error.get("type").is_some());
402
+ assert!(serialized_error.get("loc").is_some());
403
+ assert!(serialized_error.get("msg").is_some());
404
+ assert!(
405
+ serialized_error.get("input").is_some(),
406
+ "Missing 'input' field in serialized JSON!"
407
+ );
408
+ assert!(
409
+ serialized_error.get("ctx").is_some(),
410
+ "Missing 'ctx' field in serialized JSON!"
411
+ );
412
+
413
+ assert_eq!(
414
+ serialized_error["input"],
415
+ Value::String("this_is_way_too_long".to_string())
416
+ );
417
+ assert_eq!(serialized_error["ctx"], json!({"max_length": 10}));
418
+ }
419
+
420
+ #[test]
421
+ fn test_exclusive_minimum() {
422
+ let schema = json!({
423
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
424
+ "type": "object",
425
+ "required": ["id", "name", "price"],
426
+ "properties": {
427
+ "id": {
428
+ "type": "integer"
429
+ },
430
+ "name": {
431
+ "type": "string",
432
+ "minLength": 3
433
+ },
434
+ "price": {
435
+ "type": "number",
436
+ "exclusiveMinimum": 0
437
+ }
438
+ }
439
+ });
440
+
441
+ let validator = SchemaValidator::new(schema).unwrap();
442
+
443
+ let data = json!({
444
+ "id": 1,
445
+ "name": "X",
446
+ "price": -10
447
+ });
448
+
449
+ let result = validator.validate(&data);
450
+ eprintln!("Validation result: {:?}", result);
451
+
452
+ assert!(result.is_err(), "Should have validation errors");
453
+ let err = result.unwrap_err();
454
+ eprintln!("Errors: {:?}", err.errors);
455
+ assert_eq!(err.errors.len(), 2, "Should have 2 errors");
456
+ }
457
+ }