Add a GET_COUNT fetch action for graphql dataProvider

marmelab · Oct 15, 2020 · b209df2 · b209df2
1 parent aad6285
commit b209df2
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 5 deletions.
diff --git a/packages/ra-data-graphql-simple/src/buildGqlQuery.js b/packages/ra-data-graphql-simple/src/buildGqlQuery.js
@@ -1,5 +1,5 @@
 import { GET_LIST, GET_MANY, GET_MANY_REFERENCE, DELETE } from 'ra-core';
-import { QUERY_TYPES } from 'ra-data-graphql';
+import { QUERY_TYPES, GET_COUNT } from 'ra-data-graphql';
 import { TypeKind } from 'graphql';
 import * as gqlTypes from 'graphql-ast-types-browser';
 
@@ -164,6 +164,15 @@ export default introspectionResults => (
     queryType,
     variables
 ) => {
+    console.log(resource);
+    const countType = resource[GET_COUNT];
+
+    if (!countType) {
+        throw new Error(
+            `No query or mutation matching fetch type ${GET_COUNT} could be found for resource ${resource.type.name}`
+        );
+    }
+
     const { sortField, sortOrder, ...metaVariables } = variables;
     const apolloArgs = buildApolloArgs(queryType, variables);
     const args = buildArgs(queryType, variables);
@@ -186,7 +195,7 @@ export default introspectionResults => (
                         gqlTypes.selectionSet(fields)
                     ),
                     gqlTypes.field(
-                        gqlTypes.name(`_${queryType.name}Meta`),
+                        gqlTypes.name(countType.name),
                         gqlTypes.name('total'),
                         metaArgs,
                         null,

diff --git a/packages/ra-data-graphql-simple/src/buildGqlQuery.test.js b/packages/ra-data-graphql-simple/src/buildGqlQuery.test.js
@@ -8,6 +8,7 @@ import {
     CREATE,
     DELETE,
 } from 'ra-core';
+import { GET_COUNT } from 'ra-data-graphql';
 import buildGqlQuery, {
     buildApolloArgs,
     buildArgs,
@@ -293,6 +294,7 @@ describe('buildGqlQuery', () => {
     };
 
     const resource = {
+        [GET_COUNT]: { name: '_allCommandMeta' },
         type: {
             fields: [
                 { type: { kind: TypeKind.SCALAR, name: '' }, name: 'foo' },

diff --git a/packages/ra-data-graphql-simple/src/index.js b/packages/ra-data-graphql-simple/src/index.js
@@ -1,12 +1,16 @@
 import merge from 'lodash/merge';
-import buildDataProvider from 'ra-data-graphql';
+import buildDataProvider, {
+    GET_COUNT as INNER_GET_COUNT,
+} from 'ra-data-graphql';
 import { DELETE, DELETE_MANY, UPDATE, UPDATE_MANY } from 'ra-core';
 
 import defaultBuildQuery from './buildQuery';
 const defaultOptions = {
     buildQuery: defaultBuildQuery,
 };
 
+export const GET_COUNT = INNER_GET_COUNT;
+
 export const buildQuery = defaultBuildQuery;
 
 export default options => {

diff --git a/packages/ra-data-graphql/src/constants.js b/packages/ra-data-graphql/src/constants.js
@@ -10,7 +10,14 @@ import {
     DELETE_MANY,
 } from 'ra-core';
 
-export const QUERY_TYPES = [GET_LIST, GET_MANY, GET_MANY_REFERENCE, GET_ONE];
+export const GET_COUNT = 'GET_COUNT';
+export const QUERY_TYPES = [
+    GET_LIST,
+    GET_MANY,
+    GET_MANY_REFERENCE,
+    GET_ONE,
+    GET_COUNT,
+];
 export const MUTATION_TYPES = [
     CREATE,
     UPDATE,

diff --git a/packages/ra-data-graphql/src/index.js b/packages/ra-data-graphql/src/index.js
@@ -16,17 +16,20 @@ import {
     QUERY_TYPES as INNER_QUERY_TYPES,
     MUTATION_TYPES as INNER_MUTATION_TYPES,
     ALL_TYPES as INNER_ALL_TYPES,
+    GET_COUNT as INNER_GET_COUNT,
 } from './constants';
 import defaultResolveIntrospection from './introspection';
 export const QUERY_TYPES = INNER_QUERY_TYPES;
 export const MUTATION_TYPES = INNER_MUTATION_TYPES;
 export const ALL_TYPES = INNER_ALL_TYPES;
+export const GET_COUNT = INNER_GET_COUNT;
 
 const defaultOptions = {
     resolveIntrospection: defaultResolveIntrospection,
     introspection: {
         operationNames: {
             [GET_LIST]: resource => `all${pluralize(resource.name)}`,
+            [GET_COUNT]: resource => `_all${pluralize(resource.name)}Meta`,
             [GET_ONE]: resource => `${resource.name}`,
             [GET_MANY]: resource => `all${pluralize(resource.name)}`,
             [GET_MANY_REFERENCE]: resource => `all${pluralize(resource.name)}`,

diff --git a/packages/ra-data-graphql/src/introspection.js b/packages/ra-data-graphql/src/introspection.js
@@ -2,7 +2,7 @@ import { getIntrospectionQuery } from 'graphql';
 import gql from 'graphql-tag';
 import { GET_LIST, GET_ONE } from 'ra-core';
 
-import { ALL_TYPES } from './constants';
+import { ALL_TYPES, GET_COUNT } from './constants';
 
 export const isResourceIncluded = ({ include, type }) => {
     if (Array.isArray(include)) {
@@ -70,6 +70,9 @@ export default async (client, options) => {
             ) &&
             queries.some(
                 query => query.name === options.operationNames[GET_ONE](type)
+            ) &&
+            queries.some(
+                query => query.name === options.operationNames[GET_COUNT](type)
             )
         );
     };

diff --git a/packages/ra-data-graphql/src/introspection.test.js b/packages/ra-data-graphql/src/introspection.test.js
@@ -11,6 +11,7 @@ import {
     UPDATE,
     DELETE,
 } from 'ra-core';
+import { GET_COUNT } from './constants';
 
 describe('introspection', () => {
     describe('isResourceIncluded', () => {
@@ -102,8 +103,10 @@ describe('introspection', () => {
                                     name: 'Query',
                                     fields: [
                                         { name: 'allPost' },
+                                        { name: '_allPostMeta' },
                                         { name: 'Post' },
                                         { name: 'allComment' },
+                                        { name: '_allCommentMeta' },
                                         { name: 'Comment' },
                                     ],
                                 },
@@ -134,6 +137,7 @@ describe('introspection', () => {
                 [GET_LIST]: resource => `all${resource.name}`,
                 [GET_ONE]: resource => `${resource.name}`,
                 [GET_MANY]: resource => `all${resource.name}`,
+                [GET_COUNT]: resource => `_all${resource.name}Meta`,
                 [GET_MANY_REFERENCE]: resource => `all${resource.name}`,
                 [CREATE]: resource => `create${resource.name}`,
                 [UPDATE]: resource => `update${resource.name}`,
@@ -151,8 +155,10 @@ describe('introspection', () => {
             const introspectionResults = await introspectionResultsPromise;
             expect(introspectionResults.queries).toEqual([
                 { name: 'allPost' },
+                { name: '_allPostMeta' },
                 { name: 'Post' },
                 { name: 'allComment' },
+                { name: '_allCommentMeta' },
                 { name: 'Comment' },
                 { name: 'createPost' },
                 { name: 'updatePost' },
@@ -171,6 +177,7 @@ describe('introspection', () => {
                     [GET_LIST]: { name: 'allPost' },
                     [GET_ONE]: { name: 'Post' },
                     [GET_MANY]: { name: 'allPost' },
+                    [GET_COUNT]: { name: '_allPostMeta' },
                     [GET_MANY_REFERENCE]: { name: 'allPost' },
                     [CREATE]: { name: 'createPost' },
                     [UPDATE]: { name: 'updatePost' },
@@ -181,6 +188,7 @@ describe('introspection', () => {
                     [GET_LIST]: { name: 'allComment' },
                     [GET_ONE]: { name: 'Comment' },
                     [GET_MANY]: { name: 'allComment' },
+                    [GET_COUNT]: { name: '_allCommentMeta' },
                     [GET_MANY_REFERENCE]: { name: 'allComment' },
                 },
             ]);