t-bug-catcher 0.5.1__tar.gz → 0.5.3__tar.gz

{t_bug_catcher-0.5.1 → t_bug_catcher-0.5.3}/PKG-INFO

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

{t_bug_catcher-0.5.1 → t_bug_catcher-0.5.3}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.5.1
+current_version = 0.5.3
 commit = True
 tag = False
 

{t_bug_catcher-0.5.1 → t_bug_catcher-0.5.3}/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.5.1",
+    version="0.5.3",
     zip_safe=False,
     install_requires=install_requirements,
     include_package_data=True,

{t_bug_catcher-0.5.1 → t_bug_catcher-0.5.3}/t_bug_catcher/__init__.py

@@ -3,7 +3,7 @@
 __author__ = """Thoughtful"""
 __email__ = "support@thoughtful.ai"
 # fmt: off
-__version__ = '0.5.1'
+__version__ = '0.5.3'
 # fmt: on
 
 from .bug_catcher import (

{t_bug_catcher-0.5.1 → t_bug_catcher-0.5.3}/t_bug_catcher/bug_catcher.py

@@ -334,5 +334,8 @@ 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
 
-if CONFIG.STAGE.lower() == "delivery":
-    pre_run_validation = PRE_RUN_VALIDATION
+if not CONFIG.STAGE:
+    logger.warning("Implementation Stage is not configured. Please configure it before running.")
+else:
+    if CONFIG.STAGE.lower() == "delivery":
+        pre_run_validation = PRE_RUN_VALIDATION

{t_bug_catcher-0.5.1 → t_bug_catcher-0.5.3}/t_bug_catcher/config.py

@@ -14,6 +14,8 @@ class Config:
         MAX_DESCRIPTION_LENGTH: int = 250
         SUMMARY_LENGTH: int = 120
         STACK_SCOPE: int = 3
+        STACK_ITEM_LENGTH: int = 100
+        STACK_TEXT_LENGTH: int = 10000
 
     class TICKET_PRIORITIES:
         """Priorities class for configuring the application."""
@@ -25,6 +27,7 @@ class Config:
         LOWEST: str = "5"
 
     SUPPORT_BOARD = "AB"
+    BC_BOARD = "BC"
 
     KEYS_TO_REMOVE = ["credential", "password"]
     BUILD_INFO_FILE = "commit_info.json"
@@ -42,10 +45,16 @@ 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")
+    if 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")
+    else:
+        STAGE = "test"
+        ADMIN_CODE = ""
+        WORKER_NAME = ""
+        EMPOWER_URL = ""
 
 
 CONFIG = Config()

{t_bug_catcher-0.5.1 → t_bug_catcher-0.5.3}/t_bug_catcher/jira.py

@@ -150,13 +150,14 @@ class Jira:
         }
 
     @retry_if_bad_request
-    def get_issues(self) -> dict:
+    def get_issues(self, project_key: Optional[str] = None) -> dict:
         """A function to get the issues using a Jira API.
 
         It updates the headers, sets up a JQL query, specifies additional query parameters,
         makes a GET request to the Jira API, and returns the JSON response.
         """
-        jql_query = f'project = "{self._project_key}"'
+        project_key = project_key or self._project_key
+        jql_query = f'project = "{project_key}"'
 
         # Specify additional query parameters if needed
         query_params = {"jql": jql_query, "maxResults": 100}  # Adjust as needed
@@ -210,6 +211,7 @@ class Jira:
         summary: str,
         description: dict,
         issue_type: str,
+        project_key: Optional[str] = None,
         assignee: Optional[str] = None,
         labels: Optional[list] = None,
         priority: Optional[str] = None,
@@ -227,18 +229,19 @@ class Jira:
         Returns:
             The JSON payload for creating a new issue.
         """
+        project_key = project_key or self._project_key
         fields = {
             "fields": {
                 "assignee": {"id": assignee if assignee else "-1"},
                 "description": description,
                 "issuetype": {"id": issue_type},
-                "project": {"key": self._project_key},
+                "project": {"key": project_key},
                 "summary": summary,
             },
         }
         if labels:
             fields["fields"]["labels"] = labels
-        if self._project_key == CONFIG.SUPPORT_BOARD and CONFIG.ADMIN_CODE:
+        if project_key == CONFIG.SUPPORT_BOARD and CONFIG.ADMIN_CODE:
             fields["fields"]["customfield_10077"] = [CONFIG.ADMIN_CODE]
         if priority:
             fields["fields"]["priority"] = {"id": priority}
@@ -264,7 +267,7 @@ class Jira:
         )
 
     @retry_if_bad_request
-    def __get_issue_types(self) -> dict:
+    def __get_issue_types(self, project_key: Optional[str] = None) -> dict:
         """Get the board information.
 
         Args:
@@ -273,9 +276,10 @@ class Jira:
         Returns:
             dict: The board information
         """
+        project_key = project_key or self._project_key
         response = requests.request(
             "GET",
-            url=self._base_url + f"/rest/api/3/project/{self._project_key}",
+            url=self._base_url + f"/rest/api/3/project/{project_key}",
             headers=self.__get_headers(),
             auth=self._auth,
         )
@@ -850,6 +854,54 @@ class Jira:
             + self.__error_markup(warning_id),
         }
 
+    def __create_internal_error_markup(
+        self,
+        exc_type: type,
+        exc_value: Union[Exception, str],
+        exc_traceback: TracebackType,
+        error_id: str,
+        additional_info: Optional[str] = None,
+        metadata: Optional[dict] = None,
+    ) -> dict:
+        """Create a description with the given trace_back and additional_info.
+
+        Args:
+            exc_type (type): The type of the exception.
+            exc_value (Exception): The exception.
+            exc_traceback (TracebackType): The trace_back.
+            error_id (str): The error ID.
+            additional_info (str, optional): Additional information. Defaults to "".
+            metadata (dict, optional): Additional metadata. Defaults to None.
+
+        Returns:
+            dict: A dictionary containing the version, type, and content.
+        """
+        exc_info = f"{exc_type.__name__}: {exc_value}"
+        frames = get_frames(exc_traceback)
+        error_string: str = frames[-1].line
+        exc_traceback_info: str = (
+            f"Traceback (most recent call last):\n{''.join(traceback.format_tb(exc_traceback))}{exc_info}"
+        )
+        if len(exc_traceback_info) > 30000:
+            exc_traceback_info: str = (
+                f"Traceback (most recent call last):\n{''.join(traceback.format_tb(exc_traceback)[-1])}{exc_info}"
+            )
+
+        return {
+            "version": 1,
+            "type": "doc",
+            "content": []
+            + (self.__error_string_markup(error_string, exc_info) if error_string else [])
+            + self.__bot_name_markup()
+            + self.__date_markup()
+            + self.__runlink_markup()
+            + self.__environment_markup()
+            + (self.__description_markup(additional_info) if additional_info else [])
+            + self.__traceback_markup(exc_traceback_info)
+            + (self.__metadata_markup(metadata) if metadata else [])
+            + self.__error_markup(error_id),
+        }
+
     def __create_transtion_markup(self, issue_status: str) -> dict:
         """Create a transition markup.
 
@@ -1070,6 +1122,7 @@ class Jira:
         self,
         summary: str,
         description: dict,
+        project_key: Optional[str] = None,
         assignee_id: Optional[str] = None,
         attachments: Optional[List] = None,
         labels: Optional[list] = None,
@@ -1088,11 +1141,14 @@ class Jira:
         Returns:
             The response from creating the ticket.
         """
-        if CONFIG.STAGE.lower() == "hypercare":
+        project_key = project_key or self._project_key
+        if project_key == CONFIG.BC_BOARD:
+            issue_type = self.__get_issue_types(project_key=project_key).get("task")
+        elif CONFIG.STAGE and CONFIG.STAGE.lower() == "hypercare":
             issue_type = self._issue_types.get("hypercare") or self._issue_types.get("epic")
-        elif CONFIG.STAGE.lower() == "support":
+        elif CONFIG.STAGE and CONFIG.STAGE.lower() == "support":
             issue_type = self._issue_types.get("support") or self._issue_types.get("epic")
-        elif CONFIG.STAGE.lower() == "delivery" and self._project_key == CONFIG.SUPPORT_BOARD:
+        elif CONFIG.STAGE and CONFIG.STAGE.lower() == "delivery" and project_key == CONFIG.SUPPORT_BOARD:
             issue_type = self._issue_types.get("development") or self._issue_types.get("epic")
         else:
             issue_type = (
@@ -1107,6 +1163,7 @@ class Jira:
             description=description,
             assignee=assignee_id,
             issue_type=issue_type,
+            project_key=project_key,
             labels=labels,
             priority=priority,
         )
@@ -1118,6 +1175,7 @@ class Jira:
                 description=description,
                 assignee=assignee_id,
                 issue_type=issue_type,
+                project_key=project_key,
                 priority=priority,
             )
             response = self.post_ticket(issue=issue)
@@ -1137,7 +1195,7 @@ class Jira:
             for attachment in attachments:
                 if os.path.exists(str(attachment)):
                     self.add_attachment(attachment, ticket_id)
-        if self._webhook_url and self._project_key != CONFIG.SUPPORT_BOARD:
+        if self._webhook_url and project_key != CONFIG.SUPPORT_BOARD:
             self.move_ticket_to_board(ticket_id)
         return response
 
@@ -1248,6 +1306,8 @@ class Jira:
                     additional_info=additional_info,
                     metadata=metadata,
                 )
+                if stack_trace and os.path.exists(stack_trace):
+                    os.remove(stack_trace)
                 return existing_ticket
 
             if stack_trace:
@@ -1270,7 +1330,7 @@ class Jira:
                 metadata=metadata,
             )
 
-            priority = CONFIG.TICKET_PRIORITIES.HIGH if CONFIG.STAGE.lower() == "hypercare" else None
+            priority = CONFIG.TICKET_PRIORITIES.HIGH if CONFIG.STAGE and CONFIG.STAGE.lower() == "hypercare" else None
 
             response = self.__create_new_ticket(
                 summary=summary,
@@ -1284,7 +1344,8 @@ class Jira:
                 os.remove(stack_trace)
             return response
         except Exception as ex:
-            logger.warning(f"Failed to create Jira issue due to: {ex.__class__.__name__}: {ex}")
+            logger.warning(f"Failed to create Jira issue due to: {type(ex)}: {ex}")
+            self.report_internal_error(exception=ex, additional_info="Failed to report error.")
             return False
 
     def report_unhandled_error(
@@ -1314,6 +1375,8 @@ class Jira:
                     existing_ticket=existing_ticket,
                     summary=summary,
                 )
+                if os.path.exists(stack_trace):
+                    os.remove(stack_trace)
                 return existing_ticket
 
             assignee_id = None
@@ -1330,7 +1393,9 @@ class Jira:
                 error_id=error_id,
             )
 
-            priority = CONFIG.TICKET_PRIORITIES.HIGHEST if CONFIG.STAGE.lower() == "hypercare" else None
+            priority = (
+                CONFIG.TICKET_PRIORITIES.HIGHEST if CONFIG.STAGE and CONFIG.STAGE.lower() == "hypercare" else None
+            )
 
             response = self.__create_new_ticket(
                 summary=summary,
@@ -1344,9 +1409,67 @@ class Jira:
                 os.remove(stack_trace)
             return response
         except Exception as ex:
-            logger.warning(f"Failed to create Jira issue due to: {ex.__class__.__name__}: {ex}")
+            logger.warning(f"Failed to create Jira issue due to: {type(ex)}: {ex}")
+            self.report_internal_error(exception=ex, additional_info="Failed to report unhandled error.")
             return False
 
+    def report_internal_error(self, exception: Exception, metadata: dict = None, additional_info: str = None):
+        """Report an internal error to Jira.
+
+        Args:
+            exception (Exception): The exception to be added to the Jira issue.
+
+        Returns:
+            The response from creating the Jira issue.
+        """
+        try:
+            if not exception:
+                _, exception, _ = sys.exc_info()
+
+            attachments = [str(file) for file in Path().cwd().glob("stack_details_*.json")]
+
+            summary = self.__create_summary(type(exception), exception, exception.__traceback__)
+            error_id = self.__generate_error_id(exc_type=type(exception), exc_traceback=exception.__traceback__)
+
+            existing_ticket = self.filter_tickets(
+                all_tickets=self.get_issues(project_key=CONFIG.BC_BOARD)["issues"],
+                error_id=error_id,
+            )
+            if existing_ticket:
+                self.__update_existing_ticket(
+                    existing_ticket=existing_ticket,
+                    attachments=attachments,
+                    summary=summary,
+                    additional_info=additional_info,
+                    metadata=metadata,
+                )
+                for file in attachments:
+                    os.remove(file)
+                return existing_ticket
+
+            description = self.__create_internal_error_markup(
+                exc_type=type(exception),
+                exc_value=exception,
+                exc_traceback=exception.__traceback__,
+                error_id=error_id,
+                additional_info=additional_info,
+                metadata=metadata,
+            )
+
+            response = self.__create_new_ticket(
+                summary=summary,
+                description=description,
+                project_key=CONFIG.BC_BOARD,
+                attachments=attachments,
+                labels=["bug_catcher"],
+            )
+            for file in attachments:
+                os.remove(file)
+            logger.info("Created Bug Catcher issue.")
+            return response
+        except Exception as ex:
+            logger.warning(f"Failed to report Bug Catcher issue due to: {type(ex)}: {ex}")
+
     @retry_if_bad_request
     def add_attachment(self, attachment: str, ticket_id: str) -> Optional[dict]:
         """Uploads an attachment to a Jira ticket.

{t_bug_catcher-0.5.1 → t_bug_catcher-0.5.3}/t_bug_catcher/stack_saver.py

@@ -1,7 +1,6 @@
 import inspect
 import json
 import linecache
-import os
 import re
 import sys
 from datetime import datetime
@@ -99,7 +98,6 @@ class StackSaver:
 
         if secrets:
             logger.warning("Failed to mask credentials")
-            os.remove(file_path)
             raise Exception("Failed to mask credentials")
 
         with open(file_path, "w") as file:

{t_bug_catcher-0.5.1 → t_bug_catcher-0.5.3}/t_bug_catcher/utils/common.py

@@ -26,7 +26,7 @@ class Encoder(json.JSONEncoder):
         try:
             object_copy = copy.deepcopy(o)
         except (TypeError, AttributeError):
-            return str(o)
+            return str(o)[: CONFIG.LIMITS.STACK_TEXT_LENGTH]
         try:
             if hasattr(object_copy, "__dict__"):
                 keys_to_remove = [
@@ -36,14 +36,17 @@ class Encoder(json.JSONEncoder):
                 ]
                 for key in keys_to_remove:
                     del object_copy.__dict__[key]
-                return {str(key): str(value) for key, value in object_copy.__dict__.items()}
+                return {
+                    str(key): str(value)[: CONFIG.LIMITS.STACK_TEXT_LENGTH]
+                    for key, value in object_copy.__dict__.items()
+                }
             if isinstance(object_copy, (datetime, date)):
                 return object_copy.isoformat()
             if isinstance(object_copy, Path):
                 return str(object_copy)
             return super().default(self, object_copy)
         except TypeError:
-            return str(object_copy)
+            return str(object_copy)[: CONFIG.LIMITS.STACK_TEXT_LENGTH]
 
 
 def get_frames(exc_traceback: TracebackType) -> List:
@@ -55,9 +58,12 @@ def get_frames(exc_traceback: TracebackType) -> List:
     Returns:
         List: The frames of the exception.
     """
-    return [
+    frames = [
         frame for frame in traceback.extract_tb(exc_traceback) if "site-packages" not in str(frame.filename).lower()
     ]
+    if not frames:
+        frames = [frame for frame in traceback.extract_tb(exc_traceback)]
+    return frames
 
 
 def convert_keys_to_primitives(data: dict) -> dict:
@@ -71,7 +77,12 @@ def convert_keys_to_primitives(data: dict) -> dict:
     """
     new_dict = {}
     for key, value in data.items():
+        if isinstance(value, list) or isinstance(value, tuple):
+            value = value[: CONFIG.LIMITS.STACK_ITEM_LENGTH]
         if isinstance(value, dict):
+            items_list = list(value.items())
+            sliced_list = items_list[: CONFIG.LIMITS.STACK_ITEM_LENGTH]
+            value = dict(sliced_list)
             new_dict[str(key)] = convert_keys_to_primitives(value)
         else:
             new_dict[str(key)] = value

{t_bug_catcher-0.5.1 → t_bug_catcher-0.5.3}/t_bug_catcher.egg-info/PKG-INFO

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

{t_bug_catcher-0.5.1 → t_bug_catcher-0.5.3}/tests/test_t_bug_catcher.py

@@ -64,8 +64,8 @@ class TestBugCatcher(unittest.TestCase):
                     self.bug_catcher.report_error(exception=ex)
                     actual_call = mock_warning.call_args
                     warning_message = actual_call[0][0]
-                    self.assertTrue(warning_message.startswith("Failed to create Jira issue due to"))
-                    self.assertEqual(mock_warning.call_count, 1)
+                    self.assertTrue(warning_message.startswith("Failed to report Bug Catcher issue due to"))
+                    self.assertEqual(mock_warning.call_count, 2)
 
 
 if __name__ == "__main__":