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

Notify on corrupt SQLite database #131367

Draft
wants to merge 5 commits into
base: dev
Choose a base branch
from
Draft

Notify on corrupt SQLite database #131367

wants to merge 5 commits into from
+62 −4

Conversation

rlaunch
Copy link

@rlaunch rlaunch commented Nov 23, 2024 •
edited
Loading

Proposed change

Currently, when Home Assistant detects that the recorder SQLite database is corrupt, the database is recreated and the error is logged to the application logs. Often users may not notice this error message, as the database corruption is handled without user interaction.

This PR provides additional visibility for users by creating a persistent notification in the Home Assistant UI. As well as this we fire an event to allow for further automation.

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

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 Ruff (ruff format 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.

To help with the load of incoming pull requests:

@rlaunch rlaunch requested a review from a team as a code owner November 23, 2024 14:45
@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!

Code owner commands

Code owners of recorder can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign recorder Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

This was referenced Nov 23, 2024
Closed
Draft
@cgarwood
Copy link
Member

I feel like Repairs is the correct location with this (as you had in your initial commits) -- curious why you switched to a persistent_notification instead.

@rlaunch
Copy link
Author

rlaunch commented Nov 23, 2024

Hi @cgarwood,

I previously created PR #129733 that used the repairs feature as a method for communicating the DB corruption, however as the corruption is not fixable by the user directly, it was deemed that it was not suitable to be a repair as they must be fixable.

Best,
Ryan

@rlaunch rlaunch mentioned this pull request Nov 23, 2024
Open
frenck
frenck requested changes Nov 23, 2024
View reviewed changes
homeassistant/components/recorder/core.py
Create a persistent notification and fire a 'recorder_database_corrupt' event to inform
users that their recorder database has been rebuilt due to database corruption.
"""
persistent_notification.create(
Copy link
Member

Choose a reason for hiding this comment

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

We consider persistent notifications to be user space nowadays, we should not be using that to send users system messages.

Copy link
Author

Choose a reason for hiding this comment

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

Hey @frenck ,

Is there another mechanism we can use to display these sort of errors in the UI?

I can see value in there being some sort of proactive alert/notification as the database corruption is effectively handled silently, so users would not know to check the logs for the error.

Best,
Ryan

@home-assistant home-assistant bot marked this pull request as draft November 23, 2024 16:04
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frenck frenck frenck requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
cla-signed core has-tests integration: recorder new-feature Quality Scale: internal
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

No repair/user notification when database corruption detected
3 participants
@rlaunch @cgarwood @frenck