risingwave_connector/source/kinesis/
mod.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15pub mod enumerator;
16pub use enumerator::client::KinesisSplitEnumerator;
17pub mod source;
18pub mod split;
19
20use std::collections::HashMap;
21
22use serde::Deserialize;
23use serde_with::{DisplayFromStr, serde_as};
24pub use source::KinesisMeta;
25use with_options::WithOptions;
26
27use crate::connector_common::KinesisCommon;
28use crate::enforce_secret::EnforceSecret;
29use crate::error::ConnectorError;
30use crate::source::SourceProperties;
31use crate::source::kinesis::source::reader::KinesisSplitReader;
32use crate::source::kinesis::split::KinesisSplit;
33
34pub const KINESIS_CONNECTOR: &str = "kinesis";
35
36#[serde_as]
37#[derive(Clone, Debug, Deserialize, WithOptions)]
38pub struct KinesisProperties {
39    #[serde(rename = "scan.startup.mode", alias = "kinesis.scan.startup.mode")]
40    // accepted values: "latest", "earliest", "timestamp"
41    pub scan_startup_mode: Option<String>,
42
43    #[serde(rename = "scan.startup.timestamp.millis")]
44    #[serde_as(as = "Option<DisplayFromStr>")]
45    pub start_timestamp_millis: Option<i64>,
46
47    #[serde(flatten)]
48    pub common: KinesisCommon,
49
50    #[serde(flatten)]
51    pub reader_config: KinesisReaderConfig,
52
53    #[serde(flatten)]
54    pub unknown_fields: HashMap<String, String>,
55}
56
57const fn kinesis_reader_default_eof_retry_interval_ms() -> u64 {
58    1000
59}
60
61const fn kinesis_reader_default_error_retry_interval_ms() -> u64 {
62    200
63}
64
65#[serde_as]
66#[derive(Clone, Debug, Deserialize, WithOptions)]
67pub struct KinesisReaderConfig {
68    #[serde(
69        rename = "kinesis.reader.eof_retry_interval_ms",
70        default = "kinesis_reader_default_eof_retry_interval_ms"
71    )]
72    pub eof_retry_interval_ms: u64,
73
74    #[serde(
75        rename = "kinesis.reader.error_retry_interval_ms",
76        default = "kinesis_reader_default_error_retry_interval_ms"
77    )]
78    pub error_retry_interval_ms: u64,
79}
80
81impl Default for KinesisReaderConfig {
82    fn default() -> Self {
83        Self {
84            eof_retry_interval_ms: kinesis_reader_default_eof_retry_interval_ms(),
85            error_retry_interval_ms: kinesis_reader_default_error_retry_interval_ms(),
86        }
87    }
88}
89impl SourceProperties for KinesisProperties {
90    type Split = KinesisSplit;
91    type SplitEnumerator = KinesisSplitEnumerator;
92    type SplitReader = KinesisSplitReader;
93
94    const SOURCE_NAME: &'static str = KINESIS_CONNECTOR;
95}
96
97impl EnforceSecret for KinesisProperties {
98    fn enforce_secret<'a>(prop_iter: impl Iterator<Item = &'a str>) -> Result<(), ConnectorError> {
99        for prop in prop_iter {
100            KinesisCommon::enforce_one(prop)?;
101        }
102        Ok(())
103    }
104}
105
106impl crate::source::UnknownFields for KinesisProperties {
107    fn unknown_fields(&self) -> HashMap<String, String> {
108        self.unknown_fields.clone()
109    }
110}
111
112#[cfg(test)]
113mod test {
114    use maplit::{btreemap, hashmap};
115
116    use super::*;
117    use crate::WithOptionsSecResolved;
118    use crate::source::ConnectorProperties;
119
120    #[test]
121    fn test_parse_kinesis_timestamp_offset() {
122        let props: HashMap<String, String> = hashmap! {
123            "stream".to_owned() => "sample_stream".to_owned(),
124            "aws.region".to_owned() => "us-east-1".to_owned(),
125            "scan_startup_mode".to_owned() => "timestamp".to_owned(),
126            "scan.startup.timestamp.millis".to_owned() => "123456789".to_owned(),
127        };
128
129        let kinesis_props: KinesisProperties =
130            serde_json::from_value(serde_json::to_value(props).unwrap()).unwrap();
131        assert_eq!(kinesis_props.start_timestamp_millis, Some(123456789));
132    }
133
134    #[test]
135    fn test_kinesis_props() {
136        let with_options = btreemap! {
137            "connector".to_owned() => "kinesis".to_owned(),
138            "scan.startup.mode".to_owned() => "latest".to_owned(),
139            "stream".to_owned() => "sample_stream".to_owned(),
140            "aws.region".to_owned() => "us-east-1".to_owned(),
141            "endpoint".to_owned() => "https://kinesis.us-east-1.amazonaws.com".to_owned(),
142            "aws.credentials.access_key_id".to_owned() => "access_key".to_owned(),
143            "aws.credentials.secret_access_key".to_owned() => "secret_key".to_owned(),
144        };
145        let connector_props = ConnectorProperties::extract(
146            WithOptionsSecResolved::without_secrets(with_options),
147            true,
148        )
149        .unwrap();
150        let ConnectorProperties::Kinesis(kinesis_props) = connector_props else {
151            panic!()
152        };
153
154        assert_eq!(kinesis_props.common.sdk_connect_timeout_ms, 10000);
155
156        let with_options = btreemap! {
157            "connector".to_owned() => "kinesis".to_owned(),
158            "scan.startup.mode".to_owned() => "latest".to_owned(),
159            "stream".to_owned() => "sample_stream".to_owned(),
160            "aws.region".to_owned() => "us-east-1".to_owned(),
161            "endpoint".to_owned() => "https://kinesis.us-east-1.amazonaws.com".to_owned(),
162            "aws.credentials.access_key_id".to_owned() => "access_key".to_owned(),
163            "aws.credentials.secret_access_key".to_owned() => "secret_key".to_owned(),
164            "kinesis.sdk.connect_timeout_ms".to_owned() => "20000".to_owned(),
165        };
166        let connector_props = ConnectorProperties::extract(
167            WithOptionsSecResolved::without_secrets(with_options),
168            true,
169        )
170        .unwrap();
171        let ConnectorProperties::Kinesis(kinesis_props) = connector_props else {
172            panic!()
173        };
174
175        assert_eq!(kinesis_props.common.sdk_connect_timeout_ms, 20000);
176    }
177}
risingwave_connector/source/kinesis/mod.rs

risingwave_connector/source/kinesis/
mod.rs
