Skip to content

Clean up stream resources in Teslemetry config entry unloading #970

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

Closed
Bre77 wants to merge 1 commit into from
Closed

Clean up stream resources in Teslemetry config entry unloading #970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion homeassistant/components/teslemetry/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,16 @@ async def async_setup_entry(hass: HomeAssistant, entry: TeslemetryConfigEntry) -

async def async_unload_entry(hass: HomeAssistant, entry: TeslemetryConfigEntry) -> bool:
"""Unload Teslemetry Config."""
return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
# Remove stream listeners for each vehicle
for vehicle in entry.runtime_data.vehicles:
vehicle.remove_listener()

# Close the stream connection
if entry.runtime_data.stream:
entry.runtime_data.stream.close()

return unload_ok


async def async_migrate_entry(
Expand Down
8 changes: 1 addition & 7 deletions homeassistant/components/teslemetry/quality_scale.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,7 @@ rules:
unique-config-entry: done
# Silver
action-exceptions: done
config-entry-unloading:
status: todo
comment: |
async_unload_entry must clean up: (1) close TeslemetryStream websocket via
stream.close(), (2) call remove_listener() for each vehicle to unsubscribe
from stream events, (3) consider using entry.async_on_unload() during setup
to register cleanup callbacks automatically.
config-entry-unloading: done
docs-configuration-parameters: done
docs-installation-parameters: done
entity-unavailable: done
Expand Down
Loading