[pve-devel] [PATCH many 00/19] notifications: move template strings to template files; PBS preparations
Lukas Wagner
l.wagner at proxmox.com
Tue Apr 9 15:25:36 CEST 2024
The notification system uses handlebar templates to render the subject
and the body of notifications. Previously, the template strings were
defined inline at the call site. This patch series extracts the templates
into template files and installs them at
/usr/share/proxmox-ve/templates/default
where they stored as <template-name>-{body,subject}.{txt,html}.hbs
The 'default' part in the path is a preparation for translated
notifications and/or overridable notification templates.
Future work could provide notifications translated to e.g. German
in `templates/de` or similar. This will be a first for having
translated strings on the backend-side, so there is need for further
research.
The patches for `proxmox` also include some preparatory patches for
the upcoming integration of the notification system into PBS. They
are not needed for PVE, but I included them here since Folke and I
tested the PVE changes with them applied. IMO they should just be
applied with the same version bump.
The list of optional, preparatory patches is:
notify: give each notification a unique ID
notify: api: add get_targets
notify: derive `api` for Deleteable*Property
notify: derive Deserialize/Serialize for Notification struct
notify: pbs context: include nodename in default sendmail author
notify: renderer: add relative-percentage helper from PBS
Folke kindly did some off-list testing before this was posted, hence
his T-bs were included.
Bumps/dependencies:
- proxmox_notify
- libproxmox-rs-perl/libpve-rs-perl (needs bumped proxmox_notify)
- libpve-notify-perl (needs bumped libproxmox-rs-perl/libpve-rs-perl)
- pve-ha-manager (needs bumped libpve-notify-perl)
- pve-manager (needs bumped libpve-notify-perl)
- proxmox-mail-forward (optional. should not be affected by any changes, but I think
it should be also be bumped for any larger proxmox_notify changes to avoid any
weird hidden regressions due to mismatches of proxmox_notify
proxmox:
Lukas Wagner (11):
notify: switch to file-based templating system
notify: make api methods take config struct ownership
notify: convert Option<Vec<T>> -> Vec<T> in config structs
notify: don't make tests require pve-context
notify: make the `mail-forwarder` feature depend on proxmox-sys
notify: give each notification a unique ID
notify: api: add get_targets
notify: derive `api` for Deleteable*Property
notify: derive Deserialize/Serialize for Notification struct
notify: pbs context: include nodename in default sendmail author
notify: renderer: add relative-percentage helper from PBS
proxmox-notify/Cargo.toml | 7 +-
proxmox-notify/examples/render.rs | 63 ------
proxmox-notify/src/api/gotify.rs | 48 ++---
proxmox-notify/src/api/matcher.rs | 59 +++--
proxmox-notify/src/api/mod.rs | 111 ++++++++--
proxmox-notify/src/api/sendmail.rs | 60 +++---
proxmox-notify/src/api/smtp.rs | 122 +++++------
proxmox-notify/src/context/mod.rs | 10 +-
proxmox-notify/src/context/pbs.rs | 18 +-
proxmox-notify/src/context/pve.rs | 15 ++
proxmox-notify/src/context/test.rs | 9 +
proxmox-notify/src/endpoints/common/mail.rs | 20 +-
proxmox-notify/src/endpoints/gotify.rs | 12 +-
proxmox-notify/src/endpoints/sendmail.rs | 34 +--
proxmox-notify/src/endpoints/smtp.rs | 38 ++--
proxmox-notify/src/lib.rs | 58 ++---
proxmox-notify/src/matcher.rs | 71 +++---
proxmox-notify/src/renderer/html.rs | 14 --
proxmox-notify/src/renderer/mod.rs | 226 ++++++++------------
proxmox-notify/src/renderer/plaintext.rs | 39 ----
20 files changed, 503 insertions(+), 531 deletions(-)
delete mode 100644 proxmox-notify/examples/render.rs
proxmox-perl-rs:
Lukas Wagner (3):
notify: use file based notification templates
notify: don't pass config structs by reference
notify: adapt to Option<Vec<T>> to Vec<T> changes in proxmox_notify
common/src/notify.rs | 48 +++++++++++++++++++++-----------------------
1 file changed, 23 insertions(+), 25 deletions(-)
pve-cluster:
Lukas Wagner (1):
notify: use named template instead of passing template strings
src/PVE/Notify.pm | 29 ++++++++++++-----------------
1 file changed, 12 insertions(+), 17 deletions(-)
pve-ha-manager:
Lukas Wagner (1):
env: notify: use named templates instead of passing template strings
debian/pve-ha-manager.install | 3 +++
src/Makefile | 1 +
src/PVE/HA/Env/PVE2.pm | 4 ++--
src/PVE/HA/NodeStatus.pm | 20 +------------------
src/PVE/HA/Sim/Env.pm | 3 ++-
src/templates/Makefile | 10 ++++++++++
src/templates/default/fencing-body.html.hbs | 14 +++++++++++++
src/templates/default/fencing-body.txt.hbs | 11 ++++++++++
src/templates/default/fencing-subject.txt.hbs | 1 +
9 files changed, 45 insertions(+), 22 deletions(-)
create mode 100644 src/templates/Makefile
create mode 100644 src/templates/default/fencing-body.html.hbs
create mode 100644 src/templates/default/fencing-body.txt.hbs
create mode 100644 src/templates/default/fencing-subject.txt.hbs
pve-manager:
Lukas Wagner (3):
gitignore: ignore any test artifacts
tests: remove vzdump_notification test
notifications: use named templates instead of in-code templates
.gitignore | 2 +
Makefile | 2 +-
PVE/API2/APT.pm | 9 +-
PVE/API2/Replication.pm | 20 +---
PVE/VZDump.pm | 6 +-
templates/Makefile | 24 +++++
.../default/package-updates-body.html.hbs | 6 ++
.../default/package-updates-body.txt.hbs | 3 +
.../default/package-updates-subject.txt.hbs | 1 +
templates/default/replication-body.html.hbs | 18 ++++
templates/default/replication-body.txt.hbs | 12 +++
templates/default/replication-subject.txt.hbs | 1 +
templates/default/test-body.html.hbs | 1 +
templates/default/test-body.txt.hbs | 1 +
templates/default/test-subject.txt.hbs | 1 +
templates/default/vzdump-body.html.hbs | 11 ++
templates/default/vzdump-body.txt.hbs | 10 ++
templates/default/vzdump-subject.txt.hbs | 1 +
test/Makefile | 6 +-
test/vzdump_notification_test.pl | 101 ------------------
20 files changed, 98 insertions(+), 138 deletions(-)
create mode 100644 templates/Makefile
create mode 100644 templates/default/package-updates-body.html.hbs
create mode 100644 templates/default/package-updates-body.txt.hbs
create mode 100644 templates/default/package-updates-subject.txt.hbs
create mode 100644 templates/default/replication-body.html.hbs
create mode 100644 templates/default/replication-body.txt.hbs
create mode 100644 templates/default/replication-subject.txt.hbs
create mode 100644 templates/default/test-body.html.hbs
create mode 100644 templates/default/test-body.txt.hbs
create mode 100644 templates/default/test-subject.txt.hbs
create mode 100644 templates/default/vzdump-body.html.hbs
create mode 100644 templates/default/vzdump-body.txt.hbs
create mode 100644 templates/default/vzdump-subject.txt.hbs
delete mode 100755 test/vzdump_notification_test.pl
Summary over all repositories:
51 files changed, 681 insertions(+), 733 deletions(-)
--
Generated by git-murpp 0.7.1
More information about the pve-devel
mailing list