From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH proxmox 13/55] notify: move Config to config module
Date: Fri, 13 Nov 2026 16:07:46 +0100 [thread overview]
Message-ID: <20261113150828.756836-14-l.wagner@proxmox.com> (raw)
In-Reply-To: <20261113150828.756836-1-l.wagner@proxmox.com>
Another step in cleaning up lib.rs.
Took the opportunity to make `digest` a private field and add a new
getter `digest`.
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
proxmox-notify/src/api/gotify.rs | 2 +-
proxmox-notify/src/api/matcher.rs | 12 ++--
proxmox-notify/src/api/mod.rs | 2 +-
proxmox-notify/src/api/sendmail.rs | 2 +-
proxmox-notify/src/api/smtp.rs | 2 +-
proxmox-notify/src/api/webhook.rs | 2 +-
proxmox-notify/src/config.rs | 103 +++++++++++++++++++++++++++-
proxmox-notify/src/lib.rs | 106 +----------------------------
8 files changed, 114 insertions(+), 117 deletions(-)
diff --git a/proxmox-notify/src/api/gotify.rs b/proxmox-notify/src/api/gotify.rs
index fc56d250b..e0f7cf16b 100644
--- a/proxmox-notify/src/api/gotify.rs
+++ b/proxmox-notify/src/api/gotify.rs
@@ -234,7 +234,7 @@ mod tests {
let mut config = empty_config();
add_default_gotify_endpoint(&mut config)?;
- let digest = config.digest.clone();
+ let digest = config.digest().clone();
update_endpoint(
&mut config,
diff --git a/proxmox-notify/src/api/matcher.rs b/proxmox-notify/src/api/matcher.rs
index 1994cb65c..7df30c083 100644
--- a/proxmox-notify/src/api/matcher.rs
+++ b/proxmox-notify/src/api/matcher.rs
@@ -270,7 +270,7 @@ matcher: matcher2
let mut config = config_with_two_matchers();
- let digest = config.digest.clone();
+ let digest = config.digest().clone();
update_matcher(
&mut config,
@@ -327,7 +327,7 @@ matcher: matcher2
fn test_matcher_update() -> Result<(), HttpError> {
let mut config = config_with_two_matchers();
- let digest = config.digest.clone();
+ let digest = config.digest().clone();
update_matcher(
&mut config,
@@ -382,7 +382,7 @@ matcher: matcher2
#[cfg(feature = "legacy-matchers")]
fn test_update_matcher_mutually_exclusive_with_expression() -> Result<(), HttpError> {
let mut config = config_with_two_matchers();
- let digest = config.digest.clone();
+ let digest = config.digest().clone();
let proto = MatcherConfigUpdater {
expression: Some(valid_expression_string()),
@@ -416,7 +416,7 @@ matcher: matcher2
#[test]
fn test_update_invalid_expression() -> Result<(), HttpError> {
let mut config = config_with_two_matchers();
- let digest = config.digest.clone();
+ let digest = config.digest().clone();
assert!(
update_matcher(
@@ -447,7 +447,7 @@ matcher: matcher2
#[test]
fn test_update_minifies_pretty_printed_expression() -> Result<(), HttpError> {
let mut config = config_with_two_matchers();
- let digest = config.digest.clone();
+ let digest = config.digest().clone();
let expr = nested_expression();
let pretty = serde_json::to_string_pretty(&expr).unwrap();
@@ -476,7 +476,7 @@ matcher: matcher2
#[test]
fn test_update_normalizes_expression_with_extra_whitespace() -> Result<(), HttpError> {
let mut config = config_with_two_matchers();
- let digest = config.digest.clone();
+ let digest = config.digest().clone();
// Same expression as `nested_expression`, but handwritten, with all sorts of
// odd whitespace characters.
diff --git a/proxmox-notify/src/api/mod.rs b/proxmox-notify/src/api/mod.rs
index 44d3bb163..bdbecf741 100644
--- a/proxmox-notify/src/api/mod.rs
+++ b/proxmox-notify/src/api/mod.rs
@@ -88,7 +88,7 @@ pub fn get_targets(config: &Config) -> Result<Vec<Target>, HttpError> {
fn verify_digest(config: &Config, digest: Option<ConfigDigest>) -> Result<(), HttpError> {
if let Some(digest) = digest
- && config.digest != digest
+ && config.digest() != &digest
{
http_bail!(
BAD_REQUEST,
diff --git a/proxmox-notify/src/api/sendmail.rs b/proxmox-notify/src/api/sendmail.rs
index aecc69b38..cff63b806 100644
--- a/proxmox-notify/src/api/sendmail.rs
+++ b/proxmox-notify/src/api/sendmail.rs
@@ -230,7 +230,7 @@ pub mod tests {
let mut config = empty_config();
add_sendmail_endpoint_for_test(&mut config, "sendmail-endpoint")?;
- let digest = config.digest.clone();
+ let digest = config.digest().clone();
update_endpoint(
&mut config,
diff --git a/proxmox-notify/src/api/smtp.rs b/proxmox-notify/src/api/smtp.rs
index f36a51e8c..ceae77df3 100644
--- a/proxmox-notify/src/api/smtp.rs
+++ b/proxmox-notify/src/api/smtp.rs
@@ -289,7 +289,7 @@ pub mod tests {
let mut config = empty_config();
add_smtp_endpoint_for_test(&mut config, "smtp-endpoint")?;
- let digest = config.digest.clone();
+ let digest = config.digest().clone();
update_endpoint(
&mut config,
diff --git a/proxmox-notify/src/api/webhook.rs b/proxmox-notify/src/api/webhook.rs
index 8755eb291..7266faca6 100644
--- a/proxmox-notify/src/api/webhook.rs
+++ b/proxmox-notify/src/api/webhook.rs
@@ -351,7 +351,7 @@ mod tests {
let mut config = empty_config();
add_default_webhook_endpoint(&mut config)?;
- let digest = config.digest.clone();
+ let digest = config.digest().clone();
update_endpoint(
&mut config,
diff --git a/proxmox-notify/src/config.rs b/proxmox-notify/src/config.rs
index bf1469160..59da68c5e 100644
--- a/proxmox-notify/src/config.rs
+++ b/proxmox-notify/src/config.rs
@@ -3,14 +3,16 @@ use std::sync::OnceLock;
use proxmox_config_digest::ConfigDigest;
use proxmox_schema::{ApiType, ObjectSchema};
use proxmox_section_config::{SectionConfig, SectionConfigData, SectionConfigPlugin};
+use serde_json::Value;
+use tracing::error;
-use crate::Error;
use crate::api_types::{
GOTIFY_TYPENAME, GotifyConfig, GotifyPrivateConfig, MATCHER_TYPENAME, MatcherConfig,
SENDMAIL_TYPENAME, SMTP_TYPENAME, SendmailConfig, SmtpConfig, SmtpPrivateConfig,
WEBHOOK_TYPENAME, WebhookConfig, WebhookPrivateConfig,
};
use crate::schema::BACKEND_NAME_SCHEMA;
+use crate::{Context, Error};
/// Section config schema for the public config file.
pub fn config_parser() -> &'static SectionConfig {
@@ -126,3 +128,102 @@ pub fn write_private(config: &SectionConfigData) -> Result<String, Error> {
.write("priv/notifications.cfg", config)
.map_err(Error::config_serialization)
}
+
+/// Notification configuration
+#[derive(Debug, Clone)]
+pub struct Config {
+ pub(crate) config: SectionConfigData,
+ pub(crate) private_config: SectionConfigData,
+ digest: ConfigDigest,
+}
+
+impl Config {
+ /// Parse raw config
+ pub fn new(
+ context: &Context,
+ raw_config: &str,
+ raw_private_config: &str,
+ ) -> Result<Self, Error> {
+ let (mut config, digest) = config(raw_config)?;
+ let (private_config, _) = private_config(raw_private_config)?;
+
+ let default_config = context.default_config();
+
+ let builtin_config = config_parser()
+ .parse("<builtin>", default_config)
+ .map_err(|err| Error::ConfigDeserialization(err.into()))?;
+
+ for (key, (builtin_typename, builtin_value)) in &builtin_config.sections {
+ if let Some((typename, value)) = config.sections.get_mut(key) {
+ if builtin_typename == typename && value == builtin_value {
+ // Entry is built-in and the config entry section in notifications.cfg
+ // is exactly the same.
+ if let Some(obj) = value.as_object_mut() {
+ obj.insert("origin".to_string(), Value::String("builtin".into()));
+ } else {
+ error!("section config entry is not an object. This should not happen");
+ }
+ } else {
+ // Entry is built-in, but it has been modified by the user.
+ if let Some(obj) = value.as_object_mut() {
+ obj.insert(
+ "origin".to_string(),
+ Value::String("modified-builtin".into()),
+ );
+ } else {
+ error!("section config entry is not an object. This should not happen");
+ }
+ }
+ } else {
+ let mut val = builtin_value.clone();
+
+ if let Some(obj) = val.as_object_mut() {
+ obj.insert("origin".to_string(), Value::String("builtin".into()));
+ } else {
+ error!("section config entry is not an object. This should not happen");
+ }
+ config
+ .set_data(key, builtin_typename, val)
+ .map_err(|err| Error::ConfigDeserialization(err.into()))?;
+ }
+ }
+
+ for (_, (_, value)) in config.sections.iter_mut() {
+ if let Some(obj) = value.as_object_mut() {
+ if obj.get("origin").is_none() {
+ obj.insert("origin".to_string(), Value::String("user-created".into()));
+ }
+ }
+ }
+
+ Ok(Self {
+ config,
+ digest,
+ private_config,
+ })
+ }
+
+ /// Serialize config
+ pub fn write(&self) -> Result<(String, String), Error> {
+ let mut c = self.config.clone();
+ for (_, (_, value)) in c.sections.iter_mut() {
+ // Remove 'origin' parameter, we do not want it in our
+ // config fields
+ // TODO: Check if there is a better way for this, maybe a
+ // separate type for API responses?
+ if let Some(obj) = value.as_object_mut() {
+ obj.remove("origin");
+ } else {
+ error!("section config entry is not an object. This should not happen");
+ }
+ }
+
+ Ok((write(&c)?, write_private(&self.private_config)?))
+ }
+
+ /// Returns the SHA256 digest of the configuration.
+ /// The digest is only computed once when the configuration deserialized.
+ pub fn digest(&self) -> &ConfigDigest {
+ &self.digest
+ }
+}
diff --git a/proxmox-notify/src/lib.rs b/proxmox-notify/src/lib.rs
index 8f0b962e7..4407ae80d 100644
--- a/proxmox-notify/src/lib.rs
+++ b/proxmox-notify/src/lib.rs
@@ -5,11 +5,8 @@ use std::{collections::HashMap, fmt::Display, str::FromStr};
use serde::{Deserialize, Serialize};
use serde_json::Value;
-use tracing::error;
-use proxmox_config_digest::ConfigDigest;
use proxmox_schema::api;
-use proxmox_section_config::SectionConfigData;
use proxmox_uuid::Uuid;
#[cfg(feature = "api-impl")]
@@ -30,6 +27,7 @@ pub mod api_types;
mod error;
pub use error::Error;
+pub use config::Config;
pub use context::Context;
pub use context::ContextImpl;
@@ -187,105 +185,3 @@ impl Notification {
self.metadata.timestamp
}
}
-
-/// Notification configuration
-#[derive(Debug, Clone)]
-pub struct Config {
- config: SectionConfigData,
- private_config: SectionConfigData,
- digest: ConfigDigest,
-}
-
-impl Config {
- /// Parse raw config
- pub fn new(
- context: &Context,
- raw_config: &str,
- raw_private_config: &str,
- ) -> Result<Self, Error> {
- let (mut config, digest) = config::config(raw_config)?;
- let (private_config, _) = config::private_config(raw_private_config)?;
-
- let default_config = context.default_config();
-
- let builtin_config = config::config_parser()
- .parse("<builtin>", default_config)
- .map_err(|err| Error::ConfigDeserialization(err.into()))?;
-
- for (key, (builtin_typename, builtin_value)) in &builtin_config.sections {
- if let Some((typename, value)) = config.sections.get_mut(key) {
- if builtin_typename == typename && value == builtin_value {
- // Entry is built-in and the config entry section in notifications.cfg
- // is exactly the same.
- if let Some(obj) = value.as_object_mut() {
- obj.insert("origin".to_string(), Value::String("builtin".into()));
- } else {
- error!("section config entry is not an object. This should not happen");
- }
- } else {
- // Entry is built-in, but it has been modified by the user.
- if let Some(obj) = value.as_object_mut() {
- obj.insert(
- "origin".to_string(),
- Value::String("modified-builtin".into()),
- );
- } else {
- error!("section config entry is not an object. This should not happen");
- }
- }
- } else {
- let mut val = builtin_value.clone();
-
- if let Some(obj) = val.as_object_mut() {
- obj.insert("origin".to_string(), Value::String("builtin".into()));
- } else {
- error!("section config entry is not an object. This should not happen");
- }
- config
- .set_data(key, builtin_typename, val)
- .map_err(|err| Error::ConfigDeserialization(err.into()))?;
- }
- }
-
- for (_, (_, value)) in config.sections.iter_mut() {
- if let Some(obj) = value.as_object_mut() {
- if obj.get("origin").is_none() {
- obj.insert("origin".to_string(), Value::String("user-created".into()));
- }
- }
- }
-
- Ok(Self {
- config,
- digest,
- private_config,
- })
- }
-
- /// Serialize config
- pub fn write(&self) -> Result<(String, String), Error> {
- let mut c = self.config.clone();
- for (_, (_, value)) in c.sections.iter_mut() {
- // Remove 'origin' parameter, we do not want it in our
- // config fields
- // TODO: Check if there is a better way for this, maybe a
- // separate type for API responses?
- if let Some(obj) = value.as_object_mut() {
- obj.remove("origin");
- } else {
- error!("section config entry is not an object. This should not happen");
- }
- }
-
- Ok((
- config::write(&c)?,
- config::write_private(&self.private_config)?,
- ))
- }
-
- /// Returns the SHA256 digest of the configuration.
- /// The digest is only computed once when the configuration deserialized.
- pub fn digest(&self) -> &ConfigDigest {
- &self.digest
- }
-}
--
2.47.3
next prev parent reply other threads:[~2026-11-13 15:12 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 ` Lukas Wagner [this message]
2026-11-13 15:07 ` [PATCH proxmox 14/55] notify: move Notification and sub-types to `notification` module Lukas Wagner
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-14-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