Merge pull request #937 from constructive-io/fix/orderby-not-working-v5

fix: enable orderBy on all columns alongside filterBy in v5 plugin

Author: pyramation

graphile/graphile-settings/src/plugins/enable-all-filter-columns.ts

@@ -1,17 +1,17 @@
 import type { GraphileConfig } from 'graphile-config';
 
 /**
- * EnableAllFilterColumnsPlugin - Enables filtering on ALL columns, not just indexed ones.
+ * EnableAllFilterColumnsPlugin - Enables filtering and ordering on ALL columns, not just indexed ones.
  *
  * WHY THIS EXISTS:
- * PostGraphile v5's `PgIndexBehaviorsPlugin` restricts filtering to only indexed columns
- * by default. This is a performance optimization - filtering on non-indexed columns can
+ * PostGraphile v5's `PgIndexBehaviorsPlugin` restricts filtering and ordering to only indexed columns
+ * by default. This is a performance optimization - filtering/ordering on non-indexed columns can
  * cause slow table scans. However, for development and flexibility, we want to allow
- * filtering on all columns and let developers/DBAs decide which columns need indexes.
+ * filtering and ordering on all columns and let developers/DBAs decide which columns need indexes.
  *
  * SOURCE CODE REFERENCE:
  * PgIndexBehaviorsPlugin marks non-indexed columns with `extensions.isIndexed = false`
- * and then adds `-filterBy` behavior to remove them from filters:
+ * and then adds `-filterBy` and `-orderBy` behaviors to remove them from filters and ordering:
  * https://github.com/graphile/crystal/blob/924b2515c6bd30e5905ac1419a25244b40c8bb4d/graphile-build/graphile-build-pg/src/plugins/PgIndexBehaviorsPlugin.ts
  *
  * The relevant v5 code (from PgIndexBehaviorsPlugin):
@@ -25,7 +25,7 @@ import type { GraphileConfig } from 'graphile-config';
  *         const newBehavior = [behavior];
  *         const attr = codec.attributes[attributeName];
  *         if (attr.extensions?.isIndexed === false) {
- *           newBehavior.push("-filterBy", "-orderBy");  // <-- This removes filterBy!
+ *           newBehavior.push("-filterBy", "-orderBy");  // <-- This removes filterBy AND orderBy!
  *         }
  *         return newBehavior;
  *       },
@@ -36,15 +36,16 @@ import type { GraphileConfig } from 'graphile-config';
  *
  * OUR FIX:
  * We add a behavior callback that runs AFTER PgIndexBehaviorsPlugin's "postInferred" phase
- * and adds `+attribute:filterBy` back to ALL columns, regardless of index status.
+ * and adds `+attribute:filterBy` and `+attribute:orderBy` back to ALL columns, regardless of index status.
  *
  * This means:
  * - All columns will appear in the connection filter's filter argument
- * - Developers can filter by any column
- * - It's the developer's/DBA's responsibility to add indexes for frequently filtered columns
+ * - All columns will appear in the connection's orderBy enum
+ * - Developers can filter and sort by any column
+ * - It's the developer's/DBA's responsibility to add indexes for frequently filtered/sorted columns
  *
  * PERFORMANCE WARNING:
- * Filtering on non-indexed columns can cause full table scans, which may be slow on large
+ * Filtering or ordering on non-indexed columns can cause full table scans, which may be slow on large
  * tables. Monitor your query performance and add indexes as needed. You can check which
  * columns are indexed by querying pg_indexes or using EXPLAIN ANALYZE on your queries.
  *
@@ -56,23 +57,24 @@ import type { GraphileConfig } from 'graphile-config';
 export const EnableAllFilterColumnsPlugin: GraphileConfig.Plugin = {
   name: 'EnableAllFilterColumnsPlugin',
   version: '1.0.0',
-  description: 'Enables filtering on all columns, not just indexed ones',
+  description: 'Enables filtering and ordering on all columns, not just indexed ones',
 
   schema: {
     entityBehavior: {
       pgCodecAttribute: {
         /**
          * This callback runs in the "inferred" phase AFTER PgIndexBehaviorsPlugin's
-         * "postInferred" phase. It adds `filterBy` back to ALL columns, overriding
-         * the `-filterBy` that PgIndexBehaviorsPlugin adds to non-indexed columns.
+         * "postInferred" phase. It adds `filterBy` and `orderBy` back to ALL columns,
+         * overriding the `-filterBy` and `-orderBy` that PgIndexBehaviorsPlugin adds
+         * to non-indexed columns.
          */
         inferred: {
           after: ['postInferred'],
           provides: ['enableAllFilters'],
           callback(behavior) {
-            // Add filterBy to override any -filterBy from PgIndexBehaviorsPlugin
+            // Add filterBy and orderBy to override PgIndexBehaviorsPlugin restrictions
             // The behavior system will resolve conflicts, with later additions winning
-            return [behavior, 'filterBy'];
+            return [behavior, 'filterBy', 'orderBy'];
           },
         },
       },

graphql/server-test/__tests__/__snapshots__/schema-snapshot.test.ts.snap

@@ -1069,12 +1069,24 @@ enum PostOrderBy {
   ID_DESC
   AUTHOR_ID_ASC
   AUTHOR_ID_DESC
+  TITLE_ASC
+  TITLE_DESC
   SLUG_ASC
   SLUG_DESC
+  CONTENT_ASC
+  CONTENT_DESC
+  EXCERPT_ASC
+  EXCERPT_DESC
+  IS_PUBLISHED_ASC
+  IS_PUBLISHED_DESC
   PUBLISHED_AT_ASC
   PUBLISHED_AT_DESC
+  VIEW_COUNT_ASC
+  VIEW_COUNT_DESC
   CREATED_AT_ASC
   CREATED_AT_DESC
+  UPDATED_AT_ASC
+  UPDATED_AT_DESC
 }
 
 """Methods to use when ordering \`PostTag\`."""
@@ -1088,6 +1100,8 @@ enum PostTagOrderBy {
   POST_ID_DESC
   TAG_ID_ASC
   TAG_ID_DESC
+  CREATED_AT_ASC
+  CREATED_AT_DESC
 }
 
 """A \`Tag\` edge in the connection, with data from \`PostTag\`."""
@@ -1112,6 +1126,12 @@ enum TagOrderBy {
   NAME_DESC
   SLUG_ASC
   SLUG_DESC
+  DESCRIPTION_ASC
+  DESCRIPTION_DESC
+  COLOR_ASC
+  COLOR_DESC
+  CREATED_AT_ASC
+  CREATED_AT_DESC
 }
 
 type User {
@@ -1290,8 +1310,16 @@ enum CommentOrderBy {
   AUTHOR_ID_DESC
   PARENT_ID_ASC
   PARENT_ID_DESC
+  CONTENT_ASC
+  CONTENT_DESC
+  IS_APPROVED_ASC
+  IS_APPROVED_DESC
+  LIKES_COUNT_ASC
+  LIKES_COUNT_DESC
   CREATED_AT_ASC
   CREATED_AT_DESC
+  UPDATED_AT_ASC
+  UPDATED_AT_DESC
 }
 
 """A \`Comment\` edge in the connection."""
@@ -1375,8 +1403,18 @@ enum UserOrderBy {
   EMAIL_DESC
   USERNAME_ASC
   USERNAME_DESC
+  DISPLAY_NAME_ASC
+  DISPLAY_NAME_DESC
+  BIO_ASC
+  BIO_DESC
+  IS_ACTIVE_ASC
+  IS_ACTIVE_DESC
+  ROLE_ASC
+  ROLE_DESC
   CREATED_AT_ASC
   CREATED_AT_DESC
+  UPDATED_AT_ASC
+  UPDATED_AT_DESC
 }
 
 """Root meta schema type"""