pubnub 0.7.0

PubNub SDK for Rust
Documentation 
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

//! Heartbeat effect module.
//!
//! Module contains implementation of `Heartbeat` and `Delayed heartbeat` effect
//! which is used to announce `user_id` presence on specified channels and
//! groups.

use futures::TryFutureExt;
use log::info;

use crate::{
    core::PubNubError,
    lib::alloc::{sync::Arc, vec, vec::Vec},
    presence::event_engine::{
        effects::HeartbeatEffectExecutor, PresenceEvent, PresenceInput, PresenceParameters,
    },
};

#[allow(clippy::too_many_arguments)]
pub(super) async fn execute(
    input: &PresenceInput,
    executor: &Arc<HeartbeatEffectExecutor>,
) -> Vec<PresenceEvent> {
    let channel_groups: Option<Vec<String>> = input.channel_groups();
    let channels: Option<Vec<String>> = input.channels();

    info!(
        "Heartbeat for\nchannels: {:?}\nchannel groups: {:?}",
        channels, channel_groups
    );

    executor(PresenceParameters {
        channels: &channels,
        channel_groups: &channel_groups,
    })
    .map_ok_or_else(
        |error| {
            log::error!("Handshake error: {:?}", error);

            // Cancel is possible and no retries should be done.
            (!matches!(error, PubNubError::EffectCanceled))
                .then(|| vec![PresenceEvent::HeartbeatFailure { reason: error }])
                .unwrap_or(vec![])
        },
        |_| vec![PresenceEvent::HeartbeatSuccess],
    )
    .await
}

#[cfg(test)]
mod it_should {
    use super::*;
    use crate::{
        core::{PubNubError, TransportResponse},
        dx::presence::HeartbeatResult,
    };
    use futures::FutureExt;

    #[tokio::test]
    async fn return_heartbeat_success_event() {
        let mocked_heartbeat_function: Arc<HeartbeatEffectExecutor> = Arc::new(move |parameters| {
            assert_eq!(parameters.channel_groups, &Some(vec!["cg1".to_string()]));
            assert_eq!(parameters.channels, &Some(vec!["ch1".to_string()]));

            async move { Ok(HeartbeatResult) }.boxed()
        });

        let result = execute(
            &PresenceInput::new(
                &Some(vec!["ch1".to_string()]),
                &Some(vec!["cg1".to_string()]),
            ),
            &mocked_heartbeat_function,
        )
        .await;

        assert!(!result.is_empty());
        assert!(matches!(
            result.first().unwrap(),
            PresenceEvent::HeartbeatSuccess
        ));
    }

    #[tokio::test]
    async fn return_heartbeat_failed_event_on_error() {
        let mocked_heartbeat_function: Arc<HeartbeatEffectExecutor> = Arc::new(move |_| {
            async move {
                Err(PubNubError::Transport {
                    details: "test".into(),
                    response: Some(Box::new(TransportResponse {
                        status: 500,
                        ..Default::default()
                    })),
                })
            }
            .boxed()
        });

        let result = execute(
            &PresenceInput::new(
                &Some(vec!["ch1".to_string()]),
                &Some(vec!["cg1".to_string()]),
            ),
            &mocked_heartbeat_function,
        )
        .await;

        assert!(!result.is_empty());
        assert!(matches!(
            result.first().unwrap(),
            PresenceEvent::HeartbeatFailure { .. }
        ));
    }

    #[tokio::test]
    async fn return_empty_event_on_effect_cancel_err() {
        let mocked_heartbeat_function: Arc<HeartbeatEffectExecutor> =
            Arc::new(move |_| async move { Err(PubNubError::EffectCanceled) }.boxed());

        let result = execute(
            &PresenceInput::new(
                &Some(vec!["ch1".to_string()]),
                &Some(vec!["cg1".to_string()]),
            ),
            &mocked_heartbeat_function,
        )
        .await;

        assert!(result.is_empty());
    }
}