t-bug-catcher 0.3.1__tar.gz → 0.4.1__tar.gz

{t_bug_catcher-0.3.1 → t_bug_catcher-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: t_bug_catcher
-Version: 0.3.1
+Version: 0.4.1
 Summary: Bug catcher
 Home-page: https://www.thoughtful.ai/
 Author: Thoughtful
@@ -14,6 +14,7 @@ Requires-Python: >=3.9
 Requires-Dist: requests<3.0.0,>=2.31.0
 Requires-Dist: bugsnag>=4.6.1
 Requires-Dist: retry~=0.9.2
+Requires-Dist: whispers>=2.2.1
 
 t-bug-catcher
 ==============

t_bug_catcher-0.3.1/t_bug_catcher.egg-info/requires.txt → t_bug_catcher-0.4.1/requirements.txt

@@ -1,3 +1,4 @@
 requests<3.0.0,>=2.31.0
 bugsnag>=4.6.1
 retry~=0.9.2
+whispers>=2.2.1

{t_bug_catcher-0.3.1 → t_bug_catcher-0.4.1}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.3.1
+current_version = 0.4.1
 commit = True
 tag = False
 

{t_bug_catcher-0.3.1 → t_bug_catcher-0.4.1}/setup.py

@@ -26,7 +26,9 @@ setup(
     packages=find_packages(include=["t_bug_catcher", "t_bug_catcher.*"]),
     test_suite="tests",
     url="https://www.thoughtful.ai/",
-    version="0.3.1",
+    version="0.4.1",
     zip_safe=False,
     install_requires=install_requirements,
+    include_package_data=True,
+    package_data={"": ["resources/*.yml"]},
 )

{t_bug_catcher-0.3.1 → t_bug_catcher-0.4.1}/t_bug_catcher/__init__.py

@@ -3,14 +3,12 @@
 __author__ = """Thoughtful"""
 __email__ = "support@thoughtful.ai"
 # fmt: off
-__version__ = '0.3.1'
+__version__ = '0.4.1'
 # fmt: on
 
 from .bug_catcher import (
     configure,
     report_error,
-    report_error_to_jira,
-    report_error_to_bugsnag,
     attach_file_to_exception,
     install_sys_hook,
     uninstall_sys_hook,
@@ -19,8 +17,6 @@ from .bug_catcher import (
 __all__ = [
     "configure",
     "report_error",
-    "report_error_to_jira",
-    "report_error_to_bugsnag",
     "attach_file_to_exception",
     "install_sys_hook",
     "uninstall_sys_hook",

{t_bug_catcher-0.3.1 → t_bug_catcher-0.4.1}/t_bug_catcher/bug_catcher.py

@@ -8,6 +8,7 @@ from typing import List, Optional
 from .bug_snag import BugSnag
 from .config import CONFIG
 from .jira import Jira
+from .stack_saver import StackSaver
 from .utils import logger
 from .utils.common import get_frames
 
@@ -89,6 +90,7 @@ class BugCatcher:
         self.__bug_snag: BugSnag = BugSnag()
         self.__configurator: Configurator = Configurator(self.__jira, self.__bug_snag)
         self.__sys_excepthook = None
+        self.__stack_saver = StackSaver()
 
     @property
     def configure(self):
@@ -131,11 +133,14 @@ class BugCatcher:
             logger.warning(f"Exception {handled_error} already reported.")
             return
 
+        stack_trace = self.__stack_saver.save_stack_trace(exception)
+
         if self.__configurator.is_jira_configured:
             self.__jira.report_error(
                 exception=exception,
                 assignee=assignee,
                 attachments=attachments,
+                stack_trace=stack_trace,
                 additional_info=description,
                 metadata=metadata,
             )
@@ -243,8 +248,10 @@ class BugCatcher:
             logger.warning(f"Exception {handled_error} already reported.")
             return
 
+        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)
+            self.__jira.report_unhandled_error(exc_type, exc_value, exc_traceback, stack_trace)
         if self.__configurator.is_bugsnag_configured:
             self.__bug_snag.report_unhandled_error(exc_type, exc_value, exc_traceback)
 

{t_bug_catcher-0.3.1 → t_bug_catcher-0.4.1}/t_bug_catcher/config.py

@@ -13,6 +13,7 @@ class Config:
         MAX_ISSUE_ATTACHMENTS: int = 100
         MAX_DESCRIPTION_LENGTH: int = 250
         SUMMARY_LENGTH: int = 120
+        STACK_SCOPE: int = 3
 
     SUPPORT_BOARD = "AB"
 
@@ -20,6 +21,7 @@ class Config:
         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')}/"
+        f"stepRuns/{os.environ.get('RC_ACTIVITY_RUN_ID')}/"
     )
 
     ENVIRONMENT = (

{t_bug_catcher-0.3.1 → t_bug_catcher-0.4.1}/t_bug_catcher/jira.py

@@ -1,12 +1,12 @@
 """JiraPoster class for interacting with the Jira API."""
 
-import datetime
 import hashlib
 import json
 import os
 import re
 import sys
 import traceback
+from datetime import datetime
 from importlib.metadata import version
 from pathlib import Path
 from types import TracebackType
@@ -19,7 +19,7 @@ from retry import retry
 from .config import CONFIG
 from .exceptions import BadRequestError
 from .utils import logger
-from .utils.common import get_frames
+from .utils.common import Encoder, get_frames
 from .workitems import variables
 
 
@@ -389,7 +389,7 @@ class Jira:
                     },
                     {
                         "type": "text",
-                        "text": str(datetime.datetime.now().strftime("%B %d, %Y %I:%M:%S %p")),
+                        "text": str(datetime.now().strftime("%B %d, %Y %I:%M:%S %p")),
                     },
                 ],
             }
@@ -521,7 +521,7 @@ class Jira:
                         "content": [
                             {
                                 "type": "text",
-                                "text": json.dumps(metadata, indent=4),
+                                "text": json.dumps(metadata, indent=4, cls=Encoder),
                             }
                         ],
                     },
@@ -735,7 +735,7 @@ class Jira:
         date_markup = [
             {
                 "type": "text",
-                "text": f" at {str(datetime.datetime.now().strftime('%B %d, %Y %I:%M:%S %p'))}",
+                "text": f" at {str(datetime.now().strftime('%B %d, %Y %I:%M:%S %p'))}",
             },
             {"type": "hardBreak"},
         ]
@@ -959,6 +959,7 @@ class Jira:
         exception: Optional[Exception] = None,
         assignee: Optional[str] = None,
         attachments: Union[List, str, Path, None] = None,
+        stack_trace: Optional[str] = None,
         metadata: Optional[dict] = None,
         additional_info: Optional[str] = None,
     ) -> dict:
@@ -968,6 +969,7 @@ class Jira:
             exception (Exception, optional): The exception to be added to the Jira issue.
             assignee (str, optional): The assignee to be added to the Jira issue.
             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.
 
@@ -1012,6 +1014,9 @@ class Jira:
                 )
                 return existing_ticket
 
+            if stack_trace:
+                attachments.insert(0, stack_trace)
+
             assignee_id = None
             assignee = assignee if assignee else self._default_assignee
             if assignee:
@@ -1036,19 +1041,23 @@ class Jira:
                 attachments=attachments,
                 labels=["bug_catcher"],
             )
+            if os.path.exists(stack_trace):
+                os.remove(stack_trace)
             return response
         except Exception as ex:
             logger.warning(f"Failed to create Jira issue due to: {ex.__class__.__name__}: {ex}")
             return False
 
-    def report_unhandled_error(self, exc_type: type, exc_value: Union[Exception, str], exc_traceback: TracebackType):
+    def report_unhandled_error(
+        self, exc_type: type, exc_value: Union[Exception, str], exc_traceback: TracebackType, 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.
-            assignee (str, optional): The assignee to be added to the Jira issue.
+            stack_trace (str, optional): Stack trace to be added to the Jira issue.
 
         Returns:
             The response from creating the Jira issue.
@@ -1086,8 +1095,11 @@ class Jira:
                 summary=summary,
                 description=description,
                 assignee_id=assignee_id,
+                attachments=[stack_trace] if stack_trace else None,
                 labels=["bug_catcher", "fatal_error"],
             )
+            if os.path.exists(stack_trace):
+                os.remove(stack_trace)
             return response
         except Exception as ex:
             logger.warning(f"Failed to create Jira issue due to: {ex.__class__.__name__}: {ex}")

t_bug_catcher-0.4.1/t_bug_catcher/resources/whispers_config.yml

@@ -0,0 +1,44 @@
+include:
+  files:
+    - "**/*"
+  rules:
+    - password
+    - uri
+    - secret
+    - webhook
+    - apikey
+    - apikey-known
+    - apikey-maybe
+    - id: username
+      group: misc
+      description: Variable names refering to user
+      message: Secret
+      severity: Low
+      key:
+        regex: ^\S*(user(name?)|login|id|uid|otp)_?(hash)?[0-9]*$
+        ignorecase: True
+      value:
+        minlen: 1
+  severity:
+    - Critical
+    - High
+    - Medium
+
+exclude:
+  files:
+    - __pycache__|\.eggs|build|dev|\.vscode|\.git
+    - .*/(locale|spec|test|mock)s?/
+    - integration|node_modules
+    - (package(-lock)?|npm-shrinkwrap)\.json
+
+  keys:
+    - .*(public|project).*
+
+  values:
+    - ^(true|false|yes|no|1|0)$
+    - .*_(user|password|token|key|placeholder|name)$
+    - ^aws_(access_key_id|secret_access_key|session_token)$
+    - ^((cn?trl|alt|shift|del|ins|esc|tab|f[\d]+) ?[\+_\-\\/] ?)+[\w]+$
+
+
+

t_bug_catcher-0.4.1/t_bug_catcher/stack_saver.py

@@ -0,0 +1,181 @@
+import inspect
+import json
+import os
+import re
+import sys
+from datetime import datetime
+from pathlib import Path
+from types import FunctionType, ModuleType
+from typing import Optional
+
+import whispers
+
+from .config import CONFIG
+from .utils import logger
+from .utils.common import Encoder
+
+
+class StackSaver:
+    """A class to save the stack trace."""
+
+    def __init__(self):
+        """Initializes the StackSaver class."""
+        pass
+
+    @staticmethod
+    def strip_path(path: str):
+        """A static method to strip the current working directory path from the input.
+
+        Args:
+            path (str): The path from which to strip the current working directory path.
+
+        Returns:
+            str: The stripped path.
+        """
+        return path.replace(os.getcwd(), "").strip(os.sep)
+
+    @staticmethod
+    def serialize_frame_info(frame_info: dict) -> dict:
+        """A static method to serialize the frame info.
+
+        Args:
+            frame_info (dict): The frame info to be serialized.
+
+        Returns:
+            dict: The serialized frame info.
+        """
+        run_locals = {}
+        run_args = {}
+        if frame_info["locals"]:
+            for key, value in frame_info["locals"].items():
+                if str(key).lower() == "credentials":
+                    continue
+                if isinstance(value, dict):
+                    run_locals[str(key)] = value
+                else:
+                    run_locals[str(key)] = str(value)
+        for key, value in frame_info["args"].items():
+            if str(key).lower() == "credentials":
+                continue
+            if isinstance(value, dict):
+                run_args[str(key)] = value
+            else:
+                run_args[str(key)] = str(value)
+        serializable_frame_info = {
+            "filename": frame_info["filename"],
+            "function_name": frame_info["function_name"],
+            "locals": run_locals,
+            "args": run_args,
+        }
+        return serializable_frame_info
+
+    @staticmethod
+    def filter_variables(variables: dict) -> dict:
+        """A static method to filter the variables.
+
+        Args:
+            variables (dict): The variables to be filtered.
+
+        Returns:
+            dict: The filtered variables.
+        """
+        if not isinstance(variables, dict):
+            return variables
+        else:
+            local_variables = {}
+            for var_name, var in variables.items():
+                if re.match(r"^__\w+__$", var_name):
+                    continue
+                if isinstance(var, (ModuleType, FunctionType)):
+                    continue
+                local_variables[var_name] = var
+            return local_variables
+
+    def mask_credentials(self, file_path: str) -> None:
+        """A method to mask the credentials in the file.
+
+        Args:
+            file_path (str): The path of the file to be masked.
+
+        Raises:
+            Exception: If the masking fails.
+
+        Returns:
+            None
+        """
+        with open(file_path, "r") as f:
+            filedata = f.readlines()
+
+        config_path = Path(__file__).parent.resolve().as_posix() + "/resources/whispers_config.yml"
+
+        args = f"-c {config_path} {file_path}"
+
+        secrets = [secret for secret in whispers.secrets(args)]
+        unique_secrets = []
+        seen = set()
+        for secret in secrets:
+            item = (secret.key, secret.value, secret.line)
+            if item not in seen:
+                seen.add(item)
+                unique_secrets.append(secret)
+
+        for index, line in enumerate(filedata):
+            if not unique_secrets:
+                break
+
+            for secret in unique_secrets:
+                if secret.key in line and secret.value in line:
+                    filedata[index] = line.replace(secret.value, secret.value[:1] + "***")
+                    unique_secrets.pop(unique_secrets.index(secret))
+                    break
+
+        if unique_secrets:
+            logger.warning("Failed to mask credentials")
+            os.remove(file_path)
+            raise Exception("Failed to mask credentials")
+
+        with open(file_path, "w") as file:
+            file.writelines(filedata)
+
+    def save_stack_trace(self, exception: Optional[Exception] = None):
+        """A method to save the stack trace.
+
+        Args:
+            exception (Exception, optional): The exception to be saved. Defaults to None.
+
+        Returns:
+            Optional[str]: The path of the saved stack trace.
+        """
+        try:
+            frames = []
+            stack_details_json = []
+            tb = exception.__traceback__ if exception else sys.exc_info()[2]
+            while tb is not None:
+                frame = tb.tb_frame
+                if "site-packages" in frame.f_code.co_filename:
+                    tb = tb.tb_next
+                    continue
+                frames.append(frame)
+                tb = tb.tb_next
+            frames = frames[: CONFIG.LIMITS.STACK_SCOPE]
+
+            for frame in frames:
+                frame_info = {
+                    "filename": self.strip_path(frame.f_code.co_filename),
+                    "function_name": frame.f_code.co_name,
+                    "locals": self.filter_variables(frame.f_locals),
+                    "args": self.filter_variables(inspect.getargvalues(frame)[3]),
+                }
+                stack_details_json.append(self.serialize_frame_info(frame_info))
+
+            file_path = f"stack_details_{datetime.now().strftime('%Y%m%d%H%M%S')}.json"
+
+            with open(file_path, "w") as f:
+                json.dump(stack_details_json, f, indent=4, cls=Encoder)
+
+            self.mask_credentials(file_path)
+
+            return file_path
+        except Exception as e:
+            logger.warning(f"Failed to save stack trace: {e}")
+            return

t_bug_catcher-0.4.1/t_bug_catcher/utils/common.py

@@ -0,0 +1,41 @@
+import traceback
+from datetime import date, datetime
+from json import JSONEncoder
+from pathlib import Path
+from types import TracebackType
+from typing import List
+
+
+class Encoder(JSONEncoder):
+    """This class is used to encode the Episode object to json."""
+
+    def default(self, o):
+        """This method is used to encode the Episode object to json.
+
+        Args:
+            o (object): The object to be encoded.
+
+        Returns:
+            str: The json string.
+        """
+        if hasattr(o, "__dict__"):
+            return o.__dict__
+        if isinstance(o, (datetime, date)):
+            return o.isoformat()
+        if isinstance(o, Path):
+            return str(o)
+        return JSONEncoder.default(self, o)
+
+
+def get_frames(exc_traceback: TracebackType) -> List:
+    """Get the frames of the exception.
+
+    Args:
+        exc_traceback (TracebackType): The traceback of the exception.
+
+    Returns:
+        List: The frames of the exception.
+    """
+    return [
+        frame for frame in traceback.extract_tb(exc_traceback) if "site-packages" not in str(frame.filename).lower()
+    ]

{t_bug_catcher-0.3.1 → t_bug_catcher-0.4.1}/t_bug_catcher.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: t_bug_catcher
-Version: 0.3.1
+Version: 0.4.1
 Summary: Bug catcher
 Home-page: https://www.thoughtful.ai/
 Author: Thoughtful
@@ -14,6 +14,7 @@ Requires-Python: >=3.9
 Requires-Dist: requests<3.0.0,>=2.31.0
 Requires-Dist: bugsnag>=4.6.1
 Requires-Dist: retry~=0.9.2
+Requires-Dist: whispers>=2.2.1
 
 t-bug-catcher
 ==============

{t_bug_catcher-0.3.1 → t_bug_catcher-0.4.1}/t_bug_catcher.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ t_bug_catcher/bug_snag.py
 t_bug_catcher/config.py
 t_bug_catcher/exceptions.py
 t_bug_catcher/jira.py
+t_bug_catcher/stack_saver.py
 t_bug_catcher/workitems.py
 t_bug_catcher.egg-info/PKG-INFO
 t_bug_catcher.egg-info/SOURCES.txt
@@ -17,6 +18,7 @@ t_bug_catcher.egg-info/dependency_links.txt
 t_bug_catcher.egg-info/not-zip-safe
 t_bug_catcher.egg-info/requires.txt
 t_bug_catcher.egg-info/top_level.txt
+t_bug_catcher/resources/whispers_config.yml
 t_bug_catcher/utils/__init__.py
 t_bug_catcher/utils/common.py
 t_bug_catcher/utils/logger.py

t_bug_catcher-0.3.1/requirements.txt → t_bug_catcher-0.4.1/t_bug_catcher.egg-info/requires.txt

@@ -1,3 +1,4 @@
 requests<3.0.0,>=2.31.0
 bugsnag>=4.6.1
-retry~=0.9.2
+retry~=0.9.2
+whispers>=2.2.1

t_bug_catcher-0.3.1/t_bug_catcher/utils/common.py

@@ -1,17 +0,0 @@
-import traceback
-from types import TracebackType
-from typing import List
-
-
-def get_frames(exc_traceback: TracebackType) -> List:
-    """Get the frames of the exception.
-
-    Args:
-        exc_traceback (TracebackType): The traceback of the exception.
-
-    Returns:
-        List: The frames of the exception.
-    """
-    return [
-        frame for frame in traceback.extract_tb(exc_traceback) if "site-packages" not in str(frame.filename).lower()
-    ]