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

Add Exception handling when processing udev devices #5088

Merged
merged 9 commits into from
May 29, 2024

Conversation

RichardPar
Copy link
Contributor

@RichardPar RichardPar commented May 18, 2024

Khadas VIM4 UDEV returns something that python crapps its pants about. The exception just allows it to continue.

Proposed change

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to the supervisor)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Ruff (ruff format supervisor tests)
  • Tests have been added to verify that the new code works.

If API endpoints of add-on configuration are added/changed:

Summary by CodeRabbit

  • Bug Fixes
    • Improved device processing by handling UnicodeDecodeError exceptions, ensuring smoother operation and logging warning messages for better diagnostics.

Khadas VIM4 UDEV returns something that python crapps its pants about. The exception just allows it to continue.
Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @RichardPar

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

supervisor/hardware/manager.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft May 21, 2024 06:59
Added an exception print for the times things go bad.
@RichardPar RichardPar requested a review from agners May 21, 2024 09:59
supervisor/hardware/manager.py Outdated Show resolved Hide resolved
@RichardPar
Copy link
Contributor Author

@pvizeli Any help would be appreciated... IANAPD (I am not a python developer :) This was my limit without me butchering things.

I just copied the exception handler from an example a few functions above - it was written exactly the same (in the same file)

The exception is not fatal when parsing error happens on one node. print it and continue.
@RichardPar RichardPar marked this pull request as ready for review May 22, 2024 11:58
@home-assistant home-assistant bot requested a review from pvizeli May 22, 2024 11:58
device.device_node   function bails very badly!  It raises no exceptions to the top but complains and errors
supervisor/hardware/manager.py Outdated Show resolved Hide resolved
supervisor/hardware/manager.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft May 22, 2024 13:30
@agners agners added the bugfix A bug fix label May 23, 2024
@agners agners changed the title Add Exception handling to UDEV reading and parsing Add Exception handling when processing udev devices May 23, 2024
@agners agners marked this pull request as ready for review May 23, 2024 08:24
@home-assistant home-assistant bot requested a review from agners May 23, 2024 08:24
Copy link

coderabbitai bot commented May 27, 2024

Walkthrough

Walkthrough

The recent update in supervisor/hardware/manager.py introduces error handling for UnicodeDecodeError during udev property processing. This ensures that the Home Assistant Supervisor continues to function even when encountering devices with unknown or different encodings, by logging a warning and proceeding with device processing.

Changes

File Path Change Summary
supervisor/hardware/manager.py Modified _import_devices method to handle UnicodeDecodeError, log a warning, and continue device processing.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Manager
    participant UdevDevice
    participant Logger

    Manager->>UdevDevice: Process properties
    UdevDevice-->>Manager: Return property with unknown encoding
    Manager->>Logger: Log warning for UnicodeDecodeError
    Manager->>UdevDevice: Continue processing other devices

Assessment against linked issues

Objective Addressed Explanation
Handle UnicodeDecodeError during udev property processing (#5092)
Ensure Supervisor continues device processing despite encoding errors (#5092)

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits Files that changed from the base of the PR and between 4e5b75f and bf2a837.
Files selected for processing (1)
  • supervisor/hardware/manager.py (1 hunks)
Additional comments not posted (1)
supervisor/hardware/manager.py (1)

106-112: The implementation of exception handling for UnicodeDecodeError is appropriate and aligns with the PR's objectives.


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.

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

Copy link

@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: 1

supervisor/hardware/manager.py Show resolved Hide resolved
@mdegat01 mdegat01 merged commit 5f5754e into home-assistant:main May 29, 2024
20 of 21 checks passed
@mdegat01
Copy link
Contributor

Thanks @RichardPar 👍

@github-actions github-actions bot locked and limited conversation to collaborators May 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

UDEV parsing in Supervisor not checking inputs .
4 participants