8000 Fix webostv notify service by thecode · Pull Request #66760 · home-assistant/core · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix webostv notify service 8000 #66760

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

Merged
merged 2 commits into from
Feb 17, 2022
Merged

Conversation

thecode
Copy link
Member
@thecode thecode commented Feb 17, 2022

Proposed change

Fix webostv notify service to allow using extra keys. This was allowed before migration to config flow and there is no reason to fail the service on a missing icon if icon is not used in the service call and another extra key is used.

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

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:

@probot-home-assistant
Copy link

Hey there @bendavid, mind taking a look at this pull request as it has been labeled with an integration (webostv) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@ludeeus ludeeus merged commit e79348f into home-assistant:dev Feb 17, 2022
@thecode thecode deleted the webostv-fix-notify-icon branch February 17, 2022 19:13
@@ -46,8 +46,8 @@ async def async_send_message(self, message: str = "", **kwargs: Any) -> None:
if not self._client.is_connected():
await self._client.connect()

data = kwargs.get(ATTR_DATA)
icon_path = data.get(CONF_ICON, "") if data else None
data = kwargs.get(ATTR_DATA, {})
Copy link
Member

Choose a reason for hiding this comment

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

data may be None even when the key is present. It's a bad pattern in the notify integration:

kwargs[ATTR_DATA] = service.data.get(ATTR_DATA)

Copy link
Member

Choose a reason for hiding this comment

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

I don't understand what this solves looking at the change and the PR description.

Copy link
Member Author

Choose a reason for hiding this comment

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

It was explained (not clearly) in this #66727 (comment), If you call the service with extra keys before this change we fail with an error than an icon was not found, for example:

service: notify.living_room_lg_tv
data:
  message: Test
  url: "something"

Will fail and show an error than an icon was not found although the key icon is not in the configuration. This happen because I changed the data.get(CONF_ICON) to default to an empty string when I introduced the config flow support. What it does is that when we have a data key without a icon subkey we pass an empty string to the control library. The control library will return an error for this case. However if we pass None the control library does not try to load an icon.

Copy link
Member Author

Choose a reason for hiding this comment

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

data may be None even when the key is present. It's a bad pattern in the notify integration:

kwargs[ATTR_DATA] = service.data.get(ATTR_DATA)

In this case it would be better to revert back to icon_path = data.get(CONF_ICON) if data else None so that we don't fail both on empty dict and None

Copy link
Member

Choose a reason for hiding this comment

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

Ok, good. We'll need to correct this fix though to handle the data key having a None value, which is the default.

thecode added a commit to thecode/core that referenced this pull request Feb 17, 2022
balloob pushed a commit that referenced this pull request Feb 18, 2022
@balloob balloob mentioned this pull request Feb 18, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Feb 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

WebOS notification not sent if data.data contains anything.
5 participants
0