Merge pull request #79 from jcortega/master

Feature: Support for EventBridge / CloudWatchEvent

Author: horike37

README.md

@@ -19,6 +19,7 @@ This Serverless Framework plugin supports the AWS service proxy integration feat
       - [Can use greedy, for deeper Folders](#can-use-greedy--for-deeper-folders)
   - [SNS](#sns)
   - [DynamoDB](#dynamodb)
+  - [EventBridge](#eventbridge)
 - [Common API Gateway features](#common-api-gateway-features)
   - [Enabling CORS](#enabling-cors)
   - [Adding Authorization](#adding-authorization)
@@ -47,6 +48,7 @@ Please pull request if you are intersted in it.
 - S3
 - SNS
 - DynamoDB
+- EventBridge
 
 ## How to use
 
@@ -376,6 +378,56 @@ curl -XPUT https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/dynamodb/<has
  -H 'Content-Type:application/json'
 ```
 
+
+### EventBridge
+
+Sample syntax for EventBridge proxy in `serverless.yml`.
+
+```yaml
+custom:
+  apiGatewayServiceProxies:
+    - eventbridge:  # source and detailType are hardcoded; detail defaults to POST body
+        path: /eventbridge
+        method: post
+        source: 'hardcoded_source'
+        detailType: 'hardcoded_detailType'
+        eventBusName: { Ref: 'YourBusName' }
+        cors: true
+    - eventbridge:  # source and detailType as path parameters
+        path: /eventbridge/{detailTypeKey}/{sourceKey}
+        method: post
+        detailType:
+          pathParam: detailTypeKey
+        source:
+          pathParam: sourceKey
+        eventBusName: { Ref: 'YourBusName' }
+        cors: true
+    - eventbridge:  # source, detail, and detailType as body parameters
+        path: /eventbridge/{detailTypeKey}/{sourceKey}
+        method: post
+        detailType:
+          bodyParam: data.detailType
+        source:
+          bodyParam: data.source
+        detail:
+          bodyParam: data.detail
+        eventBusName: { Ref: 'YourBusName' }
+        cors: true
+
+resources:
+  Resources:
+    YourBus:
+      Type: AWS::Events::EventBus
+      Properties:
+        Name: YourEventBus
+```
+
+Sample request after deploying.
+
+```bash
+curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/eventbridge -d '{"message": "some data"}'  -H 'Content-Type:application/json'
+```
+
 ## Common API Gateway features
 
 ### Enabling CORS
@@ -659,4 +711,4 @@ custom:
                 "success": false,
                 "errorMessage": "Client Error"
               }
-```
+```

__tests__/integration/eventbridge/multiple-integrations/service/serverless.yml

@@ -0,0 +1,55 @@
+service: multiple-eventbridge-proxy
+
+provider:
+  name: aws
+  runtime: nodejs10.x
+
+plugins:
+  localPath: './../../../../../../'
+  modules:
+    - serverless-apigateway-service-proxy
+
+custom:
+  apiGatewayServiceProxies:
+    # set static detailType and source
+    - eventbridge:
+        path: /eventbridge1
+        method: post
+        detailType: 'hardcordeddetailtype'
+        source: 'hardcodedsource'
+        eventBusName: { Ref: 'YourBus' }
+        cors: true
+    # set detailType and source as path parameter
+    - eventbridge:
+        path: /eventbridge2/{myDetailType}/{mySource} 
+        method: post
+        detailType:
+          pathParam: myDetailType
+        source:
+          pathParam: mySource
+        eventBusName: { Ref: 'YourBus' }
+        cors: true
+    # set detailType and source as query parameter
+    - eventbridge:
+        path: /eventbridge3
+        method: post
+        detailType:
+          queryStringParam: myDetailTypeKey
+        source:
+          queryStringParam: mySourceKey
+        eventBusName: { Ref: 'YourBus' }
+        cors: true
+    # set value of detailType api event id by default
+    - eventbridge:
+        path: /eventbridge4
+        method: post
+        eventBusName: { Ref: 'YourBus' }
+        source: mySourceName
+        cors: true
+
+resources:
+  Resources:
+    YourBus:
+      Type: AWS::Events::EventBus
+      Properties:
+        Name: YourEventBus-${self:provider.stage}-multi

__tests__/integration/eventbridge/multiple-integrations/tests.js

@@ -0,0 +1,81 @@
+'use strict'
+
+const expect = require('chai').expect
+const fetch = require('node-fetch')
+const { deployWithRandomStage, removeService } = require('../../../utils')
+
+describe('Multiple EventBridge Proxy Integrations Test', () => {
+  let endpoint
+  let stage
+  const config = '__tests__/integration/eventbridge/multiple-integrations/service/serverless.yml'
+
+  beforeAll(async () => {
+    const result = await deployWithRandomStage(config)
+    stage = result.stage
+    endpoint = result.endpoint
+  })
+
+  afterAll(() => {
+    removeService(stage, config)
+  })
+
+  it('should get correct response from eventbridge proxy endpoints with static detailType and source', async () => {
+    const testEndpoint = `${endpoint}/eventbridge1`
+    const response = await fetch(testEndpoint, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({ message: `data for event bus` })
+    })
+    expect(response.headers.get('access-control-allow-origin')).to.deep.equal('*')
+    expect(response.status).to.be.equal(200)
+    const body = await response.json()
+    expect(body).to.have.own.property('Entries')
+    expect(body).to.have.own.property('FailedEntryCount')
+    expect(body.FailedEntryCount).to.equal(0)
+  })
+
+  it('should get correct response from eventbridge proxy endpoints with detailType and source as path parameters', async () => {
+    const testEndpoint = `${endpoint}/eventbridge2/myDetailType/mySource`
+    const response = await fetch(testEndpoint, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({ message: `data for event bus` })
+    })
+    expect(response.headers.get('access-control-allow-origin')).to.deep.equal('*')
+    expect(response.status).to.be.equal(200)
+    const body = await response.json()
+    expect(body).to.have.own.property('Entries')
+    expect(body).to.have.own.property('FailedEntryCount')
+    expect(body.FailedEntryCount).to.equal(0)
+  })
+
+  it('should get correct response from eventbridge proxy endpoints with detailType and source as query parameters', async () => {
+    const testEndpoint = `${endpoint}/eventbridge3?myDetailTypeKey=myDetailTypeValue&mySourceKey=mySourceValue`
+    const response = await fetch(testEndpoint, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({ message: `data for event bus` })
+    })
+    expect(response.headers.get('access-control-allow-origin')).to.deep.equal('*')
+    expect(response.status).to.be.equal(200)
+    const body = await response.json()
+    expect(body).to.have.own.property('Entries')
+    expect(body).to.have.own.property('FailedEntryCount')
+    expect(body.FailedEntryCount).to.equal(0)
+  })
+
+  it('should get correct response from eventbridge proxy endpoints without given detailType and source parameters', async () => {
+    const testEndpoint = `${endpoint}/eventbridge4`
+    const response = await fetch(testEndpoint, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({ message: `data for event bus` })
+    })
+    expect(response.headers.get('access-control-allow-origin')).to.deep.equal('*')
+    expect(response.status).to.be.equal(200)
+    const body = await response.json()
+    expect(body).to.have.own.property('Entries')
+    expect(body).to.have.own.property('FailedEntryCount')
+    expect(body.FailedEntryCount).to.equal(0)
+  })
+})

__tests__/integration/eventbridge/single-integration/service/serverless.yml

@@ -0,0 +1,26 @@
+service: eventbridge-proxy
+
+provider:
+  name: aws
+  runtime: nodejs10.x
+
+plugins:
+  localPath: './../../../../../../'
+  modules:
+    - serverless-apigateway-service-proxy
+
+custom:
+  apiGatewayServiceProxies:
+    - eventbridge:
+        path: /eventbridge
+        method: post
+        eventBusName: { Ref: 'YourBus' }
+        source: mySourceName
+        cors: true
+
+resources:
+  Resources:
+    YourBus:
+      Type: AWS::Events::EventBus
+      Properties:
+        Name: YourEventBus-${self:provider.stage}-single

__tests__/integration/eventbridge/single-integration/tests.js

@@ -0,0 +1,37 @@
+'use strict'
+
+const expect = require('chai').expect
+const fetch = require('node-fetch')
+const { deployWithRandomStage, removeService } = require('../../../utils')
+
+describe('Single EventBridge Proxy Integration Test', () => {
+  let endpoint
+  let stage
+  const config = '__tests__/integration/eventbridge/single-integration/service/serverless.yml'
+
+  beforeAll(async () => {
+    const result = await deployWithRandomStage(config)
+    stage = result.stage
+    endpoint = result.endpoint
+  })
+
+  afterAll(() => {
+    removeService(stage, config)
+  })
+
+  it('should get correct response from eventbridge proxy endpoint', async () => {
+    const testEndpoint = `${endpoint}/eventbridge`
+
+    const response = await fetch(testEndpoint, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({ message: 'some data' })
+    })
+    expect(response.headers.get('access-control-allow-origin')).to.deep.equal('*')
+    expect(response.status).to.be.equal(200)
+    const body = await response.json()
+    expect(body).to.have.own.property('Entries')
+    expect(body).to.have.own.property('FailedEntryCount')
+    expect(body.FailedEntryCount).to.equal(0)
+  })
+})

lib/apiGateway/schema.js

@@ -163,6 +163,23 @@ const dynamodbDefaultKeyScheme = Joi.object()
     )
   )
 
+// EventBridge detailType parameter
+const detailType = Joi.alternatives().try([
+  Joi.string(),
+  Joi.object()
+    .keys({
+      pathParam: Joi.string(),
+      queryStringParam: Joi.string()
+    })
+    .xor('pathParam', 'queryStringParam')
+    .error(
+      customErrorBuilder(
+        'object.xor',
+        'key must contain "pathParam" or "queryStringParam and only one'
+      )
+    )
+])
+
 const request = Joi.object({
   template: Joi.object().required()
 })
@@ -175,7 +192,7 @@ const response = Joi.object({
   })
 })
 
-const allowedProxies = ['kinesis', 'sqs', 's3', 'sns', 'dynamodb']
+const allowedProxies = ['kinesis', 'sqs', 's3', 'sns', 'dynamodb', 'eventbridge']
 
 const proxiesSchemas = {
   kinesis: Joi.object({
@@ -217,6 +234,13 @@ const proxiesSchemas = {
       hashKey: dynamodbDefaultKeyScheme.required(),
       rangeKey: dynamodbDefaultKeyScheme
     })
+  }),
+  eventbridge: Joi.object({
+    eventbridge: proxy.append({
+      eventBusName: stringOrRef.required(),
+      source: stringOrRef.required(),
+      detailType
+    })
   })
 }
 

lib/apiGateway/validate.test.js

@@ -40,7 +40,7 @@ describe('#validateServiceProxies()', () => {
 
       expect(() => serverlessApigatewayServiceProxy.validateServiceProxies()).to.throw(
         serverless.classes.Error,
-        'Invalid APIG proxy "xxxxx". This plugin supported Proxies are: kinesis, sqs, s3, sns, dynamodb.'
+        'Invalid APIG proxy "xxxxx". This plugin supported Proxies are: kinesis, sqs, s3, sns, dynamodb, eventbridge.'
       )
     })
 

lib/index.js

@@ -29,6 +29,10 @@ const compileSnsServiceProxy = require('./package/sns/compileSnsServiceProxy')
 const compileMethodsToDynamodb = require('./package/dynamodb/compileMethodsToDynamodb')
 const compileIamRoleToDynamodb = require('./package/dynamodb/compileIamRoleToDynamodb')
 const compileDynamodbServiceProxy = require('./package/dynamodb/compileDynamodbServiceProxy')
+// EventBridge
+const compileMethodsToEventBridge = require('./package/eventbridge/compileMethodsToEventBridge')
+const compileIamRoleToEventBridge = require('./package/eventbridge/compileIamRoleToEventBridge')
+const compileEventBridgeServiceProxy = require('./package/eventbridge/compileEventBridgeServiceProxy')
 
 class ServerlessApigatewayServiceProxy {
   constructor(serverless, options) {
@@ -60,6 +64,9 @@ class ServerlessApigatewayServiceProxy {
       compileMethodsToDynamodb,
       compileIamRoleToDynamodb,
       compileDynamodbServiceProxy,
+      compileMethodsToEventBridge,
+      compileIamRoleToEventBridge,
+      compileEventBridgeServiceProxy,
       getStackInfo,
       validate,
       methods,
@@ -90,6 +97,9 @@ class ServerlessApigatewayServiceProxy {
           // DynamoDB getProxy
           await this.compileDynamodbServiceProxy()
 
+          // EventBridge proxy
+          await this.compileEventBridgeServiceProxy()
+
           await this.mergeDeployment()
         }
       },