Skip to main content

risingwave_stream/executor/backfill/snapshot_backfill/
executor.rs

1// Copyright 2024 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
15use std::cmp::min;
16use std::collections::VecDeque;
17use std::future::{Future, pending, ready};
18use std::mem::take;
19use std::sync::Arc;
20use std::time::Duration;
21
22use anyhow::anyhow;
23use futures::future::{Either, try_join_all};
24use futures::{FutureExt, Stream, TryFutureExt, TryStreamExt, pin_mut};
25use risingwave_common::array::StreamChunk;
26use risingwave_common::hash::VnodeBitmapExt;
27use risingwave_common::metrics::LabelGuardedIntCounter;
28use risingwave_common::row::OwnedRow;
29use risingwave_common::util::epoch::{Epoch, EpochPair};
30use risingwave_common_rate_limit::{MonitoredRateLimiter, RateLimit, RateLimiter};
31use risingwave_hummock_sdk::HummockReadEpoch;
32use risingwave_pb::batch_plan::ScanRange;
33use risingwave_pb::common::PbThrottleType;
34use risingwave_storage::StateStore;
35use risingwave_storage::store::PrefetchOptions;
36use risingwave_storage::table::ChangeLogRow;
37use risingwave_storage::table::batch_table::{BatchTable, PkScanRange};
38use tokio::select;
39use tokio::sync::mpsc::UnboundedReceiver;
40use tokio::time::sleep;
41
42use crate::executor::backfill::snapshot_backfill::receive_next_barrier;
43use crate::executor::backfill::snapshot_backfill::state::{
44    BackfillState, EpochBackfillProgress, VnodeBackfillProgress,
45};
46use crate::executor::backfill::snapshot_backfill::vnode_stream::VnodeStream;
47use crate::executor::backfill::utils::{
48    UpstreamStreamKeyUpdateNormalizer, create_builder, mapping_message,
49};
50use crate::executor::monitor::StreamingMetrics;
51use crate::executor::prelude::{StateTable, StreamExt, try_stream};
52use crate::executor::{
53    ActorContextRef, Barrier, BoxedMessageStream, DispatcherBarrier, DispatcherMessage, Execute,
54    MergeExecutorInput, Message, Mutation, StreamExecutorError, StreamExecutorResult,
55    expect_first_barrier,
56};
57use crate::task::CreateMviewProgressReporter;
58
59pub struct SnapshotBackfillExecutor<S: StateStore> {
60    /// Upstream table
61    upstream_table: BatchTable<S>,
62
63    /// Backfill progress table
64    progress_state_table: StateTable<S>,
65
66    /// Upstream with the same schema with the upstream table.
67    upstream: Option<MergeExecutorInput>,
68
69    /// The column indices need to be forwarded to the downstream from the upstream and table scan.
70    output_indices: Vec<usize>,
71
72    /// Current executor stream-key indices in the output schema.
73    stream_key: Vec<usize>,
74
75    progress: CreateMviewProgressReporter,
76
77    chunk_size: usize,
78    rate_limiter: MonitoredRateLimiter,
79
80    barrier_rx: UnboundedReceiver<Barrier>,
81
82    actor_ctx: ActorContextRef,
83    metrics: Arc<StreamingMetrics>,
84
85    snapshot_epoch: Option<u64>,
86    /// (`eq_prefix`, `range_bounds`) for pk scan range pushdown.
87    pk_scan_range: PkScanRange,
88}
89
90impl<S: StateStore> SnapshotBackfillExecutor<S> {
91    fn build_pk_scan_range(
92        pb_scan_range: Option<&ScanRange>,
93        upstream_table: &BatchTable<S>,
94    ) -> StreamExecutorResult<PkScanRange> {
95        match pb_scan_range {
96            Some(scan_range) => Ok(PkScanRange::new(
97                scan_range.clone(),
98                upstream_table.pk_serializer().get_data_types().to_vec(),
99            )?),
100            None => Ok(PkScanRange::full()),
101        }
102    }
103
104    #[expect(clippy::too_many_arguments)]
105    pub(crate) fn new(
106        upstream_table: BatchTable<S>,
107        progress_state_table: StateTable<S>,
108        upstream: Option<MergeExecutorInput>,
109        pb_pk_scan_range: Option<&ScanRange>,
110        output_indices: Vec<usize>,
111        stream_key: Vec<usize>,
112        actor_ctx: ActorContextRef,
113        progress: CreateMviewProgressReporter,
114        chunk_size: usize,
115        rate_limit: RateLimit,
116        barrier_rx: UnboundedReceiver<Barrier>,
117        metrics: Arc<StreamingMetrics>,
118        snapshot_epoch: Option<u64>,
119    ) -> StreamExecutorResult<Self> {
120        if let Some(upstream) = &upstream {
121            assert_eq!(&upstream.info.schema, upstream_table.schema());
122        }
123        if upstream_table.pk_in_output_indices().is_none() {
124            panic!(
125                "storage table should include all pk columns in output: pk_indices: {:?}, output_indices: {:?}, schema: {:?}",
126                upstream_table.pk_indices(),
127                upstream_table.output_indices(),
128                upstream_table.schema()
129            )
130        };
131        assert!(
132            stream_key.iter().all(|idx| *idx < output_indices.len()),
133            "stream key indices should refer to output schema: stream_key: {:?}, output_indices: {:?}",
134            stream_key,
135            output_indices
136        );
137        let pk_scan_range = Self::build_pk_scan_range(pb_pk_scan_range, &upstream_table)?;
138        if !matches!(rate_limit, RateLimit::Disabled) {
139            trace!(
140                ?rate_limit,
141                "create snapshot backfill executor with rate limit"
142            );
143        }
144        let rate_limiter = RateLimiter::new(rate_limit).monitored(upstream_table.table_id());
145        Ok(Self {
146            upstream_table,
147            progress_state_table,
148            upstream,
149            output_indices,
150            stream_key,
151            progress,
152            chunk_size,
153            rate_limiter,
154            barrier_rx,
155            actor_ctx,
156            metrics,
157            snapshot_epoch,
158            pk_scan_range,
159        })
160    }
161
162    #[try_stream(ok = Message, error = StreamExecutorError)]
163    async fn execute_inner(mut self) {
164        trace!("snapshot backfill executor start");
165        let upstream = if let Some(mut upstream) = self.upstream {
166            let first_upstream_barrier = expect_first_barrier(&mut upstream).await?;
167            trace!(epoch = ?first_upstream_barrier.epoch, "get first upstream barrier");
168            Some((first_upstream_barrier, upstream))
169        } else {
170            None
171        };
172        let first_recv_barrier = receive_next_barrier(&mut self.barrier_rx).await?;
173        trace!(epoch = ?first_recv_barrier.epoch, "get first inject barrier");
174        let should_snapshot_backfill: Option<u64> = if let Some(snapshot_epoch) =
175            self.snapshot_epoch
176        {
177            if let Some((first_upstream_barrier, _)) = &upstream {
178                if first_upstream_barrier.epoch != first_recv_barrier.epoch {
179                    assert!(snapshot_epoch <= first_upstream_barrier.epoch.prev);
180                    Some(snapshot_epoch)
181                } else {
182                    None
183                }
184            } else {
185                // must go through snapshot backfill when having no upstream
186                Some(snapshot_epoch)
187            }
188        } else {
189            // when snapshot epoch is not set, the StreamNode must be created previously and has finished the backfill
190            if cfg!(debug_assertions) {
191                panic!(
192                    "snapshot epoch not set. first_upstream_epoch: {:?}, first_recv_epoch: {:?}",
193                    upstream.map(|(first_upstream_barrier, _)| first_upstream_barrier.epoch),
194                    first_recv_barrier.epoch
195                );
196            } else {
197                let (first_upstream_barrier, _) = upstream
198                    .as_ref()
199                    .ok_or_else(|| anyhow!("no upstream while snapshot epoch not set"))?;
200                warn!(first_upstream_epoch = ?first_upstream_barrier.epoch, first_recv_epoch=?first_recv_barrier.epoch, "snapshot epoch not set");
201                assert_eq!(first_upstream_barrier.epoch, first_recv_barrier.epoch);
202                None
203            }
204        };
205        let first_recv_barrier_epoch = first_recv_barrier.epoch;
206        let initial_backfill_paused =
207            first_recv_barrier.is_backfill_pause_on_startup(self.actor_ctx.fragment_id);
208        yield Message::Barrier(first_recv_barrier);
209        let mut backfill_state = BackfillState::new(
210            self.progress_state_table,
211            first_recv_barrier_epoch,
212            self.upstream_table.pk_serializer().clone(),
213        )
214        .await?;
215
216        let (mut barrier_epoch, mut need_report_finish, upstream) = {
217            if let Some(snapshot_epoch) = should_snapshot_backfill {
218                let table_id_str = format!("{}", self.upstream_table.table_id());
219                let actor_id_str = format!("{}", self.actor_ctx.id);
220
221                let consume_upstream_row_count = self
222                    .metrics
223                    .snapshot_backfill_consume_row_count
224                    .with_guarded_label_values(&[
225                        table_id_str.as_str(),
226                        actor_id_str.as_str(),
227                        "consume_upstream",
228                    ]);
229
230                let mut upstream_buffer = if let Some((first_upstream_barrier, upstream)) = upstream
231                {
232                    SnapshotBackfillUpstream::Buffer(UpstreamBuffer::new(
233                        upstream,
234                        first_upstream_barrier,
235                        consume_upstream_row_count,
236                    ))
237                } else {
238                    SnapshotBackfillUpstream::Empty
239                };
240
241                // Phase 1: consume upstream snapshot
242                let (mut barrier_epoch, upstream_buffer) = if first_recv_barrier_epoch.prev
243                    < snapshot_epoch
244                {
245                    trace!(
246                        table_id = %self.upstream_table.table_id(),
247                        snapshot_epoch,
248                        barrier_epoch = ?first_recv_barrier_epoch,
249                        "start consuming snapshot"
250                    );
251                    {
252                        let consuming_snapshot_row_count = self
253                            .metrics
254                            .snapshot_backfill_consume_row_count
255                            .with_guarded_label_values(&[
256                                table_id_str.as_str(),
257                                actor_id_str.as_str(),
258                                "consuming_snapshot",
259                            ]);
260                        let snapshot_stream = make_consume_snapshot_stream(
261                            &self.upstream_table,
262                            snapshot_epoch,
263                            self.chunk_size,
264                            &self.rate_limiter,
265                            &mut self.barrier_rx,
266                            &mut self.progress,
267                            &mut backfill_state,
268                            first_recv_barrier_epoch,
269                            initial_backfill_paused,
270                            &self.actor_ctx,
271                            &self.pk_scan_range,
272                        );
273
274                        pin_mut!(snapshot_stream);
275
276                        while let Some(message) = upstream_buffer
277                            .run_future(snapshot_stream.try_next())
278                            .await?
279                        {
280                            if let Message::Chunk(chunk) = &message {
281                                consuming_snapshot_row_count.inc_by(chunk.cardinality() as _);
282                            }
283                            yield message;
284                        }
285                    }
286
287                    let recv_barrier = self.barrier_rx.recv().await.expect("should exist");
288                    let recv_barrier_epoch = recv_barrier.epoch;
289                    assert_eq!(snapshot_epoch, recv_barrier_epoch.prev);
290                    let post_commit = backfill_state.commit(recv_barrier.epoch).await?;
291                    yield Message::Barrier(recv_barrier);
292                    post_commit.post_yield_barrier(None).await?;
293                    (
294                        recv_barrier_epoch,
295                        upstream_buffer.start_consuming_log_store(snapshot_epoch),
296                    )
297                } else {
298                    trace!(
299                        table_id = %self.upstream_table.table_id(),
300                        snapshot_epoch,
301                        barrier_epoch = ?first_recv_barrier_epoch,
302                        "skip consuming snapshot"
303                    );
304                    (
305                        first_recv_barrier_epoch,
306                        upstream_buffer.start_consuming_log_store(first_recv_barrier_epoch.prev),
307                    )
308                };
309
310                // Phase 2: consume upstream log store
311                match upstream_buffer {
312                    Either::Left(mut upstream_buffer) => {
313                        let initial_pending_lag =
314                            if let SnapshotBackfillUpstream::Buffer(upstream_buffer) =
315                                &upstream_buffer
316                            {
317                                Some(Duration::from_millis(
318                                    Epoch(upstream_buffer.pending_epoch_lag()).physical_time(),
319                                ))
320                            } else {
321                                None
322                            };
323                        trace!(
324                            ?barrier_epoch,
325                            table_id = %self.upstream_table.table_id(),
326                            ?initial_pending_lag,
327                            "start consuming log store"
328                        );
329
330                        let consuming_log_store_row_count = self
331                            .metrics
332                            .snapshot_backfill_consume_row_count
333                            .with_guarded_label_values(&[
334                                table_id_str.as_str(),
335                                actor_id_str.as_str(),
336                                "consuming_log_store",
337                            ]);
338                        let mut pending_non_checkpoint_barrier: Vec<EpochPair> = vec![];
339                        loop {
340                            let barrier = receive_next_barrier(&mut self.barrier_rx).await?;
341                            assert_eq!(barrier_epoch.curr, barrier.epoch.prev);
342                            let is_finished = upstream_buffer.consumed_epoch(barrier.epoch).await?;
343                            // Disable calling next_epoch, because, if barrier_epoch.prev is a checkpoint epoch,
344                            // next_epoch(barrier_epoch.prev) is actually waiting for the committed epoch.
345                            // However, upstream_buffer's is_polling_epoch_data can be false, since just received
346                            // the checkpoint barrier_epoch.prev. And then the upstream_buffer may stop polling upstream
347                            // when the max_pending_epoch_lag is small. When upstream is not polled, the barrier of the next
348                            // committed epoch cannot be collected.
349                            // {
350                            //     // we must call `next_epoch` after `consumed_epoch`, and otherwise in `next_epoch`
351                            //     // we may block the upstream, and the upstream never get a chance to finish the `next_epoch`
352                            //     let next_prev_epoch = upstream_buffer
353                            //         .run_future(self.upstream_table.next_epoch(barrier_epoch.prev))
354                            //         .await?;
355                            //     assert_eq!(next_prev_epoch, barrier.epoch.prev);
356                            // }
357                            barrier_epoch = barrier.epoch;
358                            if barrier.kind.is_checkpoint() {
359                                let pending_non_checkpoint_barrier =
360                                    take(&mut pending_non_checkpoint_barrier);
361                                let end_epoch = barrier_epoch.prev;
362                                let start_epoch = pending_non_checkpoint_barrier
363                                    .first()
364                                    .map(|epoch| epoch.prev)
365                                    .unwrap_or(end_epoch);
366                                trace!(?barrier_epoch, kind = ?barrier.kind, ?pending_non_checkpoint_barrier, "start consume epoch change log");
367                                // use `upstream_buffer.run_future` to poll upstream concurrently so that we won't have back-pressure
368                                // on the upstream. Otherwise, in `batch_iter_log_with_pk_bounds`, we may wait upstream epoch to be committed,
369                                // and the back-pressure may cause the upstream unable to consume the barrier and then cause deadlock.
370                                let mut stream = upstream_buffer
371                                    .run_future(make_log_stream(
372                                        &self.upstream_table,
373                                        start_epoch,
374                                        end_epoch,
375                                        None,
376                                        self.chunk_size,
377                                    ))
378                                    .await?;
379                                while let Some(chunk) =
380                                    upstream_buffer.run_future(stream.try_next()).await?
381                                {
382                                    trace!(
383                                        ?barrier_epoch,
384                                        size = chunk.cardinality(),
385                                        "consume change log yield chunk",
386                                    );
387                                    consuming_log_store_row_count.inc_by(chunk.cardinality() as _);
388                                    yield Message::Chunk(chunk);
389                                }
390
391                                trace!(?barrier_epoch, "after consume change log");
392
393                                stream
394                                    .for_vnode_pk_progress(|vnode, row_count, progress| {
395                                        assert_eq!(progress, None);
396                                        backfill_state.finish_epoch(
397                                            vnode,
398                                            barrier.epoch.prev,
399                                            row_count,
400                                        );
401                                    })
402                                    .await?;
403                            } else {
404                                pending_non_checkpoint_barrier.push(barrier.epoch);
405                            }
406
407                            if let SnapshotBackfillUpstream::Buffer(upstream_buffer) =
408                                &upstream_buffer
409                            {
410                                if is_finished {
411                                    assert_eq!(upstream_buffer.pending_epoch_lag(), 0);
412                                    assert!(pending_non_checkpoint_barrier.is_empty());
413                                    self.progress.finish_consuming_log_store(barrier.epoch);
414                                } else {
415                                    self.progress.update_create_mview_log_store_progress(
416                                        barrier.epoch,
417                                        upstream_buffer.pending_epoch_lag(),
418                                    );
419                                }
420                            }
421
422                            let post_commit = backfill_state.commit(barrier.epoch).await?;
423                            let update_vnode_bitmap =
424                                barrier.as_update_vnode_bitmap(self.actor_ctx.id);
425                            yield Message::Barrier(barrier);
426                            post_commit.post_yield_barrier(None).await?;
427                            if update_vnode_bitmap.is_some() {
428                                return Err(anyhow!(
429                                    "should not update vnode bitmap during consuming log store"
430                                )
431                                .into());
432                            }
433
434                            if is_finished {
435                                assert!(
436                                    pending_non_checkpoint_barrier.is_empty(),
437                                    "{pending_non_checkpoint_barrier:?}"
438                                );
439                                break;
440                            }
441                        }
442                        trace!(
443                            ?barrier_epoch,
444                            table_id = %self.upstream_table.table_id(),
445                            "finish consuming log store"
446                        );
447
448                        (
449                            barrier_epoch,
450                            false,
451                            upstream_buffer.start_consuming_upstream(),
452                        )
453                    }
454                    Either::Right(upstream) => {
455                        trace!(
456                            ?barrier_epoch,
457                            table_id = %self.upstream_table.table_id(),
458                            "skip consuming log store and start consuming upstream directly"
459                        );
460
461                        (barrier_epoch, true, upstream)
462                    }
463                }
464            } else {
465                let (first_upstream_barrier, _) = upstream
466                    .as_ref()
467                    .expect("should have upstream when skipping snapshot backfill");
468                backfill_state
469                    .latest_progress()
470                    .for_each(|(vnode, progress)| {
471                        let progress = progress.expect("should not be empty");
472                        assert_eq!(
473                            progress.epoch, first_upstream_barrier.epoch.prev,
474                            "vnode: {:?}",
475                            vnode
476                        );
477                        assert_eq!(
478                            progress.progress,
479                            EpochBackfillProgress::Consumed,
480                            "vnode: {:?}",
481                            vnode
482                        );
483                    });
484                trace!(
485                    table_id = %self.upstream_table.table_id(),
486                    "skip backfill"
487                );
488                let (first_upstream_barrier, upstream) =
489                    upstream.expect("should have upstream when skipping snapshot backfill");
490                assert_eq!(first_upstream_barrier.epoch, first_recv_barrier_epoch);
491                (first_upstream_barrier.epoch, true, upstream)
492            }
493        };
494        let current_stream_key_indices = self
495            .stream_key
496            .iter()
497            .map(|idx| self.output_indices[*idx])
498            .collect();
499        let update_normalizer = UpstreamStreamKeyUpdateNormalizer::new(
500            &upstream.info.stream_key,
501            current_stream_key_indices,
502        );
503        let mut upstream = upstream.into_executor(self.barrier_rx).execute();
504        let mut epoch_row_count = 0;
505        // Phase 3: consume upstream
506        while let Some(msg) = upstream.try_next().await? {
507            let Some(msg) = update_normalizer.normalize_message(msg) else {
508                continue;
509            };
510            match msg {
511                Message::Barrier(barrier) => {
512                    assert_eq!(barrier.epoch.prev, barrier_epoch.curr);
513                    self.upstream_table
514                        .vnodes()
515                        .iter_vnodes()
516                        .for_each(|vnode| {
517                            // Note: the `epoch_row_count` is the accumulated row count of all vnodes of the current
518                            // executor.
519                            backfill_state.finish_epoch(vnode, barrier.epoch.prev, epoch_row_count);
520                        });
521                    epoch_row_count = 0;
522                    let update_vnode_bitmap = barrier.as_update_vnode_bitmap(self.actor_ctx.id);
523                    barrier_epoch = barrier.epoch;
524                    if need_report_finish {
525                        need_report_finish = false;
526                        self.progress.finish_consuming_log_store(barrier_epoch);
527                    }
528                    let post_commit = backfill_state.commit(barrier.epoch).await?;
529                    yield Message::Barrier(barrier);
530                    if let Some(new_vnode_bitmap) =
531                        post_commit.post_yield_barrier(update_vnode_bitmap).await?
532                    {
533                        let _prev_vnode_bitmap =
534                            self.upstream_table.update_vnode_bitmap(new_vnode_bitmap);
535                        backfill_state
536                            .latest_progress()
537                            .for_each(|(vnode, progress)| {
538                                let progress = progress.expect("should not be empty");
539                                assert_eq!(
540                                    progress.epoch, barrier_epoch.prev,
541                                    "vnode {:?} has unexpected progress epoch",
542                                    vnode
543                                );
544                                assert_eq!(
545                                    progress.progress,
546                                    EpochBackfillProgress::Consumed,
547                                    "vnode {:?} has unexpected progress",
548                                    vnode
549                                );
550                            });
551                    }
552                }
553                msg => {
554                    if let Message::Chunk(chunk) = &msg {
555                        epoch_row_count += chunk.cardinality();
556                    }
557                    yield msg;
558                }
559            }
560        }
561    }
562}
563
564impl<S: StateStore> Execute for SnapshotBackfillExecutor<S> {
565    fn execute(self: Box<Self>) -> BoxedMessageStream {
566        let output_indices = self.output_indices.clone();
567        self.execute_inner()
568            .filter_map(move |result| {
569                ready({
570                    match result {
571                        Ok(message) => mapping_message(message, &output_indices).map(Ok),
572                        Err(e) => Some(Err(e)),
573                    }
574                })
575            })
576            .boxed()
577    }
578}
579
580struct ConsumingSnapshot;
581struct ConsumingLogStore;
582
583#[derive(Debug)]
584struct PendingBarriers {
585    first_upstream_barrier_epoch: EpochPair,
586
587    /// Pending non-checkpoint barriers before receiving the next checkpoint barrier
588    /// Newer barrier at the front
589    pending_non_checkpoint_barriers: VecDeque<DispatcherBarrier>,
590
591    /// In the outer `VecDeque`, newer barriers at the front.
592    /// In the inner `VecDeque`, newer barrier at the front, with the first barrier as checkpoint barrier,
593    /// and others as non-checkpoint barrier
594    checkpoint_barrier_groups: VecDeque<VecDeque<DispatcherBarrier>>,
595}
596
597impl PendingBarriers {
598    fn new(first_upstream_barrier: DispatcherBarrier) -> Self {
599        Self {
600            first_upstream_barrier_epoch: first_upstream_barrier.epoch,
601            pending_non_checkpoint_barriers: Default::default(),
602            checkpoint_barrier_groups: VecDeque::from_iter([VecDeque::from_iter([
603                first_upstream_barrier,
604            ])]),
605        }
606    }
607
608    fn add(&mut self, barrier: DispatcherBarrier) {
609        let is_checkpoint = barrier.kind.is_checkpoint();
610        self.pending_non_checkpoint_barriers.push_front(barrier);
611        if is_checkpoint {
612            self.checkpoint_barrier_groups
613                .push_front(take(&mut self.pending_non_checkpoint_barriers));
614        }
615    }
616
617    fn pop(&mut self) -> Option<VecDeque<DispatcherBarrier>> {
618        self.checkpoint_barrier_groups.pop_back()
619    }
620
621    fn consume_epoch(&mut self, epoch: EpochPair) {
622        let barriers = self
623            .checkpoint_barrier_groups
624            .back_mut()
625            .expect("non-empty");
626        let oldest_upstream_barrier = barriers.back().expect("non-empty");
627        assert!(
628            oldest_upstream_barrier.epoch.prev >= epoch.prev,
629            "oldest upstream barrier has epoch {:?} earlier than epoch to consume {:?}",
630            oldest_upstream_barrier.epoch,
631            epoch
632        );
633        if oldest_upstream_barrier.epoch.prev == epoch.prev {
634            assert_eq!(oldest_upstream_barrier.epoch, epoch);
635            barriers.pop_back();
636            if barriers.is_empty() {
637                self.checkpoint_barrier_groups.pop_back();
638            }
639        }
640    }
641
642    fn latest_epoch(&self) -> Option<EpochPair> {
643        self.pending_non_checkpoint_barriers
644            .front()
645            .or_else(|| {
646                self.checkpoint_barrier_groups
647                    .front()
648                    .and_then(|barriers| barriers.front())
649            })
650            .map(|barrier| barrier.epoch)
651    }
652
653    fn checkpoint_epoch_count(&self) -> usize {
654        self.checkpoint_barrier_groups.len()
655    }
656
657    fn has_checkpoint_epoch(&self) -> bool {
658        !self.checkpoint_barrier_groups.is_empty()
659    }
660}
661
662enum SnapshotBackfillUpstream<S> {
663    Empty,
664    Buffer(UpstreamBuffer<S>),
665}
666
667impl<S> SnapshotBackfillUpstream<S> {
668    async fn run_future<T, E: Into<StreamExecutorError>>(
669        &mut self,
670        future: impl Future<Output = Result<T, E>>,
671    ) -> StreamExecutorResult<T> {
672        match self {
673            SnapshotBackfillUpstream::Empty => future.await.map_err(Into::into),
674            SnapshotBackfillUpstream::Buffer(buffer) => buffer.run_future(future).await,
675        }
676    }
677}
678
679impl SnapshotBackfillUpstream<ConsumingSnapshot> {
680    fn start_consuming_log_store(
681        self,
682        consumed_epoch: u64,
683    ) -> Either<SnapshotBackfillUpstream<ConsumingLogStore>, MergeExecutorInput> {
684        match self {
685            SnapshotBackfillUpstream::Empty => Either::Left(SnapshotBackfillUpstream::Empty),
686            SnapshotBackfillUpstream::Buffer(buffer) => {
687                match buffer.start_consuming_log_store(consumed_epoch) {
688                    Either::Left(buffer) => Either::Left(SnapshotBackfillUpstream::Buffer(buffer)),
689                    Either::Right(input) => Either::Right(input),
690                }
691            }
692        }
693    }
694}
695
696impl SnapshotBackfillUpstream<ConsumingLogStore> {
697    async fn consumed_epoch(&mut self, epoch: EpochPair) -> StreamExecutorResult<bool> {
698        match self {
699            SnapshotBackfillUpstream::Empty => Ok(false),
700            SnapshotBackfillUpstream::Buffer(buffer) => buffer.consumed_epoch(epoch).await,
701        }
702    }
703
704    fn start_consuming_upstream(self) -> MergeExecutorInput {
705        match self {
706            SnapshotBackfillUpstream::Empty => {
707                unreachable!("unlike to start consuming upstream when having no upstream")
708            }
709            SnapshotBackfillUpstream::Buffer(buffer) => buffer.start_consuming_upstream(),
710        }
711    }
712}
713
714struct UpstreamBuffer<S> {
715    upstream: MergeExecutorInput,
716    max_pending_epoch_lag: u64,
717    consumed_epoch: u64,
718    /// Barriers received from upstream but not yet received the barrier from local barrier worker.
719    upstream_pending_barriers: PendingBarriers,
720    /// Whether we have started polling any upstream data before the next checkpoint barrier.
721    /// When `true`, we should continue polling until the next checkpoint barrier, because
722    /// some data in this epoch have been discarded and data in this epoch
723    /// must be read from log store
724    is_polling_epoch_data: bool,
725    consume_upstream_row_count: LabelGuardedIntCounter,
726    _phase: S,
727}
728
729impl UpstreamBuffer<ConsumingSnapshot> {
730    fn new(
731        upstream: MergeExecutorInput,
732        first_upstream_barrier: DispatcherBarrier,
733        consume_upstream_row_count: LabelGuardedIntCounter,
734    ) -> Self {
735        Self {
736            upstream,
737            is_polling_epoch_data: false,
738            consume_upstream_row_count,
739            upstream_pending_barriers: PendingBarriers::new(first_upstream_barrier),
740            // no limit on the number of pending barrier in the beginning
741            max_pending_epoch_lag: u64::MAX,
742            consumed_epoch: 0,
743            _phase: ConsumingSnapshot {},
744        }
745    }
746
747    fn start_consuming_log_store(
748        mut self,
749        consumed_epoch: u64,
750    ) -> Either<UpstreamBuffer<ConsumingLogStore>, MergeExecutorInput> {
751        if self
752            .upstream_pending_barriers
753            .first_upstream_barrier_epoch
754            .prev
755            == consumed_epoch
756        {
757            assert_eq!(
758                1,
759                self.upstream_pending_barriers
760                    .pop()
761                    .expect("non-empty")
762                    .len()
763            );
764        }
765        let max_pending_epoch_lag = self.pending_epoch_lag();
766        let buffer = UpstreamBuffer {
767            upstream: self.upstream,
768            upstream_pending_barriers: self.upstream_pending_barriers,
769            max_pending_epoch_lag,
770            is_polling_epoch_data: self.is_polling_epoch_data,
771            consume_upstream_row_count: self.consume_upstream_row_count,
772            consumed_epoch,
773            _phase: ConsumingLogStore {},
774        };
775        if buffer.is_finished() {
776            Either::Right(buffer.upstream)
777        } else {
778            Either::Left(buffer)
779        }
780    }
781}
782
783impl<S> UpstreamBuffer<S> {
784    fn can_consume_upstream(&self) -> bool {
785        self.is_polling_epoch_data || self.pending_epoch_lag() < self.max_pending_epoch_lag
786    }
787
788    async fn concurrently_consume_upstream(&mut self) -> StreamExecutorError {
789        {
790            loop {
791                if let Err(e) = try {
792                    if !self.can_consume_upstream() {
793                        // pause the future to block consuming upstream
794                        sleep(Duration::from_secs(30)).await;
795                        warn!(pending_barrier = ?self.upstream_pending_barriers, "not polling upstream but timeout");
796                        return pending().await;
797                    }
798                    self.consume_until_next_checkpoint_barrier().await?;
799                } {
800                    break e;
801                }
802            }
803        }
804    }
805
806    /// Consume the upstream until seeing the next barrier.
807    async fn consume_until_next_checkpoint_barrier(&mut self) -> StreamExecutorResult<()> {
808        loop {
809            let msg: DispatcherMessage = self
810                .upstream
811                .try_next()
812                .await?
813                .ok_or_else(|| anyhow!("end of upstream"))?;
814            match msg {
815                DispatcherMessage::Chunk(chunk) => {
816                    self.is_polling_epoch_data = true;
817                    self.consume_upstream_row_count
818                        .inc_by(chunk.cardinality() as _);
819                }
820                DispatcherMessage::Barrier(barrier) => {
821                    let is_checkpoint = barrier.kind.is_checkpoint();
822                    self.upstream_pending_barriers.add(barrier);
823                    if is_checkpoint {
824                        self.is_polling_epoch_data = false;
825                        break;
826                    } else {
827                        self.is_polling_epoch_data = true;
828                    }
829                }
830                DispatcherMessage::Watermark(_) => {
831                    self.is_polling_epoch_data = true;
832                }
833            }
834        }
835        Ok(())
836    }
837}
838
839impl UpstreamBuffer<ConsumingLogStore> {
840    #[await_tree::instrument("consumed_epoch: {:?}", epoch)]
841    async fn consumed_epoch(&mut self, epoch: EpochPair) -> StreamExecutorResult<bool> {
842        assert!(!self.is_finished());
843        if !self.upstream_pending_barriers.has_checkpoint_epoch() {
844            // when upstream_pending_barriers is empty and not polling any intermediate epoch data,
845            // we must have returned true to indicate finish, and should not be called again.
846            assert!(self.is_polling_epoch_data);
847            self.consume_until_next_checkpoint_barrier().await?;
848            assert_eq!(self.upstream_pending_barriers.checkpoint_epoch_count(), 1);
849        }
850        self.upstream_pending_barriers.consume_epoch(epoch);
851
852        {
853            {
854                let prev_epoch = epoch.prev;
855                assert!(self.consumed_epoch < prev_epoch);
856                let elapsed_epoch = prev_epoch - self.consumed_epoch;
857                self.consumed_epoch = prev_epoch;
858                if self.upstream_pending_barriers.has_checkpoint_epoch() {
859                    // try consuming ready upstreams when we haven't yielded all pending barriers yet.
860                    while self.can_consume_upstream()
861                        && let Some(result) =
862                            self.consume_until_next_checkpoint_barrier().now_or_never()
863                    {
864                        result?;
865                    }
866                }
867                // sub to ensure that the lag is monotonically decreasing.
868                // here we subtract half the elapsed epoch, so that approximately when downstream progresses two epochs,
869                // the upstream can at least progress for one epoch.
870                self.max_pending_epoch_lag = min(
871                    self.pending_epoch_lag(),
872                    self.max_pending_epoch_lag.saturating_sub(elapsed_epoch / 2),
873                );
874            }
875        }
876        Ok(self.is_finished())
877    }
878
879    fn is_finished(&self) -> bool {
880        if cfg!(debug_assertions) && !self.is_polling_epoch_data {
881            assert!(
882                self.upstream_pending_barriers
883                    .pending_non_checkpoint_barriers
884                    .is_empty()
885            )
886        }
887        !self.upstream_pending_barriers.has_checkpoint_epoch() && !self.is_polling_epoch_data
888    }
889
890    fn start_consuming_upstream(self) -> MergeExecutorInput {
891        assert!(self.is_finished());
892        assert_eq!(self.pending_epoch_lag(), 0);
893        self.upstream
894    }
895}
896
897impl<S> UpstreamBuffer<S> {
898    /// Run a future while concurrently polling the upstream so that the upstream
899    /// won't be back-pressured.
900    async fn run_future<T, E: Into<StreamExecutorError>>(
901        &mut self,
902        future: impl Future<Output = Result<T, E>>,
903    ) -> StreamExecutorResult<T> {
904        select! {
905            biased;
906            e = self.concurrently_consume_upstream() => {
907                Err(e)
908            }
909            // this arm won't be starved, because the first arm is always pending unless returning with error
910            result = future => {
911                result.map_err(Into::into)
912            }
913        }
914    }
915
916    fn pending_epoch_lag(&self) -> u64 {
917        self.upstream_pending_barriers
918            .latest_epoch()
919            .map(|epoch| {
920                epoch
921                    .prev
922                    .checked_sub(self.consumed_epoch)
923                    .expect("pending epoch must be later than consumed_epoch")
924            })
925            .unwrap_or(0)
926    }
927}
928
929#[await_tree::instrument("make_log_stream: {start_epoch}-{end_epoch} table {}", upstream_table.table_id())]
930async fn make_log_stream(
931    upstream_table: &BatchTable<impl StateStore>,
932    start_epoch: u64,
933    end_epoch: u64,
934    start_pk: Option<OwnedRow>,
935    chunk_size: usize,
936) -> StreamExecutorResult<VnodeStream<impl super::vnode_stream::ChangeLogRowStream>> {
937    let data_types = upstream_table.schema().data_types();
938    let start_pk = start_pk.as_ref();
939    // TODO: may avoid polling all vnodes concurrently at the same time but instead with a limit on concurrency.
940    let vnode_streams = try_join_all(upstream_table.vnodes().iter_vnodes().map(move |vnode| {
941        upstream_table
942            .batch_iter_vnode_log(
943                start_epoch,
944                HummockReadEpoch::Committed(end_epoch),
945                start_pk,
946                vnode,
947            )
948            .map_ok(move |stream| {
949                let stream = stream.map_err(Into::into);
950                (vnode, stream, 0)
951            })
952    }))
953    .await?;
954    let builder = create_builder(RateLimit::Disabled, chunk_size, data_types.clone());
955    Ok(VnodeStream::new(
956        vnode_streams,
957        upstream_table.pk_in_output_indices().expect("should exist"),
958        builder,
959    ))
960}
961
962async fn make_snapshot_stream(
963    upstream_table: &BatchTable<impl StateStore>,
964    snapshot_epoch: u64,
965    backfill_state: &BackfillState<impl StateStore>,
966    rate_limit: RateLimit,
967    chunk_size: usize,
968    snapshot_rebuild_interval: Duration,
969    pk_scan_range: &PkScanRange,
970) -> StreamExecutorResult<VnodeStream<impl super::vnode_stream::ChangeLogRowStream>> {
971    let data_types = upstream_table.schema().data_types();
972    let vnode_streams = try_join_all(backfill_state.latest_progress().filter_map(
973        move |(vnode, progress)| {
974            let start_pk = match progress {
975                None => Some((None, 0)),
976                Some(VnodeBackfillProgress {
977                    row_count,
978                    progress: EpochBackfillProgress::Consuming { latest_pk },
979                    ..
980                }) => Some((Some(latest_pk), *row_count)),
981                Some(VnodeBackfillProgress {
982                    progress: EpochBackfillProgress::Consumed,
983                    ..
984                }) => None,
985            };
986            start_pk.map(|(start_pk, row_count)| {
987                upstream_table
988                    .batch_iter_vnode_with_pk_range(
989                        HummockReadEpoch::Committed(snapshot_epoch),
990                        start_pk,
991                        &pk_scan_range.pk_prefix,
992                        &pk_scan_range.range_bounds,
993                        vnode,
994                        PrefetchOptions::prefetch_for_large_range_scan(),
995                        snapshot_rebuild_interval,
996                    )
997                    .map_ok(move |stream| {
998                        let stream = stream.map_ok(ChangeLogRow::Insert).map_err(Into::into);
999                        (vnode, stream, row_count)
1000                    })
1001            })
1002        },
1003    ))
1004    .await?;
1005    let builder = create_builder(rate_limit, chunk_size, data_types.clone());
1006    Ok(VnodeStream::new(
1007        vnode_streams,
1008        upstream_table.pk_in_output_indices().expect("should exist"),
1009        builder,
1010    ))
1011}
1012
1013#[expect(clippy::too_many_arguments)]
1014#[try_stream(ok = Message, error = StreamExecutorError)]
1015async fn make_consume_snapshot_stream<'a, S: StateStore>(
1016    upstream_table: &'a BatchTable<S>,
1017    snapshot_epoch: u64,
1018    chunk_size: usize,
1019    rate_limiter: &'a MonitoredRateLimiter,
1020    barrier_rx: &'a mut UnboundedReceiver<Barrier>,
1021    progress: &'a mut CreateMviewProgressReporter,
1022    backfill_state: &'a mut BackfillState<S>,
1023    first_recv_barrier_epoch: EpochPair,
1024    initial_backfill_paused: bool,
1025    actor_ctx: &'a ActorContextRef,
1026    pk_scan_range: &'a PkScanRange,
1027) {
1028    let mut barrier_epoch = first_recv_barrier_epoch;
1029
1030    // start consume upstream snapshot
1031    let mut snapshot_stream = make_snapshot_stream(
1032        upstream_table,
1033        snapshot_epoch,
1034        &*backfill_state,
1035        rate_limiter.rate_limit(),
1036        chunk_size,
1037        actor_ctx.config.developer.snapshot_iter_rebuild_interval(),
1038        pk_scan_range,
1039    )
1040    .await?;
1041
1042    async fn select_barrier_and_snapshot_stream(
1043        barrier_rx: &mut UnboundedReceiver<Barrier>,
1044        snapshot_stream: &mut (impl Stream<Item = StreamExecutorResult<StreamChunk>> + Unpin),
1045        throttle_snapshot_stream: bool,
1046        backfill_paused: bool,
1047    ) -> StreamExecutorResult<Either<Barrier, Option<StreamChunk>>> {
1048        select! {
1049            biased;
1050
1051            result = receive_next_barrier(barrier_rx) => {
1052                Ok(Either::Left(result?))
1053            },
1054            result = snapshot_stream.try_next(), if !throttle_snapshot_stream && !backfill_paused => {
1055                Ok(Either::Right(result?))
1056            }
1057        }
1058    }
1059
1060    let mut backfill_paused = initial_backfill_paused;
1061    loop {
1062        let throttle_snapshot_stream = matches!(rate_limiter.rate_limit(), RateLimit::Pause);
1063        match select_barrier_and_snapshot_stream(
1064            barrier_rx,
1065            &mut snapshot_stream,
1066            throttle_snapshot_stream,
1067            backfill_paused,
1068        )
1069        .await?
1070        {
1071            Either::Left(barrier) => {
1072                assert_eq!(barrier.epoch.prev, barrier_epoch.curr);
1073                barrier_epoch = barrier.epoch;
1074
1075                if barrier_epoch.curr >= snapshot_epoch {
1076                    return Err(anyhow!("should not receive barrier with epoch {barrier_epoch:?} later than snapshot epoch {snapshot_epoch}").into());
1077                }
1078                if barrier.should_start_fragment_backfill(actor_ctx.fragment_id) {
1079                    backfill_paused = false;
1080                }
1081                if let Some(chunk) = snapshot_stream.consume_builder() {
1082                    rate_limiter.wait(chunk.cardinality() as _).await;
1083                    yield Message::Chunk(chunk);
1084                }
1085                snapshot_stream
1086                    .for_vnode_pk_progress(|vnode, row_count, pk_progress| {
1087                        if let Some(pk) = pk_progress {
1088                            backfill_state.update_epoch_progress(
1089                                vnode,
1090                                snapshot_epoch,
1091                                row_count,
1092                                pk,
1093                            );
1094                        } else {
1095                            backfill_state.finish_epoch(vnode, snapshot_epoch, row_count);
1096                        }
1097                    })
1098                    .await?;
1099                let count = backfill_state.total_row_count();
1100                let post_commit = backfill_state.commit(barrier.epoch).await?;
1101                trace!(?barrier_epoch, count, "update progress");
1102                progress.update(barrier_epoch, barrier_epoch.prev, count as _);
1103
1104                let new_rate_limit = barrier.mutation.as_ref().and_then(|m| {
1105                    if let Mutation::Throttle(config) = &**m
1106                        && let Some(config) = config.get(&actor_ctx.fragment_id)
1107                        && config.throttle_type() == PbThrottleType::Backfill
1108                    {
1109                        Some(config.rate_limit)
1110                    } else {
1111                        None
1112                    }
1113                });
1114                yield Message::Barrier(barrier);
1115                post_commit.post_yield_barrier(None).await?;
1116
1117                if let Some(new_rate_limit) = new_rate_limit {
1118                    let new_rate_limit = new_rate_limit.into();
1119                    rate_limiter.update(new_rate_limit);
1120                    snapshot_stream.update_rate_limiter(new_rate_limit, chunk_size);
1121                }
1122            }
1123            Either::Right(Some(chunk)) => {
1124                if backfill_paused {
1125                    return Err(
1126                        anyhow!("snapshot backfill paused, but received snapshot chunk").into(),
1127                    );
1128                }
1129                rate_limiter.wait(chunk.cardinality() as _).await;
1130                yield Message::Chunk(chunk);
1131            }
1132            Either::Right(None) => {
1133                break;
1134            }
1135        }
1136    }
1137
1138    // finish consuming upstream snapshot, report finish
1139    let barrier_to_report_finish = receive_next_barrier(barrier_rx).await?;
1140    assert_eq!(barrier_to_report_finish.epoch.prev, barrier_epoch.curr);
1141    barrier_epoch = barrier_to_report_finish.epoch;
1142    snapshot_stream
1143        .for_vnode_pk_progress(|vnode, row_count, pk_progress| {
1144            assert_eq!(pk_progress, None);
1145            backfill_state.finish_epoch(vnode, snapshot_epoch, row_count);
1146        })
1147        .await?;
1148    let count = backfill_state.total_row_count();
1149    trace!(?barrier_epoch, count, "report finish");
1150    let post_commit = backfill_state.commit(barrier_epoch).await?;
1151    progress.finish(barrier_epoch, count as _);
1152    yield Message::Barrier(barrier_to_report_finish);
1153    post_commit.post_yield_barrier(None).await?;
1154
1155    // keep receiving remaining barriers until receiving a barrier with epoch as snapshot_epoch
1156    loop {
1157        let barrier = receive_next_barrier(barrier_rx).await?;
1158        assert_eq!(barrier.epoch.prev, barrier_epoch.curr);
1159        barrier_epoch = barrier.epoch;
1160        let post_commit = backfill_state.commit(barrier.epoch).await?;
1161        yield Message::Barrier(barrier);
1162        post_commit.post_yield_barrier(None).await?;
1163        if barrier_epoch.curr == snapshot_epoch {
1164            break;
1165        }
1166    }
1167    trace!(?barrier_epoch, "finish consuming snapshot");
1168}
1169
1170#[cfg(test)]
1171mod tests {
1172    use std::collections::HashSet;
1173    use std::sync::Arc;
1174
1175    use risingwave_common::array::StreamChunk;
1176    use risingwave_common::catalog::{ColumnDesc, ColumnId, Field, Schema, TableId};
1177    use risingwave_common::row::OwnedRow;
1178    use risingwave_common::test_prelude::StreamChunkTestExt;
1179    use risingwave_common::types::DataType;
1180    use risingwave_common::util::epoch::{EpochPair, test_epoch};
1181    use risingwave_common::util::sort_util::OrderType;
1182    use risingwave_hummock_test::test_utils::{HummockTestEnv, prepare_hummock_test_env};
1183    use risingwave_rpc_client::HummockMetaClient;
1184    use risingwave_storage::hummock::HummockStorage;
1185    use risingwave_storage::table::batch_table::BatchTable;
1186    use tokio::sync::mpsc::unbounded_channel;
1187    use tokio::time::{Duration, timeout};
1188
1189    use super::*;
1190    use crate::common::table::state_table::{
1191        StateTable, StateTableBuilder, StateTableOpConsistencyLevel,
1192    };
1193    use crate::common::table::test_utils::gen_pbtable_with_value_indices;
1194    use crate::executor::exchange::input::{Input, LocalInput};
1195    use crate::executor::exchange::permit::channel_for_test;
1196    use crate::executor::{ActorContext, DispatcherMessage, ExecutorInfo, MergeExecutorUpstream};
1197    use crate::task::LocalBarrierManager;
1198
1199    const SOURCE_TABLE_ID: TableId = TableId::new(0x233);
1200    const PROGRESS_TABLE_ID: TableId = TableId::new(0x234);
1201
1202    fn source_table_pb() -> risingwave_pb::catalog::PbTable {
1203        gen_pbtable_with_value_indices(
1204            SOURCE_TABLE_ID,
1205            vec![ColumnDesc::unnamed(ColumnId::new(0), DataType::Int64)],
1206            vec![OrderType::ascending()],
1207            vec![0],
1208            0,
1209            vec![0],
1210        )
1211    }
1212
1213    fn progress_table_pb() -> risingwave_pb::catalog::PbTable {
1214        gen_pbtable_with_value_indices(
1215            PROGRESS_TABLE_ID,
1216            vec![
1217                ColumnDesc::unnamed(ColumnId::new(0), DataType::Int16),
1218                ColumnDesc::unnamed(ColumnId::new(1), DataType::Int64),
1219                ColumnDesc::unnamed(ColumnId::new(2), DataType::Int64),
1220                ColumnDesc::unnamed(ColumnId::new(3), DataType::Boolean),
1221                ColumnDesc::unnamed(ColumnId::new(4), DataType::Int64),
1222            ],
1223            vec![OrderType::ascending()],
1224            vec![0],
1225            1,
1226            vec![1, 2, 3, 4],
1227        )
1228    }
1229
1230    fn source_batch_table(store: HummockStorage) -> BatchTable<HummockStorage> {
1231        BatchTable::for_test(
1232            store,
1233            SOURCE_TABLE_ID,
1234            vec![ColumnDesc::unnamed(ColumnId::new(0), DataType::Int64)],
1235            vec![OrderType::ascending()],
1236            vec![0],
1237            vec![0],
1238        )
1239    }
1240
1241    async fn source_state_table(store: HummockStorage) -> StateTable<HummockStorage> {
1242        StateTableBuilder::new(&source_table_pb(), store, None)
1243            .with_op_consistency_level(StateTableOpConsistencyLevel::LogStoreEnabled)
1244            .forbid_preload_all_rows()
1245            .build()
1246            .await
1247    }
1248
1249    async fn progress_state_table(store: HummockStorage) -> StateTable<HummockStorage> {
1250        StateTable::from_table_catalog(&progress_table_pb(), store, None).await
1251    }
1252
1253    async fn commit_insert_epoch(
1254        test_env: &HummockTestEnv,
1255        source_state_table: &mut StateTable<HummockStorage>,
1256        epoch: &mut EpochPair,
1257        table_ids: HashSet<TableId>,
1258        values: &[i64],
1259    ) {
1260        for value in values {
1261            source_state_table.insert(OwnedRow::new(vec![Some((*value).into())]));
1262        }
1263        epoch.inc_for_test();
1264        test_env.storage.start_epoch(epoch.curr, table_ids);
1265        source_state_table.commit_for_test(*epoch).await.unwrap();
1266        let res = test_env
1267            .storage
1268            .seal_and_sync_epoch(epoch.prev, HashSet::from_iter([SOURCE_TABLE_ID]))
1269            .await
1270            .unwrap();
1271        test_env
1272            .meta_client
1273            .commit_epoch_with_change_log(epoch.prev, res, Some(vec![epoch.prev]))
1274            .await
1275            .unwrap();
1276        test_env
1277            .storage
1278            .wait_version(test_env.manager.get_current_version().await)
1279            .await;
1280    }
1281
1282    fn start_progress_epochs(test_env: &HummockTestEnv, max_epoch: u64) {
1283        for epoch in 1..=max_epoch {
1284            test_env
1285                .storage
1286                .start_epoch(test_epoch(epoch), HashSet::from_iter([PROGRESS_TABLE_ID]));
1287        }
1288    }
1289
1290    fn make_upstream_input(
1291        barrier_manager: LocalBarrierManager,
1292        actor_ctx: ActorContextRef,
1293        rx: crate::executor::exchange::permit::Receiver,
1294    ) -> MergeExecutorInput {
1295        MergeExecutorInput::new(
1296            MergeExecutorUpstream::Singleton(LocalInput::new(rx, 1001.into()).boxed_input()),
1297            actor_ctx,
1298            1919.into(),
1299            barrier_manager,
1300            Arc::new(StreamingMetrics::unused()),
1301            ExecutorInfo::for_test(
1302                Schema::new(vec![Field::unnamed(DataType::Int64)]),
1303                vec![0],
1304                "SnapshotBackfillUpstream".to_owned(),
1305                0,
1306            ),
1307        )
1308    }
1309
1310    async fn expect_barrier_with_timeout(
1311        executor: &mut BoxedMessageStream,
1312        reason: &str,
1313    ) -> Barrier {
1314        let message = timeout(Duration::from_secs(10), executor.next())
1315            .await
1316            .unwrap_or_else(|_| panic!("timed out waiting for barrier: {reason}"))
1317            .unwrap()
1318            .unwrap();
1319        match message {
1320            Message::Barrier(barrier) => barrier,
1321            other => panic!("expected barrier for {reason}, got {other:?}"),
1322        }
1323    }
1324
1325    async fn expect_chunk_with_timeout(
1326        executor: &mut BoxedMessageStream,
1327        reason: &str,
1328    ) -> StreamChunk {
1329        let message = timeout(Duration::from_secs(10), executor.next())
1330            .await
1331            .unwrap_or_else(|_| panic!("timed out waiting for chunk: {reason}"))
1332            .unwrap()
1333            .unwrap();
1334        match message {
1335            Message::Chunk(chunk) => chunk,
1336            other => panic!("expected chunk for {reason}, got {other:?}"),
1337        }
1338    }
1339
1340    async fn expect_pending_with_timeout(executor: &mut BoxedMessageStream, reason: &str) {
1341        assert!(
1342            timeout(Duration::from_millis(200), executor.next())
1343                .await
1344                .is_err(),
1345            "executor unexpectedly produced a message while waiting for {reason}"
1346        );
1347    }
1348
1349    #[tokio::test]
1350    async fn test_snapshot_backfill_without_upstream_on_hummock() {
1351        let source_env = prepare_hummock_test_env().await;
1352        source_env.register_table(source_table_pb()).await;
1353        let progress_env = prepare_hummock_test_env().await;
1354        progress_env.register_table(progress_table_pb()).await;
1355
1356        let mut source_state_table = source_state_table(source_env.storage.clone()).await;
1357        let source_table = source_batch_table(source_env.storage.clone());
1358        let progress_state_table = progress_state_table(progress_env.storage.clone()).await;
1359
1360        let mut epoch = EpochPair::new_test_epoch(test_epoch(1));
1361        source_env
1362            .storage
1363            .start_epoch(epoch.curr, HashSet::from_iter([SOURCE_TABLE_ID]));
1364        source_state_table.init_epoch(epoch).await.unwrap();
1365
1366        commit_insert_epoch(
1367            &source_env,
1368            &mut source_state_table,
1369            &mut epoch,
1370            HashSet::from_iter([SOURCE_TABLE_ID]),
1371            &[1],
1372        )
1373        .await;
1374        commit_insert_epoch(
1375            &source_env,
1376            &mut source_state_table,
1377            &mut epoch,
1378            HashSet::from_iter([SOURCE_TABLE_ID]),
1379            &[2],
1380        )
1381        .await;
1382        commit_insert_epoch(
1383            &source_env,
1384            &mut source_state_table,
1385            &mut epoch,
1386            HashSet::from_iter([SOURCE_TABLE_ID]),
1387            &[3],
1388        )
1389        .await;
1390        commit_insert_epoch(
1391            &source_env,
1392            &mut source_state_table,
1393            &mut epoch,
1394            HashSet::from_iter([SOURCE_TABLE_ID]),
1395            &[],
1396        )
1397        .await;
1398        start_progress_epochs(&progress_env, 5);
1399
1400        let barrier_manager = LocalBarrierManager::for_test();
1401        let progress = CreateMviewProgressReporter::for_test(barrier_manager);
1402        let actor_ctx = ActorContext::for_test(1234);
1403        let (barrier_tx, barrier_rx) = unbounded_channel();
1404        barrier_tx
1405            .send(Barrier::new_test_barrier(test_epoch(1)))
1406            .unwrap();
1407
1408        let mut executor = SnapshotBackfillExecutor::new(
1409            source_table,
1410            progress_state_table,
1411            None,
1412            None,
1413            vec![0],
1414            vec![0],
1415            actor_ctx,
1416            progress,
1417            1024,
1418            RateLimit::Disabled,
1419            barrier_rx,
1420            Arc::new(StreamingMetrics::unused()),
1421            Some(test_epoch(3)),
1422        )
1423        .expect("snapshot backfill executor should be created")
1424        .boxed()
1425        .execute();
1426
1427        assert_eq!(
1428            expect_barrier_with_timeout(&mut executor, "initial injected barrier")
1429                .await
1430                .epoch,
1431            Barrier::new_test_barrier(test_epoch(1)).epoch
1432        );
1433        assert_eq!(
1434            expect_chunk_with_timeout(&mut executor, "snapshot chunk without upstream").await,
1435            StreamChunk::from_pretty(
1436                " I
1437                + 1
1438                + 2
1439                + 3"
1440            )
1441        );
1442        expect_pending_with_timeout(&mut executor, "snapshot finish barrier 2").await;
1443
1444        barrier_tx
1445            .send(Barrier::new_test_barrier(test_epoch(2)))
1446            .unwrap();
1447        assert_eq!(
1448            expect_barrier_with_timeout(&mut executor, "snapshot progress barrier 2")
1449                .await
1450                .epoch,
1451            Barrier::new_test_barrier(test_epoch(2)).epoch
1452        );
1453
1454        barrier_tx
1455            .send(Barrier::new_test_barrier(test_epoch(3)))
1456            .unwrap();
1457        assert_eq!(
1458            expect_barrier_with_timeout(&mut executor, "snapshot progress barrier 3")
1459                .await
1460                .epoch,
1461            Barrier::new_test_barrier(test_epoch(3)).epoch
1462        );
1463
1464        barrier_tx
1465            .send(Barrier::new_test_barrier(test_epoch(4)))
1466            .unwrap();
1467        assert_eq!(
1468            expect_barrier_with_timeout(&mut executor, "post-snapshot barrier 4")
1469                .await
1470                .epoch,
1471            Barrier::new_test_barrier(test_epoch(4)).epoch
1472        );
1473
1474        barrier_tx
1475            .send(Barrier::new_test_barrier(test_epoch(5)))
1476            .unwrap();
1477        assert_eq!(
1478            expect_barrier_with_timeout(&mut executor, "steady-state barrier 5")
1479                .await
1480                .epoch,
1481            Barrier::new_test_barrier(test_epoch(5)).epoch
1482        );
1483
1484        expect_pending_with_timeout(&mut executor, "next local barrier").await;
1485    }
1486
1487    #[tokio::test]
1488    async fn test_snapshot_backfill_with_upstream_on_hummock() {
1489        let source_env = prepare_hummock_test_env().await;
1490        source_env.register_table(source_table_pb()).await;
1491        let progress_env = prepare_hummock_test_env().await;
1492        progress_env.register_table(progress_table_pb()).await;
1493
1494        let mut source_state_table = source_state_table(source_env.storage.clone()).await;
1495        let source_table = source_batch_table(source_env.storage.clone());
1496        let progress_state_table = progress_state_table(progress_env.storage.clone()).await;
1497
1498        let mut epoch = EpochPair::new_test_epoch(test_epoch(1));
1499        source_env
1500            .storage
1501            .start_epoch(epoch.curr, HashSet::from_iter([SOURCE_TABLE_ID]));
1502        source_state_table.init_epoch(epoch).await.unwrap();
1503
1504        commit_insert_epoch(
1505            &source_env,
1506            &mut source_state_table,
1507            &mut epoch,
1508            HashSet::from_iter([SOURCE_TABLE_ID]),
1509            &[],
1510        )
1511        .await;
1512        commit_insert_epoch(
1513            &source_env,
1514            &mut source_state_table,
1515            &mut epoch,
1516            HashSet::from_iter([SOURCE_TABLE_ID]),
1517            &[],
1518        )
1519        .await;
1520        commit_insert_epoch(
1521            &source_env,
1522            &mut source_state_table,
1523            &mut epoch,
1524            HashSet::from_iter([SOURCE_TABLE_ID]),
1525            &[],
1526        )
1527        .await;
1528        commit_insert_epoch(
1529            &source_env,
1530            &mut source_state_table,
1531            &mut epoch,
1532            HashSet::from_iter([SOURCE_TABLE_ID]),
1533            &[4],
1534        )
1535        .await;
1536        start_progress_epochs(&progress_env, 6);
1537
1538        let barrier_manager = LocalBarrierManager::for_test();
1539        let progress = CreateMviewProgressReporter::for_test(barrier_manager.clone());
1540        let actor_ctx = ActorContext::for_test(1235);
1541        let (barrier_tx, barrier_rx) = unbounded_channel();
1542        let (upstream_tx, upstream_rx) = channel_for_test();
1543
1544        upstream_tx
1545            .send(
1546                DispatcherMessage::Barrier(
1547                    Barrier::new_test_barrier(test_epoch(5)).into_dispatcher(),
1548                )
1549                .into(),
1550            )
1551            .await
1552            .unwrap();
1553        barrier_tx
1554            .send(Barrier::new_test_barrier(test_epoch(1)))
1555            .unwrap();
1556
1557        let mut executor = SnapshotBackfillExecutor::new(
1558            source_table,
1559            progress_state_table,
1560            Some(make_upstream_input(
1561                barrier_manager,
1562                actor_ctx.clone(),
1563                upstream_rx,
1564            )),
1565            None,
1566            vec![0],
1567            vec![0],
1568            actor_ctx,
1569            progress,
1570            1024,
1571            RateLimit::Disabled,
1572            barrier_rx,
1573            Arc::new(StreamingMetrics::unused()),
1574            Some(test_epoch(3)),
1575        )
1576        .expect("snapshot backfill executor should be created")
1577        .boxed()
1578        .execute();
1579
1580        assert_eq!(
1581            expect_barrier_with_timeout(&mut executor, "initial injected barrier")
1582                .await
1583                .epoch,
1584            Barrier::new_test_barrier(test_epoch(1)).epoch
1585        );
1586        expect_pending_with_timeout(&mut executor, "snapshot finish barrier 2").await;
1587        barrier_tx
1588            .send(Barrier::new_test_barrier(test_epoch(2)))
1589            .unwrap();
1590        assert_eq!(
1591            expect_barrier_with_timeout(&mut executor, "snapshot progress barrier 2")
1592                .await
1593                .epoch,
1594            Barrier::new_test_barrier(test_epoch(2)).epoch
1595        );
1596
1597        barrier_tx
1598            .send(Barrier::new_test_barrier(test_epoch(3)))
1599            .unwrap();
1600        assert_eq!(
1601            expect_barrier_with_timeout(&mut executor, "snapshot progress barrier 3")
1602                .await
1603                .epoch,
1604            Barrier::new_test_barrier(test_epoch(3)).epoch
1605        );
1606
1607        barrier_tx
1608            .send(Barrier::new_test_barrier(test_epoch(4)))
1609            .unwrap();
1610        assert_eq!(
1611            expect_barrier_with_timeout(&mut executor, "snapshot completion barrier 4")
1612                .await
1613                .epoch,
1614            Barrier::new_test_barrier(test_epoch(4)).epoch
1615        );
1616
1617        barrier_tx
1618            .send(Barrier::new_test_barrier(test_epoch(5)))
1619            .unwrap();
1620        assert_eq!(
1621            expect_chunk_with_timeout(&mut executor, "log-store replay chunk").await,
1622            StreamChunk::from_pretty(
1623                " I
1624                + 4"
1625            )
1626        );
1627        assert_eq!(
1628            expect_barrier_with_timeout(&mut executor, "log-store completion barrier")
1629                .await
1630                .epoch,
1631            Barrier::new_test_barrier(test_epoch(5)).epoch
1632        );
1633
1634        upstream_tx
1635            .send(DispatcherMessage::Chunk(StreamChunk::from_pretty(" I\n + 5")).into())
1636            .await
1637            .unwrap();
1638        let stop_barrier = Barrier::new_test_barrier(test_epoch(6)).with_stop();
1639        upstream_tx
1640            .send(DispatcherMessage::Barrier(stop_barrier.clone().into_dispatcher()).into())
1641            .await
1642            .unwrap();
1643        barrier_tx.send(stop_barrier.clone()).unwrap();
1644
1645        assert_eq!(
1646            expect_chunk_with_timeout(&mut executor, "live upstream chunk after handoff").await,
1647            StreamChunk::from_pretty(" I\n + 5")
1648        );
1649        assert_eq!(
1650            expect_barrier_with_timeout(&mut executor, "final stop barrier")
1651                .await
1652                .epoch,
1653            stop_barrier.epoch
1654        );
1655    }
1656}