Make WS command backup/generate send events #130524
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
emontnemery
commented
Nov 13, 2024
Comment on lines
+56
to
+62
| @dataclass(slots=True) | ||
| class BackupProgress: | ||
| """Backup progress class.""" | ||
|
|
||
| done: bool | ||
| stage: str | None | ||
| success: bool | None |
There was a problem hiding this comment.
This is inspired by backup job progress fired by supervisor:
event_type: supervisor_event
data:
event: job
data:
name: backup_manager_partial_backup
reference: a945ac38
uuid: 6a6ab1807ed64ca18ab1d03fb2fd2282
progress: 0
stage: finishing_file
done: true
parent_id: null
errors: []| @@ -127,7 +132,6 @@ async def handle_backup_start( | |||
| ) -> None: | |||
| """Backup start notification.""" | |||
| manager = hass.data[DATA_MANAGER] | |||
| manager.backing_up = True | |||
There was a problem hiding this comment.
This did not seem to be needed.
Comment on lines
-136
to
-139
| with patch( | ||
| "homeassistant.components.backup.manager.BackupManager.async_create_backup", | ||
| return_value=TEST_BACKUP, | ||
| ): |
There was a problem hiding this comment.
The patching is replaced by mocking the backup file creation to better test the cooperation between the WS handler and the backup manager
| ) -> None: | ||
| """Test generating a backup.""" | ||
| await setup_backup_integration(hass, with_hassio=with_hassio) | ||
|
|
||
| client = await hass_ws_client(hass) | ||
| freezer.move_to("2024-11-13 12:01:00+01:00") |
There was a problem hiding this comment.
Time frozen to make the backup slug stable
MartinHjelmare
approved these changes
Nov 13, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Make WS command
backup/generatesend eventsRationale:
Creating a backup may need a very long time to finish. To allow frontend to show progress, we let the command immediately return the backup slug, and then fire off events as the backup job progresses
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: