feat: create event for response and comment events

openedx · Sep 29, 2023 · a9e78da · a9e78da
1 parent 434a194
commit a9e78da
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 1 deletion.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -17,6 +17,12 @@ Changed
 ~~~~~~~
 * Re-licensed this repository from AGPL 3.0 to Apache 2.0
 
+[8.7.0] - 2023-09-29
+--------------------
+Added
+~~~~~
+* Added new ``FORUM_THREAD_CREATED``, ``FORUM_RESPONSE_CREATED``, ``FORUM_COMMENT_CREATED`` events in learning subdomain
+
 [8.6.0] - 2023-08-28
 --------------------
 Added

diff --git a/openedx_events/__init__.py b/openedx_events/__init__.py
@@ -5,4 +5,4 @@
 more information about the project.
 """
 
-__version__ = "8.6.0"
+__version__ = "8.7.0"
diff --git a/openedx_events/learning/data.py b/openedx_events/learning/data.py
@@ -334,6 +334,9 @@ class DiscussionThreadData:
     title_truncated = attr.ib(type=bool)
     truncated = attr.ib(type=bool)
     url = attr.ib(type=str)
+    user_id = attr.ib(type=int)
+    course_id = attr.ib(type=CourseKey)
+    discussion = attr.ib(type=dict, factory=dict)
     user_course_roles = attr.ib(type=List[str], factory=list)
     user_forums_roles = attr.ib(type=List[str], factory=list)
     options = attr.ib(type=dict, factory=dict)
diff --git a/openedx_events/learning/signals.py b/openedx_events/learning/signals.py
@@ -209,3 +209,27 @@
         "thread": DiscussionThreadData,
     }
 )
+
+# .. event_type: org.openedx.learning.thread.created.v1
+# .. event_name: FORUM_RESPONSE_CREATED
+# .. event_description: Emitted when a new response is added to a thread
+# .. event_data: DiscussionThreadData
+# Warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
+FORUM_RESPONSE_CREATED = OpenEdxPublicSignal(
+    event_type="org.openedx.learning.response.created.v1",
+    data={
+        "thread": DiscussionThreadData,
+    }
+)
+
+# .. event_type: org.openedx.learning.thread.created.v1
+# .. event_name: FORUM_RESPONSE_CREATED
+# .. event_description: Emitted when a new comment is added to a thread
+# .. event_data: DiscussionThreadData
+# Warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
+FORUM_COMMENT_CREATED = OpenEdxPublicSignal(
+    event_type="org.openedx.learning.response.created.v1",
+    data={
+        "thread": DiscussionThreadData,
+    }
+)
diff --git a/openedx_events/tooling.py b/openedx_events/tooling.py
@@ -23,6 +23,8 @@
     "org.openedx.content_authoring.course.certificate_config.deleted.v1",
     "org.openedx.learning.user.notification.requested.v1",
     "org.openedx.learning.thread.created.v1",
+    "org.openedx.learning.response.created.v1",
+    "org.openedx.learning.comment.created.v1",
 ]