whispeer 0.0.22

A plugin-based pub/sub messaging system
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use crate::plugins::plugin::Plugin;
use std::collections::HashMap;

/// Manages the registered plugins and their lifecycle.
///
/// The `PluginManager` holds a list of active plugins and is responsible for invoking
/// their respective hooks at the appropriate times in the broker's lifecycle.
pub struct PluginManager {
  plugins: Vec<Box<dyn Plugin>>,
}

impl PluginManager {
  /// Creates a new, empty `PluginManager`.
  pub fn new() -> Self {
    Self {
      plugins: Vec::new(),
    }
  }

  /// Adds a plugin to the manager.
  ///
  /// # Arguments
  ///
  /// * `plugin` - A boxed `Plugin` trait object.
  pub fn add_plugin(&mut self, plugin: Box<dyn Plugin>) {
    self.plugins.push(plugin);
  }

  /// Invokes the `on_publish` hook on all registered plugins.
  pub async fn on_publish(
    &self,
    topic: &str,
    payload: &mut Vec<u8>,
    headers: &mut HashMap<String, String>,
  ) -> Result<(), anyhow::Error> {
    for plugin in &self.plugins {
      plugin.on_publish(topic, payload, headers).await?;
    }
    Ok(())
  }

  /// Invokes the `on_before_recieved` hook on all registered plugins.
  pub async fn on_before_recieve(
    &self,
    topic: &str,
    payload: &mut Vec<u8>,
    headers: &mut HashMap<String, String>,
  ) -> Result<String, anyhow::Error> {
    let orig_topic = topic;
    let mut topic = topic.to_string();
    for plugin in &self.plugins {
      topic = plugin
        .on_before_recieved(orig_topic, payload, headers)
        .await?;
    }
    Ok(topic)
  }

  /// Invokes the `on_message_received` hook on all registered plugins.
  ///
  /// Note: This method executes the plugins in reverse order to ensure that symmetric
  /// operations (like compression/encryption on publish and decompression/decryption
  /// on receive) are handled correctly.
  pub async fn on_message_received(
    &self,
    topic: &str,
    payload: &mut Vec<u8>,
    headers: &HashMap<String, String>,
  ) -> Result<(), anyhow::Error> {
    for plugin in self.plugins.iter().rev() {
      plugin.on_message_received(topic, payload, headers).await?;
    }
    Ok(())
  }

  /// Invokes the `on_subscribe` hook on all registered plugins.
  pub async fn on_subscribe(&self, topic: &str) -> Result<(), anyhow::Error> {
    for plugin in &self.plugins {
      plugin.on_subscribe(topic).await?;
    }
    Ok(())
  }
}