add is_learning_material filter show courses and programs first in de…

…fault sort (#1104)
mitodl · Jun 18, 2024 · eb0537b · eb0537b
1 parent 44d5812
commit eb0537b
Show file tree

Hide file tree

Showing 7 changed files with 163 additions and 9 deletions.
diff --git a/frontends/api/src/generated/v1/api.ts b/frontends/api/src/generated/v1/api.ts
diff --git a/learning_resources_search/api.py b/learning_resources_search/api.py
@@ -38,7 +38,7 @@
 
 LEARN_SUGGEST_FIELDS = ["title.trigram", "description.trigram"]
 COURSENUM_SORT_FIELD = "course.course_numbers.sort_coursenum"
-DEFAULT_SORT = "-created_on"
+DEFAULT_SORT = ["is_learning_material", "-created_on"]
 
 
 def gen_content_file_id(content_file_id):
@@ -551,7 +551,7 @@ def construct_search(search_params):
         sort = generate_sort_clause(search_params)
         search = search.sort(sort)
     elif not search_params.get("q"):
-        search = search.sort(DEFAULT_SORT)
+        search = search.sort(*DEFAULT_SORT)
 
     if search_params.get("endpoint") == CONTENT_FILE_TYPE:
         query_type_query = {"exists": {"field": "content_type"}}
@@ -598,7 +598,6 @@ def execute_learn_search(search_params):
     """
 
     search = construct_search(search_params)
-
     return search.execute().to_dict()
 
 

diff --git a/learning_resources_search/api_test.py b/learning_resources_search/api_test.py
@@ -1428,6 +1428,7 @@ def test_execute_learn_search_for_learning_resource_query(opensearch):
                 "course.course_numbers.sort_coursenum",
                 "course.course_numbers.primary",
                 "resource_relations",
+                "is_learning_material",
             ]
         },
     }
@@ -1630,6 +1631,7 @@ def test_execute_learn_search_for_content_file_query(opensearch):
                 "course.course_numbers.sort_coursenum",
                 "course.course_numbers.primary",
                 "resource_relations",
+                "is_learning_material",
             ]
         },
     }
@@ -1760,7 +1762,7 @@ def test_document_percolation(opensearch, mocker):
     [
         ("-views", None, [{"views": {"order": "desc"}}]),
         ("-views", "text", [{"views": {"order": "desc"}}]),
-        (None, None, [{"created_on": {"order": "desc"}}]),
+        (None, None, ["is_learning_material", {"created_on": {"order": "desc"}}]),
         (None, "text", None),
     ],
 )

diff --git a/learning_resources_search/constants.py b/learning_resources_search/constants.py
@@ -74,6 +74,7 @@ class FilterConfig:
     "platform": FilterConfig("platform.code"),
     "offered_by": FilterConfig("offered_by.code"),
     "learning_format": FilterConfig("learning_format.code"),
+    "is_learning_material": FilterConfig("is_learning_material"),
 }
 
 SEARCH_NESTED_FILTERS = {
@@ -368,4 +369,5 @@ class FilterConfig:
     "course.course_numbers.sort_coursenum",
     "course.course_numbers.primary",
     "resource_relations",
+    "is_learning_material",
 ]
diff --git a/learning_resources_search/serializers.py b/learning_resources_search/serializers.py
@@ -38,6 +38,8 @@
 from learning_resources_search.api import gen_content_file_id
 from learning_resources_search.constants import (
     CONTENT_FILE_TYPE,
+    COURSE_TYPE,
+    PROGRAM_TYPE,
 )
 from learning_resources_search.models import PercolateQuery
 from learning_resources_search.utils import remove_child_queries
@@ -79,6 +81,8 @@ def serialize_learning_resource_for_update(
     return {
         "resource_relations": {"name": "resource"},
         "created_on": learning_resource_obj.created_on,
+        "is_learning_material": learning_resource_obj.resource_type
+        not in [COURSE_TYPE, PROGRAM_TYPE],
         **serialized_data,
     }
 
@@ -175,6 +179,7 @@ def to_representation(self, obj):
     "professional",
     "free",
     "learning_format",
+    "is_learning_material",
 ]
 
 CONTENT_FILE_AGGREGATIONS = ["topic", "content_feature_type", "platform", "offered_by"]
@@ -261,6 +266,13 @@ class LearningResourcesSearchRequestSerializer(SearchRequestSerializer):
         default=None,
         help_text="True if the learning resource offers a certificate",
     )
+    is_learning_material = ArrayWrappedBoolean(
+        required=False,
+        allow_null=True,
+        default=None,
+        help_text="True if the learning resource is a podcast, podcast episode, video, "
+        "video playlist, or learning path",
+    )
     certification_choices = CertificationType.as_tuple()
     certification_type = StringArrayField(
         required=False,

diff --git a/learning_resources_search/serializers_test.py b/learning_resources_search/serializers_test.py
@@ -142,6 +142,7 @@
                     "url": "http://xpro.mit.edu/courses/course-v1:xPRO+MCPO+R1/",
                     "resource_type": "course",
                     "platform": "globalalumni",
+                    "is_learning_material": False,
                 },
             }
         ],
@@ -278,6 +279,7 @@
             "url": "http://xpro.mit.edu/courses/course-v1:xPRO+MCPO+R1/",
             "resource_type": "course",
             "platform": "globalalumni",
+            "is_learning_material": False,
         }
     ],
     "metadata": {
@@ -344,6 +346,7 @@
                     "last_modified": None,
                     "runs": [],
                     "course_feature": [],
+                    "is_learning_material": True,
                     "user_list_parents": [],
                 },
             }
@@ -507,6 +510,7 @@
             "last_modified": None,
             "runs": [],
             "course_feature": [],
+            "is_learning_material": True,
             "user_list_parents": [],
         }
     ],
@@ -589,6 +593,7 @@ def test_serialize_learning_resource_for_bulk(resource_type, is_professional, no
         "_id": resource.id,
         "resource_relations": {"name": "resource"},
         "created_on": resource.created_on,
+        "is_learning_material": resource.resource_type not in ["course", "program"],
         **free_dict,
         **LearningResourceSerializer(resource).data,
     }
@@ -635,6 +640,7 @@ def test_serialize_course_numbers_for_bulk(
         "resource_relations": {"name": "resource"},
         "created_on": resource.created_on,
         "free": False,
+        "is_learning_material": False,
         **LearningResourceSerializer(resource).data,
     }
     expected_data["course"]["course_numbers"][0] = {
@@ -713,6 +719,7 @@ def test_learning_resources_search_request_serializer():
         "certification": "false",
         "certification_type": CertificationType.none.name,
         "free": True,
+        "is_learning_material": True,
         "offered_by": "xpro,ocw",
         "platform": "xpro,edx,ocw",
         "topic": "Math",
@@ -730,6 +737,7 @@ def test_learning_resources_search_request_serializer():
         "sortby": "-start_date",
         "professional": [True],
         "certification": [False],
+        "is_learning_material": [True],
         "certification_type": [CertificationType.none.name],
         "free": [True],
         "offered_by": ["xpro", "ocw"],

diff --git a/openapi/specs/v1.yaml b/openapi/specs/v1.yaml
@@ -2093,6 +2093,7 @@ paths:
             - professional
             - free
             - learning_format
+            - is_learning_material
             type: string
             description: |-
               * `resource_type` - resource_type
@@ -2107,6 +2108,7 @@ paths:
               * `professional` - professional
               * `free` - free
               * `learning_format` - learning_format
+              * `is_learning_material` - is_learning_material
         description: Show resource counts by category
       - in: query
         name: certification
@@ -2254,6 +2256,13 @@ paths:
           items:
             type: integer
         description: The id value for the learning resource
+      - in: query
+        name: is_learning_material
+        schema:
+          type: boolean
+          nullable: true
+        description: True if the learning resource is a podcast, podcast episode,
+          video, video playlist, or learning path
       - in: query
         name: learning_format
         schema:
@@ -2494,6 +2503,7 @@ paths:
             - professional
             - free
             - learning_format
+            - is_learning_material
             type: string
             description: |-
               * `resource_type` - resource_type
@@ -2508,6 +2518,7 @@ paths:
               * `professional` - professional
               * `free` - free
               * `learning_format` - learning_format
+              * `is_learning_material` - is_learning_material
         description: Show resource counts by category
       - in: query
         name: certification
@@ -2655,6 +2666,13 @@ paths:
           items:
             type: integer
         description: The id value for the learning resource
+      - in: query
+        name: is_learning_material
+        schema:
+          type: boolean
+          nullable: true
+        description: True if the learning resource is a podcast, podcast episode,
+          video, video playlist, or learning path
       - in: query
         name: learning_format
         schema:
@@ -2920,6 +2938,7 @@ paths:
             - professional
             - free
             - learning_format
+            - is_learning_material
             type: string
             description: |-
               * `resource_type` - resource_type
@@ -2934,6 +2953,7 @@ paths:
               * `professional` - professional
               * `free` - free
               * `learning_format` - learning_format
+              * `is_learning_material` - is_learning_material
         description: Show resource counts by category
       - in: query
         name: certification
@@ -3081,6 +3101,13 @@ paths:
           items:
             type: integer
         description: The id value for the learning resource
+      - in: query
+        name: is_learning_material
+        schema:
+          type: boolean
+          nullable: true
+        description: True if the learning resource is a podcast, podcast episode,
+          video, video playlist, or learning path
       - in: query
         name: learning_format
         schema:
@@ -3337,6 +3364,7 @@ paths:
             - professional
             - free
             - learning_format
+            - is_learning_material
             type: string
             description: |-
               * `resource_type` - resource_type
@@ -3351,6 +3379,7 @@ paths:
               * `professional` - professional
               * `free` - free
               * `learning_format` - learning_format
+              * `is_learning_material` - is_learning_material
         description: Show resource counts by category
       - in: query
         name: certification
@@ -3498,6 +3527,13 @@ paths:
           items:
             type: integer
         description: The id value for the learning resource
+      - in: query
+        name: is_learning_material
+        schema:
+          type: boolean
+          nullable: true
+        description: True if the learning resource is a podcast, podcast episode,
+          video, video playlist, or learning path
       - in: query
         name: learning_format
         schema:
@@ -6873,6 +6909,7 @@ components:
       - professional
       - free
       - learning_format
+      - is_learning_material
       type: string
       description: |-
         * `resource_type` - resource_type
@@ -6887,6 +6924,7 @@ components:
         * `professional` - professional
         * `free` - free
         * `learning_format` - learning_format
+        * `is_learning_material` - is_learning_material
       x-enum-descriptions:
       - resource_type
       - certification
@@ -6900,6 +6938,7 @@ components:
       - professional
       - free
       - learning_format
+      - is_learning_material
     Article:
       type: object
       description: Serializer for LearningResourceInstructor model
@@ -9218,6 +9257,11 @@ components:
           type: boolean
           nullable: true
           description: True if the learning resource offers a certificate
+        is_learning_material:
+          type: boolean
+          nullable: true
+          description: True if the learning resource is a podcast, podcast episode,
+            video, video playlist, or learning path
         certification_type:
           type: array
           items: