[ntfy] Add dedicated service plugin `ntfy` #638

amotl · 2023-04-20T16:16:46Z

About

While the previous integration of an adapter for ntfy was based on Apprise, this patch adds a dedicated service plugin instead.

In that way, mqttwarn will have better control about all the details. In a specific case (see references about Frigate), the current implementation had to be improved, in order to address attachments on the local filesystem, and upload them to the ntfy instance. This was not possible beforehand.

Documentation

You can inspect the documentation about the new plugin in its rendered version at mqttwarn notifier catalog » ntfy.

Details

Currently, Apprise does not offer to upload attachments from local files, and ntfy-wrapper only works on ntfy.sh, but not with on-premise installations. For those reasons, our implementation is solely based on requests now, and supports both options. It is thoroughly covered by corresponding software tests (100%).

References

codecov-commenter · 2023-04-20T16:25:38Z

Codecov Report

Merging #638 (609d79f) into main (079ceeb) will increase coverage by 1.65%.
The diff coverage is 99.18%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main     #638      +/-   ##
==========================================
+ Coverage   42.44%   44.10%   +1.65%     
==========================================
  Files          83       84       +1     
  Lines        3854     3970     +116     
==========================================
+ Hits         1636     1751     +115     
- Misses       2218     2219       +1

Flag	Coverage Δ
unittests	`44.10% <99.18%> (+1.65%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
mqttwarn/services/apprise_multi.py	`95.45% <ø> (ø)`
mqttwarn/services/apprise_single.py	`95.34% <ø> (ø)`
mqttwarn/services/apprise_util.py	`100.00% <ø> (ø)`
mqttwarn/services/ntfy.py	`99.13% <99.13%> (ø)`
mqttwarn/commands.py	`100.00% <100.00%> (ø)`
mqttwarn/core.py	`92.09% <100.00%> (ø)`
mqttwarn/model.py	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

amotl · 2023-04-20T16:57:42Z

docs/notifier-catalog.md

+targets  = {
+    'test': {
+        'url': 'https://ntfy.sh/testdrive',
+        'attach': 'https://unsplash.com/photos/spdQ1dVuIHw/download?w=320',


attach is the standard ntfy field to attach a file from a URL.

amotl · 2023-04-20T17:00:15Z

docs/notifier-catalog.md

+targets  = {
+    'test': {
+        'url': 'https://ntfy.sh/testdrive',
+        'attachment': '/tmp/ntfy-attachment-{slot}-{label}.png',


I've introduced the attachment option/field to signal to mqttwarn that it should attach a local file to the ntfy notification, in order to support @sevmonster's use case.

However, I do not like the naming yet, as it's easy to confuse with the attach field. We should choose another name. I am leaning towards just using file instead. Do you have any other suggestions?

I've renamed the option to file with 40e2efd, as proposed. I think it's a better choice to avoid confusion.

amotl · 2023-04-21T13:08:05Z

docs/notifier-catalog.md

+:::{important}
+[ntfy publishing options] outlines different ways to marshal data to the ntfy
+HTTP API. mqttwarn is using HTTP headers for serializing values, because the
+HTTP body will already be used for the attachment file. Because of this, you
+are not able to use UTF-8 characters within your message text, they will be
+replaced by placeholder characters like `?`.
+:::


mqttwarn is using HTTP headers for serializing values. Because of this, you are not able to use UTF-8 characters within your message text, they will be replaced by placeholder characters like ?.

@binwiederhier outlined a potential solution for this slight drawback, and figured it would be trivial to implement on behalf of ntfy, see caronc/apprise#866 (comment). 🌻

As I said in the other comment; ntfy server does support UTF-8 in headers, so if you send valid UTF-8 in headers it'll work. But because the HTTP spec does not officially support UTF-8, your libraries or language may not support it.

The suggested RFC encoding would fix this, obviously.

Hi Philipp.

ntfy server does support UTF-8 in headers, so if you send valid UTF-8 in headers it'll work.

Ah. Thanks for mentioning it once again.

But because the HTTP spec does not officially support UTF-8, your libraries or language may not support it.

Right, the Python client libraries would currently already croak on that detail, raising a corresponding exception. I will see if a workaround can be applied in form of a monkey patch or such.

But we agree it's dangerous, because there may be HTTP intermediaries in between, which might scramble those headers, right?

Encoding the headers using RFC 2047 would fix this, obviously.

I will very much appreciate such an improvement to ntfy. Until it will converge, I will eventually look into the monkey patch solution, or just let it sit like it is.

Thank you so much for your swift responses, and keep up the spirit.

With kind regards,
Andreas.

Works wonderfully: binwiederhier/ntfy#707

It's merged and will be in the next release

That was fast. Thank you very much!

I've adjusted the client-side implementation correspondingly with 609d79f. Thank you again!

Hi again,

at 609d79f#r110220447, you've commented:

I didn't do tags. Only title and message. Though tags are probably a good idea too.

This has already been added with binwiederhier/ntfy@59a5077713 now - thank you so much! I've complemented this improvement with b67e390, where RFC 2047 encoding will now only be applied to specific fields, title, message, and tags.

When looking through the available fields once more, I only discovered that the Action's label value might be another candidate for being encoded with RFC 2047, in order to use UTF-8 characters on the action buttons, when using HTTP header transport mode. But please consider this only as a discovery on my end, I personally do not have a need for that.

Thanks again for the quick turnaround on this matter.

With kind regards,
Andreas.

jpmens

Looks good to me

caronc · 2023-04-22T09:44:40Z

Just seeing this now, in regards to this:

address attachments on the local filesystem, and upload them to the ntfy instance. This was not possible beforehand.

Apprise does support local attachments to Ntfy already. I just wanted to chime in should i need to fix a bug of my own. Is this not working anymore?

Also, in another thread, i saw a discussion about renaming attach to file in the ntfy payload. Is this the case? Or will both keys work for backwards compatibility? Or most likely i just misinterpreted what was being said here🙂

amotl · 2023-04-23T13:06:29Z

Dear Chris,

thank you for chiming in. I've responded over at caronc/apprise#866 (comment), because I think it fits the context better, and otherwise the relevant information would be missing from that discussion. TLDR; a) I don't think Apprise currently supports local attachments, but only remote attachments of the ntfy API. b) Using a file field is exclusively related to the mqttwarn integration, nothing changed on the ntfy API.

With kind regards,
Andreas.

Only apply the encoding to the values of ntfy option fields `title`, `message`, and `tags`. Strip non-ASCII characters from all others.

Tests: Move test_ntfy out of the way

d9b495b

amotl mentioned this pull request Apr 20, 2023

[ntfy] Improve example/tutorial about Frigate event notifications #639

Merged

[ntfy] Add dedicated service plugin ntfy

79ea76a

amotl force-pushed the amo/ntfy branch from 2b90c29 to 79ea76a Compare April 20, 2023 16:32

amotl commented Apr 20, 2023

View reviewed changes

amotl requested review from jpmens and sumnerboy12 April 20, 2023 17:00

amotl marked this pull request as ready for review April 20, 2023 17:00

This was referenced Apr 20, 2023

Receiving and processing MQTT messages from Frigate NVR #632

Open

ntfy service #607

Open

[ntfy] Support for attaching/uploading local files caronc/apprise#866

Closed

Support for self-hosted ntfy instances vict0rsch/ntfy-wrapper#8

Closed

amotl commented Apr 21, 2023

View reviewed changes

[ntfy] Use file option to signal uploading a local file as attachment

40e2efd

amotl force-pushed the amo/ntfy branch from 986fcb6 to 40e2efd Compare April 21, 2023 13:13

amotl mentioned this pull request Apr 21, 2023

Improve section about mqttwarn owntracks/booklet#70

Merged

jpmens approved these changes Apr 22, 2023

View reviewed changes

This comment was marked as duplicate.

Sign in to view

[ntfy] Use RFC 2047 for encoding HTTP header values

609d79f

amotl force-pushed the amo/ntfy branch from 65c4c11 to 609d79f Compare April 23, 2023 16:50

amotl added 2 commits April 26, 2023 23:38

[ntfy] Add more fields: icon, cache, firebase, unifiedpush

7332f9b

[ntfy] Improve RFC 2047 header value encoding

b67e390

Only apply the encoding to the values of ntfy option fields `title`, `message`, and `tags`. Strip non-ASCII characters from all others.

amotl merged commit 08b4355 into main Apr 26, 2023

amotl deleted the amo/ntfy branch April 26, 2023 22:18

amotl mentioned this pull request May 3, 2023

Add basic example program, validating a self-hosted ntfy setup vict0rsch/ntfy-wrapper#10

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ntfy] Add dedicated service plugin `ntfy` #638

[ntfy] Add dedicated service plugin `ntfy` #638

amotl commented Apr 20, 2023 •

edited

Loading

codecov-commenter commented Apr 20, 2023 •

edited

Loading

amotl Apr 20, 2023

amotl Apr 20, 2023

amotl Apr 21, 2023 •

edited

Loading

amotl Apr 21, 2023 •

edited

Loading

binwiederhier Apr 21, 2023

amotl Apr 21, 2023 •

edited

Loading

binwiederhier Apr 21, 2023

binwiederhier Apr 22, 2023

amotl Apr 23, 2023

amotl Apr 23, 2023 •

edited

Loading

amotl Apr 26, 2023

jpmens left a comment

caronc commented Apr 22, 2023

This comment was marked as duplicate.

amotl commented Apr 23, 2023 •

edited

Loading

[ntfy] Add dedicated service plugin ntfy #638

[ntfy] Add dedicated service plugin ntfy #638

Conversation

amotl commented Apr 20, 2023 • edited Loading

About

Documentation

Details

References

codecov-commenter commented Apr 20, 2023 • edited Loading

Codecov Report

amotl Apr 20, 2023

Choose a reason for hiding this comment

amotl Apr 20, 2023

Choose a reason for hiding this comment

amotl Apr 21, 2023 • edited Loading

Choose a reason for hiding this comment

amotl Apr 21, 2023 • edited Loading

Choose a reason for hiding this comment

binwiederhier Apr 21, 2023

Choose a reason for hiding this comment

amotl Apr 21, 2023 • edited Loading

Choose a reason for hiding this comment

binwiederhier Apr 21, 2023

Choose a reason for hiding this comment

binwiederhier Apr 22, 2023

Choose a reason for hiding this comment

amotl Apr 23, 2023

Choose a reason for hiding this comment

amotl Apr 23, 2023 • edited Loading

Choose a reason for hiding this comment

amotl Apr 26, 2023

Choose a reason for hiding this comment

jpmens left a comment

Choose a reason for hiding this comment

caronc commented Apr 22, 2023

This comment was marked as duplicate.

amotl commented Apr 23, 2023 • edited Loading

[ntfy] Add dedicated service plugin `ntfy` #638

[ntfy] Add dedicated service plugin `ntfy` #638

amotl commented Apr 20, 2023 •

edited

Loading

codecov-commenter commented Apr 20, 2023 •

edited

Loading

amotl Apr 21, 2023 •

edited

Loading

amotl Apr 21, 2023 •

edited

Loading

amotl Apr 21, 2023 •

edited

Loading

amotl Apr 23, 2023 •

edited

Loading

amotl commented Apr 23, 2023 •

edited

Loading