Nest config flow #14921

balloob · 2018-06-11T03:27:58Z

Description:

Add a config flow to configure Nest. Backwards compatible!

Move Nest component to be folder based and split component up
When client id/secret is provided via configuration.yaml, the config flow can be used to configure your Nest account. I did not incorporate asking for client id/secret inside the config flow as that requires a developer account, I don't find that suitable for a UI config flow.
Config flow is structured in a way that creates foundation for other components to add authentication implementation. This foundation is not done yet, as I didn't want to clutter this PR. In the future, if a user is logged into the cloud component, they will be able to do a full OAuth2 flow without the user having to register their own developer account.

Basic functionality is already working.

To do:

Merge frontend PR to allow placeholders in translations Allow placeholders for config flow description frontend#1274
Add tests for Nest config flow
Use config entry forwarding instead of discovery to load other Nest platforms
Import existing access tokens

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.github.io#<home-assistant.github.io PR number goes here>

Example entry for `configuration.yaml` (if applicable):

nest:
  client_id: bla
  client_secret: bla

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New or updated dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Tests have been added to verify that the new code works.

houndci-bot · 2018-06-11T15:45:51Z

homeassistant/components/nest/config_flow.py

+        if self.hass.config_entries.async_entries(DOMAIN):
+            return self.async_abort(reason='already_setup')
+
+        tokens = await self.hass.async_add_job(load_json, info['nest_conf_path'])


line too long (81 > 79 characters)

homeassistant/components/nest/config_flow.py

+            return self.async_abort(reason='already_setup')
+
+        flow = self.hass.data[DATA_FLOW_IMPL][DOMAIN]
+        tokens = await self.hass.async_add_job(


homeassistant/components/nest/config_flow.py

+        if self.hass.config_entries.async_entries(DOMAIN):
+            return self.async_abort(reason='already_setup')
+
+        flow = self.hass.data[DATA_FLOW_IMPL][DOMAIN]


MartinHjelmare

Looks good. Two small comments.

MartinHjelmare · 2018-06-11T20:36:40Z

homeassistant/components/nest/.translations/en.json

+{
+    "config": {
+        "abort": {
+            "already_setup": "You can only configure a single Nest account",


There's no period at the end here.

MartinHjelmare · 2018-06-11T20:38:23Z

homeassistant/components/nest/strings.json

+      "internal_error": "Internal error validating code"
+    },
+    "abort": {
+      "already_setup": "You can only configure a single Nest account",


Same as above.

awarecan · 2018-06-11T21:32:41Z

homeassistant/components/nest/local_auth.py

+from . import config_flow
+from .const import DOMAIN
+
+ACCESS_TOKEN_URL = 'https://api.home.nest.com/oauth2/access_token'


Should we get those URLs from python-nest?
https://github.com/jkoelker/python-nest/blob/a45cda8c4efae0ec0725fe15d2788928cd54f21d/nest/nest.py#L22-L23

Good point. I've rewritten to use this whole file to use the authentication mechanism from python-nest. I've added a test so that if the package changes, it will blow up our test.

awarecan · 2018-06-11T21:44:42Z

without the user having to register their own developer account.

Does that mean HA Cloud will have to pass Work with Nest certification? I have little doubt about that, some guy in SmartThings community want to do similar things and rejected by Nest several times. Nest said, such "usage" should ask each user register their own developer account.

See Nest's response here

Kane610 · 2018-06-11T22:00:44Z

homeassistant/components/nest/config_flow.py

@@ -0,0 +1,154 @@
+"""Config flow to configure Philips Hue."""


Copy paste issue

Kane610 · 2018-06-11T22:01:15Z

homeassistant/components/nest/config_flow.py

+    VERSION = 1
+
+    def __init__(self):
+        """Initialize the Hue flow."""


Copy paste issue

awarecan · 2018-06-12T13:07:27Z

homeassistant/components/nest/__init__.py

+    filename = config.get(CONF_FILENAME, NEST_CONFIG_FILE)
+    access_token_cache_file = hass.config.path(filename)
+
+    if await hass.async_add_job(os.path.isfile, access_token_cache_file):


Is await unnecessary? I think async_add_job is not a coroutine

It returns a task that is awaitable for the result of the function. This is used to run non asyncio functions inside a worker thread pool and get the response.

awarecan · 2018-06-12T13:21:54Z

homeassistant/components/nest/__init__.py


    _LOGGER.debug("proceeding with setup")
-    conf = config[DOMAIN]
+    conf = hass.data.get(DATA_NEST_CONFIG, {})
    hass.data[DATA_NEST] = NestDevice(hass, conf, nest)


There may have a potential issue, inside NestDevice constructor, it will first call nest.Nest._status, which will trigger the establish of the persistence HTTP connection. This function may block event loop for few seconds, depends on network condition. It wouldn't be necessary address in this PR. I will figure out some solution, or take this chane to change python-nest better support asyncio.

Good catch! We should never do I/O inside the event loop. I've pushed the I/O pieces into a standalone initialize function.

houndci-bot · 2018-06-12T14:14:27Z

tests/components/nest/test_local_auth.py

+
+import pytest
+
+import requests


'requests' imported but unused

balloob · 2018-06-12T14:17:15Z

Does that mean HA Cloud will have to pass Work with Nest certification?

Yes. Home Assistant Cloud will try to work directly with partners to pass certification.

houndci-bot · 2018-06-12T14:24:41Z

homeassistant/components/nest/__init__.py

 from homeassistant.helpers.dispatcher import async_dispatcher_send, \
    async_dispatcher_connect
 from homeassistant.helpers.entity import Entity

 REQUIREMENTS = ['python-nest==4.0.2']
+from .const import DOMAIN
+from . import local_auth


module level import not at top of file

houndci-bot · 2018-06-12T14:24:42Z

homeassistant/components/nest/__init__.py

 from homeassistant.helpers.dispatcher import async_dispatcher_send, \
    async_dispatcher_connect
 from homeassistant.helpers.entity import Entity

 REQUIREMENTS = ['python-nest==4.0.2']
+from .const import DOMAIN


module level import not at top of file

awarecan · 2018-06-12T16:20:03Z

homeassistant/components/nest/__init__.py

+    def initialize(self):
+        """Initialize Nest."""
+        if self.local_structure is None:
+            self.local_structure = [s.name for s in self.nest.structures]


We need to trigger a Nest API call even self.local_structure is None.

structure_names = [s.name for s in self.nest.structures] if self.local_structure is None: self.local_structure = structure_names else: for structure in self.local_structure: if structure not in structure_names: # raise ValueError('cannot find structure')

Are you sure? That's not how the current logic works:

I am sure. Because in current implement, in next few lines, it will access nest.structures anyway.

I don't see that in the current code

If goes else, then next line talked to Nest API will be here, it is called by climate.nest setup code.

So, in that case, it would not block nest component setup, but will block climate.nest setup. I think better resolve that in initialize() method.

awarecan · 2018-06-12T17:01:37Z

@balloob since you are working on config flow, can you add another workflow?
Current implement if I understanding is right, likes

load_config() ---> client_id/client_secret --> if access_token_cached --> import(access_token)
                                                |--> else redirect user to input pin -> cache access_token

can you change it to

load_config() ---> if access_token_cached --> import(access_token)
                   |--> else if no client_id/secret --> ask user input client_id/secret -->
                   |--> else if has client_id/secret --> redirect user to input pin -> cache access_token

By this way, I don't need save my client_secret in conf file anymore

balloob · 2018-06-12T18:24:52Z

I will not change that work flow. As said in the PR description, client ID / secret will have to be defined in configuration.yaml. As also mentioned in the PR description, existing access tokens are already imported.

Sorry I misunderstood. You're not talking about config flow but about how to deal with configuration.yaml.

I only added the initial importing now for backwards compatibility. In the future, people don't have an access token cache anymore.

Also, making any further changes is out of scope for this PR. It's already big enough.

* Move nest to dir based component * Add config flow for Nest * Load Nest platforms via config entry * Add tests for Nest config flow * Import existing access tokens as config entries * Lint * Update coverage * Update translation * Fix tests * Address strings * Use python-nest token resolution * Lint * Do not do I/O inside constructor * Lint * Update test requirements

balloob requested a review from a team as a code owner June 11, 2018 03:27

homeassistant added the cla-signed label Jun 11, 2018

ghost assigned balloob Jun 11, 2018

ghost added the in progress label Jun 11, 2018

homeassistant added integration: nest core cla-signed labels Jun 11, 2018

houndci-bot reviewed Jun 11, 2018

View reviewed changes

balloob changed the title ~~WIP: Nest config flow~~ Nest config flow Jun 11, 2018

houndci-bot reviewed Jun 11, 2018

View reviewed changes

homeassistant added the cla-signed label Jun 11, 2018

MartinHjelmare approved these changes Jun 11, 2018

View reviewed changes

awarecan reviewed Jun 11, 2018

View reviewed changes

Kane610 reviewed Jun 11, 2018

View reviewed changes

homeassistant/components/nest/config_flow.py Outdated

@@ -0,0 +1,154 @@

"""Config flow to configure Philips Hue."""

Copy link

Member

Kane610 Jun 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy paste issue

Kane610 reviewed Jun 11, 2018

View reviewed changes

awarecan reviewed Jun 12, 2018

View reviewed changes

houndci-bot reviewed Jun 12, 2018

View reviewed changes

tests/components/nest/test_local_auth.py Outdated

import pytest

import requests

Copy link

houndci-bot Jun 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'requests' imported but unused

balloob force-pushed the nest-config-flow branch from 26c1225 to ffd704c Compare June 12, 2018 14:24

homeassistant added the cla-signed label Jun 12, 2018

houndci-bot reviewed Jun 12, 2018

View reviewed changes

awarecan reviewed Jun 12, 2018

View reviewed changes

balloob added 5 commits June 13, 2018 10:59

Move nest to dir based component

4779b97

Add config flow for Nest

7377150

Load Nest platforms via config entry

ab1ca95

Add tests for Nest config flow

2ff506c

Import existing access tokens as config entries

0cdb213

balloob added 10 commits June 13, 2018 10:59

Lint

903c01f

Update coverage

f40fdd9

Update translation

417bbf6

Fix tests

36fd373

Address strings

a20ed50

Use python-nest token resolution

4daa6fe

Lint

d83468f

Do not do I/O inside constructor

1da619f

Lint

c196cf1

Update test requirements

d40e09e

balloob force-pushed the nest-config-flow branch from 31d76fb to d40e09e Compare June 13, 2018 14:59

homeassistant added the cla-signed label Jun 13, 2018

balloob merged commit e014a84 into dev Jun 13, 2018

ghost removed the in progress label Jun 13, 2018

balloob deleted the nest-config-flow branch June 13, 2018 15:14

balloob mentioned this pull request Jun 22, 2018

0.72 #15088

Merged

home-assistant locked and limited conversation to collaborators Dec 10, 2018

		@@ -0,0 +1,154 @@
		"""Config flow to configure Philips Hue."""

Uh oh!

Nest config flow #14921

Nest config flow #14921

Uh oh!

Conversation

balloob commented Jun 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

awarecan commented Jun 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

balloob commented Jun 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

awarecan Jun 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

awarecan commented Jun 12, 2018

Uh oh!

balloob commented Jun 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

balloob commented Jun 11, 2018 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

awarecan commented Jun 11, 2018 •

edited

Loading

balloob commented Jun 12, 2018 •

edited

Loading

awarecan Jun 12, 2018 •

edited

Loading

balloob commented Jun 12, 2018 •

edited

Loading