Merge pull request #905 from openedx/pwnage101/ENT-9209

feat: support restricted/custom-b2b runs via enterprise_force_include_aggregation_keys

enterprise_catalog/apps/api_client/discovery.py

@@ -30,6 +30,8 @@
 
 LOGGER = logging.getLogger(__name__)
 
+CUSTOM_B2B_RESTRICTION_TYPE_KEY = 'custom-b2b-enterprise'
+
 
 class DiscoveryApiClient(BaseOAuthClient):
     """
@@ -294,7 +296,8 @@ def get_metadata_by_query(self, catalog_query):
             raise exc
 
         try:
-            # NOTE johnnagro this ONLY supports courses at the moment (NOT programs, leanerpathways, etc)
+            # NOTE johnnagro: This ONLY supports courses at the moment (NOT programs, leanerpathways, etc).
+            # NOTE Troy: This now also supports force-including restricted/custom-b2b courses.
             if forced_aggregation_keys := catalog_query.content_filter.get('enterprise_force_include_aggregation_keys'):
                 LOGGER.info(
                     'get_metadata_by_query enterprise_force_include_aggregation_keys seen'
@@ -324,7 +327,7 @@ def _retrieve_courses(self, offset, request_params):
 
     def get_courses(self, query_params=None):
         """
-        Return results from the discovery service's /courses endpoint.
+        Return results from the discovery service's /api/v1/courses/ endpoint.
 
         Arguments:
             query_params (dict): additional query params for the rest api endpoint
@@ -336,6 +339,11 @@ def get_courses(self, query_params=None):
         request_params = {
             'ordering': 'key',
             'limit': DISCOVERY_OFFSET_SIZE,
+            # ALWAYS include restricted/custom-b2b courses in the search results. Usability/visiblility of restricted
+            # courses is ultimately controlled at the level of catalog inclusion, but this helper function is designed
+            # to facilitate fetching specific courses. Therefore, there's no reason to hide anything restricted at this
+            # level of the code.
+            'include_restricted': CUSTOM_B2B_RESTRICTION_TYPE_KEY,
         }
         request_params.update(query_params or {})