from __future__ import annotations import pathlib from typing import Any, Literal, Self from cryptography.hazmat.backends import default_backend from cryptography.hazmat.primitives import serialization from fansifter_common.adapters.aws.secretsmanager import SecretsManager from fansifter_common.adapters.snowflake.converter import SnowflakeConverter from fansifter_common.constants import PROD_ENVIRONMENT, QA_ENVIRONMENT from fansifter_common.utils.functional import lazy_proxy from pydantic import Field, ImportString, SecretStr, ValidationError, model_validator from pydantic_settings import BaseSettings, SettingsConfigDict from sqlalchemy import URL class Settings(BaseSettings): # Main environment: str debug: bool = Field(validation_alias="APP_DEBUG", default=False) run_from_cli: bool = Field(validation_alias="APP_RUN_FROM_CLI", default=False) # Directories base_dir: pathlib.Path = pathlib.Path(__file__).resolve().parent root_dir: pathlib.Path = base_dir.parent # Service service_name: str = "ows-email-campaigns" service_version: str = "1.0.0" # AWS region aws_region_name: str = "us-east-1" # Postgres postgres_user: str = "postgres" postgres_password: str = "postgres" postgres_host: str = "localhost" postgres_port: int = 5432 postgres_name: str = "dmp" postgres_echo: bool = False postgres_pool_size: int = 10 postgres_pool_max_overflow: int = 20 postgres_pool_recycle: int = 4 * 60 * 60 # ~4 hours postgres_pool_pre_ping: bool = False postgres_pool_reset_on_return: Literal["commit", "rollback"] | None = None postgres_connect_args: dict[str, Any] = { "keepalives": 1, "keepalives_idle": 60, "keepalives_interval": 10, "keepalives_count": 5, } @property def postgres_url(self) -> URL: return URL.create( drivername="postgresql+psycopg", username=self.postgres_user, password=self.postgres_password, host=self.postgres_host, port=self.postgres_port, database=self.postgres_name, ) # Snowflake snowflake_account: str = "account" snowflake_database: str = "database" snowflake_schema: str = "schema" snowflake_warehouse: str = "warehouse" snowflake_role: str = "role" snowflake_user: str = "user" snowflake_password: str | None = None snowflake_host: str = "localhost" snowflake_port: int = 443 snowflake_url: str = "" @model_validator(mode="after") def _setup_snowflake_url(self) -> Any: from snowflake.sqlalchemy import URL self.snowflake_url = URL( account=self.snowflake_account, user=self.snowflake_user, database=self.snowflake_database, schema=self.snowflake_schema, warehouse=self.snowflake_warehouse, role=self.snowflake_role, client_session_keep_alive=True, ) return self snowflake_echo: bool = False snowflake_pool_size: int = 10 snowflake_pool_max_overflow: int = 20 snowflake_pool_recycle: int = 4 * 55 * 60 # ~4 hours snowflake_pool_pre_ping: bool = False snowflake_pool_reset_on_return: Literal["commit", "rollback"] | None = None default_snowflake_private_key_path: pathlib.Path = ( pathlib.Path.home() / ".ssh/snowflake/rsa_key.p8" ) snowflake_private_key_path: pathlib.Path = default_snowflake_private_key_path snowflake_private_key: bytes = b"" snowflake_key_passphrase: bytes = b"" snowflake_connect_args: dict[str, Any] = { "converter_class": SnowflakeConverter, } @model_validator(mode="after") def _setup_snowflake_connect_args(self) -> Self: if self.environment == "test": return self # Load private key if not set and path exists if not self.snowflake_private_key and self.snowflake_private_key_path.exists(): self.snowflake_private_key = self.snowflake_private_key_path.read_bytes() # Check if private key and passphrase are set in QA/PROD environment if self.environment in (QA_ENVIRONMENT, PROD_ENVIRONMENT) and ( not self.snowflake_key_passphrase or not self.snowflake_private_key ): raise ValueError( "Snowflake private key passphrase and path must be set in " "QA/PROD environment." ) # Load private key if self.snowflake_private_key: pem_private_key = serialization.load_pem_private_key( self.snowflake_private_key, password=self.snowflake_key_passphrase or None, backend=default_backend(), ) private_key = pem_private_key.private_bytes( encoding=serialization.Encoding.DER, format=serialization.PrivateFormat.PKCS8, encryption_algorithm=serialization.NoEncryption(), ) self.snowflake_connect_args["private_key"] = private_key return self jinja2sql_template_searchpath: list[pathlib.Path] = [ base_dir / "rosters" / "sql", base_dir / "emails" / "sql", base_dir / "campaigns" / "sql", base_dir / "profile" / "sql", base_dir / "automated" / "sql", base_dir / "fonts" / "sql", ] # ORM orm_models: list[ImportString[Any]] = [ "email_campaigns.rosters.models", "email_campaigns.audiences.models", "email_campaigns.emails.models", "email_campaigns.campaigns.models", "email_campaigns.automated.models", "email_campaigns.reporting.models", ] # JWT Auth jwt_auth_enabled: bool = False @model_validator(mode="after") def _setup_jwt_auth_enabled(self) -> Self: if self.environment in [QA_ENVIRONMENT, PROD_ENVIRONMENT]: self.jwt_auth_enabled = True return self jwt_auth_exclude_paths: list[str] = [ "/hello", "/hello/", "/redoc", "/docs*", "/openapi.json", "/_debug_toolbar", "/campaigns/autosave", # endpoint uses custom basic auth "/campaigns/autosave/v2", # endpoint uses custom basic auth (Stripo v2) "/automated/autosave", # endpoint uses custom basic auth "/automated/autosave/v2", # endpoint uses custom basic auth (Stripo v2) "/campaigns-public-preview/*", # public endpoint with token auth "/source-campaigns/.+/.+/automated-emails$", # internal endpoint for source systems like SMF, Wyng, Tunespeak "/automated-emails-public-preview/*", # public endpoint with token auth ] # OpenAPI / Swagger qa_server_url: str = "https://qa-email-campaigns-center.theorchard.io" openapi_url: str | None = "/openapi.json" @model_validator(mode="after") def _setup_openapi_url(self) -> Self: if self.environment == PROD_ENVIRONMENT: self.openapi_url = None return self openapi_filepath: pathlib.Path = ( root_dir / "spec" / "ows_email_campaigns-1.0.0.yaml" ) openapi_servers: list[dict[str, Any]] | None = None @model_validator(mode="after") def _setup_openapi_servers(self) -> Self: if self.environment == "dev" and self.run_from_cli: self.openapi_servers = [{"url": self.qa_server_url}] return self auth_allow_full_access: bool = False @model_validator(mode="after") def _setup_auth_allow_full_access(self) -> Self: """Allow to set full access authorization for local/dev environment(s) only.""" if self.environment in [QA_ENVIRONMENT, PROD_ENVIRONMENT]: self.auth_allow_full_access = False if not self.auth_allow_full_access and not self.jwt_auth_enabled: raise ValueError( "For not enabled full access [AUTH_ALLOW_FULL_ACCESS], " "you must enable JWT authentication [JWT_AUTH_ENABLED=true]." ) return self # Account access account_access_cache_timeout: int = 60 * 10 # 10 minutes # M2M Token @property def m2m_token_secret_name_key(self) -> str: return f"{self.environment}/lambda-audience-refresh-m2m-token/m2m_token" @property def m2m_token_secret_expire_name_key(self) -> str: return ( f"{self.environment}/lambda-audience-refresh-m2m-token/m2m_token_expiration" ) # Redis redis_host: str = "localhost" redis_port: int = 6379 redis_ssl: bool = False @model_validator(mode="after") def _setup_redis_ssl(self) -> Self: if self.environment in [QA_ENVIRONMENT, PROD_ENVIRONMENT]: self.redis_ssl = True return self # Cache cache_backend: str = "locmem" cache_default_timeout: int = 300 cache_key_prefix: str = "ows-email-campaigns:" cache_redis_db: int = 0 @model_validator(mode="after") def _setup_cache_backend(self) -> Self: if self.environment in [QA_ENVIRONMENT, PROD_ENVIRONMENT]: self.cache_backend = "redis" return self # Campaigns campaign_schedule_in_queue_minutes: int = 2 # Logging logging_debug: bool = Field(False, validation_alias="LOGGING_DEBUG") @property def logging_config(self) -> dict[str, Any]: return { "version": 1, "disable_existing_loggers": True, "formatters": { "json": { "()": "owslogger.logger.DDJsonFormatter", "service_name": self.service_name, "service_version": self.service_version, "env": self.environment, }, "console": { "()": "fansifter_common.logging.ConsoleFormatter", }, }, "filters": { "require_debug_true": { "()": "fansifter_common.logging.RequireDebugTrueFilter", "value": self.logging_debug, }, "require_debug_false": { "()": "fansifter_common.logging.RequireDebugFalseFilter", "value": self.logging_debug, }, }, "handlers": { "stream": { "level": "INFO", "class": "logging.StreamHandler", "formatter": "json", "filters": ["require_debug_false"], }, "rich": { "level": "INFO", "class": "rich.logging.RichHandler", "filters": ["require_debug_true"], "formatter": "console", }, "null": { "level": "INFO", "class": "logging.NullHandler", }, }, "loggers": { "email_campaigns": { "handlers": ["stream", "rich"], "level": "INFO", }, "sqlalchemy.engine": { "handlers": ["stream", "rich"], "level": "WARNING", }, "anydi": { "handlers": ["stream", "rich"], "level": "WARNING", }, "httpx": { "handlers": ["stream", "rich"], "level": "WARNING", }, "uvicorn": { "handlers": ["stream", "rich"], "level": "INFO", }, "uvicorn.access": { "handlers": ["null"], "level": "INFO", }, }, } # Sentry sentry_dsn: str | None @model_validator(mode="after") def _setup_sentry_dsn(self) -> Self: if not self.sentry_dsn and self.environment in [ QA_ENVIRONMENT, PROD_ENVIRONMENT, ]: raise ValueError(f"Sentry is not configured in {self.environment}.") return self # SendGrid sendgrid_sme_api_key: str = "" sendgrid_orchard_api_key: str = "" sendgrid_awal_api_key: str = "" # Split.io splitio_api_key: str = Field(validation_alias="SPLIT_IO_API_KEY", default="") splitio_block_until_ready_timeout: int = Field( validation_alias="SPLIT_IO_BLOCK_UNTIL_READY_TIMEOUT", default=60 ) splitio_config: dict[str, Any] = { "impressionsMode": "optimized", "preforkedInitialization": False, } @model_validator(mode="after") def _setup_splitio_config(self) -> Self: if self.splitio_api_key == "localhost": self.splitio_config.update( { "splitFile": str(self.root_dir / "tests/split.yaml"), } ) return self # Google Fonts google_fonts_api_key: str = "" # Stripo stripo_base_url: str = "" stripo_client_id: str = "" stripo_client_secret: str = "" stripo_automated_client_id: str = "" stripo_automated_client_secret: str = "" stripo_autosave_username: str = "" stripo_autosave_password: str = "" # Stripo V2 (feature-flagged) stripo_v2_base_url: str = "" stripo_v2_coediting_url: str = "" stripo_v2_client_id: str = "" stripo_v2_client_secret: str = "" stripo_v2_automated_client_id: str = "" stripo_v2_automated_client_secret: str = "" # Preference center preference_center_secret_key: str = "" preference_center_secret_key_name: str = "" unsubscribe_host: str = "" preference_center_url: str = "" privacy_footer_utm_source_name: str = "fs_email_footer" translations_path: str = str(root_dir / "locale" / "translations.json") # Email public preview email_public_preview_secret_key: str = "" email_public_preview_ttl_seconds: int = 604800 # 7 days qa_email_public_preview_domain: str = "qapdesuite.com" email_public_preview_available_domains: list[str] = [ "theorchard.com", "sonymusic.com", "awal.com", ] reply_to_sme_domain: str = Field( default="reply.email.qa-fansifter.theorchard.io", validation_alias="REPLY_TO_SME_DOMAIN", ) reply_to_orchard_domain: str = Field( default="reply.email.qa-fansifter.theorchard.io", validation_alias="REPLY_TO_ORCHARD_DOMAIN", ) reply_to_awal_domain: str = Field( default="reply.email.qa-fansifter.theorchard.io", validation_alias="REPLY_TO_AWAL_DOMAIN", ) reply_to_header_enabled: bool = Field( default=True, validation_alias="REPLY_TO_HEADER_ENABLED", ) reply_to_secret_key: SecretStr = Field( default=SecretStr(""), validation_alias="REPLY_TO_SECRET_KEY", ) @model_validator(mode="after") def _set_reply_to_header_enabled(self) -> Self: if self.environment == PROD_ENVIRONMENT: self.reply_to_header_enabled = False return self @model_validator(mode="after") def _validate_email_public_preview_domains(self) -> Self: if self.environment == PROD_ENVIRONMENT: if not self.email_public_preview_available_domains: raise ValueError( "email_public_preview_available_domains must not be empty " "in production environment" ) return self @model_validator(mode="after") def _get_credentials_from_secrets_manager(self) -> Self: if self.environment in [QA_ENVIRONMENT, PROD_ENVIRONMENT]: secrets_manager = SecretsManager(region_name=self.aws_region_name) self.preference_center_secret_key = secrets_manager.get_secret( self.preference_center_secret_key_name ) return self model_config = SettingsConfigDict( env_file=".env", env_file_encoding="utf-8", case_sensitive=False, extra="allow", ) def setup_settings(**defaults: Any) -> Settings: """Setup the application settings.""" try: return Settings(**defaults) except ValidationError as exc: errors = "\n".join( [ f" * {'.'.join(map(str, error['loc']))} - {error['msg']}" for error in exc.errors() ] ) raise RuntimeError(f"Failed to initialize settings:\n {errors}") from exc settings = lazy_proxy(setup_settings)