go_zoom_kinesis/processor.rs
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 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160
//! Core processor implementation for handling Kinesis streams
//!
//! This module provides the main processing logic for consuming records from
//! Kinesis streams. It handles:
//!
//! - Shard discovery and management
//! - Record batch processing with retries
//! - Checkpointing of progress
//! - Monitoring and metrics
//! - Graceful shutdown
use aws_smithy_types_convert::date_time::DateTimeExt;
use chrono::{DateTime, Utc};
use tokio::time::Instant;
use crate::client::KinesisClientError;
use crate::error::{BeforeCheckpointError, ProcessingError};
use crate::monitoring::{IteratorEventType, MonitoringConfig, ProcessingEvent, ShardEventType};
use crate::{
client::KinesisClientTrait,
error::{ProcessorError, Result},
store::CheckpointStore,
};
use async_trait::async_trait;
use aws_sdk_kinesis::types::{Record, ShardIteratorType};
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::mpsc;
use tokio::sync::Semaphore;
use tracing::debug;
use tracing::{error, info, trace, warn};
/// Trait for implementing record processing logic
///
/// Implementors should handle the business logic for processing individual records
/// and return processed data through the associated Item type. Additional context about
/// the record and its processing state is provided through the metadata parameter.
///
/// # Examples
///
/// ```rust
/// use go_zoom_kinesis::{RecordProcessor};
/// use go_zoom_kinesis::processor::{RecordMetadata, CheckpointMetadata};
/// use go_zoom_kinesis::error::{ProcessingError, BeforeCheckpointError};
/// use aws_sdk_kinesis::types::Record;
/// use tracing::warn;
///
/// // Example data processing function
/// async fn process_data(data: &[u8]) -> anyhow::Result<String> {
/// // Simulate some data processing
/// Ok(String::from_utf8_lossy(data).to_string())
/// }
///
/// #[derive(Clone)]
/// struct MyProcessor;
///
/// #[async_trait::async_trait]
/// impl RecordProcessor for MyProcessor {
/// type Item = String;
///
/// async fn process_record<'a>(
/// &self,
/// record: &'a Record,
/// metadata: RecordMetadata<'a>,
/// ) -> std::result::Result<Option<Self::Item>, ProcessingError> {
/// // Process record data
/// let data = record.data().as_ref();
///
/// match process_data(data).await {
/// Ok(processed) => Ok(Some(processed)),
/// Err(e) => {
/// // Use metadata for detailed error context
/// warn!(
/// shard_id = %metadata.shard_id(),
/// sequence = %metadata.sequence_number(),
/// error = %e,
/// "Processing failed"
/// );
/// Err(ProcessingError::soft(e)) // Will be retried forever
/// }
/// }
/// }
///
/// async fn before_checkpoint(
/// &self,
/// processed_items: Vec<Self::Item>,
/// metadata: CheckpointMetadata<'_>,
/// ) -> std::result::Result<(), BeforeCheckpointError> {
/// // Optional validation before checkpointing
/// if processed_items.is_empty() {
/// return Err(BeforeCheckpointError::soft(
/// anyhow::anyhow!("No items to checkpoint")
/// )); // Will retry before_checkpoint
/// }
/// Ok(())
/// }
/// }
/// ```
///
/// # Type Parameters
///
/// * `Item` - The type of data produced by processing records
///
/// # Record Processing
///
/// The `process_record` method returns:
/// * `Ok(Some(item))` - Processing succeeded and produced an item
/// * `Ok(None)` - Processing succeeded but produced no item
/// * `Err(ProcessingError::SoftFailure)` - Temporary failure, will retry forever
/// * `Err(ProcessingError::HardFailure)` - Permanent failure, skip record
///
/// # Checkpoint Validation
///
/// The `before_checkpoint` method allows validation before checkpointing and returns:
/// * `Ok(())` - Proceed with checkpoint
/// * `Err(BeforeCheckpointError::SoftError)` - Retry before_checkpoint
/// * `Err(BeforeCheckpointError::HardError)` - Stop trying before_checkpoint but proceed with checkpoint
///
/// # Metadata Access
///
/// The `RecordMetadata` parameter provides:
/// * `shard_id()` - ID of the shard this record came from
/// * `sequence_number()` - Sequence number of the record
/// * `approximate_arrival_timestamp()` - When the record arrived in Kinesis
/// * `partition_key()` - Partition key used for the record
/// * `explicit_hash_key()` - Optional explicit hash key
///
/// The `CheckpointMetadata` parameter provides:
/// * `shard_id` - ID of the shard being checkpointed
/// * `sequence_number` - Sequence number being checkpointed
#[async_trait]
pub trait RecordProcessor: Send + Sync {
/// The type of data produced by processing records
type Item: Send + Clone + Send + Sync + 'static;
/// Process a single record from the Kinesis stream
///
/// # Arguments
///
/// * `record` - The Kinesis record to process
/// * `metadata` - Additional context about the record and processing attempt
///
/// # Returns
///
/// * `Ok(Some(item))` if processing succeeded and produced an item
/// * `Ok(None)` if processing succeeded but produced no item
/// * `Err(ProcessingError::SoftFailure)` for retriable errors (retries forever)
/// * `Err(ProcessingError::HardFailure)` for permanent failures (skips record)
async fn process_record<'a>(
&self,
record: &'a Record,
metadata: RecordMetadata<'a>,
) -> std::result::Result<Option<Self::Item>, ProcessingError>;
/// Validate processed items before checkpointing
///
/// # Arguments
///
/// * `processed_items` - Successfully processed items from the batch
/// * `metadata` - Information about the checkpoint operation
///
/// # Returns
///
/// * `Ok(())` to proceed with checkpoint
/// * `Err(BeforeCheckpointError::SoftError)` to retry before_checkpoint
/// * `Err(BeforeCheckpointError::HardError)` to stop trying before_checkpoint
async fn before_checkpoint(
&self,
_processed_items: Vec<Self::Item>,
_metadata: CheckpointMetadata<'_>,
) -> std::result::Result<(), BeforeCheckpointError> {
Ok(()) // Default implementation does nothing
}
}
/// Metadata associated with a Kinesis record during processing
///
/// This struct provides access to record metadata through reference-based accessors,
/// avoiding unnecessary data copying while maintaining access to processing context
/// such as shard ID and attempt count.
///
/// # Examples
///
/// ```rust
/// use go_zoom_kinesis::processor::RecordMetadata;
/// use aws_sdk_kinesis::types::Record;
///
/// fn process_with_metadata(metadata: &RecordMetadata) {
/// println!("Processing record {} from shard {}",
/// metadata.sequence_number(),
/// metadata.shard_id()
/// );
///
/// if metadata.attempt_number() > 1 {
/// println!("Retry attempt {}", metadata.attempt_number());
/// }
///
/// if let Some(timestamp) = metadata.approximate_arrival_timestamp() {
/// println!("Record arrived at: {}", timestamp);
/// }
/// }
/// ```
#[derive(Debug)]
pub struct RecordMetadata<'a> {
/// Reference to the underlying Kinesis record
record: &'a Record,
/// ID of the shard this record came from
shard_id: String,
/// Number of processing attempts for this record (starts at 1)
attempt_number: u32,
}
impl<'a> RecordMetadata<'a> {
/// Creates a new metadata instance for a record
///
/// # Arguments
///
/// * `record` - Reference to the Kinesis record
/// * `shard_id` - ID of the shard this record came from
/// * `attempt_number` - Current processing attempt number (starts at 1)
pub fn new(record: &'a Record, shard_id: String, attempt_number: u32) -> Self {
Self {
record,
shard_id,
attempt_number,
}
}
/// Gets the sequence number of the record
///
/// This is a unique identifier for the record within its shard.
pub fn sequence_number(&self) -> &str {
self.record.sequence_number()
}
/// Gets the approximate time when the record was inserted into the stream
///
/// Returns `None` if the timestamp is not available or cannot be converted
/// to the chrono timestamp format.
pub fn approximate_arrival_timestamp(&self) -> Option<DateTime<Utc>> {
self.record
.approximate_arrival_timestamp()
.and_then(|ts| ts.to_chrono_utc().ok())
}
/// Gets the partition key of the record
///
/// The partition key is used to determine which shard in the stream
/// the record belongs to.
pub fn partition_key(&self) -> &str {
self.record.partition_key()
}
/// Gets the ID of the shard this record came from
pub fn shard_id(&self) -> &str {
&self.shard_id
}
/// Gets the current processing attempt number
///
/// This starts at 1 for the first attempt and increments
/// for each retry.
pub fn attempt_number(&self) -> u32 {
self.attempt_number
}
}
/// Metadata associated with a checkpoint operation
///
/// This struct provides access to checkpoint metadata through reference-based accessors,
/// providing context about the checkpoint operation such as shard ID and sequence number.
///
/// # Examples
///
/// ```rust
/// use go_zoom_kinesis::processor::CheckpointMetadata;
///
/// fn validate_checkpoint(metadata: &CheckpointMetadata) {
/// println!("Checkpointing shard {} at sequence {}",
/// metadata.shard_id(),
/// metadata.sequence_number()
/// );
///
/// // Perform checkpoint validation
/// if metadata.sequence_number().starts_with("49579") {
/// println!("Checkpoint at expected sequence range");
/// }
/// }
/// ```
#[derive(Debug, Clone)]
pub struct CheckpointMetadata<'a> {
/// ID of the shard being checkpointed
shard_id: &'a str,
/// Sequence number being checkpointed
sequence_number: &'a str,
}
impl CheckpointMetadata<'_> {
/// Gets the ID of the shard being checkpointed
pub fn shard_id(&self) -> &str {
self.shard_id
}
/// Gets the sequence number being checkpointed
pub fn sequence_number(&self) -> &str {
self.sequence_number
}
}
/// Specifies where to start reading from in the stream
#[derive(Debug, Clone)]
pub enum InitialPosition {
/// Start from the oldest available record
TrimHorizon,
/// Start from the newest record
Latest,
/// Start from a specific sequence number
AtSequenceNumber(String),
/// Start from a specific timestamp
AtTimestamp(DateTime<Utc>),
}
/// Result of processing a batch of records
#[derive(Debug)]
struct BatchProcessingResult {
/// Sequence numbers of successfully processed records
successful_records: Vec<String>,
/// Sequence numbers of failed records
failed_records: Vec<String>,
/// Last successfully processed sequence number
last_successful_sequence: Option<String>,
}
/// Configuration for the Kinesis processor
#[derive(Debug, Clone)]
pub struct ProcessorConfig {
/// Name of the Kinesis stream to process
pub stream_name: String,
/// Maximum number of records to request per GetRecords call
pub batch_size: i32,
/// Timeout for API calls to AWS
pub api_timeout: Duration,
/// Maximum time allowed for processing a single record
pub processing_timeout: Duration,
/// Optional total runtime limit
pub total_timeout: Option<Duration>,
/// Maximum number of retry attempts (None for infinite)
pub max_retries: Option<u32>,
/// How often to refresh the shard list
pub shard_refresh_interval: Duration,
/// Maximum number of shards to process concurrently
pub max_concurrent_shards: Option<u32>,
/// Monitoring configuration
pub monitoring: MonitoringConfig,
/// Where to start reading from in the stream
pub initial_position: InitialPosition,
/// Whether to prefer stored checkpoints over initial position
pub prefer_stored_checkpoint: bool,
/// Minimum time to retrieve a batch of records from multiple client batch retrievals
pub minimum_batch_retrieval_time: Duration,
/// Maximum number of loops to retrieve batches of records
pub max_batch_retrieval_loops: Option<u32>,
}
impl Default for ProcessorConfig {
fn default() -> Self {
Self {
stream_name: String::new(),
batch_size: 100,
api_timeout: Duration::from_secs(30),
processing_timeout: Duration::from_secs(300),
total_timeout: None,
max_retries: Some(3),
shard_refresh_interval: Duration::from_secs(60),
max_concurrent_shards: None,
monitoring: MonitoringConfig::default(),
initial_position: InitialPosition::TrimHorizon,
prefer_stored_checkpoint: true,
minimum_batch_retrieval_time: Duration::from_millis(100),
max_batch_retrieval_loops: Some(10),
}
}
}
/// Internal context holding processor state and dependencies
pub struct ProcessingContext<P, C, S>
where
P: RecordProcessor + Send + Sync + 'static,
C: KinesisClientTrait + Send + Sync + Clone + 'static,
S: CheckpointStore + Send + Sync + Clone + 'static,
{
/// The user-provided record processor implementation
processor: Arc<P>,
/// AWS Kinesis client
client: Arc<C>,
/// Checkpoint storage implementation
store: Arc<S>,
/// Processor configuration
config: ProcessorConfig,
/// Channel for sending monitoring events
monitoring_tx: Option<mpsc::Sender<ProcessingEvent>>,
}
impl<
P: RecordProcessor,
C: KinesisClientTrait + std::clone::Clone,
S: CheckpointStore + std::clone::Clone,
> Clone for ProcessingContext<P, C, S>
{
fn clone(&self) -> Self {
Self {
processor: self.processor.clone(),
client: self.client.clone(),
store: self.store.clone(),
config: self.config.clone(),
monitoring_tx: self.monitoring_tx.clone(),
}
}
}
impl<P, C, S> ProcessingContext<P, C, S>
where
P: RecordProcessor + Send + Sync + 'static,
C: KinesisClientTrait + Send + Sync + Clone + 'static,
S: CheckpointStore + Send + Sync + Clone + 'static,
{
/// Creates a new processing context
///
/// # Arguments
///
/// * `processor` - The record processor implementation
/// * `client` - AWS Kinesis client
/// * `store` - Checkpoint storage implementation
/// * `config` - Processor configuration
/// * `monitoring_tx` - Optional channel for monitoring events
pub fn new(
processor: P,
client: C,
store: S,
config: ProcessorConfig,
monitoring_tx: Option<mpsc::Sender<ProcessingEvent>>,
) -> Self {
Self {
processor: Arc::new(processor),
client: Arc::new(client),
store: Arc::new(store),
config,
monitoring_tx,
}
}
/// Sends a monitoring event if monitoring is enabled
async fn send_monitoring_event(&self, event: ProcessingEvent) {
if let Some(tx) = &self.monitoring_tx {
if let Err(e) = tx.send(event).await {
warn!(error = %e, "Failed to send monitoring event");
} else {
trace!("Sent monitoring event successfully");
}
}
}
/// Checks if an error indicates an expired iterator
fn is_iterator_expired(&self, error: &KinesisClientError) -> bool {
matches!(error, KinesisClientError::ExpiredIterator)
}
}
/// Main Kinesis stream processor
///
/// Handles the orchestration of:
/// - Shard discovery and management
/// - Record batch processing
/// - Checkpointing
/// - Monitoring
/// - Graceful shutdown
///
/// # Examples
///
/// ```rust
/// use go_zoom_kinesis::{KinesisProcessor, ProcessorConfig, RecordProcessor, ProcessorError};
/// use aws_sdk_kinesis::Client;
/// use go_zoom_kinesis::store::InMemoryCheckpointStore;
///
/// async fn run_processor(
/// processor: impl RecordProcessor + 'static,
/// client: Client,
/// config: ProcessorConfig
/// ) -> Result<(), ProcessorError> {
/// let store = InMemoryCheckpointStore::new();
/// let (shutdown_tx, shutdown_rx) = tokio::sync::watch::channel(false);
///
/// let (processor, _monitoring_rx) = KinesisProcessor::new(
/// config,
/// processor,
/// client,
/// store
/// );
///
/// processor.run(shutdown_rx).await
/// }
/// ```
pub struct KinesisProcessor<P, C, S>
where
P: RecordProcessor + Send + Sync + 'static,
P::Item: Send + Sync + 'static,
C: KinesisClientTrait + Send + Sync + Clone + 'static,
S: CheckpointStore + Send + Sync + Clone + 'static,
{
context: ProcessingContext<P, C, S>,
}
impl<P, C, S> KinesisProcessor<P, C, S>
where
P: RecordProcessor + Send + Sync + 'static,
C: KinesisClientTrait + Send + Sync + Clone + 'static,
S: CheckpointStore + Send + Sync + Clone + 'static,
{
/// Creates a new processor instance
///
/// # Arguments
///
/// * `config` - Processor configuration
/// * `processor` - Record processor implementation
/// * `client` - AWS Kinesis client
/// * `store` - Checkpoint storage implementation
///
/// # Returns
///
/// Returns a tuple of the processor instance and an optional monitoring channel receiver
pub fn new(
config: ProcessorConfig,
processor: P,
client: C,
store: S,
) -> (Self, Option<mpsc::Receiver<ProcessingEvent>>) {
let (monitoring_tx, monitoring_rx) = if config.monitoring.enabled {
let (tx, rx) = mpsc::channel(config.monitoring.channel_size);
(Some(tx), Some(rx))
} else {
(None, None)
};
let context = ProcessingContext::new(processor, client, store, config, monitoring_tx);
(Self { context }, monitoring_rx)
}
/// Starts processing the Kinesis stream
///
/// # Arguments
///
/// * `shutdown` - Channel receiver for shutdown signals
///
/// # Returns
///
/// Returns Ok(()) on successful shutdown, or Error on processing failures
pub async fn run(&self, mut shutdown_rx: tokio::sync::watch::Receiver<bool>) -> Result<()> {
info!(stream=%self.context.config.stream_name, "Starting Kinesis processor");
loop {
if *shutdown_rx.borrow() {
info!("Shutdown signal received");
break;
}
if let Err(e) = self.process_stream(&mut shutdown_rx).await {
error!(error=%e, "Error processing stream");
if !matches!(e, ProcessorError::Shutdown) {
return Err(e);
}
break;
}
}
info!("Processor shutdown complete");
Ok(())
}
/// Process all shards in the stream
async fn process_stream(
&self,
shutdown_rx: &mut tokio::sync::watch::Receiver<bool>,
) -> Result<()> {
let shards = self
.context
.client
.list_shards(&self.context.config.stream_name)
.await?;
let semaphore = self
.context
.config
.max_concurrent_shards
.map(|limit| Arc::new(Semaphore::new(limit as usize)));
let mut handles = Vec::new();
for shard in shards {
let shard_id = shard.shard_id().to_string();
let context = self.context.clone(); // Clone the context instead of self
let semaphore = semaphore.clone();
let shutdown_rx = shutdown_rx.clone();
let handle = tokio::spawn(async move {
let _permit = if let Some(sem) = &semaphore {
Some(sem.acquire().await?)
} else {
None
};
// Create a new processor for this shard using the cloned context
let processor = KinesisProcessor { context };
processor.process_shard(&shard_id, shutdown_rx).await
});
handles.push(handle);
}
for handle in handles {
handle.await??;
}
Ok(())
}
/// Get a batch of records from a shard
///
/// # Arguments
///
/// * `ctx` - Processing context
/// * `shard_id` - ID of the shard being processed
/// * `iterator` - Shard iterator for getting records
/// * `shutdown_rx` - Channel receiver for shutdown signals
async fn get_records_batch(
ctx: &ProcessingContext<P, C, S>,
shard_id: &str,
iterator: &str,
shutdown_rx: &mut tokio::sync::watch::Receiver<bool>,
) -> Result<(Vec<Record>, Option<String>)> {
match ctx
.client
.get_records(
iterator,
ctx.config.batch_size,
0,
ctx.config.max_retries,
shutdown_rx,
)
.await
{
Ok(result) => Ok(result),
Err(e) if ctx.is_iterator_expired(&e) => {
warn!(
shard_id = %shard_id,
error = %e,
"Iterator expired"
);
Err(ProcessorError::IteratorExpired(shard_id.to_string()))
}
Err(e) => {
error!(
shard_id = %shard_id,
error = %e,
"Failed to get records"
);
Err(ProcessorError::GetRecordsFailed(e.to_string()))
}
}
}
/// Initialize checkpoint for a shard
///
/// # Arguments
///
/// * `ctx` - Processing context
/// * `shard_id` - ID of the shard to initialize
async fn initialize_checkpoint(
ctx: &ProcessingContext<P, C, S>,
shard_id: &str,
) -> Result<Option<String>> {
match ctx.store.get_checkpoint(shard_id).await {
Ok(Some(cp)) => {
info!(
shard_id = %shard_id,
checkpoint = %cp,
"Retrieved existing checkpoint"
);
Ok(Some(cp))
}
Ok(None) => {
info!(shard_id = %shard_id, "No existing checkpoint found");
Ok(None)
}
Err(e) => {
error!(
shard_id = %shard_id,
error = %e,
"Failed to retrieve checkpoint"
);
Err(ProcessorError::CheckpointError(e.to_string()))
}
}
}
/// Get initial iterator for a shard
///
/// # Arguments
///
/// * `ctx` - Processing context
/// * `shard_id` - ID of the shard
/// * `checkpoint` - Optional checkpoint to start from
/// * `shutdown_rx` - Channel receiver for shutdown signals
async fn get_initial_iterator(
ctx: &ProcessingContext<P, C, S>,
shard_id: &str,
checkpoint: &Option<String>,
shutdown_rx: &mut tokio::sync::watch::Receiver<bool>,
) -> Result<String> {
let iterator_type = if checkpoint.is_some() {
ShardIteratorType::AfterSequenceNumber
} else {
ShardIteratorType::TrimHorizon
};
tokio::select! {
iterator_result = ctx.client.get_shard_iterator(
&ctx.config.stream_name,
shard_id,
iterator_type,
checkpoint.as_deref(),
None,
) => {
match iterator_result {
Ok(iterator) => {
debug!(
shard_id = %shard_id,
"Successfully acquired initial iterator"
);
Ok(iterator)
}
Err(e) => {
error!(
shard_id = %shard_id,
error = %e,
"Failed to get initial iterator"
);
Err(ProcessorError::GetIteratorFailed(e.to_string()))
}
}
}
_ = shutdown_rx.changed() => {
info!(
shard_id = %shard_id,
"Shutdown received while getting initial iterator"
);
Err(ProcessorError::Shutdown)
}
}
}
/// Process a batch of records
async fn process_batch(
&self,
shard_id: &str,
iterator: &str,
state: &mut ShardProcessingState,
mut shutdown_rx: tokio::sync::watch::Receiver<bool>,
) -> Result<BatchResult> {
let batch_start = Instant::now();
let mut accumulated_records = Vec::new();
let mut current_iterator = iterator.to_string();
let mut loop_count = 0;
loop {
if let Some(max_loops) = self.context.config.max_batch_retrieval_loops {
if loop_count >= max_loops {
debug!(shard_id=%shard_id, loop_count=loop_count, "Reached maximum batch retrieval loops");
break;
}
}
match Self::get_records_batch(
&self.context,
shard_id,
¤t_iterator,
&mut shutdown_rx,
)
.await
{
Ok((records, next_iterator)) => {
if records.is_empty() && next_iterator.is_none() {
if accumulated_records.is_empty() {
return Ok(BatchResult::EndOfShard);
}
break;
}
accumulated_records.extend(records);
if let Some(next) = next_iterator {
current_iterator = next;
} else {
break;
}
loop_count += 1;
let elapsed = batch_start.elapsed();
if elapsed < self.context.config.minimum_batch_retrieval_time {
continue;
} else if !accumulated_records.is_empty() {
break;
}
}
Err(ProcessorError::IteratorExpired(_)) => {
self.context
.send_monitoring_event(ProcessingEvent::iterator(
shard_id.to_string(),
IteratorEventType::Expired,
None,
))
.await;
let new_iterator = Self::get_initial_iterator(
&self.context,
shard_id,
&state.last_successful_sequence,
&mut shutdown_rx,
)
.await?;
self.context
.send_monitoring_event(ProcessingEvent::iterator(
shard_id.to_string(),
IteratorEventType::Renewed,
None,
))
.await;
return Ok(BatchResult::Continue(new_iterator));
}
Err(e) => {
self.context
.send_monitoring_event(ProcessingEvent::shard_event(
shard_id.to_string(),
ShardEventType::Error,
Some(e.to_string()),
))
.await;
return Err(e);
}
}
}
if !accumulated_records.is_empty() {
let batch_processor = BatchProcessor {
ctx: self.context.clone(),
};
match batch_processor
.process_batch(shard_id, &accumulated_records, &mut shutdown_rx)
.await
{
Ok(batch_result) => {
if let Some(seq) = batch_result.last_successful_sequence {
state.last_successful_sequence = Some(seq);
}
self.context
.send_monitoring_event(ProcessingEvent::batch_complete(
shard_id.to_string(),
batch_result.successful_records.len(),
batch_result.failed_records.len(),
batch_start.elapsed(),
))
.await;
if batch_result.successful_records.is_empty() {
Ok(BatchResult::NoRecords)
} else {
Ok(BatchResult::Continue(current_iterator))
}
}
Err(e) => {
self.context
.send_monitoring_event(ProcessingEvent::batch_error(
shard_id.to_string(),
e.to_string(),
batch_start.elapsed(),
))
.await;
Err(e)
}
}
} else {
Ok(BatchResult::NoRecords)
}
}
/// Process a single shard
///
/// # Arguments
///
/// * `ctx` - Processing context
/// * `shard_id` - ID of the shard to process
/// * `shutdown_rx` - Channel receiver for shutdown signals
async fn process_shard(
&self,
shard_id: &str,
shutdown_rx: tokio::sync::watch::Receiver<bool>,
) -> Result<()> {
info!(shard_id=%shard_id, "Starting shard processing");
self.context
.send_monitoring_event(ProcessingEvent::shard_event(
shard_id.to_string(),
ShardEventType::Started,
None,
))
.await;
if *shutdown_rx.borrow() {
self.context
.send_monitoring_event(ProcessingEvent::shard_event(
shard_id.to_string(),
ShardEventType::Interrupted,
Some("Early shutdown".to_string()),
))
.await;
return Self::handle_early_shutdown(shard_id);
}
let mut state = ShardProcessingState::new();
let checkpoint = match Self::initialize_checkpoint(&self.context, shard_id).await {
Ok(cp) => {
if let Some(ref checkpoint) = cp {
self.context
.send_monitoring_event(ProcessingEvent::checkpoint(
shard_id.to_string(),
checkpoint.clone(),
true,
None,
))
.await;
}
cp
}
Err(e) => {
self.context
.send_monitoring_event(ProcessingEvent::checkpoint(
shard_id.to_string(),
"".to_string(),
false,
Some(e.to_string()),
))
.await;
return Err(e);
}
};
let mut shutdown_rx_clone = shutdown_rx.clone();
let mut iterator = match Self::get_initial_iterator(
&self.context,
shard_id,
&checkpoint,
&mut shutdown_rx_clone,
)
.await
{
Ok(it) => it,
Err(e) => {
self.context
.send_monitoring_event(ProcessingEvent::iterator(
shard_id.to_string(),
IteratorEventType::Failed,
Some(e.to_string()),
))
.await;
return Err(e);
}
};
loop {
let mut shutdown_rx2 = shutdown_rx.clone();
tokio::select! {
batch_result = self.process_batch(
shard_id,
&iterator,
&mut state,
shutdown_rx2.clone(),
) => {
match batch_result {
Ok(BatchResult::Continue(next_it)) => {
iterator = next_it;
self.context.send_monitoring_event(ProcessingEvent::iterator(
shard_id.to_string(),
IteratorEventType::Renewed,
None,
)).await;
}
Ok(BatchResult::EndOfShard) => {
self.context.send_monitoring_event(ProcessingEvent::shard_event(
shard_id.to_string(),
ShardEventType::Completed,
None,
)).await;
break;
}
Ok(BatchResult::NoRecords) => continue,
Err(e) => {
self.context.send_monitoring_event(ProcessingEvent::shard_event(
shard_id.to_string(),
ShardEventType::Error,
Some(e.to_string()),
)).await;
return Err(e);
}
}
}
_ = shutdown_rx2.changed() => {
info!(shard_id=%shard_id, "Shutdown received in main processing loop");
self.context.send_monitoring_event(ProcessingEvent::shard_event(
shard_id.to_string(),
ShardEventType::Interrupted,
Some("Shutdown requested".to_string()),
)).await;
return Err(ProcessorError::Shutdown);
}
}
}
info!(shard_id=%shard_id, "Completed shard processing");
self.context
.send_monitoring_event(ProcessingEvent::shard_event(
shard_id.to_string(),
ShardEventType::Completed,
None,
))
.await;
Ok(())
}
/// Handle early shutdown request
fn handle_early_shutdown(shard_id: &str) -> Result<()> {
info!(
shard_id = %shard_id,
"Shutdown signal received before processing started"
);
Err(ProcessorError::Shutdown)
}
}
/// Tracks the state of shard processing
struct ShardProcessingState {
/// Last successfully processed sequence number
last_successful_sequence: Option<String>,
}
impl ShardProcessingState {
fn new() -> Self {
Self {
last_successful_sequence: None,
}
}
}
/// Result of batch processing operations
#[allow(dead_code)]
enum BatchResult {
/// Continue processing with new iterator
Continue(String),
/// End of shard reached
EndOfShard,
/// No records received
NoRecords,
}
struct BatchProcessor<P, C, S>
where
P: RecordProcessor + Send + Sync + 'static,
C: KinesisClientTrait + Send + Sync + Clone + 'static,
S: CheckpointStore + Send + Sync + Clone + 'static,
{
ctx: ProcessingContext<P, C, S>,
}
#[derive(Debug)]
enum RecordProcessingResult<T> {
Success(String, Option<T>),
Failed(String),
}
impl BatchProcessingResult {
fn new() -> Self {
Self {
successful_records: Vec::new(),
failed_records: Vec::new(),
last_successful_sequence: None,
}
}
}
impl<P, C, S> BatchProcessor<P, C, S>
where
P: RecordProcessor + Send + Sync + 'static,
C: KinesisClientTrait + Send + Sync + Clone + 'static,
S: CheckpointStore + Send + Sync + Clone + 'static,
{
async fn process_batch(
&self,
shard_id: &str,
records: &[Record],
shutdown_rx: &mut tokio::sync::watch::Receiver<bool>,
) -> Result<BatchProcessingResult> {
let batch_start = Instant::now();
let mut result = BatchProcessingResult::new();
let mut processed_items = Vec::new();
for record in records {
if *shutdown_rx.borrow() {
return Err(ProcessorError::Shutdown);
}
let process_result = self
.process_single_record(record, shard_id, shutdown_rx)
.await?;
self.update_batch_result(&mut result, &mut processed_items, process_result);
}
if !processed_items.is_empty() {
match self
.handle_checkpointing(shard_id, &result, &processed_items, shutdown_rx)
.await
{
Ok(()) => {
self.send_batch_metrics(shard_id, &result, batch_start.elapsed())
.await;
Ok(result)
}
Err(e) => {
warn!("Checkpoint failed: {}", e);
Err(e)
}
}
} else {
Ok(result)
}
}
async fn process_single_record(
&self,
record: &Record,
shard_id: &str,
shutdown_rx: &mut tokio::sync::watch::Receiver<bool>,
) -> Result<RecordProcessingResult<P::Item>> {
let sequence = record.sequence_number().to_string();
let mut attempt_number = 0;
loop {
if *shutdown_rx.borrow() {
return Err(ProcessorError::Shutdown);
}
tokio::select! {
process_result = self.attempt_process_record(record, shard_id, attempt_number) => {
match process_result {
Ok(Some(item)) => {
self.send_success_event(shard_id, &sequence).await;
return Ok(RecordProcessingResult::Success(sequence, Some(item)));
}
Ok(None) => {
self.send_success_event(shard_id, &sequence).await;
return Ok(RecordProcessingResult::Success(sequence, None));
}
Err(ProcessingError::SoftFailure(e)) => {
self.send_attempt_event(shard_id, &sequence, attempt_number, false, Some(e.to_string())).await;
attempt_number += 1;
continue;
}
Err(ProcessingError::HardFailure(e)) => {
self.send_failure_event(shard_id, &sequence, e.to_string()).await;
return Ok(RecordProcessingResult::Failed(sequence));
}
}
}
_ = shutdown_rx.changed() => {
return Err(ProcessorError::Shutdown);
}
_ = tokio::time::sleep(self.ctx.config.processing_timeout) => {
return Err(ProcessorError::ProcessingTimeout(self.ctx.config.processing_timeout));
}
}
}
}
async fn attempt_process_record(
&self,
record: &Record,
shard_id: &str,
attempt_number: u32,
) -> std::result::Result<Option<P::Item>, ProcessingError> {
self.ctx
.processor
.process_record(
record,
RecordMetadata::new(record, shard_id.to_string(), attempt_number),
)
.await
}
fn update_batch_result(
&self,
result: &mut BatchProcessingResult,
processed_items: &mut Vec<P::Item>,
record_result: RecordProcessingResult<P::Item>,
) {
match record_result {
RecordProcessingResult::Success(sequence, item) => {
if let Some(item) = item {
processed_items.push(item);
}
result.successful_records.push(sequence.clone());
result.last_successful_sequence = Some(sequence);
}
RecordProcessingResult::Failed(sequence) => {
result.failed_records.push(sequence);
}
}
}
async fn handle_checkpointing(
&self,
shard_id: &str,
result: &BatchProcessingResult,
processed_items: &[P::Item],
shutdown_rx: &mut tokio::sync::watch::Receiver<bool>,
) -> Result<()> {
if let Some(last_sequence) = &result.last_successful_sequence {
let metadata = CheckpointMetadata {
shard_id,
sequence_number: last_sequence,
};
let mut retry_count = 0;
loop {
if *shutdown_rx.borrow() {
return Err(ProcessorError::Shutdown);
}
tokio::select! {
checkpoint_result = self.try_checkpoint(shard_id, last_sequence, processed_items, &metadata) => {
match checkpoint_result {
Ok(()) => return Ok(()),
Err(BeforeCheckpointError::SoftError(e)) => {
retry_count += 1;
self.ctx.send_monitoring_event(ProcessingEvent::checkpoint(
shard_id.to_string(),
last_sequence.to_string(),
false,
Some(format!("Validation failed (attempt {}): {}", retry_count, e)),
)).await;
continue;
}
Err(BeforeCheckpointError::HardError(e)) => {
return Err(ProcessorError::CheckpointError(e.to_string()));
}
}
}
_ = shutdown_rx.changed() => {
return Err(ProcessorError::Shutdown);
}
}
}
}
Ok(())
}
async fn try_checkpoint(
&self,
shard_id: &str,
sequence: &str,
processed_items: &[P::Item],
metadata: &CheckpointMetadata<'_>,
) -> std::result::Result<(), BeforeCheckpointError> {
match self
.ctx
.processor
.before_checkpoint(processed_items.to_vec(), metadata.clone())
.await
{
Ok(()) => match self.ctx.store.save_checkpoint(shard_id, sequence).await {
Ok(()) => {
self.send_checkpoint_success(shard_id, sequence).await;
Ok(())
}
Err(e) => Err(BeforeCheckpointError::SoftError(e)),
},
Err(e) => Err(e),
}
}
// Monitoring event helpers
async fn send_success_event(&self, shard_id: &str, sequence: &str) {
self.ctx
.send_monitoring_event(ProcessingEvent::record_success(
shard_id.to_string(),
sequence.to_string(),
true,
))
.await;
}
async fn send_failure_event(&self, shard_id: &str, sequence: &str, error: String) {
self.ctx
.send_monitoring_event(ProcessingEvent::record_failure(
shard_id.to_string(),
sequence.to_string(),
error,
))
.await;
}
async fn send_attempt_event(
&self,
shard_id: &str,
sequence: &str,
attempt: u32,
success: bool,
error: Option<String>,
) {
self.ctx
.send_monitoring_event(ProcessingEvent::record_attempt(
shard_id.to_string(),
sequence.to_string(),
success,
attempt,
Duration::from_secs(0),
error,
false,
))
.await;
}
async fn send_checkpoint_success(&self, shard_id: &str, sequence: &str) {
self.ctx
.send_monitoring_event(ProcessingEvent::checkpoint(
shard_id.to_string(),
sequence.to_string(),
true,
None,
))
.await;
}
async fn send_batch_metrics(
&self,
shard_id: &str,
result: &BatchProcessingResult,
duration: Duration,
) {
self.ctx
.send_monitoring_event(ProcessingEvent::batch_complete(
shard_id.to_string(),
result.successful_records.len(),
result.failed_records.len(),
duration,
))
.await;
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::monitoring::ProcessingEventType;
use crate::test::collect_monitoring_events;
use crate::test::{
mocks::{MockCheckpointStore, MockKinesisClient, MockRecordProcessor},
TestUtils,
};
use std::collections::HashSet;
use std::sync::Once;
use crate::InMemoryCheckpointStore;
use tracing_subscriber::EnvFilter;
// Add this static for one-time initialization
static INIT: Once = Once::new();
/// Initialize logging for tests
fn init_logging() {
INIT.call_once(|| {
tracing_subscriber::fmt()
.with_env_filter(
EnvFilter::from_default_env()
.add_directive("go_zoom_kinesis=debug".parse().unwrap())
.add_directive("test=debug".parse().unwrap()),
)
.with_test_writer()
.with_thread_ids(true)
.with_file(true)
.with_line_number(true)
.try_init()
.ok();
});
}
#[tokio::test]
async fn test_processor_basic_flow() -> anyhow::Result<()> {
let config = ProcessorConfig {
stream_name: "test-stream".to_string(),
batch_size: 100,
api_timeout: Duration::from_secs(1),
processing_timeout: Duration::from_secs(1),
total_timeout: None,
max_retries: Some(2),
shard_refresh_interval: Duration::from_secs(1),
max_concurrent_shards: None,
monitoring: MonitoringConfig::default(),
initial_position: InitialPosition::TrimHorizon,
prefer_stored_checkpoint: true,
minimum_batch_retrieval_time: Duration::from_millis(50), // Short time for tests
max_batch_retrieval_loops: Some(2), // Limited loops for tests
};
let client = MockKinesisClient::new();
let processor = MockRecordProcessor::new();
let checkpoint_store = MockCheckpointStore::new();
let test_records = TestUtils::create_test_records(3);
client
.mock_list_shards(Ok(vec![TestUtils::create_test_shard("shard-1")]))
.await;
client
.mock_get_iterator(Ok("test-iterator".to_string()))
.await;
client
.mock_get_records(Ok((test_records.clone(), None)))
.await;
let (tx, rx) = tokio::sync::watch::channel(false);
let (processor, _monitoring_rx) =
KinesisProcessor::new(config, processor.clone(), client, checkpoint_store);
let processor_handle = tokio::spawn(async move { processor.run(rx).await });
tokio::time::sleep(Duration::from_millis(100)).await;
tx.send(true)?;
processor_handle.await??;
Ok(())
}
#[tokio::test]
async fn test_processor_error_handling() -> anyhow::Result<()> {
let config = ProcessorConfig {
stream_name: "test-stream".to_string(),
batch_size: 100,
api_timeout: Duration::from_secs(1),
processing_timeout: Duration::from_secs(1),
total_timeout: None,
max_retries: Some(2),
shard_refresh_interval: Duration::from_secs(1),
max_concurrent_shards: None,
monitoring: MonitoringConfig::default(),
initial_position: InitialPosition::TrimHorizon,
prefer_stored_checkpoint: true,
minimum_batch_retrieval_time: Duration::from_millis(50), // Short time for tests
max_batch_retrieval_loops: Some(2), // Limited loops for tests
};
let client = MockKinesisClient::new();
let processor = MockRecordProcessor::new();
let checkpoint_store = MockCheckpointStore::new();
client
.mock_list_shards(Ok(vec![TestUtils::create_test_shard("shard-1")]))
.await;
client
.mock_get_iterator(Ok("test-iterator".to_string()))
.await;
// Configure explicit failure
processor
.configure_failure(
"sequence-0".to_string(),
"soft",
2, // Will fail after 2 attempts
)
.await;
// Create test record that will fail
let test_records = vec![TestUtils::create_test_record("sequence-0", b"will fail")];
client
.mock_get_records(Ok((test_records, Some("next-iterator".to_string()))))
.await;
let (tx, rx) = tokio::sync::watch::channel(false);
let (processor_instance, _monitoring_rx) =
KinesisProcessor::new(config, processor.clone(), client, checkpoint_store);
// Run processor and wait for processing
let processor_handle = tokio::spawn(async move { processor_instance.run(rx).await });
// Give enough time for processing and retries
tokio::time::sleep(Duration::from_secs(1)).await;
// Signal shutdown
tx.send(true)?;
// Wait for processor to complete
processor_handle.await??;
// Verify errors were recorded
let error_count = processor.get_error_count().await;
assert!(
error_count > 0,
"Expected errors to be recorded, got {}",
error_count
);
Ok(())
}
#[tokio::test]
async fn test_processor_checkpoint_recovery() -> anyhow::Result<()> {
let config = ProcessorConfig {
stream_name: "test-stream".to_string(),
batch_size: 100,
api_timeout: Duration::from_secs(1),
processing_timeout: Duration::from_secs(1),
total_timeout: None,
max_retries: Some(2),
shard_refresh_interval: Duration::from_secs(1),
max_concurrent_shards: None,
monitoring: MonitoringConfig::default(),
initial_position: InitialPosition::TrimHorizon,
prefer_stored_checkpoint: true,
minimum_batch_retrieval_time: Duration::from_millis(50), // Short time for tests
max_batch_retrieval_loops: Some(2), // Limited loops for tests
};
let client = MockKinesisClient::new();
let processor = MockRecordProcessor::new();
let checkpoint_store = MockCheckpointStore::new();
checkpoint_store
.save_checkpoint("shard-1", "sequence-100")
.await?;
client
.mock_list_shards(Ok(vec![TestUtils::create_test_shard("shard-1")]))
.await;
client
.mock_get_iterator(Ok("test-iterator".to_string()))
.await;
client
.mock_get_records(Ok((
TestUtils::create_test_records(1),
Some("next-iterator".to_string()),
)))
.await;
let (tx, rx) = tokio::sync::watch::channel(false);
let (processor, _monitoring_rx) =
KinesisProcessor::new(config, processor.clone(), client, checkpoint_store);
tokio::spawn(async move {
tokio::time::sleep(Duration::from_millis(100)).await;
tx.send(true).unwrap();
});
processor.run(rx).await?;
let processed_records = processor.context.processor.get_processed_records().await;
assert!(!processed_records.is_empty());
Ok(())
}
#[tokio::test]
async fn test_processor_multiple_shards() -> anyhow::Result<()> {
let config = ProcessorConfig {
stream_name: "test-stream".to_string(),
batch_size: 100,
api_timeout: Duration::from_secs(1),
processing_timeout: Duration::from_secs(1),
total_timeout: None,
max_retries: Some(2),
shard_refresh_interval: Duration::from_secs(1),
max_concurrent_shards: Some(2),
monitoring: MonitoringConfig::default(),
initial_position: InitialPosition::TrimHorizon,
prefer_stored_checkpoint: true,
minimum_batch_retrieval_time: Duration::from_millis(50), // Short time for tests
max_batch_retrieval_loops: Some(2), // Limited loops for tests
};
let client = MockKinesisClient::new();
let processor = MockRecordProcessor::new();
let checkpoint_store = MockCheckpointStore::new();
client
.mock_list_shards(Ok(vec![
TestUtils::create_test_shard("shard-1"),
TestUtils::create_test_shard("shard-2"),
]))
.await;
client
.mock_get_iterator(Ok("test-iterator-1".to_string()))
.await;
client
.mock_get_iterator(Ok("test-iterator-2".to_string()))
.await;
client
.mock_get_records(Ok((
TestUtils::create_test_records(1),
Some("next-iterator-1".to_string()),
)))
.await;
client
.mock_get_records(Ok((
TestUtils::create_test_records(1),
Some("next-iterator-2".to_string()),
)))
.await;
let (tx, rx) = tokio::sync::watch::channel(false);
let (processor, _monitoring_rx) =
KinesisProcessor::new(config, processor.clone(), client, checkpoint_store);
tokio::spawn(async move {
tokio::time::sleep(Duration::from_millis(200)).await;
tx.send(true).unwrap();
});
processor.run(rx).await?;
let processed_records = processor.context.processor.get_processed_records().await;
assert!(processed_records.len() >= 2);
Ok(())
}
#[tokio::test]
async fn test_processor_with_monitoring() -> Result<()> {
init_logging();
info!("Starting monitoring test");
// Configure with monitoring enabled
let config = ProcessorConfig {
stream_name: "test-stream".to_string(),
batch_size: 100,
monitoring: MonitoringConfig {
enabled: true,
channel_size: 100,
metrics_interval: Duration::from_millis(100),
include_retry_details: true,
rate_limit: None,
},
..Default::default()
};
let client = MockKinesisClient::new();
let processor = MockRecordProcessor::new();
let store = MockCheckpointStore::new();
// Setup test data
client
.mock_list_shards(Ok(vec![TestUtils::create_test_shard("shard-1")]))
.await;
client
.mock_get_iterator(Ok("test-iterator".to_string()))
.await;
// Create test record
let test_record = TestUtils::create_test_record("seq-1", b"test");
client
.mock_get_records(Ok((vec![test_record], Some("next-iterator".to_string()))))
.await;
let (tx, rx) = tokio::sync::watch::channel(false);
let (processor_instance, mut monitoring_rx) =
KinesisProcessor::new(config, processor.clone(), client, store);
// Spawn processor task
let handle = tokio::spawn(async move { processor_instance.run(rx).await });
// Collect and verify events
let events =
collect_monitoring_events(&mut monitoring_rx, Duration::from_millis(500)).await;
// Debug print events
println!("\nReceived Events:");
for event in &events {
println!("Event: {:?}", event);
}
// Verify we got all expected event types
let mut found_events = HashSet::new();
for event in &events {
match &event.event_type {
ProcessingEventType::ShardEvent {
event_type: ShardEventType::Started,
..
} => {
found_events.insert("shard_start");
}
ProcessingEventType::RecordSuccess { .. } => {
found_events.insert("record_success");
}
ProcessingEventType::Checkpoint { success: true, .. } => {
found_events.insert("checkpoint_success");
}
ProcessingEventType::BatchComplete { .. } => {
found_events.insert("batch_complete");
}
ProcessingEventType::ShardEvent {
event_type: ShardEventType::Completed,
..
} => {
found_events.insert("shard_complete");
}
_ => {}
}
}
// Verify required events
let required_events = vec![
"shard_start",
"record_success",
"checkpoint_success",
"batch_complete",
"shard_complete",
];
for required in required_events {
assert!(
found_events.contains(required),
"Missing required event: {}. Found events: {:?}",
required,
found_events
);
}
// Verify event ordering
let mut saw_start = false;
let mut saw_success = false;
let mut saw_checkpoint = false;
let mut saw_batch = false;
let mut saw_complete = false;
for event in events {
match event.event_type {
ProcessingEventType::ShardEvent {
event_type: ShardEventType::Started,
..
} => {
saw_start = true;
assert!(!saw_success, "Start should come before success");
}
ProcessingEventType::RecordSuccess { .. } => {
saw_success = true;
assert!(saw_start, "Success should come after start");
}
ProcessingEventType::Checkpoint { success: true, .. } => {
saw_checkpoint = true;
assert!(saw_success, "Checkpoint should come after success");
}
ProcessingEventType::BatchComplete { .. } => {
saw_batch = true;
assert!(
saw_checkpoint,
"Batch complete should come after checkpoint"
);
}
ProcessingEventType::ShardEvent {
event_type: ShardEventType::Completed,
..
} => {
saw_complete = true;
assert!(saw_batch, "Complete should come after batch");
}
_ => {}
}
}
// Verify we saw all events in correct order
assert!(
saw_start && saw_success && saw_checkpoint && saw_batch && saw_complete,
"Missing some events in the sequence"
);
tx.send(true)
.map_err(|e| anyhow::anyhow!("Failed to send shutdown signal: {}", e))?;
handle.await??;
Ok(())
}
#[tokio::test]
async fn test_metadata_basic() -> Result<()> {
let config = ProcessorConfig {
stream_name: "test-stream".to_string(),
..Default::default()
};
let client = MockKinesisClient::new();
let processor = MockRecordProcessor::new();
let store = InMemoryCheckpointStore::new();
// Setup single record processing
client
.mock_list_shards(Ok(vec![TestUtils::create_test_shard("shard-1")]))
.await;
client
.mock_get_iterator(Ok("test-iterator".to_string()))
.await;
let test_record = TestUtils::create_test_record("seq-1", b"test-data");
client.mock_get_records(Ok((vec![test_record], None))).await;
let (tx, rx) = tokio::sync::watch::channel(false);
let (processor_instance, _) =
KinesisProcessor::new(config, processor.clone(), client, store);
// Run processor briefly
let processor_handle = tokio::spawn(async move { processor_instance.run(rx).await });
tokio::time::sleep(Duration::from_millis(100)).await;
tx.send(true).map_err(|e| {
ProcessorError::Other(anyhow::anyhow!("Failed to send shutdown signal: {}", e))
})?;
processor_handle.await??;
// Verify processed record count
assert_eq!(processor.get_process_count().await, 1);
Ok(())
}
#[tokio::test]
async fn test_metadata_retry_counting() -> Result<()> {
init_logging();
info!("Starting metadata retry counting test");
// Configure for exactly 2 retries (attempts 0, 1, 2)
let config = ProcessorConfig {
stream_name: "test-stream".to_string(),
max_retries: Some(2), // Allows attempts 0, 1, and 2
monitoring: MonitoringConfig {
enabled: true,
channel_size: 100,
metrics_interval: Duration::from_millis(100),
include_retry_details: true,
rate_limit: None,
},
..Default::default()
};
let client = MockKinesisClient::new();
let processor = MockRecordProcessor::new();
let store = InMemoryCheckpointStore::new();
// Configure to fail on attempts 0 and 1, succeed on attempt 2
processor
.set_failure_sequence("test-seq-1".to_string(), "soft".to_string(), 2)
.await;
// Setup single test record
let test_record = TestUtils::create_test_record("test-seq-1", b"test data");
// Setup mock responses
client
.mock_list_shards(Ok(vec![TestUtils::create_test_shard("shard-1")]))
.await;
client
.mock_get_iterator(Ok("test-iterator".to_string()))
.await;
client.mock_get_records(Ok((vec![test_record], None))).await;
let (tx, rx) = tokio::sync::watch::channel(false);
let (processor_instance, mut monitoring_rx) =
KinesisProcessor::new(config, processor.clone(), client, store);
// Spawn processor task
let processor_handle = tokio::spawn(async move { processor_instance.run(rx).await });
// Collect events with timeout
let mut events = Vec::new();
let timeout = Duration::from_secs(2);
let start = Instant::now();
// Collect all events until we see completion or timeout
while let Ok(Some(event)) = tokio::time::timeout(
Duration::from_millis(100),
monitoring_rx.as_mut().unwrap().recv(),
)
.await
{
events.push(event);
// Check for completion (successful processing and checkpointing)
if events.iter().any(|e| {
matches!(
&e.event_type,
ProcessingEventType::Checkpoint {
sequence_number,
success: true,
..
} if sequence_number == "test-seq-1"
)
}) {
break;
}
if start.elapsed() > timeout {
tx.send(true)?; // Initiate shutdown
return Err(anyhow::anyhow!("Test timed out waiting for completion").into());
}
}
// Debug print collected events
debug!("Collected Events:");
for event in &events {
debug!("Event: {:?}", event);
}
// Track attempts and successes separately
let mut failed_attempts = Vec::new();
let mut success_seen = false;
let mut success_attempt = None;
for event in &events {
match &event.event_type {
ProcessingEventType::RecordAttempt {
sequence_number,
attempt_number,
success: false,
..
} if sequence_number == "test-seq-1" => {
failed_attempts.push(*attempt_number);
}
ProcessingEventType::RecordSuccess {
sequence_number, ..
} if sequence_number == "test-seq-1" => {
success_seen = true;
// Success should be attempt 2
success_attempt = Some(2);
}
_ => {}
}
}
// Verify failed attempts
assert_eq!(
failed_attempts,
vec![0, 1],
"Expected attempts 0 and 1 to fail. Got: {:?}",
failed_attempts
);
// Verify success
assert!(success_seen, "Should have seen success event");
assert_eq!(
success_attempt,
Some(2),
"Success should have occurred on attempt 2"
);
// Verify checkpoint was saved
let checkpoint_events: Vec<_> = events
.iter()
.filter(|e| {
matches!(
&e.event_type,
ProcessingEventType::Checkpoint {
sequence_number,
success: true,
..
} if sequence_number == "test-seq-1"
)
})
.collect();
assert_eq!(
checkpoint_events.len(),
1,
"Should have exactly one successful checkpoint"
);
// Verify event ordering
let mut saw_attempt_0 = false;
let mut saw_attempt_1 = false;
let mut saw_success = false;
let mut saw_checkpoint = false;
for event in &events {
match &event.event_type {
ProcessingEventType::RecordAttempt {
sequence_number,
attempt_number: 0,
..
} if sequence_number == "test-seq-1" => {
saw_attempt_0 = true;
assert!(
!saw_attempt_1 && !saw_success,
"Attempt 0 should come first"
);
}
ProcessingEventType::RecordAttempt {
sequence_number,
attempt_number: 1,
..
} if sequence_number == "test-seq-1" => {
saw_attempt_1 = true;
assert!(
saw_attempt_0 && !saw_success,
"Attempt 1 should come after attempt 0"
);
}
ProcessingEventType::RecordSuccess {
sequence_number, ..
} if sequence_number == "test-seq-1" => {
saw_success = true;
assert!(
saw_attempt_0 && saw_attempt_1,
"Success should come after attempts"
);
}
ProcessingEventType::Checkpoint {
sequence_number,
success: true,
..
} if sequence_number == "test-seq-1" => {
saw_checkpoint = true;
assert!(saw_success, "Checkpoint should come after success");
}
_ => {}
}
}
assert!(
saw_attempt_0 && saw_attempt_1 && saw_success && saw_checkpoint,
"Missing events in sequence"
);
// Clean shutdown
tx.send(true)?;
// Wait for processor with timeout
match tokio::time::timeout(Duration::from_secs(1), processor_handle).await {
Ok(result) => {
result??; // Propagate any processor errors
}
Err(_) => {
return Err(anyhow::anyhow!("Processor failed to shut down within timeout").into());
}
}
Ok(())
}
#[tokio::test]
async fn test_metadata_shard_id() -> Result<()> {
let config = ProcessorConfig {
stream_name: "test-stream".to_string(),
..Default::default()
};
let client = MockKinesisClient::new();
let processor = MockRecordProcessor::new();
let store = InMemoryCheckpointStore::new();
// Setup test with specific shard ID
let test_shard_id = "test-shard-123";
client
.mock_list_shards(Ok(vec![TestUtils::create_test_shard(test_shard_id)]))
.await;
client
.mock_get_iterator(Ok("test-iterator".to_string()))
.await;
let test_record = TestUtils::create_test_record("seq-1", b"test-data");
client.mock_get_records(Ok((vec![test_record], None))).await;
let (tx, rx) = tokio::sync::watch::channel(false);
let (processor_instance, _) =
KinesisProcessor::new(config, processor.clone(), client, store);
// Run processor
let processor_handle = tokio::spawn(async move { processor_instance.run(rx).await });
tokio::time::sleep(Duration::from_millis(100)).await;
tx.send(true).map_err(|e| {
ProcessorError::Other(anyhow::anyhow!("Failed to send shutdown signal: {}", e))
})?;
processor_handle.await??;
// Verify shard ID was correct
assert_eq!(processor.get_process_count().await, 1);
Ok(())
}
#[tokio::test]
async fn test_metadata_sequence_numbers() -> Result<()> {
let config = ProcessorConfig {
stream_name: "test-stream".to_string(),
..Default::default()
};
let client = MockKinesisClient::new();
let processor = MockRecordProcessor::new();
let store = InMemoryCheckpointStore::new();
// Setup multiple records with specific sequence numbers
client
.mock_list_shards(Ok(vec![TestUtils::create_test_shard("shard-1")]))
.await;
client
.mock_get_iterator(Ok("test-iterator".to_string()))
.await;
let records = vec![
TestUtils::create_test_record("seq-1", b"data1"),
TestUtils::create_test_record("seq-2", b"data2"),
];
client.mock_get_records(Ok((records, None))).await;
let (tx, rx) = tokio::sync::watch::channel(false);
let (processor_instance, _) =
KinesisProcessor::new(config, processor.clone(), client, store);
// Run processor
let processor_handle = tokio::spawn(async move { processor_instance.run(rx).await });
tokio::time::sleep(Duration::from_millis(100)).await;
tx.send(true).map_err(|e| {
ProcessorError::Other(anyhow::anyhow!("Failed to send shutdown signal: {}", e))
})?;
processor_handle.await??;
// Verify all records were processed
assert_eq!(processor.get_process_count().await, 2);
Ok(())
}
}