Add sample_bytes to media player supported format and a test

[synesthesiam]

Adds a sample_bytes field to MediaPlayerSupportedFormat. For certain media formats, we will need to know the required width of audio samples because ffmpeg has limited supported.

A test is also added for media player format code to increase test coverage.

[coderabbitai]

Walkthrough

This pull request introduces a new field, sample_bytes, to the MediaPlayerSupportedFormat message in the aioesphomeapi/api.proto file. Correspondingly, a class attribute for sample_bytes is added to the MediaPlayerSupportedFormat class in aioesphomeapi/model.py. Additionally, a new test function is implemented in tests/test_model.py to validate the conversion of media player information into the MediaPlayerInfo object, ensuring proper instantiation of the new attribute along with existing ones.

Changes

File	Change Summary
aioesphomeapi/api.proto	Added uint32 sample_bytes = 5 to MediaPlayerSupportedFormat message.
aioesphomeapi/model.py	Added sample_bytes: int = 0 to MediaPlayerSupportedFormat class.
tests/test_model.py	Introduced test_media_player_supported_format_convert_list to validate the conversion of formats.

Possibly related PRs

• Add MediaPlayerSupportedFormat #925: Introduces the MediaPlayerSupportedFormat message, relevant to the new field addition.
• Remove id from MediaPlayerSupportedFormat #948: Removes the id field from the MediaPlayerSupportedFormat message, affecting the same message structure.

Suggested labels

new-feature

Tip

New features

Walkthrough comment now includes:

• Possibly related PRs: A list of potentially related PRs to help you recall past context.
• Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

• Please share any feedback in the discussion post on our Discord.
• Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between af5309e and ebb53a2.

Files selected for processing (3)

• aioesphomeapi/api.proto (1 hunks)
• aioesphomeapi/model.py (1 hunks)
• tests/test_model.py (2 hunks)

Additional context used

Path-based instructions (3)

tests/test_model.py (1)

Pattern **: - Do not generate or add any sequence diagrams

aioesphomeapi/model.py (1)

Pattern **: - Do not generate or add any sequence diagrams

aioesphomeapi/api.proto (1)

Pattern **: - Do not generate or add any sequence diagrams

Additional comments not posted (3)

tests/test_model.py (1)

657-683: Approve the test implementation for MediaPlayerSupportedFormat.

The test function test_media_player_supported_format_convert_list correctly checks the instantiation of the MediaPlayerInfo object from a dictionary. It includes the new sample_bytes field, ensuring it is properly integrated.

Consider adding more comprehensive tests to cover edge cases or variations in input, such as missing fields or incorrect data types, to ensure robustness.

aioesphomeapi/model.py (1)

838-838: Approve the addition of sample_bytes attribute.

The new attribute sample_bytes in the MediaPlayerSupportedFormat class is correctly defined with a default value of 0. This addition follows the standard practice for extending data models in a backward-compatible manner.

Ensure that the usage of this new attribute is covered in all relevant parts of the application, particularly in serialization and deserialization logic, to maintain data integrity.

aioesphomeapi/api.proto (1)

1148-1148: Approve the addition of sample_bytes field.

The new field sample_bytes in the MediaPlayerSupportedFormat message is correctly defined as a uint32. This is an appropriate choice for representing byte sizes and ensures compatibility and correctness in data handling.

Verify that this new field is properly handled in all parts of the application that interact with media player formats, including serialization, deserialization, and any relevant business logic.

---

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (151b76d) to head (ebb53a2).
Report is 6 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main      #955      +/-   ##
===========================================
+ Coverage   99.88%   100.00%   +0.11%     
===========================================
  Files          17        17              
  Lines        2635      2636       +1     
===========================================
+ Hits         2632      2636       +4     
+ Misses          3         0       -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.