Add support for observing Many-to-Many field changes in ModelObserver #209
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ges in some tests.
…d readability and flexibility
Ensure test consumers send JSON responses confirming subscription and unsubscription actions. Update tests to validate the new response payloads for improved accuracy and clarity. Fix timeout error on slow machines by explicitly waiting for subscription and unsubscription confirmation before proceeding with further test execution.
Integrated support for `m2m_changed` signals in `ModelObserver` to handle many-to-many relationship changes. Updated the `database_event` method accordingly and introduced a new test to validate m2m signal handling with actions such as add, remove, and clear operations. Adjusted test data to include `groups` field for verification.
Using `str(id(self))` for `dispatch_uid` ensures compatibility with cases where signal identifiers are expected to be strings. This change prevents potential issues in environments that enforce strict type checks.
Added a warning to highlight partial support for many-to-many fields in model observation. This warns about signal issues during object deletion and potential non-deterministic behavior due to Django's use of savepoints. References a long-standing Django bug for further context.
Added checks for `through` attribute and improved handling of `pre_clear` and `reverse` cases in many-to-many field changes. Enhanced the logic to avoid duplicates and ensure correct updates to related instances. Updated tests to validate these changes, ensuring robust many-to-many relationship observation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This PR introduces functionality for handling
m2m_changedsignals within theModelObserverclass, enabling observation of changes in many-to-many relationships.Note: This PR is dependent on #208 and must be reviewed and merged only after it. It is based on the commits from that PR.
Key Changes:
m2m_changed_receiver) to handlem2m_changedevents for many-to-many fields._connectmethod to dynamically registerm2m_changedsignals for all many-to-many fields in the observed model.post_add,post_remove, andpost_clearactions.Additional Notes:
UnsupportedWarning) to inform users about potential non-deterministic behavior when savepoints are used in transactions.ModelObservershould be updated to reflect support for many-to-many field observation and its known limitations.This enhancement improves the versatility of the
ModelObserver, allowing for more robust real-time updates in applications with many-to-many relationships.