Apply more review suggestions

Signed-off-by: James Rhodes <jarhodes314@gmail.com>

Author: jarhodes314

Cargo.lock

@@ -455,7 +455,7 @@ define_tedge_config! {
 
             #[tedge_config(default(value = false))]
             #[doku(skip)] // Hide the configuration in `tedge config list --doc`
-            in_mapper: bool,
+            built_in: bool,
 
             // TODO validation
             /// The topic prefix that will be used for the mapper bridge MQTT topic. For instance,
@@ -818,10 +818,15 @@ define_tedge_config! {
 }
 
 impl ReadableKey {
-    // This is designed to be simple way of
+    // This is designed to be a simple way of controlling whether values appear in the output of
+    // `tedge config list`. Ideally this would be integrated into [define_tedge_config], see
+    // https://github.com/thin-edge/thin-edge.io/issues/2767 for more detail on that.
+    // Currently this accompanies `#[doku(skip)]` on the relevant configurations, which hides
+    // them in `tedge config list --doc`. The configurations are hidden to avoid unfinished
+    // features from being discovered.
     pub fn is_printable_value(self, value: &str) -> bool {
         match self {
-            Self::C8yBridgeInMapper => value != "false",
+            Self::C8yBridgeBuiltIn => value != "false",
             Self::C8yBridgeTopicPrefix => value != "c8y",
             _ => true,
         }

crates/common/tedge_config/src/tedge_config_cli/tedge_config.rs

@@ -1,19 +1,14 @@
 pub mod bridge {
     use mqtt_channel::Message;
-
-    // FIXME: doesn't account for custom topic root, use MQTT scheme API here
-    pub const C8Y_BRIDGE_UP_PAYLOAD: &str = "1";
-    pub const C8Y_BRIDGE_DOWN_PAYLOAD: &str = "0";
-
-    pub fn main_device_health_topic(service: &str) -> String {
-        format!("te/device/main/service/{service}/status/health")
-    }
+    use tedge_api::main_device_health_topic;
+    use tedge_api::MQTT_BRIDGE_DOWN_PAYLOAD;
+    use tedge_api::MQTT_BRIDGE_UP_PAYLOAD;
 
     pub fn is_c8y_bridge_up(message: &Message, service: &str) -> bool {
         let c8y_bridge_health_topic = main_device_health_topic(service);
         match message.payload_str() {
             Ok(payload) => {
-                message.topic.name == c8y_bridge_health_topic && payload == C8Y_BRIDGE_UP_PAYLOAD
+                message.topic.name == c8y_bridge_health_topic && payload == MQTT_BRIDGE_UP_PAYLOAD
             }
             Err(_err) => false,
         }
@@ -24,7 +19,7 @@ pub mod bridge {
         match message.payload_str() {
             Ok(payload) => {
                 message.topic.name == c8y_bridge_health_topic
-                    && (payload == C8Y_BRIDGE_UP_PAYLOAD || payload == C8Y_BRIDGE_DOWN_PAYLOAD)
+                    && (payload == MQTT_BRIDGE_UP_PAYLOAD || payload == MQTT_BRIDGE_DOWN_PAYLOAD)
             }
             Err(_err) => false,
         }

crates/core/c8y_api/src/utils.rs

@@ -38,7 +38,7 @@ pub struct BridgeConfig {
 #[derive(Debug, Eq, PartialEq, Clone, Copy)]
 pub enum BridgeLocation {
     Mosquitto,
-    Mapper,
+    BuiltIn,
 }
 
 impl BridgeConfig {

crates/core/tedge/src/bridge/config.rs

@@ -197,8 +197,8 @@ pub fn bridge_config(
             Ok(BridgeConfig::from(params))
         }
         Cloud::C8y => {
-            let bridge_location = match config.c8y.bridge.in_mapper {
-                true => BridgeLocation::Mapper,
+            let bridge_location = match config.c8y.bridge.built_in {
+                true => BridgeLocation::BuiltIn,
                 false => BridgeLocation::Mosquitto,
             };
             let params = BridgeConfigC8yParams {
@@ -440,7 +440,7 @@ fn new_bridge(
     config_location: &TEdgeConfigLocation,
     device_type: &str,
 ) -> Result<(), ConnectError> {
-    if bridge_config.bridge_location == BridgeLocation::Mapper {
+    if bridge_config.bridge_location == BridgeLocation::BuiltIn {
         clean_up(config_location, bridge_config)?;
         return Ok(());
     }

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

@@ -11,6 +11,14 @@ use std::process;
 use std::sync::Arc;
 use tedge_utils::timestamp::TimeFormat;
 
+pub const MQTT_BRIDGE_UP_PAYLOAD: &str = "1";
+pub const MQTT_BRIDGE_DOWN_PAYLOAD: &str = "0";
+
+// FIXME: doesn't account for custom topic root, use MQTT scheme API here
+pub fn main_device_health_topic(service: &str) -> String {
+    format!("te/device/main/service/{service}/status/health")
+}
+
 /// Encodes a valid health topic.
 ///
 /// Health topics are topics on which messages about health status of services are published. To be

crates/core/tedge_api/src/health.rs

@@ -23,6 +23,7 @@ pub mod workflow;
 pub use download::*;
 pub use entity_store::EntityStore;
 pub use error::*;
+pub use health::*;
 pub use messages::CommandStatus;
 pub use messages::Jsonify;
 pub use messages::OperationStatus;

crates/core/tedge_api/src/lib.rs

@@ -38,7 +38,7 @@ impl TEdgeComponent for CumulocityMapper {
 
         let mqtt_config = tedge_config.mqtt_config()?;
         let c8y_mapper_config = C8yMapperConfig::from_tedge_config(cfg_dir, &tedge_config)?;
-        if tedge_config.c8y.bridge.in_mapper {
+        if tedge_config.c8y.bridge.built_in {
             let custom_topics = tedge_config
                 .c8y
                 .smartrest

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

@@ -8,7 +8,6 @@ use c8y_api::smartrest::smartrest_serializer::succeed_static_operation;
 use c8y_api::smartrest::smartrest_serializer::CumulocitySupportedOperations;
 use c8y_api::smartrest::smartrest_serializer::SmartRest;
 use c8y_api::utils::bridge::is_c8y_bridge_established;
-use c8y_api::utils::bridge::main_device_health_topic;
 use c8y_auth_proxy::url::ProxyUrlGenerator;
 use c8y_http_proxy::handle::C8YHttpProxy;
 use c8y_http_proxy::messages::C8YRestRequest;
@@ -33,6 +32,7 @@ use tedge_actors::Service;
 use tedge_actors::ServiceProvider;
 use tedge_actors::SimpleMessageBox;
 use tedge_actors::SimpleMessageBoxBuilder;
+use tedge_api::main_device_health_topic;
 use tedge_downloader_ext::DownloadRequest;
 use tedge_downloader_ext::DownloadResult;
 use tedge_file_system_ext::FsWatchEvent;

crates/extensions/c8y_mapper_ext/src/actor.rs

@@ -197,7 +197,7 @@ impl C8yMapperConfig {
             }
         }
 
-        let bridge_in_mapper = tedge_config.c8y.bridge.in_mapper;
+        let bridge_in_mapper = tedge_config.c8y.bridge.built_in;
 
         Ok(C8yMapperConfig::new(
             config_dir,