feat: add visibility configuration (#604)

Co-authored-by: bboure <[email protected]>
sid88in · Jun 28, 2023 · ffedf54 · ffedf54
1 parent ca13f78
commit ffedf54
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 1 deletion.
diff --git a/doc/general-config.md b/doc/general-config.md
@@ -49,6 +49,7 @@ appSync:
 - `waf`: See [Web Application Firefall](WAF.md)
 - `logging`: See [Logging](#Logging)
 - `xrayEnabled`: Boolean. Enable or disable X-Ray tracing.
+- `visibility`: Optional. `GLOBAL` or `PRIVATE`. Defaults to `GLOBAL`.
 - `tags`: A key-value pair for tagging this AppSync API
 
 ## Schema

diff --git a/src/__tests__/__snapshots__/api.test.ts.snap b/src/__tests__/__snapshots__/api.test.ts.snap
@@ -27,6 +27,7 @@ Object {
           "Value": "Dev",
         },
       ],
+      "Visibility": "GLOBAL",
       "XrayEnabled": false,
     },
     "Type": "AWS::AppSync::GraphQLApi",
@@ -64,6 +65,7 @@ Object {
           "Value": "Dev",
         },
       ],
+      "Visibility": "GLOBAL",
       "XrayEnabled": false,
     },
     "Type": "AWS::AppSync::GraphQLApi",

diff --git a/src/__tests__/api.test.ts b/src/__tests__/api.test.ts
@@ -22,6 +22,35 @@ describe('Api', () => {
                   "Value": "Dev",
                 },
               ],
+              "Visibility": "GLOBAL",
+              "XrayEnabled": false,
+            },
+            "Type": "AWS::AppSync::GraphQLApi",
+          },
+        }
+      `);
+    });
+
+    it('should compile the Api Resource for a private endpoint', () => {
+      const api = new Api(
+        given.appSyncConfig({
+          visibility: 'PRIVATE',
+        }),
+        plugin,
+      );
+      expect(api.compileEndpoint()).toMatchInlineSnapshot(`
+        Object {
+          "GraphQlApi": Object {
+            "Properties": Object {
+              "AuthenticationType": "API_KEY",
+              "Name": "MyApi",
+              "Tags": Array [
+                Object {
+                  "Key": "stage",
+                  "Value": "Dev",
+                },
+              ],
+              "Visibility": "PRIVATE",
               "XrayEnabled": false,
             },
             "Type": "AWS::AppSync::GraphQLApi",
@@ -63,6 +92,7 @@ describe('Api', () => {
                   "Value": "Dev",
                 },
               ],
+              "Visibility": "GLOBAL",
               "XrayEnabled": false,
             },
             "Type": "AWS::AppSync::GraphQLApi",
@@ -168,6 +198,7 @@ describe('Api', () => {
                 "DefaultAction": "ALLOW",
                 "UserPoolId": "pool123",
               },
+              "Visibility": "GLOBAL",
               "XrayEnabled": false,
             },
             "Type": "AWS::AppSync::GraphQLApi",

diff --git a/src/__tests__/validation/__snapshots__/base.test.ts.snap b/src/__tests__/validation/__snapshots__/base.test.ts.snap
@@ -54,5 +54,7 @@ exports[`Valdiation Waf Invalid should validate a Throttle limit 1`] = `
 exports[`Valdiation should validate  1`] = `
 ": must have required property 'name'
 : must have required property 'authentication'
-/unknownPorp: invalid (unknown) property"
+/unknownPorp: invalid (unknown) property
+/xrayEnabled: must be boolean
+/visibility: must be \\"GLOBAL\\" or \\"PRIVATE\\""
 `;
diff --git a/src/__tests__/validation/base.test.ts b/src/__tests__/validation/base.test.ts
@@ -4,8 +4,21 @@ import { basicConfig } from '../basicConfig';
 
 describe('Valdiation', () => {
   it('should validate ', () => {
+    expect(
+      validateConfig({
+        ...basicConfig,
+        visibility: 'GLOBAL',
+        xrayEnabled: true,
+        tags: {
+          foo: 'bar',
+        },
+      }),
+    ).toBe(true);
+
     expect(function () {
       validateConfig({
+        visibility: 'FOO',
+        xrayEnabled: 'BAR',
         unknownPorp: 'foo',
       });
     }).toThrowErrorMatchingSnapshot();
@@ -55,6 +68,7 @@ describe('Valdiation', () => {
               retentionInDays: 'bar',
               excludeVerboseContent: 'buzz',
               loggingRoleArn: 123,
+              visibility: 'FOO',
             },
           },
         },

diff --git a/src/resources/Api.ts b/src/resources/Api.ts
@@ -74,6 +74,7 @@ export class Api {
       Type: 'AWS::AppSync::GraphQLApi',
       Properties: {
         Name: this.config.name,
+        Visibility: this.config.visibility || 'GLOBAL',
         XrayEnabled: this.config.xrayEnabled || false,
         Tags: this.getTagsConfig(),
       },

diff --git a/src/types/plugin.ts b/src/types/plugin.ts
@@ -16,6 +16,7 @@ export type AppSyncConfig = {
   caching?: CachingConfig;
   waf?: WafConfig;
   tags?: Record<string, string>;
+  visibility?: 'GLOBAL' | 'PRIVATE';
 };
 
 export type IamStatement = {

diff --git a/src/validation.ts b/src/validation.ts
@@ -678,6 +678,11 @@ export const appSyncSchema = {
       },
     },
     xrayEnabled: { type: 'boolean' },
+    visibility: {
+      type: 'string',
+      enum: ['GLOBAL', 'PRIVATE'],
+      errorMessage: 'must be "GLOBAL" or "PRIVATE"',
+    },
     substitutions: { $ref: '#/definitions/substitutions' },
     waf: {
       type: 'object',