From fd624f9d2e2c7179559cd4ad534e7085993e9a65 Mon Sep 17 00:00:00 2001 From: Navin Karkera Date: Tue, 6 Jun 2023 10:52:42 +0530 Subject: [PATCH] fixup! docs: adr for enabling producing to event bus via settings Co-authored-by: Robert Raposa --- docs/decisions/0011-producing-to-event-bus-via-settings.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/decisions/0011-producing-to-event-bus-via-settings.rst b/docs/decisions/0011-producing-to-event-bus-via-settings.rst index ab6b9c2b..6e8ec3b1 100644 --- a/docs/decisions/0011-producing-to-event-bus-via-settings.rst +++ b/docs/decisions/0011-producing-to-event-bus-via-settings.rst @@ -9,7 +9,7 @@ Status Context ******* -The initial implementation of the event bus allowed only a single event type to be published to a topic, with details like topic name, consumer group name, and consumer name were configured via code. We weren't sure what the api would finally look like, and whether the event bus config would live as part of the definition of the event, so we just went with explicit code that we could iterate upon. +The initial implementation of the event bus allowed only a single event type to be published to a topic, with details like topic name, consumer group name, and consumer name configured via code. We weren't sure what the api would finally look like, and whether the event bus config would live as part of the definition of the event, so we just went with explicit code that we could iterate upon. The current implementation of openedx-events does not actually push any events to the underlying implementations like `edx-event-bus-kafka`_ and `edx-event-bus-redis`_. The event-producing application is expected to create a signal handler (since openedx-events subclasses Django signals) to catch the event and push it into the event bus. Some examples of the handlers: `handlers example`_. @@ -88,5 +88,5 @@ Consequences Rejected Alternatives ********************* -* Implementing configurable handlers in the host applications will require repeating the code in each host application. -* Following the current way of using fixed handlers will restricts users ability to combine events in a single topic based on their preference. +* Implementing configurable handlers in the host applications, rather than in the shared library, will require repeating the code in each host application. +* Following the current way of using fixed handlers will restricts users ability to combine events in a single topic based on their preference, as well as stopping users from producing additional defined events to the event bus without code changes.