edx-enterprise-data 9.8.1__tar.gz → 9.9.2__tar.gz

{edx_enterprise_data-9.8.1 → edx_enterprise_data-9.9.2}/CHANGELOG.rst

@@ -16,6 +16,18 @@ Unreleased
 
 =========================
 
+[10.9.2] - 2025-03-11
+---------------------
+  * feat: support flex groups in csv report on LPR.
+
+[10.9.0] - 2025-02-24
+---------------------
+  * feat: get groups data from membership endpoint using enterprise client.
+
+[10.8.1] - 2025-02-20
+---------------------
+  * fix: Limited accuracy of floating pointing numbers to 2 places.
+
 [10.8.1] - 2025-02-20
 ---------------------
   * feat: Added 2 new columns in module performance report model and exposed them via associated REST API.

{edx_enterprise_data-9.8.1/edx_enterprise_data.egg-info → edx_enterprise_data-9.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-data
-Version: 9.8.1
+Version: 9.9.2
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX

{edx_enterprise_data-9.8.1 → edx_enterprise_data-9.9.2/edx_enterprise_data.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-data
-Version: 9.8.1
+Version: 9.9.2
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX

{edx_enterprise_data-9.8.1 → edx_enterprise_data-9.9.2}/edx_enterprise_data.egg-info/SOURCES.txt

@@ -118,6 +118,7 @@ enterprise_data/migrations/0044_enterpriseexecedlcmoduleperformance.py
 enterprise_data/migrations/0045_alter_enterpriseexecedlcmoduleperformance_options_and_more.py
 enterprise_data/migrations/0046_enterprisegroupmembership.py
 enterprise_data/migrations/0047_enterpriseexecedlcmoduleperformance_avg_after_lo_score_and_more.py
+enterprise_data/migrations/0048_alter_enterpriseexecedlcmoduleperformance_avg_after_lo_score_and_more.py
 enterprise_data/migrations/__init__.py
 enterprise_data/settings/__init__.py
 enterprise_data/settings/test.py

{edx_enterprise_data-9.8.1 → edx_enterprise_data-9.9.2}/enterprise_data/__init__.py

@@ -2,4 +2,4 @@
 Enterprise data api application. This Django app exposes API endpoints used by enterprises.
 """
 
-__version__ = "9.8.1"
+__version__ = "9.9.2"

{edx_enterprise_data-9.8.1 → edx_enterprise_data-9.9.2}/enterprise_data/api/v1/serializers.py

@@ -6,6 +6,7 @@ from uuid import UUID
 from rest_framework import serializers
 
 from enterprise_data.admin_analytics.constants import ResponseType
+from enterprise_data.cache.decorators import cache_it
 from enterprise_data.models import (
     EnterpriseAdminLearnerProgress,
     EnterpriseAdminSummarizeInsights,
@@ -26,6 +27,8 @@ class EnterpriseLearnerEnrollmentSerializer(serializers.ModelSerializer):
     course_api_url = serializers.SerializerMethodField()
     enterprise_user_id = serializers.SerializerMethodField()
     total_learning_time_hours = serializers.SerializerMethodField()
+    enterprise_flex_group_name = serializers.SerializerMethodField()
+    enterprise_flex_group_uuid = serializers.SerializerMethodField()
 
     class Meta:
         model = EnterpriseLearnerEnrollment
@@ -44,8 +47,9 @@ class EnterpriseLearnerEnrollmentSerializer(serializers.ModelSerializer):
             'last_activity_date', 'progress_status', 'passed_date', 'current_grade',
             'letter_grade', 'enterprise_user_id', 'user_email', 'user_account_creation_date',
             'user_country_code', 'user_username', 'user_first_name', 'user_last_name', 'enterprise_name',
-            'enterprise_customer_uuid', 'enterprise_sso_uid', 'created', 'course_api_url', 'total_learning_time_hours',
-            'is_subsidy', 'course_product_line', 'budget_id', 'enterprise_group_name', 'enterprise_group_uuid',
+            'enterprise_customer_uuid', 'enterprise_sso_uid', 'created', 'course_api_url',
+            'total_learning_time_hours', 'is_subsidy', 'course_product_line', 'budget_id',
+            'enterprise_flex_group_name', 'enterprise_flex_group_uuid',
         )
 
     def get_course_api_url(self, obj):
@@ -62,6 +66,51 @@ class EnterpriseLearnerEnrollmentSerializer(serializers.ModelSerializer):
         """Returns the learners total learning time in hours"""
         return round((obj.total_learning_time_seconds or 0.0)/3600.0, 2)
 
+    @cache_it()
+    def _get_flex_groups(self, obj):
+        """
+        Returns list of tuples containing group (name, uuid) pairs for the learner.
+        This is cached to prevent duplicate database queries.
+        """
+        enterprise_user_id = obj.enterprise_user_id
+
+        if not enterprise_user_id:
+            return []
+
+        # Get all group memberships for this user in a single query
+        # Order by name for consistent ordering
+        return list(
+            EnterpriseGroupMembership.objects.filter(
+                enterprise_customer_user_id=enterprise_user_id,
+                membership_is_removed=False,
+                group_is_removed=False,
+                group_type="flex",
+            )
+            .order_by("enterprise_group_name")
+            .values_list("enterprise_group_name", "enterprise_group_uuid")
+            .distinct()
+        )
+
+    def get_enterprise_flex_group_name(self, obj):
+        """Returns a comma-separated list of enterprise group names that the learner is associated with"""
+        groups = self._get_flex_groups(obj)
+
+        if not groups:
+            return obj.enterprise_group_name
+
+        # Return comma-separated list of group names (first element of each tuple)
+        return ', '.join(group[0] for group in groups)
+
+    def get_enterprise_flex_group_uuid(self, obj):
+        """Returns a comma-separated list of enterprise group UUIDs that the learner is associated with"""
+        groups = self._get_flex_groups(obj)
+
+        if not groups:
+            return obj.enterprise_group_uuid
+
+        # Return comma-separated list of group UUIDs (second element of each tuple)
+        return ', '.join(str(group[1]) for group in groups)
+
 
 class EnterpriseSubsidyBudgetSerializer(serializers.ModelSerializer):
     """

{edx_enterprise_data-9.8.1 → edx_enterprise_data-9.9.2}/enterprise_data/api/v1/views/enterprise_learner.py

@@ -8,6 +8,7 @@ from uuid import UUID
 
 from rest_framework import filters, viewsets
 from rest_framework.decorators import action
+from rest_framework.exceptions import NotFound
 from rest_framework.response import Response
 
 from django.conf import settings
@@ -20,6 +21,7 @@ from django.utils import timezone
 
 from enterprise_data.admin_analytics.database.utils import LOGGER
 from enterprise_data.api.v1 import serializers
+from enterprise_data.clients import EnterpriseApiClient
 from enterprise_data.models import EnterpriseGroupMembership, EnterpriseLearner, EnterpriseLearnerEnrollment
 from enterprise_data.paginators import EnterpriseEnrollmentsPagination
 from enterprise_data.renderers import EnrollmentsCSVRenderer
@@ -176,12 +178,51 @@ class EnterpriseLearnerEnrollmentViewSet(EnterpriseViewSetMixin, viewsets.ReadOn
 
         group_uuid = query_filters.get('group_uuid')
         if group_uuid:
-            flex_group_exists = EnterpriseGroupMembership.objects.filter(
-                enterprise_customer_user_id=OuterRef('enterprise_user_id'),
-                enterprise_group_uuid=group_uuid,
-                group_type='flex'
-            )
-            queryset = queryset.filter(Exists(flex_group_exists))
+            queryset = self.filter_by_group_uuid(queryset, group_uuid)
+
+        return queryset
+
+    def filter_by_group_uuid(self, queryset, group_uuid):
+        """
+        Filters the queryset based on the provided group_uuid. If no records are found,
+        it attempts to fetch group learners from the API and filter the queryset again.
+
+        Args:
+            queryset (QuerySet): The initial queryset to filter.
+            group_uuid (str): The UUID of the group to filter by.
+
+        Returns:
+            QuerySet: The filtered queryset.
+        """
+        flex_group_exists = EnterpriseGroupMembership.objects.filter(
+            enterprise_customer_user_id=OuterRef('enterprise_user_id'),
+            enterprise_group_uuid=group_uuid,
+            group_type='flex'
+        )
+
+        # First, filter the queryset using flex_group_exists
+        filtered_queryset = queryset.filter(Exists(flex_group_exists))
+
+        # If no records are found, attempt to fetch group_learners from the API
+        if not filtered_queryset.exists():
+            try:
+                enterprise_api_client = EnterpriseApiClient(
+                    settings.BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL,
+                    settings.BACKEND_SERVICE_EDX_OAUTH2_KEY,
+                    settings.BACKEND_SERVICE_EDX_OAUTH2_SECRET,
+                )
+                group_learners = enterprise_api_client.get_enterprise_group_learners(group_uuid)
+                if group_learners:
+                    group_learners_ids = [learner['enterprise_customer_user_id'] for learner in group_learners]
+                    queryset = queryset.filter(enterprise_user_id__in=group_learners_ids)
+                else:
+                    LOGGER.warning(f"No group learners found for group: {group_uuid}")
+                    raise NotFound(f"No learners found for group: {group_uuid}")
+            except (Exception) as e:  # pylint: disable=broad-exception-caught
+                LOGGER.error("Failed to fetch group learners from API: %s", e)
+                queryset = queryset.none()  # API call failed or unexpected error, return an empty queryset
+        else:
+            queryset = filtered_queryset
 
         return queryset
 

{edx_enterprise_data-9.8.1 → edx_enterprise_data-9.9.2}/enterprise_data/clients.py

@@ -101,3 +101,30 @@ class EnterpriseApiClient(OAuthAPIClient):
         TieredCache.set_all_tiers(cache_key, data, DEFAULT_REPORTING_CACHE_TIMEOUT)
 
         return data
+
+    def get_enterprise_group_learners(self, group_uuid):
+        """
+        Get the learners associated with a given enterprise group.
+
+        Returns: list of learners or None if unable to retrieve or no learners exist
+        """
+        LOGGER.info(f'[EnterpriseApiClient] getting learners for enterprise group:{group_uuid}')
+        url = urljoin(self.API_BASE_URL, f'enterprise-group/{group_uuid}/learners/')
+        all_learners = []
+
+        try:
+            while url:
+                response = self.get(url)
+                response.raise_for_status()
+                data = response.json()
+                all_learners.extend(data.get('results', []))
+                url = data.get('next')  # Get the URL for the next page, if any
+
+        except (HTTPError, RequestException) as exc:
+            LOGGER.warning(
+                "[Data Overview Failure] Unable to retrieve Enterprise Group Learners details. "
+                f"Group: {group_uuid}, Exception: {exc}"
+            )
+            return None
+
+        return all_learners

edx_enterprise_data-9.9.2/enterprise_data/migrations/0048_alter_enterpriseexecedlcmoduleperformance_avg_after_lo_score_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 4.2.15 on 2025-02-25 08:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('enterprise_data', '0047_enterpriseexecedlcmoduleperformance_avg_after_lo_score_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='enterpriseexecedlcmoduleperformance',
+            name='avg_after_lo_score',
+            field=models.DecimalField(decimal_places=2, max_digits=38, null=True),
+        ),
+        migrations.AlterField(
+            model_name='enterpriseexecedlcmoduleperformance',
+            name='avg_before_lo_score',
+            field=models.DecimalField(decimal_places=2, max_digits=38, null=True),
+        ),
+    ]

{edx_enterprise_data-9.8.1 → edx_enterprise_data-9.9.2}/enterprise_data/models.py

@@ -559,8 +559,8 @@ class EnterpriseExecEdLCModulePerformance(models.Model):
     discussion_forum_activities_total_count = models.PositiveIntegerField(null=True)
     pass_grade = models.DecimalField(max_digits=38, decimal_places=2, null=True)
     question_name = models.CharField(max_length=500, null=True)
-    avg_before_lo_score = models.DecimalField(max_digits=38, decimal_places=6, null=True)
-    avg_after_lo_score = models.DecimalField(max_digits=38, decimal_places=6, null=True)
+    avg_before_lo_score = models.DecimalField(max_digits=38, decimal_places=2, null=True)
+    avg_after_lo_score = models.DecimalField(max_digits=38, decimal_places=2, null=True)
 
     def __str__(self):
         """

{edx_enterprise_data-9.8.1 → edx_enterprise_data-9.9.2}/enterprise_data/renderers.py

@@ -27,7 +27,7 @@ class EnrollmentsCSVRenderer(CSVStreamingRenderer):
         'letter_grade', 'enterprise_user_id', 'user_email', 'user_account_creation_date',
         'user_country_code', 'user_username', 'user_first_name', 'user_last_name', 'enterprise_name',
         'enterprise_customer_uuid', 'enterprise_sso_uid', 'created', 'course_api_url', 'total_learning_time_hours',
-        'is_subsidy', 'course_product_line', 'budget_id', 'enterprise_group_name', 'enterprise_group_uuid',
+        'is_subsidy', 'course_product_line', 'budget_id', 'enterprise_flex_group_name', 'enterprise_flex_group_uuid',
     ]