Skip to main content

risingwave_meta/barrier/context/
recovery.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::{Ordering, max, min};
16use std::collections::hash_map::Entry;
17use std::collections::{HashMap, HashSet};
18use std::sync::atomic::AtomicU32;
19
20use anyhow::{Context, anyhow};
21use futures::StreamExt;
22use futures::stream::FuturesUnordered;
23use itertools::Itertools;
24use risingwave_common::bail;
25use risingwave_common::catalog::{DatabaseId, TableId};
26use risingwave_common::id::JobId;
27use risingwave_common::util::stream_graph_visitor::visit_stream_node_cont;
28use risingwave_connector::source::SplitImpl;
29use risingwave_hummock_sdk::change_log::TableChangeLogs;
30use risingwave_hummock_sdk::version::HummockVersion;
31use risingwave_meta_model::SinkId;
32use risingwave_pb::stream_plan::stream_node::PbNodeBody;
33use sea_orm::TransactionTrait;
34use thiserror_ext::AsReport;
35use tracing::{info, warn};
36
37use super::BarrierWorkerRuntimeInfoSnapshot;
38use crate::MetaResult;
39use crate::barrier::DatabaseRuntimeInfoSnapshot;
40use crate::barrier::checkpoint::{
41    BatchRefreshJobCheckpointControl, BatchRefreshLogicalFragments, BatchRefreshRenderResult,
42};
43use crate::barrier::context::{GlobalBarrierWorkerContext, GlobalBarrierWorkerContextImpl};
44use crate::barrier::progress::TrackingJob;
45use crate::barrier::rpc::to_partial_graph_id;
46use crate::controller::fragment::{InflightActorInfo, InflightFragmentInfo};
47use crate::controller::scale::{
48    FragmentRenderMap, LoadedFragment, LoadedFragmentContext, RenderedGraph,
49    render_actor_assignments,
50};
51use crate::controller::utils::StreamingJobExtraInfo;
52use crate::manager::ActiveStreamingWorkerNodes;
53use crate::model::{ActorId, FragmentDownstreamRelation, FragmentId, StreamActor};
54use crate::rpc::ddl_controller::refill_upstream_sink_union_in_table;
55use crate::stream::cdc::reload_cdc_table_snapshot_splits;
56use crate::stream::{
57    SourceChange, StreamFragmentGraph, UpstreamSinkInfo, cleanup_dropped_streaming_jobs,
58};
59
60#[derive(Debug)]
61pub(crate) struct UpstreamSinkRecoveryInfo {
62    target_fragment_id: FragmentId,
63    upstream_infos: Vec<UpstreamSinkInfo>,
64}
65
66#[derive(Debug)]
67pub struct LoadedRecoveryContext {
68    pub fragment_context: LoadedFragmentContext,
69    pub job_extra_info: HashMap<JobId, StreamingJobExtraInfo>,
70    pub upstream_sink_recovery: HashMap<JobId, UpstreamSinkRecoveryInfo>,
71    pub fragment_relations: FragmentDownstreamRelation,
72}
73
74impl LoadedRecoveryContext {
75    fn empty(fragment_context: LoadedFragmentContext) -> Self {
76        Self {
77            fragment_context,
78            job_extra_info: HashMap::new(),
79            upstream_sink_recovery: HashMap::new(),
80            fragment_relations: FragmentDownstreamRelation::default(),
81        }
82    }
83}
84
85pub struct RenderedDatabaseRuntimeInfo {
86    pub job_infos: HashMap<JobId, HashMap<FragmentId, InflightFragmentInfo>>,
87    pub stream_actors: HashMap<ActorId, StreamActor>,
88    pub source_splits: HashMap<ActorId, Vec<SplitImpl>>,
89    /// Batch refresh jobs rendered during `render_runtime_info`.
90    pub batch_refresh: HashMap<JobId, BatchRefreshRenderResult>,
91}
92
93pub fn render_runtime_info(
94    actor_id_generator: &AtomicU32,
95    worker_nodes: &ActiveStreamingWorkerNodes,
96    recovery_context: &LoadedRecoveryContext,
97    database_id: DatabaseId,
98) -> MetaResult<Option<RenderedDatabaseRuntimeInfo>> {
99    let Some(mut per_database_context) =
100        recovery_context.fragment_context.for_database(database_id)
101    else {
102        return Ok(None);
103    };
104
105    assert!(!per_database_context.is_empty());
106
107    // Extract batch refresh jobs before rendering via `render_actor_assignments`.
108    // They will be rendered independently using the unified `render_actors_and_build_job_info`.
109    let batch_refresh_job_ids: HashSet<JobId> = per_database_context
110        .job_map
111        .iter()
112        .filter(|(_, model)| model.refresh_interval_sec.is_some())
113        .map(|(job_id, _)| *job_id)
114        .collect();
115
116    let mut batch_refresh_logical = HashMap::new();
117    if !batch_refresh_job_ids.is_empty() {
118        let batch_refresh_fragment_ids: HashSet<FragmentId> = batch_refresh_job_ids
119            .iter()
120            .flat_map(|job_id| {
121                per_database_context
122                    .job_fragments
123                    .get(job_id)
124                    .unwrap()
125                    .keys()
126                    .copied()
127            })
128            .collect();
129
130        for &job_id in &batch_refresh_job_ids {
131            let fragments = per_database_context.job_fragments.remove(&job_id).unwrap();
132            let downstreams = fragments
133                .keys()
134                .filter_map(|fid| {
135                    recovery_context
136                        .fragment_relations
137                        .get(fid)
138                        .map(|r| (*fid, r.clone()))
139                })
140                .collect();
141            batch_refresh_logical.insert(
142                job_id,
143                BatchRefreshLogicalFragments {
144                    fragments,
145                    downstreams,
146                },
147            );
148        }
149
150        // Remove ensembles that only contain batch refresh fragments.
151        per_database_context.ensembles.retain(|ensemble| {
152            !ensemble
153                .component_fragments()
154                .all(|fid| batch_refresh_fragment_ids.contains(&fid))
155        });
156    }
157
158    // Render actors for each batch refresh job.
159    let mut batch_refresh = HashMap::new();
160    for (job_id, logical) in batch_refresh_logical {
161        let extra = recovery_context
162            .job_extra_info
163            .get(&job_id)
164            .expect("should have extra info");
165        let streaming_job_model = per_database_context
166            .job_map
167            .get(&job_id)
168            .expect("should have streaming job model");
169        let database_model = &per_database_context.database_map[&database_id];
170        let partial_graph_id = to_partial_graph_id(database_id, Some(job_id));
171
172        let render_result = BatchRefreshJobCheckpointControl::render_actors_and_build_job_info(
173            &logical.fragments,
174            &logical.downstreams,
175            &extra.job_definition,
176            actor_id_generator,
177            worker_nodes.current(),
178            &database_model.resource_group,
179            streaming_job_model,
180            partial_graph_id,
181        )?;
182
183        batch_refresh.insert(job_id, render_result);
184    }
185
186    // If all fragments were batch refresh, no normal rendering needed.
187    if per_database_context.ensembles.is_empty() {
188        return Ok(Some(RenderedDatabaseRuntimeInfo {
189            job_infos: HashMap::new(),
190            stream_actors: HashMap::new(),
191            source_splits: HashMap::new(),
192            batch_refresh,
193        }));
194    }
195
196    let RenderedGraph { mut fragments, .. } = render_actor_assignments(
197        actor_id_generator,
198        worker_nodes.current(),
199        &per_database_context,
200    )?;
201
202    let single_database = match fragments.remove(&database_id) {
203        Some(info) => info,
204        None => return Ok(None),
205    };
206
207    let mut database_map = HashMap::from([(database_id, single_database)]);
208    recovery_table_with_upstream_sinks(
209        &mut database_map,
210        &recovery_context.upstream_sink_recovery,
211    )?;
212    let stream_actors = build_stream_actors(&database_map, &recovery_context.job_extra_info)?;
213
214    let job_infos = database_map
215        .remove(&database_id)
216        .expect("database entry must exist");
217
218    let mut source_splits = HashMap::new();
219    for fragment_infos in job_infos.values() {
220        for fragment in fragment_infos.values() {
221            for (actor_id, info) in &fragment.actors {
222                source_splits.insert(*actor_id, info.splits.clone());
223            }
224        }
225    }
226
227    Ok(Some(RenderedDatabaseRuntimeInfo {
228        job_infos,
229        stream_actors,
230        source_splits,
231        batch_refresh,
232    }))
233}
234
235/// For normal DDL operations, the `UpstreamSinkUnion` operator is modified dynamically, and does not persist the
236/// newly added or deleted upstreams in meta-store. Therefore, when restoring jobs, we need to restore the
237/// information required by the operator based on the current state of the upstream (sink) and downstream (table) of
238/// the operator. All necessary metadata must be preloaded before rendering.
239fn recovery_table_with_upstream_sinks(
240    inflight_jobs: &mut FragmentRenderMap,
241    upstream_sink_recovery: &HashMap<JobId, UpstreamSinkRecoveryInfo>,
242) -> MetaResult<()> {
243    if upstream_sink_recovery.is_empty() {
244        return Ok(());
245    }
246
247    let mut seen_jobs = HashSet::new();
248
249    for jobs in inflight_jobs.values_mut() {
250        for (job_id, fragments) in jobs {
251            if !seen_jobs.insert(*job_id) {
252                return Err(anyhow::anyhow!("Duplicate job id found: {}", job_id).into());
253            }
254
255            if let Some(recovery) = upstream_sink_recovery.get(job_id) {
256                if let Some(target_fragment) = fragments.get_mut(&recovery.target_fragment_id) {
257                    refill_upstream_sink_union_in_table(
258                        &mut target_fragment.nodes,
259                        &recovery.upstream_infos,
260                    );
261                } else {
262                    return Err(anyhow::anyhow!(
263                        "target fragment {} not found for upstream sink recovery of job {}",
264                        recovery.target_fragment_id,
265                        job_id
266                    )
267                    .into());
268                }
269            }
270        }
271    }
272
273    Ok(())
274}
275
276/// Assembles `StreamActor` instances from rendered fragment info and job context.
277///
278/// This function combines the actor assignments from `FragmentRenderMap` with
279/// runtime context (timezone, config, definition) from `StreamingJobExtraInfo`
280/// to produce the final `StreamActor` structures needed for recovery.
281fn build_stream_actors(
282    all_info: &FragmentRenderMap,
283    job_extra_info: &HashMap<JobId, StreamingJobExtraInfo>,
284) -> MetaResult<HashMap<ActorId, StreamActor>> {
285    let mut stream_actors = HashMap::new();
286
287    for (job_id, streaming_info) in all_info.values().flatten() {
288        let extra_info = job_extra_info
289            .get(job_id)
290            .cloned()
291            .ok_or_else(|| anyhow!("no streaming job info for {}", job_id))?;
292        let expr_context = extra_info.stream_context().to_expr_context();
293        let job_definition = extra_info.job_definition;
294        let config_override = extra_info.config_override;
295
296        for (fragment_id, fragment_infos) in streaming_info {
297            for (actor_id, InflightActorInfo { vnode_bitmap, .. }) in &fragment_infos.actors {
298                stream_actors.insert(
299                    *actor_id,
300                    StreamActor {
301                        actor_id: *actor_id,
302                        fragment_id: *fragment_id,
303                        vnode_bitmap: vnode_bitmap.clone(),
304                        mview_definition: job_definition.clone(),
305                        expr_context: Some(expr_context.clone()),
306                        config_override: config_override.clone(),
307                    },
308                );
309            }
310        }
311    }
312    Ok(stream_actors)
313}
314
315impl GlobalBarrierWorkerContextImpl {
316    fn resolve_job_committed_epoch(
317        job_id: JobId,
318        fragments: &HashMap<FragmentId, LoadedFragment>,
319        state_table_committed_epochs: &HashMap<TableId, u64>,
320    ) -> MetaResult<u64> {
321        let mut table_id_iter = fragments
322            .values()
323            .flat_map(|fragment| fragment.state_table_ids.iter().copied());
324        let Some(first_table_id) = table_id_iter.next() else {
325            bail!("job {} has no state table", job_id);
326        };
327        let committed_epoch = *state_table_committed_epochs
328            .get(&first_table_id)
329            .ok_or_else(|| anyhow!("cannot get committed epoch on table {}.", first_table_id))?;
330        for table_id in table_id_iter {
331            let table_committed_epoch = *state_table_committed_epochs
332                .get(&table_id)
333                .ok_or_else(|| anyhow!("cannot get committed epoch on table {}.", table_id))?;
334            if committed_epoch != table_committed_epoch {
335                bail!(
336                    "table {} has committed epoch {} different to other table {} with committed epoch {} in job {}",
337                    first_table_id,
338                    committed_epoch,
339                    table_id,
340                    table_committed_epoch,
341                    job_id
342                );
343            }
344        }
345
346        Ok(committed_epoch)
347    }
348
349    async fn finish_completed_batch_refresh_background_jobs(
350        &self,
351        recovery_context: &LoadedRecoveryContext,
352        state_table_committed_epochs: &HashMap<TableId, u64>,
353        background_jobs: &mut HashSet<JobId>,
354    ) -> MetaResult<()> {
355        let background_job_ids = background_jobs.iter().copied().collect_vec();
356        for job_id in background_job_ids {
357            let Some(job) = recovery_context.fragment_context.job_map.get(&job_id) else {
358                continue;
359            };
360            if job.refresh_interval_sec.is_none() {
361                continue;
362            }
363            let Some(fragments) = recovery_context.fragment_context.job_fragments.get(&job_id)
364            else {
365                continue;
366            };
367
368            let committed_epoch =
369                Self::resolve_job_committed_epoch(job_id, fragments, state_table_committed_epochs)?;
370            let snapshot_backfill_info = StreamFragmentGraph::collect_snapshot_backfill_info_impl(
371                fragments
372                    .values()
373                    .map(|fragment| (&fragment.nodes, fragment.fragment_type_mask)),
374            )?
375            .0
376            .ok_or_else(|| anyhow!("batch refresh job {} has no snapshot backfill info", job_id))?;
377            let snapshot_epoch = snapshot_backfill_info
378                .upstream_mv_table_id_to_backfill_epoch
379                .values()
380                .find_map(|e| *e)
381                .unwrap_or(committed_epoch);
382            if committed_epoch < snapshot_epoch {
383                continue;
384            }
385
386            info!(
387                %job_id,
388                committed_epoch,
389                snapshot_epoch,
390                "finish completed batch refresh background job during recovery"
391            );
392            self.finish_creating_job(TrackingJob::recovered_from_fragment_nodes(
393                job_id,
394                fragments
395                    .iter()
396                    .map(|(fragment_id, fragment)| (*fragment_id, &fragment.nodes)),
397            ))
398            .await?;
399            background_jobs.remove(&job_id);
400        }
401
402        Ok(())
403    }
404
405    async fn apply_pre_applied_drop_cancel(
406        &self,
407        database_id: Option<DatabaseId>,
408    ) -> MetaResult<bool> {
409        let drop_cancel = self.scheduled_barriers.pre_apply_drop_cancel(database_id);
410        let has_drop_streaming_jobs = !drop_cancel.streaming_job_ids.is_empty();
411        cleanup_dropped_streaming_jobs(
412            &self.refresh_manager,
413            &self.hummock_manager,
414            &self.metadata_manager,
415            drop_cancel.streaming_job_ids,
416            drop_cancel.dropped_state_table_ids,
417            "drop_streaming_jobs",
418        )
419        .await?;
420        Ok(has_drop_streaming_jobs)
421    }
422
423    /// Clean catalogs for creating streaming jobs that are in foreground mode or table fragments not persisted.
424    async fn clean_dirty_streaming_jobs(&self, database_id: Option<DatabaseId>) -> MetaResult<()> {
425        self.metadata_manager
426            .catalog_controller
427            .clean_dirty_subscription(database_id)
428            .await?;
429
430        let cleaned_dirty_jobs = self
431            .metadata_manager
432            .catalog_controller
433            .clean_dirty_creating_jobs(database_id)
434            .await?;
435        for sink_id in &cleaned_dirty_jobs.sink_ids {
436            self.iceberg_compaction_manager
437                .clear_iceberg_maintenance_by_sink_id(*sink_id);
438        }
439        if database_id.is_some() {
440            // Per-database recovery does not run the global Hummock purge below. Unregister the
441            // dirty jobs cleaned in this database through the normal dropped-table cleanup path.
442            cleanup_dropped_streaming_jobs(
443                &self.refresh_manager,
444                &self.hummock_manager,
445                &self.metadata_manager,
446                cleaned_dirty_jobs.streaming_job_ids,
447                cleaned_dirty_jobs.dropped_table_ids,
448                "clean_dirty_creating_jobs",
449            )
450            .await?;
451        }
452        self.metadata_manager
453            .reset_all_refresh_jobs_to_idle()
454            .await?;
455
456        // unregister cleaned sources.
457        self.source_manager
458            .apply_source_change(SourceChange::DropSource {
459                dropped_source_ids: cleaned_dirty_jobs.source_ids,
460            })
461            .await;
462
463        Ok(())
464    }
465
466    async fn reset_sink_coordinator(&self, database_id: Option<DatabaseId>) -> MetaResult<()> {
467        if let Some(database_id) = database_id {
468            let sink_ids = self
469                .metadata_manager
470                .catalog_controller
471                .list_sink_ids(Some(database_id))
472                .await?;
473            self.sink_manager
474                .stop_sink_coordinator(sink_ids.clone())
475                .await;
476            self.iceberg_pk_index_sink_manager
477                .unregister_sinks(sink_ids);
478        } else {
479            self.sink_manager.reset().await;
480            self.iceberg_pk_index_sink_manager.reset();
481        }
482        Ok(())
483    }
484
485    /// Re-register iceberg pk-index sink commit coordinators after recovery wipes them.
486    async fn reregister_iceberg_pk_index_sinks(
487        &self,
488        database_id: Option<DatabaseId>,
489    ) -> MetaResult<()> {
490        let pb_sinks = self
491            .metadata_manager
492            .catalog_controller
493            .list_sinks()
494            .await?;
495        let mut futs = FuturesUnordered::new();
496        for pb_sink in pb_sinks {
497            if database_id.is_some_and(|db_id| pb_sink.database_id != db_id)
498                || !crate::manager::iceberg_pk_index_sink::is_iceberg_pk_index_sink(
499                    &pb_sink.properties,
500                )
501            {
502                continue;
503            }
504            let config = crate::manager::iceberg_pk_index_sink::build_iceberg_config(&pb_sink)
505                .with_context(|| {
506                    format!(
507                        "build iceberg config while re-registering v3 sink {}",
508                        pb_sink.id
509                    )
510                })?;
511            let state_table_id = self
512                .metadata_manager
513                .catalog_controller
514                .get_sink_state_table_ids(pb_sink.id)
515                .await?
516                .into_iter()
517                .next()
518                .ok_or_else(|| {
519                    anyhow!(
520                        "no state table found while re-registering iceberg v3 sink {}",
521                        pb_sink.id
522                    )
523                })?;
524            let recovered_epoch = self
525                .hummock_manager
526                .on_current_version(|version| version.table_committed_epoch(state_table_id))
527                .await
528                .ok_or_else(|| {
529                    anyhow!(
530                        "cannot get committed epoch for iceberg v3 sink {} state table {}",
531                        pb_sink.id,
532                        state_table_id
533                    )
534                })?;
535            let manager = &self.iceberg_pk_index_sink_manager;
536            futs.push(async move {
537                let partial_graph_id = to_partial_graph_id(pb_sink.database_id, None);
538                let result = manager
539                    .register_sink(pb_sink.id, partial_graph_id, config)
540                    .await;
541                if result.is_ok() {
542                    manager.advance_committed_epochs([(partial_graph_id, recovered_epoch)]);
543                }
544                (pb_sink.id, result)
545            });
546        }
547
548        while let Some((id, res)) = futs.next().await {
549            if let Err(e) = res {
550                let msg = format!("register iceberg v3 sink {} during recovery", id);
551                return Err(e.context(msg).into());
552            }
553        }
554        Ok(())
555    }
556
557    async fn abort_dirty_pending_sink_state(
558        &self,
559        database_id: Option<DatabaseId>,
560    ) -> MetaResult<()> {
561        let pending_sinks: HashSet<SinkId> = self
562            .metadata_manager
563            .catalog_controller
564            .list_all_pending_sinks(database_id)
565            .await?;
566
567        if pending_sinks.is_empty() {
568            return Ok(());
569        }
570
571        let sink_with_state_tables: HashMap<SinkId, Vec<TableId>> = self
572            .metadata_manager
573            .catalog_controller
574            .fetch_sink_with_state_table_ids(pending_sinks)
575            .await?;
576
577        let mut sink_committed_epoch: HashMap<SinkId, u64> = HashMap::new();
578
579        for (sink_id, table_ids) in sink_with_state_tables {
580            let Some(table_id) = table_ids.first() else {
581                return Err(anyhow!("no state table id in sink: {}", sink_id).into());
582            };
583
584            self.hummock_manager
585                .on_current_version(|version| -> MetaResult<()> {
586                    if let Some(committed_epoch) = version.table_committed_epoch(*table_id) {
587                        assert!(
588                            sink_committed_epoch
589                                .insert(sink_id, committed_epoch)
590                                .is_none()
591                        );
592                        Ok(())
593                    } else {
594                        Err(anyhow!("cannot get committed epoch on table {}.", table_id).into())
595                    }
596                })
597                .await?;
598        }
599
600        self.metadata_manager
601            .catalog_controller
602            .abort_pending_sink_epochs(sink_committed_epoch)
603            .await?;
604
605        Ok(())
606    }
607
608    async fn purge_state_table_from_hummock(
609        &self,
610        all_state_table_ids: &HashSet<TableId>,
611    ) -> MetaResult<()> {
612        self.hummock_manager.purge(all_state_table_ids).await?;
613        Ok(())
614    }
615
616    async fn list_background_job_progress(
617        &self,
618        database_id: Option<DatabaseId>,
619    ) -> MetaResult<HashSet<JobId>> {
620        let mgr = &self.metadata_manager;
621        mgr.catalog_controller
622            .list_background_creating_jobs(false, database_id)
623            .await
624    }
625
626    async fn load_recovery_context(
627        &self,
628        database_id: Option<DatabaseId>,
629    ) -> MetaResult<LoadedRecoveryContext> {
630        let inner = self
631            .metadata_manager
632            .catalog_controller
633            .get_inner_read_guard()
634            .await;
635        let txn = inner.db.begin().await?;
636
637        let fragment_context = self
638            .metadata_manager
639            .catalog_controller
640            .load_fragment_context_in_txn(&txn, database_id)
641            .await
642            .inspect_err(|err| {
643                warn!(error = %err.as_report(), "load fragment context failed");
644            })?;
645
646        if fragment_context.is_empty() {
647            return Ok(LoadedRecoveryContext::empty(fragment_context));
648        }
649
650        let job_ids = fragment_context.job_map.keys().copied().collect_vec();
651        let job_extra_info = self
652            .metadata_manager
653            .catalog_controller
654            .get_streaming_job_extra_info_in_txn(&txn, job_ids)
655            .await?;
656
657        let mut upstream_targets = HashMap::new();
658        for fragment in fragment_context
659            .job_fragments
660            .values()
661            .flat_map(|fragments| fragments.values())
662        {
663            let mut has_upstream_union = false;
664            visit_stream_node_cont(&fragment.nodes, |node| {
665                if let Some(PbNodeBody::UpstreamSinkUnion(_)) = node.node_body {
666                    has_upstream_union = true;
667                    false
668                } else {
669                    true
670                }
671            });
672
673            if has_upstream_union
674                && let Some(previous) =
675                    upstream_targets.insert(fragment.job_id, fragment.fragment_id)
676            {
677                bail!(
678                    "multiple upstream sink union fragments found for job {}, fragment {}, kept {}",
679                    fragment.job_id,
680                    fragment.fragment_id,
681                    previous
682                );
683            }
684        }
685
686        let mut upstream_sink_recovery = HashMap::new();
687        if !upstream_targets.is_empty() {
688            let tables = self
689                .metadata_manager
690                .catalog_controller
691                .get_user_created_table_by_ids_in_txn(&txn, upstream_targets.keys().copied())
692                .await?;
693
694            for table in tables {
695                let job_id = table.id.as_job_id();
696                let Some(target_fragment_id) = upstream_targets.get(&job_id) else {
697                    // This should not happen unless catalog changes or legacy metadata are involved.
698                    tracing::debug!(
699                        job_id = %job_id,
700                        "upstream sink union target fragment not found for table"
701                    );
702                    continue;
703                };
704
705                let upstream_infos = self
706                    .metadata_manager
707                    .catalog_controller
708                    .get_all_upstream_sink_infos_in_txn(&txn, &table, *target_fragment_id as _)
709                    .await?;
710
711                upstream_sink_recovery.insert(
712                    job_id,
713                    UpstreamSinkRecoveryInfo {
714                        target_fragment_id: *target_fragment_id,
715                        upstream_infos,
716                    },
717                );
718            }
719        }
720
721        let fragment_relations = self
722            .metadata_manager
723            .catalog_controller
724            .get_fragment_downstream_relations_in_txn(
725                &txn,
726                fragment_context
727                    .job_fragments
728                    .values()
729                    .flat_map(|fragments| fragments.keys().copied())
730                    .collect_vec(),
731            )
732            .await?;
733
734        Ok(LoadedRecoveryContext {
735            fragment_context,
736            job_extra_info,
737            upstream_sink_recovery,
738            fragment_relations,
739        })
740    }
741
742    #[expect(clippy::type_complexity)]
743    fn resolve_hummock_version_epochs(
744        background_jobs: impl Iterator<Item = (JobId, &HashMap<FragmentId, LoadedFragment>)>,
745        version: &HummockVersion,
746        table_change_log: &TableChangeLogs,
747    ) -> MetaResult<(
748        HashMap<TableId, u64>,
749        HashMap<TableId, Vec<(Vec<u64>, u64)>>,
750    )> {
751        let table_committed_epoch: HashMap<_, _> = version
752            .state_table_info
753            .info()
754            .iter()
755            .map(|(table_id, info)| (*table_id, info.committed_epoch))
756            .collect();
757        let get_table_committed_epoch = |table_id| -> anyhow::Result<u64> {
758            Ok(*table_committed_epoch
759                .get(&table_id)
760                .ok_or_else(|| anyhow!("cannot get committed epoch on table {}.", table_id))?)
761        };
762        let mut min_downstream_committed_epochs = HashMap::new();
763        for (job_id, fragments) in background_jobs {
764            let job_committed_epoch =
765                Self::resolve_job_committed_epoch(job_id, fragments, &table_committed_epoch)?;
766            if let (Some(snapshot_backfill_info), _) =
767                StreamFragmentGraph::collect_snapshot_backfill_info_impl(
768                    fragments
769                        .values()
770                        .map(|fragment| (&fragment.nodes, fragment.fragment_type_mask)),
771                )?
772            {
773                for (upstream_table, snapshot_epoch) in
774                    snapshot_backfill_info.upstream_mv_table_id_to_backfill_epoch
775                {
776                    let snapshot_epoch = snapshot_epoch.ok_or_else(|| {
777                        anyhow!(
778                            "recovered snapshot backfill job {} has not filled snapshot epoch to upstream {}",
779                            job_id, upstream_table
780                        )
781                    })?;
782                    let pinned_epoch = max(snapshot_epoch, job_committed_epoch);
783                    match min_downstream_committed_epochs.entry(upstream_table) {
784                        Entry::Occupied(entry) => {
785                            let prev_min_epoch = entry.into_mut();
786                            *prev_min_epoch = min(*prev_min_epoch, pinned_epoch);
787                        }
788                        Entry::Vacant(entry) => {
789                            entry.insert(pinned_epoch);
790                        }
791                    }
792                }
793            }
794        }
795        let mut log_epochs = HashMap::new();
796        for (upstream_table_id, downstream_committed_epoch) in min_downstream_committed_epochs {
797            let upstream_committed_epoch = get_table_committed_epoch(upstream_table_id)?;
798            match upstream_committed_epoch.cmp(&downstream_committed_epoch) {
799                Ordering::Less => {
800                    bail!(
801                        "downstream epoch {} later than upstream epoch {} of table {}",
802                        downstream_committed_epoch,
803                        upstream_committed_epoch,
804                        upstream_table_id
805                    );
806                }
807                Ordering::Equal => {
808                    continue;
809                }
810                Ordering::Greater => {
811                    if let Some(table_change_log) = table_change_log.get(&upstream_table_id) {
812                        let epochs = table_change_log
813                            .filter_epoch((downstream_committed_epoch, upstream_committed_epoch))
814                            .map(|epoch_log| {
815                                (
816                                    epoch_log.non_checkpoint_epochs.clone(),
817                                    epoch_log.checkpoint_epoch,
818                                )
819                            })
820                            .collect_vec();
821                        let first_epochs = epochs.first();
822                        if let Some((_, first_checkpoint_epoch)) = &first_epochs
823                            && *first_checkpoint_epoch == downstream_committed_epoch
824                        {
825                        } else {
826                            bail!(
827                                "resolved first log epoch {:?} on table {} not matched with downstream committed epoch {}",
828                                epochs,
829                                upstream_table_id,
830                                downstream_committed_epoch
831                            );
832                        }
833                        log_epochs
834                            .try_insert(upstream_table_id, epochs)
835                            .expect("non-duplicated");
836                    } else {
837                        bail!(
838                            "upstream table {} on epoch {} has lagged downstream on epoch {} but no table change log",
839                            upstream_table_id,
840                            upstream_committed_epoch,
841                            downstream_committed_epoch
842                        );
843                    }
844                }
845            }
846        }
847        Ok((table_committed_epoch, log_epochs))
848    }
849
850    pub(super) async fn reload_runtime_info_impl(
851        &self,
852    ) -> MetaResult<BarrierWorkerRuntimeInfoSnapshot> {
853        {
854            {
855                {
856                    self.clean_dirty_streaming_jobs(None)
857                        .await
858                        .context("clean dirty streaming jobs")?;
859
860                    self.reset_sink_coordinator(None)
861                        .await
862                        .context("reset sink coordinator")?;
863                    self.abort_dirty_pending_sink_state(None)
864                        .await
865                        .context("abort dirty pending sink state")?;
866
867                    // We must abort dirty pending sink state before registering iceberg pk-index sinks,
868                    // otherwise recover_pending will take speculative (epoch > committed epoch) pending sink state
869                    // as valid and cause duplicated iceberg commit.
870                    self.reregister_iceberg_pk_index_sinks(None)
871                        .await
872                        .context("re-register iceberg v3 sinks after recovery")?;
873
874                    // Background job progress needs to be recovered.
875                    tracing::info!("recovering background job progress");
876                    let mut initial_background_jobs = self
877                        .list_background_job_progress(None)
878                        .await
879                        .context("recover background job progress should not fail")?;
880
881                    tracing::info!("recovered background job progress");
882
883                    // This is a quick path to accelerate the process of dropping and canceling streaming jobs.
884                    let _ = self.apply_pre_applied_drop_cancel(None).await?;
885                    self.metadata_manager
886                        .catalog_controller
887                        .cleanup_dropped_tables()
888                        .await;
889
890                    let active_streaming_nodes =
891                        ActiveStreamingWorkerNodes::new_snapshot(self.metadata_manager.clone())
892                            .await?;
893
894                    let background_streaming_jobs =
895                        initial_background_jobs.iter().cloned().collect_vec();
896
897                    tracing::info!(
898                        "background streaming jobs: {:?} total {}",
899                        background_streaming_jobs,
900                        background_streaming_jobs.len()
901                    );
902
903                    let unreschedulable_jobs = {
904                        let mut unreschedulable_jobs = HashSet::new();
905
906                        for job_id in background_streaming_jobs {
907                            let scan_types = self
908                                .metadata_manager
909                                .get_job_backfill_scan_types(job_id)
910                                .await?;
911
912                            if scan_types
913                                .values()
914                                .any(|scan_type| !scan_type.is_reschedulable(false))
915                            {
916                                unreschedulable_jobs.insert(job_id);
917                            }
918                        }
919
920                        unreschedulable_jobs
921                    };
922
923                    if !unreschedulable_jobs.is_empty() {
924                        info!(
925                            "unreschedulable background jobs: {:?}",
926                            unreschedulable_jobs
927                        );
928                    }
929
930                    // Resolve actor info for recovery. If there's no actor to recover, most of the
931                    // following steps will be no-op, while the compute nodes will still be reset.
932                    // TODO(error-handling): attach context to the errors and log them together, instead of inspecting everywhere.
933                    if !unreschedulable_jobs.is_empty() {
934                        bail!(
935                            "Recovery for unreschedulable background jobs is not yet implemented. \
936                             This path is triggered when the following jobs have at least one scan type that is not reschedulable: {:?}.",
937                            unreschedulable_jobs
938                        );
939                    }
940
941                    let mut recovery_context = self.load_recovery_context(None).await?;
942                    if self.apply_pre_applied_drop_cancel(None).await? {
943                        recovery_context = self.load_recovery_context(None).await?;
944                    }
945
946                    self.purge_state_table_from_hummock(
947                        &recovery_context
948                            .fragment_context
949                            .job_fragments
950                            .values()
951                            .flat_map(|fragments| fragments.values())
952                            .flat_map(|fragment| fragment.state_table_ids.iter().copied())
953                            .collect(),
954                    )
955                    .await
956                    .context("purge state table from hummock")?;
957
958                    let (state_table_committed_epochs, state_table_log_epochs) = self
959                        .hummock_manager
960                        .on_current_version_and_table_change_log(|version, table_change_log| {
961                            Self::resolve_hummock_version_epochs(
962                                recovery_context
963                                    .fragment_context
964                                    .job_fragments
965                                    .iter()
966                                    .filter_map(|(job_id, job)| {
967                                        initial_background_jobs
968                                            .contains(job_id)
969                                            .then_some((*job_id, job))
970                                    }),
971                                version,
972                                table_change_log,
973                            )
974                        })
975                        .await?;
976
977                    self.finish_completed_batch_refresh_background_jobs(
978                        &recovery_context,
979                        &state_table_committed_epochs,
980                        &mut initial_background_jobs,
981                    )
982                    .await?;
983
984                    let mv_depended_subscriptions = self
985                        .metadata_manager
986                        .get_mv_depended_subscriptions(None)
987                        .await?;
988
989                    // Refresh background job progress for the final snapshot to reflect any catalog changes.
990                    let background_jobs = {
991                        let mut refreshed_background_jobs = self
992                            .list_background_job_progress(None)
993                            .await
994                            .context("recover background job progress should not fail")?;
995                        recovery_context
996                            .fragment_context
997                            .job_map
998                            .keys()
999                            .filter_map(|job_id| {
1000                                refreshed_background_jobs.remove(job_id).then_some(*job_id)
1001                            })
1002                            .collect()
1003                    };
1004
1005                    let database_infos = self
1006                        .metadata_manager
1007                        .catalog_controller
1008                        .list_databases()
1009                        .await?;
1010
1011                    let cdc_table_snapshot_splits =
1012                        reload_cdc_table_snapshot_splits(&self.env.meta_store_ref().conn, None)
1013                            .await?;
1014
1015                    Ok(BarrierWorkerRuntimeInfoSnapshot {
1016                        active_streaming_nodes,
1017                        recovery_context,
1018                        state_table_committed_epochs,
1019                        state_table_log_epochs,
1020                        mv_depended_subscriptions,
1021                        background_jobs,
1022                        hummock_version_stats: self.hummock_manager.get_version_stats().await,
1023                        database_infos,
1024                        cdc_table_snapshot_splits,
1025                    })
1026                }
1027            }
1028        }
1029    }
1030
1031    pub(super) async fn reload_database_runtime_info_impl(
1032        &self,
1033        database_id: DatabaseId,
1034    ) -> MetaResult<DatabaseRuntimeInfoSnapshot> {
1035        self.clean_dirty_streaming_jobs(Some(database_id))
1036            .await
1037            .context("clean dirty streaming jobs")?;
1038
1039        self.reset_sink_coordinator(Some(database_id))
1040            .await
1041            .context("reset sink coordinator")?;
1042        self.abort_dirty_pending_sink_state(Some(database_id))
1043            .await
1044            .context("abort dirty pending sink state")?;
1045        self.reregister_iceberg_pk_index_sinks(Some(database_id))
1046            .await
1047            .context("re-register iceberg v3 sinks after recovery")?;
1048
1049        // Background job progress needs to be recovered.
1050        tracing::info!(
1051            ?database_id,
1052            "recovering background job progress of database"
1053        );
1054
1055        let mut background_jobs = self
1056            .list_background_job_progress(Some(database_id))
1057            .await
1058            .context("recover background job progress of database should not fail")?;
1059        tracing::info!(?database_id, "recovered background job progress");
1060
1061        // This is a quick path to accelerate the process of dropping and canceling streaming jobs.
1062        let _ = self
1063            .apply_pre_applied_drop_cancel(Some(database_id))
1064            .await?;
1065
1066        let recovery_context = self.load_recovery_context(Some(database_id)).await?;
1067
1068        let missing_background_jobs = background_jobs
1069            .iter()
1070            .filter(|job_id| {
1071                !recovery_context
1072                    .fragment_context
1073                    .job_map
1074                    .contains_key(*job_id)
1075            })
1076            .copied()
1077            .collect_vec();
1078        if !missing_background_jobs.is_empty() {
1079            warn!(
1080                database_id = %database_id,
1081                missing_job_ids = ?missing_background_jobs,
1082                "background jobs missing in rendered info"
1083            );
1084        }
1085
1086        let (state_table_committed_epochs, state_table_log_epochs) = self
1087            .hummock_manager
1088            .on_current_version_and_table_change_log(|version, table_change_log| {
1089                Self::resolve_hummock_version_epochs(
1090                    background_jobs.iter().filter_map(|job_id| {
1091                        recovery_context
1092                            .fragment_context
1093                            .job_fragments
1094                            .get(job_id)
1095                            .map(|job| (*job_id, job))
1096                    }),
1097                    version,
1098                    table_change_log,
1099                )
1100            })
1101            .await?;
1102
1103        self.finish_completed_batch_refresh_background_jobs(
1104            &recovery_context,
1105            &state_table_committed_epochs,
1106            &mut background_jobs,
1107        )
1108        .await?;
1109
1110        let mv_depended_subscriptions = self
1111            .metadata_manager
1112            .get_mv_depended_subscriptions(Some(database_id))
1113            .await?;
1114
1115        let cdc_table_snapshot_splits =
1116            reload_cdc_table_snapshot_splits(&self.env.meta_store_ref().conn, Some(database_id))
1117                .await?;
1118
1119        self.refresh_manager
1120            .remove_trackers_by_database(database_id);
1121
1122        Ok(DatabaseRuntimeInfoSnapshot {
1123            recovery_context,
1124            state_table_committed_epochs,
1125            state_table_log_epochs,
1126            mv_depended_subscriptions,
1127            background_jobs,
1128            cdc_table_snapshot_splits,
1129        })
1130    }
1131}
1132
1133#[cfg(test)]
1134mod tests {
1135    use std::collections::HashMap;
1136
1137    use risingwave_common::catalog::FragmentTypeMask;
1138    use risingwave_common::id::WorkerId;
1139    use risingwave_meta_model::DispatcherType;
1140    use risingwave_meta_model::fragment::DistributionType;
1141    use risingwave_pb::stream_plan::stream_node::PbNodeBody;
1142    use risingwave_pb::stream_plan::{
1143        PbDispatchOutputMapping, PbStreamNode, UpstreamSinkUnionNode as PbUpstreamSinkUnionNode,
1144    };
1145
1146    use super::*;
1147    use crate::controller::fragment::InflightActorInfo;
1148    use crate::model::DownstreamFragmentRelation;
1149    use crate::stream::UpstreamSinkInfo;
1150
1151    #[test]
1152    fn test_recovery_table_with_upstream_sinks_updates_union_node() {
1153        let database_id = DatabaseId::new(1);
1154        let job_id = JobId::new(10);
1155        let fragment_id = FragmentId::new(100);
1156        let sink_fragment_id = FragmentId::new(200);
1157
1158        let mut inflight_jobs: FragmentRenderMap = HashMap::new();
1159        let fragment = InflightFragmentInfo {
1160            fragment_id,
1161            distribution_type: DistributionType::Hash,
1162            fragment_type_mask: FragmentTypeMask::empty(),
1163            vnode_count: 1,
1164            nodes: PbStreamNode {
1165                node_body: Some(PbNodeBody::UpstreamSinkUnion(Box::new(
1166                    PbUpstreamSinkUnionNode {
1167                        init_upstreams: vec![],
1168                    },
1169                ))),
1170                ..Default::default()
1171            },
1172            actors: HashMap::new(),
1173            state_table_ids: HashSet::new(),
1174        };
1175
1176        inflight_jobs
1177            .entry(database_id)
1178            .or_default()
1179            .entry(job_id)
1180            .or_default()
1181            .insert(fragment_id, fragment);
1182
1183        let upstream_sink_recovery = HashMap::from([(
1184            job_id,
1185            UpstreamSinkRecoveryInfo {
1186                target_fragment_id: fragment_id,
1187                upstream_infos: vec![UpstreamSinkInfo {
1188                    sink_id: SinkId::new(1),
1189                    sink_fragment_id,
1190                    sink_output_fields: vec![],
1191                    sink_original_target_columns: vec![],
1192                    project_exprs: vec![],
1193                    new_sink_downstream: DownstreamFragmentRelation {
1194                        downstream_fragment_id: FragmentId::new(300),
1195                        dispatcher_type: DispatcherType::Hash,
1196                        dist_key_indices: vec![],
1197                        output_mapping: PbDispatchOutputMapping::default(),
1198                    },
1199                }],
1200            },
1201        )]);
1202
1203        recovery_table_with_upstream_sinks(&mut inflight_jobs, &upstream_sink_recovery).unwrap();
1204
1205        let updated = inflight_jobs
1206            .get(&database_id)
1207            .unwrap()
1208            .get(&job_id)
1209            .unwrap()
1210            .get(&fragment_id)
1211            .unwrap();
1212
1213        let PbNodeBody::UpstreamSinkUnion(updated_union) =
1214            updated.nodes.node_body.as_ref().unwrap()
1215        else {
1216            panic!("expected upstream sink union node");
1217        };
1218
1219        assert_eq!(updated_union.init_upstreams.len(), 1);
1220        assert_eq!(
1221            updated_union.init_upstreams[0].upstream_fragment_id,
1222            sink_fragment_id.as_raw_id()
1223        );
1224    }
1225
1226    #[test]
1227    fn test_build_stream_actors_uses_preloaded_extra_info() {
1228        let database_id = DatabaseId::new(2);
1229        let job_id = JobId::new(20);
1230        let fragment_id = FragmentId::new(120);
1231        let actor_id = ActorId::new(500);
1232
1233        let mut inflight_jobs: FragmentRenderMap = HashMap::new();
1234        inflight_jobs
1235            .entry(database_id)
1236            .or_default()
1237            .entry(job_id)
1238            .or_default()
1239            .insert(
1240                fragment_id,
1241                InflightFragmentInfo {
1242                    fragment_id,
1243                    distribution_type: DistributionType::Hash,
1244                    fragment_type_mask: FragmentTypeMask::empty(),
1245                    vnode_count: 1,
1246                    nodes: PbStreamNode::default(),
1247                    actors: HashMap::from([(
1248                        actor_id,
1249                        InflightActorInfo {
1250                            worker_id: WorkerId::new(1),
1251                            vnode_bitmap: None,
1252                            splits: vec![],
1253                        },
1254                    )]),
1255                    state_table_ids: HashSet::new(),
1256                },
1257            );
1258
1259        let job_extra_info = HashMap::from([(
1260            job_id,
1261            StreamingJobExtraInfo {
1262                timezone: Some("UTC".to_owned()),
1263                config_override: "cfg".into(),
1264                job_definition: "definition".to_owned(),
1265                backfill_orders: None,
1266                refresh_interval_sec: None,
1267            },
1268        )]);
1269
1270        let stream_actors = build_stream_actors(&inflight_jobs, &job_extra_info).unwrap();
1271
1272        let actor = stream_actors.get(&actor_id).unwrap();
1273        assert_eq!(actor.actor_id, actor_id);
1274        assert_eq!(actor.fragment_id, fragment_id);
1275        assert_eq!(actor.mview_definition, "definition");
1276        assert_eq!(&*actor.config_override, "cfg");
1277        let expr_ctx = actor.expr_context.as_ref().unwrap();
1278        assert_eq!(expr_ctx.time_zone, "UTC");
1279    }
1280}