public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH proxmox 14/55] notify: move Notification and sub-types to `notification` module
Date: Fri, 13 Nov 2026 16:07:47 +0100	[thread overview]
Message-ID: <20261113150828.756836-15-l.wagner@proxmox.com> (raw)
In-Reply-To: <20261113150828.756836-1-l.wagner@proxmox.com>

No functional changes.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 proxmox-notify/src/lib.rs          | 164 +----------------------------
 proxmox-notify/src/notification.rs | 164 +++++++++++++++++++++++++++++
 2 files changed, 166 insertions(+), 162 deletions(-)
 create mode 100644 proxmox-notify/src/notification.rs

diff --git a/proxmox-notify/src/lib.rs b/proxmox-notify/src/lib.rs
index 4407ae80d..f0d0f3866 100644
--- a/proxmox-notify/src/lib.rs
+++ b/proxmox-notify/src/lib.rs
@@ -1,14 +1,6 @@
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![deny(unsafe_code)]
 
-use std::{collections::HashMap, fmt::Display, str::FromStr};
-
-use serde::{Deserialize, Serialize};
-use serde_json::Value;
-
-use proxmox_schema::api;
-use proxmox_uuid::Uuid;
-
 #[cfg(feature = "api-impl")]
 pub mod api;
 
@@ -31,157 +23,5 @@ pub use config::Config;
 pub use context::Context;
 pub use context::ContextImpl;
 
-#[api()]
-#[derive(Clone, Debug, Copy, Serialize, Deserialize, PartialEq, Eq, PartialOrd)]
-#[serde(rename_all = "kebab-case")]
-/// Severity of a notification
-pub enum Severity {
-    /// General information
-    Info,
-    /// A noteworthy event
-    Notice,
-    /// Warning
-    Warning,
-    /// Error
-    Error,
-    /// Unknown severity (e.g. forwarded system mails)
-    Unknown,
-}
-
-impl Display for Severity {
-    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::result::Result<(), std::fmt::Error> {
-        match self {
-            Severity::Info => f.write_str("info"),
-            Severity::Notice => f.write_str("notice"),
-            Severity::Warning => f.write_str("warning"),
-            Severity::Error => f.write_str("error"),
-            Severity::Unknown => f.write_str("unknown"),
-        }
-    }
-}
-
-impl FromStr for Severity {
-    type Err = Error;
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
-        match s {
-            "info" => Ok(Self::Info),
-            "notice" => Ok(Self::Notice),
-            "warning" => Ok(Self::Warning),
-            "error" => Ok(Self::Error),
-            "unknown" => Ok(Self::Unknown),
-            _ => Err(Error::invalid_config(format!("invalid severity {s}"))),
-        }
-    }
-}
-
-#[derive(Debug, Clone, Serialize, Deserialize)]
-#[serde(rename_all = "kebab-case")]
-pub enum Content {
-    /// Title and body will be rendered as a template
-    #[serde(rename_all = "kebab-case")]
-    Template {
-        /// Name of the used template
-        template_name: String,
-        /// Data that can be used for template rendering.
-        data: Value,
-    },
-    #[cfg(feature = "mail-forwarder")]
-    #[serde(rename_all = "kebab-case")]
-    ForwardedMail {
-        /// Raw mail contents
-        raw: Vec<u8>,
-        /// Fallback title
-        title: String,
-        /// Fallback body
-        body: String,
-        /// UID to use when calling sendmail
-        #[allow(dead_code)] // Unused in some feature flag permutations
-        uid: Option<u32>,
-    },
-}
-
-#[derive(Debug, Clone, Serialize, Deserialize)]
-#[serde(rename_all = "kebab-case")]
-pub struct Metadata {
-    /// Notification severity
-    severity: Severity,
-    /// Timestamp of the notification as a UNIX epoch
-    timestamp: i64,
-    /// Additional fields for additional key-value metadata
-    additional_fields: HashMap<String, String>,
-}
-
-#[derive(Debug, Clone, Serialize, Deserialize)]
-#[serde(rename_all = "kebab-case")]
-/// Notification which can be sent
-pub struct Notification {
-    /// Notification content
-    content: Content,
-    /// Metadata
-    metadata: Metadata,
-    /// Unique ID
-    id: Uuid,
-}
-
-impl Notification {
-    pub fn from_template<S: AsRef<str>>(
-        severity: Severity,
-        template_name: S,
-        template_data: Value,
-        fields: HashMap<String, String>,
-    ) -> Self {
-        Self {
-            metadata: Metadata {
-                severity,
-                additional_fields: fields,
-                timestamp: proxmox_time::epoch_i64(),
-            },
-            content: Content::Template {
-                template_name: template_name.as_ref().to_string(),
-                data: template_data,
-            },
-            id: Uuid::generate(),
-        }
-    }
-    #[cfg(feature = "mail-forwarder")]
-    pub fn new_forwarded_mail(raw_mail: &[u8], uid: Option<u32>) -> Result<Self, Error> {
-        let message = mail_parser::MessageParser::default()
-            .parse(raw_mail)
-            .ok_or_else(|| Error::invalid_forwarded_message("could not parse forwarded email"))?;
-
-        let title = message.subject().unwrap_or_default().into();
-        let body = message.body_text(0).unwrap_or_default().into();
-
-        let mut additional_fields = HashMap::new();
-        additional_fields.insert("hostname".into(), proxmox_sys::nodename().into());
-        additional_fields.insert("type".into(), "system-mail".into());
-
-        Ok(Self {
-            // Unfortunately we cannot reasonably infer the severity from the
-            // mail contents, so just set it to the highest for now so that
-            // it is not filtered out.
-            content: Content::ForwardedMail {
-                raw: raw_mail.into(),
-                title,
-                body,
-                uid,
-            },
-            metadata: Metadata {
-                severity: Severity::Unknown,
-                additional_fields,
-                timestamp: proxmox_time::epoch_i64(),
-            },
-            id: Uuid::generate(),
-        })
-    }
-
-    /// Return the unique ID of this notification.
-    pub fn id(&self) -> &Uuid {
-        &self.id
-    }
-
-    /// Return the notification's timestamp
-    pub fn timestamp(&self) -> i64 {
-        self.metadata.timestamp
-    }
-}
+mod notification;
+pub use notification::*;
diff --git a/proxmox-notify/src/notification.rs b/proxmox-notify/src/notification.rs
new file mode 100644
index 000000000..426a2259a
--- /dev/null
+++ b/proxmox-notify/src/notification.rs
@@ -0,0 +1,164 @@
+use std::{collections::HashMap, fmt::Display, str::FromStr};
+
+use serde::{Deserialize, Serialize};
+use serde_json::Value;
+
+use proxmox_schema::api;
+use proxmox_uuid::Uuid;
+
+use crate::Error;
+
+#[api]
+#[derive(Clone, Debug, Copy, Serialize, Deserialize, PartialEq, Eq, PartialOrd)]
+#[serde(rename_all = "kebab-case")]
+/// Severity of a notification
+pub enum Severity {
+    /// General information
+    Info,
+    /// A noteworthy event
+    Notice,
+    /// Warning
+    Warning,
+    /// Error
+    Error,
+    /// Unknown severity (e.g. forwarded system mails)
+    Unknown,
+}
+
+impl Display for Severity {
+    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::result::Result<(), std::fmt::Error> {
+        match self {
+            Severity::Info => f.write_str("info"),
+            Severity::Notice => f.write_str("notice"),
+            Severity::Warning => f.write_str("warning"),
+            Severity::Error => f.write_str("error"),
+            Severity::Unknown => f.write_str("unknown"),
+        }
+    }
+}
+
+impl FromStr for Severity {
+    type Err = Error;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s {
+            "info" => Ok(Self::Info),
+            "notice" => Ok(Self::Notice),
+            "warning" => Ok(Self::Warning),
+            "error" => Ok(Self::Error),
+            "unknown" => Ok(Self::Unknown),
+            _ => Err(Error::invalid_config(format!("invalid severity {s}"))),
+        }
+    }
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub enum Content {
+    /// Title and body will be rendered as a template
+    #[serde(rename_all = "kebab-case")]
+    Template {
+        /// Name of the used template
+        template_name: String,
+        /// Data that can be used for template rendering.
+        data: Value,
+    },
+    #[cfg(feature = "mail-forwarder")]
+    #[serde(rename_all = "kebab-case")]
+    ForwardedMail {
+        /// Raw mail contents
+        raw: Vec<u8>,
+        /// Fallback title
+        title: String,
+        /// Fallback body
+        body: String,
+        /// UID to use when calling sendmail
+        #[allow(dead_code)] // Unused in some feature flag permutations
+        uid: Option<u32>,
+    },
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct Metadata {
+    /// Notification severity
+    pub(crate) severity: Severity,
+    /// Timestamp of the notification as a UNIX epoch
+    pub(crate) timestamp: i64,
+    /// Additional fields for additional key-value metadata
+    pub(crate) additional_fields: HashMap<String, String>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+/// Notification which can be sent
+pub struct Notification {
+    /// Notification content
+    pub(crate) content: Content,
+    /// Metadata
+    pub(crate) metadata: Metadata,
+    /// Unique ID
+    pub(crate) id: Uuid,
+}
+
+impl Notification {
+    pub fn from_template<S: AsRef<str>>(
+        severity: Severity,
+        template_name: S,
+        template_data: Value,
+        fields: HashMap<String, String>,
+    ) -> Self {
+        Self {
+            metadata: Metadata {
+                severity,
+                additional_fields: fields,
+                timestamp: proxmox_time::epoch_i64(),
+            },
+            content: Content::Template {
+                template_name: template_name.as_ref().to_string(),
+                data: template_data,
+            },
+            id: Uuid::generate(),
+        }
+    }
+    #[cfg(feature = "mail-forwarder")]
+    pub fn new_forwarded_mail(raw_mail: &[u8], uid: Option<u32>) -> Result<Self, Error> {
+        let message = mail_parser::MessageParser::default()
+            .parse(raw_mail)
+            .ok_or_else(|| Error::invalid_forwarded_message("could not parse forwarded email"))?;
+
+        let title = message.subject().unwrap_or_default().into();
+        let body = message.body_text(0).unwrap_or_default().into();
+
+        let mut additional_fields = HashMap::new();
+        additional_fields.insert("hostname".into(), proxmox_sys::nodename().into());
+        additional_fields.insert("type".into(), "system-mail".into());
+
+        Ok(Self {
+            // Unfortunately we cannot reasonably infer the severity from the
+            // mail contents, so just set it to the highest for now so that
+            // it is not filtered out.
+            content: Content::ForwardedMail {
+                raw: raw_mail.into(),
+                title,
+                body,
+                uid,
+            },
+            metadata: Metadata {
+                severity: Severity::Unknown,
+                additional_fields,
+                timestamp: proxmox_time::epoch_i64(),
+            },
+            id: Uuid::generate(),
+        })
+    }
+
+    /// Return the unique ID of this notification.
+    pub fn id(&self) -> &Uuid {
+        &self.id
+    }
+
+    /// Return the notification's timestamp
+    pub fn timestamp(&self) -> i64 {
+        self.metadata.timestamp
+    }
+}
-- 
2.47.3





  parent reply	other threads:[~2026-11-13 15:10 UTC|newest]

Thread overview: 58+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-13 15:07 [PATCH many 00/55] notify: maintenance, PDM preparations, queue + worker Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 01/55] notify: disallow `unsafe` code Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 02/55] notify: refactor error type Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 03/55] notify: move `Endpoint` trait to endpoint module as pub(crate) Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 04/55] notify: use ConfigDigest instead of raw byte arrays Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 05/55] notify: remove static context and pass context as parameter Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 06/55] notify: matcher: drop unused field matcher verifiers Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 07/55] notify: introduce 'send-impl', 'api-impl' and 'api-types' features Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 08/55] notify: matcher: make matcher validation methods public Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 09/55] notify: make SendmailEndpoint and SmtpEndpoint private types Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 10/55] notify: move `send`, `test_target` and `Bus` to new `send` module Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 11/55] notify: move Origin type to api_types module Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 12/55] notify: move Target " Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 13/55] notify: move Config to config module Lukas Wagner
2026-11-13 15:07 ` Lukas Wagner [this message]
2026-11-13 15:07 ` [PATCH proxmox 15/55] notify: move schema module to api_types Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 16/55] notify: move check_matches from api_types::matcher to send::Bus Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 17/55] notify: move TemplateSource to context module Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 18/55] notify: config: cleanup helpers names and visibility Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 19/55] notify: config: rename section config parser/writer methods Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 20/55] notify: config: pass builtins explicitly when parsing section config Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 21/55] notify: implement PartialEq for all Config types Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 22/55] notify: use typed SectionConfigData Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 23/55] notify: api: api types: rename Deleteable* -> Deletable* Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 24/55] notify: context: parse builtin config only once Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 25/55] notify: context: parse proxy config in trait impl, not at the callsite Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 26/55] notify: gate sub-modules with the appropriate feature flags Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 27/55] notify: fold mail-forwarder feature into send-impl Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 28/55] notify: forwarded mails: don't hardcode severity and metadata fields Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 29/55] notify: don't pass uid when instantiating forwarded mail notifications Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 30/55] notify: derive PartialEq for Notification type Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 31/55] notify: add getters for severity and fields on " Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 32/55] notify: add test suite for " Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 33/55] notify: serialize raw, forwarded mail content as base64 Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 34/55] notify: unify code paths for legacy-sendmail and regular notifications Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 35/55] notify: add backwards-compat note to Notification type Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 36/55] notify: remove 'test_target' API Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 37/55] notify: replace notification instantiation with builder pattern Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 38/55] notify: add send receipts Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 39/55] notify: implement notification queue submitter Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 40/55] notify: context: add read_config Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 41/55] notify: queue: add queue consumer Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 42/55] notify: queue: add worker task Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-backup 43/55] notifications: don't ignore verification errors in legacy-sendmail mode Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-backup 44/55] notifications: adapt to proxmox-notify API changes Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-backup 45/55] api: notification: send test notification via proxmox_notify::send Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-backup 46/55] notifications: send all notifications via proxmox-notify's queue Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-perl-rs 47/55] pve: notify: adapt to changes in the public API of proxmox-notify Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-perl-rs 48/55] pve: notify: add `PVE::RS::Notify::enqueue` method Lukas Wagner
2026-11-13 15:08 ` [PATCH pve-cluster 49/55] notify: send notifications via notification queue Lukas Wagner
2026-11-13 15:08 ` [PATCH manager 50/55] vzdump: send legacy-sendmail notifications via simplified API Lukas Wagner
2026-11-13 15:08 ` [PATCH manager 51/55] pve-notify-worker: add new rust-based notification worker daemon Lukas Wagner
2026-11-13 15:08 ` [PATCH manager 52/55] debian: add 'pve-notify-worker' as a dependency Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-mail-forward 53/55] forward mails via notification queue Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-mail-forward 54/55] use return code to signal permanent or temporary failure Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-mail-forward 55/55] limit size of mail read from stdin Lukas Wagner
2026-11-17  9:35 ` [PATCH many 00/55] notify: maintenance, PDM preparations, queue + worker Lukas Wagner
2026-11-18  9:55 ` superseded: " Lukas Wagner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20261113150828.756836-15-l.wagner@proxmox.com \
    --to=l.wagner@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal