Compensation example for Workflows #1333

cicoyle · 2025-05-05T15:43:54Z

Add a compensation workflow example

Signed-off-by: Cassandra Coyle <[email protected]>

salaboy · 2025-05-07T13:42:24Z

@cicoyle I was looking at this PR. The example doesn't seem to show that compensations are executed, right? Was this already implemented in dotnet? Do we have any reference of how it was implemented in dotnet? Did you used that implementation as inspiration for this PR?

Signed-off-by: Cassandra Coyle <[email protected]>

cicoyle · 2025-05-19T19:55:02Z

@cicoyle I was looking at this PR. The example doesn't seem to show that compensations are executed, right? Was this already implemented in dotnet? Do we have any reference of how it was implemented in dotnet? Did you used that implementation as inspiration for this PR?

This is a new pattern entirely. There are no examples in any other sdk or in the dapr docs. Its a simple example to illustrate how users can use the compensation workflow pattern.

Signed-off-by: Cassandra Coyle <[email protected]>

examples/src/main/java/io/dapr/examples/workflows/README.md

siri-varma

Overall LGTM.

I think most of the files are missing a new line. If we could add that, the PR is good to go.

examples/src/main/java/io/dapr/examples/workflows/compensation/BookTripWorkflow.java

Signed-off-by: artur-ciocanu <[email protected]>

artur-ciocanu

@cicoyle awesome job! I love the docs related to Mechanical Markdown.

My only concern is the comment from @javier-aliaga regarding retries. Either we mention this is the code comment or add some note, so developers are aware how handling the exception might affect the retry behavior.

Signed-off-by: Cassandra Coyle <[email protected]>

cicoyle · 2025-05-29T16:04:49Z

Will circle back to the build failures

Signed-off-by: Cassandra Coyle <[email protected]>

salaboy

not 100% sure about this but here is the label

Signed-off-by: Cassandra Coyle <[email protected]>

artur-ciocanu

LGTM

codecov · 2025-05-29T19:56:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.13%. Comparing base (d759c53) to head (13a0891).
Report is 161 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #1333      +/-   ##
============================================
+ Coverage     76.91%   78.13%   +1.22%     
- Complexity     1592     1830     +238     
============================================
  Files           145      223      +78     
  Lines          4843     5663     +820     
  Branches        562      601      +39     
============================================
+ Hits           3725     4425     +700     
- Misses          821      917      +96     
- Partials        297      321      +24

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

* add basic compensation example for wf Signed-off-by: Cassandra Coyle <[email protected]> * update commands to run + wf id Signed-off-by: Cassandra Coyle <[email protected]> * update readme + add mechanical markdown Signed-off-by: Cassandra Coyle <[email protected]> * fix import Signed-off-by: Cassandra Coyle <[email protected]> * fix mechanical markdown + add how to test it locally Signed-off-by: Cassandra Coyle <[email protected]> * move compensation example readme to workflows readme Signed-off-by: Cassandra Coyle <[email protected]> * Update BookCarActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookFlightActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookHotelActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripClient.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripWorker.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripWorkflow.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelCarActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelFlightActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelHotelActivity.java Signed-off-by: artur-ciocanu <[email protected]> * add retry IT tests and catch TaskFailedException Signed-off-by: Cassandra Coyle <[email protected]> * add test for no compensation if successful and assert attempts Signed-off-by: Cassandra Coyle <[email protected]> * update mechanical markdown Signed-off-by: Cassandra Coyle <[email protected]> * add back pubsub... but this should be removed long term Signed-off-by: Cassandra Coyle <[email protected]> * try adding waitforsidecar Signed-off-by: Cassandra Coyle <[email protected]> * rm tests from examples pr Signed-off-by: Cassandra Coyle <[email protected]> * reset unintended changes Signed-off-by: Cassandra Coyle <[email protected]> --------- Signed-off-by: Cassandra Coyle <[email protected]> Signed-off-by: artur-ciocanu <[email protected]> Co-authored-by: artur-ciocanu <[email protected]>

* Compensation example for Workflows (#1333) * add basic compensation example for wf Signed-off-by: Cassandra Coyle <[email protected]> * update commands to run + wf id Signed-off-by: Cassandra Coyle <[email protected]> * update readme + add mechanical markdown Signed-off-by: Cassandra Coyle <[email protected]> * fix import Signed-off-by: Cassandra Coyle <[email protected]> * fix mechanical markdown + add how to test it locally Signed-off-by: Cassandra Coyle <[email protected]> * move compensation example readme to workflows readme Signed-off-by: Cassandra Coyle <[email protected]> * Update BookCarActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookFlightActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookHotelActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripClient.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripWorker.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripWorkflow.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelCarActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelFlightActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelHotelActivity.java Signed-off-by: artur-ciocanu <[email protected]> * add retry IT tests and catch TaskFailedException Signed-off-by: Cassandra Coyle <[email protected]> * add test for no compensation if successful and assert attempts Signed-off-by: Cassandra Coyle <[email protected]> * update mechanical markdown Signed-off-by: Cassandra Coyle <[email protected]> * add back pubsub... but this should be removed long term Signed-off-by: Cassandra Coyle <[email protected]> * try adding waitforsidecar Signed-off-by: Cassandra Coyle <[email protected]> * rm tests from examples pr Signed-off-by: Cassandra Coyle <[email protected]> * reset unintended changes Signed-off-by: Cassandra Coyle <[email protected]> --------- Signed-off-by: Cassandra Coyle <[email protected]> Signed-off-by: artur-ciocanu <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> * Adding Support for Suspend / Resume Workflows (#1405) * adding IT test Signed-off-by: salaboy <[email protected]> * adding initial version of suspend/resume example Signed-off-by: salaboy <[email protected]> * updating README Signed-off-by: salaboy <[email protected]> * Update README.md Signed-off-by: salaboy <[email protected]> * following Javi's suggestion Signed-off-by: salaboy <[email protected]> * fixing wrong year in headers Signed-off-by: salaboy <[email protected]> * fixing paths in one more README.md file Signed-off-by: salaboy <[email protected]> * adding output validation Signed-off-by: salaboy <[email protected]> * adding missing port Signed-off-by: salaboy <[email protected]> * fixing check conditions Signed-off-by: salaboy <[email protected]> --------- Signed-off-by: salaboy <[email protected]> Co-authored-by: Cassie Coyle <[email protected]> --------- Signed-off-by: Cassandra Coyle <[email protected]> Signed-off-by: artur-ciocanu <[email protected]> Signed-off-by: salaboy <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Co-authored-by: salaboy <[email protected]>

* add basic compensation example for wf Signed-off-by: Cassandra Coyle <[email protected]> * update commands to run + wf id Signed-off-by: Cassandra Coyle <[email protected]> * update readme + add mechanical markdown Signed-off-by: Cassandra Coyle <[email protected]> * fix import Signed-off-by: Cassandra Coyle <[email protected]> * fix mechanical markdown + add how to test it locally Signed-off-by: Cassandra Coyle <[email protected]> * move compensation example readme to workflows readme Signed-off-by: Cassandra Coyle <[email protected]> * Update BookCarActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookFlightActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookHotelActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripClient.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripWorker.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripWorkflow.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelCarActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelFlightActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelHotelActivity.java Signed-off-by: artur-ciocanu <[email protected]> * add retry IT tests and catch TaskFailedException Signed-off-by: Cassandra Coyle <[email protected]> * add test for no compensation if successful and assert attempts Signed-off-by: Cassandra Coyle <[email protected]> * update mechanical markdown Signed-off-by: Cassandra Coyle <[email protected]> * add back pubsub... but this should be removed long term Signed-off-by: Cassandra Coyle <[email protected]> * try adding waitforsidecar Signed-off-by: Cassandra Coyle <[email protected]> * rm tests from examples pr Signed-off-by: Cassandra Coyle <[email protected]> * reset unintended changes Signed-off-by: Cassandra Coyle <[email protected]> --------- Signed-off-by: Cassandra Coyle <[email protected]> Signed-off-by: artur-ciocanu <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Signed-off-by: sirivarma <[email protected]>

* Compensation example for Workflows (dapr#1333) * add basic compensation example for wf Signed-off-by: Cassandra Coyle <[email protected]> * update commands to run + wf id Signed-off-by: Cassandra Coyle <[email protected]> * update readme + add mechanical markdown Signed-off-by: Cassandra Coyle <[email protected]> * fix import Signed-off-by: Cassandra Coyle <[email protected]> * fix mechanical markdown + add how to test it locally Signed-off-by: Cassandra Coyle <[email protected]> * move compensation example readme to workflows readme Signed-off-by: Cassandra Coyle <[email protected]> * Update BookCarActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookFlightActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookHotelActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripClient.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripWorker.java Signed-off-by: artur-ciocanu <[email protected]> * Update BookTripWorkflow.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelCarActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelFlightActivity.java Signed-off-by: artur-ciocanu <[email protected]> * Update CancelHotelActivity.java Signed-off-by: artur-ciocanu <[email protected]> * add retry IT tests and catch TaskFailedException Signed-off-by: Cassandra Coyle <[email protected]> * add test for no compensation if successful and assert attempts Signed-off-by: Cassandra Coyle <[email protected]> * update mechanical markdown Signed-off-by: Cassandra Coyle <[email protected]> * add back pubsub... but this should be removed long term Signed-off-by: Cassandra Coyle <[email protected]> * try adding waitforsidecar Signed-off-by: Cassandra Coyle <[email protected]> * rm tests from examples pr Signed-off-by: Cassandra Coyle <[email protected]> * reset unintended changes Signed-off-by: Cassandra Coyle <[email protected]> --------- Signed-off-by: Cassandra Coyle <[email protected]> Signed-off-by: artur-ciocanu <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> * Adding Support for Suspend / Resume Workflows (dapr#1405) * adding IT test Signed-off-by: salaboy <[email protected]> * adding initial version of suspend/resume example Signed-off-by: salaboy <[email protected]> * updating README Signed-off-by: salaboy <[email protected]> * Update README.md Signed-off-by: salaboy <[email protected]> * following Javi's suggestion Signed-off-by: salaboy <[email protected]> * fixing wrong year in headers Signed-off-by: salaboy <[email protected]> * fixing paths in one more README.md file Signed-off-by: salaboy <[email protected]> * adding output validation Signed-off-by: salaboy <[email protected]> * adding missing port Signed-off-by: salaboy <[email protected]> * fixing check conditions Signed-off-by: salaboy <[email protected]> --------- Signed-off-by: salaboy <[email protected]> Co-authored-by: Cassie Coyle <[email protected]> --------- Signed-off-by: Cassandra Coyle <[email protected]> Signed-off-by: artur-ciocanu <[email protected]> Signed-off-by: salaboy <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Co-authored-by: salaboy <[email protected]> Signed-off-by: siri-varma <[email protected]>

add basic compensation example for wf

de243ff

Signed-off-by: Cassandra Coyle <[email protected]>

update commands to run + wf id

1d74fbc

Signed-off-by: Cassandra Coyle <[email protected]>

cicoyle and others added 6 commits May 19, 2025 16:40

update readme + add mechanical markdown

312c99c

Signed-off-by: Cassandra Coyle <[email protected]>

Merge branch 'master' into feat-wf-compensating-activities

8f648b2

fix import

417a0af

Signed-off-by: Cassandra Coyle <[email protected]>

fix mechanical markdown + add how to test it locally

3f8cab0

Signed-off-by: Cassandra Coyle <[email protected]>

move compensation example readme to workflows readme

457dd76

Signed-off-by: Cassandra Coyle <[email protected]>

Merge branch 'master' into feat-wf-compensating-activities

7fbc50e

cicoyle marked this pull request as ready for review May 21, 2025 14:48

cicoyle requested review from a team as code owners May 21, 2025 14:48

siri-varma reviewed May 21, 2025

View reviewed changes

examples/src/main/java/io/dapr/examples/workflows/README.md Outdated Show resolved Hide resolved

siri-varma approved these changes May 21, 2025

View reviewed changes

javier-aliaga reviewed May 22, 2025

View reviewed changes

examples/src/main/java/io/dapr/examples/workflows/compensation/BookTripWorkflow.java Outdated Show resolved Hide resolved

artur-ciocanu added 9 commits May 22, 2025 18:11

Update BookCarActivity.java

b5829bf

Signed-off-by: artur-ciocanu <[email protected]>

Update BookFlightActivity.java

94ed1a9

Signed-off-by: artur-ciocanu <[email protected]>

Update BookHotelActivity.java

5eba626

Signed-off-by: artur-ciocanu <[email protected]>

Update BookTripClient.java

5f227ad

Signed-off-by: artur-ciocanu <[email protected]>

Update BookTripWorker.java

2e4448b

Signed-off-by: artur-ciocanu <[email protected]>

Update BookTripWorkflow.java

4beb458

Signed-off-by: artur-ciocanu <[email protected]>

Update CancelCarActivity.java

e272c14

Signed-off-by: artur-ciocanu <[email protected]>

Update CancelFlightActivity.java

cd80b1a

Signed-off-by: artur-ciocanu <[email protected]>

Update CancelHotelActivity.java

5dbf3dc

Signed-off-by: artur-ciocanu <[email protected]>

artur-ciocanu previously approved these changes May 22, 2025

View reviewed changes

artur-ciocanu and others added 4 commits May 22, 2025 18:30

Merge branch 'master' into feat-wf-compensating-activities

828f5eb

Merge branch 'master' into feat-wf-compensating-activities

c6b507f

Merge branch 'master' into feat-wf-compensating-activities

2b0c5a0

Merge branch 'master' into feat-wf-compensating-activities

7ecf00e

add retry IT tests and catch TaskFailedException

732d4f3

Signed-off-by: Cassandra Coyle <[email protected]>

cicoyle dismissed artur-ciocanu’s stale review via 732d4f3 May 29, 2025 14:53

add test for no compensation if successful and assert attempts

8a27e79

Signed-off-by: Cassandra Coyle <[email protected]>

cicoyle removed the do-not-merge label May 29, 2025

cicoyle and others added 3 commits May 29, 2025 10:10

update mechanical markdown

8fc18f9

Signed-off-by: Cassandra Coyle <[email protected]>

Merge branch 'master' into feat-wf-compensating-activities

063e9ea

Merge branch 'master' into feat-wf-compensating-activities

958de58

cicoyle requested review from javier-aliaga and artur-ciocanu May 29, 2025 15:30

add back pubsub... but this should be removed long term

2528a21

Signed-off-by: Cassandra Coyle <[email protected]>

cicoyle mentioned this pull request May 29, 2025

SpringBoot Example: Compensation Workflow #1395

Open

salaboy requested review from salaboy and removed request for javier-aliaga May 29, 2025 16:57

salaboy previously approved these changes May 29, 2025

View reviewed changes

try adding waitforsidecar

da76513

Signed-off-by: Cassandra Coyle <[email protected]>

cicoyle dismissed salaboy’s stale review via da76513 May 29, 2025 17:58

cicoyle added 2 commits May 29, 2025 13:35

rm tests from examples pr

e9455ac

Signed-off-by: Cassandra Coyle <[email protected]>

reset unintended changes

13a0891

Signed-off-by: Cassandra Coyle <[email protected]>

artur-ciocanu approved these changes May 29, 2025

View reviewed changes

artur-ciocanu added the auto-merge label May 29, 2025

cicoyle merged commit 114e354 into dapr:master May 29, 2025
9 of 10 checks passed

cicoyle mentioned this pull request May 29, 2025

Compensating Workflows Pattern dapr/docs#4665

Open

cicoyle mentioned this pull request Jun 11, 2025

[1.15] Cherrypick Compensation PR + Suspend/Resume PR #1415

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Compensation example for Workflows #1333

Compensation example for Workflows #1333

Uh oh!

cicoyle commented May 5, 2025 •

edited

Loading

Uh oh!

salaboy commented May 7, 2025

Uh oh!

cicoyle commented May 19, 2025

Uh oh!

Uh oh!

siri-varma left a comment

Uh oh!

Uh oh!

artur-ciocanu left a comment

Uh oh!

cicoyle commented May 29, 2025

Uh oh!

salaboy left a comment

Uh oh!

artur-ciocanu left a comment

Uh oh!

Uh oh!

codecov bot commented May 29, 2025

Uh oh!

Uh oh!

Compensation example for Workflows #1333

Compensation example for Workflows #1333

Uh oh!

Conversation

cicoyle commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

salaboy commented May 7, 2025

Uh oh!

cicoyle commented May 19, 2025

Uh oh!

Uh oh!

siri-varma left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

artur-ciocanu left a comment

Choose a reason for hiding this comment

Uh oh!

cicoyle commented May 29, 2025

Uh oh!

salaboy left a comment

Choose a reason for hiding this comment

Uh oh!

artur-ciocanu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented May 29, 2025

Codecov Report

Uh oh!

Uh oh!

cicoyle commented May 5, 2025 •

edited

Loading