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

Make database access in the eventloop raise an exception #71547

Merged
merged 5 commits into from
May 9, 2022

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented May 8, 2022

Breaking change

  • Accessing the database does blocking I/O and needs to be done
    in the executor since it causes instability by blocking Home Assistant's
    event loop (which means Home Assistant cannot do anything until the
    database call finishes)

  • In 2022.4 we added a warning that the database executor should
    be used for database access which revealed places where the
    database was accessed in the eventloop

  • If the database is accessed in the default executor, it will continue
    to report the access, but proceed as normal.

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:

- In 2022.4 we added a warning that the database executor should
  be used for database access which revealed places where the
  database was accessed in the eventloop

- If the database is accessed in the default executor, it will continue
  to report the access, but proceed as normal.
@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 (recorder) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@AngellusMortis

This comment was marked as abuse.

@bdraco
Copy link
Member Author

bdraco commented May 9, 2022

sqlalchemy 1.4 now has asyncio support but its still maturing. We might switch to it once they release 2.0 but all the existing code would have to change since everything has to be awaited.

https://docs.sqlalchemy.org/en/14/orm/extensions/asyncio.html

@bdraco
Copy link
Member Author

bdraco commented May 9, 2022

codecov failure is not related to this PR

@bdraco bdraco merged commit 222baa5 into home-assistant:dev May 9, 2022
@bdraco bdraco deleted the db_access_blocking_event_loop branch May 9, 2022 20:22
@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