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,5 +1,5 @@
1
- //! HTTP server runtime initialization and management.
2
-
3
- pub mod server_runner;
4
-
5
- pub use server_runner::{normalize_route_metadata, run_server};
1
+ //! HTTP server runtime initialization and management.
2
+
3
+ pub mod server_runner;
4
+
5
+ pub use server_runner::{normalize_route_metadata, run_server};
@@ -1,324 +1,324 @@
1
- //! HTTP server initialization and lifecycle management.
2
- //!
3
- //! This module handles starting the Spikard HTTP server with handlers,
4
- //! middleware configuration, and lifecycle hooks.
5
-
6
- use crate::RubyHandler;
7
- use crate::config::server_config::extract_server_config;
8
- use crate::di::build_dependency_container;
9
- use axum::routing::get;
10
- use magnus::prelude::*;
11
- use magnus::{Error, RHash, Ruby, TryConvert, Value, r_hash::ForEach};
12
- use spikard_http::{Handler, Route, RouteMetadata, SchemaRegistry, Server};
13
- use std::sync::Arc;
14
- use tracing::{info, warn};
15
-
16
- /// Start the Spikard HTTP server from Ruby
17
- ///
18
- /// Creates an Axum HTTP server in a dedicated background thread with its own Tokio runtime.
19
- ///
20
- /// # Arguments
21
- ///
22
- /// * `routes_json` - JSON string containing route metadata
23
- /// * `handlers` - Ruby Hash mapping handler_name => Proc
24
- /// * `config` - Ruby ServerConfig object with all middleware settings
25
- /// * `hooks_value` - Lifecycle hooks
26
- /// * `ws_handlers` - WebSocket handlers
27
- /// * `sse_producers` - SSE producers
28
- /// * `dependencies` - Dependency injection container
29
- ///
30
- /// # Example (Ruby)
31
- ///
32
- /// ```ruby
33
- /// config = Spikard::ServerConfig.new(host: '0.0.0.0', port: 8000)
34
- /// Spikard::Native.run_server(routes_json, handlers, config, hooks, ws, sse, deps)
35
- /// ```
36
- #[allow(clippy::too_many_arguments)]
37
- pub fn run_server(
38
- ruby: &Ruby,
39
- routes_json: String,
40
- handlers: Value,
41
- config_value: Value,
42
- hooks_value: Value,
43
- ws_handlers: Value,
44
- sse_producers: Value,
45
- dependencies: Value,
46
- ) -> Result<(), Error> {
47
- let mut config = extract_server_config(ruby, config_value)?;
48
-
49
- let host = config.host.clone();
50
- let port = config.port;
51
-
52
- let metadata: Vec<RouteMetadata> = serde_json::from_str(&routes_json)
53
- .map_err(|err| Error::new(ruby.exception_arg_error(), format!("Invalid routes JSON: {}", err)))?;
54
-
55
- let handlers_hash = RHash::from_value(handlers).ok_or_else(|| {
56
- Error::new(
57
- ruby.exception_arg_error(),
58
- "handlers parameter must be a Hash of handler_name => Proc",
59
- )
60
- })?;
61
-
62
- let json_module = ruby
63
- .class_object()
64
- .funcall::<_, _, Value>("const_get", ("JSON",))
65
- .map_err(|err| Error::new(ruby.exception_name_error(), format!("JSON module not found: {}", err)))?;
66
-
67
- let schema_registry = SchemaRegistry::new();
68
-
69
- let mut routes_with_handlers: Vec<(Route, Arc<dyn Handler>)> = Vec::new();
70
-
71
- for route_meta in metadata {
72
- let route = Route::from_metadata(route_meta.clone(), &schema_registry)
73
- .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("Failed to create route: {}", e)))?;
74
-
75
- let handler_key = ruby.str_new(&route_meta.handler_name);
76
- let handler_value: Value = match handlers_hash.lookup(handler_key) {
77
- Ok(val) => val,
78
- Err(_) => {
79
- return Err(Error::new(
80
- ruby.exception_arg_error(),
81
- format!("Handler '{}' not found in handlers hash", route_meta.handler_name),
82
- ));
83
- }
84
- };
85
-
86
- let ruby_handler = RubyHandler::new_for_server(
87
- ruby,
88
- handler_value,
89
- route_meta.handler_name.clone(),
90
- json_module,
91
- &route,
92
- )?;
93
-
94
- routes_with_handlers.push((route, Arc::new(ruby_handler) as Arc<dyn Handler>));
95
- }
96
-
97
- let lifecycle_hooks = if let Ok(registry) = <&crate::NativeLifecycleRegistry>::try_convert(hooks_value) {
98
- Some(registry.take_hooks())
99
- } else if !hooks_value.is_nil() {
100
- let hooks_hash = RHash::from_value(hooks_value)
101
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "lifecycle_hooks parameter must be a Hash"))?;
102
-
103
- let mut hooks = spikard_http::LifecycleHooks::new();
104
- type RubyHookVec = Vec<
105
- Arc<
106
- dyn spikard_http::lifecycle::LifecycleHook<
107
- axum::http::Request<axum::body::Body>,
108
- axum::http::Response<axum::body::Body>,
109
- >,
110
- >,
111
- >;
112
-
113
- let extract_hooks = |key: &str| -> Result<RubyHookVec, Error> {
114
- let key_sym = ruby.to_symbol(key);
115
- if let Some(hooks_array) = hooks_hash.get(key_sym)
116
- && !hooks_array.is_nil()
117
- {
118
- let array = magnus::RArray::from_value(hooks_array)
119
- .ok_or_else(|| Error::new(ruby.exception_type_error(), format!("{} must be an Array", key)))?;
120
-
121
- let mut result = Vec::new();
122
- let len = array.len();
123
- for i in 0..len {
124
- let hook_value: Value = array.entry(i as isize)?;
125
- let name = format!("{}_{}", key, i);
126
- let ruby_hook = crate::lifecycle::RubyLifecycleHook::new(name, hook_value);
127
- result.push(Arc::new(ruby_hook)
128
- as Arc<
129
- dyn spikard_http::lifecycle::LifecycleHook<
130
- axum::http::Request<axum::body::Body>,
131
- axum::http::Response<axum::body::Body>,
132
- >,
133
- >);
134
- }
135
- return Ok(result);
136
- }
137
- Ok(Vec::new())
138
- };
139
-
140
- for hook in extract_hooks("on_request")? {
141
- hooks.add_on_request(hook);
142
- }
143
-
144
- for hook in extract_hooks("pre_validation")? {
145
- hooks.add_pre_validation(hook);
146
- }
147
-
148
- for hook in extract_hooks("pre_handler")? {
149
- hooks.add_pre_handler(hook);
150
- }
151
-
152
- for hook in extract_hooks("on_response")? {
153
- hooks.add_on_response(hook);
154
- }
155
-
156
- for hook in extract_hooks("on_error")? {
157
- hooks.add_on_error(hook);
158
- }
159
-
160
- Some(hooks)
161
- } else {
162
- None
163
- };
164
-
165
- config.lifecycle_hooks = lifecycle_hooks.map(Arc::new);
166
-
167
- #[cfg(feature = "di")]
168
- {
169
- if let Ok(registry) = <&crate::NativeDependencyRegistry>::try_convert(dependencies) {
170
- config.di_container = Some(Arc::new(registry.take_container()?));
171
- } else if !dependencies.is_nil() {
172
- match build_dependency_container(ruby, dependencies) {
173
- Ok(container) => {
174
- config.di_container = Some(Arc::new(container));
175
- }
176
- Err(err) => {
177
- return Err(Error::new(
178
- ruby.exception_runtime_error(),
179
- format!("Failed to build DI container: {}", err),
180
- ));
181
- }
182
- }
183
- }
184
- }
185
-
186
- Server::init_logging();
187
-
188
- info!("Starting Spikard server on {}:{}", host, port);
189
- info!("Registered {} routes", routes_with_handlers.len());
190
-
191
- let mut app_router = Server::with_handlers(config.clone(), routes_with_handlers)
192
- .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("Failed to build router: {}", e)))?;
193
-
194
- let mut ws_endpoints = Vec::new();
195
- if !ws_handlers.is_nil() {
196
- let ws_hash = RHash::from_value(ws_handlers)
197
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "WebSocket handlers must be a Hash"))?;
198
-
199
- ws_hash.foreach(|path: String, factory: Value| -> Result<ForEach, Error> {
200
- let handler_instance = factory.funcall::<_, _, Value>("call", ()).map_err(|e| {
201
- Error::new(
202
- ruby.exception_runtime_error(),
203
- format!("Failed to create WebSocket handler: {}", e),
204
- )
205
- })?;
206
-
207
- let ws_state = crate::websocket::create_websocket_state(ruby, handler_instance)?;
208
-
209
- ws_endpoints.push((path, ws_state));
210
-
211
- Ok(ForEach::Continue)
212
- })?;
213
- }
214
-
215
- let mut sse_endpoints = Vec::new();
216
- if !sse_producers.is_nil() {
217
- let sse_hash = RHash::from_value(sse_producers)
218
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "SSE producers must be a Hash"))?;
219
-
220
- sse_hash.foreach(|path: String, factory: Value| -> Result<ForEach, Error> {
221
- let producer_instance = factory.funcall::<_, _, Value>("call", ()).map_err(|e| {
222
- Error::new(
223
- ruby.exception_runtime_error(),
224
- format!("Failed to create SSE producer: {}", e),
225
- )
226
- })?;
227
-
228
- let sse_state = crate::sse::create_sse_state(ruby, producer_instance)?;
229
-
230
- sse_endpoints.push((path, sse_state));
231
-
232
- Ok(ForEach::Continue)
233
- })?;
234
- }
235
-
236
- for (path, ws_state) in ws_endpoints {
237
- info!("Registered WebSocket endpoint: {}", path);
238
- app_router = app_router.route(
239
- &path,
240
- get(spikard_http::websocket_handler::<crate::websocket::RubyWebSocketHandler>).with_state(ws_state),
241
- );
242
- }
243
-
244
- for (path, sse_state) in sse_endpoints {
245
- info!("Registered SSE endpoint: {}", path);
246
- app_router = app_router.route(
247
- &path,
248
- get(spikard_http::sse_handler::<crate::sse::RubySseEventProducer>).with_state(sse_state),
249
- );
250
- }
251
-
252
- let addr = format!("{}:{}", config.host, config.port);
253
- let socket_addr: std::net::SocketAddr = addr.parse().map_err(|e| {
254
- Error::new(
255
- ruby.exception_arg_error(),
256
- format!("Invalid socket address {}: {}", addr, e),
257
- )
258
- })?;
259
-
260
- let runtime = tokio::runtime::Builder::new_current_thread()
261
- .enable_all()
262
- .build()
263
- .map_err(|e| {
264
- Error::new(
265
- ruby.exception_runtime_error(),
266
- format!("Failed to create Tokio runtime: {}", e),
267
- )
268
- })?;
269
-
270
- let background_config = config.background_tasks.clone();
271
-
272
- runtime
273
- .block_on(async move {
274
- let listener = tokio::net::TcpListener::bind(socket_addr)
275
- .await
276
- .map_err(|err| format!("Failed to bind to {socket_addr}: {err}"))?;
277
-
278
- info!("Server listening on {}", socket_addr);
279
-
280
- let background_runtime = spikard_http::BackgroundRuntime::start(background_config.clone()).await;
281
- crate::background::install_handle(background_runtime.handle());
282
-
283
- let serve_result = axum::serve(listener, app_router).await;
284
-
285
- crate::background::clear_handle();
286
-
287
- if let Err(err) = background_runtime.shutdown().await {
288
- warn!("Failed to drain background tasks during shutdown: {:?}", err);
289
- }
290
-
291
- serve_result.map_err(|e| format!("Server error: {e}"))?;
292
- Ok::<(), String>(())
293
- })
294
- .map_err(|msg| Error::new(ruby.exception_runtime_error(), msg))?;
295
-
296
- Ok(())
297
- }
298
-
299
- /// Validate and normalize route metadata using the Rust RouteMetadata schema.
300
- ///
301
- /// Parses the provided JSON, compiles schemas/parameter validators to ensure
302
- /// correctness, and returns a canonical JSON string. This keeps Ruby-sourced
303
- /// metadata aligned with the Rust core types.
304
- pub fn normalize_route_metadata(_ruby: &Ruby, routes_json: String) -> Result<String, Error> {
305
- let registry = SchemaRegistry::new();
306
- let routes: Vec<RouteMetadata> = serde_json::from_str(&routes_json)
307
- .map_err(|err| Error::new(magnus::exception::arg_error(), format!("Invalid routes JSON: {err}")))?;
308
-
309
- for route in &routes {
310
- Route::from_metadata(route.clone(), &registry).map_err(|err| {
311
- Error::new(
312
- magnus::exception::runtime_error(),
313
- format!("Invalid route {} {}: {err}", route.method, route.path),
314
- )
315
- })?;
316
- }
317
-
318
- serde_json::to_string(&routes).map_err(|err| {
319
- Error::new(
320
- magnus::exception::runtime_error(),
321
- format!("Failed to serialise routes: {err}"),
322
- )
323
- })
324
- }
1
+ //! HTTP server initialization and lifecycle management.
2
+ //!
3
+ //! This module handles starting the Spikard HTTP server with handlers,
4
+ //! middleware configuration, and lifecycle hooks.
5
+
6
+ use crate::RubyHandler;
7
+ use crate::config::server_config::extract_server_config;
8
+ use crate::di::build_dependency_container;
9
+ use axum::routing::get;
10
+ use magnus::prelude::*;
11
+ use magnus::{Error, RHash, Ruby, TryConvert, Value, r_hash::ForEach};
12
+ use spikard_http::{Handler, Route, RouteMetadata, SchemaRegistry, Server};
13
+ use std::sync::Arc;
14
+ use tracing::{info, warn};
15
+
16
+ /// Start the Spikard HTTP server from Ruby
17
+ ///
18
+ /// Creates an Axum HTTP server in a dedicated background thread with its own Tokio runtime.
19
+ ///
20
+ /// # Arguments
21
+ ///
22
+ /// * `routes_json` - JSON string containing route metadata
23
+ /// * `handlers` - Ruby Hash mapping handler_name => Proc
24
+ /// * `config` - Ruby ServerConfig object with all middleware settings
25
+ /// * `hooks_value` - Lifecycle hooks
26
+ /// * `ws_handlers` - WebSocket handlers
27
+ /// * `sse_producers` - SSE producers
28
+ /// * `dependencies` - Dependency injection container
29
+ ///
30
+ /// # Example (Ruby)
31
+ ///
32
+ /// ```ruby
33
+ /// config = Spikard::ServerConfig.new(host: '0.0.0.0', port: 8000)
34
+ /// Spikard::Native.run_server(routes_json, handlers, config, hooks, ws, sse, deps)
35
+ /// ```
36
+ #[allow(clippy::too_many_arguments)]
37
+ pub fn run_server(
38
+ ruby: &Ruby,
39
+ routes_json: String,
40
+ handlers: Value,
41
+ config_value: Value,
42
+ hooks_value: Value,
43
+ ws_handlers: Value,
44
+ sse_producers: Value,
45
+ dependencies: Value,
46
+ ) -> Result<(), Error> {
47
+ let mut config = extract_server_config(ruby, config_value)?;
48
+
49
+ let host = config.host.clone();
50
+ let port = config.port;
51
+
52
+ let metadata: Vec<RouteMetadata> = serde_json::from_str(&routes_json)
53
+ .map_err(|err| Error::new(ruby.exception_arg_error(), format!("Invalid routes JSON: {}", err)))?;
54
+
55
+ let handlers_hash = RHash::from_value(handlers).ok_or_else(|| {
56
+ Error::new(
57
+ ruby.exception_arg_error(),
58
+ "handlers parameter must be a Hash of handler_name => Proc",
59
+ )
60
+ })?;
61
+
62
+ let json_module = ruby
63
+ .class_object()
64
+ .funcall::<_, _, Value>("const_get", ("JSON",))
65
+ .map_err(|err| Error::new(ruby.exception_name_error(), format!("JSON module not found: {}", err)))?;
66
+
67
+ let schema_registry = SchemaRegistry::new();
68
+
69
+ let mut routes_with_handlers: Vec<(Route, Arc<dyn Handler>)> = Vec::new();
70
+
71
+ for route_meta in metadata {
72
+ let route = Route::from_metadata(route_meta.clone(), &schema_registry)
73
+ .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("Failed to create route: {}", e)))?;
74
+
75
+ let handler_key = ruby.str_new(&route_meta.handler_name);
76
+ let handler_value: Value = match handlers_hash.lookup(handler_key) {
77
+ Ok(val) => val,
78
+ Err(_) => {
79
+ return Err(Error::new(
80
+ ruby.exception_arg_error(),
81
+ format!("Handler '{}' not found in handlers hash", route_meta.handler_name),
82
+ ));
83
+ }
84
+ };
85
+
86
+ let ruby_handler = RubyHandler::new_for_server(
87
+ ruby,
88
+ handler_value,
89
+ route_meta.handler_name.clone(),
90
+ json_module,
91
+ &route,
92
+ )?;
93
+
94
+ routes_with_handlers.push((route, Arc::new(ruby_handler) as Arc<dyn Handler>));
95
+ }
96
+
97
+ let lifecycle_hooks = if let Ok(registry) = <&crate::NativeLifecycleRegistry>::try_convert(hooks_value) {
98
+ Some(registry.take_hooks())
99
+ } else if !hooks_value.is_nil() {
100
+ let hooks_hash = RHash::from_value(hooks_value)
101
+ .ok_or_else(|| Error::new(ruby.exception_arg_error(), "lifecycle_hooks parameter must be a Hash"))?;
102
+
103
+ let mut hooks = spikard_http::LifecycleHooks::new();
104
+ type RubyHookVec = Vec<
105
+ Arc<
106
+ dyn spikard_http::lifecycle::LifecycleHook<
107
+ axum::http::Request<axum::body::Body>,
108
+ axum::http::Response<axum::body::Body>,
109
+ >,
110
+ >,
111
+ >;
112
+
113
+ let extract_hooks = |key: &str| -> Result<RubyHookVec, Error> {
114
+ let key_sym = ruby.to_symbol(key);
115
+ if let Some(hooks_array) = hooks_hash.get(key_sym)
116
+ && !hooks_array.is_nil()
117
+ {
118
+ let array = magnus::RArray::from_value(hooks_array)
119
+ .ok_or_else(|| Error::new(ruby.exception_type_error(), format!("{} must be an Array", key)))?;
120
+
121
+ let mut result = Vec::new();
122
+ let len = array.len();
123
+ for i in 0..len {
124
+ let hook_value: Value = array.entry(i as isize)?;
125
+ let name = format!("{}_{}", key, i);
126
+ let ruby_hook = crate::lifecycle::RubyLifecycleHook::new(name, hook_value);
127
+ result.push(Arc::new(ruby_hook)
128
+ as Arc<
129
+ dyn spikard_http::lifecycle::LifecycleHook<
130
+ axum::http::Request<axum::body::Body>,
131
+ axum::http::Response<axum::body::Body>,
132
+ >,
133
+ >);
134
+ }
135
+ return Ok(result);
136
+ }
137
+ Ok(Vec::new())
138
+ };
139
+
140
+ for hook in extract_hooks("on_request")? {
141
+ hooks.add_on_request(hook);
142
+ }
143
+
144
+ for hook in extract_hooks("pre_validation")? {
145
+ hooks.add_pre_validation(hook);
146
+ }
147
+
148
+ for hook in extract_hooks("pre_handler")? {
149
+ hooks.add_pre_handler(hook);
150
+ }
151
+
152
+ for hook in extract_hooks("on_response")? {
153
+ hooks.add_on_response(hook);
154
+ }
155
+
156
+ for hook in extract_hooks("on_error")? {
157
+ hooks.add_on_error(hook);
158
+ }
159
+
160
+ Some(hooks)
161
+ } else {
162
+ None
163
+ };
164
+
165
+ config.lifecycle_hooks = lifecycle_hooks.map(Arc::new);
166
+
167
+ #[cfg(feature = "di")]
168
+ {
169
+ if let Ok(registry) = <&crate::NativeDependencyRegistry>::try_convert(dependencies) {
170
+ config.di_container = Some(Arc::new(registry.take_container()?));
171
+ } else if !dependencies.is_nil() {
172
+ match build_dependency_container(ruby, dependencies) {
173
+ Ok(container) => {
174
+ config.di_container = Some(Arc::new(container));
175
+ }
176
+ Err(err) => {
177
+ return Err(Error::new(
178
+ ruby.exception_runtime_error(),
179
+ format!("Failed to build DI container: {}", err),
180
+ ));
181
+ }
182
+ }
183
+ }
184
+ }
185
+
186
+ Server::init_logging();
187
+
188
+ info!("Starting Spikard server on {}:{}", host, port);
189
+ info!("Registered {} routes", routes_with_handlers.len());
190
+
191
+ let mut app_router = Server::with_handlers(config.clone(), routes_with_handlers)
192
+ .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("Failed to build router: {}", e)))?;
193
+
194
+ let mut ws_endpoints = Vec::new();
195
+ if !ws_handlers.is_nil() {
196
+ let ws_hash = RHash::from_value(ws_handlers)
197
+ .ok_or_else(|| Error::new(ruby.exception_arg_error(), "WebSocket handlers must be a Hash"))?;
198
+
199
+ ws_hash.foreach(|path: String, factory: Value| -> Result<ForEach, Error> {
200
+ let handler_instance = factory.funcall::<_, _, Value>("call", ()).map_err(|e| {
201
+ Error::new(
202
+ ruby.exception_runtime_error(),
203
+ format!("Failed to create WebSocket handler: {}", e),
204
+ )
205
+ })?;
206
+
207
+ let ws_state = crate::websocket::create_websocket_state(ruby, handler_instance)?;
208
+
209
+ ws_endpoints.push((path, ws_state));
210
+
211
+ Ok(ForEach::Continue)
212
+ })?;
213
+ }
214
+
215
+ let mut sse_endpoints = Vec::new();
216
+ if !sse_producers.is_nil() {
217
+ let sse_hash = RHash::from_value(sse_producers)
218
+ .ok_or_else(|| Error::new(ruby.exception_arg_error(), "SSE producers must be a Hash"))?;
219
+
220
+ sse_hash.foreach(|path: String, factory: Value| -> Result<ForEach, Error> {
221
+ let producer_instance = factory.funcall::<_, _, Value>("call", ()).map_err(|e| {
222
+ Error::new(
223
+ ruby.exception_runtime_error(),
224
+ format!("Failed to create SSE producer: {}", e),
225
+ )
226
+ })?;
227
+
228
+ let sse_state = crate::sse::create_sse_state(ruby, producer_instance)?;
229
+
230
+ sse_endpoints.push((path, sse_state));
231
+
232
+ Ok(ForEach::Continue)
233
+ })?;
234
+ }
235
+
236
+ for (path, ws_state) in ws_endpoints {
237
+ info!("Registered WebSocket endpoint: {}", path);
238
+ app_router = app_router.route(
239
+ &path,
240
+ get(spikard_http::websocket_handler::<crate::websocket::RubyWebSocketHandler>).with_state(ws_state),
241
+ );
242
+ }
243
+
244
+ for (path, sse_state) in sse_endpoints {
245
+ info!("Registered SSE endpoint: {}", path);
246
+ app_router = app_router.route(
247
+ &path,
248
+ get(spikard_http::sse_handler::<crate::sse::RubySseEventProducer>).with_state(sse_state),
249
+ );
250
+ }
251
+
252
+ let addr = format!("{}:{}", config.host, config.port);
253
+ let socket_addr: std::net::SocketAddr = addr.parse().map_err(|e| {
254
+ Error::new(
255
+ ruby.exception_arg_error(),
256
+ format!("Invalid socket address {}: {}", addr, e),
257
+ )
258
+ })?;
259
+
260
+ let runtime = tokio::runtime::Builder::new_current_thread()
261
+ .enable_all()
262
+ .build()
263
+ .map_err(|e| {
264
+ Error::new(
265
+ ruby.exception_runtime_error(),
266
+ format!("Failed to create Tokio runtime: {}", e),
267
+ )
268
+ })?;
269
+
270
+ let background_config = config.background_tasks.clone();
271
+
272
+ runtime
273
+ .block_on(async move {
274
+ let listener = tokio::net::TcpListener::bind(socket_addr)
275
+ .await
276
+ .map_err(|err| format!("Failed to bind to {socket_addr}: {err}"))?;
277
+
278
+ info!("Server listening on {}", socket_addr);
279
+
280
+ let background_runtime = spikard_http::BackgroundRuntime::start(background_config.clone()).await;
281
+ crate::background::install_handle(background_runtime.handle());
282
+
283
+ let serve_result = axum::serve(listener, app_router).await;
284
+
285
+ crate::background::clear_handle();
286
+
287
+ if let Err(err) = background_runtime.shutdown().await {
288
+ warn!("Failed to drain background tasks during shutdown: {:?}", err);
289
+ }
290
+
291
+ serve_result.map_err(|e| format!("Server error: {e}"))?;
292
+ Ok::<(), String>(())
293
+ })
294
+ .map_err(|msg| Error::new(ruby.exception_runtime_error(), msg))?;
295
+
296
+ Ok(())
297
+ }
298
+
299
+ /// Validate and normalize route metadata using the Rust RouteMetadata schema.
300
+ ///
301
+ /// Parses the provided JSON, compiles schemas/parameter validators to ensure
302
+ /// correctness, and returns a canonical JSON string. This keeps Ruby-sourced
303
+ /// metadata aligned with the Rust core types.
304
+ pub fn normalize_route_metadata(_ruby: &Ruby, routes_json: String) -> Result<String, Error> {
305
+ let registry = SchemaRegistry::new();
306
+ let routes: Vec<RouteMetadata> = serde_json::from_str(&routes_json)
307
+ .map_err(|err| Error::new(magnus::exception::arg_error(), format!("Invalid routes JSON: {err}")))?;
308
+
309
+ for route in &routes {
310
+ Route::from_metadata(route.clone(), &registry).map_err(|err| {
311
+ Error::new(
312
+ magnus::exception::runtime_error(),
313
+ format!("Invalid route {} {}: {err}", route.method, route.path),
314
+ )
315
+ })?;
316
+ }
317
+
318
+ serde_json::to_string(&routes).map_err(|err| {
319
+ Error::new(
320
+ magnus::exception::runtime_error(),
321
+ format!("Failed to serialise routes: {err}"),
322
+ )
323
+ })
324
+ }