feat: Add Apprise-based notification system with rule engine #4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mverteuil
force-pushed
the
feature/notifications
branch
2 times, most recently
from
db13287 to
d7cdc6a
Compare
…ervice Delegates scope checking queries to DetectionQueryService to maintain proper separation of concerns between business logic and data access. Changes: - Add is_first_detection_ever() and is_first_detection_in_period() methods to DetectionQueryService for window function queries - Add get_species_taxonomy() to SpeciesDatabaseService for taxonomy lookups - Refactor NotificationRuleProcessor to use DetectionQueryService for scope checks - Wire DetectionQueryService into NotificationManager via dependency injection - Update all notification tests to mock DetectionQueryService methods - Fix flaky integration test by stopping background flush task during manual flushes All 1,788 tests pass. Pre-commit checks pass.
Implements Apprise integration for notification delivery and comprehensive rule-based notification filtering. Changes: - Add AppriseService for multi-channel notifications (Discord, Telegram, etc.) - Implement notification rule processing with taxa filters, scope checks - Add comprehensive test suites with proper Mock specs and type safety - Wire notification services into application lifecycle - Update test utilities for better Mock handling - Fix test flakiness and type checking errors All 184 notification tests pass. All pre-commit checks pass.
Add ast-grep patterns to detect when Mock objects use other Mock classes as their spec parameter (e.g., spec=MagicMock, spec=Mock, spec=AsyncMock). These circular references provide no type safety and defeat the purpose of using specs. Update documentation to explicitly list these as forbidden patterns.
Replaced all spec=MagicMock (circular reference) with proper specs using the actual apprise.Apprise methods (add, notify, clear). This provides proper type safety while maintaining test functionality. All 39 tests pass.
- Changed AsyncMock(spec=AsyncMock) to AsyncMock(spec=ActualMethod) - Fixes ast-grep linter errors for mock object specifications - Ensures mocks properly match their target method signatures
- Changed AsyncMock method mocks from spec=ClassName.method to spec_set=True - Fixes test failure where spec validation expected 'self' parameter - spec_set validates attribute assignment without validating call signature - Resolves conflict between ast-grep requirement for specs and signature validation
mverteuil
force-pushed
the
feature/notifications
branch
from
b133a70 to
60cd624
Compare
- Images are already pre-built in CI workflow - Avoids redundant rebuild that was causing test failures - Aligns with fast-actions worktree pattern
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces a comprehensive notification system using Apprise, enabling BirdNET-Pi to send alerts via multiple services (email, Discord, Slack, etc.) based on configurable detection rules.
Key Features
DetectionQueryServiceTechnical Details
New Components
ApprisePlatformService: Core notification delivery service with platform configurationNotificationRuleProcessor: Rule evaluation and detection filtering engineNotificationManager: Orchestrates notification workflow with buffering supportDatabase Changes
get_detections_in_time_window()toDetectionQueryServicefor efficient rule filteringget_vernacular_name()toSpeciesDatabaseServicefor common name lookupsQuality Assurance
Testing
All tests passing with comprehensive coverage:
Breaking Changes
None - this is a new feature that extends existing notification system.
Documentation
Configuration examples included in test fixtures. User documentation will follow in separate PR.