Initial support for client-side schemas (#480)

* Initial support for client-side schemas

* Update unit tests for API with client schema parameter

* Increase timeout for CLI tests

* Enable query validation for queries with client-side data

* Add unit test for nested local data

* Update snapshots

* Update test to include mixed client-server data

* Support not having a server schema for local state only queries

* Have client schema extend server schema

* Fix unit tests with old API

* Support loading client-side schema from GQL tag

Author: shadaj

packages/apollo-cli/src/commands/codegen/__tests__/__snapshots__/generate.test.ts.snap

@@ -213,6 +213,113 @@ export interface SimpleQuery {
 //=============================================================="
 `;
 
+exports[`successful codegen infers TypeScript target and writes types for query with client-side data 1`] = `
+"
+
+/* tslint:disable */
+// This file was automatically generated and should not be edited.
+
+// ====================================================
+// GraphQL query operation: SimpleQuery
+// ====================================================
+
+export interface SimpleQuery_complexLocalState {
+  someData: string;
+}
+
+export interface SimpleQuery_serverSideField {
+  serverData: string;
+  addedLocalData: string;
+}
+
+export interface SimpleQuery {
+  hello: string;
+  localState: string;
+  complexLocalState: SimpleQuery_complexLocalState;
+  serverSideField: SimpleQuery_serverSideField;
+}
+
+/* tslint:disable */
+// This file was automatically generated and should not be edited.
+
+//==============================================================
+// START Enums and Input Objects
+//==============================================================
+
+//==============================================================
+// END Enums and Input Objects
+//=============================================================="
+`;
+
+exports[`successful codegen infers TypeScript target and writes types for query with client-side data with schema in a JS file 1`] = `
+"
+
+/* tslint:disable */
+// This file was automatically generated and should not be edited.
+
+// ====================================================
+// GraphQL query operation: SimpleQuery
+// ====================================================
+
+export interface SimpleQuery_complexLocalState {
+  someData: string;
+}
+
+export interface SimpleQuery_serverSideField {
+  serverData: string;
+  addedLocalData: string;
+}
+
+export interface SimpleQuery {
+  hello: string;
+  localState: string;
+  complexLocalState: SimpleQuery_complexLocalState;
+  serverSideField: SimpleQuery_serverSideField;
+}
+
+/* tslint:disable */
+// This file was automatically generated and should not be edited.
+
+//==============================================================
+// START Enums and Input Objects
+//==============================================================
+
+//==============================================================
+// END Enums and Input Objects
+//=============================================================="
+`;
+
+exports[`successful codegen infers TypeScript target and writes types for query with only client-side data 1`] = `
+"
+
+/* tslint:disable */
+// This file was automatically generated and should not be edited.
+
+// ====================================================
+// GraphQL query operation: SimpleQuery
+// ====================================================
+
+export interface SimpleQuery_complexLocalState {
+  someData: string;
+}
+
+export interface SimpleQuery {
+  localState: string;
+  complexLocalState: SimpleQuery_complexLocalState;
+}
+
+/* tslint:disable */
+// This file was automatically generated and should not be edited.
+
+//==============================================================
+// START Enums and Input Objects
+//==============================================================
+
+//==============================================================
+// END Enums and Input Objects
+//=============================================================="
+`;
+
 exports[`successful codegen writes Flow types into a __generated__ directory next to sources when no output is set 1`] = `
 "
 

packages/apollo-cli/src/commands/codegen/__tests__/fixtures/clientSideOnlyQuery.graphql

@@ -0,0 +1,6 @@
+query SimpleQuery {
+  localState @client
+  complexLocalState @client {
+    someData
+  }
+}

packages/apollo-cli/src/commands/codegen/__tests__/fixtures/clientSideOnlySchema.graphql

@@ -0,0 +1,8 @@
+type Query {
+  localState: String!
+  complexLocalState: LocalType!
+}
+
+type LocalType {
+  someData: String!
+}

packages/apollo-cli/src/commands/codegen/__tests__/fixtures/clientSideSchema.graphql

@@ -0,0 +1,12 @@
+extend type Query {
+  localState: String!
+  complexLocalState: LocalType!
+}
+
+type LocalType {
+  someData: String!
+}
+
+extend type ServerField {
+  addedLocalData: String!
+}

packages/apollo-cli/src/commands/codegen/__tests__/fixtures/clientSideSchemaQuery.graphql

@@ -0,0 +1,12 @@
+query SimpleQuery {
+  hello
+  localState @client
+  complexLocalState @client {
+    someData
+  }
+
+  serverSideField {
+    serverData
+    addedLocalData @client
+  }
+}

packages/apollo-cli/src/commands/codegen/__tests__/generate.test.ts

@@ -32,6 +32,39 @@ const otherQuery = fs.readFileSync(
   path.resolve(__dirname, "./fixtures/otherQuery.graphql")
 );
 
+const clientSideSchema = fs.readFileSync(
+  path.resolve(__dirname, "./fixtures/clientSideSchema.graphql")
+);
+
+const clientSideSchemaTag = `
+gql\`
+extend type Query {
+  localState: String!
+  complexLocalState: LocalType!
+}
+
+type LocalType {
+  someData: String!
+}
+
+extend type ServerField {
+  addedLocalData: String!
+}
+\`
+`;
+
+const clientSideSchemaQuery = fs.readFileSync(
+  path.resolve(__dirname, "./fixtures/clientSideSchemaQuery.graphql")
+);
+
+const clientSideOnlySchema = fs.readFileSync(
+  path.resolve(__dirname, "./fixtures/clientSideOnlySchema.graphql")
+);
+
+const clientSideOnlyQuery = fs.readFileSync(
+  path.resolve(__dirname, "./fixtures/clientSideOnlyQuery.graphql")
+);
+
 beforeEach(() => {
   vol.reset();
   vol.fromJSON({
@@ -104,6 +137,44 @@ describe("successful codegen", () => {
       expect(mockFS.readFileSync("API.ts").toString()).toMatchSnapshot();
     });
 
+  test
+    .do(() => {
+      vol.fromJSON({
+        "schema.json": JSON.stringify(fullSchema.__schema),
+        "clientSideSchema.graphql": clientSideSchema.toString(),
+        "clientSideSchemaQuery.graphql": clientSideSchemaQuery.toString()
+      });
+    })
+    .command(["codegen:generate", "--schema=schema.json", "--clientSchema=clientSideSchema.graphql", "--outputFlat", "API.ts"])
+    .it("infers TypeScript target and writes types for query with client-side data", () => {
+      expect(mockFS.readFileSync("API.ts").toString()).toMatchSnapshot();
+    });
+
+    test
+    .do(() => {
+      vol.fromJSON({
+        "schema.json": JSON.stringify(fullSchema.__schema),
+        "clientSideSchemaTag.js": clientSideSchemaTag.toString(),
+        "clientSideSchemaQuery.graphql": clientSideSchemaQuery.toString()
+      });
+    })
+    .command(["codegen:generate", "--schema=schema.json", "--clientSchema=clientSideSchemaTag.js", "--outputFlat", "API.ts"])
+    .it("infers TypeScript target and writes types for query with client-side data with schema in a JS file", () => {
+      expect(mockFS.readFileSync("API.ts").toString()).toMatchSnapshot();
+    });
+
+  test
+    .do(() => {
+      vol.fromJSON({
+        "clientSideOnlySchema.graphql": clientSideOnlySchema.toString(),
+        "clientSideOnlyQuery.graphql": clientSideOnlyQuery.toString()
+      });
+    })
+    .command(["codegen:generate", "--clientSchema=clientSideOnlySchema.graphql", "--outputFlat", "API.ts"])
+    .it("infers TypeScript target and writes types for query with only client-side data", () => {
+      expect(mockFS.readFileSync("API.ts").toString()).toMatchSnapshot();
+    });
+
   test
     .do(() => {
       vol.fromJSON({

packages/apollo-cli/src/commands/codegen/generate.ts

@@ -5,7 +5,7 @@ import * as path from "path";
 
 import { TargetType, default as generate } from "../../generate";
 
-import { buildClientSchema } from "graphql";
+import { buildClientSchema, buildSchema, parse, visit, GraphQLCompositeType, extendSchema, buildASTSchema } from "graphql";
 
 import * as fg from "glob";
 import { fs, withGlobalFS } from "apollo-codegen-core/lib/localfs";
@@ -14,6 +14,8 @@ import { promisify } from "util";
 import { loadSchemaStep } from "../../load-schema";
 
 import { engineFlags } from "../../engine-cli";
+import { fromFile } from '../../fetch-schema';
+import { loadQueryDocuments } from 'apollo-codegen-core/lib/loading';
 
 export default class Generate extends Command {
   static description =
@@ -32,6 +34,9 @@ export default class Generate extends Command {
     schema: flags.string({
       description: "Path to your GraphQL schema introspection result"
     }),
+    clientSchema: flags.string({
+      description: "Path to your client-side GraphQL schema file for `apollo-link-state` (either .graphql or .json)"
+    }),
 
     ...engineFlags,
 
@@ -177,7 +182,7 @@ export default class Generate extends Command {
             );
           });
           task.title = `Scanning for GraphQL queries (${paths.length} found)`;
-          ctx.queryPaths = paths;
+          ctx.queryPaths = paths.filter(p => path.resolve(p) != (flags.clientSchema ? path.resolve(flags.clientSchema) : undefined));
         }
       },
       loadSchemaStep(
@@ -187,21 +192,62 @@ export default class Generate extends Command {
         flags.engine,
         "Loading GraphQL schema",
         async ctx => {
-          const schemaFileContent = await promisify(fs.readFile)(
-            path.resolve(flags.schema as string)
-          );
-          const schemaData = JSON.parse((schemaFileContent as any) as string);
-          ctx.schema = schemaData.data
-            ? schemaData.data.__schema
-            : schemaData.__schema
-              ? schemaData.__schema
-              : schemaData;
+          if (flags.schema) {
+            const schemaFileContent = await promisify(fs.readFile)(
+              path.resolve(flags.schema as string)
+            );
+            const schemaData = JSON.parse((schemaFileContent as any) as string);
+            ctx.schema = schemaData.data
+              ? schemaData.data.__schema
+              : schemaData.__schema
+                ? schemaData.__schema
+                : schemaData;
+          } else {
+            this.log("Not loading because no path was provided (you should have a client-side schema)");
+          }
         }
       ),
       {
         title: "Parsing GraphQL schema",
-        task: async ctx => {
-          ctx.schema = buildClientSchema({ __schema: ctx.schema });
+        task: async (ctx, task) => {
+          if (ctx.schema) {
+            ctx.schema = buildClientSchema({ __schema: ctx.schema });
+          } else {
+            task.skip("No server-side schema provided")
+          }
+        }
+      },
+      {
+        title: "Loading client-side GraphQL schema",
+        task: async (ctx, task) => {
+          if (!flags.clientSchema) {
+            task.skip("Path to client schema not provided")
+          } else {
+            const foundDocuments = loadQueryDocuments([path.resolve(flags.clientSchema)]);
+            if (foundDocuments.length == 0) {
+              this.error("Found no query documents, aborting");
+            }
+
+            if (foundDocuments.length > 1) {
+              this.warn("Found more than one query document, using the first one");
+            }
+
+            const ast = foundDocuments[0];
+            const clientNodes: {parentType: string}[] = [];
+            visit(ast, {
+              enter(node, key, parent, path, ancestors) {
+                if (node.kind == "FieldDefinition") {
+                  (node as any).__client = true;
+                }
+              }
+            });
+
+            if (ctx.schema) {
+              ctx.schema = extendSchema(ctx.schema, ast);
+            } else {
+              ctx.schema = buildASTSchema(ast);
+            }
+          }
         }
       },
       {

packages/apollo-cli/src/commands/schema/__tests__/__snapshots__/download.test.ts.snap

@@ -82,7 +82,7 @@ const engineSuccess = ({ schema, tag, results } = {}) => nock => {
     });
 };
 
-jest.setTimeout(15000);
+jest.setTimeout(25000);
 
 describe("successful checks", () => {
   test

packages/apollo-cli/src/commands/schema/__tests__/check.test.ts

@@ -41,7 +41,7 @@ beforeEach(() => {
   });
 })
 
-jest.setTimeout(15000);
+jest.setTimeout(25000);
 
 describe("successful schema downloading", () => {
   test