From bbafc5ef420820eb0dd301938091b014135bdb9f Mon Sep 17 00:00:00 2001
From: Arunmozhi <tecoholic@users.noreply.github.com>
Date: Mon, 10 Jul 2023 19:00:03 +0530
Subject: [PATCH] feat: add a flag to hide course prices in enrollment page
 when zero

This commit adds "hide_course_price_when_zero" attribute to the EnterpriseCustomer
model which can be enabled to hide the course price information from showing up
in the enrollment landing page, when the final price of the course is Zero.

* fix: bump pip-tools version to 6.6.2 to get rid of CI error

Internal-ref: https://tasks.opencraft.com/browse/BB-7541
---
 CHANGELOG.rst                                 |  5 ++++
 enterprise/__init__.py                        |  2 +-
 enterprise/admin/forms.py                     |  1 +
 .../migrations/0155_auto_20230706_0810.py     | 23 +++++++++++++++
 enterprise/models.py                          |  5 ++++
 .../enterprise_course_enrollment_page.html    | 24 ++++++++--------
 .../enterprise/templatetags/course_modal.html |  2 +-
 enterprise/utils.py                           | 24 ++++++++++++++++
 enterprise/views.py                           |  4 +++
 requirements/dev.txt                          |  2 +-
 tests/test_enterprise/test_utils.py           | 28 +++++++++++++++++++
 tests/test_utilities.py                       |  1 +
 12 files changed, 107 insertions(+), 14 deletions(-)
 create mode 100644 enterprise/migrations/0155_auto_20230706_0810.py

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index d354de2c2c..4b4b347a3e 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -17,7 +17,12 @@ Unreleased
 ----------
 * nothing
 
+[3.42.9]
+--------
+feat: add a flag to hide course prices in enrollment page when zero
+
 [3.42.8]
+--------
 feat: add additional fields to EnterpriseCourseEnrollmentViewSet
 
 [3.42.7]
diff --git a/enterprise/__init__.py b/enterprise/__init__.py
index 2478874dae..dfbb99e9e0 100644
--- a/enterprise/__init__.py
+++ b/enterprise/__init__.py
@@ -2,6 +2,6 @@
 Your project description goes here.
 """
 
-__version__ = "3.42.8"
+__version__ = "3.42.9"
 
 default_app_config = "enterprise.apps.EnterpriseConfig"
diff --git a/enterprise/admin/forms.py b/enterprise/admin/forms.py
index 8d6c9234af..e69225c068 100644
--- a/enterprise/admin/forms.py
+++ b/enterprise/admin/forms.py
@@ -398,6 +398,7 @@ class Meta:
             "enable_audit_data_reporting",
             "replace_sensitive_sso_username",
             "hide_course_original_price",
+            "hide_course_price_when_zero",
             "enable_portal_code_management_screen",
             "enable_portal_subscription_management_screen",
             "enable_learner_portal",
diff --git a/enterprise/migrations/0155_auto_20230706_0810.py b/enterprise/migrations/0155_auto_20230706_0810.py
new file mode 100644
index 0000000000..afae75b55d
--- /dev/null
+++ b/enterprise/migrations/0155_auto_20230706_0810.py
@@ -0,0 +1,23 @@
+# Generated by Django 3.2.15 on 2023-07-06 08:10
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('enterprise', '0154_alter_systemwideenterpriseuserroleassignment_unique_together'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='enterprisecustomer',
+            name='hide_course_price_when_zero',
+            field=models.BooleanField(default=False, help_text='Specify whether course cost should be hidden in the landing page when the final price is zero.'),
+        ),
+        migrations.AddField(
+            model_name='historicalenterprisecustomer',
+            name='hide_course_price_when_zero',
+            field=models.BooleanField(default=False, help_text='Specify whether course cost should be hidden in the landing page when the final price is zero.'),
+        ),
+    ]
diff --git a/enterprise/models.py b/enterprise/models.py
index 7cdb362fd3..d2bfac1187 100644
--- a/enterprise/models.py
+++ b/enterprise/models.py
@@ -386,6 +386,11 @@ class Meta:
         help_text=_("The email address where learner's reply to enterprise emails will be delivered.")
     )
 
+    hide_course_price_when_zero = models.BooleanField(
+        default=False,
+        help_text=_("Specify whether course cost should be hidden in the landing page when the final price is zero.")
+    )
+
     @property
     def enterprise_customer_identity_provider(self):
         """
diff --git a/enterprise/templates/enterprise/enterprise_course_enrollment_page.html b/enterprise/templates/enterprise/enterprise_course_enrollment_page.html
index 1d4a777bdf..efb644a519 100644
--- a/enterprise/templates/enterprise/enterprise_course_enrollment_page.html
+++ b/enterprise/templates/enterprise/enterprise_course_enrollment_page.html
@@ -77,19 +77,21 @@ <h2>{{ confirmation_text }}</h2>
 
                 <label for="radio{{ forloop.counter0 }}">
                   <strong class="title">{{ course_mode.title }}</strong>
-                  <span class="price">
-                    {{ price_text }}:
-                    {% if course_mode.final_price and course_mode.original_price != course_mode.final_price %}
-                      {% if hide_course_original_price %}
-                        {{ course_mode.final_price }}
+                  {% if not course_mode.hide_price %}
+                    <span class="price">
+                      {{ price_text }}:
+                      {% if course_mode.final_price and course_mode.original_price != course_mode.final_price %}
+                        {% if hide_course_original_price %}
+                          {{ course_mode.final_price }}
+                        {% else %}
+                          <strike>{{ course_mode.original_price }}</strike> {{ course_mode.final_price }}
+                          <div>{{discount_text|safe }}</div>
+                        {% endif %}
                       {% else %}
-                        <strike>{{ course_mode.original_price }}</strike> {{ course_mode.final_price }}
-                        <div>{{discount_text|safe }}</div>
+                        {{ course_mode.original_price }}
                       {% endif %}
-                    {% else %}
-                      {{ course_mode.original_price }}
-                    {% endif %}
-                  </span>
+                    </span>
+                  {% endif %}
                   <span class="description">{{ course_mode.description }}</span>
                 </label>
               </div>
diff --git a/enterprise/templates/enterprise/templatetags/course_modal.html b/enterprise/templates/enterprise/templatetags/course_modal.html
index 41e6f694e0..bc7965b9f3 100644
--- a/enterprise/templates/enterprise/templatetags/course_modal.html
+++ b/enterprise/templates/enterprise/templatetags/course_modal.html
@@ -25,7 +25,7 @@ <h1 id="modal-header-text-{{ index }}" class="modal-header-text">{{ course_title
           <ul class="details-list">
             {% if premium_modes|length > 0 %}
               {% with course_mode=premium_modes.0 %}
-                {% if course_mode.original_price %}
+                {% if course_mode.original_price and not course_mode.hide_price %}
                   <li>
                     <div class="detail-container">
                       <div class="detail-title-container">
diff --git a/enterprise/utils.py b/enterprise/utils.py
index e48127d50f..2e2fef6396 100644
--- a/enterprise/utils.py
+++ b/enterprise/utils.py
@@ -2302,3 +2302,27 @@ def parse_lms_api_datetime(datetime_string, datetime_format=LMS_API_DATETIME_FOR
 def localized_utcnow():
     """Helper function to return localized utcnow()."""
     return pytz.UTC.localize(datetime.datetime.utcnow())  # pylint: disable=no-value-for-parameter
+
+
+def hide_price_when_zero(enterprise_customer, course_modes):
+    """
+    Adds a "hide_price" flag to the course modes if price is zero and "Hide course price when zero" flag is set.
+
+    Arguments:
+        enterprise_customer: The EnterpriseCustomer that the enrollemnt is being done.
+        course_modes: iterable with dictionaries containing a required 'final_price' key
+    """
+    if not enterprise_customer.hide_course_price_when_zero:
+        return course_modes
+
+    for mode in course_modes:
+        mode['hide_price'] = False
+        try:
+            numbers = re.findall(r'\d+', mode['final_price'])
+            mode['hide_price'] = int(''.join(numbers)) == 0
+        except ValueError:
+            LOGGER.warning(
+                'hide_price_when_zero: Could not convert price of course mode "%s" to int.',
+                mode['title']
+            )
+    return course_modes
diff --git a/enterprise/views.py b/enterprise/views.py
index f21bd581c3..adb079aca6 100644
--- a/enterprise/views.py
+++ b/enterprise/views.py
@@ -75,6 +75,7 @@
     get_enterprise_customer_user,
     get_platform_logo_url,
     get_program_type_description,
+    hide_price_when_zero,
     is_course_run_enrollable,
     localized_utcnow,
     track_enrollment,
@@ -1522,6 +1523,9 @@ def get_enterprise_course_enrollment_page(
             # Filter audit course modes.
             course_modes = filter_audit_course_modes(enterprise_customer, course_modes)
 
+            # Set a flag to hide the $0 when the customer doesn't want it to be shown
+            course_modes = hide_price_when_zero(enterprise_customer, course_modes)
+
             # Allows automatic assignment to a cohort upon enrollment.
             cohort = request.GET.get('cohort')
             # Add a message to the message display queue if the learner
diff --git a/requirements/dev.txt b/requirements/dev.txt
index 53ee4c0538..6dc56c542b 100644
--- a/requirements/dev.txt
+++ b/requirements/dev.txt
@@ -415,7 +415,7 @@ pillow==9.0.1
     #   -r requirements/doc.txt
     #   -r requirements/test-master.txt
     #   -r requirements/test.txt
-pip-tools==6.5.1
+pip-tools==6.6.2
     # via -r requirements/dev.in
 pkginfo==1.8.2
     # via twine
diff --git a/tests/test_enterprise/test_utils.py b/tests/test_enterprise/test_utils.py
index 884627e886..9c7cc6fda4 100644
--- a/tests/test_enterprise/test_utils.py
+++ b/tests/test_enterprise/test_utils.py
@@ -16,6 +16,7 @@
     enroll_licensed_users_in_courses,
     get_idiff_list,
     get_platform_logo_url,
+    hide_price_when_zero,
     is_pending_user,
     parse_lms_api_datetime,
     serialize_notification_content,
@@ -334,3 +335,30 @@ def expected_email_item(user, activation_links):
 
         expected_email_items = [expected_email_item(user, activation_links) for user in users]
         assert email_items == expected_email_items
+
+    @ddt.data(True, False)
+    def test_hide_course_price_when_zero(self, hide_price):
+        customer = factories.EnterpriseCustomerFactory()
+        zero_modes = [
+            {"final_price": "$0"},
+            {"final_price": "$0.000"},
+            {"final_price": "Rs. 0.00"},
+            {"final_price": "0.00 EURO"},
+        ]
+        non_zero_modes = [
+            {"final_price": "$100"},
+            {"final_price": "$73.50"},
+            {"final_price": "Rs.8000.00"},
+            {"final_price": "4000 Euros"},
+        ]
+        customer.hide_course_price_when_zero = hide_price
+
+        processed_zero_modes = hide_price_when_zero(customer, zero_modes)
+        processed_non_zero_modes = hide_price_when_zero(customer, non_zero_modes)
+
+        if hide_price:
+            self.assertTrue(all(mode["hide_price"] for mode in processed_zero_modes))
+            self.assertFalse(all(mode["hide_price"] for mode in processed_non_zero_modes))
+        else:
+            self.assertEqual(zero_modes, processed_zero_modes)
+            self.assertEqual(non_zero_modes, processed_non_zero_modes)
diff --git a/tests/test_utilities.py b/tests/test_utilities.py
index b8580c1c73..cfa1f71bd2 100644
--- a/tests/test_utilities.py
+++ b/tests/test_utilities.py
@@ -146,6 +146,7 @@ def setUp(self):
                 "system_wide_role_assignments",
                 "reply_to",
                 "hide_labor_market_data",
+                "hide_course_price_when_zero",
             ]
         ),
         (