Declare deprecation of traverse_pagination method

ecommerce/core/utils.py

@@ -5,6 +5,7 @@ import logging
 from urlparse import parse_qs, urlparse
 
 import six
+import waffle
 from django.core.exceptions import ValidationError
 
 logger = logging.getLogger(__name__)
@@ -48,10 +49,13 @@ def get_cache_key(**kwargs):
     return hashlib.md5(key).hexdigest()
 
 
-def traverse_pagination(response, endpoint):
+def deprecated_traverse_pagination(response, endpoint):
     """
     Traverse a paginated API response.
 
+    Note: This method should be deprecated since it defeats the purpose
+    of pagination.
+
     Extracts and concatenates "results" (list of dict) returned by DRF-powered
     APIs.
 
@@ -63,6 +67,9 @@ def traverse_pagination(response, endpoint):
         list of dict.
 
     """
+    if waffle.switch_is_active("debug_logging_for_deprecated_traverse_pagination"):  # pragma: no cover
+        logger.info("deprecated_traverse_pagination method is called for endpoint %s", endpoint)
+
     results = response.get('results', [])
 
     next_page = response.get('next')

ecommerce/courses/utils.py

@@ -5,7 +5,7 @@ from django.core.cache import cache
 from django.utils.translation import ugettext_lazy as _
 from opaque_keys.edx.keys import CourseKey
 
-from ecommerce.core.utils import traverse_pagination
+from ecommerce.core.utils import deprecated_traverse_pagination
 
 
 def mode_for_product(product):
@@ -77,7 +77,7 @@ def get_course_catalogs(site, resource_id=None):
     if resource_id:
         results = response
     else:
-        results = traverse_pagination(response, endpoint)
+        results = deprecated_traverse_pagination(response, endpoint)
 
     cache.set(cache_key, results, settings.COURSES_API_CACHE_TIMEOUT)
     return results

ecommerce/enterprise/utils.py

@@ -16,7 +16,7 @@ from oscar.core.loading import get_model
 from requests.exceptions import ConnectionError, Timeout
 from slumber.exceptions import SlumberHttpBaseException
 
-from ecommerce.core.utils import traverse_pagination
+from ecommerce.core.utils import deprecated_traverse_pagination
 from ecommerce.enterprise.exceptions import EnterpriseDoesNotExist
 from ecommerce.extensions.offer.models import OFFER_PRIORITY_ENTERPRISE
 
@@ -86,7 +86,7 @@ def get_enterprise_customers(site):
                 'name': each['name'],
                 'id': each['uuid'],
             }
-            for each in traverse_pagination(response, endpoint)
+            for each in deprecated_traverse_pagination(response, endpoint)
         ],
         key=lambda k: k['name'].lower()
     )

ecommerce/extensions/order/management/commands/create_fake_orders.py

@@ -7,7 +7,6 @@ from django.db import transaction
 from oscar.core.loading import get_class, get_model
 from oscar.test.factories import UserFactory
 
-
 logger = logging.getLogger(__name__)
 Order = get_model('order', 'Order')
 Basket = get_model('basket', 'Basket')

ecommerce/programs/conditions.py

@@ -10,7 +10,7 @@ from requests.exceptions import ConnectionError, Timeout
 from slumber.exceptions import HttpNotFoundError, SlumberBaseException
 
 from ecommerce.cache_utils.utils import TieredCache
-from ecommerce.core.utils import get_cache_key, traverse_pagination
+from ecommerce.core.utils import deprecated_traverse_pagination, get_cache_key
 from ecommerce.extensions.offer.decorators import check_condition_applicability
 from ecommerce.extensions.offer.mixins import SingleItemConsumptionConditionMixin
 from ecommerce.programs.utils import get_program
@@ -85,7 +85,8 @@ class ProgramCourseRunSeatsCondition(SingleItemConsumptionConditionMixin, Condit
                     basket, 'entitlements', site_configuration.entitlement_api_client.entitlements
                 )
                 if isinstance(response, dict):
-                    entitlements = traverse_pagination(response, site_configuration.entitlement_api_client.entitlements)
+                    entitlements = deprecated_traverse_pagination(
+                        response, site_configuration.entitlement_api_client.entitlements)
                 else:
                     entitlements = response
         return enrollments, entitlements

ecommerce/programs/tests/test_conditions.py

@@ -267,7 +267,7 @@ class ProgramCourseRunSeatsConditionTests(ProgramTestMixin, TestCase):
                 if seat.attr.id_verification_required:
                     basket.add_product(seat)
 
-        with mock.patch('ecommerce.programs.conditions.traverse_pagination') as mock_processing_entitlements:
+        with mock.patch('ecommerce.programs.conditions.deprecated_traverse_pagination') as mock_processing_entitlements:
             self.assertFalse(self.condition.is_satisfied(offer, basket))
             mock_processing_entitlements.assert_not_called()