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

Validate in split_entity_id #66835

Merged
merged 3 commits into from
Feb 19, 2022
Merged

Validate in split_entity_id #66835

merged 3 commits into from
Feb 19, 2022

Conversation

balloob
Copy link
Member

@balloob balloob commented Feb 18, 2022

Breaking change

Custom component authors: split_entity_id will now raise a ValueError if the passed value does not follow the basic entity ID format (<domain>.<object id>). Previously it could return a list with a single item.

Proposed change

Validate it's a valid entity ID and not return data that violates the type signature.

I noticed that our validator would crash if the entity ID was invalid when I stumbled upon this commit: zachowj/node-red-contrib-home-assistant-websocket@d085ef4#diff-ada8264180728098ca920091eca5641fd9a97221543fa087a9cec21b488c3de3R258-R267

Type of change

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

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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 Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@balloob balloob requested a review from a team as a code owner February 18, 2022 21:04
@probot-home-assistant probot-home-assistant bot added core small-pr PRs with less than 30 lines. labels Feb 18, 2022
@@ -71,7 +71,7 @@
EMPTY_JSON_OBJECT = "{}"
UNIT_OF_MEASUREMENT_JSON = '"unit_of_measurement":'

HA_DOMAIN_ENTITY_ID = f"{HA_DOMAIN}."
HA_DOMAIN_ENTITY_ID = f"{HA_DOMAIN}._"
Copy link
Member Author

Choose a reason for hiding this comment

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

@bdraco I think you added validating domains like this. Is this ok to change so split_entity_id doesn't raise?

Copy link
Member

Choose a reason for hiding this comment

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

That should be fine. All it cares about is that is the left side.

@balloob balloob merged commit 1bbc1f5 into dev Feb 19, 2022
@balloob balloob deleted the validate-split-entity-id branch February 19, 2022 00:11
@github-actions github-actions bot locked and limited conversation to collaborators Feb 20, 2022
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.

4 participants