|
| 1 | +package io.temporal.worker; |
| 2 | + |
| 3 | +import static org.junit.Assert.assertEquals; |
| 4 | +import static org.junit.Assert.assertTrue; |
| 5 | + |
| 6 | +import io.temporal.activity.ActivityInterface; |
| 7 | +import io.temporal.activity.ActivityMethod; |
| 8 | +import io.temporal.activity.ActivityOptions; |
| 9 | +import io.temporal.api.common.v1.WorkflowExecution; |
| 10 | +import io.temporal.api.enums.v1.EventType; |
| 11 | +import io.temporal.api.history.v1.HistoryEvent; |
| 12 | +import io.temporal.client.WorkflowClient; |
| 13 | +import io.temporal.testing.internal.SDKTestWorkflowRule; |
| 14 | +import io.temporal.workflow.Workflow; |
| 15 | +import io.temporal.workflow.WorkflowInterface; |
| 16 | +import io.temporal.workflow.WorkflowMethod; |
| 17 | +import java.time.Duration; |
| 18 | +import java.util.List; |
| 19 | +import java.util.concurrent.atomic.AtomicBoolean; |
| 20 | +import java.util.concurrent.atomic.AtomicInteger; |
| 21 | +import org.junit.Rule; |
| 22 | +import org.junit.Test; |
| 23 | + |
| 24 | +/** |
| 25 | + * Validation test for the interrupted activity completion fix. |
| 26 | + * |
| 27 | + * <p>This test demonstrates that the fix for https://github.com/temporalio/sdk-java/issues/731 is working correctly. |
| 28 | + * Before the fix, activities that returned with the interrupted flag set would fail to report their results |
| 29 | + * due to gRPC call failures. |
| 30 | + * |
| 31 | + * <p>The fix was applied in ActivityWorker.sendReply() method to temporarily clear the interrupted flag |
| 32 | + * during gRPC calls and restore it afterward. |
| 33 | + */ |
| 34 | +public class InterruptedActivityCompletionValidationTest { |
| 35 | + |
| 36 | + private static final String SUCCESS_RESULT = "completed-with-interrupted-flag"; |
| 37 | + private static final AtomicInteger executionCount = new AtomicInteger(0); |
| 38 | + private static final AtomicBoolean interruptedFlagWasSet = new AtomicBoolean(false); |
| 39 | + |
| 40 | + @Rule |
| 41 | + public SDKTestWorkflowRule testWorkflowRule = |
| 42 | + SDKTestWorkflowRule.newBuilder() |
| 43 | + .setWorkflowTypes(TestWorkflowImpl.class) |
| 44 | + .setActivityImplementations(new TestActivityImpl()) |
| 45 | + .build(); |
| 46 | + |
| 47 | + @WorkflowInterface |
| 48 | + public interface TestWorkflow { |
| 49 | + @WorkflowMethod |
| 50 | + String execute(); |
| 51 | + } |
| 52 | + |
| 53 | + @ActivityInterface |
| 54 | + public interface TestActivity { |
| 55 | + @ActivityMethod |
| 56 | + String processWithInterruptedFlag(); |
| 57 | + } |
| 58 | + |
| 59 | + /** |
| 60 | + * This test validates that the fix is working by demonstrating that: |
| 61 | + * |
| 62 | + * <p> |
| 63 | + * 1. An activity can set the interrupted flag and still return a result |
| 64 | + * 2. The result is successfully reported to the Temporal server |
| 65 | + * 3. The workflow completes with the expected result |
| 66 | + * 4. The activity completion is properly recorded in the workflow history |
| 67 | + * |
| 68 | + * <p>Before the fix: This test would fail with CancellationException during gRPC calls After the |
| 69 | + * fix: This test passes, proving activities can complete despite interrupted flag |
| 70 | + */ |
| 71 | + @Test |
| 72 | + public void testActivityCompletionWithInterruptedFlag() { |
| 73 | + // Reset counters |
| 74 | + executionCount.set(0); |
| 75 | + interruptedFlagWasSet.set(false); |
| 76 | + |
| 77 | + // Execute workflow |
| 78 | + TestWorkflow workflow = testWorkflowRule.newWorkflowStub(TestWorkflow.class); |
| 79 | + WorkflowExecution execution = WorkflowClient.start(workflow::execute); |
| 80 | + |
| 81 | + // Wait for completion and get result |
| 82 | + String result = |
| 83 | + testWorkflowRule |
| 84 | + .getWorkflowClient() |
| 85 | + .newUntypedWorkflowStub(execution, null) |
| 86 | + .getResult(String.class); |
| 87 | + |
| 88 | + // Validate the workflow completed successfully with expected result |
| 89 | + assertEquals("Activity should return the expected result", SUCCESS_RESULT, result); |
| 90 | + |
| 91 | + // Validate the activity was executed exactly once |
| 92 | + assertEquals("Activity should be executed exactly once", 1, executionCount.get()); |
| 93 | + |
| 94 | + // Validate that the interrupted flag was actually set during execution |
| 95 | + assertTrue("Activity should have set the interrupted flag", interruptedFlagWasSet.get()); |
| 96 | + |
| 97 | + // Validate that the activity completion was properly recorded in workflow history |
| 98 | + List<HistoryEvent> events = |
| 99 | + testWorkflowRule.getWorkflowClient().fetchHistory(execution.getWorkflowId()).getEvents(); |
| 100 | + |
| 101 | + boolean activityCompletedFound = false; |
| 102 | + for (HistoryEvent event : events) { |
| 103 | + if (event.getEventType() == EventType.EVENT_TYPE_ACTIVITY_TASK_COMPLETED) { |
| 104 | + activityCompletedFound = true; |
| 105 | + break; |
| 106 | + } |
| 107 | + } |
| 108 | + assertTrue( |
| 109 | + "Activity completion should be recorded in workflow history", activityCompletedFound); |
| 110 | + } |
| 111 | + |
| 112 | + /** |
| 113 | + * This test validates that activities that fail with interrupted flag set can still properly |
| 114 | + * report their failures. |
| 115 | + */ |
| 116 | + @Test |
| 117 | + public void testActivityFailureWithInterruptedFlag() { |
| 118 | + executionCount.set(0); |
| 119 | + interruptedFlagWasSet.set(false); |
| 120 | + |
| 121 | + TestWorkflow workflow = testWorkflowRule.newWorkflowStub(TestWorkflow.class); |
| 122 | + WorkflowExecution execution = WorkflowClient.start(workflow::execute); |
| 123 | + |
| 124 | + try { |
| 125 | + testWorkflowRule |
| 126 | + .getWorkflowClient() |
| 127 | + .newUntypedWorkflowStub(execution, null) |
| 128 | + .getResult(String.class); |
| 129 | + } catch (Exception e) { |
| 130 | + // Expected to fail, but the important thing is that the failure was properly reported |
| 131 | + assertTrue("Should contain failure information", e.getMessage().contains("Activity failed")); |
| 132 | + } |
| 133 | + |
| 134 | + // Validate the activity was executed |
| 135 | + assertEquals("Activity should be executed", 1, executionCount.get()); |
| 136 | + |
| 137 | + // Validate the interrupted flag was set |
| 138 | + assertTrue("Activity should have set the interrupted flag", interruptedFlagWasSet.get()); |
| 139 | + } |
| 140 | + |
| 141 | + public static class TestWorkflowImpl implements TestWorkflow { |
| 142 | + |
| 143 | + private final TestActivity activity = |
| 144 | + Workflow.newActivityStub( |
| 145 | + TestActivity.class, |
| 146 | + ActivityOptions.newBuilder().setScheduleToCloseTimeout(Duration.ofSeconds(30)).build()); |
| 147 | + |
| 148 | + @Override |
| 149 | + public String execute() { |
| 150 | + return activity.processWithInterruptedFlag(); |
| 151 | + } |
| 152 | + } |
| 153 | + |
| 154 | + public static class TestActivityImpl implements TestActivity { |
| 155 | + |
| 156 | + @Override |
| 157 | + public String processWithInterruptedFlag() { |
| 158 | + executionCount.incrementAndGet(); |
| 159 | + |
| 160 | + // This is the critical scenario that was failing before the fix: |
| 161 | + // Activity sets the interrupted flag and then tries to return a result |
| 162 | + Thread.currentThread().interrupt(); |
| 163 | + interruptedFlagWasSet.set(true); |
| 164 | + |
| 165 | + // Before the fix: The gRPC call to report this result would fail with |
| 166 | + // CancellationException because the interrupted flag was set |
| 167 | + // After the fix: The interrupted flag is temporarily cleared during the |
| 168 | + // gRPC call, allowing the result to be successfully reported |
| 169 | + return SUCCESS_RESULT; |
| 170 | + } |
| 171 | + } |
| 172 | +} |
0 commit comments