Skip to content

Add MQTT debug info#33461

Merged
balloob merged 3 commits intohome-assistant:devfrom
emontnemery:mqtt_debug_info
Apr 1, 2020
Merged

Add MQTT debug info#33461
balloob merged 3 commits intohome-assistant:devfrom
emontnemery:mqtt_debug_info

Conversation

@emontnemery
Copy link
Copy Markdown
Contributor

Proposed change

Add WS command to fetch MQTT debug info for an MQTT device:

  • List of entities with:
    • Discovery topic and discovery message
    • List of subscribed topics, with the 10 most recently received messages
  • List of device triggers with:
    • Discovery topic and discovery message

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

Example entry for configuration.yaml:

# Example configuration.yaml

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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

@probot-home-assistant
Copy link
Copy Markdown

Hey there @home-assistant/core, mind taking a look at this pull request as its been labeled with a integration (mqtt) you are listed as a codeowner for? Thanks!

Comment on lines +25 to +26
if len(messages) >= STORED_MESSAGES:
messages.pop(0)
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.

Instead of this, use a deque with a maxlen

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I did initally, but a deque can't be serialized as JSON so this was the lazy way out. Will look again.

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.

We are more often adding messages than serializing to JSON.

check_func = check_func.func

wrapper_func = None
if asyncio.iscoroutinefunction(check_func):
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.

Is this necessary, are there any that are coroutines ?

Copy link
Copy Markdown
Contributor Author

@emontnemery emontnemery Mar 31, 2020

Choose a reason for hiding this comment

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

No, it's not really necessary, none of the native MQTT integrations have coroutine callbacks.
Should I just remove this case?

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.

Yeah let's remove it.

DATA_MQTT_DEBUG_INFO, {"entities": {}, "triggers": {}}
)
for entry in entries:
if entry.entity_id in mqtt_debug_info["entities"]:
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.

Make this a guard clause. if x not in y: continue

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.

Looks great !

@balloob balloob merged commit fb93b79 into home-assistant:dev Apr 1, 2020
@lock lock Bot locked and limited conversation to collaborators Apr 2, 2020
@emontnemery emontnemery deleted the mqtt_debug_info branch June 10, 2020 18:30
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.

3 participants