all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH proxmox master 2/2] notify: stop using deprecated functions from handlebars
Date: Fri, 23 May 2025 15:31:58 +0200	[thread overview]
Message-ID: <20250523133158.306128-2-l.wagner@proxmox.com> (raw)
In-Reply-To: <20250523133158.306128-1-l.wagner@proxmox.com>

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 proxmox-notify/src/endpoints/webhook.rs  |  8 ++---
 proxmox-notify/src/renderer/html.rs      |  7 ++--
 proxmox-notify/src/renderer/mod.rs       | 43 +++++++++---------------
 proxmox-notify/src/renderer/plaintext.rs |  7 ++--
 4 files changed, 25 insertions(+), 40 deletions(-)

diff --git a/proxmox-notify/src/endpoints/webhook.rs b/proxmox-notify/src/endpoints/webhook.rs
index e6947730..a210b94c 100644
--- a/proxmox-notify/src/endpoints/webhook.rs
+++ b/proxmox-notify/src/endpoints/webhook.rs
@@ -11,7 +11,7 @@ use std::time::Duration;
 
 use handlebars::{
     Context as HandlebarsContext, Handlebars, Helper, HelperResult, Output, RenderContext,
-    RenderError as HandlebarsRenderError, RenderErrorReason,
+    RenderErrorReason,
 };
 use http::Request;
 use percent_encoding::AsciiSet;
@@ -430,7 +430,7 @@ fn handlebars_percent_encode(
     let param0 = h
         .param(0)
         .and_then(|v| v.value().as_str())
-        .ok_or_else(|| HandlebarsRenderError::new("url-encode: missing parameter"))?;
+        .ok_or_else(|| RenderErrorReason::ParamNotFoundForIndex("url-encode", 0))?;
 
     // See https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding
     const FRAGMENT: &AsciiSet = &percent_encoding::CONTROLS
@@ -471,7 +471,7 @@ fn handlebars_json(
     let param0 = h
         .param(0)
         .map(|v| v.value())
-        .ok_or_else(|| HandlebarsRenderError::new("json: missing parameter"))?;
+        .ok_or_else(|| RenderErrorReason::ParamNotFoundForIndex("json", 0))?;
 
     let json =
         serde_json::to_string(param0).map_err(|err| RenderErrorReason::NestedError(err.into()))?;
@@ -490,7 +490,7 @@ fn handlebars_escape(
     let text = h
         .param(0)
         .and_then(|v| v.value().as_str())
-        .ok_or_else(|| HandlebarsRenderError::new("escape: missing text parameter"))?;
+        .ok_or_else(|| RenderErrorReason::ParamNotFoundForIndex("escape", 0))?;
 
     let val = Value::String(text.to_string());
     let json =
diff --git a/proxmox-notify/src/renderer/html.rs b/proxmox-notify/src/renderer/html.rs
index e84fd73a..16394531 100644
--- a/proxmox-notify/src/renderer/html.rs
+++ b/proxmox-notify/src/renderer/html.rs
@@ -1,6 +1,5 @@
 use handlebars::{
-    Context, Handlebars, Helper, HelperResult, Output, RenderContext,
-    RenderError as HandlebarsRenderError, RenderErrorReason,
+    Context, Handlebars, Helper, HelperResult, Output, RenderContext, RenderErrorReason,
 };
 use serde_json::Value;
 
@@ -16,7 +15,7 @@ fn render_html_table(
 ) -> HelperResult {
     let param = h
         .param(0)
-        .ok_or_else(|| HandlebarsRenderError::new("parameter not found"))?;
+        .ok_or_else(|| RenderErrorReason::ParamNotFoundForIndex("table", 0))?;
 
     let value = param.value();
 
@@ -68,7 +67,7 @@ fn render_object(
 ) -> HelperResult {
     let param = h
         .param(0)
-        .ok_or_else(|| HandlebarsRenderError::new("parameter not found"))?;
+        .ok_or_else(|| RenderErrorReason::ParamNotFoundForIndex("object", 0))?;
 
     let value = param.value();
 
diff --git a/proxmox-notify/src/renderer/mod.rs b/proxmox-notify/src/renderer/mod.rs
index bff76ed1..17c56bc8 100644
--- a/proxmox-notify/src/renderer/mod.rs
+++ b/proxmox-notify/src/renderer/mod.rs
@@ -3,8 +3,7 @@
 use std::{fmt::Display, time::Duration};
 
 use handlebars::{
-    Context, Handlebars, Helper, HelperDef, HelperResult, Output, RenderContext,
-    RenderError as HandlebarsRenderError,
+    Context, Handlebars, Helper, HelperDef, HelperResult, Output, RenderContext, RenderErrorReason,
 };
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
@@ -84,11 +83,11 @@ fn handlebars_relative_percentage_helper(
     let param0 = h
         .param(0)
         .and_then(|v| v.value().as_f64())
-        .ok_or_else(|| HandlebarsRenderError::new("relative-percentage: param0 not found"))?;
+        .ok_or_else(|| RenderErrorReason::ParamNotFoundForIndex("relative-percentage", 0))?;
     let param1 = h
         .param(1)
         .and_then(|v| v.value().as_f64())
-        .ok_or_else(|| HandlebarsRenderError::new("relative-percentage: param1 not found"))?;
+        .ok_or_else(|| RenderErrorReason::ParamNotFoundForIndex("relative-percentage", 1))?;
 
     if param1 == 0.0 {
         out.write("-")?;
@@ -149,36 +148,24 @@ impl ValueRenderFunction {
     }
 
     fn register_helpers(handlebars: &mut Handlebars) {
-        ValueRenderFunction::HumanBytes.register_handlebars_helper(handlebars);
-        ValueRenderFunction::Duration.register_handlebars_helper(handlebars);
-        ValueRenderFunction::Timestamp.register_handlebars_helper(handlebars);
+        ValueRenderFunction::HumanBytes.register_handlebars_helper("human-bytes", handlebars);
+        ValueRenderFunction::Duration.register_handlebars_helper("duration", handlebars);
+        ValueRenderFunction::Timestamp.register_handlebars_helper("timestamp", handlebars);
     }
 
-    fn register_handlebars_helper(&'static self, handlebars: &mut Handlebars) {
-        // Use serde to get own kebab-case representation that is later used
-        // to register the helper, e.g. HumanBytes -> human-bytes
-        let tag = serde_json::to_string(self)
-            .expect("serde failed to serialize ValueRenderFunction enum");
-
-        // But as it's a string value, the generated string is quoted,
-        // so remove leading/trailing double quotes
-        let tag = tag
-            .strip_prefix('\"')
-            .and_then(|t| t.strip_suffix('\"'))
-            .expect("serde serialized string representation was not contained in double quotes");
-
+    fn register_handlebars_helper(&'static self, name: &'static str, handlebars: &mut Handlebars) {
         handlebars.register_helper(
-            tag,
+            name,
             Box::new(
-                |h: &Helper,
-                 _r: &Handlebars,
-                 _: &Context,
-                 _rc: &mut RenderContext,
-                 out: &mut dyn Output|
-                 -> HelperResult {
+                move |h: &Helper,
+                      _r: &Handlebars,
+                      _: &Context,
+                      _rc: &mut RenderContext,
+                      out: &mut dyn Output|
+                      -> HelperResult {
                     let param = h
                         .param(0)
-                        .ok_or(HandlebarsRenderError::new("parameter not found"))?;
+                        .ok_or_else(|| RenderErrorReason::ParamNotFoundForIndex(name, 0))?;
 
                     let value = param.value();
                     out.write(&self.render(value))?;
diff --git a/proxmox-notify/src/renderer/plaintext.rs b/proxmox-notify/src/renderer/plaintext.rs
index 104f12d9..3433b99f 100644
--- a/proxmox-notify/src/renderer/plaintext.rs
+++ b/proxmox-notify/src/renderer/plaintext.rs
@@ -1,8 +1,7 @@
 use std::collections::HashMap;
 
 use handlebars::{
-    Context, Handlebars, Helper, HelperResult, Output, RenderContext,
-    RenderError as HandlebarsRenderError, RenderErrorReason,
+    Context, Handlebars, Helper, HelperResult, Output, RenderContext, RenderErrorReason,
 };
 use serde_json::Value;
 
@@ -42,7 +41,7 @@ fn render_plaintext_table(
 ) -> HelperResult {
     let param = h
         .param(0)
-        .ok_or_else(|| HandlebarsRenderError::new("parameter not found"))?;
+        .ok_or_else(|| RenderErrorReason::ParamNotFoundForIndex("table", 0))?;
     let value = param.value();
     let table: Table = serde_json::from_value(value.clone())
         .map_err(|err| RenderErrorReason::NestedError(err.into()))?;
@@ -85,7 +84,7 @@ fn render_object(
 ) -> HelperResult {
     let param = h
         .param(0)
-        .ok_or_else(|| HandlebarsRenderError::new("parameter not found"))?;
+        .ok_or_else(|| RenderErrorReason::ParamNotFoundForIndex("object", 0))?;
 
     let value = param.value();
 
-- 
2.39.5



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


  reply	other threads:[~2025-05-23 13:33 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-23 13:31 [pve-devel] [PATCH proxmox master 1/2] notify: migrate to handlebars 5 Lukas Wagner
2025-05-23 13:31 ` Lukas Wagner [this message]
2025-05-26 14:01 ` [pve-devel] applied: " Thomas Lamprecht

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=20250523133158.306128-2-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal