KOJO-217 | Start of Usage Patterns guide #118
Open
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
alexberryman
reviewed
Mar 2, 2021
| --- | --- | --- | ||
| can_work_in_parallel | | | ||
| cron_expression | | | ||
| schedule_limit | | |
There was a problem hiding this comment.
I like the idea of expressing this as a quick reference table. If we transpose the rows we can add all the patterns so they can be viewed side-by-side to compare them easier:
| pattern | can_work_in_parallel | cron_expression | schedule_limit |
|---|---|---|---|
| static schedule | false | 0 0 * * * | 1 |
| continuous singleton | false | * * * * * | 1 |
| delagated linear clone | true | * * * * * | 10 |
| dynamically scheduled | true | null | null |
|
|
||
| ### Continuous Singleton | ||
|
|
||
| This pattern is for situations where you need to do some work continuously, and having a single process is sufficient compute for keeping up with the work (e.g. polling something for changes and then processing those changes). |
There was a problem hiding this comment.
It might be useful to include a visual diagram of each pattern something like
Made this with https://plantuml.com/activity-diagram-beta and put linked it as an image via https://github.com/Zingam/UML-in-Markdown
|
|
||
| #### Kojo Runtime API Interactions | ||
|
|
||
| None. |
There was a problem hiding this comment.
What would go in here normally?
- happy path:
->requestCompleteSuccess()->applyRequest() - error path:
->requestCompleteFailed()->applyRequest() - DLC Patten
->schduleNewJob($job)?
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.
I went back on forth on how best to present this stuff, let me know which parts you like and what you dislike, and I'll do it for other example patterns