Merge branch 'master' into inputTransformer

Author: zirkelc

.github/workflows/config.yml

@@ -1,6 +1,6 @@
 name: CI
 
-on: push
+on: [push, pull_request]
 
 jobs:
   test:

CHANGELOG.md

@@ -4,6 +4,9 @@
 
 This is the Serverless Framework plugin for AWS Step Functions.
 
+## Requirement
+Serverless Framework v2.32.0 or later is required.
+
 ## TOC
 
  - [Install](#install)
@@ -48,6 +51,7 @@ This is the Serverless Framework plugin for AWS Step Functions.
          - [Specifying a RoleArn](#specifying-a-rolearn)
          - [Specifying a custom CloudWatch EventBus](#specifying-a-custom-cloudwatch-eventbus)
          - [Specifying a custom EventBridge EventBus](#specifying-a-custom-eventbridge-eventbus)
+         - [Specifying a DeadLetterQueue](#specifying-a-deadletterqueue)
  - [Tags](#tags)
  - [Commands](#commands)
      - [deploy](#deploy)
@@ -164,7 +168,7 @@ stepFunctions:
       dependsOn:
         - DynamoDBTable
         - KinesisStream
-        - CUstomIamRole
+        - CustomIamRole
       tags:
         Team: Atlantis
   activities:
@@ -1166,6 +1170,73 @@ stepFunctions:
         ...
 ```
 
+#### Specifying a DeadLetterQueue
+
+You can configure a target queue to send dead-letter queue events to:
+
+```yml
+stepFunctions:
+  stateMachines:
+    exampleEventBridgeEventStartsMachine:
+      events:
+        - eventBridge:
+            eventBusName: 'my-custom-event-bus'
+            event:
+              source:
+                - "my.custom.source"
+              detail-type:
+                - "My Event Type"
+              detail:
+                state:
+                  - pending
+            deadLetterConfig: 'arn:aws:sqs:us-east-1:012345678910:my-dlq' # SQS Arn
+      definition:
+        ...
+```
+##### Important point
+Don't forget to [Grant permissions to the dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-dlq.html#eb-dlq-perms), to do that you may need to have the `ARN` of the generated `EventBridge Rule`.
+
+In order to get the `ARN` you can use [intrinsic functions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html) against the `logicalId`, this plugin generates `logicalIds` following this format:
+```ts
+`${StateMachineName}EventsRuleCloudWatchEvent${index}`
+```
+Given this example 👇
+```yml
+stepFunctions:
+  stateMachines:
+    hellostepfunc1: # <---- StateMachineName
+      events:
+        - eventBridge:
+            eventBusName: 'my-custom-event-bus'
+            event:
+              source:
+                - "my.custom.source"
+        - eventBridge:
+            eventBusName: 'my-custom-event-bus'
+            event:
+              source:
+                - "my.custom.source"
+            deadLetterConfig: 'arn:aws:sqs:us-east-1:012345678910:my-dlq'
+      name: myStateMachine
+      definition:
+        Comment: "A Hello World example of the Amazon States Language using an AWS Lambda Function"
+        StartAt: HelloWorld1
+        States:
+          HelloWorld1:
+            Type: Task
+            Resource:
+              Fn::GetAtt: [hello, Arn]
+            End: true
+```
+Then
+```yaml
+# to get the Arn of the 1st EventBridge rule
+!GetAtt Hellostepfunc1EventsRuleCloudWatchEvent1.Arn
+
+# to get the Arn of the 2nd EventBridge rule
+!GetAtt Hellostepfunc1EventsRuleCloudWatchEvent2.Arn
+```
+
 ## Tags
 
 You can specify tags on each state machine. Additionally any global tags (specified under `provider` section in your `serverless.yml`) would be merged in as well.

README.md

@@ -5,12 +5,14 @@ const BbPromise = require('bluebird');
 
 module.exports = {
   compileApiKeys() {
-    if (this.serverless.service.provider.apiKeys) {
-      if (!Array.isArray(this.serverless.service.provider.apiKeys)) {
+    const apiKeys = _.get(this.serverless.service.provider.apiGateway, 'apiKeys')
+      || this.serverless.service.provider.apiKeys;
+    if (apiKeys) {
+      if (!Array.isArray(apiKeys)) {
         throw new this.serverless.classes.Error('apiKeys property must be an array');
       }
 
-      _.forEach(this.serverless.service.provider.apiKeys, (apiKey, i) => {
+      _.forEach(apiKeys, (apiKey, i) => {
         const apiKeyNumber = i + 1;
 
         if (typeof apiKey !== 'string') {

lib/deploy/events/apiGateway/apiKeys.js

@@ -2,7 +2,7 @@
 
 const expect = require('chai').expect;
 const Serverless = require('serverless/lib/Serverless');
-const AwsProvider = require('serverless/lib/plugins/aws/provider/awsProvider');
+const AwsProvider = require('serverless/lib/plugins/aws/provider');
 const ServerlessStepFunctions = require('./../../../index');
 
 describe('#methods()', () => {
@@ -16,7 +16,8 @@ describe('#methods()', () => {
       region: 'us-east-1',
     };
     serverless.setProvider('aws', new AwsProvider(serverless));
-    serverless.service.provider.apiKeys = ['1234567890'];
+    if (!serverless.service.provider.apiGateway) serverless.service.provider.apiGateway = {};
+    serverless.service.provider.apiGateway.apiKeys = ['1234567890'];
     serverless.service.provider.compiledCloudFormationTemplate = {
       Resources: {},
     };
@@ -79,12 +80,12 @@ describe('#methods()', () => {
   }));
 
   it('throw error if apiKey property is not an array', () => {
-    serverlessStepFunctions.serverless.service.provider.apiKeys = 2;
+    serverlessStepFunctions.serverless.service.provider.apiGateway.apiKeys = 2;
     expect(() => serverlessStepFunctions.compileApiKeys()).to.throw(Error);
   });
 
   it('throw error if an apiKey is not a string', () => {
-    serverlessStepFunctions.serverless.service.provider.apiKeys = [2];
+    serverlessStepFunctions.serverless.service.provider.apiGateway.apiKeys = [2];
     expect(() => serverlessStepFunctions.compileApiKeys()).to.throw(Error);
   });
 });

lib/deploy/events/apiGateway/apiKeys.test.js

@@ -2,7 +2,7 @@
 
 const expect = require('chai').expect;
 const Serverless = require('serverless/lib/Serverless');
-const AwsProvider = require('serverless/lib/plugins/aws/provider/awsProvider');
+const AwsProvider = require('serverless/lib/plugins/aws/provider');
 const ServerlessStepFunctions = require('./../../../index');
 
 describe('#compileAuthorizers()', () => {

lib/deploy/events/apiGateway/authorizers.test.js

@@ -2,7 +2,7 @@
 
 const expect = require('chai').expect;
 const Serverless = require('serverless/lib/Serverless');
-const AwsProvider = require('serverless/lib/plugins/aws/provider/awsProvider');
+const AwsProvider = require('serverless/lib/plugins/aws/provider');
 const ServerlessStepFunctions = require('./../../../index');
 
 describe('#compileCors()', () => {

lib/deploy/events/apiGateway/cors.test.js

@@ -2,7 +2,7 @@
 
 const expect = require('chai').expect;
 const Serverless = require('serverless/lib/Serverless');
-const AwsProvider = require('serverless/lib/plugins/aws/provider/awsProvider');
+const AwsProvider = require('serverless/lib/plugins/aws/provider');
 const ServerlessStepFunctions = require('./../../../index');
 
 describe('#compileDeployment()', () => {

lib/deploy/events/apiGateway/deployment.test.js

@@ -4,7 +4,7 @@ const expect = require('chai').expect;
 const sinon = require('sinon');
 const BbPromise = require('bluebird');
 const Serverless = require('serverless/lib/Serverless');
-const AwsProvider = require('serverless/lib/plugins/aws/provider/awsProvider');
+const AwsProvider = require('serverless/lib/plugins/aws/provider');
 const ServerlessStepFunctions = require('./../../../index');
 
 

lib/deploy/events/apiGateway/endpointInfo.test.js

@@ -2,7 +2,7 @@
 
 const expect = require('chai').expect;
 const Serverless = require('serverless/lib/Serverless');
-const AwsProvider = require('serverless/lib/plugins/aws/provider/awsProvider');
+const AwsProvider = require('serverless/lib/plugins/aws/provider');
 const ServerlessStepFunctions = require('./../../../index');
 
 describe('#compileHttpIamRole()', () => {