From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pbs-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
by lore.proxmox.com (Postfix) with ESMTPS id A85821FF164
for <inbox@lore.proxmox.com>; Fri, 28 Mar 2025 11:23:01 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id F32B236C1C;
Fri, 28 Mar 2025 11:22:54 +0100 (CET)
From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Date: Fri, 28 Mar 2025 11:22:38 +0100
Message-Id: <20250328102242.75539-7-l.wagner@proxmox.com>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20250328102242.75539-1-l.wagner@proxmox.com>
References: <20250328102242.75539-1-l.wagner@proxmox.com>
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results: 0
AWL 0.013 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DMARC_MISSING 0.1 Missing DMARC policy
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
Subject: [pbs-devel] [PATCH proxmox-backup v3 06/10] notifications: add type
for sync notification template data
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
<pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox Backup Server development discussion
<pbs-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pbs-devel-bounces@lists.proxmox.com
Sender: "pbs-devel" <pbs-devel-bounces@lists.proxmox.com>
This commit adds a separate type for the data passed to this type of
notification template. Also we make sure that we do not expose any
non-primitive types to the template renderer, any data
needed in the template is mapped into the new dedicated
template data type.
This ensures that any changes in types defined in other places
do not leak into the template rendering process by accident.
This commit also tries to unify the style and naming of template
variables.
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
src/server/notifications/mod.rs | 52 +++++++++++++++-------
src/server/notifications/template_data.rs | 36 +++++++++++++++
templates/default/sync-err-body.txt.hbs | 14 +++---
templates/default/sync-err-subject.txt.hbs | 8 ++--
templates/default/sync-ok-body.txt.hbs | 14 +++---
templates/default/sync-ok-subject.txt.hbs | 6 +--
6 files changed, 92 insertions(+), 38 deletions(-)
diff --git a/src/server/notifications/mod.rs b/src/server/notifications/mod.rs
index e0dd92d2..9e069710 100644
--- a/src/server/notifications/mod.rs
+++ b/src/server/notifications/mod.rs
@@ -25,7 +25,8 @@ mod template_data;
use template_data::{
AcmeErrTemplateData, CommonData, GcErrTemplateData, GcOkTemplateData,
- PackageUpdatesTemplateData, PruneErrTemplateData, PruneOkTemplateData,
+ PackageUpdatesTemplateData, PruneErrTemplateData, PruneOkTemplateData, SyncErrTemplateData,
+ SyncOkTemplateData,
};
/// Initialize the notification system by setting context in proxmox_notify
@@ -320,21 +321,6 @@ pub fn send_prune_status(
}
pub fn send_sync_status(job: &SyncJobConfig, result: &Result<(), Error>) -> Result<(), Error> {
- let (fqdn, port) = get_server_url();
- let mut data = json!({
- "job": job,
- "fqdn": fqdn,
- "port": port,
- });
-
- let (template, severity) = match result {
- Ok(()) => ("sync-ok", Severity::Info),
- Err(err) => {
- data["error"] = err.to_string().into();
- ("sync-err", Severity::Error)
- }
- };
-
let metadata = HashMap::from([
("job-id".into(), job.id.clone()),
("datastore".into(), job.store.clone()),
@@ -342,7 +328,39 @@ pub fn send_sync_status(job: &SyncJobConfig, result: &Result<(), Error>) -> Resu
("type".into(), "sync".into()),
]);
- let notification = Notification::from_template(severity, template, data, metadata);
+ let notification = match result {
+ Ok(()) => {
+ let template_data = SyncOkTemplateData {
+ common: CommonData::new(),
+ datastore: job.store.clone(),
+ job_id: job.id.clone(),
+ remote: job.remote.clone(),
+ remote_datastore: job.remote_store.clone(),
+ };
+ Notification::from_template(
+ Severity::Info,
+ "sync-ok",
+ serde_json::to_value(template_data)?,
+ metadata,
+ )
+ }
+ Err(err) => {
+ let template_data = SyncErrTemplateData {
+ common: CommonData::new(),
+ datastore: job.store.clone(),
+ job_id: job.id.clone(),
+ remote: job.remote.clone(),
+ remote_datastore: job.remote_store.clone(),
+ error: format!("{err:#}"),
+ };
+ Notification::from_template(
+ Severity::Error,
+ "sync-err",
+ serde_json::to_value(template_data)?,
+ metadata,
+ )
+ }
+ };
let (email, notify, mode) = lookup_datastore_notify_settings(&job.store);
match mode {
diff --git a/src/server/notifications/template_data.rs b/src/server/notifications/template_data.rs
index 1b04352e..81ee19c6 100644
--- a/src/server/notifications/template_data.rs
+++ b/src/server/notifications/template_data.rs
@@ -211,3 +211,39 @@ pub struct PruneErrTemplateData {
/// The error that occured during the prune job.
pub error: String,
}
+
+/// Template data for the sync-ok template.
+#[derive(Serialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct SyncOkTemplateData {
+ /// Common properties.
+ #[serde(flatten)]
+ pub common: CommonData,
+ /// The datastore.
+ pub datastore: String,
+ /// The ID of the job.
+ pub job_id: String,
+ /// The remote.
+ pub remote: Option<String>,
+ /// The remote datastore we synced to/from.
+ pub remote_datastore: String,
+}
+
+/// Template data for the sync-err template.
+#[derive(Serialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct SyncErrTemplateData {
+ /// Common properties.
+ #[serde(flatten)]
+ pub common: CommonData,
+ /// The datastore.
+ pub datastore: String,
+ /// The ID of the job.
+ pub job_id: String,
+ /// The remote.
+ pub remote: Option<String>,
+ /// The remote datastore we synced to/from.
+ pub remote_datastore: String,
+ /// The error that occurred during the sync job.
+ pub error: String,
+}
diff --git a/templates/default/sync-err-body.txt.hbs b/templates/default/sync-err-body.txt.hbs
index a56d9d22..d47a5d6c 100644
--- a/templates/default/sync-err-body.txt.hbs
+++ b/templates/default/sync-err-body.txt.hbs
@@ -1,14 +1,14 @@
-Job ID: {{job.id}}
-Datastore: {{job.store}}
-{{#if job.remote~}}
-Remote: {{job.remote}}
-Remote Store: {{job.remote-store}}
+Job ID: {{job-id}}
+Datastore: {{datastore}}
+{{#if remote~}}
+Remote: {{remote}}
+Remote Store: {{remote-datastore}}
{{else~}}
-Local Source Store: {{job.remote-store}}
+Local Source Store: {{remote-datastore}}
{{/if}}
Synchronization failed: {{error}}
Please visit the web interface for further details:
-<https://{{fqdn}}:{{port}}/#pbsServerAdministration:tasks>
+<{{base-url}}/#pbsServerAdministration:tasks>
diff --git a/templates/default/sync-err-subject.txt.hbs b/templates/default/sync-err-subject.txt.hbs
index a1464802..a4aee3e4 100644
--- a/templates/default/sync-err-subject.txt.hbs
+++ b/templates/default/sync-err-subject.txt.hbs
@@ -1,5 +1,5 @@
-{{#if job.remote~}}
-Sync remote '{{ job.remote }}' datastore '{{ job.remote-store }}' failed
+{{#if remote~}}
+Sync remote '{{remote}}' datastore '{{remote-datastore}}' failed
{{else~}}
-Sync local datastore '{{ job.remote-store }}' failed
-{{/if}}
+Sync local datastore '{{remote-datastore}}' failed
+{{/if}}
diff --git a/templates/default/sync-ok-body.txt.hbs b/templates/default/sync-ok-body.txt.hbs
index 25c4b33b..6ef5993d 100644
--- a/templates/default/sync-ok-body.txt.hbs
+++ b/templates/default/sync-ok-body.txt.hbs
@@ -1,14 +1,14 @@
-Job ID: {{job.id}}
-Datastore: {{job.store}}
-{{#if job.remote~}}
-Remote: {{job.remote}}
-Remote Store: {{job.remote-store}}
+Job ID: {{job-id}}
+Datastore: {{datastore}}
+{{#if remote~}}
+Remote: {{remote}}
+Remote Store: {{remote-datastore}}
{{else~}}
-Local Source Store: {{job.remote-store}}
+Local Source Store: {{remote-datastore}}
{{/if}}
Synchronization successful.
Please visit the web interface for further details:
-<https://{{fqdn}}:{{port}}/#DataStore-{{job.store}}>
+<{{base-url}}/#DataStore-{{datastore}}>
diff --git a/templates/default/sync-ok-subject.txt.hbs b/templates/default/sync-ok-subject.txt.hbs
index 76616b5c..35fac2ce 100644
--- a/templates/default/sync-ok-subject.txt.hbs
+++ b/templates/default/sync-ok-subject.txt.hbs
@@ -1,5 +1,5 @@
-{{#if job.remote~}}
-Sync remote '{{ job.remote }}' datastore '{{ job.remote-store }}' successful
+{{#if remote~}}
+Sync remote '{{remote}}' datastore '{{remote-datastore}}' successful
{{else~}}
-Sync local datastore '{{ job.remote-store }}' successful
+Sync local datastore '{{remote-datastore}}' successful
{{/if}}
--
2.39.5
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel