Change codelist sort order on user pages #3003

Author: tomodwyer

opencodelists/tests/views/test_user.py

@@ -69,8 +69,8 @@ def test_user_codelists(
         for version in codelist["versions"]
         if version.is_draft
     ] == [
-        codelist.versions.first().id,
         organisation_codelist.versions.first().id,
+        codelist.versions.first().id,
     ]
 
     # make org codelist under-review
@@ -144,3 +144,89 @@ def test_user_codelists(
         org_codelist_version_id,
         user_codelist_version_id,
     ]
+
+
+def test_user_codelists_sort_user_first(
+    client,
+    user,
+    organisation,
+    codelist_from_scratch,
+    user_codelist_from_scratch,
+):
+    # Give both codelists the same name (case-insensitive), one user-owned and one org-owned
+    update_codelist(
+        codelist=user_codelist_from_scratch,
+        owner=user,
+        name="alpha list",
+        slug="alpha-list-user",
+        description=user_codelist_from_scratch.description,
+        methodology=user_codelist_from_scratch.methodology,
+        references={},
+        signoffs={},
+    )
+    update_codelist(
+        codelist=codelist_from_scratch,
+        owner=organisation,
+        name="ALPHA LIST",
+        slug="alpha-list-org",
+        description=codelist_from_scratch.description,
+        methodology=codelist_from_scratch.methodology,
+        references={},
+        signoffs={},
+    )
+
+    client.force_login(user)
+    response = client.get(reverse("user", args=(user.username,)))
+
+    matching_codelists = [
+        codelist["codelist"]
+        for codelist in response.context["all_codelists"]
+        if codelist["codelist"].name.casefold() == "alpha list"
+    ]
+    assert [codelist.owner for codelist in matching_codelists] == [user, organisation]
+
+
+def test_published_codelists_sorted_same_as_all_codelists(
+    client,
+    user,
+    user_codelist,
+    user_codelist_from_scratch,
+):
+    update_codelist(
+        codelist=user_codelist,
+        owner=user,
+        name="zeta list",
+        slug="zeta-list",
+        description=user_codelist.description,
+        methodology=user_codelist.methodology,
+        references={},
+        signoffs={},
+    )
+    update_codelist(
+        codelist=user_codelist_from_scratch,
+        owner=user,
+        name="ALPHA LIST",
+        slug="alpha-list",
+        description=user_codelist_from_scratch.description,
+        methodology=user_codelist_from_scratch.methodology,
+        references={},
+        signoffs={},
+    )
+    save_for_review(draft=user_codelist_from_scratch.versions.first())
+    publish_version(version=user_codelist_from_scratch.versions.last())
+
+    client.force_login(user)
+    response = client.get(reverse("user", args=(user.username,)))
+
+    codelist_ids = {user_codelist.id, user_codelist_from_scratch.id}
+    all_codelist_ids = [
+        codelist["codelist"].id
+        for codelist in response.context["all_codelists"]
+        if codelist["codelist"].id in codelist_ids
+    ]
+    published_codelist_ids = [
+        version.codelist.id
+        for version in response.context["published_codelists"]
+        if version.codelist.id in codelist_ids
+    ]
+    assert published_codelist_ids == all_codelist_ids

opencodelists/views/user.py

@@ -1,13 +1,28 @@
+from datetime import datetime
+
 from django.shortcuts import get_object_or_404, render
 
-from codelists.models import Status
+from codelists.models import Codelist, Status
 
 from ..models import User
 
 
 def user(request, username):
     user = get_object_or_404(User, username=username)
 
+    def codelist_sort_key(codelist: Codelist) -> tuple[str, bool, str, datetime]:
+        """
+        We sort by name, then owner, then date (all case-insensitive where applicable),
+        while making sure the current user's codelists appear before organisation ones
+        when names are the same.
+        """
+        return (
+            codelist.name.casefold(),
+            codelist.owner != user,
+            str(codelist.owner).casefold(),
+            codelist.updated_at,
+        )
+
     # Find all of the codelists owned (in their current version) by this user with at least one published version.
     owned_codelists = user.codelists.filter(
         versions__status=Status.PUBLISHED
@@ -38,11 +53,7 @@ def user(request, username):
                 else []
             ),
         }
-        for codelist in sorted(
-            codelists_to_display, key=lambda x: (x.owner != user, str(x.owner), x.name)
-        )
-        # We sort first by owner, then by name - but making sure that the current user's
-        # codelists always come first
+        for codelist in sorted(codelists_to_display, key=codelist_sort_key)
         # We can't use a queryset order_by (where versions_under_review/drafts are querysets of CodelistVersion
         # instances), as a codelist can have multiple versions and multiple handles, and this results in duplicates
         # in the returned queryset. See https://code.djangoproject.com/ticket/18165
@@ -52,10 +63,8 @@ def user(request, username):
         "user": user,
         "published_codelists": [
             codelist.latest_published_version()
-            for codelist in owned_codelists.order_by("handles__name")
+            for codelist in sorted(owned_codelists, key=codelist_sort_key)
         ],
-        # note that name is a property on a codelist, not an attribute, and it comes from the current handle.
-        # If we want to order codelists or versions by codelist name, we actually need to order them by handle name.
         "all_codelists": all_codelists,
     }