From d75f1b2b3ea5efcb6de2ba6fa5a3108b9874af5d Mon Sep 17 00:00:00 2001
From: Allen Porter <allen@thebends.org>
Date: Sun, 29 Oct 2023 14:26:10 -0700
Subject: [PATCH] Fix bug in fitbit credential import for expired tokens
 (#103024)

* Fix bug in fitbit credential import on token refresh

* Use stable test ids

* Update homeassistant/components/fitbit/sensor.py

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
---
 homeassistant/components/fitbit/sensor.py   | 11 +++++++----
 tests/components/fitbit/conftest.py         |  5 +++--
 tests/components/fitbit/test_config_flow.py | 18 +++++++++++++-----
 3 files changed, 23 insertions(+), 11 deletions(-)

diff --git a/homeassistant/components/fitbit/sensor.py b/homeassistant/components/fitbit/sensor.py
index 4885c9fa16d..d0d939ce67e 100644
--- a/homeassistant/components/fitbit/sensor.py
+++ b/homeassistant/components/fitbit/sensor.py
@@ -581,7 +581,9 @@ async def async_setup_platform(
             refresh_cb=lambda x: None,
         )
         try:
-            await hass.async_add_executor_job(authd_client.client.refresh_token)
+            updated_token = await hass.async_add_executor_job(
+                authd_client.client.refresh_token
+            )
         except OAuth2Error as err:
             _LOGGER.debug("Unable to import fitbit OAuth2 credentials: %s", err)
             translation_key = "deprecated_yaml_import_issue_cannot_connect"
@@ -599,9 +601,10 @@ async def async_setup_platform(
                 data={
                     "auth_implementation": DOMAIN,
                     CONF_TOKEN: {
-                        ATTR_ACCESS_TOKEN: config_file[ATTR_ACCESS_TOKEN],
-                        ATTR_REFRESH_TOKEN: config_file[ATTR_REFRESH_TOKEN],
-                        "expires_at": config_file[ATTR_LAST_SAVED_AT],
+                        ATTR_ACCESS_TOKEN: updated_token[ATTR_ACCESS_TOKEN],
+                        ATTR_REFRESH_TOKEN: updated_token[ATTR_REFRESH_TOKEN],
+                        "expires_at": updated_token["expires_at"],
+                        "scope": " ".join(updated_token.get("scope", [])),
                     },
                     CONF_CLOCK_FORMAT: config[CONF_CLOCK_FORMAT],
                     CONF_UNIT_SYSTEM: config[CONF_UNIT_SYSTEM],
diff --git a/tests/components/fitbit/conftest.py b/tests/components/fitbit/conftest.py
index 155e5499543..682fb0edd3b 100644
--- a/tests/components/fitbit/conftest.py
+++ b/tests/components/fitbit/conftest.py
@@ -41,10 +41,11 @@ TIMESERIES_API_URL_FORMAT = (
 
 # These constants differ from values in the config entry or fitbit.conf
 SERVER_ACCESS_TOKEN = {
-    "refresh_token": "server-access-token",
-    "access_token": "server-refresh-token",
+    "refresh_token": "server-refresh-token",
+    "access_token": "server-access-token",
     "type": "Bearer",
     "expires_in": 60,
+    "scope": " ".join(OAUTH_SCOPES),
 }
 
 
diff --git a/tests/components/fitbit/test_config_flow.py b/tests/components/fitbit/test_config_flow.py
index 152439ec19a..cf2d5d17f22 100644
--- a/tests/components/fitbit/test_config_flow.py
+++ b/tests/components/fitbit/test_config_flow.py
@@ -2,6 +2,7 @@
 
 from collections.abc import Awaitable, Callable
 from http import HTTPStatus
+import time
 from typing import Any
 from unittest.mock import patch
 
@@ -16,9 +17,7 @@ from homeassistant.helpers import config_entry_oauth2_flow, issue_registry as ir
 
 from .conftest import (
     CLIENT_ID,
-    FAKE_ACCESS_TOKEN,
     FAKE_AUTH_IMPL,
-    FAKE_REFRESH_TOKEN,
     PROFILE_API_URL,
     PROFILE_USER_ID,
     SERVER_ACCESS_TOKEN,
@@ -204,6 +203,11 @@ async def test_config_entry_already_exists(
     assert result.get("reason") == "already_configured"
 
 
+@pytest.mark.parametrize(
+    "token_expiration_time",
+    [time.time() + 86400, time.time() - 86400],
+    ids=("token_active", "token_expired"),
+)
 async def test_import_fitbit_config(
     hass: HomeAssistant,
     fitbit_config_setup: None,
@@ -235,16 +239,20 @@ async def test_import_fitbit_config(
     assert config_entry.unique_id == PROFILE_USER_ID
 
     data = dict(config_entry.data)
+    # Verify imported values from fitbit.conf and configuration.yaml and
+    # that the token is updated.
     assert "token" in data
+    expires_at = data["token"]["expires_at"]
+    assert expires_at > time.time()
     del data["token"]["expires_at"]
-    # Verify imported values from fitbit.conf and configuration.yaml
     assert dict(config_entry.data) == {
         "auth_implementation": DOMAIN,
         "clock_format": "24H",
         "monitored_resources": ["activities/steps"],
         "token": {
-            "access_token": FAKE_ACCESS_TOKEN,
-            "refresh_token": FAKE_REFRESH_TOKEN,
+            "access_token": "server-access-token",
+            "refresh_token": "server-refresh-token",
+            "scope": "activity heartrate nutrition profile settings sleep weight",
         },
         "unit_system": "default",
     }