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
use super::{
channel::{self, ConsumerChannel, ProducerChannel},
types::{GetShardsOutput, Lineages, Shard},
DynamodbClient, Error,
};
use aws_sdk_dynamodbstreams::types::{Record, ShardIteratorType};
use std::{
cmp,
pin::Pin,
sync::Arc,
task::{Context, Poll},
};
use tokio::{
sync::mpsc,
time::{sleep, Duration},
};
use tokio_stream::Stream;
use tracing::error;
/// The polling half of DynamoDB Streams.
#[derive(Debug)]
pub struct DynamodbStreamProducer<Client>
where
Client: DynamodbClient + 'static,
{
table_name: String,
stream_arn: String,
shards: Option<Vec<Shard>>,
channel: ProducerChannel,
client: Client,
shard_iterator_type: ShardIteratorType,
interval: Option<Duration>,
sender: mpsc::Sender<Vec<Record>>,
}
impl<Client> DynamodbStreamProducer<Client>
where
Client: DynamodbClient + 'static,
{
fn client(&self) -> Arc<Client> {
Arc::new(self.client.clone())
}
/// Get shards and shard iterator ids for first attempt to get records.
async fn init(&mut self) -> Result<(), Error> {
let stream_arn = self.client.get_stream_arn(&self.table_name).await?;
self.stream_arn = stream_arn;
let shards = self.get_all_shards().await?;
let shards = self
.get_shard_iterators(shards, self.shard_iterator_type.clone())
.await;
self.shards = Some(shards);
self.channel.send_init();
Ok(())
}
/// Get records and renew shards for next iteration.
async fn iterate(&mut self) -> Result<Vec<Record>, Error> {
let lineages: Lineages = self.shards.take().unwrap_or_default().into();
let (mut shards, records) = lineages.get_records(self.client()).await;
let new_shards = self
.get_all_shards()
.await?
.into_iter()
.filter(|shard| !shards.iter().any(|s| s.id() == shard.id()))
.collect::<Vec<Shard>>();
let mut new_shards = self
.get_shard_iterators(new_shards, ShardIteratorType::Latest)
.await;
shards.append(&mut new_shards);
self.shards = Some(shards);
Ok(records)
}
/// Poll the DynamoDB Streams.
async fn streaming(&mut self) {
ok_or_return!(self.init().await, |err| {
error!(
"Unexpected error during initialization: {err}. Skip polling {} table.",
self.table_name,
);
});
loop {
let records = ok_or_return!(self.iterate().await, |err| {
error!(
"Unexpected error during iteration: {err}. Stop polling {} table.",
self.table_name,
);
});
if self.channel.should_close() {
return;
}
if !records.is_empty() && self.sender.send(records).await.is_err() {
return;
}
if let Some(duration) = self.interval {
sleep(duration).await;
}
}
}
/// Get all shards from the DynamoDB table.
async fn get_all_shards(&self) -> Result<Vec<Shard>, Error> {
let GetShardsOutput {
mut shards,
mut last_shard_id,
} = self.client.get_shards(&self.stream_arn, None).await?;
while last_shard_id.is_some() {
let mut output = self
.client
.get_shards(&self.stream_arn, last_shard_id.take())
.await?;
shards.append(&mut output.shards);
last_shard_id = output.last_shard_id;
}
Ok(shards)
}
/// Get and set shard iterator.
async fn get_shard_iterators(
&self,
shards: Vec<Shard>,
shard_iterator_type: ShardIteratorType,
) -> Vec<Shard> {
let (tx, mut rx) = mpsc::channel::<Shard>(cmp::max(1, shards.len()));
let mut output: Vec<Shard> = vec![];
let client = self.client();
for shard in shards {
let tx = tx.clone();
let client = Arc::clone(&client);
let stream_arn = self.stream_arn.clone();
let shard_iterator_type = shard_iterator_type.clone();
tokio::spawn(async move {
let shard = match client
.get_shard_with_iterator(stream_arn, shard, shard_iterator_type)
.await
{
Ok(shard) => shard,
Err(err) => {
error!("Unexpected error during getting shard iterator: {err}");
return;
}
};
if let Err(err) = tx.send(shard).await {
error!("Unexpected error during sending shard: {err}");
}
});
}
drop(tx);
while let Some(shard) = rx.recv().await {
output.push(shard);
}
output
}
}
/// Represent DynamoDB Stream.
///
/// This struct receives DynamoDB Stream records from polling half and emit them as Rust Stream.
#[derive(Debug)]
pub struct DynamodbStream {
receiver: mpsc::Receiver<Vec<Record>>,
channel: Option<ConsumerChannel>,
}
impl DynamodbStream {
/// Get [`ConsumerChannel`] as communication channel to the stream.
///
/// Once you take a channel from this method, you can't take it anymore from the same channel
/// because this method also passes the ownership of the channel.
///
/// ```rust,no_run
/// use aws_config::BehaviorVersion;
/// use dynamo_subscriber as subscriber;
///
/// # async fn wrapper() {
/// # let config = aws_config::load_defaults(BehaviorVersion::latest()).await;
/// # let client = subscriber::Client::new(&config);
/// let mut stream = subscriber::stream::builder()
/// .client(client)
/// .table_name("People")
/// .build();
/// let channel = stream.take_channel();
/// assert!(channel.is_some());
///
/// let channel = stream.take_channel();
/// assert!(channel.is_none());
/// # }
/// ```
pub fn take_channel(&mut self) -> Option<ConsumerChannel> {
self.channel.take()
}
}
impl Stream for DynamodbStream {
type Item = Vec<Record>;
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
self.receiver.poll_recv(cx)
}
}
impl Drop for DynamodbStream {
fn drop(&mut self) {
self.receiver.close();
if let Some(mut channel) = self.take_channel() {
channel.close(|| {});
}
}
}
impl AsRef<mpsc::Receiver<Vec<Record>>> for DynamodbStream {
fn as_ref(&self) -> &mpsc::Receiver<Vec<Record>> {
&self.receiver
}
}
impl AsMut<mpsc::Receiver<Vec<Record>>> for DynamodbStream {
fn as_mut(&mut self) -> &mut mpsc::Receiver<Vec<Record>> {
&mut self.receiver
}
}
/// A builder for [`DynamodbStream`].
#[derive(Debug)]
pub struct DynamodbStreamBuilder<Client>
where
Client: DynamodbClient + 'static,
{
table_name: Option<String>,
client: Option<Client>,
shard_iterator_type: ShardIteratorType,
interval: Option<Duration>,
buffer: usize,
}
impl<Client> DynamodbStreamBuilder<Client>
where
Client: DynamodbClient + 'static,
{
/// Create a new `DynamodbStreamBuilder`.
pub fn new() -> Self {
Self {
table_name: None,
client: None,
shard_iterator_type: ShardIteratorType::Latest,
interval: Some(Duration::from_secs(3)),
buffer: 100,
}
}
/// Set table name you want to retrieve records from.
///
/// **Setting any table name is required** before the build method is called.
pub fn table_name(self, table_name: impl Into<String>) -> Self {
Self {
table_name: Some(table_name.into()),
..self
}
}
/// Set client to call AWS APIs.
///
/// **Setting any client is required** before the build method is called.
pub fn client(self, client: Client) -> Self {
Self {
client: Some(client),
..self
}
}
/// Set [`ShardIteratorType`] to get records for the first time.
/// After the first time, the DynamodbStream uses the shard iterator from the previous
/// `get records` operation outputs.
///
/// Setting any shard iterator type is optional. If you omit calling this method,
/// `ShardIteratorType::Latest` is used as default value.
pub fn shard_iterator_type(self, shard_iterator_type: ShardIteratorType) -> Self {
Self {
shard_iterator_type,
..self
}
}
/// Set interval between polling attempts. When None is provided there are no intervals between
/// polling iterations.
///
/// Setting any interval is optional. If you omit calling this method,
/// `3 seconds` is used as default value.
pub fn interval(self, interval: Option<Duration>) -> Self {
Self { interval, ..self }
}
/// Set the buffer for [`tokio::sync::mpsc::channel`](tokio::sync::mpsc::channel).
///
/// The stream records are stored up to the buffer size unless the records are consumed.
/// Once the buffer is full, attempts to receive records from the DynamoDB Streams will
/// wait until the records is consumed.
///
/// This method will panic when given zero as buffer size.
///
/// Setting buffer size is optional. If you omit calling this method,
/// `100` is used as default value.
pub fn buffer(self, buffer: usize) -> Self {
if buffer == 0 {
panic!("buffer must be positive.");
}
Self { buffer, ..self }
}
/// Consumes the builder and constructs a [`DynamodbStream`].
///
/// This method will panic if no table name is set or no client is set.
pub fn build(self) -> DynamodbStream {
let (c_half, rx) = self.build_producer();
DynamodbStream {
receiver: rx,
channel: Some(c_half),
}
}
fn build_producer(self) -> (ConsumerChannel, mpsc::Receiver<Vec<Record>>) {
let table_name = self.table_name.expect("`table_name` is required");
let client = self.client.expect("`client` is required");
let (p_half, c_half) = channel::new();
let (tx_mpsc, rx_mpsc) = mpsc::channel::<Vec<Record>>(self.buffer);
let mut producer = DynamodbStreamProducer {
table_name,
stream_arn: "".to_string(),
shards: None,
channel: p_half,
client,
shard_iterator_type: self.shard_iterator_type,
interval: self.interval,
sender: tx_mpsc,
};
tokio::spawn(async move {
producer.streaming().await;
});
(c_half, rx_mpsc)
}
}
impl<Client> Default for DynamodbStreamBuilder<Client>
where
Client: DynamodbClient + 'static,
{
fn default() -> Self {
Self::new()
}
}