Merge pull request #21 from lowhung/lowhung/add-global-configuration

sandtreader · web-flow · commit 64a89ed70b5a · 2025-11-27T18:01:19.000Z
feat: add global configuration support for module initialization
diff --git a/examples/multi/src/publisher1.rs b/examples/multi/src/publisher1.rs
@@ -1,6 +1,6 @@
 //! Sample Caraytid module - publisher side
 use anyhow::Result;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use config::Config;
 use serde_json::json;
 use std::sync::Arc;
diff --git a/examples/multi/src/publisher2.rs b/examples/multi/src/publisher2.rs
@@ -1,6 +1,6 @@
 //! Sample Caraytid module - publisher side
 use anyhow::Result;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use config::Config;
 use serde_json::json;
 use std::sync::Arc;
diff --git a/examples/multi/src/subscriber.rs b/examples/multi/src/subscriber.rs
@@ -1,6 +1,6 @@
 //! Simple Caraytid module - subscriber side
 use anyhow::Result;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use config::Config;
 use std::sync::Arc;
 use tracing::info;
diff --git a/examples/performance/src/publisher.rs b/examples/performance/src/publisher.rs
@@ -2,7 +2,7 @@
 use crate::message::Message;
 use anyhow::Result;
 use arcstr::ArcStr;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use config::Config;
 use futures::future::join_all;
 use std::sync::Arc;
diff --git a/examples/performance/src/subscriber.rs b/examples/performance/src/subscriber.rs
@@ -1,7 +1,7 @@
 //! Caraytid performance test - subscriber side
 use crate::message::Message;
 use anyhow::Result;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use config::Config;
 use std::sync::Arc;
 use tokio::sync::Mutex;
diff --git a/examples/request/src/requester.rs b/examples/request/src/requester.rs
@@ -1,6 +1,6 @@
 //! Sample Caraytid module - requester side
 use anyhow::Result;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use config::Config;
 use serde_json::json;
 use std::sync::Arc;
diff --git a/examples/request/src/responder.rs b/examples/request/src/responder.rs
@@ -1,6 +1,6 @@
 //! Simple Caraytid module - responder side
 use anyhow::Result;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use config::Config;
 use serde_json::Value;
 use std::sync::Arc;
diff --git a/examples/rest/src/rest_hello_world.rs b/examples/rest/src/rest_hello_world.rs
@@ -2,7 +2,7 @@
 use crate::message::Message;
 use anyhow::Result;
 use caryatid_module_rest_server::messages::RESTResponse;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use config::Config;
 use futures::future;
 use std::sync::Arc;
diff --git a/examples/simple/src/publisher.rs b/examples/simple/src/publisher.rs
@@ -1,6 +1,6 @@
 //! Sample Caraytid module - publisher side
 use anyhow::Result;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use config::Config;
 use serde_json::json;
 use std::sync::Arc;
diff --git a/examples/simple/src/subscriber.rs b/examples/simple/src/subscriber.rs
@@ -1,6 +1,6 @@
 //! Simple Caraytid module - subscriber side
 use anyhow::Result;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use config::Config;
 use std::sync::Arc;
 use tracing::info;
diff --git a/examples/typed/src/publisher.rs b/examples/typed/src/publisher.rs
@@ -1,7 +1,7 @@
 //! Typed messages Caraytid module - publisher side
 use crate::message::{Message, Test};
 use anyhow::Result;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use config::Config;
 use serde_json::json;
 use std::sync::Arc;
diff --git a/examples/typed/src/subscriber.rs b/examples/typed/src/subscriber.rs
@@ -1,7 +1,7 @@
 //! Simple Caraytid module - subscriber side
 use crate::message::Message;
 use anyhow::Result;
-use caryatid_sdk::{module, Context, Module};
+use caryatid_sdk::{module, Context};
 use chrono::Local;
 use config::Config;
 use std::sync::Arc;
diff --git a/modules/clock/Cargo.toml b/modules/clock/Cargo.toml
@@ -9,10 +9,9 @@ description = "Clock module for Caryatid"
 license = "Apache-2.0"
 
 [dependencies]
-caryatid_sdk = { version="0.13", path = "../../sdk" }
+caryatid_sdk = { version = "0.14", path = "../../sdk" }
 anyhow = "1.0"
 tokio = { version = "1", features = ["full"] }
-serde_json = "1.0"
 config = "0.15.11"
 tracing = "0.1.40"
 tracing-subscriber = "0.3.18"
diff --git a/modules/playback/Cargo.toml b/modules/playback/Cargo.toml
@@ -9,7 +9,7 @@ description = "Message playback module for Caryatid"
 license = "Apache-2.0"
 
 [dependencies]
-caryatid_sdk = { version="0.13", path = "../../sdk" }
+caryatid_sdk = { version = "0.14", path = "../../sdk" }
 anyhow = "1.0"
 serde_json = "1.0"
 config = "0.15.11"
diff --git a/modules/playback/src/playback.rs b/modules/playback/src/playback.rs
@@ -1,7 +1,7 @@
 //! Caryatid Playback module
 
 use anyhow::{Error, Result};
-use caryatid_sdk::{module, Context, MessageBounds, Module};
+use caryatid_sdk::{module, Context, MessageBounds};
 use config::Config;
 use std::fs::read_to_string;
 use std::path::{Path, PathBuf};
diff --git a/modules/record/Cargo.toml b/modules/record/Cargo.toml
@@ -9,7 +9,7 @@ description = "Message recording module for Caryatid"
 license = "Apache-2.0"
 
 [dependencies]
-caryatid_sdk = { version="0.13", path = "../../sdk" }
+caryatid_sdk = { version = "0.14", path = "../../sdk" }
 anyhow = "1.0"
 serde_json = "1.0"
 config = "0.15.11"
diff --git a/modules/record/src/record.rs b/modules/record/src/record.rs
@@ -1,7 +1,7 @@
 //! Caryatid Record module
 
 use anyhow::{Error, Result};
-use caryatid_sdk::{module, Context, MessageBounds, Module};
+use caryatid_sdk::{module, Context, MessageBounds};
 use config::Config;
 use std::fs::File;
 use std::path::{Path, PathBuf};
diff --git a/modules/rest_server/Cargo.toml b/modules/rest_server/Cargo.toml
@@ -9,9 +9,8 @@ description = "REST server module for Caryatid"
 license = "Apache-2.0"
 
 [dependencies]
-caryatid_sdk = { version="0.13", path = "../../sdk" }
+caryatid_sdk = { version = "0.14", path = "../../sdk" }
 anyhow = "1.0"
-serde_json = "1.0"
 config = "0.15.11"
 tracing = "0.1.40"
 tracing-subscriber = "0.3.18"
diff --git a/modules/spy/Cargo.toml b/modules/spy/Cargo.toml
@@ -9,13 +9,10 @@ description = "Spy module for Caryatid"
 license = "Apache-2.0"
 
 [dependencies]
-caryatid_sdk = { version="0.13", path = "../../sdk" }
+caryatid_sdk = { version = "0.14", path = "../../sdk" }
 anyhow = "1.0"
-tokio = { version = "1", features = ["full"] }
-serde_json = "1.0"
 config = "0.15.11"
 tracing = "0.1.40"
-serde = { version = "1.0.214", features = ["derive"] }
 
 [lib]
 path = "src/spy.rs"
diff --git a/modules/spy/src/spy.rs b/modules/spy/src/spy.rs
@@ -1,7 +1,7 @@
 //! Caryatid Spy module
 
 use anyhow::Result;
-use caryatid_sdk::{module, Context, MessageBounds, Module};
+use caryatid_sdk::{module, Context, MessageBounds};
 use config::Config;
 use std::sync::Arc;
 use tracing::{error, info};
diff --git a/process/Cargo.toml b/process/Cargo.toml
@@ -1,14 +1,14 @@
 # Caraytid process - loads and runs modules
 [package]
 name = "caryatid_process"
-version = "0.13.0"
+version = "0.13.1"
 edition = "2021"
 authors = ["Paul Clark <paul.clark@iohk.io>"]
 description = "Library for building a Caryatid process"
 license = "Apache-2.0"
 
 [dependencies]
-caryatid_sdk = { version="0.13", path = "../sdk" }
+caryatid_sdk = { version="0.14", path = "../sdk" }
 futures = "0.3"
 anyhow = "1.0"
 tokio = { version = "1", features = ["full"] }
diff --git a/process/src/process.rs b/process/src/process.rs
@@ -2,7 +2,7 @@
 //! Loads and runs modules built with caryatid-sdk
 
 use anyhow::{anyhow, Result};
-use caryatid_sdk::config::{config_from_value, get_sub_config};
+use caryatid_sdk::config::{build_module_config, config_from_value, get_sub_config};
 use caryatid_sdk::context::GlobalContext;
 use caryatid_sdk::{Context, MessageBounds, MessageBus, Module, ModuleRegistry};
 use config::Config;
@@ -58,7 +58,7 @@ impl<M: MessageBounds> Process<M> {
             }
         };
 
-        return Ok(BusInfo { id, bus });
+        Ok(BusInfo { id, bus })
     }
 
     /// Create a process with the given config
@@ -78,7 +78,6 @@ impl<M: MessageBounds> Process<M> {
                             Ok(bus) => {
                                 buses.push(Arc::new(bus));
                             }
-
                             _ => {}
                         }
                     }
@@ -112,36 +111,38 @@ impl<M: MessageBounds> Process<M> {
         }
 
         // Initialise all the modules from [module.<id>] configuration
-        if let Ok(mod_confs) = self.config.get_table("module") {
-            for (id, mod_conf) in mod_confs {
-                if let Ok(modt) = mod_conf.into_table() {
-                    let modc = config_from_value(modt);
-                    let mut module_name = id.clone(); // Default
-                    if let Ok(class) = modc.get_string("class") {
-                        module_name = class;
-                    }
-
-                    // Look up the module
-                    if let Some(module) = self.modules.get(&module_name) {
-                        info!("Initialising module {id}");
-                        let message_bus = self.context.message_bus.clone();
-                        let message_bus = if let Some(m) = &mut monitor {
-                            m.spy_on_bus(&module_name, message_bus)
-                        } else {
-                            message_bus
-                        };
-                        let context = Arc::new(Context::new(
-                            self.config.clone(),
-                            message_bus,
-                            self.context.startup_watch.subscribe(),
-                        ));
-                        module.init(context, Arc::new(modc)).await.unwrap();
-                    } else {
-                        error!("Unrecognised module class: {module_name} in [module.{id}]");
-                    }
-                } else {
+        if let Ok(module_cfgs) = self.config.get_table("module") {
+            for (id, module_cfg) in module_cfgs {
+                let Ok(module_tbl) = module_cfg.into_table() else {
                     warn!("Bad configuration for module {id} ignored");
-                }
+                    continue;
+                };
+
+                let module_cfg = build_module_config(&self.config, module_tbl);
+                let module_name = module_cfg
+                    .get_string("class")
+                    .unwrap_or_else(|_| id.clone());
+
+                let Some(module) = self.modules.get(&module_name) else {
+                    error!("Unrecognised module class: {module_name} in [module.{id}]");
+                    continue;
+                };
+
+                info!("Initialising module {id}");
+
+                let message_bus = self.context.message_bus.clone();
+                let message_bus = match &mut monitor {
+                    Some(m) => m.spy_on_bus(&module_name, message_bus),
+                    None => message_bus,
+                };
+
+                let context = Arc::new(Context::new(
+                    self.config.clone(),
+                    message_bus,
+                    self.context.startup_watch.subscribe(),
+                ));
+
+                module.init(context, Arc::new(module_cfg)).await?;
             }
         }
 
@@ -151,9 +152,9 @@ impl<M: MessageBounds> Process<M> {
             tokio::spawn(monitor.monitor());
         }
 
-        // Send startup message if required
+        // Send the startup message if required
         let _ = self.context.startup_watch.send(true);
-        if let Ok(topic) = self.config.get_string("startup.topic") {
+        if let Ok(topic) = self.config.get_string("global.startup.topic") {
             self.context
                 .message_bus
                 .publish(&topic, Arc::new(M::default()))
diff --git a/sdk/Cargo.toml b/sdk/Cargo.toml
@@ -2,7 +2,7 @@
 
 [package]
 name = "caryatid_sdk"
-version = "0.13.1"
+version = "0.14.0"
 edition = "2021"
 authors = ["Paul Clark <paul.clark@iohk.io>"]
 description = "The Caryatid framework module SDK"
@@ -12,12 +12,10 @@ license = "Apache-2.0"
 tokio = { version = "1", features = ["full"] }
 anyhow = "1.0"
 futures = "0.3"
-serde_json = "1.0"
 config = "0.15.11"
 caryatid_macros = { version="0.8", path = "macros" }
 tracing = "0.1.40"
 serde = { version = "1.0.214", features = ["derive"] }
-chrono = { version = "0.4", features = ["serde"] }
 rand = "0.9"
 hex = "0.4.3"
 async-trait = "0.1.88"
diff --git a/sdk/src/config.rs b/sdk/src/config.rs
