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

Support Asynchronous Dynamic Module Loading #1071

Merged
merged 5 commits into from
Mar 3, 2024

Conversation

caronc
Copy link
Owner

@caronc caronc commented Mar 3, 2024

Description:

Related issue (if applicable): #1020

This is in efforts to address a racing condition that happens in Home Assistant Core/110242

Effectively what this patch does is adds a mutex around the (notification) plugin loading. In addition to this, a flag is tracked when loading has been completed allowing threaded or asynchronous instances of Apprise to work correctly.

Previously (before this patch), the Apprise library would start loading it's (notification) plugins dynamically after first being instantiated. However second instances would not recognize that the first instance hadn't completed loading all the libraries. The second instance would however detect that plugins were loaded (it really depends on how far the first instance got during it's startup) and assumed it was okay to start processing URLs it was fed. If your notification URL referenced a plugin that simply hadn't loaded yet (it's a timing thing), it would flat out fail.

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@1020-async-module-loading-fix

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

@codecov-commenter
Copy link

codecov-commenter commented Mar 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.27%. Comparing base (52aa7f4) to head (519dec9).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1071   +/-   ##
=======================================
  Coverage   99.27%   99.27%           
=======================================
  Files         136      136           
  Lines       17739    17753   +14     
  Branches     3618     3623    +5     
=======================================
+ Hits        17611    17625   +14     
  Misses        119      119           
  Partials        9        9           

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

@caronc caronc merged commit 26d8e45 into master Mar 3, 2024
12 checks passed
@caronc caronc mentioned this pull request Mar 7, 2024
4 tasks
@caronc caronc deleted the 1020-async-module-loading-fix branch April 6, 2024 15:05
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