Fix userprofile keyerror, remove duplicate gear fetch code

custom_components/garmin_connect/__init__.py

@@ -39,57 +39,96 @@ async def async_migrate_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         "Migrating Garmin Connect config entry from version %s", entry.version)
 
     if entry.version == 1:
-        # Check if we need to migrate (old entries have username/password, new ones have token)
-        if CONF_TOKEN not in entry.data:
-            # Missing token - check if we have username/password to migrate
-            if CONF_USERNAME in entry.data and CONF_PASSWORD in entry.data:
+        # Scenario 1: Has USERNAME + PASSWORD but no TOKEN (old auth method)
+        # Migrate to: ID + TOKEN
+        if (
+            CONF_TOKEN not in entry.data
+            and CONF_USERNAME in entry.data
+            and CONF_PASSWORD in entry.data
+        ):
+            _LOGGER.info(
+                "Migrating Garmin Connect config entry from username/password to token-based authentication")
+
+            username = entry.data[CONF_USERNAME]
+            password = entry.data[CONF_PASSWORD]
+
+            # Determine if user is in China
+            in_china = hass.config.country == "CN"
+
+            # Create temporary API client to get token
+            api = Garmin(email=username, password=password, is_cn=in_china)
+
+            try:
+                # Login to get the token
+                await hass.async_add_executor_job(api.login)
+
+                # Get the OAuth tokens
+                tokens = api.garth.dumps()
+
+                # Create new data with token, keeping the ID
+                new_data = {
+                    CONF_ID: entry.data.get(CONF_ID, username),
+                    CONF_TOKEN: tokens,
+                }
+
+                # Update the config entry
+                hass.config_entries.async_update_entry(entry, data=new_data)
+
                 _LOGGER.info(
-                    "Migrating Garmin Connect config entry to token-based authentication")
-
-                username = entry.data[CONF_USERNAME]
-                password = entry.data[CONF_PASSWORD]
-
-                # Determine if user is in China
-                in_china = hass.config.country == "CN"
-
-                # Create temporary API client to get token
-                api = Garmin(email=username, password=password, is_cn=in_china)
-
-                try:
-                    # Login to get the token
-                    await hass.async_add_executor_job(api.login)
-
-                    # Get the OAuth tokens
-                    tokens = api.garth.dumps()
-
-                    # Create new data with token, keeping the ID
-                    new_data = {
-                        CONF_ID: entry.data.get(CONF_ID, username),
-                        CONF_TOKEN: tokens,
-                    }
-
-                    # Update the config entry
-                    hass.config_entries.async_update_entry(entry, data=new_data)
-
-                    _LOGGER.info(
-                        "Successfully migrated Garmin Connect config entry")
-                    return True
-
-                except Exception as err:  # pylint: disable=broad-except
-                    _LOGGER.error(
-                        "Failed to migrate Garmin Connect config entry. "
-                        "Please re-authenticate. Error: %s", err
-                    )
-                    return False
-            else:
-                # No token and no username/password - config entry is incomplete
-                _LOGGER.warning(
-                    "Garmin Connect config entry is missing required data (no token and no credentials). "
-                    "This entry cannot be migrated automatically. A reauth flow will be triggered."
-                )
-                # Return True to allow setup to proceed, which will trigger reauth via ConfigEntryAuthFailed
+                    "Successfully migrated Garmin Connect config entry")
                 return True
 
+            except Exception as err:  # pylint: disable=broad-except
+                _LOGGER.error(
+                    "Failed to migrate Garmin Connect config entry. "
+                    "Please re-add the integration. Error: %s",
+                    err,
+                )
+                return False
+
+        # Scenario 2: Has USERNAME + TOKEN but no ID (partially migrated)
+        # Migrate to: ID + TOKEN (remove USERNAME)
+        elif (
+            CONF_ID not in entry.data
+            and CONF_USERNAME in entry.data
+            and CONF_TOKEN in entry.data
+        ):
+            _LOGGER.info(
+                "Migrating Garmin Connect config entry: converting USERNAME to ID")
+
+            username = entry.data[CONF_USERNAME]
+
+            # Create new data with ID instead of USERNAME
+            new_data = {
+                CONF_ID: username,
+                CONF_TOKEN: entry.data[CONF_TOKEN],
+            }
+
+            # Update the config entry
+            hass.config_entries.async_update_entry(entry, data=new_data)
+
+            _LOGGER.info(
+                "Successfully migrated Garmin Connect config entry from USERNAME to ID")
+            return True
+
+        # Scenario 3: Missing both TOKEN and credentials (incomplete/corrupted)
+        # Add placeholder ID to allow reauth flow
+        elif CONF_TOKEN not in entry.data:
+            if CONF_ID not in entry.data:
+                _LOGGER.info(
+                    "Config entry missing CONF_ID, adding placeholder for reauth flow")
+                new_data = {
+                    **entry.data,
+                    CONF_ID: entry.entry_id,  # Use entry_id as fallback
+                }
+                hass.config_entries.async_update_entry(entry, data=new_data)
+
+            _LOGGER.info(
+                "Garmin Connect config entry is incomplete (missing token). "
+                "Reauthentication will be required to complete setup."
+            )
+            return True
+
     return True
 
 
@@ -162,14 +201,18 @@ class GarminConnectDataUpdateCoordinator(DataUpdateCoordinator):
         try:
             # Check if the token exists in the entry data
             if CONF_TOKEN not in self.entry.data:
-                _LOGGER.warning(
+                _LOGGER.info(
+                    "Token not found in config entry. Reauthentication required."
+                )
+                raise ConfigEntryAuthFailed(
                     "Token not found in config entry. This may be an old or incomplete configuration. "
                     "A reauthentication flow will be initiated. Please check your notifications."
                 )
-                raise ConfigEntryAuthFailed(
-                    "Token not found. Please reauthenticate via the notification prompt.")
 
             await self.hass.async_add_executor_job(self.api.login, self.entry.data[CONF_TOKEN])
+        except ConfigEntryAuthFailed:
+            # Re-raise ConfigEntryAuthFailed without logging as "unknown error"
+            raise
         except GarminConnectAuthenticationError as err:
             _LOGGER.error(
                 "Authentication error occurred during login: %s", err.response.text)
@@ -342,10 +385,14 @@ class GarminConnectDataUpdateCoordinator(DataUpdateCoordinator):
 
         # Gear data
         try:
-            gear = await self.hass.async_add_executor_job(
-                self.api.get_gear, summary[Gear.USERPROFILE_ID]
-            )
-            _LOGGER.debug("Gear data fetched: %s", gear)
+            # Check if userProfileId exists in summary before fetching gear data
+            if Gear.USERPROFILE_ID in summary:
+                gear = await self.hass.async_add_executor_job(
+                    self.api.get_gear, summary[Gear.USERPROFILE_ID]
+                )
+                _LOGGER.debug("Gear data fetched: %s", gear)
+            else:
+                _LOGGER.debug("No userProfileId found in summary, skipping gear data fetch")
 
             # Fitness age data
             fitnessage_data = await self.hass.async_add_executor_job(
@@ -395,36 +442,34 @@ class GarminConnectDataUpdateCoordinator(DataUpdateCoordinator):
             return {}
 
         try:
-            # Gear data like shoes, bike, etc.
-            gear = await self.hass.async_add_executor_job(
-                self.api.get_gear, summary[Gear.USERPROFILE_ID]
-            )
+            # Use gear data from the first fetch if available
             if gear:
-                _LOGGER.debug("Gear data fetched: %s", gear)
-            else:
-                _LOGGER.debug("No gear data found")
+                # Gear stats data like distance, time, etc.
+                tasks: list[Awaitable] = [
+                    self.hass.async_add_executor_job(
+                        self.api.get_gear_stats, gear_item[Gear.UUID]
+                    )
+                    for gear_item in gear
+                ]
+                gear_stats = await asyncio.gather(*tasks)
+                if gear_stats:
+                    _LOGGER.debug("Gear statistics data fetched: %s", gear_stats)
+                else:
+                    _LOGGER.debug("No gear statistics data found")
 
-            # Gear stats data like distance, time, etc.
-            tasks: list[Awaitable] = [
-                self.hass.async_add_executor_job(
-                    self.api.get_gear_stats, gear_item[Gear.UUID]
-                )
-                for gear_item in gear
-            ]
-            gear_stats = await asyncio.gather(*tasks)
-            if gear_stats:
-                _LOGGER.debug("Gear statistics data fetched: %s", gear_stats)
+                # Gear defaults data like shoe, bike, etc.
+                if Gear.USERPROFILE_ID in summary:
+                    gear_defaults = await self.hass.async_add_executor_job(
+                        self.api.get_gear_defaults, summary[Gear.USERPROFILE_ID]
+                    )
+                    if gear_defaults:
+                        _LOGGER.debug("Gear defaults data fetched: %s", gear_defaults)
+                    else:
+                        _LOGGER.debug("No gear defaults data found")
+                else:
+                    _LOGGER.debug("No userProfileId found in summary, skipping gear defaults fetch")
             else:
-                _LOGGER.debug("No gear statistics data found")
-
-            # Gear defaults data like shoe, bike, etc.
-            gear_defaults = await self.hass.async_add_executor_job(
-                self.api.get_gear_defaults, summary[Gear.USERPROFILE_ID]
-            )
-            if gear_defaults:
-                _LOGGER.debug("Gear defaults data fetched: %s", gear_defaults)
-            else:
-                _LOGGER.debug("No gear defaults data found")
+                _LOGGER.debug("No gear data available, skipping gear stats and defaults fetch")
         except GarminConnectAuthenticationError as err:
             _LOGGER.error(
                 "Authentication error occurred while fetching Gear data: %s", err.response.text)

custom_components/garmin_connect/manifest.json

@@ -8,5 +8,5 @@
   "iot_class": "cloud_polling",
   "issue_tracker": "https://github.com/cyberjunky/home-assistant-garmin_connect/issues",
   "requirements": ["garminconnect>=0.2.31"],
-  "version": "0.2.35"
+  "version": "0.2.38"
 }