feat: make 14 day trial default for feature rollout (#203)

* feat: make 14 day trial default for feature rollout

* chore: nit

Author: ilee2u

CHANGELOG.rst

@@ -13,6 +13,12 @@ Change Log
 
 Unreleased
 **********
+
+4.11.0 - 2025-08-08
+******************
+* Replaced the get_audit_trial_length_days utils.py function from with the AUDIT_TRIAL_MAX_DAYS = 14, as the
+  audit trial length will be 14 days going forwards.
+
 4.10.8 - 2025-07-31
 *******************
 * Chat history to support XPert Chat API V2 response with a list of messages.

learning_assistant/__init__.py

@@ -2,6 +2,6 @@
 Plugin for a learning assistant backend, intended for use within edx-platform.
 """
 
-__version__ = '4.10.8'
+__version__ = '4.11.0'
 
 default_app_config = 'learning_assistant.apps.LearningAssistantConfig'  # pylint: disable=invalid-name

learning_assistant/api.py

@@ -12,7 +12,7 @@
 from jinja2 import BaseLoader, Environment
 from opaque_keys import InvalidKeyError
 
-from learning_assistant.constants import ACCEPTED_CATEGORY_TYPES, CATEGORY_TYPE_MAP
+from learning_assistant.constants import ACCEPTED_CATEGORY_TYPES, AUDIT_TRIAL_MAX_DAYS, CATEGORY_TYPE_MAP
 from learning_assistant.data import LearningAssistantAuditTrialData, LearningAssistantCourseEnabledData
 from learning_assistant.models import (
     LearningAssistantAuditTrial,
@@ -29,7 +29,6 @@
     traverse_block_pre_order,
 )
 from learning_assistant.text_utils import html_to_text
-from learning_assistant.utils import get_audit_trial_length_days
 
 log = logging.getLogger(__name__)
 User = get_user_model()
@@ -243,7 +242,7 @@ def get_message_history(courserun_key, user, message_count):
     return message_history
 
 
-def get_audit_trial_expiration_date_from_start_date(start_date, user_id, enrollment_mode):
+def get_audit_trial_expiration_date_from_start_date(start_date):
     """
     Given a start date of an audit trial, return the expiration date of the audit trial.
 
@@ -253,14 +252,12 @@ def get_audit_trial_expiration_date_from_start_date(start_date, user_id, enrollm
 
     Arguments:
     * start_date (datetime): the start date of the audit trial
-    * user_id (int): user id
-    * enrollment_mode (str): enrollment mode of the user
 
     Returns:
     * expiration_date (datetime): the expiration date of the audit trial
     """
-    trial_length_days = get_audit_trial_length_days(user_id, enrollment_mode)
-    expiration_datetime = start_date + timedelta(days=trial_length_days)
+    # Default audit trial length is 14 days
+    expiration_datetime = start_date + timedelta(days=AUDIT_TRIAL_MAX_DAYS)
 
     return expiration_datetime
 
@@ -291,13 +288,12 @@ def get_audit_trial(user):
     )
 
 
-def get_or_create_audit_trial(user, enrollment_mode):
+def get_or_create_audit_trial(user):
     """
     Given a user, return the associated audit trial data, creating a new audit trial for the user if one does not exist.
 
     Arguments:
     * user (User): the user
-    * enrollment_mode (str): enrollment mode of the user
 
     Returns:
     * audit_trial_data (LearningAssistantAuditTrialData): the audit trial data
@@ -306,7 +302,7 @@ def get_or_create_audit_trial(user, enrollment_mode):
         * expiration_date (datetime): the expiration date of the audit trial
     """
     start_date = timezone.now()
-    expiration_date = get_audit_trial_expiration_date_from_start_date(start_date, user.id, enrollment_mode)
+    expiration_date = get_audit_trial_expiration_date_from_start_date(start_date)
 
     audit_trial, _ = LearningAssistantAuditTrial.objects.get_or_create(
         user=user,

learning_assistant/utils.py

@@ -156,42 +156,6 @@ def get_optimizely_variation(user_id, enrollment_mode):
     return {'enabled': enabled, 'variation_key': variation_key}
 
 
-def get_audit_trial_length_days(user_id, enrollment_mode):
-    """
-    Return the length of an audit trial in days.
-
-    Arguments:
-    * user_id
-    * enrollment_mode
-
-    Returns:
-    * int: the length of an audit trial in days
-    """
-    variation = get_optimizely_variation(user_id, enrollment_mode)
-
-    # For the sake of the experiment on the backend, the only difference in behavior should be for the 28 day variation.
-    # This is because the control group will never see the audit experience, so the value being returned here does not
-    # matter, and the 14 day variation can use the default trial length of 14 days.
-    if (
-        variation['enabled']
-        and variation['variation_key'] == getattr(settings, 'OPTIMIZELY_LEARNING_ASSISTANT_TRIAL_VARIATION_KEY_28', '')
-    ):
-        trial_length_days = 28
-    else:
-        default_trial_length_days = 14
-        trial_length_days = getattr(settings, 'LEARNING_ASSISTANT_AUDIT_TRIAL_LENGTH_DAYS', default_trial_length_days)
-
-    if trial_length_days is None:
-        trial_length_days = default_trial_length_days
-
-    # If LEARNING_ASSISTANT_AUDIT_TRIAL_LENGTH_DAYS is set to a negative number, assume it should be 0.
-    # pylint: disable=consider-using-max-builtin
-    if trial_length_days < 0:
-        trial_length_days = 0
-
-    return trial_length_days
-
-
 def parse_lms_datetime(datetime_string):
     """
     Parse an LMS datetime into a timezone-aware, Python datetime object.

learning_assistant/views.py

@@ -33,17 +33,12 @@
     render_prompt_template,
     save_chat_message,
 )
+from learning_assistant.constants import AUDIT_TRIAL_MAX_DAYS
 from learning_assistant.models import LearningAssistantMessage
 from learning_assistant.platform_imports import get_cache_course_run_data
 from learning_assistant.serializers import MessageSerializer
 from learning_assistant.toggles import chat_history_enabled
-from learning_assistant.utils import (
-    extract_message_content,
-    get_audit_trial_length_days,
-    get_chat_response,
-    parse_lms_datetime,
-    user_role_is_staff,
-)
+from learning_assistant.utils import extract_message_content, get_chat_response, parse_lms_datetime, user_role_is_staff
 
 log = logging.getLogger(__name__)
 
@@ -178,7 +173,7 @@ def post(self, request, course_run_id):
         # If user has an audit enrollment record, get or create their trial. If the trial is not expired, return the
         # next message. Otherwise, return 403
         elif enrollment_mode in CourseMode.UPSELL_TO_VERIFIED_MODES:  # AUDIT, HONOR
-            audit_trial = get_or_create_audit_trial(request.user, enrollment_mode)
+            audit_trial = get_or_create_audit_trial(request.user)
             is_user_audit_trial_expired = audit_trial_is_expired(enrollment_object, audit_trial)
             if is_user_audit_trial_expired:
                 return Response(
@@ -335,6 +330,7 @@ def get(self, request, course_run_id):
 
         data['audit_trial'] = trial_data
 
-        data['audit_trial_length_days'] = get_audit_trial_length_days(user.id, enrollment_mode)
+        # Default audit trial length is 14 days
+        data['audit_trial_length_days'] = AUDIT_TRIAL_MAX_DAYS
 
         return Response(status=http_status.HTTP_200_OK, data=data)

tests/test_api.py

@@ -532,23 +532,15 @@ class GetAuditTrialExpirationDateFromStartTests(TestCase):
     """
 
     @ddt.data(
-        (datetime(2024, 1, 1, 0, 0, 0), datetime(2024, 1, 2, 0, 0, 0), 1),
-        (datetime(2024, 1, 18, 0, 0, 0), datetime(2024, 1, 19, 0, 0, 0), 1),
-        (datetime(2024, 1, 1, 0, 0, 0), datetime(2024, 1, 8, 0, 0, 0), 7),
-        (datetime(2024, 1, 18, 0, 0, 0), datetime(2024, 1, 25, 0, 0, 0), 7),
-        (datetime(2024, 1, 1, 0, 0, 0), datetime(2024, 1, 15, 0, 0, 0), 14),
-        (datetime(2024, 1, 18, 0, 0, 0), datetime(2024, 2, 1, 0, 0, 0), 14),
+        (datetime(2024, 1, 1, 0, 0, 0), datetime(2024, 1, 15, 0, 0, 0)),
+        (datetime(2024, 1, 18, 0, 0, 0), datetime(2024, 2, 1, 0, 0, 0)),
     )
     @ddt.unpack
-    @patch('learning_assistant.api.get_audit_trial_length_days')
     def test_expiration_date(
         self, start_date,
         expected_expiration_date,
-        trial_length_days,
-        mock_get_audit_trial_length_days
     ):
-        mock_get_audit_trial_length_days.return_value = trial_length_days
-        expiration_date = get_audit_trial_expiration_date_from_start_date(start_date, 1, 'verified')
+        expiration_date = get_audit_trial_expiration_date_from_start_date(start_date)
         self.assertEqual(expected_expiration_date, expiration_date)
 
 
@@ -623,7 +615,7 @@ def test_exists_get(self, audit_trial_expiration_date, get_audit_trial_expiratio
             start_date=audit_trial_start_date,
             expiration_date=timezone.make_aware(audit_trial_expiration_date),
         )
-        self.assertEqual(expected_return, get_or_create_audit_trial(self.user, 'verified'))
+        self.assertEqual(expected_return, get_or_create_audit_trial(self.user))
 
     @freeze_time('2024-01-01')
     @ddt.data(
@@ -644,7 +636,7 @@ def test_not_exists_create(self, audit_trial_expiration_date, get_audit_trial_ex
             expiration_date=timezone.make_aware(audit_trial_expiration_date)
         )
 
-        self.assertEqual(expected_return, get_or_create_audit_trial(self.user, 'verified'))
+        self.assertEqual(expected_return, get_or_create_audit_trial(self.user))
 
 
 @ddt.ddt
@@ -715,7 +707,7 @@ def test_audit_trial_expired(self, start_date):
         audit_trial_data = LearningAssistantAuditTrialData(
             user_id=self.user.id,
             start_date=start_date,
-            expiration_date=get_audit_trial_expiration_date_from_start_date(start_date, 1, 'verified'),
+            expiration_date=get_audit_trial_expiration_date_from_start_date(start_date),
         )
 
         self.assertEqual(audit_trial_is_expired(mock_enrollment, audit_trial_data), True)
@@ -729,7 +721,7 @@ def test_audit_trial_unexpired(self):
         audit_trial_data = LearningAssistantAuditTrialData(
             user_id=self.user.id,
             start_date=start_date,
-            expiration_date=get_audit_trial_expiration_date_from_start_date(start_date, 1, 'verified'),
+            expiration_date=get_audit_trial_expiration_date_from_start_date(start_date),
         )
 
         self.assertEqual(audit_trial_is_expired(mock_enrollment, audit_trial_data), False)

tests/test_utils.py

@@ -14,7 +14,6 @@
 from learning_assistant.constants import LMS_DATETIME_FORMAT
 from learning_assistant.utils import (
     extract_message_content,
-    get_audit_trial_length_days,
     get_chat_response,
     get_optimizely_variation,
     get_reduced_message_list,
@@ -221,44 +220,6 @@ def test_user_role_is_staff(self, role, expected_value):
         self.assertEqual(user_role_is_staff(role), expected_value)
 
 
-@ddt.ddt
-class GetAuditTrialLengthDaysTests(TestCase):
-    """
-    Tests for the get_audit_trial_length_days helper function.
-    """
-    @ddt.data(
-        (None, 14),
-        (0, 0),
-        (-7, 0),
-        (7, 7),
-        (14, 14),
-        (28, 28),
-    )
-    @ddt.unpack
-    def test_get_audit_trial_length_days_with_value(self, setting_value, expected_value):
-        with patch.object(settings, 'LEARNING_ASSISTANT_AUDIT_TRIAL_LENGTH_DAYS', setting_value):
-            self.assertEqual(get_audit_trial_length_days(1, 'verified'), expected_value)
-
-    @override_settings()
-    def test_get_audit_trial_length_days_no_setting(self):
-        del settings.LEARNING_ASSISTANT_AUDIT_TRIAL_LENGTH_DAYS
-        self.assertEqual(get_audit_trial_length_days(1, 'verified'), 14)
-
-    # mock optimizely function
-    @ddt.data(
-        ('variation', 28),
-        ('control', 14),
-    )
-    @ddt.unpack
-    @patch('learning_assistant.utils.get_optimizely_variation')
-    def test_get_audit_trial_length_days_experiment(
-        self, variation_key, expected_value, mock_get_optimizely_variation
-    ):
-        mock_get_optimizely_variation.return_value = {'enabled': True, 'variation_key': variation_key}
-        with patch.object(settings, 'OPTIMIZELY_LEARNING_ASSISTANT_TRIAL_VARIATION_KEY_28', 'variation'):
-            self.assertEqual(get_audit_trial_length_days(1, 'verified'), expected_value)
-
-
 class GetOptimizelyVariationTests(TestCase):
     """
     Tests for the get_optimizely_variation helper function.