feat: Add compensation workflow pattern to Spring Boot examples#1696
feat: Add compensation workflow pattern to Spring Boot examples#1696siri-varma wants to merge 2 commits intodapr:masterfrom
Conversation
Port the BookTrip compensation (Saga) workflow from the plain Java examples into the Spring Boot workflow patterns module, adding @Component-annotated activities and a /wfp/compensation REST endpoint. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Siri Varma Vegiraju <svegiraju@Siris-MacBook-Pro.local>
There was a problem hiding this comment.
Pull request overview
Adds a Spring Boot “compensation / Saga” workflow pattern example (BookTrip) to the workflows/patterns module, along with a REST endpoint to trigger it.
Changes:
- Introduces
BookTripWorkflowimplementing a simple saga with compensating activities. - Adds booking and cancellation workflow activities as Spring components.
- Exposes a new
POST /wfp/compensationendpoint to run the workflow and return its output.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| spring-boot-examples/workflows/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/CancelHotelActivity.java | Adds hotel-cancellation activity for compensation flow |
| spring-boot-examples/workflows/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/CancelFlightActivity.java | Adds flight-cancellation activity for compensation flow |
| spring-boot-examples/workflows/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/CancelCarActivity.java | Adds car-cancellation activity for compensation flow |
| spring-boot-examples/workflows/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/BookTripWorkflow.java | Implements saga-style orchestration with compensation retries |
| spring-boot-examples/workflows/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/BookHotelActivity.java | Adds hotel booking activity used by the workflow |
| spring-boot-examples/workflows/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/BookFlightActivity.java | Adds flight booking activity used by the workflow |
| spring-boot-examples/workflows/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/BookCarActivity.java | Adds car booking activity that intentionally fails to trigger compensation |
| spring-boot-examples/workflows/patterns/src/main/java/io/dapr/springboot/examples/wfp/WorkflowPatternsRestController.java | Adds POST /wfp/compensation endpoint to run the new workflow |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
...s/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/BookHotelActivity.java
Show resolved
Hide resolved
...ows/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/BookCarActivity.java
Show resolved
Hide resolved
...atterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/CancelFlightActivity.java
Show resolved
Hide resolved
...patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/CancelHotelActivity.java
Show resolved
Hide resolved
...ws/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/BookTripWorkflow.java
Show resolved
Hide resolved
...ws/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/BookTripWorkflow.java
Show resolved
Hide resolved
...s/patterns/src/main/java/io/dapr/springboot/examples/wfp/WorkflowPatternsRestController.java
Show resolved
Hide resolved
.../patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/BookFlightActivity.java
Show resolved
Hide resolved
...s/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/CancelCarActivity.java
Show resolved
Hide resolved
...ws/patterns/src/main/java/io/dapr/springboot/examples/wfp/compensation/BookTripWorkflow.java
Show resolved
Hide resolved
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1696 +/- ##
=========================================
Coverage 79.53% 79.53%
Complexity 2193 2193
=========================================
Files 237 237
Lines 6577 6577
Branches 730 730
=========================================
Hits 5231 5231
Misses 990 990
Partials 356 356 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@siri-varma I am a bit against this way of doing compensations, that's why I've created this example: https://github.com/diagrid-labs/workflow-patterns-spring-boot?tab=readme-ov-file#compensate-on-error-example I think that having an arraylist inside the workflow itself is a hack and should be avoided. Check this specifically: https://github.com/diagrid-labs/workflow-patterns-spring-boot/blob/main/workflows/src/main/java/io/dapr/springboot/workflows/compensateonerror/CompensateWhenErrorWorkflow.java#L40 Check the example and let me know if you have any questions, I would rather have an example following that approach in the SDK than a port from other languages. |
salaboy
left a comment
There was a problem hiding this comment.
Check my comment in the PR
Port the BookTrip compensation (Saga) workflow from the plain Java examples into the Spring Boot workflow patterns module, adding @Component-annotated activities and a /wfp/compensation REST endpoint.
Description
Please explain the changes you've made
Issue reference
We strive to have all PR being opened based on an issue, where the problem or feature have been discussed prior to implementation.
Please reference the issue this PR will close: #1395
#1395
Checklist
Please make sure you've completed the relevant tasks for this PR, out of the following list: