edx-enterprise-data 9.7.0__py3-none-any.whl → 9.7.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: edx-enterprise-data
3
- Version: 9.7.0
3
+ Version: 9.7.1
4
4
  Summary: Enterprise Reporting
5
5
  Home-page: https://github.com/openedx/edx-enterprise-data
6
6
  Author: edX
@@ -1,4 +1,4 @@
1
- enterprise_data/__init__.py,sha256=-XYlQBRXnJXltF46PlBf71t4JXIIDeiUw42P7lcjs5E,123
1
+ enterprise_data/__init__.py,sha256=beJW1KjpyzsHXlYoxVmfUymgU7McJaqZjGVzmukVbWY,123
2
2
  enterprise_data/apps.py,sha256=aF6hZwDfI2oWj95tUTm_2ikHueQj-jLj-u0GrgzpsQI,414
3
3
  enterprise_data/clients.py,sha256=GvQupy5TVYfO_IKC3yzXSAgNP54r-PtIjidM5ws9Iks,3947
4
4
  enterprise_data/constants.py,sha256=uCKjfpdlMYFZJsAj3n9RMw4Cmg5_6s3NuwocO-fch3s,238
@@ -16,12 +16,12 @@ enterprise_data/admin_analytics/database/__init__.py,sha256=vNSWKf2VV5xMegN7htJJ
16
16
  enterprise_data/admin_analytics/database/utils.py,sha256=5u-d6ZQW95mF_r4bH8Xdi7DgpYAuDFOG_q0P-bjKXHU,1712
17
17
  enterprise_data/admin_analytics/database/queries/__init__.py,sha256=IC5TLOr_GnydbrVbl2mWhwO3aUbYeHuDmfPTLmwGhZA,218
18
18
  enterprise_data/admin_analytics/database/queries/fact_engagement_admin_dash.py,sha256=r62hjL680PEC-qKE7gty5oHAtluQdLsg1QoSuabhKOc,7289
19
- enterprise_data/admin_analytics/database/queries/fact_enrollment_admin_dash.py,sha256=brRgmgtzPLsOdt1vYrk_EpoQLm2izmOdBapxAxNkXzA,8420
19
+ enterprise_data/admin_analytics/database/queries/fact_enrollment_admin_dash.py,sha256=6EX0W3RWRzSrpIbqFJvStnj5Rkfzi9KyFP0UNmb75pU,8814
20
20
  enterprise_data/admin_analytics/database/queries/skills_daily_rollup_admin_dash.py,sha256=PgWwvtVCK5lbiq6z44lH0fwbkdWYukhyXZL9X8lNWCY,4099
21
21
  enterprise_data/admin_analytics/database/tables/__init__.py,sha256=Z-c3P9hqR-dC9uYKe63qHkQG9Nms8cLE2jRN-4jeMM0,289
22
22
  enterprise_data/admin_analytics/database/tables/base.py,sha256=1KyKsC18pW3m-5U-T6pdt5rIwsz6Wp3QFFbD3r6L6YQ,395
23
23
  enterprise_data/admin_analytics/database/tables/fact_engagement_admin_dash.py,sha256=8aJsMsnMw67M6NGeUtWbQ-2g-OwN69XSAlD7KiMfOoA,10523
24
- enterprise_data/admin_analytics/database/tables/fact_enrollment_admin_dash.py,sha256=FFpGtv2PUIDSdTqSZV4F3tVP9uDvS64ZqQXMGygCGok,11294
24
+ enterprise_data/admin_analytics/database/tables/fact_enrollment_admin_dash.py,sha256=cRRBFRc2p54BkW_h7GuUud-gWzJrqKep9dYgxOf7tIY,11741
25
25
  enterprise_data/admin_analytics/database/tables/skills_daily_rollup_admin_dash.py,sha256=3xNwSi0wfCyBHcXPd6-9Ujs1NUm8kmZRg_gPrZzp9nQ,3233
26
26
  enterprise_data/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
27
27
  enterprise_data/api/urls.py,sha256=POqc_KATHdnpMf9zHtpO46pKD5KAlAExtx7G6iylLcU,273
@@ -33,12 +33,12 @@ enterprise_data/api/v1/__init__.py,sha256=1aAzAYU5hk-RW6cKUxa1645cbZMxn7GIZ7OMjW
33
33
  enterprise_data/api/v1/serializers.py,sha256=oS09fMJyb3DkSc2y5TH5Yknd9NjYrlmWMRPNqBZ741U,10902
34
34
  enterprise_data/api/v1/urls.py,sha256=IpOyS9UWuyip6fw6gtrxBw9SZLOdxh3sQ2j0Gdk4eOw,4180
35
35
  enterprise_data/api/v1/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
36
- enterprise_data/api/v1/views/analytics_completions.py,sha256=4jg2I50TNn2Q6InLCI9eS1MBiFo4SMRsTx4kZJtNmpI,6268
37
- enterprise_data/api/v1/views/analytics_engagements.py,sha256=W9DNalWIgoeo_KXqapDj2_ireRyXU47nKHw95sAEtxM,6306
38
- enterprise_data/api/v1/views/analytics_enrollments.py,sha256=HXgoFwvXk-CZcf6qbVOfYSCnkfDxGvfHxl0j3RcKz7A,6290
39
- enterprise_data/api/v1/views/analytics_leaderboard.py,sha256=zwd-2A2sctjAdx5BUjCqiwcZ5aNvM8wfm386pR-RwGQ,4114
36
+ enterprise_data/api/v1/views/analytics_completions.py,sha256=xT9ywSRNjbQNLJjsm2N4cCyAXeibXY1800uirDn1prg,6260
37
+ enterprise_data/api/v1/views/analytics_engagements.py,sha256=TK6i0tSk0QObda0ysunEFzYrlsvLvSEypJRLJEi7JCk,6298
38
+ enterprise_data/api/v1/views/analytics_enrollments.py,sha256=6QRjzWapvc6jP3rv2QkGzfZMR2kRcsKqY3xRkvpIyRQ,6282
39
+ enterprise_data/api/v1/views/analytics_leaderboard.py,sha256=zOkvoxX5YlBZ0aLrvpWrdXJmQuAIWKb9Q5DReBbRT8k,4108
40
40
  enterprise_data/api/v1/views/base.py,sha256=Kkmd5zgEBAhvwS_GoGXSK6lgbDNwSPioYn-QbnizI3w,3416
41
- enterprise_data/api/v1/views/enterprise_admin.py,sha256=hAZR7dh8MIFMibs1rw0mPcdj_DyTjTpa0OqmrGPNdoM,8205
41
+ enterprise_data/api/v1/views/enterprise_admin.py,sha256=DyN6RS4qY8sgKNIvcx1nRmSGuPm2pLYHZeh5YHXlH2w,8209
42
42
  enterprise_data/api/v1/views/enterprise_learner.py,sha256=NqI_Tlz5v3p4fYZe2RRCg54AizslZdHB3Ckh8YQrhIM,18163
43
43
  enterprise_data/api/v1/views/enterprise_offers.py,sha256=VifxgqTLFLVw4extYPlHcN1N_yjXcsYsAlYEnAbpb10,1266
44
44
  enterprise_data/cache/__init__.py,sha256=fiBUploll1kmDy2vCmnNpeZVTD4ewsgtRF14vVs0Rb4,1850
@@ -54,12 +54,14 @@ enterprise_data/management/commands/create_enterprise_learner_enrollment_lpr_v1.
54
54
  enterprise_data/management/commands/create_enterprise_learner_lpr_v1.py,sha256=bUYmZHA3yK3ZBPhV0wkpRDgH_Q2b5rVQnwSp2hRmh28,1799
55
55
  enterprise_data/management/commands/create_enterprise_offer.py,sha256=0R1eEKWTCGjod4I8qBH2UBD-erqj5mFtM_DG5Vxet_0,1150
56
56
  enterprise_data/management/commands/create_enterprise_user.py,sha256=V_kvOSPZ1DXfAdF1W3AwAtavEYjdYaHBjjfzndZP8lk,1498
57
+ enterprise_data/management/commands/pre_warm_analytics_cache.py,sha256=5AznzVrU_tGxqtVLreOhnJ7iJUKc388YSyctTowWWCs,8276
57
58
  enterprise_data/management/commands/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
58
59
  enterprise_data/management/commands/tests/test_create_dummy_data_lpr_v1.py,sha256=wt9fqAFKQVTqllpZ42dch-n31JavUifUIB9CKNYcnYM,1086
59
60
  enterprise_data/management/commands/tests/test_create_enterprise_enrollment.py,sha256=5CABLk8qAx8RP8mrFtnbJ4-xVkf9-5Mq6iQcx8jBfFc,1742
60
61
  enterprise_data/management/commands/tests/test_create_enterprise_learner_enrollment_lpr_v1.py,sha256=FzOBHcd1FfSVN5AI8oAKvmqj-W8Y-V7x9yJx9R1WrLQ,3845
61
62
  enterprise_data/management/commands/tests/test_create_enterprise_learner_lpr_v1.py,sha256=P7wyyaZ4LMWv1umpCThp4By5DWjtI7kYAmY0AeuY2XI,1637
62
63
  enterprise_data/management/commands/tests/test_create_enterprise_user.py,sha256=0uxG332-jYpaxUIrMtIVRTwvRfxTWEQBIwZlIQO7f2g,1469
64
+ enterprise_data/management/commands/tests/test_pre_warm_analytics_cache.py,sha256=zjib-l9kNJiRG8EHxdQa66C8S0qaC5f4qb03-ddA7Rg,1997
63
65
  enterprise_data/migrations/0001_initial.py,sha256=g2fNJGLxELthmYrJlPB7cBxbsLWB6u-MotQvE3t95ww,2358
64
66
  enterprise_data/migrations/0002_auto_20180430_1358.py,sha256=roRSgWy2p4hFefNFaajg-q_e8_5FHZih_ou1dLTwWQk,600
65
67
  enterprise_data/migrations/0003_auto_20180501_0603.py,sha256=N9C5QcdRMfzTycO6xqdi7WPkwrktn3y3NEsm30L4pS8,415
@@ -169,8 +171,8 @@ enterprise_reporting/tests/test_send_enterprise_reports.py,sha256=WtL-RqGgu2x5PP
169
171
  enterprise_reporting/tests/test_utils.py,sha256=Zt_TA0LVb-B6fQGkUkAKKVlUKKnQh8jnw1US1jKe7g8,9493
170
172
  enterprise_reporting/tests/test_vertica_client.py,sha256=-R2yNCGUjRtoXwLMBloVFQkFYrJoo613VCr61gwI3kQ,140
171
173
  enterprise_reporting/tests/utils.py,sha256=xms2LM7DV3wczXEfctOK1ddel1EE0J_YSr17UzbCDy4,1401
172
- edx_enterprise_data-9.7.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
173
- edx_enterprise_data-9.7.0.dist-info/METADATA,sha256=bDigs0YXxVqQLa6h2E7tuDnZ-WVtg6VkvlEt6i5dWsk,1569
174
- edx_enterprise_data-9.7.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
175
- edx_enterprise_data-9.7.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
176
- edx_enterprise_data-9.7.0.dist-info/RECORD,,
174
+ edx_enterprise_data-9.7.1.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
175
+ edx_enterprise_data-9.7.1.dist-info/METADATA,sha256=sHPXXn_ikyBqlaGAx2XbPGCFGqbk-ggqan5fQn_uCtk,1569
176
+ edx_enterprise_data-9.7.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
177
+ edx_enterprise_data-9.7.1.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
178
+ edx_enterprise_data-9.7.1.dist-info/RECORD,,
@@ -2,4 +2,4 @@
2
2
  Enterprise data api application. This Django app exposes API endpoints used by enterprises.
3
3
  """
4
4
 
5
- __version__ = "9.7.0"
5
+ __version__ = "9.7.1"
@@ -7,6 +7,18 @@ class FactEnrollmentAdminDashQueries:
7
7
  """
8
8
  Queries related to the fact_enrollment_admin_dash table.
9
9
  """
10
+ @staticmethod
11
+ def get_top_enterprises_query(count=10):
12
+ """
13
+ Get the query to fetch the top enterprises by enrollments.
14
+ """
15
+ return f"""
16
+ SELECT enterprise_customer_uuid
17
+ FROM fact_enrollment_admin_dash
18
+ GROUP BY enterprise_customer_uuid
19
+ ORDER BY COUNT(enterprise_customer_uuid) DESC LIMIT {count};
20
+ """
21
+
10
22
  @staticmethod
11
23
  def get_enrollment_count_query():
12
24
  """
@@ -17,6 +17,22 @@ class FactEnrollmentAdminDashTable(BaseTable):
17
17
  """
18
18
  queries = FactEnrollmentAdminDashQueries()
19
19
 
20
+ def get_top_enterprises(self, count=10):
21
+ """
22
+ Get the top enterprises by enrollments.
23
+
24
+ Arguments:
25
+ count (int): The number of enterprises to return.
26
+
27
+ Returns:
28
+ list<str>: A list of enterprise UUIDs.
29
+ """
30
+ result = run_query(
31
+ query=self.queries.get_top_enterprises_query(count),
32
+ as_dict=False,
33
+ )
34
+ return [row[0] for row in result]
35
+
20
36
  @cache_it()
21
37
  def get_enrollment_count(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
22
38
  """
@@ -77,7 +93,7 @@ class FactEnrollmentAdminDashTable(BaseTable):
77
93
  Get the enrollment date range for the given enterprise customer.
78
94
 
79
95
  Arguments:
80
- enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
96
+ enterprise_customer_uuid (UUID | str): The UUID of the enterprise customer.
81
97
 
82
98
  Returns:
83
99
  (tuple<date, date>): The minimum and maximum enrollment dates.
@@ -2,7 +2,7 @@
2
2
  Views for enterprise admin completions analytics.
3
3
  """
4
4
 
5
- from datetime import datetime
5
+ from datetime import date
6
6
  from logging import getLogger
7
7
 
8
8
  from edx_rbac.decorators import permission_required
@@ -50,7 +50,7 @@ class AdvanceAnalyticsCompletionsView(AnalyticsPaginationMixin, ViewSet):
50
50
 
51
51
  # get values from query params or use default values
52
52
  start_date = serializer.data.get('start_date', min_enrollment_date)
53
- end_date = serializer.data.get('end_date', datetime.now())
53
+ end_date = serializer.data.get('end_date', date.today())
54
54
  page = serializer.data.get('page', 1)
55
55
  page_size = serializer.data.get('page_size', 100)
56
56
  completions = FactEnrollmentAdminDashTable().get_all_completions(
@@ -132,7 +132,7 @@ class AdvanceAnalyticsCompletionsView(AnalyticsPaginationMixin, ViewSet):
132
132
  )
133
133
  # get values from query params or use default
134
134
  start_date = serializer.data.get('start_date', min_enrollment_date)
135
- end_date = serializer.data.get('end_date', datetime.now())
135
+ end_date = serializer.data.get('end_date', date.today())
136
136
  with timer('construct_completion_all_stats'):
137
137
  data = {
138
138
  'completions_over_time': FactEnrollmentAdminDashTable().get_completions_time_series_data(
@@ -2,7 +2,7 @@
2
2
  Views for handling REST endpoints related to Engagements analytics.
3
3
  """
4
4
 
5
- from datetime import datetime
5
+ from datetime import date
6
6
  from logging import getLogger
7
7
 
8
8
  from edx_rbac.decorators import permission_required
@@ -50,7 +50,7 @@ class AdvanceAnalyticsEngagementView(AnalyticsPaginationMixin, ViewSet):
50
50
 
51
51
  # get values from query params or use default values
52
52
  start_date = serializer.data.get('start_date', min_enrollment_date)
53
- end_date = serializer.data.get('end_date', datetime.now())
53
+ end_date = serializer.data.get('end_date', date.today())
54
54
  page = serializer.data.get('page', 1)
55
55
  page_size = serializer.data.get('page_size', 100)
56
56
  engagements = FactEngagementAdminDashTable().get_all_engagements(
@@ -132,7 +132,7 @@ class AdvanceAnalyticsEngagementView(AnalyticsPaginationMixin, ViewSet):
132
132
  )
133
133
  # get values from query params or use default
134
134
  start_date = serializer.data.get('start_date', min_enrollment_date)
135
- end_date = serializer.data.get('end_date', datetime.now())
135
+ end_date = serializer.data.get('end_date', date.today())
136
136
  with timer('construct_engagement_all_stats'):
137
137
  data = {
138
138
  'engagement_over_time': FactEngagementAdminDashTable().get_engagement_time_series_data(
@@ -1,7 +1,7 @@
1
1
  """
2
2
  Advance Analytics for API endpoints to fetch enterprise enrollments data.
3
3
  """
4
- from datetime import datetime
4
+ from datetime import date
5
5
  from logging import getLogger
6
6
 
7
7
  from edx_rbac.decorators import permission_required
@@ -49,7 +49,7 @@ class AdvanceAnalyticsEnrollmentsView(AnalyticsPaginationMixin, ViewSet):
49
49
 
50
50
  # get values from query params or use default values
51
51
  start_date = serializer.data.get('start_date', min_enrollment_date)
52
- end_date = serializer.data.get('end_date', datetime.now())
52
+ end_date = serializer.data.get('end_date', date.today())
53
53
  page = serializer.data.get('page', 1)
54
54
  page_size = serializer.data.get('page_size', 100)
55
55
  enrollments = FactEnrollmentAdminDashTable().get_all_enrollments(
@@ -131,7 +131,7 @@ class AdvanceAnalyticsEnrollmentsView(AnalyticsPaginationMixin, ViewSet):
131
131
  )
132
132
  # get values from query params or use default
133
133
  start_date = serializer.data.get('start_date', min_enrollment_date)
134
- end_date = serializer.data.get('end_date', datetime.now())
134
+ end_date = serializer.data.get('end_date', date.today())
135
135
  with timer('construct_enrollment_all_stats'):
136
136
  data = {
137
137
  'enrollments_over_time': FactEnrollmentAdminDashTable().get_enrolment_time_series_data(
@@ -2,7 +2,7 @@
2
2
  Views for fetching leaderboard data.
3
3
  """
4
4
 
5
- from datetime import datetime
5
+ from datetime import date
6
6
  from logging import getLogger
7
7
 
8
8
  from edx_rbac.decorators import permission_required
@@ -46,7 +46,7 @@ class AdvanceAnalyticsLeaderboardView(AnalyticsPaginationMixin, ViewSet):
46
46
 
47
47
  # get values from query params or use default values
48
48
  start_date = serializer.data.get('start_date', min_enrollment_date)
49
- end_date = serializer.data.get('end_date', datetime.now())
49
+ end_date = serializer.data.get('end_date', date.today())
50
50
  page = serializer.data.get('page', 1)
51
51
  page_size = serializer.data.get('page_size', 100)
52
52
  leaderboard = FactEngagementAdminDashTable().get_all_leaderboard_data(
@@ -1,7 +1,7 @@
1
1
  """
2
2
  Views for enterprise admin api v1.
3
3
  """
4
- from datetime import datetime
4
+ from datetime import date, datetime
5
5
 
6
6
  from edx_rbac.decorators import permission_required
7
7
  from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication
@@ -160,7 +160,7 @@ class EnterpriseAdminAnalyticsSkillsView(APIView):
160
160
  if (start_date := serializer.data.get('start_date')) is None:
161
161
  start_date, _ = FactEnrollmentAdminDashTable().get_enrollment_date_range(enterprise_id)
162
162
 
163
- end_date = serializer.data.get('end_date', datetime.now())
163
+ end_date = serializer.data.get('end_date', date.today())
164
164
 
165
165
  with timer('top_skills'):
166
166
  skills = SkillsDailyRollupAdminDashTable().get_top_skills(enterprise_id, start_date, end_date)
@@ -0,0 +1,218 @@
1
+ """
2
+ Management command for pre-warming the analytics cache for large enterprises.
3
+ """
4
+ from datetime import date
5
+
6
+ from django.core.management.base import BaseCommand, CommandError
7
+
8
+ from enterprise_data.admin_analytics.database.tables import (
9
+ FactEngagementAdminDashTable,
10
+ FactEnrollmentAdminDashTable,
11
+ SkillsDailyRollupAdminDashTable,
12
+ )
13
+
14
+
15
+ class Command(BaseCommand):
16
+ """
17
+ Add cache entries for analytics related data for a large enterprise.
18
+
19
+ The top enterprises will be the ones with the most enrollments.
20
+ """
21
+ help = 'Pre-warm the analytics cache for a large enterprises.'
22
+
23
+ @staticmethod
24
+ def __cache_enrollment_data(enterprise_customer_uuid):
25
+ """
26
+ Helper method to cache all the enrollment related data for the given enterprise.
27
+
28
+ Arguments:
29
+ enterprise_customer_uuid (str): The UUID of the enterprise customer.
30
+ """
31
+ enterprise_enrollment_table = FactEnrollmentAdminDashTable()
32
+ start_date, _ = enterprise_enrollment_table.get_enrollment_date_range(
33
+ enterprise_customer_uuid,
34
+ )
35
+ end_date = date.today()
36
+ enterprise_enrollment_table.get_enrollment_count(
37
+ enterprise_customer_uuid=enterprise_customer_uuid,
38
+ start_date=start_date,
39
+ end_date=end_date,
40
+ )
41
+ page_size = 100
42
+ enterprise_enrollment_table.get_all_enrollments(
43
+ enterprise_customer_uuid=enterprise_customer_uuid,
44
+ start_date=start_date,
45
+ end_date=end_date,
46
+ limit=page_size,
47
+ offset=0,
48
+ )
49
+ enterprise_enrollment_table.get_enrollment_and_course_count(
50
+ enterprise_customer_uuid=enterprise_customer_uuid,
51
+ start_date=start_date,
52
+ end_date=end_date,
53
+ )
54
+ enterprise_enrollment_table.get_completion_count(
55
+ enterprise_customer_uuid=enterprise_customer_uuid,
56
+ start_date=start_date,
57
+ end_date=end_date,
58
+ )
59
+ enterprise_enrollment_table.get_top_courses_by_enrollments(
60
+ enterprise_customer_uuid=enterprise_customer_uuid,
61
+ start_date=start_date,
62
+ end_date=end_date,
63
+ )
64
+ enterprise_enrollment_table.get_top_subjects_by_enrollments(
65
+ enterprise_customer_uuid=enterprise_customer_uuid,
66
+ start_date=start_date,
67
+ end_date=end_date,
68
+ )
69
+ enterprise_enrollment_table.get_enrolment_time_series_data(
70
+ enterprise_customer_uuid=enterprise_customer_uuid,
71
+ start_date=start_date,
72
+ end_date=end_date,
73
+ )
74
+
75
+ @staticmethod
76
+ def __cache_completions_data(enterprise_customer_uuid):
77
+ """
78
+ Helper method to cache all the completions related data for the given enterprise.
79
+
80
+ Arguments:
81
+ enterprise_customer_uuid (str): The UUID of the enterprise customer.
82
+ """
83
+ enterprise_enrollment_table = FactEnrollmentAdminDashTable()
84
+ start_date, _ = enterprise_enrollment_table.get_enrollment_date_range(
85
+ enterprise_customer_uuid,
86
+ )
87
+ end_date = date.today()
88
+
89
+ page_size = 100
90
+ enterprise_enrollment_table.get_all_completions(
91
+ enterprise_customer_uuid=enterprise_customer_uuid,
92
+ start_date=start_date,
93
+ end_date=end_date,
94
+ limit=page_size,
95
+ offset=0,
96
+ )
97
+ enterprise_enrollment_table.get_completion_count(
98
+ enterprise_customer_uuid=enterprise_customer_uuid,
99
+ start_date=start_date,
100
+ end_date=end_date,
101
+ )
102
+ enterprise_enrollment_table.get_top_courses_by_completions(
103
+ enterprise_customer_uuid=enterprise_customer_uuid,
104
+ start_date=start_date,
105
+ end_date=end_date,
106
+ )
107
+ enterprise_enrollment_table.get_top_subjects_by_completions(
108
+ enterprise_customer_uuid=enterprise_customer_uuid,
109
+ start_date=start_date,
110
+ end_date=end_date,
111
+ )
112
+ enterprise_enrollment_table.get_completions_time_series_data(
113
+ enterprise_customer_uuid=enterprise_customer_uuid,
114
+ start_date=start_date,
115
+ end_date=end_date,
116
+ )
117
+
118
+ @staticmethod
119
+ def __cache_engagement_data(enterprise_customer_uuid):
120
+ """
121
+ Helper method to cache all the engagement related data for the given enterprise.
122
+
123
+ Arguments:
124
+ enterprise_customer_uuid (str): The UUID of the enterprise customer.
125
+ """
126
+ start_date, _ = FactEnrollmentAdminDashTable().get_enrollment_date_range(
127
+ enterprise_customer_uuid,
128
+ )
129
+ end_date = date.today()
130
+ enterprise_engagement_table = FactEngagementAdminDashTable()
131
+ enterprise_engagement_table.get_learning_hours_and_daily_sessions(
132
+ enterprise_customer_uuid=enterprise_customer_uuid,
133
+ start_date=start_date,
134
+ end_date=end_date,
135
+ )
136
+ enterprise_engagement_table.get_engagement_count(
137
+ enterprise_customer_uuid=enterprise_customer_uuid,
138
+ start_date=start_date,
139
+ end_date=end_date,
140
+ )
141
+ page_size = 100
142
+ enterprise_engagement_table.get_all_engagements(
143
+ enterprise_customer_uuid=enterprise_customer_uuid,
144
+ start_date=start_date,
145
+ end_date=end_date,
146
+ limit=page_size,
147
+ offset=0,
148
+ )
149
+ enterprise_engagement_table.get_top_courses_by_engagement(
150
+ enterprise_customer_uuid=enterprise_customer_uuid,
151
+ start_date=start_date,
152
+ end_date=end_date,
153
+ )
154
+ enterprise_engagement_table.get_top_subjects_by_engagement(
155
+ enterprise_customer_uuid=enterprise_customer_uuid,
156
+ start_date=start_date,
157
+ end_date=end_date,
158
+ )
159
+ enterprise_engagement_table.get_engagement_time_series_data(
160
+ enterprise_customer_uuid=enterprise_customer_uuid,
161
+ start_date=start_date,
162
+ end_date=end_date,
163
+ )
164
+ enterprise_engagement_table.get_all_leaderboard_data(
165
+ enterprise_customer_uuid=enterprise_customer_uuid,
166
+ start_date=start_date,
167
+ end_date=end_date,
168
+ limit=page_size,
169
+ offset=0,
170
+ )
171
+ enterprise_engagement_table.get_leaderboard_data_count(
172
+ enterprise_customer_uuid=enterprise_customer_uuid,
173
+ start_date=start_date,
174
+ end_date=end_date,
175
+ )
176
+
177
+ @staticmethod
178
+ def __cache_skills_data(enterprise_customer_uuid):
179
+ """
180
+ Helper method to cache all the skills related data for the given enterprise.
181
+
182
+ Arguments:
183
+ enterprise_customer_uuid (str): The UUID of the enterprise customer.
184
+ """
185
+ start_date, _ = FactEnrollmentAdminDashTable().get_enrollment_date_range(
186
+ enterprise_customer_uuid,
187
+ )
188
+ end_date = date.today()
189
+ skills_table = SkillsDailyRollupAdminDashTable()
190
+ skills_table.get_top_skills(
191
+ enterprise_customer_uuid=enterprise_customer_uuid,
192
+ start_date=start_date,
193
+ end_date=end_date,
194
+ )
195
+ skills_table.get_top_skills_by_enrollment(
196
+ enterprise_customer_uuid=enterprise_customer_uuid,
197
+ start_date=start_date,
198
+ end_date=end_date,
199
+ )
200
+ skills_table.get_top_skills_by_completion(
201
+ enterprise_customer_uuid=enterprise_customer_uuid,
202
+ start_date=start_date,
203
+ end_date=end_date,
204
+ )
205
+
206
+ def handle(self, *args, **options):
207
+ for enterprise_customer_uuid in FactEnrollmentAdminDashTable().get_top_enterprises():
208
+ try:
209
+ self.__cache_enrollment_data(enterprise_customer_uuid)
210
+ self.__cache_completions_data(enterprise_customer_uuid)
211
+ self.__cache_engagement_data(enterprise_customer_uuid)
212
+ self.__cache_skills_data(enterprise_customer_uuid)
213
+ except Exception as exc:
214
+ info = (
215
+ 'Error trying to add cache entries for enterprise '
216
+ '{}: {}'.format(enterprise_customer_uuid, exc)
217
+ )
218
+ raise CommandError(info) from exc
@@ -0,0 +1,51 @@
1
+ """
2
+ Tests for `./manage.py pre_warm_analytics_cache` management command.
3
+ """
4
+ from datetime import datetime
5
+ from unittest import TestCase
6
+
7
+ from mock import MagicMock, patch
8
+ from pytest import mark
9
+
10
+ from django.core.management import call_command
11
+
12
+
13
+ @mark.django_db
14
+ class Test(TestCase):
15
+ """
16
+ Tests to validate the behavior of `./manage.py pre_warm_analytics_cache` management command.
17
+ """
18
+ def setUp(self):
19
+ """
20
+ Setup method.
21
+ """
22
+ super().setUp()
23
+ self.enterprise_uuid = 'ee5e6b3a-069a-4947-bb8d-d2dbc323396c'
24
+
25
+ get_enrollment_date_range_patcher = patch(
26
+ 'enterprise_data.api.v1.views.analytics_enrollments.FactEnrollmentAdminDashTable.get_enrollment_date_range',
27
+ return_value=(datetime.now(), datetime.now())
28
+ )
29
+
30
+ get_enrollment_date_range_patcher.start()
31
+ self.addCleanup(get_enrollment_date_range_patcher.stop)
32
+
33
+ @patch('enterprise_data.admin_analytics.database.tables.fact_engagement_admin_dash.run_query', MagicMock())
34
+ @patch('enterprise_data.admin_analytics.database.tables.fact_enrollment_admin_dash.run_query', MagicMock())
35
+ @patch('enterprise_data.admin_analytics.database.tables.skills_daily_rollup_admin_dash.run_query', MagicMock())
36
+ @patch('enterprise_data.api.v1.views.analytics_enrollments.FactEnrollmentAdminDashTable.get_top_enterprises')
37
+ @patch('enterprise_data.cache.decorators.cache.set')
38
+ @patch('enterprise_data.cache.decorators.cache.get')
39
+ def test_pre_warm_analytics_cache(self, mock_get_cache, mock_set_cache, mock_get_top_enterprises):
40
+ """
41
+ Validate that the command caches the analytics data for a large enterprise.
42
+ """
43
+ mock_get_top_enterprises.return_value = [
44
+ self.enterprise_uuid
45
+ ]
46
+ mock_get_cache.return_value = MagicMock(is_found=False)
47
+
48
+ call_command('pre_warm_analytics_cache')
49
+
50
+ assert mock_get_cache.call_count == 24
51
+ assert mock_set_cache.call_count == 24