feat(userlist): add sortable columns to User List

2025-12-24 02:39:18 -05:00 · 2025-04-28 19:45:50 +02:00
parent 049bc59d2d
commit 1dbacec4f9
4 changed files with 181 additions and 49 deletions
--- a/jellyseerr-api.yml
+++ b/jellyseerr-api.yml
@@ -3909,8 +3909,14 @@ paths:
          name: sort
          schema:
            type: string
-            enum: [created, updated, requests, displayname]
+            enum: [created, updated, requests, displayname, usertype, role]
            default: created
+        - in: query
+          name: sortDirection
+          schema:
+            type: string
+            enum: [asc, desc]
+            default: desc
        - in: query
          name: q
          required: false
--- a/server/routes/user/index.ts
+++ b/server/routes/user/index.ts
@@ -42,6 +42,9 @@ router.get('/', async (req, res, next) => {
      : Math.max(10, includeIds.length);
    const skip = req.query.skip ? Number(req.query.skip) : 0;
    const q = req.query.q ? req.query.q.toString().toLowerCase() : '';
+    const sortDirection =
+      (req.query.sortDirection as string) === 'asc' ? 'ASC' : 'DESC';
+
    let query = getRepository(User).createQueryBuilder('user');

    if (q) {
@@ -56,28 +59,31 @@ router.get('/', async (req, res, next) => {
    }

    switch (req.query.sort) {
+      case 'created':
+        query = query.orderBy('user.createdAt', sortDirection);
+        break;
      case 'updated':
-        query = query.orderBy('user.updatedAt', 'DESC');
+        query = query.orderBy('user.updatedAt', sortDirection);
        break;
      case 'displayname':
        query = query
          .addSelect(
            `CASE WHEN (user.username IS NULL OR user.username = '') THEN (
-              CASE WHEN (user.plexUsername IS NULL OR user.plexUsername = '') THEN (
-                CASE WHEN (user.jellyfinUsername IS NULL OR user.jellyfinUsername = '') THEN
-                  "user"."email"
+                CASE WHEN (user.plexUsername IS NULL OR user.plexUsername = '') THEN (
+                  CASE WHEN (user.jellyfinUsername IS NULL OR user.jellyfinUsername = '') THEN
+                    "user"."email"
+                  ELSE
+                    LOWER(user.jellyfinUsername)
+                  END)
                ELSE
-                  LOWER(user.jellyfinUsername)
+                  LOWER(user.plexUsername)
                END)
              ELSE
-                LOWER(user.jellyfinUsername)
-              END)
-            ELSE
-              LOWER(user.username)
-            END`,
+                LOWER(user.username)
+              END`,
            'displayname_sort_key'
          )
-          .orderBy('displayname_sort_key', 'ASC');
+          .orderBy('displayname_sort_key', sortDirection);
        break;
      case 'requests':
        query = query
@@ -87,10 +93,16 @@ router.get('/', async (req, res, next) => {
              .from(MediaRequest, 'request')
              .where('request.requestedBy.id = user.id');
          }, 'request_count')
-          .orderBy('request_count', 'DESC');
+          .orderBy('request_count', sortDirection);
+        break;
+      case 'usertype':
+        query = query.orderBy('user.userType', sortDirection);
+        break;
+      case 'role':
+        query = query.orderBy('user.permissions', sortDirection);
        break;
      default:
-        query = query.orderBy('user.id', 'ASC');
+        query = query.orderBy('user.id', sortDirection);
        break;
    }

--- a/src/components/UserList/index.tsx
+++ b/src/components/UserList/index.tsx
@@ -18,9 +18,10 @@ import globalMessages from '@app/i18n/globalMessages';
 import defineMessages from '@app/utils/defineMessages';
 import { Transition } from '@headlessui/react';
 import {
-  BarsArrowDownIcon,
+  ChevronDownIcon,
  ChevronLeftIcon,
  ChevronRightIcon,
+  ChevronUpIcon,
  InboxArrowDownIcon,
  PencilIcon,
  UserPlusIcon,
@@ -77,6 +78,15 @@ const messages = defineMessages('components.UserList', {
  autogeneratepasswordTip: 'Email a server-generated password to the user',
  validationUsername: 'You must provide an username',
  validationEmail: 'Email required',
+  sortBy: 'Sort by {field}',
+  sortByUser: 'Sort by username',
+  sortByRequests: 'Sort by number of requests',
+  sortByType: 'Sort by account type',
+  sortByRole: 'Sort by user role',
+  sortByJoined: 'Sort by join date',
+  toggleSortDirection: 'Click again to sort {direction}',
+  ascending: 'ascending',
+  descending: 'descending',
  sortCreated: 'Join Date',
  sortDisplayName: 'Display Name',
  sortRequests: 'Request Count',
@@ -84,7 +94,14 @@ const messages = defineMessages('components.UserList', {
    'The <strong>Enable Local Sign-In</strong> setting is currently disabled.',
 });

-type Sort = 'created' | 'updated' | 'requests' | 'displayname';
+type Sort =
+  | 'created'
+  | 'updated'
+  | 'requests'
+  | 'displayname'
+  | 'usertype'
+  | 'role';
+type SortDirection = 'asc' | 'desc';

 const UserList = () => {
  const intl = useIntl();
@@ -98,6 +115,7 @@ const UserList = () => {
  const page = router.query.page ? Number(router.query.page) : 1;
  const pageIndex = page - 1;
  const updateQueryParams = useUpdateQueryParams({ page: page.toString() });
+  const [sortDirection, setSortDirection] = useState<SortDirection>('desc');

  const {
    data,
@@ -106,9 +124,18 @@ const UserList = () => {
  } = useSWR<UserResultsResponse>(
    `/api/v1/user?take=${currentPageSize}&skip=${
      pageIndex * currentPageSize
-    }&sort=${currentSort}`
+    }&sort=${currentSort}&sortDirection=${sortDirection}`
  );

+  const handleSortChange = (sortKey: Sort) => {
+    if (currentSort === sortKey) {
+      setSortDirection(sortDirection === 'asc' ? 'desc' : 'asc');
+    } else {
+      setCurrentSort(sortKey);
+      setSortDirection('desc');
+    }
+  };
+
  const [isDeleting, setDeleting] = useState(false);
  const [showImportModal, setShowImportModal] = useState(false);
  const [deleteModal, setDeleteModal] = useState<{
@@ -133,6 +160,9 @@ const UserList = () => {

      setCurrentSort(filterSettings.currentSort);
      setCurrentPageSize(filterSettings.currentPageSize);
+      if (filterSettings.sortDirection) {
+        setSortDirection(filterSettings.sortDirection);
+      }
    }
  }, []);

@@ -142,9 +172,74 @@ const UserList = () => {
      JSON.stringify({
        currentSort,
        currentPageSize,
+        sortDirection,
      })
    );
-  }, [currentSort, currentPageSize]);
+  }, [currentSort, currentPageSize, sortDirection]);
+
+  const SortableColumnHeader = ({
+    sortKey,
+    currentSort,
+    sortDirection,
+    onSortChange,
+    children,
+  }: {
+    sortKey: Sort;
+    currentSort: Sort;
+    sortDirection: SortDirection;
+    onSortChange: (sortKey: Sort) => void;
+    children: React.ReactNode;
+  }) => {
+    const intl = useIntl();
+
+    const getTooltip = () => {
+      if (currentSort === sortKey) {
+        return intl.formatMessage(messages.toggleSortDirection, {
+          direction:
+            sortDirection === 'asc'
+              ? intl.formatMessage(messages.descending)
+              : intl.formatMessage(messages.ascending),
+        });
+      }
+
+      switch (sortKey) {
+        case 'displayname':
+          return intl.formatMessage(messages.sortByUser);
+        case 'requests':
+          return intl.formatMessage(messages.sortByRequests);
+        case 'usertype':
+          return intl.formatMessage(messages.sortByType);
+        case 'role':
+          return intl.formatMessage(messages.sortByRole);
+        case 'created':
+          return intl.formatMessage(messages.sortByJoined);
+        default:
+          return intl.formatMessage(messages.sortBy, { field: sortKey });
+      }
+    };
+
+    return (
+      <Table.TH
+        className="cursor-pointer hover:bg-gray-700"
+        onClick={() => onSortChange(sortKey)}
+        data-testid={`column-header-${sortKey}`}
+        title={getTooltip()}
+      >
+        <div className="flex items-center">
+          <span>{children}</span>
+          {currentSort === sortKey && (
+            <span className="ml-1">
+              {sortDirection === 'asc' ? (
+                <ChevronUpIcon className="h-4 w-4" />
+              ) : (
+                <ChevronDownIcon className="h-4 w-4" />
+              )}
+            </span>
+          )}
+        </div>
+      </Table.TH>
+    );
+  };

  const isUserPermsEditable = (userId: number) =>
    userId !== 1 && userId !== currentUser?.id;
@@ -519,7 +614,7 @@ const UserList = () => {
              <span>{intl.formatMessage(messages.createlocaluser)}</span>
            </Button>
            <Button
-              className="flex-grow lg:mr-2"
+              className="flex-grow"
              buttonType="primary"
              onClick={() => setShowImportModal(true)}
            >
@@ -541,31 +636,6 @@ const UserList = () => {
              </span>
            </Button>
          </div>
-          <div className="mb-2 flex flex-grow lg:mb-0 lg:flex-grow-0">
-            <span className="inline-flex cursor-default items-center rounded-l-md border border-r-0 border-gray-500 bg-gray-800 px-3 text-sm text-gray-100">
-              <BarsArrowDownIcon className="h-6 w-6" />
-            </span>
-            <select
-              id="sort"
-              name="sort"
-              onChange={(e) => {
-                setCurrentSort(e.target.value as Sort);
-                router.push(router.pathname);
-              }}
-              value={currentSort}
-              className="rounded-r-only"
-            >
-              <option value="created">
-                {intl.formatMessage(messages.sortCreated)}
-              </option>
-              <option value="requests">
-                {intl.formatMessage(messages.sortRequests)}
-              </option>
-              <option value="displayname">
-                {intl.formatMessage(messages.sortDisplayName)}
-              </option>
-            </select>
-          </div>
        </div>
      </div>
      <Table>
@@ -584,11 +654,46 @@ const UserList = () => {
                />
              )}
            </Table.TH>
-            <Table.TH>{intl.formatMessage(messages.user)}</Table.TH>
-            <Table.TH>{intl.formatMessage(messages.totalrequests)}</Table.TH>
-            <Table.TH>{intl.formatMessage(messages.accounttype)}</Table.TH>
-            <Table.TH>{intl.formatMessage(messages.role)}</Table.TH>
-            <Table.TH>{intl.formatMessage(messages.created)}</Table.TH>
+            <SortableColumnHeader
+              sortKey="displayname"
+              currentSort={currentSort}
+              sortDirection={sortDirection}
+              onSortChange={handleSortChange}
+            >
+              {intl.formatMessage(messages.user)}
+            </SortableColumnHeader>
+            <SortableColumnHeader
+              sortKey="requests"
+              currentSort={currentSort}
+              sortDirection={sortDirection}
+              onSortChange={handleSortChange}
+            >
+              {intl.formatMessage(messages.totalrequests)}
+            </SortableColumnHeader>
+            <SortableColumnHeader
+              sortKey="usertype"
+              currentSort={currentSort}
+              sortDirection={sortDirection}
+              onSortChange={handleSortChange}
+            >
+              {intl.formatMessage(messages.accounttype)}
+            </SortableColumnHeader>
+            <SortableColumnHeader
+              sortKey="role"
+              currentSort={currentSort}
+              sortDirection={sortDirection}
+              onSortChange={handleSortChange}
+            >
+              {intl.formatMessage(messages.role)}
+            </SortableColumnHeader>
+            <SortableColumnHeader
+              sortKey="created"
+              currentSort={currentSort}
+              sortDirection={sortDirection}
+              onSortChange={handleSortChange}
+            >
+              {intl.formatMessage(messages.created)}
+            </SortableColumnHeader>
            <Table.TH className="text-right">
              {(data.results ?? []).length > 1 && (
                <Button
--- a/src/i18n/locale/en.json
+++ b/src/i18n/locale/en.json
@@ -1282,6 +1282,7 @@
  "components.TvDetails.watchtrailer": "Watch Trailer",
  "components.UserList.accounttype": "Type",
  "components.UserList.admin": "Admin",
+  "components.UserList.ascending": "ascending",
  "components.UserList.autogeneratepassword": "Automatically Generate Password",
  "components.UserList.autogeneratepasswordTip": "Email a server-generated password to the user",
  "components.UserList.bulkedit": "Bulk Edit",
@@ -1291,6 +1292,7 @@
  "components.UserList.creating": "Creating…",
  "components.UserList.deleteconfirm": "Are you sure you want to delete this user? All of their request data will be permanently removed.",
  "components.UserList.deleteuser": "Delete User",
+  "components.UserList.descending": "descending",
  "components.UserList.edituser": "Edit User Permissions",
  "components.UserList.email": "Email Address",
  "components.UserList.importedfromJellyfin": "<strong>{userCount}</strong> {mediaServerName} {userCount, plural, one {user} other {users}} imported successfully!",
@@ -1312,9 +1314,16 @@
  "components.UserList.passwordinfodescription": "Configure an application URL and enable email notifications to allow automatic password generation.",
  "components.UserList.plexuser": "Plex User",
  "components.UserList.role": "Role",
+  "components.UserList.sortBy": "Sort by {field}",
+  "components.UserList.sortByJoined": "Sort by join date",
+  "components.UserList.sortByRequests": "Sort by number of requests",
+  "components.UserList.sortByRole": "Sort by user role",
+  "components.UserList.sortByType": "Sort by account type",
+  "components.UserList.sortByUser": "Sort by username",
  "components.UserList.sortCreated": "Join Date",
  "components.UserList.sortDisplayName": "Display Name",
  "components.UserList.sortRequests": "Request Count",
+  "components.UserList.toggleSortDirection": "Click again to sort {direction}",
  "components.UserList.totalrequests": "Requests",
  "components.UserList.user": "User",
  "components.UserList.usercreatedfailed": "Something went wrong while creating the user.",