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

Consistent Status Display on All Supported Services #931

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

Conversation

caronc
Copy link
Owner

@caronc caronc commented Aug 20, 2023

Description:

Related issue (if applicable): #691

Apprise carries a few entries as part of it's payload. The optional title, the body, and the type (whether it's an info, warning, error, etc).

The problem is the info doesn't get carried forward on a lot of different platforms, yet it does on others. due to the varying degree of support from one service to another, some support icons that change colors, but others are very text driven (like SMS messages).

For consistency, these text forms should share a means of passing along the message status. those who don't wnat to see it can turn it off with ?status=off.

The Ascii layout is as follows:

Notification Type Text Representation Image Ascii Alternative
NotifyType.INFO info Build Status [i]
NotifyType.SUCCESS success Build Status [+]
NotifyType.WARNING warning Build Status [~]
NotifyType.FAILURE failure Build Status [!]

The following systems have been detected to not properly pass along the status:

  • SignalAPI
  • ... still need to iterate over the /plugins and get remaining impacted plugins

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • No lint errors (use flake8)
  • 100% test coverage

Testing

Anyone can help test this source code as follows:

# Create a virtual environment to work in as follows:
python3 -m venv apprise

# Change into our new directory
cd apprise

# Activate our virtual environment
source bin/activate

# Install the branch
pip install git+https://github.com/caronc/apprise.git@show-status-consistency

# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
  <apprise url related to ticket>

@caronc caronc changed the title SignalAPI Status Display Consistent Status Display on All Supported Services Aug 20, 2023
@codecov-commenter
Copy link

codecov-commenter commented Aug 20, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (31caff1) 99.51% compared to head (3d40a46) 99.51%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #931   +/-   ##
=======================================
  Coverage   99.51%   99.51%           
=======================================
  Files         123      123           
  Lines       16349    16349           
  Branches     3329     3329           
=======================================
  Hits        16270    16270           
  Misses         70       70           
  Partials        9        9           
Files Changed Coverage Δ
apprise/plugins/NotifySignalAPI.py 100.00% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants