Add ability to create AWS::Scheduler::Schedule triggers and specify timezone #11935

tie624 · 2023-04-25T14:48:37Z

Adds the ability to create AWS::Scheduler::Schedule triggers as an alternative to AWS::Event::Rule, which may be preferable if hitting account-wide limits on number of AWS::Event::Rule triggers per bus (Lambdas are only able to be triggered from the default bus).

Also allows you to specify a timezone to run it on local time.

Unless they need to use inputPath or inputTransformer, developers should be able to just add the method config option and seamlessly migrate to use Scheduler if the devs find themselves up against the account quotas.

Closes: #11680

Replaces: #11707

continues from the work of @joelwalden and @KillDozerX2

Also added timezone enum

…lues This will add better validation for users

renamed variable to being just `timezone`

tie624 · 2023-04-27T19:40:31Z

@medikoo I took the existing PRs and fixed the merged conflicts and filled in any missing holes. I have also tested it and it seems to be working OK. Can you please give it a review when you get a chance?

@joelwalden and @KillDozerX2 this PR includes the work you have done. So feel free to review this as well.

medikoo

@tie624 great thanks for thaking that over, and sorry for late review.

It looks as great direction, please see my comments

lib/plugins/aws/package/compile/events/schedule.js

lib/plugins/aws/package/lib/iam-role-lambda-execution-template.json

lib/plugins/aws/package/lib/merge-iam-templates.js

test/unit/lib/plugins/aws/package/compile/events/schedule.test.js

test/unit/lib/plugins/aws/package/lib/merge-iam-templates.test.js

tie624 · 2023-05-11T21:22:42Z

@tie624 great thanks for thaking that over, and sorry for late review.

It looks as great direction, please see my comments

@medikoo I have addressed your comments and made the appropriate changes. Can you please take another look when you can?

medikoo

Thank you @tie624 that looks really good!

I have just a few I believe final suggestions, and we should be good to go 🎉

lib/plugins/aws/package/compile/events/schedule.js

lib/plugins/aws/package/lib/merge-iam-templates.js

tie624 · 2023-05-13T03:40:04Z

Thank you @tie624 that looks really good!

I have just a few I believe final suggestions, and we should be good to go 🎉

@medikoo thanks for the tips and direction. The changes have been made. Please take another look at it.

tie624 · 2023-05-13T05:24:42Z

I also made the permissions more granular rather than using a wildcard to allow all functions.

medikoo

Thanks for update @tie624. I have just a few last style suggestions

lib/plugins/aws/package/compile/events/schedule.js

tie624 · 2023-05-15T18:29:30Z

@medikoo changes made

medikoo

Thank you @tie624 and sorry, there are still few thing which we should improve before merging this in

lib/plugins/aws/package/compile/events/schedule.js

test/unit/lib/plugins/aws/package/compile/events/schedule.test.js

tie624 · 2023-05-16T19:24:33Z

@medikoo please take another look.

codecov · 2023-05-17T08:43:45Z

Codecov Report

Patch coverage: 98.11% and project coverage change: +0.02 🎉

Comparison is base (bc99c2c) 86.68% compared to head (d3bef57) 86.71%.

❗ Current head d3bef57 differs from pull request most recent head f1885ba. Consider uploading reports for the commit f1885ba to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #11935      +/-   ##
==========================================
+ Coverage   86.68%   86.71%   +0.02%     
==========================================
  Files         316      316              
  Lines       13439    13474      +35     
==========================================
+ Hits        11650    11684      +34     
- Misses       1789     1790       +1

Impacted Files	Coverage Δ
commitlint.config.js	`0.00% <ø> (ø)`
...s/aws/package/compile/events/event-bridge/index.js	`97.72% <ø> (ø)`
lib/plugins/aws/provider.js	`94.78% <ø> (ø)`
lib/plugins/aws/package/compile/events/schedule.js	`97.82% <97.87%> (-0.48%)`	⬇️
lib/plugins/aws/deploy-function.js	`96.53% <100.00%> (ø)`
lib/plugins/aws/invoke-local/index.js	`69.87% <100.00%> (ø)`
lib/plugins/aws/lib/naming.js	`97.44% <100.00%> (+0.01%)`	⬆️
...gins/aws/package/compile/events/cloud-watch-log.js	`100.00% <100.00%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

medikoo

Great work @tie624 ! 🎉

…less#11935)

joelwalden and others added 11 commits January 25, 2023 21:06

Add ability to create AWS::Scheduler::Schedule triggers

811c5a4

Update docs

8418153

Updates based on PR feedback

5a4668e

Add required RoleARN param

bb18f4f

Update specs

c17c6e2

Add FlexibleTimeWindow to properties

07e9240

feat: ✨ Added ability to specify timezone

4a66cc1

Also added timezone enum

feat: ✨ Updated schema of schedule event to be one of two possible va…

f73658c

…lues This will add better validation for users

fix: 🐛 Switched to snake case for schedule expression timezone

20f4a76

renamed variable to being just `timezone`

fix: ✏️ Added schedule to method enum and added titles to both schemas

8d81acf

Merge branch 'main' into add-schedule-scheduler

8e5b786

tie624 marked this pull request as draft April 25, 2023 14:52

joelwalden and others added 8 commits April 25, 2023 11:12

Use SLS role instead of manually passing RoleARN

93e4f99

fix merge conflict resolution errors

39f7893

fix validation schema and tests

f1b9b41

add missing dependsOn property

565695c

fix naming issue

955c250

add missing role permissions

cde56e9

update documentation for using timezone

5171fe1

fix some tests and increase coverage

caf1c2c

tie624 marked this pull request as ready for review April 27, 2023 19:18

medikoo added enhancement cat/aws-event-schedule labels May 10, 2023

medikoo suggested changes May 10, 2023

View reviewed changes

medikoo mentioned this pull request May 10, 2023

Add ability to create AWS::Scheduler::Schedule triggers #11707

Closed

tie624 added 4 commits May 10, 2023 17:32

remove timezone list

b5de40c

combine validation schemas

0af72bd

add scheduler policy statements conditionally

98c3e78

move scheduler policies tests to scheduler test file

89924a2

isolate compiling of different resources

a91bbae

tie624 requested a review from medikoo May 11, 2023 21:21

medikoo suggested changes May 12, 2023

View reviewed changes

medikoo assigned tie624 May 12, 2023

a bit of refactoring

37efd30

tie624 requested a review from medikoo May 13, 2023 03:38

add granular permissions

c4c4e6a

medikoo suggested changes May 15, 2023

View reviewed changes

lib/plugins/aws/package/compile/events/schedule.js Outdated Show resolved Hide resolved

lib/plugins/aws/package/compile/events/schedule.js Show resolved Hide resolved

lib/plugins/aws/package/compile/events/schedule.js Outdated Show resolved Hide resolved

some more refactoring

317c732

tie624 requested a review from medikoo May 15, 2023 18:29

medikoo suggested changes May 16, 2023

View reviewed changes

lib/plugins/aws/package/compile/events/schedule.js Outdated Show resolved Hide resolved

lib/plugins/aws/package/compile/events/schedule.js Outdated Show resolved Hide resolved

test/unit/lib/plugins/aws/package/compile/events/schedule.test.js Outdated Show resolved Hide resolved

tie624 added 4 commits May 16, 2023 09:41

reorganize schedule event tests

1c6f54b

add test

84d9cc6

emend test

889c70b

refactor scheduler permissions

bdc735d

tie624 requested a review from medikoo May 16, 2023 19:22

fix small issue

f1885ba

medikoo approved these changes May 17, 2023

View reviewed changes

medikoo merged commit 34d922d into serverless:main May 17, 2023

bhb603 mentioned this pull request Jun 13, 2023

Error using timezone serverless/serverless-local-schedule#34

Open

danmactough mentioned this pull request Aug 1, 2023

EventBridge Scheduler Integration for Stepfunction serverless-operations/serverless-step-functions#571

Closed

jappurohit041 mentioned this pull request Sep 10, 2023

Create Schedules using Eventbridge Scheduler serverless-operations/serverless-step-functions#580

Merged

wardpieters mentioned this pull request Nov 6, 2023

fix: run pinginator at set time in correct timezone rickklaasboer/discord-pinginator#1

Merged

khacminh pushed a commit to khacminh/serverless that referenced this pull request Nov 29, 2023

feat(AWS Schedule): AWS::Scheduler::Schedule based triggers (server…

610ab63

…less#11935)

Add ability to create AWS::Scheduler::Schedule triggers and specify timezone #11935

Add ability to create AWS::Scheduler::Schedule triggers and specify timezone #11935

Uh oh!

Conversation

tie624 commented Apr 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tie624 commented Apr 27, 2023

Uh oh!

medikoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tie624 commented May 11, 2023

Uh oh!

medikoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tie624 commented May 13, 2023

Uh oh!

tie624 commented May 13, 2023

Uh oh!

medikoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tie624 commented May 15, 2023

Uh oh!

medikoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tie624 commented May 16, 2023

Uh oh!

codecov bot commented May 17, 2023

Codecov Report

Uh oh!

medikoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tie624 commented Apr 25, 2023 •

edited

Loading