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
//! # Links
//!
//! Links are used to communicate with services. You can obtain a link by starting a service
//! or using the [`ServiceContext::link`] function on the service context.
//!
//! You can also convert a link into a [`MessageLink`] which is a link based on a type of
//! message rather than a type of service. This can be done using the [`Link::message_link`]
//! function.

use std::{error::Error, fmt::Display};

use crate::{
    envelope::{Envelope, ExecutorEnvelope, FutureEnvelope, ServiceMessage, StopEnvelope},
    msg::{BoxFuture, Handler, Message},
    service::{Service, ServiceContext},
};
use tokio::sync::{mpsc, oneshot};

/// Links are used to send and receive messages from services
/// you will receive a link when you start a service or through
/// the `link()` fn on a service context
///
/// Links are cheaply clonable and can be passed between threads
pub struct Link<S>(pub(crate) mpsc::UnboundedSender<ServiceMessage<S>>);

/// Alternative type to a link rather than representing a
/// service type this represents a link to a service that
/// accepts a specific message type
///
/// These are cheaply clonable
pub struct MessageLink<M: Message>(Box<dyn MessageLinkTx<M>>);

/// Sender trait implemented by types that can be used to
/// send messages of a speicifc type implements a cloning
/// impl aswell
trait MessageLinkTx<M: Message> {
    /// Sends a message using the underlying channel as an
    /// envelope with the provided `tx` value for handling
    /// responses
    fn tx(&self, msg: M, tx: Option<oneshot::Sender<M::Response>>) -> LinkResult<()>;

    /// Boxed cloning implementation which produces a cloned
    /// value without exposing a sized type
    fn boxed_clone(&self) -> Box<dyn MessageLinkTx<M>>;
}

impl<S, M> MessageLinkTx<M> for mpsc::UnboundedSender<ServiceMessage<S>>
where
    S: Service + Handler<M>,
    M: Message,
{
    fn tx(&self, msg: M, tx: Option<oneshot::Sender<M::Response>>) -> LinkResult<()> {
        self.send(Envelope::new(msg, tx))
            .map_err(|_| LinkError::Send)
    }

    fn boxed_clone(&self) -> Box<dyn MessageLinkTx<M>> {
        Box::new(self.clone())
    }
}

impl<M> MessageLink<M>
where
    M: Message,
{
    pub async fn send(&self, msg: M) -> LinkResult<M::Response> {
        let (tx, rx) = oneshot::channel();
        self.0.tx(msg, Some(tx))?;
        rx.await.map_err(|_| LinkError::Recv)
    }

    pub fn do_send(&self, msg: M) -> LinkResult<()> {
        self.0.tx(msg, None)
    }
}

/// Clone implementation to clone inner sender for the link
impl<S> Clone for Link<S> {
    fn clone(&self) -> Self {
        Self(self.0.clone())
    }
}
/// Clone implementation to clone inner sender for the recipient
impl<M: Message> Clone for MessageLink<M> {
    fn clone(&self) -> Self {
        Self(self.0.boxed_clone())
    }
}

/// Errors that can occur while working with a link
#[derive(Debug)]
pub enum LinkError {
    /// Failed to send message to service
    Send,
    /// Failed to receive response back from service
    Recv,
}

impl Display for LinkError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            LinkError::Send => f.write_str("Failed to send to link"),
            LinkError::Recv => f.write_str("Failed to receive from link"),
        }
    }
}

impl Error for LinkError {}

/// Result type for results where the error is a [`LinkError`]
pub type LinkResult<T> = Result<T, LinkError>;

impl<S> Link<S>
where
    S: Service,
{
    /// Checks whether the underlying sender is closed
    pub fn is_closed(&self) -> bool {
        self.0.is_closed()
    }

    /// Creates a message link type from this link type this allows you
    /// to have links to multiple different services that accept a
    /// specific message type
    pub fn message_link<M>(&self) -> MessageLink<M>
    where
        M: Message,
        S: Handler<M>,
    {
        MessageLink(self.0.boxed_clone())
    }

    /// Internal wrapper for sending service messages and handling
    /// the error responses
    pub(crate) fn tx(&self, value: ServiceMessage<S>) -> LinkResult<()> {
        match self.0.send(value) {
            Ok(_) => Ok(()),
            Err(_) => Err(LinkError::Send),
        }
    }

    /// Tells the service to complete and wait on the action which
    /// produce a future depending on the service and context. While
    /// the action is being awaited messages will not be accepted. The
    /// result of the action will be returned.  
    ///
    /// Mutable access to the service and the service context are
    /// provided to the closure
    ///
    ///
    /// ```
    /// use interlink::prelude::*;
    /// use std::time::Duration;
    /// use tokio::time::sleep;
    ///
    /// #[derive(Service)]
    /// struct MyService;
    ///
    /// #[tokio::test]
    /// async fn test() {
    ///     let link: Link<MyService> = MyService {}.start();
    ///     let value = link.wait(|service, ctx| Box::pin(async move {
    ///         println!("Service waiting on processing loop");
    ///         sleep(Duration::from_millis(1000)).await;
    ///         println!("Action executed on service");
    ///         12
    ///     }))
    ///     .await
    ///     .unwrap();
    ///
    ///     assert_eq!(value, 12);
    /// }
    ///
    /// ```
    pub async fn wait<F, R>(&self, action: F) -> LinkResult<R>
    where
        for<'a> F:
            FnOnce(&'a mut S, &'a mut ServiceContext<S>) -> BoxFuture<'a, R> + Send + 'static,
        R: Send + 'static,
    {
        let (tx, rx) = oneshot::channel();
        self.tx(FutureEnvelope::new(Box::new(action), Some(tx)))?;
        rx.await.map_err(|_| LinkError::Recv)
    }

    /// Tells the service to complete and wait on the action which
    /// produce a future depending on the service and context. While
    /// the action is being awaited messages will not be accepted.
    ///
    /// Mutable access to the service and the service context are
    /// provided to the closure
    ///
    /// ```
    /// use interlink::prelude::*;
    /// use std::time::Duration;
    /// use tokio::time::sleep;
    ///
    /// #[derive(Service)]
    /// struct MyService;
    ///
    /// #[tokio::test]
    /// async fn test() {
    ///     let link: Link<MyService> = MyService {}.start();
    ///     link.do_wait(|service, ctx| Box::pin(async move {
    ///         println!("Service waiting on processing loop");
    ///         sleep(Duration::from_millis(1000)).await;
    ///         println!("Action executed on service");
    ///     }))
    ///     .unwrap();
    /// }
    ///
    /// ```
    pub fn do_wait<F, R>(&self, action: F) -> LinkResult<()>
    where
        for<'a> F:
            FnOnce(&'a mut S, &'a mut ServiceContext<S>) -> BoxFuture<'a, R> + Send + 'static,
        R: Send + 'static,
    {
        self.tx(FutureEnvelope::new(Box::new(action), None))
    }

    /// Sends a message to the service. The service must implement a
    /// Handler for the message. Will return the response value from
    /// the handler once awaited
    ///
    /// ```
    ///
    /// use interlink::prelude::*;
    ///
    /// #[derive(Service)]
    /// struct Test;
    ///
    /// #[derive(Message)]
    /// #[msg(rtype = "String")]
    /// struct MyMessage {
    ///     value: String,
    /// }
    ///
    /// impl Handler<MyMessage> for Test {
    ///     type Response = Mr<MyMessage>;
    ///
    ///     fn handle(&mut self, msg: MyMessage, ctx: &mut ServiceContext<Self>) -> Self::Response {
    ///         Mr(msg.value)
    ///     }
    /// }
    ///
    /// #[tokio::test]
    /// async fn test() {
    ///     let link = Test {}.start();
    ///     let resp = link.send(MyMessage {
    ///         value: "Test123".to_string()
    ///     })
    ///     .await
    ///     .unwrap();
    ///
    ///     assert_eq!(&resp, "Test123")
    /// }
    /// ```
    pub async fn send<M>(&self, msg: M) -> LinkResult<M::Response>
    where
        M: Message,
        S: Handler<M>,
    {
        let (tx, rx) = oneshot::channel();
        self.tx(Envelope::new(msg, Some(tx)))?;
        rx.await.map_err(|_| LinkError::Recv)
    }

    /// Sends a message to the service. The service must implement a
    /// Handler for the message. Will not wait for a response from
    /// the service
    ///
    /// ```
    ///
    /// use interlink::prelude::*;
    ///
    /// #[derive(Service)]
    /// struct Test;
    ///
    /// #[derive(Message)]
    /// struct MyMessage {
    ///     value: String,
    /// }
    ///
    /// impl Handler<MyMessage> for Test {
    ///     type Response = ();
    ///
    ///     fn handle(&mut self, msg: MyMessage, ctx: &mut ServiceContext<Self>) {
    ///         assert_eq!(&msg.value, "Test123");
    ///     }
    /// }
    ///
    /// #[tokio::test]
    /// async fn test() {
    ///     let link = Test {}.start();
    ///     link.do_send(MyMessage {
    ///         value: "Test123".to_string()
    ///     })
    ///     .unwrap();
    /// }
    /// ```
    pub fn do_send<M>(&self, msg: M) -> LinkResult<()>
    where
        M: Message,
        S: Handler<M>,
    {
        self.tx(Envelope::new(msg, None))
    }

    /// Executes the provided action on the service and service context
    /// awaiting the promise from this function will result in the return
    /// value of the closure. The provided closure is given mutable access
    /// to the service and context
    ///
    /// ```
    /// use interlink::prelude::*;
    ///
    /// #[derive(Service)]
    /// struct Test {
    ///     value: String
    /// }
    ///
    /// #[tokio::test]
    /// async fn test() {
    ///     let link = Test { value: "Test".to_string() }.start();
    ///     
    ///     let value = link.exec(|service: &mut Test, _ctx| {
    ///         service.value.push('A');
    ///
    ///         service.value.clone()
    ///     })
    ///     .await
    ///     .expect("Failed to execute action on service");
    ///
    ///     assert_eq!(value, "TestA");
    /// }
    ///
    /// ```
    pub async fn exec<F, R>(&self, action: F) -> LinkResult<R>
    where
        F: FnOnce(&mut S, &mut ServiceContext<S>) -> R + Send + 'static,
        R: Send + 'static,
    {
        let (tx, rx) = oneshot::channel();

        self.tx(ExecutorEnvelope::new(action, Some(tx)))?;

        rx.await.map_err(|_| LinkError::Recv)
    }

    /// Executes the provided action on the service and service context
    /// ignoring the result of the action. The provided closure is given
    /// mutable access to the service and context
    ///
    /// ```
    /// use interlink::prelude::*;
    ///
    /// #[derive(Service)]
    /// struct Test {
    ///     value: String
    /// }
    ///
    /// #[tokio::test]
    /// async fn test() {
    ///     let link = Test { value: "Test".to_string() }.start();
    ///     
    ///     link.do_exec(|service: &mut Test, _ctx| {
    ///         println!("Value: {}", service.value);
    ///
    ///         service.value.push('A');
    ///
    ///         println!("Value: {}", service.value);
    ///     })
    ///     .expect("Failed to execute action on service");
    /// }
    ///
    /// ```
    pub fn do_exec<F, R>(&self, action: F) -> LinkResult<()>
    where
        F: FnOnce(&mut S, &mut ServiceContext<S>) -> R + Send + 'static,
        R: Send + 'static,
    {
        self.tx(ExecutorEnvelope::new(action, None))
    }

    /// Tells the associated service to stop processing messages. After
    /// this message is recieved no more messages will be processed.
    pub fn stop(&self) {
        // Send the stop message to the service
        let _ = self.tx(Box::new(StopEnvelope));
    }
}