Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve config_flow error handling #225

Merged
merged 1 commit into from
Oct 1, 2024
Merged

Improve config_flow error handling #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 43 additions & 16 deletions custom_components/opnsense/config_flow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from collections.abc import Mapping
import ipaddress
import logging
import socket
from typing import Any
from urllib.parse import quote_plus, urlparse
import xmlrpc
Expand Down Expand Up @@ -94,9 +95,10 @@ async def async_step_user(self, user_input=None):
username=username,
password=password,
session=async_create_clientsession(
self.hass, raise_for_status=False
self.hass, raise_for_status=True
),
opts={"verify_ssl": verify_ssl},
initial=True,
)
system_info: Mapping[str, Any] = await client.get_system_info()

Expand All @@ -107,8 +109,9 @@ async def async_step_user(self, user_input=None):
await self.async_set_unique_id(slugify(system_info["device_id"]))
self._abort_if_unique_id_configured()

except (aiohttp.InvalidURL, InvalidURL):
except (aiohttp.InvalidURL, InvalidURL) as err:
errors["base"] = "invalid_url_format"
_LOGGER.error(f"InvalidURL Error. {err.__class__.__qualname__}: {err}")
except xmlrpc.client.Fault as err:
if "Invalid username or password" in str(err):
errors["base"] = "invalid_auth"
Expand All @@ -117,25 +120,45 @@ async def async_step_user(self, user_input=None):
elif "opnsense.exec_php does not exist" in str(err):
errors["base"] = "plugin_missing"
else:
message = cleanse_sensitive_data(
f"Unexpected {err=}, {type(err)=}", [username, password]
errors["base"] = "cannot_connect"
_LOGGER.error(
cleanse_sensitive_data(
f"XMLRPC Error. {err.__class__.__qualname__}: {err}",
[username, password],
)
_LOGGER.error(message)
)
except (
aiohttp.ClientResponseError,
aiohttp.ClientError,
aiohttp.ClientConnectorError,
socket.gaierror,
) as err:
errors["base"] = "cannot_connect"
_LOGGER.error(f"Aiohttp Error. {err.__class__.__qualname__}: {err}")
except (aiohttp.ClientResponseError,) as err:
if err.status == 401 or err.status == 403:
errors["base"] = "invalid_auth"
else:
errors["base"] = "cannot_connect"
_LOGGER.error(f"Aiohttp Error. {err.__class__.__qualname__}: {err}")
except xmlrpc.client.ProtocolError as err:
if "307 Temporary Redirect" in str(err):
errors["base"] = "url_redirect"
elif "301 Moved Permanently" in str(err):
errors["base"] = "url_redirect"
else:
message = cleanse_sensitive_data(
f"Unexpected {err=}, {type(err)=}", [username, password]
)
_LOGGER.error(message)
errors["base"] = "cannot_connect"
_LOGGER.error(
cleanse_sensitive_data(
f"XMLRPC Error. {err.__class__.__qualname__}: {err}",
[username, password],
)
)
except (aiohttp.TooManyRedirects, aiohttp.RedirectClientError):
_LOGGER.error(f"Redirect Error. {err.__class__.__qualname__}: {err}")
errors["base"] = "url_redirect"
except (TimeoutError, aiohttp.ServerTimeoutError):
_LOGGER.error(f"Timeout Error. {err.__class__.__qualname__}: {err}")
errors["base"] = "connect_timeout"
except OSError as err:
# bad response from OPNsense when creds are valid but authorization is
Expand All @@ -149,16 +172,20 @@ async def async_step_user(self, user_input=None):
"""OSError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:1129)"""
errors["base"] = "cannot_connect_ssl"
else:
message = cleanse_sensitive_data(
f"Unexpected {err=}, {type(err)=}", [username, password]
)
_LOGGER.error(message)
errors["base"] = "unknown"
_LOGGER.error(
cleanse_sensitive_data(
f"Error. {err.__class__.__qualname__}: {err}",
[username, password],
)
)
except Exception as err:
message = cleanse_sensitive_data(
f"Unexpected {err=}, {type(err)=}", [username, password]
_LOGGER.error(
cleanse_sensitive_data(
f"Other Error. {err.__class__.__qualname__}: {err}",
[username, password],
)
)
_LOGGER.error(message)
errors["base"] = "unknown"
else:
return self.async_create_entry(
Expand Down
20 changes: 15 additions & 5 deletions custom_components/opnsense/pyopnsense/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ def __init__(
password: str,
session: aiohttp.ClientSession,
opts: Mapping[str, Any] = None,
initial: bool = False,
) -> None:
"""OPNsense Client initializer."""

Expand All @@ -67,6 +68,7 @@ def __init__(
)
self._scheme: str = parts.scheme
self._session: aiohttp.ClientSession = session
self._initial = initial
try:
self._loop = asyncio.get_running_loop()
except RuntimeError:
Expand Down Expand Up @@ -95,9 +97,11 @@ async def inner(self, *args, **kwargs):
raise e
except Exception as e:
_LOGGER.error(
f"Error in {func.__name__.strip('_')}. {e.__class__.__qualname__}: {e}"
f"Error in {func.__name__.strip('_')}. {e.__class__.__qualname__}: "
f"{re.sub(r'(\w+):(\w+)@', '<redacted>:<redacted>@', str(e))}"
)
# raise err
if self._initial:
raise e

return inner

Expand Down Expand Up @@ -225,7 +229,9 @@ async def _get_from_stream(self, path: str) -> Mapping[str, Any] | list:
f"Error in {inspect.currentframe().f_back.f_code.co_qualname.strip('_')}. Path: {url}. Response {response.status}: {response.reason}"
)
except aiohttp.ClientError as e:
_LOGGER.error(f"Client error: {str(e)}")
_LOGGER.error(f"Client error. {e.__class__.__qualname__}: {e}")
if self._initial:
raise e

return {}

Expand Down Expand Up @@ -255,7 +261,9 @@ async def _get(self, path: str) -> Mapping[str, Any] | list:
f"Error in {inspect.currentframe().f_back.f_code.co_qualname.strip('_')}. Path: {url}. Response {response.status}: {response.reason}"
)
except aiohttp.ClientError as e:
_LOGGER.error(f"Client error: {str(e)}")
_LOGGER.error(f"Client error. {e.__class__.__qualname__}: {e}")
if self._initial:
raise e

return {}

Expand Down Expand Up @@ -287,7 +295,9 @@ async def _post(self, path: str, payload=None) -> Mapping[str, Any] | list:
f"Error in {inspect.currentframe().f_back.f_code.co_qualname.strip('_')}. Path: {url}. Response {response.status}: {response.reason}"
)
except aiohttp.ClientError as e:
_LOGGER.error(f"Client error: {str(e)}")
_LOGGER.error(f"Client error. {e.__class__.__qualname__}: {e}")
if self._initial:
raise e

return {}

Expand Down
Loading