rustfs/crates/ecstore/src/bucket/replication/replication_metadata_boundary.rs

// 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 std::sync::Arc;

use crate::bucket::{metadata::BucketMetadata, metadata_sys};
use crate::disk::{BUCKET_META_PREFIX, RUSTFS_META_BUCKET};
use crate::runtime::instance::InstanceContext;
use rustfs_utils::path::path_join_buf;
use s3s::dto::ReplicationConfiguration;
use time::OffsetDateTime;

use super::replication_error_boundary::{Error, Result};

pub(crate) type ReplicationInstanceContext = InstanceContext;

const REPLICATION_DIR: &str = ".replication";
const RESYNC_FILE_NAME: &str = "resync.bin";

pub(crate) struct ReplicationMetadataStore;

impl ReplicationMetadataStore {
    pub(crate) const MRF_REPLICATION_FILE: &'static str = "config/replication/mrf.bin";
    pub(crate) const FORCE_DELETE_REPLICATION_FILE: &'static str = "config/replication/force-delete.bin";
    pub(crate) const FORCE_DELETE_REPLICATION_TRANSACTION_LOCK: &'static str = "config/replication/force-delete.bin.transaction";

    pub(crate) async fn replication_config(bucket: &str) -> Result<(ReplicationConfiguration, OffsetDateTime)> {
        metadata_sys::get_replication_config(bucket).await
    }

    pub(crate) async fn optional_replication_config(bucket: &str) -> Result<Option<ReplicationConfiguration>> {
        let config = match Self::replication_config(bucket).await {
            Ok((config, _)) => Some(config),
            Err(err) => {
                if err != Error::ConfigNotFound {
                    return Err(err);
                }
                None
            }
        };
        Ok(config)
    }

    pub(crate) async fn delete_metadata(bucket: &str) -> Result<Arc<BucketMetadata>> {
        let sys = metadata_sys::get_bucket_metadata_sys()?;
        let sys = sys.read().await;
        Ok(sys.get_config(bucket).await?.0)
    }

    pub(crate) async fn delete_metadata_in(ctx: &ReplicationInstanceContext, bucket: &str) -> Result<Arc<BucketMetadata>> {
        let sys = ctx
            .bucket_metadata_sys()
            .ok_or_else(|| Error::other("request instance bucket metadata system is not initialized"))?;
        let sys = sys.read().await;
        Ok(sys.get_config(bucket).await?.0)
    }

    pub(crate) fn rustfs_meta_bucket() -> &'static str {
        RUSTFS_META_BUCKET
    }

    pub(crate) fn resync_lock_key(bucket: &str, arn: &str) -> String {
        format!("{REPLICATION_DIR}/{bucket}/{arn}")
    }

    pub(crate) fn resync_admission_lock_key(bucket: &str) -> String {
        format!("{REPLICATION_DIR}/{bucket}/admission.lock")
    }

    pub(crate) fn bucket_resync_dir_path(bucket: &str) -> String {
        path_join_buf(&[BUCKET_META_PREFIX, bucket, REPLICATION_DIR])
    }

    pub(crate) fn bucket_resync_file_path(bucket: &str) -> String {
        let resync_dir_path = Self::bucket_resync_dir_path(bucket);
        path_join_buf(&[&resync_dir_path, RESYNC_FILE_NAME])
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn replication_metadata_paths_match_existing_layout() {
        assert_eq!(
            ReplicationMetadataStore::resync_lock_key("bucket-a", "arn-a"),
            ".replication/bucket-a/arn-a"
        );
        assert_eq!(
            ReplicationMetadataStore::resync_admission_lock_key("bucket-a"),
            ".replication/bucket-a/admission.lock"
        );
        assert_eq!(
            ReplicationMetadataStore::bucket_resync_dir_path("bucket-a"),
            "buckets/bucket-a/.replication"
        );
        assert_eq!(
            ReplicationMetadataStore::bucket_resync_file_path("bucket-a"),
            "buckets/bucket-a/.replication/resync.bin"
        );
        assert_eq!(ReplicationMetadataStore::MRF_REPLICATION_FILE, "config/replication/mrf.bin");
        assert_eq!(
            ReplicationMetadataStore::FORCE_DELETE_REPLICATION_FILE,
            "config/replication/force-delete.bin"
        );
        assert_eq!(
            ReplicationMetadataStore::FORCE_DELETE_REPLICATION_TRANSACTION_LOCK,
            "config/replication/force-delete.bin.transaction"
        );
    }
}