// Copyright 2024 RustFS Team // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. use super::metadata::{BUCKET_TARGETS_FILE, BucketMetadata, load_bucket_metadata}; use super::quota::BucketQuota; use super::target::BucketTargets; use crate::bucket::bucket_target_sys::BucketTargetSys; use crate::bucket::metadata::{load_bucket_metadata_parse, load_bucket_metadata_parse_with_presence}; use crate::bucket::utils::is_meta_bucketname; use crate::disk::RUSTFS_META_BUCKET; use crate::error::{Error, Result, is_err_bucket_not_found}; use crate::runtime::sources as runtime_sources; use crate::storage_api_contracts::heal::HealOperations as _; use crate::storage_api_contracts::namespace::NamespaceLocking as _; use crate::store::ECStore; use futures::future::join_all; use rustfs_common::heal_channel::HealOpts; use rustfs_policy::policy::BucketPolicy; use s3s::dto::ReplicationConfiguration; use s3s::dto::{ AccelerateConfiguration, BucketLifecycleConfiguration, BucketLoggingStatus, CORSConfiguration, NotificationConfiguration, ObjectLockConfiguration, PublicAccessBlockConfiguration, RequestPaymentConfiguration, ServerSideEncryptionConfiguration, Tagging, VersioningConfiguration, WebsiteConfiguration, }; use std::collections::HashSet; use std::time::Duration; use std::{collections::HashMap, sync::Arc}; use time::OffsetDateTime; use tokio::sync::RwLock; use tokio::time::sleep; use tokio_util::sync::CancellationToken; use tracing::{error, warn}; const BUCKET_METADATA_REFRESH_INTERVAL: Duration = Duration::from_secs(15 * 60); pub async fn init_bucket_metadata_sys(api: Arc, buckets: Vec) { // The metadata system is inherently per-store (it holds the store handle // and that store's bucket cache), so it lives on the store's own instance // context (backlog#1052 S3) — a second instance initializes its own cell // instead of panicking on the process-global one. let instance_ctx = api.ctx.clone(); let is_dist_erasure = instance_ctx.is_dist_erasure().await; let mut sys = BucketMetadataSys::new(api); sys.init(buckets).await; let sys = Arc::new(RwLock::new(sys)); instance_ctx.init_bucket_metadata_sys(sys.clone()); if is_dist_erasure { start_refresh_buckets_metadata_loop(sys); } } /// The current instance's bucket metadata system (legacy free-function /// facade: resolves the published store's context, or the bootstrap one). pub fn get_global_bucket_metadata_sys() -> Option>> { crate::runtime::global::current_ctx().bucket_metadata_sys() } pub(super) fn get_bucket_metadata_sys() -> Result>> { if let Some(sys) = get_global_bucket_metadata_sys() { Ok(sys) } else { Err(Error::other("bucket metadata sys not initialized for this instance")) } } pub async fn set_bucket_metadata(bucket: String, bm: BucketMetadata) -> Result<()> { let sys = get_bucket_metadata_sys()?; let lock = sys.write().await; lock.set(bucket, Arc::new(bm)).await; Ok(()) } /// Drop a bucket's cached metadata from the in-memory map. /// /// This is the counterpart to [`set_bucket_metadata`] and is invoked when a /// bucket is deleted so peers stop serving stale cached configuration for it. /// Returns `true` if an entry was present. pub async fn remove_bucket_metadata(bucket: &str) -> Result { let sys = get_bucket_metadata_sys()?; let lock = sys.read().await; Ok(lock.remove(bucket).await) } fn start_refresh_buckets_metadata_loop(sys: Arc>) { let Some(cancel_token) = runtime_sources::background_services_cancel_token() else { warn!("bucket metadata refresh loop skipped because background cancellation token is not initialized"); return; }; tokio::spawn(async move { refresh_buckets_metadata_loop(sys, cancel_token).await; }); } async fn refresh_buckets_metadata_loop(sys: Arc>, cancel_token: CancellationToken) { loop { if !wait_refresh_interval_or_cancel(&cancel_token, BUCKET_METADATA_REFRESH_INTERVAL).await { break; } refresh_buckets_metadata_once(sys.clone()).await; } } async fn wait_refresh_interval_or_cancel(cancel_token: &CancellationToken, interval: Duration) -> bool { tokio::select! { _ = cancel_token.cancelled() => false, _ = sleep(interval) => true, } } async fn refresh_buckets_metadata_once(sys: Arc>) { let buckets = { let sys = sys.read().await; sys.bucket_names().await }; if buckets.is_empty() { return; } let count = runtime_sources::endpoint_erasure_set_count() .map(|count| count * 10) .unwrap_or(10) .max(1); let mut failed_buckets = HashSet::new(); for chunk in buckets.chunks(count) { let sys = sys.read().await; sys.concurrent_load(chunk, &mut failed_buckets).await; } if !failed_buckets.is_empty() { warn!( failed_bucket_count = failed_buckets.len(), "bucket metadata refresh loop left buckets queued for retry" ); } } async fn sync_bucket_target_sys(bucket: &str, bm: &BucketMetadata) { BucketTargetSys::get() .update_all_targets(bucket, bm.bucket_target_config.as_ref()) .await; } /// Publish the bucket's durability override (or its absence) to the disk /// layer registry consulted by `effective_durability`. /// /// Called from every path that installs a bucket's metadata into the cache /// (initial load, config update, peer reload notification, refresh loop, /// lazy load), so the override propagates with exactly the bucket-metadata /// cache invalidation semantics and never through a channel of its own. fn sync_bucket_durability(bucket: &str, bm: &BucketMetadata) { let mode = bm .durability_config() .and_then(|cfg| cfg.normalized_mode()) .and_then(|mode| crate::disk::local::DurabilityMode::parse(&mode)); crate::disk::local::bucket_durability::set(bucket, mode); } /// Drop a bucket's durability override when its metadata leaves the cache. fn clear_bucket_durability(bucket: &str) { crate::disk::local::bucket_durability::set(bucket, None); } pub async fn get(bucket: &str) -> Result> { let sys = get_bucket_metadata_sys()?; let lock = sys.read().await; lock.get(bucket).await } // ---- Instance-scoped variants (backlog#1052 S7) ---- // // A store's own bucket operations resolve the metadata system of *their* // instance context so two servers in one process stay isolated; when the // instance cell is not initialized yet (early startup) they fall back to the // ambient default — the single-instance legacy behavior. pub(crate) fn bucket_metadata_sys_of(ctx: &crate::runtime::instance::InstanceContext) -> Result>> { if let Some(sys) = ctx.bucket_metadata_sys() { return Ok(sys); } get_bucket_metadata_sys() } pub(crate) async fn get_in(ctx: &crate::runtime::instance::InstanceContext, bucket: &str) -> Result> { let sys = bucket_metadata_sys_of(ctx)?; let lock = sys.read().await; lock.get(bucket).await } pub(crate) async fn created_at_in(ctx: &crate::runtime::instance::InstanceContext, bucket: &str) -> Result { let sys = bucket_metadata_sys_of(ctx)?; let lock = sys.read().await; lock.created_at(bucket).await } pub(crate) async fn set_bucket_metadata_in(ctx: &crate::runtime::instance::InstanceContext, bm: BucketMetadata) -> Result<()> { let sys = bucket_metadata_sys_of(ctx)?; let lock = sys.read().await; lock.persist_and_set(bm).await } pub(crate) async fn remove_bucket_metadata_in(ctx: &crate::runtime::instance::InstanceContext, bucket: &str) -> Result { let sys = bucket_metadata_sys_of(ctx)?; let lock = sys.read().await; Ok(lock.remove(bucket).await) } pub async fn update(bucket: &str, config_file: &str, data: Vec) -> Result { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let _targets_guard = if config_file == BUCKET_TARGETS_FILE { Some(acquire_bucket_targets_transaction_lock(bucket).await?) } else { None }; let mut bucket_meta_sys = bucket_meta_sys_lock.write().await; bucket_meta_sys.update(bucket, config_file, data).await } pub async fn update_bucket_targets_under_transaction_lock(bucket: &str, data: Vec) -> Result { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let mut bucket_meta_sys = bucket_meta_sys_lock.write().await; bucket_meta_sys.update(bucket, BUCKET_TARGETS_FILE, data).await } pub async fn acquire_bucket_targets_transaction_lock(bucket: &str) -> Result { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let api = bucket_meta_sys_lock.read().await.object_store(); let lock = api .new_ns_lock(RUSTFS_META_BUCKET, &bucket_targets_transaction_lock_key(bucket)) .await?; Ok(lock.get_write_lock(crate::set_disk::get_lock_acquire_timeout()).await?) } fn bucket_targets_transaction_lock_key(bucket: &str) -> String { format!("bucket-targets/{bucket}/transaction.lock") } pub async fn delete(bucket: &str, config_file: &str) -> Result { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let mut bucket_meta_sys = bucket_meta_sys_lock.write().await; bucket_meta_sys.delete(bucket, config_file).await } pub async fn get_bucket_policy(bucket: &str) -> Result<(BucketPolicy, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_bucket_policy(bucket).await } /// Returns the raw JSON string of the bucket policy as originally stored. /// This preserves the exact format of the policy document as it was PUT. pub async fn get_bucket_policy_raw(bucket: &str) -> Result<(String, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_bucket_policy_raw(bucket).await } pub async fn get_bucket_acl_config(bucket: &str) -> Result<(String, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_bucket_acl_config(bucket).await } /// The bucket's durability override config (if any) with its update time. /// /// `Ok((None, ..))` means the bucket has no override and follows the global /// durability mode. pub async fn get_durability_config( bucket: &str, ) -> Result<(Option, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; let (bm, _) = bucket_meta_sys.get_config(bucket).await?; Ok((bm.durability_config(), bm.durability_config_updated_at)) } pub async fn get_quota_config(bucket: &str) -> Result<(BucketQuota, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_quota_config(bucket).await } pub async fn get_bucket_targets_config(bucket: &str) -> Result { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_bucket_targets_config(bucket).await } pub async fn get_cors_config(bucket: &str) -> Result<(CORSConfiguration, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_cors_config(bucket).await } pub async fn get_tagging_config(bucket: &str) -> Result<(Tagging, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_tagging_config(bucket).await } pub async fn get_public_access_block_config(bucket: &str) -> Result<(PublicAccessBlockConfiguration, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_public_access_block_config(bucket).await } pub async fn get_lifecycle_config(bucket: &str) -> Result<(BucketLifecycleConfiguration, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_lifecycle_config(bucket).await } pub async fn get_sse_config(bucket: &str) -> Result<(ServerSideEncryptionConfiguration, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_sse_config(bucket).await } pub async fn get_object_lock_config(bucket: &str) -> Result<(ObjectLockConfiguration, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_object_lock_config(bucket).await } pub async fn get_replication_config(bucket: &str) -> Result<(ReplicationConfiguration, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_replication_config(bucket).await } pub async fn get_notification_config(bucket: &str) -> Result> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_notification_config(bucket).await } pub async fn get_versioning_config(bucket: &str) -> Result<(VersioningConfiguration, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_versioning_config(bucket).await } pub async fn get_website_config(bucket: &str) -> Result<(WebsiteConfiguration, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_website_config(bucket).await } pub async fn get_logging_config(bucket: &str) -> Result<(BucketLoggingStatus, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_logging_config(bucket).await } pub async fn get_accelerate_config(bucket: &str) -> Result<(AccelerateConfiguration, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_accelerate_config(bucket).await } pub async fn get_request_payment_config(bucket: &str) -> Result<(RequestPaymentConfiguration, OffsetDateTime)> { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_request_payment_config(bucket).await } pub async fn get_config_from_disk(bucket: &str) -> Result { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_config_from_disk(bucket).await } pub async fn created_at(bucket: &str) -> Result { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.created_at(bucket).await } pub async fn list_bucket_targets(bucket: &str) -> Result { let bucket_meta_sys_lock = get_bucket_metadata_sys()?; let bucket_meta_sys = bucket_meta_sys_lock.read().await; bucket_meta_sys.get_bucket_targets_config(bucket).await } /// Bound and lifetime of the negative cache for buckets with no persisted /// metadata. Entries are invalidated the moment real metadata is cached, so /// the TTL only bounds staleness for out-of-band creations whose reload /// notification was lost; the capacity bounds memory under bogus-name floods. const ABSENT_BUCKET_METADATA_TTL: Duration = Duration::from_secs(30); const ABSENT_BUCKET_METADATA_MAX_ENTRIES: u64 = 10_000; #[derive(Debug)] pub struct BucketMetadataSys { metadata_map: RwLock>>, /// Buckets recently observed to have no persisted metadata. Serving the /// fabricated default from here (instead of re-reading disk) keeps the /// per-request cost of repeated lookups for such names bounded — without /// this, every request naming a nonexistent bucket pays a namespace-lock /// acquisition plus a full erasure-set metadata fanout (reachable /// pre-auth via CORS preflight, and per-key in DeleteObjects). absent_metadata: moka::future::Cache, api: Arc, initialized: RwLock, } impl BucketMetadataSys { pub fn new(api: Arc) -> Self { Self { metadata_map: RwLock::new(HashMap::new()), absent_metadata: moka::future::Cache::builder() .max_capacity(ABSENT_BUCKET_METADATA_MAX_ENTRIES) .time_to_live(ABSENT_BUCKET_METADATA_TTL) .build(), api, initialized: RwLock::new(false), } } pub(crate) fn object_store(&self) -> Arc { self.api.clone() } pub async fn init(&mut self, buckets: Vec) { let _ = self.init_internal(buckets).await; } async fn init_internal(&self, buckets: Vec) -> Result<()> { let count = runtime_sources::endpoint_erasure_set_count() .map(|count| count * 10) .ok_or_else(|| Error::other("endpoint pools not initialized"))?; let mut failed_buckets: HashSet = HashSet::new(); let mut buckets = buckets.as_slice(); loop { if buckets.len() < count { self.concurrent_load(buckets, &mut failed_buckets).await; break; } self.concurrent_load(&buckets[..count], &mut failed_buckets).await; buckets = &buckets[count..] } let mut initialized = self.initialized.write().await; *initialized = true; Ok(()) } async fn concurrent_load(&self, buckets: &[String], failed_buckets: &mut HashSet) { let mut futures = Vec::new(); for bucket in buckets.iter() { let api = self.api.clone(); let bucket = bucket.clone(); futures.push(async move { sleep(Duration::from_millis(30)).await; let _ = api .heal_bucket( &bucket, &HealOpts { recreate: true, ..Default::default() }, ) .await; load_bucket_metadata_parse_with_presence(self.api.clone(), bucket.as_str(), true).await }); } let results = join_all(futures).await; for (idx, res) in results.into_iter().enumerate() { match res { Ok((bm, persisted)) => { if let Some(bucket) = buckets.get(idx) { if persisted { self.set(bucket.clone(), Arc::new(bm)).await; } else { // A fabricated default (no persisted metadata // readable right now) must never REPLACE an // existing entry: the periodic refresh would // otherwise downgrade a lock-enabled bucket to an // authoritative "no lock" default on a transient // ConfigNotFound, disabling the object-lock // delete gate and wiping its target/durability // sync state. Insert-if-vacant keeps the startup // behavior for legacy buckets without a metadata // file, atomically under the map write lock. let mut map = self.metadata_map.write().await; map.entry(bucket.clone()).or_insert_with(|| Arc::new(bm)); } } } Err(e) => { error!("Unable to load bucket metadata, will be retried: {:?}", e); if let Some(bucket) = buckets.get(idx) { failed_buckets.insert(bucket.clone()); } } } } } pub async fn get(&self, bucket: &str) -> Result> { if is_meta_bucketname(bucket) { return Err(Error::ConfigNotFound); } let map = self.metadata_map.read().await; if let Some(bm) = map.get(bucket) { Ok(bm.clone()) } else { Err(Error::ConfigNotFound) } } pub async fn set(&self, bucket: String, bm: Arc) { if !is_meta_bucketname(&bucket) { let mut map = self.metadata_map.write().await; map.insert(bucket.clone(), bm.clone()); drop(map); // Real metadata supersedes any recorded absence immediately. self.absent_metadata.invalidate(&bucket).await; sync_bucket_target_sys(&bucket, &bm).await; sync_bucket_durability(&bucket, &bm); } } /// Remove a bucket's cached metadata from the in-memory map. /// /// Returns `true` if an entry was present. Reserved meta buckets are ignored. pub async fn remove(&self, bucket: &str) -> bool { if is_meta_bucketname(bucket) { return false; } let mut map = self.metadata_map.write().await; let removed = map.remove(bucket).is_some(); drop(map); if removed { BucketTargetSys::get().delete(bucket).await; clear_bucket_durability(bucket); } removed } async fn _reset(&mut self) { let mut map = self.metadata_map.write().await; map.clear(); } pub async fn update(&mut self, bucket: &str, config_file: &str, data: Vec) -> Result { self.update_and_parse(bucket, config_file, data, true).await } pub async fn delete(&mut self, bucket: &str, config_file: &str) -> Result { self.update_and_parse(bucket, config_file, Vec::new(), false).await } async fn update_and_parse(&mut self, bucket: &str, config_file: &str, data: Vec, parse: bool) -> Result { let Some(store) = runtime_sources::object_store_handle() else { return Err(Error::other("errServerNotInitialized")); }; if is_meta_bucketname(bucket) { return Err(Error::other("errInvalidArgument")); } let mut bm = match load_bucket_metadata_parse(store, bucket, parse).await { Ok(res) => res, Err(err) => { if !runtime_sources::setup_is_erasure().await && !runtime_sources::setup_is_dist_erasure().await && is_err_bucket_not_found(&err) { BucketMetadata::new(bucket) } else { error!("load bucket metadata failed: {}", err); return Err(err); } } }; let updated = bm.update_config(config_file, data)?; self.save(bm).await?; Ok(updated) } async fn save(&self, bm: BucketMetadata) -> Result<()> { if is_meta_bucketname(&bm.name) { return Err(Error::other("errInvalidArgument")); } self.persist_and_set(bm).await } /// Persist metadata through this system's own store and cache it here /// (backlog#1052 S7). The store-scoped bucket path uses this so a second /// server's metadata never leaks into the ambient (first) instance. pub(crate) async fn persist_and_set(&self, bm: BucketMetadata) -> Result<()> { let mut bm = bm; bm.save_with_store(self.api.clone()).await?; self.set(bm.name.clone(), Arc::new(bm)).await; Ok(()) } async fn bucket_names(&self) -> Vec { self.metadata_map.read().await.keys().cloned().collect() } pub async fn get_config_from_disk(&self, bucket: &str) -> Result { if is_meta_bucketname(bucket) { return Err(Error::other("errInvalidArgument")); } load_bucket_metadata(self.api.clone(), bucket).await } pub async fn get_config(&self, bucket: &str) -> Result<(Arc, bool)> { let has_bm = { let map = self.metadata_map.read().await; map.get(bucket).cloned() }; if let Some(bm) = has_bm { Ok((bm, false)) } else { // A recent lookup already established there is no persisted // metadata: serve the fabricated default without another // namespace-lock + erasure-set fanout. if self.absent_metadata.get(bucket).await.is_some() { let mut bm = BucketMetadata::new(bucket); bm.default_timestamps(); return Ok((Arc::new(bm), true)); } let (bm, persisted) = match load_bucket_metadata_parse_with_presence(self.api.clone(), bucket, true).await { Ok(res) => res, Err(err) => { return if *self.initialized.read().await { Err(Error::other("errBucketMetadataNotInitialized")) } else { Err(err) }; } }; let bm = Arc::new(bm); // This lazy path caches only metadata that actually exists on // this store. A fabricated default must not enter the map: // `get()` is map-only and fail-closed — the object-lock delete // gate (`object_lock_delete_check_required`) skips its per-object // protection stat exactly when the map serves metadata saying the // bucket has no Object Lock, so caching a fabricated default here // would turn a metadata miss into an authoritative "no lock" // answer. (Startup `concurrent_load` still caches fabricated // defaults for buckets listed on disk — legacy buckets without a // metadata file — but never lets one replace an existing entry.) if persisted { let mut map = self.metadata_map.write().await; map.insert(bucket.to_string(), bm.clone()); drop(map); sync_bucket_target_sys(bucket, &bm).await; sync_bucket_durability(bucket, &bm); } else { self.absent_metadata.insert(bucket.to_string(), ()).await; } Ok((bm, true)) } } pub async fn get_versioning_config(&self, bucket: &str) -> Result<(VersioningConfiguration, OffsetDateTime)> { let bm = match self.get_config(bucket).await { Ok((res, _)) => res, Err(err) => { return if err == Error::ConfigNotFound { Ok((VersioningConfiguration::default(), OffsetDateTime::UNIX_EPOCH)) } else { Err(err) }; } }; if let Some(config) = &bm.versioning_config { Ok((config.clone(), bm.versioning_config_updated_at)) } else { Ok((VersioningConfiguration::default(), bm.versioning_config_updated_at)) } } pub async fn get_bucket_policy(&self, bucket: &str) -> Result<(BucketPolicy, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.policy_config { Ok((config.clone(), bm.policy_config_updated_at)) } else if !bm.policy_config_json.is_empty() { Ok((serde_json::from_slice(&bm.policy_config_json)?, bm.policy_config_updated_at)) } else { Err(Error::ConfigNotFound) } } /// Returns the raw JSON string of the bucket policy as originally stored. /// This preserves the exact format of the policy document as it was PUT. pub async fn get_bucket_policy_raw(&self, bucket: &str) -> Result<(String, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if bm.policy_config_json.is_empty() { Err(Error::ConfigNotFound) } else { let policy_str = String::from_utf8(bm.policy_config_json.clone()) .map_err(|e| Error::other(format!("invalid UTF-8 in policy JSON: {}", e)))?; Ok((policy_str, bm.policy_config_updated_at)) } } pub async fn get_bucket_acl_config(&self, bucket: &str) -> Result<(String, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.bucket_acl_config { Ok((config.clone(), bm.bucket_acl_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn get_tagging_config(&self, bucket: &str) -> Result<(Tagging, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.tagging_config { Ok((config.clone(), bm.tagging_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn get_public_access_block_config(&self, bucket: &str) -> Result<(PublicAccessBlockConfiguration, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.public_access_block_config { Ok((config.clone(), bm.public_access_block_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn get_object_lock_config(&self, bucket: &str) -> Result<(ObjectLockConfiguration, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.object_lock_config { Ok((config.clone(), bm.object_lock_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn get_lifecycle_config(&self, bucket: &str) -> Result<(BucketLifecycleConfiguration, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.lifecycle_config { if config.rules.is_empty() { Err(Error::ConfigNotFound) } else { Ok((config.clone(), bm.lifecycle_config_updated_at)) } } else { Err(Error::ConfigNotFound) } } pub async fn get_notification_config(&self, bucket: &str) -> Result> { let bm = match self.get_config(bucket).await { Ok((bm, _)) => bm.notification_config.clone(), Err(err) => { if err == Error::ConfigNotFound { None } else { return Err(err); } } }; Ok(bm) } pub async fn get_sse_config(&self, bucket: &str) -> Result<(ServerSideEncryptionConfiguration, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.sse_config { Ok((config.clone(), bm.encryption_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn get_cors_config(&self, bucket: &str) -> Result<(CORSConfiguration, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.cors_config { Ok((config.clone(), bm.cors_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn get_website_config(&self, bucket: &str) -> Result<(WebsiteConfiguration, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.website_config { Ok((config.clone(), bm.website_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn get_logging_config(&self, bucket: &str) -> Result<(BucketLoggingStatus, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.logging_config { Ok((config.clone(), bm.logging_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn get_accelerate_config(&self, bucket: &str) -> Result<(AccelerateConfiguration, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.accelerate_config { Ok((config.clone(), bm.accelerate_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn get_request_payment_config(&self, bucket: &str) -> Result<(RequestPaymentConfiguration, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.request_payment_config { Ok((config.clone(), bm.request_payment_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn created_at(&self, bucket: &str) -> Result { let bm = match self.get_config(bucket).await { Ok((bm, _)) => bm.created, Err(err) => { return Err(err); } }; Ok(bm) } pub async fn get_quota_config(&self, bucket: &str) -> Result<(BucketQuota, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.quota_config { Ok((config.clone(), bm.quota_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn get_replication_config(&self, bucket: &str) -> Result<(ReplicationConfiguration, OffsetDateTime)> { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.replication_config { Ok((config.clone(), bm.replication_config_updated_at)) } else { Err(Error::ConfigNotFound) } } pub async fn get_bucket_targets_config(&self, bucket: &str) -> Result { let (bm, _) = self.get_config(bucket).await?; if let Some(config) = &bm.bucket_target_config { Ok(config.clone()) } else { Err(Error::ConfigNotFound) } } } /// Test-only fixture shared with sibling modules (e.g. the quota checker /// tests): a 4-disk `ECStore` on an isolated instance context, so tests /// exercising the metadata system never touch ambient process state. #[cfg(test)] pub(crate) mod test_support { use super::*; use crate::disk::endpoint::Endpoint; use crate::layout::endpoints::{EndpointServerPools, Endpoints, PoolEndpoints}; use crate::runtime::instance::InstanceContext; use crate::store::init_local_disks_with_instance_ctx; pub(crate) async fn isolated_store_over_temp_disks() -> (Vec, Arc) { let mut dirs = Vec::with_capacity(4); let mut endpoints = Vec::with_capacity(4); for disk_idx in 0..4 { let dir = tempfile::tempdir().expect("tempdir should be created"); let mut endpoint = Endpoint::try_from(dir.path().to_str().expect("tempdir path should be utf8")).expect("endpoint should parse"); endpoint.set_pool_index(0); endpoint.set_set_index(0); endpoint.set_disk_index(disk_idx); dirs.push(dir); endpoints.push(endpoint); } let endpoint_pools = EndpointServerPools(vec![PoolEndpoints { legacy: false, set_count: 1, drives_per_set: 4, endpoints: Endpoints::from(endpoints), cmd_line: "metadata-sys-cache-test".to_string(), platform: "test".to_string(), }]); let instance_ctx = Arc::new(InstanceContext::new()); init_local_disks_with_instance_ctx(&instance_ctx, endpoint_pools.clone()) .await .expect("local disks should initialize"); let ecstore = ECStore::new_with_instance_ctx( "127.0.0.1:0".parse().expect("test address"), endpoint_pools, CancellationToken::new(), instance_ctx, ) .await .expect("ECStore should initialize"); (dirs, ecstore) } } #[cfg(test)] mod tests { use super::test_support::isolated_store_over_temp_disks; use super::*; use crate::bucket::target::{BucketTarget, BucketTargetType, Credentials}; use serial_test::serial; use tokio::time::timeout; /// Pins the fail-closed caching contract of the lazy `get_config` path /// and the refresh no-replace rule: fabricated defaults are returned but /// never served by the map-only `get()`, persisted metadata is cached on /// lazy load (superseding a recorded absence), and a refresh-load miss /// never replaces an existing entry. #[tokio::test] async fn get_config_never_caches_fabricated_defaults_as_authoritative() { let (_dirs, ecstore) = isolated_store_over_temp_disks().await; let sys = BucketMetadataSys::new(ecstore); // (a) Miss: the fabricated default is returned but not cached. let (bm, _) = sys .get_config("absent-bucket") .await .expect("fabricated default should be returned"); assert!(bm.object_lock_config_xml.is_empty()); assert!( sys.get("absent-bucket").await.is_err(), "a fabricated default must never be served by the map-only get()" ); // The repeat lookup is served from the negative cache, same answer. let (bm, _) = sys .get_config("absent-bucket") .await .expect("negative-cached default should be returned"); assert!(bm.object_lock_config_xml.is_empty()); assert!(sys.get("absent-bucket").await.is_err()); // (b) Persisting real metadata supersedes the recorded absence, and a // lazy reload after a map wipe re-caches it. let mut persisted = BucketMetadata::new("absent-bucket"); persisted.policy_config_json = b"persisted-marker".to_vec(); sys.persist_and_set(persisted).await.expect("metadata should persist"); sys.metadata_map.write().await.clear(); let _ = sys .get_config("absent-bucket") .await .expect("persisted metadata should lazily reload"); let cached = sys .get("absent-bucket") .await .expect("lazily loaded persisted metadata must be cached"); assert_eq!(cached.policy_config_json, b"persisted-marker".to_vec()); // (c) A refresh-load miss (no persisted metadata readable) must not // replace an existing entry. let mut kept = BucketMetadata::new("kept-bucket"); kept.policy_config_json = b"kept-marker".to_vec(); sys.set("kept-bucket".to_string(), Arc::new(kept)).await; let mut failed = HashSet::new(); let refresh_targets = vec!["kept-bucket".to_string()]; sys.concurrent_load(&refresh_targets, &mut failed).await; let kept = sys .get("kept-bucket") .await .expect("existing entry must survive a refresh miss"); assert_eq!( kept.policy_config_json, b"kept-marker".to_vec(), "a fabricated refresh default must not replace real metadata" ); } #[tokio::test] async fn get_bucket_policy_rejects_malformed_cached_policy() { let (_dirs, ecstore) = isolated_store_over_temp_disks().await; let sys = BucketMetadataSys::new(ecstore); let mut metadata = BucketMetadata::new("malformed-policy"); metadata.policy_config_json = b"{".to_vec(); sys.set("malformed-policy".to_string(), Arc::new(metadata)).await; let err = sys .get_bucket_policy("malformed-policy") .await .expect_err("malformed persisted policy must not be treated as missing"); assert!(matches!(err, Error::Io(_)), "malformed persisted policy must surface its parse failure"); } fn target(bucket: &str, id: &str) -> BucketTarget { BucketTarget { source_bucket: bucket.to_string(), endpoint: format!("{id}.example.com:9000"), credentials: Some(Credentials { access_key: "access".to_string(), secret_key: "secret".to_string(), ..Default::default() }), target_bucket: format!("{bucket}-{id}"), arn: format!("arn:rustfs:replication:us-east-1:{bucket}:{id}"), target_type: BucketTargetType::ReplicationService, region: "us-east-1".to_string(), ..Default::default() } } #[tokio::test] #[serial] async fn metadata_reload_syncs_bucket_target_sys() { let bucket = "metadata-reload-targets"; let target_sys = BucketTargetSys::get(); target_sys.delete(bucket).await; let mut bm = BucketMetadata::new(bucket); bm.bucket_target_config = Some(BucketTargets { targets: vec![target(bucket, "fresh")], }); sync_bucket_target_sys(bucket, &bm).await; let targets = target_sys .list_bucket_targets(bucket) .await .expect("target sync should publish bucket targets"); assert_eq!(targets.targets.len(), 1); assert_eq!(targets.targets[0].arn, format!("arn:rustfs:replication:us-east-1:{bucket}:fresh")); target_sys.delete(bucket).await; } #[tokio::test] #[serial] async fn metadata_reload_clears_stale_bucket_targets_when_config_is_removed() { let bucket = "metadata-clear-targets"; let target_sys = BucketTargetSys::get(); target_sys.delete(bucket).await; target_sys .targets_map .write() .await .insert(bucket.to_string(), vec![target(bucket, "stale")]); let bm = BucketMetadata::new(bucket); sync_bucket_target_sys(bucket, &bm).await; assert!(target_sys.list_bucket_targets(bucket).await.is_err()); target_sys.delete(bucket).await; } /// HP-5b (rustfs/backlog#938): installing bucket metadata publishes the /// durability override to the disk-layer registry, and clearing the /// config (or an invalid payload) withdraws it. #[test] fn metadata_sync_publishes_and_clears_durability_override() { use crate::disk::local::{DurabilityMode, bucket_durability}; let bucket = "metadata-sync-durability"; let mut bm = BucketMetadata::new(bucket); bm.durability_config_json = br#"{"mode":"relaxed"}"#.to_vec(); sync_bucket_durability(bucket, &bm); assert_eq!(bucket_durability::lookup(bucket), Some(DurabilityMode::Relaxed)); // Metadata without the config entry clears the override. let bm = BucketMetadata::new(bucket); sync_bucket_durability(bucket, &bm); assert_eq!(bucket_durability::lookup(bucket), None); // Invalid payloads degrade to "no override", never to a tier. let mut bm = BucketMetadata::new(bucket); bm.durability_config_json = br#"{"mode":"bogus"}"#.to_vec(); sync_bucket_durability(bucket, &bm); assert_eq!(bucket_durability::lookup(bucket), None); // Cache removal clears the override too. let mut bm = BucketMetadata::new(bucket); bm.durability_config_json = br#"{"mode":"none"}"#.to_vec(); sync_bucket_durability(bucket, &bm); assert_eq!(bucket_durability::lookup(bucket), Some(DurabilityMode::None)); clear_bucket_durability(bucket); assert_eq!(bucket_durability::lookup(bucket), None); } #[tokio::test] async fn refresh_wait_exits_when_cancelled() { let cancel_token = CancellationToken::new(); cancel_token.cancel(); let should_refresh = timeout( Duration::from_millis(100), wait_refresh_interval_or_cancel(&cancel_token, Duration::from_secs(60)), ) .await .expect("cancelled refresh wait should not sleep until the interval"); assert!(!should_refresh); } }