feat: Added enterprise uuid in event context for enterprise enrolment events

common/djangoapps/student/models.py

@@ -1377,7 +1377,7 @@ class CourseEnrollment(models.Model):
         from openedx.core.djangoapps.enrollments.permissions import ENROLL_IN_COURSE
         return not user.has_perm(ENROLL_IN_COURSE, course)
 
-    def update_enrollment(self, mode=None, is_active=None, skip_refund=False):
+    def update_enrollment(self, mode=None, is_active=None, skip_refund=False, enterprise_uuid=None):
         """
         Updates an enrollment for a user in a class.  This includes options
         like changing the mode, toggling is_active True/False, etc.
@@ -1413,7 +1413,7 @@ class CourseEnrollment(models.Model):
 
         if activation_changed:
             if self.is_active:
-                self.emit_event(EVENT_NAME_ENROLLMENT_ACTIVATED)
+                self.emit_event(EVENT_NAME_ENROLLMENT_ACTIVATED, enterprise_uuid=enterprise_uuid)
             else:
                 UNENROLL_DONE.send(sender=None, course_enrollment=self, skip_refund=skip_refund)
                 self.emit_event(EVENT_NAME_ENROLLMENT_DEACTIVATED)
@@ -1457,7 +1457,7 @@ class CourseEnrollment(models.Model):
                                   mode=mode, course_id=course_id,
                                   cost=cost, currency=currency)
 
-    def emit_event(self, event_name):
+    def emit_event(self, event_name, enterprise_uuid=None):
         """
         Emits an event to explicitly track course enrollment and unenrollment.
         """
@@ -1465,12 +1465,17 @@ class CourseEnrollment(models.Model):
 
         try:
             context = contexts.course_context_from_course_id(self.course_id)
+            if enterprise_uuid:
+                context["enterprise_uuid"] = enterprise_uuid
             assert isinstance(self.course_id, CourseKey)
             data = {
                 'user_id': self.user.id,
                 'course_id': str(self.course_id),
                 'mode': self.mode,
             }
+            if enterprise_uuid and 'username' not in context:
+                data['username'] = self.user.username
+
             segment_properties = {
                 'category': 'conversion',
                 'label': str(self.course_id),
@@ -1511,7 +1516,7 @@ class CourseEnrollment(models.Model):
                 )
 
     @classmethod
-    def enroll(cls, user, course_key, mode=None, check_access=False, can_upgrade=False):
+    def enroll(cls, user, course_key, mode=None, check_access=False, can_upgrade=False, enterprise_uuid=None):
         """
         Enroll a user in a course. This saves immediately.
 
@@ -1540,6 +1545,8 @@ class CourseEnrollment(models.Model):
                 while selecting a session. The default is set to False to avoid
                 breaking the orignal course enroll code.
 
+        enterprise_uuid (str): Add course enterprise uuid
+
         Exceptions that can be raised: NonExistentCourseError,
         EnrollmentClosedError, CourseFullError, AlreadyEnrolledError.  All these
         are subclasses of CourseEnrollmentException if you want to catch all of
@@ -1590,7 +1597,7 @@ class CourseEnrollment(models.Model):
 
         # User is allowed to enroll if they've reached this point.
         enrollment = cls.get_or_create_enrollment(user, course_key)
-        enrollment.update_enrollment(is_active=True, mode=mode)
+        enrollment.update_enrollment(is_active=True, mode=mode, enterprise_uuid=enterprise_uuid)
         enrollment.send_signal(EnrollStatusChange.enroll)
 
         return enrollment

common/djangoapps/track/contexts.py

@@ -68,7 +68,8 @@ def context_dict_for_learning_context(context_key):
         {
             'context_id': 'course-v1:org+course+run',
             'course_id': 'course-v1:org+course+run',
-            'org_id': 'org'
+            'org_id': 'org',
+            'enterprise_uuid': 'enterprise_customer_uuid'
         }
 
     Example 2::
@@ -76,7 +77,8 @@ def context_dict_for_learning_context(context_key):
         {
             'context_id': 'lib:edX:a-content-library',
             'course_id': '',
-            'org_id': 'edX'
+            'org_id': 'edX',
+            'enterprise_uuid': '1a0fbcbe-49e5-42f1-8e83-4cddfa592f22'
         }
 
     """
@@ -84,6 +86,7 @@ def context_dict_for_learning_context(context_key):
         'context_id': str(context_key) if context_key else '',
         'course_id': '',
         'org_id': '',
+        'enterprise_uuid': '',
     }
     if context_key is not None:
         assert isinstance(context_key, LearningContextKey)
@@ -91,4 +94,6 @@ def context_dict_for_learning_context(context_key):
             context_dict['course_id'] = str(context_key)
         if hasattr(context_key, 'org'):
             context_dict['org_id'] = context_key.org
+        if hasattr(context_key, 'enterprise_uuid'):
+            context_dict['enterprise_uuid'] = context_key.enterprise_uuid
     return context_dict

common/djangoapps/track/tests/test_contexts.py

@@ -28,13 +28,13 @@ class TestContexts(TestCase):  # lint-amnesty, pylint: disable=missing-class-doc
 
     def assert_parses_course_id_from_url(self, format_string, course_id):
         assert contexts.course_context_from_url(format_string.format(course_id=course_id)) ==\
-               {'course_id': course_id, 'org_id': self.ORG_ID}
+               {'course_id': course_id, 'org_id': self.ORG_ID, 'enterprise_uuid': ''}
 
     def test_no_course_id_in_url(self):
         self.assert_empty_context_for_url('http://foo.bar.com/dashboard')
 
     def assert_empty_context_for_url(self, url):
-        assert contexts.course_context_from_url(url) == {'course_id': '', 'org_id': ''}
+        assert contexts.course_context_from_url(url) == {'course_id': '', 'org_id': '', 'enterprise_uuid': ''}
 
     @ddt.data('', '/', '/?', '?format=json')
     def test_malformed_course_id(self, postfix):

common/djangoapps/track/tests/test_middleware.py

@@ -74,9 +74,11 @@ class TrackMiddlewareTestCase(TestCase):
 
     def test_default_request_context(self):
         context = self.get_context_for_path('/courses/')
-        assert context == {'accept_language': '', 'referer': '', 'user_id': '', 'session': '', 'username': '',
-                           'ip': '127.0.0.1', 'host': 'testserver', 'agent': '', 'path': '/courses/', 'org_id': '',
-                           'course_id': '', 'client_id': None}
+        assert context == {
+            'accept_language': '', 'referer': '', 'user_id': '', 'session': '', 'username': '', 'ip': '127.0.0.1',
+            'host': 'testserver', 'agent': '', 'path': '/courses/', 'org_id': '', 'course_id': '', 'client_id': None,
+            'enterprise_uuid': ''
+        }
 
     def test_no_forward_for_header_ip_context(self):
         request = self.request_factory.get('/courses/')

common/djangoapps/track/views/tests/test_views.py

@@ -238,6 +238,7 @@ class TestTrackViews(EventTrackingTestCase):  # lint-amnesty, pylint: disable=mi
                     'referer': '',
                     'client_id': None,
                     'course_id': 'foo/bar/baz',
+                    'enterprise_uuid': '',
                     'path': self.path_with_course,
                     'page': None
                 }
@@ -279,6 +280,7 @@ class TestTrackViews(EventTrackingTestCase):  # lint-amnesty, pylint: disable=mi
                     'referer': '',
                     'client_id': '1033501218.1368477899',
                     'course_id': 'foo/bar/baz',
+                    'enterprise_uuid': '',
                     'path': self.path_with_course,
                     'page': None
                 }