edx-enterprise-data 10.10.1__py3-none-any.whl → 10.11.0__py3-none-any.whl

{edx_enterprise_data-10.10.1.dist-info → edx_enterprise_data-10.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: edx-enterprise-data
-Version: 10.10.1
+Version: 10.11.0
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX
@@ -45,6 +45,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: home-page
 Dynamic: license
+Dynamic: license-file
 Dynamic: provides-extra
 Dynamic: requires-dist
 Dynamic: summary

{edx_enterprise_data-10.10.1.dist-info → edx_enterprise_data-10.11.0.dist-info}/RECORD

@@ -1,7 +1,9 @@
-enterprise_data/__init__.py,sha256=ZNUDCqsK0PsxTU8WCuIxtRJVuai59_dk0bJuCzGqMgY,125
+edx_enterprise_data-10.11.0.dist-info/licenses/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+enterprise_data/__init__.py,sha256=nDaMECZ0E2QipjI60KC7fwBRg7oDJLQr1bfT6czggFQ,125
 enterprise_data/apps.py,sha256=aF6hZwDfI2oWj95tUTm_2ikHueQj-jLj-u0GrgzpsQI,414
-enterprise_data/clients.py,sha256=pBuCQOP7NYl264ZbMtZCRPCET1pg0by8w6PVlA-icKA,4995
+enterprise_data/clients.py,sha256=glw-fXu3V7rKEpiUBF056gZEdNK4KnWcP9tNYELimRQ,6566
 enterprise_data/constants.py,sha256=uCKjfpdlMYFZJsAj3n9RMw4Cmg5_6s3NuwocO-fch3s,238
+enterprise_data/exceptions.py,sha256=4AI6mdxgH3aNYJm5RCfxsf19MFSFIXc9xTWwPeERgHc,420
 enterprise_data/filters.py,sha256=D2EiK12MMpBoz6eOUmTpoJEhj_sH7bA93NRRAdvkDVo,6163
 enterprise_data/models.py,sha256=gbZl-ei0qe_l-BFeE0gWeyfWqmgi9X9LAF8MYOEfk2s,26555
 enterprise_data/paginators.py,sha256=YPrC5TeXFt-ymenT2H8H2nCbDCnAzJQlH9kFPElRxWE,269
@@ -14,14 +16,22 @@ enterprise_data/admin_analytics/constants.py,sha256=-6uLAq5DUeA_rv5eUb9SeqlG3iVW
 enterprise_data/admin_analytics/data_loaders.py,sha256=b6RjEIxCol8ETQMY7QfwhqN9eEAvrUN_UldIG7rgsSY,736
 enterprise_data/admin_analytics/database/__init__.py,sha256=vNSWKf2VV5xMegN7htJJtxtQEb0ASLC6frE2w0ZpYpE,104
 enterprise_data/admin_analytics/database/utils.py,sha256=5u-d6ZQW95mF_r4bH8Xdi7DgpYAuDFOG_q0P-bjKXHU,1712
+enterprise_data/admin_analytics/database/filters/__init__.py,sha256=ZteBm55429cn8zaUVYHRFA7InQPWP0b4XiZeq24HQT4,115
+enterprise_data/admin_analytics/database/filters/base.py,sha256=nOek6XgHEVBKUTGk-K0PZpy0RSZB3D7kc8OD5nlqXcE,71
+enterprise_data/admin_analytics/database/filters/fact_enrollment_admin_dash.py,sha256=WKRBWRCujiMay2ePdl9vnNN1ux-LO0edyb79W4dm-S4,1808
 enterprise_data/admin_analytics/database/queries/__init__.py,sha256=IC5TLOr_GnydbrVbl2mWhwO3aUbYeHuDmfPTLmwGhZA,218
 enterprise_data/admin_analytics/database/queries/fact_engagement_admin_dash.py,sha256=eLy9GT0gFGLbw8yZZdEaeCAw0pTEUsy0-Ud5g2T9T80,10836
-enterprise_data/admin_analytics/database/queries/fact_enrollment_admin_dash.py,sha256=ikTly1_fb-xzrXUTpA7B2dRRYpcuDhbpxMBkxbs-DP4,11064
+enterprise_data/admin_analytics/database/queries/fact_enrollment_admin_dash.py,sha256=0YbIQvNL8pgi-apsoYzBSnDeouiqZIUlYzIH4xkbY_w,10942
 enterprise_data/admin_analytics/database/queries/skills_daily_rollup_admin_dash.py,sha256=ZaJPghTrQvBGsFxfpeR8EE45ujtaYI9R_xkoDDqD2So,4269
+enterprise_data/admin_analytics/database/query_filters/__init__.py,sha256=xW9cf5KGpMs33tTlil5gzKq4RxcZVCJZESsrHo2X0E4,182
+enterprise_data/admin_analytics/database/query_filters/base.py,sha256=XZUC1AIaDPBq0cwh2Xn5wp_DZfsD3HnMMvqFUt7iM2E,2205
+enterprise_data/admin_analytics/database/query_filters/between.py,sha256=YvAM4WSJSCHb1nCzeJLwku4zkJKHrqnSrEnl7-xMOoA,924
+enterprise_data/admin_analytics/database/query_filters/equal.py,sha256=Z4OPVSZmoC52HElwladgydSx2VHLJmptke0QS2mNbz8,744
+enterprise_data/admin_analytics/database/query_filters/in_.py,sha256=RsqDVTgzJ0vvEMmtyefPNZh8U3eShLp7ZqY_J5oC45E,802
 enterprise_data/admin_analytics/database/tables/__init__.py,sha256=Z-c3P9hqR-dC9uYKe63qHkQG9Nms8cLE2jRN-4jeMM0,289
 enterprise_data/admin_analytics/database/tables/base.py,sha256=1KyKsC18pW3m-5U-T6pdt5rIwsz6Wp3QFFbD3r6L6YQ,395
 enterprise_data/admin_analytics/database/tables/fact_engagement_admin_dash.py,sha256=VMUGwfrUsYd_NnxEDNBovAmHwhdTCSImGA6JjHzknhk,12959
-enterprise_data/admin_analytics/database/tables/fact_enrollment_admin_dash.py,sha256=cRRBFRc2p54BkW_h7GuUud-gWzJrqKep9dYgxOf7tIY,11741
+enterprise_data/admin_analytics/database/tables/fact_enrollment_admin_dash.py,sha256=9YPX9vdNGQD-bqpRd_voqH8lJ5mSakibc2FgFKfJPPk,15828
 enterprise_data/admin_analytics/database/tables/skills_daily_rollup_admin_dash.py,sha256=3xNwSi0wfCyBHcXPd6-9Ujs1NUm8kmZRg_gPrZzp9nQ,3233
 enterprise_data/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/api/urls.py,sha256=POqc_KATHdnpMf9zHtpO46pKD5KAlAExtx7G6iylLcU,273
@@ -30,16 +40,16 @@ enterprise_data/api/v0/serializers.py,sha256=dngZTk6DhRxApchQKCMp1B_c8aVnQtH0NCq
 enterprise_data/api/v0/urls.py,sha256=vzJjqIo_S3AXWs9Us8XTaJc3FnxLbYzAkmLyuDQqum0,699
 enterprise_data/api/v0/views.py,sha256=4RslZ4NZOU-844bnebEQ71ji2utRY7jEijqC45oQQD0,14380
 enterprise_data/api/v1/__init__.py,sha256=1aAzAYU5hk-RW6cKUxa1645cbZMxn7GIZ7OMjWc9MKI,46
-enterprise_data/api/v1/serializers.py,sha256=27LcGcIJPPVm4PedHdgQclrPpdKhtd3E0OJYf4u5sBU,13788
+enterprise_data/api/v1/serializers.py,sha256=U3zxiideqwpoJuofI0dkx0AwbN2GUiELxqJIXIVwI9s,13843
 enterprise_data/api/v1/urls.py,sha256=Wl1xLboPg-Lq1ZvjAWf51JKYkHlmx02Kpq1nwfDyS8s,4372
 enterprise_data/api/v1/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/api/v1/views/analytics_completions.py,sha256=esFbJ5q8ssnm2Mfbc3rZXtiGHF-MeM4KQ4Ft3N7wwHU,6260
 enterprise_data/api/v1/views/analytics_engagements.py,sha256=Yo-bpA-0xOQHUPTFF0jHWxjm6KpSC-l2nGxhYX0ajBk,6298
-enterprise_data/api/v1/views/analytics_enrollments.py,sha256=hw87VZ0hFWpwf3QEHFn9cUgDy2s7SzsXt6Rf9TaNsS0,6282
+enterprise_data/api/v1/views/analytics_enrollments.py,sha256=_KBo4RhEmfQXcCOgvowD28WCVJwlc4APuCnRDbAYK9E,6563
 enterprise_data/api/v1/views/analytics_leaderboard.py,sha256=3dyo7_OhyGEEeibemBrRsUOo0jbM4LbDgV5gw3YnVig,4186
 enterprise_data/api/v1/views/base.py,sha256=Kkmd5zgEBAhvwS_GoGXSK6lgbDNwSPioYn-QbnizI3w,3416
 enterprise_data/api/v1/views/enterprise_admin.py,sha256=xxpb48cjuHkFJH-IQG0DwOvdH8RgyYD-aQjyfMMJNFg,9030
-enterprise_data/api/v1/views/enterprise_learner.py,sha256=noFAKFe1T8CXRSFt8aMajF-utPO4x2WK-kxdIYw5qE4,20601
+enterprise_data/api/v1/views/enterprise_learner.py,sha256=vRzfaQCEoeq_tEY7KsNZJVzgn7XEWZ1l-n0oUoSVGyU,20093
 enterprise_data/api/v1/views/enterprise_offers.py,sha256=VifxgqTLFLVw4extYPlHcN1N_yjXcsYsAlYEnAbpb10,1266
 enterprise_data/cache/__init__.py,sha256=fiBUploll1kmDy2vCmnNpeZVTD4ewsgtRF14vVs0Rb4,1850
 enterprise_data/cache/decorators.py,sha256=vLbXK9VSv-HzVkkXS1-TkuSMxudwyxz04WFsAXqmjuM,1273
@@ -54,7 +64,7 @@ enterprise_data/management/commands/create_enterprise_learner_enrollment_lpr_v1.
 enterprise_data/management/commands/create_enterprise_learner_lpr_v1.py,sha256=bUYmZHA3yK3ZBPhV0wkpRDgH_Q2b5rVQnwSp2hRmh28,1799
 enterprise_data/management/commands/create_enterprise_offer.py,sha256=0R1eEKWTCGjod4I8qBH2UBD-erqj5mFtM_DG5Vxet_0,1150
 enterprise_data/management/commands/create_enterprise_user.py,sha256=V_kvOSPZ1DXfAdF1W3AwAtavEYjdYaHBjjfzndZP8lk,1498
-enterprise_data/management/commands/pre_warm_analytics_cache.py,sha256=3MCThZiZgfveD3NqFt95WTJ9LFTYxN8ZYbqWF1JinI8,8327
+enterprise_data/management/commands/pre_warm_analytics_cache.py,sha256=i64hcbvqGW0UWYbx046iEETzCOcva1cdYumdb5RByGU,8522
 enterprise_data/management/commands/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/management/commands/tests/test_create_dummy_data_lpr_v1.py,sha256=wt9fqAFKQVTqllpZ42dch-n31JavUifUIB9CKNYcnYM,1086
 enterprise_data/management/commands/tests/test_create_enterprise_enrollment.py,sha256=5CABLk8qAx8RP8mrFtnbJ4-xVkf9-5Mq6iQcx8jBfFc,1742
@@ -121,7 +131,7 @@ enterprise_data/tests/test_utils.py,sha256=3sM3YWEoihHupgwhh0NiI66CbcQPLY4I_W0xj
 enterprise_data/tests/test_views.py,sha256=UvDRNTxruy5zBK_KgUy2cBMbwlaTW_vkM0-TCXbQZiY,69667
 enterprise_data/tests/admin_analytics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/tests/admin_analytics/mock_analytics_data.py,sha256=qN73YxoD1kAtKsQo94avR0DGMCsJClrpqFxxYC6reqE,15248
-enterprise_data/tests/admin_analytics/mock_enrollments.py,sha256=u61tkqSdVKExURJF7arvBoXvbdkF39CkjxQiTvVMXIE,4467
+enterprise_data/tests/admin_analytics/mock_enrollments.py,sha256=n67vb0dQVbNaI1PvEPlo8ljkrlQ5RvnHpR2kVuOk1go,4632
 enterprise_data/tests/admin_analytics/test_analytics_engagements.py,sha256=gfO6RI2gbDMhOD4p4h7l6sZpisglBreTPtJRqNxIgo8,10440
 enterprise_data/tests/admin_analytics/test_analytics_enrollments.py,sha256=uFa6gnlf-CthctdYTWsw-pLLOxkELGiq8YFq5CyWFbs,10826
 enterprise_data/tests/admin_analytics/test_analytics_leaderboard.py,sha256=iFT47BVlgf93u1K2l3_8HDcXY-9vWKp3iUaWM7V0C2U,5476
@@ -151,7 +161,7 @@ enterprise_data_roles/migrations/0007_enterprisedataroleassignment_applies_to_al
 enterprise_data_roles/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data_roles/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data_roles/tests/factories.py,sha256=VOm0NyOhiKkxl1MRIriRkKSpKypr9-4lG2FrsE2YfKo,1153
-enterprise_data_roles/tests/test_models.py,sha256=wJv7ywk0BSbjlW_U142h0aFxZleAHyT92nIiPy_ECW4,1476
+enterprise_data_roles/tests/test_models.py,sha256=r7fcYXnzWjlAHUxvvC8y7taUQWYPhyXuCU-q1KHWeO4,1475
 enterprise_reporting/__init__.py,sha256=yQO9ureIxFnl-1a_34H53elDwuAzXrSmhLlzqqD2SJ0,112
 enterprise_reporting/constants.py,sha256=LAi9HPXDF5I8xT4E65YTO6FhnlK_6MdNpBeBVZ9Ckdk,211
 enterprise_reporting/delivery_method.py,sha256=JpNEDT3yk4IV27OsqIq0iLv3xcTkW9B285P91YBUrsA,6109
@@ -176,8 +186,7 @@ enterprise_reporting/tests/test_send_enterprise_reports.py,sha256=zBj7sDvRLJQbRs
 enterprise_reporting/tests/test_utils.py,sha256=y4t6w9aKra-ftqtUeHvPwOhje-1npz7auV5o74ya8fE,9523
 enterprise_reporting/tests/test_vertica_client.py,sha256=-R2yNCGUjRtoXwLMBloVFQkFYrJoo613VCr61gwI3kQ,140
 enterprise_reporting/tests/utils.py,sha256=xms2LM7DV3wczXEfctOK1ddel1EE0J_YSr17UzbCDy4,1401
-edx_enterprise_data-10.10.1.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-edx_enterprise_data-10.10.1.dist-info/METADATA,sha256=hDRA9ivxmE2KXvocGs8ttz8nEI_sKRVhNdUAHa5wN6w,1685
-edx_enterprise_data-10.10.1.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-edx_enterprise_data-10.10.1.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
-edx_enterprise_data-10.10.1.dist-info/RECORD,,
+edx_enterprise_data-10.11.0.dist-info/METADATA,sha256=BA0kvVq5-XmTgHE-p05B0oL10L49owYI6kl3_2RBvJY,1707
+edx_enterprise_data-10.11.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+edx_enterprise_data-10.11.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
+edx_enterprise_data-10.11.0.dist-info/RECORD,,

{edx_enterprise_data-10.10.1.dist-info → edx_enterprise_data-10.11.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.0.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

enterprise_data/__init__.py

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

enterprise_data/admin_analytics/database/filters/__init__.py

@@ -0,0 +1,5 @@
+"""
+Query Filters for database tables.
+"""
+
+from .fact_enrollment_admin_dash import FactEnrollmentAdminDashFilters

enterprise_data/admin_analytics/database/filters/base.py

@@ -0,0 +1,7 @@
+"""
+Base filters for database tables.
+"""
+
+
+class BaseFilter:
+    pass

enterprise_data/admin_analytics/database/filters/fact_enrollment_admin_dash.py

@@ -0,0 +1,51 @@
+"""
+Query filters for enrollments table.
+"""
+from enterprise_data.admin_analytics.database.filters.base import BaseFilter
+from enterprise_data.admin_analytics.database.query_filters import BetweenQueryFilter, EqualQueryFilter, INQueryFilter
+
+
+class FactEnrollmentAdminDashFilters(BaseFilter):
+    """
+    Query filters for enrollments table.
+    """
+    @staticmethod
+    def enterprise_customer_uuid_filter(enterprise_customer_uuid_params_key: str) -> EqualQueryFilter:
+        """
+        Filter by enterprise customer uuid.
+
+        Arguments:
+            enterprise_customer_uuid_params_key: The key against which value will be passed in the query.
+        """
+        return EqualQueryFilter(
+            column='enterprise_customer_uuid',
+            value_placeholder=enterprise_customer_uuid_params_key,
+        )
+
+    @staticmethod
+    def enterprise_enrollment_date_range_filter(
+            start_date_params_key: str, end_date_params_key: str
+    ) -> BetweenQueryFilter:
+        """
+        Filter by enrollment date to be in the given range.
+
+        Arguments:
+            start_date_params_key (str): The start date key against which value will be passed in the query.
+            end_date_params_key (str): The end date key against which value will be passed in the query.
+        """
+        return BetweenQueryFilter(
+            column='enterprise_enrollment_date',
+            range_placeholders=(start_date_params_key, end_date_params_key),
+        )
+
+    @staticmethod
+    def enterprise_user_id_in_filter(
+            enterprise_user_id_param_keys: list,
+    ) -> INQueryFilter:
+        """
+        Filter by enterprise user id.
+        """
+        return INQueryFilter(
+            column='enterprise_user_id',
+            values_placeholders=enterprise_user_id_param_keys
+        )

enterprise_data/admin_analytics/database/queries/fact_enrollment_admin_dash.py

@@ -1,6 +1,7 @@
 """
 Module containing queries for the fact_enrollment_admin_dash table.
 """
+from ..query_filters import QueryFilters
 
 
 class FactEnrollmentAdminDashQueries:
@@ -20,27 +21,25 @@ class FactEnrollmentAdminDashQueries:
         """
 
     @staticmethod
-    def get_enrollment_count_query():
+    def get_enrollment_count_query(query_filters: QueryFilters) -> str:
         """
         Get the query to fetch the total number of enrollments for an enterprise customer.
         """
-        return """
+        return f"""
             SELECT count(*)
             FROM fact_enrollment_admin_dash
-            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                enterprise_enrollment_date BETWEEN %(start_date)s AND %(end_date)s;
+            WHERE {query_filters.to_sql()};
         """
 
     @staticmethod
-    def get_all_enrollments_query():
+    def get_all_enrollments_query(query_filters: QueryFilters) -> str:
         """
         Get the query to fetch all enrollments.
         """
-        return """
+        return f"""
             SELECT email, course_title, course_subject, enroll_type, enterprise_enrollment_date
             FROM fact_enrollment_admin_dash
-            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                enterprise_enrollment_date BETWEEN %(start_date)s AND %(end_date)s
+            WHERE {query_filters.to_sql()}
             ORDER BY ENTERPRISE_ENROLLMENT_DATE DESC LIMIT %(limit)s OFFSET %(offset)s
         """
 
@@ -98,21 +97,21 @@ class FactEnrollmentAdminDashQueries:
         """
 
     @staticmethod
-    def get_top_courses_by_enrollments_query(record_count=10):
+    def get_top_courses_by_enrollments_query(query_filters: QueryFilters, record_count: int = 10) -> str:
         """
         Get the query to fetch the enrollment count by courses.
 
         Query will fetch the top N courses by enrollment count. Where N is the value of record_count.
 
         Arguments:
+            query_filters (QueryFilters): List of query filters.
             record_count (int): Number of records to fetch.
         """
         return f"""
             WITH filtered_data AS (
                 SELECT *
                 FROM fact_enrollment_admin_dash
-                WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                enterprise_enrollment_date BETWEEN %(start_date)s AND %(end_date)s
+                WHERE {query_filters.to_sql()}
             ),
             top_10_courses AS (
                 SELECT course_key
@@ -134,7 +133,7 @@ class FactEnrollmentAdminDashQueries:
         """
 
     @staticmethod
-    def get_top_subjects_by_enrollments_query(record_count=10):
+    def get_top_subjects_by_enrollments_query(query_filters: QueryFilters, record_count: int = 10) -> str:
         """
         Get the query to fetch the enrollment count by subjects.
 
@@ -142,13 +141,13 @@ class FactEnrollmentAdminDashQueries:
 
         Arguments:
             record_count (int): Number of records to fetch.
+            query_filters (QueryFilters): List of query filters.
         """
         return f"""
             WITH filtered_data AS (
                 SELECT *
                 FROM fact_enrollment_admin_dash
-                WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                enterprise_enrollment_date BETWEEN %(start_date)s AND %(end_date)s
+                WHERE {query_filters.to_sql()}
             ),
             top_10_subjects AS (
                 SELECT course_subject
@@ -168,15 +167,17 @@ class FactEnrollmentAdminDashQueries:
         """
 
     @staticmethod
-    def get_enrolment_time_series_data_query():
+    def get_enrolment_time_series_data_query(query_filters: QueryFilters) -> str:
         """
         Get the query to fetch the enrollment time series data with daily aggregation.
+
+        Arguments:
+            query_filters (QueryFilters): A list of filters for this query.
         """
-        return """
+        return f"""
             SELECT enterprise_enrollment_date, enroll_type, COUNT(*) as enrollment_count
             FROM fact_enrollment_admin_dash
-            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                enterprise_enrollment_date BETWEEN %(start_date)s AND %(end_date)s
+            WHERE {query_filters.to_sql()}
             GROUP BY enterprise_enrollment_date, enroll_type
             ORDER BY enterprise_enrollment_date;
         """

enterprise_data/admin_analytics/database/query_filters/__init__.py

@@ -0,0 +1,7 @@
+"""
+Query Filters to filter query data.
+"""
+from .base import QueryFilters
+from .between import BetweenQueryFilter
+from .equal import EqualQueryFilter
+from .in_ import INQueryFilter

enterprise_data/admin_analytics/database/query_filters/base.py

@@ -0,0 +1,68 @@
+"""
+Base Query Filter.
+"""
+from abc import ABC, abstractmethod
+
+
+class QueryFilter(ABC):
+    """
+    Base Query filter class for functionality common to all filters.
+    """
+    @abstractmethod
+    def to_sql(self) -> str:
+        """
+        Convert the filter to a SQL string.
+        """
+        raise NotImplementedError
+
+    @staticmethod
+    def validate_argument_exclusivity(value, value_placeholder):
+        """
+        Validate that that arguments are mutually exclusive.
+
+        This method will make sure that at-least one of the value or value_placeholder is provided. it will also
+        make sure that both value and value_placeholder are not provided at the same time.
+
+        Arguments:
+            value: The value of the filter.
+            value_placeholder: The placeholder for the value.
+        """
+        if value is not None and value_placeholder is not None:
+            raise ValueError('Both value and value_placeholder cannot be provided at the same time.')
+        if value is None and value_placeholder is None:
+            raise ValueError('Either value or value_placeholder must be provided.')
+        return True
+
+    def value_to_sql(self, value):
+        """
+        Convert the given value to a string in a way that it can be used inside WHERE clause of SQL query.
+
+        Note: This method is meant to evolve according to user needs. currently it handles the following data types.
+        More types can be added as needed.
+
+        1. str: Encloses the string in single quotes.
+        2. list<str>: Encloses the list of strings in a tuple after calling this method recursively on each item.
+
+        Arguments:
+            value (Any): The value to format.
+
+        Returns:
+            (Any): The formatted value.
+        """
+        if isinstance(value, str):
+            return f"'{value}'"
+        if isinstance(value, list):
+            return [self.value_to_sql(item) for item in value]
+
+        return value
+
+
+class QueryFilters(list):
+    """
+    A list of QueryFilter objects.
+    """
+    def to_sql(self) -> str:
+        """
+        Convert the filters to a SQL string.
+        """
+        return ' AND '.join([_filter.to_sql() for _filter in self])

enterprise_data/admin_analytics/database/query_filters/between.py

@@ -0,0 +1,30 @@
+"""
+Query filter for between operation.
+"""
+from .base import QueryFilter
+
+
+class BetweenQueryFilter(QueryFilter):
+    """
+    Query filter for between operation.
+    """
+
+    def __init__(self, column: str, _range: tuple = None, range_placeholders: tuple = None):
+        """
+        Initialize the filter.
+
+        This will also validate arguments.
+        """
+        self.validate_argument_exclusivity(_range, range_placeholders)
+
+        self.column = column
+        self.range = _range
+        self.range_placeholders = range_placeholders
+
+    def to_sql(self) -> str:
+        if self.range:
+            lower, upper = self.range
+            return f'{self.column} BETWEEN {self.value_to_sql(lower)} AND {self.value_to_sql(upper)}'
+        else:
+            lower_placeholder, upper_placeholder = self.range_placeholders
+            return f'{self.column} BETWEEN %({lower_placeholder})s AND %({upper_placeholder})s'

enterprise_data/admin_analytics/database/query_filters/equal.py

@@ -0,0 +1,27 @@
+"""
+Query filter for equal operation.
+"""
+from .base import QueryFilter
+
+
+class EqualQueryFilter(QueryFilter):
+    """
+    Query filter for equal operation.
+    """
+    def __init__(self, column: str, value: str = None, value_placeholder: str = None):
+        """
+        Initialize the filter.
+
+        This will also validate arguments.
+        """
+        self.validate_argument_exclusivity(value, value_placeholder)
+
+        self.column = column
+        self.value = value
+        self.value_placeholder = value_placeholder
+
+    def to_sql(self) -> str:
+        if self.value is not None:
+            return f'{self.column} = {self.value_to_sql(self.value)}'
+        else:
+            return f'{self.column} = %({self.value_placeholder})s'

enterprise_data/admin_analytics/database/query_filters/in_.py

@@ -0,0 +1,28 @@
+"""
+Query filter for between operation.
+"""
+from .base import QueryFilter
+
+
+class INQueryFilter(QueryFilter):
+    """
+    Query filter for IN operation.
+    """
+
+    def __init__(self, column: str, values: list = None, values_placeholders: list = None):
+        """
+        Initialize the filter.
+
+        This will also validate arguments.
+        """
+        self.validate_argument_exclusivity(values, values_placeholders)
+
+        self.column = column
+        self.values = values
+        self.values_placeholders = values_placeholders
+
+    def to_sql(self) -> str:
+        if self.values is not None:
+            return f'{self.column} IN {str(tuple(self.value_to_sql(self.values)))}'
+        else:
+            return f'{self.column} IN {tuple(f"%({item})s" for item in self.values_placeholders)}'

enterprise_data/admin_analytics/database/tables/fact_enrollment_admin_dash.py

@@ -2,20 +2,95 @@
 Module for interacting with the fact_enrollment_admin_dash table.
 """
 from datetime import date, datetime
+from logging import getLogger
+from typing import Optional, Tuple
 from uuid import UUID
 
 from enterprise_data.cache.decorators import cache_it
+from enterprise_data.clients import EnterpriseApiClient
+from enterprise_data.exceptions import EnterpriseApiClientException
 
+from ..filters import FactEnrollmentAdminDashFilters
 from ..queries import FactEnrollmentAdminDashQueries
+from ..query_filters import INQueryFilter, QueryFilters
 from ..utils import run_query
 from .base import BaseTable
 
+LOGGER = getLogger(__name__)
+
 
 class FactEnrollmentAdminDashTable(BaseTable):
     """
     Class for communicating with the fact_enrollment_admin_dash table.
     """
     queries = FactEnrollmentAdminDashQueries()
+    filters = FactEnrollmentAdminDashFilters()
+
+    def __get_enterprise_user_query_filter(  # pylint: disable=inconsistent-return-statements
+            self, group_uuid: Optional[UUID],
+            enterprise_customer_uuid: UUID
+    ) -> Optional[Tuple[INQueryFilter, dict]]:
+        """
+        Get the query filter to filter enrollments for enterprise users in the given group.
+
+        Arguments:
+            group_uuid (UUID): The UUID of the group.
+            enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+
+        Returns:
+            (INQueryFilter | None): The query filter to filter enrollments for enterprise users in the given group.
+        """
+        if not group_uuid:
+            return None
+
+        try:
+            learners_in_group = EnterpriseApiClient.get_enterprise_user_ids_in_group(group_uuid)
+        except EnterpriseApiClientException:
+            LOGGER.exception(
+                "Failed to get learners in group [%s] for enterprise [%s]",
+                group_uuid,
+                enterprise_customer_uuid,
+            )
+        else:
+            params = {f'eu_{i}': i for i in range(len(learners_in_group))}
+            return self.filters.enterprise_user_id_in_filter(list(params.keys())), params
+
+    def __get_common_query_filters(
+            self, enterprise_customer_uuid: UUID,
+            group_uuid: Optional[UUID],
+            start_date: date,
+            end_date: date,
+    ) -> (QueryFilters, dict):
+        """
+        Utility method to get query filters common in most usages below.
+
+        This will return a tuple containing the query filters list and the dictionary of query parameters that
+        will be used in the query.
+
+        It will contain the following query filters.
+            1. enterprise_customer_uuid filter to filter records for an enterprise customer.
+            2. enrollment_date range filter to filter records by enrollment date.
+            3. group_uuid filter to filter records for learners who belong to the given group.
+        """
+        query_filters = QueryFilters([
+            self.filters.enterprise_customer_uuid_filter('enterprise_customer_uuid'),
+            self.filters.enterprise_enrollment_date_range_filter('start_date', 'end_date'),
+        ])
+        params = {
+            'enterprise_customer_uuid': enterprise_customer_uuid,
+            'start_date': start_date,
+            'end_date': end_date,
+        }
+
+        response = self.__get_enterprise_user_query_filter(
+            group_uuid, enterprise_customer_uuid
+        )
+        if response is not None:
+            enterprise_user_id_in_filter, enterprise_user_id_params = response
+            query_filters.append(enterprise_user_id_in_filter)
+            params.update(enterprise_user_id_params)
+
+        return query_filters, params
 
     def get_top_enterprises(self, count=10):
         """
@@ -34,25 +109,32 @@ class FactEnrollmentAdminDashTable(BaseTable):
         return [row[0] for row in result]
 
     @cache_it()
-    def get_enrollment_count(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+    def get_enrollment_count(
+            self,
+            enterprise_customer_uuid: UUID,
+            group_uuid: Optional[UUID],
+            start_date: date,
+            end_date: date,
+    ) -> int:
         """
         Get the total number of enrollments for the given enterprise customer.
 
         Arguments:
             enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+            group_uuid (UUID): The UUID of the group.
             start_date (date): The start date.
             end_date (date): The end date.
 
         Returns:
             (int): The total number of enrollments.
         """
+        query_filters, query_filter_params = self.__get_common_query_filters(
+            enterprise_customer_uuid, group_uuid, start_date, end_date
+        )
+
         results = run_query(
-            query=self.queries.get_enrollment_count_query(),
-            params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
-            }
+            query=self.queries.get_enrollment_count_query(query_filters),
+            params=query_filter_params
         )
         if not results:
             return 0
@@ -60,13 +142,20 @@ class FactEnrollmentAdminDashTable(BaseTable):
 
     @cache_it()
     def get_all_enrollments(
-            self, enterprise_customer_uuid: UUID, start_date: date, end_date: date, limit: int, offset: int
-    ):
+            self,
+            enterprise_customer_uuid: UUID,
+            group_uuid: Optional[UUID],
+            start_date: date,
+            end_date: date,
+            limit: int,
+            offset: int,
+    ) -> list:
         """
         Get all enrollments for the given enterprise customer.
 
         Arguments:
             enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+            group_uuid (UUID): The UUID of the group.
             start_date (date): The start date.
             end_date (date): The end date.
             limit (int): The maximum number of records to return.
@@ -75,12 +164,14 @@ class FactEnrollmentAdminDashTable(BaseTable):
         Returns:
             list<dict>: A list of dictionaries containing the enrollment data.
         """
+        query_filters, query_filter_params = self.__get_common_query_filters(
+            enterprise_customer_uuid, group_uuid, start_date, end_date
+        )
+
         return run_query(
-            query=self.queries.get_all_enrollments_query(),
+            query=self.queries.get_all_enrollments_query(query_filters),
             params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
+                **query_filter_params,
                 'limit': limit,
                 'offset': offset,
             },
@@ -167,71 +258,90 @@ class FactEnrollmentAdminDashTable(BaseTable):
         return int(results[0][0] or 0)
 
     @cache_it()
-    def get_top_courses_by_enrollments(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+    def get_top_courses_by_enrollments(
+            self, enterprise_customer_uuid: UUID,
+            group_uuid: Optional[UUID],
+            start_date: date,
+            end_date: date
+    ) -> list:
         """
         Get the top courses enrollments for the given enterprise customer.
 
         Arguments:
             enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+            group_uuid (UUID): The UUID of the group.
             start_date (date): The start date.
             end_date (date): The end date.
 
         Returns:
             list<dict>: A list of dictionaries containing the course key, course_title and enrollment count.
         """
+        query_filters, query_filter_params = self.__get_common_query_filters(
+            enterprise_customer_uuid, group_uuid, start_date, end_date
+        )
+
         return run_query(
-            query=self.queries.get_top_courses_by_enrollments_query(),
-            params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
-            },
+            query=self.queries.get_top_courses_by_enrollments_query(query_filters),
+            params=query_filter_params,
             as_dict=True,
         )
 
     @cache_it()
-    def get_top_subjects_by_enrollments(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+    def get_top_subjects_by_enrollments(
+            self,
+            enterprise_customer_uuid: UUID,
+            group_uuid: Optional[UUID],
+            start_date: date,
+            end_date: date,
+    ) -> list:
         """
         Get the top subjects by enrollments for the given enterprise customer.
 
         Arguments:
             enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+            group_uuid (UUID): The UUID of the group.
             start_date (date): The start date.
             end_date (date): The end date.
 
         Returns:
             list<dict>: A list of dictionaries containing the subject and enrollment count.
         """
+        query_filters, query_filter_params = self.__get_common_query_filters(
+            enterprise_customer_uuid, group_uuid, start_date, end_date
+        )
+
         return run_query(
-            query=self.queries.get_top_subjects_by_enrollments_query(),
-            params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
-            },
+            query=self.queries.get_top_subjects_by_enrollments_query(query_filters),
+            params=query_filter_params,
             as_dict=True,
         )
 
     @cache_it()
-    def get_enrolment_time_series_data(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+    def get_enrolment_time_series_data(
+            self, enterprise_customer_uuid: UUID,
+            group_uuid: Optional[UUID],
+            start_date: date,
+            end_date: date
+    ) -> list:
         """
         Get the enrollment time series data for the given enterprise customer.
 
         Arguments:
             enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+            group_uuid (UUID): The UUID of the group.
             start_date (date): The start date.
             end_date (date): The end date.
 
         Returns:
             list<dict>: A list of dictionaries containing the date and enrollment count.
         """
+        query_filters, query_filter_params = self.__get_common_query_filters(
+            enterprise_customer_uuid, group_uuid, start_date, end_date
+        )
+
         return run_query(
-            query=self.queries.get_enrolment_time_series_data_query(),
-            params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
-            },
+            query=self.queries.get_enrolment_time_series_data_query(query_filters),
+            params=query_filter_params,
             as_dict=True,
         )
 

enterprise_data/api/v1/serializers.py

@@ -341,6 +341,7 @@ class AdvanceAnalyticsQueryParamSerializer(serializers.Serializer):  # pylint: d
     response_type = serializers.CharField(required=False)
     page = serializers.IntegerField(required=False, min_value=1)
     page_size = serializers.IntegerField(required=False, min_value=2)
+    group_uuid = serializers.UUIDField(required=False)
 
     def validate(self, attrs):
         """

enterprise_data/api/v1/views/analytics_enrollments.py

@@ -52,8 +52,11 @@ class AdvanceAnalyticsEnrollmentsView(AnalyticsPaginationMixin, ViewSet):
         end_date = serializer.data.get('end_date', date.today())
         page = serializer.data.get('page', 1)
         page_size = serializer.data.get('page_size', 100)
+        group_uuid = serializer.data.get('group_uuid')
+
         enrollments = FactEnrollmentAdminDashTable().get_all_enrollments(
             enterprise_customer_uuid=enterprise_uuid,
+            group_uuid=group_uuid,
             start_date=start_date,
             end_date=end_date,
             limit=page_size,
@@ -61,6 +64,7 @@ class AdvanceAnalyticsEnrollmentsView(AnalyticsPaginationMixin, ViewSet):
         )
         total_count = FactEnrollmentAdminDashTable().get_enrollment_count(
             enterprise_customer_uuid=enterprise_uuid,
+            group_uuid=group_uuid,
             start_date=start_date,
             end_date=end_date,
         )
@@ -78,7 +82,7 @@ class AdvanceAnalyticsEnrollmentsView(AnalyticsPaginationMixin, ViewSet):
 
             return StreamingHttpResponse(
                 IndividualEnrollmentsCSVRenderer().render(self._stream_serialized_data(
-                    enterprise_uuid, start_date, end_date, total_count
+                    enterprise_uuid, group_uuid, start_date, end_date, total_count
                 )),
                 content_type="text/csv",
                 headers={"Content-Disposition": f'attachment; filename="{filename}"'},
@@ -93,7 +97,7 @@ class AdvanceAnalyticsEnrollmentsView(AnalyticsPaginationMixin, ViewSet):
         )
 
     @staticmethod
-    def _stream_serialized_data(enterprise_uuid, start_date, end_date, total_count, page_size=50000):
+    def _stream_serialized_data(enterprise_uuid, group_uuid, start_date, end_date, total_count, page_size=50000):
         """
         Stream the serialized data.
         """
@@ -101,6 +105,7 @@ class AdvanceAnalyticsEnrollmentsView(AnalyticsPaginationMixin, ViewSet):
         while offset < total_count:
             enrollments = FactEnrollmentAdminDashTable().get_all_enrollments(
                 enterprise_customer_uuid=enterprise_uuid,
+                group_uuid=group_uuid,
                 start_date=start_date,
                 end_date=end_date,
                 limit=page_size,
@@ -132,16 +137,18 @@ class AdvanceAnalyticsEnrollmentsView(AnalyticsPaginationMixin, ViewSet):
         # get values from query params or use default
         start_date = serializer.data.get('start_date', min_enrollment_date)
         end_date = serializer.data.get('end_date', date.today())
+        group_uuid = serializer.data.get('group_uuid')
+
         with timer('construct_enrollment_all_stats'):
             data = {
                 'enrollments_over_time': FactEnrollmentAdminDashTable().get_enrolment_time_series_data(
-                    enterprise_uuid, start_date, end_date
+                    enterprise_uuid, group_uuid, start_date, end_date
                 ),
                 'top_courses_by_enrollments': FactEnrollmentAdminDashTable().get_top_courses_by_enrollments(
-                    enterprise_uuid, start_date, end_date,
+                    enterprise_uuid, group_uuid, start_date, end_date,
                 ),
                 'top_subjects_by_enrollments': FactEnrollmentAdminDashTable().get_top_subjects_by_enrollments(
-                    enterprise_uuid, start_date, end_date,
+                    enterprise_uuid, group_uuid, start_date, end_date,
                 ),
             }
         return Response(data)

enterprise_data/api/v1/views/enterprise_learner.py

@@ -22,6 +22,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.exceptions import EnterpriseApiClientException
 from enterprise_data.models import EnterpriseGroupMembership, EnterpriseLearner, EnterpriseLearnerEnrollment
 from enterprise_data.paginators import EnterpriseEnrollmentsPagination
 from enterprise_data.renderers import EnrollmentsCSVRenderer
@@ -202,29 +203,19 @@ class EnterpriseLearnerEnrollmentViewSet(EnterpriseViewSetMixin, viewsets.ReadOn
 
         # First, filter the queryset using flex_group_exists
         filtered_queryset = queryset.filter(Exists(flex_group_exists))
+        if filtered_queryset.exists():
+            return filtered_queryset
 
-        # 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
+        try:
+            return queryset.filter(
+                enterprise_user_id__in=EnterpriseApiClient.get_enterprise_user_ids_in_group(group_uuid)
+            )
+        except EnterpriseApiClientException as error:
+            LOGGER.warning(f'No group learners found for group: {group_uuid}')
+            raise NotFound(f'No learners found for group: {group_uuid}') from error
+        except Exception as e:  # pylint: disable=broad-exception-caught
+            LOGGER.error('Failed to fetch group learners from API: %s', e)
+            return queryset.none()  # API call failed or unexpected error, return an empty queryset
 
     def filter_by_offer_id(self, queryset, offer_id):
         """

enterprise_data/clients.py

@@ -1,10 +1,10 @@
 """
 Clients used to connect to other systems.
 """
-
-
 import logging
+from typing import Any, List
 from urllib.parse import urljoin
+from uuid import UUID
 
 from edx_django_utils.cache import TieredCache
 from edx_rest_api_client.client import OAuthAPIClient
@@ -13,9 +13,11 @@ from rest_framework.exceptions import NotFound, ParseError
 
 from django.conf import settings
 
+from enterprise_data.exceptions import EnterpriseApiClientException
 from enterprise_data.utils import get_cache_key
 
 DEFAULT_REPORTING_CACHE_TIMEOUT = 60 * 60 * 6  # 6 hours (Value is in seconds)
+GROUP_DATA_CACHE_TIMEOUT = 60 * 60  # 1 hour (Value is in seconds)
 LOGGER = logging.getLogger('enterprise_data')
 
 
@@ -102,16 +104,28 @@ class EnterpriseApiClient(OAuthAPIClient):
 
         return data
 
-    def get_enterprise_group_learners(self, group_uuid):
+    def get_enterprise_group_learners(self, group_uuid: UUID) -> List[Any]:
         """
         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}')
+        LOGGER.info(f'[EnterpriseApiClient] getting learners for enterprise group: {group_uuid}')
+
+        cache_key = get_cache_key(
+            resource='enterprise-group-learners',
+            group_uuid=group_uuid,
+        )
+        cached_response = TieredCache.get_cached_response(cache_key)
+        if cached_response.is_found:
+            LOGGER.info(
+                f'[EnterpriseApiClient] cache info found for enterprise group: {group_uuid}'
+                f' with {cached_response.value}'
+            )
+            return cached_response.value
+
         url = urljoin(self.API_BASE_URL, f'enterprise-group/{group_uuid}/learners/')
         all_learners = []
-
         try:
             while url:
                 response = self.get(url)
@@ -119,12 +133,30 @@ class EnterpriseApiClient(OAuthAPIClient):
                 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
+            raise EnterpriseApiClientException(
+                f'Unable to process Enterprise Group Learners details for group {group_uuid}'
+            ) from exc
 
+        TieredCache.set_all_tiers(cache_key, all_learners, GROUP_DATA_CACHE_TIMEOUT)
         return all_learners
+
+    @staticmethod
+    def get_enterprise_user_ids_in_group(group_uuid: UUID) -> List[int]:
+        """
+        Get a list of all enterprise customer user ids that belong to the given group.
+
+        Arguments:
+            group_uuid (str|UUID): The group uuid.
+        """
+        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)
+        return [learner['enterprise_customer_user_id'] for learner in group_learners]

enterprise_data/exceptions.py

@@ -0,0 +1,21 @@
+"""
+Custom Exceptions related to enterprise data.
+"""
+
+
+class EnterpriseDataException(Exception):
+    """
+    Base exception for enterprise data.
+    """
+
+    def __init__(self, message: str):
+        """
+        Initialize the exception with a message.
+        """
+        super().__init__(message)
+
+
+class EnterpriseApiClientException(EnterpriseDataException):
+    """
+    Exception for enterprise API client.
+    """

enterprise_data/management/commands/pre_warm_analytics_cache.py

@@ -2,6 +2,7 @@
 Management command for pre-warming the analytics cache for large enterprises.
 """
 from datetime import date
+from uuid import UUID
 
 from django.core.management.base import BaseCommand, CommandError
 
@@ -21,12 +22,12 @@ class Command(BaseCommand):
     help = 'Pre-warm the analytics cache for a large enterprises.'
 
     @staticmethod
-    def __cache_enrollment_data(enterprise_customer_uuid):
+    def __cache_enrollment_data(enterprise_customer_uuid: UUID):
         """
         Helper method to cache all the enrollment related data for the given enterprise.
 
         Arguments:
-            enterprise_customer_uuid (str): The UUID of the enterprise customer.
+            enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
         """
         enterprise_enrollment_table = FactEnrollmentAdminDashTable()
         start_date, _ = enterprise_enrollment_table.get_enrollment_date_range(
@@ -35,12 +36,14 @@ class Command(BaseCommand):
         end_date = date.today()
         enterprise_enrollment_table.get_enrollment_count(
             enterprise_customer_uuid=enterprise_customer_uuid,
+            group_uuid=None,
             start_date=start_date,
             end_date=end_date,
         )
         page_size = 100
         enterprise_enrollment_table.get_all_enrollments(
             enterprise_customer_uuid=enterprise_customer_uuid,
+            group_uuid=None,
             start_date=start_date,
             end_date=end_date,
             limit=page_size,
@@ -58,27 +61,30 @@ class Command(BaseCommand):
         )
         enterprise_enrollment_table.get_top_courses_by_enrollments(
             enterprise_customer_uuid=enterprise_customer_uuid,
+            group_uuid=None,
             start_date=start_date,
             end_date=end_date,
         )
         enterprise_enrollment_table.get_top_subjects_by_enrollments(
             enterprise_customer_uuid=enterprise_customer_uuid,
+            group_uuid=None,
             start_date=start_date,
             end_date=end_date,
         )
         enterprise_enrollment_table.get_enrolment_time_series_data(
             enterprise_customer_uuid=enterprise_customer_uuid,
+            group_uuid=None,
             start_date=start_date,
             end_date=end_date,
         )
 
     @staticmethod
-    def __cache_completions_data(enterprise_customer_uuid):
+    def __cache_completions_data(enterprise_customer_uuid: UUID):
         """
         Helper method to cache all the completions related data for the given enterprise.
 
         Arguments:
-            enterprise_customer_uuid (str): The UUID of the enterprise customer.
+            enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
         """
         enterprise_enrollment_table = FactEnrollmentAdminDashTable()
         start_date, _ = enterprise_enrollment_table.get_enrollment_date_range(
@@ -116,12 +122,12 @@ class Command(BaseCommand):
         )
 
     @staticmethod
-    def __cache_engagement_data(enterprise_customer_uuid):
+    def __cache_engagement_data(enterprise_customer_uuid: UUID):
         """
         Helper method to cache all the engagement related data for the given enterprise.
 
         Arguments:
-            enterprise_customer_uuid (str): The UUID of the enterprise customer.
+            enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
         """
         start_date, _ = FactEnrollmentAdminDashTable().get_enrollment_date_range(
             enterprise_customer_uuid,
@@ -176,12 +182,12 @@ class Command(BaseCommand):
         )
 
     @staticmethod
-    def __cache_skills_data(enterprise_customer_uuid):
+    def __cache_skills_data(enterprise_customer_uuid: UUID):
         """
         Helper method to cache all the skills related data for the given enterprise.
 
         Arguments:
-            enterprise_customer_uuid (str): The UUID of the enterprise customer.
+            enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
         """
         start_date, _ = FactEnrollmentAdminDashTable().get_enrollment_date_range(
             enterprise_customer_uuid,

enterprise_data/tests/admin_analytics/mock_enrollments.py

@@ -23,6 +23,7 @@ ENROLLMENTS = [
         "passed_date_raw": "2021-08-25",
         "passed_date": "2021-08-25",
         "has_passed": 1,
+        "enterprise_user_id": 1,
     },
     {
         "enterprise_customer_name": "Hill Ltd",
@@ -46,6 +47,7 @@ ENROLLMENTS = [
         "passed_date_raw": "2021-09-01",
         "passed_date": "2021-09-01",
         "has_passed": 1,
+        "enterprise_user_id": 1,
     },
     {
         "enterprise_customer_name": "Hill Ltd",
@@ -69,6 +71,7 @@ ENROLLMENTS = [
         "passed_date_raw": None,
         "passed_date": '2022-08-24',
         "has_passed": 0,
+        "enterprise_user_id": 1,
     },
     {
         "enterprise_customer_name": "Hill Ltd",
@@ -92,6 +95,7 @@ ENROLLMENTS = [
         "passed_date_raw": None,
         "passed_date": "2022-08-24",
         "has_passed": 0,
+        "enterprise_user_id": 1,
     },
     {
         "enterprise_customer_name": "Hill Ltd",
@@ -115,5 +119,6 @@ ENROLLMENTS = [
         "passed_date_raw": None,
         "passed_date": "2022-08-20",
         "has_passed": 0,
+        "enterprise_user_id": 1,
     },
 ]

enterprise_data_roles/tests/test_models.py

@@ -2,7 +2,6 @@
 Tests for the `enterprise-data` models module.
 """
 
-
 import unittest
 
 import ddt