Add tracking logs

CHANGELOG.rst

@@ -14,6 +14,12 @@ Change Log
 Unreleased
 ~~~~~~~~~~
 
+[4.0.4] - 2024-06-13
+~~~~~~~~~~~~~~~~~~~~
+
+* Emit tracking log events for `openedx.completion_aggregator.progress.*` and
+  `openedx.completion_aggregator.completion.*` for the various block/course types
+
 [4.0.3] - 2023-10-24
 ~~~~~~~~~~~~~~~~~~~~
 

completion_aggregator/__init__.py

@@ -5,4 +5,4 @@
 
 from __future__ import absolute_import, unicode_literals
 
-__version__ = '4.0.3'
+__version__ = '4.0.4'

completion_aggregator/models.py

@@ -5,6 +5,7 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
+from eventtracking import tracker
 from opaque_keys.edx.django.models import CourseKeyField, UsageKeyField
 from opaque_keys.edx.keys import CourseKey, UsageKey
 
@@ -171,8 +172,44 @@ def submit_completion(self, user, course_key, block_key, aggregation_name, earne
                 'last_modified': last_modified,
             },
         )
+        self.emit_completion_aggregator_logs([obj])
+
         return obj, is_new
 
+    @staticmethod
+    def emit_completion_aggregator_logs(updated_aggregators):
+        """
+        Emit a tracking log for each element of the list parameter.
+
+        Parameters
+        ----------
+            updated_aggregators: List of Aggregator intances
+
+        """
+        for aggregator in updated_aggregators:
+            event = "progress" if aggregator.percent < 1 else "completion"
+            event_type = aggregator.aggregation_name
+
+            if event_type not in settings.ALLOWED_COMPLETION_AGGREGATOR_EVENT_TYPES.get(event, {}):
+                continue
+
+            event_name = f"openedx.completion_aggregator.{event}.{event_type}"
+
+            tracker.emit(
+                event_name,
+                {
+                    "user_id": aggregator.user_id,
+                    "course_id": str(aggregator.course_key),
+                    "block_id": str(aggregator.block_key),
+                    "modified": aggregator.modified,
+                    "created": aggregator.created,
+                    "earned": aggregator.earned,
+                    "possible": aggregator.possible,
+                    "percent": aggregator.percent,
+                    "type": event_type,
+                }
+            )
+
     def bulk_create_or_update(self, updated_aggregators):
         """
         Update the collection of aggregator object using mysql insert on duplicate update query.
@@ -194,6 +231,7 @@ def bulk_create_or_update(self, updated_aggregators):
                 else:
                     aggregation_data = [obj.get_values() for obj in updated_aggregators]
                     cur.executemany(INSERT_OR_UPDATE_AGGREGATOR_QUERY, aggregation_data)
+                    self.emit_completion_aggregator_logs(updated_aggregators)
 
 
 class Aggregator(TimeStampedModel):

completion_aggregator/settings/common.py

@@ -9,6 +9,23 @@ def plugin_settings(settings):
     """
     Modify the provided settings object with settings specific to this plugin.
     """
+    # Emit feature allows to publish two kind of events progress and completion
+    # This setting controls which type of event will be published to change the default behavior
+    # the block type should be removed or added from the progress or completion list.
+    settings.ALLOWED_COMPLETION_AGGREGATOR_EVENT_TYPES = {
+        "progress": {
+            "course",
+            "chapter",
+            "sequential",
+            "vertical",
+        },
+        "completion": {
+            "course",
+            "chapter",
+            "sequential",
+            "vertical",
+        }
+    }
     settings.COMPLETION_AGGREGATOR_BLOCK_TYPES = {
         'course',
         'chapter',

requirements/base.in

@@ -9,5 +9,6 @@ django-model-utils    # Provides TimeStampedModel abstract base class
 edx-opaque-keys    # Provides CourseKey and UsageKey
 edx-completion
 edx-toggles
+event-tracking
 six
 XBlock[django]

requirements/base.txt

@@ -97,7 +97,7 @@ drf-jwt==1.19.2
     # via edx-drf-extensions
 edx-celeryutils==1.2.5
     # via -r requirements/base.in
-edx-completion==4.4.0
+edx-completion==4.6.0
     # via -r requirements/base.in
 edx-django-utils==5.10.1
     # via
@@ -119,7 +119,9 @@ edx-toggles==5.1.1
     #   edx-completion
     #   event-tracking
 event-tracking==2.3.0
-    # via edx-completion
+    # via
+    #   -r requirements/base.in
+    # edx-completion
 fastavro==1.9.4
     # via openedx-events
 fs==2.4.16

requirements/dev.txt

@@ -173,7 +173,7 @@ drf-jwt==1.19.2
     #   edx-drf-extensions
 edx-celeryutils==1.2.5
     # via -r requirements/quality.txt
-edx-completion==4.4.0
+edx-completion==4.6.0
     # via -r requirements/quality.txt
 edx-django-utils==5.10.1
     # via

requirements/doc.txt

@@ -184,7 +184,7 @@ edx-celeryutils==1.2.5
     # via
     #   -r requirements/base.txt
     #   -r requirements/test.txt
-edx-completion==4.4.0
+edx-completion==4.6.0
     # via
     #   -r requirements/base.txt
     #   -r requirements/test.txt

requirements/quality.txt

@@ -158,7 +158,7 @@ drf-jwt==1.19.2
     #   edx-drf-extensions
 edx-celeryutils==1.2.5
     # via -r requirements/test.txt
-edx-completion==4.4.0
+edx-completion==4.6.0
     # via -r requirements/test.txt
 edx-django-utils==5.10.1
     # via

requirements/test.txt

@@ -143,7 +143,7 @@ drf-jwt==1.19.2
     #   edx-drf-extensions
 edx-celeryutils==1.2.5
     # via -r requirements/base.txt
-edx-completion==4.4.0
+edx-completion==4.6.0
     # via -r requirements/base.txt
 edx-django-utils==5.10.1
     # via

test_settings.py

@@ -18,10 +18,24 @@ def root(*args):
     return join(abspath(dirname(__file__)), *args)
 
 
+ALLOWED_COMPLETION_AGGREGATOR_EVENT_TYPES = {
+    "progress": [
+        "course",
+        "chapter",
+        "sequential",
+        "vertical",
+    ],
+    "completion": [
+        "course",
+        "chapter",
+        "sequential",
+        "vertical",
+    ]
+}
 AUTH_USER_MODEL = 'auth.User'
 CELERY_ALWAYS_EAGER = True
 COMPLETION_AGGREGATOR_BLOCK_TYPES = {'course', 'chapter', 'sequential'}
-COMPLETION_AGGREGATOR_ASYNC_AGGREGATION = True
+COMPLETION_AGGREGATOR_ASYNC_AGGREGATION = False
 COMPLETION_AGGREGATOR_AGGREGATION_LOCK = 'COMPLETION_AGGREGATOR_AGGREGATION_LOCK'
 COMPLETION_AGGREGATOR_CLEANUP_LOCK = 'COMPLETION_AGGREGATOR_CLEANUP_LOCK'
 COMPLETION_AGGREGATOR_AGGREGATION_LOCK_TIMEOUT_SECONDS = 1800
@@ -53,6 +67,7 @@ def root(*args):
     'oauth2_provider',
     'waffle',
     'test_utils.test_app',
+    'eventtracking.django.apps.EventTrackingConfig',
 )
 
 LOCALE_PATHS = [root('completion_aggregator', 'conf', 'locale')]
@@ -81,5 +96,7 @@ def root(*args):
 ]
 USE_TZ = True
 
+EVENT_TRACKING_ENABLED = True
+
 # pylint: disable=unused-import,wrong-import-position
 from test_utils.test_app import celery  # isort:skip

tests/test_batch.py

@@ -60,6 +60,7 @@ def test_synchronous_aggregation(mock_task, users):
     assert mock_task.call_count == 4  # Called once per created BlockCompletion
 
 
+@override_settings(COMPLETION_AGGREGATOR_ASYNC_AGGREGATION=True)
 @patch('completion_aggregator.tasks.aggregation_tasks.update_aggregators.apply_async')
 def test_with_multiple_batches(mock_task, users):
     course_key = CourseKey.from_string('course-v1:OpenCraft+Onboarding+2018')
@@ -87,6 +88,7 @@ def test_with_multiple_batches(mock_task, users):
     }
 
 
+@override_settings(COMPLETION_AGGREGATOR_ASYNC_AGGREGATION=True)
 @patch('completion_aggregator.tasks.aggregation_tasks.update_aggregators.apply_async')
 def test_with_stale_completions(mock_task, users):
     course_key = CourseKey.from_string('course-v1:OpenCraft+Onboarding+2018')
@@ -107,6 +109,7 @@ def test_with_stale_completions(mock_task, users):
     assert mock_task.call_count == 2  # Called once for each user
 
 
+@override_settings(COMPLETION_AGGREGATOR_ASYNC_AGGREGATION=True)
 @patch('completion_aggregator.tasks.aggregation_tasks.update_aggregators.apply_async')
 def test_with_full_course_stale_completion(mock_task, users):
     course_key = CourseKey.from_string('course-v1:OpenCraft+Onboarding+2018')

tests/test_core.py

@@ -15,7 +15,7 @@
 from xblock.core import XBlock
 
 from django.contrib.auth import get_user_model
-from django.test import TestCase
+from django.test import TestCase, override_settings
 from django.utils.timezone import now
 
 from completion.models import BlockCompletion
@@ -282,6 +282,7 @@ def test_unmodified_course(self):
             ]
         )
 
+    @override_settings(COMPLETION_AGGREGATOR_ASYNC_AGGREGATION=True)
     @XBlock.register_temp_plugin(CourseBlock, 'course')
     @XBlock.register_temp_plugin(OtherAggBlock, 'chapter')
     @XBlock.register_temp_plugin(HTMLBlock, 'html')
@@ -319,6 +320,7 @@ def test_modified_course(self):
             ]
         )
 
+    @override_settings(COMPLETION_AGGREGATOR_ASYNC_AGGREGATION=True)
     @XBlock.register_temp_plugin(CourseBlock, 'course')
     @XBlock.register_temp_plugin(OtherAggBlock, 'chapter')
     @XBlock.register_temp_plugin(HTMLBlock, 'html')
@@ -356,6 +358,7 @@ def test_pass_changed_blocks_argument(self):
             ]
         )
 
+    @override_settings(COMPLETION_AGGREGATOR_ASYNC_AGGREGATION=True)
     @XBlock.register_temp_plugin(CourseBlock, 'course')
     @XBlock.register_temp_plugin(OtherAggBlock, 'chapter')
     @XBlock.register_temp_plugin(HTMLBlock, 'html')

tests/test_models.py

@@ -9,14 +9,17 @@
 import ddt
 import pytest
 import six
+from mock import patch
 from opaque_keys.edx.keys import UsageKey
 
+from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.core.exceptions import ValidationError
 from django.test import TestCase
 from django.utils.timezone import now
 
 from completion_aggregator.models import Aggregator
+from completion_aggregator.settings import common as common_settings
 
 
 @ddt.ddt
@@ -31,6 +34,13 @@ class AggregatorTestCase(TestCase):
     def setUp(self):
         super().setUp()
         self.user = get_user_model().objects.create(username='testuser')
+        self.tracker_patch = patch('completion_aggregator.models.tracker')
+        self.tracker_mock = self.tracker_patch.start()
+        common_settings.plugin_settings(settings)
+
+    def tearDown(self):
+        """Stop patching."""
+        self.tracker_mock.stop()
 
     def test_submit_completion_with_invalid_user(self):
         with pytest.raises(TypeError):
@@ -43,6 +53,7 @@ def test_submit_completion_with_invalid_user(self):
                 possible=27.0,
                 last_modified=now(),
             )
+            self.tracker_mock.assert_not_called()
 
     @ddt.data(
         # Valid arguments
@@ -64,6 +75,7 @@ def test_submit_completion_with_valid_data(self, block_key_obj, aggregate_name,
         self.assertEqual(obj.earned, earned)
         self.assertEqual(obj.possible, possible)
         self.assertEqual(obj.percent, expected_percent)
+        self.assert_emit_method_called(obj)
 
     @ddt.data(
         # Earned greater than possible
@@ -105,6 +117,7 @@ def test_submit_completion_with_exception(
             )
 
             self.assertEqual(exception_message, str(context_manager.exception))
+            self.tracker_mock.assert_not_called()
 
     @ddt.data(
         (
@@ -129,6 +142,7 @@ def test_aggregate_completion_string(
             f'{six.text_type(block_key_obj)}: {expected_percent}'
         )
         self.assertEqual(six.text_type(obj), expected_string)
+        self.assert_emit_method_called(obj)
 
     @ddt.data(
         # Changes the value of earned. This does not create a new object.
@@ -179,6 +193,7 @@ def test_submit_completion_twice_with_changes(
         )
         self.assertEqual(obj.percent, expected_percent)
         self.assertTrue(is_new)
+        self.assert_emit_method_called(obj)
 
         new_obj, is_new = Aggregator.objects.submit_completion(
             user=self.user,
@@ -193,6 +208,7 @@ def test_submit_completion_twice_with_changes(
         self.assertEqual(is_new, is_second_obj_new)
         if is_second_obj_new:
             self.assertNotEqual(obj.id, new_obj.id)
+        self.assert_emit_method_called(new_obj)
 
     @ddt.data(
         (BLOCK_KEY_OBJ, 'course', 0.5, 1, 0.5),
@@ -211,3 +227,26 @@ def test_get_values(self, block_key_obj, aggregate_name, earned, possible, expec
         values = aggregator.get_values()
         self.assertEqual(values['user'], self.user.id)
         self.assertEqual(values['percent'], expected_percent)
+
+    def assert_emit_method_called(self, obj):
+        """Verify that the tracker.emit method was called once with the right values."""
+        if obj.aggregation_name not in settings.ALLOWED_COMPLETION_AGGREGATOR_EVENT_TYPES:
+            return
+
+        event = "progress" if obj.percent < 1 else "completion"
+
+        self.tracker_mock.emit.assert_called_once_with(
+            f"openedx.completion_aggregator.{event}.{obj.aggregation_name}",
+            {
+                "user_id": obj.user_id,
+                "course_id": str(obj.course_key),
+                "block_id": str(obj.block_key),
+                "modified": obj.modified,
+                "created": obj.created,
+                "earned": obj.earned,
+                "possible": obj.possible,
+                "percent": obj.percent,
+                "type": obj.aggregation_name,
+            }
+        )
+        self.tracker_mock.emit.reset_mock()

tests/test_signals.py

@@ -10,7 +10,7 @@
 from opaque_keys.edx.keys import CourseKey, UsageKey
 
 from django.contrib.auth import get_user_model
-from django.test import TestCase
+from django.test import TestCase, override_settings
 from django.utils.timezone import now
 
 from completion.models import BlockCompletion
@@ -35,6 +35,7 @@ def setUp(self):
             user_model.objects.get_or_create(username='user2')[0],
         ]
 
+    @override_settings(COMPLETION_AGGREGATOR_ASYNC_AGGREGATION=True)
     @patch('completion_aggregator.tasks.aggregation_tasks.update_aggregators.apply_async')
     def test_basic(self, mock_task):
         course_key = CourseKey.from_string('edX/test/2018')