✨(search) allows different search and courses page

Add `RICHIE_SEARCH_REVERSE_ID` setting that allows to have different search page and courses parent page. Closes #1810
openfun · Oct 24, 2022 · 553ee60 · 553ee60
1 parent f2e7d77
commit 553ee60
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,8 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Added
 
+- Add `RICHIE_SEARCH_REVERSE_ID` setting that allows to have different search page and courses
+  parent page.
 - Add Dashboard router
 - Add generic dashboard component
 - Add dashboard components for Order, Enrollment

diff --git a/...site-factory/template/{{cookiecutter.site}}/src/backend/{{cookiecutter.site}}/settings.py b/...site-factory/template/{{cookiecutter.site}}/src/backend/{{cookiecutter.site}}/settings.py
@@ -270,6 +270,13 @@ class Base(StyleguideMixin, DRFMixin, RichieCoursesConfigurationMixin, Configura
         environ_prefix=None,
     )
 
+    # Configure course search page reverse id
+    RICHIE_SEARCH_REVERSE_ID = values.Value(
+        "courses",
+        environ_name="RICHIE_SEARCH_REVERSE_ID",
+        environ_prefix=None,
+    )
+
     # Internationalization
     TIME_ZONE = "Europe/Paris"
     USE_I18N = True

diff --git a/sandbox/settings.py b/sandbox/settings.py
@@ -554,6 +554,13 @@ class Base(StyleguideMixin, DRFMixin, RichieCoursesConfigurationMixin, Configura
         environ_prefix=None,
     )
 
+    # Configure course search page reverse id
+    RICHIE_SEARCH_REVERSE_ID = values.Value(
+        "courses",
+        environ_name="RICHIE_SEARCH_REVERSE_ID",
+        environ_prefix=None,
+    )
+
     @classmethod
     def _get_environment(cls):
         """Environment in which the application is launched."""

diff --git a/src/richie/apps/core/context_processors.py b/src/richie/apps/core/context_processors.py
@@ -54,6 +54,11 @@ def site_metas(request: HttpRequest):
         **WebAnalyticsContextProcessor().context_processor(request),
     }
 
+    # Add a context variable with the reverse id of the search course page.
+    context["RICHIE_SEARCH_REVERSE_ID"] = getattr(
+        settings, "RICHIE_SEARCH_REVERSE_ID", "courses"
+    )
+
     if getattr(settings, "CDN_DOMAIN", None):
         context["CDN_DOMAIN"] = settings.CDN_DOMAIN
 

diff --git a/src/richie/apps/core/templates/richie/base.html b/src/richie/apps/core/templates/richie/base.html
@@ -108,7 +108,7 @@
                             <div class="topbar__menu topbar__menu--aside">
                                 {% block topbar_searchbar %}
                                 <div class="topbar__search richie-react richie-react--root-search-suggest-field"
-                                    data-props='{"courseSearchPageUrl": "{% page_url 'courses' %}"}'></div>
+                                    data-props='{"courseSearchPageUrl": "{% page_url RICHIE_SEARCH_REVERSE_ID %}"}'></div>
                                 {% endblock topbar_searchbar %}
                                 <ul class="topbar__list topbar__list--controls">
                                     {% block userlogin %}

diff --git a/src/richie/apps/courses/templates/courses/cms/category_detail.html b/src/richie/apps/courses/templates/courses/cms/category_detail.html
@@ -130,13 +130,13 @@ <h2 class="category-detail__title">{% trans "Related courses" %}</h2>
                                 {% include "richie/pagination.html" with label=_("Courses pagination") %}
                                 <div class="button-caesura">
                                 {% if category.get_meta_category %}
-                                    <a href="{% page_url 'courses' %}?{{ category.get_meta_category.extended_object.reverse_id }}={{ category.get_es_id }}" class="category-detail__see-more">
+                                    <a href="{% page_url RICHIE_SEARCH_REVERSE_ID %}?{{ category.get_meta_category.extended_object.reverse_id }}={{ category.get_es_id }}" class="category-detail__see-more">
                                     {% blocktrans with category_title=category.extended_object.get_title %}
                                         See all courses related to {{ category_title }}
                                     {% endblocktrans %}
                                     </a>
                                 {% else %}
-                                    <a href="{% page_url 'courses' %}" class="category-detail__see-more">
+                                    <a href="{% page_url RICHIE_SEARCH_REVERSE_ID %}" class="category-detail__see-more">
                                     {% trans "See all courses" %}
                                     </a>
                                 {% endif %}

diff --git a/src/richie/apps/courses/templates/courses/cms/organization_detail.html b/src/richie/apps/courses/templates/courses/cms/organization_detail.html
@@ -124,7 +124,7 @@ <h2 class="organization-detail__title">{% trans "Related courses" %}</h2>
                         {% if paginator.num_pages > 1 %}
                             {% include "richie/pagination.html" with label=_("Related courses pagination") %}
                             <div class="button-caesura">
-                                <a href="{% page_url 'courses' %}?organizations={{ organization.get_es_id }}" class="organization-detail__see-more">
+                                <a href="{% page_url RICHIE_SEARCH_REVERSE_ID %}?organizations={{ organization.get_es_id }}" class="organization-detail__see-more">
                                     {% blocktrans with organization_title=organization.extended_object.get_title %}
                                         See all courses related to {{ organization_title }}
                                     {% endblocktrans %}

diff --git a/src/richie/apps/courses/templates/courses/cms/person_detail.html b/src/richie/apps/courses/templates/courses/cms/person_detail.html
@@ -133,7 +133,7 @@ <h2 class="person-detail__title">{% trans "Courses" %}</h2>
                             {% if paginator.num_pages > 1 %}
                                 {% include "richie/pagination.html" with label=_("Courses pagination") %}
                                 <div class="button-caesura">
-                                    <a href="{% page_url 'courses' %}?persons={{ person.extended_object_id }}" class="person-detail__see-more">
+                                    <a href="{% page_url RICHIE_SEARCH_REVERSE_ID %}?persons={{ person.extended_object_id }}" class="person-detail__see-more">
                                     {% blocktrans with person_title=person.extended_object.get_title %}
                                         See all courses related to {{ person_title }}
                                     {% endblocktrans %}

diff --git a/src/richie/plugins/large_banner/templates/richie/large_banner/hero-intro.html b/src/richie/plugins/large_banner/templates/richie/large_banner/hero-intro.html
@@ -18,9 +18,9 @@
                 </p>
 
                 <div class="richie-react richie-react--root-search-suggest-field"
-                    data-props='{"courseSearchPageUrl": "{% page_url 'courses' %}"}'></div>
+                    data-props='{"courseSearchPageUrl": "{% page_url RICHIE_SEARCH_REVERSE_ID %}"}'></div>
 
-                <a class="hero-intro__cta" href="{% page_url 'courses' %}">
+                <a class="hero-intro__cta" href="{% page_url RICHIE_SEARCH_REVERSE_ID %}">
                     {% trans "Explore our catalog" %}
                 </a>
             </div>

diff --git a/tests/apps/courses/test_templates_organization_detail.py b/tests/apps/courses/test_templates_organization_detail.py
@@ -283,9 +283,12 @@ def test_templates_organization_detail_cms_published_content(self):
     @mock.patch(
         "cms.templatetags.cms_tags.PageUrl.get_value", return_value="/the/courses/"
     )
-    @override_settings(RICHIE_GLIMPSE_PAGINATION={"courses": 2})
+    @override_settings(
+        RICHIE_GLIMPSE_PAGINATION={"courses": 2},
+        RICHIE_SEARCH_REVERSE_ID="overall-search",
+    )
     def test_templates_organization_detail_cms_published_content_max_courses(
-        self, _mock_page_url
+        self, mock_page_url
     ):
         """
         Make sure the organization detail page does not display too many courses, even when a large
@@ -309,11 +312,21 @@ def test_templates_organization_detail_cms_published_content_max_courses(
         self.assertEqual(organization.get_courses().count(), 3)
 
         # Only the first two are rendered in the template
+        # with mock.patch("cms.templatetags.cms_tags.PageUrl.get_value", return_value="/the/courses/"):
         response = self.client.get(organization.extended_object.get_absolute_url())
         self.assertContains(response, courses[0].extended_object.get_title())
         self.assertContains(response, courses[1].extended_object.get_title())
         self.assertNotContains(response, courses[2].extended_object.get_title())
 
+        self.assertEqual(
+            "overall-search",
+            mock_page_url.call_args[1]["page_lookup"],
+            msg=(
+                "Check if `RICHIE_SEARCH_REVERSE_ID` setting value is used has reverse id "
+                "to find course page search."
+            ),
+        )
+
         # There is a link to view more related courses directly in the Search view
         self.assertContains(
             response, f'href="/the/courses/?organizations={organization.get_es_id():s}"'