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.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, ValidationError, field_validator, model_validator, ) from pydantic_core.core_schema import ValidationInfo from pydantic_settings import BaseSettings, SettingsConfigDict from snowflake.cortex import CompleteOptions # type: ignore[reportMissingTypeStubs] from sqlalchemy import URL from ows_text_campaigns.adapters.scanner import ContentScanResponse class Settings(BaseSettings): # Main environment: str = Field(validation_alias="Environment") 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.parent # Service service_name: str = "ows-text-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_engine_args: dict[str, Any] = { "echo": False, "pool_size": 10, "max_overflow": 20, "pool_recycle": 4 * 60 * 60, # ~4 hours "pool_pre_ping": False, "pool_reset_on_return": None, "connect_args": { "keepalives": 1, "keepalives_idle": 60, "keepalives_interval": 10, "keepalives_count": 5, }, "isolation_level": "AUTOCOMMIT", "skip_autocommit_rollback": True, } @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, ) 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, "client_session_keep_alive": True, } @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 / "campaigns" / "sql", base_dir / "rosters" / "sql", base_dir / "twilio" / "sql", ] # ORM orm_models: list[ImportString[Any]] = ["ows_text_campaigns.twilio.models"] # Twilio twilio_account_sid: str = "" twilio_auth_token: str = "" @property def twilio_status_callback_url(self) -> str: return f"https://{self.environment.lower()}-fansifter-twilio-webhooks.theorchard.com/outbound" # Preference Center preference_center_secret_key: str = "" @property def preference_center_url(self) -> str: if self.environment == PROD_ENVIRONMENT: return "https://fan-preferences.sonymusic.com" return "https://qa-preferences.theorchard.io" @property def preference_center_profile_url_template(self) -> str: return f"{self.preference_center_url}/en/profile/{{fan_token}}/subscriptions" # URL Shortener @property def url_shortener_domain(self) -> str: if self.environment == PROD_ENVIRONMENT: return "smf.link" return "click.qapdesuite.com" # Kafka kafka_bootstrap_servers: str = "localhost" kafka_event_topic: str = "event.twilio.webhook.inbound" kafka_status_update_topic: str = "event.twilio.fan.subscriptionStatusUpdate" kafka_use_ssl: bool = True # DynamoDB fan_states_dynamodb_tablename: str = "fan_states" # 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 # Artist artist_image_allowed_content_types: list[str] = [ "image/jpeg", "image/jpg", "image/png", ] # Maximum file size for artist image includes base64 encoding overhead artist_image_max_file_size: int = 375 * 1024 # 375 KB artist_image_min_width: int = 300 # pixels artist_image_min_height: int = 300 # pixels artist_opt_in_message_terms: str = ( "Please review my Terms & Conditions (smf.link/tc-us) and " "Privacy Policy (smf.link/pp-us). To receive my messages, reply YES." ) artist_reopt_in_message: str = ( "{artist_name}: Welcome back. Message STOP to cancel." ) artist_welcome_message_instructions: str = ( "Msg&Data rates may apply. Reply HELP for help. Reply STOP to stop messages." ) artist_info_message: str = ( "This is a conversation with {artist_name}.\n " "Manage Preferences: {preference_center_url}\n " "If you no longer want to receive these messages, simply reply STOP. To resume messaging text START." ) # Campaigns campaign_schedule_in_queue_minutes: int = 10 campaign_max_attachments: int = 1 campaign_attachment_allowed_content_types: list[str] = [ "image/jpeg", "image/jpg", "image/png", "image/gif", ] campaign_attachment_max_file_size: int = 500 * 1024 # 500 KB campaign_attachment_min_width: int = 300 # pixels campaign_attachment_min_height: int = 300 # pixels max_allowed_personalized_attributes_limit: int = 1000 mms_send_supported_countries: tuple[str, ...] = ( "US", "CA", ) # Channel -> country codes that channel must never target. channel_country_blocklist: dict[Literal["SMS", "WHATSAPP"], set[str]] = { "WHATSAPP": {"US"} } # Media assets_image_min_allowed_file_size: int = 1024 # 1 KB assets_image_max_allowed_file_size: int = 5 * 1024 * 1024 # 5 MB assets_bucket_name: str = Field(default="", validation_alias="ASSETS_BUCKET_NAME") assets_iam_role_arn: str = Field(default="", validation_alias="ASSETS_IAM_ROLE_ARN") assets_cdn_domain: str = Field(default="", validation_alias="ASSETS_CDN_DOMAIN") assets_path: str = Field(default="assets", validation_alias="ASSETS_PATH") def get_asset_upload_policy(self, key: str) -> dict[str, Any]: return { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:PutObject", ], "Resource": f"arn:aws:s3:::{self.assets_bucket_name}/{key}", } ], } jwt_auth_exclude_paths: list[str] = [ "/hello/", "/redoc", "/docs*", "/openapi.json", "/_debug_toolbar", "/twilio/inbound", ] # OpenAPI / Swagger qa_server_url: str = "https://qa-ows-text-campaigns.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_text_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 # 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-text-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 # KMS kms_enabled: bool = True @classmethod @field_validator("kms_enabled") def _setup_kms_enabled(cls, v: bool, info: ValidationInfo) -> bool: environment: str = info.data["environment"] if environment in (QA_ENVIRONMENT, PROD_ENVIRONMENT): return True return v kms_key_id: str = Field(default="", validation_alias="KMS_KEY_ID") @classmethod @field_validator("kms_key_id") def _setup_kms_key_id(cls, v: str, info: ValidationInfo) -> str: kms_enabled: bool = info.data["kms_enabled"] if kms_enabled and not v: raise ValueError("`kms_key_id` must be set.") return v # 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": { "ows_text_campaigns": { "handlers": ["stream", "rich"], "level": "INFO", }, "fansifter_common.httpclient": { "handlers": ["stream", "rich"], "level": "WARNING", }, "sqlalchemy.engine": { "handlers": ["stream", "rich"], "level": "WARNING", }, "snowflake": { "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 = 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 model_config = SettingsConfigDict( env_file=".env", env_file_encoding="utf-8", case_sensitive=False, extra="allow", ) content_scanner_llm_model: str = "claude-4-sonnet" content_scanner_llm_options: CompleteOptions = { "temperature": 0, "top_p": 0, "max_tokens": 4096, "guardrails": False, "response_format": { "type": "json", "schema": ContentScanResponse.model_json_schema(), }, } content_scanner_llm_timeout: int = 15 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 # Lazy proxy for settings settings = lazy_proxy(setup_settings)