chore: create a waffle switch and flag (#4671)

Author: skumargupta83

course_discovery/apps/api/v1/views/courses.py

@@ -34,8 +34,9 @@
     Collaborator, Course, CourseEditor, CourseEntitlement, CourseRun, CourseType, CourseUrlSlug, Organization, Program,
     Seat, Source, Video
 )
+from course_discovery.apps.course_metadata.toggles import IS_COURSE_RUN_FOR_DUMMY_SKU_GENERATION
 from course_discovery.apps.course_metadata.utils import (
-    create_missing_entitlement, ensure_draft_world, validate_course_number, validate_slug_format
+    create_missing_entitlement, ensure_draft_world, generate_sku, validate_course_number, validate_slug_format
 )
 from course_discovery.apps.publisher.utils import is_publisher_user
 
@@ -213,7 +214,6 @@ def create(self, request, *args, **kwargs):
 
         if error_message:
             return Response((_('Incorrect data sent. ') + error_message).strip(), status=status.HTTP_400_BAD_REQUEST)
-
         partner = request.site.partner
         course_creation_fields['partner'] = partner.id
         course_creation_fields['key'] = self.get_course_key(course_creation_fields)
@@ -240,7 +240,6 @@ def create(self, request, *args, **kwargs):
 
         course = serializer.save(draft=True)
         course.set_active_url_slug(url_slug)
-
         organization = Organization.objects.get(key=course_creation_fields['org'])
         course.authoring_organizations.add(organization)
 
@@ -250,6 +249,9 @@ def create(self, request, *args, **kwargs):
             course.collaborators.add(*collaborators)
 
         entitlement_types = course.type.entitlement_types.all()
+        # Waffle switch to control dummy SKU generation logic for 2U purpose.
+        if IS_COURSE_RUN_FOR_DUMMY_SKU_GENERATION.is_enabled():
+            generate_sku(partner, course)  # Generates a SKU for the provide by entitlements
         prices = request.data.get('prices', {})
         for entitlement_type in entitlement_types:
             CourseEntitlement.objects.create(

course_discovery/apps/course_metadata/models.py

@@ -57,12 +57,12 @@
 )
 from course_discovery.apps.course_metadata.query import CourseQuerySet, CourseRunQuerySet, ProgramQuerySet
 from course_discovery.apps.course_metadata.toggles import (
-    IS_SUBDIRECTORY_SLUG_FORMAT_ENABLED, IS_SUBDIRECTORY_SLUG_FORMAT_FOR_BOOTCAMP_ENABLED,
-    IS_SUBDIRECTORY_SLUG_FORMAT_FOR_EXEC_ED_ENABLED
+    IS_COURSE_RUN_FOR_DUMMY_SKU_GENERATION, IS_SUBDIRECTORY_SLUG_FORMAT_ENABLED,
+    IS_SUBDIRECTORY_SLUG_FORMAT_FOR_BOOTCAMP_ENABLED, IS_SUBDIRECTORY_SLUG_FORMAT_FOR_EXEC_ED_ENABLED
 )
 from course_discovery.apps.course_metadata.utils import (
     UploadToFieldNamePath, bulk_operation_upload_to_path, clean_query, clear_slug_request_cache_for_course,
-    custom_render_variations, get_course_run_statuses, get_slug_for_course, is_ocm_course,
+    custom_render_variations, generate_sku, get_course_run_statuses, get_slug_for_course, is_ocm_course,
     push_to_ecommerce_for_course_run, push_tracks_to_lms_for_course_run, set_official_state, subtract_deadline_delta,
     validate_ai_languages
 )
@@ -2813,12 +2813,13 @@ def get_seat_default_upgrade_deadline(self, seat_type):
     def update_or_create_seat_helper(self, seat_type, prices, upgrade_deadline_override):
         default_deadline = self.get_seat_default_upgrade_deadline(seat_type)
         defaults = {'upgrade_deadline': default_deadline}
-
         if seat_type.slug in prices:
             defaults['price'] = prices[seat_type.slug]
         if seat_type.slug == Seat.VERIFIED:
             defaults['upgrade_deadline_override'] = upgrade_deadline_override
-
+        # Waffle switch to control dummy SKU generation logic for 2U purpose.
+        if IS_COURSE_RUN_FOR_DUMMY_SKU_GENERATION.is_enabled():
+            generate_sku(None, self)  # Generates a SKU for the provide by Seat
         seat, __ = Seat.everything.update_or_create(
             course_run=self,
             type=seat_type,

course_discovery/apps/course_metadata/tests/test_models.py

@@ -1743,6 +1743,28 @@ def test_verified_upgrade_deadline_reset_on_upgrade_deadline_override_change(sel
         assert verified_seat.upgrade_deadline_override is not None
         assert verified_seat.upgrade_deadline == new_deadline_override
 
+    @patch('course_discovery.apps.course_metadata.models.IS_COURSE_RUN_FOR_DUMMY_SKU_GENERATION')
+    @patch('course_discovery.apps.course_metadata.models.generate_sku')
+    def test_generate_sku_called_when_waffle_enabled(self, mock_generate_sku, mock_switch):
+        mock_switch.is_enabled.return_value = True  # Force switch to be active
+        course_run = factories.CourseRunFactory.create(key='course-v1:org1+12+2T2025b')
+        factories.SeatFactory.create(course_run=course_run)
+        seat_type = SeatType.objects.create(slug='verified')
+        prices = {'verified': 500}
+        course_run.update_or_create_seat_helper(seat_type, prices, upgrade_deadline_override=None)
+        mock_generate_sku.assert_called_once_with(None, course_run)
+
+    @patch('course_discovery.apps.course_metadata.models.IS_COURSE_RUN_FOR_DUMMY_SKU_GENERATION')
+    @patch('course_discovery.apps.course_metadata.models.generate_sku')
+    def test_generate_sku_called_when_waffle_disable(self, mock_generate_sku, mock_switch):
+        mock_switch.is_enabled.return_value = False  # Force switch to be active
+        course_run = factories.CourseRunFactory.create(key='course-v1:org1+12+2T2025b')
+        factories.SeatFactory.create(course_run=course_run)
+        seat_type = SeatType.objects.create(slug='verified')
+        prices = {'verified': 500}
+        course_run.update_or_create_seat_helper(seat_type, prices, upgrade_deadline_override=None)
+        mock_generate_sku.assert_not_called()
+
 
 class CourseRunTestsThatNeedSetUp(OAuth2Mixin, TestCase):
     """

course_discovery/apps/course_metadata/tests/test_utils.py

@@ -43,7 +43,7 @@
 from course_discovery.apps.course_metadata.utils import (
     calculated_seat_upgrade_deadline, clean_html, convert_svg_to_png_from_url, create_missing_entitlement,
     download_and_save_course_image, download_and_save_program_image, ensure_draft_world, fetch_getsmarter_products,
-    is_google_drive_url, serialize_entitlement_for_ecommerce_api, serialize_seat_for_ecommerce_api,
+    generate_sku, is_google_drive_url, serialize_entitlement_for_ecommerce_api, serialize_seat_for_ecommerce_api,
     transform_skills_data, validate_slug_format
 )
 
@@ -1676,3 +1676,34 @@ def test_validate_slug_format__raise_exception_for_bootcamp_course(self, slug, i
             expected_error_message = expected_error_message.format(url_slug=slug)
             actual_error_message = str(context.exception)
             self.assertIn(expected_error_message, actual_error_message)
+
+
+@ddt.ddt
+class ValidateDummySKU(TestCase):
+    """
+    Test suite for validate generated Dummy SKU by generate_sku method
+    """
+    def test_generate_sku_with_partner(self):
+        partner = mock.Mock(id=101)
+        course = mock.Mock(uuid='abc-uuid')
+        sku = generate_sku(partner=partner, course=course)
+        self.assertIsInstance(sku, str)
+        self.assertEqual(len(sku), 7)
+
+    def test_generate_sku_without_partner(self):
+        course = mock.Mock(uuid='abc-uuid', key='course-key')
+        sku = generate_sku(partner=None, course=course)
+        self.assertIsInstance(sku, str)
+        self.assertEqual(len(sku), 7)
+
+    def test_generate_sku_invalid_combination(self):
+        partner = mock.Mock(id=None)
+        course = mock.Mock(uuid='abc-uuid')
+        with self.assertRaises(ValidationError) as context:
+            generate_sku(partner=partner, course=course)
+        self.assertIn("Unexpected combition SKU", str(context.exception))
+
+    def test_generate_sku_missing_course(self):
+        partner = mock.Mock(id=101)
+        with self.assertRaises(ValidationError):
+            generate_sku(partner=partner, course=None)

course_discovery/apps/course_metadata/toggles.py

@@ -78,3 +78,14 @@
 IS_COURSE_RUN_VARIANT_ID_ECOMMERCE_CONSUMABLE = WaffleSwitch(
     'course_metadata.is_course_run_variant_id_ecommerce_consumable', __name__
 )
+# .. toggle_name: course_metadata.is_dummy_sku_generation
+# .. toggle_implementation: WaffleSwitch
+# .. toggle_default: False
+# .. toggle_description: Enable dummy SKU generation for 2U purposes,
+# .. toggle_use_cases: open_edx
+# .. toggle_creation_date: 2025-09-16
+# .. toggle_target_removal_date: None
+# .. toggle_tickets: PROD-4430
+IS_COURSE_RUN_FOR_DUMMY_SKU_GENERATION = WaffleSwitch(
+    'course_metadata.is_dummy_sku_generation', __name__
+)

course_discovery/apps/course_metadata/utils.py

@@ -4,6 +4,7 @@
 import re
 import string
 import uuid
+from hashlib import md5
 from tempfile import NamedTemporaryFile
 from urllib.parse import urljoin, urlparse
 
@@ -1291,3 +1292,24 @@ def bulk_operation_upload_to_path(instance, filename):  # pylint: disable=unused
     Utility method used on BulkOperationTask csv_file field to generate unique file names.
     """
     return f"bulk_operations/uploads/{str(uuid.uuid4())}/{filename}"
+
+
+def generate_sku(partner=None, course=None):
+    """
+    Generates a SKU for the provide by entitlements and seats combination.
+    Example: 76E4E71
+    """
+    try:
+        if partner and getattr(partner, 'id', None) and course is not None:
+            _hash = ' '.join((str(course.uuid), str(partner.id))).encode('utf-8')
+            logger.info('Initiating SKU generation for the course entitlements.')
+        elif partner is None:
+            _hash = ' '.join((str(course.uuid), str(course.key))).encode('utf-8')
+            logger.info('Initiating SKU generation for the seats.')
+        else:
+            raise Exception('Unexpected entitlements and seats')
+        md5_hash = md5(_hash.lower())
+        digest = md5_hash.hexdigest()[-7:]
+        return digest.upper()
+    except Exception as exc:
+        raise ValidationError("Unexpected combition SKU") from exc