public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com, pve-devel@lists.proxmox.com
Subject: [PATCH proxmox 14/29] notify: migrate PBS's and PVE's default matcher to expression syntax
Date: Thu,  9 Jul 2026 13:57:01 +0200	[thread overview]
Message-ID: <20260709115716.299836-15-l.wagner@proxmox.com> (raw)
In-Reply-To: <20260709115716.299836-1-l.wagner@proxmox.com>

Instead of providing the default matcher expression as a JSON blob, we
programmatically construct the appropricate SectionConfigData entity.
This required a change of the Context trait, now the default_config
method returns &'static SectionConfigData instead of &'static str.

The actual SectionConfigData entity is only constructed once and then
stored in a OnceLock.

A nice side-effect of this change is that the config-parsing code path
is more efficient, since we don't have to deserialize the default config
over and over again.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 proxmox-notify/src/context/mod.rs      |  4 +-
 proxmox-notify/src/context/pbs.rs      | 87 ++++++++++++++++++++------
 proxmox-notify/src/context/pve.rs      | 67 +++++++++++++++-----
 proxmox-notify/src/context/test.rs     |  9 ++-
 proxmox-notify/src/lib.rs              |  6 +-
 proxmox-notify/src/matcher/calendar.rs |  9 ++-
 proxmox-notify/src/matcher/field.rs    | 11 +++-
 proxmox-notify/src/matcher/severity.rs | 10 ++-
 8 files changed, 157 insertions(+), 46 deletions(-)

diff --git a/proxmox-notify/src/context/mod.rs b/proxmox-notify/src/context/mod.rs
index 87a2a716..70c3a567 100644
--- a/proxmox-notify/src/context/mod.rs
+++ b/proxmox-notify/src/context/mod.rs
@@ -1,6 +1,8 @@
 use std::fmt::Debug;
 use std::sync::Mutex;
 
+use proxmox_section_config::SectionConfigData;
+
 use crate::Error;
 use crate::renderer::TemplateSource;
 
@@ -24,7 +26,7 @@ pub trait Context: Send + Sync + Debug {
     /// Proxy configuration for the current node
     fn http_proxy_config(&self) -> Option<String>;
     /// Return default config for built-in targets/matchers.
-    fn default_config(&self) -> &'static str;
+    fn default_config(&self) -> &'static SectionConfigData;
     /// Return the path of `filename` from `source` and a certain (optional) `namespace`
     fn lookup_template(
         &self,
diff --git a/proxmox-notify/src/context/pbs.rs b/proxmox-notify/src/context/pbs.rs
index a9121548..b2561ad1 100644
--- a/proxmox-notify/src/context/pbs.rs
+++ b/proxmox-notify/src/context/pbs.rs
@@ -1,14 +1,19 @@
 use std::path::Path;
+use std::sync::OnceLock;
 
 use serde::Deserialize;
 use tracing::error;
 
 use proxmox_schema::{ObjectSchema, Schema, StringSchema};
-use proxmox_section_config::{SectionConfig, SectionConfigPlugin};
+use proxmox_section_config::{SectionConfig, SectionConfigData, SectionConfigPlugin};
 
-use crate::Error;
 use crate::context::{Context, common};
+use crate::endpoints::sendmail::{SENDMAIL_TYPENAME, SendmailConfig};
+use crate::matcher::field::FieldMatcher;
+use crate::matcher::severity::SeverityMatcher;
+use crate::matcher::{MATCHER_TYPENAME, MatcherConfig};
 use crate::renderer::TemplateSource;
+use crate::{Error, Severity};
 
 const PBS_USER_CFG_FILENAME: &str = "/etc/proxmox-backup/user.cfg";
 const PBS_NODE_CFG_FILENAME: &str = "/etc/proxmox-backup/node.cfg";
@@ -60,21 +65,6 @@ fn lookup_mail_address(content: &str, username: &str) -> Option<String> {
     }
 }
 
-const DEFAULT_CONFIG: &str = "\
-sendmail: mail-to-root
-    comment Send mails to root@pam's email address
-    mailto-user root@pam
-
-
-matcher: default-matcher
-    mode all
-    invert-match true
-    match-field exact:type=prune
-    match-severity info
-    target mail-to-root
-    comment Route everything but successful prune job notifications to mail-to-root
-";
-
 #[derive(Debug)]
 pub struct PBSContext;
 
@@ -102,8 +92,67 @@ impl Context for PBSContext {
         content.and_then(|content| common::lookup_datacenter_config_key(&content, "http-proxy"))
     }
 
-    fn default_config(&self) -> &'static str {
-        DEFAULT_CONFIG
+    fn default_config(&self) -> &'static SectionConfigData {
+        static DEFAULT_CONFIG: OnceLock<SectionConfigData> = OnceLock::new();
+        DEFAULT_CONFIG.get_or_init(|| {
+            // FIXME: Long-term we want to move the trait implementation to the product,
+            // maybe add some nice builder to construct the default config.
+            // Moving this as-is to the product would expose a lot of internals
+            // to the product.
+
+            let mut config = SectionConfigData::default();
+            config
+                .set_data(
+                    "mail-to-root",
+                    SENDMAIL_TYPENAME,
+                    SendmailConfig {
+                        name: "mail-to-root".into(),
+                        mailto_user: vec!["root@pam".into()],
+                        comment: Some("Send mails to root@pam's email address".into()),
+                        ..Default::default()
+                    },
+                )
+                .expect("failed to set 'mail-to-root' in default config");
+
+            use proxmox_match_expression::{not, any_of, all_of};
+
+            let expression = any_of![
+                not!(
+                    FieldMatcher::Exact {
+                        field: "type".into(),
+                        values: vec!["prune".into()],
+                    }.into()
+                ),
+                all_of![
+                    FieldMatcher::Exact {
+                        field: "type".into(),
+                        values: vec!["prune".into()],
+                    }.into(),
+                    SeverityMatcher {
+                        severities: vec![Severity::Error, Severity::Warning],
+                    }.into(),
+                ],
+            ];
+
+            let expression = serde_json::to_string(&expression)
+                .expect("failed serialize expression for 'default-matcher'");
+
+            config
+                .set_data(
+                    "default-matcher",
+                    MATCHER_TYPENAME,
+                    MatcherConfig {
+                        name: "default-matcher".into(),
+                        expression: Some(expression),
+                        target: vec!["mail-to-root".into()],
+                        comment: Some("Route everything but successful prune job notifications to mail-to-root".into()),
+                        ..Default::default()
+                    },
+                )
+                .expect("failed to set 'default-matcher' in default config");
+
+            config
+        })
     }
 
     fn lookup_template(
diff --git a/proxmox-notify/src/context/pve.rs b/proxmox-notify/src/context/pve.rs
index 3d9ff92e..00fab322 100644
--- a/proxmox-notify/src/context/pve.rs
+++ b/proxmox-notify/src/context/pve.rs
@@ -1,7 +1,15 @@
+use std::path::Path;
+use std::sync::OnceLock;
+
+use proxmox_match_expression::Expression;
+use proxmox_section_config::SectionConfigData;
+
 use crate::Error;
 use crate::context::{Context, common};
+use crate::endpoints::sendmail::{SENDMAIL_TYPENAME, SendmailConfig};
+use crate::matcher::expression::NotificationMatcher;
+use crate::matcher::{MATCHER_TYPENAME, MatcherConfig};
 use crate::renderer::TemplateSource;
-use std::path::Path;
 
 fn lookup_mail_address(content: &str, user: &str) -> Option<String> {
     common::normalize_for_return(content.lines().find_map(|line| {
@@ -14,18 +22,6 @@ fn lookup_mail_address(content: &str, user: &str) -> Option<String> {
     }))
 }
 
-const DEFAULT_CONFIG: &str = "\
-sendmail: mail-to-root
-	comment Send mails to root@pam's email address
-	mailto-user root@pam
-
-
-matcher: default-matcher
-    mode all
-    target mail-to-root
-    comment Route all notifications to mail-to-root
-";
-
 #[derive(Debug)]
 pub struct PVEContext;
 
@@ -51,8 +47,49 @@ impl Context for PVEContext {
         content.and_then(|content| common::lookup_datacenter_config_key(&content, "http_proxy"))
     }
 
-    fn default_config(&self) -> &'static str {
-        DEFAULT_CONFIG
+    fn default_config(&self) -> &'static SectionConfigData {
+        static DEFAULT_CONFIG: OnceLock<SectionConfigData> = OnceLock::new();
+        DEFAULT_CONFIG.get_or_init(|| {
+            // FIXME: Long-term we want to move the trait implementation to the product,
+            // maybe add some nice builder to construct the default config.
+            // Moving this as-is to the product would expose a lot of internals
+            // to the product.
+
+            let mut config = SectionConfigData::default();
+            config
+                .set_data(
+                    "mail-to-root",
+                    SENDMAIL_TYPENAME,
+                    SendmailConfig {
+                        name: "mail-to-root".into(),
+                        mailto_user: vec!["root@pam".into()],
+                        comment: Some("Send mails to root@pam's email address".into()),
+                        ..Default::default()
+                    },
+                )
+                .expect("failed to set 'mail-to-root' in default config");
+
+            let expr: Expression<NotificationMatcher> = Expression::Constant(true);
+
+            let expr_str = serde_json::to_string(&expr)
+                .expect("failed serialize expression for 'default-matcher'");
+
+            config
+                .set_data(
+                    "default-matcher",
+                    MATCHER_TYPENAME,
+                    MatcherConfig {
+                        name: "default-matcher".into(),
+                        expression: Some(expr_str),
+                        target: vec!["mail-to-root".into()],
+                        comment: Some("Route all notifications to mail-to-root".into()),
+                        ..Default::default()
+                    },
+                )
+                .expect("failed to set 'default-matcher' in default config");
+
+            config
+        })
     }
 
     fn lookup_template(
diff --git a/proxmox-notify/src/context/test.rs b/proxmox-notify/src/context/test.rs
index 22da38d3..ad8ef696 100644
--- a/proxmox-notify/src/context/test.rs
+++ b/proxmox-notify/src/context/test.rs
@@ -1,3 +1,7 @@
+use std::sync::OnceLock;
+
+use proxmox_section_config::SectionConfigData;
+
 use crate::Error;
 use crate::context::Context;
 use crate::renderer::TemplateSource;
@@ -28,8 +32,9 @@ impl Context for TestContext {
         None
     }
 
-    fn default_config(&self) -> &'static str {
-        ""
+    fn default_config(&self) -> &'static SectionConfigData {
+        static DEFAULT_CONFIG: OnceLock<SectionConfigData> = OnceLock::new();
+        DEFAULT_CONFIG.get_or_init(|| SectionConfigData::default())
     }
 
     fn lookup_template(
diff --git a/proxmox-notify/src/lib.rs b/proxmox-notify/src/lib.rs
index 12d21edc..1d1c03cc 100644
--- a/proxmox-notify/src/lib.rs
+++ b/proxmox-notify/src/lib.rs
@@ -285,11 +285,7 @@ impl Config {
         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()))?;
+        let builtin_config = context().default_config();
 
         for (key, (builtin_typename, builtin_value)) in &builtin_config.sections {
             if let Some((typename, value)) = config.sections.get_mut(key) {
diff --git a/proxmox-notify/src/matcher/calendar.rs b/proxmox-notify/src/matcher/calendar.rs
index c6263eb5..43805840 100644
--- a/proxmox-notify/src/matcher/calendar.rs
+++ b/proxmox-notify/src/matcher/calendar.rs
@@ -3,9 +3,10 @@ use std::str::FromStr;
 
 use serde::{Deserialize, Serialize};
 
+use proxmox_match_expression::Expression;
 use proxmox_time::DailyDuration;
 
-use crate::{Error, Notification};
+use crate::{Error, Notification, matcher::expression::NotificationMatcher};
 
 use super::MatchDirective;
 
@@ -53,6 +54,12 @@ pub struct CalendarMatcher {
     schedule: DailyDurationWrapper,
 }
 
+impl From<CalendarMatcher> for Expression<NotificationMatcher> {
+    fn from(value: CalendarMatcher) -> Self {
+        Expression::Match(NotificationMatcher::Calendar(value))
+    }
+}
+
 impl MatchDirective for CalendarMatcher {
     fn matches(&self, notification: &Notification) -> Result<bool, Error> {
         self.schedule
diff --git a/proxmox-notify/src/matcher/field.rs b/proxmox-notify/src/matcher/field.rs
index fd25939c..a21b00d3 100644
--- a/proxmox-notify/src/matcher/field.rs
+++ b/proxmox-notify/src/matcher/field.rs
@@ -2,13 +2,14 @@ use std::{fmt, str::FromStr};
 
 use const_format::concatcp;
 use regex::Regex;
+use serde::{Deserialize, Serialize};
 
+use proxmox_match_expression::Expression;
 use proxmox_schema::{
     ApiStringFormat, Schema, StringSchema, api_types::SAFE_ID_REGEX_STR, const_regex,
 };
-use serde::{Deserialize, Serialize};
 
-use crate::{Error, Notification};
+use crate::{Error, Notification, matcher::expression::NotificationMatcher};
 
 use super::MatchDirective;
 
@@ -45,6 +46,12 @@ pub enum FieldMatcher {
     },
 }
 
+impl From<FieldMatcher> for Expression<NotificationMatcher> {
+    fn from(value: FieldMatcher) -> Self {
+        Expression::Match(NotificationMatcher::Field(value))
+    }
+}
+
 impl MatchDirective for FieldMatcher {
     fn matches(&self, notification: &Notification) -> Result<bool, Error> {
         Ok(match self {
diff --git a/proxmox-notify/src/matcher/severity.rs b/proxmox-notify/src/matcher/severity.rs
index 64472fab..a2538bcc 100644
--- a/proxmox-notify/src/matcher/severity.rs
+++ b/proxmox-notify/src/matcher/severity.rs
@@ -3,7 +3,9 @@ use std::str::FromStr;
 
 use serde::{Deserialize, Serialize};
 
-use crate::{Error, Notification, Severity};
+use proxmox_match_expression::Expression;
+
+use crate::{Error, Notification, Severity, matcher::expression::NotificationMatcher};
 
 use super::MatchDirective;
 
@@ -13,6 +15,12 @@ pub struct SeverityMatcher {
     pub(crate) severities: Vec<Severity>,
 }
 
+impl From<SeverityMatcher> for Expression<NotificationMatcher> {
+    fn from(value: SeverityMatcher) -> Self {
+        Expression::Match(NotificationMatcher::Severity(value))
+    }
+}
+
 impl MatchDirective for SeverityMatcher {
     /// Check if this directive matches a given notification
     fn matches(&self, notification: &Notification) -> Result<bool, Error> {
-- 
2.47.3





  parent reply	other threads:[~2026-07-09 12:00 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-09 11:56 [PATCH many 00/29] notifications: add nested match expressions Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 01/29] add new proxmox-match-expression crate Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 02/29] notify: promote matcher to dir-style module Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 03/29] notify: fix doc comment Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 04/29] notify: matcher: break out severity matcher into submodule Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 05/29] notify: matcher: break out field " Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 06/29] notify: matcher: break out calendar " Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 07/29] notify: matcher: calendar: add basic unit test Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 08/29] notify: matcher: add InlineSeverityMatcher Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 09/29] notify: matcher: add InlineFieldMatcher Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 10/29] notify: matcher: add InlineCalendarMatcher Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 11/29] notify: matcher: add expression support Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 12/29] notify: api: support new expression parameter Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox 13/29] notify: api: add `get_matcher_as_expression` Lukas Wagner
2026-07-09 11:57 ` Lukas Wagner [this message]
2026-07-09 11:57 ` [PATCH proxmox 15/29] notify: move legacy matcher keys behind feature flag Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-widget-toolkit 16/29] notification: increase matcher window width Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-widget-toolkit 17/29] notifications: matcher: add support for match expressions Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-widget-toolkit 18/29] notification: matcher: add better calendar editor Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-widget-toolkit 19/29] notifications: matcher: consistently use title case for UI elements Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-backup 20/29] notification: opt into 'legacy-matchers' feature in proxmox-notify Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-backup 21/29] api: notification: add 'migrate-to-expression' parameter to get_matcher Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-backup 22/29] ui: notification: enable new matcher UI Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-perl-rs 23/29] notify: matcher: pass matcher config / updater directly Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-perl-rs 24/29] notify: opt into 'legacy-matchers' feature in proxmox-notify Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-perl-rs 25/29] notify: add 'migrate_to_expression' parameter for get_matcher Lukas Wagner
2026-07-09 11:57 ` [PATCH manager 26/29] api: notification: pass config/updater directly to rust bindings Lukas Wagner
2026-07-09 11:57 ` [PATCH manager 27/29] api: notification: get_matcher: add 'migrate-to-expression' parameter Lukas Wagner
2026-07-09 11:57 ` [PATCH manager 28/29] api: notification: add 'expression' to matcher parameter schema Lukas Wagner
2026-07-09 11:57 ` [PATCH manager 29/29] ui: notification: enable new matcher UI 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=20260709115716.299836-15-l.wagner@proxmox.com \
    --to=l.wagner@proxmox.com \
    --cc=pbs-devel@lists.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