Add totalCount to paginate

danielrearden · May 16, 2020 · 32fe4be · 32fe4be
1 parent c0298f8
commit 32fe4be
Show file tree

Hide file tree

Showing 11 changed files with 171 additions and 31 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased](https://github.com/danielrearden/sqlmancer/compare/v0.2.1...HEAD)
 
+### Added
+- `totalCount` property to object returned by `paginate`
+
 ### Fixed
 - Return type generated by @paginate
 

diff --git a/src/__tests__/mysql/integration.test.ts b/src/__tests__/mysql/integration.test.ts
@@ -191,6 +191,7 @@ describe('integration (mysql)', () => {
               id
             }
             hasMore
+            totalCount
           }
           filmsPaginated {
             aggregate {
@@ -216,6 +217,7 @@ describe('integration (mysql)', () => {
               id
             }
             hasMore
+            totalCount
           }
           actor(id: 1) {
             filmsPaginated {
@@ -242,6 +244,7 @@ describe('integration (mysql)', () => {
                 id
               }
               hasMore
+              totalCount
             }
           }
         }
@@ -255,6 +258,7 @@ describe('integration (mysql)', () => {
     expect(data?.actorsPaginated.aggregate.max.lastUpdate).toBeDefined()
     expect(data?.actorsPaginated.results.length).toBeGreaterThan(0)
     expect(data?.actorsPaginated.hasMore).toBeDefined()
+    expect(data?.actorsPaginated.totalCount).toBeDefined()
     expect(data?.filmsPaginated.aggregate.count).toBeGreaterThan(0)
     expect(data?.filmsPaginated.aggregate.min.title).toBeDefined()
     expect(data?.filmsPaginated.aggregate.min.length).toBeDefined()
@@ -266,6 +270,7 @@ describe('integration (mysql)', () => {
     expect(data?.filmsPaginated.aggregate.sum.length).toBeDefined()
     expect(data?.filmsPaginated.results.length).toBeGreaterThan(0)
     expect(data?.filmsPaginated.hasMore).toBeDefined()
+    expect(data?.filmsPaginated.totalCount).toBeDefined()
     expect(data?.actor.filmsPaginated.aggregate.count).toBeGreaterThan(0)
     expect(data?.actor.filmsPaginated.aggregate.min.title).toBeDefined()
     expect(data?.actor.filmsPaginated.aggregate.min.length).toBeDefined()
@@ -277,6 +282,7 @@ describe('integration (mysql)', () => {
     expect(data?.actor.filmsPaginated.aggregate.sum.length).toBeDefined()
     expect(data?.actor.filmsPaginated.results.length).toBeGreaterThan(0)
     expect(data?.actor.filmsPaginated.hasMore).toBeDefined()
+    expect(data?.actor.filmsPaginated.totalCount).toBeDefined()
   })
 
   test('abstract types', async () => {

diff --git a/src/__tests__/postgres/integration.test.ts b/src/__tests__/postgres/integration.test.ts
@@ -209,6 +209,7 @@ describe('integration (postgres)', () => {
               id
             }
             hasMore
+            totalCount
           }
           filmsPaginated {
             aggregate {
@@ -234,6 +235,7 @@ describe('integration (postgres)', () => {
               id
             }
             hasMore
+            totalCount
           }
           actor(id: 1) {
             filmsPaginated {
@@ -260,6 +262,7 @@ describe('integration (postgres)', () => {
                 id
               }
               hasMore
+              totalCount
             }
           }
         }
@@ -273,6 +276,7 @@ describe('integration (postgres)', () => {
     expect(data?.actorsPaginated.aggregate.max.lastUpdate).toBeDefined()
     expect(data?.actorsPaginated.results.length).toBeGreaterThan(0)
     expect(data?.actorsPaginated.hasMore).toBeDefined()
+    expect(data?.actorsPaginated.totalCount).toBeDefined()
     expect(data?.filmsPaginated.aggregate.count).toBeGreaterThan(0)
     expect(data?.filmsPaginated.aggregate.min.title).toBeDefined()
     expect(data?.filmsPaginated.aggregate.min.length).toBeDefined()
@@ -284,6 +288,7 @@ describe('integration (postgres)', () => {
     expect(data?.filmsPaginated.aggregate.sum.length).toBeDefined()
     expect(data?.filmsPaginated.results.length).toBeGreaterThan(0)
     expect(data?.filmsPaginated.hasMore).toBeDefined()
+    expect(data?.filmsPaginated.totalCount).toBeDefined()
     expect(data?.actor.filmsPaginated.aggregate.count).toBeGreaterThan(0)
     expect(data?.actor.filmsPaginated.aggregate.min.title).toBeDefined()
     expect(data?.actor.filmsPaginated.aggregate.min.length).toBeDefined()
@@ -295,6 +300,7 @@ describe('integration (postgres)', () => {
     expect(data?.actor.filmsPaginated.aggregate.sum.length).toBeDefined()
     expect(data?.actor.filmsPaginated.results.length).toBeGreaterThan(0)
     expect(data?.actor.filmsPaginated.hasMore).toBeDefined()
+    expect(data?.actor.filmsPaginated.totalCount).toBeDefined()
   })
 
   test('abstract types', async () => {

diff --git a/src/__tests__/sqlite/integration.test.ts b/src/__tests__/sqlite/integration.test.ts
@@ -193,6 +193,7 @@ describe('integration (sqlite)', () => {
               id
             }
             hasMore
+            totalCount
           }
           filmsPaginated {
             aggregate {
@@ -218,6 +219,7 @@ describe('integration (sqlite)', () => {
               id
             }
             hasMore
+            totalCount
           }
           actor(id: 1) {
             filmsPaginated {
@@ -244,6 +246,7 @@ describe('integration (sqlite)', () => {
                 id
               }
               hasMore
+              totalCount
             }
           }
         }
@@ -257,6 +260,7 @@ describe('integration (sqlite)', () => {
     expect(data?.actorsPaginated.aggregate.max.lastUpdate).toBeDefined()
     expect(data?.actorsPaginated.results.length).toBeGreaterThan(0)
     expect(data?.actorsPaginated.hasMore).toBeDefined()
+    expect(data?.actorsPaginated.totalCount).toBeDefined()
     expect(data?.filmsPaginated.aggregate.count).toBeGreaterThan(0)
     expect(data?.filmsPaginated.aggregate.min.title).toBeDefined()
     expect(data?.filmsPaginated.aggregate.min.length).toBeDefined()
@@ -268,6 +272,7 @@ describe('integration (sqlite)', () => {
     expect(data?.filmsPaginated.aggregate.sum.length).toBeDefined()
     expect(data?.filmsPaginated.results.length).toBeGreaterThan(0)
     expect(data?.filmsPaginated.hasMore).toBeDefined()
+    expect(data?.filmsPaginated.totalCount).toBeDefined()
     expect(data?.actor.filmsPaginated.aggregate.count).toBeGreaterThan(0)
     expect(data?.actor.filmsPaginated.aggregate.min.title).toBeDefined()
     expect(data?.actor.filmsPaginated.aggregate.min.length).toBeDefined()
@@ -279,6 +284,7 @@ describe('integration (sqlite)', () => {
     expect(data?.actor.filmsPaginated.aggregate.sum.length).toBeDefined()
     expect(data?.actor.filmsPaginated.results.length).toBeGreaterThan(0)
     expect(data?.actor.filmsPaginated.hasMore).toBeDefined()
+    expect(data?.actor.filmsPaginated.totalCount).toBeDefined()
   })
 
   test('abstract types', async () => {

diff --git a/src/directives/__tests__/__fixtures__/schema.ts b/src/directives/__tests__/__fixtures__/schema.ts
@@ -16,6 +16,7 @@ const typeDefs = `
     widgets: [Widget!]! @limit @offset @orderBy(model: "Widget") @where(model: "Widget")
     alsoWidgets: [Widget!]! @orderBy @where
     someMoreWidgets: [Widget!]! @many
+    paginatedWidgets: Widget @paginate
   }
 
   type Mutation {

diff --git a/src/directives/__tests__/directives.test.ts b/src/directives/__tests__/directives.test.ts
@@ -147,29 +147,40 @@ describe('directives', () => {
 
   describe('@paginate', () => {
     test('correct usage', async () => {
-      const { createWidget, createWidgets, updateWidget, updateWidgets } = (schema.getType(
-        'Mutation'
+      const { paginatedWidgets } = (schema.getType('Query') as GraphQLObjectType).getFields()
+      const { results, aggregate, hasMore, totalCount } = (schema.getType(
+        'WidgetPage'
       ) as GraphQLObjectType).getFields()
-      const CreateWidgetInput = schema.getType('CreateWidgetInput') as GraphQLInputObjectType
-      const UpdateWidgetInput = schema.getType('UpdateWidgetInput') as GraphQLInputObjectType
-      const createWidgetInputArgType = createWidget.args.find((arg) => arg.name === 'input')!.type
-      const createWidgetsInputArgType = createWidgets.args.find((arg) => arg.name === 'input')!.type
-      const updateWidgetInputArgType = updateWidget.args.find((arg) => arg.name === 'input')!.type
-      const updateWidgetsInputArgType = updateWidgets.args.find((arg) => arg.name === 'input')!.type
-      expect(createWidgetInputArgType.toString()).toBe('CreateWidgetInput!')
-      expect(createWidgetsInputArgType.toString()).toBe('[CreateWidgetInput!]!')
-      expect(updateWidgetInputArgType.toString()).toBe('UpdateWidgetInput!')
-      expect(updateWidgetsInputArgType.toString()).toBe('UpdateWidgetInput!')
-      expect(CreateWidgetInput.getFields().id.type.toString()).toBe('ID')
-      expect(CreateWidgetInput.getFields().idNullable.type.toString()).toBe('ID')
-      expect(CreateWidgetInput.getFields().idList.type.toString()).toBe('[ID!]!')
-      expect(CreateWidgetInput.getFields().string.type.toString()).toBe('String!')
-      expect(CreateWidgetInput.getFields().json.type.toString()).toBe('JSON!')
-      expect(UpdateWidgetInput.getFields().idNullable.type.toString()).toBe('ID')
-      expect(UpdateWidgetInput.getFields().idList.type.toString()).toBe('[ID!]')
-      expect(UpdateWidgetInput.getFields().string.type.toString()).toBe('String')
-      expect(UpdateWidgetInput.getFields().json.type.toString()).toBe('JSON')
-      expect(UpdateWidgetInput.getFields().id).toBeUndefined()
+      const { count } = (schema.getType('WidgetAggregate') as GraphQLObjectType).getFields()
+      const minFields = (schema.getType('WidgetAggregateMin') as GraphQLObjectType).getFields()
+      const maxFields = (schema.getType('WidgetAggregateMax') as GraphQLObjectType).getFields()
+      const sumFields = (schema.getType('WidgetAggregateSum') as GraphQLObjectType).getFields()
+      const avgFields = (schema.getType('WidgetAggregateAvg') as GraphQLObjectType).getFields()
+
+      expect(paginatedWidgets.type.toString()).toBe('WidgetPage!')
+      expect(results.type.toString()).toBe('[Widget!]!')
+      expect(aggregate.type.toString()).toBe('WidgetAggregate!')
+      expect(hasMore.type.toString()).toBe('Boolean!')
+      expect(totalCount.type.toString()).toBe('Int!')
+      expect(count.type.toString()).toBe('Int!')
+
+      expect(minFields.id).toBeDefined()
+      expect(minFields.string).toBeDefined()
+      expect(minFields.int).toBeDefined()
+      expect(minFields.float).toBeDefined()
+      expect(maxFields.id).toBeDefined()
+      expect(maxFields.string).toBeDefined()
+      expect(maxFields.int).toBeDefined()
+      expect(maxFields.float).toBeDefined()
+      expect(sumFields.int).toBeDefined()
+      expect(sumFields.float).toBeDefined()
+      expect(avgFields.int).toBeDefined()
+      expect(avgFields.float).toBeDefined()
+
+      expect(sumFields.id).toBeUndefined()
+      expect(sumFields.string).toBeUndefined()
+      expect(avgFields.id).toBeUndefined()
+      expect(avgFields.string).toBeUndefined()
     })
   })
 })
diff --git a/src/directives/paginate.ts b/src/directives/paginate.ts
@@ -56,6 +56,9 @@ export class PaginateDirective extends SchemaDirectiveVisitor<any, any> {
         hasMore: {
           type: new GraphQLNonNull(GraphQLBoolean),
         },
+        totalCount: {
+          type: new GraphQLNonNull(GraphQLInt),
+        },
       }),
     })
   }

diff --git a/src/queryBuilder/__tests__/__snapshots__/paginate.test.ts.snap b/src/queryBuilder/__tests__/__snapshots__/paginate.test.ts.snap
@@ -126,6 +126,10 @@ Array [
 ]
 `;
 
+exports[`PaginateBuilder mysql totalCount correct usage 1`] = `"select json_object('totalCount', (select coalesce(\`f1\`.\`count\`, 0) from (select count(\`f2\`.\`film_id\`) as count from \`film\` as \`f2\`) as \`f1\`)) as \`page\`"`;
+
+exports[`PaginateBuilder mysql totalCount correct usage 2`] = `Array []`;
+
 exports[`PaginateBuilder postgres aggregate avg 1`] = `"select json_build_object('aggregate', (select json_build_object('avg', json_build_object('rentalRate', coalesce(avg(\\"f1\\".\\"rental_rate\\"), 0))) from (select \\"f2\\".\\"rental_rate\\" from \\"film\\" as \\"f2\\") as \\"f1\\")) as \\"page\\""`;
 
 exports[`PaginateBuilder postgres aggregate avg 2`] = `Array []`;
@@ -252,6 +256,10 @@ Array [
 ]
 `;
 
+exports[`PaginateBuilder postgres totalCount correct usage 1`] = `"select json_build_object('totalCount', (select coalesce(\\"f1\\".\\"count\\", 0) from (select count(\\"f2\\".\\"film_id\\") as count from \\"film\\" as \\"f2\\") as \\"f1\\")) as \\"page\\""`;
+
+exports[`PaginateBuilder postgres totalCount correct usage 2`] = `Array []`;
+
 exports[`PaginateBuilder sqlite aggregate avg 1`] = `"select json_object('aggregate', (select json_object('avg', json_object('rentalRate', coalesce(avg(\`f1\`.\`rental_rate\`), 0))) from (select \`f2\`.\`rental_rate\` from \`film\` as \`f2\`) as \`f1\`)) as \`page\`"`;
 
 exports[`PaginateBuilder sqlite aggregate avg 2`] = `Array []`;
@@ -379,3 +387,7 @@ Array [
   "FILM",
 ]
 `;
+
+exports[`PaginateBuilder sqlite totalCount correct usage 1`] = `"select json_object('totalCount', (select coalesce(\`f1\`.\`count\`, 0) from (select count(\`f2\`.\`film_id\`) as count from \`film\` as \`f2\`) as \`f1\`)) as \`page\`"`;
+
+exports[`PaginateBuilder sqlite totalCount correct usage 2`] = `Array []`;
diff --git a/src/queryBuilder/__tests__/paginate.test.ts b/src/queryBuilder/__tests__/paginate.test.ts
@@ -226,5 +226,22 @@ describe('PaginateBuilder', () => {
         expect(bindings).toMatchSnapshot()
       })
     })
+
+    describe('totalCount', () => {
+      test('correct usage', async () => {
+        const builder = client.models.Film.paginate().totalCount()
+        const builder2 = client.models.Film.paginate().offset(10).totalCount()
+        const builder3 = client.models.Film.paginate().limit(10).totalCount()
+        const { sql, bindings } = builder.toQueryBuilder().toSQL()
+        const result = await builder.execute()
+        const result2 = await builder2.execute()
+        const result3 = await builder3.execute()
+        expect(result.totalCount).toBeNumber()
+        expect(result.totalCount).toBe(result2.totalCount)
+        expect(result.totalCount).toBe(result3.totalCount)
+        expect(sql).toMatchSnapshot()
+        expect(bindings).toMatchSnapshot()
+      })
+    })
   })
 })
diff --git a/src/queryBuilder/base.ts b/src/queryBuilder/base.ts
@@ -482,7 +482,7 @@ export abstract class BaseBuilder {
     return { orderByColumnName, direction, selectExpression }
   }
 
-  protected _applyExpressions(query: Knex.QueryBuilder, expressions: Expressions) {
+  protected _applyExpressions(query: Knex.QueryBuilder, expressions: Expressions, includeLimitOffset = true) {
     expressions.join.forEach((join) => (query as any)[join.type](join.table, join.on))
 
     expressions.where.forEach((whereArgs) => (query.where as any)(...whereArgs))
@@ -495,11 +495,11 @@ export abstract class BaseBuilder {
       query.orderBy(expressions.orderBy as any)
     }
 
-    if (this._limit) {
+    if (this._limit && includeLimitOffset) {
       query.limit(this._limit)
     }
 
-    if (this._offset) {
+    if (this._offset && includeLimitOffset) {
       query.offset(this._offset)
     }
   }