Handle timeout error construct by the old client version (#852)

Author: yycptt

internal/internal_utils.go

@@ -226,8 +226,15 @@ func getErrorDetails(err error, dataConverter DataConverter) (string, []byte) {
 // constructError construct error from reason and details sending down from server.
 func constructError(reason string, details []byte, dataConverter DataConverter) error {
 	if strings.HasPrefix(reason, errReasonTimeout) {
-		timeoutType := getTimeoutTypeFromErrReason(reason)
 		details := newEncodedValues(details, dataConverter)
+		timeoutType, err := getTimeoutTypeFromErrReason(reason)
+		if err != nil {
+			// prior client version uses details to indicate timeoutType
+			if err := details.Get(&timeoutType); err != nil {
+				panic(err)
+			}
+			return NewTimeoutError(timeoutType)
+		}
 		return NewTimeoutError(timeoutType, details)
 	}
 
@@ -286,12 +293,12 @@ func getMetricsScopeForLocalActivity(ts *metrics.TaggedScope, workflowType, loca
 	return ts.GetTaggedScope(tagWorkflowType, workflowType, tagLocalActivityType, localActivityType)
 }
 
-func getTimeoutTypeFromErrReason(reason string) s.TimeoutType {
+func getTimeoutTypeFromErrReason(reason string) (s.TimeoutType, error) {
 	timeoutTypeStr := reason[strings.Index(reason, " ")+1:]
 	var timeoutType s.TimeoutType
 	if err := timeoutType.UnmarshalText([]byte(timeoutTypeStr)); err != nil {
-		// this should never happen
-		panic(err)
+		// this happens when the timeout error reason is constructed by an prior constructed by prior client version
+		return 0, err
 	}
-	return timeoutType
+	return timeoutType, nil
 }

internal/internal_utils_test.go

@@ -127,3 +127,28 @@ func TestGetErrorDetails_TimeoutError(t *testing.T) {
 	require.Equal(t, fmt.Sprintf("%v %v", errReasonTimeout, s.TimeoutTypeHeartbeat), reason)
 	require.Equal(t, val2, data)
 }
+
+func TestConstructError_TimeoutError(t *testing.T) {
+	dc := getDefaultDataConverter()
+	details, err := dc.ToData(testErrorDetails1)
+	require.NoError(t, err)
+
+	reason := fmt.Sprintf("%v %v", errReasonTimeout, s.TimeoutTypeHeartbeat)
+	constructedErr := constructError(reason, details, dc)
+	timeoutErr, ok := constructedErr.(*TimeoutError)
+	require.True(t, ok)
+	require.True(t, timeoutErr.HasDetails())
+	var detailValue string
+	err = timeoutErr.Details(&detailValue)
+	require.NoError(t, err)
+	require.Equal(t, testErrorDetails1, detailValue)
+
+	// Backward compatibility test
+	reason = errReasonTimeout
+	details, err = dc.ToData(s.TimeoutTypeHeartbeat)
+	constructedErr = constructError(reason, details, dc)
+	timeoutErr, ok = constructedErr.(*TimeoutError)
+	require.True(t, ok)
+	require.Equal(t, s.TimeoutTypeHeartbeat, timeoutErr.TimeoutType())
+	require.False(t, timeoutErr.HasDetails())
+}