feat: cleanup processing of websocket packets

[bdraco]

Description of change

• remove unreachable code that checked type of data since invalid data already raises in the WSPacket class
• cache the result of the WSPacket properties
• avoid many dict lookups in the websocket data processing
• avoid creating enums in the websocket packet processing
• avoid useless set creation on every packet when models is not passed
• add some missing types
• cache klass_from_format since the inputs are almost all the same

Summary by CodeRabbit

• Refactor

  • Improved performance by replacing some property decorators with cached property decorators.
  • Enhanced type safety with added return type hints for initialization methods.

• Bug Fixes

  • Enhanced handling of various action types and models to prevent unexpected behavior.
  • Added debug logging for better troubleshooting of unexpected model types.

[coderabbitai]

Walkthrough

The recent modifications primarily focus on enhancing the functionality and performance of the WSAction, WSPacket, and WSSubscriptionMessage classes in the bootstrap.py and websocket.py files. Key changes include refining variable assignments, updating conditional checks, implementing cached properties for efficiency, and adding debug logging for better traceability.

Changes

Files	Change Summaries
src/uiprotect/data/bootstrap.py	Refactored process_ws_packet function, removed WSJSONPacketFrame import, added _ModelType_NVR_value and _ModelType_Event_value assignments.
src/uiprotect/data/websocket.py	Added cached_property decorator, replaced @property with @cached_property, added return type hint to __init__ method.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Bootstrap
    participant WSPacket

    Client ->> Bootstrap: Initialize Bootstrap instance
    Bootstrap ->> WSPacket: Receive WebSocket data
    WSPacket -->> Bootstrap: Parse data with cached properties
    Bootstrap ->> Bootstrap: Process WebSocket packet
    Bootstrap -->> Client: Return processed data

Loading

Poem

In the land of code, where packets fly,
@cached_property now stands high.
With variables refined and checks anew,
Debug logs light the pathway through.
The Bootstrap dances with grace and might,
In the twilight of bytes, it finds its light.
🐇✨

---

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>.
  • 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]

Codecov Report

Attention: Patch coverage is 65.21739% with 8 lines in your changes missing coverage. Please review.

Files	Coverage Δ
src/uiprotect/data/websocket.py	82.85% <100.00%> (-0.24%)	⬇️
src/uiprotect/data/bootstrap.py	51.81% <50.00%> (+0.97%)	⬆️

... and 1 file with indirect coverage changes

[coderabbitai]

Actionable comments posted: 1

Outside diff range and nitpick comments (1)

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

186-186: Add a docstring to the __init__ method to improve code documentation.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a58f4b9 and cca13bc.

Files selected for processing (2)

• src/uiprotect/data/bootstrap.py (3 hunks)
• src/uiprotect/data/websocket.py (5 hunks)

Additional context used

GitHub Check: codecov/patch

src/uiprotect/data/bootstrap.py

[warning] 550-550: src/uiprotect/data/bootstrap.py#L550
Added line #L550 was not covered by tests

---

[warning] 586-586: src/uiprotect/data/bootstrap.py#L586
Added line #L586 was not covered by tests

Additional comments not posted (3)

src/uiprotect/data/websocket.py (2)

Line range hint 196-206: The use of cached_property for action_frame and data_frame is a good optimization to avoid redundant decoding.

Also applies to: 206-227

---

226-227: Ensure that the cache invalidation in the raw setter method is effective by testing edge cases where raw data changes frequently.

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

171-173: The addition of _ModelType_NVR_value and _ModelType_Event_value as class-level constants is a good practice for maintainability and readability.

[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 cca13bc and eeb3649.

Files selected for processing (1)

• src/uiprotect/data/websocket.py (6 hunks)

Files skipped from review as they are similar to previous changes (1)

• src/uiprotect/data/websocket.py