feat!: Only accept metadata object in send_event_with_custom_metadata
#179
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
4 tasks
This changes `send_event_with_custom_metadata` to accept a single `metadata` object rather than all the fields that go into one. It turns out that in practice, the event-bus-kafka consumer already needs to build an EventsMetadata object or something equivalent to it as it reconstructs the metadata from Kafka message headers, since that's where the parsing and validation logic already is. It then has to splat the object back out when calling this method. This leads to a possible collision risk in the method's kwargs, but it's also just awkward. It is likely that the same issue would arise in any other consumer.
timmc-edx
force-pushed
the
timmc/custom2
branch
from
ecd3273
to
c2ad141
Compare
Merged
6 tasks
2 tasks
mariajgrimaldi
pushed a commit
that referenced
this pull request
Feb 15, 2023
…a` (#179) This changes `send_event_with_custom_metadata` to accept a single `metadata` object rather than all the fields that go into one. It turns out that in practice, the event-bus-kafka consumer already needs to build an EventsMetadata object or something equivalent to it as it reconstructs the metadata from Kafka message headers, since that's where the parsing and validation logic already is. It then has to splat the object back out when calling this method. This leads to a possible collision risk in the method's kwargs, but it's also just awkward. It is likely that the same issue would arise in any other consumer. Addresses #178
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.
This changes
send_event_with_custom_metadatato accept a singlemetadataobject rather than all the fields that go into one.It turns out that in practice, the event-bus-kafka consumer already needs to build an EventsMetadata object or something equivalent to it as it reconstructs the metadata from Kafka message headers, since that's where the parsing and validation logic already is. It then has to splat the object back out when calling this method. This leads to a possible collision risk in the method's kwargs, but it's also just awkward. It is likely that the same issue would arise in any other consumer.
Merge checklist: