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
use crate::channel::ChannelOptions;
use crate::message::OutgoingMessage;
use crate::metrics::{HandlerMetrics, ServerMetrics};
use crate::server_side_channel::ServerSideChannel;
use crate::server_side_handlers::{
    Action, Assigner, CallHandlerFactory, CastHandlerFactory, HandleCall, HandleCast,
    MessageHandlers,
};
use crate::{Call, Cast, Error, ProcedureId};
use bytecodec::marker::Never;
use factory::{DefaultFactory, Factory};
use fibers::net::futures::{Connected, TcpListenerBind};
use fibers::net::streams::Incoming;
use fibers::net::TcpListener;
use fibers::sync::mpsc;
use fibers::{self, BoxSpawn, Spawn};
use futures::future::{loop_fn, Either, Loop};
use futures::{self, Async, Future, Poll, Stream};
use prometrics::metrics::MetricBuilder;
use slog::{Discard, Logger};
use std::collections::HashMap;
use std::mem;
use std::net::SocketAddr;

/// RPC server builder.
#[derive(Debug)]
pub struct ServerBuilder {
    bind_addr: SocketAddr,
    logger: Logger,
    handlers: MessageHandlers,
    channel_options: ChannelOptions,
    metrics: MetricBuilder,
    handlers_metrics: HashMap<ProcedureId, HandlerMetrics>,
}
impl ServerBuilder {
    /// Makes a new `ServerBuilder` instance.
    pub fn new(bind_addr: SocketAddr) -> Self {
        ServerBuilder {
            bind_addr,
            logger: Logger::root(Discard, o!()),
            handlers: MessageHandlers(HashMap::new()),
            channel_options: ChannelOptions::default(),
            metrics: MetricBuilder::new(),
            handlers_metrics: HashMap::new(),
        }
    }

    /// Sets the logger of the server.
    ///
    /// The default value is `Logger::root(Discard, o!())`.
    pub fn logger(&mut self, logger: Logger) -> &mut Self {
        self.logger = logger;
        self
    }

    /// Sets `ChannelOptions` used by the service.
    ///
    /// The default value is `ChannelOptions::default()`.
    pub fn channel_options(&mut self, options: ChannelOptions) -> &mut Self {
        self.channel_options = options;
        self
    }

    /// Sets `MetricBuilder` used by the service.
    ///
    /// The default value is `MetricBuilder::new()`.
    pub fn metrics(&mut self, builder: MetricBuilder) -> &mut Self {
        self.metrics = builder;
        self
    }

    /// Registers a handler for the request/response RPC.
    ///
    /// This equivalent to
    /// `add_call_handler_with_codec(handler, DefaultFactory::new(), DefaultFactory::new())`.
    ///
    /// # Panices
    ///
    /// If a procedure which has `T::ID` already have been registered, the calling thread will panic.
    pub fn add_call_handler<T, H>(&mut self, handler: H) -> &mut Self
    where
        T: Call,
        H: HandleCall<T>,
        T::ReqDecoder: Default,
        T::ResEncoder: Default,
    {
        self.add_call_handler_with_codec(handler, DefaultFactory::new(), DefaultFactory::new())
    }

    /// Registers a handler (with the given decoder maker) for the request/response RPC.
    ///
    /// This equivalent to `add_call_handler_with_codec(handler, decoder_factory, DefaultFactory::new())`.
    ///
    /// # Panices
    ///
    /// If a procedure which has `T::ID` already have been registered, the calling thread will panic.
    pub fn add_call_handler_with_decoder<T, H, D>(
        &mut self,
        handler: H,
        decoder_factory: D,
    ) -> &mut Self
    where
        T: Call,
        H: HandleCall<T>,
        D: Factory<Item = T::ReqDecoder> + Send + Sync + 'static,
        T::ResEncoder: Default,
    {
        self.add_call_handler_with_codec(handler, decoder_factory, DefaultFactory::new())
    }

    /// Registers a handler (with the given encoder maker) for the request/response RPC.
    ///
    /// This equivalent to
    /// `add_call_handler_with_codec(handler, DefaultFactory::new(), encoder_factory)`.
    ///
    /// # Panices
    ///
    /// If a procedure which has `T::ID` already have been registered,
    /// the calling thread will panic.
    pub fn add_call_handler_with_encoder<T, H, E>(
        &mut self,
        handler: H,
        encoder_factory: E,
    ) -> &mut Self
    where
        T: Call,
        H: HandleCall<T>,
        E: Factory<Item = T::ResEncoder> + Send + Sync + 'static,
        T::ReqDecoder: Default,
    {
        self.add_call_handler_with_codec(handler, DefaultFactory::new(), encoder_factory)
    }

    /// Registers a handler (with the given decoder/encoder makers) for the request/response RPC.
    ///
    /// # Panices
    ///
    /// If a procedure which has `T::ID` already have been registered, the calling thread will panic.
    pub fn add_call_handler_with_codec<T, H, D, E>(
        &mut self,
        handler: H,
        decoder_factory: D,
        encoder_factory: E,
    ) -> &mut Self
    where
        T: Call,
        H: HandleCall<T>,
        D: Factory<Item = T::ReqDecoder> + Send + Sync + 'static,
        E: Factory<Item = T::ResEncoder> + Send + Sync + 'static,
    {
        assert!(
            !self.handlers.0.contains_key(&T::ID),
            "RPC registration conflicts: procedure={:?}, name={:?}",
            T::ID,
            T::NAME
        );

        let metrics = HandlerMetrics::new(self.metrics.clone(), T::ID, T::NAME, "call");
        self.handlers_metrics.insert(T::ID, metrics.clone());

        let handler = CallHandlerFactory::new(handler, decoder_factory, encoder_factory, metrics);
        self.handlers.0.insert(T::ID, Box::new(handler));
        self
    }

    /// Registers a handler for the notification RPC.
    ///
    /// This equivalent to `add_cast_handler_with_encoder(handler, DefaultFactory::new())`.
    ///
    /// # Panices
    ///
    /// If a procedure which has `T::ID` already have been registered, the calling thread will panic.
    pub fn add_cast_handler<T, H>(&mut self, handler: H) -> &mut Self
    where
        T: Cast,
        H: HandleCast<T>,
        T::Decoder: Default,
    {
        self.add_cast_handler_with_decoder(handler, DefaultFactory::new())
    }

    /// Registers a handler (with the given decoder maker) for the notification RPC.
    ///
    /// # Panices
    ///
    /// If a procedure which has `T::ID` already have been registered, the calling thread will panic.
    pub fn add_cast_handler_with_decoder<T, H, D>(
        &mut self,
        handler: H,
        decoder_factory: D,
    ) -> &mut Self
    where
        T: Cast,
        H: HandleCast<T>,
        D: Factory<Item = T::Decoder> + Send + Sync + 'static,
    {
        assert!(
            !self.handlers.0.contains_key(&T::ID),
            "RPC registration conflicts: procedure={:?}, name={:?}",
            T::ID,
            T::NAME
        );

        let metrics = HandlerMetrics::new(self.metrics.clone(), T::ID, T::NAME, "cast");
        self.handlers_metrics.insert(T::ID, metrics.clone());

        let handler = CastHandlerFactory::new(handler, decoder_factory, metrics);
        self.handlers.0.insert(T::ID, Box::new(handler));
        self
    }

    /// Returns the resulting RPC server.
    pub fn finish<S>(mut self, spawner: S) -> Server<S>
    where
        S: Clone + Spawn + Send + 'static,
    {
        let logger = self.logger.new(o!("server" => self.bind_addr.to_string()));
        info!(logger, "Starts RPC server");
        let handlers = mem::replace(&mut self.handlers, MessageHandlers(HashMap::new()));
        Server {
            listener: Listener::Binding(TcpListener::bind(self.bind_addr)),
            logger,
            spawner,
            assigner: Assigner::new(handlers),
            channel_options: self.channel_options.clone(),
            metrics: ServerMetrics::new(self.metrics.clone(), self.handlers_metrics.clone()),
        }
    }
}

/// RPC server.
#[must_use = "futures do nothing unless polled"]
#[derive(Debug)]
pub struct Server<S> {
    listener: Listener,
    logger: Logger,
    spawner: S,
    assigner: Assigner,
    channel_options: ChannelOptions,
    metrics: ServerMetrics,
}
impl<S> Server<S> {
    /// Returns a future that retrieves the address to which the server is bound.
    pub fn local_addr(self) -> impl Future<Item = (Self, SocketAddr), Error = Error> {
        match self.listener {
            Listener::Listening(_, addr) => Either::A(futures::finished((self, addr))),
            Listener::Binding(_) => {
                let future = loop_fn(self, |mut this| {
                    if fibers::fiber::with_current_context(|_| ()).is_none() {
                        return Ok(Loop::Continue(this));
                    }

                    track!(this.listener.poll())?;
                    if let Listener::Listening(_, addr) = this.listener {
                        Ok(Loop::Break((this, addr)))
                    } else {
                        Ok(Loop::Continue(this))
                    }
                });
                Either::B(future)
            }
        }
    }

    /// Polls the address to which the server is bound.
    pub fn poll_local_addr(&mut self) -> Poll<SocketAddr, Error> {
        match self.listener {
            Listener::Listening(_, addr) => Ok(Async::Ready(addr)),
            Listener::Binding(_) => {
                track!(self.listener.poll())?;
                if let Listener::Listening(_, addr) = self.listener {
                    Ok(Async::Ready(addr))
                } else {
                    Ok(Async::NotReady)
                }
            }
        }
    }

    /// Returns the metrics of the server.
    pub fn metrics(&self) -> &ServerMetrics {
        &self.metrics
    }
}
impl<S> Future for Server<S>
where
    S: Clone + Spawn + Send + 'static,
{
    type Item = ();
    type Error = Error;

    fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
        while let Async::Ready(item) = track!(self.listener.poll())? {
            if let Some((client, addr)) = item {
                let logger = self.logger.new(o!("client" => addr.to_string()));
                info!(logger, "New TCP client");

                let options = self.channel_options.clone();
                let metrics = self.metrics.channels().create_channel_metrics(addr);
                let channels = self.metrics.channels().clone();
                let exit_logger = logger.clone();
                let spawner = self.spawner.clone().boxed();
                let assigner = self.assigner.clone();
                let future = client
                    .map_err(|e| track!(Error::from(e)))
                    .and_then(move |stream| {
                        let channel = ServerSideChannel::new(
                            logger,
                            stream,
                            assigner.clone(),
                            options,
                            metrics,
                        );
                        ChannelHandler::new(spawner, channel)
                    });
                self.spawner.spawn(future.then(move |result| {
                    channels.remove_channel_metrics(addr);
                    if let Err(e) = result {
                        error!(exit_logger, "TCP connection aborted: {}", e);
                    } else {
                        info!(exit_logger, "TCP connection was closed");
                    }
                    Ok(())
                }));
            } else {
                info!(self.logger, "RPC server stopped");
                return Ok(Async::Ready(()));
            }
        }
        Ok(Async::NotReady)
    }
}

struct ChannelHandler {
    spawner: BoxSpawn,
    channel: ServerSideChannel,
    reply_tx: mpsc::Sender<OutgoingMessage>,
    reply_rx: mpsc::Receiver<OutgoingMessage>,
}
impl ChannelHandler {
    fn new(spawner: BoxSpawn, channel: ServerSideChannel) -> Self {
        let (reply_tx, reply_rx) = mpsc::channel();
        ChannelHandler {
            spawner,
            channel,
            reply_tx,
            reply_rx,
        }
    }
}
impl Future for ChannelHandler {
    type Item = ();
    type Error = Error;

    fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
        loop {
            while let Async::Ready(action) = track!(self.channel.poll())? {
                if let Some(action) = action {
                    match action {
                        Action::NoReply(noreply) => {
                            if let Some(future) = noreply.into_future() {
                                self.spawner.spawn(future.map_err(|_: Never| ()));
                            }
                        }
                        Action::Reply(mut reply) => {
                            if let Some(message) = reply.try_take() {
                                self.channel.reply(message);
                            } else {
                                let reply_tx = self.reply_tx.clone();
                                let future = reply.map(move |message| {
                                    let _ = reply_tx.send(message);
                                });
                                self.spawner.spawn(future.map_err(|_: Never| ()));
                            }
                        }
                    }
                } else {
                    return Ok(Async::Ready(()));
                }
            }

            let mut do_break = true;
            while let Async::Ready(item) = self.reply_rx.poll().expect("Never fails") {
                let message = item.expect("Never fails");
                self.channel.reply(message);
                do_break = false;
            }
            if do_break {
                break;
            }
        }
        Ok(Async::NotReady)
    }
}

#[derive(Debug)]
enum Listener {
    Binding(TcpListenerBind),
    Listening(Incoming, SocketAddr),
}
impl Stream for Listener {
    type Item = (Connected, SocketAddr);
    type Error = Error;

    fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error> {
        loop {
            let next = match self {
                Listener::Binding(f) => {
                    if let Async::Ready(listener) = track!(f.poll().map_err(Error::from))? {
                        let addr = track!(listener.local_addr().map_err(Error::from))?;
                        Listener::Listening(listener.incoming(), addr)
                    } else {
                        break;
                    }
                }
                Listener::Listening(s, _) => return track!(s.poll().map_err(Error::from)),
            };
            *self = next;
        }
        Ok(Async::NotReady)
    }
}