Merge branch 'fix/twe-50-blogpage-related-posts-same-division' into staging

bmispelon · bmispelon · commit 94ec4894eb86 · 2025-03-17T12:27:28.000+01:00
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -64,7 +64,7 @@
 
 - [ ] Images are optimised and lazy-loading used where appropriate
 - [ ] SVGs have been optimised
-- [ ] Perfomance and transfer of data considered
+- [ ] Performance and transfer of data considered
 - [ ] If JavaScript is needed alternatives have been considered
 - [ ] Not required
 
diff --git a/tbx/blog/models.py b/tbx/blog/models.py
@@ -169,8 +169,7 @@ def services(self):
     def tags(self):
         return chain(self.services, self.sectors)
 
-    @cached_property
-    def related_blog_posts(self):
+    def get_related_blog_posts(self):
         prefetch_author_images = models.Prefetch(
             "authors__author__image",
             queryset=CustomImage.objects.prefetch_renditions(
@@ -179,13 +178,8 @@ def related_blog_posts(self):
                 "format-webp|fill-286x286",
             ),
         )
-
-        return (
-            BlogPage.objects.filter(
-                Q(related_sectors__in=self.sectors)
-                | Q(related_services__in=self.services)
-            )
-            .live()
+        queryset = (
+            BlogPage.objects.live()
             .public()
             .defer_streamfields()
             .prefetch_related(
@@ -196,9 +190,28 @@ def related_blog_posts(self):
             )
             .distinct()
             .order_by("-date")
-            .exclude(pk=self.pk)[:3]
+            .exclude(pk=self.pk)
         )
 
+        if final_division := getattr(self, "final_division", None):
+            # Ideally this would be implemented at the database-level but it's
+            # very hard to implement the final_division logic at the ORM level
+            def filter_fn(page):
+                return page.final_division == final_division
+
+            queryset = list(filter(filter_fn, queryset))
+        else:
+            queryset = queryset.filter(
+                Q(related_sectors__in=self.sectors)
+                | Q(related_services__in=self.services)
+            )
+
+        return queryset
+
+    @cached_property
+    def related_blog_posts(self):
+        return self.get_related_blog_posts()[:3]
+
     @cached_property
     def blog_index(self):
         ancestor = BlogIndexPage.objects.ancestor_of(self).order_by("-depth").first()
diff --git a/tbx/blog/tests/test_models.py b/tbx/blog/tests/test_models.py
@@ -1,13 +1,17 @@
+from operator import attrgetter
+
 from django.core.paginator import Page as PaginatorPage
 
 from wagtail.coreutils import get_dummy_request
 from wagtail.models import PageViewRestriction
 from wagtail.test.utils import WagtailPageTestCase
 
 from faker import Faker
+from wagtail_factories import PageFactory
 
 from tbx.blog.factories import BlogIndexPageFactory, BlogPageFactory
 from tbx.blog.models import BlogPage
+from tbx.divisions.factories import DivisionPageFactory
 from tbx.taxonomy.factories import SectorFactory, ServiceFactory
 
 
@@ -59,3 +63,31 @@ def test_create(self):
         )
         self.assertEqual(another_blog_post.related_services.count(), 3)
         self.assertEqual(another_blog_post.related_sectors.count(), 2)
+
+    def test_related_blog_posts_same_division(self):
+        sector = SectorFactory.create()
+        # The logic of `final_division` skips ancestors with depth <= 2,
+        # So we create the division page with enough parents to be at depth 3:
+        division = DivisionPageFactory.create(parent=PageFactory(parent=PageFactory()))
+        blog_post = BlogPageFactory(division=division, related_sectors=[sector])
+        BlogPageFactory(title="same sector", division=None, related_sectors=[sector])
+        BlogPageFactory(
+            title="same division (direct)", division=division, related_sectors=[]
+        )
+        BlogPageFactory(
+            title="same division (direct) same sector",
+            division=division,
+            related_sectors=[sector],
+        )
+        BlogPageFactory(title="same division (parent)", parent=division)
+
+        self.assertQuerySetEqual(
+            blog_post.related_blog_posts,
+            [
+                "same division (direct)",
+                "same division (direct) same sector",
+                "same division (parent)",
+            ],
+            transform=attrgetter("title"),
+            ordered=False,
+        )
diff --git a/tbx/project_styleguide/templates/patterns/molecules/carbon-impact/carbon-impact.html b/tbx/project_styleguide/templates/patterns/molecules/carbon-impact/carbon-impact.html
@@ -4,7 +4,7 @@
     <div class="grid">
         <div class="grid__carbon-impact">
             <div class="footer__carbon-impact">
-                <p class="footer__carbon-impact-text">Loading the site homepage emits just <span>0.07g of CO2</span> per view.</p>
+                <p class="footer__carbon-impact-text">Loading the site homepage emits just <span>0.02g of CO2</span> per view.</p>
                 {% if CARBON_EMISSIONS_PAGE %}
                     <p class="footer__carbon-impact-text">
                         <a href="{% pageurl CARBON_EMISSIONS_PAGE %}" class="footer__carbon-impact-link">Find out more about our carbon impact</a>
diff --git a/tbx/work/models.py b/tbx/work/models.py
@@ -298,8 +298,7 @@ def header_image_alt_text(self):
             return header_alt_text
         return self.header_image.title
 
-    @property
-    def related_works(self):
+    def get_related_works(self):
         prefetch_listing_images = models.Prefetch(
             "header_image",
             queryset=CustomImage.objects.prefetch_renditions(
@@ -310,23 +309,38 @@ def related_works(self):
             ),
         )
 
-        # get 3 pages with same services and exclude self page
-        return (
-            WorkPage.objects.filter(
-                Q(related_sectors__in=self.sectors)
-                | Q(related_services__in=self.services)
-            )
-            .live()
+        queryset = (
+            WorkPage.objects.live()
             .public()
             .defer_streamfields()
             .prefetch_related(
                 "related_sectors", "related_services", prefetch_listing_images
             )
             .distinct()
             .order_by(F("date").desc(nulls_last=True))
-            .exclude(pk=self.pk)[:3]
+            .exclude(pk=self.pk)
         )
 
+        if final_division := getattr(self, "final_division", None):
+            # Ideally this would be implemented at the database-level but it's
+            # very hard to implement the final_division logic at the ORM level
+            def filter_fn(page):
+                return page.final_division == final_division
+
+            queryset = list(filter(filter_fn, queryset))
+        else:
+            queryset = queryset.filter(
+                Q(related_sectors__in=self.sectors)
+                | Q(related_services__in=self.services)
+            )
+
+        return queryset
+
+    @cached_property
+    def related_works(self):
+        # get 3 pages with same services and exclude self page
+        return self.get_related_works()[:3]
+
     def set_body_word_count(self):
         body_basic_html = self.body.stream_block.render_basic(self.body)
         body_text = BeautifulSoup(body_basic_html, "html.parser").get_text()
diff --git a/tbx/work/tests/test_models.py b/tbx/work/tests/test_models.py
@@ -1,10 +1,15 @@
+from operator import attrgetter
+
 from django.core.paginator import Page as PaginatorPage
 
 from wagtail.coreutils import get_dummy_request
 from wagtail.models import PageViewRestriction
 from wagtail.test.utils import WagtailPageTestCase
 
-from tbx.taxonomy.factories import ServiceFactory
+from wagtail_factories import PageFactory
+
+from tbx.divisions.factories import DivisionPageFactory
+from tbx.taxonomy.factories import SectorFactory, ServiceFactory
 from tbx.work.factories import (
     HistoricalWorkPageFactory,
     WorkIndexPageFactory,
@@ -55,6 +60,36 @@ def test_create(self):
         self.assertEqual(another_page.related_services.count(), 3)
 
 
+class TestWorkPage(WagtailPageTestCase):
+    def test_related_works(self):
+        sector = SectorFactory.create()
+        # The logic of `final_division` skips ancestors with depth <= 2,
+        # So we create the division page with enough parents to be at depth 3:
+        division = DivisionPageFactory.create(parent=PageFactory(parent=PageFactory()))
+        work_page = WorkPageFactory(division=division, related_sectors=[sector])
+        WorkPageFactory(title="same sector", division=None, related_sectors=[sector])
+        WorkPageFactory(
+            title="same division (direct)", division=division, related_sectors=[]
+        )
+        WorkPageFactory(
+            title="same division (direct) same sector",
+            division=division,
+            related_sectors=[sector],
+        )
+        WorkPageFactory(title="same division (parent)", parent=division)
+
+        self.assertQuerySetEqual(
+            work_page.related_works,
+            [
+                "same division (direct)",
+                "same division (direct) same sector",
+                "same division (parent)",
+            ],
+            transform=attrgetter("title"),
+            ordered=False,
+        )
+
+
 class TestWorkPageFactory(WagtailPageTestCase):
     def test_create(self):
         page = WorkPageFactory()
