Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: Improve Notif. Test message to catch edge cases #4604

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

chakflying
Copy link
Collaborator

@chakflying chakflying commented Mar 20, 2024

⚠️⚠️⚠️ Since we do not accept all types of pull requests and do not want to waste your time. Please be sure that you have read pull request rules:
https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma

Tick the checkbox if you understand [x]:

  • I have read and understand the pull request rules.

Description

In the past, there were a few issues where problems with peoples' notification configuration caused UP/DOWN notification to fail to deliver, but the manually triggered Test message is unable to reproduce the issue. Just from memory key ones are:

  • Handling newline characters within msg: e.g. a DOWN message for a Ping monitor would most likely include a newline character. This has caused webhook notifications to fail to deliver because of issue with templating.
  • Unicode char: The cross emoji somehow cause the message to be blocked by notification providers.

Maybe we should improve the test message to include these common pitfalls for better testing.

Type of change

  • New feature (non-breaking change which adds functionality)

Checklist

  • My code follows the style guidelines of this project
  • I ran ESLint and other linters for modified files
  • I have performed a self-review of my own code and tested it
  • I have commented my code, particularly in hard-to-understand areas (including JSDoc for methods)
  • My changes generates no new warnings
  • My code needed automated testing. I have added them (this is optional task)

Screenshots (if any)

Please do not use any external image service. Instead, just paste in or drag and drop the image here, and it will be uploaded automatically.

@CommanderStorm
Copy link
Collaborator

Another change that might be worth lumping into this is to make the Test-button iclude a monitorJSON, as all other notifications (Cert-Exp, UP, DOWN) have that.

See #3414

@chakflying chakflying added the area:notifications Everything related to notifications label Mar 29, 2024
@CommanderStorm CommanderStorm added the needs:work this PR needs work label May 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:notifications Everything related to notifications needs:work this PR needs work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants