Rename the connection args -> grav args, and ensures the city shows, and show nearbyShows connections give the right pagination data

Author: orta

_schema.graphql

@@ -1971,7 +1971,6 @@ type City {
   name: String
   coordinates: LatLng
   shows(
-    size: Int
     sort: PartnerShowSorts
     status: EventStatus
     after: String
@@ -6900,7 +6899,6 @@ type Show implements Node {
 
   # Shows that are near (~75km) from this show
   nearbyShows(
-    size: Int
     sort: PartnerShowSorts
     status: EventStatus
     after: String

docs/dataloaders.md

@@ -37,24 +37,24 @@ artwork's artist - using the dataloader pattern that call would only happen once
 
 Our usage has a few moving parts:
 
-* The `api` object: for example [`/lib/apis/gravity.js`][api_grav] - it is a wrapper around [fetch][fetch] that
+- The `api` object: for example [`/lib/apis/gravity.js`][api_grav] - it is a wrapper around [fetch][fetch] that
   customizes the request to the service. The params tend to differ depending on the authentication method for that
   server.
 
-* The `loader factory` - there are three loader factories. They all end up exposing the same API, so your tests should
+- The `loader factory` - there are three loader factories. They all end up exposing the same API, so your tests should
   be the same shape regardless of the servers or types of calls you need to make.
 
   When an unauthenticated API call is made we take the result and store it in memcache, then the next time (potentially
   on another user's request) the cached result is passed back and we update memcache for the next request.
 
-  * [`loader_without_authentication_factory`][no_auth_loader] for API requests which can call the `api` directly and be
+  - [`loader_without_authentication_factory`][no_auth_loader] for API requests which can call the `api` directly and be
     safely cached in memcache.
-  * [`loader_with_authentication_factory`][auth_loader] for API requests that _could_ require a call for an
+  - [`loader_with_authentication_factory`][auth_loader] for API requests that _could_ require a call for an
     authentication token (like the examples in [Adding a New Microservice][new_micro].)
-  * [`loader_one_off_factory`][one_off_loader] for API requests which have custom auth schemes, or need to ignore cache
+  - [`loader_one_off_factory`][one_off_loader] for API requests which have custom auth schemes, or need to ignore cache
     completely.
 
-* The `loader` themselves. These are a set of functions which [are exposed][loaders] as properties on the root object
+- The `loader` themselves. These are a set of functions which [are exposed][loaders] as properties on the root object
   during the resolving stages of our graphQL implementation.
 
   ```js
@@ -92,17 +92,17 @@ Our usage has a few moving parts:
         },
       }),
 
-      resolve: (artist, options, request, { rootValue: { artistArtworksLoader } }) => {
+      resolve: async (artist, options, request, { rootValue: { artistArtworksLoader } }) => {
         const { limit: size, offset } = getPagingParameters(options)
         const { sort, filter, published } = options
 
         const gravityArgs = { size, offset, sort, filter, published }
-        return artistArtworksLoader(artist.id, gravityArgs).then(artworks =>
-          connectionFromArraySlice(artworks, options, {
-            arrayLength: artistArtworkArrayLength(artist, filter),
-            sliceStart: offset,
-          })
-        )
+        const artworks = await artistArtworksLoader(artist.id, gravityArgs)
+
+        return connectionFromArraySlice(artworks, options, {
+          arrayLength: artistArtworkArrayLength(artist, filter),
+          sliceStart: offset,
+        })
       },
     },
     // [...]

src/lib/helpers.ts

@@ -90,12 +90,14 @@ export const queriedForFieldsOtherThanBlacklisted = (
 export const queryContainsField = (fieldASTs, soughtField) => {
   return parseFieldASTsIntoArray(fieldASTs).includes(soughtField)
 }
-export const parseRelayOptions = options => {
+
+export const convertConnectionArgsToGravityArgs = options => {
   const { limit: size, offset } = getPagingParameters(options)
   const page = Math.round((size + offset) / size)
   const gravityArgs = omit(options, ["first", "after", "last", "before"])
   return Object.assign({}, { page, size, offset }, gravityArgs)
 }
+
 export const removeNulls = object => {
   Object.keys(object).forEach(key => object[key] == null && delete object[key]) // eslint-disable-line eqeqeq, no-param-reassign, max-len
 }

src/lib/loaders/loaders_without_authentication/gravity.ts

@@ -101,6 +101,7 @@ export default opts => {
     setsLoader: gravityLoader("sets"),
     showLoader: gravityLoader(id => `show/${id}`),
     showsLoader: gravityLoader("shows"),
+    showsWithHeadersLoader: gravityLoader("shows", {}, { headers: true }),
     similarArtworksLoader: gravityLoader("related/artworks"),
     similarGenesLoader: gravityLoader(
       id => `gene/${id}/similar`,

src/schema/__tests__/city.test.ts

@@ -49,7 +49,7 @@ describe("City", () => {
       {
         city(slug: "sacramende-ca-usa") {
           name
-          shows {
+          shows(first: 1) {
             edges {
               node {
                 id
@@ -61,9 +61,11 @@ describe("City", () => {
     `
 
     const mockShows = [{ id: "first-show" }]
-    const mockShowsLoader = jest.fn(() => Promise.resolve(mockShows))
+    const mockShowsLoader = jest.fn(() =>
+      Promise.resolve({ body: mockShows, headers: { "x-total-count": 1 } })
+    )
     const rootValue = {
-      showsLoader: mockShowsLoader,
+      showsWithHeadersLoader: mockShowsLoader,
       accessToken: null,
       userID: null,
     }

src/schema/__tests__/show.test.js

@@ -32,7 +32,11 @@ describe("Show type", () => {
 
     rootValue = {
       showLoader: sinon.stub().returns(Promise.resolve(showData)),
-      showsLoader: sinon.stub().returns(Promise.resolve([showData])),
+      showsWithHeadersLoader: sinon
+        .stub()
+        .returns(
+          Promise.resolve({ body: [showData], headers: { "x-total-count": 1 } })
+        ),
       galaxyGalleriesLoader: sinon.stub().returns(Promise.resolve(galaxyData)),
       partnerShowLoader: sinon.stub().returns(Promise.resolve(showData)),
     }
@@ -617,7 +621,7 @@ describe("Show type", () => {
       const query = gql`
         {
           show(id: "new-museum-1-2015-triennial-surround-audience") {
-            nearbyShows {
+            nearbyShows(first: 1) {
               edges {
                 node {
                   id

src/schema/artist/index.js

@@ -49,7 +49,7 @@ import {
   GraphQLInt,
 } from "graphql"
 import { connectionFromArraySlice } from "graphql-relay"
-import { parseRelayOptions } from "lib/helpers"
+import { convertConnectionArgsToGravityArgs } from "lib/helpers"
 import { totalViaLoader } from "lib/total"
 
 // Manually curated list of artist id's who has verified auction lots that can be
@@ -94,7 +94,7 @@ export const ArtistType = new GraphQLObjectType({
           _request,
           { rootValue: { articlesLoader } }
         ) => {
-          const pageOptions = parseRelayOptions(args)
+          const pageOptions = convertConnectionArgsToGravityArgs(args)
           const { page, size, offset } = pageOptions
 
           const gravityArgs = omit(args, ["first", "after", "last", "before"])
@@ -242,7 +242,9 @@ export const ArtistType = new GraphQLObjectType({
           }
 
           // Convert `after` cursors to page params
-          const { page, size, offset } = parseRelayOptions(options)
+          const { page, size, offset } = convertConnectionArgsToGravityArgs(
+            options
+          )
           const diffusionArgs = {
             page,
             size,

src/schema/artist/related.js

@@ -3,7 +3,7 @@ import { pageable, getPagingParameters } from "relay-cursor-paging"
 import { SuggestedArtistsArgs } from "schema/me/suggested_artists_args"
 import { artistConnection } from "schema/artist"
 import { geneConnection } from "schema/gene"
-import { parseRelayOptions } from "lib/helpers"
+import { convertConnectionArgsToGravityArgs } from "lib/helpers"
 import { createPageCursors } from "schema/fields/pagination"
 import { assign } from "lodash"
 import { connectionFromArraySlice, connectionFromArray } from "graphql-relay"
@@ -60,7 +60,9 @@ export const Related = {
             },
           }
         ) => {
-          const { page, size, offset } = parseRelayOptions(args)
+          const { page, size, offset } = convertConnectionArgsToGravityArgs(
+            args
+          )
           const { kind, exclude_artists_without_artworks } = args
           const gravityArgs = {
             page,

src/schema/artist/shows.js

@@ -3,7 +3,7 @@ import { GraphQLInt, GraphQLString, GraphQLBoolean } from "graphql"
 import PartnerShowSorts from "schema/sorts/partner_show_sorts"
 import { merge, defaults, reject, includes, omit } from "lodash"
 import { createPageCursors } from "schema/fields/pagination"
-import { parseRelayOptions } from "lib/helpers"
+import { convertConnectionArgsToGravityArgs } from "lib/helpers"
 import { connectionFromArraySlice } from "graphql-relay"
 
 // TODO: Fix upstream, for now we remove shows from certain Partner types
@@ -75,7 +75,7 @@ export const ShowField = {
 export const ShowsConnectionField = {
   args: pageable(ShowArgs),
   resolve: ({ id }, args, _request, { rootValue: { relatedShowsLoader } }) => {
-    const pageOptions = parseRelayOptions(args)
+    const pageOptions = convertConnectionArgsToGravityArgs(args)
     const { page, size, offset } = pageOptions
     const gravityArgs = omit(args, ["first", "after", "last", "before"])
     return relatedShowsLoader(

src/schema/city/index.ts

@@ -15,8 +15,9 @@ import EventStatus from "schema/input_fields/event_status"
 
 import cityData from "./city_data.json"
 import { pageable } from "relay-cursor-paging"
-import { connectionFromArray } from "graphql-relay"
+import { connectionFromArraySlice } from "graphql-relay"
 import { LOCAL_DISCOVERY_RADIUS_KM } from "./constants"
+import { convertConnectionArgsToGravityArgs } from "lib/helpers"
 
 const CityType = new GraphQLObjectType({
   name: "City",
@@ -33,23 +34,36 @@ const CityType = new GraphQLObjectType({
     shows: {
       type: showConnection,
       args: pageable({
-        size: {
-          type: GraphQLInt,
-        },
         sort: PartnerShowSorts,
         status: EventStatus,
       }),
-      resolve: (city, args, _context, { rootValue: { showsLoader } }) => {
+      resolve: async (
+        city,
+        args,
+        _c,
+        { rootValue: { showsWithHeadersLoader } }
+      ) => {
         const gravityOptions = {
-          ...args,
+          ...convertConnectionArgsToGravityArgs(args),
           displayable: true,
           near: `${city.coordinates.lat},${city.coordinates.lng}`,
           max_distance: LOCAL_DISCOVERY_RADIUS_KM,
+          total_count: true,
         }
+        delete gravityOptions.page
+
+        const response = await showsWithHeadersLoader(gravityOptions)
+        const { headers, body: cities } = response
 
-        return showsLoader(gravityOptions).then(response => {
-          return connectionFromArray(response, args)
+        const results = connectionFromArraySlice(cities, args, {
+          arrayLength: headers["x-total-count"],
+          sliceStart: gravityOptions.offset,
         })
+
+        // This is in our schema, so might as well fill it
+        // @ts-ignore
+        results.totalCount = headers["x-total-count"]
+        return results
       },
     },
     fairs: {

src/schema/collection.js

@@ -7,7 +7,7 @@ import CollectionSorts from "./sorts/collection_sorts"
 import { artworkConnection } from "./artwork"
 import {
   queriedForFieldsOtherThanBlacklisted,
-  parseRelayOptions,
+  convertConnectionArgsToGravityArgs,
 } from "lib/helpers"
 import { GravityIDFields, NodeInterface } from "./object_identification"
 import {
@@ -47,7 +47,7 @@ export const CollectionType = new GraphQLObjectType({
       ) => {
         const gravityOptions = Object.assign(
           { total_count: true },
-          parseRelayOptions(options)
+          convertConnectionArgsToGravityArgs(options)
         )
         // Adds a default case for the sort
         gravityOptions.sort = gravityOptions.sort || "-position"

src/schema/fair.ts

@@ -1,7 +1,7 @@
 import { omit } from "lodash"
 import { pageable } from "relay-cursor-paging"
 import { connectionFromArraySlice } from "graphql-relay"
-import { parseRelayOptions } from "lib/helpers"
+import { convertConnectionArgsToGravityArgs } from "lib/helpers"
 import moment from "moment"
 import cached from "./fields/cached"
 import date from "./fields/date"
@@ -143,7 +143,10 @@ const FairType = new GraphQLObjectType({
         _request,
         { rootValue: { fairBoothsLoader } }
       ) => {
-        const gravityOptions = omit(parseRelayOptions(options), ["page"])
+        const gravityOptions = omit(
+          convertConnectionArgsToGravityArgs(options),
+          ["page"]
+        )
         gravityOptions.sort = gravityOptions.sort || "-featured"
 
         return Promise.all([

src/schema/filter_artworks.js

@@ -8,7 +8,7 @@ import { computeTotalPages, createPageCursors } from "./fields/pagination"
 import { artworkConnection } from "./artwork"
 import { pageable } from "relay-cursor-paging"
 import {
-  parseRelayOptions,
+  convertConnectionArgsToGravityArgs,
   queriedForFieldsOtherThanBlacklisted,
   removeNulls,
 } from "lib/helpers"
@@ -99,7 +99,7 @@ export const FilterArtworksType = new GraphQLObjectType({
         request,
         { rootValue: { filterArtworksLoader } }
       ) => {
-        const relayOptions = parseRelayOptions(args)
+        const relayOptions = convertConnectionArgsToGravityArgs(args)
 
         return filterArtworksLoader(
           assign(gravityOptions, relayOptions, {})

src/schema/gene.js

@@ -12,7 +12,7 @@ import filterArtworks, {
 } from "./filter_artworks"
 import {
   queriedForFieldsOtherThanBlacklisted,
-  parseRelayOptions,
+  convertConnectionArgsToGravityArgs,
 } from "lib/helpers"
 import { GravityIDFields, NodeInterface } from "./object_identification"
 import {
@@ -65,7 +65,10 @@ export const GeneType = new GraphQLObjectType({
           request,
           { rootValue: { geneArtistsLoader } }
         ) => {
-          const parsedOptions = _.omit(parseRelayOptions(options), "page")
+          const parsedOptions = _.omit(
+            convertConnectionArgsToGravityArgs(options),
+            "page"
+          )
           const gravityOptions = _.extend(parsedOptions, {
             exclude_artists_without_artworks: true,
           })
@@ -93,7 +96,7 @@ export const GeneType = new GraphQLObjectType({
           request,
           { rootValue: { filterArtworksLoader } }
         ) => {
-          const gravityOptions = parseRelayOptions(options)
+          const gravityOptions = convertConnectionArgsToGravityArgs(options)
           // Do some massaging of the options for ElasticSearch
           gravityOptions.aggregations = options.aggregations || []
           gravityOptions.aggregations.push("total")

src/schema/gene_families.js

@@ -4,7 +4,7 @@ import {
   connectionDefinitions,
   connectionFromPromisedArray,
 } from "graphql-relay"
-import { parseRelayOptions } from "lib/helpers"
+import { convertConnectionArgsToGravityArgs } from "lib/helpers"
 
 const { connectionType: GeneFamilyConnection } = connectionDefinitions({
   nodeType: GeneFamily.type,
@@ -15,9 +15,13 @@ const GeneFamilies = {
   description: "A list of Gene Families",
   args: pageable(),
   resolve: (_root, options, _request, { rootValue }) => {
-    const gravityOptions = Object.assign({}, parseRelayOptions(options), {
-      sort: "position",
-    })
+    const gravityOptions = Object.assign(
+      {},
+      convertConnectionArgsToGravityArgs(options),
+      {
+        sort: "position",
+      }
+    )
     return connectionFromPromisedArray(
       rootValue.geneFamiliesLoader(gravityOptions),
       gravityOptions

src/schema/me/conversation/index.js

@@ -13,7 +13,7 @@ import {
 } from "graphql"
 import { pageable } from "relay-cursor-paging"
 import { connectionFromArraySlice, connectionDefinitions } from "graphql-relay"
-import { parseRelayOptions } from "lib/helpers"
+import { convertConnectionArgsToGravityArgs } from "lib/helpers"
 import { ArtworkType } from "schema/artwork"
 import { ShowType } from "schema/show"
 import { GlobalIDField, NodeInterface } from "schema/object_identification"
@@ -350,7 +350,7 @@ export const ConversationFields = {
       req,
       { rootValue: { conversationMessagesLoader } }
     ) => {
-      const { page, size, offset } = parseRelayOptions(options)
+      const { page, size, offset } = convertConnectionArgsToGravityArgs(options)
       return conversationMessagesLoader({
         page,
         size,