feat(pg): support ordering with NULLS FIRST / NULLS LAST (#332)

graphile · Nov 21, 2018 · 545d082 · 545d082
1 parent 4a05670
commit 545d082
Show file tree

Hide file tree

Showing 6 changed files with 103 additions and 11 deletions.
diff --git a/packages/graphile-build-pg/src/QueryBuilder.d.ts b/packages/graphile-build-pg/src/QueryBuilder.d.ts
@@ -25,7 +25,7 @@ export default class QueryBuilder {
   public where(exprGen: SQLGen): void;
   public whereBound(exprGen: SQLGen, isLower: boolean): void;
   public setOrderIsUnique(): void;
-  public orderBy(exprGen: SQLGen, ascending: boolean): void;
+  public orderBy(exprGen: SQLGen, ascending: boolean, nullsFirst: boolean): void;
   public limit(limitGen: NumberGen): void;
   public offset(offsetGen: NumberGen): void;
   public first(first: number): void;
@@ -45,7 +45,7 @@ export default class QueryBuilder {
   };
   public getFinalOffset(): number;
   public getFinalLimit(): number;
-  public getOrderByExpressionsAndDirections(): Array<[SQL, boolean]>;
+  public getOrderByExpressionsAndDirections(): Array<[SQL, boolean, boolean]>;
   public getSelectFieldsCount(): number;
   public buildSelectFields(): SQL;
   public buildSelectJson({ addNullCase }: { addNullCase?: boolean }): SQL;

diff --git a/packages/graphile-build-pg/src/QueryBuilder.js b/packages/graphile-build-pg/src/QueryBuilder.js
@@ -66,7 +66,7 @@ class QueryBuilder {
       lower: Array<SQLGen>,
       upper: Array<SQLGen>,
     },
-    orderBy: Array<[SQLGen, boolean]>,
+    orderBy: Array<[SQLGen, boolean, boolean]>,
     orderIsUnique: boolean,
     limit: ?NumberGen,
     offset: ?NumberGen,
@@ -88,7 +88,7 @@ class QueryBuilder {
       lower: Array<SQL>,
       upper: Array<SQL>,
     },
-    orderBy: Array<[SQL, boolean]>,
+    orderBy: Array<[SQL, boolean, boolean]>,
     orderIsUnique: boolean,
     limit: ?number,
     offset: ?number,
@@ -236,9 +236,9 @@ class QueryBuilder {
   setOrderIsUnique() {
     this.data.orderIsUnique = true;
   }
-  orderBy(exprGen: SQLGen, ascending: boolean = true) {
+  orderBy(exprGen: SQLGen, ascending: boolean = true, nullsFirst: boolean) {
     this.checkLock("orderBy");
-    this.data.orderBy.push([exprGen, ascending]);
+    this.data.orderBy.push([exprGen, ascending, nullsFirst]);
   }
   limit(limitGen: NumberGen) {
     this.checkLock("limit");
@@ -473,11 +473,17 @@ class QueryBuilder {
         this.compiledData.orderBy.length
           ? sql.fragment`order by ${sql.join(
               this.compiledData.orderBy.map(
-                ([expr, ascending]) =>
+                ([expr, ascending, nullsFirst]) =>
                   sql.fragment`${expr} ${
                     Number(ascending) ^ Number(flip)
                       ? sql.fragment`ASC`
                       : sql.fragment`DESC`
+                  }${
+                    nullsFirst === true
+                      ? sql.fragment` NULLS FIRST`
+                      : nullsFirst === false
+                        ? sql.fragment` NULLS LAST`
+                        : null
                   }`
               ),
               ","
@@ -554,9 +560,10 @@ class QueryBuilder {
       }, []);
     } else if (type === "orderBy") {
       const context = getContext();
-      this.compiledData[type] = this.data[type].map(([a, b]) => [
+      this.compiledData[type] = this.data[type].map(([a, b, c]) => [
         callIfNecessary(a, context),
         b,
+        c,
       ]);
     } else if (type === "from") {
       if (this.data.from) {

diff --git a/packages/graphile-build-pg/src/plugins/PgConnectionArgOrderBy.js b/packages/graphile-build-pg/src/plugins/PgConnectionArgOrderBy.js
@@ -2,7 +2,7 @@
 import isString from "lodash/isString";
 import type { Plugin } from "graphile-build";
 
-export default (function PgConnectionArgOrderBy(builder) {
+export default (function PgConnectionArgOrderBy(builder, { orderByNullsLast }) {
   builder.hook("init", (_, build) => {
     const {
       newWithHooks,
@@ -121,13 +121,21 @@ export default (function PgConnectionArgOrderBy(builder) {
                   Array.isArray(specs[0]) || specs.length === 0
                     ? specs
                     : [specs];
-                orders.forEach(([col, ascending]) => {
+                orders.forEach(([col, ascending, specNullsFirst]) => {
                   const expr = isString(col)
                     ? sql.fragment`${queryBuilder.getTableAlias()}.${sql.identifier(
                         col
                       )}`
                     : col;
-                  queryBuilder.orderBy(expr, ascending);
+                  // If the enum specifies null ordering, use that
+                  // Otherwise, use the orderByNullsLast option if present
+                  const nullsFirst =
+                    specNullsFirst != null
+                      ? specNullsFirst
+                      : orderByNullsLast != null
+                        ? !orderByNullsLast
+                        : undefined;
+                  queryBuilder.orderBy(expr, ascending, nullsFirst);
                 });
                 if (unique) {
                   queryBuilder.setOrderIsUnique();

diff --git a/packages/postgraphile-core/__tests__/fixtures/queries/orderByNullsLast.graphql b/packages/postgraphile-core/__tests__/fixtures/queries/orderByNullsLast.graphql
@@ -0,0 +1,14 @@
+{
+  asc: allSimilarTable1S(orderBy: COL2_ASC) {
+    nodes {
+      nodeId
+      col2
+    }
+  }
+  desc: allSimilarTable1S(orderBy: COL2_DESC) {
+    nodes {
+      nodeId
+      col2
+    }
+  }
+}
diff --git a/packages/postgraphile-core/__tests__/integration/__snapshots__/queries.test.js.snap b/packages/postgraphile-core/__tests__/integration/__snapshots__/queries.test.js.snap
@@ -2007,6 +2007,61 @@ Object {
 }
 `;
 
+exports[`orderByNullsLast.graphql 1`] = `
+Object {
+  "data": Object {
+    "asc": Object {
+      "nodes": Array [
+        Object {
+          "col2": 1,
+          "nodeId": "WyJzaW1pbGFyX3RhYmxlXzFTIiw1XQ==",
+        },
+        Object {
+          "col2": 4,
+          "nodeId": "WyJzaW1pbGFyX3RhYmxlXzFTIiwzXQ==",
+        },
+        Object {
+          "col2": 6,
+          "nodeId": "WyJzaW1pbGFyX3RhYmxlXzFTIiwxXQ==",
+        },
+        Object {
+          "col2": null,
+          "nodeId": "WyJzaW1pbGFyX3RhYmxlXzFTIiwyXQ==",
+        },
+        Object {
+          "col2": null,
+          "nodeId": "WyJzaW1pbGFyX3RhYmxlXzFTIiw0XQ==",
+        },
+      ],
+    },
+    "desc": Object {
+      "nodes": Array [
+        Object {
+          "col2": 6,
+          "nodeId": "WyJzaW1pbGFyX3RhYmxlXzFTIiwxXQ==",
+        },
+        Object {
+          "col2": 4,
+          "nodeId": "WyJzaW1pbGFyX3RhYmxlXzFTIiwzXQ==",
+        },
+        Object {
+          "col2": 1,
+          "nodeId": "WyJzaW1pbGFyX3RhYmxlXzFTIiw1XQ==",
+        },
+        Object {
+          "col2": null,
+          "nodeId": "WyJzaW1pbGFyX3RhYmxlXzFTIiwyXQ==",
+        },
+        Object {
+          "col2": null,
+          "nodeId": "WyJzaW1pbGFyX3RhYmxlXzFTIiw0XQ==",
+        },
+      ],
+    },
+  },
+}
+`;
+
 exports[`posts.graphql 1`] = `
 Object {
   "data": Object {

diff --git a/packages/postgraphile-core/__tests__/integration/queries.test.js b/packages/postgraphile-core/__tests__/integration/queries.test.js
@@ -42,6 +42,7 @@ beforeAll(() => {
       viewUniqueKey,
       dSchema,
       simpleCollections,
+      orderByNullsLast,
     ] = await Promise.all([
       createPostGraphileSchema(pgClient, ["a", "b", "c"]),
       createPostGraphileSchema(pgClient, ["a", "b", "c"], { classicIds: true }),
@@ -61,6 +62,11 @@ beforeAll(() => {
       createPostGraphileSchema(pgClient, ["a", "b", "c"], {
         simpleCollections: "both",
       }),
+      createPostGraphileSchema(pgClient, ["a"], {
+        graphileBuildOptions: {
+          orderByNullsLast: true,
+        },
+      }),
     ]);
     // Now for RBAC-enabled tests
     await pgClient.query("set role postgraphile_test_authenticator");
@@ -78,6 +84,7 @@ beforeAll(() => {
       viewUniqueKey,
       dSchema,
       simpleCollections,
+      orderByNullsLast,
       rbac,
     };
   });
@@ -119,6 +126,7 @@ beforeAll(() => {
             "simple-procedure-computed-fields.graphql":
               gqlSchemas.simpleCollections,
             "simple-procedure-query.graphql": gqlSchemas.simpleCollections,
+            "orderByNullsLast.graphql": gqlSchemas.orderByNullsLast,
           };
           let gqlSchema = schemas[fileName];
           if (!gqlSchema) {