@luvio/graphql-parser 0.62.2

package/src/__tests__/main.spec.ts

@@ -0,0 +1,600 @@
+import * as parser from '../main';
+
+describe('LDS GraphQL Parser', () => {
+    describe('parseAndVisit', () => {
+        it('transforms GraphQL operation into a custom AST', () => {
+            const source = /* GraphQL */ `
+                query {
+                    uiapi {
+                        query {
+                            Account(where: { Name: { like: "Account1" } }) @connection {
+                                edges {
+                                    node @resource(type: "Record") {
+                                        Name {
+                                            value
+                                            displayValue
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            `;
+
+            const expected = {
+                kind: 'Document',
+                definitions: [
+                    {
+                        kind: 'OperationDefinition',
+                        operation: 'query',
+                        luvioSelections: [
+                            {
+                                kind: 'ObjectFieldSelection',
+                                name: 'uiapi',
+                                luvioSelections: [
+                                    {
+                                        kind: 'ObjectFieldSelection',
+                                        name: 'query',
+                                        luvioSelections: [
+                                            {
+                                                kind: 'CustomFieldSelection',
+                                                name: 'Account',
+                                                type: 'Connection',
+                                                luvioSelections: [
+                                                    {
+                                                        kind: 'ObjectFieldSelection',
+                                                        name: 'edges',
+                                                        luvioSelections: [
+                                                            {
+                                                                kind: 'CustomFieldSelection',
+                                                                name: 'node',
+                                                                type: 'Record',
+                                                                luvioSelections: [
+                                                                    {
+                                                                        kind: 'ObjectFieldSelection',
+                                                                        name: 'Name',
+                                                                        luvioSelections: [
+                                                                            {
+                                                                                kind: 'ScalarFieldSelection',
+                                                                                name: 'value',
+                                                                            },
+                                                                            {
+                                                                                kind: 'ScalarFieldSelection',
+                                                                                name: 'displayValue',
+                                                                            },
+                                                                        ],
+                                                                    },
+                                                                ],
+                                                            },
+                                                        ],
+                                                    },
+                                                ],
+                                                arguments: [
+                                                    {
+                                                        kind: 'Argument',
+                                                        name: 'where',
+                                                        value: {
+                                                            kind: 'ObjectValue',
+                                                            fields: {
+                                                                Name: {
+                                                                    kind: 'ObjectValue',
+                                                                    fields: {
+                                                                        like: {
+                                                                            kind: 'StringValue',
+                                                                            value: 'Account1',
+                                                                        },
+                                                                    },
+                                                                },
+                                                            },
+                                                        },
+                                                    },
+                                                ],
+                                            },
+                                        ],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            };
+
+            const target = parser.parseAndVisit(source);
+
+            expect(target).toStrictEqual(expected);
+        });
+
+        it('transforms GraphQL connection directive on child property', () => {
+            const source = /* GraphQL */ `
+                query {
+                    uiapi {
+                        query {
+                            Account(where: { Name: { like: "Account1" } }) @connection {
+                                edges {
+                                    node @resource(type: "Record") {
+                                        Child @connection {
+                                            edges {
+                                                Id
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            `;
+
+            const expected = {
+                kind: 'Document',
+                definitions: [
+                    {
+                        kind: 'OperationDefinition',
+                        operation: 'query',
+                        luvioSelections: [
+                            {
+                                kind: 'ObjectFieldSelection',
+                                name: 'uiapi',
+                                luvioSelections: [
+                                    {
+                                        kind: 'ObjectFieldSelection',
+                                        name: 'query',
+                                        luvioSelections: [
+                                            {
+                                                kind: 'CustomFieldSelection',
+                                                name: 'Account',
+                                                type: 'Connection',
+                                                luvioSelections: [
+                                                    {
+                                                        kind: 'ObjectFieldSelection',
+                                                        name: 'edges',
+                                                        luvioSelections: [
+                                                            {
+                                                                kind: 'CustomFieldSelection',
+                                                                name: 'node',
+                                                                type: 'Record',
+                                                                luvioSelections: [
+                                                                    {
+                                                                        kind: 'CustomFieldSelection',
+                                                                        name: 'Child',
+                                                                        type: 'Connection',
+                                                                        luvioSelections: [
+                                                                            {
+                                                                                kind: 'ObjectFieldSelection',
+                                                                                name: 'edges',
+                                                                                luvioSelections: [
+                                                                                    {
+                                                                                        kind: 'ScalarFieldSelection',
+                                                                                        name: 'Id',
+                                                                                    },
+                                                                                ],
+                                                                            },
+                                                                        ],
+                                                                    },
+                                                                ],
+                                                            },
+                                                        ],
+                                                    },
+                                                ],
+                                                arguments: [
+                                                    {
+                                                        kind: 'Argument',
+                                                        name: 'where',
+                                                        value: {
+                                                            kind: 'ObjectValue',
+                                                            fields: {
+                                                                Name: {
+                                                                    kind: 'ObjectValue',
+                                                                    fields: {
+                                                                        like: {
+                                                                            kind: 'StringValue',
+                                                                            value: 'Account1',
+                                                                        },
+                                                                    },
+                                                                },
+                                                            },
+                                                        },
+                                                    },
+                                                ],
+                                            },
+                                        ],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            };
+
+            const target = parser.parseAndVisit(source);
+
+            expect(target).toStrictEqual(expected);
+        });
+
+        it('transforms GraphQL fragment into a custom AST', () => {
+            const source = /* GraphQL */ `
+                fragment requiredFields on Record {
+                    id
+                    WeakEtag
+                    ApiName
+                    DisplayValue
+                    LastModifiedById {
+                        value
+                    }
+                    LastModifiedDate {
+                        value
+                    }
+                    SystemModstamp {
+                        value
+                    }
+                    RecordTypeId {
+                        value
+                    }
+                }
+            `;
+
+            const expected = {
+                kind: 'Document',
+                definitions: [
+                    {
+                        kind: 'FragmentDefinition',
+                        name: 'requiredFields',
+                        typeCondition: { kind: 'NamedType', name: 'Record' },
+                        luvioSelections: [
+                            { kind: 'ScalarFieldSelection', name: 'id' },
+                            { kind: 'ScalarFieldSelection', name: 'WeakEtag' },
+                            { kind: 'ScalarFieldSelection', name: 'ApiName' },
+                            { kind: 'ScalarFieldSelection', name: 'DisplayValue' },
+                            {
+                                kind: 'ObjectFieldSelection',
+                                name: 'LastModifiedById',
+                                luvioSelections: [{ kind: 'ScalarFieldSelection', name: 'value' }],
+                            },
+                            {
+                                kind: 'ObjectFieldSelection',
+                                name: 'LastModifiedDate',
+                                luvioSelections: [{ kind: 'ScalarFieldSelection', name: 'value' }],
+                            },
+                            {
+                                kind: 'ObjectFieldSelection',
+                                name: 'SystemModstamp',
+                                luvioSelections: [{ kind: 'ScalarFieldSelection', name: 'value' }],
+                            },
+                            {
+                                kind: 'ObjectFieldSelection',
+                                name: 'RecordTypeId',
+                                luvioSelections: [{ kind: 'ScalarFieldSelection', name: 'value' }],
+                            },
+                        ],
+                    },
+                ],
+            };
+
+            const target = parser.parseAndVisit(source);
+            expect(target).toStrictEqual(expected);
+        });
+
+        it('throws an error for unsupported GraphQL definition', () => {
+            const source = /* GraphQL */ `
+                type Character {
+                    name: String!
+                    appearsIn: [Episode!]!
+                }
+            `;
+
+            expect(() => parser.parseAndVisit(source)).toThrowError(
+                'Unsupported ObjectTypeDefinition definition. Only OperationDefinition and FragmentDefinition are supported in a GraphQL Document'
+            );
+        });
+
+        it('throws an error for unsupported GraphQL operation definition', () => {
+            const source = /* GraphQL */ `
+                mutation CreateReviewForEpisode($ep: Episode!, $review: ReviewInput!) {
+                    createReview(episode: $ep, review: $review) {
+                        stars
+                        commentary
+                    }
+                }
+            `;
+
+            expect(() => parser.parseAndVisit(source)).toThrowError(
+                'Unsupported mutation operation. Only query operation is supported'
+            );
+        });
+
+        it('transforms variable definitions', () => {
+            const source = /* GraphQL */ `
+                query HeroNameAndFriends($episode: Episode = JEDI) {
+                    hero(episode: $episode) {
+                        name
+                        friends {
+                            name
+                        }
+                    }
+                }
+            `;
+
+            const expected = {
+                kind: 'Document',
+                definitions: [
+                    {
+                        kind: 'OperationDefinition',
+                        operation: 'query',
+                        name: 'HeroNameAndFriends',
+                        luvioSelections: [
+                            {
+                                kind: 'ObjectFieldSelection',
+                                name: 'hero',
+                                luvioSelections: [
+                                    { kind: 'ScalarFieldSelection', name: 'name' },
+                                    {
+                                        kind: 'ObjectFieldSelection',
+                                        name: 'friends',
+                                        luvioSelections: [
+                                            { kind: 'ScalarFieldSelection', name: 'name' },
+                                        ],
+                                    },
+                                ],
+                                arguments: [
+                                    {
+                                        kind: 'Argument',
+                                        name: 'episode',
+                                        value: { kind: 'Variable', name: 'episode' },
+                                    },
+                                ],
+                            },
+                        ],
+                        variableDefinitions: [
+                            {
+                                kind: 'VariableDefinition',
+                                variable: { kind: 'Variable', name: 'episode' },
+                                type: { kind: 'NamedType', name: 'Episode' },
+                                defaultValue: { kind: 'EnumValue', value: 'JEDI' },
+                            },
+                        ],
+                    },
+                ],
+            };
+
+            const target = parser.parseAndVisit(source);
+
+            expect(target).toStrictEqual(expected);
+        });
+
+        it("throws an error when variable definition isn't used", () => {
+            const source = /* GraphQL */ `
+                query HeroNameAndFriends($episode: Episode = JEDI) {
+                    hero(episode: JEDI) {
+                        name
+                        friends {
+                            name
+                        }
+                    }
+                }
+            `;
+
+            expect(() => parser.parseAndVisit(source)).toThrowError(
+                'Variable $episode was defined but never used.'
+            );
+        });
+
+        it("throws an error when variable used isn't defined", () => {
+            const source = /* GraphQL */ `
+                query HeroNameAndFriends {
+                    hero(episode: $episode) {
+                        name
+                        friends {
+                            name
+                        }
+                    }
+                }
+            `;
+
+            expect(() => parser.parseAndVisit(source)).toThrowError(
+                'Variable $episode was used but never defined.'
+            );
+        });
+
+        it('transform directives', () => {
+            const source = /* GraphQL */ `
+                query Hero($episode: Episode) {
+                    hero(episode: $episode) {
+                        name
+                        friends @include(if: true) {
+                            name
+                        }
+                    }
+                }
+            `;
+
+            const expected = {
+                kind: 'Document',
+                definitions: [
+                    {
+                        kind: 'OperationDefinition',
+                        operation: 'query',
+                        name: 'Hero',
+                        luvioSelections: [
+                            {
+                                kind: 'ObjectFieldSelection',
+                                name: 'hero',
+                                luvioSelections: [
+                                    { kind: 'ScalarFieldSelection', name: 'name' },
+                                    {
+                                        kind: 'ObjectFieldSelection',
+                                        name: 'friends',
+                                        luvioSelections: [
+                                            { kind: 'ScalarFieldSelection', name: 'name' },
+                                        ],
+                                        directives: [
+                                            {
+                                                kind: 'Directive',
+                                                name: 'include',
+                                                arguments: [
+                                                    {
+                                                        kind: 'Argument',
+                                                        name: 'if',
+                                                        value: {
+                                                            kind: 'BooleanValue',
+                                                            value: true,
+                                                        },
+                                                    },
+                                                ],
+                                            },
+                                        ],
+                                    },
+                                ],
+                                arguments: [
+                                    {
+                                        kind: 'Argument',
+                                        name: 'episode',
+                                        value: { kind: 'Variable', name: 'episode' },
+                                    },
+                                ],
+                            },
+                        ],
+                        variableDefinitions: [
+                            {
+                                kind: 'VariableDefinition',
+                                variable: { kind: 'Variable', name: 'episode' },
+                                type: { kind: 'NamedType', name: 'Episode' },
+                            },
+                        ],
+                    },
+                ],
+            };
+
+            const target = parser.parseAndVisit(source);
+
+            expect(target).toStrictEqual(expected);
+        });
+
+        it('transform fragment spread', () => {
+            const source = /* GraphQL */ `
+                {
+                    aliasTest: hero(episode: EMPIRE) {
+                        ...nameField
+                        appearsIn
+                    }
+                }
+
+                fragment nameField on Character {
+                    name
+                }
+            `;
+
+            const expected = {
+                kind: 'Document',
+                definitions: [
+                    {
+                        kind: 'OperationDefinition',
+                        operation: 'query',
+                        luvioSelections: [
+                            {
+                                kind: 'ObjectFieldSelection',
+                                name: 'hero',
+                                luvioSelections: [
+                                    { kind: 'FragmentSpread', name: 'nameField' },
+                                    { kind: 'ScalarFieldSelection', name: 'appearsIn' },
+                                ],
+                                arguments: [
+                                    {
+                                        kind: 'Argument',
+                                        name: 'episode',
+                                        value: { kind: 'EnumValue', value: 'EMPIRE' },
+                                    },
+                                ],
+                                alias: 'aliasTest',
+                            },
+                        ],
+                    },
+                    {
+                        kind: 'FragmentDefinition',
+                        name: 'nameField',
+                        typeCondition: { kind: 'NamedType', name: 'Character' },
+                        luvioSelections: [{ kind: 'ScalarFieldSelection', name: 'name' }],
+                    },
+                ],
+            };
+
+            const target = parser.parseAndVisit(source);
+
+            expect(target).toStrictEqual(expected);
+        });
+
+        it('transform inline fragment', () => {
+            const source = /* GraphQL */ `
+                query HeroForEpisode($ep: Episode!) {
+                    hero(episode: $ep) {
+                        name
+                        ... on Droid {
+                            primaryFunction
+                        }
+                        ... on Human {
+                            height
+                        }
+                    }
+                }
+            `;
+
+            const expected = {
+                kind: 'Document',
+                definitions: [
+                    {
+                        kind: 'OperationDefinition',
+                        operation: 'query',
+                        luvioSelections: [
+                            {
+                                kind: 'ObjectFieldSelection',
+                                name: 'hero',
+                                luvioSelections: [
+                                    { kind: 'ScalarFieldSelection', name: 'name' },
+                                    {
+                                        kind: 'InlineFragment',
+                                        luvioSelections: [
+                                            {
+                                                kind: 'ScalarFieldSelection',
+                                                name: 'primaryFunction',
+                                            },
+                                        ],
+                                        typeCondition: { kind: 'NamedType', name: 'Droid' },
+                                    },
+                                    {
+                                        kind: 'InlineFragment',
+                                        luvioSelections: [
+                                            { kind: 'ScalarFieldSelection', name: 'height' },
+                                        ],
+                                        typeCondition: { kind: 'NamedType', name: 'Human' },
+                                    },
+                                ],
+                                arguments: [
+                                    {
+                                        kind: 'Argument',
+                                        name: 'episode',
+                                        value: { kind: 'Variable', name: 'ep' },
+                                    },
+                                ],
+                            },
+                        ],
+                        name: 'HeroForEpisode',
+                        variableDefinitions: [
+                            {
+                                kind: 'VariableDefinition',
+                                variable: { kind: 'Variable', name: 'ep' },
+                                type: {
+                                    kind: 'NonNullType',
+                                    type: { kind: 'NamedType', name: 'Episode' },
+                                },
+                            },
+                        ],
+                    },
+                ],
+            };
+
+            const target = parser.parseAndVisit(source);
+
+            expect(target).toStrictEqual(expected);
+        });
+    });
+});

package/src/__tests__/type-node.spec.ts

@@ -0,0 +1,82 @@
+import { NamedTypeNode, TypeNode } from 'graphql/language';
+import { transform } from '../type-node';
+
+describe('Luvio GraphQL TypeNode transform', () => {
+    it('returns LuvioTypeNode when input is GraphQL NamedTypeNode', () => {
+        expect(
+            transform({
+                kind: 'NamedType',
+                name: {
+                    kind: 'Name',
+                    value: 'test',
+                },
+            })
+        ).toStrictEqual({
+            kind: 'NamedType',
+            name: 'test',
+        });
+    });
+
+    it('returns LuvioTypeNode when input is GraphQL ListTypeNode', () => {
+        expect(
+            transform({
+                kind: 'ListType',
+                type: {
+                    kind: 'NamedType',
+                    name: {
+                        kind: 'Name',
+                        value: 'test',
+                    },
+                },
+            })
+        ).toStrictEqual({
+            kind: 'ListType',
+            type: {
+                kind: 'NamedType',
+                name: 'test',
+            },
+        });
+    });
+
+    it('returns LuvioTypeNode when input is GraphQL NonNullTypeNode', () => {
+        expect(
+            transform({
+                kind: 'NonNullType',
+                type: {
+                    kind: 'NamedType',
+                    name: {
+                        kind: 'Name',
+                        value: 'test',
+                    },
+                },
+            })
+        ).toStrictEqual({
+            kind: 'NonNullType',
+            type: {
+                kind: 'NamedType',
+                name: 'test',
+            },
+        });
+    });
+
+    it('throws when input is unsupported TypeNode', () => {
+        expect(() =>
+            transform({
+                kind: 'Unknown',
+                name: 'test',
+            } as unknown as TypeNode)
+        ).toThrowError('Unsupported TypeNode');
+    });
+
+    it('throws when input is unsupported NonNullTypeNode', () => {
+        expect(() =>
+            transform({
+                kind: 'NonNullType',
+                type: {
+                    kind: 'Unknown',
+                    name: 'test',
+                } as unknown as NamedTypeNode,
+            })
+        ).toThrowError('Unsupported NonNullTypeNode');
+    });
+});