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

feat(scheduler): validate schedule name length #31200

Merged
merged 5 commits into from
Sep 4, 2024
Merged

feat(scheduler): validate schedule name length #31200

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
782f101
fix(scheduler): validate schedule name length
LaurenceWarne Aug 23, 2024
a59e40f
Update some wording
LaurenceWarne Aug 30, 2024
e061596
Merge branch 'main' into fix/add-length-limit-to-schedule-name
LaurenceWarne Sep 1, 2024
1ae1dd3
Merge branch 'main' into fix/add-length-limit-to-schedule-name
kaizencc Sep 4, 2024
887a1de
Merge branch 'main' into fix/add-length-limit-to-schedule-name
mergify[bot] Sep 4, 2024
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
5 changes: 4 additions & 1 deletion packages/@aws-cdk/aws-scheduler-alpha/lib/schedule.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Duration, IResource, Resource } from 'aws-cdk-lib';
import { Duration, IResource, Resource, Token } from 'aws-cdk-lib';
import * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';
import * as kms from 'aws-cdk-lib/aws-kms';
import { CfnSchedule } from 'aws-cdk-lib/aws-scheduler';
Expand Down Expand Up @@ -324,6 +324,9 @@ export class Schedule extends Resource implements ISchedule {
const flexibleTimeWindow = props.timeWindow ?? TimeWindow.off();

this.validateTimeFrame(props.start, props.end);
if (props.scheduleName && !Token.isUnresolved(props.scheduleName) && props.scheduleName.length > 64) {
throw new Error(`schedule name '${props.scheduleName}' exceeds 64 characters in length`);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be user-friendly and good to display the length.

Suggested change
throw new Error(`schedule name '${props.scheduleName}' exceeds 64 characters in length`);
throw new Error(`scheduleName cannot be longer than 64 characters, got: ${props.scheduleName.length}`);


const resource = new CfnSchedule(this, 'Resource', {
name: this.physicalName,
Expand Down
11 changes: 11 additions & 0 deletions packages/@aws-cdk/aws-scheduler-alpha/test/schedule.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,5 +214,16 @@ describe('Schedule', () => {
});
}).toThrow('The provided duration must be between 1 minute and 1440 minutes, got 0');
});

test('throw error when schedule name exceeds 64', () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
test('throw error when schedule name exceeds 64', () => {
test('throw error when scheduleName exceeds 64 characters', () => {

const name = 'an-extremely-unnecessarily-long-name-exceeding-64-characters-in-length';
expect(() => {
new Schedule(stack, 'TestSchedule', {
schedule: expr,
target: new SomeLambdaTarget(func, role),
scheduleName: name,
});
}).toThrow(`schedule name '${name}' exceeds 64 characters in length`);
});
});
});
Loading