From 826547a8e14beabfced2d9da408fa1d7a8e8a015 Mon Sep 17 00:00:00 2001
From: Der Mundschenk & Compagnie <mundschenk-at@users.noreply.github.com>
Date: Sat, 30 Nov 2024 13:46:31 +0100
Subject: [PATCH] fix(ignore): Prevent empty events from being published to HA
 (#24969)

Co-authored-by: Koen Kanters <koenkanters94@gmail.com>
---
 lib/extension/homeassistant.ts | 4 ++--
 test/homeassistant.test.js     | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/lib/extension/homeassistant.ts b/lib/extension/homeassistant.ts
index f5bfe1e234..c6e0f8c75b 100644
--- a/lib/extension/homeassistant.ts
+++ b/lib/extension/homeassistant.ts
@@ -2270,7 +2270,7 @@ export default class HomeAssistant extends Extension {
 
         const value_template =
             `{% set patterns = [\n${patterns}\n] %}\n` +
-            `{% set action_value = value_json.action|default(None) %}\n` +
+            `{% set action_value = value_json.action|default('') %}\n` +
             `{% set ns = namespace(r=[('action', action_value)]) %}\n` +
             `{% for p in patterns %}\n` +
             `  {% set m = action_value|regex_findall(p.pattern) %}\n` +
@@ -2283,7 +2283,7 @@ export default class HomeAssistant extends Extension {
             `  {% set ns.r = ns.r|rejectattr(0, 'eq', 'action')|list + [('action', ns.r|selectattr(0, 'eq', 'actionPrefix')|map(attribute=1)|first + ns.r|selectattr(0, 'eq', 'action')|map(attribute=1)|first)] %}\n` +
             `{% endif %}\n` +
             `{% set ns.r = ns.r + [('event_type', ns.r|selectattr(0, 'eq', 'action')|map(attribute=1)|first)] %}\n` +
-            `{{dict.from_keys(ns.r|rejectattr(0, 'in', 'action, actionPrefix'))|to_json}}`;
+            `{{dict.from_keys(ns.r|rejectattr(0, 'in', 'action, actionPrefix')|reject('eq', ('event_type', '')))|to_json}}`;
 
         return value_template;
     }
diff --git a/test/homeassistant.test.js b/test/homeassistant.test.js
index bee5fb819e..6c73857352 100644
--- a/test/homeassistant.test.js
+++ b/test/homeassistant.test.js
@@ -428,7 +428,7 @@ describe('HomeAssistant extension', () => {
             unique_id: '0x0017880104e45520_action_zigbee2mqtt',
             // Needs to be updated whenever one of the ACTION_*_PATTERN constants changes.
             value_template:
-                '{% set patterns = [\n{"pattern": \'^(?P<button>(?:button_)?[a-z0-9]+)_(?P<action>(?:press|hold)(?:_release)?)$\', "groups": ["button", "action"]},\n{"pattern": \'^(?P<action>recall|scene)_(?P<scene>[0-2][0-9]{0,2})$\', "groups": ["action", "scene"]},\n{"pattern": \'^(?P<actionPrefix>region_)(?P<region>[1-9]|10)_(?P<action>enter|leave|occupied|unoccupied)$\', "groups": ["actionPrefix", "region", "action"]},\n{"pattern": \'^(?P<action>dial_rotate)_(?P<direction>left|right)_(?P<speed>step|slow|fast)$\', "groups": ["action", "direction", "speed"]},\n{"pattern": \'^(?P<action>brightness_step)(?:_(?P<direction>up|down))?$\', "groups": ["action", "direction"]}\n] %}\n{% set action_value = value_json.action|default(None) %}\n{% set ns = namespace(r=[(\'action\', action_value)]) %}\n{% for p in patterns %}\n  {% set m = action_value|regex_findall(p.pattern) %}\n  {% if m[0] is undefined %}{% continue %}{% endif %}\n  {% for key, value in zip(p.groups, m[0]) %}\n    {% set ns.r = ns.r|rejectattr(0, \'eq\', key)|list + [(key, value)] %}\n  {% endfor %}\n{% endfor %}\n{% if ns.r|selectattr(0, \'eq\', \'actionPrefix\')|first is defined %}\n  {% set ns.r = ns.r|rejectattr(0, \'eq\', \'action\')|list + [(\'action\', ns.r|selectattr(0, \'eq\', \'actionPrefix\')|map(attribute=1)|first + ns.r|selectattr(0, \'eq\', \'action\')|map(attribute=1)|first)] %}\n{% endif %}\n{% set ns.r = ns.r + [(\'event_type\', ns.r|selectattr(0, \'eq\', \'action\')|map(attribute=1)|first)] %}\n{{dict.from_keys(ns.r|rejectattr(0, \'in\', \'action, actionPrefix\'))|to_json}}',
+                "{% set patterns = [\n{\"pattern\": '^(?P<button>(?:button_)?[a-z0-9]+)_(?P<action>(?:press|hold)(?:_release)?)$', \"groups\": [\"button\", \"action\"]},\n{\"pattern\": '^(?P<action>recall|scene)_(?P<scene>[0-2][0-9]{0,2})$', \"groups\": [\"action\", \"scene\"]},\n{\"pattern\": '^(?P<actionPrefix>region_)(?P<region>[1-9]|10)_(?P<action>enter|leave|occupied|unoccupied)$', \"groups\": [\"actionPrefix\", \"region\", \"action\"]},\n{\"pattern\": '^(?P<action>dial_rotate)_(?P<direction>left|right)_(?P<speed>step|slow|fast)$', \"groups\": [\"action\", \"direction\", \"speed\"]},\n{\"pattern\": '^(?P<action>brightness_step)(?:_(?P<direction>up|down))?$', \"groups\": [\"action\", \"direction\"]}\n] %}\n{% set action_value = value_json.action|default('') %}\n{% set ns = namespace(r=[('action', action_value)]) %}\n{% for p in patterns %}\n  {% set m = action_value|regex_findall(p.pattern) %}\n  {% if m[0] is undefined %}{% continue %}{% endif %}\n  {% for key, value in zip(p.groups, m[0]) %}\n    {% set ns.r = ns.r|rejectattr(0, 'eq', key)|list + [(key, value)] %}\n  {% endfor %}\n{% endfor %}\n{% if ns.r|selectattr(0, 'eq', 'actionPrefix')|first is defined %}\n  {% set ns.r = ns.r|rejectattr(0, 'eq', 'action')|list + [('action', ns.r|selectattr(0, 'eq', 'actionPrefix')|map(attribute=1)|first + ns.r|selectattr(0, 'eq', 'action')|map(attribute=1)|first)] %}\n{% endif %}\n{% set ns.r = ns.r + [('event_type', ns.r|selectattr(0, 'eq', 'action')|map(attribute=1)|first)] %}\n{{dict.from_keys(ns.r|rejectattr(0, 'in', 'action, actionPrefix')|reject('eq', ('event_type', '')))|to_json}}",
         };
 
         expect(MQTT.publish).toHaveBeenCalledWith(
@@ -1998,7 +1998,7 @@ describe('HomeAssistant extension', () => {
             unique_id: '0x0017880104e45520_action_zigbee2mqtt',
             // Needs to be updated whenever one of the ACTION_*_PATTERN constants changes.
             value_template:
-                '{% set patterns = [\n{"pattern": \'^(?P<button>(?:button_)?[a-z0-9]+)_(?P<action>(?:press|hold)(?:_release)?)$\', "groups": ["button", "action"]},\n{"pattern": \'^(?P<action>recall|scene)_(?P<scene>[0-2][0-9]{0,2})$\', "groups": ["action", "scene"]},\n{"pattern": \'^(?P<actionPrefix>region_)(?P<region>[1-9]|10)_(?P<action>enter|leave|occupied|unoccupied)$\', "groups": ["actionPrefix", "region", "action"]},\n{"pattern": \'^(?P<action>dial_rotate)_(?P<direction>left|right)_(?P<speed>step|slow|fast)$\', "groups": ["action", "direction", "speed"]},\n{"pattern": \'^(?P<action>brightness_step)(?:_(?P<direction>up|down))?$\', "groups": ["action", "direction"]}\n] %}\n{% set action_value = value_json.action|default(None) %}\n{% set ns = namespace(r=[(\'action\', action_value)]) %}\n{% for p in patterns %}\n  {% set m = action_value|regex_findall(p.pattern) %}\n  {% if m[0] is undefined %}{% continue %}{% endif %}\n  {% for key, value in zip(p.groups, m[0]) %}\n    {% set ns.r = ns.r|rejectattr(0, \'eq\', key)|list + [(key, value)] %}\n  {% endfor %}\n{% endfor %}\n{% if ns.r|selectattr(0, \'eq\', \'actionPrefix\')|first is defined %}\n  {% set ns.r = ns.r|rejectattr(0, \'eq\', \'action\')|list + [(\'action\', ns.r|selectattr(0, \'eq\', \'actionPrefix\')|map(attribute=1)|first + ns.r|selectattr(0, \'eq\', \'action\')|map(attribute=1)|first)] %}\n{% endif %}\n{% set ns.r = ns.r + [(\'event_type\', ns.r|selectattr(0, \'eq\', \'action\')|map(attribute=1)|first)] %}\n{{dict.from_keys(ns.r|rejectattr(0, \'in\', \'action, actionPrefix\'))|to_json}}',
+                "{% set patterns = [\n{\"pattern\": '^(?P<button>(?:button_)?[a-z0-9]+)_(?P<action>(?:press|hold)(?:_release)?)$', \"groups\": [\"button\", \"action\"]},\n{\"pattern\": '^(?P<action>recall|scene)_(?P<scene>[0-2][0-9]{0,2})$', \"groups\": [\"action\", \"scene\"]},\n{\"pattern\": '^(?P<actionPrefix>region_)(?P<region>[1-9]|10)_(?P<action>enter|leave|occupied|unoccupied)$', \"groups\": [\"actionPrefix\", \"region\", \"action\"]},\n{\"pattern\": '^(?P<action>dial_rotate)_(?P<direction>left|right)_(?P<speed>step|slow|fast)$', \"groups\": [\"action\", \"direction\", \"speed\"]},\n{\"pattern\": '^(?P<action>brightness_step)(?:_(?P<direction>up|down))?$', \"groups\": [\"action\", \"direction\"]}\n] %}\n{% set action_value = value_json.action|default('') %}\n{% set ns = namespace(r=[('action', action_value)]) %}\n{% for p in patterns %}\n  {% set m = action_value|regex_findall(p.pattern) %}\n  {% if m[0] is undefined %}{% continue %}{% endif %}\n  {% for key, value in zip(p.groups, m[0]) %}\n    {% set ns.r = ns.r|rejectattr(0, 'eq', key)|list + [(key, value)] %}\n  {% endfor %}\n{% endfor %}\n{% if ns.r|selectattr(0, 'eq', 'actionPrefix')|first is defined %}\n  {% set ns.r = ns.r|rejectattr(0, 'eq', 'action')|list + [('action', ns.r|selectattr(0, 'eq', 'actionPrefix')|map(attribute=1)|first + ns.r|selectattr(0, 'eq', 'action')|map(attribute=1)|first)] %}\n{% endif %}\n{% set ns.r = ns.r + [('event_type', ns.r|selectattr(0, 'eq', 'action')|map(attribute=1)|first)] %}\n{{dict.from_keys(ns.r|rejectattr(0, 'in', 'action, actionPrefix')|reject('eq', ('event_type', '')))|to_json}}",
         };
 
         expect(MQTT.publish).toHaveBeenCalledWith(