feat: Introduce disable_expiry field on the enterprise customer model (…

…#2106)

CHANGELOG.rst

@@ -17,6 +17,10 @@ Unreleased
 ----------
 * nothing unreleased
 
+[4.19.0]
+--------
+* feat: Introduce disable_expiry field on the enterprise customer model
+
 [4.18.6]
 --------
 * feat: allowing for group members to be revived by reassigning

enterprise/__init__.py

@@ -2,4 +2,4 @@
 Your project description goes here.
 """
 
-__version__ = "4.18.6"
+__version__ = "4.19.0"

enterprise/admin/__init__.py

@@ -211,6 +211,7 @@ class EnterpriseCustomerAdmin(DjangoObjectActions, SimpleHistoryAdmin):
                        'enable_integrated_customer_learner_portal_search',
                        'enable_analytics_screen', 'enable_audit_enrollment',
                        'enable_audit_data_reporting', 'enable_learner_portal_offers',
+                       'disable_expiry_messaging_for_learner_credit',
                        'enable_executive_education_2U_fulfillment',
                        'enable_career_engagement_network_on_learner_portal',
                        'career_engagement_network_message', 'enable_pathways', 'enable_programs',

enterprise/admin/forms.py

@@ -395,6 +395,7 @@ class Meta:
             "enable_audit_data_reporting",
             "replace_sensitive_sso_username",
             "hide_course_original_price",
+            "disable_expiry_messaging_for_learner_credit",
             "enable_portal_code_management_screen",
             "enable_portal_subscription_management_screen",
             "enable_learner_portal",

enterprise/api/v1/serializers.py

@@ -211,7 +211,7 @@ class Meta:
         model = models.EnterpriseCustomer
         fields = (
             'uuid', 'name', 'slug', 'active', 'auth_org_id', 'site', 'enable_data_sharing_consent',
-            'enforce_data_sharing_consent', 'branding_configuration',
+            'enforce_data_sharing_consent', 'branding_configuration', 'disable_expiry_messaging_for_learner_credit',
             'identity_provider', 'enable_audit_enrollment', 'replace_sensitive_sso_username',
             'enable_portal_code_management_screen', 'sync_learner_profile_data', 'enable_audit_data_reporting',
             'enable_learner_portal', 'enable_learner_portal_offers', 'enable_portal_learner_credit_management_screen',

enterprise/migrations/0208_enterprisecustomer_disable_expiry_messaging_for_learner_credit_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 4.2.13 on 2024-05-16 16:24
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('enterprise', '0207_alter_enterprisegroupmembership_enterprise_customer_user_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='enterprisecustomer',
+            name='disable_expiry_messaging_for_learner_credit',
+            field=models.BooleanField(default=False, help_text='If checked, learners and admins will not receive expiration-related email and other notifications regarding learner credit plans.', verbose_name='Disable expiration messaging for learner credit'),
+        ),
+        migrations.AddField(
+            model_name='historicalenterprisecustomer',
+            name='disable_expiry_messaging_for_learner_credit',
+            field=models.BooleanField(default=False, help_text='If checked, learners and admins will not receive expiration-related email and other notifications regarding learner credit plans.', verbose_name='Disable expiration messaging for learner credit'),
+        ),
+    ]

enterprise/models.py

@@ -312,6 +312,13 @@ class Meta:
         on_delete=models.CASCADE
     )
 
+    disable_expiry_messaging_for_learner_credit = models.BooleanField(
+        verbose_name="Disable expiration messaging for learner credit",
+        default=False,
+        help_text=_("If checked, learners and admins will not receive expiration-related email and "
+                    "other notifications regarding learner credit plans.")
+    )
+
     enable_portal_code_management_screen = models.BooleanField(
         verbose_name="Display code management screen",
         default=False,

tests/test_enterprise/api/test_views.py

@@ -1201,6 +1201,7 @@ class TestEnterpriseCustomerViewSet(BaseTestEnterpriseAPIViews):
                 'enable_audit_enrollment': False,
                 'replace_sensitive_sso_username': False, 'enable_portal_code_management_screen': False,
                 'sync_learner_profile_data': False,
+                'disable_expiry_messaging_for_learner_credit': False,
                 'enable_audit_data_reporting': True,
                 'enable_learner_portal': True,
                 'enable_learner_portal_offers': False,
@@ -1269,6 +1270,7 @@ class TestEnterpriseCustomerViewSet(BaseTestEnterpriseAPIViews):
                     'identity_provider': None, 'enable_audit_enrollment': False,
                     'replace_sensitive_sso_username': False, 'enable_portal_code_management_screen': False,
                     'sync_learner_profile_data': False, 'enable_audit_data_reporting': False,
+                    'disable_expiry_messaging_for_learner_credit': False,
                     'enable_learner_portal': True, 'enable_learner_portal_offers': False,
                     'enable_portal_learner_credit_management_screen': False,
                     'enable_executive_education_2U_fulfillment': False,
@@ -1356,6 +1358,7 @@ class TestEnterpriseCustomerViewSet(BaseTestEnterpriseAPIViews):
                 'identity_provider': FAKE_UUIDS[0], 'enable_audit_enrollment': False,
                 'replace_sensitive_sso_username': False, 'enable_portal_code_management_screen': False,
                 'sync_learner_profile_data': False,
+                'disable_expiry_messaging_for_learner_credit': False,
                 'enable_audit_data_reporting': False,
                 'enable_learner_portal': True,
                 'enable_learner_portal_offers': False,
@@ -1430,6 +1433,7 @@ class TestEnterpriseCustomerViewSet(BaseTestEnterpriseAPIViews):
                 'replace_sensitive_sso_username': False,
                 'enable_portal_code_management_screen': False,
                 'sync_learner_profile_data': False,
+                'disable_expiry_messaging_for_learner_credit': False,
                 'enable_audit_data_reporting': False,
                 'enable_learner_portal': True,
                 'enable_learner_portal_offers': False,
@@ -1526,6 +1530,7 @@ class TestEnterpriseCustomerViewSet(BaseTestEnterpriseAPIViews):
                 'enable_audit_enrollment': False,
                 'replace_sensitive_sso_username': False, 'enable_portal_code_management_screen': False,
                 'sync_learner_profile_data': False,
+                'disable_expiry_messaging_for_learner_credit': False,
                 'enable_audit_data_reporting': False,
                 'enable_learner_portal': True,
                 'enable_learner_portal_offers': False,
@@ -1767,6 +1772,7 @@ def test_enterprise_customer_with_access_to(
                 'replace_sensitive_sso_username': False,
                 'enable_portal_code_management_screen': True,
                 'sync_learner_profile_data': False,
+                'disable_expiry_messaging_for_learner_credit': False,
                 'enable_audit_data_reporting': False,
                 'enable_learner_portal': True,
                 'enable_learner_portal_offers': False,

tests/test_utilities.py

@@ -141,6 +141,7 @@ def setUp(self):
                 "invite_keys",
                 "hide_course_original_price",
                 "site",
+                "disable_expiry_messaging_for_learner_credit",
                 "enable_data_sharing_consent",
                 "enforce_data_sharing_consent",
                 "enable_audit_enrollment",