refactor(view): consolidate sending analytics event into success view

this removes the need for any helper function

benefits/enrollment/views.py

@@ -105,7 +105,7 @@ def index(request):
                     client.link_concession_group_funding_source(
                         group_id=group_id, funding_source_id=funding_source.id, expiry_date=session.enrollment_expiry(request)
                     )
-                    return _success(request, group_id)
+                    return success(request)
                 else:  # already_enrolled
                     if group_funding_source.concession_expiry is None:
                         # update expiration of existing enrollment, return success
@@ -114,7 +114,7 @@ def index(request):
                             funding_source_id=funding_source.id,
                             expiry_date=session.enrollment_expiry(request),
                         )
-                        return _success(request, group_id)
+                        return success(request)
                     else:
                         is_expired = _is_expired(group_funding_source.concession_expiry)
                         is_within_reenrollment_window = _is_within_reenrollment_window(
@@ -128,19 +128,19 @@ def index(request):
                                 funding_source_id=funding_source.id,
                                 expiry_date=session.enrollment_expiry(request),
                             )
-                            return _success(request, group_id)
+                            return success(request)
                         else:
                             # re-enrollment error, return enrollment error with expiration and reenrollment_date
                             return reenrollment_error(request)
             else:  # eligibility does not support expiration
                 if not already_enrolled:
                     # enroll user with no expiration date, return success
                     client.link_concession_group_funding_source(group_id=group_id, funding_source_id=funding_source.id)
-                    return _success(request, group_id)
+                    return success(request)
                 else:  # already_enrolled
                     if group_funding_source.concession_expiry is None:
                         # no action, return success
-                        return _success(request, group_id)
+                        return success(request)
                     else:
                         # remove expiration date, return success
                         raise NotImplementedError("Removing expiration date is currently not supported")
@@ -173,11 +173,6 @@ def index(request):
         return TemplateResponse(request, TEMPLATE_INDEX, context)
 
 
-def _success(request, group_id):
-    analytics.returned_success(request, group_id)
-    return success(request)
-
-
 def _get_group_funding_source(client: Client, group_id, funding_source_id):
     group_funding_sources = client.get_concession_group_linked_funding_sources(group_id)
     matching_group_funding_source = None
@@ -232,6 +227,7 @@ def retry(request):
 
 
 @pageview_decorator
+@decorator_from_middleware(EligibleSessionRequired)
 @decorator_from_middleware(VerifierSessionRequired)
 def success(request):
     """View handler for the final success page."""
@@ -240,10 +236,12 @@ def success(request):
 
     agency = session.agency(request)
     verifier = session.verifier(request)
+    eligibility = session.eligibility(request)
 
     if session.logged_in(request) and verifier.auth_provider.supports_sign_out:
         # overwrite origin for a logged in user
         # if they click the logout button, they are taken to the new route
         session.update(request, origin=reverse(ROUTE_LOGGED_OUT))
 
+    analytics.returned_success(request, eligibility.group_id)
     return TemplateResponse(request, agency.enrollment_success_template)

tests/pytest/enrollment/test_views.py

@@ -667,8 +667,8 @@ def test_success_no_verifier(client):
 
 
 @pytest.mark.django_db
-@pytest.mark.usefixtures("mocked_session_verifier_auth_required")
-def test_success_authentication_logged_in(mocker, client, model_TransitAgency):
+@pytest.mark.usefixtures("mocked_session_verifier_auth_required", "mocked_session_eligibility")
+def test_success_authentication_logged_in(mocker, client, model_TransitAgency, mocked_analytics_module):
     mock_session = mocker.patch("benefits.enrollment.views.session")
     mock_session.logged_in.return_value = True
     mock_session.agency.return_value = model_TransitAgency
@@ -679,11 +679,12 @@ def test_success_authentication_logged_in(mocker, client, model_TransitAgency):
     assert response.status_code == 200
     assert response.template_name == TEMPLATE_SUCCESS
     assert {"origin": reverse(ROUTE_LOGGED_OUT)} in mock_session.update.call_args
+    mocked_analytics_module.returned_success.assert_called_once()
 
 
 @pytest.mark.django_db
-@pytest.mark.usefixtures("mocked_session_verifier_auth_required")
-def test_success_authentication_not_logged_in(mocker, client, model_TransitAgency):
+@pytest.mark.usefixtures("mocked_session_verifier_auth_required", "mocked_session_eligibility")
+def test_success_authentication_not_logged_in(mocker, client, model_TransitAgency, mocked_analytics_module):
     mock_session = mocker.patch("benefits.enrollment.views.session")
     mock_session.logged_in.return_value = False
     mock_session.agency.return_value = model_TransitAgency
@@ -693,13 +694,15 @@ def test_success_authentication_not_logged_in(mocker, client, model_TransitAgenc
 
     assert response.status_code == 200
     assert response.template_name == TEMPLATE_SUCCESS
+    mocked_analytics_module.returned_success.assert_called_once()
 
 
 @pytest.mark.django_db
-@pytest.mark.usefixtures("mocked_session_agency", "mocked_session_verifier_auth_not_required")
-def test_success_no_authentication(client):
+@pytest.mark.usefixtures("mocked_session_agency", "mocked_session_verifier_auth_not_required", "mocked_session_eligibility")
+def test_success_no_authentication(client, mocked_analytics_module):
     path = reverse(ROUTE_SUCCESS)
     response = client.get(path)
 
     assert response.status_code == 200
     assert response.template_name == TEMPLATE_SUCCESS
+    mocked_analytics_module.returned_success.assert_called_once()