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        if database_id.is_some() {
436            // Per-database recovery does not run the global Hummock purge below. Unregister the
437            // dirty jobs cleaned in this database through the normal dropped-table cleanup path.
438            cleanup_dropped_streaming_jobs(
439                &self.refresh_manager,
440                &self.hummock_manager,
441                &self.metadata_manager,
442                cleaned_dirty_jobs.streaming_job_ids,
443                cleaned_dirty_jobs.dropped_table_ids,
444                "clean_dirty_creating_jobs",
445            )
446            .await?;
447        }
448        self.metadata_manager
449            .reset_all_refresh_jobs_to_idle()
450            .await?;
451
452        // unregister cleaned sources.
453        self.source_manager
454            .apply_source_change(SourceChange::DropSource {
455                dropped_source_ids: cleaned_dirty_jobs.source_ids,
456            })
457            .await;
458
459        Ok(())
460    }
461
462    async fn reset_sink_coordinator(&self, database_id: Option<DatabaseId>) -> MetaResult<()> {
463        if let Some(database_id) = database_id {
464            let sink_ids = self
465                .metadata_manager
466                .catalog_controller
467                .list_sink_ids(Some(database_id))
468                .await?;
469            self.sink_manager
470                .stop_sink_coordinator(sink_ids.clone())
471                .await;
472            self.iceberg_pk_index_sink_manager
473                .unregister_sinks(sink_ids);
474        } else {
475            self.sink_manager.reset().await;
476            self.iceberg_pk_index_sink_manager.reset();
477        }
478        Ok(())
479    }
480
481    /// Re-register iceberg pk-index sink commit coordinators after recovery wipes them.
482    async fn reregister_iceberg_pk_index_sinks(
483        &self,
484        database_id: Option<DatabaseId>,
485    ) -> MetaResult<()> {
486        let pb_sinks = self
487            .metadata_manager
488            .catalog_controller
489            .list_sinks()
490            .await?;
491        let mut futs = FuturesUnordered::new();
492        for pb_sink in pb_sinks {
493            if database_id.is_some_and(|db_id| pb_sink.database_id != db_id)
494                || !crate::manager::iceberg_pk_index_sink::is_iceberg_pk_index_sink(
495                    &pb_sink.properties,
496                )
497            {
498                continue;
499            }
500            let config = crate::manager::iceberg_pk_index_sink::build_iceberg_config(&pb_sink)
501                .with_context(|| {
502                    format!(
503                        "build iceberg config while re-registering v3 sink {}",
504                        pb_sink.id
505                    )
506                })?;
507            let manager = &self.iceberg_pk_index_sink_manager;
508            futs.push(async move { (pb_sink.id, manager.register_sink(pb_sink.id, config).await) });
509        }
510
511        while let Some((id, res)) = futs.next().await {
512            if let Err(e) = res {
513                let msg = format!("register iceberg v3 sink {} during recovery", id);
514                return Err(e.context(msg).into());
515            }
516        }
517        Ok(())
518    }
519
520    async fn abort_dirty_pending_sink_state(
521        &self,
522        database_id: Option<DatabaseId>,
523    ) -> MetaResult<()> {
524        let pending_sinks: HashSet<SinkId> = self
525            .metadata_manager
526            .catalog_controller
527            .list_all_pending_sinks(database_id)
528            .await?;
529
530        if pending_sinks.is_empty() {
531            return Ok(());
532        }
533
534        let sink_with_state_tables: HashMap<SinkId, Vec<TableId>> = self
535            .metadata_manager
536            .catalog_controller
537            .fetch_sink_with_state_table_ids(pending_sinks)
538            .await?;
539
540        let mut sink_committed_epoch: HashMap<SinkId, u64> = HashMap::new();
541
542        for (sink_id, table_ids) in sink_with_state_tables {
543            let Some(table_id) = table_ids.first() else {
544                return Err(anyhow!("no state table id in sink: {}", sink_id).into());
545            };
546
547            self.hummock_manager
548                .on_current_version(|version| -> MetaResult<()> {
549                    if let Some(committed_epoch) = version.table_committed_epoch(*table_id) {
550                        assert!(
551                            sink_committed_epoch
552                                .insert(sink_id, committed_epoch)
553                                .is_none()
554                        );
555                        Ok(())
556                    } else {
557                        Err(anyhow!("cannot get committed epoch on table {}.", table_id).into())
558                    }
559                })
560                .await?;
561        }
562
563        self.metadata_manager
564            .catalog_controller
565            .abort_pending_sink_epochs(sink_committed_epoch)
566            .await?;
567
568        Ok(())
569    }
570
571    async fn purge_state_table_from_hummock(
572        &self,
573        all_state_table_ids: &HashSet<TableId>,
574    ) -> MetaResult<()> {
575        self.hummock_manager.purge(all_state_table_ids).await?;
576        Ok(())
577    }
578
579    async fn list_background_job_progress(
580        &self,
581        database_id: Option<DatabaseId>,
582    ) -> MetaResult<HashSet<JobId>> {
583        let mgr = &self.metadata_manager;
584        mgr.catalog_controller
585            .list_background_creating_jobs(false, database_id)
586            .await
587    }
588
589    async fn load_recovery_context(
590        &self,
591        database_id: Option<DatabaseId>,
592    ) -> MetaResult<LoadedRecoveryContext> {
593        let inner = self
594            .metadata_manager
595            .catalog_controller
596            .get_inner_read_guard()
597            .await;
598        let txn = inner.db.begin().await?;
599
600        let fragment_context = self
601            .metadata_manager
602            .catalog_controller
603            .load_fragment_context_in_txn(&txn, database_id)
604            .await
605            .inspect_err(|err| {
606                warn!(error = %err.as_report(), "load fragment context failed");
607            })?;
608
609        if fragment_context.is_empty() {
610            return Ok(LoadedRecoveryContext::empty(fragment_context));
611        }
612
613        let job_ids = fragment_context.job_map.keys().copied().collect_vec();
614        let job_extra_info = self
615            .metadata_manager
616            .catalog_controller
617            .get_streaming_job_extra_info_in_txn(&txn, job_ids)
618            .await?;
619
620        let mut upstream_targets = HashMap::new();
621        for fragment in fragment_context
622            .job_fragments
623            .values()
624            .flat_map(|fragments| fragments.values())
625        {
626            let mut has_upstream_union = false;
627            visit_stream_node_cont(&fragment.nodes, |node| {
628                if let Some(PbNodeBody::UpstreamSinkUnion(_)) = node.node_body {
629                    has_upstream_union = true;
630                    false
631                } else {
632                    true
633                }
634            });
635
636            if has_upstream_union
637                && let Some(previous) =
638                    upstream_targets.insert(fragment.job_id, fragment.fragment_id)
639            {
640                bail!(
641                    "multiple upstream sink union fragments found for job {}, fragment {}, kept {}",
642                    fragment.job_id,
643                    fragment.fragment_id,
644                    previous
645                );
646            }
647        }
648
649        let mut upstream_sink_recovery = HashMap::new();
650        if !upstream_targets.is_empty() {
651            let tables = self
652                .metadata_manager
653                .catalog_controller
654                .get_user_created_table_by_ids_in_txn(&txn, upstream_targets.keys().copied())
655                .await?;
656
657            for table in tables {
658                let job_id = table.id.as_job_id();
659                let Some(target_fragment_id) = upstream_targets.get(&job_id) else {
660                    // This should not happen unless catalog changes or legacy metadata are involved.
661                    tracing::debug!(
662                        job_id = %job_id,
663                        "upstream sink union target fragment not found for table"
664                    );
665                    continue;
666                };
667
668                let upstream_infos = self
669                    .metadata_manager
670                    .catalog_controller
671                    .get_all_upstream_sink_infos_in_txn(&txn, &table, *target_fragment_id as _)
672                    .await?;
673
674                upstream_sink_recovery.insert(
675                    job_id,
676                    UpstreamSinkRecoveryInfo {
677                        target_fragment_id: *target_fragment_id,
678                        upstream_infos,
679                    },
680                );
681            }
682        }
683
684        let fragment_relations = self
685            .metadata_manager
686            .catalog_controller
687            .get_fragment_downstream_relations_in_txn(
688                &txn,
689                fragment_context
690                    .job_fragments
691                    .values()
692                    .flat_map(|fragments| fragments.keys().copied())
693                    .collect_vec(),
694            )
695            .await?;
696
697        Ok(LoadedRecoveryContext {
698            fragment_context,
699            job_extra_info,
700            upstream_sink_recovery,
701            fragment_relations,
702        })
703    }
704
705    #[expect(clippy::type_complexity)]
706    fn resolve_hummock_version_epochs(
707        background_jobs: impl Iterator<Item = (JobId, &HashMap<FragmentId, LoadedFragment>)>,
708        version: &HummockVersion,
709        table_change_log: &TableChangeLogs,
710    ) -> MetaResult<(
711        HashMap<TableId, u64>,
712        HashMap<TableId, Vec<(Vec<u64>, u64)>>,
713    )> {
714        let table_committed_epoch: HashMap<_, _> = version
715            .state_table_info
716            .info()
717            .iter()
718            .map(|(table_id, info)| (*table_id, info.committed_epoch))
719            .collect();
720        let get_table_committed_epoch = |table_id| -> anyhow::Result<u64> {
721            Ok(*table_committed_epoch
722                .get(&table_id)
723                .ok_or_else(|| anyhow!("cannot get committed epoch on table {}.", table_id))?)
724        };
725        let mut min_downstream_committed_epochs = HashMap::new();
726        for (job_id, fragments) in background_jobs {
727            let job_committed_epoch =
728                Self::resolve_job_committed_epoch(job_id, fragments, &table_committed_epoch)?;
729            if let (Some(snapshot_backfill_info), _) =
730                StreamFragmentGraph::collect_snapshot_backfill_info_impl(
731                    fragments
732                        .values()
733                        .map(|fragment| (&fragment.nodes, fragment.fragment_type_mask)),
734                )?
735            {
736                for (upstream_table, snapshot_epoch) in
737                    snapshot_backfill_info.upstream_mv_table_id_to_backfill_epoch
738                {
739                    let snapshot_epoch = snapshot_epoch.ok_or_else(|| {
740                        anyhow!(
741                            "recovered snapshot backfill job {} has not filled snapshot epoch to upstream {}",
742                            job_id, upstream_table
743                        )
744                    })?;
745                    let pinned_epoch = max(snapshot_epoch, job_committed_epoch);
746                    match min_downstream_committed_epochs.entry(upstream_table) {
747                        Entry::Occupied(entry) => {
748                            let prev_min_epoch = entry.into_mut();
749                            *prev_min_epoch = min(*prev_min_epoch, pinned_epoch);
750                        }
751                        Entry::Vacant(entry) => {
752                            entry.insert(pinned_epoch);
753                        }
754                    }
755                }
756            }
757        }
758        let mut log_epochs = HashMap::new();
759        for (upstream_table_id, downstream_committed_epoch) in min_downstream_committed_epochs {
760            let upstream_committed_epoch = get_table_committed_epoch(upstream_table_id)?;
761            match upstream_committed_epoch.cmp(&downstream_committed_epoch) {
762                Ordering::Less => {
763                    bail!(
764                        "downstream epoch {} later than upstream epoch {} of table {}",
765                        downstream_committed_epoch,
766                        upstream_committed_epoch,
767                        upstream_table_id
768                    );
769                }
770                Ordering::Equal => {
771                    continue;
772                }
773                Ordering::Greater => {
774                    if let Some(table_change_log) = table_change_log.get(&upstream_table_id) {
775                        let epochs = table_change_log
776                            .filter_epoch((downstream_committed_epoch, upstream_committed_epoch))
777                            .map(|epoch_log| {
778                                (
779                                    epoch_log.non_checkpoint_epochs.clone(),
780                                    epoch_log.checkpoint_epoch,
781                                )
782                            })
783                            .collect_vec();
784                        let first_epochs = epochs.first();
785                        if let Some((_, first_checkpoint_epoch)) = &first_epochs
786                            && *first_checkpoint_epoch == downstream_committed_epoch
787                        {
788                        } else {
789                            bail!(
790                                "resolved first log epoch {:?} on table {} not matched with downstream committed epoch {}",
791                                epochs,
792                                upstream_table_id,
793                                downstream_committed_epoch
794                            );
795                        }
796                        log_epochs
797                            .try_insert(upstream_table_id, epochs)
798                            .expect("non-duplicated");
799                    } else {
800                        bail!(
801                            "upstream table {} on epoch {} has lagged downstream on epoch {} but no table change log",
802                            upstream_table_id,
803                            upstream_committed_epoch,
804                            downstream_committed_epoch
805                        );
806                    }
807                }
808            }
809        }
810        Ok((table_committed_epoch, log_epochs))
811    }
812
813    pub(super) async fn reload_runtime_info_impl(
814        &self,
815    ) -> MetaResult<BarrierWorkerRuntimeInfoSnapshot> {
816        {
817            {
818                {
819                    self.clean_dirty_streaming_jobs(None)
820                        .await
821                        .context("clean dirty streaming jobs")?;
822
823                    self.reset_sink_coordinator(None)
824                        .await
825                        .context("reset sink coordinator")?;
826                    self.abort_dirty_pending_sink_state(None)
827                        .await
828                        .context("abort dirty pending sink state")?;
829
830                    // We must abort dirty pending sink state before registering iceberg pk-index sinks,
831                    // otherwise recover_pending will take speculative (epoch > committed epoch) pending sink state
832                    // as valid and cause duplicated iceberg commit.
833                    self.reregister_iceberg_pk_index_sinks(None)
834                        .await
835                        .context("re-register iceberg v3 sinks after recovery")?;
836
837                    // Background job progress needs to be recovered.
838                    tracing::info!("recovering background job progress");
839                    let mut initial_background_jobs = self
840                        .list_background_job_progress(None)
841                        .await
842                        .context("recover background job progress should not fail")?;
843
844                    tracing::info!("recovered background job progress");
845
846                    // This is a quick path to accelerate the process of dropping and canceling streaming jobs.
847                    let _ = self.apply_pre_applied_drop_cancel(None).await?;
848                    self.metadata_manager
849                        .catalog_controller
850                        .cleanup_dropped_tables()
851                        .await;
852
853                    let active_streaming_nodes =
854                        ActiveStreamingWorkerNodes::new_snapshot(self.metadata_manager.clone())
855                            .await?;
856
857                    let background_streaming_jobs =
858                        initial_background_jobs.iter().cloned().collect_vec();
859
860                    tracing::info!(
861                        "background streaming jobs: {:?} total {}",
862                        background_streaming_jobs,
863                        background_streaming_jobs.len()
864                    );
865
866                    let unreschedulable_jobs = {
867                        let mut unreschedulable_jobs = HashSet::new();
868
869                        for job_id in background_streaming_jobs {
870                            let scan_types = self
871                                .metadata_manager
872                                .get_job_backfill_scan_types(job_id)
873                                .await?;
874
875                            if scan_types
876                                .values()
877                                .any(|scan_type| !scan_type.is_reschedulable(false))
878                            {
879                                unreschedulable_jobs.insert(job_id);
880                            }
881                        }
882
883                        unreschedulable_jobs
884                    };
885
886                    if !unreschedulable_jobs.is_empty() {
887                        info!(
888                            "unreschedulable background jobs: {:?}",
889                            unreschedulable_jobs
890                        );
891                    }
892
893                    // Resolve actor info for recovery. If there's no actor to recover, most of the
894                    // following steps will be no-op, while the compute nodes will still be reset.
895                    // TODO(error-handling): attach context to the errors and log them together, instead of inspecting everywhere.
896                    if !unreschedulable_jobs.is_empty() {
897                        bail!(
898                            "Recovery for unreschedulable background jobs is not yet implemented. \
899                             This path is triggered when the following jobs have at least one scan type that is not reschedulable: {:?}.",
900                            unreschedulable_jobs
901                        );
902                    }
903
904                    let mut recovery_context = self.load_recovery_context(None).await?;
905                    if self.apply_pre_applied_drop_cancel(None).await? {
906                        recovery_context = self.load_recovery_context(None).await?;
907                    }
908
909                    self.purge_state_table_from_hummock(
910                        &recovery_context
911                            .fragment_context
912                            .job_fragments
913                            .values()
914                            .flat_map(|fragments| fragments.values())
915                            .flat_map(|fragment| fragment.state_table_ids.iter().copied())
916                            .collect(),
917                    )
918                    .await
919                    .context("purge state table from hummock")?;
920
921                    let (state_table_committed_epochs, state_table_log_epochs) = self
922                        .hummock_manager
923                        .on_current_version_and_table_change_log(|version, table_change_log| {
924                            Self::resolve_hummock_version_epochs(
925                                recovery_context
926                                    .fragment_context
927                                    .job_fragments
928                                    .iter()
929                                    .filter_map(|(job_id, job)| {
930                                        initial_background_jobs
931                                            .contains(job_id)
932                                            .then_some((*job_id, job))
933                                    }),
934                                version,
935                                table_change_log,
936                            )
937                        })
938                        .await?;
939
940                    self.finish_completed_batch_refresh_background_jobs(
941                        &recovery_context,
942                        &state_table_committed_epochs,
943                        &mut initial_background_jobs,
944                    )
945                    .await?;
946
947                    let mv_depended_subscriptions = self
948                        .metadata_manager
949                        .get_mv_depended_subscriptions(None)
950                        .await?;
951
952                    // Refresh background job progress for the final snapshot to reflect any catalog changes.
953                    let background_jobs = {
954                        let mut refreshed_background_jobs = self
955                            .list_background_job_progress(None)
956                            .await
957                            .context("recover background job progress should not fail")?;
958                        recovery_context
959                            .fragment_context
960                            .job_map
961                            .keys()
962                            .filter_map(|job_id| {
963                                refreshed_background_jobs.remove(job_id).then_some(*job_id)
964                            })
965                            .collect()
966                    };
967
968                    let database_infos = self
969                        .metadata_manager
970                        .catalog_controller
971                        .list_databases()
972                        .await?;
973
974                    let cdc_table_snapshot_splits =
975                        reload_cdc_table_snapshot_splits(&self.env.meta_store_ref().conn, None)
976                            .await?;
977
978                    Ok(BarrierWorkerRuntimeInfoSnapshot {
979                        active_streaming_nodes,
980                        recovery_context,
981                        state_table_committed_epochs,
982                        state_table_log_epochs,
983                        mv_depended_subscriptions,
984                        background_jobs,
985                        hummock_version_stats: self.hummock_manager.get_version_stats().await,
986                        database_infos,
987                        cdc_table_snapshot_splits,
988                    })
989                }
990            }
991        }
992    }
993
994    pub(super) async fn reload_database_runtime_info_impl(
995        &self,
996        database_id: DatabaseId,
997    ) -> MetaResult<DatabaseRuntimeInfoSnapshot> {
998        self.clean_dirty_streaming_jobs(Some(database_id))
999            .await
1000            .context("clean dirty streaming jobs")?;
1001
1002        self.reset_sink_coordinator(Some(database_id))
1003            .await
1004            .context("reset sink coordinator")?;
1005        self.abort_dirty_pending_sink_state(Some(database_id))
1006            .await
1007            .context("abort dirty pending sink state")?;
1008        self.reregister_iceberg_pk_index_sinks(Some(database_id))
1009            .await
1010            .context("re-register iceberg v3 sinks after recovery")?;
1011
1012        // Background job progress needs to be recovered.
1013        tracing::info!(
1014            ?database_id,
1015            "recovering background job progress of database"
1016        );
1017
1018        let mut background_jobs = self
1019            .list_background_job_progress(Some(database_id))
1020            .await
1021            .context("recover background job progress of database should not fail")?;
1022        tracing::info!(?database_id, "recovered background job progress");
1023
1024        // This is a quick path to accelerate the process of dropping and canceling streaming jobs.
1025        let _ = self
1026            .apply_pre_applied_drop_cancel(Some(database_id))
1027            .await?;
1028
1029        let recovery_context = self.load_recovery_context(Some(database_id)).await?;
1030
1031        let missing_background_jobs = background_jobs
1032            .iter()
1033            .filter(|job_id| {
1034                !recovery_context
1035                    .fragment_context
1036                    .job_map
1037                    .contains_key(*job_id)
1038            })
1039            .copied()
1040            .collect_vec();
1041        if !missing_background_jobs.is_empty() {
1042            warn!(
1043                database_id = %database_id,
1044                missing_job_ids = ?missing_background_jobs,
1045                "background jobs missing in rendered info"
1046            );
1047        }
1048
1049        let (state_table_committed_epochs, state_table_log_epochs) = self
1050            .hummock_manager
1051            .on_current_version_and_table_change_log(|version, table_change_log| {
1052                Self::resolve_hummock_version_epochs(
1053                    background_jobs.iter().filter_map(|job_id| {
1054                        recovery_context
1055                            .fragment_context
1056                            .job_fragments
1057                            .get(job_id)
1058                            .map(|job| (*job_id, job))
1059                    }),
1060                    version,
1061                    table_change_log,
1062                )
1063            })
1064            .await?;
1065
1066        self.finish_completed_batch_refresh_background_jobs(
1067            &recovery_context,
1068            &state_table_committed_epochs,
1069            &mut background_jobs,
1070        )
1071        .await?;
1072
1073        let mv_depended_subscriptions = self
1074            .metadata_manager
1075            .get_mv_depended_subscriptions(Some(database_id))
1076            .await?;
1077
1078        let cdc_table_snapshot_splits =
1079            reload_cdc_table_snapshot_splits(&self.env.meta_store_ref().conn, Some(database_id))
1080                .await?;
1081
1082        self.refresh_manager
1083            .remove_trackers_by_database(database_id);
1084
1085        Ok(DatabaseRuntimeInfoSnapshot {
1086            recovery_context,
1087            state_table_committed_epochs,
1088            state_table_log_epochs,
1089            mv_depended_subscriptions,
1090            background_jobs,
1091            cdc_table_snapshot_splits,
1092        })
1093    }
1094}
1095
1096#[cfg(test)]
1097mod tests {
1098    use std::collections::HashMap;
1099
1100    use risingwave_common::catalog::FragmentTypeMask;
1101    use risingwave_common::id::WorkerId;
1102    use risingwave_meta_model::DispatcherType;
1103    use risingwave_meta_model::fragment::DistributionType;
1104    use risingwave_pb::stream_plan::stream_node::PbNodeBody;
1105    use risingwave_pb::stream_plan::{
1106        PbDispatchOutputMapping, PbStreamNode, UpstreamSinkUnionNode as PbUpstreamSinkUnionNode,
1107    };
1108
1109    use super::*;
1110    use crate::controller::fragment::InflightActorInfo;
1111    use crate::model::DownstreamFragmentRelation;
1112    use crate::stream::UpstreamSinkInfo;
1113
1114    #[test]
1115    fn test_recovery_table_with_upstream_sinks_updates_union_node() {
1116        let database_id = DatabaseId::new(1);
1117        let job_id = JobId::new(10);
1118        let fragment_id = FragmentId::new(100);
1119        let sink_fragment_id = FragmentId::new(200);
1120
1121        let mut inflight_jobs: FragmentRenderMap = HashMap::new();
1122        let fragment = InflightFragmentInfo {
1123            fragment_id,
1124            distribution_type: DistributionType::Hash,
1125            fragment_type_mask: FragmentTypeMask::empty(),
1126            vnode_count: 1,
1127            nodes: PbStreamNode {
1128                node_body: Some(PbNodeBody::UpstreamSinkUnion(Box::new(
1129                    PbUpstreamSinkUnionNode {
1130                        init_upstreams: vec![],
1131                    },
1132                ))),
1133                ..Default::default()
1134            },
1135            actors: HashMap::new(),
1136            state_table_ids: HashSet::new(),
1137        };
1138
1139        inflight_jobs
1140            .entry(database_id)
1141            .or_default()
1142            .entry(job_id)
1143            .or_default()
1144            .insert(fragment_id, fragment);
1145
1146        let upstream_sink_recovery = HashMap::from([(
1147            job_id,
1148            UpstreamSinkRecoveryInfo {
1149                target_fragment_id: fragment_id,
1150                upstream_infos: vec![UpstreamSinkInfo {
1151                    sink_id: SinkId::new(1),
1152                    sink_fragment_id,
1153                    sink_output_fields: vec![],
1154                    sink_original_target_columns: vec![],
1155                    project_exprs: vec![],
1156                    new_sink_downstream: DownstreamFragmentRelation {
1157                        downstream_fragment_id: FragmentId::new(300),
1158                        dispatcher_type: DispatcherType::Hash,
1159                        dist_key_indices: vec![],
1160                        output_mapping: PbDispatchOutputMapping::default(),
1161                    },
1162                }],
1163            },
1164        )]);
1165
1166        recovery_table_with_upstream_sinks(&mut inflight_jobs, &upstream_sink_recovery).unwrap();
1167
1168        let updated = inflight_jobs
1169            .get(&database_id)
1170            .unwrap()
1171            .get(&job_id)
1172            .unwrap()
1173            .get(&fragment_id)
1174            .unwrap();
1175
1176        let PbNodeBody::UpstreamSinkUnion(updated_union) =
1177            updated.nodes.node_body.as_ref().unwrap()
1178        else {
1179            panic!("expected upstream sink union node");
1180        };
1181
1182        assert_eq!(updated_union.init_upstreams.len(), 1);
1183        assert_eq!(
1184            updated_union.init_upstreams[0].upstream_fragment_id,
1185            sink_fragment_id.as_raw_id()
1186        );
1187    }
1188
1189    #[test]
1190    fn test_build_stream_actors_uses_preloaded_extra_info() {
1191        let database_id = DatabaseId::new(2);
1192        let job_id = JobId::new(20);
1193        let fragment_id = FragmentId::new(120);
1194        let actor_id = ActorId::new(500);
1195
1196        let mut inflight_jobs: FragmentRenderMap = HashMap::new();
1197        inflight_jobs
1198            .entry(database_id)
1199            .or_default()
1200            .entry(job_id)
1201            .or_default()
1202            .insert(
1203                fragment_id,
1204                InflightFragmentInfo {
1205                    fragment_id,
1206                    distribution_type: DistributionType::Hash,
1207                    fragment_type_mask: FragmentTypeMask::empty(),
1208                    vnode_count: 1,
1209                    nodes: PbStreamNode::default(),
1210                    actors: HashMap::from([(
1211                        actor_id,
1212                        InflightActorInfo {
1213                            worker_id: WorkerId::new(1),
1214                            vnode_bitmap: None,
1215                            splits: vec![],
1216                        },
1217                    )]),
1218                    state_table_ids: HashSet::new(),
1219                },
1220            );
1221
1222        let job_extra_info = HashMap::from([(
1223            job_id,
1224            StreamingJobExtraInfo {
1225                timezone: Some("UTC".to_owned()),
1226                config_override: "cfg".into(),
1227                job_definition: "definition".to_owned(),
1228                backfill_orders: None,
1229                refresh_interval_sec: None,
1230            },
1231        )]);
1232
1233        let stream_actors = build_stream_actors(&inflight_jobs, &job_extra_info).unwrap();
1234
1235        let actor = stream_actors.get(&actor_id).unwrap();
1236        assert_eq!(actor.actor_id, actor_id);
1237        assert_eq!(actor.fragment_id, fragment_id);
1238        assert_eq!(actor.mview_definition, "definition");
1239        assert_eq!(&*actor.config_override, "cfg");
1240        let expr_ctx = actor.expr_context.as_ref().unwrap();
1241        assert_eq!(expr_ctx.time_zone, "UTC");
1242    }
1243}