[pbs-devel] [PATCH proxmox-backup 04/10] notifications: add type for APT notification template data

[Lukas Wagner]

On  2025-03-21 13:25, Lukas Wagner wrote:
> 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 at proxmox.com>
> ---
>  src/server/notifications/mod.rs               | 23 ++++++-----
>  src/server/notifications/template_data.rs     | 41 ++++++++++++++++++-
>  .../default/package-updates-body.txt.hbs      |  8 ++--
>  .../default/package-updates-subject.txt.hbs   |  2 +-
>  4 files changed, 57 insertions(+), 17 deletions(-)
> 
> diff --git a/src/server/notifications/mod.rs b/src/server/notifications/mod.rs
> index 864c6e9f..480db365 100644
> --- a/src/server/notifications/mod.rs
> +++ b/src/server/notifications/mod.rs
> @@ -23,7 +23,10 @@ const SPOOL_DIR: &str = concatcp!(pbs_buildcfg::PROXMOX_BACKUP_STATE_DIR, "/noti
>  
>  mod template_data;
>  
> -use template_data::{AcmeErrTemplateData, CommonData, GcErrTemplateData, GcOkTemplateData};
> +use template_data::{
> +    AcmeErrTemplateData, CommonData, GcErrTemplateData, GcOkTemplateData,
> +    PackageUpdatesTemplateData,
> +};
>  
>  /// Initialize the notification system by setting context in proxmox_notify
>  pub fn init() -> Result<(), Error> {
> @@ -464,23 +467,21 @@ fn get_server_url() -> (String, usize) {
>  }
>  
>  pub fn send_updates_available(updates: &[&APTUpdateInfo]) -> Result<(), Error> {
> -    let (fqdn, port) = get_server_url();
>      let hostname = proxmox_sys::nodename().to_string();
>  
> -    let data = json!({
> -        "fqdn": fqdn,
> -        "hostname": &hostname,
> -        "port": port,
> -        "updates": updates,
> -    });
> -
>      let metadata = HashMap::from([
>          ("hostname".into(), hostname),
>          ("type".into(), "package-updates".into()),
>      ]);
>  
> -    let notification =
> -        Notification::from_template(Severity::Info, "package-updates", data, metadata);
> +    let template_data = PackageUpdatesTemplateData::new(updates);
> +
> +    let notification = Notification::from_template(
> +        Severity::Info,
> +        "package-updates",
> +        serde_json::to_value(template_data)?,
> +        metadata,
> +    );
>  
>      send_notification(notification)?;
>      Ok(())
> diff --git a/src/server/notifications/template_data.rs b/src/server/notifications/template_data.rs
> index c3e31367..98b39c10 100644
> --- a/src/server/notifications/template_data.rs
> +++ b/src/server/notifications/template_data.rs
> @@ -1,4 +1,4 @@
> -use pbs_api_types::GarbageCollectionStatus;
> +use pbs_api_types::{APTUpdateInfo, GarbageCollectionStatus};
>  use serde::Serialize;
>  
>  // NOTE: For some of these types, the `XyzOkTemplateData` and `XyzErrTemplateData`
> @@ -141,3 +141,42 @@ pub struct AcmeErrTemplateData {
>      /// The error that occured when trying to request the certificate.
>      pub error: String,
>  }
> +
> +#[derive(Serialize)]
> +#[serde(rename_all = "kebab-case")]
> +/// A single package which can be upgraded.
> +pub struct UpgradablePackage {
> +    /// The name of the package.
> +    name: String,
> +    /// The new version which can be installed.
> +    version: String,
> +    /// The currently installed version.
> +    old_version: String,
> +}

I'll do a

name -> package_name
old_version -> installed_version
version -> available_version

in a v2 so that this the same as in the PVE template which I am auditing right now.

I'll send it once I am sure that there are no other changes I want to make
in order to make it more consistent with PVE's templates.

-- 
- Lukas