Skip to content

Refactor logbook to reduce overhead and complexity#71509

Merged
balloob merged 6 commits intohome-assistant:devfrom
bdraco:logbook_refactor
May 9, 2022
Merged

Refactor logbook to reduce overhead and complexity#71509
balloob merged 6 commits intohome-assistant:devfrom
bdraco:logbook_refactor

Conversation

@bdraco
Copy link
Copy Markdown
Member

@bdraco bdraco commented May 8, 2022

Note: This may be easier to review with hide whitespace diff

Proposed change

Refactor logbook to reduce overhead and complexity

  • EntityAttributeCache has been replaced with EntityNameCache since we only ever needed it for the name as the other attributes were removed in previous PRs

  • The logic for augmenting context ids has been moved into ContextAugmenter

  • We now only wrap Rows with LazyEventPartialState when they are needed for external events or logbook events which significantly improves performance since most entries do not require the full object. This allows the complexity of the deferral of constructing properties to be removed since we only create the LazyEventPartialState object when we need it.

  • Add helpers to reduce duplication in tests.

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

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.
  • 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.

The integration reached or maintains the following Integration Quality Scale:

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

To help with the load of incoming pull requests:

@bdraco bdraco marked this pull request as ready for review May 8, 2022 06:46
Copy link
Copy Markdown
Member

@thecode thecode left a comment

Choose a reason for hiding this comment

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

Changes for Shelly looks good

@balloob
Copy link
Copy Markdown
Member

balloob commented May 9, 2022

Nice one!! 🐬

@balloob balloob merged commit 24d7a46 into home-assistant:dev May 9, 2022
@github-actions github-actions bot locked and limited conversation to collaborators May 10, 2022
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.

4 participants