Allow finish_flow callback to change data entry result type (#16100)

* Allow finish_flow callback to change data entry result type

* Add unit test
This commit is contained in:
Jason Hu authored and GitHub committed 2018-08-21 10:48:24 -07:00
1 parent b26506ad4a
commit 00c6f56cc8
4 files changed
+80 -29

No files matched your search

+11 -8
View File
@@ -2,7 +2,7 @@
import asyncio
import logging
from collections import OrderedDict
from typing import Any, Dict, List, Optional, Tuple, cast, Union
from typing import Any, Dict, List, Optional, Tuple, cast
import jwt
@@ -256,20 +256,23 @@ class AuthManager:
return await auth_provider.async_credential_flow(context)
async def _async_finish_login_flow(
self, context: Optional[Dict], result: Dict[str, Any]) \
-> Optional[Union[models.User, models.Credentials]]:
self, flow: data_entry_flow.FlowHandler, result: Dict[str, Any]) \
-> Dict[str, Any]:
"""Return a user as result of login flow."""
if result['type'] != data_entry_flow.RESULT_TYPE_CREATE_ENTRY:
return None
return result
auth_provider = self._providers[result['handler']]
cred = await auth_provider.async_get_or_create_credentials(
credentials = await auth_provider.async_get_or_create_credentials(
result['data'])
if context is not None and context.get('credential_only'):
return cred
if flow.context is not None and flow.context.get('credential_only'):
result['result'] = credentials
return result
return await self.async_get_or_create_user(cred)
user = await self.async_get_or_create_user(credentials)
result['result'] = user
return result
@callback
def _async_get_auth_provider(
+8 -10
View File
@@ -372,23 +372,24 @@ class ConfigEntries:
return await entry.async_unload(
self.hass, component=getattr(self.hass.components, component))
async def _async_finish_flow(self, context, result):
async def _async_finish_flow(self, flow, result):
"""Finish a config flow and add an entry."""
# If no discovery config entries in progress, remove notification.
# Remove notification if no other discovery config entries in progress
if not any(ent['context']['source'] in DISCOVERY_SOURCES for ent
in self.hass.config_entries.flow.async_progress()):
in self.hass.config_entries.flow.async_progress()
if ent['flow_id'] != flow.flow_id):
self.hass.components.persistent_notification.async_dismiss(
DISCOVERY_NOTIFICATION_ID)
if result['type'] != data_entry_flow.RESULT_TYPE_CREATE_ENTRY:
return None
return result
entry = ConfigEntry(
version=result['version'],
domain=result['handler'],
title=result['title'],
data=result['data'],
source=context['source'],
source=flow.context['source'],
)
self._entries.append(entry)
self._async_schedule_save()
@@ -402,11 +403,8 @@ class ConfigEntries:
await async_setup_component(
self.hass, entry.domain, self._hass_config)
# Return Entry if they not from a discovery request
if context['source'] not in DISCOVERY_SOURCES:
return entry
return entry
result['result'] = entry
return result
async def _async_create_flow(self, handler_key, *, context, data):
"""Create a flow for specified handler.
+10 -7
View File
@@ -64,7 +64,7 @@ class FlowManager:
return await self._async_handle_step(flow, flow.init_step, data)
async def async_configure(
self, flow_id: str, user_input: Optional[str] = None) -> Any:
self, flow_id: str, user_input: Optional[Dict] = None) -> Any:
"""Continue a configuration flow."""
flow = self._progress.get(flow_id)
@@ -86,7 +86,7 @@ class FlowManager:
raise UnknownFlow
async def _async_handle_step(self, flow: Any, step_id: str,
user_input: Optional[str]) -> Dict:
user_input: Optional[Dict]) -> Dict:
"""Handle a step of a flow."""
method = "async_step_{}".format(step_id)
@@ -106,14 +106,17 @@ class FlowManager:
flow.cur_step = (result['step_id'], result['data_schema'])
return result
# We pass a copy of the result because we're mutating our version
result = await self._async_finish_flow(flow, dict(result))
# _async_finish_flow may change result type, check it again
if result['type'] == RESULT_TYPE_FORM:
flow.cur_step = (result['step_id'], result['data_schema'])
return result
# Abort and Success results both finish the flow
self._progress.pop(flow.flow_id)
# We pass a copy of the result because we're mutating our version
entry = await self._async_finish_flow(flow.context, dict(result))
if result['type'] == RESULT_TYPE_CREATE_ENTRY:
result['result'] = entry
return result