Add best practices documentation for workflow development#724
Open
mcruzdev wants to merge 3 commits into
Open
Conversation
Covers four common pitfalls: using @transactional for persistence instead of manual QuarkusTransaction, referencing secrets via handles instead of hard-coding credentials, naming tasks explicitly for observability, and separating business retries (tryCatch with retry) from infrastructure retries (Fault Tolerance config properties).
Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com>
|
🚀 PR Preview babc866 has been successfully built and deployed to https://quarkiverse-flow-pr-724-preview.surge.sh
|
| return workflow("notify") | ||
| .use(u -> u.secrets("mySecrets")) | ||
| .tasks( | ||
| // NEVER hard-code tokens in the workflow definition |
Member
There was a problem hiding this comment.
The token is not hard-coded in this example. 🤔
| .delay("PT1H")) | ||
| .doTasks(tasks( | ||
| function("notifyRejection", approvalService::notifyRejection, VacationRequest.class)))))) | ||
| .build(); |
Member
There was a problem hiding this comment.
Have you tested this code? If not, it's a great way to deliver a simple example.
Member
Author
There was a problem hiding this comment.
| "tryApproval", | ||
| t -> t.tryCatch(tasks( | ||
| function("submitRequest", approvalService::submit, VacationRequest.class), | ||
| function("checkApproval", approvalService::requireApproval, VacationRequest.class))) |
Member
There was a problem hiding this comment.
I think the VacationRequest.class parameter is unnecessary.
…deable files Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com>
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.
Description
Covers four common pitfalls: using
@Transactionalfor persistence instead of manual QuarkusTransaction, referencing secrets via handles instead of hard-coding credentials, naming tasks explicitly for observability, and separating business retries (tryCatch with retry) from infrastructure retries (Fault Tolerance config properties).Fixes #723
Testing
Test Plan
Manual Testing
Checklist
Before submitting this PR, please ensure:
./mvnw clean install -DskipITs=falseAdditional Notes