Add message to Timeout failures (temporalio#756)

morigs · Sep 25, 2020 · a97a0e6 · a97a0e6
1 parent 23e313d
commit a97a0e6
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/common/failure/failure.go b/common/failure/failure.go
@@ -30,6 +30,10 @@ import (
 	failurepb "go.temporal.io/api/failure/v1"
 )
 
+const (
+	failureSourceServer = "Server"
+)
+
 func NewServerFailure(message string, nonRetryable bool) *failurepb.Failure {
 	f := &failurepb.Failure{
 		Message: message,
@@ -52,8 +56,10 @@ func NewResetWorkflowFailure(message string, lastHeartbeatDetails *commonpb.Payl
 	return f
 }
 
-func NewTimeoutFailure(timeoutType enumspb.TimeoutType) *failurepb.Failure {
+func NewTimeoutFailure(message string, timeoutType enumspb.TimeoutType) *failurepb.Failure {
 	f := &failurepb.Failure{
+		Message: message,
+		Source:  failureSourceServer,
 		FailureInfo: &failurepb.Failure_TimeoutFailureInfo{TimeoutFailureInfo: &failurepb.TimeoutFailureInfo{
 			TimeoutType: timeoutType,
 		}},

diff --git a/host/activity_test.go b/host/activity_test.go
@@ -316,7 +316,7 @@ func (s *integrationSuite) TestActivityHeartbeatDetailsDuringRetry() {
 			s.Equal(int32(i+2), pendingActivity.GetAttempt())
 			s.Equal(enumspb.PENDING_ACTIVITY_STATE_SCHEDULED, pendingActivity.GetState())
 			if i == 0 {
-				s.Equal(failure.NewTimeoutFailure(enumspb.TIMEOUT_TYPE_HEARTBEAT), pendingActivity.GetLastFailure())
+				s.Equal(failure.NewTimeoutFailure("ActivityTask timeout", enumspb.TIMEOUT_TYPE_HEARTBEAT), pendingActivity.GetLastFailure())
 			} else { // i == 1
 				expectedErrString := "retryable-error"
 				s.NotNil(pendingActivity.GetLastFailure().GetApplicationFailureInfo())

diff --git a/service/history/timerQueueActiveTaskExecutor.go b/service/history/timerQueueActiveTaskExecutor.go
@@ -219,7 +219,7 @@ Loop:
 			break Loop
 		}
 
-		timeoutFailure := failure.NewTimeoutFailure(timerSequenceID.timerType)
+		timeoutFailure := failure.NewTimeoutFailure("ActivityTask timeout", timerSequenceID.timerType)
 		var retryState enumspb.RetryState
 		if retryState, err = mutableState.RetryActivity(
 			activityInfo,
@@ -486,7 +486,7 @@ func (t *timerQueueActiveTaskExecutor) executeWorkflowTimeoutTask(
 
 	eventBatchFirstEventID := mutableState.GetNextEventID()
 
-	timeoutFailure := failure.NewTimeoutFailure(enumspb.TIMEOUT_TYPE_START_TO_CLOSE)
+	timeoutFailure := failure.NewTimeoutFailure("WorkflowTask timeout", enumspb.TIMEOUT_TYPE_START_TO_CLOSE)
 	backoffInterval := backoff.NoBackoff
 	retryState := enumspb.RETRY_STATE_TIMEOUT
 	continueAsNewInitiator := enumspb.CONTINUE_AS_NEW_INITIATOR_RETRY