From 7c51d30b0e9110a856631d64cee93fd3fe878af7 Mon Sep 17 00:00:00 2001 From: Cristhian Garcia Date: Wed, 8 Nov 2023 10:04:48 -0500 Subject: [PATCH] fix: rename tracking event --- eventtracking/backends/event_bus.py | 12 ++++++------ eventtracking/backends/tests/test_event_bus.py | 6 +++--- eventtracking/config.py | 10 +++++----- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/eventtracking/backends/event_bus.py b/eventtracking/backends/event_bus.py index 8f51bf0..ca42988 100644 --- a/eventtracking/backends/event_bus.py +++ b/eventtracking/backends/event_bus.py @@ -4,11 +4,11 @@ from datetime import datetime from openedx_events.analytics.data import TrackingLogData -from openedx_events.analytics.signals import TRACKING_LOG_EVENT_EMITTED +from openedx_events.analytics.signals import TRACKING_EVENT_EMITTED from openedx_events.event_bus import get_producer from eventtracking.backends.routing import RoutingBackend -from eventtracking.config import SEND_TRACKING_LOG_EVENT_EMITTED_SIGNAL +from eventtracking.config import SEND_TRACKING_EVENT_EMITTED_SIGNAL logger = logging.getLogger(__name__) @@ -21,9 +21,9 @@ class EventBusRoutingBackend(RoutingBackend): def send(self, event): """ Send the tracking log event to the event bus by emitting the - TRACKING_LOG_EVENT_EMITTED signal using custom metadata. + TRACKING_EVENT_EMITTED signal using custom metadata. """ - if not SEND_TRACKING_LOG_EVENT_EMITTED_SIGNAL.is_enabled(): + if not SEND_TRACKING_EVENT_EMITTED_SIGNAL.is_enabled(): return data = json.dumps(event.get("data")) @@ -41,11 +41,11 @@ def send(self, event): context=context, ) - metadata = TRACKING_LOG_EVENT_EMITTED.generate_signal_metadata() + metadata = TRACKING_EVENT_EMITTED.generate_signal_metadata() logger.info(f"Sending tracking lof {tracking_log.name} to the event bus.") get_producer().send( - signal=TRACKING_LOG_EVENT_EMITTED, + signal=TRACKING_EVENT_EMITTED, topic="analytics", event_key_field="tracking_log.name", event_data={"tracking_log": tracking_log}, diff --git a/eventtracking/backends/tests/test_event_bus.py b/eventtracking/backends/tests/test_event_bus.py index 40ffdf1..c16a7ab 100644 --- a/eventtracking/backends/tests/test_event_bus.py +++ b/eventtracking/backends/tests/test_event_bus.py @@ -8,7 +8,7 @@ from django.test import override_settings from openedx_events.analytics.data import TrackingLogData -from openedx_events.analytics.signals import TRACKING_LOG_EVENT_EMITTED +from openedx_events.analytics.signals import TRACKING_EVENT_EMITTED from eventtracking.backends.event_bus import EventBusRoutingBackend @@ -46,7 +46,7 @@ def test_successful_send_event(self, mock_get_producer): mock_send.assert_called() self.assertDictContainsSubset( { - "signal": TRACKING_LOG_EVENT_EMITTED, + "signal": TRACKING_EVENT_EMITTED, "topic": "analytics", "event_key_field": "tracking_log.name", "event_data": { @@ -64,7 +64,7 @@ def test_successful_send_event(self, mock_get_producer): ) @patch( - "eventtracking.backends.event_bus.SEND_TRACKING_LOG_EVENT_EMITTED_SIGNAL.is_enabled" + "eventtracking.backends.event_bus.SEND_TRACKING_EVENT_EMITTED_SIGNAL.is_enabled" ) @patch("eventtracking.backends.event_bus.get_producer") def test_event_is_disabled(self, mock_get_producer, mock_is_enabled): diff --git a/eventtracking/config.py b/eventtracking/config.py index d42a347..98ca0a0 100644 --- a/eventtracking/config.py +++ b/eventtracking/config.py @@ -5,15 +5,15 @@ from edx_toggles.toggles import SettingToggle -# .. toggle_name: SEND_TRACKING_LOG_EVENT_EMITTED_SIGNAL +# .. toggle_name: SEND_TRACKING_EVENT_EMITTED_SIGNAL # .. toggle_implementation: SettingToggle # .. toggle_default: False -# .. toggle_description: When True, the system will publish `TRACKING_LOG_EVENT_EMITTED` signals to the event bus. The -# `TRACKING_LOG_EVENT_EMITTED` signal is emit when a tracking log is emitted. +# .. toggle_description: When True, the system will publish `TRACKING_EVENT_EMITTED` signals to the event bus. The +# `TRACKING_EVENT_EMITTED` signal is emit when a tracking log is emitted. # .. toggle_use_cases: circuit_breaker # .. toggle_creation_date: 2023-10-26 -SEND_TRACKING_LOG_EVENT_EMITTED_SIGNAL = SettingToggle( - 'SEND_TRACKING_LOG_EVENT_EMITTED_SIGNAL', +SEND_TRACKING_EVENT_EMITTED_SIGNAL = SettingToggle( + 'SEND_TRACKING_EVENT_EMITTED_SIGNAL', default=True, module_name=__name__ )