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.

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

Chunk large logbook queries and add an end_time to the api so we stop sending events #72351

Merged
merged 18 commits into from
May 23, 2022

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented May 23, 2022

Frontend PR home-assistant/frontend#12753

Proposed change

  • Marks the RowAsEvent dataclass as frozen
  • Avoids running the queue processor task if the connection gets unsubscribed before the results are delivered from the database
  • If query asks for more than 25 hours of past data, we send the most recent 24 hours first, and the older data in a second response so they aren't waiting for the history.
  • Supports an end_time in the past (useful with big queries) or future (for when to cut off streaming)

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:

- I forget to mark this as frozen
@probot-home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (logbook) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@bdraco
Copy link
Member Author

bdraco commented May 23, 2022

Need to run performance stats again to make sure this is no impact. Can't imagine there would be, but I need to do it anyways to revalidate the REST api and original websocket api has not regressed.

@bdraco bdraco changed the title Freeze logbook EventAsRow dataclass Chunk large logbook queries May 23, 2022
@bdraco bdraco changed the title Chunk large logbook queries Chunk large logbook queries and add an end_time to the api so we stop sending events May 23, 2022
@bdraco bdraco marked this pull request as ready for review May 23, 2022 18:48
@bdraco bdraco requested a review from a team as a code owner May 23, 2022 18:48
@bdraco
Copy link
Member Author

bdraco commented May 23, 2022

Test failed because the CI runner is too slow 👎

@bdraco
Copy link
Member Author

bdraco commented May 23, 2022

I ended up switching to async_fire_time_changed. It is good enough for the test. Better to be reliable than perfect.

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

3 participants