aor-graphql-client

aor-graphql-client

A GraphQL client for admin-on-rest built with Apollo

A version of the admin-on-rest demo using this client is available at https://marmelab.com/admin-on-rest-graphql-demo.
The source code for this demo is available at https://github.com/marmelab/admin-on-rest-graphql-demo.

• Installation
• Usage
• Options

This is a very low level library which is not meant to be used directly unless you really want full control or are building a custom GraphQL client.

It provides the foundations for other packages such as:

• aor-graphql-client-simple
• aor-graphql-client-graphcool

About GraphQL and Apollo

This library is meant to be used with Apollo on the client side but you're free to use any graphql server.

Installation

Install with:

npm install --save aor-graphql-client

or

yarn add aor-graphql-client

Usage

// in App.js
import React, { Component } from 'react';
import buildApolloClient from 'aor-graphql-client';

import { Admin, Resource } from 'admin-on-rest';
import { Delete } from 'admin-on-rest/lib/mui';

import { PostCreate, PostEdit, PostList } from '../components/admin/posts';

const client = new ApolloClient();

class App extends Component {
    constructor() {
        super();
        this.state = { restClient: null };
    }
    componentDidMount() {
        buildApolloClient()
            .then(restClient => this.setState({ restClient }));
    }

    render() {
        const { restClient } = this.state;

        if (!restClient) {
            return <div>Loading</div>;
        }

        return (
            <Admin restClient={restClient}>
                <Resource name="Post" list={PostList} edit={PostEdit} create={PostCreate} remove={Delete} />
            </Admin>
        );
    }
}

export default App;

Options

Customize the Apollo client

You can specify the client options by calling buildApolloClient like this:

import { createNetworkInterface } from 'react-apollo';

buildApolloClient({
    clientOptions: {
        networkInterface: createNetworkInterface({
            uri: 'http://api.myproduct.com/graphql',
        }),
    },
});

You can pass any options supported by the ApolloClient contructor with the addition of uri which can be specified so that we create the network interface for you.

You can also supply your own ApolloClient instance directly with:

buildApolloClient({ client: myClient });

IntrospectionOptions

Instead of running an IntrospectionQuery you can also provide the IntrospectionQuery result directly. This speeds up the initial rendering of the Admin component as it no longer has to wait for the introspection query request to resolve.

import { __schema as schema } from './schema';

const introspectionOptions = {
  schema
};

buildApolloClient({
    introspection: introspectionOptions
});

The ./schema file is a schema.json in ./scr retrieved with get-graphql-schema --json <graphql_endpoint>.

Note: Importing the schema.json file will significantly increase the bundle size.

Specify your queries and mutations

For the client to know how to map Admin-on-rest request to apollo queries and mutations, you must provide a queryBuilder option. The queryBuilder is a factory function which will be called with the introspection query result.

The introspection result is an object with 3 properties:

• types: an array of all the GraphQL types discovered on your endpoint
• queries: an array of all the GraphQL queries and mutations discovered on your endpoint
• resources: an array of objects with a type property, which is the GraphQL type for this resource, and a property for each Admin-on-rest fetch verb for which we found a matching query or mutation

For example:

{
    types: [
        {
            name: 'Post',
            kind: 'OBJECT',
            fields: [
                { name: 'id', type: { kind: 'NON_NULL', ofType: { kind: 'SCALAR', name: 'ID' } } },
                { name: 'title', type: { kind: 'NON_NULL', ofType: { kind: 'SCALAR', name: 'String' } } },
                ...
            ]
        },
        ...
    ],
    queries: [
        {
            name: 'createPost',
            args: [
                { name: 'title', type: { kind: 'NON_NULL', ofType: { kind: 'SCALAR', name: 'String' } } }
            ],
            type : { kind: 'OBJECT', name: 'Category' }
        },
        ...
    ],
    resources: [
        {
            type: {
                name: 'Post',
                kind: 'OBJECT',
                fields: [
                    { name: 'id', type: { kind: 'NON_NULL', ofType: { kind: 'SCALAR', name: 'ID' } } },
                    { name: 'title', type: { kind: 'NON_NULL', ofType: { kind: 'SCALAR', name: 'String' } } },
                    ...
                ]
            },
            GET_LIST: {
                name: 'createPost',
                args: [
                    { name: 'title', type: { kind: 'NON_NULL', ofType: { kind: 'SCALAR', name: 'String' } } }
                ],
                type : { kind: 'OBJECT', name: 'Category' }
            },
            ...
        }
    ]
}

The queryBuilder function must return a function which will be called with the same parameters as the Admin-on-rest client but must return an object matching the options of the ApolloClient query method with an additional parseResponse function.

This parseResponse function will be called with an ApolloQueryResult and must returns the data expected by Admin-on-rest.

For example:

import buildFieldList from './buildFieldList';

const queryBuilder = introspectionResults => (aorFetchType, resourceName, params) => {
    const resource = introspectionResults.resource.find(r => r.type.name === resourceName);

    switch (aorFetchType) {
        case 'GET_ONE':
            return {
                query: gql`query ${resource[aorFetchType].name}($id: ID) {
                    data: ${resource[aorFetchType].name}(id: $id) {
                        ${buildFieldList(introspectionResults, resource, aorFetchType)}
                    }
                }`,
                variables: params, // params = { id: ... }
                parseResponse: response => response.data,
            }
            break;
        // ... other types handled here
    }
}

buildApolloClient({ queryBuilder });

Troubleshooting

When I create or edit a resource, the list or edit page does not refresh its data

admin-on-rest maintain its own cache of resources data but, by default, so does the Apollo client. For every queries, we inject a default fetchPolicy set to network-only so that the Apollo client always refetch the data when requested.

Do not override this fetchPolicy.

Contributing

Run the tests with this command:

make test