spikard 0.3.2 → 0.3.4

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 (180) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +659 -659
  4. data/ext/spikard_rb/Cargo.toml +17 -17
  5. data/ext/spikard_rb/extconf.rb +10 -10
  6. data/ext/spikard_rb/src/lib.rs +6 -6
  7. data/lib/spikard/app.rb +386 -386
  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 +221 -221
  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 +360 -360
  23. data/vendor/crates/spikard-core/Cargo.toml +40 -40
  24. data/vendor/crates/spikard-core/src/bindings/mod.rs +3 -3
  25. data/vendor/crates/spikard-core/src/bindings/response.rs +133 -133
  26. data/vendor/crates/spikard-core/src/debug.rs +63 -63
  27. data/vendor/crates/spikard-core/src/di/container.rs +726 -726
  28. data/vendor/crates/spikard-core/src/di/dependency.rs +273 -273
  29. data/vendor/crates/spikard-core/src/di/error.rs +118 -118
  30. data/vendor/crates/spikard-core/src/di/factory.rs +538 -538
  31. data/vendor/crates/spikard-core/src/di/graph.rs +545 -545
  32. data/vendor/crates/spikard-core/src/di/mod.rs +192 -192
  33. data/vendor/crates/spikard-core/src/di/resolved.rs +411 -411
  34. data/vendor/crates/spikard-core/src/di/value.rs +283 -283
  35. data/vendor/crates/spikard-core/src/errors.rs +39 -39
  36. data/vendor/crates/spikard-core/src/http.rs +153 -153
  37. data/vendor/crates/spikard-core/src/lib.rs +29 -29
  38. data/vendor/crates/spikard-core/src/lifecycle.rs +422 -422
  39. data/vendor/crates/spikard-core/src/parameters.rs +722 -722
  40. data/vendor/crates/spikard-core/src/problem.rs +310 -310
  41. data/vendor/crates/spikard-core/src/request_data.rs +189 -189
  42. data/vendor/crates/spikard-core/src/router.rs +249 -249
  43. data/vendor/crates/spikard-core/src/schema_registry.rs +183 -183
  44. data/vendor/crates/spikard-core/src/type_hints.rs +304 -304
  45. data/vendor/crates/spikard-core/src/validation.rs +699 -699
  46. data/vendor/crates/spikard-http/Cargo.toml +58 -58
  47. data/vendor/crates/spikard-http/src/auth.rs +247 -247
  48. data/vendor/crates/spikard-http/src/background.rs +249 -249
  49. data/vendor/crates/spikard-http/src/bindings/mod.rs +3 -3
  50. data/vendor/crates/spikard-http/src/bindings/response.rs +1 -1
  51. data/vendor/crates/spikard-http/src/body_metadata.rs +8 -8
  52. data/vendor/crates/spikard-http/src/cors.rs +490 -490
  53. data/vendor/crates/spikard-http/src/debug.rs +63 -63
  54. data/vendor/crates/spikard-http/src/di_handler.rs +423 -423
  55. data/vendor/crates/spikard-http/src/handler_response.rs +190 -190
  56. data/vendor/crates/spikard-http/src/handler_trait.rs +228 -228
  57. data/vendor/crates/spikard-http/src/handler_trait_tests.rs +284 -284
  58. data/vendor/crates/spikard-http/src/lib.rs +529 -529
  59. data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +149 -149
  60. data/vendor/crates/spikard-http/src/lifecycle.rs +428 -428
  61. data/vendor/crates/spikard-http/src/middleware/mod.rs +285 -285
  62. data/vendor/crates/spikard-http/src/middleware/multipart.rs +86 -86
  63. data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +147 -147
  64. data/vendor/crates/spikard-http/src/middleware/validation.rs +287 -287
  65. data/vendor/crates/spikard-http/src/openapi/mod.rs +309 -309
  66. data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +190 -190
  67. data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +308 -308
  68. data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +195 -195
  69. data/vendor/crates/spikard-http/src/parameters.rs +1 -1
  70. data/vendor/crates/spikard-http/src/problem.rs +1 -1
  71. data/vendor/crates/spikard-http/src/query_parser.rs +369 -369
  72. data/vendor/crates/spikard-http/src/response.rs +399 -399
  73. data/vendor/crates/spikard-http/src/router.rs +1 -1
  74. data/vendor/crates/spikard-http/src/schema_registry.rs +1 -1
  75. data/vendor/crates/spikard-http/src/server/handler.rs +87 -87
  76. data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +98 -98
  77. data/vendor/crates/spikard-http/src/server/mod.rs +805 -805
  78. data/vendor/crates/spikard-http/src/server/request_extraction.rs +119 -119
  79. data/vendor/crates/spikard-http/src/sse.rs +447 -447
  80. data/vendor/crates/spikard-http/src/testing/form.rs +14 -14
  81. data/vendor/crates/spikard-http/src/testing/multipart.rs +60 -60
  82. data/vendor/crates/spikard-http/src/testing/test_client.rs +285 -285
  83. data/vendor/crates/spikard-http/src/testing.rs +377 -377
  84. data/vendor/crates/spikard-http/src/type_hints.rs +1 -1
  85. data/vendor/crates/spikard-http/src/validation.rs +1 -1
  86. data/vendor/crates/spikard-http/src/websocket.rs +324 -324
  87. data/vendor/crates/spikard-rb/Cargo.toml +42 -42
  88. data/vendor/crates/spikard-rb/build.rs +8 -8
  89. data/vendor/crates/spikard-rb/src/background.rs +63 -63
  90. data/vendor/crates/spikard-rb/src/config.rs +294 -294
  91. data/vendor/crates/spikard-rb/src/conversion.rs +453 -453
  92. data/vendor/crates/spikard-rb/src/di.rs +409 -409
  93. data/vendor/crates/spikard-rb/src/handler.rs +625 -625
  94. data/vendor/crates/spikard-rb/src/lib.rs +2771 -2771
  95. data/vendor/crates/spikard-rb/src/lifecycle.rs +274 -274
  96. data/vendor/crates/spikard-rb/src/server.rs +283 -283
  97. data/vendor/crates/spikard-rb/src/sse.rs +231 -231
  98. data/vendor/crates/spikard-rb/src/test_client.rs +404 -404
  99. data/vendor/crates/spikard-rb/src/test_sse.rs +143 -143
  100. data/vendor/crates/spikard-rb/src/test_websocket.rs +221 -221
  101. data/vendor/crates/spikard-rb/src/websocket.rs +233 -233
  102. data/vendor/spikard-core/Cargo.toml +40 -40
  103. data/vendor/spikard-core/src/bindings/mod.rs +3 -3
  104. data/vendor/spikard-core/src/bindings/response.rs +133 -133
  105. data/vendor/spikard-core/src/debug.rs +63 -63
  106. data/vendor/spikard-core/src/di/container.rs +726 -726
  107. data/vendor/spikard-core/src/di/dependency.rs +273 -273
  108. data/vendor/spikard-core/src/di/error.rs +118 -118
  109. data/vendor/spikard-core/src/di/factory.rs +538 -538
  110. data/vendor/spikard-core/src/di/graph.rs +545 -545
  111. data/vendor/spikard-core/src/di/mod.rs +192 -192
  112. data/vendor/spikard-core/src/di/resolved.rs +411 -411
  113. data/vendor/spikard-core/src/di/value.rs +283 -283
  114. data/vendor/spikard-core/src/http.rs +153 -153
  115. data/vendor/spikard-core/src/lib.rs +28 -28
  116. data/vendor/spikard-core/src/lifecycle.rs +422 -422
  117. data/vendor/spikard-core/src/parameters.rs +719 -719
  118. data/vendor/spikard-core/src/problem.rs +310 -310
  119. data/vendor/spikard-core/src/request_data.rs +189 -189
  120. data/vendor/spikard-core/src/router.rs +249 -249
  121. data/vendor/spikard-core/src/schema_registry.rs +183 -183
  122. data/vendor/spikard-core/src/type_hints.rs +304 -304
  123. data/vendor/spikard-core/src/validation.rs +699 -699
  124. data/vendor/spikard-http/Cargo.toml +58 -58
  125. data/vendor/spikard-http/src/auth.rs +247 -247
  126. data/vendor/spikard-http/src/background.rs +249 -249
  127. data/vendor/spikard-http/src/bindings/mod.rs +3 -3
  128. data/vendor/spikard-http/src/bindings/response.rs +1 -1
  129. data/vendor/spikard-http/src/body_metadata.rs +8 -8
  130. data/vendor/spikard-http/src/cors.rs +490 -490
  131. data/vendor/spikard-http/src/debug.rs +63 -63
  132. data/vendor/spikard-http/src/di_handler.rs +423 -423
  133. data/vendor/spikard-http/src/handler_response.rs +190 -190
  134. data/vendor/spikard-http/src/handler_trait.rs +228 -228
  135. data/vendor/spikard-http/src/handler_trait_tests.rs +284 -284
  136. data/vendor/spikard-http/src/lib.rs +529 -529
  137. data/vendor/spikard-http/src/lifecycle/adapter.rs +149 -149
  138. data/vendor/spikard-http/src/lifecycle.rs +428 -428
  139. data/vendor/spikard-http/src/middleware/mod.rs +285 -285
  140. data/vendor/spikard-http/src/middleware/multipart.rs +86 -86
  141. data/vendor/spikard-http/src/middleware/urlencoded.rs +147 -147
  142. data/vendor/spikard-http/src/middleware/validation.rs +287 -287
  143. data/vendor/spikard-http/src/openapi/mod.rs +309 -309
  144. data/vendor/spikard-http/src/openapi/parameter_extraction.rs +190 -190
  145. data/vendor/spikard-http/src/openapi/schema_conversion.rs +308 -308
  146. data/vendor/spikard-http/src/openapi/spec_generation.rs +195 -195
  147. data/vendor/spikard-http/src/parameters.rs +1 -1
  148. data/vendor/spikard-http/src/problem.rs +1 -1
  149. data/vendor/spikard-http/src/query_parser.rs +369 -369
  150. data/vendor/spikard-http/src/response.rs +399 -399
  151. data/vendor/spikard-http/src/router.rs +1 -1
  152. data/vendor/spikard-http/src/schema_registry.rs +1 -1
  153. data/vendor/spikard-http/src/server/handler.rs +80 -80
  154. data/vendor/spikard-http/src/server/lifecycle_execution.rs +98 -98
  155. data/vendor/spikard-http/src/server/mod.rs +805 -805
  156. data/vendor/spikard-http/src/server/request_extraction.rs +119 -119
  157. data/vendor/spikard-http/src/sse.rs +447 -447
  158. data/vendor/spikard-http/src/testing/form.rs +14 -14
  159. data/vendor/spikard-http/src/testing/multipart.rs +60 -60
  160. data/vendor/spikard-http/src/testing/test_client.rs +285 -285
  161. data/vendor/spikard-http/src/testing.rs +377 -377
  162. data/vendor/spikard-http/src/type_hints.rs +1 -1
  163. data/vendor/spikard-http/src/validation.rs +1 -1
  164. data/vendor/spikard-http/src/websocket.rs +324 -324
  165. data/vendor/spikard-rb/Cargo.toml +42 -42
  166. data/vendor/spikard-rb/build.rs +8 -8
  167. data/vendor/spikard-rb/src/background.rs +63 -63
  168. data/vendor/spikard-rb/src/config.rs +294 -294
  169. data/vendor/spikard-rb/src/conversion.rs +392 -392
  170. data/vendor/spikard-rb/src/di.rs +409 -409
  171. data/vendor/spikard-rb/src/handler.rs +534 -534
  172. data/vendor/spikard-rb/src/lib.rs +2020 -2020
  173. data/vendor/spikard-rb/src/lifecycle.rs +267 -267
  174. data/vendor/spikard-rb/src/server.rs +283 -283
  175. data/vendor/spikard-rb/src/sse.rs +231 -231
  176. data/vendor/spikard-rb/src/test_client.rs +404 -404
  177. data/vendor/spikard-rb/src/test_sse.rs +143 -143
  178. data/vendor/spikard-rb/src/test_websocket.rs +221 -221
  179. data/vendor/spikard-rb/src/websocket.rs +233 -233
  180. metadata +1 -1
@@ -1,625 +1,625 @@
1
- //! Ruby handler wrapper implementing the Handler trait.
2
- //!
3
- //! This module provides the `RubyHandler` struct that wraps Ruby Proc objects
4
- //! and implements Spikard's `Handler` trait for async request processing.
5
-
6
- #![allow(dead_code)]
7
-
8
- use axum::body::Body;
9
- use axum::http::{HeaderName, HeaderValue, Request, StatusCode};
10
- use magnus::prelude::*;
11
- use magnus::value::{InnerValue, Opaque};
12
- use magnus::{Error, RHash, RString, Ruby, TryConvert, Value, gc::Marker};
13
- use serde_json::{Map as JsonMap, Value as JsonValue};
14
- use spikard_core::errors::StructuredError;
15
- use spikard_http::ParameterValidator;
16
- use spikard_http::SchemaValidator;
17
- use spikard_http::problem::ProblemDetails;
18
- use spikard_http::{Handler, HandlerResponse, HandlerResult, RequestData};
19
- use std::collections::HashMap;
20
- use std::panic::AssertUnwindSafe;
21
- use std::pin::Pin;
22
- use std::sync::Arc;
23
-
24
- use crate::conversion::{
25
- json_to_ruby, json_to_ruby_with_uploads, map_to_ruby_hash, multimap_to_ruby_hash, ruby_value_to_json,
26
- };
27
-
28
- /// Response payload with status, headers, and body data.
29
- pub struct HandlerResponsePayload {
30
- pub status: u16,
31
- pub headers: HashMap<String, String>,
32
- pub body: Option<JsonValue>,
33
- pub raw_body: Option<Vec<u8>>,
34
- }
35
-
36
- /// Streaming response variant containing an enumerator and metadata.
37
- pub struct StreamingResponsePayload {
38
- pub enumerator: Arc<Opaque<Value>>,
39
- pub status: u16,
40
- pub headers: HashMap<String, String>,
41
- }
42
-
43
- /// Handler result: either a payload or a streaming response.
44
- pub enum RubyHandlerResult {
45
- Payload(HandlerResponsePayload),
46
- Streaming(StreamingResponsePayload),
47
- }
48
-
49
- impl StreamingResponsePayload {
50
- /// Convert streaming response into a `HandlerResponse`.
51
- pub fn into_response(self) -> Result<HandlerResponse, Error> {
52
- let ruby = Ruby::get().map_err(|_| {
53
- Error::new(
54
- Ruby::get().unwrap().exception_runtime_error(),
55
- "Ruby VM unavailable while building streaming response",
56
- )
57
- })?;
58
-
59
- let status = StatusCode::from_u16(self.status).map_err(|err| {
60
- Error::new(
61
- ruby.exception_arg_error(),
62
- format!("Invalid streaming status code {}: {}", self.status, err),
63
- )
64
- })?;
65
-
66
- let header_pairs = self
67
- .headers
68
- .into_iter()
69
- .map(|(name, value)| {
70
- let header_name = HeaderName::from_bytes(name.as_bytes()).map_err(|err| {
71
- Error::new(
72
- ruby.exception_arg_error(),
73
- format!("Invalid header name '{name}': {err}"),
74
- )
75
- })?;
76
- let header_value = HeaderValue::from_str(&value).map_err(|err| {
77
- Error::new(
78
- ruby.exception_arg_error(),
79
- format!("Invalid header value for '{name}': {err}"),
80
- )
81
- })?;
82
- Ok((header_name, header_value))
83
- })
84
- .collect::<Result<Vec<_>, Error>>()?;
85
-
86
- let enumerator = self.enumerator.clone();
87
- let body_stream = async_stream::stream! {
88
- loop {
89
- match poll_stream_chunk(&enumerator) {
90
- Ok(Some(bytes)) => yield Ok(bytes),
91
- Ok(None) => break,
92
- Err(err) => {
93
- yield Err(Box::new(err));
94
- break;
95
- }
96
- }
97
- }
98
- };
99
-
100
- let mut response = HandlerResponse::stream(body_stream).with_status(status);
101
- for (name, value) in header_pairs {
102
- response = response.with_header(name, value);
103
- }
104
- Ok(response)
105
- }
106
- }
107
-
108
- /// Poll a single chunk from a Ruby enumerator.
109
- fn poll_stream_chunk(enumerator: &Arc<Opaque<Value>>) -> Result<Option<bytes::Bytes>, std::io::Error> {
110
- let ruby = Ruby::get().map_err(|err| std::io::Error::other(err.to_string()))?;
111
- let enum_value = enumerator.get_inner_with(&ruby);
112
- match enum_value.funcall::<_, _, Value>("next", ()) {
113
- Ok(chunk) => crate::conversion::ruby_value_to_bytes(chunk).map(Some),
114
- Err(err) => {
115
- if err.is_kind_of(ruby.exception_stop_iteration()) {
116
- Ok(None)
117
- } else {
118
- Err(std::io::Error::other(err.to_string()))
119
- }
120
- }
121
- }
122
- }
123
-
124
- /// Inner state of a Ruby handler.
125
- pub struct RubyHandlerInner {
126
- pub handler_proc: Opaque<Value>,
127
- pub handler_name: String,
128
- pub method: String,
129
- pub path: String,
130
- pub json_module: Opaque<Value>,
131
- pub request_validator: Option<Arc<SchemaValidator>>,
132
- pub response_validator: Option<Arc<SchemaValidator>>,
133
- pub parameter_validator: Option<ParameterValidator>,
134
- pub upload_file_class: Option<Opaque<Value>>,
135
- }
136
-
137
- /// Wrapper around a Ruby Proc that implements the Handler trait.
138
- #[derive(Clone)]
139
- pub struct RubyHandler {
140
- pub inner: Arc<RubyHandlerInner>,
141
- }
142
-
143
- impl RubyHandler {
144
- /// Create a new RubyHandler from a route and handler Proc.
145
- pub fn new(route: &spikard_http::Route, handler_value: Value, json_module: Value) -> Result<Self, Error> {
146
- let upload_file_class = lookup_upload_file_class()?;
147
- Ok(Self {
148
- inner: Arc::new(RubyHandlerInner {
149
- handler_proc: Opaque::from(handler_value),
150
- handler_name: route.handler_name.clone(),
151
- method: route.method.as_str().to_string(),
152
- path: route.path.clone(),
153
- json_module: Opaque::from(json_module),
154
- request_validator: route.request_validator.clone(),
155
- response_validator: route.response_validator.clone(),
156
- parameter_validator: route.parameter_validator.clone(),
157
- upload_file_class,
158
- }),
159
- })
160
- }
161
-
162
- /// Create a new RubyHandler for server mode
163
- ///
164
- /// This is used by run_server to create handlers from Ruby Procs
165
- pub fn new_for_server(
166
- _ruby: &Ruby,
167
- handler_value: Value,
168
- handler_name: String,
169
- method: String,
170
- path: String,
171
- json_module: Value,
172
- route: &spikard_http::Route,
173
- ) -> Result<Self, Error> {
174
- let upload_file_class = lookup_upload_file_class()?;
175
- Ok(Self {
176
- inner: Arc::new(RubyHandlerInner {
177
- handler_proc: Opaque::from(handler_value),
178
- handler_name,
179
- method,
180
- path,
181
- json_module: Opaque::from(json_module),
182
- request_validator: route.request_validator.clone(),
183
- response_validator: route.response_validator.clone(),
184
- parameter_validator: route.parameter_validator.clone(),
185
- upload_file_class,
186
- }),
187
- })
188
- }
189
-
190
- /// Required by Ruby GC; invoked through the magnus mark hook.
191
- #[allow(dead_code)]
192
- pub fn mark(&self, marker: &Marker) {
193
- if let Ok(ruby) = Ruby::get() {
194
- let proc_val = self.inner.handler_proc.get_inner_with(&ruby);
195
- marker.mark(proc_val);
196
- }
197
- }
198
-
199
- /// Handle a request synchronously.
200
- pub fn handle(&self, request_data: RequestData) -> HandlerResult {
201
- let cloned = request_data.clone();
202
- let result = std::panic::catch_unwind(AssertUnwindSafe(|| self.handle_inner(cloned)));
203
- match result {
204
- Ok(res) => res,
205
- Err(_) => Err(structured_error(
206
- StatusCode::INTERNAL_SERVER_ERROR,
207
- "panic",
208
- "Unexpected panic while executing Ruby handler",
209
- )),
210
- }
211
- }
212
-
213
- fn handle_inner(&self, request_data: RequestData) -> HandlerResult {
214
- if let Some(validator) = &self.inner.request_validator
215
- && let Err(errors) = validator.validate(&request_data.body)
216
- {
217
- let problem = ProblemDetails::from_validation_error(&errors);
218
- return Err(validation_error_response(&problem));
219
- }
220
-
221
- let validated_params = if let Some(validator) = &self.inner.parameter_validator {
222
- match validator.validate_and_extract(
223
- &request_data.query_params,
224
- request_data.raw_query_params.as_ref(),
225
- request_data.path_params.as_ref(),
226
- request_data.headers.as_ref(),
227
- request_data.cookies.as_ref(),
228
- ) {
229
- Ok(value) => Some(value),
230
- Err(errors) => {
231
- let problem = ProblemDetails::from_validation_error(&errors);
232
- return Err(validation_error_response(&problem));
233
- }
234
- }
235
- } else {
236
- None
237
- };
238
-
239
- let ruby = Ruby::get().map_err(|_| {
240
- structured_error(
241
- StatusCode::INTERNAL_SERVER_ERROR,
242
- "ruby_vm_unavailable",
243
- "Ruby VM unavailable while invoking handler",
244
- )
245
- })?;
246
-
247
- let request_value = build_ruby_request(&ruby, &self.inner, &request_data, validated_params.as_ref())
248
- .map_err(|err| (StatusCode::INTERNAL_SERVER_ERROR, err.to_string()))?;
249
-
250
- let handler_proc = self.inner.handler_proc.get_inner_with(&ruby);
251
- let handler_result = handler_proc.funcall("call", (request_value,));
252
- let response_value = match handler_result {
253
- Ok(value) => value,
254
- Err(err) => {
255
- return Err(structured_error(
256
- StatusCode::INTERNAL_SERVER_ERROR,
257
- "handler_failed",
258
- format!("Handler '{}' failed: {}", self.inner.handler_name, err),
259
- ));
260
- }
261
- };
262
-
263
- let handler_result = interpret_handler_response(&ruby, &self.inner, response_value).map_err(|err| {
264
- structured_error(
265
- StatusCode::INTERNAL_SERVER_ERROR,
266
- "response_interpret_error",
267
- format!(
268
- "Failed to interpret response from '{}': {}",
269
- self.inner.handler_name, err
270
- ),
271
- )
272
- })?;
273
-
274
- let payload = match handler_result {
275
- RubyHandlerResult::Streaming(streaming) => {
276
- let response = streaming.into_response().map_err(|err| {
277
- structured_error(
278
- StatusCode::INTERNAL_SERVER_ERROR,
279
- "streaming_response_error",
280
- format!("Failed to build streaming response: {}", err),
281
- )
282
- })?;
283
- return Ok(response.into_response());
284
- }
285
- RubyHandlerResult::Payload(payload) => payload,
286
- };
287
-
288
- if let Some(validator) = &self.inner.response_validator {
289
- let candidate_body = match payload.body.clone() {
290
- Some(body) => Some(body),
291
- None => match try_parse_raw_body(&payload.raw_body) {
292
- Ok(parsed) => parsed,
293
- Err(err) => {
294
- return Err(structured_error(
295
- StatusCode::INTERNAL_SERVER_ERROR,
296
- "response_body_decode_error",
297
- err,
298
- ));
299
- }
300
- },
301
- };
302
-
303
- match candidate_body {
304
- Some(json_body) => {
305
- if let Err(errors) = validator.validate(&json_body) {
306
- let problem = ProblemDetails::from_validation_error(&errors);
307
- return Err(validation_error_response(&problem));
308
- }
309
- }
310
- None => {
311
- return Err(structured_error(
312
- StatusCode::INTERNAL_SERVER_ERROR,
313
- "response_validation_failed",
314
- "Response validator requires JSON body but handler returned raw bytes",
315
- ));
316
- }
317
- }
318
- }
319
-
320
- let HandlerResponsePayload {
321
- status,
322
- headers,
323
- body,
324
- raw_body,
325
- } = payload;
326
-
327
- let mut response_builder = axum::http::Response::builder().status(status);
328
- let mut has_content_type = false;
329
-
330
- for (name, value) in headers.iter() {
331
- if name.eq_ignore_ascii_case("content-type") {
332
- has_content_type = true;
333
- }
334
- let header_name = HeaderName::from_bytes(name.as_bytes()).map_err(|err| {
335
- (
336
- StatusCode::INTERNAL_SERVER_ERROR,
337
- format!("Invalid header name '{name}': {err}"),
338
- )
339
- })?;
340
- let header_value = HeaderValue::from_str(value).map_err(|err| {
341
- (
342
- StatusCode::INTERNAL_SERVER_ERROR,
343
- format!("Invalid header value for '{name}': {err}"),
344
- )
345
- })?;
346
-
347
- response_builder = response_builder.header(header_name, header_value);
348
- }
349
-
350
- if !has_content_type && body.is_some() {
351
- response_builder = response_builder.header(
352
- HeaderName::from_static("content-type"),
353
- HeaderValue::from_static("application/json"),
354
- );
355
- }
356
-
357
- let body_bytes = if let Some(raw) = raw_body {
358
- raw
359
- } else if let Some(json_value) = body {
360
- serde_json::to_vec(&json_value).map_err(|err| {
361
- (
362
- StatusCode::INTERNAL_SERVER_ERROR,
363
- format!("Failed to serialise response body: {err}"),
364
- )
365
- })?
366
- } else {
367
- Vec::new()
368
- };
369
-
370
- response_builder.body(Body::from(body_bytes)).map_err(|err| {
371
- (
372
- StatusCode::INTERNAL_SERVER_ERROR,
373
- format!("Failed to build response: {err}"),
374
- )
375
- })
376
- }
377
- }
378
-
379
- impl Handler for RubyHandler {
380
- fn call(
381
- &self,
382
- _req: Request<Body>,
383
- request_data: RequestData,
384
- ) -> Pin<Box<dyn std::future::Future<Output = HandlerResult> + Send + '_>> {
385
- let handler = self.clone();
386
- Box::pin(async move { handler.handle(request_data) })
387
- }
388
- }
389
-
390
- fn structured_error(status: StatusCode, code: &str, message: impl Into<String>) -> (StatusCode, String) {
391
- let payload = StructuredError::simple(code.to_string(), message.into());
392
- let body = serde_json::to_string(&payload)
393
- .unwrap_or_else(|_| r#"{"error":"internal_error","code":"internal_error","details":{}}"#.to_string());
394
- (status, body)
395
- }
396
-
397
- fn validation_error_response(problem: &ProblemDetails) -> (StatusCode, String) {
398
- let payload = StructuredError::new(
399
- "validation_error".to_string(),
400
- problem.title.clone(),
401
- serde_json::to_value(problem).unwrap_or_else(|_| serde_json::json!({})),
402
- );
403
- let body = serde_json::to_string(&payload)
404
- .unwrap_or_else(|_| r#"{"error":"validation_error","code":"validation_error","details":{}}"#.to_string());
405
- (problem.status_code(), body)
406
- }
407
-
408
- fn try_parse_raw_body(raw_body: &Option<Vec<u8>>) -> Result<Option<JsonValue>, String> {
409
- let Some(bytes) = raw_body else {
410
- return Ok(None);
411
- };
412
- let text = String::from_utf8(bytes.clone()).map_err(|e| format!("Invalid UTF-8 in response body: {e}"))?;
413
- if text.is_empty() {
414
- return Ok(None);
415
- }
416
- serde_json::from_str(&text)
417
- .map(Some)
418
- .map_err(|e| format!("Failed to parse response body as JSON: {e}"))
419
- }
420
-
421
- fn lookup_upload_file_class() -> Result<Option<Opaque<Value>>, Error> {
422
- let ruby = match Ruby::get() {
423
- Ok(ruby) => ruby,
424
- Err(_) => return Ok(None),
425
- };
426
-
427
- let upload_file = ruby.eval::<Value>("Spikard::UploadFile").ok();
428
- Ok(upload_file.map(Opaque::from))
429
- }
430
-
431
- /// Build a Ruby Hash request object from request data.
432
- fn build_ruby_request(
433
- ruby: &Ruby,
434
- handler: &RubyHandlerInner,
435
- request_data: &RequestData,
436
- validated_params: Option<&JsonValue>,
437
- ) -> Result<Value, Error> {
438
- let hash = ruby.hash_new();
439
-
440
- hash.aset(ruby.intern("method"), ruby.str_new(&handler.method))?;
441
- hash.aset(ruby.intern("path"), ruby.str_new(&handler.path))?;
442
-
443
- let path_params = map_to_ruby_hash(ruby, request_data.path_params.as_ref())?;
444
- hash.aset(ruby.intern("path_params"), path_params)?;
445
-
446
- let query_value = json_to_ruby(ruby, &request_data.query_params)?;
447
- hash.aset(ruby.intern("query"), query_value)?;
448
-
449
- let raw_query = multimap_to_ruby_hash(ruby, request_data.raw_query_params.as_ref())?;
450
- hash.aset(ruby.intern("raw_query"), raw_query)?;
451
-
452
- let headers = map_to_ruby_hash(ruby, request_data.headers.as_ref())?;
453
- hash.aset(ruby.intern("headers"), headers)?;
454
-
455
- let cookies = map_to_ruby_hash(ruby, request_data.cookies.as_ref())?;
456
- hash.aset(ruby.intern("cookies"), cookies)?;
457
-
458
- let upload_class_value = handler.upload_file_class.as_ref().map(|cls| cls.get_inner_with(ruby));
459
- let body_value = json_to_ruby_with_uploads(ruby, &request_data.body, upload_class_value.as_ref())?;
460
- hash.aset(ruby.intern("body"), body_value)?;
461
- if let Some(raw) = &request_data.raw_body {
462
- let raw_str = ruby.str_from_slice(raw);
463
- hash.aset(ruby.intern("raw_body"), raw_str)?;
464
- } else {
465
- hash.aset(ruby.intern("raw_body"), ruby.qnil())?;
466
- }
467
-
468
- let params_value = if let Some(validated) = validated_params {
469
- json_to_ruby(ruby, validated)?
470
- } else {
471
- build_default_params(ruby, request_data)?
472
- };
473
- hash.aset(ruby.intern("params"), params_value)?;
474
-
475
- Ok(hash.as_value())
476
- }
477
-
478
- /// Build default params from request data path/query/headers/cookies.
479
- fn build_default_params(ruby: &Ruby, request_data: &RequestData) -> Result<Value, Error> {
480
- let mut map = JsonMap::new();
481
-
482
- for (key, value) in request_data.path_params.as_ref() {
483
- map.insert(key.clone(), JsonValue::String(value.clone()));
484
- }
485
-
486
- if let JsonValue::Object(obj) = &request_data.query_params {
487
- for (key, value) in obj {
488
- map.insert(key.clone(), value.clone());
489
- }
490
- }
491
-
492
- for (key, value) in request_data.headers.as_ref() {
493
- map.insert(key.clone(), JsonValue::String(value.clone()));
494
- }
495
-
496
- for (key, value) in request_data.cookies.as_ref() {
497
- map.insert(key.clone(), JsonValue::String(value.clone()));
498
- }
499
-
500
- json_to_ruby(ruby, &JsonValue::Object(map))
501
- }
502
-
503
- /// Interpret a Ruby handler response into our response types.
504
- fn interpret_handler_response(
505
- ruby: &Ruby,
506
- handler: &RubyHandlerInner,
507
- value: Value,
508
- ) -> Result<RubyHandlerResult, Error> {
509
- if value.is_nil() {
510
- return Ok(RubyHandlerResult::Payload(HandlerResponsePayload {
511
- status: 200,
512
- headers: HashMap::new(),
513
- body: None,
514
- raw_body: None,
515
- }));
516
- }
517
-
518
- if is_streaming_response(ruby, value)? {
519
- let stream_value: Value = value.funcall("stream", ())?;
520
- let status: i64 = value.funcall("status_code", ())?;
521
- let headers_value: Value = value.funcall("headers", ())?;
522
-
523
- let status_u16 = u16::try_from(status).map_err(|_| {
524
- Error::new(
525
- ruby.exception_arg_error(),
526
- "StreamingResponse status_code must be between 0 and 65535",
527
- )
528
- })?;
529
-
530
- let headers = value_to_string_map(ruby, headers_value)?;
531
-
532
- return Ok(RubyHandlerResult::Streaming(StreamingResponsePayload {
533
- enumerator: Arc::new(Opaque::from(stream_value)),
534
- status: status_u16,
535
- headers,
536
- }));
537
- }
538
-
539
- let status_symbol = ruby.intern("status_code");
540
- if value.respond_to(status_symbol, false)? {
541
- let status: i64 = value.funcall("status_code", ())?;
542
- let status_u16 = u16::try_from(status)
543
- .map_err(|_| Error::new(ruby.exception_arg_error(), "status_code must be between 0 and 65535"))?;
544
-
545
- let headers_value: Value = value.funcall("headers", ())?;
546
- let headers = if headers_value.is_nil() {
547
- HashMap::new()
548
- } else {
549
- let hash = RHash::try_convert(headers_value)?;
550
- hash.to_hash_map::<String, String>()?
551
- };
552
-
553
- let content_value: Value = value.funcall("content", ())?;
554
- let mut raw_body = None;
555
- let body = if content_value.is_nil() {
556
- None
557
- } else if let Ok(str_value) = RString::try_convert(content_value) {
558
- // SAFETY: Magnus RString::as_slice() yields a valid byte slice for the
559
- // lifetime of the RString value. We immediately call .to_vec() which copies
560
- // the bytes into owned memory, so the result does not retain any references
561
- // to the underlying RString. This is safe because the copy happens before
562
- // the RString reference is released.
563
- let slice = unsafe { str_value.as_slice() };
564
- raw_body = Some(slice.to_vec());
565
- None
566
- } else {
567
- Some(ruby_value_to_json(
568
- ruby,
569
- handler.json_module.get_inner_with(ruby),
570
- content_value,
571
- )?)
572
- };
573
-
574
- return Ok(RubyHandlerResult::Payload(HandlerResponsePayload {
575
- status: status_u16,
576
- headers,
577
- body,
578
- raw_body,
579
- }));
580
- }
581
-
582
- if let Ok(str_value) = RString::try_convert(value) {
583
- // SAFETY: Magnus RString::as_slice() returns a valid byte slice that remains
584
- // valid for the lifetime of the RString. We call .to_vec() to copy the bytes
585
- // into owned storage, ensuring the returned HandlerResponsePayload does not
586
- // hold any references back to the RString. This copy-then-own pattern is safe.
587
- let slice = unsafe { str_value.as_slice() };
588
- return Ok(RubyHandlerResult::Payload(HandlerResponsePayload {
589
- status: 200,
590
- headers: HashMap::new(),
591
- body: None,
592
- raw_body: Some(slice.to_vec()),
593
- }));
594
- }
595
-
596
- let body_json = ruby_value_to_json(ruby, handler.json_module.get_inner_with(ruby), value)?;
597
-
598
- Ok(RubyHandlerResult::Payload(HandlerResponsePayload {
599
- status: 200,
600
- headers: HashMap::new(),
601
- body: Some(body_json),
602
- raw_body: None,
603
- }))
604
- }
605
-
606
- /// Convert a Ruby value to a string HashMap.
607
- fn value_to_string_map(ruby: &Ruby, value: Value) -> Result<HashMap<String, String>, Error> {
608
- if value.is_nil() {
609
- return Ok(HashMap::new());
610
- }
611
- let hash = RHash::try_convert(value)?;
612
- hash.to_hash_map::<String, String>().map_err(|err| {
613
- Error::new(
614
- ruby.exception_arg_error(),
615
- format!("Expected headers hash of strings: {}", err),
616
- )
617
- })
618
- }
619
-
620
- /// Check if a Ruby value is a streaming response.
621
- fn is_streaming_response(ruby: &Ruby, value: Value) -> Result<bool, Error> {
622
- let stream_sym = ruby.intern("stream");
623
- let status_sym = ruby.intern("status_code");
624
- Ok(value.respond_to(stream_sym, false)? && value.respond_to(status_sym, false)?)
625
- }
1
+ //! Ruby handler wrapper implementing the Handler trait.
2
+ //!
3
+ //! This module provides the `RubyHandler` struct that wraps Ruby Proc objects
4
+ //! and implements Spikard's `Handler` trait for async request processing.
5
+
6
+ #![allow(dead_code)]
7
+
8
+ use axum::body::Body;
9
+ use axum::http::{HeaderName, HeaderValue, Request, StatusCode};
10
+ use magnus::prelude::*;
11
+ use magnus::value::{InnerValue, Opaque};
12
+ use magnus::{Error, RHash, RString, Ruby, TryConvert, Value, gc::Marker};
13
+ use serde_json::{Map as JsonMap, Value as JsonValue};
14
+ use spikard_core::errors::StructuredError;
15
+ use spikard_http::ParameterValidator;
16
+ use spikard_http::SchemaValidator;
17
+ use spikard_http::problem::ProblemDetails;
18
+ use spikard_http::{Handler, HandlerResponse, HandlerResult, RequestData};
19
+ use std::collections::HashMap;
20
+ use std::panic::AssertUnwindSafe;
21
+ use std::pin::Pin;
22
+ use std::sync::Arc;
23
+
24
+ use crate::conversion::{
25
+ json_to_ruby, json_to_ruby_with_uploads, map_to_ruby_hash, multimap_to_ruby_hash, ruby_value_to_json,
26
+ };
27
+
28
+ /// Response payload with status, headers, and body data.
29
+ pub struct HandlerResponsePayload {
30
+ pub status: u16,
31
+ pub headers: HashMap<String, String>,
32
+ pub body: Option<JsonValue>,
33
+ pub raw_body: Option<Vec<u8>>,
34
+ }
35
+
36
+ /// Streaming response variant containing an enumerator and metadata.
37
+ pub struct StreamingResponsePayload {
38
+ pub enumerator: Arc<Opaque<Value>>,
39
+ pub status: u16,
40
+ pub headers: HashMap<String, String>,
41
+ }
42
+
43
+ /// Handler result: either a payload or a streaming response.
44
+ pub enum RubyHandlerResult {
45
+ Payload(HandlerResponsePayload),
46
+ Streaming(StreamingResponsePayload),
47
+ }
48
+
49
+ impl StreamingResponsePayload {
50
+ /// Convert streaming response into a `HandlerResponse`.
51
+ pub fn into_response(self) -> Result<HandlerResponse, Error> {
52
+ let ruby = Ruby::get().map_err(|_| {
53
+ Error::new(
54
+ Ruby::get().unwrap().exception_runtime_error(),
55
+ "Ruby VM unavailable while building streaming response",
56
+ )
57
+ })?;
58
+
59
+ let status = StatusCode::from_u16(self.status).map_err(|err| {
60
+ Error::new(
61
+ ruby.exception_arg_error(),
62
+ format!("Invalid streaming status code {}: {}", self.status, err),
63
+ )
64
+ })?;
65
+
66
+ let header_pairs = self
67
+ .headers
68
+ .into_iter()
69
+ .map(|(name, value)| {
70
+ let header_name = HeaderName::from_bytes(name.as_bytes()).map_err(|err| {
71
+ Error::new(
72
+ ruby.exception_arg_error(),
73
+ format!("Invalid header name '{name}': {err}"),
74
+ )
75
+ })?;
76
+ let header_value = HeaderValue::from_str(&value).map_err(|err| {
77
+ Error::new(
78
+ ruby.exception_arg_error(),
79
+ format!("Invalid header value for '{name}': {err}"),
80
+ )
81
+ })?;
82
+ Ok((header_name, header_value))
83
+ })
84
+ .collect::<Result<Vec<_>, Error>>()?;
85
+
86
+ let enumerator = self.enumerator.clone();
87
+ let body_stream = async_stream::stream! {
88
+ loop {
89
+ match poll_stream_chunk(&enumerator) {
90
+ Ok(Some(bytes)) => yield Ok(bytes),
91
+ Ok(None) => break,
92
+ Err(err) => {
93
+ yield Err(Box::new(err));
94
+ break;
95
+ }
96
+ }
97
+ }
98
+ };
99
+
100
+ let mut response = HandlerResponse::stream(body_stream).with_status(status);
101
+ for (name, value) in header_pairs {
102
+ response = response.with_header(name, value);
103
+ }
104
+ Ok(response)
105
+ }
106
+ }
107
+
108
+ /// Poll a single chunk from a Ruby enumerator.
109
+ fn poll_stream_chunk(enumerator: &Arc<Opaque<Value>>) -> Result<Option<bytes::Bytes>, std::io::Error> {
110
+ let ruby = Ruby::get().map_err(|err| std::io::Error::other(err.to_string()))?;
111
+ let enum_value = enumerator.get_inner_with(&ruby);
112
+ match enum_value.funcall::<_, _, Value>("next", ()) {
113
+ Ok(chunk) => crate::conversion::ruby_value_to_bytes(chunk).map(Some),
114
+ Err(err) => {
115
+ if err.is_kind_of(ruby.exception_stop_iteration()) {
116
+ Ok(None)
117
+ } else {
118
+ Err(std::io::Error::other(err.to_string()))
119
+ }
120
+ }
121
+ }
122
+ }
123
+
124
+ /// Inner state of a Ruby handler.
125
+ pub struct RubyHandlerInner {
126
+ pub handler_proc: Opaque<Value>,
127
+ pub handler_name: String,
128
+ pub method: String,
129
+ pub path: String,
130
+ pub json_module: Opaque<Value>,
131
+ pub request_validator: Option<Arc<SchemaValidator>>,
132
+ pub response_validator: Option<Arc<SchemaValidator>>,
133
+ pub parameter_validator: Option<ParameterValidator>,
134
+ pub upload_file_class: Option<Opaque<Value>>,
135
+ }
136
+
137
+ /// Wrapper around a Ruby Proc that implements the Handler trait.
138
+ #[derive(Clone)]
139
+ pub struct RubyHandler {
140
+ pub inner: Arc<RubyHandlerInner>,
141
+ }
142
+
143
+ impl RubyHandler {
144
+ /// Create a new RubyHandler from a route and handler Proc.
145
+ pub fn new(route: &spikard_http::Route, handler_value: Value, json_module: Value) -> Result<Self, Error> {
146
+ let upload_file_class = lookup_upload_file_class()?;
147
+ Ok(Self {
148
+ inner: Arc::new(RubyHandlerInner {
149
+ handler_proc: Opaque::from(handler_value),
150
+ handler_name: route.handler_name.clone(),
151
+ method: route.method.as_str().to_string(),
152
+ path: route.path.clone(),
153
+ json_module: Opaque::from(json_module),
154
+ request_validator: route.request_validator.clone(),
155
+ response_validator: route.response_validator.clone(),
156
+ parameter_validator: route.parameter_validator.clone(),
157
+ upload_file_class,
158
+ }),
159
+ })
160
+ }
161
+
162
+ /// Create a new RubyHandler for server mode
163
+ ///
164
+ /// This is used by run_server to create handlers from Ruby Procs
165
+ pub fn new_for_server(
166
+ _ruby: &Ruby,
167
+ handler_value: Value,
168
+ handler_name: String,
169
+ method: String,
170
+ path: String,
171
+ json_module: Value,
172
+ route: &spikard_http::Route,
173
+ ) -> Result<Self, Error> {
174
+ let upload_file_class = lookup_upload_file_class()?;
175
+ Ok(Self {
176
+ inner: Arc::new(RubyHandlerInner {
177
+ handler_proc: Opaque::from(handler_value),
178
+ handler_name,
179
+ method,
180
+ path,
181
+ json_module: Opaque::from(json_module),
182
+ request_validator: route.request_validator.clone(),
183
+ response_validator: route.response_validator.clone(),
184
+ parameter_validator: route.parameter_validator.clone(),
185
+ upload_file_class,
186
+ }),
187
+ })
188
+ }
189
+
190
+ /// Required by Ruby GC; invoked through the magnus mark hook.
191
+ #[allow(dead_code)]
192
+ pub fn mark(&self, marker: &Marker) {
193
+ if let Ok(ruby) = Ruby::get() {
194
+ let proc_val = self.inner.handler_proc.get_inner_with(&ruby);
195
+ marker.mark(proc_val);
196
+ }
197
+ }
198
+
199
+ /// Handle a request synchronously.
200
+ pub fn handle(&self, request_data: RequestData) -> HandlerResult {
201
+ let cloned = request_data.clone();
202
+ let result = std::panic::catch_unwind(AssertUnwindSafe(|| self.handle_inner(cloned)));
203
+ match result {
204
+ Ok(res) => res,
205
+ Err(_) => Err(structured_error(
206
+ StatusCode::INTERNAL_SERVER_ERROR,
207
+ "panic",
208
+ "Unexpected panic while executing Ruby handler",
209
+ )),
210
+ }
211
+ }
212
+
213
+ fn handle_inner(&self, request_data: RequestData) -> HandlerResult {
214
+ if let Some(validator) = &self.inner.request_validator
215
+ && let Err(errors) = validator.validate(&request_data.body)
216
+ {
217
+ let problem = ProblemDetails::from_validation_error(&errors);
218
+ return Err(validation_error_response(&problem));
219
+ }
220
+
221
+ let validated_params = if let Some(validator) = &self.inner.parameter_validator {
222
+ match validator.validate_and_extract(
223
+ &request_data.query_params,
224
+ request_data.raw_query_params.as_ref(),
225
+ request_data.path_params.as_ref(),
226
+ request_data.headers.as_ref(),
227
+ request_data.cookies.as_ref(),
228
+ ) {
229
+ Ok(value) => Some(value),
230
+ Err(errors) => {
231
+ let problem = ProblemDetails::from_validation_error(&errors);
232
+ return Err(validation_error_response(&problem));
233
+ }
234
+ }
235
+ } else {
236
+ None
237
+ };
238
+
239
+ let ruby = Ruby::get().map_err(|_| {
240
+ structured_error(
241
+ StatusCode::INTERNAL_SERVER_ERROR,
242
+ "ruby_vm_unavailable",
243
+ "Ruby VM unavailable while invoking handler",
244
+ )
245
+ })?;
246
+
247
+ let request_value = build_ruby_request(&ruby, &self.inner, &request_data, validated_params.as_ref())
248
+ .map_err(|err| (StatusCode::INTERNAL_SERVER_ERROR, err.to_string()))?;
249
+
250
+ let handler_proc = self.inner.handler_proc.get_inner_with(&ruby);
251
+ let handler_result = handler_proc.funcall("call", (request_value,));
252
+ let response_value = match handler_result {
253
+ Ok(value) => value,
254
+ Err(err) => {
255
+ return Err(structured_error(
256
+ StatusCode::INTERNAL_SERVER_ERROR,
257
+ "handler_failed",
258
+ format!("Handler '{}' failed: {}", self.inner.handler_name, err),
259
+ ));
260
+ }
261
+ };
262
+
263
+ let handler_result = interpret_handler_response(&ruby, &self.inner, response_value).map_err(|err| {
264
+ structured_error(
265
+ StatusCode::INTERNAL_SERVER_ERROR,
266
+ "response_interpret_error",
267
+ format!(
268
+ "Failed to interpret response from '{}': {}",
269
+ self.inner.handler_name, err
270
+ ),
271
+ )
272
+ })?;
273
+
274
+ let payload = match handler_result {
275
+ RubyHandlerResult::Streaming(streaming) => {
276
+ let response = streaming.into_response().map_err(|err| {
277
+ structured_error(
278
+ StatusCode::INTERNAL_SERVER_ERROR,
279
+ "streaming_response_error",
280
+ format!("Failed to build streaming response: {}", err),
281
+ )
282
+ })?;
283
+ return Ok(response.into_response());
284
+ }
285
+ RubyHandlerResult::Payload(payload) => payload,
286
+ };
287
+
288
+ if let Some(validator) = &self.inner.response_validator {
289
+ let candidate_body = match payload.body.clone() {
290
+ Some(body) => Some(body),
291
+ None => match try_parse_raw_body(&payload.raw_body) {
292
+ Ok(parsed) => parsed,
293
+ Err(err) => {
294
+ return Err(structured_error(
295
+ StatusCode::INTERNAL_SERVER_ERROR,
296
+ "response_body_decode_error",
297
+ err,
298
+ ));
299
+ }
300
+ },
301
+ };
302
+
303
+ match candidate_body {
304
+ Some(json_body) => {
305
+ if let Err(errors) = validator.validate(&json_body) {
306
+ let problem = ProblemDetails::from_validation_error(&errors);
307
+ return Err(validation_error_response(&problem));
308
+ }
309
+ }
310
+ None => {
311
+ return Err(structured_error(
312
+ StatusCode::INTERNAL_SERVER_ERROR,
313
+ "response_validation_failed",
314
+ "Response validator requires JSON body but handler returned raw bytes",
315
+ ));
316
+ }
317
+ }
318
+ }
319
+
320
+ let HandlerResponsePayload {
321
+ status,
322
+ headers,
323
+ body,
324
+ raw_body,
325
+ } = payload;
326
+
327
+ let mut response_builder = axum::http::Response::builder().status(status);
328
+ let mut has_content_type = false;
329
+
330
+ for (name, value) in headers.iter() {
331
+ if name.eq_ignore_ascii_case("content-type") {
332
+ has_content_type = true;
333
+ }
334
+ let header_name = HeaderName::from_bytes(name.as_bytes()).map_err(|err| {
335
+ (
336
+ StatusCode::INTERNAL_SERVER_ERROR,
337
+ format!("Invalid header name '{name}': {err}"),
338
+ )
339
+ })?;
340
+ let header_value = HeaderValue::from_str(value).map_err(|err| {
341
+ (
342
+ StatusCode::INTERNAL_SERVER_ERROR,
343
+ format!("Invalid header value for '{name}': {err}"),
344
+ )
345
+ })?;
346
+
347
+ response_builder = response_builder.header(header_name, header_value);
348
+ }
349
+
350
+ if !has_content_type && body.is_some() {
351
+ response_builder = response_builder.header(
352
+ HeaderName::from_static("content-type"),
353
+ HeaderValue::from_static("application/json"),
354
+ );
355
+ }
356
+
357
+ let body_bytes = if let Some(raw) = raw_body {
358
+ raw
359
+ } else if let Some(json_value) = body {
360
+ serde_json::to_vec(&json_value).map_err(|err| {
361
+ (
362
+ StatusCode::INTERNAL_SERVER_ERROR,
363
+ format!("Failed to serialise response body: {err}"),
364
+ )
365
+ })?
366
+ } else {
367
+ Vec::new()
368
+ };
369
+
370
+ response_builder.body(Body::from(body_bytes)).map_err(|err| {
371
+ (
372
+ StatusCode::INTERNAL_SERVER_ERROR,
373
+ format!("Failed to build response: {err}"),
374
+ )
375
+ })
376
+ }
377
+ }
378
+
379
+ impl Handler for RubyHandler {
380
+ fn call(
381
+ &self,
382
+ _req: Request<Body>,
383
+ request_data: RequestData,
384
+ ) -> Pin<Box<dyn std::future::Future<Output = HandlerResult> + Send + '_>> {
385
+ let handler = self.clone();
386
+ Box::pin(async move { handler.handle(request_data) })
387
+ }
388
+ }
389
+
390
+ fn structured_error(status: StatusCode, code: &str, message: impl Into<String>) -> (StatusCode, String) {
391
+ let payload = StructuredError::simple(code.to_string(), message.into());
392
+ let body = serde_json::to_string(&payload)
393
+ .unwrap_or_else(|_| r#"{"error":"internal_error","code":"internal_error","details":{}}"#.to_string());
394
+ (status, body)
395
+ }
396
+
397
+ fn validation_error_response(problem: &ProblemDetails) -> (StatusCode, String) {
398
+ let payload = StructuredError::new(
399
+ "validation_error".to_string(),
400
+ problem.title.clone(),
401
+ serde_json::to_value(problem).unwrap_or_else(|_| serde_json::json!({})),
402
+ );
403
+ let body = serde_json::to_string(&payload)
404
+ .unwrap_or_else(|_| r#"{"error":"validation_error","code":"validation_error","details":{}}"#.to_string());
405
+ (problem.status_code(), body)
406
+ }
407
+
408
+ fn try_parse_raw_body(raw_body: &Option<Vec<u8>>) -> Result<Option<JsonValue>, String> {
409
+ let Some(bytes) = raw_body else {
410
+ return Ok(None);
411
+ };
412
+ let text = String::from_utf8(bytes.clone()).map_err(|e| format!("Invalid UTF-8 in response body: {e}"))?;
413
+ if text.is_empty() {
414
+ return Ok(None);
415
+ }
416
+ serde_json::from_str(&text)
417
+ .map(Some)
418
+ .map_err(|e| format!("Failed to parse response body as JSON: {e}"))
419
+ }
420
+
421
+ fn lookup_upload_file_class() -> Result<Option<Opaque<Value>>, Error> {
422
+ let ruby = match Ruby::get() {
423
+ Ok(ruby) => ruby,
424
+ Err(_) => return Ok(None),
425
+ };
426
+
427
+ let upload_file = ruby.eval::<Value>("Spikard::UploadFile").ok();
428
+ Ok(upload_file.map(Opaque::from))
429
+ }
430
+
431
+ /// Build a Ruby Hash request object from request data.
432
+ fn build_ruby_request(
433
+ ruby: &Ruby,
434
+ handler: &RubyHandlerInner,
435
+ request_data: &RequestData,
436
+ validated_params: Option<&JsonValue>,
437
+ ) -> Result<Value, Error> {
438
+ let hash = ruby.hash_new();
439
+
440
+ hash.aset(ruby.intern("method"), ruby.str_new(&handler.method))?;
441
+ hash.aset(ruby.intern("path"), ruby.str_new(&handler.path))?;
442
+
443
+ let path_params = map_to_ruby_hash(ruby, request_data.path_params.as_ref())?;
444
+ hash.aset(ruby.intern("path_params"), path_params)?;
445
+
446
+ let query_value = json_to_ruby(ruby, &request_data.query_params)?;
447
+ hash.aset(ruby.intern("query"), query_value)?;
448
+
449
+ let raw_query = multimap_to_ruby_hash(ruby, request_data.raw_query_params.as_ref())?;
450
+ hash.aset(ruby.intern("raw_query"), raw_query)?;
451
+
452
+ let headers = map_to_ruby_hash(ruby, request_data.headers.as_ref())?;
453
+ hash.aset(ruby.intern("headers"), headers)?;
454
+
455
+ let cookies = map_to_ruby_hash(ruby, request_data.cookies.as_ref())?;
456
+ hash.aset(ruby.intern("cookies"), cookies)?;
457
+
458
+ let upload_class_value = handler.upload_file_class.as_ref().map(|cls| cls.get_inner_with(ruby));
459
+ let body_value = json_to_ruby_with_uploads(ruby, &request_data.body, upload_class_value.as_ref())?;
460
+ hash.aset(ruby.intern("body"), body_value)?;
461
+ if let Some(raw) = &request_data.raw_body {
462
+ let raw_str = ruby.str_from_slice(raw);
463
+ hash.aset(ruby.intern("raw_body"), raw_str)?;
464
+ } else {
465
+ hash.aset(ruby.intern("raw_body"), ruby.qnil())?;
466
+ }
467
+
468
+ let params_value = if let Some(validated) = validated_params {
469
+ json_to_ruby(ruby, validated)?
470
+ } else {
471
+ build_default_params(ruby, request_data)?
472
+ };
473
+ hash.aset(ruby.intern("params"), params_value)?;
474
+
475
+ Ok(hash.as_value())
476
+ }
477
+
478
+ /// Build default params from request data path/query/headers/cookies.
479
+ fn build_default_params(ruby: &Ruby, request_data: &RequestData) -> Result<Value, Error> {
480
+ let mut map = JsonMap::new();
481
+
482
+ for (key, value) in request_data.path_params.as_ref() {
483
+ map.insert(key.clone(), JsonValue::String(value.clone()));
484
+ }
485
+
486
+ if let JsonValue::Object(obj) = &request_data.query_params {
487
+ for (key, value) in obj {
488
+ map.insert(key.clone(), value.clone());
489
+ }
490
+ }
491
+
492
+ for (key, value) in request_data.headers.as_ref() {
493
+ map.insert(key.clone(), JsonValue::String(value.clone()));
494
+ }
495
+
496
+ for (key, value) in request_data.cookies.as_ref() {
497
+ map.insert(key.clone(), JsonValue::String(value.clone()));
498
+ }
499
+
500
+ json_to_ruby(ruby, &JsonValue::Object(map))
501
+ }
502
+
503
+ /// Interpret a Ruby handler response into our response types.
504
+ fn interpret_handler_response(
505
+ ruby: &Ruby,
506
+ handler: &RubyHandlerInner,
507
+ value: Value,
508
+ ) -> Result<RubyHandlerResult, Error> {
509
+ if value.is_nil() {
510
+ return Ok(RubyHandlerResult::Payload(HandlerResponsePayload {
511
+ status: 200,
512
+ headers: HashMap::new(),
513
+ body: None,
514
+ raw_body: None,
515
+ }));
516
+ }
517
+
518
+ if is_streaming_response(ruby, value)? {
519
+ let stream_value: Value = value.funcall("stream", ())?;
520
+ let status: i64 = value.funcall("status_code", ())?;
521
+ let headers_value: Value = value.funcall("headers", ())?;
522
+
523
+ let status_u16 = u16::try_from(status).map_err(|_| {
524
+ Error::new(
525
+ ruby.exception_arg_error(),
526
+ "StreamingResponse status_code must be between 0 and 65535",
527
+ )
528
+ })?;
529
+
530
+ let headers = value_to_string_map(ruby, headers_value)?;
531
+
532
+ return Ok(RubyHandlerResult::Streaming(StreamingResponsePayload {
533
+ enumerator: Arc::new(Opaque::from(stream_value)),
534
+ status: status_u16,
535
+ headers,
536
+ }));
537
+ }
538
+
539
+ let status_symbol = ruby.intern("status_code");
540
+ if value.respond_to(status_symbol, false)? {
541
+ let status: i64 = value.funcall("status_code", ())?;
542
+ let status_u16 = u16::try_from(status)
543
+ .map_err(|_| Error::new(ruby.exception_arg_error(), "status_code must be between 0 and 65535"))?;
544
+
545
+ let headers_value: Value = value.funcall("headers", ())?;
546
+ let headers = if headers_value.is_nil() {
547
+ HashMap::new()
548
+ } else {
549
+ let hash = RHash::try_convert(headers_value)?;
550
+ hash.to_hash_map::<String, String>()?
551
+ };
552
+
553
+ let content_value: Value = value.funcall("content", ())?;
554
+ let mut raw_body = None;
555
+ let body = if content_value.is_nil() {
556
+ None
557
+ } else if let Ok(str_value) = RString::try_convert(content_value) {
558
+ // SAFETY: Magnus RString::as_slice() yields a valid byte slice for the
559
+ // lifetime of the RString value. We immediately call .to_vec() which copies
560
+ // the bytes into owned memory, so the result does not retain any references
561
+ // to the underlying RString. This is safe because the copy happens before
562
+ // the RString reference is released.
563
+ let slice = unsafe { str_value.as_slice() };
564
+ raw_body = Some(slice.to_vec());
565
+ None
566
+ } else {
567
+ Some(ruby_value_to_json(
568
+ ruby,
569
+ handler.json_module.get_inner_with(ruby),
570
+ content_value,
571
+ )?)
572
+ };
573
+
574
+ return Ok(RubyHandlerResult::Payload(HandlerResponsePayload {
575
+ status: status_u16,
576
+ headers,
577
+ body,
578
+ raw_body,
579
+ }));
580
+ }
581
+
582
+ if let Ok(str_value) = RString::try_convert(value) {
583
+ // SAFETY: Magnus RString::as_slice() returns a valid byte slice that remains
584
+ // valid for the lifetime of the RString. We call .to_vec() to copy the bytes
585
+ // into owned storage, ensuring the returned HandlerResponsePayload does not
586
+ // hold any references back to the RString. This copy-then-own pattern is safe.
587
+ let slice = unsafe { str_value.as_slice() };
588
+ return Ok(RubyHandlerResult::Payload(HandlerResponsePayload {
589
+ status: 200,
590
+ headers: HashMap::new(),
591
+ body: None,
592
+ raw_body: Some(slice.to_vec()),
593
+ }));
594
+ }
595
+
596
+ let body_json = ruby_value_to_json(ruby, handler.json_module.get_inner_with(ruby), value)?;
597
+
598
+ Ok(RubyHandlerResult::Payload(HandlerResponsePayload {
599
+ status: 200,
600
+ headers: HashMap::new(),
601
+ body: Some(body_json),
602
+ raw_body: None,
603
+ }))
604
+ }
605
+
606
+ /// Convert a Ruby value to a string HashMap.
607
+ fn value_to_string_map(ruby: &Ruby, value: Value) -> Result<HashMap<String, String>, Error> {
608
+ if value.is_nil() {
609
+ return Ok(HashMap::new());
610
+ }
611
+ let hash = RHash::try_convert(value)?;
612
+ hash.to_hash_map::<String, String>().map_err(|err| {
613
+ Error::new(
614
+ ruby.exception_arg_error(),
615
+ format!("Expected headers hash of strings: {}", err),
616
+ )
617
+ })
618
+ }
619
+
620
+ /// Check if a Ruby value is a streaming response.
621
+ fn is_streaming_response(ruby: &Ruby, value: Value) -> Result<bool, Error> {
622
+ let stream_sym = ruby.intern("stream");
623
+ let status_sym = ruby.intern("status_code");
624
+ Ok(value.respond_to(stream_sym, false)? && value.respond_to(status_sym, false)?)
625
+ }