Accept a job struct as the argument to perform/1#32
Merged
Conversation
|
Looks great and I think the documentation is clear. I agree that this is a good first step. |
The `perform/1` function now receives an `Oban.Job` struct as the sole argument, calling `perform/1` again with only the `args` map if no clause catches the struct. This allows workers to use any attribute of the job to customize behaviour, e.g. the number of attempts or when a job was inserted into the database. The implementation is entirely backward compatible, provided workers are defined with the `use` macro. Workers that implement the `Oban.Worker` behaviour manually will need to change the signature of `perform/1` to accept a job struct.
sorentwo
force-pushed
the
feature/perform-job-struct
branch
from
7de2b21 to
a01840b
Compare
Member
Author
|
@andykent Thanks for taking a look 💛 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The
perform/1function now receives anOban.Jobstruct as the sole argument, callingperform/1again with only theargsmap if no clause catches the struct. This allows workers to use any attribute of the job to customize behaviour, e.g. the number of attempts or when a job was inserted into the database.The implementation is entirely backward compatible, provided workers are defined with the
usemacro. Workers that implement theOban.Workerbehaviour manually will need to change the signature ofperform/1to accept a job struct.Addresses the first part of #27
I'm opening this as a PR to get some feedback on the implementation and documentation.
/cc @andykent