Add issue sensors to Overseerr integration by AmGarera · Pull Request #158888 · home-assistant/core

AmGarera · 2025-12-13T03:39:56Z

Description

This PR adds 6 new sensors to track issue statistics in Overseerr. This is the first part of comprehensive issue management functionality - service actions will be added in a separate PR per review guidelines.

Note: This PR is now based on #158924 and depends on it being merged first.

Changes

New Sensors

Total issues
Open issues
Closed issues
Video issues
Audio issues
Subtitle issues

Technical Changes

Created models.py with OverseerrData composite model containing both RequestCount and IssueCount
Updated coordinator.py to fetch both request and issue counts in single update cycle
Modified sensor.py to use composite data model (data.requests.* and data.issues.*)
Added ISSUES constant to const.py
Added webhook support for issue notification types (ISSUE_REPORTED, ISSUE_COMMENTED, ISSUE_RESOLVED, ISSUE_REOPENED)
Added sensor translations to strings.json

Dependencies

Depends on Bump python-overseerr to 0.8.0 #158924 (python-overseerr 0.8.0 bump)
Requires python-overseerr 0.8.0 (PR: Add full CRUD support for issue management joostlek/python-overseerr#291) ✅ Merged

Type of change

Additional information

Services for issue management will be added in a follow-up PR
All new code follows Platinum quality scale requirements
Test coverage maintained above 95%

Checklist

The code change is tested and works locally
Tests have been added to verify the new code works
Documentation has been updated (separate PR: Document Overseerr issue management features home-assistant.io#42494)

Related Issues/PRs

python-overseerr enhancement: Add full CRUD support for issue management joostlek/python-overseerr#291 ✅ Merged
Dependency bump: Bump python-overseerr to 0.8.0 #158924 (merge this first)
Documentation: Document Overseerr issue management features home-assistant.io#42494
Replaces combined PR Add comprehensive issue management to Overseerr integration #158512 (split per review feedback)

home-assistant · 2025-12-13T03:40:02Z

Hey there @joostlek, mind taking a look at this pull request as it has been labeled with an integration (overseerr) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of overseerr can trigger bot actions by commenting:

@home-assistant close Closes the pull request.
@home-assistant rename Awesome new title Renames the pull request.
@home-assistant reopen Reopen the pull request.
@home-assistant unassign overseerr Removes the current integration label and assignees on the pull request, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

AmGarera · 2025-12-13T04:23:46Z

Implementation Plan

This PR is part 1 of a 2-part implementation for comprehensive issue management in Overseerr.

Dependencies

This PR depends on python-overseerr#291 which adds the issue management API methods to the python-overseerr library (v0.8.0).

PR Split Rationale

Per the review process guidelines, sensor changes and service introductions should be in separate PRs. This allows for:

Easier review of focused changes
Independent testing and validation
Clearer git history

Implementation Sequence

✅ python-overseerr library enhancement (PR #291) - Approved, awaiting merge
🔄 This PR: Add issue sensors - Adds 6 sensors and updates coordinator
⏳ Future PR: Add issue services - Will add 4 services (get_issues, create_issue, update_issue, delete_issue) after this PR merges
⏳ Documentation (PR #42494) - Covers both sensors and services, to be merged after both implementation PRs

What's in This PR

6 new issue sensors (total, open, closed, video, audio, subtitle)
Composite data model (OverseerrData) in coordinator
Webhook support for issue notifications
Updated translations

What's NOT in This PR (coming in part 2)

Service actions for issue management
Service schemas and definitions
Service-related constants

joostlek · 2025-12-13T09:45:13Z

I published v0.8.0, please bump in a separate PR

AmGarera · 2025-12-13T16:33:36Z

I've split out the dependency bump into #158924 as requested. Once that's merged, this PR will be ready for review.

The updated order is:

✅ python-overseerr v0.8.0 released
🔄 Bump python-overseerr to 0.8.0 #158924 - Version bump (Done/Merged)
⏳ This PR - Issue sensors (Ready For Review)
⏳ Follow-up PR - Issue services (after this merges)

joostlek

Can we add tests for this?

joostlek · 2025-12-13T21:19:47Z



-class OverseerrCoordinator(DataUpdateCoordinator[RequestCount]):
+class OverseerrCoordinator(DataUpdateCoordinator[OverseerrData]):


I think it would be nice to split up the coordinators so we can specifically only update the parts that need it. I am happy to help with this part, but justletting it know

Do we want to split them in this PR or in another PR, after this one? I'm good with either approach.

I think I'd rather do it in this PR.

home-assistant · 2025-12-13T21:19:52Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

AmGarera · 2025-12-14T00:54:47Z

Can we add tests for this?

I'll get these added

AmGarera · 2025-12-14T16:15:06Z

I've added comprehensive tests for the coordinator in commit 493ea08.

The test coverage now includes:

Successful data fetch for both requests and issues
Authentication error handling (for both API calls)
Connection error handling (for both API calls)
Data refresh functionality
Proper exception raising (ConfigEntryAuthFailed, UpdateFailed)

joostlek

Feel free to message me on Discord btw

joostlek · 2025-12-15T13:56:00Z



-class OverseerrCoordinator(DataUpdateCoordinator[RequestCount]):
+class OverseerrCoordinator(DataUpdateCoordinator[OverseerrData]):


I think I'd rather do it in this PR.

joostlek · 2025-12-15T13:56:15Z

  "iot_class": "local_push",
  "quality_scale": "platinum",
-  "requirements": ["python-overseerr==0.7.1"]
+  "requirements": ["python-overseerr==0.8.0"]


We bumped this in a separate PR right?

joostlek · 2025-12-15T13:56:41Z

+    ),
+    OverseerrSensorEntityDescription(
+        key="total_issues",
+        native_unit_of_measurement=ISSUES,


Oh we can move the unit of measurement to the translations and then we can translate it :)

joostlek · 2025-12-15T13:57:52Z

We don't want to test the coordinator directly, instead we should observe it via the state machine, like we do in the snapshot test (that's why test_sensor.ambr is updated).

Also, I think that we should have a test where we get an issue related webhook and observe what that does

Add 6 new sensors to track issues in Overseerr: - Total issues - Open issues - Closed issues - Video issues - Audio issues - Subtitle issues Update coordinator to fetch both request and issue counts. Add webhook support for issue notifications.

Add test coverage for the OverseerrCoordinator including: - Successful data fetch for both requests and issues - Authentication error handling - Connection error handling - Data refresh functionality - Proper exception raising (ConfigEntryAuthFailed, UpdateFailed) Also add issue_count.json test fixture and update conftest to mock get_issue_count API method.

Update test assertions to use actual values from request_count.json fixture instead of hardcoded incorrect values.

- Update REGISTERED_NOTIFICATIONS value from 222 to 4062 (now includes issue notifications) - Remove 'Bigger scope' test case as we now use all notification types - Update webhook_config.json fixture with new notification types value - Update snapshots for new issue sensors - All 52 tests passing with 100% coverage

Replace placeholder 'none' entity IDs with proper translation-key-based IDs: - sensor.overseerr_none → sensor.overseerr_total_issues - sensor.overseerr_none_2 → sensor.overseerr_open_issues - sensor.overseerr_none_3 → sensor.overseerr_closed_issues - sensor.overseerr_none_4 → sensor.overseerr_video_issues - sensor.overseerr_none_5 → sensor.overseerr_audio_issues - sensor.overseerr_none_6 → sensor.overseerr_subtitle_issues This fixes CI test failures on Python 3.14.2 where snapshots were not found.

- Move unit_of_measurement from hardcoded ISSUES constant to translation strings - Remove ISSUES constant from const.py (no longer needed) - Add 'state.measurement' translations for all 6 issue sensors - Remove direct coordinator tests (test via state machine instead) - Add webhook test for issue events (test_webhook_issue_trigger_update) - Fix webhook handler to refresh coordinator for REQUEST_ and ISSUE_ events - Add webhook_issue_reported.json test fixture - Update snapshots for new unit_of_measurement approach This allows the unit 'issues' to be translated to different languages.

AmGarera requested a review from joostlek as a code owner December 13, 2025 03:39

home-assistant Bot added cla-signed integration: overseerr labels Dec 13, 2025

home-assistant Bot assigned joostlek Dec 13, 2025

home-assistant Bot added the Quality Scale: platinum label Dec 13, 2025

AmGarera mentioned this pull request Dec 13, 2025

Document Overseerr issue management features home-assistant/home-assistant.io#42494

Merged

AmGarera mentioned this pull request Dec 13, 2025

Add full CRUD support for issue management joostlek/python-overseerr#291

Merged

AmGarera mentioned this pull request Dec 13, 2025

Bump python-overseerr to 0.8.0 #158924

Merged

16 tasks

AmGarera force-pushed the feature/overseerr-issue-sensors branch from 20d7c65 to 47bcdb7 Compare December 13, 2025 16:34

joostlek added the new-feature label Dec 13, 2025

joostlek requested changes Dec 13, 2025

View reviewed changes

home-assistant Bot marked this pull request as draft December 13, 2025 21:19

AmGarera marked this pull request as ready for review December 14, 2025 17:14

home-assistant Bot requested a review from joostlek December 14, 2025 17:14

AmGarera marked this pull request as draft December 14, 2025 17:14

AmGarera marked this pull request as ready for review December 15, 2025 01:46

joostlek requested changes Dec 15, 2025

View reviewed changes

home-assistant Bot marked this pull request as draft December 15, 2025 13:58

AmGarera added 5 commits December 15, 2025 21:02

Fix coordinator test assertions to match fixture data

464e9d0

Update test assertions to use actual values from request_count.json fixture instead of hardcoded incorrect values.

AmGarera force-pushed the feature/overseerr-issue-sensors branch from 9bca18c to cb6bed5 Compare December 16, 2025 02:02

AmGarera marked this pull request as ready for review December 16, 2025 16:07

home-assistant Bot requested a review from joostlek December 16, 2025 16:07

joostlek approved these changes Dec 16, 2025

View reviewed changes

home-assistant Bot added the code-owner-approved label Dec 16, 2025

joostlek merged commit 3f57b46 into home-assistant:dev Dec 16, 2025
36 checks passed

AmGarera deleted the feature/overseerr-issue-sensors branch December 16, 2025 16:38

heindrichpaul pushed a commit to heindrichpaul/core that referenced this pull request Dec 17, 2025

Add issue sensors to Overseerr integration (home-assistant#158888)

612fcf3

github-actions Bot locked and limited conversation to collaborators Dec 17, 2025



		class OverseerrCoordinator(DataUpdateCoordinator[RequestCount]):
		class OverseerrCoordinator(DataUpdateCoordinator[OverseerrData]):

Uh oh!

Conversation

AmGarera commented Dec 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

New Sensors

Technical Changes

Dependencies

Type of change

Additional information

Checklist

Related Issues/PRs

Uh oh!

home-assistant Bot commented Dec 13, 2025

Uh oh!

AmGarera commented Dec 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Implementation Plan

Dependencies

PR Split Rationale

Implementation Sequence

What's in This PR

What's NOT in This PR (coming in part 2)

Uh oh!

joostlek commented Dec 13, 2025

Uh oh!

AmGarera commented Dec 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joostlek left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

home-assistant Bot commented Dec 13, 2025

Uh oh!

AmGarera commented Dec 14, 2025

Uh oh!

AmGarera commented Dec 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joostlek left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

AmGarera commented Dec 13, 2025 •

edited

Loading

AmGarera commented Dec 13, 2025 •

edited

Loading

AmGarera commented Dec 13, 2025 •

edited

Loading

AmGarera commented Dec 14, 2025 •

edited

Loading