[BD-32] Hooks demo

common/djangoapps/student/signals/receivers.py

@@ -10,9 +10,12 @@
 from django.db.models.signals import post_save, pre_save
 from django.dispatch import receiver
 
+from edx_django_utils.hooks import trigger_action
+
 from lms.djangoapps.courseware.toggles import courseware_mfe_progress_milestones_are_active
 from common.djangoapps.student.helpers import EMAIL_EXISTS_MSG_FMT, USERNAME_EXISTS_MSG_FMT, AccountValidationError
 from common.djangoapps.student.models import CourseEnrollment, CourseEnrollmentCelebration, is_email_retired, is_username_retired  # lint-amnesty, pylint: disable=line-too-long
+from common.djangoapps.util.model_utils import get_changed_fields_dict
 
 
 @receiver(pre_save, sender=get_user_model())
@@ -70,3 +73,22 @@ def create_course_enrollment_celebration(sender, instance, created, **kwargs):
     except IntegrityError:
         # A celebration object was already created. Shouldn't happen, but ignore it if it does.
         pass
+
+
+@receiver(pre_save, sender=CourseEnrollment)
+def enrollment_pre_save_callback(sender, **kwargs):
+    """
+    Capture old fields on the user instance before save and cache them as a
+    private field on the current model for use in the post_save callback.
+    """
+    enrollment = kwargs['instance']
+    enrollment._changed_fields = get_changed_fields_dict(enrollment, sender)  # lint-amnesty, pylint: disable=protected-access
+
+
+@receiver(post_save, sender=CourseEnrollment)
+def trigger_post_enrollment_actions(sender, instance, created, **kwargs):
+    changed_fields = instance._changed_fields
+    if created or 'is_active' in changed_fields:
+        if instance.is_active:
+            print("triggering action")
+            trigger_action('openedx.lms.enrollment.post_enrollment.action.v1', instance, created)

lms/envs/devstack.py

@@ -432,3 +432,24 @@ def should_show_debug_toolbar(request):  # lint-amnesty, pylint: disable=missing
 # Used in edx-proctoring for ID generation in lieu of SECRET_KEY - dummy value
 # (ref MST-637)
 PROCTORING_USER_OBFUSCATION_KEY = '85920908f28904ed733fe576320db18cabd7b6cd'
+HOOKS_EXTENSION_CONFIG = {
+      "openedx.lms.auth.post_register.action.v1": {
+               "pipeline": [
+                     "openedx_basic_hooks.actions.post_register.post_register_tweet",
+                    ],
+               "async": True
+     },
+      "openedx.lms.enrollment.post_enrollment.action.v1": {
+               "pipeline": [
+                     "openedx_basic_hooks.actions.post_enrollment.post_enrollment_tweet",
+                    ],
+               "async": True
+     },
+      "openedx.lms.auth.pre_register.filter.v1": {
+               "pipeline": [
+                     "openedx_basic_hooks.filters.pre_register.check_year_of_birth",
+                    ],
+               "async": False
+          }
+
+}

openedx/core/djangoapps/user_authn/views/register.py

@@ -22,6 +22,8 @@
 from django.views.decorators.csrf import csrf_exempt, ensure_csrf_cookie
 from django.views.decorators.debug import sensitive_post_parameters
 from edx_django_utils.monitoring import set_custom_attribute
+from edx_django_utils.hooks import trigger_action, trigger_filter
+from edx_django_utils.hooks.exceptions import HookException
 from edx_toggles.toggles import LegacyWaffleFlag, LegacyWaffleFlagNamespace
 from pytz import UTC
 from ratelimit.decorators import ratelimit
@@ -248,6 +250,8 @@ def create_account_with_params(request, params):
     # Announce registration
     REGISTER_USER.send(sender=None, user=user, registration=registration)
 
+    trigger_action("openedx.lms.auth.post_register.action.v1", user, registration)
+
     create_comments_service_user(user)
 
     try:
@@ -522,6 +526,16 @@ def post(self, request):
         if response:
             return response
 
+        try:
+            trigger_filter("openedx.lms.auth.pre_register.filter.v1", data)
+        except HookException as err:
+            errors = {
+                "hook_error": [{"user_message": err.message}]
+            }
+
+            return  self._create_response(request, errors, status_code=err.status_code)
+
+
         response, user = self._create_account(request, data)
         if response:
             return response