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

Remove warning about using incorrect schema for entity service registration #312

Merged
merged 1 commit into from
Dec 15, 2024

Conversation

RogerSelwyn
Copy link
Contributor

@RogerSelwyn RogerSelwyn commented Oct 12, 2024

2024-10-12 12:00:30.700 WARNING (MainThread) [homeassistant.helpers.frame] Detected that custom integration 'nodered' registers an entity service with a non entity service schema which will stop working in HA Core 2025.9 at custom_components/nodered/switch.py, line 62: platform.async_register_entity_service(, please create a bug report at https://github.com/zachowj/hass-node-red/issues

Summary by CodeRabbit

  • Chores
    • Simplified the schema definition for the Node-RED switch integration without altering existing functionality.

@github-actions github-actions bot added the Stale label Dec 12, 2024
Copy link

coderabbitai bot commented Dec 12, 2024

Walkthrough

The changes in this pull request involve modifying the SERVICE_TRIGGER_SCHEMA in the custom_components/nodered/switch.py file. The schema has been transitioned from a vol.Schema object to a plain dictionary format while retaining the same required and optional fields. This adjustment does not affect the existing logic or functionality of the Node-RED switch integration, as the rest of the file remains unchanged.

Changes

File Path Change Summary
custom_components/nodered/switch.py Updated SERVICE_TRIGGER_SCHEMA from vol.Schema({...}) to a plain dictionary structure {...}.

Possibly related issues


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

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: 0

🧹 Outside diff range and nitpick comments (1)
custom_components/nodered/switch.py (1)

34-38: Consider monitoring Home Assistant schema changes.

While this change addresses the immediate warning for HA Core 2025.9, it would be beneficial to:

  1. Monitor Home Assistant's deprecation timeline for any related schema changes
  2. Consider adding a comment documenting this change and its relation to HA Core 2025.9 compatibility

Add a comment above the schema:

+# Updated schema format for HA Core 2025.9 compatibility
SERVICE_TRIGGER_SCHEMA = {
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2413954 and d81ce2c.

📒 Files selected for processing (1)
  • custom_components/nodered/switch.py (1 hunks)
🔇 Additional comments (2)
custom_components/nodered/switch.py (2)

34-38: LGTM! Schema changes align with Home Assistant Core requirements.

The transition from vol.Schema to dictionary format maintains all necessary validations while complying with future Home Assistant Core requirements. This change should resolve the warning about non-compliant schema.


34-38: Verify service registration functionality.

While the schema changes look correct, let's verify that the service registration works as expected with the new schema format.

@zachowj zachowj removed the Stale label Dec 12, 2024
@zachowj zachowj merged commit 8c93dd4 into zachowj:main Dec 15, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants