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
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
// -------------------------------------------------------------------------------------------------
// Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
// https://nautechsystems.io
//
// Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
// You may not use this file except in compliance with the License.
// You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// -------------------------------------------------------------------------------------------------
//! Real-time and static `Clock` implementations.
use std::{any::Any, collections::BTreeMap, fmt::Debug, ops::Deref, time::Duration};
use ahash::AHashMap;
use chrono::{DateTime, Utc};
use nautilus_core::{
AtomicTime, UnixNanos,
correctness::{check_positive_u64, check_predicate_true, check_valid_string_utf8},
string::formatting::Separable,
};
use ustr::Ustr;
use crate::timer::{
TestTimer, TimeEvent, TimeEventCallback, TimeEventHandler, Timer, create_valid_interval,
};
/// Represents a type of clock.
///
/// # Notes
///
/// An active timer is one which has not expired (`timer.is_expired == False`).
pub trait Clock: Debug + Any {
/// Returns the current date and time as a timezone-aware `DateTime<UTC>`.
fn utc_now(&self) -> DateTime<Utc> {
DateTime::from_timestamp_nanos(self.timestamp_ns().as_i64())
}
/// Returns the current UNIX timestamp in nanoseconds (ns).
fn timestamp_ns(&self) -> UnixNanos;
/// Returns the current UNIX timestamp in microseconds (μs).
fn timestamp_us(&self) -> u64;
/// Returns the current UNIX timestamp in milliseconds (ms).
fn timestamp_ms(&self) -> u64;
/// Returns the current UNIX timestamp in seconds.
fn timestamp(&self) -> f64;
/// Returns the names of active timers in the clock.
fn timer_names(&self) -> Vec<&str>;
/// Returns the count of active timers in the clock.
fn timer_count(&self) -> usize;
/// If a timer with the `name` exists.
fn timer_exists(&self, name: &Ustr) -> bool;
/// Register a default event handler for the clock. If a timer
/// does not have an event handler, then this handler is used.
fn register_default_handler(&mut self, callback: TimeEventCallback);
/// Get handler for [`TimeEvent`].
///
/// Note: Panics if the event does not have an associated handler
fn get_handler(&self, event: TimeEvent) -> TimeEventHandler;
/// Set a timer to alert at the specified time.
///
/// See [`Clock::set_time_alert_ns`] for flag semantics.
///
/// # Callback
///
/// - `callback`: Some, then callback handles the time event.
/// - `callback`: None, then the clock's default time event callback is used.
///
/// # Errors
///
/// Returns an error if `name` is invalid, `alert_time` is in the past when not allowed,
/// or any predicate check fails.
fn set_time_alert(
&mut self,
name: &str,
alert_time: DateTime<Utc>,
callback: Option<TimeEventCallback>,
allow_past: Option<bool>,
) -> anyhow::Result<()> {
self.set_time_alert_ns(name, alert_time.into(), callback, allow_past)
}
/// Set a timer to alert at the specified time.
///
/// Any existing timer registered under the same `name` is cancelled with a warning before the new alert is scheduled.
///
/// # Flags
///
/// | `allow_past` | Behavior |
/// |--------------|-----------------------------------------------------------------------------------------|
/// | `true` | If alert time is **in the past**, the alert fires immediately; otherwise at alert time. |
/// | `false` | Returns an error if alert time is earlier than now. |
///
/// # Callback
///
/// - `callback`: Some, then callback handles the time event.
/// - `callback`: None, then the clock's default time event callback is used.
///
/// # Errors
///
/// Returns an error if `name` is invalid, `alert_time_ns` is earlier than now when not allowed,
/// or any predicate check fails.
fn set_time_alert_ns(
&mut self,
name: &str,
alert_time_ns: UnixNanos,
callback: Option<TimeEventCallback>,
allow_past: Option<bool>,
) -> anyhow::Result<()>;
/// Set a timer to fire time events at every interval between start and stop time.
///
/// Any existing timer registered under the same `name` is cancelled with a warning before the new timer is scheduled.
///
/// See [`Clock::set_timer_ns`] for flag semantics.
///
/// # Callback
///
/// - `callback`: Some, then callback handles the time event.
/// - `callback`: None, then the clock's default time event callback is used.
///
/// # Errors
///
/// Returns an error if `name` is invalid, `interval` is not positive,
/// or if any predicate check fails.
#[expect(clippy::too_many_arguments)]
fn set_timer(
&mut self,
name: &str,
interval: Duration,
start_time: Option<DateTime<Utc>>,
stop_time: Option<DateTime<Utc>>,
callback: Option<TimeEventCallback>,
allow_past: Option<bool>,
fire_immediately: Option<bool>,
) -> anyhow::Result<()> {
self.set_timer_ns(
name,
interval.as_nanos() as u64,
start_time.map(UnixNanos::from),
stop_time.map(UnixNanos::from),
callback,
allow_past,
fire_immediately,
)
}
/// Set a timer to fire time events at every interval between start and stop time.
///
/// Any existing timer registered under the same `name` is cancelled before the new timer is scheduled.
///
/// # Start Time
///
/// - `None` or `Some(0)`: Uses the current time as start time.
/// - `Some(non_zero)`: Uses the specified timestamp as start time.
///
/// # Flags
///
/// | `allow_past` | `fire_immediately` | Behavior |
/// |--------------|--------------------|---------------------------------------------------------------------------------------|
/// | `true` | `true` | First event fires immediately at start time, even if start time is in the past. |
/// | `true` | `false` | First event fires at start time + interval, even if start time is in the past. |
/// | `false` | `true` | Returns error if start time is in the past (first event would be immediate but past). |
/// | `false` | `false` | Returns error if start time + interval is in the past. |
///
/// # Callback
///
/// - `callback`: Some, then callback handles the time event.
/// - `callback`: None, then the clock's default time event callback is used.
///
/// # Errors
///
/// Returns an error if `name` is invalid, `interval_ns` is not positive,
/// or if any predicate check fails.
#[expect(clippy::too_many_arguments)]
fn set_timer_ns(
&mut self,
name: &str,
interval_ns: u64,
start_time_ns: Option<UnixNanos>,
stop_time_ns: Option<UnixNanos>,
callback: Option<TimeEventCallback>,
allow_past: Option<bool>,
fire_immediately: Option<bool>,
) -> anyhow::Result<()>;
/// Returns the time interval in which the timer `name` is triggered.
///
/// If the timer doesn't exist `None` is returned.
fn next_time_ns(&self, name: &str) -> Option<UnixNanos>;
/// Cancels the timer with `name`.
fn cancel_timer(&mut self, name: &str);
/// Cancels all timers.
fn cancel_timers(&mut self);
/// Resets the clock by clearing it's internal state.
fn reset(&mut self);
}
impl dyn Clock {
/// Returns a reference to this clock as `Any` for downcasting.
pub fn as_any(&self) -> &dyn std::any::Any {
self
}
/// Returns a mutable reference to this clock as `Any` for downcasting.
pub fn as_any_mut(&mut self) -> &mut dyn std::any::Any {
self
}
}
/// Registry for timer event callbacks.
///
/// Provides shared callback registration and retrieval logic used by both
/// `TestClock` and `LiveClock`.
#[derive(Debug, Default)]
pub struct CallbackRegistry {
default_callback: Option<TimeEventCallback>,
callbacks: AHashMap<Ustr, TimeEventCallback>,
}
impl CallbackRegistry {
/// Creates a new [`CallbackRegistry`] instance.
#[must_use]
pub fn new() -> Self {
Self {
default_callback: None,
callbacks: AHashMap::new(),
}
}
/// Registers a default handler callback.
pub fn register_default_handler(&mut self, callback: TimeEventCallback) {
self.default_callback = Some(callback);
}
/// Registers a callback for a specific timer name.
pub fn register_callback(&mut self, name: Ustr, callback: TimeEventCallback) {
self.callbacks.insert(name, callback);
}
/// Returns whether a callback exists for the given name (either specific or default).
#[must_use]
pub fn has_any_callback(&self, name: &Ustr) -> bool {
self.callbacks.contains_key(name) || self.default_callback.is_some()
}
/// Gets the callback for a specific timer name, falling back to the default.
#[must_use]
pub fn get_callback(&self, name: &Ustr) -> Option<TimeEventCallback> {
self.callbacks
.get(name)
.cloned()
.or_else(|| self.default_callback.clone())
}
/// Gets a handler for a time event.
///
/// # Panics
///
/// Panics if no callback exists for the event name.
#[must_use]
pub fn get_handler(&self, event: TimeEvent) -> TimeEventHandler {
let callback = self
.get_callback(&event.name)
.unwrap_or_else(|| panic!("Event '{}' should have associated handler", event.name));
TimeEventHandler::new(event, callback)
}
/// Clears all registered callbacks.
pub fn clear(&mut self) {
self.callbacks.clear();
}
}
/// Validates and prepares parameters for setting a time alert.
///
/// Handles name validation, default value unwrapping, and past timestamp adjustment.
///
/// # Errors
///
/// Returns an error if the name is invalid or if the alert time is in the past when not allowed.
pub fn validate_and_prepare_time_alert(
name: &str,
mut alert_time_ns: UnixNanos,
allow_past: Option<bool>,
ts_now: UnixNanos,
) -> anyhow::Result<(Ustr, UnixNanos)> {
check_valid_string_utf8(name, stringify!(name))?;
let name = Ustr::from(name);
let allow_past = allow_past.unwrap_or(true);
if alert_time_ns < ts_now {
if allow_past {
alert_time_ns = ts_now;
log::warn!(
"Timer '{name}' alert time {} was in the past, adjusted to current time for immediate firing",
alert_time_ns.to_rfc3339(),
);
} else {
anyhow::bail!(
"Timer '{name}' alert time {} was in the past (current time is {ts_now})",
alert_time_ns.to_rfc3339(),
);
}
}
Ok((name, alert_time_ns))
}
/// Validates and prepares parameters for setting a timer.
///
/// Handles name and interval validation, default value unwrapping, start time normalization,
/// and stop time validation.
///
/// # Errors
///
/// Returns an error if name is invalid, interval is not positive, or stop time validation fails.
pub fn validate_and_prepare_timer(
name: &str,
interval_ns: u64,
start_time_ns: Option<UnixNanos>,
stop_time_ns: Option<UnixNanos>,
allow_past: Option<bool>,
fire_immediately: Option<bool>,
ts_now: UnixNanos,
) -> anyhow::Result<(Ustr, UnixNanos, Option<UnixNanos>, bool, bool)> {
check_valid_string_utf8(name, stringify!(name))?;
check_positive_u64(interval_ns, stringify!(interval_ns))?;
let name = Ustr::from(name);
let allow_past = allow_past.unwrap_or(true);
let fire_immediately = fire_immediately.unwrap_or(false);
let mut start_time_ns = start_time_ns.unwrap_or_default();
if start_time_ns == 0 {
// Zero start time indicates no explicit start; we use the current time
start_time_ns = ts_now;
} else if !allow_past {
let next_event_time = if fire_immediately {
start_time_ns
} else {
start_time_ns + interval_ns
};
if next_event_time < ts_now {
anyhow::bail!(
"Timer '{name}' next event time {} would be in the past (current time is {ts_now})",
next_event_time.to_rfc3339(),
);
}
}
if let Some(stop_time) = stop_time_ns {
if stop_time <= start_time_ns {
anyhow::bail!(
"Timer '{name}' stop time {} must be after start time {}",
stop_time.to_rfc3339(),
start_time_ns.to_rfc3339(),
);
}
if !allow_past && stop_time <= ts_now {
anyhow::bail!(
"Timer '{name}' stop time {} is in the past (current time is {ts_now})",
stop_time.to_rfc3339(),
);
}
}
Ok((
name,
start_time_ns,
stop_time_ns,
allow_past,
fire_immediately,
))
}
/// A static test clock.
///
/// Stores the current timestamp internally which can be advanced.
///
/// # Threading
///
/// This clock is thread-affine; use it only from the thread that created it.
#[derive(Debug)]
pub struct TestClock {
time: AtomicTime,
// Use btree map to ensure stable ordering when scanning for timers in `advance_time`
timers: BTreeMap<Ustr, TestTimer>,
callbacks: CallbackRegistry,
}
impl TestClock {
/// Creates a new [`TestClock`] instance.
#[must_use]
pub fn new() -> Self {
Self {
time: AtomicTime::new(false, UnixNanos::default()),
timers: BTreeMap::new(),
callbacks: CallbackRegistry::new(),
}
}
/// Returns a reference to the internal timers for the clock.
#[must_use]
pub const fn get_timers(&self) -> &BTreeMap<Ustr, TestTimer> {
&self.timers
}
/// Advances the internal clock to the specified `to_time_ns` and optionally sets the clock to that time.
///
/// This function ensures that the clock behaves in a non-decreasing manner. If `set_time` is `true`,
/// the internal clock will be updated to the value of `to_time_ns`. Otherwise, the clock will advance
/// without explicitly setting the time.
///
/// The method processes active timers, advancing them to `to_time_ns`, and collects any `TimeEvent`
/// objects that are triggered as a result. Only timers that are not expired are processed.
///
/// # Warnings
///
/// Logs a warning if >= 1,000,000 time events are allocated during advancement.
///
/// # Panics
///
/// Panics if `to_time_ns` is less than the current internal clock time.
pub fn advance_time(&mut self, to_time_ns: UnixNanos, set_time: bool) -> Vec<TimeEvent> {
const WARN_TIME_EVENTS_THRESHOLD: usize = 1_000_000;
let from_time_ns = self.time.get_time_ns();
assert!(
to_time_ns >= from_time_ns,
"Invariant: time must be non-decreasing, `to_time_ns` {to_time_ns} < `from_time_ns` {from_time_ns}"
);
if set_time {
self.time.set_time(to_time_ns);
}
// Iterate and advance timers and collect events, only retain alive timers
let mut events: Vec<TimeEvent> = Vec::new();
self.timers.retain(|_, timer| {
timer.advance(to_time_ns).for_each(|event| {
events.push(event);
});
!timer.is_expired()
});
if events.len() >= WARN_TIME_EVENTS_THRESHOLD {
log::warn!(
"Allocated {} time events during clock advancement from {} to {}, \
consider stopping the timer between large time ranges with no data points",
events.len().separate_with_commas(),
from_time_ns,
to_time_ns
);
}
events.sort_by_key(|a| a.ts_event);
events
}
/// Matches `TimeEvent` objects with their corresponding event handlers.
///
/// This function takes an `events` vector of `TimeEvent` objects, assumes they are already sorted
/// by their `ts_event`, and matches them with the appropriate callback handler from the internal
/// registry of callbacks. If no specific callback is found for an event, the default callback is used.
///
/// # Panics
///
/// Panics if the default callback is not set for the clock when matching handlers.
#[must_use]
pub fn match_handlers(&self, events: Vec<TimeEvent>) -> Vec<TimeEventHandler> {
events
.into_iter()
.map(|event| self.callbacks.get_handler(event))
.collect()
}
fn replace_existing_timer_if_needed(&mut self, name: &Ustr) {
replace_existing_timer(&mut self.timers, name);
}
}
impl Default for TestClock {
/// Creates a new default [`TestClock`] instance.
fn default() -> Self {
Self::new()
}
}
impl Deref for TestClock {
type Target = AtomicTime;
fn deref(&self) -> &Self::Target {
&self.time
}
}
impl Clock for TestClock {
fn timestamp_ns(&self) -> UnixNanos {
self.time.get_time_ns()
}
fn timestamp_us(&self) -> u64 {
self.time.get_time_us()
}
fn timestamp_ms(&self) -> u64 {
self.time.get_time_ms()
}
fn timestamp(&self) -> f64 {
self.time.get_time()
}
fn timer_names(&self) -> Vec<&str> {
self.timers
.iter()
.filter(|(_, timer)| !timer.is_expired())
.map(|(k, _)| k.as_str())
.collect()
}
fn timer_count(&self) -> usize {
self.timers
.iter()
.filter(|(_, timer)| !timer.is_expired())
.count()
}
fn timer_exists(&self, name: &Ustr) -> bool {
self.timers.contains_key(name)
}
fn register_default_handler(&mut self, callback: TimeEventCallback) {
self.callbacks.register_default_handler(callback);
}
/// Returns the handler for the given `TimeEvent`.
///
/// # Panics
///
/// Panics if no event-specific or default callback has been registered for the event.
fn get_handler(&self, event: TimeEvent) -> TimeEventHandler {
self.callbacks.get_handler(event)
}
fn set_time_alert_ns(
&mut self,
name: &str,
alert_time_ns: UnixNanos,
callback: Option<TimeEventCallback>,
allow_past: Option<bool>,
) -> anyhow::Result<()> {
let ts_now = self.get_time_ns();
let (name, alert_time_ns) =
validate_and_prepare_time_alert(name, alert_time_ns, allow_past, ts_now)?;
self.replace_existing_timer_if_needed(&name);
check_predicate_true(
callback.is_some() | self.callbacks.has_any_callback(&name),
"No callbacks provided",
)?;
if let Some(callback) = callback {
self.callbacks.register_callback(name, callback);
}
// Safe to calculate interval now that we've ensured alert_time_ns >= ts_now
let interval_ns = create_valid_interval((alert_time_ns - ts_now).into());
let fire_immediately = alert_time_ns == ts_now;
let timer = TestTimer::new(
name,
interval_ns,
ts_now,
Some(alert_time_ns),
fire_immediately,
);
self.timers.insert(name, timer);
Ok(())
}
fn set_timer_ns(
&mut self,
name: &str,
interval_ns: u64,
start_time_ns: Option<UnixNanos>,
stop_time_ns: Option<UnixNanos>,
callback: Option<TimeEventCallback>,
allow_past: Option<bool>,
fire_immediately: Option<bool>,
) -> anyhow::Result<()> {
let ts_now = self.get_time_ns();
let (name, start_time_ns, stop_time_ns, _allow_past, fire_immediately) =
validate_and_prepare_timer(
name,
interval_ns,
start_time_ns,
stop_time_ns,
allow_past,
fire_immediately,
ts_now,
)?;
check_predicate_true(
callback.is_some() | self.callbacks.has_any_callback(&name),
"No callbacks provided",
)?;
self.replace_existing_timer_if_needed(&name);
if let Some(callback) = callback {
self.callbacks.register_callback(name, callback);
}
let interval_ns = create_valid_interval(interval_ns);
let timer = TestTimer::new(
name,
interval_ns,
start_time_ns,
stop_time_ns,
fire_immediately,
);
self.timers.insert(name, timer);
Ok(())
}
fn next_time_ns(&self, name: &str) -> Option<UnixNanos> {
self.timers
.get(&Ustr::from(name))
.map(|timer| timer.next_time_ns())
}
fn cancel_timer(&mut self, name: &str) {
let timer = self.timers.remove(&Ustr::from(name));
if let Some(mut timer) = timer {
timer.cancel();
}
}
fn cancel_timers(&mut self) {
for timer in &mut self.timers.values_mut() {
timer.cancel();
}
self.timers.clear();
}
fn reset(&mut self) {
self.time = AtomicTime::new(false, UnixNanos::default());
self.timers = BTreeMap::new();
self.callbacks.clear();
}
}
pub(crate) fn replace_existing_timer<T: Timer>(timers: &mut BTreeMap<Ustr, T>, name: &Ustr) {
let is_expired = timers.get(name).map(|t| t.is_expired());
match is_expired {
Some(true) => {
timers.remove(name);
}
Some(false) => {
if let Some(mut timer) = timers.remove(name) {
timer.cancel();
}
log::warn!("Timer '{name}' replaced");
}
None => {}
}
}
#[cfg(test)]
mod tests {
use std::{
sync::{Arc, Mutex},
time::Duration,
};
use nautilus_core::{MUTEX_POISONED, UnixNanos};
use rstest::{fixture, rstest};
use ustr::Ustr;
use super::*;
use crate::timer::{TimeEvent, TimeEventCallback};
#[derive(Debug, Default)]
struct TestCallback {
/// Shared flag updated from within the timer callback; Mutex keeps the closure `Send` for tests.
called: Arc<Mutex<bool>>,
}
impl TestCallback {
fn new(called: Arc<Mutex<bool>>) -> Self {
Self { called }
}
}
impl From<TestCallback> for TimeEventCallback {
fn from(callback: TestCallback) -> Self {
Self::from(move |_event: TimeEvent| {
if let Ok(mut called) = callback.called.lock() {
*called = true;
}
})
}
}
#[fixture]
pub fn test_clock() -> TestClock {
let mut clock = TestClock::new();
clock.register_default_handler(TestCallback::default().into());
clock
}
#[rstest]
fn test_time_monotonicity(mut test_clock: TestClock) {
let initial_time = test_clock.timestamp_ns();
test_clock.advance_time(UnixNanos::from(*initial_time + 1000), true);
assert!(test_clock.timestamp_ns() > initial_time);
}
#[rstest]
fn test_timer_registration(mut test_clock: TestClock) {
test_clock
.set_time_alert_ns(
"test_timer",
(*test_clock.timestamp_ns() + 1000).into(),
None,
None,
)
.unwrap();
assert_eq!(test_clock.timer_count(), 1);
assert_eq!(test_clock.timer_names(), vec!["test_timer"]);
}
#[rstest]
fn test_timer_expiration(mut test_clock: TestClock) {
let alert_time = (*test_clock.timestamp_ns() + 1000).into();
test_clock
.set_time_alert_ns("test_timer", alert_time, None, None)
.unwrap();
let events = test_clock.advance_time(alert_time, true);
assert_eq!(events.len(), 1);
assert_eq!(events[0].name.as_str(), "test_timer");
}
#[rstest]
fn test_timer_cancellation(mut test_clock: TestClock) {
test_clock
.set_time_alert_ns(
"test_timer",
(*test_clock.timestamp_ns() + 1000).into(),
None,
None,
)
.unwrap();
assert_eq!(test_clock.timer_count(), 1);
test_clock.cancel_timer("test_timer");
assert_eq!(test_clock.timer_count(), 0);
}
#[rstest]
fn test_time_advancement(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
test_clock
.set_timer_ns("test_timer", 1000, Some(start_time), None, None, None, None)
.unwrap();
let events = test_clock.advance_time(UnixNanos::from(*start_time + 2500), true);
assert_eq!(events.len(), 2);
assert_eq!(*events[0].ts_event, *start_time + 1000);
assert_eq!(*events[1].ts_event, *start_time + 2000);
}
#[rstest]
fn test_default_and_custom_callbacks() {
let mut clock = TestClock::new();
let default_called = Arc::new(Mutex::new(false));
let custom_called = Arc::new(Mutex::new(false));
let default_callback = TestCallback::new(Arc::clone(&default_called));
let custom_callback = TestCallback::new(Arc::clone(&custom_called));
clock.register_default_handler(TimeEventCallback::from(default_callback));
clock
.set_time_alert_ns(
"default_timer",
(*clock.timestamp_ns() + 1000).into(),
None,
None,
)
.unwrap();
clock
.set_time_alert_ns(
"custom_timer",
(*clock.timestamp_ns() + 1000).into(),
Some(TimeEventCallback::from(custom_callback)),
None,
)
.unwrap();
let events = clock.advance_time(UnixNanos::from(*clock.timestamp_ns() + 1000), true);
let handlers = clock.match_handlers(events);
for handler in handlers {
handler.callback.call(handler.event);
}
assert!(*default_called.lock().expect(MUTEX_POISONED));
assert!(*custom_called.lock().expect(MUTEX_POISONED));
}
#[rstest]
fn test_timer_with_rust_local_callback() {
use std::{cell::RefCell, rc::Rc};
let mut clock = TestClock::new();
let call_count = Rc::new(RefCell::new(0_u32));
let call_count_clone = Rc::clone(&call_count);
// Create RustLocal callback using Rc (not Send/Sync)
let callback: Rc<dyn Fn(TimeEvent)> = Rc::new(move |_event: TimeEvent| {
*call_count_clone.borrow_mut() += 1;
});
clock
.set_time_alert_ns(
"local_timer",
(*clock.timestamp_ns() + 1000).into(),
Some(TimeEventCallback::from(callback)),
None,
)
.unwrap();
let events = clock.advance_time(UnixNanos::from(*clock.timestamp_ns() + 1000), true);
let handlers = clock.match_handlers(events);
for handler in handlers {
handler.callback.call(handler.event);
}
assert_eq!(*call_count.borrow(), 1);
}
#[rstest]
fn test_multiple_timers(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
test_clock
.set_timer_ns("timer1", 1000, Some(start_time), None, None, None, None)
.unwrap();
test_clock
.set_timer_ns("timer2", 2000, Some(start_time), None, None, None, None)
.unwrap();
let events = test_clock.advance_time(UnixNanos::from(*start_time + 2000), true);
assert_eq!(events.len(), 3);
assert_eq!(events[0].name.as_str(), "timer1");
assert_eq!(events[1].name.as_str(), "timer1");
assert_eq!(events[2].name.as_str(), "timer2");
}
#[rstest]
fn test_allow_past_parameter_true(mut test_clock: TestClock) {
test_clock.set_time(UnixNanos::from(2000));
let current_time = test_clock.timestamp_ns();
let past_time = UnixNanos::from(current_time.as_u64() - 1000);
// With allow_past=true (default), should adjust to current time and succeed
test_clock
.set_time_alert_ns("past_timer", past_time, None, Some(true))
.unwrap();
// Verify timer was created with adjusted time
assert_eq!(test_clock.timer_count(), 1);
assert_eq!(test_clock.timer_names(), vec!["past_timer"]);
// Next time should be at or after current time, not in the past
let next_time = test_clock.next_time_ns("past_timer").unwrap();
assert!(next_time >= current_time);
}
#[rstest]
fn test_allow_past_parameter_false(mut test_clock: TestClock) {
test_clock.set_time(UnixNanos::from(2000));
let current_time = test_clock.timestamp_ns();
let past_time = current_time - 1000;
// With allow_past=false, should fail for past times
let result = test_clock.set_time_alert_ns("past_timer", past_time, None, Some(false));
// Verify the operation failed with appropriate error
assert!(result.is_err());
assert!(format!("{}", result.unwrap_err()).contains("was in the past"));
// Verify no timer was created
assert_eq!(test_clock.timer_count(), 0);
assert!(test_clock.timer_names().is_empty());
}
#[rstest]
fn test_invalid_stop_time_validation(mut test_clock: TestClock) {
test_clock.set_time(UnixNanos::from(2000));
let current_time = test_clock.timestamp_ns();
let start_time = current_time + 1000;
let stop_time = current_time + 500; // Stop time before start time
// Should fail because stop_time < start_time
let result = test_clock.set_timer_ns(
"invalid_timer",
100,
Some(start_time),
Some(stop_time),
None,
None,
None,
);
// Verify the operation failed with appropriate error
assert!(result.is_err());
assert!(format!("{}", result.unwrap_err()).contains("must be after start time"));
// Verify no timer was created
assert_eq!(test_clock.timer_count(), 0);
}
#[rstest]
fn test_set_timer_ns_fire_immediately_true(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
let interval_ns = 1000;
test_clock
.set_timer_ns(
"fire_immediately_timer",
interval_ns,
Some(start_time),
None,
None,
None,
Some(true),
)
.unwrap();
// Advance time to check immediate firing and subsequent intervals
let events = test_clock.advance_time(start_time + 2500, true);
// Should fire immediately at start_time (0), then at start_time+1000, then at start_time+2000
assert_eq!(events.len(), 3);
assert_eq!(*events[0].ts_event, *start_time); // Fires immediately
assert_eq!(*events[1].ts_event, *start_time + 1000); // Then after interval
assert_eq!(*events[2].ts_event, *start_time + 2000); // Then after second interval
}
#[rstest]
fn test_set_timer_ns_fire_immediately_false(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
let interval_ns = 1000;
test_clock
.set_timer_ns(
"normal_timer",
interval_ns,
Some(start_time),
None,
None,
None,
Some(false),
)
.unwrap();
// Advance time to check normal behavior
let events = test_clock.advance_time(start_time + 2500, true);
// Should fire after first interval, not immediately
assert_eq!(events.len(), 2);
assert_eq!(*events[0].ts_event, *start_time + 1000); // Fires after first interval
assert_eq!(*events[1].ts_event, *start_time + 2000); // Then after second interval
}
#[rstest]
fn test_set_timer_ns_fire_immediately_default_is_false(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
let interval_ns = 1000;
// Don't specify fire_immediately (should default to false)
test_clock
.set_timer_ns(
"default_timer",
interval_ns,
Some(start_time),
None,
None,
None,
None,
)
.unwrap();
let events = test_clock.advance_time(start_time + 1500, true);
// Should behave the same as fire_immediately=false
assert_eq!(events.len(), 1);
assert_eq!(*events[0].ts_event, *start_time + 1000); // Fires after first interval
}
#[rstest]
fn test_set_timer_ns_fire_immediately_with_zero_start_time(mut test_clock: TestClock) {
test_clock.set_time(5000.into());
let interval_ns = 1000;
test_clock
.set_timer_ns(
"zero_start_timer",
interval_ns,
None,
None,
None,
None,
Some(true),
)
.unwrap();
let events = test_clock.advance_time(UnixNanos::from(7000), true);
// With zero start time, should use current time as start
// Fire immediately at current time (5000), then at 6000, 7000
assert_eq!(events.len(), 3);
assert_eq!(*events[0].ts_event, 5000); // Immediate fire at current time
assert_eq!(*events[1].ts_event, 6000);
assert_eq!(*events[2].ts_event, 7000);
}
#[rstest]
fn test_multiple_timers_different_fire_immediately_settings(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
let interval_ns = 1000;
// One timer with fire_immediately=true
test_clock
.set_timer_ns(
"immediate_timer",
interval_ns,
Some(start_time),
None,
None,
None,
Some(true),
)
.unwrap();
// One timer with fire_immediately=false
test_clock
.set_timer_ns(
"normal_timer",
interval_ns,
Some(start_time),
None,
None,
None,
Some(false),
)
.unwrap();
let events = test_clock.advance_time(start_time + 1500, true);
// Should have 3 events total: immediate_timer fires at start & 1000, normal_timer fires at 1000
assert_eq!(events.len(), 3);
// Sort events by timestamp to check order
let mut event_times: Vec<u64> = events.iter().map(|e| e.ts_event.as_u64()).collect();
event_times.sort_unstable();
assert_eq!(event_times[0], start_time.as_u64()); // immediate_timer fires immediately
assert_eq!(event_times[1], start_time.as_u64() + 1000); // both timers fire at 1000
assert_eq!(event_times[2], start_time.as_u64() + 1000); // both timers fire at 1000
}
#[rstest]
fn test_timer_name_collision_overwrites(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
// Set first timer
test_clock
.set_timer_ns(
"collision_timer",
1000,
Some(start_time),
None,
None,
None,
None,
)
.unwrap();
// Setting timer with same name should overwrite the existing one
let result = test_clock.set_timer_ns(
"collision_timer",
2000,
Some(start_time),
None,
None,
None,
None,
);
assert!(result.is_ok());
// Should still only have one timer (overwritten)
assert_eq!(test_clock.timer_count(), 1);
// The timer should have the new interval
let next_time = test_clock.next_time_ns("collision_timer").unwrap();
// With interval 2000 and start at start_time, next time should be start_time + 2000
assert_eq!(next_time, start_time + 2000);
}
#[rstest]
fn test_timer_zero_interval_error(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
// Attempt to set timer with zero interval should fail
let result =
test_clock.set_timer_ns("zero_interval", 0, Some(start_time), None, None, None, None);
assert!(result.is_err());
assert_eq!(test_clock.timer_count(), 0);
}
#[rstest]
fn test_timer_empty_name_error(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
// Attempt to set timer with empty name should fail
let result = test_clock.set_timer_ns("", 1000, Some(start_time), None, None, None, None);
assert!(result.is_err());
assert_eq!(test_clock.timer_count(), 0);
}
#[rstest]
fn test_timer_exists(mut test_clock: TestClock) {
let name = Ustr::from("exists_timer");
assert!(!test_clock.timer_exists(&name));
test_clock
.set_time_alert_ns(
name.as_str(),
(*test_clock.timestamp_ns() + 1_000).into(),
None,
None,
)
.unwrap();
assert!(test_clock.timer_exists(&name));
}
#[rstest]
fn test_timer_rejects_past_stop_time_when_not_allowed(mut test_clock: TestClock) {
test_clock.set_time(UnixNanos::from(10_000));
let current = test_clock.timestamp_ns();
let result = test_clock.set_timer_ns(
"past_stop",
10_000,
Some(current - 500),
Some(current - 100),
None,
Some(false),
None,
);
let err = result.expect_err("expected stop time validation error");
let err_msg = err.to_string();
assert!(err_msg.contains("stop time"));
assert!(err_msg.contains("in the past"));
}
#[rstest]
fn test_timer_accepts_future_stop_time(mut test_clock: TestClock) {
let current = test_clock.timestamp_ns();
let result = test_clock.set_timer_ns(
"future_stop",
1_000,
Some(current),
Some(current + 10_000),
None,
Some(false),
None,
);
assert!(result.is_ok());
}
#[rstest]
fn test_timer_fire_immediately_at_exact_stop_time(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
let interval_ns = 1000;
let stop_time = start_time + interval_ns; // Stop exactly at first interval
test_clock
.set_timer_ns(
"exact_stop",
interval_ns,
Some(start_time),
Some(stop_time),
None,
None,
Some(true),
)
.unwrap();
let events = test_clock.advance_time(stop_time, true);
// Should fire immediately at start, then at stop time (which equals first interval)
assert_eq!(events.len(), 2);
assert_eq!(*events[0].ts_event, *start_time); // Immediate fire
assert_eq!(*events[1].ts_event, *stop_time); // Fire at stop time
}
#[rstest]
fn test_timer_advance_to_exact_next_time(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
let interval_ns = 1000;
test_clock
.set_timer_ns(
"exact_advance",
interval_ns,
Some(start_time),
None,
None,
None,
Some(false),
)
.unwrap();
// Advance to exactly the next fire time
let next_time = test_clock.next_time_ns("exact_advance").unwrap();
let events = test_clock.advance_time(next_time, true);
assert_eq!(events.len(), 1);
assert_eq!(*events[0].ts_event, *next_time);
}
#[rstest]
fn test_allow_past_bar_aggregation_use_case(mut test_clock: TestClock) {
// Simulate bar aggregation scenario: current time is in middle of a bar window
test_clock.set_time(UnixNanos::from(100_500)); // 100.5 seconds
let bar_start_time = UnixNanos::from(100_000); // 100 seconds (0.5 sec ago)
let interval_ns = 1000; // 1 second bars
// With allow_past=false and fire_immediately=false:
// start_time is in past (100 sec) but next event (101 sec) is in future
// This should be ALLOWED for bar aggregation
let result = test_clock.set_timer_ns(
"bar_timer",
interval_ns,
Some(bar_start_time),
None,
None,
Some(false), // allow_past = false
Some(false), // fire_immediately = false
);
// Should succeed because next event time (100_000 + 1000 = 101_000) > current time (100_500)
assert!(result.is_ok());
assert_eq!(test_clock.timer_count(), 1);
// Next event should be at bar_start_time + interval = 101_000
let next_time = test_clock.next_time_ns("bar_timer").unwrap();
assert_eq!(*next_time, 101_000);
}
#[rstest]
fn test_allow_past_false_rejects_when_next_event_in_past(mut test_clock: TestClock) {
test_clock.set_time(UnixNanos::from(102_000)); // 102 seconds
let past_start_time = UnixNanos::from(100_000); // 100 seconds (2 sec ago)
let interval_ns = 1000; // 1 second interval
// With allow_past=false and fire_immediately=false:
// Next event would be 100_000 + 1000 = 101_000, which is < current time (102_000)
// This should be REJECTED
let result = test_clock.set_timer_ns(
"past_event_timer",
interval_ns,
Some(past_start_time),
None,
None,
Some(false), // allow_past = false
Some(false), // fire_immediately = false
);
// Should fail because next event time (101_000) < current time (102_000)
assert!(result.is_err());
assert!(
result
.unwrap_err()
.to_string()
.contains("would be in the past")
);
}
#[rstest]
fn test_allow_past_false_with_fire_immediately_true(mut test_clock: TestClock) {
test_clock.set_time(UnixNanos::from(100_500)); // 100.5 seconds
let past_start_time = UnixNanos::from(100_000); // 100 seconds (0.5 sec ago)
let interval_ns = 1000;
// With fire_immediately=true, next event = start_time (which is in past)
// This should be REJECTED with allow_past=false
let result = test_clock.set_timer_ns(
"immediate_past_timer",
interval_ns,
Some(past_start_time),
None,
None,
Some(false), // allow_past = false
Some(true), // fire_immediately = true
);
// Should fail because next event time (100_000) < current time (100_500)
assert!(result.is_err());
assert!(
result
.unwrap_err()
.to_string()
.contains("would be in the past")
);
}
#[rstest]
fn test_cancel_timer_during_execution(mut test_clock: TestClock) {
let start_time = test_clock.timestamp_ns();
test_clock
.set_timer_ns(
"cancel_test",
1000,
Some(start_time),
None,
None,
None,
None,
)
.unwrap();
assert_eq!(test_clock.timer_count(), 1);
// Cancel the timer
test_clock.cancel_timer("cancel_test");
assert_eq!(test_clock.timer_count(), 0);
// Advance time - should get no events from cancelled timer
let events = test_clock.advance_time(start_time + 2000, true);
assert_eq!(events.len(), 0);
}
#[rstest]
fn test_cancel_all_timers(mut test_clock: TestClock) {
// Create multiple timers
test_clock
.set_timer_ns("timer1", 1000, None, None, None, None, None)
.unwrap();
test_clock
.set_timer_ns("timer2", 1500, None, None, None, None, None)
.unwrap();
test_clock
.set_timer_ns("timer3", 2000, None, None, None, None, None)
.unwrap();
assert_eq!(test_clock.timer_count(), 3);
// Cancel all timers
test_clock.cancel_timers();
assert_eq!(test_clock.timer_count(), 0);
// Advance time - should get no events
let events = test_clock.advance_time(UnixNanos::from(5000), true);
assert_eq!(events.len(), 0);
}
#[rstest]
fn test_clock_reset_clears_timers(mut test_clock: TestClock) {
test_clock
.set_timer_ns("reset_test", 1000, None, None, None, None, None)
.unwrap();
assert_eq!(test_clock.timer_count(), 1);
// Reset the clock
test_clock.reset();
assert_eq!(test_clock.timer_count(), 0);
assert_eq!(test_clock.timestamp_ns(), UnixNanos::default()); // Time reset to zero
}
#[rstest]
fn test_set_time_alert_default_impl(mut test_clock: TestClock) {
let current_time = test_clock.utc_now();
let alert_time = current_time + chrono::Duration::seconds(1);
// Test the default implementation that delegates to set_time_alert_ns
test_clock
.set_time_alert("alert_test", alert_time, None, None)
.unwrap();
assert_eq!(test_clock.timer_count(), 1);
assert_eq!(test_clock.timer_names(), vec!["alert_test"]);
// Verify the timer is set for the correct time
let expected_ns = UnixNanos::from(alert_time);
let next_time = test_clock.next_time_ns("alert_test").unwrap();
// Should be very close (within a few nanoseconds due to conversion)
let diff = if next_time >= expected_ns {
next_time.as_u64() - expected_ns.as_u64()
} else {
expected_ns.as_u64() - next_time.as_u64()
};
assert!(
diff < 1000,
"Timer should be set within 1 microsecond of expected time"
);
}
#[rstest]
fn test_set_timer_default_impl(mut test_clock: TestClock) {
let current_time = test_clock.utc_now();
let start_time = current_time + chrono::Duration::seconds(1);
let interval = Duration::from_millis(500);
// Test the default implementation that delegates to set_timer_ns
test_clock
.set_timer(
"timer_test",
interval,
Some(start_time),
None,
None,
None,
None,
)
.unwrap();
assert_eq!(test_clock.timer_count(), 1);
assert_eq!(test_clock.timer_names(), vec!["timer_test"]);
// Advance time and verify timer fires at correct intervals
let start_ns = UnixNanos::from(start_time);
let interval_ns = interval.as_nanos() as u64;
let events = test_clock.advance_time(start_ns + interval_ns * 3, true);
assert_eq!(events.len(), 3); // Should fire 3 times
// Verify timing
assert_eq!(*events[0].ts_event, *start_ns + interval_ns);
assert_eq!(*events[1].ts_event, *start_ns + interval_ns * 2);
assert_eq!(*events[2].ts_event, *start_ns + interval_ns * 3);
}
#[rstest]
fn test_set_timer_with_stop_time_default_impl(mut test_clock: TestClock) {
let current_time = test_clock.utc_now();
let start_time = current_time + chrono::Duration::seconds(1);
let stop_time = current_time + chrono::Duration::seconds(3);
let interval = Duration::from_secs(1);
// Test with stop time
test_clock
.set_timer(
"timer_with_stop",
interval,
Some(start_time),
Some(stop_time),
None,
None,
None,
)
.unwrap();
assert_eq!(test_clock.timer_count(), 1);
// Advance beyond stop time
let stop_ns = UnixNanos::from(stop_time);
let events = test_clock.advance_time(stop_ns + 1000, true);
// Should fire twice: at start_time + 1s and start_time + 2s, but not at start_time + 3s since that would be at stop_time
assert_eq!(events.len(), 2);
let start_ns = UnixNanos::from(start_time);
let interval_ns = interval.as_nanos() as u64;
assert_eq!(*events[0].ts_event, *start_ns + interval_ns);
assert_eq!(*events[1].ts_event, *start_ns + interval_ns * 2);
}
#[rstest]
fn test_set_timer_fire_immediately_default_impl(mut test_clock: TestClock) {
let current_time = test_clock.utc_now();
let start_time = current_time + chrono::Duration::seconds(1);
let interval = Duration::from_millis(500);
// Test with fire_immediately=true
test_clock
.set_timer(
"immediate_timer",
interval,
Some(start_time),
None,
None,
None,
Some(true),
)
.unwrap();
let start_ns = UnixNanos::from(start_time);
let interval_ns = interval.as_nanos() as u64;
// Advance to start time + 1 interval
let events = test_clock.advance_time(start_ns + interval_ns, true);
// Should fire immediately at start_time, then again at start_time + interval
assert_eq!(events.len(), 2);
assert_eq!(*events[0].ts_event, *start_ns); // Immediate fire
assert_eq!(*events[1].ts_event, *start_ns + interval_ns); // Regular interval
}
#[rstest]
fn test_set_time_alert_when_alert_time_equals_current_time(mut test_clock: TestClock) {
let current_time = test_clock.timestamp_ns();
// Set time alert for exactly the current time
test_clock
.set_time_alert_ns("alert_at_current_time", current_time, None, None)
.unwrap();
assert_eq!(test_clock.timer_count(), 1);
// Advance time by exactly 0 (to current time) - should fire immediately
let events = test_clock.advance_time(current_time, true);
// Should fire immediately since alert_time_ns == ts_now
assert_eq!(events.len(), 1);
assert_eq!(events[0].name.as_str(), "alert_at_current_time");
assert_eq!(*events[0].ts_event, *current_time);
}
#[rstest]
fn test_cancel_and_reschedule_same_name(mut test_clock: TestClock) {
let start = test_clock.timestamp_ns();
test_clock
.set_time_alert_ns("timer", UnixNanos::from(*start + 1000), None, None)
.unwrap();
assert_eq!(test_clock.timer_count(), 1);
test_clock.cancel_timer("timer");
assert_eq!(test_clock.timer_count(), 0);
test_clock
.set_time_alert_ns("timer", UnixNanos::from(*start + 2000), None, None)
.unwrap();
assert_eq!(test_clock.timer_count(), 1);
let events = test_clock.advance_time(UnixNanos::from(*start + 1500), true);
assert!(events.is_empty());
let events = test_clock.advance_time(UnixNanos::from(*start + 2000), true);
assert_eq!(events.len(), 1);
assert_eq!(*events[0].ts_event, *start + 2000);
}
#[rstest]
fn test_multiple_timers_same_timestamp_all_fire(mut test_clock: TestClock) {
let fire_time = UnixNanos::from(*test_clock.timestamp_ns() + 1000);
for i in 0..5 {
test_clock
.set_time_alert_ns(&format!("timer_{i}"), fire_time, None, None)
.unwrap();
}
assert_eq!(test_clock.timer_count(), 5);
let events = test_clock.advance_time(fire_time, true);
assert_eq!(events.len(), 5);
for event in &events {
assert_eq!(*event.ts_event, *fire_time);
}
}
#[rstest]
fn test_events_ordered_by_timestamp_after_advance() {
let mut clock = TestClock::new();
clock.register_default_handler(TestCallback::default().into());
let start = clock.timestamp_ns();
clock
.set_time_alert_ns("third", UnixNanos::from(*start + 300), None, None)
.unwrap();
clock
.set_time_alert_ns("first", UnixNanos::from(*start + 100), None, None)
.unwrap();
clock
.set_time_alert_ns("second", UnixNanos::from(*start + 200), None, None)
.unwrap();
let events = clock.advance_time(UnixNanos::from(*start + 400), true);
assert_eq!(events.len(), 3);
assert_eq!(events[0].name.as_str(), "first");
assert_eq!(events[1].name.as_str(), "second");
assert_eq!(events[2].name.as_str(), "third");
}
#[rstest]
fn test_large_interval_does_not_overflow(mut test_clock: TestClock) {
let start = test_clock.timestamp_ns();
let large_interval: u64 = 1_000_000_000 * 60 * 60 * 24 * 365; // ~1 year in ns
test_clock
.set_timer_ns(
"large_interval",
large_interval,
Some(start),
None,
None,
None,
None,
)
.unwrap();
let events = test_clock.advance_time(UnixNanos::from(*start + large_interval), true);
assert_eq!(events.len(), 1);
assert_eq!(*events[0].ts_event, *start + large_interval);
}
#[rstest]
fn test_near_zero_interval_fires_correctly(mut test_clock: TestClock) {
let start = test_clock.timestamp_ns();
test_clock
.set_timer_ns("tiny", 1, Some(start), None, None, None, None)
.unwrap();
let events = test_clock.advance_time(UnixNanos::from(*start + 10), true);
assert_eq!(events.len(), 10);
for i in 1..events.len() {
assert!(events[i].ts_event >= events[i - 1].ts_event);
}
}
#[rstest]
fn test_repeated_advance_to_same_time_no_double_fire(mut test_clock: TestClock) {
let fire_time = UnixNanos::from(*test_clock.timestamp_ns() + 1000);
test_clock
.set_time_alert_ns("once", fire_time, None, None)
.unwrap();
let events1 = test_clock.advance_time(fire_time, true);
assert_eq!(events1.len(), 1);
let events2 = test_clock.advance_time(fire_time, true);
assert!(events2.is_empty());
}
#[rstest]
fn test_advance_with_no_timers(mut test_clock: TestClock) {
let start = test_clock.timestamp_ns();
let events = test_clock.advance_time(UnixNanos::from(*start + 1000), true);
assert!(events.is_empty());
assert_eq!(*test_clock.timestamp_ns(), *start + 1000);
}
}