From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <d.csapak@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by lists.proxmox.com (Postfix) with ESMTPS id 9BF746BCCB
for <pbs-devel@lists.proxmox.com>; Thu, 18 Mar 2021 13:01:40 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 8EC6D18C35
for <pbs-devel@lists.proxmox.com>; Thu, 18 Mar 2021 13:01:10 +0100 (CET)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
[212.186.127.180])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by firstgate.proxmox.com (Proxmox) with ESMTPS id A9F8C18C2B
for <pbs-devel@lists.proxmox.com>; Thu, 18 Mar 2021 13:01:09 +0100 (CET)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 6F55D4635C
for <pbs-devel@lists.proxmox.com>; Thu, 18 Mar 2021 13:01:09 +0100 (CET)
From: Dominik Csapak <d.csapak@proxmox.com>
To: pbs-devel@lists.proxmox.com
Date: Thu, 18 Mar 2021 13:01:05 +0100
Message-Id: <20210318120108.26423-3-d.csapak@proxmox.com>
X-Mailer: git-send-email 2.20.1
In-Reply-To: <20210318120108.26423-1-d.csapak@proxmox.com>
References: <20210318120108.26423-1-d.csapak@proxmox.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results: 0
AWL 0.182 Adjusted score from AWL reputation of From: address
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/,
medium trust
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 v2 2/5]
server/email_notifications: do not panic on template registration
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>
X-List-Received-Date: Thu, 18 Mar 2021 12:01:40 -0000
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