ra-data-graphql/src/introspection.test.ts

A GraphQL data provider for react-admin

import {
    introspectSchema,
    isResourceExcluded,
    isResourceIncluded,
} from './introspection';
import {
    GET_LIST,
    GET_ONE,
    GET_MANY,
    GET_MANY_REFERENCE,
    CREATE,
    UPDATE,
    DELETE,
} from 'ra-core';

describe('introspection', () => {
    describe('isResourceIncluded', () => {
        it('return false with an include option containing an array and tested type is not in it', () => {
            expect(
                isResourceIncluded(
                    {
                        name: 'NotMe',
                        kind: 'OBJECT',
                        fields: [],
                        interfaces: [],
                    },
                    {
                        include: ['Post', 'Comment'],
                    }
                )
            ).toBe(false);
        });

        it('return true with an include option containing an array and tested type is in it', () => {
            expect(
                isResourceIncluded(
                    {
                        name: 'Post',
                        kind: 'OBJECT',
                        fields: [],
                        interfaces: [],
                    },
                    {
                        include: ['Post', 'Comment'],
                    }
                )
            ).toBe(true);
        });

        it('return false with an include option containing an array and tested type is not in it', () => {
            expect(
                isResourceIncluded(
                    {
                        name: 'Post',
                        kind: 'OBJECT',
                        fields: [],
                        interfaces: [],
                    },
                    {
                        include: ['NotMe'],
                    }
                )
            ).toBe(false);
        });

        it('return true with an include option being a function returning true', () => {
            expect(
                isResourceIncluded(
                    {
                        name: 'Post',
                        kind: 'OBJECT',
                        fields: [],
                        interfaces: [],
                    },
                    { include: () => true }
                )
            ).toBe(true);
        });

        it('return false with an include option being a function returning false', () => {
            expect(
                isResourceIncluded(
                    {
                        name: 'Post',
                        kind: 'OBJECT',
                        fields: [],
                        interfaces: [],
                    },
                    { include: () => false }
                )
            ).toBe(false);
        });
    });

    describe('isResourceExcluded', () => {
        it('return true with an exclude option containing an array and tested type is in it', () => {
            expect(
                isResourceExcluded(
                    {
                        name: 'NotMe',
                        kind: 'OBJECT',
                        fields: [],
                        interfaces: [],
                    },
                    {
                        exclude: ['NotMe'],
                    }
                )
            ).toBe(true);
        });

        it('return true with an exclude option being a function returning true', () => {
            expect(
                isResourceExcluded(
                    {
                        name: 'Post',
                        kind: 'OBJECT',
                        fields: [],
                        interfaces: [],
                    },
                    { exclude: () => true }
                )
            ).toBe(true);
        });

        it('return false with an exclude option being a function returning false', () => {
            expect(
                isResourceExcluded(
                    {
                        name: 'Post',
                        kind: 'OBJECT',
                        fields: [],
                        interfaces: [],
                    },
                    { exclude: () => false }
                )
            ).toBe(false);
        });
    });

    describe('introspection parsing returns an object', () => {
        const client = {
            query: jest.fn(() =>
                Promise.resolve({
                    data: {
                        __schema: {
                            queryType: { name: 'Query' },
                            mutationType: { name: 'Mutation' },
                            types: [
                                {
                                    name: 'Query',
                                    fields: [
                                        { name: 'allPost' },
                                        { name: 'Post' },
                                        { name: 'allComment' },
                                        { name: 'Comment' },
                                    ],
                                },
                                {
                                    name: 'Mutation',
                                    fields: [
                                        { name: 'createPost' },
                                        { name: 'updatePost' },
                                        { name: 'deletePost' },
                                        { name: 'createIHavePartialCrud' },
                                        { name: 'updateIHavePartialCrud' },
                                        { name: 'deleteIHavePartialCrud' },
                                    ],
                                },
                                { name: 'Post' },
                                { name: 'Comment' },
                                { name: 'IHavePartialCrud' },
                                { name: 'ImExcluded' },
                            ],
                        },
                    },
                })
            ),
        };

        // @ts-ignore
        const introspectionResultsPromise = introspectSchema(client, {
            operationNames: {
                [GET_LIST]: resource => `all${resource.name}`,
                [GET_ONE]: resource => `${resource.name}`,
                [GET_MANY]: resource => `all${resource.name}`,
                [GET_MANY_REFERENCE]: resource => `all${resource.name}`,
                [CREATE]: resource => `create${resource.name}`,
                [UPDATE]: resource => `update${resource.name}`,
                [DELETE]: resource => `delete${resource.name}`,
            },
            exclude: ['ImExcluded'],
        });

        it('with a "types" array containing all types found', async () => {
            const introspectionResults = await introspectionResultsPromise;
            expect(introspectionResults.types).toHaveLength(4);
        });

        it('with a "queries" array containing all queries and mutations found', async () => {
            const introspectionResults = await introspectionResultsPromise;
            expect(introspectionResults.queries).toEqual([
                { name: 'allPost' },
                { name: 'Post' },
                { name: 'allComment' },
                { name: 'Comment' },
                { name: 'createPost' },
                { name: 'updatePost' },
                { name: 'deletePost' },
                { name: 'createIHavePartialCrud' },
                { name: 'updateIHavePartialCrud' },
                { name: 'deleteIHavePartialCrud' },
            ]);
        });

        it('with a "resources" array containing objects describing resources', async () => {
            const introspectionResults = await introspectionResultsPromise;
            expect(introspectionResults.resources).toEqual([
                {
                    type: { name: 'Post' },
                    [GET_LIST]: { name: 'allPost' },
                    [GET_ONE]: { name: 'Post' },
                    [GET_MANY]: { name: 'allPost' },
                    [GET_MANY_REFERENCE]: { name: 'allPost' },
                    [CREATE]: { name: 'createPost' },
                    [UPDATE]: { name: 'updatePost' },
                    [DELETE]: { name: 'deletePost' },
                },
                {
                    type: { name: 'Comment' },
                    [GET_LIST]: { name: 'allComment' },
                    [GET_ONE]: { name: 'Comment' },
                    [GET_MANY]: { name: 'allComment' },
                    [GET_MANY_REFERENCE]: { name: 'allComment' },
                },
                {
                    type: { name: 'IHavePartialCrud' },
                    [CREATE]: { name: 'createIHavePartialCrud' },
                    [UPDATE]: { name: 'updateIHavePartialCrud' },
                    [DELETE]: { name: 'deleteIHavePartialCrud' },
                },
            ]);
        });
    });
});