aboutsummaryrefslogtreecommitdiff
path: root/jsonrpc/src/server/mod.rs
blob: ed027f592925cdecd91b7d5ce4456493afd9060d (plain)
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
pub mod builder;
pub mod channel;
pub mod pubsub_service;
mod response_queue;
pub mod service;

use std::{collections::HashMap, sync::Arc};

use log::{debug, error, info, trace, warn};

use karyon_core::{
    async_runtime::Executor,
    async_util::{select, Either, TaskGroup, TaskResult},
};

#[cfg(feature = "tls")]
use karyon_net::async_rustls::rustls;
#[cfg(feature = "tcp")]
use karyon_net::tcp::TcpConfig;
#[cfg(feature = "ws")]
use karyon_net::ws::ServerWsConfig;
use karyon_net::{Conn, Endpoint, Listener};

#[cfg(feature = "ws")]
use crate::codec::WsJsonCodec;
use crate::{codec::JsonCodec, message, Error, PubSubRPCService, RPCService, Result};

use channel::Channel;
use response_queue::ResponseQueue;

pub const INVALID_REQUEST_ERROR_MSG: &str = "Invalid request";
pub const FAILED_TO_PARSE_ERROR_MSG: &str = "Failed to parse";
pub const METHOD_NOT_FOUND_ERROR_MSG: &str = "Method not found";
pub const UNSUPPORTED_JSONRPC_VERSION: &str = "Unsupported jsonrpc version";

const CHANNEL_SUBSCRIPTION_BUFFER_SIZE: usize = 100;

struct NewRequest {
    srvc_name: String,
    method_name: String,
    msg: message::Request,
}

enum SanityCheckResult {
    NewReq(NewRequest),
    ErrRes(message::Response),
}

struct ServerConfig {
    endpoint: Endpoint,
    #[cfg(feature = "tcp")]
    tcp_config: TcpConfig,
    #[cfg(feature = "tls")]
    tls_config: Option<rustls::ServerConfig>,
    services: HashMap<String, Arc<dyn RPCService + 'static>>,
    pubsub_services: HashMap<String, Arc<dyn PubSubRPCService + 'static>>,
}

/// Represents an RPC server
pub struct Server {
    listener: Listener<serde_json::Value>,
    task_group: TaskGroup,
    config: ServerConfig,
}

impl Server {
    /// Starts the RPC server. This will spawn a new task for the main accept loop,
    /// which listens for incoming connections.
    pub fn start(self: &Arc<Self>) {
        // Handle the completion of the accept loop task
        let on_complete = {
            let this = self.clone();
            |result: TaskResult<Result<()>>| async move {
                if let TaskResult::Completed(Err(err)) = result {
                    error!("Main accept loop stopped: {err}");
                    this.shutdown().await;
                }
            }
        };

        // Spawns a new task for the main accept loop
        self.task_group.spawn(
            {
                let this = self.clone();
                async move {
                    loop {
                        match this.listener.accept().await {
                            Ok(conn) => {
                                if let Err(err) = this.handle_conn(conn).await {
                                    error!("Handle a new connection: {err}")
                                }
                            }
                            Err(err) => {
                                error!("Accept a new connection: {err}")
                            }
                        }
                    }
                }
            },
            on_complete,
        );
    }

    /// Returns the local endpoint.
    pub fn local_endpoint(&self) -> Result<Endpoint> {
        self.listener.local_endpoint().map_err(Error::from)
    }

    /// Shuts down the RPC server
    pub async fn shutdown(&self) {
        self.task_group.cancel().await;
    }

    /// Handles a new connection
    async fn handle_conn(self: &Arc<Self>, conn: Conn<serde_json::Value>) -> Result<()> {
        let endpoint: Option<Endpoint> = conn.peer_endpoint().ok();
        debug!("Handle a new connection {:?}", endpoint);

        let conn = Arc::new(conn);

        let (ch_tx, ch_rx) = async_channel::bounded(CHANNEL_SUBSCRIPTION_BUFFER_SIZE);
        // Create a new connection channel for managing subscriptions
        let channel = Channel::new(ch_tx);

        // Create a response queue
        let queue = ResponseQueue::new();

        let chan = channel.clone();
        let on_complete = |result: TaskResult<Result<()>>| async move {
            if let TaskResult::Completed(Err(err)) = result {
                debug!("Notification loop stopped: {err}");
            }
            // Close the connection channel
            chan.close();
        };

        // Start listening for new responses in the queue or new notifications
        self.task_group.spawn(
            {
                let conn = conn.clone();
                let queue = queue.clone();
                async move {
                    loop {
                        // The select function will prioritize the first future if both futures are ready.
                        // This gives priority to the responses in the response queue.
                        match select(queue.recv(), ch_rx.recv()).await {
                            Either::Left(res) => {
                                conn.send(res).await?;
                            }
                            Either::Right(notification) => {
                                let nt = notification?;
                                let params = Some(serde_json::json!(message::NotificationResult {
                                    subscription: nt.sub_id,
                                    result: Some(nt.result),
                                }));
                                let notification = message::Notification {
                                    jsonrpc: message::JSONRPC_VERSION.to_string(),
                                    method: nt.method,
                                    params,
                                };
                                debug!("--> {notification}");
                                conn.send(serde_json::json!(notification)).await?;
                            }
                        }
                    }
                }
            },
            on_complete,
        );

        let chan = channel.clone();
        let on_complete = |result: TaskResult<Result<()>>| async move {
            if let TaskResult::Completed(Err(err)) = result {
                error!("Connection {:?} dropped: {err}", endpoint);
            } else {
                warn!("Connection {:?} dropped", endpoint);
            }
            // Close the connection channel when the connection dropped
            chan.close();
        };

        // Spawn a new task and wait for new requests.
        self.task_group.spawn(
            {
                let this = self.clone();
                async move {
                    loop {
                        let msg = conn.recv().await?;
                        this.new_request(queue.clone(), channel.clone(), msg).await;
                    }
                }
            },
            on_complete,
        );

        Ok(())
    }

    fn sanity_check(&self, request: serde_json::Value) -> SanityCheckResult {
        let rpc_msg = match serde_json::from_value::<message::Request>(request) {
            Ok(m) => m,
            Err(_) => {
                let response = message::Response {
                    error: Some(message::Error {
                        code: message::PARSE_ERROR_CODE,
                        message: FAILED_TO_PARSE_ERROR_MSG.to_string(),
                        data: None,
                    }),
                    ..Default::default()
                };
                return SanityCheckResult::ErrRes(response);
            }
        };

        if rpc_msg.jsonrpc != message::JSONRPC_VERSION {
            let response = message::Response {
                error: Some(message::Error {
                    code: message::INVALID_REQUEST_ERROR_CODE,
                    message: UNSUPPORTED_JSONRPC_VERSION.to_string(),
                    data: None,
                }),
                id: Some(rpc_msg.id),
                ..Default::default()
            };
            return SanityCheckResult::ErrRes(response);
        }

        debug!("<-- {rpc_msg}");

        // Parse the service name and its method
        let srvc_method_str = rpc_msg.method.clone();
        let srvc_method: Vec<&str> = srvc_method_str.split('.').collect();
        if srvc_method.len() < 2 {
            let response = message::Response {
                error: Some(message::Error {
                    code: message::INVALID_REQUEST_ERROR_CODE,
                    message: INVALID_REQUEST_ERROR_MSG.to_string(),
                    data: None,
                }),
                id: Some(rpc_msg.id),
                ..Default::default()
            };
            return SanityCheckResult::ErrRes(response);
        }

        let srvc_name = srvc_method[0].to_string();
        let method_name = srvc_method[1].to_string();

        SanityCheckResult::NewReq(NewRequest {
            srvc_name,
            method_name,
            msg: rpc_msg,
        })
    }

    /// Spawns a new task for handling the new request
    async fn new_request(
        self: &Arc<Self>,
        queue: Arc<ResponseQueue<serde_json::Value>>,
        channel: Arc<Channel>,
        msg: serde_json::Value,
    ) {
        trace!("--> new request {msg}");
        let on_complete = |result: TaskResult<Result<()>>| async move {
            if let TaskResult::Completed(Err(err)) = result {
                error!("Handle a new request: {err}");
            }
        };

        // Spawns a new task for handling the new request, and push the
        // response to the response queue.
        self.task_group.spawn(
            {
                let this = self.clone();
                async move {
                    let response = this.handle_request(channel, msg).await;
                    debug!("--> {response}");
                    queue.push(serde_json::json!(response)).await;
                    Ok(())
                }
            },
            on_complete,
        );
    }

    /// Handles the new request, and returns an RPC Response that has either
    /// an error or result
    async fn handle_request(
        &self,
        channel: Arc<Channel>,
        msg: serde_json::Value,
    ) -> message::Response {
        let req = match self.sanity_check(msg) {
            SanityCheckResult::NewReq(req) => req,
            SanityCheckResult::ErrRes(res) => return res,
        };

        let mut response = message::Response {
            error: None,
            result: None,
            id: Some(req.msg.id.clone()),
            ..Default::default()
        };

        // Check if the service exists in pubsub services list
        if let Some(service) = self.config.pubsub_services.get(&req.srvc_name) {
            // Check if the method exists within the service
            if let Some(method) = service.get_pubsub_method(&req.method_name) {
                let params = req.msg.params.unwrap_or(serde_json::json!(()));
                let result = method(channel, req.msg.method, params);
                response.result = match result.await {
                    Ok(res) => Some(res),
                    Err(err) => return err.to_response(Some(req.msg.id), None),
                };

                return response;
            }
        }

        // Check if the service exists in services list
        if let Some(service) = self.config.services.get(&req.srvc_name) {
            // Check if the method exists within the service
            if let Some(method) = service.get_method(&req.method_name) {
                let params = req.msg.params.unwrap_or(serde_json::json!(()));
                let result = method(params);
                response.result = match result.await {
                    Ok(res) => Some(res),
                    Err(err) => return err.to_response(Some(req.msg.id), None),
                };

                return response;
            }
        }

        response.error = Some(message::Error {
            code: message::METHOD_NOT_FOUND_ERROR_CODE,
            message: METHOD_NOT_FOUND_ERROR_MSG.to_string(),
            data: None,
        });

        response
    }

    /// Initializes a new [`Server`] from the provided [`ServerConfig`]
    async fn init(config: ServerConfig, ex: Option<Executor>) -> Result<Arc<Self>> {
        let task_group = match ex {
            Some(ex) => TaskGroup::with_executor(ex),
            None => TaskGroup::new(),
        };
        let listener = Self::listen(&config).await?;
        info!("RPC server listens to the endpoint: {}", config.endpoint);

        let server = Arc::new(Server {
            listener,
            task_group,
            config,
        });

        Ok(server)
    }

    async fn listen(config: &ServerConfig) -> Result<Listener<serde_json::Value>> {
        let endpoint = config.endpoint.clone();
        let listener: Listener<serde_json::Value> = match endpoint {
            #[cfg(feature = "tcp")]
            Endpoint::Tcp(..) => Box::new(
                karyon_net::tcp::listen(&endpoint, config.tcp_config.clone(), JsonCodec {}).await?,
            ),
            #[cfg(feature = "tls")]
            Endpoint::Tls(..) => match &config.tls_config {
                Some(conf) => Box::new(
                    karyon_net::tls::listen(
                        &endpoint,
                        karyon_net::tls::ServerTlsConfig {
                            server_config: conf.clone(),
                            tcp_config: config.tcp_config.clone(),
                        },
                        JsonCodec {},
                    )
                    .await?,
                ),
                None => return Err(Error::TLSConfigRequired),
            },
            #[cfg(feature = "ws")]
            Endpoint::Ws(..) => {
                let config = ServerWsConfig {
                    tcp_config: config.tcp_config.clone(),
                    wss_config: None,
                };
                Box::new(karyon_net::ws::listen(&endpoint, config, WsJsonCodec {}).await?)
            }
            #[cfg(all(feature = "ws", feature = "tls"))]
            Endpoint::Wss(..) => match &config.tls_config {
                Some(conf) => Box::new(
                    karyon_net::ws::listen(
                        &endpoint,
                        ServerWsConfig {
                            tcp_config: config.tcp_config.clone(),
                            wss_config: Some(karyon_net::ws::ServerWssConfig {
                                server_config: conf.clone(),
                            }),
                        },
                        WsJsonCodec {},
                    )
                    .await?,
                ),
                None => return Err(Error::TLSConfigRequired),
            },
            #[cfg(all(feature = "unix", target_family = "unix"))]
            Endpoint::Unix(..) => Box::new(karyon_net::unix::listen(
                &endpoint,
                Default::default(),
                JsonCodec {},
            )?),

            _ => return Err(Error::UnsupportedProtocol(endpoint.to_string())),
        };

        Ok(listener)
    }
}