feat: support async handling and add CronJob status tracking #894
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Improve async handling and add status tracking This commit introduces the following changes: 1. Change the `fireOnTick()` method to return a `Promise` to handle asynchronous callbacks more effectively. 2. Add a new `isRunning` property to track the running state of the `CronJob` instance. 3. Update the test suite to use the new asynchronous behavior and track the running state of the job. These changes ensure that the `CronJob` class can properly handle asynchronous callbacks, and provide a way to track the running state of the job, which can be useful for various use cases.
…outs # Short Description The changes in this commit remove repeated `callback` variables from the cron tests and adjust the test timeouts to use the `tickAsync` method instead of `tick`. ## Detailed Changes 1. Removed repeated `callback` variables from several test cases. 2. Adjusted the test timeouts to use the `tickAsync` method instead of `tick` to ensure the tests properly wait for the asynchronous operations to complete. 3. Removed the `done` callback from the test cases and instead used the `async` function syntax to handle the asynchronous nature of the tests. ## Motivation These changes improve the readability and maintainability of the cron tests by removing unnecessary variables and ensuring the tests properly handle the asynchronous nature of the CronJob functionality.
This commit introduces a new test case to ensure that the `CronJob` class waits for the running callback to complete before stopping the job. The changes include: - Adding a new test case `should wait for running callback to complete before stopping` that simulates a long-running callback and verifies that the job is not stopped until the callback has finished executing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR improves async handling in the CronJob class and adds status tracking functionality.
fireOnTick()method to return a Promise for better async callback handlingisRunningflag to track the running state of CronJob instanceswaitForCompletionfunctionality to thejob.stop()methodonCompletecallbackDuring test case writing, I encountered a type error with sinon.
To resolve this, added
sinon.restore()to theafterEachblock.Reference: https://stackoverflow.com/questions/73232999/sinon-cant-install-fake-timers-twice-on-the-same-global-object
Related Issue
Closes #713
Closes #556
Motivation and Context
These changes allow the CronJob class to handle asynchronous callbacks more effectively and provide a way to track the running state of jobs.
How Has This Been Tested?
tickAsyncmethodTypes of changes
Checklist:
!after the type/scope in the title (see the Conventional Commits standard).