cc543b200d
* Configure nest pubsub subscriber automatically Update the config flow to configure the nest pubsub subscriber automatically. After completing the authentication step, the user is now asked for the google cloud console ID, which is needed to create a subscription. Home Assistant manages the lifecycle of a subscription only when it is created by the ConfigFlow. Otherwise (if specified in configuration.yaml) it treats it similarly as before. These are the considerations or failure modes taken into account: - Subscription is created with reasonable default values as previously recommended (e.g. retion only keeps 5-15 minutes of backlog messages) - Subscriptions are created with a naming scheme that makes it clear they came from home assistant, and with a random string - Subscriptions are cleaned up when the ConfigEntry is removed. If removal fails, a subscription that is orphaned will be deleted after 30 days - If the subscription gets into a bad state or deleted, the user can go through the re-auth flow to re-create it. - Users can still specifcy a CONF_SUBSCRIBER_ID in the configuration.yaml, and skip automatic subscriber creation * Remove unnecessary nest config flow diffs and merge in upstream changes * Incorporate review feedback into nest subscription config flow * Update text wording in nest config flow
110 lines
3.8 KiB
Python
110 lines
3.8 KiB
Python
"""API for Google Nest Device Access bound to Home Assistant OAuth."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import datetime
|
|
import logging
|
|
from typing import cast
|
|
|
|
from aiohttp import ClientSession
|
|
from google.oauth2.credentials import Credentials
|
|
from google_nest_sdm.auth import AbstractAuth
|
|
from google_nest_sdm.google_nest_subscriber import GoogleNestSubscriber
|
|
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import CONF_CLIENT_ID, CONF_CLIENT_SECRET
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers import aiohttp_client, config_entry_oauth2_flow
|
|
|
|
from .const import (
|
|
API_URL,
|
|
CONF_PROJECT_ID,
|
|
CONF_SUBSCRIBER_ID,
|
|
DATA_NEST_CONFIG,
|
|
DOMAIN,
|
|
OAUTH2_TOKEN,
|
|
SDM_SCOPES,
|
|
)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
class AsyncConfigEntryAuth(AbstractAuth):
|
|
"""Provide Google Nest Device Access authentication tied to an OAuth2 based config entry."""
|
|
|
|
def __init__(
|
|
self,
|
|
websession: ClientSession,
|
|
oauth_session: config_entry_oauth2_flow.OAuth2Session,
|
|
client_id: str,
|
|
client_secret: str,
|
|
) -> None:
|
|
"""Initialize Google Nest Device Access auth."""
|
|
super().__init__(websession, API_URL)
|
|
self._oauth_session = oauth_session
|
|
self._client_id = client_id
|
|
self._client_secret = client_secret
|
|
|
|
async def async_get_access_token(self) -> str:
|
|
"""Return a valid access token for SDM API."""
|
|
if not self._oauth_session.valid_token:
|
|
await self._oauth_session.async_ensure_token_valid()
|
|
return cast(str, self._oauth_session.token["access_token"])
|
|
|
|
async def async_get_creds(self) -> Credentials:
|
|
"""Return an OAuth credential for Pub/Sub Subscriber."""
|
|
# We don't have a way for Home Assistant to refresh creds on behalf
|
|
# of the google pub/sub subscriber. Instead, build a full
|
|
# Credentials object with enough information for the subscriber to
|
|
# handle this on its own. We purposely don't refresh the token here
|
|
# even when it is expired to fully hand off this responsibility and
|
|
# know it is working at startup (then if not, fail loudly).
|
|
token = self._oauth_session.token
|
|
creds = Credentials(
|
|
token=token["access_token"],
|
|
refresh_token=token["refresh_token"],
|
|
token_uri=OAUTH2_TOKEN,
|
|
client_id=self._client_id,
|
|
client_secret=self._client_secret,
|
|
scopes=SDM_SCOPES,
|
|
)
|
|
creds.expiry = datetime.datetime.fromtimestamp(token["expires_at"])
|
|
return creds
|
|
|
|
|
|
async def new_subscriber(
|
|
hass: HomeAssistant, entry: ConfigEntry
|
|
) -> GoogleNestSubscriber | None:
|
|
"""Create a GoogleNestSubscriber."""
|
|
implementation = (
|
|
await config_entry_oauth2_flow.async_get_config_entry_implementation(
|
|
hass, entry
|
|
)
|
|
)
|
|
config = hass.data[DOMAIN][DATA_NEST_CONFIG]
|
|
if not (
|
|
subscriber_id := entry.data.get(
|
|
CONF_SUBSCRIBER_ID, config.get(CONF_SUBSCRIBER_ID)
|
|
)
|
|
):
|
|
_LOGGER.error("Configuration option 'subscriber_id' required")
|
|
return None
|
|
return await new_subscriber_with_impl(hass, entry, subscriber_id, implementation)
|
|
|
|
|
|
async def new_subscriber_with_impl(
|
|
hass: HomeAssistant,
|
|
entry: ConfigEntry,
|
|
subscriber_id: str,
|
|
implementation: config_entry_oauth2_flow.AbstractOAuth2Implementation,
|
|
) -> GoogleNestSubscriber:
|
|
"""Create a GoogleNestSubscriber, used during ConfigFlow."""
|
|
config = hass.data[DOMAIN][DATA_NEST_CONFIG]
|
|
session = config_entry_oauth2_flow.OAuth2Session(hass, entry, implementation)
|
|
auth = AsyncConfigEntryAuth(
|
|
aiohttp_client.async_get_clientsession(hass),
|
|
session,
|
|
config[CONF_CLIENT_ID],
|
|
config[CONF_CLIENT_SECRET],
|
|
)
|
|
return GoogleNestSubscriber(auth, config[CONF_PROJECT_ID], subscriber_id)
|