Add support for workflow history propagation by siri-varma · Pull Request #1739 · dapr/java-sdk

siri-varma · 2026-05-06T15:02:48Z

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: #[issue number]

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

Code compiles correctly
Created/updated tests
Extended the documentation

javier-aliaga · 2026-05-12T15:20:36Z

@siri-varma this PR #1738 will fix the CI and also uses the 1.18.0 rc version. I think you need it to test this PR

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com> Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com> Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

siri-varma · 2026-05-18T16:09:20Z

@javier-aliaga @dapr/maintainers-java-sdk Ready for reviews

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com>

Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

Copilot

Pull request overview

Copilot reviewed 36 out of 36 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (1)

durabletask-client/src/main/java/io/dapr/durabletask/PropagatedHistoryChunk.java:52

This implementation only exposes parsed HistoryEvent objects via getEvents(). If downstream consumers are expected to perform chain-of-custody/signature verification on the original signed bytes (as implied by the Javadoc), there is no way to access the raw event bytes after parsing. Consider either exposing the raw event payloads on PropagatedHistoryChunk (e.g., as List<ByteString>/byte[]) or adjusting the documentation to remove the verification claim.

  static PropagatedHistoryChunk fromProto(HistoryEvents.PropagatedHistoryChunk proto) {
    List<HistoryEvents.HistoryEvent> parsed = new ArrayList<>(proto.getRawEventsCount());
    for (int i = 0; i < proto.getRawEventsCount(); i++) {
      try {
        parsed.add(HistoryEvents.HistoryEvent.parseFrom(proto.getRawEvents(i)));
      } catch (InvalidProtocolBufferException e) {
        throw new IllegalArgumentException(
            "Failed to parse raw event " + i + " in chunk for app " + proto.getAppId(), e);
      }

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com>

javier-aliaga · 2026-05-19T14:56:31Z

+    PropagatedHistory parsed = propagatedHistory != null
+        ? PropagatedHistory.fromProto(propagatedHistory) : null;
+    ContextImplTask context = new ContextImplTask(pastEvents, newEvents, parsed);


Should we movePropagatedHistory.fromProto into the try/catch block so we can fail the context in case of exception?

codecov · 2026-05-19T14:57:58Z

Codecov Report

❌ Patch coverage is 94.11765% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 76.78%. Comparing base (89708ae) to head (5eb5664).

Files with missing lines	Patch %	Lines
...kflows/runtime/DefaultWorkflowActivityContext.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##             master    #1739   +/-   ##
=========================================
  Coverage     76.77%   76.78%           
- Complexity     2259     2266    +7     
=========================================
  Files           241      241           
  Lines          7066     7076   +10     
  Branches        740      740           
=========================================
+ Hits           5425     5433    +8     
- Misses         1277     1280    +3     
+ Partials        364      363    -1

☔ 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.

javier-aliaga · 2026-05-19T15:06:22Z

    }

+    PropagatedHistory parsed = propagatedHistory != null
+        ? PropagatedHistory.fromProto(propagatedHistory) : null;


Can we have a custom exception here so it is clear that the propagated history is broken?

cicoyle

This is a great start 🎉 few things from me for parity and user experience

cicoyle · 2026-05-19T16:52:51Z

+      PropagatedHistory history = historyOpt.get();
+      logger.info("App2 received history (scope={}, chunks={}, apps={})",
+          history.getScope(), history.getWorkflows().size(), history.getAppIDs());
+      for (PropagatedHistoryChunk chunk : history.getWorkflows()) {


I was thinking for chunks to not be user facing. They shouldn't need to know about the internal chunking mechanism. Can we rename this to WorkflowResult or similar and have a wrapper?
From there the following is exposed for end user consumption:

cicoyle · 2026-05-19T16:57:12Z

+          history.getScope(), history.getWorkflows().size(), history.getAppIDs());
+      for (PropagatedHistoryChunk chunk : history.getWorkflows()) {
+        logger.info("  chunk: app={} workflow={} instance={} events={}",
+            chunk.getAppId(), chunk.getWorkflowName(), chunk.getInstanceId(),


Can we add getActivityByName and getActivitiesByName? The goal was to use the chunks under the hood and expose this functionality using the history chunks. For ex, in the go-sdk we have:

... merchantWf, err := history.GetWorkflowByName("MerchantCheckout") card, err := processPaymentWf.GetActivityByName("ValidateCard") ...

Where a user can directly see the status of it with these exposed/user facing fields:

type ActivityResult struct { Name string Started bool Completed bool Failed bool Input *wrapperspb.StringValue Output *wrapperspb.StringValue Error *protos.TaskFailureDetails }

ActivityResult holds the status and data of a named activity.

cicoyle · 2026-05-19T17:09:56Z

+    String input = ctx.getInput(String.class);
+    logger.info("=== App2 audit activity invoked with input: {} ===", input);
+
+    Optional<PropagatedHistory> historyOpt = ctx.getPropagatedHistory();


Can we also add getChildWorkflowByName and getChildWorkflowsByName on the WorkflowResult?

javier-aliaga added the backport release-1.18 label May 14, 2026

siri-varma force-pushed the users/svegiraju/implement-workflow-2 branch 3 times, most recently from a1c39f5 to 5d732f3 Compare May 18, 2026 14:39

siri-varma and others added 6 commits May 18, 2026 07:42

Apply suggestions from code review

f5da09d

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com> Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

Refactor BookTripWorkflow to use CompensationHelper

02ec408

Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com> Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

Add CompensationHelper class for managing compensations

0874e5e

Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com> Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

Await cancellation activities in BookTripWorkflow

1eaf039

Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com> Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

Add the new changes

19c1407

Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

fix violations

66f5b53

Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

siri-varma force-pushed the users/svegiraju/implement-workflow-2 branch from 5d732f3 to 66f5b53 Compare May 18, 2026 14:42

Siri Varma Vegiraju added 4 commits May 18, 2026 07:46

Fix helper

14c7e44

Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

Modify readme

d68b814

Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

Modify readme

39171ed

Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

Modify readme

a6b8e49

Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

siri-varma marked this pull request as ready for review May 18, 2026 16:08

siri-varma requested review from a team as code owners May 18, 2026 16:08

siri-varma added the auto-merge label May 18, 2026

javier-aliaga reviewed May 19, 2026

View reviewed changes

Comment thread durabletask-client/src/main/java/io/dapr/durabletask/HistoryPropagationScope.java Outdated

javier-aliaga requested a review from Copilot May 19, 2026 12:38

Copilot started reviewing on behalf of javier-aliaga May 19, 2026 12:38 View session

Copilot AI reviewed May 19, 2026

View reviewed changes

javier-aliaga reviewed May 19, 2026

View reviewed changes

Comment thread durabletask-client/src/main/java/io/dapr/durabletask/PropagatedHistory.java Outdated

siri-varma added 4 commits May 19, 2026 07:13

Update copyright year and improve comment clarity

4c4b6ab

Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com>

Update copyright year to 2026

0f6d183

Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com>

Update HistoryPropagationScope.java

c2e4442

Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com>

Update ActivityHistoryPropagationTest.java

dbd9778

Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com>

Change to 2026

4deb73c

Signed-off-by: Siri Varma Vegiraju <s_vegiraju@apple.com>

siri-varma requested a review from Copilot May 19, 2026 14:33

Copilot started reviewing on behalf of siri-varma May 19, 2026 14:35 View session

Copilot AI reviewed May 19, 2026

View reviewed changes

Potential fix for pull request finding

5eb5664

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com>

javier-aliaga reviewed May 19, 2026

View reviewed changes

cicoyle requested changes May 19, 2026

View reviewed changes

Conversation

siri-varma commented May 6, 2026

Description

Issue reference

Checklist

Uh oh!

javier-aliaga commented May 12, 2026

Uh oh!

siri-varma commented May 18, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

javier-aliaga May 19, 2026

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented May 19, 2026

Codecov Report

Uh oh!

javier-aliaga May 19, 2026

Choose a reason for hiding this comment

Uh oh!

cicoyle left a comment

Choose a reason for hiding this comment

Uh oh!

cicoyle May 19, 2026

Choose a reason for hiding this comment

Uh oh!

cicoyle May 19, 2026

Choose a reason for hiding this comment

Uh oh!

cicoyle May 19, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants