refactor(appsync): strongly type schema definition mode

packages/@aws-cdk/aws-appsync/README.md

@@ -47,6 +47,7 @@ import * as db from '@aws-cdk/aws-dynamodb';
 
 const api = new appsync.GraphQLApi(stack, 'Api', {
   name: 'demo',
+  schemaDefinition: appsync.SchemaDefinition.FILE,
   schemaDefinitionFile: join(__dirname, 'schema.graphql'),
   authorizationConfig: {
     defaultAuthorization: {

packages/@aws-cdk/aws-appsync/lib/graphqlapi.ts

@@ -202,6 +202,21 @@ export interface LogConfig {
   readonly fieldLogLevel?: FieldLogLevel;
 }
 
+/**
+ * Enum containing the different modes of schema definition
+ */
+export enum SchemaDefinition {
+  /**
+   * Define schema through functions like addType, addQuery, etc.
+   */
+  CODE = 'CODE',
+
+  /**
+   * Define schema in a file, i.e. schema.graphql
+   */
+  FILE = 'FILE',
+}
+
 /**
  * Properties for an AppSync GraphQL API
  */
@@ -227,11 +242,14 @@ export interface GraphQLApiProps {
   readonly logConfig?: LogConfig;
 
   /**
-   * GraphQL schema definition. You have to specify a definition or a file containing one.
+   * GraphQL schema definition. Specify how you want to define your schema.
+   *
+   * SchemaDefinition.CODE allows schema definition through CDK
+   * SchemaDefinition.FILE allows schema definition through schema.graphql file
    *
-   * @default - Use schemaDefinitionFile
+   * @experimental
    */
-  readonly schemaDefinition?: string;
+  readonly schemaDefinition: SchemaDefinition;
   /**
    * File containing the GraphQL schema definition. You have to specify a definition or a file containing one.
    *
@@ -332,6 +350,7 @@ export class GraphQLApi extends Construct {
     return this._apiKey;
   }
 
+  private schemaMode: SchemaDefinition;
   private api: CfnGraphQLApi;
   private _apiKey?: string;
 
@@ -389,6 +408,7 @@ export class GraphQLApi extends Construct {
     this.arn = this.api.attrArn;
     this.graphQlUrl = this.api.attrGraphQlUrl;
     this.name = this.api.name;
+    this.schemaMode = props.schemaDefinition;
 
     if (
       defaultAuthorizationType === AuthorizationType.API_KEY ||
@@ -404,18 +424,7 @@ export class GraphQLApi extends Construct {
       this._apiKey = this.createAPIKey(apiKeyConfig);
     }
 
-    let definition;
-    if (props.schemaDefinition) {
-      definition = props.schemaDefinition;
-    } else if (props.schemaDefinitionFile) {
-      definition = readFileSync(props.schemaDefinitionFile).toString('UTF-8');
-    } else {
-      throw new Error('Missing Schema definition. Provide schemaDefinition or schemaDefinitionFile');
-    }
-    this.schema = new CfnGraphQLSchema(this, 'Schema', {
-      apiId: this.apiId,
-      definition,
-    });
+    this.schema = this.defineSchema(props.schemaDefinitionFile);
   }
 
   /**
@@ -666,4 +675,40 @@ export class GraphQLApi extends Construct {
     const authModes = props.authorizationConfig?.additionalAuthorizationModes;
     return authModes ? this.formatAdditionalAuthorizationModes(authModes) : undefined;
   }
+
+  /**
+   * Sets schema defintiion to input if schema mode is configured with SchemaDefinition.CODE
+   *
+   * @param definition string that is the graphql representation of schema
+   * @experimental temporary
+   */
+  public updateDefinition (definition: string): void{
+    if ( this.schemaMode != SchemaDefinition.CODE ) {
+      throw new Error('API cannot add type because schema definition mode is not configured as CODE.');
+    }
+    this.schema.definition = definition;
+  }
+
+  /**
+   * Define schema based on props configuration
+   * @param file the file name/s3 location of Schema
+   */
+  private defineSchema(file?: string): CfnGraphQLSchema {
+    let definition;
+
+    if ( this.schemaMode == SchemaDefinition.FILE && !file) {
+      throw new Error('schemaDefinitionFile must be configured if using FILE definition mode.');
+    } else if ( this.schemaMode == SchemaDefinition.FILE && file ) {
+      definition = readFileSync(file).toString('UTF-8');
+    } else if ( this.schemaMode == SchemaDefinition.CODE && !file ) {
+      definition = '';
+    } else if ( this.schemaMode == SchemaDefinition.CODE && file) {
+      throw new Error('definition mode CODE is incompatible with file definition. Change mode to FILE/S3 or unconfigure schemaDefinitionFile');
+    }
+
+    return new CfnGraphQLSchema(this, 'Schema', {
+      apiId: this.apiId,
+      definition,
+    });
+  }
 }

packages/@aws-cdk/aws-appsync/package.json

@@ -75,6 +75,7 @@
     "@aws-cdk/aws-dynamodb": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",
     "@aws-cdk/aws-lambda": "0.0.0",
+    "@aws-cdk/aws-s3-assets": "0.0.0",
     "@aws-cdk/core": "0.0.0",
     "constructs": "^3.0.2"
   },
@@ -84,6 +85,7 @@
     "@aws-cdk/aws-dynamodb": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",
     "@aws-cdk/aws-lambda": "0.0.0",
+    "@aws-cdk/aws-s3-assets": "0.0.0",
     "@aws-cdk/core": "0.0.0",
     "constructs": "^3.0.2"
   },

packages/@aws-cdk/aws-appsync/test/appsync-apikey.test.ts

@@ -11,6 +11,7 @@ describe('AppSync Authorization Config', () => {
     // WHEN
     new appsync.GraphQLApi(stack, 'api', {
       name: 'api',
+      schemaDefinition: appsync.SchemaDefinition.FILE,
       schemaDefinitionFile: path.join(__dirname, 'appsync.test.graphql'),
     });
 
@@ -25,6 +26,7 @@ describe('AppSync Authorization Config', () => {
     // WHEN
     new appsync.GraphQLApi(stack, 'api', {
       name: 'api',
+      schemaDefinition: appsync.SchemaDefinition.FILE,
       schemaDefinitionFile: path.join(__dirname, 'appsync.test.graphql'),
       authorizationConfig: {
         defaultAuthorization: {
@@ -47,6 +49,7 @@ describe('AppSync Authorization Config', () => {
     // WHEN
     new appsync.GraphQLApi(stack, 'api', {
       name: 'api',
+      schemaDefinition: appsync.SchemaDefinition.FILE,
       schemaDefinitionFile: path.join(__dirname, 'appsync.test.graphql'),
       authorizationConfig: {
         defaultAuthorization: {
@@ -66,6 +69,7 @@ describe('AppSync Authorization Config', () => {
     // WHEN
     new appsync.GraphQLApi(stack, 'api', {
       name: 'api',
+      schemaDefinition: appsync.SchemaDefinition.FILE,
       schemaDefinitionFile: path.join(__dirname, 'appsync.test.graphql'),
       authorizationConfig: {
         defaultAuthorization: {

packages/@aws-cdk/aws-appsync/test/appsync-grant.test.ts

@@ -15,6 +15,7 @@ beforeEach(() => {
   });
   api = new appsync.GraphQLApi(stack, 'API', {
     name: 'demo',
+    schemaDefinition: appsync.SchemaDefinition.FILE,
     schemaDefinitionFile: join(__dirname, 'appsync.test.graphql'),
     authorizationConfig: {
       defaultAuthorization: {

packages/@aws-cdk/aws-appsync/test/appsync-schema.test.ts

@@ -0,0 +1,104 @@
+import { join } from 'path';
+import '@aws-cdk/assert/jest';
+import * as cdk from '@aws-cdk/core';
+import * as appsync from '../lib';
+
+// Schema Definitions
+const type = 'type test {\n  version: String!\n}\n\n';
+const query = 'type Query {\n  getTests: [ test! ]!\n}\n\n';
+const mutation = 'type Mutation {\n  addTest(version: String!): test\n}\n';
+
+let stack: cdk.Stack;
+beforeEach(() => {
+  // GIVEN
+  stack = new cdk.Stack();
+});
+
+describe('testing schema definition mode `code`', () => {
+
+  test('definition mode `code` produces empty schema definition', () => {
+    // WHEN
+    new appsync.GraphQLApi(stack, 'API', {
+      name: 'demo',
+      schemaDefinition: appsync.SchemaDefinition.CODE,
+    });
+
+    //THEN
+    expect(stack).toHaveResourceLike('AWS::AppSync::GraphQLSchema', {
+      Definition: '',
+    });
+  });
+
+  test('definition mode `code` generates correct schema with updateDefinition', () => {
+    // WHEN
+    const api = new appsync.GraphQLApi(stack, 'API', {
+      name: 'demo',
+      schemaDefinition: appsync.SchemaDefinition.CODE,
+    });
+    api.updateDefinition(`${type}${query}${mutation}`);
+
+    //THEN
+    expect(stack).toHaveResourceLike('AWS::AppSync::GraphQLSchema', {
+      Definition: `${type}${query}${mutation}`,
+    });
+  });
+
+  test('definition mode `code` errors when schemaDefinitionFile is configured', () => {
+    // WHEN
+    const when = () => {
+      new appsync.GraphQLApi(stack, 'API', {
+        name: 'demo',
+        schemaDefinition: appsync.SchemaDefinition.CODE,
+        schemaDefinitionFile: join(__dirname, 'appsync.test.graphql'),
+      });
+    };
+
+    //THEN
+    expect(when).toThrowError('definition mode CODE is incompatible with file definition. Change mode to FILE/S3 or unconfigure schemaDefinitionFile');
+  });
+
+});
+
+describe('testing schema definition mode `file`', () => {
+
+  test('definition mode `file` produces correct output', () => {
+    // WHEN
+    new appsync.GraphQLApi(stack, 'API', {
+      name: 'demo',
+      schemaDefinition: appsync.SchemaDefinition.FILE,
+      schemaDefinitionFile: join(__dirname, 'appsync.test.graphql'),
+    });
+
+    //THEN
+    expect(stack).toHaveResourceLike('AWS::AppSync::GraphQLSchema', {
+      Definition: `${type}${query}${mutation}`,
+    });
+  });
+
+  test('definition mode `file` errors when calling updateDefiniton function', () => {
+    // WHEN
+    const api = new appsync.GraphQLApi(stack, 'API', {
+      name: 'demo',
+      schemaDefinition: appsync.SchemaDefinition.FILE,
+      schemaDefinitionFile: join(__dirname, 'appsync.test.graphql'),
+    });
+    const when = () => { api.updateDefinition('error'); };
+
+    //THEN
+    expect(when).toThrowError('API cannot add type because schema definition mode is not configured as CODE.');
+  });
+
+  test('definition mode `file` errors when schemaDefinitionFile is not configured', () => {
+    // WHEN
+    const when = () => {
+      new appsync.GraphQLApi(stack, 'API', {
+        name: 'demo',
+        schemaDefinition: appsync.SchemaDefinition.FILE,
+      });
+    };
+
+    //THEN
+    expect(when).toThrowError('schemaDefinitionFile must be configured if using FILE definition mode.');
+  });
+
+});

packages/@aws-cdk/aws-appsync/test/appsync.test.ts

@@ -11,6 +11,7 @@ test('should not throw an Error', () => {
   const when = () => {
     new appsync.GraphQLApi(stack, 'api', {
       authorizationConfig: {},
+      schemaDefinition: appsync.SchemaDefinition.FILE,
       name: 'api',
       schemaDefinitionFile: path.join(__dirname, 'appsync.test.graphql'),
     });
@@ -28,6 +29,7 @@ test('appsync should configure pipeline when pipelineConfig has contents', () =>
   const api = new appsync.GraphQLApi(stack, 'api', {
     authorizationConfig: {},
     name: 'api',
+    schemaDefinition: appsync.SchemaDefinition.FILE,
     schemaDefinitionFile: path.join(__dirname, 'appsync.test.graphql'),
   });
 
@@ -53,6 +55,7 @@ test('appsync should configure resolver as unit when pipelineConfig is empty', (
   const api = new appsync.GraphQLApi(stack, 'api', {
     authorizationConfig: {},
     name: 'api',
+    schemaDefinition: appsync.SchemaDefinition.FILE,
     schemaDefinitionFile: path.join(__dirname, 'appsync.test.graphql'),
   });
 
@@ -76,6 +79,7 @@ test('appsync should configure resolver as unit when pipelineConfig is empty arr
   const api = new appsync.GraphQLApi(stack, 'api', {
     authorizationConfig: {},
     name: 'api',
+    schemaDefinition: appsync.SchemaDefinition.FILE,
     schemaDefinitionFile: path.join(__dirname, 'appsync.test.graphql'),
   });
 

packages/@aws-cdk/aws-appsync/test/integ.graphql-iam.ts

@@ -12,6 +12,7 @@ import {
   UserPoolDefaultAction,
   Values,
   IamResource,
+  SchemaDefinition,
 } from '../lib';
 
 /*
@@ -37,6 +38,7 @@ const userPool = new UserPool(stack, 'Pool', {
 
 const api = new GraphQLApi(stack, 'Api', {
   name: 'Integ_Test_IAM',
+  schemaDefinition: SchemaDefinition.FILE,
   schemaDefinitionFile: join(__dirname, 'integ.graphql-iam.graphql'),
   authorizationConfig: {
     defaultAuthorization: {

packages/@aws-cdk/aws-appsync/test/integ.graphql.ts

@@ -10,6 +10,7 @@ import {
   PrimaryKey,
   UserPoolDefaultAction,
   Values,
+  SchemaDefinition,
 } from '../lib';
 
 /*
@@ -35,6 +36,7 @@ const userPool = new UserPool(stack, 'Pool', {
 
 const api = new GraphQLApi(stack, 'Api', {
   name: 'demoapi',
+  schemaDefinition: SchemaDefinition.FILE,
   schemaDefinitionFile: join(__dirname, 'integ.graphql.graphql'),
   authorizationConfig: {
     defaultAuthorization: {