t-bug-catcher 0.4.4__tar.gz → 0.4.6__tar.gz

{t_bug_catcher-0.4.4 → t_bug_catcher-0.4.6}/PKG-INFO

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

{t_bug_catcher-0.4.4 → t_bug_catcher-0.4.6}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.4.4
+current_version = 0.4.6
 commit = True
 tag = False
 

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

{t_bug_catcher-0.4.4 → t_bug_catcher-0.4.6}/t_bug_catcher/__init__.py

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

{t_bug_catcher-0.4.4 → t_bug_catcher-0.4.6}/t_bug_catcher/bug_catcher.py

@@ -1,5 +1,6 @@
 """JiraPoster class for interacting with the Jira API."""
 
+import inspect
 import os
 import sys
 from types import TracebackType
@@ -129,11 +130,33 @@ class BugCatcher:
             _, exception, _ = sys.exc_info()
 
         if not isinstance(exception, Exception):
-            logger.warning("Exception must be an instance of Exception.")
+            logger.warning("Implementation error. Incorrect exception type.")
+            inspected_frame = inspect.currentframe().f_back
+            if self.__configurator.is_jira_configured:
+                self.__jira.warning_message(
+                    summary="bug_catcher implementation warning ⚠️",
+                    inspected_frame=inspected_frame,
+                    message=(
+                        "Incorrect exception type. Check the variable that holds the exception "
+                        "and make sure that report_error() in the try/except block is called."
+                    ),
+                    assignee=assignee,
+                )
             return
 
         if not getattr(exception, "__traceback__", None):
-            logger.warning("No traceback available. Please provide a traceback.")
+            logger.warning("Implementation error. No traceback available.")
+            inspected_frame = inspect.currentframe().f_back
+            if self.__configurator.is_jira_configured:
+                self.__jira.warning_message(
+                    summary="bug_catcher implementation warning ⚠️",
+                    inspected_frame=inspected_frame,
+                    message=(
+                        "No traceback is available. Please, use an exception with a traceback in the try/except block. "
+                        "Not just called exceptions."
+                    ),
+                    assignee=assignee,
+                )
             return
 
         handled_error = getattr(exception, "handled_error", None)

{t_bug_catcher-0.4.4 → t_bug_catcher-0.4.6}/t_bug_catcher/jira.py

@@ -2,6 +2,7 @@
 
 import hashlib
 import json
+import linecache
 import os
 import re
 import sys
@@ -375,6 +376,42 @@ class Jira:
             }
         ]
 
+    @staticmethod
+    def __warning_markup(warning_message: str, message: str) -> List[dict]:
+        """Create the error string markup.
+
+        Args:
+            warning_message (str): The warning message.
+
+        Returns:
+            dict: The error string markup.
+        """
+        return [
+            {
+                "type": "panel",
+                "attrs": {"panelType": "warning"},
+                "content": [
+                    {
+                        "type": "paragraph",
+                        "content": [
+                            {
+                                "type": "text",
+                                "text": warning_message,
+                                "marks": [{"type": "code"}],
+                            },
+                        ],
+                    },
+                    {
+                        "type": "paragraph",
+                        "content": [
+                            {"type": "text", "text": "Message: ", "marks": [{"type": "strong"}]},
+                            {"type": "text", "text": message},
+                        ],
+                    },
+                ],
+            }
+        ]
+
     @staticmethod
     def __date_markup() -> List[dict]:
         """Create the date markup.
@@ -671,6 +708,33 @@ class Jira:
             + self.__error_markup(error_id),
         }
 
+    def __create_warning_description_markup(
+        self,
+        warning_message: str,
+        message: str,
+        warning_id: str,
+    ) -> dict:
+        """Create a warning description.
+
+        Args:
+            warning_message (str): The warning message.
+            warning_id (str): The warning ID.
+
+        Returns:
+            dict: A dictionary containing the version, type, and content.
+        """
+        return {
+            "version": 1,
+            "type": "doc",
+            "content": []
+            + self.__warning_markup(warning_message, message)
+            + self.__bot_name_markup()
+            + self.__date_markup()
+            + self.__runlink_markup()
+            + self.__environment_markup()
+            + self.__error_markup(warning_id),
+        }
+
     def __create_transtion_markup(self, issue_status: str) -> dict:
         """Create a transition markup.
 
@@ -850,7 +914,7 @@ class Jira:
         if issue_status.lower() not in ["to do", "open"]:
             self.issue_transition(
                 ticket_id=existing_ticket["id"],
-                transition_id=self._transition_types.get("to do", "open"),
+                transition_id=self._transition_types.get("to do") or self._transition_types.get("open"),
             )
             self.update_comment(
                 ticket_id=existing_ticket["id"],
@@ -962,6 +1026,55 @@ class Jira:
             self.move_ticket_to_board(ticket_id)
         return response
 
+    def warning_message(self, summary: str, inspected_frame, message: str, assignee: Optional[str] = None) -> None:
+        """Create a new ticket with warning message.
+
+        Args:
+            summary (str): The summary of the ticket.
+            inspected_frame (frame): The frame of the warning.
+            assignee (str, optional): The assignee of the ticket. Defaults to None.
+
+        Returns:
+            The response from creating the ticket.
+        """
+        if self._project_key == CONFIG.SUPPORT_BOARD and CONFIG.ADMIN_CODE:
+            summary = CONFIG.ADMIN_CODE + " - " + summary
+
+        warning_id, warning_message = self.__generate_warning_id(inspected_frame)
+
+        existing_ticket = self.filter_tickets(
+            all_tickets=self.get_issues()["issues"],
+            error_id=warning_id,
+        )
+        if existing_ticket:
+            self.__update_existing_ticket(
+                existing_ticket=existing_ticket,
+                summary=summary,
+            )
+            return existing_ticket
+
+        assignee_id = None
+        assignee = assignee if assignee else self._default_assignee
+        if assignee:
+            try:
+                assignee_id = self.__get_assignee(assignee)
+            except Exception as ex:
+                logger.info(f"Failed to get assignee {assignee} due to: {ex}")
+
+        description = self.__create_warning_description_markup(
+            warning_message=warning_message,
+            message=message,
+            warning_id=warning_id,
+        )
+        response = self.__create_new_ticket(
+            summary=summary,
+            description=description,
+            assignee_id=assignee_id,
+            labels=["bug_catcher_warning"],
+        )
+
+        return response
+
     def report_error(
         self,
         exception: Optional[Exception] = None,
@@ -1271,6 +1384,26 @@ class Jira:
         error_id = f"{path}-{exception_chain}-{frames[-1].line}-" f"{exc_type.__module__}-{exc_type.__name__}"
         return hashlib.md5(error_id.encode()).hexdigest()
 
+    @staticmethod
+    def __generate_warning_id(inspected_frame) -> tuple:
+        """Generates an error string ID using the exception, function name, and error string.
+
+        Args:
+            inspected_frame (frame): The frame of the warning.
+
+        Returns:
+            tuple: The generated error string ID and the warning message.
+        """
+        lineno = inspected_frame.f_lineno
+        filename = inspected_frame.f_code.co_filename
+        func = inspected_frame.f_code.co_name
+        line = linecache.getline(filename, lineno).strip()
+        rel_path = os.path.relpath(filename, os.getcwd())
+
+        warning_message = f"{line}\n{rel_path}:{func}:{lineno}"
+        warning_id = hashlib.md5(f"{filename}-{lineno}-{func}-{line}".encode()).hexdigest()
+        return warning_id, warning_message
+
     def __get_assignee(self, assignee: str) -> str:
         """Get assignee Jira user by ID.
 

{t_bug_catcher-0.4.4 → t_bug_catcher-0.4.6}/t_bug_catcher/utils/common.py

@@ -1,3 +1,4 @@
+import copy
 import traceback
 from datetime import date, datetime
 from json import JSONEncoder
@@ -20,21 +21,24 @@ class Encoder(JSONEncoder):
         Returns:
             str: The json string.
         """
+        object_copy = copy.deepcopy(o)
         try:
-            if hasattr(o, "__dict__"):
+            if hasattr(object_copy, "__dict__"):
                 keys_to_remove = [
-                    key for key in o.__dict__.keys() if any(s in str(key).lower() for s in CONFIG.KEYS_TO_REMOVE)
+                    key
+                    for key in object_copy.__dict__.keys()
+                    if any(s in str(key).lower() for s in CONFIG.KEYS_TO_REMOVE)
                 ]
                 for key in keys_to_remove:
-                    del o.__dict__[key]
-                return {str(key): str(value) for key, value in o.__dict__.items()}
-            if isinstance(o, (datetime, date)):
-                return o.isoformat()
-            if isinstance(o, Path):
-                return str(o)
-            return super().default(self, o)
+                    del object_copy.__dict__[key]
+                return {str(key): str(value) 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(o)
+            return str(object_copy)
 
 
 def get_frames(exc_traceback: TracebackType) -> List:

{t_bug_catcher-0.4.4 → t_bug_catcher-0.4.6}/t_bug_catcher.egg-info/PKG-INFO

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

{t_bug_catcher-0.4.4 → t_bug_catcher-0.4.6}/tests/test_t_bug_catcher.py

@@ -65,7 +65,7 @@ class TestBugCatcher(unittest.TestCase):
                     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.assertEqual(mock_warning.call_count, 2)
 
 
 if __name__ == "__main__":