feat: write SelfServiceSubscriptionRenewal during provisioning

ENT-11011

Author: iloveagent57

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

@@ -22,7 +22,8 @@
 )
 from enterprise_access.apps.core.tests.factories import UserFactory
 from enterprise_access.apps.customer_billing.constants import CheckoutIntentState
-from enterprise_access.apps.customer_billing.models import CheckoutIntent
+from enterprise_access.apps.customer_billing.models import CheckoutIntent, SelfServiceSubscriptionRenewal
+from enterprise_access.apps.customer_billing.tests.factories import StripeEventSummaryFactory
 from enterprise_access.apps.provisioning.models import (
     GetCreateCustomerStep,
     GetCreateEnterpriseAdminUsersStep,
@@ -159,7 +160,7 @@ class TestProvisioningAuth(APITest):
     """
     def setUp(self):
         super().setUp()
-        self._create_checkout_intent()
+        self.checkout_intent = self._create_checkout_intent()
 
     def tearDown(self):
         super().tearDown()
@@ -252,6 +253,8 @@ def test_provisioning_create_allowed_for_provisioning_admins(
         mock_create_agreement.return_value = DEFAULT_AGREEMENT_RECORD
         mock_create_renewal.return_value = EXPECTED_SUBSCRIPTION_PLAN_RENEWAL_RESPONSE
 
+        StripeEventSummaryFactory.create(checkout_intent=self.checkout_intent)
+
         request_payload = {**DEFAULT_REQUEST_PAYLOAD}
         request_payload['pending_admins'] = [
             {
@@ -287,7 +290,7 @@ def setUp(self):
                 'context': ALL_ACCESS_CONTEXT,
             },
         ])
-        self._create_checkout_intent()
+        self.checkout_intent = self._create_checkout_intent()
 
     def _create_checkout_intent(self):
         """Helper to create a checkout intent for testing."""
@@ -349,6 +352,7 @@ def test_get_or_create_customer_and_admins_created(
         mock_client.get_enterprise_catalogs.return_value = [DEFAULT_CATALOG_RECORD]
         mock_create_agreement.return_value = DEFAULT_AGREEMENT_RECORD
         mock_create_renewal.return_value = EXPECTED_SUBSCRIPTION_PLAN_RENEWAL_RESPONSE
+        StripeEventSummaryFactory.create(checkout_intent=self.checkout_intent)
 
         request_payload = {**DEFAULT_REQUEST_PAYLOAD}
         request_payload['pending_admins'] = [
@@ -412,6 +416,16 @@ def test_get_or_create_customer_and_admins_created(
             [{'user_email': '[email protected]'}, {'user_email': '[email protected]'}],
         )
 
+        # Verify that a SelfServiceSubscriptionRenewal record was created during provisioning
+        renewal_records = SelfServiceSubscriptionRenewal.objects.filter(
+            checkout_intent=self.checkout_intent
+        )
+        self.assertEqual(renewal_records.count(), 1)
+        renewal_record = renewal_records.first()
+        expected_renewal_id = EXPECTED_SUBSCRIPTION_PLAN_RENEWAL_RESPONSE["id"]
+        self.assertEqual(renewal_record.subscription_plan_renewal_id, expected_renewal_id)
+        self.assertIsNone(renewal_record.processed_at)
+
     @ddt.data(
         # No admin users exist, two admins created.
         {
@@ -469,6 +483,7 @@ def test_customer_fetched_admins_fetched_or_created(
         mock_license_client = mock_license_manager_client.return_value
         mock_license_client.get_customer_agreement.return_value = DEFAULT_AGREEMENT_RECORD
         mock_license_client.create_subscription_plan_renewal.return_value = EXPECTED_SUBSCRIPTION_PLAN_RENEWAL_RESPONSE
+        StripeEventSummaryFactory.create(checkout_intent=self.checkout_intent)
 
         request_payload = {**DEFAULT_REQUEST_PAYLOAD}
         request_payload['pending_admins'] = [
@@ -567,6 +582,8 @@ def test_catalog_fetched_or_created(
         mock_create_agreement.return_value = DEFAULT_AGREEMENT_RECORD
         mock_create_renewal.return_value = EXPECTED_SUBSCRIPTION_PLAN_RENEWAL_RESPONSE
 
+        StripeEventSummaryFactory.create(checkout_intent=self.checkout_intent)
+
         request_payload = {**DEFAULT_REQUEST_PAYLOAD}
         response = self.client.post(PROVISIONING_CREATE_ENDPOINT, data=request_payload)
 
@@ -623,6 +640,8 @@ def test_catalog_created_with_generated_title_and_inferred_query_id(
         mock_create_agreement.return_value = DEFAULT_AGREEMENT_RECORD
         mock_create_renewal.return_value = EXPECTED_SUBSCRIPTION_PLAN_RENEWAL_RESPONSE
 
+        StripeEventSummaryFactory.create(checkout_intent=self.checkout_intent)
+
         # Create request payload WITHOUT enterprise_catalog section
         request_payload = {**DEFAULT_REQUEST_PAYLOAD}
         request_payload.pop('enterprise_catalog')
@@ -690,6 +709,8 @@ def test_customer_agreement_fetched_or_created(
 
         mock_license_client.create_subscription_plan_renewal.return_value = EXPECTED_SUBSCRIPTION_PLAN_RENEWAL_RESPONSE
 
+        StripeEventSummaryFactory.create(checkout_intent=self.checkout_intent)
+
         request_payload = {**DEFAULT_REQUEST_PAYLOAD}
         if test_data['created_agreement']:
             request_payload['customer_agreement'] = {
@@ -748,6 +769,8 @@ def test_new_subscription_plan_created(
         mock_license_client.create_subscription_plan.side_effect = [trial_plan_record, first_paid_plan_record]
         mock_license_client.create_subscription_plan_renewal.return_value = EXPECTED_SUBSCRIPTION_PLAN_RENEWAL_RESPONSE
 
+        StripeEventSummaryFactory.create(checkout_intent=self.checkout_intent)
+
         # Make the provisioning request
         response = self.client.post(PROVISIONING_CREATE_ENDPOINT, data=DEFAULT_REQUEST_PAYLOAD)
         self.assertEqual(response.status_code, status.HTTP_201_CREATED)
@@ -855,6 +878,8 @@ def test_legacy_single_plan_request_transformation(
         legacy_request_payload.pop('first_paid_subscription_plan')
         legacy_request_payload['subscription_plan'] = legacy_request_payload.pop('trial_subscription_plan')
 
+        StripeEventSummaryFactory.create(checkout_intent=self.checkout_intent)
+
         # Make the provisioning request.
         response = self.client.post(PROVISIONING_CREATE_ENDPOINT, data=legacy_request_payload)
 
@@ -953,6 +978,7 @@ def test_checkout_intent_synchronized_on_success(
         Test that a fulfillable checkout intent is linked to workflow and marked as FULFILLED on success.
         """
         checkout_intent = self._create_checkout_intent(state=intent_state)
+        StripeEventSummaryFactory.create(checkout_intent=checkout_intent)
         self.assertEqual(checkout_intent.state, intent_state)
         self.assertIsNone(checkout_intent.workflow)
 
@@ -1097,6 +1123,7 @@ def test_checkout_intent_different_slug_ignored(self, mock_lms_api_client, mock_
         """
         # The checkout intent we expect to be updated.
         main_checkout_intent = self._create_checkout_intent(state=CheckoutIntentState.PAID)
+        StripeEventSummaryFactory.create(checkout_intent=main_checkout_intent)
 
         # Create a checkout intent with different enterprise slug. Later, test that this is NOT modified.
         different_slug = 'different-enterprise-slug'
@@ -1105,6 +1132,7 @@ def test_checkout_intent_different_slug_ignored(self, mock_lms_api_client, mock_
             state=CheckoutIntentState.PAID,
             enterprise_slug=different_slug,
         )
+        StripeEventSummaryFactory.create(checkout_intent=different_checkout_intent)
 
         # Setup mocks for successful provisioning
         mock_lms_client = mock_lms_api_client.return_value

enterprise_access/apps/provisioning/models.py

@@ -12,7 +12,11 @@
 from django_countries import countries
 
 from enterprise_access.apps.customer_billing.constants import CheckoutIntentState
-from enterprise_access.apps.customer_billing.models import CheckoutIntent
+from enterprise_access.apps.customer_billing.models import (
+    CheckoutIntent,
+    SelfServiceSubscriptionRenewal,
+    StripeEventSummary
+)
 from enterprise_access.apps.customer_billing.tasks import send_enterprise_provision_signup_confirmation_email
 from enterprise_access.apps.workflow.exceptions import UnitOfWorkException
 from enterprise_access.apps.workflow.models import AbstractWorkflow, AbstractWorkflowStep
@@ -751,6 +755,35 @@ def process_input(self, accumulated_output=None, **kwargs):
                 f'to paid plan {first_paid_plan_uuid}'
             ) from exc
 
+        # Create SelfServiceSubscriptionRenewal record to track this renewal
+        try:
+            checkout_intent = self.get_linked_checkout_intent()
+            latest_summary = StripeEventSummary.get_latest_for_checkout_intent(
+                checkout_intent,
+                stripe_subscription_id__isnull=False,
+            )
+            if not latest_summary:
+                raise self.exception_class(f'No summary for {checkout_intent}')
+
+            renewal_tracking_record, created = SelfServiceSubscriptionRenewal.objects.get_or_create(
+                checkout_intent=checkout_intent,
+                subscription_plan_renewal_id=result_dict['id'],
+                defaults={
+                    'stripe_subscription_id': latest_summary.stripe_subscription_id,
+                    'stripe_event_data': latest_summary.stripe_event_data,
+                }
+            )
+        except Exception as exc:
+            logger.exception(
+                'Failed to create SelfServiceSubscriptionRenewal tracking record for renewal %s: %s',
+                result_dict.get('id'), exc
+            )
+            raise
+
+        logger.info(
+            'SelfServiceSubscriptionRenewal record %s for renewal %s, was created=%s',
+            renewal_tracking_record.id, result_dict['id'], created,
+        )
         return self.output_class.from_dict(result_dict)
 
     def get_workflow_record(self):

enterprise_access/apps/provisioning/tests/factories.py

@@ -36,14 +36,21 @@ def input_data(self):
             },
             'create_catalog_input': {},
             'create_customer_agreement_input': {},
-            'create_subscription_plan_input': {
-                'title': 'Test Subscription Plan',
+            'create_trial_subscription_plan_input': {
+                'title': 'Test Trial Subscription Plan',
                 'salesforce_opportunity_line_item': str(uuid.uuid4()),
                 'start_date': timezone.now().date().isoformat(),
                 'expiration_date': (timezone.now() + timezone.timedelta(days=365)).date().isoformat(),
                 'desired_num_licenses': 10,
                 'product_id': 123,
             },
+            'create_first_paid_subscription_plan_input': {
+                'title': 'Test First Paid Subscription Plan',
+                'product_id': 123,
+                'start_date': timezone.now().date().isoformat(),
+                'expiration_date': (timezone.now() + timezone.timedelta(days=730)).date().isoformat(),
+                'salesforce_opportunity_line_item': str(uuid.uuid4()),
+            },
         }
 
     output_data = factory.Dict({})
@@ -77,15 +84,28 @@ def create_complete_workflow(cls, **kwargs):
                 'uuid': str(uuid.uuid4()),
                 'enterprise_customer_uuid': str(uuid.uuid4()),
             },
-            'create_subscription_plan_output': {
+            'create_trial_subscription_plan_output': {
                 'uuid': str(uuid.uuid4()),
-                'title': 'Test Subscription Plan',
+                'title': 'Test Trial Subscription Plan',
                 'salesforce_opportunity_line_item': str(uuid.uuid4()),
                 'created': timezone.now().isoformat(),
                 'start_date': timezone.now().date().isoformat(),
                 'expiration_date': (timezone.now() + timezone.timedelta(days=365)).date().isoformat(),
                 'is_active': True,
                 'is_current': True,
+                'plan_type': 'trial',
+                'enterprise_catalog_uuid': str(uuid.uuid4()),
+                'product': 1,
+            },
+            'create_first_paid_subscription_plan_output': {
+                'uuid': str(uuid.uuid4()),
+                'title': 'Test First Paid Subscription Plan',
+                'salesforce_opportunity_line_item': str(uuid.uuid4()),
+                'created': timezone.now().isoformat(),
+                'start_date': timezone.now().date().isoformat(),
+                'expiration_date': (timezone.now() + timezone.timedelta(days=730)).date().isoformat(),
+                'is_active': True,
+                'is_current': True,
                 'plan_type': 'subscription',
                 'enterprise_catalog_uuid': str(uuid.uuid4()),
                 'product': 1,