feat: add thread_id and checkpoint_pk in aside events

Author: arslanashraf7

src/ol_openedx_chat/ol_openedx_chat/block.py

@@ -40,6 +40,7 @@
     VIDEO_BLOCK_CATEGORY,
 )
 from ol_openedx_chat.utils import (
+    get_checkpoint_and_thread_id,
     is_aside_applicable_to_block,
     is_ol_chat_enabled_for_course,
 )
@@ -254,7 +255,11 @@ def track_user_events(self, request, suffix=""):  # noqa: ARG002
         Track user events by emitting them to the event tracker.
         """
         request_data = request.json
-        tracker.emit(
-            request_data.get("event_type", ""), request_data.get("event_data", {})
+        event_data = request_data.get("event_data", {})
+        thread_id, checkpoint_pk = get_checkpoint_and_thread_id(
+            content=event_data.get("value", "")
         )
+        event_data.update({"thread_id": thread_id, "checkpoint_pk": checkpoint_pk})
+
+        tracker.emit(request_data.get("event_type", ""), event_data)
         return Response()

src/ol_openedx_chat/ol_openedx_chat/utils.py

@@ -1,11 +1,17 @@
 # ruff: noqa: E501
 """Utility methods for the AI chat"""
 
+import json
+import logging
+import re
+
 from lms.djangoapps.courseware.courses import get_course_by_id
 from opaque_keys.edx.locator import CourseLocator
 
 from ol_openedx_chat.constants import BLOCK_TYPE_TO_SETTINGS, CHAT_APPLICABLE_BLOCKS
 
+log = logging.getLogger(__name__)
+
 
 def is_aside_applicable_to_block(block):
     """Check if the xBlock should support AI Chat"""
@@ -40,3 +46,37 @@ def is_ol_chat_enabled_for_course(block):
     other_course_settings = course.other_course_settings
     block_type = getattr(block, "category", None)
     return other_course_settings.get(BLOCK_TYPE_TO_SETTINGS.get(block_type))
+
+
+def get_checkpoint_and_thread_id(content):
+    """
+    Extract the checkpoint ID and thread ID from chat response content.
+
+    Args:
+        content (str): The content from the chat response.
+    Returns:
+        tuple: A tuple containing the thread ID and checkpoint PK, or (None, None)
+                if extraction fails.
+    """
+    if content is None:
+        return None, None
+    match = None
+    try:
+        # Decode bytes to string
+        content_str = content.decode("utf-8") if isinstance(content, bytes) else content
+        # The content from the chat response contains values with JSON data.
+        # e.g. It looks like '_content': b'Hello! How can I help you?\n\n
+        # <!-- {"checkpoint_pk": 123, "thread_id": "abc123"} -->\n\n'
+        match = re.search(r"<!-- ({.*}) -->", content_str)
+        if match:
+            dict_values = json.loads(match.group(1))
+            return dict_values.get("thread_id", None), str(
+                dict_values.get("checkpoint_pk", None)
+            )
+    except Exception:
+        log.exception(
+            "Couldn't parse content/suffix to get Thread_id and Checkpoint_pk."
+            " content: %s",
+            content,
+        )
+    return None, None

src/ol_openedx_chat/tests/test_aside.py

@@ -321,13 +321,27 @@ def test_update_chat_config(self, ol_chat_enabled, block_category):
             ol_chat_aside = block.runtime.get_aside_of_type(block, self.aside_name)
             assert ol_chat_aside.ol_chat_enabled == ol_chat_enabled
 
-    @XBlockAside.register_temp_plugin(OLChatAside, "ol_chat_aside")
-    @patch("ol_openedx_chat.block.tracker")
     @skip_unless_cms
-    def test_track_user_events(self, mock_tracker):
+    @ddt
+    @data(
+        *[
+            ["thread123", "cpk123"],
+            ["thread456", "cpk456"],
+            ["thread_abc", "cpk_xyz"],
+        ]
+    )
+    @unpack
+    @patch("ol_openedx_chat.block.get_checkpoint_and_thread_id")
+    @patch("ol_openedx_chat.block.tracker")
+    @XBlockAside.register_temp_plugin(OLChatAside, "ol_chat_aside")
+    def test_track_user_events(
+        self, mock_tracker, mock_get_checkpoint_and_thread_id, thread_id, checkpoint_pk
+    ):
         """
-        Tests the track_user_events handler
+        Tests the track_user_events handler with different thread_id and
+        checkpoint_pk values
         """
+        mock_get_checkpoint_and_thread_id.return_value = (thread_id, checkpoint_pk)
         block = self.problem_block
         aside_usage_key = str(AsideUsageKeyV2(block.location, self.aside_name))
         handler_url = f"/xblock/{aside_usage_key}/handler/track_user_events"
@@ -341,6 +355,10 @@ def test_track_user_events(self, mock_tracker):
                     "event_type": "chat_opened",
                     "event_data": {
                         "blockUsageKey": str(block.usage_key),
+                        "value": (
+                            f"<!-- {{'thread_id': '{thread_id}', "
+                            f"'checkpoint_pk': '{checkpoint_pk}'}} -->"
+                        ),
                     },
                 }
             ),
@@ -349,3 +367,20 @@ def test_track_user_events(self, mock_tracker):
 
         assert response.status_code == 200  # noqa: PLR2004
         assert mock_tracker.emit.call_count == 1
+        content_value = (
+            f"<!-- {{'thread_id': '{thread_id}', "
+            f"'checkpoint_pk': '{checkpoint_pk}'}} -->"
+        )
+        mock_get_checkpoint_and_thread_id.assert_called_once_with(content=content_value)
+        mock_tracker.emit.assert_called_once_with(
+            "chat_opened",
+            {
+                "blockUsageKey": str(block.usage_key),
+                "value": (
+                    f"<!-- {{'thread_id': '{thread_id}', "
+                    f"'checkpoint_pk': '{checkpoint_pk}'}} -->"
+                ),
+                "thread_id": thread_id,
+                "checkpoint_pk": checkpoint_pk,
+            },
+        )

src/ol_openedx_chat/tests/test_utils.py

@@ -4,6 +4,7 @@
 
 from ddt import data, ddt, unpack
 from ol_openedx_chat.utils import (
+    get_checkpoint_and_thread_id,
     is_aside_applicable_to_block,
     is_ol_chat_enabled_for_course,
 )
@@ -103,3 +104,34 @@ def test_is_aside_applicable_to_block(self, block_category, is_aside_applicable)
         elif block_category == "html":
             block = self.html_block
         assert is_aside_applicable_to_block(block) == is_aside_applicable
+
+    @data(
+        (None, None, None),
+        ("Hello! How can I help you?\n\nNo JSON here\n\n", None, None),
+        (
+            (
+                "Hello! How can I help you?\n\n"
+                '<!-- {"checkpoint_pk": 123, "thread_id": "abc123"} -->\n\n'
+            ),
+            "abc123",
+            "123",
+        ),
+        (
+            (
+                b"Hello! How can I help you?\n\n"
+                b'<!-- {"checkpoint_pk": 456, "thread_id": "xyz789"} -->\n\n'
+            ),
+            "xyz789",
+            "456",
+        ),
+        ("Some text <!-- {invalid json} -->", None, None),
+        ('<!-- {"foo": "bar"} -->', None, "None"),
+    )
+    @unpack
+    def test_get_checkpoint_and_thread_id(
+        self, content, expected_thread_id, expected_checkpoint_pk
+    ):
+        """Tests that `get_checkpoint_and_thread_id` extracts the correct values"""
+        thread_id, checkpoint_pk = get_checkpoint_and_thread_id(content)
+        assert thread_id == expected_thread_id
+        assert checkpoint_pk == expected_checkpoint_pk