t-bug-catcher 0.6.0__tar.gz → 0.6.2__tar.gz

{t_bug_catcher-0.6.0 → t_bug_catcher-0.6.2}/PKG-INFO

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

{t_bug_catcher-0.6.0 → t_bug_catcher-0.6.2}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.6.0
+current_version = 0.6.2
 commit = True
 tag = False
 

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

{t_bug_catcher-0.6.0 → t_bug_catcher-0.6.2}/t_bug_catcher/__init__.py

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

{t_bug_catcher-0.6.0 → t_bug_catcher-0.6.2}/t_bug_catcher/bug_catcher.py

@@ -110,6 +110,8 @@ class BugCatcher:
         metadata: Optional[dict] = None,
         attachments: Optional[List] = None,
         assignee: Optional[str] = None,
+        team: Optional[str] = None,
+        group_by: Optional[str] = None,
     ):
         """Reports an error to the Jira project.
 
@@ -119,6 +121,8 @@ class BugCatcher:
             metadata (dict, optional): The metadata to be added to the Jira issue. Defaults to None.
             attachments (List, optional): The attachments to be added to the Jira issue. Defaults to None.
             assignee (str, optional): The assignee to be added to the Jira issue. Defaults to None.
+            team (str, optional): The team to be assigned to the Jira issue. Defaults to None.
+            group_by (str, optional): The group to be assigned to the Jira issue. Defaults to None.
 
         Returns:
             None
@@ -175,10 +179,12 @@ class BugCatcher:
             self.__jira.report_error(
                 exception=exception,
                 assignee=assignee,
+                team=team,
                 attachments=attachments,
                 stack_trace=stack_trace,
                 additional_info=description,
                 metadata=metadata,
+                group_by=group_by,
             )
 
         if self.__configurator.is_bugsnag_configured:
@@ -268,7 +274,7 @@ class BugCatcher:
         Args:
             exc_type (type): The type of the exception.
             exc_value (Exception): The value of the exception.
-            traceback (traceback): The traceback of the exception.
+            exc_traceback (traceback): The traceback of the exception.
 
         Returns:
             None
@@ -289,7 +295,7 @@ class BugCatcher:
         stack_trace = self.__stack_saver.save_stack_trace(exc_value)
 
         if self.__configurator.is_jira_configured:
-            self.__jira.report_unhandled_error(exc_type, exc_value, exc_traceback, stack_trace)
+            self.__jira.report_unhandled_error(exc_value, stack_trace)
         if self.__configurator.is_bugsnag_configured:
             self.__bug_snag.report_unhandled_error(exc_type, exc_value, exc_traceback)
         frames = get_frames(exc_value.__traceback__)

{t_bug_catcher-0.6.0 → t_bug_catcher-0.6.2}/t_bug_catcher/config.py

@@ -1,4 +1,5 @@
 import os
+import socket
 
 from .workitems import metadata, variables
 
@@ -16,6 +17,7 @@ class Config:
         STACK_SCOPE: int = 3
         STACK_ITEM_LENGTH: int = 100
         STACK_TEXT_LENGTH: int = 10000
+        COMMENT_LIMIT: int = 4950
 
     class TICKET_PRIORITIES:
         """Priorities class for configuring the application."""
@@ -32,6 +34,9 @@ class Config:
     KEYS_TO_REMOVE = ["credential", "password"]
     BUILD_INFO_FILE = "commit_info.json"
 
+    HOST = socket.gethostname() if os.name.lower() == "nt" else None
+    UNAME = os.getlogin() if os.name.lower() == "nt" else None
+
     RC_RUN_LINK = (
         f"https://cloud.robocorp.com/organizations/{os.environ.get('RC_ORGANIZATION_ID')}"
         f"/workspaces/{os.environ.get('RC_WORKSPACE_ID')}/processes"

{t_bug_catcher-0.6.0 → t_bug_catcher-0.6.2}/t_bug_catcher/jira.py

@@ -7,6 +7,7 @@ import os
 import re
 import sys
 import traceback
+import zlib
 from datetime import datetime
 from importlib.metadata import version
 from pathlib import Path
@@ -21,7 +22,7 @@ from retry import retry
 from .config import CONFIG
 from .exceptions import BadRequestError
 from .utils import logger
-from .utils.common import Encoder, get_frames, retrieve_build_info
+from .utils.common import Encoder, get_frames, remove_holotree_id, retrieve_build_info
 from .workitems import variables
 
 
@@ -216,6 +217,7 @@ class Jira:
         assignee: Optional[str] = None,
         labels: Optional[list] = None,
         priority: Optional[str] = None,
+        team: Optional[str] = None,
     ) -> str:
         """Generates the issue body payload for creating a new issue.
 
@@ -226,6 +228,7 @@ class Jira:
             issue_type (str): The type of the issue.
             labels (list, optional): The labels of the issue. Defaults to None.
             priority (str, optional): The priority of the issue. Defaults to None.
+            team (str, optional): The team to be assigned to the Jira issue. Defaults to None.
 
         Returns:
             The JSON payload for creating a new issue.
@@ -246,6 +249,8 @@ class Jira:
             fields["fields"]["customfield_10077"] = [CONFIG.ADMIN_CODE]
         if priority:
             fields["fields"]["priority"] = {"id": priority}
+        if team:
+            fields["fields"]["customfield_10001"] = team
         payload = json.dumps(fields)
         return payload
 
@@ -639,6 +644,34 @@ class Jira:
             else []
         )
 
+    @staticmethod
+    def __host_markup() -> List[dict]:
+        """Create the host worker markup.
+
+        Returns:
+            dict: The host worker markup.
+        """
+        return (
+            [
+                {
+                    "type": "paragraph",
+                    "content": [
+                        {
+                            "type": "text",
+                            "text": "Host: ",
+                            "marks": [{"type": "strong"}],
+                        },
+                        {
+                            "type": "text",
+                            "text": f"{CONFIG.HOST} > {CONFIG.UNAME}",
+                        },
+                    ],
+                }
+            ]
+            if CONFIG.HOST and CONFIG.UNAME
+            else []
+        )
+
     @staticmethod
     def __traceback_markup(exc_traceback_info: str) -> List[dict]:
         """Create the traceback markup.
@@ -833,6 +866,7 @@ class Jira:
             + self.__date_markup()
             + self.__runlink_markup()
             + self.__environment_markup()
+            + self.__host_markup()
             + self.__branch_info_markup(exc_traceback)
             + (self.__description_markup(additional_info) if additional_info else [])
             + self.__traceback_markup(exc_traceback_info)
@@ -1121,9 +1155,10 @@ class Jira:
                 else []
             )
 
-        if len(issue.get("fields", {}).get("comment", [])) >= 5000:
+        if len(issue.get("fields", {}).get("comment", [])) >= CONFIG.LIMITS.COMMENT_LIMIT:
             logger.warning(
-                f"Comments for '{issue.get('key')}' were not posted due to exceeding JIRA comments limit (5000)."
+                f"Comments for '{issue.get('key')}' were not posted due to exceeding JIRA comments limit "
+                f"({CONFIG.LIMITS.COMMENT_LIMIT})."
             )
             return
 
@@ -1146,6 +1181,7 @@ class Jira:
         attachments: Optional[List] = None,
         labels: Optional[list] = None,
         priority: Optional[str] = None,
+        team: Optional[str] = None,
     ) -> requests.Response:
         """Create a new ticket.
 
@@ -1156,6 +1192,7 @@ class Jira:
             attachments (List, optional): The list of attachments. Defaults to None.
             labels (List, optional): The list of labels. Defaults to None.
             priority (str, optional): The priority of the ticket. Defaults to None.
+            team (str, optional): The team to be assigned to the Jira issue. Defaults to None.
 
         Returns:
             The response from creating the ticket.
@@ -1185,6 +1222,7 @@ class Jira:
             "project_key": project_key,
             "labels": labels,
             "priority": priority,
+            "team": team,
         }
 
         issue = self.__generate_issue_body(**issue_body)
@@ -1270,20 +1308,24 @@ class Jira:
         self,
         exception: Optional[Exception] = None,
         assignee: Optional[str] = None,
+        team: Optional[str] = None,
         attachments: Union[List, str, Path, None] = None,
         stack_trace: Optional[str] = None,
         metadata: Optional[dict] = None,
         additional_info: Optional[str] = None,
+        group_by: Optional[str] = None,
     ) -> dict:
         """Create a Jira issue with the given attachments.
 
         Args:
             exception (Exception, optional): The exception to be added to the Jira issue.
             assignee (str, optional): The assignee to be added to the Jira issue.
+            team (str, optional): The team to be assigned to the Jira issue. Defaults to None.
             attachments (List, optional): List of attachments to be added to the Jira issue.
             stack_trace (str, optional): Stack trace to be added to the Jira issue.
             metadata (dict, optional): Metadata to be added to the Jira issue.
             additional_info (str, optional): Additional information to be added to the Jira issue.
+            group_by (str, optional): group_by flag to be added to the Jira issue.
 
         Returns:
             The response from creating the Jira issue.
@@ -1309,13 +1351,31 @@ class Jira:
                 logger.warning(f"Only the first {CONFIG.LIMITS.MAX_ATTACHMENTS} attachments were uploaded.")
             attachments = attachments[: CONFIG.LIMITS.MAX_ATTACHMENTS]
 
-            summary = self.__create_summary(type(exception), exception, exception.__traceback__)
-            error_id = self.__generate_error_id(exc_type=type(exception), exc_traceback=exception.__traceback__)
+            error_id = self.__generate_error_id(exception)
+            group_id = self.generate_group_id(group_by)
 
+            all_issues = self.get_issues()["issues"]
             existing_ticket = self.filter_tickets(
-                all_tickets=self.get_issues()["issues"],
+                all_tickets=all_issues,
                 error_id=error_id,
             )
+
+            if group_id:
+                existing_tickets = [
+                    ticket
+                    for ticket in all_issues
+                    if ticket["fields"]["description"] and f"{error_id}-" in ticket["fields"]["description"]
+                ]
+                summary = self.__create_summary(
+                    type(exception),
+                    exception,
+                    exception.__traceback__,
+                    len(existing_tickets) + 1 if existing_tickets else 1,
+                )
+                error_id = f"{error_id}-{group_id}"
+            else:
+                summary = self.__create_summary(type(exception), exception, exception.__traceback__)
+
             if existing_ticket:
                 self.__update_existing_ticket(
                     existing_ticket=existing_ticket,
@@ -1357,6 +1417,7 @@ class Jira:
                 attachments=attachments,
                 labels=["bug_catcher"],
                 priority=priority,
+                team=team,
             )
             if stack_trace and os.path.exists(stack_trace):
                 os.remove(stack_trace)
@@ -1366,23 +1427,20 @@ class Jira:
             self.report_internal_error(exception=ex, additional_info="Failed to report error.")
             return False
 
-    def report_unhandled_error(
-        self, exc_type: type, exc_value: Union[Exception, str], exc_traceback: TracebackType, stack_trace: str = None
-    ):
+    def report_unhandled_error(self, exception: Exception, stack_trace: str = None):
         """Report an unhandled error to Jira.
 
         Args:
             exc_type (type): The type of the exception.
-            exc_value (Exception, str): The value of the exception.
-            exc_traceback (TracebackType): The traceback of the exception.
+            exception (Exception, str): The value of the exception.
             stack_trace (str, optional): Stack trace to be added to the Jira issue.
 
         Returns:
             The response from creating the Jira issue.
         """
         try:
-            summary = self.__create_summary(exc_type, exc_value, exc_traceback)
-            error_id = self.__generate_error_id(exc_type=exc_type, exc_traceback=exc_traceback)
+            summary = self.__create_summary(type(exception), exception, exception.__traceback__)
+            error_id = self.__generate_error_id(exception)
 
             existing_ticket = self.filter_tickets(
                 all_tickets=self.get_issues()["issues"],
@@ -1405,9 +1463,9 @@ class Jira:
                     logger.info(f"Failed to get assignee {self._default_assignee} due to: {ex}")
 
             description = self.__create_description_markup(
-                exc_type=exc_type,
-                exc_value=exc_value,
-                exc_traceback=exc_traceback,
+                exc_type=type(exception),
+                exc_value=exception,
+                exc_traceback=exception.__traceback__,
                 error_id=error_id,
             )
 
@@ -1434,6 +1492,8 @@ class Jira:
 
         Args:
             exception (Exception): The exception to be added to the Jira issue.
+            metadata (dict, optional): The metadata to be added to the Jira issue. Defaults to None.
+            additional_info (str, optional): Additional information to be added to the Jira issue. Defaults to None.
 
         Returns:
             The response from creating the Jira issue.
@@ -1445,7 +1505,7 @@ class Jira:
             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__)
+            error_id = self.__generate_error_id(exception)
 
             existing_ticket = self.filter_tickets(
                 all_tickets=self.get_issues(project_key=CONFIG.BC_BOARD)["issues"],
@@ -1613,30 +1673,47 @@ class Jira:
         for ticket in all_tickets:
             if not ticket["fields"]["description"]:
                 continue
-            if error_id not in ticket["fields"]["description"]:
+            if f"{error_id}_~" not in ticket["fields"]["description"]:
                 continue
             return ticket
 
         else:
             return None
 
-    def __generate_error_id(self, exc_type: type, exc_traceback: TracebackType) -> str:
+    def generate_group_id(self, group_by: Optional[str] = None) -> Optional[str]:
+        """Generates a group ID based on the provided group_by string.
+
+        Args:
+            group_by (str): The string to use for generating the group ID.
+
+        Returns:
+            str or None: The generated group ID if group_by is not None, otherwise None.
+        """
+        if not group_by:
+            return None
+        crc_hash = zlib.crc32(group_by.encode())
+        return format(crc_hash, "x")
+
+    def __generate_error_id(self, exception: Exception) -> str:
         """Generates an error string ID using the exception, function name, and error string.
 
         Args:
-            exc_type (type): The type of the exception.
-            exc_traceback (TracebackType): The traceback of the exception.
+            exception (Exception):
 
         Returns:
-            str: The generated error string ID.
+            str: The generated error string ID and the group ID.
 
         """
-        frames = get_frames(exc_traceback)
+        frames = get_frames(exception.__traceback__)
         exception_chain = "-".join([f"{frame.name}" for frame in frames])
         rel_path = os.path.relpath(frames[-1].filename, os.getcwd())
         path = Path(os.path.splitext(rel_path)[0]).as_posix()
-        error_id = f"{path}-{exception_chain}-{frames[-1].line}-" f"{exc_type.__module__}-{exc_type.__name__}"
-        return hashlib.md5(error_id.encode()).hexdigest()
+        path = remove_holotree_id(path)
+        error_id = (
+            f"{path}-{exception_chain}-{frames[-1].line}-" f"{type(exception).__module__}-{type(exception).__name__}"
+        )
+        hashed_id = hashlib.md5(error_id.encode()).hexdigest()
+        return hashed_id
 
     @staticmethod
     def __generate_warning_id(inspected_frame) -> tuple:
@@ -1689,7 +1766,9 @@ class Jira:
             return str(message)
         return re.sub(r"\'(.+)\'", "'...'", message)
 
-    def __create_summary(self, exc_type: type, exc_value: Union[Exception, str], exc_traceback: TracebackType) -> str:
+    def __create_summary(
+        self, exc_type: type, exc_value: Union[Exception, str], exc_traceback: TracebackType, idx: Optional[int] = None
+    ) -> str:
         """Create the summary of the ticket.
 
         Args:
@@ -1702,7 +1781,11 @@ class Jira:
         """
         frames = get_frames(exc_traceback)
         file_name, line_no, _, _ = frames[-1]
-        summary = f"[{exc_type.__name__}:{os.path.basename(file_name)}:{line_no}]"
+
+        if idx:
+            summary = f"[{exc_type.__name__}:{os.path.basename(file_name)}:{line_no}({idx})]"
+        else:
+            summary = f"[{exc_type.__name__}:{os.path.basename(file_name)}:{line_no}]"
         if self._project_key == CONFIG.SUPPORT_BOARD and CONFIG.ADMIN_CODE:
             summary = CONFIG.ADMIN_CODE + " - " + summary
         if CONFIG.LIMITS.SUMMARY_LENGTH <= len(summary):

{t_bug_catcher-0.6.0 → t_bug_catcher-0.6.2}/t_bug_catcher/utils/common.py

@@ -1,6 +1,7 @@
 import copy
 import json
 import os
+import re
 import traceback
 import urllib
 from datetime import date, datetime
@@ -101,6 +102,19 @@ def strip_path(path: str):
     return path.replace(os.getcwd(), "").strip(os.sep)
 
 
+def remove_holotree_id(path: str) -> str:
+    """A function to remove the value after 'holotree' from the path.
+
+    Args:
+        path (str): The path from which to remove the value after 'holotree'.
+
+    Returns:
+        str: The modified path.
+    """
+    pattern = r"(holotree\/)[^\/]+\/"
+    return re.sub(pattern, r"\1", path)
+
+
 def retrieve_build_info():
     """Logs build information."""
     if not os.path.exists(CONFIG.BUILD_INFO_FILE):

{t_bug_catcher-0.6.0 → t_bug_catcher-0.6.2}/t_bug_catcher.egg-info/PKG-INFO

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