bevy_webgate 0.2.0

A web server integration for the Bevy game engine that allows you to easily append a webserver to Bevy.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
use axum::handler::Handler;
use axum::response::IntoResponse;
use axum::routing::{MethodRouter, Route};
use axum::Router;
use bevy_app::App;
use bevy_ecs::world::Mut;
use std::convert::Infallible;
use std::net::IpAddr;
use tower::{Layer, Service};

use crate::{
    BevyWebServerPlugin, WebPort, WebServer, WebServerConfig, WebServerManager, WebServerResult,
    DEFAULT_IP, DEFAULT_PORT,
};

/// Extends Bevy App with multi-port web server capabilities and server management.
///
/// This trait provides methods for managing multiple web servers on different ports,
/// configuring port-specific routing, and managing server lifecycle.
///
/// # Examples
///
/// ```rust
/// use bevy::prelude::*;
/// use bevy_webgate::{WebServerAppExt, BevyWebServerPlugin};
/// use axum::routing::get;
///
/// let mut app = App::new();
/// app.add_plugins(MinimalPlugins)
///    .add_plugins(BevyWebServerPlugin);
///
/// // Multi-port usage
/// app.port_route(8081, "/admin", get(|| async { "Admin" }))
///    .port_route(8082, "/health", get(|| async { "OK" }));
///
/// // Custom IP binding
/// app.add_server("127.0.0.1".parse().unwrap(), 8083);
/// ```

pub trait WebServerAppExt {
    /// Add a server on specific IP and port
    fn add_server(&mut self, ip: IpAddr, port: WebPort) -> &mut Self;

    /// Update a server configuration at runtime
    fn update_server(
        &mut self,
        ip: IpAddr,
        port: WebPort,
        router: Router,
    ) -> WebServerResult<&mut Self>;

    /// Remove a server
    fn remove_server(&mut self, port: WebPort) -> WebServerResult<&mut Self>;

    /// Add a route to a specific port
    fn port_route(
        &mut self,
        port: WebPort,
        path: &str,
        method_router: MethodRouter<()>,
    ) -> &mut Self;

    /// Configure router for specific port
    fn port_router(&mut self, port: WebPort, router_fn: impl FnOnce(Router) -> Router)
        -> &mut Self;

    /// Add nested routes to a specific port
    fn port_nest(&mut self, port: WebPort, path: &str, router: Router<()>) -> &mut Self;

    /// Add a service to a specific port
    fn port_route_service<T>(&mut self, port: WebPort, path: &str, service: T) -> &mut Self
    where
        T: Service<axum::extract::Request, Error = Infallible> + Clone + Send + Sync + 'static,
        T::Response: IntoResponse,
        T::Future: Send + 'static;

    /// Merge another router into a specific port
    fn port_merge<R>(&mut self, port: WebPort, other: R) -> &mut Self
    where
        R: Into<Router<()>>;

    /// Add a layer to a specific port
    fn port_layer<L>(&mut self, port: WebPort, layer: L) -> &mut Self
    where
        L: Layer<Route> + Clone + Send + Sync + 'static,
        L::Service: Service<axum::extract::Request> + Clone + Send + Sync + 'static,
        <L::Service as Service<axum::extract::Request>>::Response: IntoResponse + 'static,
        <L::Service as Service<axum::extract::Request>>::Error: Into<Infallible> + 'static,
        <L::Service as Service<axum::extract::Request>>::Future: Send + 'static;

    /// Add a fallback handler to a specific port
    fn port_fallback<H, T>(&mut self, port: WebPort, handler: H) -> &mut Self
    where
        H: Handler<T, ()>,
        T: 'static;

    /// Get information about running servers
    fn running_servers(&self) -> Vec<(WebPort, IpAddr)>;

    /// All configured ports
    fn routed_ports(&self) -> Vec<WebPort>;

    /// Get the number of configured servers
    fn server_count(&self) -> usize;
}

impl WebServerAppExt for App {
    fn add_server(&mut self, ip: IpAddr, port: WebPort) -> &mut Self {
        self.world_mut().init_resource::<WebServerManager>();
        if !self.is_plugin_added::<BevyWebServerPlugin>() {
            self.add_plugins(BevyWebServerPlugin);
        }

        self.world_mut()
            .resource_scope(|_world, mut manager: Mut<WebServerManager>| {
                let _ = manager.add_server(WebServer::new(ip, port, Router::new()));
            });
        self
    }

    fn update_server(
        &mut self,
        ip: IpAddr,
        port: WebPort,
        router: Router,
    ) -> WebServerResult<&mut Self> {
        self.world_mut().init_resource::<WebServerManager>();
        if !self.is_plugin_added::<BevyWebServerPlugin>() {
            self.add_plugins(BevyWebServerPlugin);
        }
        self.world_mut()
            .resource_scope(|_world, mut manager: Mut<WebServerManager>| {
                manager.add_server(WebServer::new(ip, port, router))
            })?;

        Ok(self)
    }

    fn remove_server(&mut self, port: WebPort) -> WebServerResult<&mut Self> {
        self.world_mut()
            .resource_scope(|_world, mut manager: Mut<WebServerManager>| {
                manager.remove_server(&port);
            });
        Ok(self)
    }

    fn port_route(
        &mut self,
        port: WebPort,
        path: &str,
        method_router: MethodRouter<()>,
    ) -> &mut Self {
        self.port_router(port, |router| router.route(path, method_router));
        self
    }

    fn port_router(
        &mut self,
        port: WebPort,
        router_fn: impl FnOnce(Router) -> Router,
    ) -> &mut Self {
        self.world_mut().init_resource::<WebServerManager>();
        if !self.is_plugin_added::<BevyWebServerPlugin>() {
            self.add_plugins(BevyWebServerPlugin);
        }

        self.world_mut()
            .resource_scope(|world, mut manager: Mut<WebServerManager>| {
                // Get default IP for new servers
                let default_ip = world
                    .get_resource::<WebServerConfig>()
                    .map_or(DEFAULT_IP, |config| config.ip);

                let existing_router = manager
                    .get_server(&port)
                    .map(|srv| srv.router().clone())
                    .unwrap_or_else(|| Router::new());

                let new_router = router_fn(existing_router);
                if !manager.has_server(&port) {
                    let _ = manager.add_server(WebServer::new(default_ip, port, new_router));
                } else {
                    manager.set_router(&port, new_router);
                }
            });

        self
    }

    fn port_nest(&mut self, port: WebPort, path: &str, router: Router<()>) -> &mut Self {
        self.port_router(port, |r| r.nest(path, router))
    }

    fn port_route_service<T>(&mut self, port: WebPort, path: &str, service: T) -> &mut Self
    where
        T: Service<axum::extract::Request, Error = Infallible> + Clone + Send + Sync + 'static,
        T::Response: IntoResponse,
        T::Future: Send + 'static,
    {
        self.port_router(port, |r| r.route_service(path, service))
    }

    fn port_merge<R>(&mut self, port: WebPort, other: R) -> &mut Self
    where
        R: Into<Router<()>>,
    {
        self.port_router(port, |r| r.merge(other))
    }

    fn port_layer<L>(&mut self, port: WebPort, layer: L) -> &mut Self
    where
        L: Layer<Route> + Clone + Send + Sync + 'static,
        L::Service: Service<axum::extract::Request> + Clone + Send + Sync + 'static,
        <L::Service as Service<axum::extract::Request>>::Response: IntoResponse + 'static,
        <L::Service as Service<axum::extract::Request>>::Error: Into<Infallible> + 'static,
        <L::Service as Service<axum::extract::Request>>::Future: Send + 'static,
    {
        self.port_router(port, |r| r.layer(layer))
    }
    fn port_fallback<H, T>(&mut self, port: WebPort, handler: H) -> &mut Self
    where
        H: Handler<T, ()>,
        T: 'static,
    {
        self.port_router(port, |r| r.fallback(handler))
    }

    fn running_servers(&self) -> Vec<(WebPort, IpAddr)> {
        let running_servers = self.world().get_resource::<WebServerManager>();
        let manager = self.world().get_resource::<WebServerManager>();

        match (running_servers, manager) {
            (Some(servers), Some(manager)) => servers
                .ports()
                .into_iter()
                .filter_map(|port| manager.get_server(&port).map(|srv| (port, srv.ip())))
                .collect(),
            _ => Vec::new(),
        }
    }

    fn routed_ports(&self) -> Vec<WebPort> {
        self.world()
            .get_resource::<WebServerManager>()
            .map(|manager| manager.ports())
            .unwrap_or_default()
    }

    fn server_count(&self) -> usize {
        self.world()
            .get_resource::<WebServerManager>()
            .map(|manager| manager.len())
            .unwrap_or(0)
    }
}

/// Turns a Bevy App into a web server application with routing capabilities.
/// This is legacy of older versions of Bevy Web Server, which used a single-port model.
///
/// This trait provides basic routing functionality for single-port web servers.
/// For multi-port capabilities, use `WebServerAppExt`.
///
/// # Examples
///
/// ```rust
/// use bevy::prelude::*;
/// use bevy_webgate::{RouterAppExt, BevyWebServerPlugin};
/// use axum::routing::get;
///
/// let mut app = App::new();
/// app.add_plugins(MinimalPlugins)
///    .add_plugins(BevyWebServerPlugin);
///
/// // Simple single-port usage
/// app.route("/", get(|| async { "Hello World" }))
///    .route("/api", get(|| async { "API" }));
/// ```
pub trait RouterAppExt {
    fn router(&mut self, router_fn: impl FnOnce(Router) -> Router);
    fn route(&mut self, path: &str, method_router: MethodRouter<()>) -> &mut Self;
    fn route_service<T>(&mut self, path: &str, service: T) -> &mut Self
    where
        T: Service<axum::extract::Request, Error = Infallible> + Clone + Send + Sync + 'static,
        T::Response: IntoResponse,
        T::Future: Send + 'static;
    fn nest(&mut self, path: &str, router2: Router<()>) -> &mut Self;
    fn nest_service<T>(&mut self, path: &str, service: T) -> &mut Self
    where
        T: Service<axum::extract::Request, Error = Infallible> + Clone + Send + Sync + 'static,
        T::Response: IntoResponse,
        T::Future: Send + 'static;
    fn merge<R>(&mut self, other: R) -> &mut Self
    where
        R: Into<Router<()>>;
    fn layer<L>(&mut self, layer: L) -> &mut Self
    where
        L: Layer<Route> + Clone + Send + Sync + 'static,
        L::Service: Service<axum::extract::Request> + Clone + Send + Sync + 'static,
        <L::Service as Service<axum::extract::Request>>::Response: IntoResponse + 'static,
        <L::Service as Service<axum::extract::Request>>::Error: Into<Infallible> + 'static,
        <L::Service as Service<axum::extract::Request>>::Future: Send + 'static;
    fn route_layer<L>(&mut self, layer: L) -> &mut Self
    where
        L: Layer<Route> + Clone + Send + Sync + 'static,
        L::Service: Service<axum::extract::Request> + Clone + Send + Sync + 'static,
        <L::Service as Service<axum::extract::Request>>::Response: IntoResponse + 'static,
        <L::Service as Service<axum::extract::Request>>::Error: Into<Infallible> + 'static,
        <L::Service as Service<axum::extract::Request>>::Future: Send + 'static;
    fn fallback<H, T>(&mut self, handler: H) -> &mut Self
    where
        H: Handler<T, ()>,
        T: 'static;
    fn fallback_service<T>(&mut self, service: T) -> &mut Self
    where
        T: Service<axum::extract::Request, Error = Infallible> + Clone + Send + Sync + 'static,
        T::Response: IntoResponse,
        T::Future: Send + 'static;
    fn method_not_allowed_fallback<H, T>(&mut self, handler: H) -> &mut Self
    where
        H: Handler<T, ()>,
        T: 'static;
}

impl RouterAppExt for App {
    fn router(&mut self, router_fn: impl FnOnce(Router) -> Router) {
        self.world_mut().init_resource::<WebServerManager>();
        if !self.is_plugin_added::<BevyWebServerPlugin>() {
            self.add_plugins(BevyWebServerPlugin);
        }

        self.world_mut()
            .resource_scope(|world, mut manager: Mut<WebServerManager>| {
                let (default_ip, default_port) = world
                    .get_resource::<WebServerConfig>()
                    .map_or((DEFAULT_IP, DEFAULT_PORT), |config| {
                        (config.ip, config.port)
                    });
                if !manager.has_server(&default_port) {
                    let _ =
                        manager.add_server(WebServer::new(default_ip, default_port, Router::new()));
                }

                let existing_router = manager
                    .get_server(&default_port)
                    .map(|srv| srv.router().clone())
                    .unwrap_or_else(|| Router::new());

                let new_router = router_fn(existing_router);
                manager.set_router(&default_port, new_router);
            });
    }

    fn route(&mut self, path: &str, method_router: MethodRouter<()>) -> &mut Self {
        self.router(|router| router.route(path, method_router));
        self
    }

    fn route_service<T>(&mut self, path: &str, service: T) -> &mut Self
    where
        T: Service<axum::extract::Request, Error = Infallible> + Clone + Send + Sync + 'static,
        T::Response: IntoResponse,
        T::Future: Send + 'static,
    {
        self.router(|r| r.route_service(path, service));
        self
    }

    fn nest(&mut self, path: &str, router2: Router<()>) -> &mut Self {
        self.router(|r| r.nest(path, router2));
        self
    }

    fn nest_service<T>(&mut self, path: &str, service: T) -> &mut Self
    where
        T: Service<axum::extract::Request, Error = Infallible> + Clone + Send + Sync + 'static,
        T::Response: IntoResponse,
        T::Future: Send + 'static,
    {
        self.router(|r| r.nest_service(path, service));
        self
    }

    fn merge<R>(&mut self, other: R) -> &mut Self
    where
        R: Into<Router<()>>,
    {
        self.router(|r| r.merge(other));
        self
    }

    fn layer<L>(&mut self, layer: L) -> &mut Self
    where
        L: Layer<Route> + Clone + Send + Sync + 'static,
        L::Service: Service<axum::extract::Request> + Clone + Send + Sync + 'static,
        <L::Service as Service<axum::extract::Request>>::Response: IntoResponse + 'static,
        <L::Service as Service<axum::extract::Request>>::Error: Into<Infallible> + 'static,
        <L::Service as Service<axum::extract::Request>>::Future: Send + 'static,
    {
        self.router(|r| r.layer(layer));
        self
    }

    fn route_layer<L>(&mut self, layer: L) -> &mut Self
    where
        L: Layer<Route> + Clone + Send + Sync + 'static,
        L::Service: Service<axum::extract::Request> + Clone + Send + Sync + 'static,
        <L::Service as Service<axum::extract::Request>>::Response: IntoResponse + 'static,
        <L::Service as Service<axum::extract::Request>>::Error: Into<Infallible> + 'static,
        <L::Service as Service<axum::extract::Request>>::Future: Send + 'static,
    {
        self.router(|r| r.route_layer(layer));
        self
    }

    fn fallback<H, T>(&mut self, handler: H) -> &mut Self
    where
        H: Handler<T, ()>,
        T: 'static,
    {
        self.router(|r| r.fallback(handler));
        self
    }

    fn fallback_service<T>(&mut self, service: T) -> &mut Self
    where
        T: Service<axum::extract::Request, Error = Infallible> + Clone + Send + Sync + 'static,
        T::Response: IntoResponse,
        T::Future: Send + 'static,
    {
        self.router(|r| r.fallback_service(service));
        self
    }

    fn method_not_allowed_fallback<H, T>(&mut self, handler: H) -> &mut Self
    where
        H: Handler<T, ()>,
        T: 'static,
    {
        self.router(|r| r.method_not_allowed_fallback(handler));
        self
    }
}