feat: error handling on ticks by JosephVoid · Pull Request #861 · kelektiv/node-cron

JosephVoid · 2024-03-03T05:01:51Z

Description

I've added an error handling method in the CronJob class and added it to the constructors parameters. This error handling method will be called if any exception is thrown from the onTick method. Also added two new tests to confirm that it works.

Related Issue

Closes #426.

Motivation and Context

If any kind of exception occurs from the onTick method the whole process stops currently. To solve this, this feature will allow users to pass their own error handler when exceptions occur.

How Has This Been Tested?

Added two new test cases called should catch errors if errorhandler is provided & should throw errors if errorhandler is NOT provided

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.
If my change introduces a breaking change, I have added a ! after the type/scope in the title (see the Conventional Commits standard).

+ added error handling function param on a new constructor + added the function param on the static `from` method + caught the errors in the callback method

+ removed `@ts-expect-error line` bc it was throwing error itself

src/types/cron.types.ts

tests/cron.test.ts

src/job.ts

+ Instead of a new constructor, I added the `errorHandler` on every other constructor + removed the superflous if checks + added `errorHandler` on every `return new CronJob`

JosephVoid · 2024-03-08T04:19:36Z

Hey @sheerlox,

Thanks for the review. I've incorporated all the suggestions.

sheerlox

LGTM! Thank you for your contribution @JosephVoid 🙌

MetlHedd · 2024-11-27T14:32:27Z

Hey, any news on this being merged into main?

intcreator · 2024-12-11T19:43:11Z

hello, I'm currently working on the waitForCompletion PR as well as fixing the merge conflicts in this PR from that. I plan on reviewing this next

intcreator · 2024-12-14T04:08:40Z

I submitted a PR to this branch to fix the merge conflicts. @JosephVoid if you can merge it then this PR will be ready for a final review

intcreator · 2024-12-14T16:58:10Z

actually I think I submitted the PR to the wrong branch. new one here. if it works then it should show this merge conflict as fixed

sheerlox · 2024-12-18T15:22:56Z

Excellent work @JosephVoid, thank you for taking on this feature request! Thanks @intcreator also for taking over the review 😄

sheerlox · 2024-12-18T18:06:58Z

Looks like the tests aren't passing, if someone wants to look into it so we can merge!

ncb000gt · 2025-01-09T07:31:49Z

🎉 This PR is included in version 3.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

## [3.4.0](v3.3.2...v3.4.0) (2025-01-09) ### ✨ Features * error handling on ticks ([#861](#861)) ([0d3161f](0d3161f)), closes [#426](#426) ### 📚 Documentation * **contributing:** add "Submitting a Pull Request" & "Coding Rules" sections ([#936](#936)) ([ddd8988](ddd8988)) ### ♻️ Chores * **deps:** lock file maintenance ([494b4bf](494b4bf)) * **deps:** update dependency [@types](https://github.com/types)/node to v20.17.11 ([2978e92](2978e92)) * **deps:** update dependency lint-staged to v15.3.0 ([11f9bad](11f9bad)) * **deps:** update semantic-release related packages ([b830bdb](b830bdb)) * **deps:** update tests (major) ([#826](#826)) ([e47fd5a](e47fd5a))

JosephVoid added 3 commits March 3, 2024 07:07

feat: add error handling

616bb08

+ added error handling function param on a new constructor + added the function param on the static `from` method + caught the errors in the callback method

feat: added errorHandler function in CronJobParams

8a24489

test: added two more test cases

255ce7f

+ removed `@ts-expect-error line` bc it was throwing error itself

JosephVoid changed the title ~~feat: error handling on job.start()~~ feat(error-handle): error handling on job.start() Mar 3, 2024

JosephVoid changed the title ~~feat(error-handle): error handling on job.start()~~ feat: error handling on job.start() Mar 3, 2024

JosephVoid added 3 commits March 3, 2024 12:41

docs: added API description

4417117

fix: types

1870cdd

test: improve tests

5076e99

JosephVoid marked this pull request as ready for review March 3, 2024 09:45

sheerlox requested changes Mar 7, 2024

View reviewed changes

src/types/cron.types.ts Outdated Show resolved Hide resolved

tests/cron.test.ts Show resolved Hide resolved

src/job.ts Show resolved Hide resolved

src/job.ts Outdated Show resolved Hide resolved

src/job.ts Outdated Show resolved Hide resolved

JosephVoid added 3 commits March 8, 2024 07:06

fix: applied fix based on suggestions

9b2cc1b

+ Instead of a new constructor, I added the `errorHandler` on every other constructor + removed the superflous if checks + added `errorHandler` on every `return new CronJob`

fix: moved error handler to BaseCronJobParams

98be5fe

fix: put back the run time exception check

7ae4cca

test: check errorHandler is called with the exception + fix case typo

f13aba2

sheerlox previously approved these changes Mar 8, 2024

View reviewed changes

sheerlox requested a review from intcreator March 8, 2024 09:13

sheerlox force-pushed the feature/error-handling branch from b3902a9 to f13aba2 Compare March 8, 2024 09:19

sheerlox changed the title ~~feat: error handling on job.start()~~ feat: error handling on ticks Mar 8, 2024

Merge branch 'main' into feature/error-handling

1d1b9f7

intcreator dismissed sheerlox’s stale review via 1d1b9f7 December 16, 2024 21:12

intcreator added 2 commits December 16, 2024 13:17

restore table of contents

e2662ca

spaaaaaaaaaaaaaaaaaaaaaace

afc3cf6

intcreator previously approved these changes Dec 17, 2024

View reviewed changes

sheerlox previously approved these changes Dec 18, 2024

View reviewed changes

Merge branch 'main' into feature/error-handling

3ad88e5

intcreator added 2 commits January 8, 2025 21:39

Merge branch 'main' into feature/error-handling

5126162

Merge branch 'main' into feature/error-handling

2891f16

intcreator mentioned this pull request Jan 9, 2025

Draft: Feature/error handling (#940) #941

Closed

update test to expect a console error since that's what happens

21cb4a6

intcreator dismissed stale reviews from sheerlox and themself via 21cb4a6 January 9, 2025 07:20

intcreator merged commit 0d3161f into kelektiv:main Jan 9, 2025

ncb000gt added the released label Jan 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: error handling on ticks#861

feat: error handling on ticks#861
intcreator merged 17 commits intokelektiv:mainfrom
JosephVoid:feature/error-handling

JosephVoid commented Mar 3, 2024 •

edited by sheerlox

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JosephVoid commented Mar 8, 2024

Uh oh!

sheerlox left a comment

Uh oh!

MetlHedd commented Nov 27, 2024

Uh oh!

intcreator commented Dec 11, 2024

Uh oh!

intcreator commented Dec 14, 2024 •

edited

Loading

Uh oh!

intcreator commented Dec 14, 2024

Uh oh!

sheerlox commented Dec 18, 2024

Uh oh!

sheerlox commented Dec 18, 2024

Uh oh!

ncb000gt commented Jan 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

JosephVoid commented Mar 3, 2024 • edited by sheerlox Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JosephVoid commented Mar 8, 2024

Uh oh!

sheerlox left a comment

Choose a reason for hiding this comment

Uh oh!

MetlHedd commented Nov 27, 2024

Uh oh!

intcreator commented Dec 11, 2024

Uh oh!

intcreator commented Dec 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

intcreator commented Dec 14, 2024

Uh oh!

sheerlox commented Dec 18, 2024

Uh oh!

sheerlox commented Dec 18, 2024

Uh oh!

ncb000gt commented Jan 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

JosephVoid commented Mar 3, 2024 •

edited by sheerlox

Loading

intcreator commented Dec 14, 2024 •

edited

Loading