dsf-daemon 0.1.3

Distributed Service Framework (DSF) Daemon
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
use std::convert::TryFrom;
use std::net::SocketAddr;
use std::ops::Add;
use std::time::{Duration, SystemTime};

use async_std::future::timeout;
use futures::prelude::*;
use tracing::{span, Level};

use dsf_core::net;
use dsf_core::prelude::*;
use dsf_core::service::Subscriber;

use kad::prelude::*;

use crate::daemon::Dsf;
use crate::error::Error as DaemonError;
use crate::io::Connector;

use crate::daemon::dht::{Adapt, TryAdapt};

use crate::core::data::DataInfo;
use crate::core::peers::{Peer, PeerAddress, PeerState};
use crate::core::subscribers::SubscriptionKind;

impl<C> Dsf<C>
where
    C: Connector + Clone + Sync + Send + 'static,
{
    /// Handle a received request message and generate a response
    pub async fn handle(
        &mut self,
        addr: SocketAddr,
        req: net::Request,
    ) -> Result<net::Response, DaemonError> {
        let own_id = self.id();

        let span = span!(Level::DEBUG, "id", "{}", own_id);
        let _enter = span.enter();

        let req_id = req.id;
        let flags = req.flags.clone();
        let our_pub_key = self.service().public_key();
        let from = req.from.clone();
        let from2 = from.clone();

        trace!(
            "handling request (from: {:?} / {})\n {:?}",
            from,
            addr,
            &req
        );

        // Generic request processing here
        let peer = self.handle_base(&from, &addr.into(), &req.common, Some(SystemTime::now()));

        // Handle specific DSF and DHT messages
        if let Some(kad_req) = req.data.try_to(()) {
            self.handle_dht(from, peer, kad_req).map(move |resp| {
                let kind = resp.to();
                net::Response::new(own_id, req_id, kind, Flags::default())
            })
        } else {
            self.handle_dsf(from, peer, req.data)
                .await
                .map(move |kind| net::Response::new(own_id, req_id, kind, Flags::default()))

            // Generic response processing here
        }
        .map(move |mut resp| {
            if flags.contains(Flags::PUB_KEY_REQUEST) {
                resp.common.public_key = Some(our_pub_key);
            }

            // Update peer info
            if let Some(mut peer) = self.peers().find(&from2) {
                peer.update(|mut p| {
                    p.sent += 1;
                });
            }

            trace!("returning response (to: {:?})\n {:?}", from2, &resp);

            resp
        })
    }

    // Internal function to send a request and await a response
    /// This MUST be used in place of self.connector.clone.request for correct system behaviour
    pub(crate) async fn request(
        &mut self,
        address: Address,
        req: net::Request,
        timeout: Duration,
    ) -> Result<net::Response, DaemonError> {
        let req = req.clone();

        debug!("Sending request to: {:?} request: {:?}", address, &req);

        // Issue request and await response
        let resp = self
            .connector()
            .request(req.id, address.clone(), req, timeout)
            .await?;

        debug!(
            "Received response from: {:?} request: {:?}",
            &address, &resp
        );

        // Handle received message
        self.handle_base(&resp.from, &address, &resp.common, Some(SystemTime::now()));

        Ok(resp)
    }

    /// Internal function to send a series of requests
    pub(crate) async fn request_all(
        &mut self,
        addresses: &[Address],
        req: net::Request,
    ) -> Vec<Result<net::Response, DaemonError>> {
        let mut f = Vec::with_capacity(addresses.len());

        let c = self.connector();

        // Build requests
        for a in addresses {
            let mut req = req.clone();
            req.common.id = RequestId::default();

            let req_future = c
                .request(req.id, a.clone(), req, Duration::from_secs(10))
                .map(move |resp| (resp, a.clone()));

            f.push(req_future);
        }

        let mut responses = future::join_all(f).await;

        for (r, a) in &responses {
            if let Ok(resp) = r {
                self.handle_base(&resp.from, a, &resp.common, Some(SystemTime::now()));
            }
        }

        responses.drain(..).map(|(resp, _addr)| resp).collect()
    }

    /// Internal function to send a response
    /// This MUST be used in place of self.connector.clone.respond for correct system behavior
    pub(crate) async fn respond(
        &mut self,
        address: Address,
        resp: net::Response,
    ) -> Result<(), DaemonError> {
        let resp = resp.clone();

        trace!(
            "[DSF ({:?})] Sending response to: {:?} response: {:?}",
            self.id(),
            address,
            &resp
        );

        timeout(
            Duration::from_secs(10),
            self.connector().respond(resp.id, address, resp),
        )
        .await??;

        Ok(())
    }

    /// Handles a base message, updating internal state for the sender
    pub(crate) fn handle_base(
        &mut self,
        id: &Id,
        address: &Address,
        c: &net::Common,
        _seen: Option<SystemTime>,
    ) -> Peer {
        trace!(
            "[DSF ({:?})] Handling base message from: {:?} address: {:?} public_key: {:?}",
            self.id(),
            id,
            address,
            c.public_key
        );

        // Find or create (and push) peer
        let mut peer = self.peers().find_or_create(
            id.clone(),
            PeerAddress::Implicit(*address),
            c.public_key.clone(),
        );

        // Update peer info
        peer.update(|mut p| {
            p.set_seen(SystemTime::now());
            p.received += 1;
        });

        assert!(id != &self.id(), "handle_base called for self...");

        trace!(
            "[DSF ({:?})] Peer id: {:?} state: {:?} seen: {:?}",
            self.id(),
            id,
            peer.state(),
            peer.seen()
        );

        // Add public key if appropriate
        match (peer.state(), &c.public_key) {
            (PeerState::Unknown, Some(pk)) => {
                info!("Adding key: {:?} to peer: {:?}", pk, id);
                peer.update(|p| p.set_state(PeerState::Known(pk.clone())))
            }
            _ => (),
        };

        // Update address if specified (and different from existing)
        if let Some(a) = c.remote_address {
            if a != peer.address() {
                info!("Setting explicit address {:?} for peer: {:?}", a, id);
                peer.update(|p| p.update_address(PeerAddress::Explicit(a)));
            }
        }

        peer
    }

    /// Handle a DSF type message
    async fn handle_dsf(
        &mut self,
        from: Id,
        peer: Peer,
        req: net::RequestKind,
    ) -> Result<net::ResponseKind, DaemonError> {
        match req {
            net::RequestKind::Hello => Ok(net::ResponseKind::Status(net::Status::Ok)),
            net::RequestKind::Subscribe(service_id) => {
                info!(
                    "Subscribe request from: {} for service: {}",
                    from, service_id
                );
                let service = match self.services().find(&service_id) {
                    Some(s) => s,
                    None => {
                        // Only known services can be registered
                        error!("no service found (id: {})", service_id);
                        return Ok(net::ResponseKind::Status(net::Status::InvalidRequest));
                    }
                };

                let service = service.write().unwrap();
                let pages = match &service.primary_page {
                    Some(p) => vec![p.clone()],
                    None => vec![],
                };

                // TODO: verify this is coming from an active upstream subscriber

                // TODO: update subscriber count?

                // TODO: update peer subscription information here
                self.subscribers()
                    .update_peer(&service_id, &peer.id(), |inst| {
                        inst.info.updated = Some(SystemTime::now());
                        inst.info.expiry = Some(SystemTime::now().add(Duration::from_secs(3600)));
                    })
                    .unwrap();

                Ok(net::ResponseKind::ValuesFound(service_id, pages))
            }
            net::RequestKind::Unsubscribe(service_id) => {
                info!(
                    "Unsubscribe request from: {} for service: {}",
                    from, service_id
                );

                self.subscribers().remove(&service_id, &peer.id()).unwrap();

                Ok(net::ResponseKind::Status(net::Status::Ok))
            }
            net::RequestKind::Query(id) => {
                info!("Query request from: {} for service: {}", from, id);
                let service = match self.services().find(&id) {
                    Some(s) => s,
                    None => {
                        // Only known services can be registered
                        error!("no service found (id: {})", id);
                        return Ok(net::ResponseKind::Status(net::Status::InvalidRequest));
                    }
                };

                let _service = service.write().unwrap();

                // TODO: fetch and return data

                info!("Query request complete");

                Err(DaemonError::Unimplemented)
            }
            net::RequestKind::Register(id, pages) => {
                info!("Register request from: {} for service: {}", from, id);
                // TODO: determine whether we should allow this service to be registered

                self.service_register(&id, pages)?;

                Ok(net::ResponseKind::Status(net::Status::Ok))
            }
            net::RequestKind::Unregister(id) => {
                info!("Unegister request from: {} for service: {}", from, id);
                // TODO: determine whether we should allow this service to be unregistered

                unimplemented!()
            }
            net::RequestKind::PushData(id, data) => {
                info!("Data push from: {} for service: {}", from, id);
                let service = match self.services().find(&id) {
                    Some(s) => s,
                    None => {
                        // Only known services can be registered
                        error!("no service found (id: {})", id);
                        return Ok(net::ResponseKind::Status(net::Status::InvalidRequest));
                    }
                };

                let mut service = service.write().unwrap();

                // TODO: check we-re subscribed to the service (otherwise we shouldn't accept this data)

                // Store data against service
                for p in &data {
                    // Validate data against service
                    if let Err(e) = service.service().validate_page(p) {
                        // TODO: handle errors properly here
                        error!("Error validating page: {:?}", e);
                        continue;
                    }

                    if p.header().kind().is_page() {
                        // Apply page to service
                        if let Err(e) = service.apply_update(p) {
                            error!("Error applying service update: {:?}", e);
                        }
                    }

                    if p.header().kind().is_data() {
                        // Store data
                        if let Ok(info) = DataInfo::try_from(p) {
                            self.data().store_data(&info, p).unwrap();
                        };
                    }
                }

                // TODO: update service with newly received data
                self.services().sync_inst(&service);
                let service_id = service.id();
                drop(service);

                // TODO: send data to subscribers
                let req = net::Request::new(
                    self.id(),
                    rand::random(),
                    net::RequestKind::PushData(service_id.clone(), data),
                    Flags::default(),
                );

                let subscriptions = self.subscribers().find(&service_id)?;

                let addresses: Vec<_> = subscriptions
                    .iter()
                    .filter_map(|s| {
                        if let SubscriptionKind::Peer(peer_id) = &s.info.kind {
                            self.peers().find(peer_id).map(|p| p.address())
                        } else {
                            None
                        }
                    })
                    .collect();

                info!("Sending data push messages to: {:?}", addresses);

                // TODO: this is, not ideal...
                let mut dsf = self.clone();
                async_std::task::spawn(async move {
                    dsf.request_all(&addresses, req).await;
                });

                info!("Data push complete");

                Ok(net::ResponseKind::Status(net::Status::Ok))
            }
            _ => Err(DaemonError::Unimplemented),
        }
    }

    /// Handle a DHT request message
    fn handle_dht(
        &mut self,
        from: Id,
        peer: Peer,
        req: DhtRequest<Id, Data>,
    ) -> Result<DhtResponse<Id, Peer, Data>, DaemonError> {
        // TODO: resolve this into existing entry
        let from = DhtEntry::new(from.into(), peer);

        // Pass to DHT
        let resp = self.dht().handle(&from, &req).unwrap();

        Ok(resp)
    }
}