status method removed from trait

eclipse-zenoh · Nov 19, 2023 · d1e4b29 · d1e4b29
1 parent d1b4af8
commit d1e4b29
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 36 deletions.
diff --git a/plugins/zenoh-backend-traits/src/lib.rs b/plugins/zenoh-backend-traits/src/lib.rs
@@ -140,7 +140,7 @@ use zenoh::time::Timestamp;
 use zenoh::value::Value;
 pub use zenoh::Result as ZResult;
 use zenoh_plugin_trait::{
-    concat_enabled_features, PluginControl, PluginInstance, PluginStatus, PluginStructVersion,
+    concat_enabled_features, PluginControl, PluginInstance, PluginStatusRec, PluginStructVersion,
 };
 
 pub mod config;
@@ -235,7 +235,7 @@ impl PluginStructVersion for VolumePlugin {
 }
 
 impl PluginControl for VolumePlugin {
-    fn plugins_status(&self, _names: &zenoh::prelude::keyexpr) -> Vec<(String, PluginStatus)> {
+    fn plugins_status(&self, _names: &zenoh::prelude::keyexpr) -> Vec<(String, PluginStatusRec)> {
         Vec::new()
     }
 }

diff --git a/plugins/zenoh-plugin-storage-manager/src/lib.rs b/plugins/zenoh-plugin-storage-manager/src/lib.rs
@@ -40,7 +40,7 @@ use zenoh_core::zlock;
 use zenoh_plugin_trait::Plugin;
 use zenoh_plugin_trait::PluginControl;
 use zenoh_plugin_trait::PluginReport;
-use zenoh_plugin_trait::PluginStatus;
+use zenoh_plugin_trait::PluginStatusRec;
 use zenoh_result::ZResult;
 use zenoh_util::LibLoader;
 
@@ -247,7 +247,7 @@ impl PluginControl for StorageRuntime {
     fn report(&self) -> PluginReport {
         PluginReport::default()
     }
-    fn plugins_status(&self, names: &keyexpr) -> Vec<(String, PluginStatus)> {
+    fn plugins_status(&self, names: &keyexpr) -> Vec<(String, PluginStatusRec)> {
         let guard = self.0.lock().unwrap();
         guard
             .plugins_manager

diff --git a/plugins/zenoh-plugin-trait/src/lib.rs b/plugins/zenoh-plugin-trait/src/lib.rs
@@ -26,7 +26,7 @@ mod vtable;
 pub use manager::{DeclaredPlugin, LoadedPlugin, PluginsManager, StartedPlugin};
 pub use plugin::{
     Plugin, PluginConditionSetter, PluginControl, PluginInstance, PluginReport, PluginStartArgs,
-    PluginState, PluginStatus, PluginStatusGetter, PluginStructVersion,
+    PluginState, PluginStatus, PluginStatusRec, PluginStructVersion,
 };
 pub use vtable::{Compatibility, PluginLoaderVersion, PluginVTable, PLUGIN_LOADER_VERSION};
 

diff --git a/plugins/zenoh-plugin-trait/src/manager.rs b/plugins/zenoh-plugin-trait/src/manager.rs
@@ -23,18 +23,21 @@ use self::{
     static_plugin::StaticPlugin,
 };
 
-pub trait DeclaredPlugin<StartArgs, Instance>: PluginStatusGetter {
+pub trait DeclaredPlugin<StartArgs, Instance>: PluginStatus {
+    fn as_status(&self) -> &dyn PluginStatus;
     fn load(&mut self) -> ZResult<&mut dyn LoadedPlugin<StartArgs, Instance>>;
     fn loaded(&self) -> Option<&dyn LoadedPlugin<StartArgs, Instance>>;
     fn loaded_mut(&mut self) -> Option<&mut dyn LoadedPlugin<StartArgs, Instance>>;
 }
-pub trait LoadedPlugin<StartArgs, Instance>: PluginStatusGetter {
+pub trait LoadedPlugin<StartArgs, Instance>: PluginStatus {
+    fn as_status(&self) -> &dyn PluginStatus;
     fn start(&mut self, args: &StartArgs) -> ZResult<&mut dyn StartedPlugin<StartArgs, Instance>>;
     fn started(&self) -> Option<&dyn StartedPlugin<StartArgs, Instance>>;
     fn started_mut(&mut self) -> Option<&mut dyn StartedPlugin<StartArgs, Instance>>;
 }
 
-pub trait StartedPlugin<StartArgs, Instance>: PluginStatusGetter {
+pub trait StartedPlugin<StartArgs, Instance>: PluginStatus {
+    fn as_status(&self) -> &dyn PluginStatus;
     fn stop(&mut self);
     fn instance(&self) -> &Instance;
     fn instance_mut(&mut self) -> &mut Instance;
@@ -50,7 +53,7 @@ impl<StartArgs: PluginStartArgs, Instance: PluginInstance> PluginRecord<StartArg
     }
 }
 
-impl<StartArgs: PluginStartArgs, Instance: PluginInstance> PluginStatusGetter
+impl<StartArgs: PluginStartArgs, Instance: PluginInstance> PluginStatus
     for PluginRecord<StartArgs, Instance>
 {
     fn name(&self) -> &str {
@@ -68,14 +71,14 @@ impl<StartArgs: PluginStartArgs, Instance: PluginInstance> PluginStatusGetter
     fn report(&self) -> PluginReport {
         self.0.report()
     }
-    fn status(&self) -> PluginStatus {
-        self.0.status()
-    }
 }
 
 impl<StartArgs: PluginStartArgs, Instance: PluginInstance> DeclaredPlugin<StartArgs, Instance>
     for PluginRecord<StartArgs, Instance>
 {
+    fn as_status(&self) -> &dyn PluginStatus {
+        self
+    }
     fn load(&mut self) -> ZResult<&mut dyn LoadedPlugin<StartArgs, Instance>> {
         self.0.load()
     }
@@ -260,17 +263,18 @@ impl<StartArgs: PluginStartArgs + 'static, Instance: PluginInstance + 'static>
 impl<StartArgs: PluginStartArgs + 'static, Instance: PluginInstance + 'static> PluginControl
     for PluginsManager<StartArgs, Instance>
 {
-    fn plugins_status(&self, names: &keyexpr) -> Vec<(String, PluginStatus)> {
+    fn plugins_status(&self, names: &keyexpr) -> Vec<(String, PluginStatusRec)> {
         log::debug!(
             "Plugin manager with prefix `{}` : requested plugins_status {:?}",
             self.default_lib_prefix,
             names
         );
-        let mut plugins: Vec<(String, PluginStatus)> = Vec::new();
+        let mut plugins: Vec<(String, PluginStatusRec)> = Vec::new();
         for plugin in self.declared_plugins() {
             let name = unsafe { keyexpr::from_str_unchecked(plugin.name()) };
             if names.includes(name) {
-                plugins.push((plugin.name().to_string(), plugin.status()));
+                let status = PluginStatusRec::new(plugin.as_status());
+                plugins.push((plugin.name().to_string(), status));
             }
             // for running plugins append their subplugins prepended with the running plugin name
             if let Some(plugin) = plugin.loaded() {

diff --git a/plugins/zenoh-plugin-trait/src/manager/dynamic_plugin.rs b/plugins/zenoh-plugin-trait/src/manager/dynamic_plugin.rs
@@ -121,7 +121,7 @@ impl<StartArgs, Instance> DynamicPlugin<StartArgs, Instance> {
     }
 }
 
-impl<StartArgs: PluginStartArgs, Instance: PluginInstance> PluginStatusGetter
+impl<StartArgs: PluginStartArgs, Instance: PluginInstance> PluginStatus
     for DynamicPlugin<StartArgs, Instance>
 {
     fn name(&self) -> &str {
@@ -161,6 +161,9 @@ impl<StartArgs: PluginStartArgs, Instance: PluginInstance> PluginStatusGetter
 impl<StartArgs: PluginStartArgs, Instance: PluginInstance> DeclaredPlugin<StartArgs, Instance>
     for DynamicPlugin<StartArgs, Instance>
 {
+    fn as_status(&self) -> &dyn PluginStatus {
+        self
+    }
     fn load(&mut self) -> ZResult<&mut dyn LoadedPlugin<StartArgs, Instance>> {
         if self.starter.is_none() {
             let (lib, path) = self.source.load().add_error(&mut self.report)?;
@@ -191,6 +194,9 @@ impl<StartArgs: PluginStartArgs, Instance: PluginInstance> DeclaredPlugin<StartA
 impl<StartArgs: PluginStartArgs, Instance: PluginInstance> LoadedPlugin<StartArgs, Instance>
     for DynamicPlugin<StartArgs, Instance>
 {
+    fn as_status(&self) -> &dyn PluginStatus {
+        self
+    }
     fn start(&mut self, args: &StartArgs) -> ZResult<&mut dyn StartedPlugin<StartArgs, Instance>> {
         let starter = self
             .starter
@@ -228,6 +234,9 @@ impl<StartArgs: PluginStartArgs, Instance: PluginInstance> LoadedPlugin<StartArg
 impl<StartArgs: PluginStartArgs, Instance: PluginInstance> StartedPlugin<StartArgs, Instance>
     for DynamicPlugin<StartArgs, Instance>
 {
+    fn as_status(&self) -> &dyn PluginStatus {
+        self
+    }
     fn stop(&mut self) {
         log::debug!("Plugin `{}` stopped", self.name);
         self.report.clear();

diff --git a/plugins/zenoh-plugin-trait/src/manager/static_plugin.rs b/plugins/zenoh-plugin-trait/src/manager/static_plugin.rs
@@ -35,8 +35,7 @@ where
     }
 }
 
-impl<StartArgs, Instance: PluginInstance, P> PluginStatusGetter
-    for StaticPlugin<StartArgs, Instance, P>
+impl<StartArgs, Instance: PluginInstance, P> PluginStatus for StaticPlugin<StartArgs, Instance, P>
 where
     P: Plugin<StartArgs = StartArgs, Instance = Instance>,
 {
@@ -68,6 +67,9 @@ impl<StartArgs, Instance: PluginInstance, P> DeclaredPlugin<StartArgs, Instance>
 where
     P: Plugin<StartArgs = StartArgs, Instance = Instance>,
 {
+    fn as_status(&self) -> &dyn PluginStatus {
+        self
+    }
     fn load(&mut self) -> ZResult<&mut dyn LoadedPlugin<StartArgs, Instance>> {
         Ok(self)
     }
@@ -84,6 +86,9 @@ impl<StartArgs, Instance: PluginInstance, P> LoadedPlugin<StartArgs, Instance>
 where
     P: Plugin<StartArgs = StartArgs, Instance = Instance>,
 {
+    fn as_status(&self) -> &dyn PluginStatus {
+        self
+    }
     fn start(&mut self, args: &StartArgs) -> ZResult<&mut dyn StartedPlugin<StartArgs, Instance>> {
         if self.instance.is_none() {
             log::debug!("Plugin `{}` started", self.name());
@@ -114,6 +119,9 @@ impl<StartArgs, Instance: PluginInstance, P> StartedPlugin<StartArgs, Instance>
 where
     P: Plugin<StartArgs = StartArgs, Instance = Instance>,
 {
+    fn as_status(&self) -> &dyn PluginStatus {
+        self
+    }
     fn stop(&mut self) {
         log::debug!("Plugin `{}` stopped", self.name());
         self.instance = None;

diff --git a/plugins/zenoh-plugin-trait/src/plugin.rs b/plugins/zenoh-plugin-trait/src/plugin.rs
@@ -59,7 +59,7 @@ pub struct PluginReport {
 
 /// The status of a plugin contains all information about the plugin in single cloneable structure
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
-pub struct PluginStatus<'a> {
+pub struct PluginStatusRec<'a> {
     pub name: Cow<'a, str>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub version: Option<Cow<'a, str>>,
@@ -68,9 +68,20 @@ pub struct PluginStatus<'a> {
     pub report: PluginReport,
 }
 
-impl PluginStatus<'_> {
-    pub fn into_owned(self) -> PluginStatus<'static> {
-        PluginStatus {
+impl<'a> PluginStatusRec<'a> {
+    /// Construst status fructure from the getter interface
+    pub fn new<T: PluginStatus + ?Sized>(plugin: &'a T) -> Self {
+        Self {
+            name: Cow::Borrowed(plugin.name()),
+            version: plugin.version().map(Cow::Borrowed),
+            path: Cow::Borrowed(plugin.path()),
+            state: plugin.state(),
+            report: plugin.report(),
+        }
+    }
+    /// Convert status structure to owned version
+    pub fn into_owned(self) -> PluginStatusRec<'static> {
+        PluginStatusRec {
             name: Cow::Owned(self.name.into_owned()),
             version: self.version.map(|v| Cow::Owned(v.into_owned())),
             path: Cow::Owned(self.path.into_owned()),
@@ -80,7 +91,7 @@ impl PluginStatus<'_> {
     }
 }
 
-pub trait PluginStatusGetter {
+pub trait PluginStatus {
     /// Returns name of the plugin
     fn name(&self) -> &str;
     /// Returns version of the loaded plugin (usually the version of the plugin's crate)
@@ -92,24 +103,14 @@ pub trait PluginStatusGetter {
     /// Returns the plugin's current report: a list of messages and the severity level
     /// When status is changed, report is cleared
     fn report(&self) -> PluginReport;
-    /// Returns all the information about the plugin in signed structure
-    fn status(&self) -> PluginStatus {
-        PluginStatus {
-            name: Cow::Borrowed(self.name()),
-            version: self.version().map(Cow::Borrowed),
-            path: Cow::Borrowed(self.path()),
-            state: self.state(),
-            report: self.report(),
-        }
-    }
 }
 
 pub trait PluginControl {
     fn report(&self) -> PluginReport {
         PluginReport::default()
     }
     /// Collect information of sub-plugins matching `_names` keyexpr
-    fn plugins_status(&self, _names: &keyexpr) -> Vec<(String, PluginStatus)> {
+    fn plugins_status(&self, _names: &keyexpr) -> Vec<(String, PluginStatusRec)> {
         Vec::new()
     }
 }

diff --git a/zenoh/src/plugins/sealed.rs b/zenoh/src/plugins/sealed.rs
@@ -23,7 +23,7 @@ use zenoh_plugin_trait::Plugin;
 use zenoh_plugin_trait::PluginControl;
 use zenoh_plugin_trait::PluginInstance;
 use zenoh_plugin_trait::PluginReport;
-use zenoh_plugin_trait::PluginStatus;
+use zenoh_plugin_trait::PluginStatusRec;
 use zenoh_plugin_trait::PluginStructVersion;
 use zenoh_protocol::core::key_expr::keyexpr;
 
@@ -53,7 +53,7 @@ impl PluginControl for RunningPlugin {
         self.as_ref().report()
     }
 
-    fn plugins_status(&self, names: &keyexpr) -> Vec<(String, PluginStatus)> {
+    fn plugins_status(&self, names: &keyexpr) -> Vec<(String, PluginStatusRec)> {
         self.as_ref().plugins_status(names)
     }
 }