feat: Adding weeks to complete filed into Algolia facet

Author: nbalne

course_discovery/apps/course_metadata/algolia_models.py

@@ -83,7 +83,7 @@ def delegate_attributes(cls):
                      'secondary_description', 'tertiary_description']
     facet_fields = ['availability_level', 'subject_names', 'levels', 'active_languages', 'staff_slugs',
                     'product_allowed_in', 'product_blocked_in', 'learning_type', 'learning_type_exp',
-                    'product_ai_languages']
+                    'product_ai_languages', 'product_weeks_to_complete']
     ranking_fields = ['availability_rank', 'product_recent_enrollment_count', 'promoted_in_spanish_index',
                       'product_value_per_click_usa', 'product_value_per_click_international',
                       'product_value_per_lead_usa', 'product_value_per_lead_international']

course_discovery/apps/course_metadata/index.py

@@ -80,7 +80,7 @@ class EnglishProductIndex(BaseProductIndex):
                     ('active_languages', 'language'), ('product_type', 'product'), ('program_types', 'program_type'),
                     ('staff_slugs', 'staff'), ('product_allowed_in', 'allowed_in'),
                     ('product_blocked_in', 'blocked_in'), 'subscription_eligible',
-                    'subscription_prices', 'learning_type', 'learning_type_exp',
+                    'subscription_prices', 'learning_type', 'learning_type_exp', 'weeks_to_complete',
                     ('product_ai_languages', 'ai_languages'))
     ranking_fields = ('availability_rank', ('product_recent_enrollment_count', 'recent_enrollment_count'),
                       ('product_value_per_click_usa', 'value_per_click_usa'),
@@ -117,7 +117,7 @@ class EnglishProductIndex(BaseProductIndex):
             'partner', 'availability', 'subject', 'level', 'language', 'product', 'program_type',
             'filterOnly(staff)', 'filterOnly(allowed_in)', 'filterOnly(blocked_in)', 'skills.skill',
             'skills.category', 'skills.subcategory', 'tags', 'subscription_eligible', 'subscription_prices',
-            'learning_type', 'learning_type_exp', 'ai_languages.translation_languages',
+            'learning_type', 'learning_type_exp', 'ai_languages.translation_languages', 'weeks_to_complete',
             'ai_languages.transcription_languages',
         ],
         'customRanking': ['asc(availability_rank)', 'desc(recent_enrollment_count)']
@@ -135,7 +135,7 @@ class SpanishProductIndex(BaseProductIndex):
                     ('active_languages', 'language'), ('product_type', 'product'), ('program_types', 'program_type'),
                     ('staff_slugs', 'staff'), ('product_allowed_in', 'allowed_in'),
                     ('product_blocked_in', 'blocked_in'), 'subscription_eligible',
-                    'subscription_prices', 'learning_type', 'learning_type_exp',
+                    'subscription_prices', 'learning_type', 'learning_type_exp', 'weeks_to_complete',
                     ('product_ai_languages', 'ai_languages'))
     ranking_fields = ('availability_rank', ('product_recent_enrollment_count', 'recent_enrollment_count'),
                       ('product_value_per_click_usa', 'value_per_click_usa'),
@@ -171,7 +171,7 @@ class SpanishProductIndex(BaseProductIndex):
             'contentful_fields.faq_items, contentful_fields.featured_products'
         ],
         'attributesForFaceting': [
-            'partner', 'availability', 'subject', 'level', 'language', 'product', 'program_type',
+            'partner', 'availability', 'weeks_to_complete', 'subject', 'level', 'language', 'product', 'program_type',
             'filterOnly(staff)', 'filterOnly(allowed_in)', 'filterOnly(blocked_in)',
             'skills.skill', 'skills.category', 'skills.subcategory', 'tags', 'subscription_eligible',
             'subscription_prices', 'learning_type', 'learning_type_exp', 'ai_languages.translation_languages',

course_discovery/apps/course_metadata/tests/factories.py

@@ -496,6 +496,19 @@ def staff(self, create, extracted, **kwargs):
     class Meta:
         model = CourseRun
 
+    @factory.post_generation
+    def make_marketable(self, create, extracted, **kwargs):
+        if not create:
+            return
+        if extracted:
+            self.type.is_marketable = True
+            self.type.save()
+            if not self.seats.exists():
+                verified_type = SeatTypeFactory(slug="verified", name="Verified")
+                SeatFactory(course_run=self, type=verified_type, price=100)
+            self.status = CourseRunStatus.Published
+            self.save()
+
     @factory.post_generation
     def transcript_languages(self, create, extracted, **kwargs):
         if create:  # pragma: no cover

course_discovery/apps/course_metadata/tests/test_algolia_models.py

@@ -1,12 +1,14 @@
 import datetime
 from collections import ChainMap
+from datetime import timedelta
 
 import ddt
 import factory
 import pytest
 from django.conf import settings
 from django.contrib.sites.models import Site
 from django.test import TestCase, override_settings
+from django.utils import timezone
 from pytz import UTC
 
 from conftest import TEST_DOMAIN
@@ -16,10 +18,10 @@
 from course_discovery.apps.course_metadata.choices import ExternalProductStatus, ProgramStatus
 from course_discovery.apps.course_metadata.models import CourseRunStatus, CourseType, ProductValue, ProgramType
 from course_discovery.apps.course_metadata.tests.factories import (
-    AdditionalMetadataFactory, CourseFactory, CourseRunFactory, CourseTypeFactory, DegreeAdditionalMetadataFactory,
-    DegreeFactory, GeoLocationFactory, LevelTypeFactory, OrganizationFactory, ProductMetaFactory, ProgramFactory,
-    ProgramSubscriptionFactory, ProgramSubscriptionPriceFactory, ProgramTypeFactory, RestrictedCourseRunFactory,
-    SeatFactory, SeatTypeFactory, SourceFactory, SubjectFactory, VideoFactory
+    AdditionalMetadataFactory, CourseFactory, CourseRunFactory, CourseRunTypeFactory, CourseTypeFactory,
+    DegreeAdditionalMetadataFactory, DegreeFactory, GeoLocationFactory, LevelTypeFactory, OrganizationFactory,
+    ProductMetaFactory, ProgramFactory, ProgramSubscriptionFactory, ProgramSubscriptionPriceFactory, ProgramTypeFactory,
+    RestrictedCourseRunFactory, SeatFactory, SeatTypeFactory, SourceFactory, SubjectFactory, VideoFactory
 )
 from course_discovery.apps.ietf_language_tags.models import LanguageTag
 
@@ -599,6 +601,68 @@ def test_course_ai_languages__no_advertised_run(self):
             'transcription_languages': []
         }
 
+    def test_product_weeks_to_complete_returns_value(self):
+        course = CourseFactory()
+        run_type = CourseRunTypeFactory(is_marketable=True)
+        CourseRunFactory(
+            course=course,
+            type=run_type,
+            weeks_to_complete=8,
+            start=timezone.now() - timedelta(days=1),
+            end=timezone.now() + timedelta(days=30),
+            hidden=False,
+            make_marketable=True,
+        )
+        course.refresh_from_db()
+        proxy_course = AlgoliaProxyCourse.objects.get(pk=course.id)
+        assert proxy_course.product_weeks_to_complete == 8
+
+    def test_product_weeks_to_complete_none_if_no_advertised_run(self):
+        course = CourseFactory()
+        proxy_course = AlgoliaProxyCourse.objects.get(pk=course.id)
+        assert proxy_course.product_weeks_to_complete is None
+
+    def test_multiple_runs_only_advertised_run_is_used(self):
+        course = CourseFactory()
+        run_type = CourseRunTypeFactory(is_marketable=True)
+        CourseRunFactory(
+            course=course,
+            type=run_type,
+            weeks_to_complete=4,
+            start=timezone.now() - timedelta(days=1),
+            end=timezone.now() + timedelta(days=10),
+            hidden=False,
+            make_marketable=True,
+        )
+        advertised_run = CourseRunFactory(
+            course=course,
+            type=run_type,
+            weeks_to_complete=12,
+            start=timezone.now() - timedelta(days=1),
+            end=timezone.now() + timedelta(days=20),
+            hidden=False,
+            make_marketable=True,
+        )
+        course.advertised_course_run_id = advertised_run.id
+        course.save()
+        course.refresh_from_db()
+        proxy_course = AlgoliaProxyCourse.objects.get(pk=course.id)
+        assert proxy_course.product_weeks_to_complete == 12
+
+    @ddt.data(6, None)
+    def test_weeks_to_complete_property_type(self, weeks):
+        course = CourseFactory()
+        if weeks is not None:
+            run = CourseRunFactory(course=course, weeks_to_complete=weeks)
+            if hasattr(course, 'set_advertised_course_run'):
+                course.set_advertised_course_run(run)
+            else:
+                course.advertised_course_run_id = run.id
+            course.save()
+        proxy_course = AlgoliaProxyCourse.objects.get(pk=course.id)
+        value = proxy_course.product_weeks_to_complete
+        assert value is None or isinstance(value, int)
+
 
 @ddt.ddt
 @pytest.mark.django_db
@@ -610,6 +674,16 @@ class TestAlgoliaProxyProgram(TestAlgoliaProxyWithEdxPartner):
     IN_FIFTEEN_DAYS = datetime.datetime.now(UTC) + datetime.timedelta(days=15)
     IN_TWO_MONTHS = datetime.datetime.now(UTC) + datetime.timedelta(days=60)
 
+    def test_product_weeks_to_complete_always_none(self):
+        program = ProgramFactory()
+        proxy_program = AlgoliaProxyProgram.objects.get(pk=program.id)
+        assert proxy_program.product_weeks_to_complete is None
+
+    def test_product_weeks_to_complete_none_even_with_related_courses(self):
+        program = ProgramFactory()
+        proxy_program = AlgoliaProxyProgram.objects.get(pk=program.id)
+        assert proxy_program.product_weeks_to_complete is None
+
     def attach_course_run(self, course, availability="Archived"):
         course_start = course_end = ''
         if availability == 'none':