t-bug-catcher 0.6.13__tar.gz → 1.1.1.2766__tar.gz

t_bug_catcher-1.1.1.2766/MANIFEST.in

@@ -0,0 +1 @@
+include *.py

t_bug_catcher-1.1.1.2766/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: t-bug-catcher
+Version: 1.1.1.2766
+Requires-Python: >=3.12,<3.14
+Requires-Dist: bugsnag==4.8.0
+Requires-Dist: requests==2.32.5
+Requires-Dist: retry==0.9.2
+Dynamic: requires-dist
+Dynamic: requires-python

t_bug_catcher-1.1.1.2766/backend_shim.py

@@ -0,0 +1,31 @@
+
+# DO NOT EDIT THIS FILE -- AUTOGENERATED BY PANTS
+
+import errno
+import os
+import setuptools.build_meta
+
+backend = setuptools.build_meta.__legacy__
+
+dist_dir = "dist/"
+build_wheel = True
+build_sdist = True
+wheel_config_settings = {
+}
+sdist_config_settings = {
+}
+
+# Python 2.7 doesn't have the exist_ok arg on os.makedirs().
+try:
+    os.makedirs(dist_dir)
+except OSError as e:
+    if e.errno != errno.EEXIST:
+        raise
+
+wheel_path = backend.build_wheel(dist_dir, wheel_config_settings) if build_wheel else None
+sdist_path = backend.build_sdist(dist_dir, sdist_config_settings) if build_sdist else None
+
+if wheel_path:
+    print("wheel: {wheel_path}".format(wheel_path=wheel_path))
+if sdist_path:
+    print("sdist: {sdist_path}".format(sdist_path=sdist_path))

t_bug_catcher-1.1.1.2766/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

t_bug_catcher-1.1.1.2766/setup.py

@@ -0,0 +1,27 @@
+
+# DO NOT EDIT THIS FILE -- AUTOGENERATED BY PANTS
+# Target: libraries/t_bug_catcher:t-bug-catcher
+
+from setuptools import setup
+
+setup(**{
+    'install_requires': (
+        'bugsnag==4.8.0',
+        'requests==2.32.5',
+        'retry==0.9.2',
+    ),
+    'name': 't-bug-catcher',
+    'namespace_packages': (
+    ),
+    'package_data': {
+        't_bug_catcher': (
+            'py.typed',
+        ),
+    },
+    'packages': (
+        't_bug_catcher',
+        't_bug_catcher.utils',
+    ),
+    'python_requires': '>=3.12,<3.14',
+    'version': '1.1.1.2766',
+})

{t_bug_catcher-0.6.13 → t_bug_catcher-1.1.1.2766}/t_bug_catcher/__init__.py

@@ -1,20 +1,15 @@
 """Top-level package for t-bug-catcher."""
 
-__author__ = """Thoughtful"""
-__email__ = "support@thoughtful.ai"
-# fmt: off
-__version__ = '0.6.13'
-# fmt: on
-
 from .bug_catcher import (
-    configure,
-    report_error,
     attach_file_to_exception,
+    configure,
+    get_errors_count,
     install_sys_hook,
+    report_error,
     uninstall_sys_hook,
-    get_errors_count,
 )
 
+
 __all__ = [
     "configure",
     "report_error",

{t_bug_catcher-0.6.13 → t_bug_catcher-1.1.1.2766}/t_bug_catcher/bug_catcher.py

@@ -1,10 +1,10 @@
 """JiraPoster class for interacting with the Jira API."""
 
 import inspect
-import os
 import sys
+
+from pathlib import Path
 from types import TracebackType
-from typing import List, Optional
 
 from .bug_snag import BugSnag
 from .config import CONFIG
@@ -29,10 +29,10 @@ class Configurator:
         login: str,
         api_token: str,
         project_key: str,
-        webhook_url: Optional[str] = None,
-        webhook_secret: Optional[str] = None,
-        default_assignee: Optional[str] = None,
-    ):
+        webhook_url: str | None = None,
+        webhook_secret: str | None = None,
+        default_assignee: str | None = None,
+    ) -> None:
         """Configures the JiraPoster and BugSnag classes.
 
         Args:
@@ -55,7 +55,7 @@ class Configurator:
             default_assignee=default_assignee,
         )
 
-    def bugsnag(self, api_key: str):
+    def bugsnag(self, api_key: str) -> None:
         """Configures the BugSnag class.
 
         Args:
@@ -67,12 +67,12 @@ class Configurator:
         self.__bug_snag_configured = self.__bug_snag.config(api_key=api_key)
 
     @property
-    def is_jira_configured(self):
+    def is_jira_configured(self) -> bool:
         """Checks if the JiraPoster class has been configured."""
         return self.__jira_configured
 
     @property
-    def is_bugsnag_configured(self):
+    def is_bugsnag_configured(self) -> bool:
         """Checks if the BugSnag class has been configured."""
         return self.__bug_snag_configured
 
@@ -98,24 +98,24 @@ class BugCatcher:
         self.__errors_count = 0
 
     @property
-    def configure(self):
+    def configure(self) -> Configurator:
         """Configures the JiraPoster and BugSnag classes."""
         return self.__configurator
 
-    def get_errors_count(self):
+    def get_errors_count(self) -> int:
         """Returns the number of exceptions reported."""
         return self.__errors_count
 
     def report_error(
         self,
-        exception: Optional[Exception] = None,
-        description: Optional[str] = None,
-        metadata: Optional[dict] = None,
-        attachments: Optional[List] = None,
-        assignee: Optional[str] = None,
-        team: Optional[str] = None,
-        group_by: Optional[str] = None,
-    ):
+        exception: Exception | None = None,
+        description: str | None = None,
+        metadata: dict | None = None,
+        attachments: list | None = None,
+        assignee: str | None = None,
+        team: str | None = None,
+        group_by: str | None = None,
+    ) -> None:
         """Reports an error to the Jira project.
 
         Args:
@@ -134,8 +134,13 @@ class BugCatcher:
             logger.warning("Reporting an error is not supported in local environment.")
             return
 
-        if not self.__configurator.is_jira_configured and not self.__configurator.is_bugsnag_configured:
-            logger.warning("Jira and BugSnag are not configured. Please configure them before reporting an error.")
+        if (
+            not self.__configurator.is_jira_configured
+            and not self.__configurator.is_bugsnag_configured
+        ):
+            logger.warning(
+                "Jira and BugSnag are not configured. Please configure them before reporting an error."
+            )
             return
 
         if not exception:
@@ -197,19 +202,21 @@ class BugCatcher:
             )
 
         frames = get_frames(exception.__traceback__)
-        exc_info = f"{os.path.basename(frames[-1].filename)}:{frames[-1].name}:{frames[-1].lineno}"
+        exc_info = (
+            f"{Path(frames[-1].filename).name}:{frames[-1].name}:{frames[-1].lineno}"
+        )
         exception.handled_error = exc_info
         logger.info(f"Exception {exc_info} reported.")
         self.__errors_count += 1
 
     def report_error_to_jira(
         self,
-        exception: Optional[Exception] = None,
-        assignee: Optional[str] = None,
-        attachments: Optional[List] = None,
-        metadata: Optional[dict] = None,
-        additional_info: Optional[str] = None,
-    ):
+        exception: Exception | None = None,
+        assignee: str | None = None,
+        attachments: list | None = None,
+        metadata: dict | None = None,
+        additional_info: str | None = None,
+    ) -> None:
         """Creates a Jira issue with the given attachments.
 
         Args:
@@ -235,7 +242,9 @@ class BugCatcher:
             metadata=metadata,
         )
 
-    def report_error_to_bugsnag(self, exception: Optional[Exception] = None, metadata: Optional[dict] = None):
+    def report_error_to_bugsnag(
+        self, exception: Exception | None = None, metadata: dict | None = None
+    ) -> None:
         """Sends an error to BugSnag.
 
         Args:
@@ -271,7 +280,9 @@ class BugCatcher:
         else:
             exception.custom_attachments = [attachment]
 
-    def __excepthook(self, exc_type: type, exc_value: Exception, exc_traceback: TracebackType) -> None:
+    def __excepthook(
+        self, exc_type: type, exc_value: Exception, exc_traceback: TracebackType
+    ) -> None:
         """Handles unhandled exceptions.
 
         Args:
@@ -286,8 +297,13 @@ class BugCatcher:
             logger.warning("Reporting an error is not supported in local environment.")
             return
 
-        if not self.__configurator.is_jira_configured and not self.__configurator.is_bugsnag_configured:
-            logger.warning("Jira and BugSnag are not configured. Please configure them before reporting an error.")
+        if (
+            not self.__configurator.is_jira_configured
+            and not self.__configurator.is_bugsnag_configured
+        ):
+            logger.warning(
+                "Jira and BugSnag are not configured. Please configure them before reporting an error."
+            )
             return
 
         handled_error = getattr(exc_value, "handled_error", None)
@@ -302,11 +318,13 @@ class BugCatcher:
         if self.__configurator.is_bugsnag_configured:
             self.__bug_snag.report_unhandled_error(exc_type, exc_value, exc_traceback)
         frames = get_frames(exc_value.__traceback__)
-        exc_info = f"{os.path.basename(frames[-1].filename)}:{frames[-1].name}:{frames[-1].lineno}"
+        exc_info = (
+            f"{Path(frames[-1].filename).name}:{frames[-1].name}:{frames[-1].lineno}"
+        )
         logger.info(f"Exception {exc_info} reported.")
         self.__errors_count += 1
 
-    def __get_sys_hook_attribute(self, attribute: str = "bug_catcher_client"):
+    def __get_sys_hook_attribute(self, attribute: str = "bug_catcher_client") -> None:
         """Checks if the system hook is installed.
 
         Args:
@@ -317,14 +335,14 @@ class BugCatcher:
         """
         return getattr(sys.excepthook, attribute, None)
 
-    def install_sys_hook(self):
+    def install_sys_hook(self) -> None:
         """Installs a system hook to handle unhandled exceptions."""
         if self.__get_sys_hook_attribute():
             return
 
         self.__sys_excepthook = sys.excepthook
 
-        def excepthook(*exc_info):
+        def excepthook(*exc_info) -> None:
             self.__excepthook(*exc_info)
 
             if self.__sys_excepthook:
@@ -333,7 +351,7 @@ class BugCatcher:
         sys.excepthook = excepthook
         sys.excepthook.bug_catcher_client = self
 
-    def uninstall_sys_hook(self):
+    def uninstall_sys_hook(self) -> None:
         """Uninstalls the system hook to handle unhandled exceptions."""
         client = self.__get_sys_hook_attribute()
 

t_bug_catcher-1.1.1.2766/t_bug_catcher/bug_snag.py

@@ -0,0 +1,136 @@
+import os
+
+import bugsnag
+import requests
+
+from .config import CONFIG
+from .utils import logger
+from .workitems import variables
+
+
+bugsnag.configuration.auto_notify = False
+
+# Default error message for BugSnag reports
+_DEFAULT_ERROR_MESSAGE = "An error occurred during execution"
+
+
+class BugSnag:
+    """BugSnag class for interacting with the BugSnag API."""
+
+    def __init__(self):
+        """Initializes the BugSnag class."""
+        pass
+
+    @staticmethod
+    def _create_generic_error(exception_type: type) -> Exception:
+        """Creates a generic error of the given type with fallback handling.
+
+        Attempts to create an exception of the specified type with the default message.
+        If that fails, tries to create an empty exception of the same type.
+        If both fail, falls back to a generic Exception with the default message.
+
+        Args:
+            exception_type (type): The type of exception to create.
+
+        Returns:
+            Exception: An exception instance of the requested type (or Exception as fallback).
+        """
+        # Try to create an exception of the same type with the default message
+        # If that fails, try with no arguments (empty exception)
+        # If both fail, fall back to using Exception
+        try:
+            error = exception_type(_DEFAULT_ERROR_MESSAGE)
+        except (TypeError, ValueError):
+            try:
+                # Try instantiating with no arguments (empty exception of same type)
+                error = exception_type()
+            except (TypeError, ValueError):
+                # Fall back to Exception if the custom exception type can't be instantiated
+                error = Exception(_DEFAULT_ERROR_MESSAGE)
+        return error
+
+    def config(self, api_key: str) -> bool:
+        """Configures the BugSnag class.
+
+        Args:
+            api_key (str): The API key for the BugSnag account.
+
+        Returns:
+            bool: True if the configuration was successful, False otherwise.
+        """
+        try:
+            bugsnag.configure(
+                api_key=api_key, release_stage=CONFIG.ENVIRONMENT, auto_notify=False
+            )
+            run_id = os.environ.get("RC_PROCESS_RUN_ID", "unknown")
+            bugsnag.add_metadata_tab(
+                "Metadata",
+                {
+                    "run_url": variables.get("processRunUrl", ""),
+                    "run_by": variables.get("userEmail", ""),
+                    "run_id": run_id,
+                },
+            )
+            response = requests.request(
+                "POST",
+                "https://otlp.bugsnag.com/v1/traces",
+                headers={
+                    "Content-Type": "application/json",
+                    "Bugsnag-Api-Key": api_key,
+                    "Bugsnag-Payload-Version": "4",
+                    "Bugsnag-Span-Sampling": "True",
+                },
+                data='{"message": "test"}',
+                timeout=None,  # noqa: S113
+            )
+            if response.status_code not in [200, 201, 202, 204]:
+                logger.warning(f"Error connecting to Bugsnag: {response.text}")
+                return False
+            return True
+        except (requests.RequestException, ValueError, KeyError) as ex:
+            logger.warning(f"Failed to configure Bugsnag: {ex}")
+            return False
+
+    def report_error(
+        self, exception: Exception | None = None, metadata: dict | None = None
+    ) -> None:
+        """Sends an error to BugSnag.
+
+        Args:
+            exception (Exception, optional): The exception to report.
+            metadata (dict, optional): The metadata to be added to the Bugsnag issue. Defaults to None.
+
+        Returns:
+            None
+        """
+        run_id = os.environ.get("RC_PROCESS_RUN_ID", "unknown")
+        # Use the same exception type as provided, or default to Exception
+        exception_type = type(exception) if exception is not None else Exception
+        error = self._create_generic_error(exception_type)
+
+        bugsnag.notify(
+            error,
+            metadata={"run_id": run_id},
+        )
+
+    def report_unhandled_error(self, exc_type, exc_value, traceback) -> None:
+        """Sends an unhandled exception to BugSnag.
+
+        Args:
+            exc_type (type): The type of the exception.
+            exc_value (Exception): The value of the exception.
+            traceback (traceback): The traceback of the exception.
+
+        Returns:
+            None
+        """
+        run_id = os.environ.get("RC_PROCESS_RUN_ID", "unknown")
+        # Use the same exception type as provided, or default to Exception
+        exception_type = exc_type if exc_type is not None else Exception
+        error = self._create_generic_error(exception_type)
+
+        bugsnag.notify(
+            error,
+            metadata={"run_id": run_id},
+            severity="error",
+        )

{t_bug_catcher-0.6.13 → t_bug_catcher-1.1.1.2766}/t_bug_catcher/config.py

@@ -64,10 +64,12 @@ class Config:
         else variables.get("environment", "local")
     )
 
-    STAGE = metadata.get("process", dict()).get("implementationStage", "")
-    ADMIN_CODE = metadata.get("process", dict()).get("adminCode", "")
-    WORKER_NAME = metadata.get("process", dict()).get("name", "")
-    EMPOWER_URL = metadata.get("process", dict()).get("processRunUrl") or variables.get("processRunUrl")
+    STAGE = metadata.get("process", {}).get("implementationStage", "")
+    ADMIN_CODE = metadata.get("process", {}).get("adminCode", "")
+    WORKER_NAME = metadata.get("process", {}).get("name", "")
+    EMPOWER_URL = metadata.get("process", {}).get("processRunUrl") or variables.get(
+        "processRunUrl"
+    )
 
 
 CONFIG = Config()