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

Log events with no listeners #98540

Merged
merged 3 commits into from Aug 16, 2023
Merged

Log events with no listeners #98540

merged 3 commits into from Aug 16, 2023

Conversation

emontnemery
Copy link
Contributor

Proposed change

PR #95163 speed up event handling by not creating Event objects if there are no listeners

However, that's not convenient for tests. This PR makes sure all events are logged.

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:

@emontnemery emontnemery requested a review from a team as a code owner August 16, 2023 17:18
@home-assistant home-assistant bot added cla-signed core small-pr PRs with less than 30 lines. labels Aug 16, 2023
emontnemery
emontnemery commented Aug 16, 2023
View reviewed changes
homeassistant/core.py
@@ -1025,18 +1025,18 @@ def async_fire(
listeners = self._listeners.get(event_type, [])
match_all_listeners = self._match_all_listeners

event = Event(event_type, event_data, origin, time_fired, context)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

A normal setup will have a working recorder which subscribes to all events. Hence, we can unconditionally create the Event object here.

@emontnemery emontnemery merged commit 31f5932 into dev Aug 16, 2023
34 checks passed
@emontnemery emontnemery deleted the improve_event_logging branch August 16, 2023 18:14
@github-actions github-actions bot locked and limited conversation to collaborators Aug 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@frenck frenck frenck approved these changes

Assignees
No one assigned
Labels
cla-signed core small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@emontnemery @frenck