fix: avoid reflecting back SMOKE_CMONX when changing smart audio #141

bdraco · 2024-07-04T16:04:03Z

Description of change

This value is never reflected back by the UI client and will prevent changing smoke/CO detections if sent

Summary by CodeRabbit

New Features
- Introduced a method to manipulate audio types in device data.
Tests
- Added new unit tests for smart audio detection settings in camera configurations.

This value is never reflected back by the UI client and will prevent changing smoke/CO detections if sent

coderabbitai · 2024-07-04T16:04:10Z

Walkthrough

This update introduces a new method unifi_dict in the ProtectBaseObject class of the devices.py module, which manipulates data related to audio types and excludes specific types. It also includes a new test case to check the behavior of smart audio detection settings in cameras.

Changes

File	Change Summary
`src/uiprotect/data/devices.py`	Added a method `unifi_dict` to `ProtectBaseObject` class to manipulate audio type data.
`tests/data/test_camera.py`	Introduced the `SmartDetectAudioType` import and added a test function `test_camera_disable_co` to manage camera settings for smart audio detection.

Poem

In the land of code where changes flow,
A new method springs up to show,
How audio types, once so grand,
Can be filtered with a guiding hand.
Tests arose to check the sight,
Ensuring all works day and night.
🎉🐰 Here’s to progress sleek and bright!

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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 · 2024-07-04T16:06:13Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Files	Coverage Δ
src/uiprotect/data/devices.py	`84.92% <100.00%> (+0.32%)`	⬆️

coderabbitai

Actionable comments posted: 1

Outside diff range and nitpick comments (1)

src/uiprotect/data/devices.py (1)

474-487: Add a docstring to the method.

The method unifi_dict is missing a docstring. Adding a docstring will help in understanding the purpose and functionality of the method.

def unifi_dict(
    self,
    data: dict[str, Any] | None = None,
    exclude: set[str] | None = None,
) -> dict[str, Any]:
    """
    Manipulates data dictionaries, excluding certain audio types before returning the modified data.

    Args:
        data (dict[str, Any] | None): The data dictionary to manipulate.
        exclude (set[str] | None): The set of keys to exclude from the data dictionary.

    Returns:
        dict[str, Any]: The modified data dictionary.
    """
    data = super().unifi_dict(data=data, exclude=exclude)
    if audio_types := data.get("audioTypes"):
        # SMOKE_CMONX is not supported for audio types
        # and should not be sent to the camera
        data["audioTypes"] = [
            t for t in audio_types if t != SmartDetectAudioType.SMOKE_CMONX.value
        ]
    return data

Tools

GitHub Check: codecov/patch

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1d7fb76 and dd82d03.

Files selected for processing (1)

src/uiprotect/data/devices.py (1 hunks)

Additional context used

GitHub Check: codecov/patch

src/uiprotect/data/devices.py

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

src/uiprotect/data/devices.py

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dd82d03 and e84788c.

Files selected for processing (1)

tests/data/test_camera.py (2 hunks)

Additional comments not posted (11)

tests/data/test_camera.py (11)

20-20: Import of SmartDetectAudioType is appropriate.

The import is necessary for the new test function and correctly placed.

1021-1021: Skip test if camera data is missing.

The skip condition ensures that the test only runs if the camera data is available.

1022-1022: Parameterize the test for both enabled and disabled states.

The parameterization ensures that the test covers both enabling and disabling CO detection.

1023-1023: Mark the test as asynchronous.

The asyncio marker indicates that the test function is asynchronous.

1024-1026: Skip test if camera_obj is None.

The skip condition ensures that the test only runs if the camera_obj is available.

1028-1029: Set necessary feature flags and recording mode.

The feature flags and recording mode are set to ensure the test environment is correctly configured.

1031-1038: Set smart detect settings based on the status.

The settings for audio types are correctly adjusted based on the status parameter.

1040-1040: Reset API request mock.

Resetting the mock ensures that previous API calls do not interfere with the test.

1042-1044: Call set_smart_audio_detect_types with appropriate values.

The function call correctly sets the smart audio detect types.

1046-1049: Assert the correct audio types are set.

The assertion ensures that the audio types are correctly set in the camera_obj.

1051-1055: Verify the API request is correctly formed.

The API request is checked to ensure it matches the expected format and values.

fix: avoid reflecting back SMOKE_CMONX when changing smart audio

dd82d03

This value is never reflected back by the UI client and will prevent changing smoke/CO detections if sent

bdraco temporarily deployed to release July 4, 2024 16:06 — with GitHub Actions Inactive

coderabbitai bot reviewed Jul 4, 2024

View reviewed changes

src/uiprotect/data/devices.py Show resolved Hide resolved

chore: coverage

e84788c

bdraco merged commit 7270a5c into main Jul 4, 2024
10 checks passed

bdraco deleted the fix_smoke_co branch July 4, 2024 16:14

coderabbitai bot reviewed Jul 4, 2024

View reviewed changes

bdraco had a problem deploying to release July 4, 2024 16:15 — with GitHub Actions Failure

bdraco mentioned this pull request Jul 4, 2024

Cleanup unifiprotect entity classes home-assistant/core#121184

Merged

20 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: avoid reflecting back SMOKE_CMONX when changing smart audio #141

fix: avoid reflecting back SMOKE_CMONX when changing smart audio #141

bdraco commented Jul 4, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 4, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Jul 4, 2024 •

edited

Loading

coderabbitai bot left a comment

coderabbitai bot left a comment

fix: avoid reflecting back SMOKE_CMONX when changing smart audio #141

fix: avoid reflecting back SMOKE_CMONX when changing smart audio #141

Conversation

bdraco commented Jul 4, 2024 • edited by coderabbitai bot Loading

Description of change

Summary by CodeRabbit

coderabbitai bot commented Jul 4, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Jul 4, 2024 • edited Loading

Codecov Report

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

bdraco commented Jul 4, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 4, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

codecov bot commented Jul 4, 2024 •

edited

Loading