fix(graphql): sort by multiple fields (#14486)

r1tsuu · web-flow · commit b925d3474020 · 2025-11-07T10:00:39.000-05:00
Fixes handling of the [sort by multiple fields] feature (#8799) for GraphQL, now you can specify `query { Posts(sort: "field1, field2") ..` Closes #14450.
diff --git a/packages/graphql/src/resolvers/collections/find.ts b/packages/graphql/src/resolvers/collections/find.ts
@@ -29,8 +29,12 @@ export type Resolver = (
 
 export function findResolver(collection: Collection): Resolver {
   return async function resolver(_, args, context, info) {
-    const req = context.req = isolateObjectProperty(context.req, ['locale', 'fallbackLocale', 'transactionID'])
-    const select = context.select = args.select ? buildSelectForCollectionMany(info) : undefined
+    const req = (context.req = isolateObjectProperty(context.req, [
+      'locale',
+      'fallbackLocale',
+      'transactionID',
+    ]))
+    const select = (context.select = args.select ? buildSelectForCollectionMany(info) : undefined)
 
     req.locale = args.locale || req.locale
     req.fallbackLocale = args.fallbackLocale || req.fallbackLocale
@@ -46,6 +50,8 @@ export function findResolver(collection: Collection): Resolver {
       req.query.draft = String(draft)
     }
 
+    const { sort } = args
+
     const options = {
       collection,
       depth: 0,
@@ -55,7 +61,7 @@ export function findResolver(collection: Collection): Resolver {
       pagination: args.pagination,
       req,
       select,
-      sort: args.sort,
+      sort: typeof sort === 'string' ? sort.split(',') : undefined,
       trash: args.trash,
       where: args.where,
     }
diff --git a/packages/graphql/src/resolvers/collections/findVersions.ts b/packages/graphql/src/resolvers/collections/findVersions.ts
@@ -27,8 +27,12 @@ export type Resolver = (
 
 export function findVersionsResolver(collection: Collection): Resolver {
   return async function resolver(_, args, context, info) {
-    const req = context.req = isolateObjectProperty(context.req, ['locale', 'fallbackLocale', 'transactionID'])
-    const select = context.select = args.select ? buildSelectForCollectionMany(info) : undefined
+    const req = (context.req = isolateObjectProperty(context.req, [
+      'locale',
+      'fallbackLocale',
+      'transactionID',
+    ]))
+    const select = (context.select = args.select ? buildSelectForCollectionMany(info) : undefined)
 
     req.locale = args.locale || req.locale
     req.fallbackLocale = args.fallbackLocale || req.fallbackLocale
@@ -44,6 +48,8 @@ export function findVersionsResolver(collection: Collection): Resolver {
       req.query.draft = String(draft)
     }
 
+    const { sort } = args
+
     const options = {
       collection,
       depth: 0,
@@ -52,7 +58,7 @@ export function findVersionsResolver(collection: Collection): Resolver {
       pagination: args.pagination,
       req,
       select,
-      sort: args.sort,
+      sort: typeof sort === 'string' ? sort.split(',') : undefined,
       trash: args.trash,
       where: args.where,
     }
diff --git a/packages/graphql/src/resolvers/globals/findVersions.ts b/packages/graphql/src/resolvers/globals/findVersions.ts
@@ -20,18 +20,24 @@ export type Resolver = (
     where: Where
   },
   context: Context,
-  info: GraphQLResolveInfo
+  info: GraphQLResolveInfo,
 ) => Promise<Document>
 
 export function findVersions(globalConfig: SanitizedGlobalConfig): Resolver {
   return async function resolver(_, args, context, info) {
-    const req = context.req = isolateObjectProperty(context.req, ['locale', 'fallbackLocale', 'transactionID'])
-    const select = context.select = args.select ? buildSelectForCollectionMany(info) : undefined
+    const req = (context.req = isolateObjectProperty(context.req, [
+      'locale',
+      'fallbackLocale',
+      'transactionID',
+    ]))
+    const select = (context.select = args.select ? buildSelectForCollectionMany(info) : undefined)
 
     req.locale = args.locale || req.locale
     req.fallbackLocale = args.fallbackLocale || req.fallbackLocale
     req.query = req.query || {}
 
+    const { sort } = args
+
     const options = {
       depth: 0,
       globalConfig,
@@ -40,7 +46,7 @@ export function findVersions(globalConfig: SanitizedGlobalConfig): Resolver {
       pagination: args.pagination,
       req,
       select,
-      sort: args.sort,
+      sort: typeof sort === 'string' ? sort.split(',') : undefined,
       where: args.where,
     }
 
diff --git a/test/collections-graphql/config.ts b/test/collections-graphql/config.ts
@@ -390,6 +390,19 @@ export default buildConfigWithDefaults({
       ],
       upload: true,
     },
+    {
+      slug: 'sort',
+      fields: [
+        {
+          name: 'title',
+          type: 'text',
+        },
+        {
+          name: 'number',
+          type: 'number',
+        },
+      ],
+    },
   ],
   graphQL: {
     queries: (GraphQL) => {
diff --git a/test/collections-graphql/int.spec.ts b/test/collections-graphql/int.spec.ts
@@ -111,6 +111,30 @@ describe('collections-graphql', () => {
       expect(docs).toContainEqual(expect.objectContaining({ id: existingDoc.id }))
     })
 
+    it('should sort by multiple fields', async () => {
+      const doc1 = await payload.create({ collection: 'sort', data: { title: 'a', number: 1 } })
+      const doc2 = await payload.create({ collection: 'sort', data: { title: 'b', number: 1 } })
+      const doc3 = await payload.create({ collection: 'sort', data: { title: 'a', number: 2 } })
+      const doc4 = await payload.create({ collection: 'sort', data: { title: 'b', number: 3 } })
+
+      const query = `query {
+        Sorts(sort: "title, number") {
+          docs {
+            id
+            title
+            number
+          }
+        }
+      }`
+
+      const { data } = await restClient
+        .GRAPHQL_POST({ body: JSON.stringify({ query }) })
+        .then((res) => res.json())
+      const { docs } = data.Sorts
+
+      expect(docs.map((doc) => doc.id)).toEqual([doc3.id, doc1.id, doc4.id, doc2.id])
+    })
+
     it('should count', async () => {
       const query = `query {
         countPosts {
diff --git a/test/collections-graphql/payload-types.ts b/test/collections-graphql/payload-types.ts
@@ -79,6 +79,8 @@ export interface Config {
     'content-type': ContentType;
     'cyclical-relationship': CyclicalRelationship;
     media: Media;
+    sort: Sort;
+    'payload-kv': PayloadKv;
     'payload-locked-documents': PayloadLockedDocument;
     'payload-preferences': PayloadPreference;
     'payload-migrations': PayloadMigration;
@@ -97,6 +99,8 @@ export interface Config {
     'content-type': ContentTypeSelect<false> | ContentTypeSelect<true>;
     'cyclical-relationship': CyclicalRelationshipSelect<false> | CyclicalRelationshipSelect<true>;
     media: MediaSelect<false> | MediaSelect<true>;
+    sort: SortSelect<false> | SortSelect<true>;
+    'payload-kv': PayloadKvSelect<false> | PayloadKvSelect<true>;
     'payload-locked-documents': PayloadLockedDocumentsSelect<false> | PayloadLockedDocumentsSelect<true>;
     'payload-preferences': PayloadPreferencesSelect<false> | PayloadPreferencesSelect<true>;
     'payload-migrations': PayloadMigrationsSelect<false> | PayloadMigrationsSelect<true>;
@@ -333,6 +337,34 @@ export interface Media {
   focalX?: number | null;
   focalY?: number | null;
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "sort".
+ */
+export interface Sort {
+  id: string;
+  title?: string | null;
+  number?: number | null;
+  updatedAt: string;
+  createdAt: string;
+}
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "payload-kv".
+ */
+export interface PayloadKv {
+  id: string;
+  key: string;
+  data:
+    | {
+        [k: string]: unknown;
+      }
+    | unknown[]
+    | string
+    | number
+    | boolean
+    | null;
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "payload-locked-documents".
@@ -387,6 +419,10 @@ export interface PayloadLockedDocument {
     | ({
         relationTo: 'media';
         value: string | Media;
+      } | null)
+    | ({
+        relationTo: 'sort';
+        value: string | Sort;
       } | null);
   globalSlug?: string | null;
   user: {
@@ -609,6 +645,24 @@ export interface MediaSelect<T extends boolean = true> {
   focalX?: T;
   focalY?: T;
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "sort_select".
+ */
+export interface SortSelect<T extends boolean = true> {
+  title?: T;
+  number?: T;
+  updatedAt?: T;
+  createdAt?: T;
+}
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "payload-kv_select".
+ */
+export interface PayloadKvSelect<T extends boolean = true> {
+  key?: T;
+  data?: T;
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "payload-locked-documents_select".
diff --git a/test/collections-graphql/schema.graphql b/test/collections-graphql/schema.graphql
