From: Dominik Csapak <d.csapak@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup v2 2/5] server/email_notifications: do not panic on template registration
Date: Thu, 18 Mar 2021 13:01:05 +0100 [thread overview]
Message-ID: <20210318120108.26423-3-d.csapak@proxmox.com> (raw)
In-Reply-To: <20210318120108.26423-1-d.csapak@proxmox.com>
instead print an error and continue, the rendering functions will error
out if one of the templates could not be registered
if we `.unwrap()` here, it can lead to problems if the templates are
not correct, i.e. we could panic while holding a lock, if something holds
a mutex while this is called for the first time
add a test to catch registration issues during package build
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
changes from v1:
* add test to actually test registering, this will fail
on package build if the template registering fails
src/server/email_notifications.rs | 55 +++++++++++++++++++++++--------
1 file changed, 42 insertions(+), 13 deletions(-)
diff --git a/src/server/email_notifications.rs b/src/server/email_notifications.rs
index 229443f6..cd5a43fe 100644
--- a/src/server/email_notifications.rs
+++ b/src/server/email_notifications.rs
@@ -1,10 +1,11 @@
use anyhow::Error;
use serde_json::json;
-use handlebars::{Handlebars, Helper, Context, RenderError, RenderContext, Output, HelperResult};
+use handlebars::{Handlebars, Helper, Context, RenderError, RenderContext, Output, HelperResult, TemplateError};
use proxmox::tools::email::sendmail;
use proxmox::api::schema::parse_property_string;
+use proxmox::try_block;
use crate::{
config::datastore::DataStoreConfig,
@@ -181,25 +182,33 @@ lazy_static::lazy_static!{
static ref HANDLEBARS: Handlebars<'static> = {
let mut hb = Handlebars::new();
+ let result: Result<(), TemplateError> = try_block!({
- hb.set_strict_mode(true);
+ hb.set_strict_mode(true);
- hb.register_helper("human-bytes", Box::new(handlebars_humam_bytes_helper));
- hb.register_helper("relative-percentage", Box::new(handlebars_relative_percentage_helper));
+ hb.register_helper("human-bytes", Box::new(handlebars_humam_bytes_helper));
+ hb.register_helper("relative-percentage", Box::new(handlebars_relative_percentage_helper));
- hb.register_template_string("gc_ok_template", GC_OK_TEMPLATE).unwrap();
- hb.register_template_string("gc_err_template", GC_ERR_TEMPLATE).unwrap();
+ hb.register_template_string("gc_ok_template", GC_OK_TEMPLATE)?;
+ hb.register_template_string("gc_err_template", GC_ERR_TEMPLATE)?;
- hb.register_template_string("verify_ok_template", VERIFY_OK_TEMPLATE).unwrap();
- hb.register_template_string("verify_err_template", VERIFY_ERR_TEMPLATE).unwrap();
+ hb.register_template_string("verify_ok_template", VERIFY_OK_TEMPLATE)?;
+ hb.register_template_string("verify_err_template", VERIFY_ERR_TEMPLATE)?;
- hb.register_template_string("sync_ok_template", SYNC_OK_TEMPLATE).unwrap();
- hb.register_template_string("sync_err_template", SYNC_ERR_TEMPLATE).unwrap();
+ hb.register_template_string("sync_ok_template", SYNC_OK_TEMPLATE)?;
+ hb.register_template_string("sync_err_template", SYNC_ERR_TEMPLATE)?;
- hb.register_template_string("tape_backup_ok_template", TAPE_BACKUP_OK_TEMPLATE).unwrap();
- hb.register_template_string("tape_backup_err_template", TAPE_BACKUP_ERR_TEMPLATE).unwrap();
+ hb.register_template_string("tape_backup_ok_template", TAPE_BACKUP_OK_TEMPLATE)?;
+ hb.register_template_string("tape_backup_err_template", TAPE_BACKUP_ERR_TEMPLATE)?;
- hb.register_template_string("package_update_template", PACKAGE_UPDATES_TEMPLATE).unwrap();
+ hb.register_template_string("package_update_template", PACKAGE_UPDATES_TEMPLATE)?;
+
+ Ok(())
+ });
+
+ if let Err(err) = result {
+ eprintln!("error during template registration: {}", err);
+ }
hb
};
@@ -600,3 +609,23 @@ fn handlebars_relative_percentage_helper(
}
Ok(())
}
+
+#[test]
+fn test_template_register() {
+ HANDLEBARS.get_helper("human-bytes").unwrap();
+ HANDLEBARS.get_helper("relative-percentage").unwrap();
+
+ assert!(HANDLEBARS.has_template("gc_ok_template"));
+ assert!(HANDLEBARS.has_template("gc_err_template"));
+
+ assert!(HANDLEBARS.has_template("verify_ok_template"));
+ assert!(HANDLEBARS.has_template("verify_err_template"));
+
+ assert!(HANDLEBARS.has_template("sync_ok_template"));
+ assert!(HANDLEBARS.has_template("sync_err_template"));
+
+ assert!(HANDLEBARS.has_template("tape_backup_ok_template"));
+ assert!(HANDLEBARS.has_template("tape_backup_err_template"));
+
+ assert!(HANDLEBARS.has_template("package_update_template"));
+}
--
2.20.1
next prev parent reply other threads:[~2021-03-18 12:01 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-18 12:01 [pbs-devel] [PATCH proxmox-backup v2 0/5] improve tape backup and notifications Dominik Csapak
2021-03-18 12:01 ` [pbs-devel] [PATCH proxmox-backup v2 1/5] tools/systemd/time: implement some Traits for TimeSpan Dominik Csapak
2021-03-18 12:01 ` Dominik Csapak [this message]
2021-03-18 12:01 ` [pbs-devel] [PATCH proxmox-backup v2 3/5] server/email_notifications: do not double html escape Dominik Csapak
2021-03-18 12:01 ` [pbs-devel] [PATCH proxmox-backup v2 4/5] api2/tape/backup: include a summary on notification e-mails Dominik Csapak
2021-03-19 6:07 ` Dietmar Maurer
2021-03-18 12:01 ` [pbs-devel] [PATCH proxmox-backup v2 5/5] api2/tape/backup: wait indefinitely for lock in scheduled backup jobs Dominik Csapak
2021-03-19 6:09 ` [pbs-devel] [PATCH proxmox-backup v2 0/5] improve tape backup and notifications Dietmar Maurer
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=20210318120108.26423-3-d.csapak@proxmox.com \
--to=d.csapak@proxmox.com \
--cc=pbs-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