feat: [EDXOLDMNG-218] Marks new events as incompatible with the event…

… bus
openedx · Jan 18, 2023 · 4015419 · 4015419
1 parent cb01610
commit 4015419
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/openedx_events/content_authoring/data.py b/openedx_events/content_authoring/data.py
@@ -133,5 +133,5 @@ class CertificateConfigData:
     certificate_type = attr.ib(type=str)
     course_key = attr.ib(type=CourseKey)
     title = attr.ib(type=str)
-    signatories = attr.ib(type=List[CertificateSignatoryData])
+    signatories = attr.ib(type=List[CertificateSignatoryData], factory=list)
     is_active = attr.ib(type=bool, default=False)
diff --git a/openedx_events/content_authoring/signals.py b/openedx_events/content_authoring/signals.py
@@ -72,6 +72,7 @@
 # .. event_type: org.openedx.content_authoring.course.certificate_config.changed.v1
 # .. event_name: COURSE_CERTIFICATE_CONFIG_CHANGED
 # .. event_description: Fired when a course certificate configuration changes in Studio.
+#      Warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
 # .. event_data: CertificateConfigData
 COURSE_CERTIFICATE_CONFIG_CHANGED = OpenEdxPublicSignal(
     event_type="org.openedx.content_authoring.course.certificate_config.changed.v1",
@@ -83,6 +84,7 @@
 # .. event_type: org.openedx.content_authoring.course.certificate_config.deleted.v1
 # .. event_name: COURSE_CERTIFICATE_CONFIG_DELETED
 # .. event_description: Fired when a course certificate configuration deletes in Studio.
+#      Warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
 # .. event_data: CertificateConfigData
 COURSE_CERTIFICATE_CONFIG_DELETED = OpenEdxPublicSignal(
     event_type="org.openedx.content_authoring.course.certificate_config.deleted.v1",

diff --git a/openedx_events/event_bus/avro/tests/test_avro.py b/openedx_events/event_bus/avro/tests/test_avro.py
@@ -26,7 +26,11 @@
 
 # If a signal is explicitly not for use with the event bus, add it to this list
 #  and document why in the event's annotations
-KNOWN_UNSERIALIZABLE_SIGNALS = ["org.openedx.learning.discussions.configuration.changed.v1"]
+KNOWN_UNSERIALIZABLE_SIGNALS = [
+    "org.openedx.learning.discussions.configuration.changed.v1",
+    "org.openedx.content_authoring.course.certificate_config.changed.v1",
+    "org.openedx.content_authoring.course.certificate_config.deleted.v1",
+]
 
 
 def generate_test_event_data_for_data_type(data_type):