Fix docs example to prevent SynchronousOnlyOperation in async consumers #204
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
Fix docs example to prevent SynchronousOnlyOperation exception - Update comment_activity method to use dict(message) instead of dict(message.data) - Modify comment_activity serializer to return ReturnDict instead of CommentSerializer - Return serializer.data in the serializer method to avoid database queries in async context This change addresses the issue where serializers.data can trigger database queries, potentially causing django.core.exceptions.SynchronousOnlyOperation exceptions in asynchronous consumers.
virgil724
changed the title
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 updates the documentation example for
GenericAsyncAPIConsumerto prevent potentialSynchronousOnlyOperationexceptions that can occur when accessingserializers.datain an asynchronous context.Changes
comment_activitymethod to usedict(message)instead ofdict(message.data)comment_activityserializer method to returnReturnDictinstead ofCommentSerializerserializer.datadirectly, avoiding database queries in the async contextMotivation
The original example could lead to database queries being executed in an asynchronous context when accessing
serializers.data, potentially causingdjango.core.exceptions.SynchronousOnlyOperationexceptions. This fix ensures that the serialization happens in a synchronous context, making the example safer for use in asynchronous consumers.