feat: add support for multiple cloudformation stacks (Add apiId)

doc/general-config.md

@@ -56,6 +56,7 @@ appSync:
 - `resolverCountLimit`: Optional. The maximum number of resolvers a query can process. Must be between 1 and 1000. If not specified: unlimited.
 - `tags`: A key-value pair for tagging this AppSync API
 - `esbuild`: Custom esbuild options, or `false` See [Esbuild](#Esbuild)
+- `apiId`: See [ApiId](#ApiId)
 
 ## Schema
 
@@ -210,3 +211,33 @@ appSync:
     target: 'es2020',
     sourcemap: false
 ```
+
+
+## ApiId
+If you want to manage your existing AppSync Api through the serverless, you can specify `apiId.`
+This is handy if you
+- defined your API in the AWS console
+- defined your API through the cloudformation in the current or another stack
+
+To point your resources into existing AppSync API, you must provide apiId, which can be a string or imported value from another stack.
+```yaml
+appSync:
+  name: my-api
+  apiId: "existing api id"
+```
+
+The following configuration options are only associated with the creation of a new AppSync endpoint and will be ignored if you provide the apiId parameter:
+- name
+- authentication
+- additionalAuthentications
+- schema
+- domain
+- apiKeys
+- xrayEnabled
+- logging
+- waf
+- Tags
+> Note: you should never specify this parameter if you're managing your AppSync through this plugin since it results in removing your API.
+
+### Schema
+After specifying this parameter, you need to manually keep your schema up to date or from the main stack where your root AppSync API is defined. The plugin is not taking into account schema property due to AppSync limitation and inability to merge schemas across multiple stacks

package.json

@@ -1,6 +1,7 @@
 {
   "name": "serverless-appsync-plugin",
   "version": "0.0.0-development",
+  "type": "module",
   "description": "AWS AppSync support for the Serverless Framework",
   "main": "lib/index.js",
   "types": "lib/types/index.d.ts",
@@ -48,7 +49,7 @@
     "esbuild": "^0.17.11",
     "globby": "^11.1.0",
     "graphql": "^16.6.0",
-    "lodash": "^4.17.21",
+    "lodash-es": "^4.17.21",
     "luxon": "^2.5.0",
     "open": "^8.4.0",
     "terminal-link": "^2.1.1"

src/__tests__/api.test.ts

@@ -316,6 +316,10 @@ describe('Api', () => {
       expect(api.compileEndpoint()).toMatchSnapshot();
       expect(api.functions).toMatchSnapshot();
     });
+    it('should not compile the Api Resource when apiId is provided', () => {
+      const api = new Api(given.appSyncConfig({ apiId: '123' }), plugin);
+      expect(api.compileEndpoint()).toMatchInlineSnapshot(`Object {}`);
+    });
   });
 
   describe('Logs', () => {
@@ -342,6 +346,13 @@ describe('Api', () => {
       );
     });
 
+    it('should not compile CloudWatch Resources when apiId is provided', () => {
+      const api = new Api(given.appSyncConfig({ apiId: '1234' }), plugin);
+      expect(api.compileCloudWatchLogGroup()).toMatchInlineSnapshot(
+        `Object {}`,
+      );
+    });
+
     it('should compile CloudWatch Resources when enaabled', () => {
       const api = new Api(
         given.appSyncConfig({
@@ -568,6 +579,20 @@ describe('Api', () => {
         }
       `);
     });
+    it('should not generate an api key resources when apiId is provided', () => {
+      const api = new Api(
+        given.appSyncConfig({
+          apiId: '1234',
+        }),
+        plugin,
+      );
+      expect(
+        api.compileApiKey({
+          name: 'Default',
+          description: 'Default Key',
+        }),
+      ).toMatchInlineSnapshot(`Object {}`);
+    });
   });
 
   describe('LambdaAuthorizer', () => {
@@ -585,6 +610,18 @@ describe('Api', () => {
       );
     });
 
+    it('should not generate the Lambda Authorizer Resources when apiId is provided', () => {
+      const api = new Api(
+        given.appSyncConfig({
+          apiId: '123',
+        }),
+        plugin,
+      );
+      expect(api.compileLambdaAuthorizerPermission()).toMatchInlineSnapshot(
+        `Object {}`,
+      );
+    });
+
     it('should generate the Lambda Authorizer Resources from basic auth', () => {
       const api = new Api(
         given.appSyncConfig({
@@ -663,6 +700,11 @@ describe('Caching', () => {
     expect(api.compileCachingResources()).toEqual({});
   });
 
+  it('should not generate Resources when apiId is provided', () => {
+    const api = new Api(given.appSyncConfig({ apiId: '1234' }), plugin);
+    expect(api.compileCachingResources()).toEqual({});
+  });
+
   it('should generate Resources with defaults', () => {
     const api = new Api(
       given.appSyncConfig({
@@ -826,4 +868,14 @@ describe('Domains', () => {
     );
     expect(api.compileCustomDomain()).toMatchSnapshot();
   });
+
+  it('should not generate domain resources when apiId is provided', () => {
+    const api = new Api(
+      given.appSyncConfig({
+        apiId: '123',
+      }),
+      plugin,
+    );
+    expect(api.compileCustomDomain()).toMatchInlineSnapshot(`Object {}`);
+  });
 });

src/__tests__/basicConfig.ts

@@ -1,4 +1,4 @@
-import { AppSyncConfig } from '../types';
+import { AppSyncConfig } from '../types/index.js';
 
 export const basicConfig: AppSyncConfig = {
   name: 'My Api',

src/__tests__/getAppSyncConfig.test.ts

@@ -1,61 +1,67 @@
-import { pick } from 'lodash';
-import { getAppSyncConfig } from '../getAppSyncConfig';
-import { basicConfig } from './basicConfig';
-import { ResolverConfig } from '../types';
+import { pick } from 'lodash-es';
+import { getAppSyncConfig } from '../getAppSyncConfig.js';
+import { basicConfig } from './basicConfig.js';
+import { ResolverConfig } from '../types/index.js';
 
 test('returns basic config', async () => {
   expect(getAppSyncConfig(basicConfig)).toMatchSnapshot();
 });
 
 describe('Schema', () => {
   it('should return the default schema', () => {
-    expect(
-      getAppSyncConfig({ ...basicConfig, schema: undefined }).schema,
-    ).toMatchSnapshot();
+    const config = getAppSyncConfig({ ...basicConfig, schema: undefined });
+    const schema = 'schema' in config ? config.schema : undefined;
+    expect(schema).toMatchSnapshot();
   });
 
   it('should return a single schema as an array', () => {
-    expect(
-      getAppSyncConfig({ ...basicConfig, schema: 'mySchema.graphql' }).schema,
-    ).toMatchSnapshot();
+    const config = getAppSyncConfig({
+      ...basicConfig,
+      schema: 'mySchema.graphql',
+    });
+    const schema = 'schema' in config ? config.schema : undefined;
+    expect(schema).toMatchSnapshot();
   });
 
   it('should return a schema array unchanged', () => {
-    expect(
-      getAppSyncConfig({
-        ...basicConfig,
-        schema: ['users.graphql', 'posts.graphql'],
-      }).schema,
-    ).toMatchSnapshot();
+    const config = getAppSyncConfig({
+      ...basicConfig,
+      schema: ['users.graphql', 'posts.graphql'],
+    });
+    const schema = 'schema' in config ? config.schema : undefined;
+    expect(schema).toMatchSnapshot();
   });
 });
 
 describe('Api Keys', () => {
   it('should not generate a default Api Key when auth is not API_KEY', () => {
-    expect(
-      getAppSyncConfig({ ...basicConfig, authentication: { type: 'AWS_IAM' } })
-        .apiKeys,
-    ).toBeUndefined();
+    const config = getAppSyncConfig({
+      ...basicConfig,
+      authentication: { type: 'AWS_IAM' },
+    });
+    const apiKeys = 'apiKeys' in config ? config.apiKeys : undefined;
+    expect(apiKeys).toBeUndefined();
   });
 
   it('should generate api keys', () => {
-    expect(
-      getAppSyncConfig({
-        ...basicConfig,
-        apiKeys: [
-          {
-            name: 'John',
-            description: "John's key",
-            expiresAt: '2021-03-09T16:00:00+00:00',
-          },
-          {
-            name: 'Jane',
-            expiresAfter: '1y',
-          },
-          'InlineKey',
-        ],
-      }).apiKeys,
-    ).toMatchInlineSnapshot(`
+    const config = getAppSyncConfig({
+      ...basicConfig,
+      apiKeys: [
+        {
+          name: 'John',
+          description: "John's key",
+          expiresAt: '2021-03-09T16:00:00+00:00',
+        },
+        {
+          name: 'Jane',
+          expiresAfter: '1y',
+        },
+        'InlineKey',
+      ],
+    });
+    const apiKeys = 'apiKeys' in config ? config.apiKeys : undefined;
+
+    expect(apiKeys).toMatchInlineSnapshot(`
       Object {
         "InlineKey": Object {
           "name": "InlineKey",
@@ -229,7 +235,7 @@ describe('Resolvers', () => {
             field: 'getUsers',
           },
         },
-      ] as Record<string, ResolverConfig>[],
+      ] satisfies Record<string, ResolverConfig>[],
     });
     expect(config.resolvers).toMatchSnapshot();
   });

src/__tests__/given.ts

@@ -1,7 +1,7 @@
-import { set } from 'lodash';
+import { set } from 'lodash-es';
 import Serverless from 'serverless/lib/serverless';
 import AwsProvider from 'serverless/lib/plugins/aws/provider.js';
-import { AppSyncConfig } from '../types/plugin';
+import { AppSyncConfig } from '../types/plugin.js';
 import ServerlessAppsyncPlugin from '..';
 
 export const createServerless = (): Serverless => {

src/__tests__/schema.test.ts

@@ -51,6 +51,17 @@ describe('schema', () => {
     `);
   });
 
+  it('should generate a schema resource if apiId is provided', () => {
+    const api = new Api(
+      given.appSyncConfig({
+        apiId: '123',
+      }),
+      plugin,
+    );
+
+    expect(api.compileSchema()).toMatchInlineSnapshot(`Object {}`);
+  });
+
   it('should merge the schemas', () => {
     const api = new Api(given.appSyncConfig(), plugin);
     const schema = new Schema(api, [

src/__tests__/utils.ts

@@ -1,7 +1,7 @@
 import runServerlessFixtureEngine from '@serverless/test/setup-run-serverless-fixtures-engine';
-import { merge } from 'lodash';
+import { merge } from 'lodash-es';
 import path from 'path';
-import Serverless from 'serverless/lib/Serverless';
+import Serverless from 'serverless';
 
 type RunSlsOptions = {
   fixture: 'appsync';

src/__tests__/validation/__snapshots__/base.test.ts.snap

@@ -52,8 +52,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'
+": must have required property 'authentication'
 /unknownPorp: invalid (unknown) property
 /xrayEnabled: must be boolean
 /visibility: must be \\"GLOBAL\\" or \\"PRIVATE\\"
@@ -68,3 +67,5 @@ exports[`Valdiation should validate  2`] = `
 "/queryDepthLimit: must be <= 75
 /resolverCountLimit: must be <= 1000"
 `;
+
+exports[`Valdiation should validate  3`] = `"Invalid configuration: must contain either \\\"apiId\\\" or \\\"name\\\""`;

src/__tests__/validation/base.test.ts

@@ -29,6 +29,7 @@ describe('Valdiation', () => {
 
     expect(function () {
       validateConfig({
+        name: 'FOO',
         visibility: 'FOO',
         introspection: 10,
         queryDepthLimit: 'foo',
@@ -47,6 +48,19 @@ describe('Valdiation', () => {
         resolverCountLimit: 1001,
       });
     }).toThrowErrorMatchingSnapshot();
+
+    expect(function () {
+      validateConfig({
+        visibility: 'FOO',
+        introspection: 10,
+        queryDepthLimit: 'foo',
+        resolverCountLimit: 'bar',
+        xrayEnabled: 'BAR',
+        unknownPorp: 'foo',
+        esbuild: 'bad',
+        environment: 'Bad',
+      });
+    }).toThrowErrorMatchingSnapshot();
   });
 
   describe('Log', () => {
@@ -69,7 +83,7 @@ describe('Valdiation', () => {
               level: 'ALL',
               retentionInDays: 14,
               excludeVerboseContent: true,
-              loggingRoleArn: { Ref: 'MyLogGorupArn' },
+              // loggingRoleArn: { Ref: 'MyLogGorupArn' }, // TODO : why was it only in the tests ?
             },
           } as AppSyncConfig,
         },