Fix recordHeartbeat: swallowed cancel/reset/pause exceptions #2990
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| package io.temporal.internal.client; | ||
|
|
||
| import io.temporal.api.workflowservice.v1.RecordActivityTaskHeartbeatByIdResponse; | ||
| import io.temporal.api.workflowservice.v1.RecordActivityTaskHeartbeatResponse; | ||
|
|
||
| /** | ||
| * Container class to deduplicate {@link RecordActivityTaskHeartbeatByIdResponse} and {@link | ||
| * RecordActivityTaskHeartbeatResponse}. | ||
| */ | ||
| public final class ActivityHeartbeatResponse { | ||
| private final boolean cancelRequested; | ||
| private final boolean activityReset; | ||
| private final boolean activityPaused; | ||
|
|
||
| ActivityHeartbeatResponse( | ||
| boolean cancelRequested, boolean activityReset, boolean activityPaused) { | ||
| this.cancelRequested = cancelRequested; | ||
| this.activityReset = activityReset; | ||
| this.activityPaused = activityPaused; | ||
| } | ||
|
|
||
| public boolean getCancelRequested() { | ||
| return cancelRequested; | ||
| } | ||
|
|
||
| public boolean getActivityReset() { | ||
| return activityReset; | ||
| } | ||
|
|
||
| public boolean getActivityPaused() { | ||
| return activityPaused; | ||
| } | ||
| } |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| package io.temporal.internal.client.external; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertThrows; | ||
| import static org.junit.Assert.assertTrue; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import com.uber.m3.tally.NoopScope; | ||
| import io.grpc.Status; | ||
| import io.grpc.StatusRuntimeException; | ||
| import io.temporal.api.common.v1.WorkflowExecution; | ||
| import io.temporal.api.workflowservice.v1.RecordActivityTaskHeartbeatByIdResponse; | ||
| import io.temporal.api.workflowservice.v1.RecordActivityTaskHeartbeatResponse; | ||
| import io.temporal.api.workflowservice.v1.WorkflowServiceGrpc; | ||
| import io.temporal.client.ActivityCanceledException; | ||
| import io.temporal.client.ActivityCompletionFailureException; | ||
| import io.temporal.client.ActivityNotExistsException; | ||
| import io.temporal.client.ActivityPausedException; | ||
| import io.temporal.client.ActivityResetException; | ||
| import io.temporal.common.converter.GlobalDataConverter; | ||
| import io.temporal.serviceclient.WorkflowServiceStubs; | ||
| import io.temporal.serviceclient.WorkflowServiceStubsOptions; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
|
|
||
| public class ManualActivityCompletionClientImplTest { | ||
|
|
||
| private WorkflowServiceStubs service; | ||
| private WorkflowServiceGrpc.WorkflowServiceBlockingStub blockingStub; | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| service = mock(WorkflowServiceStubs.class); | ||
| blockingStub = mock(WorkflowServiceGrpc.WorkflowServiceBlockingStub.class); | ||
| when(service.blockingStub()).thenReturn(blockingStub); | ||
| when(blockingStub.withOption(any(), any())).thenReturn(blockingStub); | ||
| when(service.getServerCapabilities()) | ||
| .thenReturn( | ||
| () -> | ||
| io.temporal.api.workflowservice.v1.GetSystemInfoResponse.Capabilities | ||
| .getDefaultInstance()); | ||
| when(service.getOptions()) | ||
| .thenReturn(WorkflowServiceStubsOptions.newBuilder().validateAndBuildWithDefaults()); | ||
| } | ||
|
|
||
| private ManualActivityCompletionClientImpl clientWithTaskToken() { | ||
| return new ManualActivityCompletionClientImpl( | ||
| service, | ||
| "test-namespace", | ||
| "test-identity", | ||
| GlobalDataConverter.get(), | ||
| new NoopScope(), | ||
| new byte[] {1, 2, 3}, | ||
| null, | ||
| null, | ||
| null); | ||
| } | ||
|
|
||
| private ManualActivityCompletionClientImpl clientWithActivityId() { | ||
| return new ManualActivityCompletionClientImpl( | ||
| service, | ||
| "test-namespace", | ||
| "test-identity", | ||
| GlobalDataConverter.get(), | ||
| new NoopScope(), | ||
| null, | ||
| WorkflowExecution.newBuilder().setWorkflowId("wf").setRunId("run").build(), | ||
| "test-activity-id", | ||
| null); | ||
| } | ||
|
|
||
| @Test | ||
| public void cancelRequestedThrowsActivityCanceledExceptionNotSwallowed() { | ||
| when(blockingStub.recordActivityTaskHeartbeat(any())) | ||
| .thenReturn( | ||
| RecordActivityTaskHeartbeatResponse.newBuilder().setCancelRequested(true).build()); | ||
|
|
||
| assertThrows( | ||
| ActivityCanceledException.class, () -> clientWithTaskToken().recordHeartbeat("details")); | ||
| } | ||
|
|
||
| @Test | ||
| public void activityResetThrowsActivityResetExceptionNotSwallowed() { | ||
| when(blockingStub.recordActivityTaskHeartbeat(any())) | ||
| .thenReturn( | ||
| RecordActivityTaskHeartbeatResponse.newBuilder().setActivityReset(true).build()); | ||
|
|
||
| assertThrows( | ||
| ActivityResetException.class, () -> clientWithTaskToken().recordHeartbeat("details")); | ||
| } | ||
|
|
||
| @Test | ||
| public void activityPausedThrowsActivityPausedExceptionNotSwallowed() { | ||
| when(blockingStub.recordActivityTaskHeartbeat(any())) | ||
| .thenReturn( | ||
| RecordActivityTaskHeartbeatResponse.newBuilder().setActivityPaused(true).build()); | ||
|
|
||
| assertThrows( | ||
| ActivityPausedException.class, () -> clientWithTaskToken().recordHeartbeat("details")); | ||
| } | ||
|
|
||
| @Test | ||
| public void byIdCancelRequestedThrowsActivityCanceledExceptionNotSwallowed() { | ||
| when(blockingStub.recordActivityTaskHeartbeatById(any())) | ||
| .thenReturn( | ||
| RecordActivityTaskHeartbeatByIdResponse.newBuilder().setCancelRequested(true).build()); | ||
|
|
||
| assertThrows( | ||
| ActivityCanceledException.class, () -> clientWithActivityId().recordHeartbeat("details")); | ||
| } | ||
|
|
||
| @Test | ||
| public void byIdActivityResetThrowsActivityResetExceptionNotSwallowed() { | ||
| when(blockingStub.recordActivityTaskHeartbeatById(any())) | ||
| .thenReturn( | ||
| RecordActivityTaskHeartbeatByIdResponse.newBuilder().setActivityReset(true).build()); | ||
|
|
||
| assertThrows( | ||
| ActivityResetException.class, () -> clientWithActivityId().recordHeartbeat("details")); | ||
| } | ||
|
|
||
| @Test | ||
| public void byIdActivityPausedThrowsActivityPausedExceptionNotSwallowed() { | ||
| when(blockingStub.recordActivityTaskHeartbeatById(any())) | ||
| .thenReturn( | ||
| RecordActivityTaskHeartbeatByIdResponse.newBuilder().setActivityPaused(true).build()); | ||
|
|
||
| assertThrows( | ||
| ActivityPausedException.class, () -> clientWithActivityId().recordHeartbeat("details")); | ||
| } | ||
|
|
||
| @Test | ||
| public void notFoundIsReportedAsActivityNotExistsException() { | ||
| when(blockingStub.recordActivityTaskHeartbeat(any())) | ||
| .thenThrow(new StatusRuntimeException(Status.NOT_FOUND)); | ||
|
|
||
| assertThrows( | ||
| ActivityNotExistsException.class, () -> clientWithTaskToken().recordHeartbeat("details")); | ||
| } | ||
|
|
||
| @Test | ||
| public void rpcErrorIsReportedAsActivityCompletionFailureException() { | ||
| when(blockingStub.recordActivityTaskHeartbeat(any())) | ||
| .thenThrow(new StatusRuntimeException(Status.INTERNAL)); | ||
|
|
||
| ActivityCompletionFailureException failure = | ||
| assertThrows( | ||
| ActivityCompletionFailureException.class, | ||
| () -> clientWithTaskToken().recordHeartbeat("details")); | ||
|
|
||
| assertTrue(failure.getCause() instanceof StatusRuntimeException); | ||
| assertEquals( | ||
| Status.Code.INTERNAL, ((StatusRuntimeException) failure.getCause()).getStatus().getCode()); | ||
| } | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: This is the docs we use elsewhere. It is easier to maintain and then move the details here into
ActivityCompletionExceptionsince there are a lot of methods that would need all these detauilsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, I'll just delete the unnecessary doc and base it on
ActivityCompletionClient. I don't think there's much point in havingActivityCompletionExceptiondocument its own subclasses.