feat: create event for response and comment events

openedx · Oct 2, 2023 · 3739f27 · 3739f27
1 parent b36ea94
commit 3739f27
Show file tree

Hide file tree

Showing 4 changed files with 99 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.8.0] - 2023-10-02
+--------------------
+Added
+~~~~~
+* Added new ``FORUM_THREAD_CREATED``, ``FORUM_RESPONSE_CREATED``, ``FORUM_COMMENT_CREATED`` events in learning subdomain
+
 [8.7.0] - 2023-09-29
 --------------------
 Added

diff --git a/openedx_events/learning/data.py b/openedx_events/learning/data.py
@@ -329,3 +329,52 @@ class ExamAttemptData:
     usage_key = attr.ib(type=UsageKey)
     exam_type = attr.ib(type=str)
     requesting_user = attr.ib(type=UserData, default=None)
+
+
+class DiscussionThreadData:
+    """
+    Attributes defined for Open edX Discussion Thread data object.
+
+    Arguments:
+        anonymous (bool): indicates whether the user is anonymous.
+        anonymous_to_peers (bool): indicates whether the user is anonymous to peers.
+        body (str): body of the discussion thread.
+        category_id (int): identifier of the category.
+        category_name (str): name of the category.
+        commentable_id (str): identifier of the commentable.
+        group_id (int): identifier of the group.
+        id (int): identifier of the discussion thread.
+        team_id (int): identifier of the team.
+        thread_type (str): type of the thread.
+        title (str): title of the thread.
+        title_truncated (bool): indicates whether the title is truncated.
+        truncated (bool): indicates whether the thread is truncated.
+        url (str): url of the thread.
+        user_id (int): identifier of the user.
+        course_id (CourseKey): identifier of the course.
+        discussion (dict): discussion data. (optional, specific to comments and responses)
+        user_course_roles (List[str]): user course roles.
+        user_forums_roles (List[str]): user forums roles.
+        options (dict): options for the thread.
+    """
+
+    anonymous = attr.ib(type=bool)
+    anonymous_to_peers = attr.ib(type=bool)
+    body = attr.ib(type=str)
+    category_id = attr.ib(type=int)
+    category_name = attr.ib(type=str)
+    commentable_id = attr.ib(type=str)
+    group_id = attr.ib(type=int)
+    id = attr.ib(type=int)
+    team_id = attr.ib(type=int)
+    thread_type = attr.ib(type=str)
+    title = attr.ib(type=str)
+    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
@@ -13,7 +13,11 @@
     CohortData,
     CourseDiscussionConfigurationData,
     CourseEnrollmentData,
+<<<<<<< HEAD
     ExamAttemptData,
+=======
+    DiscussionThreadData,
+>>>>>>> ec91c97 (feat: create event for response and comment events)
     PersistentCourseGradeData,
     ProgramCertificateData,
     UserData,
@@ -252,3 +256,39 @@
         "exam_attempt": ExamAttemptData,
     }
 )
+
+# .. event_type: org.openedx.learning.thread.created.v1
+# .. event_name: FORUM_THREAD_CREATED
+# .. event_description: Emitted when a new thread is created in a discussion
+# .. event_data: DiscussionThreadData
+#       Warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
+FORUM_THREAD_CREATED = OpenEdxPublicSignal(
+    event_type="org.openedx.learning.thread.created.v1",
+    data={
+        "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_THREAD_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_RESPONSE_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
@@ -21,7 +21,10 @@
     "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",
-    "org.openedx.learning.user.notification.requested.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",
 ]