Skip to content

Fixed mqtt subscription filter on sys $ topics#8166

Merged
balloob merged 6 commits into
home-assistant:devfrom
natemason:fix-mqtt-sys-topic
Jun 27, 2017
Merged

Fixed mqtt subscription filter on sys $ topics#8166
balloob merged 6 commits into
home-assistant:devfrom
natemason:fix-mqtt-sys-topic

Conversation

@natemason
Copy link
Copy Markdown
Contributor

@natemason natemason commented Jun 23, 2017

Description:

MQTT subscriptions to a topic starting with $ (typically system/management topics) aren't handled as the $ isn't escaped and regex interprets it as end of line. This PR fixes support those topics.

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#8166

Checklist:

  • Local tests with tox run successfully.

@homeassistant
Copy link
Copy Markdown
Contributor

Hello @natemason,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

  1. If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.

  2. If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.

    • If you only made a single commit you should be able to run
      git commit --amend --author="Author Name <email@address.com>"
      
      (substituting Author Name and email@address.com for your actual information) to set the authorship information.
    • If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
      1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
      2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
    • Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

@mention-bot
Copy link
Copy Markdown

@natemason, thanks for your PR! By analyzing the history of the files in this pull request, we identified @balloob, @pvizeli and @fabaff to be potential reviewers.

subscription = subscription[:-2]
suffix = "(.*)"
if subscription.startswith('$'):
subscription = "\\" + subscription
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

trailing whitespace

@homeassistant
Copy link
Copy Markdown
Contributor

Hi @natemason,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@pvizeli
Copy link
Copy Markdown
Member

pvizeli commented Jun 23, 2017

Please add a unittest for it

Copy link
Copy Markdown
Member

@balloob balloob left a comment

Choose a reason for hiding this comment

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

This will also require a test to be written.

if subscription.endswith('#'):
subscription = subscription[:-2]
suffix = "(.*)"
if subscription.startswith('$'):
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think that this is the correct solution. Instead, we should call re.escape() on each part of the topic that's not +.

Comment thread tests/components/mqtt/test_init.py Outdated
"""Test the subscription of $ root and wildcard subtree topics."""
mqtt.subscribe(self.hass, '$test-topic/subtree/#', self.record_calls)

fire_mqtt_message(self.hass, '$test-topic/subtree/some-topic', 'test-payload')
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

line too long (86 > 79 characters)

Comment thread tests/components/mqtt/test_init.py Outdated
"""Test the subscription of $ root and wildcard subtree topics."""
mqtt.subscribe(self.hass, '$test-topic/subtree/#', self.record_calls)

fire_mqtt_message(self.hass, '$test-topic/subtree/some-topic', 'test-payload')
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

line too long (86 > 79 characters)

@balloob
Copy link
Copy Markdown
Member

balloob commented Jun 27, 2017

Oh no, it looks like the same fix was already merged 9 days ago in #8057.

I however still think that your tests are valuable !

@balloob balloob merged commit 23400c4 into home-assistant:dev Jun 27, 2017
@natemason
Copy link
Copy Markdown
Contributor Author

Okay thanks Paulus. Just glad to contribute (even if it was already fixed :) )

@balloob balloob mentioned this pull request Jul 1, 2017
dethpickle pushed a commit to dethpickle/home-assistant that referenced this pull request Aug 18, 2017
* Fixed mqtt subscription filter on sys $ topics

* fixed linting issue

* added unit tests for $ topics and changed fix to use re.escape

* merge upstream/dev mqtt unit tests

* Update test_init.py
@home-assistant home-assistant locked and limited conversation to collaborators Oct 20, 2017
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.

7 participants