Add top level disable and enable #1109
Merged
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
* Similar to the mapping between `job.remove` and `agenda.cancel`, these methods alter the `disabled` property for all jobs matching the supplied query * Tests covering the new logic have been added to `/test/agenda.js`
koresar
requested changes
Oct 12, 2020
lib/agenda/enable.js
Outdated
| const debug = require('debug')('agenda:enable'); | ||
|
|
||
| /** | ||
| * Enables any jobs matching the passed MongoDB query, and removes them from the database. |
There was a problem hiding this comment.
"and removes them from the database" ?
I don't see that happening in the code. :) Perhaps, the comment needs an update?
lib/agenda/enable.js
Outdated
| * @name Agenda#enable | ||
| * @function | ||
| * @param {Object} query MongoDB query to use when enabling | ||
| * @caller client code, Agenda.purge(), Job.remove() |
There was a problem hiding this comment.
Is this comment correct? I don't see that in the PR changes.
|
@koresar Thanks for the feedback and callouts on the comments/docs. I've updated my code with the upstream master and migrated my code to Typescript. Only remaining task is the HTML docs, which I believe are handled as a part of the release process via the |
koresar
approved these changes
Aug 4, 2021
|
Quality PR! Thanks for that. |
|
Published in v4.2.0. |
4 tasks
pdfowler
added a commit
to pdfowler/agenda
that referenced
this pull request
May 24, 2023
* this code has been migrated over from agenda#1109 * migrates old methods from individual files to the top level Agenda Class * test suite updated with original test suite content from original fork
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.
Use Case
We have a job which sends out invites in a staged manner over a period of time: "sendInvites". Once enough people have responded to the invite, we don't want to send out any more invites. If someone later cancels, we want to continue sending out invites in a tiered manner.
Workaround
The same effect can be accomplished by querying any outstanding "sendInvites" jobs, and iterating over them and calling
job.disable(), and doing the same thing to enable withjob.enable().Alternatively the
this._collection.updateManybased implementation can be patched to a local instance via prototype injection.Proposed Implementation
Following the example of
agenda.cancel()and its relationship withjob.remove(), this PR adds the following two methods:PR Checks: