fix: add error handling and logging to get_camera_video()

[ianalexander]

Description of change

This PR does 2 things:

1. Error handling for get_camera_video() requests: Today in get_camera_video(), if the protect server returns any status code other than 200, the client will happily return None without indicating anything went wrong. This PR uses the raise_for_status() pattern found in the rest of this file to raise an error when the protect server returns an irregular status code, providing better visibility for both the CLI and API interfaces.
2. Logging for get_camera_video() requests: This PR adds additional request logging to the get_camera_video() function, which can be used to help debug requests that fail. The log level is set to DEBUG.

This has been discussed in home-assistant/core#132524.

Pull-Request Checklist

• Code is up-to-date with the main branch
• This pull request follows the contributing guidelines.
• This pull request links relevant issues as Fixes #0000 n/a
• There are new or updated unit tests validating the change n/a
• Documentation has been updated to reflect this change n/a
• The new commits follow conventions outlined in the conventional commit spec, such as "fix(api): prevent racing of requests".

Summary by CodeRabbit

• New Features

  • Enhanced error handling for video requests, ensuring non-successful responses are managed effectively.
  • Standardized processing of event identifiers for thumbnails and heatmaps.

• Bug Fixes

  • Improved logging for video request details to aid in debugging.

• Documentation

  • Updated method signatures to reflect internal logic changes while maintaining parameter consistency.

[coderabbitai]

Walkthrough

The pull request introduces modifications to the ProtectApiClient class in the src/uiprotect/api.py file. The changes focus on improving error handling and logging for video requests, specifically in the get_camera_video method. Additionally, the methods for retrieving event thumbnails and heatmaps have been updated to standardize event identifier processing by removing the "e-" prefix from identifiers.

Changes

File	Change Summary
src/uiprotect/api.py	- Added debug logging in get_camera_video method - Implemented response status check in video request method - Updated event thumbnail and heatmap methods to handle identifier formats

Poem

🐰 Hop, hop, through the code we go,
Debugging paths where errors flow,
Thumbnails and videos, now more bright,
With rabbit-like precision and might!
API calls dancing with grace, 🌟
No "e-" prefix left to trace!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2264ea4 and 68eed49.

📒 Files selected for processing (1)

• src/uiprotect/api.py (1 hunks)

🔇 Additional comments (2)

src/uiprotect/api.py (2)

1565-1565: LGTM: Debug logging added for request details.

The addition of debug logging before making the request is helpful for troubleshooting failed requests. The log message includes all necessary context: API path, endpoint, and parameters.

---

1573-1575: LGTM: Proper error handling implemented.

The implementation of error handling using raise_for_status is a good improvement:

• Previously, non-200 status codes would silently return None
• Now, errors are properly propagated to both CLI and API users
• The error handling is consistent with the rest of the codebase's error handling pattern

This change aligns perfectly with the PR objectives of improving error visibility.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/uiprotect/api.py	0.00%	3 Missing ⚠️

Files with missing lines	Coverage Δ
src/uiprotect/api.py	55.97% <0.00%> (-0.22%)	⬇️