@khanacademy/graphql-flow 0.1.0 → 0.2.2

package/src/__test__/graphql-flow.test.js

@@ -30,7 +30,14 @@ const rawQueryToFlowTypes = (query: string, options?: Options): string => {
         scalars: {PositiveNumber: 'number'},
         ...options,
     })
-        .map(({code}) => code)
+        .map(
+            ({typeName, code, extraTypes}) =>
+                `// ${typeName}.js\n${code}` +
+                Object.keys(extraTypes)
+                    .sort()
+                    .map((k) => `\nexport type ${k} = ${extraTypes[k]};`)
+                    .join(''),
+        )
         .join('\n\n');
 };
 
@@ -43,6 +50,7 @@ describe('graphql-flow generation', () => {
         `);
 
         expect(result).toMatchInlineSnapshot(`
+            // SomeQueryType.js
             export type SomeQueryType = {|
                 variables: {|
               candies: number
@@ -54,6 +62,33 @@ describe('graphql-flow generation', () => {
         `);
     });
 
+    it('should split types', () => {
+        const result = rawQueryToFlowTypes(
+            `
+            query SomeQuery($id: String!) {
+                human(id: $id) { id }
+            }
+        `,
+            {splitTypes: true},
+        );
+
+        expect(result).toMatchInlineSnapshot(`
+            // SomeQueryType.js
+            export type SomeQueryType = {|
+                variables: {|
+              id: string
+            |},
+                response: {|
+
+              /** A human character*/
+              human: ?{|
+                id: string
+              |}
+            |}
+            |};
+        `);
+    });
+
     it('should work with a basic query', () => {
         const result = rawQueryToFlowTypes(`
             query SomeQuery {
@@ -69,20 +104,21 @@ describe('graphql-flow generation', () => {
         `);
 
         expect(result).toMatchInlineSnapshot(`
+            // SomeQueryType.js
             export type SomeQueryType = {|
                 variables: {||},
                 response: {|
 
               /** A human character*/
               human: ?{|
+                friends: ?$ReadOnlyArray<?{|
+                  name: ?string
+                |}>,
+                homePlanet: ?string,
                 id: string,
 
                 /** The person's name*/
                 name: ?string,
-                homePlanet: ?string,
-                friends: ?$ReadOnlyArray<?{|
-                  name: ?string
-                |}>,
               |}
             |}
             |};
@@ -99,6 +135,7 @@ describe('graphql-flow generation', () => {
         `);
 
         expect(result).toMatchInlineSnapshot(`
+            // SomeQueryType.js
             export type SomeQueryType = {|
                 variables: {||},
                 response: {|
@@ -128,20 +165,21 @@ describe('graphql-flow generation', () => {
             }
         `);
         expect(result).toMatchInlineSnapshot(`
+            // SomeQueryType.js
             export type SomeQueryType = {|
                 variables: {||},
                 response: {|
               friend: ?({|
-                __typename: "Human",
-                id: string,
-                hands: ?number,
+                __typename: "Animal"
               |} | {|
                 __typename: "Droid",
 
                 /** The robot's primary function*/
-                primaryFunction: ?string,
+                primaryFunction: string,
               |} | {|
-                __typename: "Animal"
+                __typename: "Human",
+                hands: ?number,
+                id: string,
               |})
             |}
             |};
@@ -178,48 +216,64 @@ describe('graphql-flow generation', () => {
         `);
 
         expect(result).toMatchInlineSnapshot(`
+            // SomeQueryType.js
             export type SomeQueryType = {|
                 variables: {||},
                 response: {|
 
               /** A human character*/
               human: ?{|
-                id: string,
-
-                /** The person's name*/
-                name: ?string,
-                homePlanet: ?string,
-                hands: ?number,
                 alive: ?boolean,
                 friends: ?$ReadOnlyArray<?({|
-                  __typename: "Human",
-                  id: string,
-                  name: ?string,
-                  friends: ?$ReadOnlyArray<?{|
-                    id: string
-                  |}>,
+                  __typename: "Droid",
                   appearsIn: ?$ReadOnlyArray<
                   /** - NEW_HOPE
                   - EMPIRE
                   - JEDI*/
                   ?("NEW_HOPE" | "EMPIRE" | "JEDI")>,
-                  hands: ?number,
-                |} | {|
-                  __typename: "Droid",
-                  id: string,
-                  name: ?string,
                   friends: ?$ReadOnlyArray<?{|
                     id: string
                   |}>,
+                  id: string,
+                  name: ?string,
+                |} | {|
+                  __typename: "Human",
                   appearsIn: ?$ReadOnlyArray<
                   /** - NEW_HOPE
                   - EMPIRE
                   - JEDI*/
                   ?("NEW_HOPE" | "EMPIRE" | "JEDI")>,
+                  friends: ?$ReadOnlyArray<?{|
+                    id: string
+                  |}>,
+                  hands: ?number,
+                  id: string,
+                  name: ?string,
                 |})>,
+                hands: ?number,
+                homePlanet: ?string,
+                id: string,
+
+                /** The person's name*/
+                name: ?string,
               |}
             |}
             |};
+
+            // Profile.js
+            export type Profile = {|
+              __typename: "Droid" | "Human",
+              appearsIn: ?$ReadOnlyArray<
+              /** - NEW_HOPE
+              - EMPIRE
+              - JEDI*/
+              ?("NEW_HOPE" | "EMPIRE" | "JEDI")>,
+              friends: ?$ReadOnlyArray<?{|
+                id: string
+              |}>,
+              id: string,
+              name: ?string,
+            |};
         `);
     });
 
@@ -238,6 +292,7 @@ describe('graphql-flow generation', () => {
         );
 
         expect(result).toMatchInlineSnapshot(`
+            // SomeQueryType.js
             export type SomeQueryType = {|
                 variables: {||},
                 response: {|
@@ -283,6 +338,158 @@ describe('graphql-flow generation', () => {
         });
     });
 
+    describe('Fragments', () => {
+        it('should resolve correctly, and produce a type file for the fragment', () => {
+            const result = rawQueryToFlowTypes(
+                `query Hello {
+                    hero(episode: JEDI) {
+                        ...onChar
+                    }
+                }
+
+                fragment onChar on Character {
+                    __typename
+                    ... on Droid {
+                        primaryFunction
+                    }
+                }`,
+            );
+            expect(result).toMatchInlineSnapshot(`
+                // HelloType.js
+                export type HelloType = {|
+                    variables: {||},
+                    response: {|
+                  hero: ?({|
+                    __typename: "Droid",
+
+                    /** The robot's primary function*/
+                    primaryFunction: string,
+                  |} | {|
+                    __typename: "Human"
+                  |})
+                |}
+                |};
+
+                // onChar.js
+                export type onChar = {|
+                  __typename: "Droid",
+
+                  /** The robot's primary function*/
+                  primaryFunction: string,
+                |} | {|
+                  __typename: "Human"
+                |};
+            `);
+        });
+
+        it('Should specialize the fragment type correctly', () => {
+            const result = rawQueryToFlowTypes(
+                `query Deps {
+                    droid(id: "hello") {
+                        ...Hello
+                    }
+                }
+
+                fragment Hello on Character {
+                    __typename
+                    name
+                    ... on Droid {
+                        primaryFunction
+                    }
+                    ... on Human {
+                        homePlanet
+                    }
+                }`,
+            );
+
+            // Note how `homePlanet` is ommitted in
+            // `DepsType.response.droid`
+            expect(result).toMatchInlineSnapshot(`
+                // DepsType.js
+                export type DepsType = {|
+                    variables: {||},
+                    response: {|
+
+                  /** A robot character*/
+                  droid: ?{|
+                    __typename: "Droid",
+                    name: ?string,
+
+                    /** The robot's primary function*/
+                    primaryFunction: string,
+                  |}
+                |}
+                |};
+
+                // Hello.js
+                export type Hello = {|
+                  __typename: "Droid",
+                  name: ?string,
+
+                  /** The robot's primary function*/
+                  primaryFunction: string,
+                |} | {|
+                  __typename: "Human",
+                  homePlanet: ?string,
+                  name: ?string,
+                |};
+            `);
+        });
+    });
+
+    it('should generate all types when exportAllObjectTypes is set', () => {
+        const result = rawQueryToFlowTypes(
+            `
+            query SomeQuery {
+                human(id: "Han Solo") {
+                    id
+                    name
+                    homePlanet
+                    hands
+                    alive
+                    friends {
+                        __typename
+                        ... on Human {
+                            hands
+                        }
+                    }
+                }
+            }
+        `,
+            {exportAllObjectTypes: true},
+        );
+
+        expect(result).toMatchInlineSnapshot(`
+            // SomeQueryType.js
+            export type SomeQueryType = {|
+                variables: {||},
+                response: {|
+
+              /** A human character*/
+              human: ?SomeQuery_human
+            |}
+            |};
+            export type SomeQuery_human = {|
+              alive: ?boolean,
+              friends: ?$ReadOnlyArray<?SomeQuery_human_friends>,
+              hands: ?number,
+              homePlanet: ?string,
+              id: string,
+
+              /** The person's name*/
+              name: ?string,
+            |};
+            export type SomeQuery_human_friends = SomeQuery_human_friends_Droid | SomeQuery_human_friends_Human;
+            export type SomeQuery_human_friends_Droid = {|
+              __typename: "Droid"
+            |};
+            export type SomeQuery_human_friends_Human = {|
+              __typename: "Human",
+              hands: ?number,
+            |};
+        `);
+    });
+
     describe('Input variables', () => {
         it('should generate a variables type', () => {
             const result = rawQueryToFlowTypes(
@@ -300,6 +507,7 @@ describe('graphql-flow generation', () => {
             );
 
             expect(result).toMatchInlineSnapshot(`
+                // SomeQueryType.js
                 export type SomeQueryType = {|
                     variables: {|
                   id: string,
@@ -310,6 +518,9 @@ describe('graphql-flow generation', () => {
                   episode?: ?("NEW_HOPE" | "EMPIRE" | "JEDI"),
                 |},
                     response: {|
+                  hero: ?{|
+                    name: ?string
+                  |},
 
                   /** A human character*/
                   human: ?{|
@@ -317,9 +528,6 @@ describe('graphql-flow generation', () => {
                       name: ?string
                     |}>
                   |},
-                  hero: ?{|
-                    name: ?string
-                  |},
                 |}
                 |};
             `);
@@ -339,16 +547,17 @@ describe('graphql-flow generation', () => {
                 {readOnlyArray: false},
             );
             expect(result).toMatchInlineSnapshot(`
+                // SomeQueryType.js
                 export type SomeQueryType = {|
                     variables: {||},
                     response: {|
                   hero: ?({|
                     id: string,
-
-                    /** The person's name*/
                     name: ?string,
                   |} | {|
                     id: string,
+
+                    /** The person's name*/
                     name: ?string,
                   |})
                 |}
@@ -370,6 +579,7 @@ describe('graphql-flow generation', () => {
                 {readOnlyArray: false},
             );
             expect(result).toMatchInlineSnapshot(`
+                // SomeQueryType.js
                 export type SomeQueryType = {|
                     variables: {||},
                     response: {|
@@ -397,6 +607,7 @@ describe('graphql-flow generation', () => {
             );
 
             expect(result).toMatchInlineSnapshot(`
+                // addCharacterType.js
                 export type addCharacterType = {|
                     variables: {|
 

package/src/cli/config.js

@@ -53,6 +53,9 @@ export const loadConfigFile = (configFile: string): CliConfig => {
             'strictNullability',
             'regenerateCommand',
             'readOnlyArray',
+            'splitTypes',
+            'generatedDirectory',
+            'exportAllObjectTypes',
         ];
         Object.keys(data.options).forEach((k) => {
             if (!externalOptionsKeys.includes(k)) {

package/src/cli/run.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 // @flow
 /* eslint-disable no-console */
 import {generateTypeFiles, processPragmas} from '../generateTypeFiles';
@@ -113,27 +114,30 @@ Object.keys(resolved).forEach((k) => {
     );
     const rawSource: string = raw.literals[0];
     const processedOptions = processPragmas(config.options, rawSource);
-    if (!hasNonFragments || !processedOptions) {
+    if (!processedOptions) {
         return;
     }
 
     // eslint-disable-next-line flowtype-errors/uncovered
     const withTypeNames: DocumentNode = addTypenameToDocument(document);
     const printed = print(withTypeNames);
-    /* eslint-disable flowtype-errors/uncovered */
-    const errors = validate(schemaForValidation, withTypeNames);
-    /* eslint-disable flowtype-errors/uncovered */
-    if (errors.length) {
-        errors.forEach((error) => {
-            console.error(
-                `Schema validation found errors for ${raw.loc.path}!`,
-            );
-            console.error(printed);
-            console.error(error);
-            validationFailures++;
-        });
+
+    if (hasNonFragments) {
+        /* eslint-disable flowtype-errors/uncovered */
+        const errors = validate(schemaForValidation, withTypeNames);
+        /* eslint-disable flowtype-errors/uncovered */
+        if (errors.length) {
+            errors.forEach((error) => {
+                console.error(
+                    `Schema validation found errors for ${raw.loc.path}!`,
+                );
+                console.error(printed);
+                console.error(error);
+                validationFailures++;
+            });
+        }
+        /* eslint-enable flowtype-errors/uncovered */
     }
-    /* eslint-enable flowtype-errors/uncovered */
 
     try {
         generateTypeFiles(