Create bound callback_message_received method for handling mqtt callbacks #117951

jbouwh · 2024-05-22T23:08:18Z

Proposed change

The current coding style for handling call backs of MQTT messages uses multiple wrappers on inner functions.

This PR creates class bound callback methods for handling mqtt callbacks and introduces a mixin that can be used to create a new call back instead. It is expected this rework approach will gain performance and save memory.

This PR implements the new helper for the sensor and binary_sensor. Other platforms will follow:

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 Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.

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

Documentation added/updated for www.home-assistant.io

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:

I have reviewed two other open pull requests in this repository.

…acks

home-assistant · 2024-05-22T23:08:25Z

Hey there @emontnemery, @bdraco, 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.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

homeassistant/components/mqtt/mixins.py

bdraco · 2024-05-23T18:32:34Z

Let's see how useful coderabbit is...

bdraco · 2024-05-23T18:32:40Z

@coderabbitai review

coderabbitai · 2024-05-23T18:32:45Z

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2024-05-23T18:32:48Z

Warning

Rate Limit Exceeded

@bdraco has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 57 minutes and 44 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 050fc73 and 2d20bd8.

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

bdraco · 2024-05-23T18:32:49Z

Going to do performance testing now

bdraco · 2024-05-23T18:44:40Z

functional test looks good

waiting for profile to finish

bdraco · 2024-05-23T18:46:43Z

Looks like we still have more places the decorators are being constructed. Need to make sure I didn't mess up the merge

bdraco · 2024-05-23T20:25:42Z

homeassistant/components/mqtt/mixins.py

+                self._attr_extra_state_attributes = filtered_dict
+            else:
+                _LOGGER.warning("JSON result was not a dictionary")
+

 class MqttAvailability(Entity):


We should probably make this MqttAvailabilityMixin as the linters will treat it a bit differently. But thats for another PR

bdraco · 2024-05-23T20:25:59Z

homeassistant/components/mqtt/mixins.py

@@ -401,6 +402,7 @@ class MqttAttributes(Entity):
    """Mixin used for platforms that support JSON attributes."""


We should probably make this MqttAttributesMixin as the linters will treat it a bit differently. But thats for another PR

bdraco · 2024-05-23T20:27:52Z

Much much better

We can probably collapse log message as well

bdraco · 2024-05-23T20:42:58Z

All still working well

jbouwh · 2024-05-24T09:18:08Z

Thnx, all looks good!

Create bound callback_message_received method for handling mqtt callb…

7e6f662

…acks

home-assistant bot added cla-signed code-quality core has-tests integration: mqtt labels May 22, 2024

home-assistant bot assigned emontnemery and bdraco May 22, 2024

home-assistant bot added by-code-owner Quality Scale: platinum labels May 22, 2024

bdraco added 6 commits May 22, 2024 13:43

refactor a bit

82bb015

Merge branch 'dev' into mqtt-callback-handling

acddc28

fix ruff

1cfe951

reduce overhead

a58a7f4

cleanup

0d355a7

cleanup

5e4a59c

jbouwh commented May 23, 2024

View reviewed changes

homeassistant/components/mqtt/mixins.py Show resolved Hide resolved

jbouwh marked this pull request as ready for review May 23, 2024 06:20

jbouwh requested review from emontnemery and bdraco as code owners May 23, 2024 06:20

jbouwh added 2 commits May 23, 2024 14:35

Revert changes alarm_control_panel

31f3d4a

Add sensor and binary sensor

2d20bd8

code cleanup

4a64683

bdraco reviewed May 23, 2024

View reviewed changes

collapse

580beac

bdraco approved these changes May 23, 2024

View reviewed changes

bdraco mentioned this pull request May 24, 2024

Allow MQTT device based auto discovery #109030

Merged

20 tasks

jbouwh merged commit 9333965 into dev May 24, 2024
38 checks passed

jbouwh deleted the mqtt-callback-handling branch May 24, 2024 09:18

github-actions bot locked and limited conversation to collaborators May 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create bound callback_message_received method for handling mqtt callbacks #117951

Create bound callback_message_received method for handling mqtt callbacks #117951

jbouwh commented May 22, 2024 •

edited

Loading

home-assistant bot commented May 22, 2024

bdraco commented May 23, 2024

bdraco commented May 23, 2024

coderabbitai bot commented May 23, 2024

coderabbitai bot commented May 23, 2024

Rate Limit Exceeded

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

bdraco commented May 23, 2024

bdraco commented May 23, 2024

bdraco commented May 23, 2024

bdraco May 23, 2024

jbouwh May 24, 2024

bdraco May 23, 2024

jbouwh May 24, 2024

bdraco commented May 23, 2024

bdraco commented May 23, 2024

jbouwh commented May 24, 2024

		@@ -401,6 +402,7 @@ class MqttAttributes(Entity):
		"""Mixin used for platforms that support JSON attributes."""

Create bound callback_message_received method for handling mqtt callbacks #117951

Create bound callback_message_received method for handling mqtt callbacks #117951

Conversation

jbouwh commented May 22, 2024 • edited Loading

Proposed change

Type of change

Additional information

Checklist

home-assistant bot commented May 22, 2024

bdraco commented May 23, 2024

bdraco commented May 23, 2024

coderabbitai bot commented May 23, 2024

coderabbitai bot commented May 23, 2024

Rate Limit Exceeded

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

bdraco commented May 23, 2024

bdraco commented May 23, 2024

bdraco commented May 23, 2024

bdraco May 23, 2024

Choose a reason for hiding this comment

jbouwh May 24, 2024

Choose a reason for hiding this comment

bdraco May 23, 2024

Choose a reason for hiding this comment

jbouwh May 24, 2024

Choose a reason for hiding this comment

bdraco commented May 23, 2024

bdraco commented May 23, 2024

jbouwh commented May 24, 2024

jbouwh commented May 22, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)