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

Support asking device to check for updates #914

Merged
merged 4 commits into from
Aug 5, 2024
Merged

Conversation

jesserockz
Copy link
Member

  • Change install key in UpdateCommandRequest to be an enum
  • Add support for sending "Check for Update" command

This changes the update_command method signature and is therefore a breaking change.

Add support for sending "Check for Update" command
Copy link
Contributor

coderabbitai bot commented Aug 5, 2024

Warning

Rate limit exceeded

@jesserockz has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 59 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 10d2cc6 and 9fb3fca.

Walkthrough

The recent changes enhance the update command functionality within the aioesphomeapi framework. A new UpdateCommand enumeration has been introduced, replacing the previous boolean install parameter in relevant request messages. This shift improves the clarity and structure of command handling across the API, client, and testing modules, promoting better maintainability and expressiveness in managing update operations.

Changes

Files Change Summary
aioesphomeapi/api.proto, aioesphomeapi/client.py, aioesphomeapi/model.py A new UpdateCommand enum has been added, replacing the install boolean in the UpdateCommandRequest. This change improves command handling in the API and client modules.
tests/test_client.py Updated tests to use the new UpdateCommand enum instead of a boolean for command parameters, enhancing clarity and maintainability.

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 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
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, codebase verification and nitpick comments (1)
aioesphomeapi/client.py (1)

1217-1219: Breaking change: Verify all function calls to update_command match the new signature.

The function call await client.update_command(1, True) in tests/test_client.py does not match the new signature. Please update this call to pass the correct UpdateCommand parameter.

  • tests/test_client.py: await client.update_command(1, True)
Analysis chain

Breaking change: Verify all function calls to update_command match the new signature.

The function signature change is a breaking change. Ensure that all function calls to update_command match the new signature with the UpdateCommand parameter.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `update_command` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type python -A 5 $'update_command'

Length of output: 69


Script:

#!/bin/bash
# Description: Verify all function calls to `update_command` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg 'update_command'

Length of output: 292

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant