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

Add backup config storage #130871

Merged
merged 4 commits into from
Nov 18, 2024

Conversation

MartinHjelmare
Copy link
Member

@MartinHjelmare MartinHjelmare commented Nov 18, 2024

Breaking change

Proposed change

  • Add backup config storage with websocket interface.
  • This store should save the automatic backup settings and data.
    • datetime of last automatic backup done (included)
    • an integer for max copies to keep (included)
    • a cron schedule string (todo)
    • a timedelta for max copies to keep (todo)
    • included data directories that should be backed up (todo)
  • The logic to handle an updated config, ie what the manager should do when the config changes, will be added separately later.

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

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

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

There is a merge conflict.

@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 (backup) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of backup 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 backup 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.

@MartinHjelmare MartinHjelmare force-pushed the cloud-backup-add-config-storage branch from 4f891a5 to 0abb521 Compare November 18, 2024 13:51
if param_value is not UNDEFINED:
setattr(self.data, param_name, param_value)

await self.save()
Copy link
Member Author

Choose a reason for hiding this comment

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

After updating the config this method should take needed actions based on the new config settings. Eg reschedule the next backup.

@MartinHjelmare MartinHjelmare marked this pull request as ready for review November 18, 2024 14:37
@MartinHjelmare MartinHjelmare requested a review from a team as a code owner November 18, 2024 14:37
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @MartinHjelmare 👍

class BackupConfigData:
"""Represent loaded backup config data."""

last_automatic_backup: datetime | None = None
Copy link
Member Author

@MartinHjelmare MartinHjelmare Nov 18, 2024

Choose a reason for hiding this comment

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

This isn't really config, but we need to store this if we want to give consumers the last automatic backup time, regardless of the metadata of any backup files, and also if we want to be able to guard against too frequent backups eg due to DST time changes.

It'll probably also be needed to seed the backup schedule, although that implementation isn't done yet.

@MartinHjelmare MartinHjelmare force-pushed the cloud-backup-add-config-storage branch from 0abb521 to e8d3fd0 Compare November 18, 2024 16:30
@MartinHjelmare MartinHjelmare force-pushed the cloud-backup-add-config-storage branch from e8d3fd0 to 2f5075a Compare November 18, 2024 19:26
@MartinHjelmare MartinHjelmare merged commit 22eb0a5 into allthebackupchanges Nov 18, 2024
60 checks passed
@MartinHjelmare MartinHjelmare deleted the cloud-backup-add-config-storage branch November 18, 2024 20:09
@github-actions github-actions bot locked and limited conversation to collaborators Nov 19, 2024
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.

2 participants