Merge pull request #3864 from albinsuresh/refactor/typed-device-topic-id-in-tedge-config

refactor: typed device topic id in tedge config

Author: albinsuresh

Cargo.lock

@@ -30,6 +30,7 @@ rustls = { workspace = true }
 serde = { workspace = true, features = ["rc"] }
 strum = { workspace = true }
 strum_macros = { workspace = true }
+tedge_api = { workspace = true }
 tedge_config_macros = { workspace = true }
 tedge_utils = { workspace = true, features = ["timestamp"] }
 thiserror = { workspace = true }

crates/common/tedge_config/Cargo.toml

@@ -46,6 +46,7 @@ use std::num::NonZeroU16;
 use std::path::PathBuf;
 use std::sync::Arc;
 use std::sync::OnceLock;
+use tedge_api::mqtt_topics::EntityTopicId;
 pub use tedge_config_macros::ConfigNotSet;
 pub use tedge_config_macros::MultiError;
 pub use tedge_config_macros::ProfileName;
@@ -673,10 +674,11 @@ define_tedge_config! {
         topic_root: String,
 
         /// The device MQTT topic identifier
-        #[tedge_config(default(value = "device/main//"))]
+        #[tedge_config(default(function = "EntityTopicId::default_main_device"))]
         #[tedge_config(example = "device/main//")]
         #[tedge_config(example = "device/child_001//")]
-        device_topic_id: String,
+        #[doku(as = "String")]
+        device_topic_id: EntityTopicId,
 
         bind: {
             /// The address mosquitto binds to for internal use

crates/common/tedge_config/src/tedge_toml/tedge_config.rs

@@ -38,6 +38,7 @@ impl_append_remove_for_single_value!(
     AbsolutePath,
     String,
     ConnectUrl,
+    EntityTopicId,
     HostPort<HTTPS_PORT>,
     HostPort<MQTT_TLS_PORT>,
     HostPort<MQTT_SVC_TLS_PORT>,

crates/common/tedge_config/src/tedge_toml/tedge_config/append_remove.rs

@@ -37,7 +37,6 @@ use std::hash::Hash;
 use std::net::ToSocketAddrs;
 use std::sync::Arc;
 use std::time::Duration;
-use tedge_api::mqtt_topics::EntityTopicId;
 use tedge_api::mqtt_topics::MqttSchema;
 use tedge_api::mqtt_topics::TopicIdError;
 use tedge_api::service_health_topic;
@@ -783,7 +782,7 @@ pub(crate) fn bridge_health_topic(
     };
 
     let mqtt_schema = MqttSchema::with_root(tedge_config.mqtt.topic_root.clone());
-    let device_topic_id = tedge_config.mqtt.device_topic_id.parse::<EntityTopicId>()?;
+    let device_topic_id = tedge_config.mqtt.device_topic_id.clone();
     Ok(service_health_topic(
         &mqtt_schema,
         &device_topic_id,

crates/core/tedge/src/cli/connect/command.rs

@@ -120,11 +120,12 @@ impl AgentConfig {
             .mqtt_topic_root
             .unwrap_or(tedge_config.mqtt.topic_root.clone().into());
 
-        let mqtt_device_topic_id: EntityTopicId = cliopts
-            .mqtt_device_topic_id
-            .unwrap_or(tedge_config.mqtt.device_topic_id.clone().into())
-            .parse()
-            .context("Could not parse the device MQTT topic")?;
+        let mqtt_device_topic_id: EntityTopicId = match cliopts.mqtt_device_topic_id {
+            Some(topic_id) => topic_id
+                .parse()
+                .context("Could not parse the device MQTT topic")?,
+            None => tedge_config.mqtt.device_topic_id.clone(),
+        };
         let service_topic_id = mqtt_device_topic_id.to_default_service_topic_id("tedge-agent")
             .with_context(|| format!("Device topic id {} currently needs default scheme, e.g: 'device/DEVICE_NAME//'", mqtt_device_topic_id))?;
 

crates/core/tedge_agent/src/agent.rs

@@ -29,11 +29,7 @@ impl SoftwareManagerConfig {
             .or_none()
             .cloned();
 
-        let device = tedge_config
-            .mqtt
-            .device_topic_id
-            .parse()
-            .unwrap_or(EntityTopicId::default_main_device());
+        let device = tedge_config.mqtt.device_topic_id.clone();
 
         Ok(SoftwareManagerConfig {
             device,

crates/core/tedge_agent/src/software_manager/config.rs

@@ -6,12 +6,10 @@ use async_trait::async_trait;
 use aws_mapper_ext::converter::AwsConverter;
 use clock::WallClock;
 use mqtt_channel::TopicFilter;
-use std::str::FromStr;
 use tedge_actors::ConvertingActor;
 use tedge_actors::MessageSink;
 use tedge_actors::MessageSource;
 use tedge_actors::NoConfig;
-use tedge_api::mqtt_topics::EntityTopicId;
 use tedge_api::mqtt_topics::MqttSchema;
 use tedge_api::service_health_topic;
 use tedge_config::models::TopicPrefix;
@@ -44,7 +42,7 @@ impl TEdgeComponent for AwsMapper {
         let mqtt_schema = MqttSchema::with_root(tedge_config.mqtt.topic_root.clone());
         if tedge_config.mqtt.bridge.built_in {
             let device_id = aws_config.device.id()?;
-            let device_topic_id = EntityTopicId::from_str(&tedge_config.mqtt.device_topic_id)?;
+            let device_topic_id = tedge_config.mqtt.device_topic_id.clone();
 
             let rules = built_in_bridge_rules(device_id, prefix)?;
 

crates/core/tedge_mapper/src/aws/mapper.rs

@@ -7,12 +7,10 @@ use az_mapper_ext::converter::AzureConverter;
 use clock::WallClock;
 use mqtt_channel::TopicFilter;
 use std::borrow::Cow;
-use std::str::FromStr;
 use tedge_actors::ConvertingActor;
 use tedge_actors::MessageSink;
 use tedge_actors::MessageSource;
 use tedge_actors::NoConfig;
-use tedge_api::mqtt_topics::EntityTopicId;
 use tedge_api::mqtt_topics::MqttSchema;
 use tedge_api::service_health_topic;
 use tedge_config::models::TopicPrefix;
@@ -44,7 +42,7 @@ impl TEdgeComponent for AzureMapper {
         let mqtt_schema = MqttSchema::with_root(tedge_config.mqtt.topic_root.clone());
 
         if tedge_config.mqtt.bridge.built_in {
-            let device_topic_id = EntityTopicId::from_str(&tedge_config.mqtt.device_topic_id)?;
+            let device_topic_id = tedge_config.mqtt.device_topic_id.clone();
 
             let remote_clientid = az_config.device.id()?;
             let rules = built_in_bridge_rules(remote_clientid, prefix)?;

crates/core/tedge_mapper/src/az/mapper.rs

@@ -188,12 +188,7 @@ pub fn service_monitor_client_config(
 
     // there is one mapper instance per cloud per thin-edge instance, perhaps we should use some
     // predefined topic id instead of trying to derive it from current device?
-    let entity_topic_id: EntityTopicId = tedge_config
-        .mqtt
-        .device_topic_id
-        .clone()
-        .parse()
-        .context("Invalid device_topic_id")?;
+    let entity_topic_id: EntityTopicId = tedge_config.mqtt.device_topic_id.clone();
     let prefix = &c8y_config.bridge.topic_prefix;
 
     let mapper_service_topic_id = entity_topic_id
@@ -356,12 +351,7 @@ fn core_mqtt_bridge_config(
 
     // there is one mapper instance per cloud per thin-edge instance, perhaps we should use some
     // predefined topic id instead of trying to derive it from current device?
-    let entity_topic_id: EntityTopicId = tedge_config
-        .mqtt
-        .device_topic_id
-        .clone()
-        .parse()
-        .context("Invalid device_topic_id")?;
+    let entity_topic_id: EntityTopicId = tedge_config.mqtt.device_topic_id.clone();
 
     let mapper_service_topic_id = entity_topic_id
         .default_service_for_device(c8y_mapper_name)
@@ -464,12 +454,7 @@ fn mqtt_service_bridge_config(
         "tedge-mapper-bridge-{}",
         c8y_config.mqtt_service.topic_prefix.as_str()
     );
-    let device_topic_id: EntityTopicId = tedge_config
-        .mqtt
-        .device_topic_id
-        .clone()
-        .parse()
-        .context("Invalid device_topic_id")?;
+    let device_topic_id: EntityTopicId = tedge_config.mqtt.device_topic_id.clone();
 
     let bridge_health_topic =
         service_health_topic(&mqtt_schema, &device_topic_id, &bridge_service_name);