pulsar 1.0.0-alpha

Rust client for Apache Pulsar
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
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
extern crate futures;
#[macro_use]
extern crate log;
#[macro_use]
extern crate nom;
#[macro_use]
extern crate prost_derive;

#[cfg(test)]
#[macro_use]
extern crate serde;

pub use client::{DeserializeMessage, Pulsar, SerializeMessage};
pub use connection::{Authentication, Connection};
pub use connection_manager::ConnectionManager;
pub use consumer::{
    Consumer, ConsumerBuilder, ConsumerOptions, ConsumerState, Message, MultiTopicConsumer,
};
pub use error::{ConnectionError, ConsumerError, Error, ProducerError, ServiceDiscoveryError};
pub use executor::Executor;
#[cfg(feature = "tokio-runtime")]
pub use executor::TokioExecutor;
#[cfg(feature = "async-std-runtime")]
pub use executor::AsyncStdExecutor;
pub use message::proto;
pub use message::proto::command_subscribe::SubType;
pub use producer::{Producer, ProducerOptions, MultiTopicProducer};
pub use service_discovery::ServiceDiscovery;

mod client;
mod connection;
mod connection_manager;
mod error;
mod executor;
pub mod consumer;
pub mod message;
pub mod producer;
mod service_discovery;

#[cfg(test)]
mod tests {
    use std::time::{Duration, Instant};

    use futures::{StreamExt, TryStreamExt};
    #[cfg(feature = "tokio-runtime")]
    use tokio;
    #[cfg(feature = "tokio-runtime")]
    use tokio::runtime::Runtime;

    use message::proto::command_subscribe::SubType;

    use crate::client::SerializeMessage;
    use crate::message::Payload;
    use crate::Error as PulsarError;
    #[cfg(feature = "tokio-runtime")]
    use crate::executor::TokioExecutor;

    use super::*;
    use nom::lib::std::collections::BTreeSet;
    use rand::distributions::Alphanumeric;
    use rand::Rng;
    use std::collections::BTreeMap;

    #[derive(Debug, Serialize, Deserialize)]
    struct TestData {
        pub data: String,
    }

    impl SerializeMessage for TestData {
        fn serialize_message(input: &Self) -> Result<producer::Message, PulsarError> {
            let payload =
                serde_json::to_vec(input).map_err(|e| PulsarError::Custom(e.to_string()))?;
            Ok(producer::Message {
                payload,
                ..Default::default()
            })
        }
    }

    impl DeserializeMessage for TestData {
        type Output = Result<TestData, serde_json::Error>;

        fn deserialize_message(payload: &Payload) -> Self::Output {
            serde_json::from_slice(&payload.data)
        }
    }

    #[derive(Debug)]
    enum Error {
        Pulsar(PulsarError),
        Timeout(std::io::Error),
        Serde(serde_json::Error),
        Utf8(std::string::FromUtf8Error),
    }

    impl From<std::io::Error> for Error {
        fn from(e: std::io::Error) -> Self {
            Error::Timeout(e)
        }
    }

    impl From<PulsarError> for Error {
        fn from(e: PulsarError) -> Self {
            Error::Pulsar(e)
        }
    }

    impl From<serde_json::Error> for Error {
        fn from(e: serde_json::Error) -> Self {
            Error::Serde(e)
        }
    }

    impl From<std::string::FromUtf8Error> for Error {
        fn from(err: std::string::FromUtf8Error) -> Self {
            Error::Utf8(err)
        }
    }

    impl std::fmt::Display for Error {
        fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
            match self {
                Error::Pulsar(e) => write!(f, "{}", e),
                Error::Timeout(e) => write!(f, "{}", e),
                Error::Serde(e) => write!(f, "{}", e),
                Error::Utf8(e) => write!(f, "{}", e),
            }
        }
    }

    use log::{Record, Metadata, LevelFilter};
    pub struct SimpleLogger;
    impl log::Log for SimpleLogger {
        fn enabled(&self, _metadata: &Metadata) -> bool {
            //metadata.level() <= Level::Info
            true
        }

        fn log(&self, record: &Record) {
            if self.enabled(record.metadata()) {
                println!("{} {}\t{}\t{}", chrono::Utc::now(),
                  record.level(), record.module_path().unwrap(), record.args());
            }
        }
        fn flush(&self) {}
    }

    pub static TEST_LOGGER: SimpleLogger = SimpleLogger;

    #[test]
    #[cfg(feature = "tokio-runtime")]
    fn round_trip() {
        let mut runtime = Runtime::new().unwrap();
        let _ = log::set_logger(&TEST_LOGGER);
        let _ = log::set_max_level(LevelFilter::Debug);

        let f = async {
            let addr = "pulsar://127.0.0.1:6650";
            let pulsar: Pulsar<TokioExecutor> = Pulsar::builder(addr).build().await.unwrap();

            let mut consumer: Consumer<TestData> = pulsar
                .consumer()
                .with_topic("test")
                .with_consumer_name("test_consumer")
                .with_subscription_type(SubType::Exclusive)
                .with_subscription("test_subscription")
                .build()
                .await
                .unwrap();

            info!("consumer created");

            let mut producer = pulsar.producer()
                .with_topic("test")
                .build()
                .await.unwrap();
            info!("producer created");

            info!("will send message");
            for _ in 0u16..5000 {
                producer.send(
                    TestData {
                        data: "data".to_string(),
                    },
                ).await.unwrap();
            }

            info!("sent");
            //let mut stream = consumer.take(5000);
            let mut count = 0usize;
            while let Ok(Some(msg)) = consumer.try_next().await {
            //let res =  consumer.next().await.unwrap();
                //let msg = res.unwrap();
                consumer.ack(&msg).await;
                let data = msg.deserialize().unwrap();
                if data.data.as_str() != "data" {
                    panic!("Unexpected payload: {}", &data.data);
                }

                count +=1;

                if count % 500 == 0 {
                    info!("messages received: {}", count);
                }
                if count == 5000 {
                    break;
                }
            }
            // FIXME .timeout(Duration::from_secs(5))
        };

        runtime.block_on(Box::pin(f));
    }

    #[test]
    #[cfg(feature = "tokio-runtime")]
    fn unsized_data() {
        let _ = log::set_logger(&TEST_LOGGER);
        let _ = log::set_max_level(LevelFilter::Debug);
        let mut runtime = Runtime::new().unwrap();

        let f = async {
            let addr = "pulsar://127.0.0.1:6650";
            let pulsar: Pulsar<TokioExecutor> = Pulsar::builder(addr).build().await.unwrap();
            let mut producer = pulsar.create_multi_topic_producer(None);

            // test &str
            {
                let topic = "test_unsized_data_str";
                let send_data = "some unsized data";

                let mut consumer = pulsar
                    .consumer()
                    .with_topic(topic)
                    .with_subscription_type(SubType::Exclusive)
                    .with_subscription("test_subscription")
                    .build::<String>()
                    .await
                    .unwrap();

                producer.send(topic, send_data.to_string()).await.unwrap();

                let msg = consumer.next().await.unwrap().unwrap();
                consumer.ack(&msg).await;

                let data = msg.deserialize().unwrap();
                if data.as_str() != send_data {
                    panic!("Unexpected payload in &str test: {}", &data);
                }
                //FIXME .timeout(Duration::from_secs(1))
            }

            // test &[u8]
            {
                let topic = "test_unsized_data_bytes";
                let send_data: &[u8] = &[0, 1, 2, 3];

                let mut consumer = pulsar
                    .consumer()
                    .with_topic(topic)
                    .with_subscription_type(SubType::Exclusive)
                    .with_subscription("test_subscription")
                    .build::<Vec<u8>>()
                    .await
                    .unwrap();

                producer.send(topic, send_data.to_vec()).await.unwrap();

                let msg = consumer.next().await.unwrap().unwrap();
                consumer.ack(&msg).await;
                let data = msg.deserialize();
                if data.as_slice() != send_data {
                    panic!("Unexpected payload in &[u8] test: {:?}", &data);
                }
            }
        };

        runtime.block_on(Box::pin(f));
    }

    #[test]
    #[ignore]
    #[cfg(feature = "tokio-runtime")]
    fn redelivery() {
        let _ = log::set_logger(&TEST_LOGGER);
        let _ = log::set_max_level(LevelFilter::Debug);
        let runtime = Runtime::new().unwrap();

        let addr = "pulsar://127.0.0.1:6650";
        let (tx, rx) = std::sync::mpsc::channel();

        let mut seen = BTreeSet::new();
        let start = Instant::now();
        let resend_delay = Duration::from_secs(4);

        let message_count = 10;
        let f = async move {
            let pulsar: Pulsar<TokioExecutor> = Pulsar::builder(addr).build().await.unwrap();

            let topic: String = std::iter::repeat(())
                .map(|()| rand::thread_rng().sample(Alphanumeric))
                .take(7)
                .collect();
            let mut producer = pulsar.create_producer(&topic, None, ProducerOptions::default()).await.unwrap();

            let mut consumer: Consumer<TestData> = pulsar
                .consumer()
                .with_topic(&topic)
                .with_consumer_name("test_consumer")
                .with_subscription_type(SubType::Exclusive)
                .with_subscription("test_subscription")
                .with_unacked_message_resend_delay(Some(resend_delay))
                .build()
                .await
                .unwrap();


            for i in 0u8..message_count {
                producer.send(
                    TestData {
                        data: i.to_string(),
                    },
                    ).await.unwrap();
            }

            let mut count = 0usize;
            while let Some(res) = consumer.next().await {

                let message = res.unwrap();
                let data = message.deserialize().unwrap();
                tx.send(data.data.clone()).unwrap();
                if !seen.contains(&data.data) {
                    seen.insert(data.data.clone());
                } else {
                    //ack the second time around
                    consumer.ack(&message).await;
                }

                count += 1;
                if count == message_count as usize * 2 {
                    break;
                }
            }
                //FIXME .timeout(Duration::from_secs(15))
        };


        runtime.spawn(Box::pin(f));

        let mut counts = BTreeMap::new();

        let timeout = Instant::now() + Duration::from_secs(2);
        let mut read_count = 0;

        while read_count < message_count {
            if let Ok(data) = rx.try_recv() {
                read_count += 1;
                *counts.entry(data).or_insert(0) += 1;
            } else {
                std::thread::sleep(Duration::from_millis(10));
            }
            if Instant::now() > timeout {
                panic!("timed out waiting for messages to be read");
            }
        }

        //check all messages we received are correct
        (0..message_count).for_each(|i| {
            let count = counts.get(&i.to_string());
            if counts.get(&i.to_string()) != Some(&1) {
                println!(
                    "Expected {} count to be 1, found {}",
                    i,
                    count.cloned().unwrap_or(0)
                );
                panic!("{:?}", counts);
            }
        });
        let mut redelivery_start = None;

        let timeout = Instant::now() + resend_delay + Duration::from_secs(4);
        while read_count < 2 * message_count {
            if let Ok(data) = rx.try_recv() {
                if redelivery_start.is_none() {
                    redelivery_start = Some(Instant::now());
                }
                read_count += 1;
                *counts.entry(data).or_insert(0) += 1;
            } else {
                std::thread::sleep(Duration::from_millis(10));
            }
            if Instant::now() > timeout {
                println!("{:?}", counts);
                panic!("timed out waiting for messages to be read");
            }
        }
        let redelivery_start = redelivery_start.unwrap();
        let expected_redelivery_start = start + resend_delay;
        println!(
            "start: 0ms, delay: {}ms, redelivery_start: {}ms, expected_redelivery: {}ms",
            resend_delay.as_millis(),
            (redelivery_start - start).as_millis(),
            (expected_redelivery_start - start).as_millis()
        );
        assert!(redelivery_start > expected_redelivery_start - Duration::from_secs(1));
        assert!(redelivery_start < expected_redelivery_start + Duration::from_secs(1));
        (0u8..message_count).for_each(|i| {
            let count = counts.get(&i.to_string());
            if count != Some(&2) {
                println!(
                    "Expected {} count to be 2, found {}",
                    i,
                    count.cloned().unwrap_or(0)
                );
                panic!("{:?}", counts);
            }
        });
    }
}