Merge pull request #934 from openedx/pwnage101/temp-backwards-compatible-1-plan-provisioning

fix: temporarily allow 1-plan provisioning.

Author: pwnage101

enterprise_access/apps/api/v1/tests/test_provisioning_views.py

@@ -7,6 +7,7 @@
 from unittest import mock
 
 import ddt
+from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.utils import timezone
 from edx_rbac.constants import ALL_ACCESS_CONTEXT
@@ -820,6 +821,80 @@ def test_new_subscription_plan_created(
         )
         assert mock_license_client.create_subscription_plan.call_count == 2
 
+    @mock.patch('enterprise_access.apps.provisioning.api.LicenseManagerApiClient')
+    @mock.patch('enterprise_access.apps.provisioning.api.LmsApiClient')
+    @mock.patch('enterprise_access.apps.api.v1.views.provisioning.logger')
+    def test_legacy_single_plan_request_transformation(
+        self, mock_logger, mock_lms_api_client, mock_license_manager_client
+    ):
+        """
+        Test that legacy requests with single 'subscription_plan' key are transformed
+        to the new two-plan format and successfully provision resources.
+        """
+        # Setup mocks for successful provisioning.
+        mock_lms_client = mock_lms_api_client.return_value
+        mock_lms_client.get_enterprise_customer_data.return_value = None
+        mock_lms_client.create_enterprise_customer.return_value = DEFAULT_CUSTOMER_RECORD
+        mock_lms_client.get_enterprise_admin_users.return_value = []
+        mock_lms_client.get_enterprise_pending_admin_users.return_value = []
+        mock_lms_client.get_enterprise_catalogs.return_value = [DEFAULT_CATALOG_RECORD]
+
+        mock_license_client = mock_license_manager_client.return_value
+        mock_license_client.get_customer_agreement.return_value = None
+        mock_license_client.create_customer_agreement.return_value = {
+            **DEFAULT_AGREEMENT_RECORD, "subscriptions": []
+        }
+        mock_license_client.create_subscription_plan.side_effect = [
+            DEFAULT_TRIAL_SUBSCRIPTION_PLAN_RECORD,
+            DEFAULT_FIRST_PAID_SUBSCRIPTION_PLAN_RECORD,
+        ]
+        mock_license_client.create_subscription_plan_renewal.return_value = (
+            EXPECTED_SUBSCRIPTION_PLAN_RENEWAL_RESPONSE
+        )
+
+        # Create a legacy request payload with 'subscription_plan' instead of the new format.
+        legacy_request_payload = {**DEFAULT_REQUEST_PAYLOAD}
+        legacy_request_payload.pop('first_paid_subscription_plan')
+        legacy_request_payload['subscription_plan'] = legacy_request_payload.pop('trial_subscription_plan')
+
+        # Make the provisioning request.
+        response = self.client.post(PROVISIONING_CREATE_ENDPOINT, data=legacy_request_payload)
+
+        # Should succeed despite using legacy format.
+        self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+
+        # Verify warning was logged about deprecated format.
+        mock_logger.warning.assert_called_once()
+        warning_message = mock_logger.warning.call_args[0][0]
+        self.assertIn('Deprecated request format detected', warning_message)
+        self.assertIn('subscription_plan', warning_message)
+
+        # Verify info log about transformation.
+        mock_logger.info.assert_called()
+        info_calls = [call[0][0] for call in mock_logger.info.call_args_list]
+        self.assertTrue(
+            any('Transformed legacy subscription_plan' in msg for msg in info_calls),
+            "Expected transformation log message not found"
+        )
+
+        # Verify response has both trial and paid subscription plans.
+        response_data = response.json()
+        self.assertIn('trial_subscription_plan', response_data)
+        self.assertIn('first_paid_subscription_plan', response_data)
+
+        # Verify the workflow input_data contains correct trial and paid plan data
+        workflow = ProvisionNewCustomerWorkflow.objects.first()
+        trial_plan_input = workflow.input_data.get('create_trial_subscription_plan_input')
+        first_paid_plan_input = workflow.input_data.get('create_first_paid_subscription_plan_input')
+        assert trial_plan_input['title'] == legacy_request_payload['subscription_plan']['title']
+        assert trial_plan_input['salesforce_opportunity_line_item'] == (
+            legacy_request_payload['subscription_plan']['salesforce_opportunity_line_item']
+        )
+        assert trial_plan_input['product_id'] == legacy_request_payload['subscription_plan']['product_id']
+        assert 'First Paid Plan' in first_paid_plan_input['title']
+        assert first_paid_plan_input['product_id'] == settings.PROVISIONING_PAID_SUBSCRIPTION_PRODUCT_ID
+        assert first_paid_plan_input['salesforce_opportunity_line_item'] is None
+
 
 @ddt.ddt
 class TestCheckoutIntentSynchronization(APITest):

enterprise_access/apps/api/v1/views/provisioning.py

@@ -1,6 +1,7 @@
 """
 Rest API views for the browse and request app.
 """
+import copy
 import logging
 
 from django.conf import settings
@@ -52,8 +53,60 @@ class ProvisioningCreateView(PermissionRequiredMixin, generics.CreateAPIView):
     permission_classes = (permissions.IsAuthenticated,)
     permission_required = constants.PROVISIONING_CREATE_PERMISSION
 
+    def _transform_legacy_request_data(self, request_data: dict) -> dict:
+        """
+        Transform legacy request format to support backward compatibility.
+
+        Converts old `subscription_plan` key to new `trial_subscription_plan` and
+        `first_paid_subscription_plan` keys if the old format is detected.
+
+        Args:
+            request_data (dict): The incoming request data
+
+        Returns:
+            dict: Transformed request data with new keys
+        """
+        # If new format is already present, return as-is.
+        if 'trial_subscription_plan' in request_data and 'first_paid_subscription_plan' in request_data:
+            return request_data
+
+        # If old format is present, transform it.
+        if 'subscription_plan' in request_data:
+            logger.warning(
+                'Deprecated request format detected: `subscription_plan` key should be replaced with '
+                '`trial_subscription_plan` and `first_paid_subscription_plan`'
+            )
+
+            subscription_plan = request_data.pop('subscription_plan')
+
+            # Use the subscription_plan data as trial_subscription_plan
+            request_data['trial_subscription_plan'] = subscription_plan
+
+            # Synthesize first_paid_subscription_plan with required fields only
+            request_data['first_paid_subscription_plan'] = {
+                'title': f"{subscription_plan.get('title', 'Subscription')} - First Paid Plan",
+                'product_id': settings.PROVISIONING_PAID_SUBSCRIPTION_PRODUCT_ID,
+                'salesforce_opportunity_line_item': None,
+            }
+
+            logger.info(
+                'Transformed legacy subscription_plan to trial_subscription_plan and '
+                'synthesized first_paid_subscription_plan'
+            )
+            logger.info(
+                'Transformed request payload: %s',
+                str(request_data),
+            )
+            return request_data
+
+        # If neither format detected, passthrough to serializer to inevitably fail validation and return HTTP 400.
+        return request_data
+
     def create(self, request, *args, **kwargs):
-        request_serializer = serializers.ProvisioningRequestSerializer(data=request.data)
+        # TEMP: Transform legacy request data before serialization. See docstring.
+        transformed_data = self._transform_legacy_request_data(copy.deepcopy(dict(request.data)))
+
+        request_serializer = serializers.ProvisioningRequestSerializer(data=transformed_data)
         request_serializer.is_valid(raise_exception=True)
 
         customer_request_data = request_serializer.validated_data['enterprise_customer']

enterprise_access/apps/provisioning/models.py

@@ -557,8 +557,8 @@ class GetCreateFirstPaidSubscriptionPlanStepInput(BaseInputOutput):
 
     title: str = field(validator=is_str)
     product_id: int = field(validator=is_int)
-    start_date: Optional[datetime] = field(validator=validators.optional(is_datetime))
-    expiration_date: Optional[datetime] = field(validator=is_datetime)
+    start_date: Optional[datetime] = field(default=None, validator=validators.optional(is_datetime))
+    expiration_date: Optional[datetime] = field(default=None, validator=validators.optional(is_datetime))
     salesforce_opportunity_line_item: Optional[str] = field(default=None, validator=validators.optional(is_str))
     enterprise_catalog_uuid: Optional[UUID] = field(default=None, validator=validators.optional(is_uuid))