fix Cybersource cancellation or success redirect failures (#5116)

fix Cybersource cancellation or success redirect failures

Author: Umar Asghar

Diff for: ecommerce/urls.py

@@ -5,6 +5,7 @@
     CouponsView,
     OrderFulfillmentView,
     UserCouponsView,
+    PaymentCallBackView
 )
 
 urlpatterns = [
@@ -16,4 +17,5 @@
         name='coupon-user-create',
     ),
     url(r'^api/v0/order_fulfillment/$', OrderFulfillmentView.as_view(), name='order-fulfillment'),
+    url(r'^payment-callback/$', PaymentCallBackView.as_view(), name='payment-callback'),
 ]

Diff for: ecommerce/views.py

@@ -7,6 +7,7 @@
 from django.db import transaction
 from django.http.response import Http404
 from django.shortcuts import get_object_or_404
+from django.views.generic.base import RedirectView
 from ipware import get_client_ip
 from rest_framework.authentication import SessionAuthentication, TokenAuthentication
 from rest_framework.exceptions import ValidationError
@@ -44,6 +45,7 @@
 )
 from ecommerce.serializers import CouponSerializer
 from mail.api import MailgunClient
+from ui.url_utils import DASHBOARD_URL, PAYMENT_CALL_BACK_URL
 
 log = logging.getLogger(__name__)
 
@@ -80,7 +82,7 @@ def post(self, request, *args, **kwargs):  # pylint: disable=unused-argument
         )
         if course_run.course.program.financial_aid_availability:
             order = create_unfulfilled_order(course_id, request.user)
-            dashboard_url = request.build_absolute_uri('/dashboard/')
+            payment_callback_url = request.build_absolute_uri(PAYMENT_CALL_BACK_URL)
             if order.total_price_paid == 0:
                 # If price is $0, don't bother going to CyberSource, just mark as fulfilled
                 order.status = Order.FULFILLED
@@ -112,11 +114,11 @@ def post(self, request, *args, **kwargs):  # pylint: disable=unused-argument
 
                 # This redirects the user to our order success page
                 payload = {}
-                url = make_dashboard_receipt_url(dashboard_url, course_id, 'receipt')
+                url = make_dashboard_receipt_url(payment_callback_url, course_id, 'receipt')
                 method = 'GET'
             else:
                 # This generates a signed payload which is submitted as an HTML form to CyberSource
-                payload = generate_cybersource_sa_payload(order, dashboard_url, user_ip)
+                payload = generate_cybersource_sa_payload(order, payment_callback_url, user_ip)
                 url = settings.CYBERSOURCE_SECURE_ACCEPTANCE_URL
                 method = 'POST'
         else:
@@ -275,3 +277,11 @@ def post(self, request, code, *args, **kwargs):  # pylint: disable=unused-argume
                     'coupon': CouponSerializer(coupon).data,
                 }
             )
+
+
+class PaymentCallBackView(RedirectView):
+    """
+    payment callback view that will redirect to dashboard url
+    """
+    url = DASHBOARD_URL
+    query_string = True

Diff for: ecommerce/views_test.py

@@ -131,7 +131,7 @@ def test_creates_order(self):
         assert create_mock.call_count == 1
         assert create_mock.call_args[0] == (course_run.edx_course_key, user)
         assert generate_mock.call_count == 1
-        assert generate_mock.call_args[0] == (order, 'http://testserver/dashboard/', fake_ip)
+        assert generate_mock.call_args[0] == (order, 'http://testserver/payment-callback/', fake_ip)
 
     @override_settings(EDXORG_BASE_URL='http://edx_base')
     def test_provides_edx_link(self):
@@ -180,7 +180,7 @@ def test_zero_price_checkout(self):
         assert resp.status_code == status.HTTP_200_OK
         assert resp.json() == {
             'payload': {},
-            'url': 'http://testserver/dashboard/?status=receipt&course_key={}'.format(
+            'url': 'http://testserver/payment-callback/?status=receipt&course_key={}'.format(
                 quote_plus(course_run.edx_course_key)
             ),
             'method': 'GET',
@@ -223,7 +223,7 @@ def test_zero_price_checkout_failed_enroll(self):
         assert resp.status_code == status.HTTP_200_OK
         assert resp.json() == {
             'payload': {},
-            'url': 'http://testserver/dashboard/?status=receipt&course_key={}'.format(
+            'url': 'http://testserver/payment-callback/?status=receipt&course_key={}'.format(
                 quote_plus(course_run.edx_course_key)
             ),
             'method': 'GET',

Diff for: ui/url_utils.py

@@ -11,6 +11,7 @@
 SEARCH_URL = "/learners/"
 ORDER_SUMMARY = "/order_summary/"
 EMAIL_URL = "/automaticemails/"
+PAYMENT_CALL_BACK_URL = "/payment-callback/"
 
 DASHBOARD_URLS = [
     DASHBOARD_URL,