Skip to content

Raise if referenced entity does not support service#68394

Merged
balloob merged 4 commits intodevfrom
call-service-feature-raise
Mar 20, 2022
Merged

Raise if referenced entity does not support service#68394
balloob merged 4 commits intodevfrom
call-service-feature-raise

Conversation

@balloob
Copy link
Copy Markdown
Member

@balloob balloob commented Mar 19, 2022

Breaking change

If an entity is explicitly referenced as a target for a service that the entity doesn't support, we now raise an error instead of silently ignoring it.

Proposed change

If an entity is explicitly referenced for a service but the entity does not contain the supported_feature, raise an error instead of silently ignoring it.

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 March 19, 2022 21:17
@probot-home-assistant probot-home-assistant bot added core small-pr PRs with less than 30 lines. labels Mar 19, 2022
@balloob balloob mentioned this pull request Mar 19, 2022
25 tasks
@balloob
Copy link
Copy Markdown
Member Author

balloob commented Mar 20, 2022

Was able to fix all tests except for 1:

Template Alarm Control Panel will only add supported_features for features it has a script defined for. However it does allow calling unsupported methods: the entity will update it's state but also log an error (source / test).

I think that we should fix this behavior in template alarm control panel. Two options:

  1. Always add the supported feature flags and do not log an error
  2. Remove the test

I went for 2 because the supported feature was not there, causing it to already be skipped.

Copy link
Copy Markdown
Contributor

@elupus elupus left a comment

Choose a reason for hiding this comment

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

I very much like this change. I don't like the silent errors. Maybe a specialized exception should be used for the not supported case?

Copy link
Copy Markdown
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

LGTM ✅

Copy link
Copy Markdown
Member

@thecode thecode left a comment

Choose a reason for hiding this comment

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

Looks good for webostv

Copy link
Copy Markdown
Contributor

@chemelli74 chemelli74 left a comment

Choose a reason for hiding this comment

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

Looks fine for SamsungTV

@balloob balloob merged commit 8bbbd19 into dev Mar 20, 2022
@balloob balloob deleted the call-service-feature-raise branch March 20, 2022 23:01
@github-actions github-actions bot locked and limited conversation to collaborators Mar 22, 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.

7 participants