refactor: standardize constant management and fix typos (#387)

* init rustfs config * init rustfs-utils crate * improve code for rustfs-config crate * add * improve code for comment * init rustfs config * improve code for rustfs-config crate * add * improve code for comment * Unified management of configurations and constants * fix: modify rustfs-config crate name * add default fn * improve code for rustfs config * refactor: standardize constant management and fix typos - Create centralized constants module for global static constants - Replace runtime format! expressions with compile-time constants - Fix DEFAULT_PORT reference issues in configuration arguments - Use const-str crate for compile-time string concatenation - Update tokio dependency from 1.42.2 to 1.45.0 - Ensure consistent naming convention for configuration constants * fix * Update common/workers/src/workers.rs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-08-13 08:36:54 +00:00 · 2025-05-07 17:23:22 +08:00
parent de275b0510
commit 29ddf4dbc8
38 changed files with 637 additions and 205 deletions
@@ -0,0 +1,23 @@
+use crate::event::config::EventConfig;
+use crate::ObservabilityConfig;
+
+/// RustFs configuration
+pub struct RustFsConfig {
+    pub observability: ObservabilityConfig,
+    pub event: EventConfig,
+}
+
+impl RustFsConfig {
+    pub fn new() -> Self {
+        Self {
+            observability: ObservabilityConfig::new(),
+            event: EventConfig::new(),
+        }
+    }
+}
+
+impl Default for RustFsConfig {
+    fn default() -> Self {
+        Self::new()
+    }
+}
@@ -0,0 +1,72 @@
+use const_str::concat;
+
+/// Application name
+/// Default value: RustFs
+/// Environment variable: RUSTFS_APP_NAME
+pub const APP_NAME: &str = "RustFs";
+/// Application version
+/// Default value: 1.0.0
+/// Environment variable: RUSTFS_VERSION
+pub const VERSION: &str = "0.0.1";
+
+/// Default configuration logger level
+/// Default value: info
+/// Environment variable: RUSTFS_LOG_LEVEL
+pub const DEFAULT_LOG_LEVEL: &str = "info";
+
+/// maximum number of connections
+/// This is the maximum number of connections that the server will accept.
+/// This is used to limit the number of connections to the server.
+pub const MAX_CONNECTIONS: usize = 100;
+/// timeout for connections
+/// This is the timeout for connections to the server.
+/// This is used to limit the time that a connection can be open.
+pub const DEFAULT_TIMEOUT_MS: u64 = 3000;
+
+/// Default Access Key
+/// Default value: rustfsadmin
+/// Environment variable: RUSTFS_ACCESS_KEY
+/// Command line argument: --access-key
+/// Example: RUSTFS_ACCESS_KEY=rustfsadmin
+/// Example: --access-key rustfsadmin
+pub const DEFAULT_ACCESS_KEY: &str = "rustfsadmin";
+/// Default Secret Key
+/// Default value: rustfsadmin
+/// Environment variable: RUSTFS_SECRET_KEY
+/// Command line argument: --secret-key
+/// Example: RUSTFS_SECRET_KEY=rustfsadmin
+/// Example: --secret-key rustfsadmin
+pub const DEFAULT_SECRET_KEY: &str = "rustfsadmin";
+/// Default configuration file for observability
+/// Default value: config/obs.toml
+/// Environment variable: RUSTFS_OBS_CONFIG
+/// Command line argument: --obs-config
+/// Example: RUSTFS_OBS_CONFIG=config/obs.toml
+/// Example: --obs-config config/obs.toml
+/// Example: --obs-config /etc/rustfs/obs.toml
+pub const DEFAULT_OBS_CONFIG: &str = "config/obs.toml";
+
+/// Default TLS key for rustfs
+/// This is the default key for TLS.
+pub const RUSTFS_TLS_KEY: &str = "rustfs_key.pem";
+
+/// Default TLS cert for rustfs
+/// This is the default cert for TLS.
+pub const RUSTFS_TLS_CERT: &str = "rustfs_cert.pem";
+
+/// Default port for rustfs
+/// This is the default port for rustfs.
+/// This is used to bind the server to a specific port.
+pub const DEFAULT_PORT: u16 = 9000;
+
+/// Default address for rustfs
+/// This is the default address for rustfs.
+pub const DEFAULT_ADDRESS: &str = concat!(":", DEFAULT_PORT);
+
+/// Default port for rustfs console
+/// This is the default port for rustfs console.
+pub const DEFAULT_CONSOLE_PORT: u16 = 9002;
+
+/// Default address for rustfs console
+/// This is the default address for rustfs console.
+pub const DEFAULT_CONSOLE_ADDRESS: &str = concat!(":", DEFAULT_CONSOLE_PORT);
@@ -0,0 +1 @@
+pub(crate) mod app;
@@ -0,0 +1,23 @@
+/// Event configuration module
+pub struct EventConfig {
+    pub event_type: String,
+    pub event_source: String,
+    pub event_destination: String,
+}
+
+impl EventConfig {
+    /// Creates a new instance of `EventConfig` with default values.
+    pub fn new() -> Self {
+        Self {
+            event_type: "default".to_string(),
+            event_source: "default".to_string(),
+            event_destination: "default".to_string(),
+        }
+    }
+}
+
+impl Default for EventConfig {
+    fn default() -> Self {
+        Self::new()
+    }
+}
@@ -0,0 +1,17 @@
+/// Event configuration module
+pub struct EventConfig {
+    pub event_type: String,
+    pub event_source: String,
+    pub event_destination: String,
+}
+
+impl EventConfig {
+    /// Creates a new instance of `EventConfig` with default values.
+    pub fn new() -> Self {
+        Self {
+            event_type: "default".to_string(),
+            event_source: "default".to_string(),
+            event_destination: "default".to_string(),
+        }
+    }
+}
@@ -0,0 +1,2 @@
+pub(crate) mod config;
+pub(crate) mod event;
@@ -0,0 +1,9 @@
+use crate::observability::config::ObservabilityConfig;
+
+mod config;
+mod constants;
+mod event;
+mod observability;
+
+pub use config::RustFsConfig;
+pub use constants::app::*;
@@ -0,0 +1,28 @@
+use crate::observability::logger::LoggerConfig;
+use crate::observability::otel::OtelConfig;
+use crate::observability::sink::SinkConfig;
+use serde::Deserialize;
+
+/// Observability configuration
+#[derive(Debug, Deserialize, Clone)]
+pub struct ObservabilityConfig {
+    pub otel: OtelConfig,
+    pub sinks: SinkConfig,
+    pub logger: Option<LoggerConfig>,
+}
+
+impl ObservabilityConfig {
+    pub fn new() -> Self {
+        Self {
+            otel: OtelConfig::new(),
+            sinks: SinkConfig::new(),
+            logger: Some(LoggerConfig::new()),
+        }
+    }
+}
+
+impl Default for ObservabilityConfig {
+    fn default() -> Self {
+        Self::new()
+    }
+}
@@ -0,0 +1,25 @@
+use serde::Deserialize;
+
+/// File sink configuration
+#[derive(Debug, Deserialize, Clone)]
+pub struct FileSinkConfig {
+    pub path: String,
+    pub max_size: u64,
+    pub max_backups: u64,
+}
+
+impl FileSinkConfig {
+    pub fn new() -> Self {
+        Self {
+            path: "".to_string(),
+            max_size: 0,
+            max_backups: 0,
+        }
+    }
+}
+
+impl Default for FileSinkConfig {
+    fn default() -> Self {
+        Self::new()
+    }
+}
@@ -0,0 +1,23 @@
+use serde::Deserialize;
+
+/// Kafka sink configuration
+#[derive(Debug, Deserialize, Clone)]
+pub struct KafkaSinkConfig {
+    pub brokers: Vec<String>,
+    pub topic: String,
+}
+
+impl KafkaSinkConfig {
+    pub fn new() -> Self {
+        Self {
+            brokers: vec!["localhost:9092".to_string()],
+            topic: "rustfs".to_string(),
+        }
+    }
+}
+
+impl Default for KafkaSinkConfig {
+    fn default() -> Self {
+        Self::new()
+    }
+}
@@ -0,0 +1,21 @@
+use serde::Deserialize;
+
+/// Logger configuration
+#[derive(Debug, Deserialize, Clone)]
+pub struct LoggerConfig {
+    pub queue_capacity: Option<usize>,
+}
+
+impl LoggerConfig {
+    pub fn new() -> Self {
+        Self {
+            queue_capacity: Some(10000),
+        }
+    }
+}
+
+impl Default for LoggerConfig {
+    fn default() -> Self {
+        Self::new()
+    }
+}
@@ -0,0 +1,8 @@
+pub(crate) mod config;
+pub(crate) mod file_sink;
+pub(crate) mod kafka_sink;
+pub(crate) mod logger;
+pub(crate) mod observability;
+pub(crate) mod otel;
+pub(crate) mod sink;
+pub(crate) mod webhook_sink;
@@ -0,0 +1,22 @@
+use crate::observability::logger::LoggerConfig;
+use crate::observability::otel::OtelConfig;
+use crate::observability::sink::SinkConfig;
+use serde::Deserialize;
+
+/// Observability configuration
+#[derive(Debug, Deserialize, Clone)]
+pub struct ObservabilityConfig {
+    pub otel: OtelConfig,
+    pub sinks: SinkConfig,
+    pub logger: Option<LoggerConfig>,
+}
+
+impl ObservabilityConfig {
+    pub fn new() -> Self {
+        Self {
+            otel: OtelConfig::new(),
+            sinks: SinkConfig::new(),
+            logger: Some(LoggerConfig::new()),
+        }
+    }
+}
@@ -0,0 +1,27 @@
+use serde::Deserialize;
+
+/// OpenTelemetry configuration
+#[derive(Debug, Deserialize, Clone)]
+pub struct OtelConfig {
+    pub endpoint: String,
+    pub service_name: String,
+    pub service_version: String,
+    pub resource_attributes: Vec<String>,
+}
+
+impl OtelConfig {
+    pub fn new() -> Self {
+        Self {
+            endpoint: "http://localhost:4317".to_string(),
+            service_name: "rustfs".to_string(),
+            service_version: "0.1.0".to_string(),
+            resource_attributes: vec![],
+        }
+    }
+}
+
+impl Default for OtelConfig {
+    fn default() -> Self {
+        Self::new()
+    }
+}
@@ -0,0 +1,28 @@
+use crate::observability::file_sink::FileSinkConfig;
+use crate::observability::kafka_sink::KafkaSinkConfig;
+use crate::observability::webhook_sink::WebhookSinkConfig;
+use serde::Deserialize;
+
+/// Sink configuration
+#[derive(Debug, Deserialize, Clone)]
+pub struct SinkConfig {
+    pub kafka: Option<KafkaSinkConfig>,
+    pub webhook: Option<WebhookSinkConfig>,
+    pub file: Option<FileSinkConfig>,
+}
+
+impl SinkConfig {
+    pub fn new() -> Self {
+        Self {
+            kafka: None,
+            webhook: None,
+            file: Some(FileSinkConfig::new()),
+        }
+    }
+}
+
+impl Default for SinkConfig {
+    fn default() -> Self {
+        Self::new()
+    }
+}
@@ -0,0 +1,25 @@
+use serde::Deserialize;
+
+/// Webhook sink configuration
+#[derive(Debug, Deserialize, Clone)]
+pub struct WebhookSinkConfig {
+    pub url: String,
+    pub method: String,
+    pub headers: Vec<(String, String)>,
+}
+
+impl WebhookSinkConfig {
+    pub fn new() -> Self {
+        Self {
+            url: "http://localhost:8080/webhook".to_string(),
+            method: "POST".to_string(),
+            headers: vec![],
+        }
+    }
+}
+
+impl Default for WebhookSinkConfig {
+    fn default() -> Self {
+        Self::new()
+    }
+}