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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
#![allow(non_upper_case_globals)]
#![allow(non_snake_case)]
#![allow(non_camel_case_types)]
#[macro_use] extern crate log;
extern crate serde_json;
extern crate serde;
extern crate rustdt_util as util;
pub extern crate futures;
pub mod json_util;
pub mod jsonrpc_common;
pub mod jsonrpc_message;
pub mod jsonrpc_request;
pub mod jsonrpc_response;
pub mod method_types;
pub mod service_util;
pub mod output_agent;
use util::core::*;
use std::collections::HashMap;
use std::result::Result;
use std::sync::Arc;
use std::sync::Mutex;
use futures::Future;
use futures::BoxFuture;
use futures::Complete;
use service_util::MessageReader;
use service_util::MessageWriter;
use jsonrpc_common::*;
use jsonrpc_message::*;
use jsonrpc_request::*;
use jsonrpc_response::*;
use method_types::*;
use output_agent::OutputAgent;
use output_agent::OutputAgentTask;
#[derive(Clone)]
pub struct Endpoint {
id_counter : Arc<Mutex<u64>>,
pending_requests : Arc<Mutex<HashMap<Id, Complete<ResponseResult>>>>,
output_agent : Arc<Mutex<OutputAgent>>,
}
impl Endpoint {
pub fn start_with(output_agent: OutputAgent)
-> Endpoint
{
Endpoint {
id_counter : newArcMutex(0),
pending_requests : newArcMutex(HashMap::new()),
output_agent : newArcMutex(output_agent)
}
}
pub fn is_shutdown(& self) -> bool {
self.output_agent.lock().unwrap().is_shutdown()
}
pub fn request_shutdown(&self) {
self.output_agent.lock().unwrap().request_shutdown();
}
pub fn shutdown_and_join(&self) {
self.output_agent.lock().unwrap().shutdown_and_join();
}
pub fn next_id(&self) -> Id {
let id_num : &mut u64 = &mut *self.id_counter.lock().unwrap();
*id_num += 1;
Id::Number(*id_num)
}
}
pub struct EndpointHandler {
pub endpoint : Endpoint,
pub request_handler : Box<RequestHandler>,
}
impl EndpointHandler {
pub fn create_with_writer<WRITER>(msg_writer: WRITER, request_handler: Box<RequestHandler>)
-> EndpointHandler
where
WRITER : MessageWriter + 'static + Send,
{
let output_agent = OutputAgent::start_with_provider(|| msg_writer);
Self::create_with_output_agent(output_agent, request_handler)
}
pub fn create_with_output_agent(output_agent: OutputAgent, request_handler: Box<RequestHandler>)
-> EndpointHandler
{
let output = Endpoint::start_with(output_agent);
Self::create(output, request_handler)
}
pub fn create(endpoint: Endpoint, request_handler: Box<RequestHandler>)
-> EndpointHandler
{
EndpointHandler { endpoint : endpoint, request_handler: request_handler }
}
pub fn run_message_read_loop<MSG_READER : ?Sized>(mut self, input: &mut MSG_READER)
-> GResult<()>
where
MSG_READER : MessageReader
{
loop {
let message = match input.read_next() {
Ok(ok) => { ok }
Err(error) => {
self.endpoint.request_shutdown();
return Err(error);
}
};
self.handle_incoming_message(&message);
if self.endpoint.is_shutdown() {
return Ok(())
}
}
}
pub fn handle_incoming_message(&mut self, message_json: &str) {
let message = serde_json::from_str::<Message>(message_json);
match message {
Ok(message) => {
match message {
Message::Request(request) => self.handle_incoming_request(request),
Message::Response(response) => self.endpoint.handle_incoming_response(response),
}
}
Err(error) => {
let error = error_JSON_RPC_InvalidRequest(error);
submit_error_write_task(&self.endpoint.output_agent, error);
}
}
}
pub fn handle_incoming_request(&mut self, request: Request) {
let output_agent = self.endpoint.output_agent.clone();
let on_response = new(move |response: Option<Response>| {
if let Some(response) = response {
submit_message_write_task(&output_agent, response.into());
} else {
let method_name = "";
info!("JSON-RPC notification complete. {:?}", method_name);
}
});
let completable = ResponseCompletable::new(request.id, on_response);
self.request_handler.handle_request(&request.method, request.params, completable);
}
}
pub trait RequestHandler {
fn handle_request(
&mut self, method_name: &str, request_params: RequestParams, completable: ResponseCompletable
);
}
pub struct NullRequestHandler;
impl RequestHandler for NullRequestHandler {
fn handle_request(
&mut self, _request_method: &str, _request_params: RequestParams, completable: ResponseCompletable
) {
completable.complete_with_error(error_JSON_RPC_MethodNotFound());
}
}
pub struct ResponseCompletable {
completion_flag: FinishedFlag,
id: Option<Id>,
on_response: Box<FnMut(Option<Response>) + Send>,
}
impl ResponseCompletable {
pub fn new(id: Option<Id>, on_response: Box<FnMut(Option<Response>) + Send>) -> ResponseCompletable {
ResponseCompletable {
completion_flag : FinishedFlag(false), id : id, on_response: on_response
}
}
pub fn complete(mut self, response_result: Option<ResponseResult>) {
self.completion_flag.finish();
if let Some(response_result) = response_result {
let response =
if let Some(id) = self.id {
Response{ id : id, result_or_error : response_result }
} else {
Response::new_error(Id::Null,
error_JSON_RPC_InvalidRequest("Property `id` not provided for request."))
};
(self.on_response)(Some(response));
} else {
(self.on_response)(None)
}
}
pub fn complete_with_error(self, error: RequestError) {
self.complete(Some(ResponseResult::Error(error)));
}
pub fn handle_request_with<PARAMS, RET, RET_ERROR, METHOD>(
self, params: RequestParams, method_handler: METHOD
)
where
PARAMS : serde::Deserialize,
RET : serde::Serialize,
RET_ERROR : serde::Serialize,
METHOD : FnOnce(PARAMS, MethodCompletable<RET, RET_ERROR>),
{
let mc = MethodCompletable::<RET, RET_ERROR>::new(self);
mc.parse_params_and_complete_with(params, method_handler);
}
pub fn sync_handle_request<PARAMS, RET, RET_ERROR, METHOD>(
self, params: RequestParams, sync_method_handler: METHOD
)
where
PARAMS : serde::Deserialize,
RET : serde::Serialize,
RET_ERROR : serde::Serialize ,
METHOD : FnOnce(PARAMS) -> MethodResult<RET, RET_ERROR>,
{
self.handle_request_with(params, |params, completable| {
let result = sync_method_handler(params);
completable.complete(result);
})
}
pub fn handle_notification_with<PARAMS, METHOD>(
self, params: RequestParams, method_handler: METHOD
)
where
PARAMS : serde::Deserialize,
METHOD : FnOnce(PARAMS),
{
let mc = MethodCompletable::<(), ()>::new(self);
mc.parse_params_and_complete_with(params, |params, completable| {
completable.completable.complete(None);
method_handler(params)
});
}
pub fn sync_handle_notification<PARAMS, METHOD>(
self, params: RequestParams, sync_method_handler: METHOD
)
where
PARAMS : serde::Deserialize,
METHOD : FnOnce(PARAMS),
{
self.handle_notification_with(params, |params| {
sync_method_handler(params);
})
}
}
use std::marker::PhantomData;
pub struct MethodCompletable
<
RET : serde::Serialize,
RET_ERROR : serde::Serialize,
>
{
completable: ResponseCompletable,
p1: PhantomData<RET>,
p2: PhantomData<RET_ERROR>,
}
impl<
RET : serde::Serialize,
RET_ERROR : serde::Serialize,
>
MethodCompletable<RET, RET_ERROR>
{
pub fn new(completable: ResponseCompletable) -> MethodCompletable<RET, RET_ERROR> {
MethodCompletable { completable : completable, p1 : PhantomData, p2 : PhantomData}
}
pub fn parse_params_and_complete_with<PARAMS, METHOD>(
self,
params: RequestParams,
method_fn: METHOD
)
where
PARAMS : serde::Deserialize,
RET : serde::Serialize,
RET_ERROR : serde::Serialize,
METHOD : FnOnce(PARAMS, Self),
{
let params_value = params.into_value();
let params_result : Result<PARAMS, _> = serde_json::from_value(params_value);
match params_result {
Ok(params) => {
method_fn(params, self);
}
Err(error) => {
self.completable.complete_with_error(error_JSON_RPC_InvalidParams(error));
}
}
}
pub fn complete(self, result: MethodResult<RET, RET_ERROR>) {
self.completable.complete(Some(ResponseResult::from(result)));
}
}
pub fn submit_message_write_task(output_agent: &Arc<Mutex<OutputAgent>>, jsonrpc_message: Message) {
let write_task : OutputAgentTask = Box::new(move |mut response_handler| {
info!("JSON-RPC message: {:?}", jsonrpc_message);
let response_str = serde_json::to_string(&jsonrpc_message).unwrap_or_else(|error| -> String {
panic!("Failed to serialize to JSON object: {}", error);
});
let write_res = response_handler.write_message(&response_str);
if let Err(error) = write_res {
error!("Error writing JSON-RPC message: {}", error);
};
});
let res = {
output_agent.lock().unwrap().try_submit_task(write_task)
};
res.expect("Output agent is shutdown or thread panicked!");
}
pub fn submit_error_write_task(output_agent: &Arc<Mutex<OutputAgent>>, error: RequestError) {
let id = Id::Null;
let response = Response::new_error(id, error);
submit_message_write_task(output_agent, response.into());
}
pub type RequestFuture<RET, RET_ERROR> = BoxFuture<RequestResult<RET, RET_ERROR>, futures::Canceled>;
impl Endpoint {
pub fn send_request<
PARAMS : serde::Serialize,
RET: serde::Deserialize,
RET_ERROR : serde::Deserialize,
>(&mut self, method_name: &str, params: PARAMS)
-> GResult<RequestFuture<RET, RET_ERROR>>
{
let (completable, future) = futures::oneshot::<ResponseResult>();
let future : futures::Oneshot<ResponseResult> = future;
let id = self.next_id();
self.pending_requests.lock().unwrap().insert(id.clone(), completable);
self.write_request(Some(id), method_name, params)?;
let future = future.map(|response_result : ResponseResult| {
RequestResult::<RET, RET_ERROR>::from(response_result)
});
Ok(new(future))
}
pub fn send_notification<
PARAMS : serde::Serialize,
>(&self, method_name: &str, params: PARAMS)
-> GResult<()>
{
let id = None;
self.write_request::<_>(id, method_name, params)
}
pub fn write_request<
PARAMS : serde::Serialize,
>(&self, id: Option<Id>, method_name: &str, params: PARAMS)
-> GResult<()>
{
let params_value = serde_json::to_value(¶ms);
let params = jsonrpc_request::to_jsonrpc_params(params_value)?;
let rpc_request = Request { id: id.clone(), method : method_name.into(), params : params };
submit_message_write_task(&self.output_agent, Message::Request(rpc_request));
Ok(())
}
pub fn handle_incoming_response(&mut self, response: Response) {
let id = response.id;
let result_or_error = response.result_or_error;
let entry = self.pending_requests.lock().unwrap().remove(&id);
match entry {
Some(entry) => {
entry.complete(result_or_error)
}
None => {
let id = Id::Null;
let error = error_JSON_RPC_InvalidResponse(format!("id `{}` not found", id));
submit_error_write_task(&self.output_agent, error);
}
}
}
}
pub mod map_request_handler;
mod tests_sample_types;
#[cfg(test)]
mod tests_ {
use super::*;
use util::core::*;
use util::tests::*;
use tests_sample_types::*;
use map_request_handler::MapRequestHandler;
use std::thread;
use serde_json::Value;
use serde_json;
use jsonrpc_common::*;
use jsonrpc_response::*;
use jsonrpc_request::*;
use jsonrpc_request::request_tests::check_error;
use method_types::*;
use json_util::JsonObject;
use json_util::test_util::to_json;
use service_util::WriteLineMessageWriter;
use futures::task::Unpark;
use futures::Async;
use std::sync::Arc;
pub fn sample_fn(params: Point) -> MethodResult<String, ()> {
let x_str : String = params.x.to_string();
let y_str : String = params.y.to_string();
Ok(x_str + &y_str)
}
pub fn no_params_method(_params: ()) -> Result<String, MethodError<()>> {
Ok("okay".into())
}
pub fn check_request(result: ResponseResult, expected: ResponseResult) {
if let ResponseResult::Error(ref error) = result {
if let ResponseResult::Error(expected_error) = expected {
check_error(error.clone(), expected_error.clone());
return;
}
}
assert_equal(&result, &expected);
}
pub fn async_method(request_params: RequestParams, completable: ResponseCompletable) {
thread::spawn(move || {
completable.sync_handle_request(request_params, sample_fn);
});
}
fn invoke_method<FN>(
req_handler: &mut RequestHandler,
method_name: &str,
request_params: RequestParams,
mut and_then: FN
)
where
FN : FnMut(Option<ResponseResult>) + 'static + Send
{
let on_response : Box<FnMut(Option<Response>) + Send> = new(move |response: Option<Response>| {
and_then(response.and_then(|e| Some(e.result_or_error)));
});
let completable = ResponseCompletable::new(Some(Id::Number(123)), on_response);
req_handler.handle_request(method_name, request_params, completable);
}
#[test]
fn test_Endpoint() {
{
let mut request_handler = MapRequestHandler::new();
let request = Request::new(1, "unknown_method".to_string(), JsonObject::new());
invoke_method(&mut request_handler, &request.method, request.params,
|result|
check_request(result.unwrap(), ResponseResult::Error(error_JSON_RPC_MethodNotFound()))
);
}
let mut request_handler = MapRequestHandler::new();
request_handler.add_request("sample_fn", Box::new(sample_fn));
request_handler.add_rpc_handler("async_method", Box::new(async_method));
let request = Request::new(1, "sample_fn".to_string(), JsonObject::new());
invoke_method(&mut request_handler, &request.method, request.params,
|result|
check_request(result.unwrap(), ResponseResult::Error(error_JSON_RPC_InvalidParams(r#"missing field "x""#)))
);
let params_value = match serde_json::to_value(&new_sample_params(10, 20)) {
Value::Object(object) => object,
_ => panic!("Not serialized into Object")
};
let request = Request::new(1, "sample_fn".to_string(), params_value);
invoke_method(&mut request_handler, &request.method, request.params.clone(),
|result|
assert_equal(result.unwrap(), ResponseResult::Result(
Value::String("1020".to_string())
))
);
request_handler.add_request("no_params_method", Box::new(no_params_method));
let id1 = Some(Id::Number(1));
let request = Request { id : id1, method : "no_params_method".into(), params : RequestParams::None, };
invoke_method(&mut request_handler, &request.method, request.params.clone(),
|result|
assert_equal(result.unwrap(), ResponseResult::Result(
Value::String("okay".to_string())
))
);
let output = vec![];
let mut eh = EndpointHandler::create_with_writer(WriteLineMessageWriter(output), new(request_handler));
let completable = ResponseCompletable::new(None, new(|_| {}));
completable.complete(None);
let completable = ResponseCompletable::new(None, new(|_| {}));
completable.complete(Some(ResponseResult::Result(Value::String("1020".to_string()))));
let request = Request {
id : None,
method : "sample_fn".into(),
params : request.params.clone(),
};
eh.handle_incoming_request(request);
let params = new_sample_params(123, 66);
eh.endpoint.send_notification("sample_fn", params.clone()).unwrap();
eh.endpoint.send_notification("async_method", params.clone()).unwrap();
assert_eq!(*eh.endpoint.id_counter.lock().unwrap(), 0);
let my_method = "sample_fn".to_string();
let future : RequestFuture<String, ()> = eh.endpoint.send_request(&my_method, params.clone()).unwrap();
assert_eq!(*eh.endpoint.id_counter.lock().unwrap(), 1);
let mut spawn = futures::task::spawn(future);
let poll = spawn.poll_future(noop_unpark());
assert_eq!(poll, Ok(Async::NotReady));
let expected_result = "sample_fn result".to_string();
let id = Id::Number(1);
let response = Response::new_result(id, Value::String(expected_result.clone()));
eh.handle_incoming_message(&to_json(&response));
let result : Result<RequestResult<String, ()>, _> = spawn.wait_future();
assert_eq!(result.unwrap(), RequestResult::MethodResult(Ok(expected_result)));
eh.endpoint.request_shutdown();
}
pub fn noop_unpark() -> Arc<Unpark> {
struct Foo;
impl Unpark for Foo {
fn unpark(&self) {}
}
Arc::new(Foo)
}
}