Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(events-targets): cannot set retry policy to 0 retry attempts #21900

Merged
merged 15 commits into from
Sep 3, 2022
Merged

fix(events-targets): cannot set retry policy to 0 retry attempts #21900

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
bc41fb1
Allow retryAttempts to be set to 0
VarunWachaspati Sep 2, 2022
02a7120
Add 0 retryAttempt unit test for AWS Batch
VarunWachaspati Sep 2, 2022
e87e413
Add 0 retryAttempt unit test for AWS CodeBuild
VarunWachaspati Sep 2, 2022
db88ca6
Add 0 retryAttempt unit test for AWS CodePipeline
VarunWachaspati Sep 2, 2022
7e0b8d2
Add 0 retryAttempt unit test for AWS Lambda
VarunWachaspati Sep 2, 2022
2635a55
Add 0 retryAttempt unit test for CloudWatch Logs
VarunWachaspati Sep 2, 2022
3609dbb
Add 0 retryAttempt unit test for AWS SQS
VarunWachaspati Sep 2, 2022
3c2a266
Add 0 retryAttempt unit test for AWS StepFunctions
VarunWachaspati Sep 2, 2022
f533ef6
Add undefined check
VarunWachaspati Sep 2, 2022
bb187c3
Remove unused queue from unit test
VarunWachaspati Sep 2, 2022
ce0ce89
Merge branch 'main' into retry-attempts
TheRealAmazonKendra Sep 3, 2022
5fb163b
Add integration test for 0 retry attempts
VarunWachaspati Sep 3, 2022
6b08375
Merge branch 'retry-attempts' of https://github.com/VarunWachaspati/a…
VarunWachaspati Sep 3, 2022
686cf70
Merge branch 'main' into retry-attempts
mergify[bot] Sep 3, 2022
28af3fa
Merge branch 'main' into retry-attempts
mergify[bot] Sep 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-events-targets/lib/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export function bindBaseTargetConfig(props: TargetBaseProps) {

return {
deadLetterConfig: deadLetterQueue ? { arn: deadLetterQueue?.queueArn } : undefined,
retryPolicy: retryAttempts || maxEventAge
retryPolicy: (retryAttempts !== undefined && retryAttempts >= 0) || maxEventAge
? {
maximumRetryAttempts: retryAttempts,
maximumEventAgeInSeconds: maxEventAge?.toSeconds({ integral: true }),
Expand Down
52 changes: 52 additions & 0 deletions packages/@aws-cdk/aws-events-targets/test/batch/batch.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,4 +237,56 @@ describe('Batch job event target', () => {
],
});
});

test('specifying retry policy with 0 retryAttempts', () => {
// GIVEN
const rule = new events.Rule(stack, 'Rule', {
schedule: events.Schedule.expression('rate(1 hour)'),
});

// WHEN
const eventInput = {
buildspecOverride: 'buildspecs/hourly.yml',
};

rule.addTarget(new targets.BatchJob(
jobQueue.jobQueueArn,
jobQueue,
jobDefinition.jobDefinitionArn,
jobDefinition, {
event: events.RuleTargetInput.fromObject(eventInput),
retryAttempts: 0,
},
));

// THEN
Template.fromStack(stack).hasResourceProperties('AWS::Events::Rule', {
ScheduleExpression: 'rate(1 hour)',
State: 'ENABLED',
Targets: [
{
Arn: {
Ref: 'MyQueueE6CA6235',
},
BatchParameters: {
JobDefinition: {
Ref: 'MyJob8719E923',
},
JobName: 'Rule',
},
Id: 'Target0',
Input: JSON.stringify(eventInput),
RetryPolicy: {
MaximumRetryAttempts: 0,
},
RoleArn: {
'Fn::GetAtt': [
'MyJobEventsRoleCF43C336',
'Arn',
],
},
},
],
});
});
});
46 changes: 46 additions & 0 deletions packages/@aws-cdk/aws-events-targets/test/codebuild/codebuild.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,52 @@ describe('CodeBuild event target', () => {
});
});

test('specifying retry policy with 0 retryAttempts', () => {
// GIVEN
const rule = new events.Rule(stack, 'Rule', {
schedule: events.Schedule.expression('rate(1 hour)'),
});

// WHEN
const eventInput = {
buildspecOverride: 'buildspecs/hourly.yml',
};

rule.addTarget(
new targets.CodeBuildProject(project, {
event: events.RuleTargetInput.fromObject(eventInput),
retryAttempts: 0,
}),
);

// THEN
Template.fromStack(stack).hasResourceProperties('AWS::Events::Rule', {
ScheduleExpression: 'rate(1 hour)',
State: 'ENABLED',
Targets: [
{
Arn: {
'Fn::GetAtt': [
'MyProject39F7B0AE',
'Arn',
],
},
Id: 'Target0',
Input: '{"buildspecOverride":"buildspecs/hourly.yml"}',
RetryPolicy: {
MaximumRetryAttempts: 0,
},
RoleArn: {
'Fn::GetAtt': [
'MyProjectEventsRole5B7D93F5',
'Arn',
],
},
},
],
});
});

test('use a Dead Letter Queue for the rule target', () => {
// GIVEN
const rule = new events.Rule(stack, 'Rule', {
Expand Down
50 changes: 50 additions & 0 deletions packages/@aws-cdk/aws-events-targets/test/codepipeline/pipeline.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,56 @@ describe('CodePipeline event target', () => {
],
});
});

test('adds 0 retry attempts to the target configuration', () => {
// WHEN
rule.addTarget(new targets.CodePipeline(pipeline, {
retryAttempts: 0,
}));

// THEN
Template.fromStack(stack).hasResourceProperties('AWS::Events::Rule', {
ScheduleExpression: 'rate(1 minute)',
State: 'ENABLED',
Targets: [
{
Arn: {
'Fn::Join': [
'',
[
'arn:',
{
Ref: 'AWS::Partition',
},
':codepipeline:',
{
Ref: 'AWS::Region',
},
':',
{
Ref: 'AWS::AccountId',
},
':',
{
Ref: 'PipelineC660917D',
},
],
],
},
Id: 'Target0',
RetryPolicy: {
MaximumRetryAttempts: 0,
},
RoleArn: {
'Fn::GetAtt': [
'PipelineEventsRole46BEEA7C',
'Arn',
],
},
},
],
});
});
});

describe('with an explicit event role', () => {
Expand Down
43 changes: 43 additions & 0 deletions packages/@aws-cdk/aws-events-targets/test/lambda/lambda.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,49 @@ test('specifying retry policy', () => {
});
});

test('specifying retry policy with 0 retryAttempts', () => {
// GIVEN
const app = new cdk.App();
const stack = new cdk.Stack(app, 'Stack');

const fn = new lambda.Function(stack, 'MyLambda', {
code: new lambda.InlineCode('foo'),
handler: 'bar',
runtime: lambda.Runtime.PYTHON_3_9,
});

// WHEN
new events.Rule(stack, 'Rule', {
schedule: events.Schedule.rate(cdk.Duration.minutes(1)),
targets: [new targets.LambdaFunction(fn, {
retryAttempts: 0,
})],
});

// THEN
expect(() => app.synth()).not.toThrow();

// the Permission resource should be in the event stack
Template.fromStack(stack).hasResourceProperties('AWS::Events::Rule', {
ScheduleExpression: 'rate(1 minute)',
State: 'ENABLED',
Targets: [
{
Arn: {
'Fn::GetAtt': [
'MyLambdaCCE802FB',
'Arn',
],
},
Id: 'Target0',
RetryPolicy: {
MaximumRetryAttempts: 0,
},
},
],
});
});

function newTestLambda(scope: constructs.Construct, suffix = '') {
return new lambda.Function(scope, `MyLambda${suffix}`, {
code: new lambda.InlineCode('foo'),
Expand Down
64 changes: 64 additions & 0 deletions packages/@aws-cdk/aws-events-targets/test/logs/log-group.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,3 +295,67 @@ testDeprecated('specifying retry policy and dead letter queue', () => {
],
});
});

testDeprecated('specifying retry policy with 0 retryAttempts', () => {
// GIVEN
const stack = new cdk.Stack();
const logGroup = new logs.LogGroup(stack, 'MyLogGroup', {
logGroupName: '/aws/events/MyLogGroup',
});
const rule1 = new events.Rule(stack, 'Rule', {
schedule: events.Schedule.rate(cdk.Duration.minutes(1)),
});

// WHEN
rule1.addTarget(new targets.CloudWatchLogGroup(logGroup, {
event: events.RuleTargetInput.fromObject({
timestamp: events.EventField.time,
message: events.EventField.fromPath('$'),
}),
retryAttempts: 0,
}));

// THEN
Template.fromStack(stack).hasResourceProperties('AWS::Events::Rule', {
ScheduleExpression: 'rate(1 minute)',
State: 'ENABLED',
Targets: [
{
Arn: {
'Fn::Join': [
'',
[
'arn:',
{
Ref: 'AWS::Partition',
},
':logs:',
{
Ref: 'AWS::Region',
},
':',
{
Ref: 'AWS::AccountId',
},
':log-group:',
{
Ref: 'MyLogGroup5C0DAD85',
},
],
],
},
Id: 'Target0',
InputTransformer: {
InputPathsMap: {
time: '$.time',
f2: '$',
},
InputTemplate: '{"timestamp":<time>,"message":<f2>}',
},
RetryPolicy: {
MaximumRetryAttempts: 0,
},
},
],
});
});
32 changes: 32 additions & 0 deletions packages/@aws-cdk/aws-events-targets/test/sqs/sqs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,3 +252,35 @@ test('specifying retry policy', () => {
],
});
});

test('specifying retry policy with 0 retryAttempts', () => {
const stack = new Stack();
const queue = new sqs.Queue(stack, 'MyQueue', { fifo: true });
const rule = new events.Rule(stack, 'MyRule', {
schedule: events.Schedule.rate(Duration.hours(1)),
});

// WHEN
rule.addTarget(new targets.SqsQueue(queue, {
retryAttempts: 0,
}));

Template.fromStack(stack).hasResourceProperties('AWS::Events::Rule', {
ScheduleExpression: 'rate(1 hour)',
State: 'ENABLED',
Targets: [
{
Arn: {
'Fn::GetAtt': [
'MyQueueE6CA6235',
'Arn',
],
},
Id: 'Target0',
RetryPolicy: {
MaximumRetryAttempts: 0,
},
},
],
});
});
46 changes: 46 additions & 0 deletions packages/@aws-cdk/aws-events-targets/test/stepfunctions/statemachine.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,52 @@ test('specifying retry policy', () => {
});
});

test('specifying retry policy with 0 retryAttempts', () => {
// GIVEN
const stack = new cdk.Stack();
const rule = new events.Rule(stack, 'Rule', {
schedule: events.Schedule.expression('rate(1 hour)'),
});

// WHEN
const role = new iam.Role(stack, 'Role', {
assumedBy: new iam.ServicePrincipal('events.amazonaws.com'),
});
const stateMachine = new sfn.StateMachine(stack, 'SM', {
definition: new sfn.Wait(stack, 'Hello', { time: sfn.WaitTime.duration(cdk.Duration.seconds(10)) }),
});

rule.addTarget(new targets.SfnStateMachine(stateMachine, {
input: events.RuleTargetInput.fromObject({ SomeParam: 'SomeValue' }),
retryAttempts: 0,
role: role,
}));

// THEN
Template.fromStack(stack).hasResourceProperties('AWS::Events::Rule', {
ScheduleExpression: 'rate(1 hour)',
State: 'ENABLED',
Targets: [
{
Arn: {
Ref: 'SM934E715A',
},
Id: 'Target0',
Input: '{"SomeParam":"SomeValue"}',
RetryPolicy: {
MaximumRetryAttempts: 0,
},
RoleArn: {
'Fn::GetAtt': [
'Role1ABCC5F0',
'Arn',
],
},
},
],
});
});

test('use a Dead Letter Queue for the rule target', () => {
// GIVEN
const app = new cdk.App();
Expand Down