feat!: rename ClientError and ServerError to APIError. fixes: #159

PiperOrigin-RevId: 740426404

Author: qiaodev

api_client.go

@@ -223,15 +223,20 @@ func iterateResponseStream[R any](rs *responseStream[R], responseConverter func(
 	}
 }
 
-type apiError struct {
-	Code    int              `json:"code,omitempty"`
-	Message string           `json:"message,omitempty"`
-	Status  string           `json:"status,omitempty"`
+// APIError contains an error response from the server.
+type APIError struct {
+	// Code is the HTTP response status code.
+	Code int `json:"code,omitempty"`
+	// Message is the server response message.
+	Message string `json:"message,omitempty"`
+	// Status is the server response status.
+	Status string `json:"status,omitempty"`
+	// Details provide more context to an error.
 	Details []map[string]any `json:"details,omitempty"`
 }
 
 type responseWithError struct {
-	ErrorInfo *apiError `json:"error,omitempty"`
+	ErrorInfo *APIError `json:"error,omitempty"`
 }
 
 func newAPIError(resp *http.Response) error {
@@ -245,41 +250,15 @@ func newAPIError(resp *http.Response) error {
 		if err := json.Unmarshal(body, respWithError); err != nil {
 			return fmt.Errorf("newAPIError: unmarshal response to error failed: %w. Response: %v", err, string(body))
 		}
-		if resp.StatusCode >= 400 && resp.StatusCode < 500 {
-			return ClientError{apiError: *respWithError.ErrorInfo}
-		}
-		return ServerError{apiError: *respWithError.ErrorInfo}
-	}
-	if resp.StatusCode >= 400 && resp.StatusCode < 500 {
-		return ClientError{apiError: apiError{Code: resp.StatusCode, Status: resp.Status}}
+		return *respWithError.ErrorInfo
 	}
-	return ServerError{apiError: apiError{Code: resp.StatusCode, Status: resp.Status}}
-}
-
-// ClientError is an error that occurs when the GenAI API
-// receives an invalid request from a client.
-type ClientError struct {
-	apiError
-}
-
-// Error returns a string representation of the ClientError.
-func (e ClientError) Error() string {
-	return fmt.Sprintf(
-		"client error. Code: %d, Message: %s, Status: %s, Details: %v",
-		e.Code, e.Message, e.Status, e.Details,
-	)
-}
-
-// ServerError is an error that occurs when the GenAI API
-// encounters an unexpected server problem.
-type ServerError struct {
-	apiError
+	return APIError{Code: resp.StatusCode, Status: resp.Status}
 }
 
 // Error returns a string representation of the ServerError.
-func (e ServerError) Error() string {
+func (e APIError) Error() string {
 	return fmt.Sprintf(
-		"server error. Code: %d, Message: %s, Status: %s, Details: %v",
+		"Error %d, Message: %s, Status: %s, Details: %v",
 		e.Code, e.Message, e.Status, e.Details,
 	)
 }

api_client_test.go

@@ -79,15 +79,15 @@ func TestSendRequest(t *testing.T) {
 			method:       http.MethodGet,
 			responseCode: http.StatusBadRequest,
 			responseBody: `{"error": {"code": 400, "message": "bad request", "status": "INVALID_ARGUMENTS", "details": [{"field": "value"}]}}`,
-			wantErr:      &ClientError{apiError: apiError{Code: http.StatusBadRequest, Message: ""}},
+			wantErr:      &APIError{Code: http.StatusBadRequest, Message: "bad request", Details: []map[string]any{{"field": "value"}}},
 		},
 		{
 			desc:         "500 error response",
 			path:         "bar",
 			method:       http.MethodGet,
 			responseCode: http.StatusInternalServerError,
 			responseBody: `{"error": {"code": 500, "message": "internal server error", "status": "INTERNAL_SERVER_ERROR", "details": [{"field": "value"}]}}`,
-			wantErr:      &ServerError{apiError: apiError{Code: http.StatusInternalServerError, Message: ""}},
+			wantErr:      &APIError{Code: http.StatusInternalServerError, Message: "internal server error", Details: []map[string]any{{"field": "value"}}},
 		},
 		{
 			desc:         "invalid response body",
@@ -126,16 +126,10 @@ func TestSendRequest(t *testing.T) {
 			}
 			if tt.wantErr != nil && err != nil {
 				// For error cases, check for want error types
-				if tt.responseCode >= 400 && tt.responseCode < 500 {
-					_, ok := err.(ClientError)
+				if tt.responseCode >= 400 {
+					_, ok := err.(APIError)
 					if !ok {
-						t.Errorf("want ClientError, got %T(%s)", err, err.Error())
-					}
-
-				} else if tt.responseCode >= 500 {
-					_, ok := err.(ServerError)
-					if !ok {
-						t.Errorf("want ServerError, got %T", err)
+						t.Errorf("want Error, got %T(%s)", err, err.Error())
 					}
 				} else if tt.path == "" { // build request error
 					if !strings.Contains(err.Error(), tt.wantErr.Error()) {
@@ -303,7 +297,7 @@ func TestSendStreamRequest(t *testing.T) {
 			mockResponse:     `{"error":{"code":400,"message":"test error message","status":"INVALID_ARGUMENT"}}`,
 			mockStatusCode:   http.StatusBadRequest,
 			wantErr:          true,
-			wantErrorMessage: "client error. Code: 400, Message: test error message, Status: INVALID_ARGUMENT, Details: []",
+			wantErrorMessage: "Error 400, Message: test error message, Status: INVALID_ARGUMENT, Details: []",
 		},
 		{
 			name:             "Error Response with empty body",
@@ -313,7 +307,7 @@ func TestSendStreamRequest(t *testing.T) {
 			mockResponse:     ``,
 			mockStatusCode:   http.StatusBadRequest,
 			wantErr:          true,
-			wantErrorMessage: "client error. Code: 400, Message: , Status: 400 Bad Request, Details: []",
+			wantErrorMessage: "Error 400, Message: , Status: 400 Bad Request, Details: []",
 		},
 		{
 			name:             "Error Response with invalid json",
@@ -333,7 +327,7 @@ func TestSendStreamRequest(t *testing.T) {
 			mockResponse:     `{"error":{"code":500,"message":"test error message","status":"INTERNAL"}}`,
 			mockStatusCode:   http.StatusInternalServerError,
 			wantErr:          true,
-			wantErrorMessage: "server error. Code: 500, Message: test error message, Status: INTERNAL, Details: []",
+			wantErrorMessage: "Error 500, Message: test error message, Status: INTERNAL, Details: []",
 		},
 		{
 			name:             "Error Response with server error and empty body",
@@ -343,7 +337,7 @@ func TestSendStreamRequest(t *testing.T) {
 			mockResponse:     ``,
 			mockStatusCode:   http.StatusInternalServerError,
 			wantErr:          true,
-			wantErrorMessage: "server error. Code: 500, Message: , Status: 500 Internal Server Error, Details: []",
+			wantErrorMessage: "Error 500, Message: , Status: 500 Internal Server Error, Details: []",
 		},
 		{
 			name:             "Error Response with server error and invalid json",