18d5abb2f6
First PR to replace pytz with zoneinfo for UTC handling across codebase. This PR migrates all UTC timezone handling from pytz to Python’s standard library zoneinfo. The pytz library is now deprecated, and its documentation recommends using zoneinfo for all new code. This update modernizes our codebase, removes legacy pytz usage, and ensures compatibility with current best practices for timezone management in Python 3.9+. No functional changes to timezone logic - just a direct replacement for UTC handling. https://github.com/openedx/edx-platform/issues/33980
242 lines
8.3 KiB
Python
242 lines
8.3 KiB
Python
"""
|
|
Contains code related to computing discount percentage
|
|
and discount applicability.
|
|
|
|
WARNING:
|
|
Keep in mind that the code in this file only applies to discounts controlled in the lms like the first purchase offer,
|
|
not other discounts like coupons or enterprise/program offers configured in ecommerce.
|
|
|
|
"""
|
|
|
|
|
|
from datetime import datetime, timedelta
|
|
|
|
from zoneinfo import ZoneInfo
|
|
from crum import get_current_request, impersonate
|
|
from django.conf import settings
|
|
from django.utils import timezone
|
|
from django.utils.dateparse import parse_datetime
|
|
from edx_toggles.toggles import WaffleFlag
|
|
|
|
from common.djangoapps.course_modes.models import CourseMode
|
|
from common.djangoapps.entitlements.models import CourseEntitlement
|
|
from lms.djangoapps.courseware.utils import is_mode_upsellable
|
|
from lms.djangoapps.courseware.toggles import COURSEWARE_MFE_MILESTONES_STREAK_DISCOUNT
|
|
from lms.djangoapps.experiments.models import ExperimentData
|
|
from lms.djangoapps.experiments.stable_bucketing import stable_bucketing_hash_group
|
|
from openedx.features.discounts.models import DiscountPercentageConfig, DiscountRestrictionConfig
|
|
from common.djangoapps.student.models import CourseEnrollment
|
|
from common.djangoapps.track import segment
|
|
|
|
|
|
# .. toggle_name: discounts.enable_first_purchase_discount_override
|
|
# .. toggle_implementation: WaffleFlag
|
|
# .. toggle_default: False
|
|
# .. toggle_description: Waffle flag to enable the First Purchase Discount to be overridden from
|
|
# EDXWELCOME/BIENVENIDOAEDX 15% discount to a new code.
|
|
# .. toggle_use_cases: opt_in
|
|
# .. toggle_creation_date: 2024-07-18
|
|
# .. toggle_target_removal_date: None
|
|
# .. toggle_tickets: REV-4097
|
|
# .. toggle_warning: This feature toggle does not have a target removal date.
|
|
FIRST_PURCHASE_DISCOUNT_OVERRIDE_FLAG = WaffleFlag('discounts.enable_first_purchase_discount_override', __name__)
|
|
|
|
# .. toggle_name: discounts.enable_discounting
|
|
# .. toggle_implementation: WaffleFlag
|
|
# .. toggle_default: False
|
|
# .. toggle_description: Toggle discounts always being disabled
|
|
# .. toggle_use_cases: temporary
|
|
# .. toggle_creation_date: 2019-4-16
|
|
# .. toggle_target_removal_date: None
|
|
# .. toggle_tickets: REVEM-282
|
|
# .. toggle_warning: This temporary feature toggle does not have a target removal date.
|
|
DISCOUNT_APPLICABILITY_FLAG = WaffleFlag('discounts.enable_discounting', __name__)
|
|
|
|
DISCOUNT_APPLICABILITY_HOLDBACK = 'first_purchase_discount_holdback'
|
|
REV1008_EXPERIMENT_ID = 16
|
|
|
|
|
|
def get_discount_expiration_date(user, course):
|
|
"""
|
|
Returns the date when the discount expires for the user.
|
|
Returns none if the user is not enrolled.
|
|
"""
|
|
# anonymous users should never get the discount
|
|
if user.is_anonymous:
|
|
return None
|
|
|
|
course_enrollment = CourseEnrollment.objects.filter(
|
|
user=user,
|
|
course=course.id,
|
|
mode__in=CourseMode.UPSELL_TO_VERIFIED_MODES
|
|
)
|
|
if len(course_enrollment) != 1:
|
|
return None
|
|
|
|
time_limit_start = None
|
|
try:
|
|
saw_banner = ExperimentData.objects.get(user=user, experiment_id=REV1008_EXPERIMENT_ID, key=str(course.id))
|
|
time_limit_start = parse_datetime(saw_banner.value)
|
|
except ExperimentData.DoesNotExist:
|
|
return None
|
|
|
|
discount_expiration_date = time_limit_start + timedelta(weeks=1)
|
|
|
|
# If the course has an upgrade deadline and discount time limit would put the discount expiration date
|
|
# after the deadline, then change the expiration date to be the upgrade deadline
|
|
verified_mode = CourseMode.verified_mode_for_course(course=course, include_expired=True)
|
|
if not verified_mode:
|
|
return None
|
|
upgrade_deadline = verified_mode.expiration_datetime
|
|
if upgrade_deadline and discount_expiration_date > upgrade_deadline:
|
|
discount_expiration_date = upgrade_deadline
|
|
|
|
return discount_expiration_date
|
|
|
|
|
|
def can_show_streak_discount_coupon(user, course):
|
|
"""
|
|
Check whether this combination of user and course
|
|
can receive the streak discount.
|
|
"""
|
|
|
|
# Feature needs to be enabled
|
|
if not COURSEWARE_MFE_MILESTONES_STREAK_DISCOUNT.is_enabled(course.id):
|
|
return False
|
|
|
|
# Course end date needs to be in the future
|
|
if course.has_ended():
|
|
return False
|
|
|
|
# Course needs to have a non-expired verified mode
|
|
modes_dict = CourseMode.modes_for_course_dict(course=course, include_expired=False)
|
|
if 'verified' not in modes_dict:
|
|
return False
|
|
|
|
# Learner needs to be in an upgradeable mode
|
|
try:
|
|
enrollment = CourseEnrollment.objects.get(
|
|
user=user,
|
|
course=course.id,
|
|
)
|
|
except CourseEnrollment.DoesNotExist:
|
|
return False
|
|
|
|
if not is_mode_upsellable(user, enrollment):
|
|
return False
|
|
|
|
# We can't import this at Django load time within the openedx tests settings context
|
|
from openedx.features.enterprise_support.utils import is_enterprise_learner
|
|
# Don't give discount to enterprise users
|
|
if is_enterprise_learner(user):
|
|
return False
|
|
|
|
return True
|
|
|
|
|
|
def can_receive_discount(user, course, discount_expiration_date=None):
|
|
"""
|
|
Check all the business logic about whether this combination of user and course
|
|
can receive a discount.
|
|
"""
|
|
# Always disable discounts until we are ready to enable this feature
|
|
with impersonate(user):
|
|
if not DISCOUNT_APPLICABILITY_FLAG.is_enabled():
|
|
return False
|
|
|
|
# TODO: Add additional conditions to return False here
|
|
|
|
# Check if discount has expired
|
|
if not discount_expiration_date:
|
|
discount_expiration_date = get_discount_expiration_date(user, course)
|
|
|
|
if discount_expiration_date is None:
|
|
return False
|
|
|
|
if discount_expiration_date < timezone.now():
|
|
return False
|
|
|
|
# Course end date needs to be in the future
|
|
if course.has_ended():
|
|
return False
|
|
|
|
# Course needs to have a non-expired verified mode
|
|
modes_dict = CourseMode.modes_for_course_dict(course=course, include_expired=False)
|
|
verified_mode = modes_dict.get('verified', None)
|
|
if not verified_mode:
|
|
return False
|
|
|
|
# Site, Partner, Course or Course Run not excluded from lms-controlled discounts
|
|
if DiscountRestrictionConfig.disabled_for_course_stacked_config(course):
|
|
return False
|
|
|
|
# Don't allow users who have enrolled in any courses in non-upsellable
|
|
# modes
|
|
if CourseEnrollment.objects.filter(user=user).exclude(mode__in=CourseMode.UPSELL_TO_VERIFIED_MODES).exists():
|
|
return False
|
|
|
|
# Don't allow any users who have entitlements (past or present)
|
|
if CourseEntitlement.objects.filter(user=user).exists():
|
|
return False
|
|
|
|
# We can't import this at Django load time within the openedx tests settings context
|
|
from openedx.features.enterprise_support.utils import is_enterprise_learner
|
|
# Don't give discount to enterprise users
|
|
if is_enterprise_learner(user):
|
|
return False
|
|
|
|
# Turn holdback on
|
|
if _is_in_holdback_and_bucket(user):
|
|
return False
|
|
|
|
return True
|
|
|
|
|
|
def _is_in_holdback_and_bucket(user):
|
|
"""
|
|
Return whether the specified user is in the first-purchase-discount holdback group.
|
|
This will also stable bucket the user.
|
|
"""
|
|
if datetime(2020, 8, 1, tzinfo=ZoneInfo("UTC")) <= datetime.now(tz=ZoneInfo("UTC")):
|
|
return False
|
|
|
|
# Holdback is 10%
|
|
bucket = stable_bucketing_hash_group(DISCOUNT_APPLICABILITY_HOLDBACK, 10, user)
|
|
|
|
request = get_current_request()
|
|
if hasattr(request, 'session') and DISCOUNT_APPLICABILITY_HOLDBACK not in request.session:
|
|
properties = {
|
|
'site': request.site.domain,
|
|
'app_label': 'discounts',
|
|
'nonInteraction': 1,
|
|
'bucket': bucket,
|
|
'experiment': 'REVEM-363',
|
|
}
|
|
segment.track(
|
|
user_id=user.id,
|
|
event_name='edx.bi.experiment.user.bucketed',
|
|
properties=properties,
|
|
)
|
|
|
|
# Mark that we've recorded this bucketing, so that we don't do it again this session
|
|
request.session[DISCOUNT_APPLICABILITY_HOLDBACK] = True
|
|
|
|
return bucket == 0
|
|
|
|
|
|
def discount_percentage(course):
|
|
"""
|
|
Get the configured discount amount.
|
|
"""
|
|
if FIRST_PURCHASE_DISCOUNT_OVERRIDE_FLAG.is_enabled():
|
|
return getattr(
|
|
settings,
|
|
'FIRST_PURCHASE_DISCOUNT_OVERRIDE_PERCENTAGE',
|
|
15
|
|
)
|
|
|
|
configured_percentage = DiscountPercentageConfig.current(course_key=course.id).percentage
|
|
if configured_percentage:
|
|
return configured_percentage
|
|
return 15
|