medea 0.2.0

Medea media server
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

//! Settings for application servers.

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

use derive_more::{Display, From};
use serde::{Deserialize, Serialize};
use smart_default::SmartDefault;

/// [Client API] servers settings.
///
/// [Client API]: https://tinyurl.com/yx9thsnr
#[derive(Clone, Debug, Deserialize, Serialize, SmartDefault)]
#[serde(default)]
pub struct ClientApiServer {
    /// [Client API] HTTP server settings.
    ///
    /// [Client API]: https://tinyurl.com/yx9thsnr
    pub http: ClientApiHttpServer,
}

/// [Client API] HTTP server settings.
///
/// [Client API]: https://tinyurl.com/yx9thsnr
#[derive(Clone, Debug, Deserialize, Serialize, SmartDefault)]
#[serde(default)]
pub struct ClientApiHttpServer {
    /// Public URL of HTTP server. Address for exposed [Client API].
    /// It's assumed that HTTP server can be reached via this URL externally.
    ///
    /// This address is returned from [Control API] in `sids` field
    /// and [Jason] uses this address to start its session.
    ///
    /// Defaults to `ws://127.0.0.1:8080/ws`.
    ///
    /// [Client API]: https://tinyurl.com/yx9thsnr
    /// [Control API]: https://tinyurl.com/yxsqplq7
    /// [Jason]: https://github.com/instrumentisto/medea/tree/master/jason
    #[default(PublicUrl("ws://127.0.0.1:8080/ws".into()))]
    pub public_url: PublicUrl,

    /// IP address to bind HTTP server to.
    ///
    /// Defaults to `0.0.0.0`.
    #[default(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)))]
    pub bind_ip: IpAddr,

    /// Port to bind HTTP server to.
    ///
    /// Defaults to `8080`.
    #[default = 8080]
    pub bind_port: u16,
}

impl ClientApiHttpServer {
    /// Builds a [`SocketAddr`] from `bind_ip` and `bind_port`.
    #[inline]
    #[must_use]
    pub fn bind_addr(&self) -> SocketAddr {
        (self.bind_ip, self.bind_port).into()
    }
}

/// Public URL of HTTP server. Address for exposed [Client API].
/// It's assumed that HTTP server can be reached via this URL externally.
///
/// This address is returned from [Control API] in `sids` field and [Jason] uses
/// this address to start its session.
///
/// [Client API]: https://tinyurl.com/yx9thsnr
/// [Control API]: https://tinyurl.com/yxsqplq7
/// [Jason]: https://github.com/instrumentisto/medea/tree/master/jason
#[derive(Clone, Debug, Display, Deserialize, Serialize, From)]
pub struct PublicUrl(pub String);

/// [Control API] servers settings.
///
/// [Control API]: https://tinyurl.com/yxsqplq7
#[derive(Clone, Debug, Deserialize, Serialize, SmartDefault)]
#[serde(default)]
pub struct ControlApiServer {
    /// [Control API] gRPC server settings.
    ///
    /// [Control API]: https://tinyurl.com/yxsqplq7
    pub grpc: ControlApiGrpcServer,
}

/// [Control API] gRPC server settings.
///
/// [Control API]: https://tinyurl.com/yxsqplq7
#[derive(Clone, Debug, Deserialize, Serialize, SmartDefault)]
#[serde(default)]
pub struct ControlApiGrpcServer {
    /// IP address to bind gRPC server to.
    ///
    /// Defaults to `0.0.0.0`.
    #[default(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)))]
    pub bind_ip: IpAddr,

    /// Port to bind gRPC server to.
    ///
    /// Defaults to `6565`.
    #[default = 6565]
    pub bind_port: u16,
}

/// Settings for application servers.
#[derive(Clone, Debug, Deserialize, Serialize, SmartDefault)]
#[serde(default)]
pub struct Server {
    /// [Client API] servers settings.
    ///
    /// [Client API]: https://tinyurl.com/yx9thsnr
    pub client: ClientApiServer,

    /// [Control API] servers settings.
    ///
    /// [Control API]: https://tinyurl.com/yxsqplq7
    pub control: ControlApiServer,
}

#[cfg(test)]
mod client_http_spec {
    use std::net::Ipv4Addr;

    use serial_test::serial;

    use crate::{conf::Conf, overrided_by_env_conf};

    #[test]
    #[serial]
    fn overrides_defaults_and_gets_bind_addr() {
        let default_conf = Conf::default();

        let env_conf = overrided_by_env_conf!(
            "MEDEA_SERVER__CLIENT__HTTP__BIND_IP" => "5.5.5.5",
            "MEDEA_SERVER__CLIENT__HTTP__BIND_PORT" => "1234",
        );

        assert_ne!(
            default_conf.server.client.http.bind_ip,
            env_conf.server.client.http.bind_ip
        );
        assert_ne!(
            default_conf.server.client.http.bind_port,
            env_conf.server.client.http.bind_port
        );

        assert_eq!(
            env_conf.server.client.http.bind_ip,
            Ipv4Addr::new(5, 5, 5, 5)
        );
        assert_eq!(env_conf.server.client.http.bind_port, 1234);
        assert_eq!(
            env_conf.server.client.http.bind_addr(),
            "5.5.5.5:1234".parse().unwrap(),
        );
    }
}

#[cfg(test)]
mod control_grpc_spec {
    use std::net::Ipv4Addr;

    use serial_test::serial;

    use crate::{conf::Conf, overrided_by_env_conf};

    #[test]
    #[serial]
    fn overrides_defaults() {
        let default_conf = Conf::default();
        let env_conf = overrided_by_env_conf!(
            "MEDEA_SERVER__CONTROL__GRPC__BIND_IP" => "182.98.12.48",
            "MEDEA_SERVER__CONTROL__GRPC__BIND_PORT" => "44444",
        );

        assert_ne!(
            default_conf.server.control.grpc.bind_ip,
            env_conf.server.control.grpc.bind_ip
        );
        assert_ne!(
            default_conf.server.control.grpc.bind_port,
            env_conf.server.control.grpc.bind_port
        );
        assert_eq!(env_conf.server.control.grpc.bind_port, 44444);
        assert_eq!(
            env_conf.server.control.grpc.bind_ip,
            Ipv4Addr::new(182, 98, 12, 48)
        );
    }
}