Merge pull request #25727 from edx/ammar/add-logs-for-dsc-flow

add logs for dsc flow to identify why `None` is being returned as enterprise customer uuid for a learner even though the leaner has a valid active enterprise present

openedx/features/enterprise_support/api.py

@@ -477,6 +477,11 @@ def enterprise_customer_uuid_for_request(request):
                 enterprise_customer_identity_provider__provider_id=sso_provider_id
             ).uuid
         except EnterpriseCustomer.DoesNotExist:
+            LOGGER.info(
+                '[ENTERPRISE DSC] Customer not found using SSO Provider ID. User: [%s], SSOProviderID: [%s]',
+                request.user.username,
+                sso_provider_id
+            )
             enterprise_customer_uuid = None
     else:
         enterprise_customer_uuid = _customer_uuid_from_query_param_cookies_or_session(request)
@@ -499,6 +504,12 @@ def enterprise_customer_uuid_for_request(request):
         # Now that we've asked the database for this users's enterprise customer data,
         # add it to their session (even if it's null/empty, which indicates the user
         # has no associated enterprise customer).
+        LOGGER.info(
+            '[ENTERPRISE DSC] Updating Session. User: [%s], UserAuthenticated: [%s], EnterpriseCustomer: [%s]',
+            request.user.username,
+            request.user.is_authenticated,
+            enterprise_customer
+        )
         add_enterprise_customer_to_session(request, enterprise_customer)
 
     return enterprise_customer_uuid
@@ -517,6 +528,12 @@ def _customer_uuid_from_query_param_cookies_or_session(request):
     ):
         enterprise_customer_uuid = function(request)
         if enterprise_customer_uuid is not _CACHE_MISS:
+            LOGGER.info(
+                '[ENTERPRISE DSC] Customer Info. User: [%s], Function: [%s], UUID: [%s]',
+                request.user.username,
+                function,
+                enterprise_customer_uuid
+            )
             return enterprise_customer_uuid
 
     return _CACHE_MISS
@@ -531,6 +548,12 @@ def enterprise_customer_for_request(request):
     enterprise_customer = enterprise_customer_from_session(request)
     if enterprise_customer is _CACHE_MISS:
         enterprise_customer = enterprise_customer_from_api(request)
+        LOGGER.info(
+            '[ENTERPRISE DSC] Updating Session. User: [%s], UserAuthenticated: [%s], EnterpriseCustomer: [%s]',
+            request.user.username,
+            request.user.is_authenticated,
+            enterprise_customer
+        )
         add_enterprise_customer_to_session(request, enterprise_customer)
     return enterprise_customer
 
@@ -596,8 +619,7 @@ def consent_needed_for_course(request, user, course_id, enrollment_exists=False)
 
             if str(current_enterprise_uuid) not in enterprises:
                 LOGGER.info(  # pragma: no cover
-                    '[ENTERPRISE DSC] Consent requirement failed due to enterprise mismatch. '
-                    'USER: [%s], CurrentEnterprise: [%s], LearnerEnterprises: [%s]',
+                    '[ENTERPRISE DSC] Enterprise mismatch. USER: [%s], CurrentEnterprise: [%s], UserEnterprises: [%s]',
                     user.username,
                     current_enterprise_uuid,
                     enterprises
@@ -606,8 +628,7 @@ def consent_needed_for_course(request, user, course_id, enrollment_exists=False)
                 domains = [learner['enterprise_customer']['site']['domain'] for learner in enterprise_learner_details]
                 if not Site.objects.filter(domain__in=domains).filter(id=request.site.id).exists():
                     LOGGER.info(  # pragma: no cover
-                        '[ENTERPRISE DSC] Consent requirement failed due to site mismatch. '
-                        'USER: [%s], RequestSite: [%s], LearnerEnterpriseDomains: [%s]',
+                        '[ENTERPRISE DSC] Site mismatch. USER: [%s], RequestSite: [%s], LearnerEnterpriseDomains: [%s]',
                         user.username,
                         request.site,
                         domains
@@ -748,6 +769,12 @@ def get_enterprise_learner_portal_enabled_message(request):
         learner_data = get_enterprise_learner_data_from_db(request.user)
         enterprise_customer = learner_data[0]['enterprise_customer'] if learner_data else None
         # Add to session cache regardless of whether it is null
+        LOGGER.info(
+            '[ENTERPRISE DSC] Updating Session. User: [%s], UserAuthenticated: [%s], EnterpriseCustomer: [%s]',
+            request.user.username,
+            request.user.is_authenticated,
+            enterprise_customer
+        )
         add_enterprise_customer_to_session(request, enterprise_customer)
         if enterprise_customer:
             cache_enterprise(enterprise_customer)