MVP implementation of Backup sync agents #126122

ludeeus · 2024-09-17T13:37:03Z

Proposed change

Based on the proposal above, this PR implements the MVP of backup sync agents.
As of now, this will only be invoked by the core backup integration.
Changes to allow these to be triggered in a supervisor environment will come in a different PR.

So this adds:

Allow integrations to define a async_get_backup_sync_agents function in the backup platform (as shown with the kitchen_sink integration)
Add 3 new WS handlers to the backup integration
Trigger backup sync if a backup is generated for the core backup integration by service call or WS.

Note that this PR does not yet add any tests, nor is related developer and user docs updated, this is on purpose as I expect the contents of this PR will change.

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:

Documentation added/updated for www.home-assistant.io

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:

I have reviewed two other open pull requests in this repository.

home-assistant · 2024-09-17T13:37:10Z

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.

home-assistant · 2024-09-17T13:37:11Z

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

Code owner commands

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

homeassistant/components/backup/__init__.py

homeassistant/components/demo/backup.py

epenet

You only need to include what you want to expose in __all__

homeassistant/components/backup/__init__.py

MartinHjelmare

Looks good! Tests are missing. Some small comments and questions.

homeassistant/components/backup/base.py

homeassistant/components/backup/websocket.py

homeassistant/components/backup/sync_agent.py

homeassistant/components/backup/__init__.py

home-assistant · 2024-10-01T10:00:55Z

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.

homeassistant/components/backup/websocket.py

homeassistant/components/backup/models.py

homeassistant/components/backup/sync_agent.py

homeassistant/components/backup/websocket.py

tests/components/backup/test_manager.py

tests/components/backup/test_websocket.py

MartinHjelmare · 2024-10-08T20:07:07Z

One test is failing.

MartinHjelmare · 2024-10-08T20:18:32Z

tests/components/backup/test_websocket.py

@@ -313,8 +314,11 @@ async def test_agents_download(
        }
    )
    with patch.object(BackupSyncAgentTest, "async_download_backup") as download_mock:
-        assert await client.receive_json()
-        assert snapshot == download_mock.call_args
+        assert snapshot == await client.receive_json()


Please put the expected value, in this case the snapshot, on the right side of the assertion.

MartinHjelmare · 2024-10-08T20:24:05Z

When adding new websocket commands we normally wait with merging the core PR until there's an approved frontend PR. If the API is already settled with the frontend that may not be needed.

MartinHjelmare · 2024-10-21T13:53:29Z

Mypy is failing.

ludeeus added 8 commits September 11, 2024 10:47

init sync agent

bb1499e

Merge branch 'dev' of github.com:home-assistant/core into backup_sync

3c318ae

add syncing

949742a

root import

85ee277

rename list to info and add sync state

12df3f8

Add base backup class

7ff2966

Revert unneded change

4b1b6a1

adjust tests

f056c64

ludeeus requested a review from a team as a code owner September 17, 2024 13:37

home-assistant bot added cla-signed core has-tests integration: backup integration: demo labels Sep 17, 2024

home-assistant bot added the Quality Scale: internal label Sep 17, 2024

epenet reviewed Sep 17, 2024

View reviewed changes

homeassistant/components/backup/__init__.py Outdated Show resolved Hide resolved

balloob reviewed Sep 17, 2024

View reviewed changes

homeassistant/components/demo/backup.py Outdated Show resolved Hide resolved

ludeeus added 2 commits September 18, 2024 07:16

move to kitchen_sink

b1cc8a3

split

6e7d60b

epenet reviewed Sep 19, 2024

View reviewed changes

homeassistant/components/backup/__init__.py Outdated Show resolved Hide resolved

homeassistant/components/backup/__init__.py Outdated Show resolved Hide resolved

move

c60835a

ludeeus added the new-feature label Sep 19, 2024

MartinHjelmare requested changes Oct 1, 2024

View reviewed changes

home-assistant bot marked this pull request as draft October 1, 2024 10:00

MartinHjelmare added the docs-missing label Oct 1, 2024

ludeeus added 2 commits October 7, 2024 06:42

Adjustments

327ca6e

Merge branch 'dev' into backup_sync

7268f78

epenet reviewed Oct 7, 2024

View reviewed changes

homeassistant/components/backup/websocket.py Outdated Show resolved Hide resolved

homeassistant/components/backup/websocket.py Outdated Show resolved Hide resolved

homeassistant/components/backup/websocket.py Outdated Show resolved Hide resolved

Adjustment

1e4053f

MartinHjelmare reviewed Oct 8, 2024

View reviewed changes

homeassistant/components/backup/models.py Outdated Show resolved Hide resolved

homeassistant/components/backup/sync_agent.py Outdated Show resolved Hide resolved

homeassistant/components/backup/websocket.py Outdated Show resolved Hide resolved

ludeeus added 4 commits October 8, 2024 15:42

update

87103f0

Tests

6e815a0

Test unknown agent

5398231

Merge branch 'dev' into backup_sync

0b34ee9

ludeeus marked this pull request as ready for review October 8, 2024 16:56

home-assistant bot requested a review from MartinHjelmare October 8, 2024 16:56

MartinHjelmare reviewed Oct 8, 2024

View reviewed changes

tests/components/backup/test_manager.py Outdated Show resolved Hide resolved

tests/components/backup/test_websocket.py Outdated Show resolved Hide resolved

adjust

31d9f98

Adjust for different test environments

6966539

MartinHjelmare reviewed Oct 8, 2024

View reviewed changes

MartinHjelmare approved these changes Oct 8, 2024

View reviewed changes

MartinHjelmare removed the integration: demo label Oct 8, 2024

Change /info WS to contain a dictinary

00ff067

MartinHjelmare approved these changes Oct 10, 2024

View reviewed changes

MartinHjelmare added the awaiting-frontend label Oct 10, 2024

ludeeus added 2 commits October 11, 2024 06:04

reorder

09f4e75

Merge branch 'dev' of github.com:home-assistant/core into backup_sync

00b6e56

MartinHjelmare approved these changes Oct 15, 2024

View reviewed changes

ludeeus added 3 commits October 15, 2024 13:48

Add websocket command to trigger sync from the supervisor

426736d

Merge branch 'dev' of github.com:home-assistant/core into backup_sync

dcda149

cleanup

f5f5c41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MVP implementation of Backup sync agents #126122

MVP implementation of Backup sync agents #126122

ludeeus commented Sep 17, 2024 •

edited by MartinHjelmare

Loading

home-assistant bot commented Sep 17, 2024

home-assistant bot commented Sep 17, 2024

epenet left a comment

MartinHjelmare left a comment

home-assistant bot commented Oct 1, 2024

MartinHjelmare commented Oct 8, 2024

MartinHjelmare Oct 8, 2024

MartinHjelmare commented Oct 8, 2024

MartinHjelmare commented Oct 21, 2024

MVP implementation of Backup sync agents #126122

Are you sure you want to change the base?

MVP implementation of Backup sync agents #126122

Conversation

ludeeus commented Sep 17, 2024 • edited by MartinHjelmare Loading

Proposed change

Type of change

Additional information

Checklist

home-assistant bot commented Sep 17, 2024

home-assistant bot commented Sep 17, 2024

epenet left a comment

Choose a reason for hiding this comment

MartinHjelmare left a comment

Choose a reason for hiding this comment

home-assistant bot commented Oct 1, 2024

MartinHjelmare commented Oct 8, 2024

MartinHjelmare Oct 8, 2024

Choose a reason for hiding this comment

MartinHjelmare commented Oct 8, 2024

MartinHjelmare commented Oct 21, 2024

ludeeus commented Sep 17, 2024 •

edited by MartinHjelmare

Loading