feat!: Switch to a single Producer, wrapped in an API singleton #32
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
timmc-edx
force-pushed
the
timmc/single-producer
branch
2 times, most recently
from
71f66d0
to
efad224
Compare
Purpose: - Revisit #16 since I finally figured out a clean way to have a single producer. - Reduce the burden on future code that will need to adjust how polling is done (#31) and maybe handle shutdown (#11) - Prepare for configurable implementation loading, which will need a singleton and getter: openedx/openedx-events#87 - Get rid of the `sync` argument (which didn't fit the abstraction) and move it to a dedicated method. Relying code should now call `get_producer().send(...)` rather than `send_to_event_bus(...)`. The return value is an object that wraps a `Producer` instance (not a `SerializingProducer`) and that handles the serialization itself. Serialization logic is moved to a cached `get_serializers(...)` that expands upon the previous `get_serializer` function; it now returns a pair of key and value serializers. This also acts as a patch point for mocking. I'd like to test the serializers themselves, but they want to talk to a server. `send_to_event_bus` gets a shorter name (now it's just a `send` method) and loses the `sync` keyword argument; there is instead now a `pre_shutdown` method.
timmc-edx
force-pushed
the
timmc/single-producer
branch
from
efad224
to
a4b9e52
Compare
robrap
reviewed
Aug 29, 2022
There was a problem hiding this comment.
Thanks @timmc-edx. I appreciated being able to review the separate commits, even if you squash in the end.
- Fix comment re: client caching - Use `cache` instead of `lru_cache` (should only ever have one value anyhow)
functools.cache is new in Python 3.9. :-)
robrap
reviewed
Aug 30, 2022
Also update CHANGELOG date prediction.
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.
Purpose:
syncargument (which didn't fit the abstraction) and move it to a dedicated method.Relying code should now call
get_producer().send(...)rather thansend_to_event_bus(...). The return value is an object that wraps aProducerinstance (not aSerializingProducer) and that handles the serialization itself.Serialization logic is moved to a cached
get_serializers(...)that expands upon the previousget_serializerfunction; it now returns a pair of key and value serializers. This also acts as a patch point for mocking.send_to_event_busgets a shorter name (now it's just asendmethod) and loses thesynckeyword argument; there is instead now apre_shutdownmethod.A few refactoring changes are broken out into foundational commits to make review easier, but I might squash-merge them:
create_schema_registry_clientand rename toget_...Merge checklist:
Check off if complete or not applicable: