[Pushsafer] Fix to prevent submitting empty parameters to upstream API

BREAKING CHANGE: This has an impact on the ``vibration`` parameter:

Previously, a Pushsafer notification would always have vibrations turned
on, which is considered to be a bug. Now, you will have to explicitly
configure `vibration=0`, in order to use the "device-default" vibration.

CHANGES.rst

@@ -6,6 +6,13 @@ mqttwarn changelog
 in progress
 ===========
 
+- Pushsafer: Fix to prevent submitting empty parameters to upstream API.
+
+  BREAKING CHANGE: This has an impact on the ``vibration`` parameter:
+  Previously, a Pushsafer notification would always have vibrations turned
+  on, which is considered to be a bug. Now, you will have to explicitly
+  configure ``vibration=0``, in order to use the "device-default" vibration.
+
 
 2023-02-13 0.32.0
 =================

mqttwarn/services/pushsafer.py

@@ -36,6 +36,9 @@ def pushsafer(**kwargs):
     if not kwargs['k']:
         kwargs['k'] = os.environ['PUSHSAFER_TOKEN']
 
+    # Don't submit empty parameters to Pushsafer.
+    kwargs = filter_empty_parameters(kwargs)
+
     url = urllib.parse.urljoin(PUSHSAFER_API, "api")
     data = urllib.parse.urlencode(kwargs).encode('utf-8')
     req = urllib.request.Request(url, data)
@@ -47,6 +50,24 @@ def pushsafer(**kwargs):
         raise PushsaferError(output)
 
 
+def filter_empty_parameters(params: t.Dict[str, str]):
+    """
+    Filter empty parameters.
+
+    Also, translate special value `vibration=0` into empty value,
+    because this currently signals "vibrate with device-default".
+    """
+    effective_parameters = OrderedDict()
+    for key, value in params.items():
+        if value != "":
+            # Special handling for `vibration=0`.
+            # TODO: Remove after eventual upstream adjustments.
+            if key == "v" and str(value) == "0":
+                value = ""
+            effective_parameters[key] = value
+    return effective_parameters
+
+
 def plugin(srv, item):
 
     srv.logging.debug("*** MODULE=%s: service=%s, target=%s", __file__, item.service, item.target)
@@ -132,7 +153,12 @@ def encode_v1(self):
             params['s'] = addrs[3]
 
         if len(addrs) > 4:
-            params['v'] = addrs[4]
+            # Special handling for `vibration`.
+            # With the v1 configuration layout, it should not always trigger a vibration when left empty.
+            # Therefore, a synthetic value `0` can be used to configure "device-default" vibration.
+            value = str(addrs[4])
+            if value != "":
+                params['v'] = value
 
         if len(addrs) > 5:
             params['u'] = addrs[5]

tests/etc/better-addresses.ini

@@ -77,7 +77,8 @@ targets = {
         'device': '52|65|78',
         'icon': 64,
         'sound': 2,
-        'vibration': 'blank',  # ?
+        # Zero means "vibrate with device-default".
+        'vibration': '0',
         'url': 'http://example.org',
         'url_title': 'Example Org',
         'time_to_live': 60,

tests/services/pushsafer/test_pushsafer_v1.py

@@ -106,7 +106,8 @@ class IoTestItem:
     IoTestItem(id="device-id", in_addrs=[TEST_TOKEN, "52|65|78"], out_data={"d": "52|65|78"}),
     IoTestItem(id="icon", in_addrs=[TEST_TOKEN, "", "test.ico"], out_data={"i": "test.ico"}),
     IoTestItem(id="sound", in_addrs=[TEST_TOKEN, "", "", "test.mp3"], out_data={"s": "test.mp3"}),
-    IoTestItem(id="vibration", in_addrs=[TEST_TOKEN, "", "", "", "1"], out_data={"v": "1"}),
+    IoTestItem(id="vibration-default", in_addrs=[TEST_TOKEN, "", "", "", "0"], out_data={"v": ""}),
+    IoTestItem(id="vibration-two", in_addrs=[TEST_TOKEN, "", "", "", "2"], out_data={"v": "2"}),
     IoTestItem(
         id="url", in_addrs=[TEST_TOKEN, "", "", "", "", "http://example.org"], out_data={"u": "http://example.org"}
     ),

tests/services/pushsafer/test_pushsafer_v2.py

@@ -106,7 +106,8 @@ class IoTestItem:
     IoTestItem(id="device-id", in_addrs={"private_key": TEST_TOKEN, "device": "52|65|78"}, out_data={"d": "52|65|78"}),
     IoTestItem(id="icon", in_addrs={"private_key": TEST_TOKEN, "icon": "test.ico"}, out_data={"i": "test.ico"}),
     IoTestItem(id="sound", in_addrs={"private_key": TEST_TOKEN, "sound": "test.mp3"}, out_data={"s": "test.mp3"}),
-    IoTestItem(id="vibration", in_addrs={"private_key": TEST_TOKEN, "vibration": 1}, out_data={"v": "1"}),
+    IoTestItem(id="vibration-default", in_addrs={"private_key": TEST_TOKEN, "vibration": 0}, out_data={"v": ""}),
+    IoTestItem(id="vibration-two", in_addrs={"private_key": TEST_TOKEN, "vibration": 2}, out_data={"v": "2"}),
     IoTestItem(
         id="url",
         in_addrs={"private_key": TEST_TOKEN, "url": "http://example.org"},

tests/services/pushsafer/util.py

@@ -17,6 +17,6 @@ def get_reference_data(**more_data):
 
 def assert_request(request: urllib.request.Request, reference_data: t.Dict[str, str]):
     assert request.full_url == "https://www.pushsafer.com/api"
-    actual_data = dict(parse_qsl(request.data.decode("utf-8")))
+    actual_data = dict(parse_qsl(request.data.decode("utf-8"), keep_blank_values=True))
     msg = f"\nGot:      {actual_data}\nExpected: {reference_data}"
     assert actual_data == reference_data, msg