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
use crate::{
    monotonic::Monotonic,
    pipe::PipeBehavior,
    protocols::pipe::{internal::InternalCmd, PipeMessage},
    Context,
};
use ockam_core::compat::sync::Arc;
use ockam_core::compat::{boxed::Box, collections::VecDeque};
use ockam_core::{Address, AllowAll, Any, Mailbox, Mailboxes, Result, Route, Routed, Worker};
use ockam_node::WorkerBuilder;

enum PeerRoute {
    Peer(Route),
    Listener(Route),
}

impl PeerRoute {
    fn peer(&self) -> &Route {
        match self {
            Self::Peer(ref p) => p,
            Self::Listener(ref l) => l,
        }
    }
}

pub struct PipeSender {
    index: Monotonic,
    out_buf: VecDeque<PipeMessage>,
    peer: Option<PeerRoute>,
    int_addr: Address,
    hooks: PipeBehavior,
}

#[ockam_core::worker]
impl Worker for PipeSender {
    type Context = Context;
    type Message = Any;

    async fn initialize(&mut self, ctx: &mut Context) -> Result<()> {
        ctx.set_cluster(crate::pipe::CLUSTER_NAME).await?;
        if let Some(PeerRoute::Listener(ref route)) = self.peer {
            ctx.send_from_address(
                route.clone(),
                InternalCmd::InitHandshake,
                self.int_addr.clone(),
            )
            .await?
        }

        Ok(())
    }

    async fn handle_message(&mut self, ctx: &mut Context, msg: Routed<Any>) -> Result<()> {
        match msg.msg_addr() {
            addr if addr == self.int_addr => self.handle_internal(ctx, msg).await?,
            _ => self.handle_external(ctx, msg).await?,
        };

        Ok(())
    }
}

impl PipeSender {
    /// Create a PipeSender with a public and "internal" address
    pub async fn create(
        ctx: &mut Context,
        peer: Route,
        addr: Address,
        int_addr: Address,
        hooks: PipeBehavior,
    ) -> Result<()> {
        let worker = Self {
            // Ordered pipes expect a 1-indexed message
            index: Monotonic::from(1),
            out_buf: VecDeque::new(),
            peer: Some(PeerRoute::Peer(peer)),
            int_addr: int_addr.clone(),
            hooks,
        };

        // TODO: @ac
        let mailboxes = Mailboxes::new(
            Mailbox::new(addr, Arc::new(AllowAll), Arc::new(AllowAll)),
            vec![Mailbox::new(
                int_addr,
                Arc::new(AllowAll),
                Arc::new(AllowAll),
            )],
        );
        WorkerBuilder::new(worker)
            .with_mailboxes(mailboxes)
            .start(ctx)
            .await?;

        Ok(())
    }

    /// Create a sender without a peer route
    ///
    /// To fully be able to use this pipe sender it needs to receive
    /// an initialisation message from a pipe receiver.
    pub async fn uninitialized(
        ctx: &mut Context,
        addr: Address,
        int_addr: Address,
        listener: Option<Route>,
        hooks: PipeBehavior,
    ) -> Result<()> {
        let worker = Self {
            index: Monotonic::from(1),
            out_buf: VecDeque::new(),
            peer: listener.map(PeerRoute::Listener),
            int_addr: int_addr.clone(),
            hooks,
        };
        // TODO: @ac
        let mailboxes = Mailboxes::new(
            Mailbox::new(addr, Arc::new(AllowAll), Arc::new(AllowAll)),
            vec![Mailbox::new(
                int_addr,
                Arc::new(AllowAll),
                Arc::new(AllowAll),
            )],
        );
        WorkerBuilder::new(worker)
            .with_mailboxes(mailboxes)
            .start(ctx)
            .await?;

        Ok(())
    }

    /// Handle internal command payloads
    async fn handle_internal(&mut self, ctx: &mut Context, msg: Routed<Any>) -> Result<()> {
        trace!("PipeSender receiving internal command");
        let return_route = msg.return_route();
        let trans = msg.into_transport_message();
        let internal_cmd = InternalCmd::from_transport(&trans)?;

        // Either run all internal message hooks OR fully set-up this sender
        match self.peer {
            Some(PeerRoute::Peer(ref peer)) => {
                self.hooks
                    .internal_all(self.int_addr.clone(), peer.clone(), ctx, &internal_cmd)
                    .await?;
            }
            _ => match internal_cmd {
                InternalCmd::InitSender => {
                    debug!("Initialise pipe sender for route {:?}", return_route);
                    self.peer = Some(PeerRoute::Peer(return_route.clone()));

                    // Send out the out_buffer
                    for msg in core::mem::take(&mut self.out_buf) {
                        send_pipe_msg(
                            &mut self.hooks,
                            ctx,
                            self.int_addr.clone(),
                            return_route.clone(),
                            msg,
                        )
                        .await?;
                    }
                }
                cmd => warn!(
                    "Received internal command '{:?}' for invalid state sender",
                    cmd
                ),
            },
        }

        Ok(())
    }

    /// Handle external user messages
    async fn handle_external(&mut self, ctx: &mut Context, msg: Routed<Any>) -> Result<()> {
        // First manipulate the onward_route state
        let mut msg = msg.into_transport_message();
        msg.onward_route.modify().pop_front();

        debug!(
            "Pipe sender '{:?}' dispatch {:?} -> {:?}",
            ctx.address(),
            self.peer.as_ref().map(|p| p.peer()),
            msg.onward_route
        );

        // Then pack TransportMessage into PipeMessage
        let index = self.index.next() as u64;
        let pipe_msg = PipeMessage::from_transport(index, msg)?;

        // Check if this sender has been fully initialised already
        match self.peer {
            Some(PeerRoute::Peer(ref peer)) => {
                send_pipe_msg(
                    &mut self.hooks,
                    ctx,
                    self.int_addr.clone(),
                    peer.clone(),
                    pipe_msg,
                )
                .await
            }
            _ => {
                debug!("Queue message into output buffer...");
                self.out_buf.push_back(pipe_msg);
                Ok(())
            }
        }
    }
}

async fn send_pipe_msg(
    hooks: &mut PipeBehavior,
    ctx: &mut Context,
    int_addr: Address,
    peer: Route,
    msg: PipeMessage,
) -> Result<()> {
    // Before we send we give all hooks a chance to run
    if let crate::pipe::PipeModifier::Drop = hooks
        .external_all(int_addr.clone(), peer.clone(), ctx, &msg)
        .await?
    {
        // Return early to prevent message sending if the
        // behaviour stack has determined to drop the message.
        return Ok(());
    }

    // Then send the message from our internal address so the
    // receiver can send any important messages there
    ctx.send_from_address(peer, msg, int_addr).await
}