t-bug-catcher 0.1.6__tar.gz → 0.2.1__tar.gz

{t_bug_catcher-0.1.6 → t_bug_catcher-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: t_bug_catcher
-Version: 0.1.6
+Version: 0.2.1
 Summary: Bug catcher
 Home-page: https://www.thoughtful.ai/
 Author: Thoughtful

{t_bug_catcher-0.1.6 → t_bug_catcher-0.2.1}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.6
+current_version = 0.2.1
 commit = True
 tag = False
 

{t_bug_catcher-0.1.6 → t_bug_catcher-0.2.1}/setup.py

@@ -26,7 +26,7 @@ setup(
     packages=find_packages(include=["t_bug_catcher", "t_bug_catcher.*"]),
     test_suite="tests",
     url="https://www.thoughtful.ai/",
-    version="0.1.6",
+    version="0.2.1",
     zip_safe=False,
     install_requires=install_requirements,
 )

{t_bug_catcher-0.1.6 → t_bug_catcher-0.2.1}/t_bug_catcher/__init__.py

@@ -3,7 +3,7 @@
 __author__ = """Thoughtful"""
 __email__ = "support@thoughtful.ai"
 # fmt: off
-__version__ = '0.1.6'
+__version__ = '0.2.1'
 # fmt: on
 
 from .bug_catcher import (
@@ -12,6 +12,8 @@ from .bug_catcher import (
     report_error_to_jira,
     report_error_to_bugsnag,
     attach_file_to_exception,
+    install_sys_hook,
+    uninstall_sys_hook,
 )
 
 __all__ = [
@@ -20,4 +22,6 @@ __all__ = [
     "report_error_to_jira",
     "report_error_to_bugsnag",
     "attach_file_to_exception",
+    "install_sys_hook",
+    "uninstall_sys_hook",
 ]

{t_bug_catcher-0.1.6 → t_bug_catcher-0.2.1}/t_bug_catcher/bug_catcher.py

@@ -1,11 +1,15 @@
 """JiraPoster class for interacting with the Jira API."""
 
+import os
+import sys
+from types import TracebackType
 from typing import List, Optional
 
 from .bug_snag import BugSnag
+from .config import CONFIG
 from .jira import Jira
 from .utils import logger
-from .workitems import variables
+from .utils.common import get_frames
 
 
 class Configurator:
@@ -24,6 +28,7 @@ class Configurator:
         api_token: str,
         project_key: str,
         webhook_url: Optional[str] = None,
+        default_assignee: Optional[str] = None,
     ):
         """Configures the JiraPoster and BugSnag classes.
 
@@ -32,6 +37,7 @@ class Configurator:
             api_token (str): The API token for the Jira account.
             project_key (str): The key of the Jira project.
             webhook_url (str, optional): The webhook URL for the Jira project. Defaults to None.
+            default_assignee (str, optional): The default assignee for the Jira project. Defaults to None.
 
         Returns:
             None
@@ -41,6 +47,7 @@ class Configurator:
             api_token=api_token,
             project_key=project_key,
             webhook_url=webhook_url,
+            default_assignee=default_assignee,
         )
 
     def bugsnag(self, api_key: str):
@@ -81,6 +88,7 @@ class BugCatcher:
         self.__jira: Jira = Jira()
         self.__bug_snag: BugSnag = BugSnag()
         self.__configurator: Configurator = Configurator(self.__jira, self.__bug_snag)
+        self.__sys_excepthook = None
 
     @property
     def configure(self):
@@ -107,7 +115,7 @@ class BugCatcher:
         Returns:
             None
         """
-        if variables.get("environment", "local") == "local":
+        if CONFIG.ENVIRONMENT.lower() == "local":
             logger.warning("Reporting an error is not supported in local environment.")
             return
 
@@ -115,6 +123,14 @@ class BugCatcher:
             logger.warning("Jira and BugSnag are not configured. Please configure them before reporting an error.")
             return
 
+        if not exception:
+            _, exception, _ = sys.exc_info()
+
+        handled_error = getattr(exception, "handled_error", None)
+        if handled_error:
+            logger.warning(f"Exception {handled_error} already reported.")
+            return
+
         if self.__configurator.is_jira_configured:
             self.__jira.report_error(
                 exception=exception,
@@ -130,6 +146,10 @@ class BugCatcher:
                 metadata=metadata,
             )
 
+        frames = get_frames(exception.__traceback__)
+        exc_info = f"{os.path.basename(frames[-1].filename)}:{frames[-1].name}:{frames[-1].lineno}"
+        exception.handled_error = exc_info
+
     def report_error_to_jira(
         self,
         exception: Optional[Exception] = None,
@@ -151,6 +171,10 @@ class BugCatcher:
             None
 
         """
+        if CONFIG.ENVIRONMENT.lower() == "local":
+            logger.warning("Reporting an error is not supported in local environment.")
+            return
+
         self.__jira.report_error(
             exception=exception,
             assignee=assignee,
@@ -170,6 +194,10 @@ class BugCatcher:
             None
 
         """
+        if CONFIG.ENVIRONMENT.lower() == "local":
+            logger.warning("Reporting an error is not supported in local environment.")
+            return
+
         self.__bug_snag.report_error(
             exception=exception,
             metadata=metadata,
@@ -191,11 +219,78 @@ class BugCatcher:
         else:
             exception.custom_attachments = [attachment]
 
+    def __excepthook(self, exc_type: type, exc_value: Exception, exc_traceback: TracebackType) -> None:
+        """Handles unhandled exceptions.
+
+        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
+        """
+        if CONFIG.ENVIRONMENT.lower() == "local":
+            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.")
+            return
+
+        handled_error = getattr(exc_value, "handled_error", None)
+        if handled_error:
+            logger.warning(f"Exception {handled_error} already reported.")
+            return
+
+        if self.__configurator.is_jira_configured:
+            self.__jira.report_unhandled_error(exc_type, exc_value, exc_traceback)
+        if self.__configurator.is_bugsnag_configured:
+            self.__bug_snag.report_unhandled_error(exc_type, exc_value, exc_traceback)
+
+    def __get_sys_hook_attribute(self, attribute: str = "bug_catcher_client"):
+        """Checks if the system hook is installed.
+
+        Args:
+            attribute (str, optional): The attribute to check. Defaults to "bug_catcher_client".
+
+        Returns:
+            The attribute of the system hook if it is installed, otherwise None.
+        """
+        return getattr(sys.excepthook, attribute, None)
+
+    def install_sys_hook(self):
+        """Installs a system hook to handle unhandled exceptions."""
+        if self.__get_sys_hook_attribute():
+            return
+
+        self.__sys_excepthook = sys.excepthook
+
+        def excepthook(*exc_info):
+            self.__excepthook(*exc_info)
+
+            if self.__sys_excepthook:
+                self.__sys_excepthook(*exc_info)
+
+        sys.excepthook = excepthook
+        sys.excepthook.bug_catcher_client = self
+
+    def uninstall_sys_hook(self):
+        """Uninstalls the system hook to handle unhandled exceptions."""
+        client = self.__get_sys_hook_attribute()
+
+        if client is self and self.__sys_excepthook:
+            sys.excepthook = self.__sys_excepthook
+            self.__sys_excepthook = None
+
 
 __bug_catcher = BugCatcher()
+__bug_catcher.install_sys_hook()
 
 configure = __bug_catcher.configure
 report_error = __bug_catcher.report_error
 attach_file_to_exception = __bug_catcher.attach_file_to_exception
 report_error_to_jira = __bug_catcher.report_error_to_jira
 report_error_to_bugsnag = __bug_catcher.report_error_to_bugsnag
+install_sys_hook = __bug_catcher.install_sys_hook
+uninstall_sys_hook = __bug_catcher.uninstall_sys_hook

t_bug_catcher-0.2.1/t_bug_catcher/bug_snag.py

@@ -0,0 +1,92 @@
+import sys
+from datetime import datetime
+from typing import Optional
+
+import bugsnag
+import requests
+
+from .config import CONFIG
+from .utils import logger
+from .workitems import variables
+
+bugsnag.configuration.auto_notify = False
+
+
+class BugSnag:
+    """BugSnag class for interacting with the BugSnag API."""
+
+    def __init__(self):
+        """Initializes the BugSnag class."""
+        pass
+
+    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)
+            bugsnag.add_metadata_tab(
+                "Metadata",
+                {
+                    "run_url": variables.get("processRunUrl", ""),
+                    "run_by": variables.get("userEmail", ""),
+                },
+            )
+            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-Sent-At": f"{datetime.now().strftime('%Y-%m-%dT%H:%M:%S.%f')}",
+                    "Bugsnag-Span-Sampling": "True",
+                },
+                data='{"message": "test"}',
+            )
+            if response.status_code not in [200, 201, 202, 204]:
+                logger.warning(f"Error connecting to Bugsnag: {response.text}")
+                return False
+            return True
+        except Exception as ex:
+            logger.warning(f"Failed to configure Bugsnag: {ex}")
+            return False
+
+    def report_error(self, exception: Optional[Exception] = None, metadata: Optional[dict] = 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
+        """
+        if not exception:
+            _, exception, _ = sys.exc_info()
+        if isinstance(metadata, dict):
+            bugsnag.notify(exception=exception, metadata={"special_info": metadata})
+            return
+        if metadata is None:
+            bugsnag.notify(exception=exception)
+            return
+        logger.warning(f"Incorrect type of metadata: {type(metadata)}")
+        bugsnag.notify(exception=exception)
+
+    def report_unhandled_error(self, exc_type, exc_value, traceback):
+        """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
+        """
+        bugsnag.notify((exc_type, exc_value, traceback), severity="error")

t_bug_catcher-0.2.1/t_bug_catcher/config.py

@@ -0,0 +1,29 @@
+import os
+
+from .workitems import variables
+
+
+class Config:
+    """Config class for configuring the application."""
+
+    class LIMITS:
+        """Limits class for configuring the application."""
+
+        MAX_ATTACHMENTS: int = 5
+        MAX_ISSUE_ATTACHMENTS: int = 100
+        MAX_DESCRIPTION_LENGTH: int = 250
+
+    RC_RUN_LINK = (
+        f"https://cloud.robocorp.com/organizations/{os.environ.get('RC_ORGANIZATION_ID')}"
+        f"/workspaces/{os.environ.get('RC_WORKSPACE_ID')}/processes"
+        f"/{os.environ.get('RC_PROCESS_ID')}/runs/{os.environ.get('RC_PROCESS_RUN_ID')}/"
+    )
+
+    ENVIRONMENT = (
+        "robocloud"
+        if not variables.get("environment") and os.environ.get("RC_PROCESS_RUN_ID")
+        else variables.get("environment", "local")
+    )
+
+
+CONFIG = Config()