fix(provider)!: `RaygunMessage` object in `on_grouping_key` method #118

miquelbeltran · 2025-05-16T14:07:31Z

Description 📝

Purpose:

In the ticket #96 the customer reported that the object provided to the on_grouping_key callback was not a RaygunMessage object but rather a Dictionary.

This was caused by a bug in the filter_keys method as the customer pointed out.

Approach:

After some iterations, the filter_keys function has been changed so it does not accept RaygunMessage objects, and instead it can only be used with dictionaries (e.g. the RaygunMessage.details). This simplifies the implementation and avoids bugs like the one reported in #96 where the RaygunMessage was overridden.

This ensures that filter_keys doesn't break the class definition of RaygunMessage.

Then, the rest of the _post() method had to be fixed to access the details of the RaygunMessage object correctly.

For that I created methods to set_details and set_error.

As well, I created unit tests that check that what the documentation says is correct.

Finally, I also fixed the documentation formatting a bit.

This is potentially a breaking change if customers were accessing the object as a dictionary, as they will have to change the code, so a major version should be released.

While implementing this fix, I also made sure that functions are pure and that they don't modify the provided RaygunMessage, but rather modify a copy and then return it.

Type of change

fix: Bug fix (non-breaking change which fixes an issue)
feat: New feature (non-breaking change which adds functionality)
chore: Chore task, release or small impact change
ci: CI configuration change
Other type of change (specify)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Related issues

Closes Documentation for Custom grouping logic has incorrect definition of the callback parameter #96

Test plan 🧪

Tested through existing and new unit tests

Author to check 👓

Project and all contained modules builds successfully
Self-/dev-tested
Unit/UI/Automation/Integration tests provided where applicable
Code is written to standards
Appropriate documentation written (code comments, internal docs)

Reviewer to check ✔️

Project and all contained modules builds successfully
Change has been dev-/reviewer-tested, where possible
Unit/UI/Automation/Integration tests provided where applicable
Code is written to standards
Appropriate documentation written (code comments, internal docs)

miquelbeltran · 2025-05-19T06:22:53Z

python3/raygun4py/raygunmsgs.py

@@ -129,15 +129,30 @@ def set_user(self, user):
 class RaygunMessage(object):

    def __init__(self):
-        self.occurredOn = datetime.utcnow()
+        self.occurredOn = datetime.now(UTC)


Fixes deprecated utcnow warning

miquelbeltran · 2025-05-19T06:23:20Z

python3/raygun4py/raygunmsgs.py

+    def __copy__(self):
+        new_instance = RaygunMessage()
+        new_instance.details = self.details.copy()
+        new_instance.occurredOn = self.occurredOn
+        return new_instance
+
+    def copy(self):
+        return self.__copy__()
+


Necessary to avoid modifying the original object in pure functions

miquelbeltran · 2025-05-19T06:23:48Z

python3/raygun4py/raygunprovider.py

@@ -295,42 +295,42 @@ def _create_message(
        )

    def _transform_message(self, message):
+        message = message.copy()


_transform_message should be pure and not modify the original message object

miquelbeltran · 2025-05-19T06:24:35Z

python3/raygun4py/raygunprovider.py

        message = utilities.ignore_exceptions(self.ignored_exceptions, message)

        if message is not None:
            message = utilities.filter_keys(self.filtered_keys, message)
-            message["details"]["groupingKey"] = utilities.execute_grouping_key(
+            message.get_details()["groupingKey"] = utilities.execute_grouping_key(


message should be a RaygunMessage object and not a dict, access properties using accessors.

miquelbeltran · 2025-05-19T06:24:57Z

python3/raygun4py/raygunprovider.py

            else:
                return None

        return message

    def _post(self, raygunMessage):
+        raygunMessage = raygunMessage.copy()


_post should be a pure function and not modify the original raygunMessage

python3/raygun4py/utilities.py

miquelbeltran · 2025-05-19T06:26:01Z

python3/raygun4py/utilities.py

+    if isinstance(object, raygunmsgs.RaygunMessage):
+        updated_object = object.copy()
+        updated_object.__dict__.update(iteration_target)
+        return updated_object
+


If the original object was a RaygunMessage, then we need to create a copy of the object and apply the changes to the internal __dict__

python3/tests/test_raygunprovider.py

Copilot

Pull Request Overview

This PR fixes a bug where the on_grouping_key callback received a raw dictionary instead of a RaygunMessage, and adjusts related methods to treat messages as immutable copies. It also updates tests, adds new setters/getters in RaygunMessage, and refines documentation.

Refactored filter_keys to detect and return a modified RaygunMessage instead of plain dict
Changed RaygunSender to use copy(), get_details(), set_details(), and set_error()
Added new getters/setters (get_error, get_details, set_details, set_error) and corresponding unit tests

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
python3/tests/test_utilities.py	Updated tests to capture and assert the return value of `filter_keys`.
python3/tests/test_raygunprovider.py	Assigned the result of `_transform_message` to `msg` in existing tests and added an error‐callback test.
python3/tests/test_raygunmsgs.py	Added tests for `get_error()` and `get_details()`.
python3/raygun4py/utilities.py	Refactored `filter_keys` to copy the underlying dict and return a `RaygunMessage` if applicable.
python3/raygun4py/raygunprovider.py	Updated `_transform_message` and `_post` to use `RaygunMessage` API methods and make copies.
python3/raygun4py/raygunmsgs.py	Made timestamps timezone‐aware and added `copy()`, getters, and setters for message details and error.
README.rst	Improved formatting around `RaygunMessage` usage in custom grouping docs.

Comments suppressed due to low confidence (3)

python3/raygun4py/utilities.py:14

The parameter name object shadows a Python built-in and is ambiguous. Consider renaming it to obj or target for clarity.

def filter_keys(filtered_keys, object):

python3/tests/test_raygunmsgs.py:162

We should add unit tests for the new set_error() and set_details() methods to ensure they correctly update the RaygunMessage state.

def test_get_error(self):

python3/tests/test_utilities.py:7

Add a test case where filter_keys is called on a RaygunMessage instance to verify it returns a RaygunMessage (not a dict) with filtered fields.

def test_filter_keys(self):

Copilot

Pull Request Overview

This PR ensures that the on_grouping_key callback always receives a RaygunMessage object (not a raw dict), fixes the key‐filtering bug, updates internal message handling methods, and adds corresponding tests and documentation tweaks.

filter_keys now detects RaygunMessage, returns a modified copy, and preserves message methods.
Added set_details/set_error and updated _transform_message/_post to use get_details/get_error/set_* APIs.
Expanded unit tests for these changes and improved README code formatting.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
python3/tests/test_utilities.py	Updated tests to assign the return of `filter_keys` and added RaygunMessage case
python3/tests/test_raygunprovider.py	Changed grouping key tests to capture and inspect the returned message object
python3/tests/test_raygunmsgs.py	Added tests for `get_error`, `get_details`, `set_error`, and `set_details`
python3/raygun4py/utilities.py	`filter_keys` now supports `RaygunMessage` inputs and returns a message copy
python3/raygun4py/raygunprovider.py	`_transform_message`/`_post` updated to use new accessors and copy semantics
python3/raygun4py/raygunmsgs.py	Added `__copy__`, `copy`, and `set_*` methods to `RaygunMessage`
README.rst	Improved code references formatting

Comments suppressed due to low confidence (2)

python3/raygun4py/utilities.py:14

[nitpick] Consider renaming the parameter 'filtered_keys' to 'keys_to_filter' for clearer intent, since 'filtered_keys' can be misread as keys already filtered.

def filter_keys(filtered_keys, obj):

python3/tests/test_utilities.py:32

Add tests for nested dictionaries inside RaygunMessage.details to ensure filter_keys recurses and filters nested keys correctly.

def test_filter_keys_raygun_message(self):

python3/raygun4py/utilities.py

python3/raygun4py/raygunmsgs.py

python3/raygun4py/utilities.py

miquelbeltran · 2025-05-19T08:58:57Z

python3/raygun4py/raygunprovider.py

+            details = message.get_details()
+            details = utilities.filter_keys(self.filtered_keys, details)


Pass the details to the filter_keys function instead of passing the whole message object

miquelbeltran · 2025-05-19T09:00:40Z

python3/raygun4py/utilities.py

+    Returns:
+        dict: The filtered dictionary.
+    """
+    iteration_target = dict(obj)


make a copy to avoid modifying the original object

miquelbeltran · 2025-05-19T09:01:14Z

python3/raygun4py/utilities.py

-    if isinstance(object, raygunmsgs.RaygunMessage):
-        iteration_target = object.__dict__


The filter_keys function shouldn't be used with RaygunMessage directly, instead it should be applied to the details

Olwiba

Changes look good 😃 thanks for adding the additional notes throughout the changes!

miquelbeltran added 5 commits May 16, 2025 15:51

fix: raygunmessage instance

fa74eba

revert doc change

e252372

format with black

816c2f0

make functions pure

c6efac5

fix deprecated warning

1a936d4

miquelbeltran commented May 19, 2025

View reviewed changes

python3/raygun4py/utilities.py Outdated Show resolved Hide resolved

miquelbeltran commented May 19, 2025

View reviewed changes

python3/tests/test_raygunprovider.py Outdated Show resolved Hide resolved

miquelbeltran added 2 commits May 19, 2025 08:28

format

778bdd4

fix: use timezone.utc for python 3.9 compat

788ca44

miquelbeltran requested a review from Copilot May 19, 2025 07:30

Copilot AI reviewed May 19, 2025

View reviewed changes

miquelbeltran added 2 commits May 19, 2025 09:50

add tests and fix naming

7acc55f

Format

ff6317b

miquelbeltran requested a review from Copilot May 19, 2025 07:57

Copilot AI reviewed May 19, 2025

View reviewed changes

python3/raygun4py/utilities.py Outdated Show resolved Hide resolved

python3/raygun4py/raygunmsgs.py Show resolved Hide resolved

python3/raygun4py/utilities.py Show resolved Hide resolved

miquelbeltran added 4 commits May 19, 2025 10:12

simplify filter keys and its usage

3040cc6

remove unused

b41bfd2

remve unused import

85193c4

remove unused

0e95048

miquelbeltran requested review from TheRealAgentK and sumitramanga May 19, 2025 08:57

miquelbeltran commented May 19, 2025

View reviewed changes

miquelbeltran mentioned this pull request May 20, 2025

feat(provider)!: positioned wildcard matching #119

Merged

17 tasks

Olwiba approved these changes May 20, 2025

View reviewed changes

miquelbeltran merged commit 4c0ab4f into master May 21, 2025
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(provider)!: `RaygunMessage` object in `on_grouping_key` method #118

fix(provider)!: `RaygunMessage` object in `on_grouping_key` method #118

Uh oh!

miquelbeltran commented May 16, 2025 •

edited

Loading

Uh oh!

miquelbeltran May 19, 2025

Uh oh!

miquelbeltran May 19, 2025

Uh oh!

miquelbeltran May 19, 2025

Uh oh!

miquelbeltran May 19, 2025

Uh oh!

miquelbeltran May 19, 2025

Uh oh!

Uh oh!

miquelbeltran May 19, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

miquelbeltran May 19, 2025

Uh oh!

miquelbeltran May 19, 2025

Uh oh!

miquelbeltran May 19, 2025

Uh oh!

Olwiba left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

		details = message.get_details()
		details = utilities.filter_keys(self.filtered_keys, details)

		if isinstance(object, raygunmsgs.RaygunMessage):
		iteration_target = object.__dict__

fix(provider)!: RaygunMessage object in on_grouping_key method #118

fix(provider)!: RaygunMessage object in on_grouping_key method #118

Uh oh!

Conversation

miquelbeltran commented May 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description 📝

Test plan 🧪

Author to check 👓

Reviewer to check ✔️

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Olwiba left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fix(provider)!: `RaygunMessage` object in `on_grouping_key` method #118

fix(provider)!: `RaygunMessage` object in `on_grouping_key` method #118

miquelbeltran commented May 16, 2025 •

edited

Loading

Olwiba left a comment •

edited

Loading