edx-enterprise-data 10.12.0__py3-none-any.whl → 10.14.0__py3-none-any.whl

{edx_enterprise_data-10.12.0.dist-info → edx_enterprise_data-10.14.0.dist-info}/METADATA

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

{edx_enterprise_data-10.12.0.dist-info → edx_enterprise_data-10.14.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-edx_enterprise_data-10.12.0.dist-info/licenses/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-enterprise_data/__init__.py,sha256=eCPWfovt7oPmCOdH366B9g4bK-v2sL1oI2SGL8UqKx4,125
+edx_enterprise_data-10.14.0.dist-info/licenses/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+enterprise_data/__init__.py,sha256=y4Uerdix66ZKv0ma98I9YNBuEs_a4mbrItRkMxGHljY,125
 enterprise_data/apps.py,sha256=aF6hZwDfI2oWj95tUTm_2ikHueQj-jLj-u0GrgzpsQI,414
 enterprise_data/clients.py,sha256=glw-fXu3V7rKEpiUBF056gZEdNK4KnWcP9tNYELimRQ,6566
 enterprise_data/constants.py,sha256=uCKjfpdlMYFZJsAj3n9RMw4Cmg5_6s3NuwocO-fch3s,238
@@ -16,12 +16,14 @@ 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=FIgcEfVQPU0TrJoFhWJMo6WPFz4WnPAzxxkwTLfwtP8,186
+enterprise_data/admin_analytics/database/filters/__init__.py,sha256=qzRLCsLTocvaFKpHIB3juyVsxaQ3ByO3YNeSAYkUsHc,257
 enterprise_data/admin_analytics/database/filters/base.py,sha256=nOek6XgHEVBKUTGk-K0PZpy0RSZB3D7kc8OD5nlqXcE,71
-enterprise_data/admin_analytics/database/filters/fact_completion_admin_dash.py,sha256=j50oW-C-N2X3g6RsvnP9PHeiz8Z4qqe-SyjxeCzb6zQ,1208
-enterprise_data/admin_analytics/database/filters/fact_enrollment_admin_dash.py,sha256=WKRBWRCujiMay2ePdl9vnNN1ux-LO0edyb79W4dm-S4,1808
+enterprise_data/admin_analytics/database/filters/fact_completion_admin_dash.py,sha256=pklKo12Vxm3rfNGE4qUiFmb9mZ526MhONPDzoJ-o0DM,679
+enterprise_data/admin_analytics/database/filters/fact_engagement_admin_dash.py,sha256=ljdCbRbPS26qJaG6RnqepqwFgiE9GIQnR1uyQRlU5RM,334
+enterprise_data/admin_analytics/database/filters/fact_enrollment_admin_dash.py,sha256=X7aVTii8hS49rSRf8EtZZKxsSZR64tX3TsEsLiHfVUg,338
+enterprise_data/admin_analytics/database/filters/mixins.py,sha256=FOtOKvcugQC8eofli8Pf2vi8EKKXoWHem1CVaLw7moA,3064
 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_engagement_admin_dash.py,sha256=RejAfiNGr0i3wyNe5bsqFOcdRKCGp-tbqS04ibgLi5I,10393
 enterprise_data/admin_analytics/database/queries/fact_enrollment_admin_dash.py,sha256=n_RiqraVzYvCsgLaPmpSBUX3cyNEHjSnkNH7n35gC80,10609
 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
@@ -31,8 +33,8 @@ enterprise_data/admin_analytics/database/query_filters/equal.py,sha256=Z4OPVSZmo
 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=yDqrt9SWvvBNb-v-7Sh-m2Vef2bsGRSsP-YKeLCAnSA,18411
+enterprise_data/admin_analytics/database/tables/fact_engagement_admin_dash.py,sha256=wAnpNgh1USAQKi86JdEy4KJ_d_IL2fbKKu3ypqi5BCs,15434
+enterprise_data/admin_analytics/database/tables/fact_enrollment_admin_dash.py,sha256=BwchyH1VJy8Ie-m_ma3bXiKKkNtJhb8A0u37hjocyiU,17049
 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
@@ -45,11 +47,11 @@ enterprise_data/api/v1/serializers.py,sha256=6yxUe_7UBh80e2ZPZIf1AUzzgtKM8-yS38Q
 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=ALkoUTgvaqCxpjnf3rkvwBT7-Hv7eM1RnCdRboCQgR8,6540
-enterprise_data/api/v1/views/analytics_engagements.py,sha256=Yo-bpA-0xOQHUPTFF0jHWxjm6KpSC-l2nGxhYX0ajBk,6298
+enterprise_data/api/v1/views/analytics_engagements.py,sha256=XHJ_sfGyeamCW4krEazHzOMDGjK5qwIDvZ1IJRUgLaE,6577
 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=uaf8sSp_JS1T5Kgi4xNCjhu6A0HKa3Zwp6JMjY3okJk,9103
+enterprise_data/api/v1/views/enterprise_admin.py,sha256=3rmFoRxnnQFoOsHDCt8excTJT84NLlhg4QhpdDJLxOM,9129
 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
@@ -65,7 +67,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=bwqocYMc72AlgXy_SbT0EL5Aa4sLtVLtYkWSLTZmio0,8696
+enterprise_data/management/commands/pre_warm_analytics_cache.py,sha256=MdvwIZdxYei5V6pTOe_-ohCXHlrMRk29fGe9rfijJzk,8841
 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
@@ -187,7 +189,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.12.0.dist-info/METADATA,sha256=ug0VdbHtFCW6mtrxcaDxw6lYa72hnc6B_gMYHfAg8xA,1707
-edx_enterprise_data-10.12.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-edx_enterprise_data-10.12.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
-edx_enterprise_data-10.12.0.dist-info/RECORD,,
+edx_enterprise_data-10.14.0.dist-info/METADATA,sha256=4L64abOc1Q5PpDbJ0vhoc0RL7yps1sCMXHD8UotGDK0,1707
+edx_enterprise_data-10.14.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+edx_enterprise_data-10.14.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
+edx_enterprise_data-10.14.0.dist-info/RECORD,,

enterprise_data/__init__.py

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

enterprise_data/admin_analytics/database/filters/__init__.py

@@ -3,4 +3,5 @@ Query Filters for database tables.
 """
 
 from .fact_completion_admin_dash import FactCompletionAdminDashFilters
+from .fact_engagement_admin_dash import FactEngagementAdminDashFilters
 from .fact_enrollment_admin_dash import FactEnrollmentAdminDashFilters

enterprise_data/admin_analytics/database/filters/fact_completion_admin_dash.py

@@ -2,28 +2,14 @@
 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
+from enterprise_data.admin_analytics.database.filters.mixins import CommonFiltersMixin
+from enterprise_data.admin_analytics.database.query_filters import EqualQueryFilter
 
 
-class FactCompletionAdminDashFilters(BaseFilter):
+class FactCompletionAdminDashFilters(CommonFiltersMixin, BaseFilter):
     """
     Query filters for completions data in enrollments table.
     """
-    @staticmethod
-    def passed_date_range_filter(
-            start_date_params_key: str, end_date_params_key: str
-    ) -> BetweenQueryFilter:
-        """
-        Filter by passed 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='passed_date',
-            range_placeholders=(start_date_params_key, end_date_params_key),
-        )
 
     @staticmethod
     def has_passed_filter() -> EqualQueryFilter:

enterprise_data/admin_analytics/database/filters/fact_engagement_admin_dash.py

@@ -0,0 +1,11 @@
+"""
+Query filters for engagments data.
+"""
+from enterprise_data.admin_analytics.database.filters.base import BaseFilter
+from enterprise_data.admin_analytics.database.filters.mixins import CommonFiltersMixin
+
+
+class FactEngagementAdminDashFilters(CommonFiltersMixin, BaseFilter):
+    """
+    Query filters for engagments data.
+    """

enterprise_data/admin_analytics/database/filters/fact_enrollment_admin_dash.py

@@ -2,50 +2,10 @@
 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
+from enterprise_data.admin_analytics.database.filters.mixins import CommonFiltersMixin
 
 
-class FactEnrollmentAdminDashFilters(BaseFilter):
+class FactEnrollmentAdminDashFilters(CommonFiltersMixin, 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/filters/mixins.py

@@ -0,0 +1,84 @@
+"""
+Common query filters for all tables.
+"""
+from logging import getLogger
+from typing import Optional, Tuple
+from uuid import UUID
+
+from enterprise_data.admin_analytics.database.filters.base import BaseFilter
+from enterprise_data.admin_analytics.database.query_filters import BetweenQueryFilter, EqualQueryFilter, INQueryFilter
+from enterprise_data.clients import EnterpriseApiClient
+from enterprise_data.exceptions import EnterpriseApiClientException
+
+LOGGER = getLogger(__name__)
+
+
+class CommonFiltersMixin(BaseFilter):
+    """
+    Common filters.
+    """
+    @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 date_range_filter(
+        column: str,
+        start_date_params_key: str,
+        end_date_params_key: str
+    ) -> BetweenQueryFilter:
+        """
+        Filter by a table column to be in the given date range.
+
+        Arguments:
+            column (str): The table column name to filter on.
+            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=column,
+            range_placeholders=(start_date_params_key, end_date_params_key),
+        )
+
+    def 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 learners_in_group}
+            enterprise_user_id_in_filter = INQueryFilter(
+                column='enterprise_user_id',
+                values_placeholders=list(params.keys()),
+            )
+            return enterprise_user_id_in_filter, params

enterprise_data/admin_analytics/database/queries/fact_engagement_admin_dash.py

@@ -21,34 +21,32 @@ class FactEngagementAdminDashQueries:
         """
 
     @staticmethod
-    def get_engagement_count_query():
+    def get_engagement_count_query(query_filters):
         """
         Get the query to fetch the total number of engagements for an enterprise customer.
         """
-        return """
+        return f"""
             SELECT count(*)
             FROM fact_enrollment_engagement_day_admin_dash
-            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                activity_date BETWEEN %(start_date)s AND %(end_date)s;
+            WHERE {query_filters.to_sql()};
         """
 
     @staticmethod
-    def get_all_engagement_query():
+    def get_all_engagement_query(query_filters):
         """
         Get the query to fetch all engagement data.
         """
-        return """
+        return f"""
             SELECT
                 email, course_title, course_subject, enroll_type, activity_date,
                 learning_time_seconds/3600 as learning_time_hours
             FROM fact_enrollment_engagement_day_admin_dash
-            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                activity_date BETWEEN %(start_date)s AND %(end_date)s
+            WHERE {query_filters.to_sql()}
             ORDER BY activity_date DESC LIMIT %(limit)s OFFSET %(offset)s;
         """
 
     @staticmethod
-    def get_top_courses_by_engagement_query(record_count=10):
+    def get_top_courses_by_engagement_query(query_filters, record_count=10):
         """
         Get the query to fetch the learning time in hours by courses.
 
@@ -69,8 +67,7 @@ class FactEngagementAdminDashQueries:
                     (learning_time_seconds / 60.0 / 60.0) AS learning_time_hours,
                     activity_date
                 FROM fact_enrollment_engagement_day_admin_dash
-                WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                activity_date BETWEEN %(start_date)s AND %(end_date)s
+                WHERE {query_filters.to_sql()}
             ),
             top_10_courses AS (
                 SELECT
@@ -94,7 +91,7 @@ class FactEngagementAdminDashQueries:
         """
 
     @staticmethod
-    def get_top_subjects_by_engagement_query(record_count=10):
+    def get_top_subjects_by_engagement_query(query_filters, record_count=10):
         """
         Get the query to fetch the learning time in hours by subjects.
 
@@ -114,8 +111,7 @@ class FactEngagementAdminDashQueries:
                     (learning_time_seconds / 60.0 / 60.0) AS learning_time_hours,
                     activity_date
                 FROM fact_enrollment_engagement_day_admin_dash
-                WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                activity_date BETWEEN %(start_date)s AND %(end_date)s
+                WHERE {query_filters.to_sql()}
             ),
             top_10_subjects AS (
                 SELECT
@@ -138,7 +134,7 @@ class FactEngagementAdminDashQueries:
         """
 
     @staticmethod
-    def get_engagement_time_series_data_query():
+    def get_engagement_time_series_data_query(query_filters):
         """
         Get the query to fetch the completion time series data.
 
@@ -147,11 +143,10 @@ class FactEngagementAdminDashQueries:
         Returns:
             (str): Query to fetch the completion time series data.
         """
-        return """
+        return f"""
             SELECT activity_date, enroll_type, SUM(learning_time_seconds)/3600 as learning_time_hours
             FROM fact_enrollment_engagement_day_admin_dash
-            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                activity_date BETWEEN %(start_date)s AND %(end_date)s
+            WHERE {query_filters.to_sql()}
             GROUP BY activity_date, enroll_type
             ORDER BY activity_date;
         """

enterprise_data/admin_analytics/database/tables/fact_engagement_admin_dash.py

@@ -2,12 +2,15 @@
 Module for interacting with the fact_enrollment_engagement_day_admin_dash table.
 """
 from datetime import date
+from typing import Optional, Tuple
 from uuid import UUID
 
 from enterprise_data.cache.decorators import cache_it
 from enterprise_data.utils import find_first
 
+from ..filters import FactEngagementAdminDashFilters
 from ..queries import FactEngagementAdminDashQueries
+from ..query_filters import QueryFilters
 from ..utils import run_query
 from .base import BaseTable
 
@@ -19,6 +22,43 @@ class FactEngagementAdminDashTable(BaseTable):
     Class for communicating with the fact_enrollment_engagement_day_admin_dash table.
     """
     queries = FactEngagementAdminDashQueries()
+    engagement_filters = FactEngagementAdminDashFilters()
+
+    def __get_common_query_filters_for_engagement(
+            self, enterprise_customer_uuid: UUID,
+            group_uuid: Optional[UUID],
+            start_date: date,
+            end_date: date,
+    ) -> Tuple[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.engagement_filters.enterprise_customer_uuid_filter('enterprise_customer_uuid'),
+            self.engagement_filters.date_range_filter('activity_date', 'start_date', 'end_date'),
+        ])
+        params = {
+            'enterprise_customer_uuid': enterprise_customer_uuid,
+            'start_date': start_date,
+            'end_date': end_date,
+        }
+
+        response = self.engagement_filters.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
 
     @cache_it()
     def get_learning_hours_and_daily_sessions(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
@@ -47,7 +87,13 @@ class FactEngagementAdminDashTable(BaseTable):
         return tuple(results[0])
 
     @cache_it()
-    def get_engagement_count(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+    def get_engagement_count(
+        self,
+        enterprise_customer_uuid: UUID,
+        group_uuid: Optional[UUID],
+        start_date: date,
+        end_date: date
+    ):
         """
         Get the total number of engagements for the given enterprise customer.
 
@@ -59,13 +105,13 @@ class FactEngagementAdminDashTable(BaseTable):
         Returns:
             int: The total number of engagements.
         """
+        query_filters, query_filter_params = self.__get_common_query_filters_for_engagement(
+            enterprise_customer_uuid, group_uuid, start_date, end_date
+        )
+
         results = run_query(
-            query=self.queries.get_engagement_count_query(),
-            params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
-            }
+            query=self.queries.get_engagement_count_query(query_filters),
+            params=query_filter_params,
         )
         if not results:
             return 0
@@ -73,13 +119,20 @@ class FactEngagementAdminDashTable(BaseTable):
 
     @cache_it()
     def get_all_engagements(
-            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
     ):
         """
         Get all engagement data for the given enterprise customer.
 
         Arguments:
             enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+            group_uuid (UUID): The UUID of a group.
             start_date (date): The start date.
             end_date (date): The end date.
             limit (int): The maximum number of records to return.
@@ -88,12 +141,14 @@ class FactEngagementAdminDashTable(BaseTable):
         Returns:
             list<dict>: A list of dictionaries containing the engagement data.
         """
+        query_filters, query_filter_params = self.__get_common_query_filters_for_engagement(
+            enterprise_customer_uuid, group_uuid, start_date, end_date
+        )
+
         return run_query(
-            query=self.queries.get_all_engagement_query(),
+            query=self.queries.get_all_engagement_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,
             },
@@ -101,7 +156,13 @@ class FactEngagementAdminDashTable(BaseTable):
         )
 
     @cache_it()
-    def get_top_courses_by_engagement(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+    def get_top_courses_by_engagement(
+        self,
+        enterprise_customer_uuid: UUID,
+        group_uuid: Optional[UUID],
+        start_date: date,
+        end_date: date
+    ):
         """
         Get the top courses by user engagement for the given enterprise customer.
 
@@ -113,18 +174,23 @@ class FactEngagementAdminDashTable(BaseTable):
         Returns:
             list<dict>: A list of dictionaries containing the course data.
         """
+        query_filters, query_filter_params = self.__get_common_query_filters_for_engagement(
+            enterprise_customer_uuid, group_uuid, start_date, end_date
+        )
         return run_query(
-            query=self.queries.get_top_courses_by_engagement_query(),
-            params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
-            },
+            query=self.queries.get_top_courses_by_engagement_query(query_filters),
+            params=query_filter_params,
             as_dict=True,
         )
 
     @cache_it()
-    def get_top_subjects_by_engagement(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+    def get_top_subjects_by_engagement(
+        self,
+        enterprise_customer_uuid: UUID,
+        group_uuid: Optional[UUID],
+        start_date: date,
+        end_date: date
+    ):
         """
         Get the top subjects by user engagement for the given enterprise customer.
 
@@ -136,18 +202,23 @@ class FactEngagementAdminDashTable(BaseTable):
         Returns:
             list<dict>: A list of dictionaries containing the subject data.
         """
+        query_filters, query_filter_params = self.__get_common_query_filters_for_engagement(
+            enterprise_customer_uuid, group_uuid, start_date, end_date
+        )
         return run_query(
-            query=self.queries.get_top_subjects_by_engagement_query(),
-            params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
-            },
+            query=self.queries.get_top_subjects_by_engagement_query(query_filters),
+            params=query_filter_params,
             as_dict=True,
         )
 
     @cache_it()
-    def get_engagement_time_series_data(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+    def get_engagement_time_series_data(
+        self,
+        enterprise_customer_uuid: UUID,
+        group_uuid: Optional[UUID],
+        start_date: date,
+        end_date: date
+    ):
         """
         Get the engagement time series data.
 
@@ -159,13 +230,12 @@ class FactEngagementAdminDashTable(BaseTable):
         Returns:
             list<dict>: A list of dictionaries containing the engagement time series data.
         """
+        query_filters, query_filter_params = self.__get_common_query_filters_for_engagement(
+            enterprise_customer_uuid, group_uuid, start_date, end_date
+        )
         return run_query(
-            query=self.queries.get_engagement_time_series_data_query(),
-            params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
-            },
+            query=self.queries.get_engagement_time_series_data_query(query_filters),
+            params=query_filter_params,
             as_dict=True,
         )
 

enterprise_data/admin_analytics/database/tables/fact_enrollment_admin_dash.py

@@ -2,60 +2,26 @@
 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 FactCompletionAdminDashFilters, FactEnrollmentAdminDashFilters
 from ..queries import FactEnrollmentAdminDashQueries
-from ..query_filters import INQueryFilter, QueryFilters
+from ..query_filters import 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()
+    enrollment_filters = FactEnrollmentAdminDashFilters()
     completion_filters = FactCompletionAdminDashFilters()
 
-    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}': enterprise_user_id for i, enterprise_user_id in enumerate(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],
@@ -74,8 +40,8 @@ class FactEnrollmentAdminDashTable(BaseTable):
             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'),
+            self.enrollment_filters.enterprise_customer_uuid_filter('enterprise_customer_uuid'),
+            self.enrollment_filters.date_range_filter('enterprise_enrollment_date', 'start_date', 'end_date'),
         ])
         params = {
             'enterprise_customer_uuid': enterprise_customer_uuid,
@@ -83,7 +49,7 @@ class FactEnrollmentAdminDashTable(BaseTable):
             'end_date': end_date,
         }
 
-        response = self.__get_enterprise_user_query_filter(
+        response = self.enrollment_filters.enterprise_user_query_filter(
             group_uuid, enterprise_customer_uuid
         )
         if response is not None:
@@ -112,8 +78,8 @@ class FactEnrollmentAdminDashTable(BaseTable):
             4. has_passed filter to filter records for successful completions.
         """
         query_filters = QueryFilters([
-            self.filters.enterprise_customer_uuid_filter('enterprise_customer_uuid'),
-            self.completion_filters.passed_date_range_filter('start_date', 'end_date'),
+            self.completion_filters.enterprise_customer_uuid_filter('enterprise_customer_uuid'),
+            self.completion_filters.date_range_filter('passed_date', 'start_date', 'end_date'),
             self.completion_filters.has_passed_filter(),
         ])
         params = {
@@ -122,7 +88,7 @@ class FactEnrollmentAdminDashTable(BaseTable):
             'end_date': end_date,
         }
 
-        response = self.__get_enterprise_user_query_filter(
+        response = self.completion_filters.enterprise_user_query_filter(
             group_uuid, enterprise_customer_uuid
         )
         if response is not None:

enterprise_data/api/v1/views/analytics_engagements.py

@@ -51,10 +51,12 @@ class AdvanceAnalyticsEngagementView(AnalyticsPaginationMixin, ViewSet):
         # get values from query params or use default values
         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')
         page = serializer.data.get('page', 1)
         page_size = serializer.data.get('page_size', 100)
         engagements = FactEngagementAdminDashTable().get_all_engagements(
             enterprise_customer_uuid=enterprise_uuid,
+            group_uuid=group_uuid,
             start_date=start_date,
             end_date=end_date,
             limit=page_size,
@@ -62,6 +64,7 @@ class AdvanceAnalyticsEngagementView(AnalyticsPaginationMixin, ViewSet):
         )
         total_count = FactEngagementAdminDashTable().get_engagement_count(
             enterprise_customer_uuid=enterprise_uuid,
+            group_uuid=group_uuid,
             start_date=start_date,
             end_date=end_date,
         )
@@ -79,7 +82,7 @@ class AdvanceAnalyticsEngagementView(AnalyticsPaginationMixin, ViewSet):
 
             return StreamingHttpResponse(
                 IndividualEngagementsCSVRenderer().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}"'},
@@ -94,7 +97,7 @@ class AdvanceAnalyticsEngagementView(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.
         """
@@ -102,6 +105,7 @@ class AdvanceAnalyticsEngagementView(AnalyticsPaginationMixin, ViewSet):
         while offset < total_count:
             engagements = FactEngagementAdminDashTable().get_all_engagements(
                 enterprise_customer_uuid=enterprise_uuid,
+                group_uuid=group_uuid,
                 start_date=start_date,
                 end_date=end_date,
                 limit=page_size,
@@ -133,16 +137,17 @@ class AdvanceAnalyticsEngagementView(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_engagement_all_stats'):
             data = {
                 'engagement_over_time': FactEngagementAdminDashTable().get_engagement_time_series_data(
-                    enterprise_uuid, start_date, end_date
+                    enterprise_uuid, group_uuid, start_date, end_date
                 ),
                 'top_courses_by_engagement': FactEngagementAdminDashTable().get_top_courses_by_engagement(
-                    enterprise_uuid, start_date, end_date,
+                    enterprise_uuid, group_uuid, start_date, end_date,
                 ),
                 'top_subjects_by_engagement': FactEngagementAdminDashTable().get_top_subjects_by_engagement(
-                    enterprise_uuid, start_date, end_date,
+                    enterprise_uuid, group_uuid, start_date, end_date,
                 ),
             }
         return Response(data)

enterprise_data/api/v1/views/enterprise_admin.py

@@ -196,7 +196,7 @@ class EnterpriseExecEdLCModulePerformanceViewSet(EnterpriseViewSetMixin, viewset
     serializer_class = serializers.EnterpriseExecEdLCModulePerformanceSerializer
     filter_backends = (filters.OrderingFilter, filters.SearchFilter)
     ordering_fields = '__all__'
-    ordering = ('last_access',)
+    ordering = ['username', 'module_name', 'last_access']
     search_fields = (
         'username',
         'course_name'

enterprise_data/management/commands/pre_warm_analytics_cache.py

@@ -147,12 +147,14 @@ class Command(BaseCommand):
         )
         enterprise_engagement_table.get_engagement_count(
             enterprise_customer_uuid=enterprise_customer_uuid,
+            group_uuid=None,
             start_date=start_date,
             end_date=end_date,
         )
         page_size = 100
         enterprise_engagement_table.get_all_engagements(
             enterprise_customer_uuid=enterprise_customer_uuid,
+            group_uuid=None,
             start_date=start_date,
             end_date=end_date,
             limit=page_size,
@@ -160,16 +162,19 @@ class Command(BaseCommand):
         )
         enterprise_engagement_table.get_top_courses_by_engagement(
             enterprise_customer_uuid=enterprise_customer_uuid,
+            group_uuid=None,
             start_date=start_date,
             end_date=end_date,
         )
         enterprise_engagement_table.get_top_subjects_by_engagement(
             enterprise_customer_uuid=enterprise_customer_uuid,
+            group_uuid=None,
             start_date=start_date,
             end_date=end_date,
         )
         enterprise_engagement_table.get_engagement_time_series_data(
             enterprise_customer_uuid=enterprise_customer_uuid,
+            group_uuid=None,
             start_date=start_date,
             end_date=end_date,
         )