feat: make signal parameter optional in preparation for removal #219
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
robrap
approved these changes
May 15, 2023
| def make_single_consumer(*, topic: str, group_id: str, signal: OpenEdxPublicSignal, **kwargs) -> EventBusConsumer: | ||
| def make_single_consumer(*, topic: str, group_id: str, | ||
| signal: OpenEdxPublicSignal = None, # pylint: disable=unused-argument | ||
| **kwargs) -> EventBusConsumer: | ||
| """ | ||
| Construct a consumer for a given topic, group, and signal. |
There was a problem hiding this comment.
- Do you want to drop
signalfrom here now? - Should we add a sentence stating that the signals will be determined by the message header, or do we not even need to mention signals in the future?
There was a problem hiding this comment.
- Going to keep signal here for now since this is part of the public API. I don't know of anyone who uses it but I've broken things before by unexpectedly changing a public API method
- I think we should just not mention it
openedx_events/event_bus/__init__.py
Outdated
| @@ -166,12 +168,11 @@ def make_single_consumer(*, topic: str, group_id: str, signal: OpenEdxPublicSign | |||
| Arguments: | |||
| topic: The event bus topic to consume from (without any environmental prefix) | |||
| group_id: The consumer group to participate in | |||
| signal: Send consumed, decoded events to the receivers of this signal | |||
| signal: DEPRECATED signals determined by message headers | |||
There was a problem hiding this comment.
If you add the notion of signals determined by message headers to a more permanent comment, then maybe the following would be more clear?
Suggested change
| signal: DEPRECATED signals determined by message headers | |
| signal: (DEPRECATED) this argument will be ignored. |
| required=True, | ||
| help='Type of signal to emit from consumed messages.' | ||
| required=False, | ||
| help='DEPRECATED signal will be determined by message headers' |
There was a problem hiding this comment.
See related comment and do what you think is best.
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:
Makes the
signalparameter of the consume_events command optional in preparation for complete removal. The signal will now be determined from the message headers.ISSUE:
#218
Dependencies:
If we're being nice, should probably not be merged before openedx/event-bus-redis#22, although the event bus redis is not production-ready yet anyway.
Reviewers:
Merge checklist:
Post merge:
finished.
Author concerns: List any concerns about this PR - inelegant
solutions, hacks, quick-and-dirty implementations, concerns about
migrations, etc.