From c6de1ae9941daa7ab347201f09e60469ddff62b2 Mon Sep 17 00:00:00 2001 From: houseme Date: Mon, 19 May 2025 17:23:17 +0800 Subject: [PATCH] feat: rename crate from `rustfs-event-notifier` to `rustfs-event` This change simplifies the crate name to better reflect its core functionality as the event handling system for RustFS. The renamed package maintains all existing functionality while improving naming consistency across the project. - Updated all imports and references to use the new crate name - Maintained API compatibility with existing implementations - Updated tests to reflect the name change --- Cargo.lock | 4 ++-- Cargo.toml | 4 ++-- crates/{event-notifier => event}/Cargo.toml | 2 +- crates/{event-notifier => event}/examples/.env.example | 0 .../{event-notifier => event}/examples/.env.zh.example | 0 crates/{event-notifier => event}/examples/event.toml | 0 crates/{event-notifier => event}/examples/full.rs | 10 +++++----- crates/{event-notifier => event}/examples/simple.rs | 8 ++++---- crates/{event-notifier => event}/examples/webhook.rs | 0 crates/{event-notifier => event}/src/adapter/kafka.rs | 0 crates/{event-notifier => event}/src/adapter/mod.rs | 0 crates/{event-notifier => event}/src/adapter/mqtt.rs | 0 .../{event-notifier => event}/src/adapter/webhook.rs | 0 crates/{event-notifier => event}/src/bus.rs | 0 crates/{event-notifier => event}/src/config.rs | 2 +- crates/{event-notifier => event}/src/error.rs | 0 crates/{event-notifier => event}/src/event.rs | 0 crates/{event-notifier => event}/src/global.rs | 0 crates/{event-notifier => event}/src/lib.rs | 0 crates/{event-notifier => event}/src/notifier.rs | 0 crates/{event-notifier => event}/src/store.rs | 0 crates/{event-notifier => event}/tests/integration.rs | 8 ++++---- rustfs/Cargo.toml | 2 +- rustfs/src/event.rs | 4 ++-- rustfs/src/main.rs | 4 ++-- rustfs/src/storage/event_notifier.rs | 4 ++-- scripts/run.sh | 2 +- 27 files changed, 27 insertions(+), 27 deletions(-) rename crates/{event-notifier => event}/Cargo.toml (97%) rename crates/{event-notifier => event}/examples/.env.example (100%) rename crates/{event-notifier => event}/examples/.env.zh.example (100%) rename crates/{event-notifier => event}/examples/event.toml (100%) rename crates/{event-notifier => event}/examples/full.rs (94%) rename crates/{event-notifier => event}/examples/simple.rs (93%) rename crates/{event-notifier => event}/examples/webhook.rs (100%) rename crates/{event-notifier => event}/src/adapter/kafka.rs (100%) rename crates/{event-notifier => event}/src/adapter/mod.rs (100%) rename crates/{event-notifier => event}/src/adapter/mqtt.rs (100%) rename crates/{event-notifier => event}/src/adapter/webhook.rs (100%) rename crates/{event-notifier => event}/src/bus.rs (100%) rename crates/{event-notifier => event}/src/config.rs (99%) rename crates/{event-notifier => event}/src/error.rs (100%) rename crates/{event-notifier => event}/src/event.rs (100%) rename crates/{event-notifier => event}/src/global.rs (100%) rename crates/{event-notifier => event}/src/lib.rs (100%) rename crates/{event-notifier => event}/src/notifier.rs (100%) rename crates/{event-notifier => event}/src/store.rs (100%) rename crates/{event-notifier => event}/tests/integration.rs (94%) diff --git a/Cargo.lock b/Cargo.lock index 48c3c13c..14e66b9e 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -7452,7 +7452,7 @@ dependencies = [ "rmp-serde", "rust-embed", "rustfs-config", - "rustfs-event-notifier", + "rustfs-event", "rustfs-obs", "rustfs-utils", "rustls 0.23.27", @@ -7490,7 +7490,7 @@ dependencies = [ ] [[package]] -name = "rustfs-event-notifier" +name = "rustfs-event" version = "0.0.1" dependencies = [ "async-trait", diff --git a/Cargo.toml b/Cargo.toml index 22e2b9e7..ab7ec092 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,7 +7,7 @@ members = [ "common/protos", # Protocol buffer definitions "common/workers", # Worker thread pools and task scheduling "crates/config", # Configuration management - "crates/event-notifier", # Event notification system + "crates/event", # Event notification system "crates/obs", # Observability utilities "crates/utils", # Utility functions and helpers "crypto", # Cryptography and security features @@ -51,7 +51,7 @@ rustfs = { path = "./rustfs", version = "0.0.1" } zip = { path = "./crates/zip", version = "0.0.1" } rustfs-config = { path = "./crates/config", version = "0.0.1" } rustfs-obs = { path = "crates/obs", version = "0.0.1" } -rustfs-event-notifier = { path = "crates/event-notifier", version = "0.0.1" } +rustfs-event = { path = "crates/event", version = "0.0.1" } rustfs-utils = { path = "crates/utils", version = "0.0.1" } workers = { path = "./common/workers", version = "0.0.1" } tokio-tar = "0.3.1" diff --git a/crates/event-notifier/Cargo.toml b/crates/event/Cargo.toml similarity index 97% rename from crates/event-notifier/Cargo.toml rename to crates/event/Cargo.toml index 3d46c72e..6d4331e0 100644 --- a/crates/event-notifier/Cargo.toml +++ b/crates/event/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "rustfs-event-notifier" +name = "rustfs-event" edition.workspace = true license.workspace = true repository.workspace = true diff --git a/crates/event-notifier/examples/.env.example b/crates/event/examples/.env.example similarity index 100% rename from crates/event-notifier/examples/.env.example rename to crates/event/examples/.env.example diff --git a/crates/event-notifier/examples/.env.zh.example b/crates/event/examples/.env.zh.example similarity index 100% rename from crates/event-notifier/examples/.env.zh.example rename to crates/event/examples/.env.zh.example diff --git a/crates/event-notifier/examples/event.toml b/crates/event/examples/event.toml similarity index 100% rename from crates/event-notifier/examples/event.toml rename to crates/event/examples/event.toml diff --git a/crates/event-notifier/examples/full.rs b/crates/event/examples/full.rs similarity index 94% rename from crates/event-notifier/examples/full.rs rename to crates/event/examples/full.rs index 23e858fb..fae56cd8 100644 --- a/crates/event-notifier/examples/full.rs +++ b/crates/event/examples/full.rs @@ -1,4 +1,4 @@ -use rustfs_event_notifier::{ +use rustfs_event::{ AdapterConfig, Bucket, Error as NotifierError, Event, Identity, Metadata, Name, NotifierConfig, Object, Source, WebhookConfig, }; use std::collections::HashMap; @@ -19,12 +19,12 @@ async fn setup_notification_system() -> Result<(), NotifierError> { })], }; - rustfs_event_notifier::initialize(config).await?; + rustfs_event::initialize(config).await?; // wait for the system to be ready for _ in 0..50 { // wait up to 5 seconds - if rustfs_event_notifier::is_ready() { + if rustfs_event::is_ready() { return Ok(()); } tokio::time::sleep(tokio::time::Duration::from_millis(100)).await; @@ -107,7 +107,7 @@ async fn main() -> Result<(), Box> { .build() .expect("failed to create event"); - if let Err(e) = rustfs_event_notifier::send_event(event).await { + if let Err(e) = rustfs_event::send_event(event).await { eprintln!("send event failed:{}", e); } @@ -122,7 +122,7 @@ async fn main() -> Result<(), Box> { // 优雅关闭通知系统 println!("turn off the notification system"); - if let Err(e) = rustfs_event_notifier::shutdown().await { + if let Err(e) = rustfs_event::shutdown().await { eprintln!("An error occurred while shutting down the notification system:{}", e); } else { println!("the notification system has been closed safely"); diff --git a/crates/event-notifier/examples/simple.rs b/crates/event/examples/simple.rs similarity index 93% rename from crates/event-notifier/examples/simple.rs rename to crates/event/examples/simple.rs index 27d422b0..5160186e 100644 --- a/crates/event-notifier/examples/simple.rs +++ b/crates/event/examples/simple.rs @@ -1,7 +1,7 @@ -use rustfs_event_notifier::create_adapters; -use rustfs_event_notifier::NotifierSystem; -use rustfs_event_notifier::{AdapterConfig, NotifierConfig, WebhookConfig}; -use rustfs_event_notifier::{Bucket, Event, Identity, Metadata, Name, Object, Source}; +use rustfs_event::create_adapters; +use rustfs_event::NotifierSystem; +use rustfs_event::{AdapterConfig, NotifierConfig, WebhookConfig}; +use rustfs_event::{Bucket, Event, Identity, Metadata, Name, Object, Source}; use std::collections::HashMap; use std::error; use std::sync::Arc; diff --git a/crates/event-notifier/examples/webhook.rs b/crates/event/examples/webhook.rs similarity index 100% rename from crates/event-notifier/examples/webhook.rs rename to crates/event/examples/webhook.rs diff --git a/crates/event-notifier/src/adapter/kafka.rs b/crates/event/src/adapter/kafka.rs similarity index 100% rename from crates/event-notifier/src/adapter/kafka.rs rename to crates/event/src/adapter/kafka.rs diff --git a/crates/event-notifier/src/adapter/mod.rs b/crates/event/src/adapter/mod.rs similarity index 100% rename from crates/event-notifier/src/adapter/mod.rs rename to crates/event/src/adapter/mod.rs diff --git a/crates/event-notifier/src/adapter/mqtt.rs b/crates/event/src/adapter/mqtt.rs similarity index 100% rename from crates/event-notifier/src/adapter/mqtt.rs rename to crates/event/src/adapter/mqtt.rs diff --git a/crates/event-notifier/src/adapter/webhook.rs b/crates/event/src/adapter/webhook.rs similarity index 100% rename from crates/event-notifier/src/adapter/webhook.rs rename to crates/event/src/adapter/webhook.rs diff --git a/crates/event-notifier/src/bus.rs b/crates/event/src/bus.rs similarity index 100% rename from crates/event-notifier/src/bus.rs rename to crates/event/src/bus.rs diff --git a/crates/event-notifier/src/config.rs b/crates/event/src/config.rs similarity index 99% rename from crates/event-notifier/src/config.rs rename to crates/event/src/config.rs index 3414f3fa..e564f726 100644 --- a/crates/event-notifier/src/config.rs +++ b/crates/event/src/config.rs @@ -100,7 +100,7 @@ impl NotifierConfig { /// /// # Example /// ``` - /// use rustfs_event_notifier::NotifierConfig; + /// use rustfs_event::NotifierConfig; /// /// let config = NotifierConfig::event_load_config(None); /// ``` diff --git a/crates/event-notifier/src/error.rs b/crates/event/src/error.rs similarity index 100% rename from crates/event-notifier/src/error.rs rename to crates/event/src/error.rs diff --git a/crates/event-notifier/src/event.rs b/crates/event/src/event.rs similarity index 100% rename from crates/event-notifier/src/event.rs rename to crates/event/src/event.rs diff --git a/crates/event-notifier/src/global.rs b/crates/event/src/global.rs similarity index 100% rename from crates/event-notifier/src/global.rs rename to crates/event/src/global.rs diff --git a/crates/event-notifier/src/lib.rs b/crates/event/src/lib.rs similarity index 100% rename from crates/event-notifier/src/lib.rs rename to crates/event/src/lib.rs diff --git a/crates/event-notifier/src/notifier.rs b/crates/event/src/notifier.rs similarity index 100% rename from crates/event-notifier/src/notifier.rs rename to crates/event/src/notifier.rs diff --git a/crates/event-notifier/src/store.rs b/crates/event/src/store.rs similarity index 100% rename from crates/event-notifier/src/store.rs rename to crates/event/src/store.rs diff --git a/crates/event-notifier/tests/integration.rs b/crates/event/tests/integration.rs similarity index 94% rename from crates/event-notifier/tests/integration.rs rename to crates/event/tests/integration.rs index c5743605..9d897238 100644 --- a/crates/event-notifier/tests/integration.rs +++ b/crates/event/tests/integration.rs @@ -1,6 +1,6 @@ -use rustfs_event_notifier::{AdapterConfig, NotifierSystem, WebhookConfig}; -use rustfs_event_notifier::{Bucket, Event, EventBuilder, Identity, Metadata, Name, Object, Source}; -use rustfs_event_notifier::{ChannelAdapter, WebhookAdapter}; +use rustfs_event::{AdapterConfig, NotifierSystem, WebhookConfig}; +use rustfs_event::{Bucket, Event, EventBuilder, Identity, Metadata, Name, Object, Source}; +use rustfs_event::{ChannelAdapter, WebhookAdapter}; use std::collections::HashMap; use std::sync::Arc; @@ -67,7 +67,7 @@ async fn test_webhook_adapter() { #[tokio::test] async fn test_notification_system() { - let config = rustfs_event_notifier::NotifierConfig { + let config = rustfs_event::NotifierConfig { store_path: "./test_events".to_string(), channel_capacity: 100, adapters: vec![AdapterConfig::Webhook(WebhookConfig { diff --git a/rustfs/Cargo.toml b/rustfs/Cargo.toml index a238665d..1f3bd2af 100644 --- a/rustfs/Cargo.toml +++ b/rustfs/Cargo.toml @@ -53,7 +53,7 @@ protos.workspace = true query = { workspace = true } rmp-serde.workspace = true rustfs-config = { workspace = true } -rustfs-event-notifier = { workspace = true } +rustfs-event = { workspace = true } rustfs-obs = { workspace = true } rustfs-utils = { workspace = true, features = ["full"] } rustls.workspace = true diff --git a/rustfs/src/event.rs b/rustfs/src/event.rs index 99e2a75c..a6819b4c 100644 --- a/rustfs/src/event.rs +++ b/rustfs/src/event.rs @@ -1,4 +1,4 @@ -use rustfs_event_notifier::NotifierConfig; +use rustfs_event::NotifierConfig; use tracing::{error, info, instrument}; #[instrument] @@ -8,7 +8,7 @@ pub(crate) async fn init_event_notifier(notifier_config: Option) { info!("event_config is not empty"); tokio::spawn(async move { let config = NotifierConfig::event_load_config(notifier_config); - let result = rustfs_event_notifier::initialize(config).await; + let result = rustfs_event::initialize(config).await; if let Err(e) = result { error!("Failed to initialize event notifier: {}", e); } else { diff --git a/rustfs/src/main.rs b/rustfs/src/main.rs index 1f158a9d..5629324e 100644 --- a/rustfs/src/main.rs +++ b/rustfs/src/main.rs @@ -562,9 +562,9 @@ async fn run(opt: config::Opt) -> Result<()> { state_manager.update(ServiceState::Stopping); // Stop the notification system - if rustfs_event_notifier::is_ready() { + if rustfs_event::is_ready() { // stop event notifier - rustfs_event_notifier::shutdown().await.map_err(|err| { + rustfs_event::shutdown().await.map_err(|err| { error!("Failed to shut down the notification system: {}", err); Error::from_string(err.to_string()) })?; diff --git a/rustfs/src/storage/event_notifier.rs b/rustfs/src/storage/event_notifier.rs index 292b45e3..59d17dba 100644 --- a/rustfs/src/storage/event_notifier.rs +++ b/rustfs/src/storage/event_notifier.rs @@ -1,4 +1,4 @@ -use rustfs_event_notifier::{Event, Metadata}; +use rustfs_event::{Event, Metadata}; /// Create a new metadata object #[allow(dead_code)] @@ -13,5 +13,5 @@ pub(crate) fn create_metadata() -> Metadata { /// Create a new event object #[allow(dead_code)] pub(crate) async fn send_event(event: Event) -> Result<(), Box> { - rustfs_event_notifier::send_event(event).await.map_err(|e| e.into()) + rustfs_event::send_event(event).await.map_err(|e| e.into()) } diff --git a/scripts/run.sh b/scripts/run.sh index d0394544..a90f8900 100755 --- a/scripts/run.sh +++ b/scripts/run.sh @@ -82,6 +82,6 @@ if [ -n "$1" ]; then fi # 启动 webhook 服务器 -#cargo run --example webhook -p rustfs-event-notifier & +#cargo run --example webhook -p rustfs-event & # 启动主服务 cargo run --bin rustfs \ No newline at end of file