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

feat: add support for fetching the rtsp url without srtp #261

Merged
merged 1 commit into from
Nov 4, 2024
Merged

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Nov 4, 2024

go2rtc doesn't support srtp yet and it doesn't need it anyways since we always use tcp with rtsps

https://github.com/AlexxIT/go2rtc/?tab=readme-ov-file#source-rtsp

Summary by CodeRabbit

  • New Features

    • Introduced a new RTSP streaming URL property (rtsps_no_srtp_url) for enhanced streaming capabilities.
    • Added a method to manage privacy zones in camera views, allowing users to enable or disable privacy settings.
  • Bug Fixes

    • Improved validation of RTSP URLs in testing to ensure correct formatting and reliability.

These changes enhance the functionality and reliability of camera management features for users.

Copy link
Contributor

coderabbitai bot commented Nov 4, 2024

Walkthrough

The changes introduce a new property, rtsps_no_srtp_url, to the CameraChannel class for constructing RTSP URLs without SRTP. Additionally, a new method, set_privacy, is added to the Camera class, allowing for the management of privacy zones. This method includes parameters for enabling the zone, adjusting microphone levels, and setting recording modes. Corresponding tests in tests/test_api.py are updated to enhance validation of the RTSP URLs, including the new property, ensuring robust testing of the camera channel functionalities.

Changes

File Change Summary
src/uiprotect/data/devices.py - Added property rtsps_no_srtp_url to CameraChannel.
- Added method set_privacy to Camera for managing privacy zones.
tests/test_api.py - Enhanced check_camera function to validate rtsp_url, rtsps_url, and new rtsps_no_srtp_url with additional assertions.

Poem

In the realm of cameras bright,
New streams flow without a fright.
Privacy zones now take their stand,
With a gentle touch, we guide the hand.
Hopping through code, we celebrate,
Enhancements made, oh, isn’t it great! 🐇✨


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
🪧 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 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.

Copy link

codecov bot commented Nov 4, 2024

Codecov Report

Attention: Patch coverage is 88.88889% with 1 line in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/uiprotect/data/devices.py 88.88% 1 Missing ⚠️
Files with missing lines Coverage Δ
src/uiprotect/data/devices.py 85.27% <88.88%> (+0.01%) ⬆️

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
tests/test_api.py (1)

84-96: LGTM! The URL validation looks good.

The changes correctly validate the RTSP URL formats, including the new rtsps_no_srtp_url property. The double validation through the loop helps ensure URL consistency.

Consider adding test cases for edge cases such as:

  • Invalid connection host
  • Empty RTSP alias
  • Special characters in RTSP alias

Example test case:

def test_rtsp_url_edge_cases():
    # Test invalid connection host
    camera.api.connection_host = None
    with pytest.raises(ValueError):
        _ = channel.rtsps_no_srtp_url

    # Test empty RTSP alias
    channel.rtsp_alias = ""
    with pytest.raises(ValueError):
        _ = channel.rtsps_no_srtp_url
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cd46006 and 3da3f8f.

📒 Files selected for processing (2)
  • src/uiprotect/data/devices.py (2 hunks)
  • tests/test_api.py (1 hunks)
🧰 Additional context used
🪛 GitHub Check: codecov/patch
src/uiprotect/data/devices.py

[warning] 301-301: src/uiprotect/data/devices.py#L301
Added line #L301 was not covered by tests

🔇 Additional comments (2)
src/uiprotect/data/devices.py (2)

276-276: LGTM!

The private attribute follows the established pattern for URL caching in the class.


298-306: Implementation looks good but needs test coverage.

The property implementation follows the established pattern and correctly handles edge cases. However, line 301 is not covered by tests.

Run the following script to verify the URL format matches go2rtc's expectations:

✅ Verification successful

The search results show that the RTSPS URL format is already being tested in tests/test_api.py, which verifies both SRTP-enabled and non-SRTP URLs. The format matches between the implementation and tests:

  1. With SRTP: rtsps://{host}:{port}/{alias}?enableSrtp
  2. Without SRTP: rtsps://{host}:{port}/{alias}

Let me verify if there are any other RTSPS URL formats in the codebase:


Let me check if there are any configuration files or examples that might show the expected URL format:


RTSPS URL format is correctly implemented and verified by tests

The implementation matches the URL format that's being verified in the test suite:

  • SRTP enabled: rtsps://{host}:{port}/{alias}?enableSrtp
  • SRTP disabled: rtsps://{host}:{port}/{alias}
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the RTSPS URL format matches go2rtc's expectations
# Test: Search for RTSPS URL handling in go2rtc documentation or code
rg -A 5 'rtsps://'

Length of output: 1517


Script:

#!/bin/bash
# Search for any other RTSPS URL patterns or documentation
rg -i 'rtsps.*://' --type md

Length of output: 30


Script:

#!/bin/bash
# Search for RTSPS configuration or examples in yaml/json files
rg -i 'rtsps' --type yaml --type json -A 5

Length of output: 42

🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 301-301: src/uiprotect/data/devices.py#L301
Added line #L301 was not covered by tests

@bdraco bdraco merged commit 7d0cfd3 into main Nov 4, 2024
14 checks passed
@bdraco bdraco deleted the no_srtp branch November 4, 2024 21:07
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.

1 participant