Skip to content

Fix logbook entity_matches_only query mode#55761

Merged
balloob merged 1 commit intohome-assistant:devfrom
tathamoddie:fix-55724
Sep 6, 2021
Merged

Fix logbook entity_matches_only query mode#55761
balloob merged 1 commit intohome-assistant:devfrom
tathamoddie:fix-55724

Conversation

@tathamoddie
Copy link
Contributor

@tathamoddie tathamoddie commented Sep 5, 2021

The way that logbook data is written to the database, versus how it is read, has gotten out of sync.

The two competing optimisations are:

No test covered this scenario.

This caused a regression in 2021.8, identified in #55724, where different query paths have inconsistent results.

Specifically, the Logbook panel displays more data than the Logbook card can.

Proposed change

Fixes #55724, which was a regression in 2021.8. This bug prevented custom log entries from displaying on the Logbook Lovelace card. They would only show on the Logbook panel, creating an inconsistent experience between the two. Now they are consistent again.

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

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:

The string matching template needs to match the same compact JSON format
as the data is now written in.
@tathamoddie
Copy link
Contributor Author

Change was implemented as per the approach suggested by @bdraco in #55724 (comment), so hopefully you could review @bdraco?

@bdraco bdraco added this to the 2021.9.4 milestone Sep 6, 2021
@balloob balloob merged commit 4fa9871 into home-assistant:dev Sep 6, 2021
balloob pushed a commit that referenced this pull request Sep 6, 2021
The string matching template needs to match the same compact JSON format
as the data is now written in.
@balloob balloob mentioned this pull request Sep 6, 2021
@tathamoddie tathamoddie deleted the fix-55724 branch September 6, 2021 21:50
@github-actions github-actions bot locked and limited conversation to collaborators Sep 7, 2021
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.

logbook card show no automation trigger after update

4 participants