GraphQL Simple Data Provider Sparse Field Support

[maxschridde1494]

Sparse Field Support for Queries and Mutations

By default, most data provider requests return

1. All of the resource's top level fields as defined in the GraphQL schema
2. Association objects containing only the association's ID.

This feature enables sparse field support for all data provider requests. Sparse fields are passed through via the existing meta param. This can increase efficiency, optimize client performance, improve security and reduce over-fetching. Also, it allows for the request of nested association fields beyond just their ID. It is available for all dataprovider actions.

An example getOne request would look like:

dataProvider.getOne(
    'posts',
    { 
        id, 
        meta: { 
            sparseFields: [
                'id', 
                'title', 
                { 
                    comments: [
                        'description', 
                        { 
                            author : [
                                'name', 
                                'email'
                            ]
                        }
                    ]
                }
            ]
        }
    },
);

[slax57]

Hi,
Thank you so much for submitting this contribution.
It's gonna take us some time to review, as it's a quite substantial PR, but we are definitely willing to have a look.
Thank you for your patience.

[adguernier]

First review.
Great job 👍

[maxschridde1494]

@adguernier Thanks for your feedback. I went ahead and made the recommended changes and improved the processSparseFields function.

[djhi]

Neat! Thanks :)

[djhi]

I meant the eslint warnings :)

[maxschridde1494]

Ahh got it. Not sure how I missed those warnings. Changes pushed up :)

[djhi]

Even though the feature is nice, I'm a bit reluctant to merge it as ra-data-graphql-simple is merely an example implementation. Are you actually using this provider?

[maxschridde1494]

Yes, here at Talysto we have used ra-data-graphql-simple as a provider for many projects.

Over the years, our team has identified a fullstack application framework, which we are calling Groovestack, that powers many of our scalable applications across various industries. The stack consists of PostgreSQL, Rails, GraphQL and React-Admin. To connect our GraphQL APIs with React-Admin, we found that the flexibility of the ra-data-graphql-simple interface and recommended patterns / schema were a great starting point. We have made enhancements, some of which we found to be general purpose and are offering to the community through the PRs we have opened recently (more to come).

Here is a quick example demo of an admin dash powered by Groovestack CORE Jobs.

You can easily experiment with Groovestack and it's CORE modules by using our create-groovestack utility.