refactor(config): update configuration access across multiple services

- Refactored the import path for CONFIG to streamline access in various service files.
- Updated SentryManager, Tracing, ActivityHandler, EventHandler, and GithubService to utilize the new CONFIG structure.
- Enhanced error handling in GithubService for missing configuration values, ensuring better diagnostics.
- Adjusted environment checks to rely on CONFIG.DEBUG for sampling rates and tracing behavior.

Author: kzndotsh

src/tux/services/handlers/activity.py

@@ -7,7 +7,7 @@
 from loguru import logger
 
 from tux.core.types import Tux
-from tux.shared.config.settings import Config
+from tux.shared.config import CONFIG
 from tux.shared.substitutions import handle_substitution
 
 # Map the string type to the discord.ActivityType enum.
@@ -37,14 +37,14 @@ def build_activity_list() -> list[discord.Activity | discord.Streaming]:
             A list of activity objects.
         """
 
-        if not Config.ACTIVITIES or not Config.ACTIVITIES.strip():
-            logger.warning("Config.ACTIVITIES is empty or None. Returning an empty list.")
+        if not CONFIG.BOT_INFO.ACTIVITIES or not CONFIG.BOT_INFO.ACTIVITIES.strip():
+            logger.warning("CONFIG.BOT_INFO.ACTIVITIES is empty or None. Returning an empty list.")
             return []
 
         try:
-            activity_data = json.loads(Config.ACTIVITIES)  # Safely parse JSON
+            activity_data = json.loads(CONFIG.BOT_INFO.ACTIVITIES)  # Safely parse JSON
         except json.JSONDecodeError:
-            logger.error(f"Failed to parse ACTIVITIES JSON: {Config.ACTIVITIES!r}")
+            logger.error(f"Failed to parse ACTIVITIES JSON: {CONFIG.BOT_INFO.ACTIVITIES!r}")
             raise  # Re-raise after logging
 
         activities: list[discord.Activity | discord.Streaming] = []

src/tux/services/handlers/event.py

@@ -3,7 +3,7 @@
 
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 from tux.shared.functions import is_harmful, strip_formatting
 from tux.ui.embeds import EmbedCreator, EmbedType
 
@@ -35,7 +35,7 @@ async def handle_harmful_message(message: discord.Message) -> None:
         None
         """
 
-        if message.author.bot and message.webhook_id not in CONFIG.BRIDGE_WEBHOOK_IDS:
+        if message.author.bot and message.webhook_id not in CONFIG.IRC_CONFIG.BRIDGE_WEBHOOK_IDS:
             return
 
         stripped_content = strip_formatting(message.content)
@@ -69,9 +69,9 @@ async def on_message_edit(self, before: discord.Message, after: discord.Message)
     @commands.Cog.listener()
     async def on_message(self, message: discord.Message) -> None:
         # Allow the IRC bridge to use the snippet command only
-        if message.webhook_id in CONFIG.BRIDGE_WEBHOOK_IDS and (
-            message.content.startswith(f"{CONFIG.DEFAULT_PREFIX}s ")
-            or message.content.startswith(f"{CONFIG.DEFAULT_PREFIX}snippet ")
+        if message.webhook_id in CONFIG.IRC_CONFIG.BRIDGE_WEBHOOK_IDS and (
+            message.content.startswith(f"{CONFIG.get_prefix()}s ")
+            or message.content.startswith(f"{CONFIG.get_prefix()}snippet ")
         ):
             ctx = await self.bot.get_context(message)
             await self.bot.invoke(ctx)

src/tux/services/sentry_manager.py

@@ -30,8 +30,7 @@
 from sentry_sdk.types import Event, Hint
 
 from tux.core.context import get_interaction_context
-from tux.shared.config.env import get_current_env
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 
 # Type alias for Sentry's log level strings.
 LogLevelStr = Literal["fatal", "critical", "error", "warning", "info", "debug"]
@@ -276,7 +275,7 @@ def _traces_sampler(sampling_context: dict[str, Any]) -> float:
         transaction_name = sampling_context.get("transaction_context", {}).get("name", "")
 
         # Full sampling in development for debugging
-        if get_current_env() in ("dev", "development"):
+        if CONFIG.DEBUG:
             return 1.0
 
         # Production sampling rates using dictionary lookup
@@ -302,7 +301,7 @@ def setup() -> None:
         This method configures the release version, environment, tracing, and
         enables Sentry's logging integration.
         """
-        if not CONFIG.SENTRY_DSN:
+        if not CONFIG.EXTERNAL_SERVICES.SENTRY_DSN:
             logger.warning("No Sentry DSN configured, skipping Sentry setup")
             return
 
@@ -311,11 +310,11 @@ def setup() -> None:
         try:
             sentry_sdk.init(
                 # https://docs.sentry.io/platforms/python/configuration/options/#dsn
-                dsn=CONFIG.SENTRY_DSN,
+                dsn=CONFIG.EXTERNAL_SERVICES.SENTRY_DSN,
                 # https://docs.sentry.io/platforms/python/configuration/options/#release
-                release=CONFIG.BOT_VERSION,
+                release=CONFIG.BOT_INFO.BOT_VERSION,
                 # https://docs.sentry.io/platforms/python/configuration/options/#environment
-                environment=get_current_env(),
+                environment="development" if CONFIG.DEBUG else "production",
                 integrations=[
                     AsyncioIntegration(),
                     LoguruIntegration(),
@@ -327,10 +326,10 @@ def setup() -> None:
                 send_default_pii=False,
                 # https://docs.sentry.io/platforms/python/configuration/options/#traces_sample_rate
                 # Adjust sampling based on environment - 100% for dev, lower for production
-                traces_sample_rate=1.0 if get_current_env() in ("dev", "development") else 0.1,
+                traces_sample_rate=1.0 if CONFIG.DEBUG else 0.1,
                 # Set profiles_sample_rate to profile transactions.
                 # We recommend adjusting this value in production.
-                profiles_sample_rate=1.0 if get_current_env() in ("dev", "development") else 0.01,
+                profiles_sample_rate=1.0 if CONFIG.DEBUG else 0.01,
                 # https://docs.sentry.io/platforms/python/configuration/filtering/#using-before-send
                 before_send=SentryManager._before_send,
                 before_send_transaction=SentryManager._before_send_transaction,

src/tux/services/tracing.py

@@ -26,6 +26,8 @@
 from discord.ext import commands
 from loguru import logger
 
+from tux.shared.config import CONFIG
+
 # Type variables for better type hints with generic functions
 P = ParamSpec("P")
 T = TypeVar("T")
@@ -574,10 +576,7 @@ def enhanced_span(op: str, name: str = "", **initial_data: Any) -> Generator[Dum
         return
 
     # In production, skip tracing for certain frequent operations
-    env = initial_data.get("environment", "development")
-    if env not in ("dev", "development") and any(
-        skip_term in name.lower() for skip_term in ["safe_get_attr", "connect_or_create"]
-    ):
+    if not CONFIG.DEBUG and any(skip_term in name.lower() for skip_term in ["safe_get_attr", "connect_or_create"]):
         yield DummySpan()
         return
 

src/tux/services/wrappers/github.py

@@ -9,7 +9,7 @@
 )
 from loguru import logger
 
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 from tux.shared.exceptions import (
     APIConnectionError,
     APIPermissionError,
@@ -20,13 +20,41 @@
 
 class GithubService:
     def __init__(self) -> None:
+        # Check if GitHub configuration is available
+        if not CONFIG.EXTERNAL_SERVICES.GITHUB_APP_ID:
+            msg = "GitHub App ID is not configured. Please set EXTERNAL_SERVICES__GITHUB_APP_ID in your .env file."
+            raise ValueError(
+                msg,
+            )
+
+        if not CONFIG.EXTERNAL_SERVICES.GITHUB_PRIVATE_KEY:
+            msg = "GitHub private key is not configured. Please set EXTERNAL_SERVICES__GITHUB_PRIVATE_KEY in your .env file."
+            raise ValueError(
+                msg,
+            )
+
+        if not CONFIG.EXTERNAL_SERVICES.GITHUB_INSTALLATION_ID:
+            msg = "GitHub installation ID is not configured. Please set EXTERNAL_SERVICES__GITHUB_INSTALLATION_ID in your .env file."
+            raise ValueError(
+                msg,
+            )
+
+        # Try to convert installation ID to int, with better error handling
+        try:
+            installation_id = int(CONFIG.EXTERNAL_SERVICES.GITHUB_INSTALLATION_ID)
+        except ValueError as e:
+            msg = "GitHub installation ID must be a valid integer. Please check EXTERNAL_SERVICES__GITHUB_INSTALLATION_ID in your .env file."
+            raise ValueError(
+                msg,
+            ) from e
+
         self.github = GitHub(
             AppInstallationAuthStrategy(
-                CONFIG.GITHUB_APP_ID,
-                CONFIG.GITHUB_PRIVATE_KEY,
-                int(CONFIG.GITHUB_INSTALLATION_ID),
-                CONFIG.GITHUB_CLIENT_ID,
-                CONFIG.GITHUB_CLIENT_SECRET,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_APP_ID,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_PRIVATE_KEY,
+                installation_id,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_CLIENT_ID,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_CLIENT_SECRET,
             ),
         )
 
@@ -41,8 +69,8 @@ async def get_repo(self) -> FullRepository:
         """
         try:
             response: Response[FullRepository] = await self.github.rest.repos.async_get(
-                CONFIG.GITHUB_REPO_OWNER,
-                CONFIG.GITHUB_REPO,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_OWNER,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO,
             )
 
             repo: FullRepository = response.parsed_data
@@ -53,7 +81,7 @@ async def get_repo(self) -> FullRepository:
                 if e.response.status_code == 404:
                     raise APIResourceNotFoundError(
                         service_name="GitHub",
-                        resource_identifier=f"{CONFIG.GITHUB_REPO_OWNER}/{CONFIG.GITHUB_REPO}",
+                        resource_identifier=f"{CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_OWNER}/{CONFIG.EXTERNAL_SERVICES.GITHUB_REPO}",
                     ) from e
                 if e.response.status_code == 403:
                     raise APIPermissionError(service_name="GitHub") from e
@@ -87,8 +115,8 @@ async def create_issue(self, title: str, body: str) -> Issue:
         """
         try:
             response: Response[Issue] = await self.github.rest.issues.async_create(
-                CONFIG.GITHUB_REPO_OWNER,
-                CONFIG.GITHUB_REPO,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_OWNER,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO,
                 title=title,
                 body=body,
             )
@@ -131,8 +159,8 @@ async def create_issue_comment(self, issue_number: int, body: str) -> IssueComme
         """
         try:
             response: Response[IssueComment] = await self.github.rest.issues.async_create_comment(
-                CONFIG.GITHUB_REPO_OWNER,
-                CONFIG.GITHUB_REPO,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_OWNER,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO,
                 issue_number,
                 body=body,
             )
@@ -177,8 +205,8 @@ async def close_issue(self, issue_number: int) -> Issue:
         """
         try:
             response: Response[Issue] = await self.github.rest.issues.async_update(
-                CONFIG.GITHUB_REPO_OWNER,
-                CONFIG.GITHUB_REPO,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_OWNER,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO,
                 issue_number,
                 state="closed",
             )
@@ -224,8 +252,8 @@ async def get_issue(self, issue_number: int) -> Issue:
 
         try:
             response: Response[Issue] = await self.github.rest.issues.async_get(
-                CONFIG.GITHUB_REPO_OWNER,
-                CONFIG.GITHUB_REPO,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_OWNER,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO,
                 issue_number,
             )
 
@@ -263,8 +291,8 @@ async def get_open_issues(self) -> list[Issue]:
 
         try:
             response: Response[list[Issue]] = await self.github.rest.issues.async_list_for_repo(
-                CONFIG.GITHUB_REPO_OWNER,
-                CONFIG.GITHUB_REPO,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_OWNER,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO,
                 state="open",
             )
 
@@ -297,8 +325,8 @@ async def get_closed_issues(self) -> list[Issue]:
 
         try:
             response: Response[list[Issue]] = await self.github.rest.issues.async_list_for_repo(
-                CONFIG.GITHUB_REPO_OWNER,
-                CONFIG.GITHUB_REPO,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_OWNER,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO,
                 state="closed",
             )
 
@@ -331,8 +359,8 @@ async def get_open_pulls(self) -> list[PullRequestSimple]:
 
         try:
             response: Response[list[PullRequestSimple]] = await self.github.rest.pulls.async_list(
-                CONFIG.GITHUB_REPO_OWNER,
-                CONFIG.GITHUB_REPO,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_OWNER,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO,
                 state="open",
             )
 
@@ -365,8 +393,8 @@ async def get_closed_pulls(self) -> list[PullRequestSimple]:
 
         try:
             response: Response[list[PullRequestSimple]] = await self.github.rest.pulls.async_list(
-                CONFIG.GITHUB_REPO_OWNER,
-                CONFIG.GITHUB_REPO,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_OWNER,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO,
                 state="closed",
             )
 
@@ -404,8 +432,8 @@ async def get_pull(self, pr_number: int) -> PullRequest:
 
         try:
             response: Response[PullRequest] = await self.github.rest.pulls.async_get(
-                CONFIG.GITHUB_REPO_OWNER,
-                CONFIG.GITHUB_REPO,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_OWNER,
+                CONFIG.EXTERNAL_SERVICES.GITHUB_REPO,
                 pr_number,
             )