chore: decouple subsidy actions and user message dependencies

Author: ahmad-hassan-dev

enterprise_access/apps/subsidy_request/constants.py

@@ -34,7 +34,9 @@ class SubsidyRequestStates:
 
     CHOICES = COMMON_STATES + LC_REQUEST_STATES
 
-
+# DEPRECATED: This class was used to add 'reminded' to the list of possible
+# actions. Its functionality has been consolidated into the self-contained
+# `LearnerCreditRequestActionTypes` class.
 class LearnerCreditAdditionalActionStates:
     """ Additional states specifically for LearnerCreditRequestActions. """
 
@@ -43,8 +45,8 @@ class LearnerCreditAdditionalActionStates:
         (REMINDED, "Reminded"),
     )
 
-
-# Combined choices for LearnerCreditRequestAction model
+# DEPRECATED: This variable combined states from multiple classes in a way that
+# was confusing and brittle. Use `LearnerCreditRequestActionTypes.CHOICES` instead.
 LearnerCreditRequestActionChoices = SubsidyRequestStates.CHOICES + LearnerCreditAdditionalActionStates.CHOICES
 
 
@@ -84,21 +86,59 @@ class SubsidyTypeChoices:
 
 SUBSIDY_REQUEST_BULK_OPERATION_BATCH_SIZE = 100
 
+class LearnerCreditRequestActionTypes:
+    """
+    Defines the set of possible values for the `recent_action` field on the
+    `LearnerCreditRequestActions` model. This represents the specific event
+    or operation that occurred (e.g., an approval, a reminder).
+    """
+    REQUESTED = 'requested'
+    APPROVED = 'approved'
+    DECLINED = 'declined'
+    ERROR = 'error'
+    ACCEPTED = 'accepted'
+    CANCELLED = 'cancelled'
+    EXPIRED = 'expired'
+    REVERSED = 'reversed'
+    REMINDED = 'reminded'
+
+    CHOICES = (
+        (REQUESTED, "Requested"),
+        (APPROVED, "Approved"),
+        (DECLINED, "Declined"),
+        (ERROR, "Error"),
+        (ACCEPTED, "Accepted"),
+        (CANCELLED, "Cancelled"),
+        (EXPIRED, "Expired"),
+        (REVERSED, "Reversed"),
+        (REMINDED, "Reminded"),
+    )
+
 
 class LearnerCreditRequestUserMessages:
     """
-    User-facing messages for LearnerCreditRequestActions status field.
-    Reusing the state keys from SubsidyRequestStates but with different display messages.
+    Defines the set of possible values for the `status` field on the
+    `LearnerCreditRequestActions` model. This represents the user-facing
+    status label that is displayed in the UI as a result of an action.
     """
+    REQUESTED = 'requested'
+    REMINDED = 'reminded'
+    APPROVED = 'approved'
+    ACCEPTED = 'accepted'
+    DECLINED = 'declined'
+    REVERSED = 'reversed'
+    CANCELLED = 'cancelled'
+    EXPIRED = 'expired'
+
     CHOICES = (
-        (SubsidyRequestStates.REQUESTED, "Requested"),
-        (LearnerCreditAdditionalActionStates.REMINDED, "Waiting For Learner"),
-        (SubsidyRequestStates.APPROVED, "Waiting For Learner"),
-        (SubsidyRequestStates.ACCEPTED, "Redeemed By Learner"),
-        (SubsidyRequestStates.DECLINED, "Declined"),
-        (SubsidyRequestStates.REVERSED, "Refunded"),
-        (SubsidyRequestStates.CANCELLED, "Cancelled"),
-        (SubsidyRequestStates.EXPIRED, "Expired"),
+        (REQUESTED, "Requested"),
+        (REMINDED, "Waiting For Learner"),
+        (APPROVED, "Waiting For Learner"),
+        (ACCEPTED, "Redeemed By Learner"),
+        (DECLINED, "Declined"),
+        (REVERSED, "Refunded"),
+        (CANCELLED, "Cancelled"),
+        (EXPIRED, "Expired"),
     )
 
 

enterprise_access/apps/subsidy_request/models.py

@@ -22,7 +22,7 @@
 from enterprise_access.apps.subsidy_request.constants import (
     SUBSIDY_REQUEST_BULK_OPERATION_BATCH_SIZE,
     LearnerCreditAdditionalActionStates,
-    LearnerCreditRequestActionChoices,
+    LearnerCreditRequestActionTypes,
     LearnerCreditRequestActionErrorReasons,
     LearnerCreditRequestUserMessages,
     SubsidyRequestStates,
@@ -560,7 +560,7 @@ class LearnerCreditRequestActions(TimeStampedModel):
         blank=False,
         null=False,
         db_index=True,
-        choices=LearnerCreditRequestActionChoices,
+        choices=LearnerCreditRequestActionTypes.CHOICES,
         help_text="The type of action taken on the learner credit request.",
     )
 
@@ -615,7 +615,7 @@ def create_action(
         Args:
             learner_credit_request (LearnerCreditRequest): The associated learner credit request.
             recent_action (str): The type of action taken (must be a valid choice from
-                LearnerCreditRequestActionChoices).
+                LearnerCreditRequestActionTypes).
             status (str): The status message (must be a valid choice from LearnerCreditRequestUserMessages.CHOICES).
             error_reason (str, optional): The error reason if applicable (must be a valid choice
                 from LearnerCreditRequestActionErrorReasons.CHOICES).