mscheduler 0.3.1

Use mongodb to schedule task running
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
use std::collections::HashMap;
use std::marker::PhantomData;
use std::sync::atomic::Ordering::SeqCst;
use std::sync::atomic::{AtomicBool, AtomicU32};
use std::sync::{Arc, Mutex};
use std::time::Duration;

use async_trait::async_trait;
use futures::StreamExt;
use mongodb::bson::{doc, to_bson, DateTime, Document};
use mongodb::options::{ChangeStreamOptions, FullDocumentType};
use mongodb::Collection;
use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};
use strum::Display;
use tokio::select;
use tokio::sync::broadcast::{Receiver, Sender};
use tokio::task::JoinHandle;
use tokio::time::MissedTickBehavior;
use tokio_util::time::delay_queue::Expired;
use tokio_util::time::DelayQueue;
use tracing::{error, info, instrument, trace, warn};
use typed_builder::TypedBuilder;

use crate::tasker::consumer::ConsumerEvent::{
    MarkSuccess, TaskExecuteResult, TaskOccupyResult, WaitOccupy, WaitOccupyQueueEmpty,
};
use crate::tasker::error::MSchedulerError::{ExecutionError, MongoDbError, NoTaskMatched};
use crate::tasker::error::{MResult, MSchedulerError};
use crate::tasker::task::Task;

#[async_trait]
pub trait TaskConsumerFunc<T: Send, K: Send>: Send + Sync + 'static {
    async fn consume(&self, params: Option<T>) -> MResult<K>;
}

#[derive(Deserialize, TypedBuilder, Debug, Clone)]
#[builder(field_defaults(default, setter(into)))]
#[non_exhaustive]
pub struct TaskConsumerConfig {
    // specific this worker's id, used to remote control worker behavior, also can be used to choose which task to run
    pub worker_id: String,
}

impl TaskConsumerConfig {
    pub fn get_worker_id(&self) -> &str {
        self.worker_id.as_str()
    }
}

pub struct SharedConsumerState<T: Send + Sync, K: Send + Sync, Func: TaskConsumerFunc<T, K>> {
    collection: Collection<Task<T, K>>,
    func: Arc<Func>,
    is_fully_scanned: AtomicBool,
    config: TaskConsumerConfig,
    max_allowed_task_cnt: AtomicU32,
    consumer_event_sender: Sender<ConsumerEvent>,
    task_map: Mutex<HashMap<String, (JoinHandle<MResult<K>>, String)>>,
}

pub struct TaskConsumer<T: Send + Sync, K: Send + Sync, Func: TaskConsumerFunc<T, K>> {
    marker: PhantomData<Task<T, K>>,
    state: Arc<SharedConsumerState<T, K, Func>>,
}

impl<T: Send + Sync, K: Send + Sync, Func: TaskConsumerFunc<T, K>> Clone
    for TaskConsumer<T, K, Func>
{
    fn clone(&self) -> Self {
        TaskConsumer {
            marker: Default::default(),
            state: self.state.clone(),
        }
    }
}

/// used to notify both inner and outer receivers
#[derive(Clone, Debug, Display)]
pub enum ConsumerEvent {
    WaitOccupy {
        key: String,
        next_occupy_time: DateTime,
    },
    WaitOccupyQueueEmpty,
    TaskOccupyResult {
        key: String,
        success: bool,
    },
    TaskExecuteResult {
        key: String,
        success: bool,
    },
    /// send this event when task is marked as success
    MarkSuccess {
        key: String,
    },
}

const MAX_CHANNEL_CAPACITY: usize = 2 << 6;

impl<
        T: DeserializeOwned + Send + Unpin + Sync + Clone + 'static,
        K: Serialize + DeserializeOwned + Send + Unpin + Sync + 'static,
        Func: TaskConsumerFunc<T, K> + Send,
    > TaskConsumer<T, K, Func>
{
    pub fn get_running_task_cnt(&self) -> u32 {
        self.state
            .task_map
            .lock()
            .expect("failed to lock task_map")
            .len() as u32
    }
    pub fn set_max_worker_cnt(&self, max_worker_cnt: u32) {
        self.state
            .max_allowed_task_cnt
            .store(max_worker_cnt, SeqCst);
    }

    pub fn get_max_worker_cnt(&self) -> u32 {
        self.state.max_allowed_task_cnt.load(SeqCst)
    }

    pub fn get_event_receiver(&self) -> Receiver<ConsumerEvent> {
        self.state.consumer_event_sender.subscribe()
    }

    #[instrument(skip_all)]
    pub async fn create(
        collection: Collection<Task<T, K>>,
        func: Func,
        config: TaskConsumerConfig,
    ) -> MResult<Self> {
        // receiver is dropped as we will spawn new in tokio::spawn
        let (sender, _) = tokio::sync::broadcast::channel::<ConsumerEvent>(MAX_CHANNEL_CAPACITY);
        let shared_consumer_state = SharedConsumerState {
            collection,
            func: Arc::new(func),
            is_fully_scanned: Default::default(),
            config,
            max_allowed_task_cnt: AtomicU32::new(u32::MAX),
            consumer_event_sender: sender,
            task_map: Default::default(),
        };
        let consumer = TaskConsumer {
            marker: Default::default(),
            state: Arc::new(shared_consumer_state),
        };
        Ok(consumer)
    }

    #[instrument(skip(queue))]
    pub fn add2queue(key: String, run_time: DateTime, queue: &Mutex<DelayQueue<String>>) {
        let diff = run_time.timestamp_millis() - DateTime::now().timestamp_millis();
        trace!("add key {} to wait queue", &key);
        if diff <= 0 {
            queue.lock().unwrap().insert(key, Duration::ZERO);
        } else {
            // diff max at about 2 years, we limit it to 1000 seconds
            queue
                .lock()
                .unwrap()
                .insert(key, Duration::from_millis(diff.min(1_000_000) as u64));
        }
    }

    #[instrument(skip_all)]
    pub async fn wait_for_event<F: Fn(&ConsumerEvent) -> bool>(
        self: &Self,
        check: F,
    ) -> Option<ConsumerEvent> {
        while let Ok(event) = self.get_event_receiver().recv().await {
            if check(&event) {
                return Some(event);
            }
        }
        None
    }

    #[instrument(skip_all)]
    pub async fn wait_for_event_with_timeout<F: Fn(&ConsumerEvent) -> bool>(
        self: &Self,
        check: F,
        timeout: Duration,
    ) -> Option<ConsumerEvent> {
        select! {
            _=tokio::time::sleep(timeout)=>{
                None
            }
            result=self.wait_for_event(check)=>{
                result
            }
        }
    }

    pub async fn start(self: &Self) {
        select! {
            _=TaskConsumer::<T, K, Func>::spawn_listen_db(self.state.clone())=>{
                warn!("listen_db loop exits");
            }
            _=TaskConsumer::<T, K, Func>::spawn_fetch_db(self.state.clone())=>{
                warn!("fetch_db loop exits");
            }
            _=TaskConsumer::<T, K, Func>::spawn_occupy(self.state.clone())=>{
                warn!("occupy loop exits");
            }
        }
    }

    #[instrument(skip_all)]
    pub async fn shutdown(self: &Self) {
        // disallow occupy new task, task_map will not change now
        self.set_max_worker_cnt(0);
        // so we can fetch all tasks
        let mutex_guard = self
            .state
            .task_map
            .lock()
            .expect("failed to get task map")
            .drain()
            .into_iter()
            .collect::<Vec<_>>();
        for (key, (_handler, running_id)) in mutex_guard.iter() {
            // TODO: fail with no time delay
            if let Err(e) = TaskConsumer::mark_task_fail(self.state.clone(), key, running_id).await
            {
                error!("failed to mark task as failed before shutdown {}", e);
            }
        }
        info!("consumer shutdown completed");
    }

    async fn spawn_occupy(state: Arc<SharedConsumerState<T, K, Func>>) {
        trace!("spawn_occupy");
        let mut receiver = state.consumer_event_sender.subscribe();
        let sender = state.consumer_event_sender.clone();
        let mut queue = DelayQueue::<String>::new();
        let mut key2queue_key = HashMap::new();
        loop {
            select! {
                Ok(consumer_event) = receiver.recv()=>{
                    match &consumer_event {
                        WaitOccupy { key, next_occupy_time } => {
                            let wait_ms = next_occupy_time.timestamp_millis() - DateTime::now().timestamp_millis();
                            let wait_ms = wait_ms.max(0);
                            let duration=Duration::from_millis(wait_ms as u64);
                            if let Some(k)=key2queue_key.get(key){
                                queue.reset(k, duration);
                            }else{
                                let queue_key=queue.insert(key.clone(), duration);
                                key2queue_key.insert(key.clone(), queue_key);
                            }
                        }
                        _=>{}
                    }
                }
                Some(expired)=futures::future::poll_fn(|cx| queue.poll_expired(cx))=>{
                    if queue.is_empty(){
                        if let Err(e)=sender.send(WaitOccupyQueueEmpty){
                            error!("failed to send occupy queue empty event {}",e);
                        }
                    }
                    let max_allowed_task_cnt = state.max_allowed_task_cnt.load(SeqCst);
                    let task_cnt = state.task_map.lock().unwrap().len()as u32;
                    key2queue_key.remove(expired.get_ref());
                    if task_cnt<max_allowed_task_cnt {
                        let _=TaskConsumer::try_occupy_task(state.clone(), &expired).await;
                    }
                }
            }
        }
    }

    /// this function should have bounded running time
    /// 1. occupy operation should have a timeout
    /// 2. avoid blocking select loop
    #[instrument(skip_all)]
    async fn try_occupy_task(
        state: Arc<SharedConsumerState<T, K, Func>>,
        expired: &Expired<String>,
    ) -> MResult<()> {
        let task_key = expired.get_ref();
        // occupy task first
        let (task, running_id) =
            match TaskConsumer::occupy_task(state.clone(), task_key.as_str()).await {
                Ok(v) => v,
                Err(e) => {
                    return Err(e);
                }
            };
        // start running task and handle results in this function
        TaskConsumer::execute_task(state, task, running_id).await;
        Ok(())
    }

    #[instrument(skip(state, key,running_id,returns), fields(key = %key.as_ref(),running_id = %running_id.as_ref()))]
    async fn postprocess_task(
        state: Arc<SharedConsumerState<T, K, Func>>,
        key: impl AsRef<str>,
        returns: &MResult<K>,
        running_id: impl AsRef<str>,
    ) {
        match returns {
            Ok(result) => {
                let _ = TaskConsumer::mark_task_success(state, key, running_id, Some(result)).await;
            }
            Err(_) => {
                // make this worker retry a bit later than other workers
                let next_occupy_time =
                    DateTime::from_millis(DateTime::now().timestamp_millis() + 3_000);
                if let Err(e) = state.consumer_event_sender.send(WaitOccupy {
                    key: key.as_ref().to_string(),
                    next_occupy_time,
                }) {
                    error!("failed to notify retry occupy {}", e);
                }
                let _ = TaskConsumer::mark_task_fail(state, key, running_id).await;
            }
        }
    }

    /// no need to store result
    #[instrument(skip(state, key,running_id,returns), fields(key = %key.as_ref(),running_id = %running_id.as_ref()))]
    async fn mark_task_success(
        state: Arc<SharedConsumerState<T, K, Func>>,
        key: impl AsRef<str>,
        running_id: impl AsRef<str>,
        returns: Option<&K>,
    ) -> MResult<Task<T, K>> {
        // the filter matches a specific running task.
        let filter = Self::verify_matched_running_task(&state, &key, &running_id);
        let mut set_fields = doc! {
            "task_state.worker_states.$.success_time":DateTime::now(),
        };
        if let Some(value) = returns {
            match to_bson(value) {
                Ok(bson_value) => {
                    set_fields.insert("task_state.worker_states.$.returns", bson_value);
                }
                Err(e) => {
                    error!(
                        "failed to serialize task returns for key={} running_id={}: {}",
                        key.as_ref(),
                        running_id.as_ref(),
                        e
                    );
                }
            }
        }
        let update = doc! {
            "$set":set_fields
        };
        let task = match state.collection.find_one_and_update(filter, update).await {
            Ok(Some(v)) => {
                trace!("mark as success completed key={}", key.as_ref());
                if let Err(e) = state.consumer_event_sender.send(MarkSuccess {
                    key: key.as_ref().to_string(),
                }) {
                    error!("failed to send success event {}", &e);
                }
                v
            }
            Ok(None) => {
                error!("failed to mark task as success, cannot find that task");
                return Err(NoTaskMatched);
            }
            Err(e) => {
                error!("failed to mark task as success, cannot find that task");
                return Err(MongoDbError(Arc::from(e)));
            }
        };
        Ok(task)
    }

    /// no need to store error reason now
    #[instrument(skip(state, key,running_id), fields(key = %key.as_ref(),running_id = %running_id.as_ref()))]
    async fn mark_task_fail(
        state: Arc<SharedConsumerState<T, K, Func>>,
        key: impl AsRef<str>,
        running_id: impl AsRef<str>,
    ) -> MResult<Task<T, K>> {
        // the filter should the specific running task.
        // however we loose the restriction to not fail or success
        let filter = Self::verify_matched_running_task(&state, &key, &running_id);
        let update = doc! {
            "$set":{
                "task_state.worker_states.$.fail_time":DateTime::now(),
            }
        };
        trace!("mark_task_fail {}", &filter);
        let task = match state.collection.find_one_and_update(filter, update).await {
            Ok(Some(v)) => {
                trace!("mark as failed completed key={}", key.as_ref());
                v
            }
            Ok(None) => {
                error!("failed to mark task as failed, cannot find that task");
                return Err(NoTaskMatched);
            }
            Err(e) => {
                error!("failed to mark task as failed, {}", &e);
                return Err(MongoDbError(Arc::from(e)));
            }
        };
        Ok(task)
    }

    #[instrument(skip_all, fields(key = %key.as_ref(),running_id = %running_id.as_ref()))]
    fn verify_matched_running_task(
        state: &Arc<SharedConsumerState<T, K, Func>>,
        key: impl AsRef<str>,
        running_id: impl AsRef<str>,
    ) -> Document {
        let filter = doc! {
            "key": key.as_ref(),
            "task_state.worker_states":{
                "$elemMatch": {
                    "running_id": running_id.as_ref(),
                    "worker_id": &state.config.worker_id,
                    "fail_time": {"$eq": null},
                    "success_time": {"$eq": null}
                }
            }
        };
        filter
    }

    #[instrument(skip(state, task,running_id), fields(task.key = %task.key))]
    async fn execute_task(
        state: Arc<SharedConsumerState<T, K, Func>>,
        task: Task<T, K>,
        running_id: impl AsRef<str> + ToString,
    ) {
        let key = task.key;
        let running_id = running_id.as_ref().to_string();
        let ping_logic = {
            let key = key.clone();
            let state = state.clone();
            let running_id = running_id.clone();
            let worker_timeout_ms = task.task_option.worker_timeout_ms;
            let ping_interval_ms = task.task_option.ping_interval_ms;
            // 3 to ensure not accidentally exit
            let max_fail_cnt = worker_timeout_ms.div_ceil(ping_interval_ms).max(3);
            let mut continuous_fail_cnt = 0;
            async move {
                let mut interval =
                    tokio::time::interval(Duration::from_millis(ping_interval_ms as u64));
                interval.set_missed_tick_behavior(MissedTickBehavior::Delay);
                loop {
                    interval.tick().await;
                    match TaskConsumer::ping_task(
                        state.clone(),
                        &key,
                        &running_id,
                        worker_timeout_ms,
                    )
                    .await
                    {
                        Ok(_) => {}
                        Err(NoTaskMatched) => {
                            trace!("failed to find task to ping key={}", &key);
                            // cannot find matched task, exit immediately
                            return MResult::<()>::Err(NoTaskMatched);
                        }
                        Err(e) => {
                            // keep trying until thread meets
                            continuous_fail_cnt += 1;
                            if continuous_fail_cnt >= max_fail_cnt {
                                error!("max ping retry encountered, exit now");
                                return Err(e);
                            }
                        }
                    }
                }
            }
        };
        let consume_logic = {
            let key = key.clone();
            let state = state.clone();
            let running_id = running_id.clone();
            async move {
                trace!("start to consume task now key={}", &key);
                let result = state.func.consume(task.params).await;
                trace!("task consumed key={}", &key);
                // post-processing in this thread
                let _ =
                    TaskConsumer::postprocess_task(state.clone(), key.clone(), &result, running_id)
                        .await;
                // send event
                if let Err(e) = state.consumer_event_sender.send(TaskExecuteResult {
                    key: key.clone(),
                    success: result.is_ok(),
                }) {
                    error!("failed to send post process event {}", e);
                }
                result
            }
        };
        let execution_logic = {
            let key = key.clone();
            let state = state.clone();
            async move {
                let result_value = select! {
                    _=ping_logic=>{
                        Err(MSchedulerError::PanicError)
                    }
                    result=consume_logic=>{
                        result
                    }
                };
                state
                    .task_map
                    .lock()
                    .expect("failed to lock task_map")
                    .remove(&key);
                result_value
            }
        };
        let join_handle = tokio::spawn(execution_logic);
        state
            .task_map
            .lock()
            .expect("failed to lock task_map")
            .insert(key, (join_handle, running_id));
    }

    #[instrument(skip(state,key,running_id), fields(key = %key.as_ref(),running_id = %running_id.as_ref()))]
    async fn ping_task(
        state: Arc<SharedConsumerState<T, K, Func>>,
        key: impl AsRef<str>,
        running_id: impl AsRef<str>,
        worker_timeout_ms: u32,
    ) -> MResult<Task<T, K>> {
        let task_key = key.as_ref();
        let running_id = running_id.as_ref();
        let next_expire_time =
            DateTime::from_millis(DateTime::now().timestamp_millis() + worker_timeout_ms as i64);

        let filter = Self::verify_matched_running_task(&state, &task_key, &running_id);
        let update = doc! {
            "$set":{
                "task_state.worker_states.$.ping_expire_time":next_expire_time,
            }
        };
        match state.collection.find_one_and_update(filter, update).await {
            Ok(Some(v)) => {
                trace!("successfully ping task key={}", &task_key);
                Ok(v)
            }
            Ok(None) => {
                trace!(
                    "failed to occupy task key={} cannot get matched task",
                    task_key
                );
                // no need to report failed to compete with other workers
                Err(NoTaskMatched)
            }
            Err(e) => {
                if let Err(e) = state.consumer_event_sender.send(TaskOccupyResult {
                    key: task_key.to_string(),
                    success: false,
                }) {
                    error!("failed to send occupy success event {}", e);
                }
                error!("failed to occupy task {}", &e);
                Err(ExecutionError(Box::new(e)))
            }
        }
    }

    #[instrument(skip(state,task_key), fields(task_key = %task_key.as_ref()))]
    async fn occupy_task(
        state: Arc<SharedConsumerState<T, K, Func>>,
        task_key: impl AsRef<str>,
    ) -> MResult<(Task<T, K>, String)> {
        let worker_id = &state.config.worker_id;
        let task_key = task_key.as_ref();
        trace!("try_occupy_task now key={} {}", task_key, worker_id);
        let all_conditions = vec![
            // match key
            doc! {"key":task_key},
            // max retry check
            Self::verify_not_completely_failed(worker_id),
            // double occupy check
            Self::verify_double_occupy(worker_id),
            // concurrent limit check
            Self::verify_concurrent_limit_check(true),
        ];
        let expire_time = DateTime::from_millis(DateTime::now().timestamp_millis() + 10_000i64);
        // some information on how to push elements into array
        // https://stackoverflow.com/questions/37427610/mongodb-update-or-insert-object-in-array
        let running_id = DateTime::now().timestamp_millis().to_string();
        let update = vec![doc! {
            "$set": {
                "task_state.worker_states": {
                    "$concatArrays": [{
                        "$filter": {
                            "input": "$task_state.worker_states",
                            "as": "item",
                            "cond": {"$or":[
                              { "$gt": ["$$item.ping_expire_time", "$$NOW"] },
                              { "$ne": ["$$item.success_time", null] },
                              { "$ne": ["$$item.fail_time", null] },
                            ]}
                        }
                    }, [{
                        "running_id": &running_id,
                        "worker_id": worker_id,
                        "ping_expire_time": expire_time,
                        "success_time": null,
                        "fail_time": null,
                    }]]
                }
            }
        }];
        let filter = doc! {"$and":all_conditions};
        trace!("updating {}", filter);
        match state.collection.find_one_and_update(filter, update).await {
            Ok(Some(v)) => {
                trace!("successfully occupy task key={}", &task_key);
                if let Err(e) = state.consumer_event_sender.send(TaskOccupyResult {
                    key: task_key.to_string(),
                    success: true,
                }) {
                    error!("failed to send occupy success event {}", e);
                }
                Ok((v, running_id))
            }
            Ok(None) => {
                trace!(
                    "failed to occupy task key={} cannot get matched task",
                    task_key
                );
                // no need to report failed to compete with other workers
                Err(NoTaskMatched)
            }
            Err(e) => {
                if let Err(e) = state.consumer_event_sender.send(TaskOccupyResult {
                    key: task_key.to_string(),
                    success: false,
                }) {
                    error!("failed to send occupy success event {}", e);
                }
                error!("failed to occupy task {}", &e);
                Err(ExecutionError(Box::new(e)))
            }
        }
    }

    fn verify_concurrent_limit_check(check_running: bool) -> Document {
        let mut conditions = vec![
            // success
            doc! {
                "$and": [
                    {
                        "$ne": [
                        "$$item.success_time", null]
                    },
                    {
                        "$eq": [
                        "$$item.fail_time", null]
                    },
                ]
            },
        ];
        // running
        if check_running {
            conditions.push(doc! {
                "$and": [
                    {
                        "$gt": [
                        "$$item.ping_expire_time", DateTime::now()]
                    },
                    {
                        "$eq": [
                        "$$item.success_time", null]
                    },
                    {
                        "$eq": [
                        "$$item.fail_time", null]
                    },
                ]
            });
        }
        doc! {
            "$expr": {
                "$lt": [{
                    "$size": {
                        "$filter": {
                            "input": "$task_state.worker_states",
                            "as": "item",
                            "cond": {"$or":conditions}
                        }
                    }
                }, "$task_option.concurrent_worker_cnt"]
            }
        }
    }

    /// if this passes, then no double occupy
    fn verify_double_occupy(worker_id: &String) -> Document {
        doc! {
            "$expr": {
                "$eq": [{
                    "$size": {
                        "$filter": {
                            "input": "$task_state.worker_states",
                            "as": "item",
                            "cond": {"$and":[
                                // running
                                { "$gt": ["$$item.ping_expire_time", DateTime::now()] },
                                { "$eq": ["$$item.success_time", null] },
                                { "$eq": ["$$item.fail_time", null] },
                                // and belong to this worker
                                { "$eq": ["$$item.worker_id", worker_id]  },
                            ]}
                        }
                    }
                }, 0]
            }
        }
    }

    /// if this passes, then this worker can run this task
    fn verify_allowed_worker_id(worker_id: &String) -> Document {
        doc! {
            "$or": [
                {
                    "task_option.specific_worker_ids": { "$eq": [] }
                },
                {
                    "task_option.specific_worker_ids": { "$in": [worker_id] }
                }
            ]
        }
    }

    /// if this passes, not completely failed
    /// NOTE: we only need to consider this worker, we cannot interface other worker's retry count
    fn verify_not_completely_failed(worker_id: &String) -> Document {
        doc! {
            "$expr": {
                "$lt": [{
                    "$size": {
                        "$filter": {
                            "input": "$task_state.worker_states",
                            "as": "item",
                            "cond": {"$and":[
                              { "$eq": ["$$item.worker_id", worker_id]  },
                              { "$ne": ["$$item.fail_time", null] },
                            ]}
                        }
                    }
                }, "$task_option.max_unexpected_retries"]
            }
        }
    }

    /// if this passes, then not completely success
    fn verify_not_completely_success() -> Document {
        // task should not be completely success
        doc! {
            "$expr": {
                "$ne": [{
                    "$size": {
                        "$filter": {
                            "input": "$task_state.worker_states",
                            "as": "item",
                            "cond": { "$ne": ["$$item.success_time", null] }
                        }
                    }
                }, "$task_option.max_unexpected_retries"]
            }
        }
    }

    #[instrument(skip(state))]
    async fn fetch_task(state: Arc<SharedConsumerState<T, K, Func>>) -> MResult<()> {
        let worker_id = &state.config.worker_id;

        let all_conditions = vec![
            // not completely success
            Self::verify_not_completely_success(),
            // check if worker id is allowed
            Self::verify_allowed_worker_id(worker_id),
            // max retry check
            Self::verify_not_completely_failed(worker_id),
            // double occupy check
            Self::verify_double_occupy(worker_id),
            // concurrent limit check
            Self::verify_concurrent_limit_check(false),
        ];
        let filter = doc! {"$and":all_conditions};
        trace!("fetch_task {}", &filter);
        let mut cursor = match state.collection.find(filter).await {
            Ok(v) => v,
            Err(e) => {
                error!("failed to fetch more tasks {}", e);
                return Err(MongoDbError(Arc::new(e)));
            }
        };
        for _ in 0..10 {
            match cursor.next().await {
                None => {
                    trace!("all remaining tasks scanned");
                    state.is_fully_scanned.store(true, SeqCst);
                    break;
                }
                Some(Err(e)) => {
                    error!("failed to get more existing tasks {}", e);
                    break;
                }
                Some(Ok(task)) => {
                    let event =
                        match TaskConsumer::<T, K, Func>::infer_consumer_event_from_task(task) {
                            None => {
                                trace!("task scanned no event is inferred");
                                continue;
                            }
                            Some(v) => {
                                trace!("task scanned event is inferred {:?}", &v);
                                v
                            }
                        };
                    if let Err(e) = state.consumer_event_sender.send(event) {
                        error!("failed to add new scanned task {}", &e);
                    }
                }
            }
        }

        Ok(())
    }

    #[instrument(skip(state))]
    async fn spawn_fetch_db(state: Arc<SharedConsumerState<T, K, Func>>) -> MResult<()> {
        trace!("spawn_fetch_db");
        let mut receiver = state.consumer_event_sender.subscribe();
        loop {
            match receiver.recv().await {
                Ok(WaitOccupyQueueEmpty) => {
                    if state.is_fully_scanned.load(SeqCst) {
                        continue;
                    }
                    let _ = TaskConsumer::fetch_task(state.clone()).await;
                }
                Ok(_) => {}
                Err(e) => {
                    error!("failed to receive event {}", e);
                    break;
                }
            }
        }
        Ok(())
    }

    #[instrument(skip(state))]
    async fn spawn_listen_db(state: Arc<SharedConsumerState<T, K, Func>>) -> MResult<()> {
        trace!("spawn_listen_db");
        // clone a receiver for this session
        let event_sender = state.consumer_event_sender.clone();
        let worker_id = &state.config.worker_id;
        // open change stream
        let change_stream_options = ChangeStreamOptions::builder()
            .full_document(Some(FullDocumentType::UpdateLookup))
            .build();
        let pipeline = [
            // copy fields to root level so we can reuse verify logic
            doc! {
                "$addFields":{
                    "task_state":"$fullDocument.task_state",
                    "task_option":"$fullDocument.task_option"
                }
            },
            // only these events are required, complete list is https://www.mongodb.com/docs/manual/reference/change-events/#std-label-change-stream-output
            doc! {
                "$match":{
                    "operationType":{"$in":["insert","replace","update"]}
                }
            },
            // filter some unnecessary task updates
            doc! {
                "$match":{
                    "$and":[
                        // avoid try to occupy already occupied task
                        Self::verify_double_occupy(worker_id),
                        // check if worker id is allowed
                        Self::verify_allowed_worker_id(worker_id),
                        // not completely success, so we have a chance to occupy
                        Self::verify_not_completely_success(),
                        // not completely failed, so we have a chance to occupy
                        Self::verify_not_completely_failed(worker_id),
                    ]
                }
            },
            doc! {
                "$project":{
                    // _id cannot get filtered, will get error if filtered
                    "operationType":1_i32,
                    // mongodb-rust says ns field should not get filtered
                    "ns":1_i32,
                    "fullDocument":1_i32,
                    // "fullDocument.key":"$fullDocument.key",
                    // "fullDocument.next_occupy_time":{"$max":["$fullDocument.task_state.start_time", {"$max":"$fullDocument.task_state.worker_states.ping_expire_time"}]},
                }
            },
        ];
        let mut change_stream = match state
            .collection
            .clone_with_type::<Task<T, K>>()
            .watch()
            .pipeline(pipeline)
            .with_options(change_stream_options)
            .await
        {
            Ok(v) => v,
            Err(e) => {
                error!("failed to open change stream {}", e);
                return Err(MongoDbError(e.into()));
            }
        };

        // keep track if we checked all existing tasks, and whether we could listen to change stream only.
        // after change stream restarts, we assume some tasks may be updated during the restart gap
        state.is_fully_scanned.store(false, SeqCst);

        // send a fetch request to fill up some tasks
        let _ = event_sender.send(WaitOccupyQueueEmpty).map_err(|e| {
            error!(
                "failed to fill up task queue at the start of change stream {}",
                e
            )
        });
        info!("start to listen to change stream");

        // listen to change event and send them to next processing stage
        while let Some(event) = change_stream.next().await {
            let change_stream_event = match event {
                Ok(v) => v,
                Err(e) => {
                    error!("failed to get change stream event {}", e);
                    continue;
                }
            };
            let task = match change_stream_event.full_document {
                None => {
                    warn!("change stream has no document");
                    continue;
                }
                Some(v) => v,
            };
            trace!("stream found key ={}", &task.key);
            let consumer_event =
                match TaskConsumer::<T, K, Func>::infer_consumer_event_from_task(task) {
                    None => {
                        // this is normal
                        continue;
                    }
                    Some(v) => v,
                };
            if let Err(e) = event_sender.send(consumer_event) {
                error!("failed to send consumer event {}", e);
            }
        }
        error!("change stream exited");
        Ok(())
    }

    #[instrument(skip(task), fields(task_id=%task.key))]
    fn infer_consumer_event_from_task(task: Task<T, K>) -> Option<ConsumerEvent> {
        // TODO: multiple worker cnt, occupy now
        let mut all_fail = true;
        let mut max_time = task.task_state.create_time;
        for state in task.task_state.worker_states {
            if let Some(t) = state.ping_expire_time {
                max_time = max_time.max(t);
            }
            if state.fail_time.is_none() {
                all_fail = false;
            }
        }
        let next_occupy_time = if all_fail { DateTime::now() } else { max_time };
        let event = WaitOccupy {
            key: task.key,
            next_occupy_time,
        };
        Some(event)
    }
}