oe-python-template 0.13.12__py3-none-any.whl → 0.13.14__py3-none-any.whl

oe_python_template/utils/_sentry.py

@@ -1,15 +1,115 @@
 """Sentry integration for application monitoring."""
 
+import re
+import urllib.parse
 from typing import Annotated
 
 import sentry_sdk
-from pydantic import BeforeValidator, Field, PlainSerializer, SecretStr
+from pydantic import AfterValidator, BeforeValidator, Field, PlainSerializer, SecretStr
 from pydantic_settings import SettingsConfigDict
 from sentry_sdk.integrations.typer import TyperIntegration
 
 from ._constants import __env__, __env_file__, __project_name__, __version__
 from ._settings import OpaqueSettings, load_settings, strip_to_none_before_validator
 
+_ERR_MSG_MISSING_SCHEME = "Sentry DSN is missing URL scheme (protocol)"
+_ERR_MSG_MISSING_NETLOC = "Sentry DSN is missing network location (domain)"
+_ERR_MSG_NON_HTTPS = "Sentry DSN must use HTTPS protocol for security"
+_ERR_MSG_INVALID_DOMAIN = "Sentry DSN must use a valid Sentry domain (ingest.us.sentry.io or ingest.de.sentry.io)"
+_ERR_MSG_INVALID_FORMAT = "Invalid Sentry DSN format"
+_VALID_SENTRY_DOMAIN_PATTERN = r"^[a-f0-9]+@o\d+\.ingest\.(us|de)\.sentry\.io$"
+
+
+def _validate_url_scheme(parsed_url: urllib.parse.ParseResult) -> None:
+    """Validate that the URL has a scheme.
+
+    Args:
+        parsed_url: The parsed URL to validate
+
+    Raises:
+        ValueError: If URL is missing scheme
+    """
+    if not parsed_url.scheme:
+        raise ValueError(_ERR_MSG_MISSING_SCHEME)
+
+
+def _validate_url_netloc(parsed_url: urllib.parse.ParseResult) -> None:
+    """Validate that the URL has a network location.
+
+    Args:
+        parsed_url: The parsed URL to validate
+
+    Raises:
+        ValueError: If URL is missing network location
+    """
+    if not parsed_url.netloc:
+        raise ValueError(_ERR_MSG_MISSING_NETLOC)
+
+
+def _validate_https_scheme(parsed_url: urllib.parse.ParseResult) -> None:
+    """Validate that the URL uses HTTPS scheme.
+
+    Args:
+        parsed_url: The parsed URL to validate
+
+    Raises:
+        ValueError: If URL doesn't use HTTPS scheme
+    """
+    if parsed_url.scheme != "https":
+        raise ValueError(_ERR_MSG_NON_HTTPS)
+
+
+def _validate_sentry_domain(netloc_with_auth: str) -> None:
+    """Validate that the URL uses a valid Sentry domain.
+
+    Args:
+        netloc_with_auth: The network location with auth part
+
+    Raises:
+        ValueError: If URL doesn't use a valid Sentry domain
+    """
+    if "@" not in netloc_with_auth:
+        raise ValueError(_ERR_MSG_INVALID_DOMAIN)
+
+    user_pass, domain = netloc_with_auth.split("@", 1)
+    full_auth = f"{user_pass}@{domain}"
+    if not re.match(_VALID_SENTRY_DOMAIN_PATTERN, full_auth):
+        raise ValueError(_ERR_MSG_INVALID_DOMAIN)
+
+
+def validate_https_dsn(value: SecretStr | None) -> SecretStr | None:
+    """Validate that the Sentry DSN is a valid HTTPS URL.
+
+    Args:
+        value: The DSN value to validate
+
+    Returns:
+        SecretStr | None: The validated DSN value
+
+    Raises:
+        ValueError: If DSN isn't a valid HTTPS URL with specific error details
+    """
+    if value is None:
+        return value
+
+    dsn = value.get_secret_value()
+    try:
+        parsed_url = urllib.parse.urlparse(dsn)
+
+        # Call validation functions outside of the try block
+        _validate_url_scheme(parsed_url)
+        _validate_url_netloc(parsed_url)
+        _validate_https_scheme(parsed_url)
+        _validate_sentry_domain(parsed_url.netloc)
+
+    except ValueError as exc:
+        raise exc from None
+    except Exception as exc:
+        error_message = _ERR_MSG_INVALID_FORMAT
+        raise ValueError(error_message) from exc
+
+    return value
+
 
 class SentrySettings(OpaqueSettings):
     """Configuration settings for Sentry integration."""
@@ -24,6 +124,7 @@ class SentrySettings(OpaqueSettings):
     dsn: Annotated[
         SecretStr | None,
         BeforeValidator(strip_to_none_before_validator),
+        AfterValidator(validate_https_dsn),
         PlainSerializer(func=OpaqueSettings.serialize_sensitive_info, return_type=str, when_used="always"),
         Field(description="Sentry DSN", examples=["https://SECRET@SECRET.ingest.de.sentry.io/SECRET"], default=None),
     ]

{oe_python_template-0.13.12.dist-info → oe_python_template-0.13.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.13.12
+Version: 0.13.14
 Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/

{oe_python_template-0.13.12.dist-info → oe_python_template-0.13.14.dist-info}/RECORD

@@ -28,13 +28,13 @@ oe_python_template/utils/_log.py,sha256=ZW4gs540SdjVK-2KeheLfDY15d_3xpO5FyGn7wTX
 oe_python_template/utils/_logfire.py,sha256=wZYNVowQx7kh3XJoJ59FjUKdrta7tp6cXOJRUT6lDU8,2128
 oe_python_template/utils/_notebook.py,sha256=oBQw9IBcXjuhzd1ECfOEPN4WJHGOm9xiPtrs11GtWG4,1777
 oe_python_template/utils/_process.py,sha256=40R0NZMqJUn0iUPERzohSUpJgU1HcJApIg1HipIxFCw,941
-oe_python_template/utils/_sentry.py,sha256=2sXrDSZSYoDEM87v7CakJ6eGBtcIhDI48PsQCLwOHgg,3319
+oe_python_template/utils/_sentry.py,sha256=7nONiWZP0hWX0QAEPcg7No3FF1BF4S-Sl0wgG7xLw8g,6367
 oe_python_template/utils/_service.py,sha256=atHAejvBucKXjzhsMSdOBBFa7rRD74zcV70Pp0pl0Tg,1038
 oe_python_template/utils/_settings.py,sha256=owFoaHEzJnVD3EVyOWF4rfIY7g6eLnU6rN0m4VHhCbA,2464
 oe_python_template/utils/boot.py,sha256=Qgq1sjT8d3fcfibnMyx5CVUJ_KKXgFI3ozZUIJbhh4I,2921
 oe_python_template/utils/.vendored/bottle.py,sha256=kZAZmh3nRzCUf-9IKGpv0yqlMciZMA_DNaaMDdcQmt0,175437
-oe_python_template-0.13.12.dist-info/METADATA,sha256=As2lzhayF4F5NNII0pImuSbJdSl1K71ADCv5bT0AonQ,34476
-oe_python_template-0.13.12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template-0.13.12.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
-oe_python_template-0.13.12.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template-0.13.12.dist-info/RECORD,,
+oe_python_template-0.13.14.dist-info/METADATA,sha256=535E3ddxUlLQusQdLrJGP0NyadIxqL-_H8v7p_NVYgk,34476
+oe_python_template-0.13.14.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template-0.13.14.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
+oe_python_template-0.13.14.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template-0.13.14.dist-info/RECORD,,