spikard 0.12.0 → 0.15.2

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 (206) hide show
  1. checksums.yaml +4 -4
  2. data/Steepfile +6 -0
  3. data/ext/spikard_rb/extconf.rb +1 -2
  4. data/ext/spikard_rb/{Cargo.lock → native/Cargo.lock} +897 -451
  5. data/ext/spikard_rb/native/Cargo.toml +24 -0
  6. data/ext/spikard_rb/src/lib.rs +5366 -3
  7. data/lib/spikard/native.rb +86 -0
  8. data/lib/spikard/version.rb +6 -1
  9. data/lib/spikard.rb +8 -45
  10. data/lib/spikard_rb.so +0 -0
  11. data/sig/types.rbs +427 -0
  12. metadata +14 -242
  13. data/LICENSE +0 -1
  14. data/README.md +0 -267
  15. data/ext/spikard_rb/Cargo.toml +0 -17
  16. data/lib/spikard/app.rb +0 -428
  17. data/lib/spikard/background.rb +0 -58
  18. data/lib/spikard/config.rb +0 -506
  19. data/lib/spikard/converters.rb +0 -13
  20. data/lib/spikard/grpc.rb +0 -182
  21. data/lib/spikard/handler_wrapper.rb +0 -113
  22. data/lib/spikard/provide.rb +0 -214
  23. data/lib/spikard/response.rb +0 -173
  24. data/lib/spikard/schema.rb +0 -243
  25. data/lib/spikard/sse.rb +0 -111
  26. data/lib/spikard/streaming_response.rb +0 -44
  27. data/lib/spikard/testing.rb +0 -432
  28. data/lib/spikard/upload_file.rb +0 -131
  29. data/lib/spikard/websocket.rb +0 -59
  30. data/sig/spikard.rbs +0 -719
  31. data/vendor/crates/spikard-bindings-shared/Cargo.toml +0 -80
  32. data/vendor/crates/spikard-bindings-shared/examples/config_extraction.rs +0 -132
  33. data/vendor/crates/spikard-bindings-shared/src/config_extractor.rs +0 -905
  34. data/vendor/crates/spikard-bindings-shared/src/conversion_traits.rs +0 -210
  35. data/vendor/crates/spikard-bindings-shared/src/di_traits.rs +0 -252
  36. data/vendor/crates/spikard-bindings-shared/src/error_response.rs +0 -404
  37. data/vendor/crates/spikard-bindings-shared/src/grpc_metadata.rs +0 -199
  38. data/vendor/crates/spikard-bindings-shared/src/handler_base.rs +0 -252
  39. data/vendor/crates/spikard-bindings-shared/src/json_conversion.rs +0 -829
  40. data/vendor/crates/spikard-bindings-shared/src/lazy_cache.rs +0 -587
  41. data/vendor/crates/spikard-bindings-shared/src/lib.rs +0 -33
  42. data/vendor/crates/spikard-bindings-shared/src/lifecycle_base.rs +0 -298
  43. data/vendor/crates/spikard-bindings-shared/src/lifecycle_executor.rs +0 -594
  44. data/vendor/crates/spikard-bindings-shared/src/response_builder.rs +0 -743
  45. data/vendor/crates/spikard-bindings-shared/src/response_interpreter.rs +0 -944
  46. data/vendor/crates/spikard-bindings-shared/src/test_client_base.rs +0 -260
  47. data/vendor/crates/spikard-bindings-shared/src/validation_helpers.rs +0 -369
  48. data/vendor/crates/spikard-bindings-shared/tests/config_extractor_behavior.rs +0 -192
  49. data/vendor/crates/spikard-bindings-shared/tests/error_response_edge_cases.rs +0 -383
  50. data/vendor/crates/spikard-bindings-shared/tests/full_coverage.rs +0 -459
  51. data/vendor/crates/spikard-bindings-shared/tests/handler_base_integration.rs +0 -280
  52. data/vendor/crates/spikard-bindings-shared/tests/integration_tests.rs +0 -669
  53. data/vendor/crates/spikard-core/Cargo.toml +0 -60
  54. data/vendor/crates/spikard-core/src/bindings/mod.rs +0 -3
  55. data/vendor/crates/spikard-core/src/bindings/response.rs +0 -130
  56. data/vendor/crates/spikard-core/src/debug.rs +0 -127
  57. data/vendor/crates/spikard-core/src/di/container.rs +0 -702
  58. data/vendor/crates/spikard-core/src/di/dependency.rs +0 -273
  59. data/vendor/crates/spikard-core/src/di/error.rs +0 -118
  60. data/vendor/crates/spikard-core/src/di/factory.rs +0 -538
  61. data/vendor/crates/spikard-core/src/di/graph.rs +0 -507
  62. data/vendor/crates/spikard-core/src/di/mod.rs +0 -192
  63. data/vendor/crates/spikard-core/src/di/resolved.rs +0 -428
  64. data/vendor/crates/spikard-core/src/di/value.rs +0 -282
  65. data/vendor/crates/spikard-core/src/errors.rs +0 -72
  66. data/vendor/crates/spikard-core/src/http.rs +0 -492
  67. data/vendor/crates/spikard-core/src/lib.rs +0 -29
  68. data/vendor/crates/spikard-core/src/lifecycle.rs +0 -1273
  69. data/vendor/crates/spikard-core/src/metadata.rs +0 -378
  70. data/vendor/crates/spikard-core/src/parameters.rs +0 -2546
  71. data/vendor/crates/spikard-core/src/problem.rs +0 -358
  72. data/vendor/crates/spikard-core/src/request_data.rs +0 -1146
  73. data/vendor/crates/spikard-core/src/router.rs +0 -530
  74. data/vendor/crates/spikard-core/src/schema_registry.rs +0 -197
  75. data/vendor/crates/spikard-core/src/type_hints.rs +0 -311
  76. data/vendor/crates/spikard-core/src/validation/error_mapper.rs +0 -710
  77. data/vendor/crates/spikard-core/src/validation/mod.rs +0 -470
  78. data/vendor/crates/spikard-core/tests/bindings_response_tests.rs +0 -136
  79. data/vendor/crates/spikard-core/tests/di_dependency_defaults.rs +0 -37
  80. data/vendor/crates/spikard-core/tests/error_mapper.rs +0 -761
  81. data/vendor/crates/spikard-core/tests/parameters_edge_cases.rs +0 -106
  82. data/vendor/crates/spikard-core/tests/parameters_full.rs +0 -701
  83. data/vendor/crates/spikard-core/tests/parameters_schema_and_formats.rs +0 -301
  84. data/vendor/crates/spikard-core/tests/request_data_roundtrip.rs +0 -67
  85. data/vendor/crates/spikard-core/tests/validation_coverage.rs +0 -250
  86. data/vendor/crates/spikard-core/tests/validation_error_paths.rs +0 -45
  87. data/vendor/crates/spikard-http/Cargo.toml +0 -87
  88. data/vendor/crates/spikard-http/examples/sse-notifications.rs +0 -148
  89. data/vendor/crates/spikard-http/examples/websocket-chat.rs +0 -92
  90. data/vendor/crates/spikard-http/src/auth.rs +0 -301
  91. data/vendor/crates/spikard-http/src/background.rs +0 -1860
  92. data/vendor/crates/spikard-http/src/bindings/mod.rs +0 -3
  93. data/vendor/crates/spikard-http/src/bindings/response.rs +0 -1
  94. data/vendor/crates/spikard-http/src/body_metadata.rs +0 -8
  95. data/vendor/crates/spikard-http/src/cors.rs +0 -1026
  96. data/vendor/crates/spikard-http/src/debug.rs +0 -128
  97. data/vendor/crates/spikard-http/src/di_handler.rs +0 -1672
  98. data/vendor/crates/spikard-http/src/grpc/framing.rs +0 -469
  99. data/vendor/crates/spikard-http/src/grpc/handler.rs +0 -1122
  100. data/vendor/crates/spikard-http/src/grpc/mod.rs +0 -434
  101. data/vendor/crates/spikard-http/src/grpc/service.rs +0 -622
  102. data/vendor/crates/spikard-http/src/grpc/streaming.rs +0 -319
  103. data/vendor/crates/spikard-http/src/handler_response.rs +0 -901
  104. data/vendor/crates/spikard-http/src/handler_trait.rs +0 -1015
  105. data/vendor/crates/spikard-http/src/handler_trait_tests.rs +0 -290
  106. data/vendor/crates/spikard-http/src/jsonrpc/http_handler.rs +0 -502
  107. data/vendor/crates/spikard-http/src/jsonrpc/method_registry.rs +0 -648
  108. data/vendor/crates/spikard-http/src/jsonrpc/mod.rs +0 -58
  109. data/vendor/crates/spikard-http/src/jsonrpc/protocol.rs +0 -1207
  110. data/vendor/crates/spikard-http/src/jsonrpc/router.rs +0 -2262
  111. data/vendor/crates/spikard-http/src/lib.rs +0 -548
  112. data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +0 -230
  113. data/vendor/crates/spikard-http/src/lifecycle.rs +0 -1193
  114. data/vendor/crates/spikard-http/src/middleware/mod.rs +0 -560
  115. data/vendor/crates/spikard-http/src/middleware/multipart.rs +0 -912
  116. data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +0 -513
  117. data/vendor/crates/spikard-http/src/middleware/validation.rs +0 -768
  118. data/vendor/crates/spikard-http/src/openapi/mod.rs +0 -309
  119. data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +0 -535
  120. data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +0 -1363
  121. data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +0 -667
  122. data/vendor/crates/spikard-http/src/query_parser.rs +0 -793
  123. data/vendor/crates/spikard-http/src/response.rs +0 -720
  124. data/vendor/crates/spikard-http/src/server/fast_router.rs +0 -186
  125. data/vendor/crates/spikard-http/src/server/grpc_routing.rs +0 -858
  126. data/vendor/crates/spikard-http/src/server/handler.rs +0 -1661
  127. data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +0 -253
  128. data/vendor/crates/spikard-http/src/server/mod.rs +0 -1649
  129. data/vendor/crates/spikard-http/src/server/request_extraction.rs +0 -871
  130. data/vendor/crates/spikard-http/src/server/routing_factory.rs +0 -618
  131. data/vendor/crates/spikard-http/src/sse.rs +0 -1409
  132. data/vendor/crates/spikard-http/src/testing/form.rs +0 -52
  133. data/vendor/crates/spikard-http/src/testing/multipart.rs +0 -64
  134. data/vendor/crates/spikard-http/src/testing/test_client.rs +0 -787
  135. data/vendor/crates/spikard-http/src/testing.rs +0 -617
  136. data/vendor/crates/spikard-http/src/websocket.rs +0 -1477
  137. data/vendor/crates/spikard-http/tests/auth_integration.rs +0 -645
  138. data/vendor/crates/spikard-http/tests/background_behavior.rs +0 -832
  139. data/vendor/crates/spikard-http/tests/common/grpc_helpers.rs +0 -1012
  140. data/vendor/crates/spikard-http/tests/common/handlers.rs +0 -309
  141. data/vendor/crates/spikard-http/tests/common/mod.rs +0 -33
  142. data/vendor/crates/spikard-http/tests/common/test_builders.rs +0 -628
  143. data/vendor/crates/spikard-http/tests/di_handler_error_responses.rs +0 -162
  144. data/vendor/crates/spikard-http/tests/di_integration.rs +0 -192
  145. data/vendor/crates/spikard-http/tests/doc_snippets.rs +0 -5
  146. data/vendor/crates/spikard-http/tests/grpc_bidirectional_streaming.rs +0 -430
  147. data/vendor/crates/spikard-http/tests/grpc_client_streaming.rs +0 -738
  148. data/vendor/crates/spikard-http/tests/grpc_error_handling_test.rs +0 -652
  149. data/vendor/crates/spikard-http/tests/grpc_integration_test.rs +0 -334
  150. data/vendor/crates/spikard-http/tests/grpc_metadata_test.rs +0 -532
  151. data/vendor/crates/spikard-http/tests/grpc_server_integration.rs +0 -495
  152. data/vendor/crates/spikard-http/tests/grpc_server_streaming.rs +0 -974
  153. data/vendor/crates/spikard-http/tests/lifecycle_execution.rs +0 -1093
  154. data/vendor/crates/spikard-http/tests/middleware_stack_integration.rs +0 -389
  155. data/vendor/crates/spikard-http/tests/multipart_behavior.rs +0 -656
  156. data/vendor/crates/spikard-http/tests/request_extraction_full.rs +0 -513
  157. data/vendor/crates/spikard-http/tests/server_auth_middleware_behavior.rs +0 -328
  158. data/vendor/crates/spikard-http/tests/server_config_builder.rs +0 -314
  159. data/vendor/crates/spikard-http/tests/server_configured_router_behavior.rs +0 -200
  160. data/vendor/crates/spikard-http/tests/server_cors_preflight.rs +0 -83
  161. data/vendor/crates/spikard-http/tests/server_handler_wrappers.rs +0 -464
  162. data/vendor/crates/spikard-http/tests/server_method_router_additional_behavior.rs +0 -286
  163. data/vendor/crates/spikard-http/tests/server_method_router_coverage.rs +0 -118
  164. data/vendor/crates/spikard-http/tests/server_middleware_behavior.rs +0 -99
  165. data/vendor/crates/spikard-http/tests/server_middleware_branches.rs +0 -204
  166. data/vendor/crates/spikard-http/tests/server_openapi_jsonrpc_static.rs +0 -421
  167. data/vendor/crates/spikard-http/tests/server_router_behavior.rs +0 -121
  168. data/vendor/crates/spikard-http/tests/sse_behavior.rs +0 -620
  169. data/vendor/crates/spikard-http/tests/sse_full_behavior.rs +0 -584
  170. data/vendor/crates/spikard-http/tests/sse_handler_behavior.rs +0 -130
  171. data/vendor/crates/spikard-http/tests/test_client_requests.rs +0 -167
  172. data/vendor/crates/spikard-http/tests/testing_helpers.rs +0 -87
  173. data/vendor/crates/spikard-http/tests/testing_module_coverage.rs +0 -155
  174. data/vendor/crates/spikard-http/tests/urlencoded_content_type.rs +0 -82
  175. data/vendor/crates/spikard-http/tests/websocket_behavior.rs +0 -663
  176. data/vendor/crates/spikard-http/tests/websocket_full_behavior.rs +0 -440
  177. data/vendor/crates/spikard-http/tests/websocket_integration.rs +0 -150
  178. data/vendor/crates/spikard-rb/Cargo.toml +0 -68
  179. data/vendor/crates/spikard-rb/build.rs +0 -200
  180. data/vendor/crates/spikard-rb/src/background.rs +0 -63
  181. data/vendor/crates/spikard-rb/src/config/mod.rs +0 -5
  182. data/vendor/crates/spikard-rb/src/config/server_config.rs +0 -401
  183. data/vendor/crates/spikard-rb/src/conversion.rs +0 -688
  184. data/vendor/crates/spikard-rb/src/di/builder.rs +0 -100
  185. data/vendor/crates/spikard-rb/src/di/mod.rs +0 -375
  186. data/vendor/crates/spikard-rb/src/grpc/handler.rs +0 -834
  187. data/vendor/crates/spikard-rb/src/grpc/mod.rs +0 -13
  188. data/vendor/crates/spikard-rb/src/gvl.rs +0 -80
  189. data/vendor/crates/spikard-rb/src/handler.rs +0 -699
  190. data/vendor/crates/spikard-rb/src/integration/mod.rs +0 -3
  191. data/vendor/crates/spikard-rb/src/lib.rs +0 -2264
  192. data/vendor/crates/spikard-rb/src/lifecycle.rs +0 -303
  193. data/vendor/crates/spikard-rb/src/metadata/mod.rs +0 -5
  194. data/vendor/crates/spikard-rb/src/metadata/route_extraction.rs +0 -507
  195. data/vendor/crates/spikard-rb/src/request.rs +0 -439
  196. data/vendor/crates/spikard-rb/src/runtime/mod.rs +0 -5
  197. data/vendor/crates/spikard-rb/src/runtime/server_runner.rs +0 -344
  198. data/vendor/crates/spikard-rb/src/server.rs +0 -307
  199. data/vendor/crates/spikard-rb/src/sse.rs +0 -231
  200. data/vendor/crates/spikard-rb/src/testing/client.rs +0 -698
  201. data/vendor/crates/spikard-rb/src/testing/mod.rs +0 -7
  202. data/vendor/crates/spikard-rb/src/testing/sse.rs +0 -108
  203. data/vendor/crates/spikard-rb/src/testing/websocket.rs +0 -573
  204. data/vendor/crates/spikard-rb/src/websocket.rs +0 -475
  205. data/vendor/crates/spikard-rb-macros/Cargo.toml +0 -25
  206. data/vendor/crates/spikard-rb-macros/src/lib.rs +0 -51
@@ -1,344 +0,0 @@
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 tokio::runtime::Runtime;
15
- use tracing::{info, warn};
16
-
17
- /// Helper function to run the server startup logic without the GVL.
18
- ///
19
- /// This is called via `call_without_gvl!` to release the GVL before blocking on the async runtime.
20
- /// This allows handlers to acquire the GVL during request processing.
21
- async fn start_server_async(
22
- socket_addr: std::net::SocketAddr,
23
- app_router: axum::Router,
24
- background_config: spikard_http::BackgroundTaskConfig,
25
- ) -> Result<(), String> {
26
- let listener = tokio::net::TcpListener::bind(socket_addr)
27
- .await
28
- .map_err(|err| format!("Failed to bind to {socket_addr}: {err}"))?;
29
-
30
- info!("Server listening on {}", socket_addr);
31
-
32
- let background_runtime = spikard_http::BackgroundRuntime::start(background_config).await;
33
- crate::background::install_handle(background_runtime.handle());
34
-
35
- let serve_result = axum::serve(listener, app_router).await;
36
-
37
- crate::background::clear_handle();
38
-
39
- if let Err(err) = background_runtime.shutdown().await {
40
- warn!("Failed to drain background tasks during shutdown: {:?}", err);
41
- }
42
-
43
- serve_result.map_err(|e| format!("Server error: {e}"))?;
44
- Ok::<(), String>(())
45
- }
46
-
47
- /// Wrapper function for `call_without_gvl!` to start the server without the GVL.
48
- fn start_server_without_gvl(
49
- runtime: &Runtime,
50
- socket_addr: std::net::SocketAddr,
51
- app_router: axum::Router,
52
- background_config: spikard_http::BackgroundTaskConfig,
53
- ) -> Result<(), String> {
54
- runtime.block_on(start_server_async(socket_addr, app_router, background_config))
55
- }
56
-
57
- /// Start the Spikard HTTP server from Ruby
58
- ///
59
- /// Creates an Axum HTTP server in a dedicated background thread with its own Tokio runtime.
60
- ///
61
- /// # Arguments
62
- ///
63
- /// * `routes_json` - JSON string containing route metadata
64
- /// * `handlers` - Ruby Hash mapping handler_name => Proc
65
- /// * `config` - Ruby ServerConfig object with all middleware settings
66
- /// * `hooks_value` - Lifecycle hooks
67
- /// * `ws_handlers` - WebSocket handlers
68
- /// * `sse_producers` - SSE producers
69
- /// * `dependencies` - Dependency injection container
70
- ///
71
- /// # Example (Ruby)
72
- ///
73
- /// ```ruby
74
- /// config = Spikard::ServerConfig.new(host: '0.0.0.0', port: 8000)
75
- /// Spikard::Native.run_server(routes_json, handlers, config, hooks, ws, sse, deps)
76
- /// ```
77
- #[allow(clippy::too_many_arguments)]
78
- pub fn run_server(
79
- ruby: &Ruby,
80
- routes_json: String,
81
- handlers: Value,
82
- config_value: Value,
83
- hooks_value: Value,
84
- ws_handlers: Value,
85
- sse_producers: Value,
86
- dependencies: Value,
87
- ) -> Result<(), Error> {
88
- let mut config = extract_server_config(ruby, config_value)?;
89
-
90
- let host = config.host.clone();
91
- let port = config.port;
92
-
93
- let metadata: Vec<RouteMetadata> = serde_json::from_str(&routes_json)
94
- .map_err(|err| Error::new(ruby.exception_arg_error(), format!("Invalid routes JSON: {}", err)))?;
95
-
96
- let handlers_hash = RHash::from_value(handlers).ok_or_else(|| {
97
- Error::new(
98
- ruby.exception_arg_error(),
99
- "handlers parameter must be a Hash of handler_name => Proc",
100
- )
101
- })?;
102
-
103
- let json_module = ruby
104
- .class_object()
105
- .funcall::<_, _, Value>("const_get", ("JSON",))
106
- .map_err(|err| Error::new(ruby.exception_name_error(), format!("JSON module not found: {}", err)))?;
107
-
108
- let schema_registry = SchemaRegistry::new();
109
-
110
- let mut routes_with_handlers: Vec<(Route, Arc<dyn Handler>)> = Vec::new();
111
-
112
- for route_meta in metadata {
113
- let route = Route::from_metadata(route_meta.clone(), &schema_registry)
114
- .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("Failed to create route: {}", e)))?;
115
-
116
- let handler_key = ruby.str_new(&route_meta.handler_name);
117
- let handler_value: Value = match handlers_hash.lookup(handler_key) {
118
- Ok(val) => val,
119
- Err(_) => {
120
- return Err(Error::new(
121
- ruby.exception_arg_error(),
122
- format!("Handler '{}' not found in handlers hash", route_meta.handler_name),
123
- ));
124
- }
125
- };
126
-
127
- let ruby_handler = RubyHandler::new_for_server(
128
- ruby,
129
- handler_value,
130
- route_meta.handler_name.clone(),
131
- json_module,
132
- &route,
133
- )?;
134
-
135
- routes_with_handlers.push((route, Arc::new(ruby_handler) as Arc<dyn Handler>));
136
- }
137
-
138
- let lifecycle_hooks = if let Ok(registry) = <&crate::NativeLifecycleRegistry>::try_convert(hooks_value) {
139
- Some(registry.take_hooks())
140
- } else if !hooks_value.is_nil() {
141
- let hooks_hash = RHash::from_value(hooks_value)
142
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "lifecycle_hooks parameter must be a Hash"))?;
143
-
144
- let mut hooks = spikard_http::LifecycleHooks::new();
145
- type RubyHookVec = Vec<
146
- Arc<
147
- dyn spikard_http::lifecycle::LifecycleHook<
148
- axum::http::Request<axum::body::Body>,
149
- axum::http::Response<axum::body::Body>,
150
- >,
151
- >,
152
- >;
153
-
154
- let extract_hooks = |key: &str| -> Result<RubyHookVec, Error> {
155
- let key_sym = ruby.to_symbol(key);
156
- if let Some(hooks_array) = hooks_hash.get(key_sym)
157
- && !hooks_array.is_nil()
158
- {
159
- let array = magnus::RArray::from_value(hooks_array)
160
- .ok_or_else(|| Error::new(ruby.exception_type_error(), format!("{} must be an Array", key)))?;
161
-
162
- let mut result = Vec::new();
163
- let len = array.len();
164
- for i in 0..len {
165
- let hook_value: Value = array.entry(i as isize)?;
166
- let name = format!("{}_{}", key, i);
167
- let ruby_hook = crate::lifecycle::RubyLifecycleHook::new(name, hook_value);
168
- result.push(Arc::new(ruby_hook)
169
- as Arc<
170
- dyn spikard_http::lifecycle::LifecycleHook<
171
- axum::http::Request<axum::body::Body>,
172
- axum::http::Response<axum::body::Body>,
173
- >,
174
- >);
175
- }
176
- return Ok(result);
177
- }
178
- Ok(Vec::new())
179
- };
180
-
181
- for hook in extract_hooks("on_request")? {
182
- hooks.add_on_request(hook);
183
- }
184
-
185
- for hook in extract_hooks("pre_validation")? {
186
- hooks.add_pre_validation(hook);
187
- }
188
-
189
- for hook in extract_hooks("pre_handler")? {
190
- hooks.add_pre_handler(hook);
191
- }
192
-
193
- for hook in extract_hooks("on_response")? {
194
- hooks.add_on_response(hook);
195
- }
196
-
197
- for hook in extract_hooks("on_error")? {
198
- hooks.add_on_error(hook);
199
- }
200
-
201
- Some(hooks)
202
- } else {
203
- None
204
- };
205
-
206
- config.lifecycle_hooks = lifecycle_hooks.map(Arc::new);
207
-
208
- #[cfg(feature = "di")]
209
- {
210
- if let Ok(registry) = <&crate::NativeDependencyRegistry>::try_convert(dependencies) {
211
- config.di_container = Some(Arc::new(registry.take_container()?));
212
- } else if !dependencies.is_nil() {
213
- match build_dependency_container(ruby, dependencies) {
214
- Ok(container) => {
215
- config.di_container = Some(Arc::new(container));
216
- }
217
- Err(err) => {
218
- return Err(Error::new(
219
- ruby.exception_runtime_error(),
220
- format!("Failed to build DI container: {}", err),
221
- ));
222
- }
223
- }
224
- }
225
- }
226
-
227
- Server::init_logging();
228
-
229
- info!("Starting Spikard server on {}:{}", host, port);
230
- info!("Registered {} routes", routes_with_handlers.len());
231
-
232
- let mut app_router = Server::with_handlers(config.clone(), routes_with_handlers)
233
- .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("Failed to build router: {}", e)))?;
234
-
235
- let mut ws_endpoints = Vec::new();
236
- if !ws_handlers.is_nil() {
237
- let ws_hash = RHash::from_value(ws_handlers)
238
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "WebSocket handlers must be a Hash"))?;
239
-
240
- ws_hash.foreach(|path: String, factory: Value| -> Result<ForEach, Error> {
241
- if let Some(ws_state) = crate::websocket::create_websocket_state(ruby, factory)? {
242
- ws_endpoints.push((path, ws_state));
243
- }
244
-
245
- Ok(ForEach::Continue)
246
- })?;
247
- }
248
-
249
- let mut sse_endpoints = Vec::new();
250
- if !sse_producers.is_nil() {
251
- let sse_hash = RHash::from_value(sse_producers)
252
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "SSE producers must be a Hash"))?;
253
-
254
- sse_hash.foreach(|path: String, factory: Value| -> Result<ForEach, Error> {
255
- let producer_instance = factory.funcall::<_, _, Value>("call", ()).map_err(|e| {
256
- Error::new(
257
- ruby.exception_runtime_error(),
258
- format!("Failed to create SSE producer: {}", e),
259
- )
260
- })?;
261
-
262
- let sse_state = crate::sse::create_sse_state(ruby, producer_instance)?;
263
-
264
- sse_endpoints.push((path, sse_state));
265
-
266
- Ok(ForEach::Continue)
267
- })?;
268
- }
269
-
270
- for (path, ws_state) in ws_endpoints {
271
- info!("Registered WebSocket endpoint: {}", path);
272
- app_router = app_router.route(
273
- &path,
274
- get(spikard_http::websocket_handler::<crate::websocket::RubyWebSocketHandler>).with_state(ws_state),
275
- );
276
- }
277
-
278
- for (path, sse_state) in sse_endpoints {
279
- info!("Registered SSE endpoint: {}", path);
280
- app_router = app_router.route(
281
- &path,
282
- get(spikard_http::sse_handler::<crate::sse::RubySseEventProducer>).with_state(sse_state),
283
- );
284
- }
285
-
286
- let addr = format!("{}:{}", config.host, config.port);
287
- let socket_addr: std::net::SocketAddr = addr.parse().map_err(|e| {
288
- Error::new(
289
- ruby.exception_arg_error(),
290
- format!("Invalid socket address {}: {}", addr, e),
291
- )
292
- })?;
293
-
294
- let runtime = tokio::runtime::Builder::new_current_thread()
295
- .enable_all()
296
- .build()
297
- .map_err(|e| {
298
- Error::new(
299
- ruby.exception_runtime_error(),
300
- format!("Failed to create Tokio runtime: {}", e),
301
- )
302
- })?;
303
-
304
- let background_config = config.background_tasks.clone();
305
- let runtime_ref = &runtime;
306
-
307
- // Release the GVL before blocking on the async runtime to allow handlers to acquire it during request processing
308
- let result = crate::call_without_gvl!(
309
- start_server_without_gvl,
310
- args: (runtime_ref, &Runtime, socket_addr, std::net::SocketAddr, app_router, axum::Router, background_config, spikard_http::BackgroundTaskConfig),
311
- return_type: Result<(), String>
312
- );
313
-
314
- result.map_err(|msg| Error::new(ruby.exception_runtime_error(), msg))?;
315
-
316
- Ok(())
317
- }
318
-
319
- /// Validate and normalize route metadata using the Rust RouteMetadata schema.
320
- ///
321
- /// Parses the provided JSON, compiles schemas/parameter validators to ensure
322
- /// correctness, and returns a canonical JSON string. This keeps Ruby-sourced
323
- /// metadata aligned with the Rust core types.
324
- pub fn normalize_route_metadata(_ruby: &Ruby, routes_json: String) -> Result<String, Error> {
325
- let registry = SchemaRegistry::new();
326
- let routes: Vec<RouteMetadata> = serde_json::from_str(&routes_json)
327
- .map_err(|err| Error::new(magnus::exception::arg_error(), format!("Invalid routes JSON: {err}")))?;
328
-
329
- for route in &routes {
330
- Route::from_metadata(route.clone(), &registry).map_err(|err| {
331
- Error::new(
332
- magnus::exception::runtime_error(),
333
- format!("Invalid route {} {}: {err}", route.method, route.path),
334
- )
335
- })?;
336
- }
337
-
338
- serde_json::to_string(&routes).map_err(|err| {
339
- Error::new(
340
- magnus::exception::runtime_error(),
341
- format!("Failed to serialise routes: {err}"),
342
- )
343
- })
344
- }
@@ -1,307 +0,0 @@
1
- //! HTTP server setup and lifecycle management.
2
- //!
3
- //! This module handles the creation and startup of the Spikard HTTP server
4
- //! including route registration, middleware configuration, and lifecycle hooks.
5
-
6
- #![allow(dead_code)]
7
-
8
- use axum::body::Body;
9
- use axum::http::Request;
10
- use axum::http::Response;
11
- use magnus::prelude::*;
12
- use magnus::{Error, RArray, RHash, Ruby, Value, r_hash::ForEach};
13
- use once_cell::sync::Lazy;
14
- use spikard_http::{Handler, Route, RouteMetadata, SchemaRegistry, Server};
15
- use std::sync::Arc;
16
- use tokio::runtime::{Builder, Runtime};
17
- use tracing::{info, warn};
18
-
19
- use crate::config::extract_server_config;
20
- use crate::handler::RubyHandler;
21
-
22
- /// Global Tokio runtime for async operations.
23
- ///
24
- /// Initialized once and reused for all async operations throughout the lifetime
25
- /// of the Ruby process.
26
- pub static GLOBAL_RUNTIME: Lazy<Result<Runtime, std::io::Error>> =
27
- Lazy::new(|| Builder::new_multi_thread().enable_all().build());
28
-
29
- pub fn global_runtime_raw() -> Result<&'static Runtime, std::io::Error> {
30
- match &*GLOBAL_RUNTIME {
31
- Ok(runtime) => Ok(runtime),
32
- Err(err) => Err(std::io::Error::new(err.kind(), err.to_string())),
33
- }
34
- }
35
-
36
- pub fn global_runtime(ruby: &Ruby) -> Result<&'static Runtime, Error> {
37
- global_runtime_raw().map_err(|err| {
38
- Error::new(
39
- ruby.exception_runtime_error(),
40
- format!("Failed to initialise global Tokio runtime: {err}"),
41
- )
42
- })
43
- }
44
-
45
- pub fn global_runtime_or_err() -> Result<&'static Runtime, Error> {
46
- global_runtime_raw().map_err(|err| {
47
- Error::new(
48
- magnus::exception::runtime_error(),
49
- format!("Failed to initialise global Tokio runtime: {err}"),
50
- )
51
- })
52
- }
53
-
54
- /// Start the Spikard HTTP server from Ruby
55
- ///
56
- /// Creates an Axum HTTP server in a dedicated background thread with its own Tokio runtime.
57
- ///
58
- /// # Arguments
59
- ///
60
- /// * `ruby` - Ruby VM reference
61
- /// * `routes_json` - JSON string containing route metadata
62
- /// * `handlers` - Ruby Hash mapping handler_name => Proc
63
- /// * `config_value` - Ruby ServerConfig object with all middleware settings
64
- /// * `hooks_value` - Ruby Hash of lifecycle hooks (optional)
65
- /// * `ws_handlers` - Ruby Hash of WebSocket handlers (optional)
66
- /// * `sse_producers` - Ruby Hash of SSE producers (optional)
67
- ///
68
- /// # Example (Ruby)
69
- ///
70
- /// ```ruby
71
- /// config = Spikard::ServerConfig.new(host: '0.0.0.0', port: 8000)
72
- /// Spikard::Native.run_server(routes_json, handlers, config, hooks, ws_handlers, sse_producers)
73
- /// ```
74
- pub fn run_server(
75
- ruby: &Ruby,
76
- routes_json: String,
77
- handlers: Value,
78
- config_value: Value,
79
- hooks_value: Value,
80
- ws_handlers: Value,
81
- sse_producers: Value,
82
- ) -> Result<(), Error> {
83
- let mut config = extract_server_config(ruby, config_value)?;
84
-
85
- let host = config.host.clone();
86
- let port = config.port;
87
-
88
- let metadata: Vec<RouteMetadata> = serde_json::from_str(&routes_json)
89
- .map_err(|err| Error::new(ruby.exception_arg_error(), format!("Invalid routes JSON: {}", err)))?;
90
-
91
- let handlers_hash = RHash::from_value(handlers).ok_or_else(|| {
92
- Error::new(
93
- ruby.exception_arg_error(),
94
- "handlers parameter must be a Hash of handler_name => Proc",
95
- )
96
- })?;
97
-
98
- let json_module = ruby
99
- .class_object()
100
- .funcall::<_, _, Value>("const_get", ("JSON",))
101
- .map_err(|err| Error::new(ruby.exception_name_error(), format!("JSON module not found: {}", err)))?;
102
-
103
- let schema_registry = SchemaRegistry::new();
104
-
105
- let mut routes_with_handlers: Vec<(Route, Arc<dyn Handler>)> = Vec::new();
106
-
107
- for route_meta in metadata {
108
- let route = Route::from_metadata(route_meta.clone(), &schema_registry)
109
- .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("Failed to create route: {}", e)))?;
110
-
111
- let handler_key = ruby.str_new(&route_meta.handler_name);
112
- let handler_value: Value = match handlers_hash.lookup(handler_key) {
113
- Ok(val) => val,
114
- Err(_) => {
115
- return Err(Error::new(
116
- ruby.exception_arg_error(),
117
- format!("Handler '{}' not found in handlers hash", route_meta.handler_name),
118
- ));
119
- }
120
- };
121
-
122
- // Fast-path: if the route metadata declares a static_response, use StaticResponseHandler
123
- if let Some(ref sr_value) = route_meta.static_response {
124
- let status = sr_value.get("status").and_then(|v| v.as_u64()).unwrap_or(200) as u16;
125
- let body = sr_value.get("body").and_then(|v| v.as_str()).unwrap_or("").to_string();
126
- let content_type = sr_value.get("content_type").and_then(|v| v.as_str());
127
- let static_handler = spikard_http::StaticResponseHandler::from_parts(status, body, content_type, vec![]);
128
- routes_with_handlers.push((route, Arc::new(static_handler) as Arc<dyn Handler>));
129
- } else {
130
- let ruby_handler = RubyHandler::new_for_server(
131
- ruby,
132
- handler_value,
133
- route_meta.handler_name.clone(),
134
- route_meta.method.clone(),
135
- route_meta.path.clone(),
136
- json_module,
137
- &route,
138
- )?;
139
-
140
- routes_with_handlers.push((route, Arc::new(ruby_handler) as Arc<dyn Handler>));
141
- }
142
- }
143
-
144
- let lifecycle_hooks = if !hooks_value.is_nil() {
145
- let hooks_hash = RHash::from_value(hooks_value)
146
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "lifecycle_hooks parameter must be a Hash"))?;
147
-
148
- let mut hooks = spikard_http::LifecycleHooks::new();
149
- type RubyHookVec = Vec<Arc<dyn spikard_http::lifecycle::LifecycleHook<Request<Body>, Response<Body>>>>;
150
-
151
- let extract_hooks = |key: &str| -> Result<RubyHookVec, Error> {
152
- let key_sym = ruby.to_symbol(key);
153
- if let Some(hooks_array) = hooks_hash.get(key_sym)
154
- && !hooks_array.is_nil()
155
- {
156
- let array = RArray::from_value(hooks_array)
157
- .ok_or_else(|| Error::new(ruby.exception_type_error(), format!("{} must be an Array", key)))?;
158
-
159
- let mut result = Vec::new();
160
- let len = array.len();
161
- for i in 0..len {
162
- let hook_value: Value = array.entry(i as isize)?;
163
- let name = format!("{}_{}", key, i);
164
- let ruby_hook = crate::lifecycle::RubyLifecycleHook::new(name, hook_value);
165
- result.push(Arc::new(ruby_hook)
166
- as Arc<
167
- dyn spikard_http::lifecycle::LifecycleHook<Request<Body>, Response<Body>>,
168
- >);
169
- }
170
- return Ok(result);
171
- }
172
- Ok(Vec::new())
173
- };
174
-
175
- for hook in extract_hooks("on_request")? {
176
- hooks.add_on_request(hook);
177
- }
178
-
179
- for hook in extract_hooks("pre_validation")? {
180
- hooks.add_pre_validation(hook);
181
- }
182
-
183
- for hook in extract_hooks("pre_handler")? {
184
- hooks.add_pre_handler(hook);
185
- }
186
-
187
- for hook in extract_hooks("on_response")? {
188
- hooks.add_on_response(hook);
189
- }
190
-
191
- for hook in extract_hooks("on_error")? {
192
- hooks.add_on_error(hook);
193
- }
194
-
195
- Some(hooks)
196
- } else {
197
- None
198
- };
199
-
200
- config.lifecycle_hooks = lifecycle_hooks.map(Arc::new);
201
-
202
- Server::init_logging();
203
-
204
- info!("Starting Spikard server on {}:{}", host, port);
205
- info!("Registered {} routes", routes_with_handlers.len());
206
-
207
- let mut app_router = Server::with_handlers(config.clone(), routes_with_handlers)
208
- .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("Failed to build router: {}", e)))?;
209
-
210
- let mut ws_endpoints = Vec::new();
211
- if !ws_handlers.is_nil() {
212
- let ws_hash = RHash::from_value(ws_handlers)
213
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "WebSocket handlers must be a Hash"))?;
214
-
215
- ws_hash.foreach(|path: String, factory: Value| -> Result<ForEach, Error> {
216
- if let Some(ws_state) = crate::websocket::create_websocket_state(ruby, factory)? {
217
- ws_endpoints.push((path, ws_state));
218
- }
219
-
220
- Ok(ForEach::Continue)
221
- })?;
222
- }
223
-
224
- let mut sse_endpoints = Vec::new();
225
- if !sse_producers.is_nil() {
226
- let sse_hash = RHash::from_value(sse_producers)
227
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "SSE producers must be a Hash"))?;
228
-
229
- sse_hash.foreach(|path: String, factory: Value| -> Result<ForEach, Error> {
230
- let producer_instance = factory.funcall::<_, _, Value>("call", ()).map_err(|e| {
231
- Error::new(
232
- ruby.exception_runtime_error(),
233
- format!("Failed to create SSE producer: {}", e),
234
- )
235
- })?;
236
-
237
- let sse_state = crate::sse::create_sse_state(ruby, producer_instance)?;
238
-
239
- sse_endpoints.push((path, sse_state));
240
-
241
- Ok(ForEach::Continue)
242
- })?;
243
- }
244
-
245
- use axum::routing::get;
246
- for (path, ws_state) in ws_endpoints {
247
- info!("Registered WebSocket endpoint: {}", path);
248
- app_router = app_router.route(
249
- &path,
250
- get(spikard_http::websocket_handler::<crate::websocket::RubyWebSocketHandler>).with_state(ws_state),
251
- );
252
- }
253
-
254
- for (path, sse_state) in sse_endpoints {
255
- info!("Registered SSE endpoint: {}", path);
256
- app_router = app_router.route(
257
- &path,
258
- get(spikard_http::sse_handler::<crate::sse::RubySseEventProducer>).with_state(sse_state),
259
- );
260
- }
261
-
262
- let addr = format!("{}:{}", config.host, config.port);
263
- let socket_addr: std::net::SocketAddr = addr.parse().map_err(|e| {
264
- Error::new(
265
- ruby.exception_arg_error(),
266
- format!("Invalid socket address {}: {}", addr, e),
267
- )
268
- })?;
269
-
270
- let runtime = tokio::runtime::Builder::new_current_thread()
271
- .enable_all()
272
- .build()
273
- .map_err(|e| {
274
- Error::new(
275
- ruby.exception_runtime_error(),
276
- format!("Failed to create Tokio runtime: {}", e),
277
- )
278
- })?;
279
-
280
- let background_config = config.background_tasks.clone();
281
-
282
- runtime
283
- .block_on(async move {
284
- let listener = tokio::net::TcpListener::bind(socket_addr)
285
- .await
286
- .map_err(|err| format!("Failed to bind to {socket_addr}: {err}"))?;
287
-
288
- info!("Server listening on {}", socket_addr);
289
-
290
- let background_runtime = spikard_http::BackgroundRuntime::start(background_config.clone()).await;
291
- crate::background::install_handle(background_runtime.handle());
292
-
293
- let serve_result = axum::serve(listener, app_router).await;
294
-
295
- crate::background::clear_handle();
296
-
297
- if let Err(err) = background_runtime.shutdown().await {
298
- warn!("Failed to drain background tasks during shutdown: {:?}", err);
299
- }
300
-
301
- serve_result.map_err(|e| format!("Server error: {e}"))?;
302
- Ok::<(), String>(())
303
- })
304
- .map_err(|msg| Error::new(ruby.exception_runtime_error(), msg))?;
305
-
306
- Ok(())
307
- }