Better error handling and reconfiguration setup options.

Author: stridera

custom_components/plex_recently_added/config_flow.py

@@ -10,7 +10,7 @@
     ConstantSelector,
     ConstantSelectorConfig
 )
-from homeassistant.config_entries import ConfigEntry
+from homeassistant.config_entries import ConfigEntry, ConfigFlowResult
 from homeassistant.core import callback
 from homeassistant.config_entries import ConfigFlow
 from homeassistant.const import (
@@ -89,4 +89,38 @@ async def async_step_user(
                 return self.async_create_entry(title=user_input[CONF_NAME] if len(user_input[CONF_NAME]) > 0 else DEFAULT_NAME, data=user_input)
 
         schema = self.add_suggested_values_to_schema(PLEX_SCHEMA, user_input)
-        return self.async_show_form(step_id="user", data_schema=schema, errors=errors)
+        return self.async_show_form(step_id="user", data_schema=schema, errors=errors)
+
+    async def async_step_reconfigure(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle reconfiguration of the integration."""
+        errors = {}
+        entry = self.hass.config_entries.async_get_entry(self.context["entry_id"])
+
+        if user_input is not None:
+            try:
+                await setup_client(
+                    self.hass,
+                    user_input[CONF_NAME],
+                    user_input[CONF_SSL],
+                    user_input[CONF_API_KEY],
+                    user_input[CONF_MAX],
+                    user_input[CONF_ON_DECK],
+                    user_input[CONF_HOST],
+                    user_input[CONF_PORT],
+                    user_input.get(CONF_SECTION_TYPES, []),
+                    user_input.get(CONF_SECTION_LIBRARIES, []),
+                    user_input.get(CONF_EXCLUDE_KEYWORDS, []),
+                )
+            except FailedToLogin as err:
+                errors = {'base': 'failed_to_login'}
+            else:
+                return self.async_update_reload_and_abort(
+                    entry,
+                    data={**entry.data, **user_input},
+                    reason="reconfigure_successful"
+                )
+
+        schema = self.add_suggested_values_to_schema(PLEX_SCHEMA, entry.data)
+        return self.async_show_form(step_id="reconfigure", data_schema=schema, errors=errors)

custom_components/plex_recently_added/options_flow.py

@@ -32,6 +32,10 @@ def __init__(self, config_entry: ConfigEntry) -> None:
     async def async_step_init(self, user_input: dict[str, Any] | None = None) -> ConfigFlowResult:
         errors = {}
 
+        # Check if the integration is loaded and coordinator is available
+        if DOMAIN not in self.hass.data or self._config_entry.entry_id not in self.hass.data[DOMAIN]:
+            return self.async_abort(reason="integration_not_loaded")
+
         coordinator = self.hass.data[DOMAIN][self._config_entry.entry_id]
 
         if user_input is not None:

custom_components/plex_recently_added/plex_api.py

@@ -50,7 +50,7 @@ async def update(self):
         try:
             info_res = await self._hass.async_add_executor_job(
                 requests.get,
-                f'{info_url}?X-Plex-Token={self._token}', 
+                f'{info_url}?X-Plex-Token={self._token}',
                 {
                     "headers":{
                         "User-agent": USER_AGENT,
@@ -62,8 +62,8 @@ async def update(self):
             check_headers(info_res)
             root = ElementTree.fromstring(info_res.text)
             identifier = root.get("machineIdentifier")
-        except OSError as e:
-            raise FailedToLogin
+        except (OSError, ValueError) as e:
+            raise FailedToLogin from e
 
         url_base = f'{info_url}/library/sections'
         all_libraries = f'{url_base}/all'
@@ -76,7 +76,7 @@ async def update(self):
         try:
             libraries = await self._hass.async_add_executor_job(
                 requests.get,
-                f'{all_libraries}?X-Plex-Token={self._token}', 
+                f'{all_libraries}?X-Plex-Token={self._token}',
                 {
                     "headers":{
                         "User-agent": USER_AGENT,
@@ -91,8 +91,8 @@ async def update(self):
                 libs.append(lib.get("title"))
                 if lib.get("type") in self._section_types and (len(self._section_libraries) == 0 or lib.get("title") in self._section_libraries):
                     sections.append({'type': lib.get("type"),'key': lib.get("key")})
-        except OSError as e:
-            raise FailedToLogin
+        except (OSError, ValueError) as e:
+            raise FailedToLogin from e
 
         """ Looping through all libraries (sections) """
         data = {
@@ -102,30 +102,34 @@ async def update(self):
             data[s] = []
 
         for library in sections:
-            recent_or_deck = on_deck if self._on_deck else recently_added
-            sub_sec = await self._hass.async_add_executor_job(
-                requests.get,
-                f'{recent_or_deck.format(library["key"], self._max * 2)}&X-Plex-Token={self._token}', 
-                {
-                    "headers":{
-                        "User-agent": USER_AGENT,
-                        "Accept": ACCEPTS,
-                    },
-                    "timeout":10
-                }
-            )
-            check_headers(sub_sec)
-            root = ElementTree.fromstring(sub_sec.text)
-            parsed_libs = parse_library(root)
-            
-            # Fetch trailer URLs for each item
-            for item in parsed_libs:
-                item['trailer'] = await get_tmdb_trailer_url(self._hass, item['title'], library['type'])
-            
-            if library["type"] not in data['all']:
-                data['all'][library["type"]] = []
-            data['all'][library["type"]] += parsed_libs
-            data[library["type"]] += parsed_libs
+            try:
+                recent_or_deck = on_deck if self._on_deck else recently_added
+                sub_sec = await self._hass.async_add_executor_job(
+                    requests.get,
+                    f'{recent_or_deck.format(library["key"], self._max * 2)}&X-Plex-Token={self._token}',
+                    {
+                        "headers":{
+                            "User-agent": USER_AGENT,
+                            "Accept": ACCEPTS,
+                        },
+                        "timeout":10
+                    }
+                )
+                check_headers(sub_sec)
+                root = ElementTree.fromstring(sub_sec.text)
+                parsed_libs = parse_library(root)
+
+                # Fetch trailer URLs for each item
+                for item in parsed_libs:
+                    item['trailer'] = await get_tmdb_trailer_url(self._hass, item['title'], library['type'])
+
+                if library["type"] not in data['all']:
+                    data['all'][library["type"]] = []
+                data['all'][library["type"]] += parsed_libs
+                data[library["type"]] += parsed_libs
+            except (OSError, ValueError) as e:
+                # Skip this library if it fails to load
+                continue
 
         data_out = {}
         for k in data.keys():

custom_components/plex_recently_added/strings.json

@@ -15,6 +15,23 @@
             "section_libraries": "Which libraries to consider",
             "verify_ssl": "Verify SSL"
           }
+        },
+        "reconfigure": {
+          "title": "Reconfigure Plex Recently Added",
+          "description": "Update your Plex server connection settings",
+          "data": {
+            "name": "Name",
+            "host": "Plex address",
+            "port": "Plex port",
+            "api_key": "Plex token",
+            "ssl": "SSL",
+            "max": "Max number of items in sensor",
+            "on_deck": "Show \"on deck\" items",
+            "section_types": "Which section types to consider",
+            "exclude_keywords": "Keyword to be exclude from the sensor",
+            "section_libraries": "Which libraries to consider",
+            "verify_ssl": "Verify SSL"
+          }
         }
       },
       "error": {
@@ -24,7 +41,8 @@
       "abort": {
         "already_configured": "User is already configured (check README)",
         "failed_to_login": "Failed to Log-in",
-        "cannot_be_reached": "Plex cannot be reached"
+        "cannot_be_reached": "Plex cannot be reached",
+        "reconfigure_successful": "Reconfiguration successful"
       }
     },
     "options": {
@@ -38,6 +56,9 @@
             "on_deck": "Show \"on deck\" items"
         }
         }
+      },
+      "abort": {
+        "integration_not_loaded": "Integration is not loaded. Please reload the integration and try again."
       }
     }
   }

custom_components/plex_recently_added/translations/en.json

@@ -15,6 +15,23 @@
           "section_libraries": "Which libraries to consider",
           "verify_ssl": "Verify SSL"
         }
+      },
+      "reconfigure": {
+        "title": "Reconfigure Plex Recently Added",
+        "description": "Update your Plex server connection settings",
+        "data": {
+          "name": "Name",
+          "host": "Plex address",
+          "port": "Plex port",
+          "api_key": "Plex token",
+          "ssl": "SSL",
+          "max": "Max number of items in sensor",
+          "on_deck": "Show \"on deck\" items",
+          "section_types": "Which section types to consider",
+          "exclude_keywords": "Keyword to be exclude from the sensor",
+          "section_libraries": "Which libraries to consider",
+          "verify_ssl": "Verify SSL"
+        }
       }
     },
     "error": {
@@ -24,7 +41,8 @@
     "abort": {
       "already_configured": "User is already configured (check README)",
       "failed_to_login": "Failed to Log-in",
-      "cannot_be_reached": "Plex cannot be reached"
+      "cannot_be_reached": "Plex cannot be reached",
+      "reconfigure_successful": "Reconfiguration successful"
     }
   },
   "options": {
@@ -38,6 +56,9 @@
           "on_deck": "Show \"on deck\" items"
       }
       }
+    },
+    "abort": {
+      "integration_not_loaded": "Integration is not loaded. Please reload the integration and try again."
     }
   }
 }