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
420
421
422
use std::collections::HashMap;
use std::ops::{Deref, DerefMut};

use std::sync::Arc;
use std::time::Duration;

use async_channel::Receiver;
use tokio::sync::oneshot;
use tokio::sync::Mutex;
use tokio::task::JoinHandle;
use tokio::time::timeout;

use google_cloud_gax::grpc::Status;
use google_cloud_gax::retry::RetrySetting;
use google_cloud_googleapis::pubsub::v1::{PublishRequest, PubsubMessage};

use crate::apiv1::publisher_client::PublisherClient;
use crate::util::ToUsize;

pub(crate) struct ReservedMessage {
    pub producer: oneshot::Sender<Result<String, Status>>,
    pub message: PubsubMessage,
}

pub(crate) enum Reserved {
    Single(ReservedMessage),
    Multi(Vec<ReservedMessage>),
}

#[derive(Debug, Clone)]
pub struct PublisherConfig {
    /// worker count. each workers have gRPC channel
    pub workers: usize,
    /// interval for flush bundle message
    pub flush_interval: Duration,
    /// max bundle size to flush
    pub bundle_size: usize,
    pub retry_setting: Option<RetrySetting>,
}

impl Default for PublisherConfig {
    fn default() -> Self {
        Self {
            workers: 3,
            flush_interval: Duration::from_millis(100),
            bundle_size: 3,
            retry_setting: None,
        }
    }
}

pub struct Awaiter {
    consumer: oneshot::Receiver<Result<String, Status>>,
}

impl Awaiter {
    pub(crate) fn new(consumer: oneshot::Receiver<Result<String, Status>>) -> Self {
        Self { consumer }
    }
    pub async fn get(self) -> Result<String, Status> {
        match self.consumer.await {
            Ok(v) => v,
            Err(_e) => Err(Status::cancelled("closed")),
        }
    }
}

/// Publisher is a scheduler which is designed for Pub/Sub's Publish flow.
/// Each item is added with a given key.
/// Items added to the empty string key are handled in random order.
/// Items added to any other key are handled sequentially.
#[derive(Clone, Debug)]
pub struct Publisher {
    ordering_senders: Arc<Vec<async_channel::Sender<Reserved>>>,
    sender: async_channel::Sender<Reserved>,
    tasks: Arc<Mutex<Tasks>>,
    fqtn: String,
    pubc: PublisherClient,
}

impl Publisher {
    pub(crate) fn new(fqtn: String, pubc: PublisherClient, config: Option<PublisherConfig>) -> Self {
        let config = config.unwrap_or_default();
        let (sender, receiver) = async_channel::unbounded::<Reserved>();
        let mut receivers = Vec::with_capacity(config.workers * 2);
        let mut ordering_senders = Vec::with_capacity(config.workers);

        // for non-ordering key message
        for _ in 0..config.workers {
            tracing::trace!("start non-ordering publisher : {}", fqtn.clone());
            receivers.push(receiver.clone());
        }

        // for ordering key message
        for _ in 0..config.workers {
            tracing::trace!("start ordering publisher : {}", fqtn.clone());
            let (sender, receiver) = async_channel::unbounded::<Reserved>();
            receivers.push(receiver);
            ordering_senders.push(sender);
        }

        Self {
            sender,
            ordering_senders: Arc::new(ordering_senders),
            tasks: Arc::new(Mutex::new(Tasks::new(fqtn.clone(), pubc.clone(), receivers, config))),
            fqtn,
            pubc,
        }
    }

    /// publish publishes msg to the topic synchronously
    pub async fn publish_immediately(
        &self,
        messages: Vec<PubsubMessage>,
        retry: Option<RetrySetting>,
    ) -> Result<Vec<String>, Status> {
        self.pubc
            .publish(
                PublishRequest {
                    topic: self.fqtn.clone(),
                    messages,
                },
                retry,
            )
            .await
            .map(|v| v.into_inner().message_ids)
    }

    /// publish publishes msg to the topic asynchronously. Messages are batched and
    /// sent according to the topic's PublisherConfig. Publish never blocks.
    ///
    /// publish returns a non-nil Awaiter which will be ready when the
    /// message has been sent (or has failed to be sent) to the server.
    pub async fn publish(&self, message: PubsubMessage) -> Awaiter {
        let (producer, consumer) = oneshot::channel();
        if message.ordering_key.is_empty() {
            let _ = self
                .sender
                .send(Reserved::Single(ReservedMessage { producer, message }))
                .await;
        } else {
            let key = message.ordering_key.as_str().to_usize();
            let index = key % self.ordering_senders.len();
            let _ = self.ordering_senders[index]
                .send(Reserved::Single(ReservedMessage { producer, message }))
                .await;
        }
        Awaiter::new(consumer)
    }

    /// Publish a message to the topic asynchronously, from synchronous code.
    /// This method blocks until the message is sent to the publisher channel.
    /// The actual publishing to the server is done asynchronously.
    pub fn publish_blocking(&self, message: PubsubMessage) -> Awaiter {
        let (producer, consumer) = oneshot::channel();
        if message.ordering_key.is_empty() {
            let _ = self
                .sender
                .send_blocking(Reserved::Single(ReservedMessage { producer, message }));
        } else {
            let key = message.ordering_key.as_str().to_usize();
            let index = key % self.ordering_senders.len();
            let _ = self.ordering_senders[index].send_blocking(Reserved::Single(ReservedMessage { producer, message }));
        }
        Awaiter::new(consumer)
    }

    /// publish_bulk publishes msg to the topic asynchronously. Messages are batched and
    /// sent according to the topic's PublisherConfig. Publish never blocks.
    ///
    /// publish_bulk returns a non-nil Awaiter which will be ready when the
    /// message has been sent (or has failed to be sent) to the server.
    pub async fn publish_bulk(&self, messages: Vec<PubsubMessage>) -> Vec<Awaiter> {
        let mut awaiters = Vec::with_capacity(messages.len());
        let mut split_by_key = HashMap::<String, Vec<ReservedMessage>>::with_capacity(messages.len());
        for message in messages {
            let (producer, consumer) = oneshot::channel();
            awaiters.push(Awaiter::new(consumer));
            split_by_key
                .entry(message.ordering_key.clone())
                .or_default()
                .push(ReservedMessage { producer, message });
        }

        for e in split_by_key {
            if e.0.is_empty() {
                let _ = self.sender.send(Reserved::Multi(e.1)).await;
            } else {
                let key = e.0.as_str().to_usize();
                let index = key % self.ordering_senders.len();
                let _ = self.ordering_senders[index].send(Reserved::Multi(e.1)).await;
            }
        }
        awaiters
    }

    pub async fn shutdown(&mut self) {
        self.sender.close();
        for s in self.ordering_senders.iter() {
            s.close();
        }
        self.tasks.lock().await.done().await;
    }
}

#[derive(Debug)]
struct Tasks {
    inner: Option<Vec<JoinHandle<()>>>,
}

impl Tasks {
    pub fn new(
        topic: String,
        pubc: PublisherClient,
        receivers: Vec<async_channel::Receiver<Reserved>>,
        config: PublisherConfig,
    ) -> Self {
        let tasks = receivers
            .into_iter()
            .map(|receiver| {
                Self::run_task(
                    receiver,
                    pubc.clone(),
                    topic.clone(),
                    config.retry_setting.clone(),
                    config.flush_interval,
                    config.bundle_size,
                )
            })
            .collect();

        Self { inner: Some(tasks) }
    }

    fn run_task(
        receiver: Receiver<Reserved>,
        mut client: PublisherClient,
        topic: String,
        retry: Option<RetrySetting>,
        flush_interval: Duration,
        bundle_size: usize,
    ) -> JoinHandle<()> {
        tokio::spawn(async move {
            //TODO enable manage task by ordering_key
            let mut bundle = MessageBundle::new();
            while !receiver.is_closed() {
                let result = match timeout(flush_interval, &mut receiver.recv()).await {
                    Ok(result) => result,
                    //timed out
                    Err(_e) => {
                        if !bundle.is_empty() {
                            tracing::trace!("elapsed: flush buffer : {}", topic);
                            for value in bundle.key_by() {
                                Self::flush(&mut client, topic.as_str(), value, retry.clone()).await;
                            }
                            bundle = MessageBundle::new();
                        }
                        continue;
                    }
                };
                match result {
                    Ok(reserved) => {
                        match reserved {
                            Reserved::Single(message) => bundle.push(message),
                            Reserved::Multi(messages) => bundle.extend(messages),
                        }
                        if bundle.len() >= bundle_size {
                            tracing::trace!("bundle size max: {}", topic);
                            for value in bundle.key_by() {
                                Self::flush(&mut client, topic.as_str(), value, retry.clone()).await;
                            }
                            bundle = MessageBundle::new();
                        }
                    }
                    //closed
                    Err(_e) => break,
                };
            }

            tracing::trace!("stop publisher : {}", topic);
            if !bundle.is_empty() {
                tracing::trace!("flush rest buffer : {}", topic);
                for value in bundle.key_by() {
                    Self::flush(&mut client, topic.as_str(), value, retry.clone()).await;
                }
            }
        })
    }

    /// flush publishes the messages in buffer.
    async fn flush(
        client: &mut PublisherClient,
        topic: &str,
        bundle: Vec<ReservedMessage>,
        retry_setting: Option<RetrySetting>,
    ) {
        let mut data = Vec::<PubsubMessage>::with_capacity(bundle.len());
        let mut callback = Vec::<oneshot::Sender<Result<String, Status>>>::with_capacity(bundle.len());
        bundle.into_iter().for_each(|r| {
            data.push(r.message);
            callback.push(r.producer);
        });
        let req = PublishRequest {
            topic: topic.to_string(),
            messages: data,
        };
        let result = client
            .publish(req, retry_setting)
            .await
            .map(|v| v.into_inner().message_ids);

        // notify to receivers
        match result {
            Ok(message_ids) => {
                for (i, p) in callback.into_iter().enumerate() {
                    let message_id = &message_ids[i];
                    if p.send(Ok(message_id.to_string())).is_err() {
                        tracing::error!("failed to notify : id={message_id}");
                    }
                }
            }
            Err(status) => {
                for p in callback.into_iter() {
                    let code = status.code();
                    let status = Status::new(code, (*status.message()).to_string());
                    if p.send(Err(status)).is_err() {
                        tracing::error!("failed to notify : status={}", code);
                    }
                }
            }
        };
    }

    /// done waits for all the workers finish.
    pub async fn done(&mut self) {
        if let Some(tasks) = self.inner.take() {
            for task in tasks {
                let _ = task.await;
            }
        }
    }
}

struct MessageBundle {
    inner: Vec<ReservedMessage>,
}

impl MessageBundle {
    fn new() -> Self {
        Self { inner: vec![] }
    }

    fn key_by(self) -> Vec<Vec<ReservedMessage>> {
        let mut values = HashMap::<String, Vec<ReservedMessage>>::new();
        for v in self.inner {
            let key = v.message.ordering_key.to_string();
            match values.get_mut(&key) {
                Some(e) => {
                    e.push(v);
                }
                None => {
                    values.insert(key, vec![v]);
                }
            }
        }
        let mut result = Vec::with_capacity(values.len());
        for (_, v) in values.into_iter() {
            result.push(v);
        }
        result
    }
}

impl Deref for MessageBundle {
    type Target = Vec<ReservedMessage>;

    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl DerefMut for MessageBundle {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.inner
    }
}

#[cfg(test)]
mod tests {
    use crate::publisher::{MessageBundle, ReservedMessage};
    use google_cloud_googleapis::pubsub::v1::PubsubMessage;
    use tokio::sync::oneshot;

    fn msg(key: &str) -> ReservedMessage {
        let (sender, _) = oneshot::channel();
        ReservedMessage {
            producer: sender,
            message: PubsubMessage {
                ordering_key: key.to_string(),
                ..Default::default()
            },
        }
    }

    #[test]
    fn test_message_bundle_key_by() {
        let mut bundle = MessageBundle::new();
        for key in ["", "a", "b", "c", "A", "", "D", "a"] {
            bundle.push(msg(key));
        }
        let msgs = bundle.key_by();
        assert_eq!(6, msgs.len());
        for msg in msgs {
            let key = msg.first().unwrap().message.ordering_key.clone();
            if key == "a" || key.is_empty() {
                assert_eq!(2, msg.len());
            } else {
                assert_eq!(1, msg.len());
            }
        }
    }
}