archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-25 15:07:39 +00:00
Code Issues Projects Releases Wiki Activity

Allow Fn::Join in stream event arns

Browse Source
This commit is contained in:
Tyler Hogan 2019-04-24 21:41:12 -07:00
parent 76beb286c3
commit 44697b94b4
No known key found for this signature in database
GPG Key ID: 0BEFFB08FEEB463E
3 changed files with 70 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/providers/aws/events/streams.md
View File

@ -44,6 +44,17 @@ functions:
type: kinesis
arn:
Fn::ImportValue: MyExportedKinesisStreamArnId
- stream
type: kinesis
arn:
Fn::Join:
- ":"
- - arn
- aws
- kinesis
- Ref: AWS::Region
- Ref: AWS::AccountId
- MyOtherKinesisStream
```
## Setting the BatchSize and StartingPosition

8
lib/plugins/aws/package/compile/events/stream/index.js
View File

@ -70,8 +70,9 @@ class AwsCompileStreamEvents {
.Error(errorMessage);
}
if (Object.keys(event.stream.arn).length !== 1
|| !(_.has(event.stream.arn, 'Fn::ImportValue')
|| _.has(event.stream.arn, 'Fn::GetAtt'))) {
|| !(_.has(event.stream.arn, 'Fn::ImportValue')
|| _.has(event.stream.arn, 'Fn::GetAtt')
|| _.has(event.stream.arn, 'Fn::Join'))) {
const errorMessage = [
`Bad dynamic ARN property on stream event in function "${functionName}"`,
' If you use a dynamic "arn" (such as with Fn::GetAtt or Fn::ImportValue)',
@ -109,6 +110,9 @@ class AwsCompileStreamEvents {
return EventSourceArn['Fn::GetAtt'][0];
} else if (EventSourceArn['Fn::ImportValue']) {
return EventSourceArn['Fn::ImportValue'];
} else if (EventSourceArn['Fn::Join']) {
// [0] is the used delimiter, [1] is the array with values
return EventSourceArn['Fn::Join'][1].slice(-1).pop();
}
return EventSourceArn.split('/')[1];
}());

66
lib/plugins/aws/package/compile/events/stream/index.test.js
View File

@ -337,21 +337,21 @@ describe('AwsCompileStreamEvents', () => {
.Properties.EventSourceArn
).to.equal(
awsCompileStreamEvents.serverless.service.functions.first.events[0]
.stream.arn
.stream.arn
);
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources.FirstEventSourceMappingDynamodbFoo
.Properties.BatchSize
).to.equal(
awsCompileStreamEvents.serverless.service.functions.first.events[0]
.stream.batchSize
.stream.batchSize
);
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources.FirstEventSourceMappingDynamodbFoo
.Properties.StartingPosition
).to.equal(
awsCompileStreamEvents.serverless.service.functions.first.events[0]
.stream.startingPosition
.stream.startingPosition
);
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources.FirstEventSourceMappingDynamodbFoo
@ -372,7 +372,7 @@ describe('AwsCompileStreamEvents', () => {
.Properties.EventSourceArn
).to.equal(
awsCompileStreamEvents.serverless.service.functions.first.events[1]
.stream.arn
.stream.arn
);
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources.FirstEventSourceMappingDynamodbBar
@ -401,7 +401,7 @@ describe('AwsCompileStreamEvents', () => {
.Properties.EventSourceArn
).to.equal(
awsCompileStreamEvents.serverless.service.functions.first.events[2]
.stream
.stream
);
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources.FirstEventSourceMappingDynamodbBaz
@ -433,13 +433,30 @@ describe('AwsCompileStreamEvents', () => {
type: 'kinesis',
},
},
{
stream: {
arn: {
'Fn::Join': [
':', [
'arn', 'aws', 'kinesis', {
Ref: 'AWS::Region',
}, {
Ref: 'AWS::AccountId',
},
'MyStream',
],
],
},
type: 'kinesis',
},
},
],
},
};
awsCompileStreamEvents.compileStreamEvents();
// dynamodb version
// dynamodb with Fn::GetAtt
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources
.FirstEventSourceMappingDynamodbSomeDdbTable.Properties.EventSourceArn
@ -468,13 +485,36 @@ describe('AwsCompileStreamEvents', () => {
],
}
);
// and now kinesis
// kinesis with Fn::ImportValue
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources
.FirstEventSourceMappingKinesisForeignKinesis.Properties.EventSourceArn
).to.deep.equal(
{ 'Fn::ImportValue': 'ForeignKinesis' }
);
// kinesis with Fn::Join
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources
.FirstEventSourceMappingKinesisMyStream.Properties.EventSourceArn
).to.deep.equal(
{
'Fn::Join': [
':', [
'arn',
'aws',
'kinesis',
{
Ref: 'AWS::Region',
}, {
Ref: 'AWS::AccountId',
},
'MyStream',
],
],
}
);
});
it('fails if Fn::GetAtt/dynamic stream ARN is used without a type', () => {
@ -493,7 +533,7 @@ describe('AwsCompileStreamEvents', () => {
expect(() => awsCompileStreamEvents.compileStreamEvents()).to.throw(Error);
});
it('fails if keys other than Fn::GetAtt/ImportValue are used for dynamic stream ARN', () => {
it('fails if keys other than Fn::GetAtt/ImportValue/Join are used for dynamic stream ARN', () => {
awsCompileStreamEvents.serverless.service.functions = {
first: {
events: [
@ -594,21 +634,21 @@ describe('AwsCompileStreamEvents', () => {
.Properties.EventSourceArn
).to.equal(
awsCompileStreamEvents.serverless.service.functions.first.events[0]
.stream.arn
.stream.arn
);
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources.FirstEventSourceMappingKinesisFoo
.Properties.BatchSize
).to.equal(
awsCompileStreamEvents.serverless.service.functions.first.events[0]
.stream.batchSize
.stream.batchSize
);
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources.FirstEventSourceMappingKinesisFoo
.Properties.StartingPosition
).to.equal(
awsCompileStreamEvents.serverless.service.functions.first.events[0]
.stream.startingPosition
.stream.startingPosition
);
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources.FirstEventSourceMappingKinesisFoo
@ -629,7 +669,7 @@ describe('AwsCompileStreamEvents', () => {
.Properties.EventSourceArn
).to.equal(
awsCompileStreamEvents.serverless.service.functions.first.events[1]
.stream.arn
.stream.arn
);
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources.FirstEventSourceMappingKinesisBar
@ -658,7 +698,7 @@ describe('AwsCompileStreamEvents', () => {
.Properties.EventSourceArn
).to.equal(
awsCompileStreamEvents.serverless.service.functions.first.events[2]
.stream
.stream
);
expect(awsCompileStreamEvents.serverless.service
.provider.compiledCloudFormationTemplate.Resources.FirstEventSourceMappingKinesisBaz