Merge pull request #1072 from torchbox/support/wagtail-64-upgrade

nickmoreton · web-flow · commit 78c84343c975 · 2025-04-15T15:39:07.000+01:00
Wagtail 6.4 Upgrade
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,16 +3,16 @@ default_language_version:
   python: python3.11
 repos:
   - repo: https://github.com/python/black
-    rev: 24.10.0
+    rev: 25.1.0
     hooks:
       - id: black
   - repo: https://github.com/PyCQA/isort
-    rev: '5.13.2'
+    rev: '6.0.1'
     hooks:
       - id: isort
   - repo: https://github.com/pycqa/flake8
     # flake8 config is in setup.cfg
-    rev: 7.1.1
+    rev: 7.2.0
     hooks:
       - id: flake8
   - repo: https://github.com/pre-commit/mirrors-eslint
@@ -45,7 +45,7 @@ repos:
           - stylelint@13.13.1
           - stylelint-config-torchbox@1.0.0
   - repo: https://github.com/adamchainz/django-upgrade
-    rev: 1.22.2
+    rev: 1.24.0
     hooks:
       - id: django-upgrade
         args: [--target-version, '4.2'] # Replace with Django version
diff --git a/docs/upgrading.md b/docs/upgrading.md
@@ -106,7 +106,7 @@ As well as testing the critical paths, these areas of functionality should be ch
 
 ### Users who logged in via SSO automatically gets 'Editor' permissions.
 
-1. When users log in via SSO, they are automatically made editors. This is done via `rca.utils.pipeline.make_sso_users_editors` and added to the `SOCIAL_AUTH_PIPELINE`. RCA will manually elevate permissiosn if necessary. 
+1. When users log in via SSO, they are automatically made editors. This is done via `rca.utils.pipeline.make_sso_users_editors` and added to the `SOCIAL_AUTH_PIPELINE`. RCA will manually elevate permissiosn if necessary.
 
 ### Users who logged in via SSO is redirected to a logout confirmation when they logout.
 
@@ -119,26 +119,10 @@ As well as testing the critical paths, these areas of functionality should be ch
 
 The following templates are overridden and should be checked for changes when upgrading Wagtail:
 
-Last checked against Wagtail version: 6.1
+Last checked against Wagtail version: 6.4
 
 - `rca/account_management/templates/wagtailadmin/base.html`
 - `rca/project_styleguide/templates/patterns/pages/auth/login.html` - This was overridden to add the "Sign in with single sign-on" button to the login template.
-- ~~`rca/users/templates/wagtailusers/users/list.html`~~ This template was deleted in 2645c204425b8fa3409a110f46b2822a1953fe49 because as of Wagtail 6.1, [it's no longer used](https://github.com/wagtail/wagtail/commit/7b1644eb37b6b6cf7800276acf9abef5254fc096). Please note that the `user_listing_buttons` template tag was used in this template, and it has since been [deprecated](https://docs.wagtail.org/en/latest/releases/6.1.html#deprecation-of-user-listing-buttons-template-tag).
-
-!!! warning "Technical Debt - to be addressed in Wagtail 6.2"
-
-    The deleted `rca/users/templates/wagtailusers/users/list.html` template did two things:
-
-    1.  altered the "Admin" (now called "Access level") column to show "Yes" if `user.is_superuser`.
-        The default behaviour is to show "Admin" if `user.is_superuser`.
-    2.  added a "Groups" column after the preceding column, whose contents are `{{user.group_links|join:", "}}`
-
-    Retaining the above functionality in Wagtail 6.1 is not a trivial task.
-    There's currently an [open PR](https://github.com/wagtail/wagtail/pull/11952) which
-    seeks to solve this problem, and it may be ready in the 6.2 release.
-
-    **Action**: When upgrading to Wagtail 6.2, look out for the above change, and restore
-    the feature to the way it was before the 6.1 upgrade.
 
 ---
 
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -7,22 +7,21 @@ authors = ["Kevin Howbrook <kevin.howbrook@torchbox.com>"]
 [tool.poetry.dependencies]
 python = "~3.11"
 django = "~4.2"
-wagtail = "~6.3"
+wagtail = "~6.4"
 psycopg2 = "~2.9"
 gunicorn = {version = "~23.0", optional = true}
 
 # Django packages
-django-basic-auth-ip-whitelist = "~0.6"
+django-basic-auth-ip-whitelist = "~0.8"
 django-birdbath = "^2.0.1"
-django-cors-headers = "^4.6.0"
+django-cors-headers = "^4.7.0"
 django-countries = "^7.6.1"
-django-csp = "~3.8"
-django-import-export = "3.3.8" # Note: v4+ has breaking changes
+django-csp = "~4.0"
 # If you update django-import-export, comprehensive testing of the feature should be carried out.
+django-import-export = "3.3.8"  # Note: v4+ has breaking changes
 django-pattern-library = "~1.3.0"
 django-phonenumber-field = {version = "^8.0.0", extras = ["phonenumbers"]}
 django-redis = "~5.4"
-django-referrer-policy = "~1.0"
 django-storages = {version = "~1.14", extras = ["boto3"]}
 dj-database-url = "~2.3"
 
@@ -36,18 +35,18 @@ wagtail-rangefilter = "^0.2.1"
 wagtail-storages = "^2.0"
 
 # Various
-beautifulsoup4 = "^4.12.3"
-coverage = "^7.6.10"
+beautifulsoup4 = "^4.13.3"
+coverage = "^7.8.0"
 freezegun = "^1.5.1"
 html5lib = "^1.1"
-lxml = "^5.3.0"
-scout-apm = "~3.2"
-sentry-sdk = "^2.19.2"
-tblib = "^3.0.0"
+lxml = "^5.3.2"
+scout-apm = "~3.2"  # Not upgrading as scout-apm (3.3.0) depends on urllib3 (>=2.2.0,<2.3.0)
+sentry-sdk = "^2.25.1"
+tblib = "^3.1.0"
 urllib3 = "^2.3.0"
-whitenoise = "^6.8.2"
-social-auth-app-django = "^5.4.2"
-django-xff = "^1.4.0"
+whitenoise = "^6.9.0"
+social-auth-app-django = "^5.4.3"
+django-xff = "^1.5.0"
 
 [tool.poetry.extras]
 gunicorn = ["gunicorn"]
@@ -60,18 +59,18 @@ stellar = "~0.4"
 wagtailmakeup = "^1.1.0"
 
 # Linters etc.
-black = "^24.10.0"
+black = "^25.1.0"
 detect-secrets = "~1.5"
-flake8 = "7.1.1"
-isort = "5.13.2"
-pre-commit = "~4.0"
+flake8 = "7.2.0"
+isort = "6.0.1"
+pre-commit = "~4.2"
 
 # Documentation
 mkdocs = "~1.6"
-mkdocs-material = "~9.5"
-pymdown-extensions = "~10.13"
+mkdocs-material = "~9.6"
+pymdown-extensions = "~10.14"
 honcho = "^2.0.0"
-django-upgrade = "^1.22.2"
+django-upgrade = "^1.24.0"
 pyupgrade = "^3.19.1"
 
 [build-system]
diff --git a/rca/project_styleguide/templates/patterns/molecules/streamfield/blocks/accordion_block.yaml b/rca/project_styleguide/templates/patterns/molecules/streamfield/blocks/accordion_block.yaml
@@ -1,7 +1,7 @@
 context:
   value:
     heading: Unpredictable Knowledge Expander
-    items: 
+    items:
       - heading: Pixel Artistry
         preview_text: Diving into a pixelated universe, reshaping the boundaries of digital canvases
         body: The realm of creations defies conventional borders, blending ancient techniques with digital frontiers. Learners embark on quests of discovery, drawing essence from a spectrum of disciplines, intertwining cutting-edge practices with traditional roots across the expansive corridors of our academy.
@@ -19,4 +19,4 @@ context:
         body: Our musical odyssey is a tapestry of sounds, embracing the silent whispers of the past and the roaring anthems of tomorrow. Participants are the maestros of their journey, orchestrating harmonies that bridge worlds, encouraged by our collective to explore, innovate, and redefine the symphony of life.
         link:
           url: '#'
-          title: 'Orchestrate Your Journey'
+          title: 'Orchestrate Your Journey'
diff --git a/rca/settings/base.py b/rca/settings/base.py
@@ -594,9 +594,9 @@
 
 
 # Referrer-policy header settings.
-# https://django-referrer-policy.readthedocs.io/en/1.0/
+# https://docs.djangoproject.com/en/stable/ref/middleware/#referrer-policy
 
-REFERRER_POLICY = env.get(
+SECURE_REFERRER_POLICY = env.get(
     "SECURE_REFERRER_POLICY", "no-referrer-when-downgrade"
 ).strip()
 
@@ -759,7 +759,10 @@
 
 # The API url to pull content from for the homepage, see rca.api_content.content
 API_CONTENT_BASE_URL = env.get("API_CONTENT_BASE_URL", "https://rca.ac.uk")
-DATA_UPLOAD_MAX_NUMBER_FIELDS = 2000
+
+# Specifies the maximum number of fields allowed in a form submission.
+# https://docs.wagtail.org/en/latest/releases/6.4.html#data-upload-max-number-fields-update
+DATA_UPLOAD_MAX_NUMBER_FIELDS = int(env.get("DATA_UPLOAD_MAX_NUMBER_FIELDS", 10_000))
 
 CACHE_CONTROL_STALE_IF_ERROR = env.get("CACHE_CONTROL_STALE_IF_ERROR", None)
 
diff --git a/rca/settings/test.py b/rca/settings/test.py
@@ -23,3 +23,12 @@
 STORAGES["staticfiles"][  # noqa
     "BACKEND"
 ] = "django.contrib.staticfiles.storage.StaticFilesStorage"
+
+# Resolve tasks immediately
+# https://docs.wagtail.org/en/stable/releases/6.4.html#background-tasks-run-at-end-of-current-transaction
+TASKS = {
+    "default": {
+        "BACKEND": "django_tasks.backends.immediate.ImmediateBackend",
+        "ENQUEUE_ON_COMMIT": False,
+    }
+}
diff --git a/rca/settings/tests/__init__.py b/rca/settings/tests/__init__.py
@@ -0,0 +1,7 @@
+from django.test import TestCase
+
+
+class SecurityHeadersTestCase(TestCase):
+    def test_referrer_policy(self):
+        response = self.client.get("/")
+        self.assertEqual(response["Referrer-Policy"], "no-referrer-when-downgrade")
diff --git a/rca/shortcourses/models.py b/rca/shortcourses/models.py
@@ -377,7 +377,7 @@ def _format_booking_bar(self):
             booking_bar["message"] = "Next course starts"
             booking_bar["date"] = manual_booking.start_date
             booking_bar["action"] = (
-                f"Book from \xA3{manual_booking.cost}"
+                f"Book from \xa3{manual_booking.cost}"
                 if manual_booking.cost
                 else "Book now"
             )
diff --git a/rca/shortcourses/tests/test_models.py b/rca/shortcourses/tests/test_models.py
@@ -169,7 +169,7 @@ def test_manual_dates(self):
         response = self.client.get("/short-course/")
         self.assertContains(
             response,
-            f"Book from \xA3{self.short_course_page.manual_bookings.first().cost}",
+            f"Book from \xa3{self.short_course_page.manual_bookings.first().cost}",
         )
         self.assertContains(response, "Next course starts 1 October 2020")
 
diff --git a/rca/static_src/javascript/components/scholarship-list.js b/rca/static_src/javascript/components/scholarship-list.js
@@ -13,9 +13,9 @@ class ScholarshipList {
 
     // Get the active Scholarship select option
     getActiveOption() {
-        const activeOption = this.programmeChooser.options[
-            this.programmeChooser.selectedIndex
-        ].value;
+        const activeOption =
+            this.programmeChooser.options[this.programmeChooser.selectedIndex]
+                .value;
 
         this.updateJSONdata(activeOption);
     }
diff --git a/rca/static_src/javascript/programmes/components/StudyModeCheckbox.js b/rca/static_src/javascript/programmes/components/StudyModeCheckbox.js
@@ -5,12 +5,8 @@ import { getCourseLengthURL, pushState } from '../programmes.routes';
 import { useStudyMode } from '../context/StudyModeContext';
 
 const ModeCheckbox = ({ ariaLabel }) => {
-    const {
-        isFullTime,
-        setIsFullTime,
-        isPartTime,
-        setIsPartTime,
-    } = useStudyMode();
+    const { isFullTime, setIsFullTime, isPartTime, setIsPartTime } =
+        useStudyMode();
     const [showError, setShowError] = useState(false);
 
     useEffect(() => {
diff --git a/rca/static_src/sass/components/_back-link.scss b/rca/static_src/sass/components/_back-link.scss
@@ -35,7 +35,8 @@
             }
         }
 
-        &:hover, &:focus {
+        &:hover,
+        &:focus {
             span {
                 &::after {
                     width: 100%;
diff --git a/rca/users/viewsets.py b/rca/users/viewsets.py
@@ -1,9 +1,52 @@
+from django.utils.functional import cached_property
+from django.utils.translation import gettext_lazy as _
+from wagtail.admin.ui.tables import Column, StatusTagColumn
+from wagtail.users.views.users import IndexView
 from wagtail.users.views.users import UserViewSet as WagtailUserViewSet
 
+from rca.utils.columns import insert_columns
+
 from .forms import CustomUserEditForm
 
 
+class CustomUserIndexView(IndexView):
+    """
+    Extends UserIndexView to add admin status and group columns before the Status
+    column.
+
+    Reimplements customisation lost as part of the Wagtail 6.1 upgrade
+    (90440d77dab70053be9cec69cb46a4f28b7da38c).
+    """
+
+    @cached_property
+    def columns(self):
+        columns = (
+            StatusTagColumn(
+                "is_superuser",
+                accessor=lambda user: _("Yes") if user.is_superuser else _("No"),
+                primary=lambda user: user.is_superuser,
+                label=_("Admin"),
+                sort_key="is_superuser",
+            ),
+            Column(
+                "Groups",
+                accessor=lambda user: ", ".join(
+                    [group.name for group in user.groups.all()]
+                ),
+                label=_("Groups"),
+            ),
+        )
+
+        return insert_columns(
+            source_columns=super().columns,
+            insert_before_column_ref="Status",
+            columns_to_insert=columns,
+        )
+
+
 class UserViewSet(WagtailUserViewSet):
+    index_view_class = CustomUserIndexView
+
     # This replaces the WAGTAIL_USER_EDIT_FORM
     def get_form_class(self, for_update=False):
         if for_update:
diff --git a/rca/utils/columns.py b/rca/utils/columns.py
@@ -0,0 +1,34 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+    from wagtail.admin.ui.tables import Column
+
+
+def insert_columns(
+    *,
+    source_columns: "Sequence[Column]",
+    insert_before_column_ref: str,
+    columns_to_insert: "Sequence[Column]",
+) -> "list[Column]":
+    """
+    Returns a copy of the given source column, with new column inserted before
+    a given column reference in that copy.
+
+    The `insert_before_column_ref` parameter is a string that identifies the column,
+    either by its `name` or by its `label`.
+    """
+
+    new_columns: "list[Column]" = []
+
+    for column in source_columns:
+        column_heading_values = (
+            getattr(column, "name", None),
+            getattr(column, "label", None),
+        )
+        if insert_before_column_ref in column_heading_values:
+            new_columns.extend(columns_to_insert)
+        new_columns.append(column)
+
+    return new_columns
diff --git a/rca/utils/shorthand.py b/rca/utils/shorthand.py
@@ -160,11 +160,9 @@ def clean(self):
             raise ValidationError(
                 {
                     "shorthand_story_url": ValidationError(
-                        (
-                            "Wagtail cannot find a Shorthand story with the 'Published URL' "
-                            f"value set to {self.shorthand_story_url}). Please update this "
-                            "via the 'Settings' panel for the story, then try again."
-                        )
+                        "Wagtail cannot find a Shorthand story with the 'Published URL' "
+                        f"value set to {self.shorthand_story_url}). Please update this "
+                        "via the 'Settings' panel for the story, then try again."
                     )
                 }
             ) from e

Original file line number	Diff line number	Diff line change
`@@ -377,7 +377,7 @@ def _format_booking_bar(self):`
`377`	`377`	`booking_bar["message"] = "Next course starts"`
`378`	`378`	`booking_bar["date"] = manual_booking.start_date`
`379`	`379`	`booking_bar["action"] = (`
`380`		`- f"Book from \xA3{manual_booking.cost}"`
	`380`	`+ f"Book from \xa3{manual_booking.cost}"`
`381`	`381`	`if manual_booking.cost`
`382`	`382`	`else "Book now"`
`383`	`383`	`)`
Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,7 @@ def test_manual_dates(self):`
`169`	`169`	`response = self.client.get("/short-course/")`
`170`	`170`	`self.assertContains(`
`171`	`171`	`response,`
`172`		`- f"Book from \xA3{self.short_course_page.manual_bookings.first().cost}",`
	`172`	`+ f"Book from \xa3{self.short_course_page.manual_bookings.first().cost}",`
`173`	`173`	`)`
`174`	`174`	`self.assertContains(response, "Next course starts 1 October 2020")`
`175`	`175`