dapr-durabletask 0.0.3

Dapr Durable Task Framework
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
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
use std::collections::{HashMap, VecDeque};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, LazyLock, Mutex, MutexGuard};

use futures::future::BoxFuture;
use serde::Serialize;
use serde::de::DeserializeOwned;

use crate::api::{
    DurableTaskError, ExternalEventResult, FailureDetails, HistoryPropagationScope,
    OrchestrationStatus, PropagatedHistory, RetryPolicy,
};
use crate::internal::{to_json, to_timestamp};
use crate::proto;

use super::completable_task::CompletableTask;
use super::options::{ActivityOptions, SubOrchestratorOptions};

/// Patch gate for replay-safe external-event timers.
const EXTERNAL_EVENT_TIMER_PATCH: &str = "dapr:external-event-timer";

/// Sentinel timestamp for indefinite event waits.
static FAR_FUTURE_TIMESTAMP: LazyLock<chrono::DateTime<chrono::Utc>> = LazyLock::new(|| {
    chrono::NaiveDate::from_ymd_opt(9999, 12, 31)
        .unwrap()
        .and_hms_opt(23, 59, 59)
        .unwrap()
        .and_utc()
});

pub(crate) fn lock_inner<T>(m: &Mutex<T>) -> MutexGuard<'_, T> {
    m.lock().unwrap_or_else(|e| e.into_inner())
}

#[derive(Debug)]
pub(crate) struct ContextConfig {
    pub(crate) max_event_names: usize,
    pub(crate) max_events_per_name: usize,
    pub(crate) max_pending_tasks_per_name: usize,
    pub(crate) max_json_payload_size: usize,
}

/// Internal state shared between the context and the orchestration executor.
pub(crate) struct OrchestrationContextInner {
    pub(crate) config: Arc<ContextConfig>,
    pub(crate) instance_id: Arc<str>,
    pub(crate) current_utc_datetime: chrono::DateTime<chrono::Utc>,
    pub(crate) is_replaying: Arc<AtomicBool>,
    pub(crate) is_complete: bool,
    pub(crate) input: Option<String>,
    pub(crate) name: Arc<str>,
    pub(crate) custom_status: Option<String>,
    pub(crate) sequence_number: i32,
    pub(crate) pending_tasks: HashMap<i32, CompletableTask>,
    pub(crate) pending_event_tasks: HashMap<String, VecDeque<CompletableTask>>,
    /// Events buffered while no waiter exists. The `bool` records whether
    /// the originating `EventRaised` event was applied during replay.
    pub(crate) buffered_events: HashMap<String, VecDeque<(Option<String>, bool)>>,
    pub(crate) pending_actions: Vec<proto::WorkflowAction>,
    pub(crate) completion_status: Option<OrchestrationStatus>,
    pub(crate) completion_result: Option<String>,
    pub(crate) completion_failure: Option<FailureDetails>,
    pub(crate) continue_as_new_input: Option<String>,
    pub(crate) save_events_on_continue: bool,
    pub(crate) is_suspended: bool,
    /// Patches recorded as applied in the orchestration history (from `WorkflowStarted` events).
    pub(crate) history_patches: std::collections::HashSet<String>,
    /// Cache of patch decisions made during the current execution.
    pub(crate) applied_patches: HashMap<String, bool>,
    /// Number of sequence-consuming scheduled actions recorded in history
    /// (TaskScheduled + TimerCreated + ChildWorkflowInstanceCreated).
    /// Used to determine whether `is_patched` is called mid-history or at the frontier.
    pub(crate) history_scheduled_count: i32,
    /// History forwarded from the parent workflow (if any). Populated from
    /// the `WorkflowRequest.propagated_history` field.
    pub(crate) propagated_history: Option<Arc<PropagatedHistory>>,
}

/// The orchestration context provided to orchestrator functions.
///
/// All methods are safe to call from async code. The context is cloneable
/// and thread-safe (`Send + Sync`), backed by `Arc<Mutex<>>`.
#[derive(Clone)]
pub struct OrchestrationContext {
    pub(crate) inner: Arc<Mutex<OrchestrationContextInner>>,
}

impl OrchestrationContext {
    /// Create a new orchestration context with the given parameters.
    pub(crate) fn new(
        instance_id: String,
        name: String,
        input: Option<String>,
        current_utc_datetime: chrono::DateTime<chrono::Utc>,
        is_replaying: bool,
        options: &crate::worker::WorkerOptions,
        event_count_hint: usize,
    ) -> Self {
        let config = Arc::new(ContextConfig {
            max_event_names: options.max_event_names,
            max_events_per_name: options.max_events_per_name,
            max_pending_tasks_per_name: options.max_pending_tasks_per_name,
            max_json_payload_size: options.max_json_payload_size,
        });

        Self {
            inner: Arc::new(Mutex::new(OrchestrationContextInner {
                config,
                instance_id: Arc::<str>::from(instance_id),
                current_utc_datetime,
                is_replaying: Arc::new(AtomicBool::new(is_replaying)),
                is_complete: false,
                input,
                name: Arc::<str>::from(name),
                custom_status: None,
                sequence_number: 0,
                pending_tasks: HashMap::with_capacity(event_count_hint / 2),
                pending_event_tasks: HashMap::new(),
                buffered_events: HashMap::new(),
                pending_actions: Vec::with_capacity(event_count_hint / 2),
                completion_status: None,
                completion_result: None,
                completion_failure: None,
                continue_as_new_input: None,
                save_events_on_continue: false,
                is_suspended: false,
                history_patches: std::collections::HashSet::new(),
                applied_patches: HashMap::new(),
                history_scheduled_count: 0,
                propagated_history: None,
            })),
        }
    }

    /// Get the instance ID.
    pub fn instance_id(&self) -> Arc<str> {
        lock_inner(&self.inner).instance_id.clone()
    }

    /// Get the current UTC datetime (deterministic, from history events).
    pub fn current_utc_datetime(&self) -> chrono::DateTime<chrono::Utc> {
        lock_inner(&self.inner).current_utc_datetime
    }

    /// Check if the orchestrator is currently replaying.
    pub fn is_replaying(&self) -> bool {
        lock_inner(&self.inner).is_replaying.load(Ordering::Acquire)
    }

    /// Get the orchestration name.
    pub fn name(&self) -> Arc<str> {
        lock_inner(&self.inner).name.clone()
    }

    /// Get the orchestration input, deserialised from JSON.
    pub fn input<T: DeserializeOwned>(&self) -> crate::api::Result<T> {
        let inner = lock_inner(&self.inner);
        crate::internal::from_json(inner.input.as_deref(), inner.config.max_json_payload_size)
    }

    /// Returns history forwarded from the parent workflow, if the parent
    /// scheduled this child with a non-`None` history propagation scope.
    ///
    /// See [`HistoryPropagationScope`] for the parent-side trade-off between
    /// `OwnHistory` and `Lineage`.
    pub fn propagated_history(&self) -> Option<Arc<PropagatedHistory>> {
        lock_inner(&self.inner).propagated_history.clone()
    }

    /// Set a custom status string.
    pub fn set_custom_status(&self, status: impl Into<String>) {
        let mut inner = lock_inner(&self.inner);
        inner.custom_status = Some(status.into());
    }

    /// Schedule an activity for execution.
    ///
    /// Returns a [`CompletableTask`] that resolves when the activity completes.
    ///
    /// During replay: if the corresponding `TaskCompleted`/`TaskFailed` event
    /// exists in history, the task will already be complete.
    /// During new execution: creates a `ScheduleTaskAction`.
    pub fn call_activity(&self, name: &str, input: impl Serialize) -> CompletableTask {
        tracing::debug!(activity = %name, "Scheduling activity");
        self.call_activity_inner(name, input, None, None)
    }

    /// Schedule an activity with an `app_id` for cross-app scenarios.
    pub fn call_activity_with_app_id(
        &self,
        name: &str,
        input: impl Serialize,
        app_id: &str,
    ) -> CompletableTask {
        tracing::debug!(activity = %name, app_id = %app_id, "Scheduling activity with app_id");
        self.call_activity_inner(name, input, Some(app_id), None)
    }

    fn call_activity_inner(
        &self,
        name: &str,
        input: impl Serialize,
        app_id: Option<&str>,
        history_propagation_scope: Option<HistoryPropagationScope>,
    ) -> CompletableTask {
        let input_json = match to_json(&input) {
            Ok(json) => json,
            Err(e) => {
                let task = CompletableTask::new();
                task.fail(FailureDetails {
                    message: format!("Failed to serialize activity input: {e}"),
                    error_type: "SerializationError".to_string(),
                    stack_trace: None,
                });
                return task;
            }
        };
        self.call_activity_raw(name, input_json, app_id, history_propagation_scope)
    }

    /// Internal: schedule an activity using a pre-serialised JSON input.
    fn call_activity_raw(
        &self,
        name: &str,
        input_json: Option<String>,
        app_id: Option<&str>,
        history_propagation_scope: Option<HistoryPropagationScope>,
    ) -> CompletableTask {
        let mut inner = lock_inner(&self.inner);
        let seq = inner.sequence_number;
        inner.sequence_number += 1;

        if let Some(existing) = inner.pending_tasks.get(&seq)
            && existing.is_complete()
        {
            return existing.clone();
        }

        let task = CompletableTask::new();
        task.set_replay_handle(inner.is_replaying.clone());
        inner.pending_tasks.insert(seq, task.clone());

        let router = app_id.map(|id| proto::TaskRouter {
            source_app_id: String::new(),
            target_app_id: Some(id.to_string()),
            target_app_namespace: None,
        });
        let action = proto::WorkflowAction {
            id: seq,
            router: None,
            workflow_action_type: Some(proto::workflow_action::WorkflowActionType::ScheduleTask(
                proto::ScheduleTaskAction {
                    name: name.to_string(),
                    version: None,
                    input: input_json,
                    router,
                    task_execution_id: String::new(),
                    history_propagation_scope: history_propagation_scope
                        .map(|s| s.to_proto() as i32),
                },
            )),
        };
        inner.pending_actions.push(action);

        task
    }

    /// Schedule an activity with options (retry policy, app ID).
    ///
    /// Returns a future that drives the activity to completion, transparently
    /// scheduling durable timers and re-issuing the activity on each retry.
    pub fn call_activity_with_options(
        &self,
        name: &str,
        input: impl Serialize,
        options: ActivityOptions,
    ) -> impl std::future::Future<Output = crate::api::Result<Option<String>>> + Send + 'static
    {
        let input_json = to_json(&input);
        let name = name.to_string();
        let app_id = options.app_id.clone();
        let scope = options.history_propagation_scope;
        let ctx = self.clone();

        async move {
            let input_json = input_json?;
            match options.retry_policy {
                Some(policy) => {
                    let first_attempt_time = ctx.current_utc_datetime();
                    let schedule: Arc<
                        dyn Fn(&OrchestrationContext) -> CompletableTask + Send + Sync,
                    > = Arc::new(move |c: &OrchestrationContext| {
                        c.call_activity_raw(&name, input_json.clone(), app_id.as_deref(), scope)
                    });
                    call_with_retry(ctx, schedule, policy, first_attempt_time).await
                }
                None => {
                    ctx.call_activity_raw(&name, input_json, app_id.as_deref(), scope)
                        .await
                }
            }
        }
    }

    /// Schedule a sub-orchestration for execution.
    pub fn call_sub_orchestrator(
        &self,
        name: &str,
        input: impl Serialize,
        instance_id: Option<&str>,
    ) -> CompletableTask {
        tracing::debug!(
            sub_orchestrator = %name,
            sub_instance_id = ?instance_id,
            "Scheduling sub-orchestration"
        );
        self.call_sub_orchestrator_inner(name, input, instance_id, None, None)
    }

    /// Schedule a sub-orchestration targeting a specific Dapr app ID.
    pub fn call_sub_orchestrator_with_app_id(
        &self,
        name: &str,
        input: impl Serialize,
        instance_id: Option<&str>,
        app_id: &str,
    ) -> CompletableTask {
        tracing::debug!(
            sub_orchestrator = %name,
            sub_instance_id = ?instance_id,
            app_id = %app_id,
            "Scheduling sub-orchestration with app_id"
        );
        self.call_sub_orchestrator_inner(name, input, instance_id, Some(app_id), None)
    }

    fn call_sub_orchestrator_inner(
        &self,
        name: &str,
        input: impl Serialize,
        instance_id: Option<&str>,
        app_id: Option<&str>,
        history_propagation_scope: Option<HistoryPropagationScope>,
    ) -> CompletableTask {
        let input_json = match to_json(&input) {
            Ok(json) => json,
            Err(e) => {
                let task = CompletableTask::new();
                task.fail(FailureDetails {
                    message: format!("Failed to serialize sub-orchestrator input: {e}"),
                    error_type: "SerializationError".to_string(),
                    stack_trace: None,
                });
                return task;
            }
        };
        self.call_sub_orchestrator_raw(
            name,
            input_json,
            instance_id,
            app_id,
            history_propagation_scope,
        )
    }

    /// Internal: schedule a sub-orchestration using a pre-serialised JSON input.
    fn call_sub_orchestrator_raw(
        &self,
        name: &str,
        input_json: Option<String>,
        instance_id: Option<&str>,
        app_id: Option<&str>,
        history_propagation_scope: Option<HistoryPropagationScope>,
    ) -> CompletableTask {
        let mut inner = lock_inner(&self.inner);
        let seq = inner.sequence_number;
        inner.sequence_number += 1;

        if let Some(existing) = inner.pending_tasks.get(&seq)
            && existing.is_complete()
        {
            return existing.clone();
        }

        let task = CompletableTask::new();
        task.set_replay_handle(inner.is_replaying.clone());
        inner.pending_tasks.insert(seq, task.clone());

        let sub_instance_id = instance_id
            .map(|s| s.to_string())
            .unwrap_or_else(|| uuid::Uuid::new_v4().to_string());

        let router = app_id.map(|id| proto::TaskRouter {
            source_app_id: String::new(),
            target_app_id: Some(id.to_string()),
            target_app_namespace: None,
        });

        let action = proto::WorkflowAction {
            id: seq,
            router: None,
            workflow_action_type: Some(
                proto::workflow_action::WorkflowActionType::CreateChildWorkflow(
                    proto::CreateChildWorkflowAction {
                        instance_id: sub_instance_id,
                        name: name.to_string(),
                        version: None,
                        input: input_json,
                        router,
                        history_propagation_scope: history_propagation_scope
                            .map(|s| s.to_proto() as i32),
                    },
                ),
            ),
        };
        inner.pending_actions.push(action);

        task
    }

    /// Schedule a sub-orchestration with options (instance ID, retry policy, app ID).
    ///
    /// Returns a future that drives the sub-orchestration to completion,
    /// transparently scheduling durable timers and re-issuing the call on each retry.
    ///
    /// Note: when a retry policy is set and no explicit `instance_id` is given,
    /// each retry uses a freshly generated instance ID.
    pub fn call_sub_orchestrator_with_options(
        &self,
        name: &str,
        input: impl Serialize,
        options: SubOrchestratorOptions,
    ) -> impl std::future::Future<Output = crate::api::Result<Option<String>>> + Send + 'static
    {
        let input_json = to_json(&input);
        let name = name.to_string();
        let instance_id = options.instance_id.clone();
        let app_id = options.app_id.clone();
        let scope = options.history_propagation_scope;
        let ctx = self.clone();

        async move {
            let input_json = input_json?;
            match options.retry_policy {
                Some(policy) => {
                    let first_attempt_time = ctx.current_utc_datetime();
                    let schedule: Arc<
                        dyn Fn(&OrchestrationContext) -> CompletableTask + Send + Sync,
                    > = Arc::new(move |c: &OrchestrationContext| {
                        c.call_sub_orchestrator_raw(
                            &name,
                            input_json.clone(),
                            instance_id.as_deref(),
                            app_id.as_deref(),
                            scope,
                        )
                    });
                    call_with_retry(ctx, schedule, policy, first_attempt_time).await
                }
                None => {
                    ctx.call_sub_orchestrator_raw(
                        &name,
                        input_json,
                        instance_id.as_deref(),
                        app_id.as_deref(),
                        scope,
                    )
                    .await
                }
            }
        }
    }

    /// Create a durable timer that fires after the specified duration.
    pub fn create_timer(&self, delay: std::time::Duration) -> CompletableTask {
        tracing::debug!(delay_ms = delay.as_millis() as u64, "Creating timer");
        let mut inner = lock_inner(&self.inner);
        let fire_at = inner.current_utc_datetime
            + chrono::Duration::from_std(delay).unwrap_or(chrono::Duration::zero());
        Self::create_timer_with_origin(&mut inner, fire_at, None, None)
    }

    /// Create a timer action, optionally tagging its origin.
    fn create_timer_with_origin(
        inner: &mut OrchestrationContextInner,
        fire_at: chrono::DateTime<chrono::Utc>,
        name: Option<String>,
        origin: Option<proto::create_timer_action::Origin>,
    ) -> CompletableTask {
        let seq = inner.sequence_number;
        inner.sequence_number += 1;

        if let Some(existing) = inner.pending_tasks.get(&seq)
            && existing.is_complete()
        {
            return existing.clone();
        }

        let task = CompletableTask::new();
        task.set_replay_handle(inner.is_replaying.clone());
        inner.pending_tasks.insert(seq, task.clone());

        let action = proto::WorkflowAction {
            id: seq,
            router: None,
            workflow_action_type: Some(proto::workflow_action::WorkflowActionType::CreateTimer(
                proto::CreateTimerAction {
                    fire_at: Some(to_timestamp(fire_at)),
                    name,
                    origin,
                },
            )),
        };
        inner.pending_actions.push(action);

        task
    }

    /// Wait for an external event with the given name.
    ///
    /// Event names are case-insensitive.
    ///
    /// Patched executions also emit a far-future timer tagged with the event
    /// name, letting the runtime track the wait.
    pub fn wait_for_external_event(&self, name: &str) -> CompletableTask {
        tracing::debug!(event_name = %name, "Waiting for external event");
        let mut inner = lock_inner(&self.inner);
        let event_name = name.to_lowercase();

        // Gate timer emission for replay safety.
        let emit_timer = Self::is_patched_inner(&mut inner, EXTERNAL_EVENT_TIMER_PATCH);
        if emit_timer {
            let origin = proto::create_timer_action::Origin::ExternalEvent(
                proto::TimerOriginExternalEvent {
                    name: name.to_string(),
                },
            );
            // Use a sentinel timer; this API returns only the event task.
            let _timer_task = Self::create_timer_with_origin(
                &mut inner,
                *FAR_FUTURE_TIMESTAMP,
                None,
                Some(origin),
            );
        }

        if let Some(events) = inner.buffered_events.get_mut(&event_name)
            && !events.is_empty()
        {
            let (data, during_replay) = events
                .pop_front()
                .expect("buffered event queue is not empty");
            let task = CompletableTask::new();
            task.set_replay_handle(inner.is_replaying.clone());
            task.complete_with_phase(data, during_replay);
            return task;
        }

        let task = CompletableTask::new();
        task.set_replay_handle(inner.is_replaying.clone());
        let max_pending = inner.config.max_pending_tasks_per_name;
        let pending = inner.pending_event_tasks.entry(event_name).or_default();
        if pending.len() >= max_pending {
            tracing::warn!(event_name = %name, "Pending event task limit reached, discarding wait");
            return task;
        }
        pending.push_back(task.clone());
        task
    }

    /// Wait for an external event with a timeout.
    ///
    /// Returns [`ExternalEventResult::Received`] if the event arrives before
    /// the timeout, or [`ExternalEventResult::TimedOut`] if the timeout fires
    /// first.
    ///
    /// Always emits a timer tagged with the event name.
    ///
    /// Event names are case-insensitive.
    pub async fn wait_for_external_event_with_timeout(
        &self,
        name: &str,
        timeout: std::time::Duration,
    ) -> crate::api::Result<ExternalEventResult> {
        tracing::debug!(
            event_name = %name,
            timeout_ms = timeout.as_millis() as u64,
            "Waiting for external event with timeout"
        );

        let (event_task, timer_task) = {
            let mut inner = lock_inner(&self.inner);
            let event_name = name.to_lowercase();

            // Create the external-event timeout timer.
            let fire_at = inner.current_utc_datetime
                + chrono::Duration::from_std(timeout).unwrap_or(chrono::Duration::zero());
            let origin = proto::create_timer_action::Origin::ExternalEvent(
                proto::TimerOriginExternalEvent {
                    name: name.to_string(),
                },
            );
            let timer_task =
                Self::create_timer_with_origin(&mut inner, fire_at, None, Some(origin));

            // Register the event wait.
            let event_task = if let Some(events) = inner.buffered_events.get_mut(&event_name)
                && !events.is_empty()
            {
                let (data, during_replay) = events
                    .pop_front()
                    .expect("buffered event queue is not empty");
                let task = CompletableTask::new();
                task.set_replay_handle(inner.is_replaying.clone());
                task.complete_with_phase(data, during_replay);
                task
            } else {
                let task = CompletableTask::new();
                task.set_replay_handle(inner.is_replaying.clone());
                let max_pending = inner.config.max_pending_tasks_per_name;
                let pending = inner.pending_event_tasks.entry(event_name).or_default();
                if pending.len() >= max_pending {
                    tracing::warn!(
                        event_name = %name,
                        "Pending event task limit reached, discarding wait"
                    );
                } else {
                    pending.push_back(task.clone());
                }
                task
            };

            (event_task, timer_task)
        };

        // Race the event and timer (0 = event, 1 = timer).
        let winner = super::when_any::when_any(vec![event_task.clone(), timer_task]).await?;
        match winner {
            0 => {
                let payload = event_task.await?;
                Ok(ExternalEventResult::Received(payload))
            }
            _ => {
                // Timer won — remove the stale event waiter so it does not
                // silently consume a later event with the same name.
                let mut inner = lock_inner(&self.inner);
                let event_name = name.to_lowercase();
                if let Some(tasks) = inner.pending_event_tasks.get_mut(&event_name) {
                    tasks.retain(|t| !t.ptr_eq(&event_task));
                }
                Ok(ExternalEventResult::TimedOut)
            }
        }
    }

    /// `is_patched` variant for callers that already hold the lock.
    fn is_patched_inner(inner: &mut OrchestrationContextInner, patch_name: &str) -> bool {
        if let Some(&cached) = inner.applied_patches.get(patch_name) {
            return cached;
        }
        if inner.history_patches.contains(patch_name) {
            inner.applied_patches.insert(patch_name.to_string(), true);
            return true;
        }
        if inner.sequence_number < inner.history_scheduled_count {
            inner.applied_patches.insert(patch_name.to_string(), false);
            return false;
        }
        inner.applied_patches.insert(patch_name.to_string(), true);
        true
    }

    /// Continue the orchestration as new with new input.
    pub fn continue_as_new(&self, input: impl Serialize, save_events: bool) {
        tracing::debug!(save_events = save_events, "Continuing orchestration as new");
        let mut inner = lock_inner(&self.inner);
        inner.continue_as_new_input = to_json(&input).ok().flatten();
        inner.save_events_on_continue = save_events;
    }

    /// Check whether a named patch should be applied in the current execution.
    ///
    /// This enables safe, deterministic code upgrades. Wrap new behaviour in
    /// `if ctx.is_patched("my-patch")` to ensure that:
    ///
    /// - Replaying executions that previously ran the *unpatched* path continue
    ///   on the unpatched path (preserving determinism).
    /// - Executions that previously ran the *patched* path continue on the
    ///   patched path.
    /// - Brand-new executions (at the history frontier) always take the patched
    ///   path.
    ///
    /// This matches the behaviour of the Go and Python SDKs.
    pub fn is_patched(&self, patch_name: &str) -> bool {
        let mut inner = lock_inner(&self.inner);

        // Return the cached decision from the current execution if available.
        if let Some(&cached) = inner.applied_patches.get(patch_name) {
            return cached;
        }

        // If this patch was recorded as applied in the history, honour it.
        if inner.history_patches.contains(patch_name) {
            inner.applied_patches.insert(patch_name.to_string(), true);
            return true;
        }

        // If the orchestrator hasn't yet consumed all scheduled actions from
        // history, this call is mid-replay.  The previous execution did NOT
        // apply this patch, so we must stay on the unpatched path to preserve
        // determinism.
        if inner.sequence_number < inner.history_scheduled_count {
            inner.applied_patches.insert(patch_name.to_string(), false);
            return false;
        }

        // We're at (or past) the history frontier — apply the patch.
        inner.applied_patches.insert(patch_name.to_string(), true);
        true
    }
}

// ── Retry helpers ─────────────────────────────────────────────────────────────

/// Compute the delay before the next retry attempt, or `None` if the retry
/// should not proceed (timeout exceeded or predicate returned false).
fn compute_retry_delay(
    policy: &RetryPolicy,
    attempt: u32,
    first_attempt_time: chrono::DateTime<chrono::Utc>,
    current_time: chrono::DateTime<chrono::Utc>,
    details: &FailureDetails,
) -> Option<std::time::Duration> {
    // Check custom predicate.
    if let Some(ref handle) = policy.handle
        && !handle(details)
    {
        return None;
    }

    // Check overall retry timeout.
    if let Some(timeout) = policy.retry_timeout {
        let elapsed = current_time - first_attempt_time;
        let timeout_dur = chrono::Duration::from_std(timeout).unwrap_or(chrono::Duration::zero());
        if elapsed >= timeout_dur {
            return None;
        }
    }

    // Exponential backoff.
    let first_ms = policy.first_retry_interval.as_millis() as f64;
    let next_ms = first_ms * policy.backoff_coefficient.powi(attempt as i32);

    let delay_ms = if let Some(max) = policy.max_retry_interval {
        next_ms.min(max.as_millis() as f64)
    } else {
        next_ms
    };

    Some(std::time::Duration::from_millis(delay_ms as u64))
}

/// Drive a task to completion, retrying on failure according to `policy`.
///
/// `schedule` is called once per attempt and must return a fresh [`CompletableTask`].
/// Between attempts a durable timer is created for the computed backoff delay,
/// preserving determinism across replays.
fn call_with_retry(
    ctx: OrchestrationContext,
    schedule: Arc<dyn Fn(&OrchestrationContext) -> CompletableTask + Send + Sync>,
    policy: RetryPolicy,
    first_attempt_time: chrono::DateTime<chrono::Utc>,
) -> BoxFuture<'static, crate::api::Result<Option<String>>> {
    Box::pin(async move {
        let mut attempt = 0;
        loop {
            let task = schedule(&ctx);
            match task.await {
                Ok(v) => return Ok(v),
                Err(DurableTaskError::TaskFailed {
                    message,
                    failure_details,
                }) => {
                    let details = failure_details.clone().unwrap_or_else(|| FailureDetails {
                        message: message.clone(),
                        error_type: "TaskFailed".to_string(),
                        stack_trace: None,
                    });

                    if attempt + 1 >= policy.max_number_of_attempts {
                        tracing::debug!(
                            attempt,
                            max = policy.max_number_of_attempts,
                            "Max retry attempts reached"
                        );
                        return Err(DurableTaskError::TaskFailed {
                            message,
                            failure_details,
                        });
                    }

                    let current_time = ctx.current_utc_datetime();
                    let delay = match compute_retry_delay(
                        &policy,
                        attempt,
                        first_attempt_time,
                        current_time,
                        &details,
                    ) {
                        Some(d) => d,
                        None => {
                            tracing::debug!(attempt, "Retry predicate or timeout prevented retry");
                            return Err(DurableTaskError::TaskFailed {
                                message,
                                failure_details,
                            });
                        }
                    };

                    tracing::debug!(
                        attempt,
                        delay_ms = delay.as_millis(),
                        "Scheduling retry timer"
                    );
                    ctx.create_timer(delay).await?;
                    attempt += 1;
                }
                Err(e) => return Err(e),
            }
        }
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use chrono::Datelike;

    fn make_ctx() -> OrchestrationContext {
        OrchestrationContext::new(
            "inst-1".to_string(),
            "my_orch".to_string(),
            Some("\"hello\"".to_string()),
            chrono::Utc::now(),
            false,
            &crate::worker::WorkerOptions::default(),
            0,
        )
    }

    #[test]
    fn test_basic_accessors() {
        let ctx = make_ctx();
        assert_eq!(ctx.instance_id().as_ref(), "inst-1");
        assert_eq!(ctx.name().as_ref(), "my_orch");
        assert!(!ctx.is_replaying());
    }

    #[test]
    fn test_input() {
        let ctx = make_ctx();
        let input: String = ctx.input().unwrap();
        assert_eq!(input, "hello");
    }

    #[test]
    fn test_set_custom_status() {
        let ctx = make_ctx();
        ctx.set_custom_status("processing");
        let inner = ctx.inner.lock().unwrap();
        assert_eq!(inner.custom_status, Some("processing".to_string()));
    }

    #[test]
    fn test_call_activity_creates_action() {
        let ctx = make_ctx();
        let _task = ctx.call_activity("greet", "world");

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(inner.sequence_number, 1);
        assert_eq!(inner.pending_actions.len(), 1);
        assert_eq!(inner.pending_actions[0].id, 0);
        match &inner.pending_actions[0].workflow_action_type {
            Some(proto::workflow_action::WorkflowActionType::ScheduleTask(a)) => {
                assert_eq!(a.name, "greet");
                assert_eq!(a.input, Some("\"world\"".to_string()));
            }
            _ => panic!("expected ScheduleTask action"),
        }
    }

    #[test]
    fn test_call_activity_replay_returns_existing() {
        let ctx = make_ctx();

        // Pre-populate a completed task at sequence 0 (simulating replay)
        {
            let mut inner = ctx.inner.lock().unwrap();
            let task = CompletableTask::new();
            task.complete(Some("42".to_string()));
            inner.pending_tasks.insert(0, task);
        }

        let task = ctx.call_activity("greet", "world");
        assert!(task.is_complete());

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(inner.pending_actions.len(), 0);
    }

    #[test]
    fn test_call_sub_orchestrator() {
        let ctx = make_ctx();
        let _task = ctx.call_sub_orchestrator("child_orch", "input", Some("child-1"));

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(inner.sequence_number, 1);
        match &inner.pending_actions[0].workflow_action_type {
            Some(proto::workflow_action::WorkflowActionType::CreateChildWorkflow(a)) => {
                assert_eq!(a.name, "child_orch");
                assert_eq!(a.instance_id, "child-1");
            }
            _ => panic!("expected CreateChildWorkflow action"),
        }
    }

    #[test]
    fn test_create_timer() {
        let ctx = make_ctx();
        let _task = ctx.create_timer(std::time::Duration::from_secs(60));

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(inner.sequence_number, 1);
        match &inner.pending_actions[0].workflow_action_type {
            Some(proto::workflow_action::WorkflowActionType::CreateTimer(a)) => {
                assert!(a.fire_at.is_some());
            }
            _ => panic!("expected CreateTimer action"),
        }
    }

    #[test]
    fn test_wait_for_external_event_buffered() {
        let ctx = make_ctx();

        // Buffer an event
        {
            let mut inner = ctx.inner.lock().unwrap();
            inner
                .buffered_events
                .entry("approval".to_string())
                .or_default()
                .push_back((Some("\"yes\"".to_string()), true));
        }

        let task = ctx.wait_for_external_event("APPROVAL"); // case-insensitive
        assert!(task.is_complete());
    }

    #[test]
    fn test_wait_for_external_event_pending() {
        let ctx = make_ctx();
        let task = ctx.wait_for_external_event("approval");
        assert!(!task.is_complete());

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(inner.pending_event_tasks.get("approval").unwrap().len(), 1);
    }

    #[test]
    fn test_continue_as_new() {
        let ctx = make_ctx();
        ctx.continue_as_new("new_input", true);

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(
            inner.continue_as_new_input,
            Some("\"new_input\"".to_string())
        );
        assert!(inner.save_events_on_continue);
    }

    #[test]
    fn test_sequence_numbers_increment() {
        let ctx = make_ctx();
        let _t1 = ctx.call_activity("a", ());
        let _t2 = ctx.call_activity("b", ());
        let _t3 = ctx.create_timer(std::time::Duration::from_secs(1));

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(inner.sequence_number, 3);
        assert_eq!(inner.pending_actions[0].id, 0);
        assert_eq!(inner.pending_actions[1].id, 1);
        assert_eq!(inner.pending_actions[2].id, 2);
    }

    #[test]
    fn test_call_sub_orchestrator_with_app_id() {
        let ctx = make_ctx();
        let _task = ctx.call_sub_orchestrator_with_app_id(
            "child_orch",
            "input",
            Some("child-1"),
            "other-app",
        );

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(inner.sequence_number, 1);
        match &inner.pending_actions[0].workflow_action_type {
            Some(proto::workflow_action::WorkflowActionType::CreateChildWorkflow(a)) => {
                assert_eq!(a.name, "child_orch");
                assert_eq!(a.instance_id, "child-1");
                let router = a.router.as_ref().expect("expected router");
                assert_eq!(router.target_app_id, Some("other-app".to_string()));
            }
            _ => panic!("expected CreateChildWorkflow action"),
        }
    }

    #[test]
    fn test_is_patched_new_execution_returns_true() {
        // No history → always at the frontier → patch applies.
        let ctx = make_ctx();
        assert!(ctx.is_patched("my-patch"));
    }

    #[test]
    fn test_is_patched_in_history_returns_true() {
        // Patch recorded in history → return true.
        let ctx = make_ctx();
        ctx.inner
            .lock()
            .unwrap()
            .history_patches
            .insert("my-patch".to_string());
        assert!(ctx.is_patched("my-patch"));
    }

    #[test]
    fn test_is_patched_mid_replay_returns_false() {
        // history_scheduled_count = 2, but seq = 0 → mid-replay, unpatched.
        let ctx = make_ctx();
        ctx.inner.lock().unwrap().history_scheduled_count = 2;
        assert!(!ctx.is_patched("my-patch"));
    }

    #[test]
    fn test_is_patched_at_frontier_after_history_returns_true() {
        // history_scheduled_count = 1, seq = 1 → at frontier.
        let ctx = make_ctx();
        {
            let mut inner = ctx.inner.lock().unwrap();
            inner.history_scheduled_count = 1;
            inner.sequence_number = 1;
        }
        assert!(ctx.is_patched("my-patch"));
    }

    #[test]
    fn test_is_patched_caches_decision() {
        let ctx = make_ctx();
        // First call caches the result.
        assert!(ctx.is_patched("my-patch"));
        // Second call uses the cache regardless of state changes.
        ctx.inner.lock().unwrap().history_scheduled_count = 99;
        assert!(ctx.is_patched("my-patch"));
    }

    /// Extract a `CreateTimerAction`.
    fn extract_create_timer(action: &proto::WorkflowAction) -> &proto::CreateTimerAction {
        match &action.workflow_action_type {
            Some(proto::workflow_action::WorkflowActionType::CreateTimer(a)) => a,
            other => panic!("expected CreateTimer action, got {other:?}"),
        }
    }

    #[test]
    fn test_create_timer_origin_none() {
        // Generic timers have no origin.
        let ctx = make_ctx();
        let _task = ctx.create_timer(std::time::Duration::from_secs(60));

        let inner = ctx.inner.lock().unwrap();
        let timer_action = extract_create_timer(&inner.pending_actions[0]);
        assert!(
            timer_action.origin.is_none(),
            "generic timer should have no origin"
        );
    }

    #[test]
    fn test_wait_for_external_event_emits_timer_new_execution() {
        // New executions emit a far-future ExternalEvent timer.
        let ctx = make_ctx();
        let _task = ctx.wait_for_external_event("approval");

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(
            inner.sequence_number, 1,
            "should have allocated a seq for the timer"
        );
        assert_eq!(
            inner.pending_actions.len(),
            1,
            "should have emitted a CreateTimerAction"
        );

        let timer_action = extract_create_timer(&inner.pending_actions[0]);
        match &timer_action.origin {
            Some(proto::create_timer_action::Origin::ExternalEvent(e)) => {
                assert_eq!(e.name, "approval");
            }
            other => panic!("expected ExternalEvent origin, got {other:?}"),
        }

        // Assert the far-future sentinel.
        let fire_at = timer_action
            .fire_at
            .as_ref()
            .expect("fire_at should be set");
        let fire_at_dt = chrono::DateTime::from_timestamp(fire_at.seconds, fire_at.nanos as u32);
        assert!(fire_at_dt.is_some());
        assert!(fire_at_dt.unwrap().year() >= 9999);
    }

    #[test]
    fn test_wait_for_external_event_no_timer_during_replay() {
        // Mid-replay without patch history keeps old behaviour: no timer.
        let ctx = make_ctx();
        ctx.inner.lock().unwrap().history_scheduled_count = 5;

        let _task = ctx.wait_for_external_event("approval");

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(
            inner.sequence_number, 0,
            "should NOT allocate a seq during replay"
        );
        assert!(
            inner.pending_actions.is_empty(),
            "should NOT emit a timer during replay"
        );
        assert_eq!(inner.pending_event_tasks.get("approval").unwrap().len(), 1);
    }

    #[test]
    fn test_wait_for_external_event_buffered_still_emits_timer() {
        // Buffered events still emit the timer in patched executions.
        let ctx = make_ctx();
        {
            let mut inner = ctx.inner.lock().unwrap();
            inner
                .buffered_events
                .entry("approval".to_string())
                .or_default()
                .push_back((Some("\"yes\"".to_string()), true));
        }

        let task = ctx.wait_for_external_event("APPROVAL");
        assert!(
            task.is_complete(),
            "buffered event should complete immediately"
        );

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(
            inner.sequence_number, 1,
            "should have allocated a seq for the timer"
        );
        assert_eq!(inner.pending_actions.len(), 1);
        let timer_action = extract_create_timer(&inner.pending_actions[0]);
        assert!(
            matches!(
                &timer_action.origin,
                Some(proto::create_timer_action::Origin::ExternalEvent(_))
            ),
            "timer origin should be ExternalEvent"
        );
    }

    #[test]
    fn test_wait_for_external_event_with_timeout_emits_timer() {
        // Timeout waits always emit the explicit timer.
        let ctx = make_ctx();

        // Mirror the method setup without awaiting the future.
        {
            let mut inner = ctx.inner.lock().unwrap();
            let event_name = "approval".to_string();
            let fire_at = inner.current_utc_datetime + chrono::Duration::seconds(30);
            let origin = proto::create_timer_action::Origin::ExternalEvent(
                proto::TimerOriginExternalEvent {
                    name: "approval".to_string(),
                },
            );
            let _timer = OrchestrationContext::create_timer_with_origin(
                &mut inner,
                fire_at,
                None,
                Some(origin),
            );
            // Register the event wait.
            let task = CompletableTask::new();
            inner
                .pending_event_tasks
                .entry(event_name)
                .or_default()
                .push_back(task);
        }

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(inner.sequence_number, 1);
        let timer_action = extract_create_timer(&inner.pending_actions[0]);
        match &timer_action.origin {
            Some(proto::create_timer_action::Origin::ExternalEvent(e)) => {
                assert_eq!(e.name, "approval");
            }
            other => panic!("expected ExternalEvent origin, got {other:?}"),
        }
        // Timeout timers are not the far-future sentinel.
        let fire_at = timer_action.fire_at.as_ref().unwrap();
        let fire_at_dt =
            chrono::DateTime::from_timestamp(fire_at.seconds, fire_at.nanos as u32).unwrap();
        assert!(fire_at_dt.year() < 9999, "should not be far-future");
    }

    #[test]
    fn test_create_timer_refactor_still_works() {
        // create_timer still delegates without adding an origin.
        let ctx = make_ctx();
        let _t1 = ctx.create_timer(std::time::Duration::from_secs(10));
        let _t2 = ctx.create_timer(std::time::Duration::from_secs(20));

        let inner = ctx.inner.lock().unwrap();
        assert_eq!(inner.sequence_number, 2);
        assert_eq!(inner.pending_actions.len(), 2);
        assert_eq!(inner.pending_actions[0].id, 0);
        assert_eq!(inner.pending_actions[1].id, 1);

        for action in &inner.pending_actions {
            let timer = extract_create_timer(action);
            assert!(timer.fire_at.is_some());
            assert!(
                timer.origin.is_none(),
                "generic timer should have no origin"
            );
        }
    }
}