Implement board member details as snippet #1189

hancush · 2024-12-20T17:58:42Z

Overview

This PR adds a Django model for board member headshots and bios and registers as a snippet for editing in the CMS. It also deprecates the headshot_url property, instead creating a shared template block that renders the right thing given a person instance and, optionally, a way to request the original aspect ratio, instead of a square thumbnail.

Connects #1176

Demo

Notes

I decided to go ahead and implement this as a snippet, since the modeladmin module is deprecated in the next version of Wagtail, so using snippets now makes our migration path easier moving forward. I'm wondering if we might want to do this in #1185, too. https://docs.wagtail.org/en/v5.2.1/reference/contrib/modeladmin/migrating_to_snippets.html

Testing Instructions

Log into the review app, then check out the Board Member Details section of the CMS.
Try some filters and verify they work as expected.
Try editing some headshots and bios. Confirm the previews render correctly.
Publish some of your edits. Confirm the changes are visible on the live site.

hancush · 2024-12-20T18:00:46Z

lametro/signals/handlers.py

+from lametro.models import LAMetroPerson, BoardMemberDetails
+
+
+@receiver(post_save, sender=LAMetroPerson)


Will handle instantiating details for new members moving forward. To backfill, we simply need to call save on all existing board members.

The review app didn't have any board members listed in the cms to start, but saving Najarian in the shell got him listed, just like you're describing!

Would it make sense to perform this save for all existing members in the new migration in this pr? That way it wouldn't have to be a manual step for staging and production when this gets pushed

hancush · 2024-12-20T18:01:33Z

lametro/models/cms.py

+    _revisions = GenericRelation(
+        "wagtailcore.Revision", related_query_name="member_details"
+    )
+
+    @property
+    def revisions(self):
+        return self._revisions


https://docs.wagtail.org/en/v5.2.7/topics/snippets/features.html#saving-draft-changes-of-snippets

hancush · 2024-12-20T18:03:42Z

lametro/models/cms.py

+        council_post = self.person.latest_council_membership.post
+        context["qualifying_post"] = council_post.acting_label
+
+        context["preview"] = True


The map and committee/board report modules require a bunch of extra context, so I use this to purposefully omit them from page previews. (I also added a note to the admin interface.)

The map currently isn't showing up on the non-preview version of the person detail page. This might be because it's on a review app that doesn't have access to map_geojson but wanted to make sure!

hancush · 2024-12-20T18:06:24Z

lametro/templates/snippets/related_object_status_tag.html

@@ -0,0 +1,4 @@
+{% load wagtailadmin_tags %}


More or less stolen from the Wagtail source code, to make the status icon in the board member details snippet list link to the person detail page.

hancush · 2024-12-20T18:08:56Z

lametro/wagtail_hooks.py

+        return user.has_perm(self._get_permission_name(action))
+
+
+class BoardMemberFilterSet(django_filters.FilterSet):


This is a django-filter filter set, which I'm using to add custom filters for whether a person is a current board member and what body they belong to, on the board member detail snippet listing page.

hancush · 2024-12-20T18:09:21Z

lametro/wagtail_hooks.py

+            HelpPanel(
+                content=(
+                    "<p>On this page, you can manage a board member's headshot and "
+                    "bio. All other details and relationships, e.g., memberships, "
+                    "should be managed in Legistar.</p>"
+                    "<p><strong>Note:</strong> The page preview excludes "
+                    "the map and committee and board report modules displayed "
+                    "on the live page.</p>"
+                )
+            ),


This makes sense. And omitting those extra bits of context should help keep the preview lightweight which is a good call!

hancush · 2024-12-20T18:10:07Z

lametro/wagtail_hooks.py

+register_snippet(BoardMemberDetailsViewSet)
+
+
+class UserBarLink:


I pulled some reusable things out of the model admin link so I could also use them for the snippet edit link.

hancush · 2024-12-20T18:10:57Z

lametro/wagtail_hooks.py

+        finder = AdminURLFinder()
+        return finder.get_edit_url(snippet)


TIL! https://docs.wagtail.org/en/latest/extending/admin_views.html#adminurlfinder

Convenient!

xmedr

This looks really cool so far! Got a few a questions and comments below, but the status links and "edit this page" links work exactly as expected, and the whole editing process is smooth.

xmedr · 2025-01-07T17:21:39Z

lametro/models/cms.py

+        loaded_obj = (
+            type(self)
+            .objects.select_related("person")
+            .prefetch_related("person__memberships")
+            .get(id=self.id)
+        )
+        return f"{loaded_obj.person.name}{' (current)' if loaded_obj.person.current_memberships.exists() else ''}"


Ah TIL, this is cool! A neat way to reduce the number of queries.

When do you personally like to use these select_related and prefetch_related? Because I imagine this would be useful in most cases where we know we want to grab some related objects, but I'd also think it'd be more nuanced than that.

xmedr · 2025-01-07T18:04:16Z

lametro/wagtail_hooks.py

+            HelpPanel(
+                content=(
+                    "<p>On this page, you can manage a board member's headshot and "
+                    "bio. All other details and relationships, e.g., memberships, "
+                    "should be managed in Legistar.</p>"
+                    "<p><strong>Note:</strong> The page preview excludes "
+                    "the map and committee and board report modules displayed "
+                    "on the live page.</p>"
+                )
+            ),


This makes sense. And omitting those extra bits of context should help keep the preview lightweight which is a good call!

xmedr · 2025-01-07T18:10:49Z

lametro/wagtail_hooks.py

+        finder = AdminURLFinder()
+        return finder.get_edit_url(snippet)


Convenient!

xmedr · 2025-01-07T19:56:36Z

lametro/signals/handlers.py

+from lametro.models import LAMetroPerson, BoardMemberDetails
+
+
+@receiver(post_save, sender=LAMetroPerson)


The review app didn't have any board members listed in the cms to start, but saving Najarian in the shell got him listed, just like you're describing!

Would it make sense to perform this save for all existing members in the new migration in this pr? That way it wouldn't have to be a manual step for staging and production when this gets pushed

xmedr · 2025-01-07T20:45:30Z

lametro/models/cms.py

+        council_post = self.person.latest_council_membership.post
+        context["qualifying_post"] = council_post.acting_label
+
+        context["preview"] = True


The map currently isn't showing up on the non-preview version of the person detail page. This might be because it's on a review app that doesn't have access to map_geojson but wanted to make sure!

Implement board member details as snippet

fb66d1e

hancush commented Dec 20, 2024

View reviewed changes

fgregg temporarily deployed to la-metro-cou-hcg-board--5h63zw December 20, 2024 18:02 Inactive

hancush commented Dec 20, 2024

View reviewed changes

Clean up unused code

de9fd7f

hancush temporarily deployed to la-metro-cou-hcg-board--5h63zw January 6, 2025 21:08 Inactive

Add lametro/apps.py

1e17165

hancush deployed to la-metro-cou-hcg-board--5h63zw January 6, 2025 21:49 View deployment

hancush requested a review from xmedr January 6, 2025 22:13

hancush marked this pull request as ready for review January 6, 2025 22:14

antidipyramid mentioned this pull request Jan 7, 2025

Create pattern for managing instance-specific content on detail pages #1176

Open

xmedr requested changes Jan 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement board member details as snippet #1189

Implement board member details as snippet #1189

hancush commented Dec 20, 2024 •

edited

Loading

hancush Dec 20, 2024

xmedr Jan 7, 2025

hancush Dec 20, 2024

hancush Dec 20, 2024

xmedr Jan 7, 2025

hancush Dec 20, 2024

hancush Dec 20, 2024

hancush Dec 20, 2024

xmedr Jan 7, 2025

hancush Dec 20, 2024

hancush Dec 20, 2024

xmedr Jan 7, 2025

xmedr left a comment

xmedr Jan 7, 2025

xmedr Jan 7, 2025

xmedr Jan 7, 2025

xmedr Jan 7, 2025

xmedr Jan 7, 2025

		from lametro.models import LAMetroPerson, BoardMemberDetails


		@receiver(post_save, sender=LAMetroPerson)

		return user.has_perm(self._get_permission_name(action))


		class BoardMemberFilterSet(django_filters.FilterSet):

		register_snippet(BoardMemberDetailsViewSet)


		class UserBarLink:

		finder = AdminURLFinder()
		return finder.get_edit_url(snippet)

Implement board member details as snippet #1189

Are you sure you want to change the base?

Implement board member details as snippet #1189

Conversation

hancush commented Dec 20, 2024 • edited Loading

Overview

Demo

Notes

Testing Instructions

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xmedr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hancush commented Dec 20, 2024 •

edited

Loading