meta_srv/metasrv/
builder.rs

1// Copyright 2023 Greptime Team
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::path::Path;
16use std::sync::atomic::AtomicBool;
17use std::sync::{Arc, Mutex, RwLock};
18use std::time::Duration;
19
20use client::client_manager::NodeClients;
21use client::inserter::InsertOptions;
22use common_base::Plugins;
23use common_catalog::consts::{MIN_USER_FLOW_ID, MIN_USER_TABLE_ID};
24use common_event_recorder::{DEFAULT_COMPACTION_TIME_WINDOW, EventRecorderImpl, EventRecorderRef};
25use common_meta::ddl::flow_meta::FlowMetadataAllocator;
26use common_meta::ddl::table_meta::{TableMetadataAllocator, TableMetadataAllocatorRef};
27use common_meta::ddl::{
28    DdlContext, NoopRegionFailureDetectorControl, RegionFailureDetectorControllerRef,
29};
30use common_meta::ddl_manager::{
31    DdlManager, DdlManagerConfiguratorRef, RepartitionProcedureFactoryRef,
32};
33use common_meta::distributed_time_constants::default_distributed_time_constants;
34use common_meta::key::TableMetadataManager;
35use common_meta::key::flow::FlowMetadataManager;
36use common_meta::key::flow::flow_state::FlowStateManager;
37use common_meta::key::runtime_switch::{RuntimeSwitchManager, RuntimeSwitchManagerRef};
38use common_meta::kv_backend::memory::MemoryKvBackend;
39use common_meta::kv_backend::{KvBackendRef, ResettableKvBackendRef};
40use common_meta::node_manager::NodeManagerRef;
41use common_meta::reconciliation::manager::ReconciliationManager;
42use common_meta::region_keeper::MemoryRegionKeeper;
43use common_meta::region_registry::LeaderRegionRegistry;
44use common_meta::sequence::SequenceBuilder;
45use common_meta::state_store::KvStateStore;
46use common_meta::stats::topic::TopicStatsRegistry;
47use common_meta::wal_provider::{build_kafka_client, build_wal_provider};
48use common_procedure::ProcedureManagerRef;
49use common_procedure::local::{LocalManager, ManagerConfig};
50use common_stat::ResourceStatImpl;
51use common_telemetry::{info, warn};
52use snafu::{ResultExt, ensure};
53use store_api::storage::MAX_REGION_SEQ;
54
55use crate::bootstrap::build_default_meta_peer_client;
56use crate::cache_invalidator::MetasrvCacheInvalidator;
57use crate::cluster::MetaPeerClientRef;
58use crate::error::{self, BuildWalProviderSnafu, OtherSnafu, Result};
59use crate::event::EventHandlerImpl;
60use crate::gc::{DefaultGcSchedulerCtx, GcScheduler};
61use crate::greptimedb_telemetry::get_greptimedb_telemetry_task;
62use crate::handler::failure_handler::RegionFailureHandler;
63use crate::handler::flow_state_handler::FlowStateHandler;
64use crate::handler::persist_stats_handler::PersistStatsHandler;
65use crate::handler::region_lease_handler::{CustomizedRegionLeaseRenewerRef, RegionLeaseHandler};
66use crate::handler::{HeartbeatHandlerGroupBuilder, HeartbeatMailbox, Pushers};
67use crate::metasrv::{
68    ElectionRef, FLOW_ID_SEQ, METASRV_DATA_DIR, Metasrv, MetasrvInfo, MetasrvOptions,
69    RegionStatAwareSelectorRef, SelectTarget, SelectorContext, SelectorRef, TABLE_ID_SEQ,
70};
71use crate::peer::MetasrvPeerAllocator;
72use crate::procedure::region_migration::DefaultContextFactory;
73use crate::procedure::region_migration::manager::RegionMigrationManager;
74use crate::procedure::repartition::gc_requirement::RepartitionGcRequirementManager;
75use crate::procedure::repartition::{
76    DefaultRepartitionProcedureFactory, GcDisabledRepartitionProcedureFactory,
77};
78use crate::procedure::wal_prune::Context as WalPruneContext;
79use crate::procedure::wal_prune::manager::{WalPruneManager, WalPruneTicker};
80use crate::region::flush_trigger::RegionFlushTrigger;
81use crate::region::supervisor::{
82    DEFAULT_INITIALIZATION_RETRY_PERIOD, DEFAULT_TICK_INTERVAL, HeartbeatAcceptor,
83    RegionFailureDetectorControl, RegionSupervisor, RegionSupervisorSelector,
84    RegionSupervisorTicker,
85};
86use crate::selector::lease_based::LeaseBasedSelector;
87use crate::selector::round_robin::RoundRobinSelector;
88use crate::service::mailbox::MailboxRef;
89use crate::service::store::cached_kv::LeaderCachedKvBackend;
90use crate::state::State;
91use crate::utils::database::DatabaseOperator;
92use crate::utils::insert_forwarder::InsertForwarder;
93
94/// The time window for twcs compaction of the region stats table.
95const REGION_STATS_TABLE_TWCS_COMPACTION_TIME_WINDOW: Duration = Duration::from_days(1);
96
97// TODO(fys): try use derive_builder macro
98pub struct MetasrvBuilder {
99    options: Option<MetasrvOptions>,
100    kv_backend: Option<KvBackendRef>,
101    in_memory: Option<ResettableKvBackendRef>,
102    selector: Option<SelectorRef>,
103    handler_group_builder: Option<HeartbeatHandlerGroupBuilder>,
104    election: Option<ElectionRef>,
105    meta_peer_client: Option<MetaPeerClientRef>,
106    node_manager: Option<NodeManagerRef>,
107    plugins: Option<Plugins>,
108    table_metadata_allocator: Option<TableMetadataAllocatorRef>,
109}
110
111impl MetasrvBuilder {
112    pub fn new() -> Self {
113        Self {
114            kv_backend: None,
115            in_memory: None,
116            selector: None,
117            handler_group_builder: None,
118            meta_peer_client: None,
119            election: None,
120            options: None,
121            node_manager: None,
122            plugins: None,
123            table_metadata_allocator: None,
124        }
125    }
126
127    pub fn options(mut self, options: MetasrvOptions) -> Self {
128        self.options = Some(options);
129        self
130    }
131
132    pub fn kv_backend(mut self, kv_backend: KvBackendRef) -> Self {
133        self.kv_backend = Some(kv_backend);
134        self
135    }
136
137    pub fn in_memory(mut self, in_memory: ResettableKvBackendRef) -> Self {
138        self.in_memory = Some(in_memory);
139        self
140    }
141
142    pub fn selector(mut self, selector: SelectorRef) -> Self {
143        self.selector = Some(selector);
144        self
145    }
146
147    pub fn heartbeat_handler(
148        mut self,
149        handler_group_builder: HeartbeatHandlerGroupBuilder,
150    ) -> Self {
151        self.handler_group_builder = Some(handler_group_builder);
152        self
153    }
154
155    pub fn meta_peer_client(mut self, meta_peer_client: MetaPeerClientRef) -> Self {
156        self.meta_peer_client = Some(meta_peer_client);
157        self
158    }
159
160    pub fn election(mut self, election: Option<ElectionRef>) -> Self {
161        self.election = election;
162        self
163    }
164
165    pub fn node_manager(mut self, node_manager: NodeManagerRef) -> Self {
166        self.node_manager = Some(node_manager);
167        self
168    }
169
170    pub fn plugins(mut self, plugins: Plugins) -> Self {
171        self.plugins = Some(plugins);
172        self
173    }
174
175    pub fn table_metadata_allocator(
176        mut self,
177        table_metadata_allocator: TableMetadataAllocatorRef,
178    ) -> Self {
179        self.table_metadata_allocator = Some(table_metadata_allocator);
180        self
181    }
182
183    pub fn options_ref(&self) -> Option<&MetasrvOptions> {
184        self.options.as_ref()
185    }
186
187    pub fn kv_backend_ref(&self) -> Option<&KvBackendRef> {
188        self.kv_backend.as_ref()
189    }
190
191    pub fn in_memory_ref(&self) -> Option<&ResettableKvBackendRef> {
192        self.in_memory.as_ref()
193    }
194
195    pub fn election_ref(&self) -> Option<&ElectionRef> {
196        self.election.as_ref()
197    }
198
199    pub fn meta_peer_client_ref(&self) -> Option<&MetaPeerClientRef> {
200        self.meta_peer_client.as_ref()
201    }
202
203    pub fn node_manager_ref(&self) -> Option<&NodeManagerRef> {
204        self.node_manager.as_ref()
205    }
206
207    pub async fn build(self) -> Result<Metasrv> {
208        let MetasrvBuilder {
209            election,
210            meta_peer_client,
211            options,
212            kv_backend,
213            in_memory,
214            selector,
215            handler_group_builder,
216            node_manager,
217            plugins,
218            table_metadata_allocator,
219        } = self;
220
221        let options = options.unwrap_or_default();
222        options.gc.validate()?;
223
224        let kv_backend = kv_backend.unwrap_or_else(|| Arc::new(MemoryKvBackend::new()));
225        let in_memory = in_memory.unwrap_or_else(|| Arc::new(MemoryKvBackend::new()));
226
227        let state = Arc::new(RwLock::new(match election {
228            None => State::leader(options.grpc.server_addr.clone(), true),
229            Some(_) => State::follower(options.grpc.server_addr.clone()),
230        }));
231
232        let leader_cached_kv_backend = Arc::new(LeaderCachedKvBackend::new(
233            state.clone(),
234            kv_backend.clone(),
235        ));
236
237        let meta_peer_client = meta_peer_client
238            .unwrap_or_else(|| build_default_meta_peer_client(&election, &in_memory));
239        let database_operator = Arc::new(DatabaseOperator::new(meta_peer_client.clone()));
240
241        let event_inserter = Box::new(InsertForwarder::new(
242            database_operator.clone(),
243            Some(InsertOptions {
244                ttl: options.event_recorder.ttl,
245                append_mode: true,
246                twcs_compaction_time_window: Some(DEFAULT_COMPACTION_TIME_WINDOW),
247            }),
248        ));
249        // Builds the event recorder to record important events and persist them as the system table.
250        let event_recorder = Arc::new(EventRecorderImpl::with_event_type_filter(
251            Box::new(EventHandlerImpl::new(event_inserter)),
252            options.event_recorder.event_types.clone(),
253        ));
254
255        let selector = selector.unwrap_or_else(|| Arc::new(LeaseBasedSelector));
256        let pushers = Pushers::default();
257        let mailbox = build_mailbox(&kv_backend, &pushers);
258        let runtime_switch_manager = Arc::new(RuntimeSwitchManager::new(kv_backend.clone()));
259        let repartition_gc_requirement_manager =
260            Arc::new(RepartitionGcRequirementManager::new(kv_backend.clone()));
261        let procedure_manager = build_procedure_manager(
262            &options,
263            &kv_backend,
264            &runtime_switch_manager,
265            event_recorder,
266        );
267
268        let table_metadata_manager = Arc::new(TableMetadataManager::new(
269            leader_cached_kv_backend.clone() as _,
270        ));
271        let flow_metadata_manager = Arc::new(FlowMetadataManager::new(
272            leader_cached_kv_backend.clone() as _,
273        ));
274
275        let selector_ctx = SelectorContext {
276            peer_discovery: meta_peer_client.clone(),
277        };
278
279        let wal_provider = build_wal_provider(&options.wal, kv_backend.clone())
280            .await
281            .context(BuildWalProviderSnafu)?;
282        let wal_provider = Arc::new(wal_provider);
283        let is_remote_wal = wal_provider.is_remote_wal();
284        let table_metadata_allocator = table_metadata_allocator.unwrap_or_else(|| {
285            let sequence = Arc::new(
286                SequenceBuilder::new(TABLE_ID_SEQ, kv_backend.clone())
287                    .initial(MIN_USER_TABLE_ID as u64)
288                    .step(10)
289                    .build(),
290            );
291            let peer_allocator = Arc::new(
292                MetasrvPeerAllocator::new(selector_ctx.clone(), selector.clone())
293                    .with_max_items(MAX_REGION_SEQ),
294            );
295            Arc::new(TableMetadataAllocator::with_peer_allocator(
296                sequence,
297                wal_provider.clone(),
298                peer_allocator,
299            ))
300        });
301        let table_id_allocator = table_metadata_allocator.table_id_allocator();
302
303        let flow_selector =
304            Arc::new(RoundRobinSelector::new(SelectTarget::Flownode)) as SelectorRef;
305
306        let flow_metadata_allocator = {
307            // for now flownode just use round-robin selector
308            let flow_selector_ctx = selector_ctx.clone();
309            let peer_allocator = Arc::new(MetasrvPeerAllocator::new(
310                flow_selector_ctx,
311                flow_selector.clone(),
312            ));
313            let seq = Arc::new(
314                SequenceBuilder::new(FLOW_ID_SEQ, kv_backend.clone())
315                    .initial(MIN_USER_FLOW_ID as u64)
316                    .step(10)
317                    .build(),
318            );
319
320            Arc::new(FlowMetadataAllocator::with_peer_allocator(
321                seq,
322                peer_allocator,
323            ))
324        };
325        let flow_state_handler =
326            FlowStateHandler::new(FlowStateManager::new(in_memory.clone().as_kv_backend_ref()));
327
328        let memory_region_keeper = Arc::new(MemoryRegionKeeper::default());
329        let node_manager = node_manager.unwrap_or_else(|| {
330            let datanode_client_channel_config = options.datanode.client.channel_config();
331            Arc::new(NodeClients::new(datanode_client_channel_config))
332        });
333        let cache_invalidator = Arc::new(MetasrvCacheInvalidator::new(
334            mailbox.clone(),
335            MetasrvInfo {
336                server_addr: options.grpc.server_addr.clone(),
337            },
338        ));
339
340        if !is_remote_wal && options.enable_region_failover {
341            ensure!(
342                options.allow_region_failover_on_local_wal,
343                error::UnexpectedSnafu {
344                    violated: "Region failover is not supported in the local WAL implementation!
345                    If you want to enable region failover for local WAL, please set `allow_region_failover_on_local_wal` to true.",
346                }
347            );
348            if options.allow_region_failover_on_local_wal {
349                warn!(
350                    "Region failover is force enabled in the local WAL implementation! This may lead to data loss during failover!"
351                );
352            }
353        }
354
355        let (tx, rx) = RegionSupervisor::channel();
356        let (region_failure_detector_controller, region_supervisor_ticker): (
357            RegionFailureDetectorControllerRef,
358            Option<std::sync::Arc<RegionSupervisorTicker>>,
359        ) = if options.enable_region_failover {
360            (
361                Arc::new(RegionFailureDetectorControl::new(tx.clone())) as _,
362                Some(Arc::new(RegionSupervisorTicker::new(
363                    DEFAULT_TICK_INTERVAL,
364                    options.region_failure_detector_initialization_delay,
365                    DEFAULT_INITIALIZATION_RETRY_PERIOD,
366                    tx.clone(),
367                ))),
368            )
369        } else {
370            (Arc::new(NoopRegionFailureDetectorControl) as _, None as _)
371        };
372
373        // region migration manager
374        let region_migration_manager = Arc::new(RegionMigrationManager::new(
375            procedure_manager.clone(),
376            DefaultContextFactory::new(
377                in_memory.clone(),
378                table_metadata_manager.clone(),
379                memory_region_keeper.clone(),
380                region_failure_detector_controller.clone(),
381                mailbox.clone(),
382                options.grpc.server_addr.clone(),
383                cache_invalidator.clone(),
384            ),
385        ));
386        region_migration_manager.try_start()?;
387        let region_supervisor_selector = plugins
388            .as_ref()
389            .and_then(|plugins| plugins.get::<RegionStatAwareSelectorRef>());
390
391        let supervisor_selector = match region_supervisor_selector {
392            Some(selector) => {
393                info!("Using region stat aware selector");
394                RegionSupervisorSelector::RegionStatAwareSelector(selector)
395            }
396            None => RegionSupervisorSelector::NaiveSelector(selector.clone()),
397        };
398
399        let region_failover_handler = if options.enable_region_failover {
400            let region_supervisor = RegionSupervisor::new(
401                rx,
402                options.failure_detector,
403                selector_ctx.clone(),
404                supervisor_selector,
405                region_migration_manager.clone(),
406                runtime_switch_manager.clone(),
407                meta_peer_client.clone(),
408                leader_cached_kv_backend.clone(),
409            )
410            .with_state(state.clone());
411
412            Some(RegionFailureHandler::new(
413                region_supervisor,
414                HeartbeatAcceptor::new(tx),
415            ))
416        } else {
417            None
418        };
419
420        let leader_region_registry = Arc::new(LeaderRegionRegistry::default());
421        let topic_stats_registry = Arc::new(TopicStatsRegistry::default());
422
423        let ddl_context = DdlContext {
424            node_manager: node_manager.clone(),
425            cache_invalidator: cache_invalidator.clone(),
426            memory_region_keeper: memory_region_keeper.clone(),
427            leader_region_registry: leader_region_registry.clone(),
428            table_metadata_manager: table_metadata_manager.clone(),
429            table_metadata_allocator: table_metadata_allocator.clone(),
430            flow_metadata_manager: flow_metadata_manager.clone(),
431            flow_metadata_allocator: flow_metadata_allocator.clone(),
432            region_failure_detector_controller,
433            soft_drop_enabled: ddl_soft_drop_enabled(&options),
434            soft_drop_retention: ddl_soft_drop_retention(&options),
435            create_database_metadata_committer: None,
436        };
437        let procedure_manager_c = procedure_manager.clone();
438        let repartition_procedure_factory: RepartitionProcedureFactoryRef = if options.gc.enable {
439            Arc::new(DefaultRepartitionProcedureFactory::new(
440                mailbox.clone(),
441                options.grpc.server_addr.clone(),
442                repartition_gc_requirement_manager.clone(),
443            ))
444        } else {
445            Arc::new(GcDisabledRepartitionProcedureFactory::new(
446                mailbox.clone(),
447                options.grpc.server_addr.clone(),
448                repartition_gc_requirement_manager.clone(),
449            ))
450        };
451        let ddl_manager = DdlManager::new(
452            ddl_context,
453            procedure_manager_c,
454            repartition_procedure_factory,
455        );
456
457        let ddl_manager = if let Some(configurator) = plugins
458            .as_ref()
459            .and_then(|p| p.get::<DdlManagerConfiguratorRef<DdlManagerConfigureContext>>())
460        {
461            let ctx = DdlManagerConfigureContext {
462                kv_backend: kv_backend.clone(),
463                meta_peer_client: meta_peer_client.clone(),
464            };
465            configurator
466                .configure(ddl_manager, ctx)
467                .await
468                .context(OtherSnafu)?
469        } else {
470            ddl_manager
471        };
472        ddl_manager
473            .register_loaders()
474            .context(error::InitDdlManagerSnafu)?;
475
476        let ddl_manager = Arc::new(ddl_manager);
477
478        let region_flush_ticker = if is_remote_wal {
479            let remote_wal_options = options.wal.remote_wal_options().unwrap();
480            let (region_flush_trigger, region_flush_ticker) = RegionFlushTrigger::new(
481                table_metadata_manager.clone(),
482                leader_region_registry.clone(),
483                topic_stats_registry.clone(),
484                mailbox.clone(),
485                options.grpc.server_addr.clone(),
486                remote_wal_options.flush_trigger_size,
487                remote_wal_options.checkpoint_trigger_size,
488                remote_wal_options.region_flush_trigger_interval,
489                remote_wal_options.periodic_checkpoint_persist_interval,
490            );
491            region_flush_trigger.try_start()?;
492
493            Some(Arc::new(region_flush_ticker))
494        } else {
495            None
496        };
497
498        // remote WAL prune ticker and manager
499        let wal_prune_ticker = if is_remote_wal && options.wal.enable_active_wal_pruning() {
500            let (tx, rx) = WalPruneManager::channel();
501            // Safety: Must be remote WAL.
502            let remote_wal_options = options.wal.remote_wal_options().unwrap();
503            let kafka_client = build_kafka_client(&remote_wal_options.connection)
504                .await
505                .context(error::BuildKafkaClientSnafu)?;
506            let wal_prune_context = WalPruneContext {
507                client: Arc::new(kafka_client),
508                table_metadata_manager: table_metadata_manager.clone(),
509                leader_region_registry: leader_region_registry.clone(),
510            };
511            let wal_prune_manager = WalPruneManager::new(
512                remote_wal_options.auto_prune_parallelism,
513                remote_wal_options.auto_prune_logical_delete,
514                rx,
515                procedure_manager.clone(),
516                wal_prune_context,
517            );
518            // Start manager in background. Ticker will be started in the main thread to send ticks.
519            wal_prune_manager.try_start().await?;
520            let wal_prune_ticker = Arc::new(WalPruneTicker::new(
521                remote_wal_options.auto_prune_interval,
522                tx.clone(),
523            ));
524            Some(wal_prune_ticker)
525        } else {
526            None
527        };
528
529        let gc_ticker = if options.gc.enable {
530            let gc_scheduler_ctx = DefaultGcSchedulerCtx::try_new(
531                table_metadata_manager.clone(),
532                procedure_manager.clone(),
533                #[cfg(feature = "enterprise")]
534                ddl_manager.clone(),
535                meta_peer_client.clone(),
536                mailbox.clone(),
537                options.grpc.server_addr.clone(),
538            )?;
539            let (gc_scheduler, gc_ticker) = GcScheduler::new_with_config(
540                gc_scheduler_ctx,
541                runtime_switch_manager.clone(),
542                options.gc.clone(),
543            )?;
544            gc_scheduler.try_start()?;
545
546            Some(Arc::new(gc_ticker))
547        } else {
548            None
549        };
550
551        let customized_region_lease_renewer = plugins
552            .as_ref()
553            .and_then(|plugins| plugins.get::<CustomizedRegionLeaseRenewerRef>());
554
555        let persist_region_stats_handler = if !options.stats_persistence.ttl.is_zero() {
556            let inserter = Box::new(InsertForwarder::new(
557                database_operator.clone(),
558                Some(InsertOptions {
559                    ttl: options.stats_persistence.ttl,
560                    append_mode: true,
561                    twcs_compaction_time_window: Some(
562                        REGION_STATS_TABLE_TWCS_COMPACTION_TIME_WINDOW,
563                    ),
564                }),
565            ));
566
567            Some(PersistStatsHandler::new(
568                inserter,
569                options.stats_persistence.interval,
570            ))
571        } else {
572            None
573        };
574
575        let handler_group_builder = match handler_group_builder {
576            Some(handler_group_builder) => handler_group_builder,
577            None => {
578                let region_lease_handler = RegionLeaseHandler::new(
579                    default_distributed_time_constants().region_lease.as_secs(),
580                    table_metadata_manager.clone(),
581                    memory_region_keeper.clone(),
582                    customized_region_lease_renewer,
583                );
584
585                HeartbeatHandlerGroupBuilder::new(pushers)
586                    .with_plugins(plugins.clone())
587                    .with_region_failure_handler(region_failover_handler)
588                    .with_region_lease_handler(Some(region_lease_handler))
589                    .with_flush_stats_factor(Some(options.flush_stats_factor))
590                    .with_flow_state_handler(Some(flow_state_handler))
591                    .with_persist_stats_handler(persist_region_stats_handler)
592                    .add_default_handlers()
593            }
594        };
595
596        let enable_telemetry = options.enable_telemetry;
597        let metasrv_home = Path::new(&options.data_home)
598            .join(METASRV_DATA_DIR)
599            .to_string_lossy()
600            .to_string();
601
602        let reconciliation_manager = Arc::new(ReconciliationManager::new(
603            node_manager.clone(),
604            table_metadata_manager.clone(),
605            cache_invalidator.clone(),
606            procedure_manager.clone(),
607        ));
608        reconciliation_manager
609            .try_start()
610            .context(error::InitReconciliationManagerSnafu)?;
611
612        let mut resource_stat = ResourceStatImpl::default();
613        resource_stat.start_collect_cpu_usage();
614
615        Ok(Metasrv {
616            state,
617            started: Arc::new(AtomicBool::new(false)),
618            start_time_ms: common_time::util::current_time_millis() as u64,
619            options,
620            in_memory,
621            kv_backend,
622            leader_cached_kv_backend,
623            meta_peer_client: meta_peer_client.clone(),
624            selector,
625            selector_ctx,
626            // TODO(jeremy): We do not allow configuring the flow selector.
627            flow_selector,
628            handler_group: RwLock::new(None),
629            handler_group_builder: Mutex::new(Some(handler_group_builder)),
630            election,
631            procedure_manager,
632            mailbox,
633            ddl_manager,
634            wal_provider,
635            table_metadata_manager,
636            runtime_switch_manager,
637            repartition_gc_requirement_manager,
638            greptimedb_telemetry_task: get_greptimedb_telemetry_task(
639                Some(metasrv_home),
640                meta_peer_client,
641                enable_telemetry,
642            )
643            .await,
644            plugins: plugins.unwrap_or_else(Plugins::default),
645            memory_region_keeper,
646            region_migration_manager,
647            region_supervisor_ticker,
648            cache_invalidator,
649            leader_region_registry,
650            wal_prune_ticker,
651            region_flush_ticker,
652            table_id_allocator,
653            reconciliation_manager,
654            topic_stats_registry,
655            resource_stat: Arc::new(resource_stat),
656            gc_ticker,
657            database_operator,
658        })
659    }
660}
661
662fn build_mailbox(kv_backend: &KvBackendRef, pushers: &Pushers) -> MailboxRef {
663    let mailbox_sequence = SequenceBuilder::new("heartbeat_mailbox", kv_backend.clone())
664        .initial(1)
665        .step(100)
666        .build();
667
668    HeartbeatMailbox::create(pushers.clone(), mailbox_sequence)
669}
670
671fn build_procedure_manager(
672    options: &MetasrvOptions,
673    kv_backend: &KvBackendRef,
674    runtime_switch_manager: &RuntimeSwitchManagerRef,
675    event_recorder: EventRecorderRef,
676) -> ProcedureManagerRef {
677    let manager_config = ManagerConfig {
678        max_retry_times: options.procedure.max_retry_times,
679        retry_delay: options.procedure.retry_delay,
680        max_running_procedures: options.procedure.max_running_procedures,
681        ..Default::default()
682    };
683    let kv_state_store = Arc::new(
684        KvStateStore::new(kv_backend.clone()).with_max_value_size(
685            options
686                .procedure
687                .max_metadata_value_size
688                .map(|v| v.as_bytes() as usize),
689        ),
690    );
691
692    Arc::new(LocalManager::new(
693        manager_config,
694        kv_state_store.clone(),
695        kv_state_store,
696        Some(runtime_switch_manager.clone()),
697        Some(event_recorder),
698    ))
699}
700
701/// Resolves if soft-drop is enabled from metasrv options.
702///
703/// Soft drop is an enterprise-only feature; it is always disabled in
704/// non-enterprise builds regardless of the configuration.
705fn ddl_soft_drop_enabled(options: &MetasrvOptions) -> bool {
706    cfg!(feature = "enterprise") && options.gc.experimental_soft_drop.enable
707}
708
709/// Returns soft-drop retention for recovering persisted procedures.
710fn ddl_soft_drop_retention(options: &MetasrvOptions) -> Option<Duration> {
711    Some(options.gc.experimental_soft_drop.retention)
712}
713
714impl Default for MetasrvBuilder {
715    fn default() -> Self {
716        Self::new()
717    }
718}
719
720/// The context for [`DdlManagerConfiguratorRef`].
721pub struct DdlManagerConfigureContext {
722    pub kv_backend: KvBackendRef,
723    pub meta_peer_client: MetaPeerClientRef,
724}
725
726#[cfg(test)]
727mod tests {
728    use super::*;
729
730    #[cfg(feature = "enterprise")]
731    #[test]
732    fn test_ddl_soft_drop_gate_preserves_retention_for_recovery() {
733        let mut options = MetasrvOptions::default();
734        options.gc.enable = true;
735        options.gc.experimental_soft_drop.enable = true;
736        options.gc.experimental_soft_drop.retention = Duration::from_secs(123);
737
738        assert!(ddl_soft_drop_enabled(&options));
739        assert_eq!(
740            Some(Duration::from_secs(123)),
741            ddl_soft_drop_retention(&options)
742        );
743    }
744
745    #[cfg(not(feature = "enterprise"))]
746    #[test]
747    fn test_ddl_soft_drop_is_always_disabled_in_non_enterprise_build() {
748        let mut options = MetasrvOptions::default();
749        options.gc.enable = true;
750        options.gc.experimental_soft_drop.enable = true;
751        options.gc.experimental_soft_drop.retention = Duration::from_secs(123);
752
753        assert!(!ddl_soft_drop_enabled(&options));
754        // Retention is preserved for recovering persisted procedures.
755        assert_eq!(
756            Some(Duration::from_secs(123)),
757            ddl_soft_drop_retention(&options)
758        );
759    }
760
761    #[test]
762    fn test_ddl_soft_drop_is_disabled_by_default() {
763        assert!(!ddl_soft_drop_enabled(&MetasrvOptions::default()));
764    }
765
766    #[test]
767    fn test_soft_drop_options_are_validated() {
768        let mut options = MetasrvOptions::default();
769        options.gc.enable = true;
770        options.gc.experimental_soft_drop.enable = true;
771        options.gc.experimental_soft_drop.retention = Duration::ZERO;
772
773        assert!(options.gc.validate().is_err());
774    }
775
776    #[tokio::test]
777    async fn test_builder_rejects_soft_drop_when_gc_is_disabled() {
778        let mut options = MetasrvOptions::default();
779        options.gc.experimental_soft_drop.enable = true;
780
781        assert!(
782            MetasrvBuilder::new()
783                .options(options)
784                .build()
785                .await
786                .is_err()
787        );
788    }
789
790    #[tokio::test]
791    async fn test_builder_skips_gc_validation_when_gc_is_disabled() {
792        let mut options = MetasrvOptions::default();
793        options.gc.enable = false;
794        options.gc.max_concurrent_tables = 0;
795
796        MetasrvBuilder::new()
797            .options(options)
798            .build()
799            .await
800            .unwrap();
801    }
802}
meta_srv/metasrv/builder.rs

meta_srv/metasrv/
builder.rs
