Merge pull request #111 from MindscapeHQ/ro/cs-100/solve-oversized-payload-issue

ro/cs-100/solve-oversized-payload-issue

Author: ProRedCat

.travis.yml

@@ -3,21 +3,19 @@ language: python
 cache: pip
 
 python:
-  - "2.7"
   - "3.6"
   - "3.7"
   - "3.8"
   - "3.9"
   - "3.10"
   - "3.11"
-  - "pypy"
+  - "3.12"
   - "pypy3"
 
 install:
   - python -m pip install coverage .[dev]
 
 script:
-  - if [[ $TRAVIS_PYTHON_VERSION == 2* || $TRAVIS_PYTHON_VERSION == 'pypy' ]]; then coverage run --source=python2 -m unittest discover python2/tests; fi
   - if [[ $TRAVIS_PYTHON_VERSION == 3* || $TRAVIS_PYTHON_VERSION == 'pypy3' ]]; then coverage run --source=python3 -m unittest discover python3/tests; fi
 
 after_success:

CHANGELOG.md

@@ -1,3 +1,12 @@
+## 5.0.0 (13/02/24):
+Breaking changes:
+  - Support for Python 2.7 has been dropped
+
+Bug Fixes:
+  - Removes largest local/global variables in crash payload to ensure payload size limit is not breached (optional)
+    - We now provide `enforce_payload_size_limit` and `log_payload_size_limit_breaches` as configuration options, both enabled by default
+    - These control whether the provider will attempt to remove variables if there is an oversized payload and log which variables were removed
+
 ## 4.4.0 (11/08/2023):
 Features:
   - Added `RaygunHandler.from_sender()` factory to construct a `RaygunHandler` instance using an existing `RaygunSender`. This allows for additional configuration of the sender.

MANIFEST.in

@@ -1,4 +1,3 @@
 include README.rst
 include setup.py
-recursive-include python2 *.py
 recursive-include python3 *.py

README.rst

@@ -10,6 +10,8 @@ raygun4py
 
 Official Raygun provider for **Python 2.7**, **Python 3.1+** and **PyPy**
 
+**Python 2.7** is supported in versions <= 4.4.0
+
 Please also refer to our `documentation site <https://raygun.com/documentation/language-guides/python/crash-reporting/installation/>`_, as this is maintained with higher priority.
 
 
@@ -132,11 +134,16 @@ The above configuration is the minimal required setup. The full set of options s
       'ignored_exceptions': [],
       'transmit_global_variables': True,
       'transmit_local_variables': True,
+      'enforce_payload_size_limit': True, 
+      'log_payload_size_limit_breaches': True,
       'transmit_environment_variables:': True,
       'userversion': "Not defined",
       'user': None
   }
 
+'enforce_payload_size_limit' when enabled (default behavior) will iteratively remove the largest global or local variable from the error message until the payload is below 128kb as payloads over 128kb will not be accepted by Raygun
+'log_payload_size_limit_breaches' when enabled (default behavior) will log breaches and specify which variables are being removed
+
 Flask
 +++++