add StatusCode for SDK Error

Co-authored-by: zigang.wang <zigang.wang@alibaba-inc.com>
alibabacloud-go · Jul 23, 2021 · d9ff2bf · d9ff2bf
1 parent fc13b6e
commit d9ff2bf
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 21 deletions.
diff --git a/tea/tea.go b/tea/tea.go
@@ -69,11 +69,12 @@ type Response struct {
 
 // SDKError struct is used save error code and message
 type SDKError struct {
-	Code    *string
-	Message *string
-	Data    *string
-	Stack   *string
-	errMsg  *string
+	Code       *string
+	StatusCode *int
+	Message    *string
+	Data       *string
+	Stack      *string
+	errMsg     *string
 }
 
 // RuntimeObject is used for converting http configuration
@@ -177,6 +178,15 @@ func NewSDKError(obj map[string]interface{}) *SDKError {
 		err.Code = String(val)
 	}
 
+	if statusCode, ok := obj["statusCode"].(int); ok {
+		err.StatusCode = Int(statusCode)
+	} else if status, ok := obj["statusCode"].(string); ok {
+		statusCode, err2 := strconv.Atoi(status)
+		if err2 == nil {
+			err.StatusCode = Int(statusCode)
+		}
+	}
+
 	if obj["message"] != nil {
 		err.Message = String(obj["message"].(string))
 	}
@@ -194,8 +204,8 @@ func (err *SDKError) SetErrMsg(msg string) {
 
 func (err *SDKError) Error() string {
 	if err.errMsg == nil {
-		str := fmt.Sprintf("SDKError:\n   Code: %s\n   Message: %s\n   Data: %s\n",
-			StringValue(err.Code), StringValue(err.Message), StringValue(err.Data))
+		str := fmt.Sprintf("SDKError:\n   StatusCode: %d\n   Code: %s\n   Message: %s\n   Data: %s\n",
+			IntValue(err.StatusCode), StringValue(err.Code), StringValue(err.Message), StringValue(err.Data))
 		err.SetErrMsg(str)
 	}
 	return StringValue(err.errMsg)
@@ -209,8 +219,8 @@ func (err *CastError) Error() string {
 // Convert is use convert map[string]interface object to struct
 func Convert(in interface{}, out interface{}) error {
 	byt, _ := json.Marshal(in)
-	decoder := jsonParser.NewDecoder(bytes.NewReader(byt))  
-	decoder.UseNumber();
+	decoder := jsonParser.NewDecoder(bytes.NewReader(byt))
+	decoder.UseNumber()
 	err := decoder.Decode(&out)
 	return err
 }
@@ -767,10 +777,10 @@ func Retryable(err error) *bool {
 		return Bool(false)
 	}
 	if realErr, ok := err.(*SDKError); ok {
-		code, err := strconv.Atoi(StringValue(realErr.Code))
-		if err != nil {
-			return Bool(true)
+		if realErr.StatusCode == nil {
+			return Bool(false)
 		}
+		code := IntValue(realErr.StatusCode)
 		return Bool(code >= http.StatusInternalServerError)
 	}
 	return Bool(true)

diff --git a/tea/tea_test.go b/tea/tea_test.go
@@ -139,9 +139,9 @@ func TestConvert(t *testing.T) {
 	utils.AssertEqual(t, "test", string(out.Body))
 }
 
-func TestConvertType(t *testing.T){
+func TestConvertType(t *testing.T) {
 	in := map[string]interface{}{
-		"key": 123,
+		"key":  123,
 		"body": []byte("test"),
 	}
 	out := new(test)
@@ -161,28 +161,30 @@ func TestRuntimeObject(t *testing.T) {
 
 func TestSDKError(t *testing.T) {
 	err := NewSDKError(map[string]interface{}{
-		"code":    "code",
-		"message": "message",
+		"code":       "code",
+		"statusCode": 404,
+		"message":    "message",
 		"data": map[string]interface{}{
 			"httpCode":  "404",
 			"requestId": "dfadfa32cgfdcasd4313",
 			"hostId":    "github.com/alibabacloud/tea",
 		},
 	})
 	utils.AssertNotNil(t, err)
-	utils.AssertEqual(t, "SDKError:\n   Code: code\n   Message: message\n   Data: {\"hostId\":\"github.com/alibabacloud/tea\",\"httpCode\":\"404\",\"requestId\":\"dfadfa32cgfdcasd4313\"}\n", err.Error())
+	utils.AssertEqual(t, "SDKError:\n   StatusCode: 404\n   Code: code\n   Message: message\n   Data: {\"hostId\":\"github.com/alibabacloud/tea\",\"httpCode\":\"404\",\"requestId\":\"dfadfa32cgfdcasd4313\"}\n", err.Error())
 
 	err.SetErrMsg("test")
 	utils.AssertEqual(t, "test", err.Error())
 }
 
 func TestSDKErrorCode404(t *testing.T) {
 	err := NewSDKError(map[string]interface{}{
-		"code":    404,
-		"message": "message",
+		"statusCode": 404,
+		"code":       "NOTFOUND",
+		"message":    "message",
 	})
 	utils.AssertNotNil(t, err)
-	utils.AssertEqual(t, "SDKError:\n   Code: 404\n   Message: message\n   Data: \n", err.Error())
+	utils.AssertEqual(t, "SDKError:\n   StatusCode: 404\n   Code: NOTFOUND\n   Message: message\n   Data: \n", err.Error())
 }
 
 func TestToObject(t *testing.T) {
@@ -334,9 +336,29 @@ func Test_Retryable(t *testing.T) {
 	}
 	err = NewSDKError(errmsg)
 	ifRetry = Retryable(err)
+	utils.AssertEqual(t, false, BoolValue(ifRetry))
+
+	errmsg["statusCode"] = 400
+	err = NewSDKError(errmsg)
+	ifRetry = Retryable(err)
+	utils.AssertEqual(t, false, BoolValue(ifRetry))
+
+	errmsg["statusCode"] = "400"
+	err = NewSDKError(errmsg)
+	ifRetry = Retryable(err)
+	utils.AssertEqual(t, false, BoolValue(ifRetry))
+
+	errmsg["statusCode"] = 500
+	err = NewSDKError(errmsg)
+	ifRetry = Retryable(err)
+	utils.AssertEqual(t, true, BoolValue(ifRetry))
+
+	errmsg["statusCode"] = "500"
+	err = NewSDKError(errmsg)
+	ifRetry = Retryable(err)
 	utils.AssertEqual(t, true, BoolValue(ifRetry))
 
-	errmsg["code"] = "400"
+	errmsg["statusCode"] = "test"
 	err = NewSDKError(errmsg)
 	ifRetry = Retryable(err)
 	utils.AssertEqual(t, false, BoolValue(ifRetry))