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.

Sign up for GitHub

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

Jump to bottom

Avoid redundant calls to async_write_ha_state in MQTT light #100690

Merged
merged 2 commits into from
Sep 22, 2023
Merged

Avoid redundant calls to async_write_ha_state in MQTT light #100690

merged 2 commits into from
Sep 22, 2023

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Sep 21, 2023 •
edited
Loading

Proposed change

Follow up on #100438, Avoid redundant calls to async_write_ha_state in MQTT light for all schema's.

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)
  • Deprecation (breaking change to happen in the future)
  • 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
  • I have followed the perfect PR recommendations
  • 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.

To help with the load of incoming pull requests:

@jbouwh jbouwh requested a review from emontnemery as a code owner September 21, 2023 16:53
@home-assistant
Copy link

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

Code owner commands

Code owners of mqtt can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign mqtt Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@jbouwh jbouwh changed the title Limit state writes for mqtt light Avoid redundant calls to async_write_ha_state in MQTT light Sep 21, 2023
@jbouwh jbouwh changed the title Avoid redundant calls to async_write_ha_state in MQTT light Avoid redundant calls to async_write_ha_state in MQTT light Sep 21, 2023
emontnemery
emontnemery previously requested changes Sep 21, 2023
View reviewed changes
homeassistant/components/mqtt/light/schema_basic.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/light/schema_json.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/light/schema_template.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft September 21, 2023 18:38
@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.

jbouwh
jbouwh commented Sep 21, 2023
View reviewed changes
homeassistant/components/mqtt/light/schema_basic.py

add_topic(CONF_RGB_STATE_TOPIC, rgb_received)

@callback
@log_messages(self.hass, self.entity_id)
@write_state_on_attr_change(
self, {"_attr_brightness", "_attr_color_mode", "_attr_rgbw_color"}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Besides _attr_rgbw_color also _attr_brightness or _attr_color_mode might have changes change. Tests added.

homeassistant/components/mqtt/light/schema_basic.py

add_topic(CONF_RGBW_STATE_TOPIC, rgbw_received)

@callback
@log_messages(self.hass, self.entity_id)
@write_state_on_attr_change(
self, {"_attr_brightness", "_attr_color_mode", "_attr_rgbww_color"}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Besides _attr_rgbww_color also _attr_brightness or _attr_color_mode might have changes change. Tests added.

homeassistant/components/mqtt/light/schema_basic.py
@@ -500,6 +499,9 @@ def _rgbx_received(

@callback
@log_messages(self.hass, self.entity_id)
@write_state_on_attr_change(
self, {"_attr_brightness", "_attr_color_mode", "_attr_rgb_color"}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Besides _attr_rgb_color also _attr_brightness or _attr_color_mode might have changes change. Tests added.

tests/components/mqtt/test_light.py
Comment on lines +3510 to +3512
("rgb-state-topic", "128,128,128", "128,128,64"),
("rgbw-state-topic", "128,128,128,255", "128,128,128,128"),
("rgbww-state-topic", "128,128,128,32,255", "128,128,128,64,255"),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added cases

@jbouwh jbouwh force-pushed the mqtt-state-writes-light branch from 7a74b55 to ade314c Compare September 22, 2023 08:58
@jbouwh jbouwh marked this pull request as ready for review September 22, 2023 09:02
@jbouwh
Copy link
Contributor Author

jbouwh commented Sep 22, 2023

Opended #100707 to fix a bug and additional tests on processing rgbx values without a state topic for brightness.

@jbouwh jbouwh force-pushed the mqtt-state-writes-light branch from ade314c to e58d164 Compare September 22, 2023 10:13
emontnemery
emontnemery approved these changes Sep 22, 2023
View reviewed changes
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @jbouwh 👍

@jbouwh jbouwh merged commit 5b422da into dev Sep 22, 2023
@jbouwh jbouwh deleted the mqtt-state-writes-light branch September 22, 2023 11:32
@github-actions github-actions bot locked and limited conversation to collaborators Sep 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@emontnemery emontnemery emontnemery approved these changes

Assignees

@emontnemery emontnemery

Labels
by-code-owner cla-signed code-quality core has-tests integration: mqtt Quality Scale: gold
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jbouwh @emontnemery