Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add stop param to method save #43

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

hugobrilhante
Copy link
Contributor

@hugobrilhante hugobrilhante commented Jan 20, 2024

Sometimes you need to update an instance of a model decorated with @publish, but you don't want a new message to be published on the broker.

An example, which may serve as a guideline to understand the motivation behind this new feature, would be updating the status of an order when it reaches its final stage:

order = Order.objects.get(order_id=order_id)
order.status = 'Confirmed'
order.save(stop=True)

In this example, by using stop=True when calling the save method, the message publication on the broker is halted, allowing the update of the order status without triggering a new publication message.

This pull request also incorporates the changes from the fix in pull request PR #42

@hugobrilhante hugobrilhante force-pushed the feat/add-stop-param-to-save branch 3 times, most recently from 2440793 to 7f31c1b Compare January 21, 2024 15:56
@@ -125,7 +125,6 @@ def my_serializer_1(obj):
self.assertEqual("", published[1].body["last_name"])
self.assertEqual("", published[1].body["first_name"])
self.assertIsNone(published[1].body["last_login"])
self.assertAlmostEqual(date_joined.strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3], published[1].body["date_joined"])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: what do you think about use a freezegun ever than remove the line ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my view freezegun is a fantastic lib and it would really be a good idea to use it. But I think that in this case it would not be worth it because it is a single line of information that is not so critical. But like I said, it's my vision. Would you like to add another lib as a dependency for this test?

@@ -1,3 +1,4 @@
# pylint: disable=protected-access
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: What is the motivation to include this bypass? Not is possible to remove that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case I could move it to the lines where there is access, I cannot remove it because I need to access the _meta.

return decorator_publish
def wrapper(cls):
class PublishModel(cls):
def save(self, *args, stop=False, **kwargs):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Change the stop to more clarify parameter, for example not_publish_message_to_queue. What do you think about this?
One docstring here joined with the documentation can be useful.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing sugestion

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants