VaalaCat/go-openai
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Optimize Client Error Return (#856)

Browse Source 
* update client error return

* update client_test.go

* update client_test.go

* update file_api_test.go

* update client_test.go

* update client_test.go
This commit is contained in:
eiixy
2024-09-26 18:25:56 +08:00
committed by GitHub
parent e095df5325
commit 38bdc812df
4 changed files with 67 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
client.go
View File

@@ -285,10 +285,18 @@ func (c *Client) baseURLWithAzureDeployment(baseURL, suffix, model string) (newB
} }
func (c *Client) handleErrorResp(resp *http.Response) error { func (c *Client) handleErrorResp(resp *http.Response) error {
if !strings.HasPrefix(resp.Header.Get("Content-Type"), "application/json") {
body, err := io.ReadAll(resp.Body)
if err != nil {
return fmt.Errorf("error, reading response body: %w", err)
}
return fmt.Errorf("error, status code: %d, status: %s, body: %s", resp.StatusCode, resp.Status, body)
}
var errRes ErrorResponse var errRes ErrorResponse
err := json.NewDecoder(resp.Body).Decode(&errRes) err := json.NewDecoder(resp.Body).Decode(&errRes)
if err != nil || errRes.Error == nil { if err != nil || errRes.Error == nil {
reqErr := &RequestError{ reqErr := &RequestError{
HTTPStatus: resp.Status,
HTTPStatusCode: resp.StatusCode, HTTPStatusCode: resp.StatusCode,
Err: err, Err: err,
} }
@@ -298,6 +306,7 @@ func (c *Client) handleErrorResp(resp *http.Response) error {
return reqErr return reqErr
} }
errRes.Error.HTTPStatus = resp.Status
errRes.Error.HTTPStatusCode = resp.StatusCode errRes.Error.HTTPStatusCode = resp.StatusCode
return errRes.Error return errRes.Error
} }

52
client_test.go
View File

@@ -136,12 +136,15 @@ func TestHandleErrorResp(t *testing.T) {
testCases := []struct { testCases := []struct {
name string name string
httpCode int httpCode int
httpStatus string
contentType string
body io.Reader body io.Reader
expected string expected string
}{ }{
{ {
name: "401 Invalid Authentication", name: "401 Invalid Authentication",
httpCode: http.StatusUnauthorized, httpCode: http.StatusUnauthorized,
contentType: "application/json",
body: bytes.NewReader([]byte( body: bytes.NewReader([]byte(
`{ `{
"error":{ "error":{
@@ -152,11 +155,12 @@ func TestHandleErrorResp(t *testing.T) {
} }
}`, }`,
)), )),
expected: "error, status code: 401, message: You didn't provide an API key. ....", expected: "error, status code: 401, status: , message: You didn't provide an API key. ....",
}, },
{ {
name: "401 Azure Access Denied", name: "401 Azure Access Denied",
httpCode: http.StatusUnauthorized, httpCode: http.StatusUnauthorized,
contentType: "application/json",
body: bytes.NewReader([]byte( body: bytes.NewReader([]byte(
`{ `{
"error":{ "error":{
@@ -165,11 +169,12 @@ func TestHandleErrorResp(t *testing.T) {
} }
}`, }`,
)), )),
expected: "error, status code: 401, message: Access denied due to Virtual Network/Firewall rules.", expected: "error, status code: 401, status: , message: Access denied due to Virtual Network/Firewall rules.",
}, },
{ {
name: "503 Model Overloaded", name: "503 Model Overloaded",
httpCode: http.StatusServiceUnavailable, httpCode: http.StatusServiceUnavailable,
contentType: "application/json",
body: bytes.NewReader([]byte(` body: bytes.NewReader([]byte(`
{ {
"error":{ "error":{
@@ -179,22 +184,53 @@ func TestHandleErrorResp(t *testing.T) {
"code":null "code":null
} }
}`)), }`)),
expected: "error, status code: 503, message: That model...", expected: "error, status code: 503, status: , message: That model...",
}, },
{ {
name: "503 no message (Unknown response)", name: "503 no message (Unknown response)",
httpCode: http.StatusServiceUnavailable, httpCode: http.StatusServiceUnavailable,
contentType: "application/json",
body: bytes.NewReader([]byte(` body: bytes.NewReader([]byte(`
{ {
"error":{} "error":{}
}`)), }`)),
expected: "error, status code: 503, message: ", expected: "error, status code: 503, status: , message: ",
},
{
name: "413 Request Entity Too Large",
httpCode: http.StatusRequestEntityTooLarge,
contentType: "text/html",
body: bytes.NewReader([]byte(`<html>
<head><title>413 Request Entity Too Large</title></head>
<body>
<center><h1>413 Request Entity Too Large</h1></center>
<hr><center>nginx</center>
</body>
</html>`)),
expected: `error, status code: 413, status: , body: <html>
<head><title>413 Request Entity Too Large</title></head>
<body>
<center><h1>413 Request Entity Too Large</h1></center>
<hr><center>nginx</center>
</body>
</html>`,
},
{
name: "errorReader",
httpCode: http.StatusRequestEntityTooLarge,
contentType: "text/html",
body: &errorReader{err: errors.New("errorReader")},
expected: "error, reading response body: errorReader",
}, },
} }
for _, tc := range testCases { for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) { t.Run(tc.name, func(t *testing.T) {
testCase := &http.Response{} testCase := &http.Response{
Header: map[string][]string{
"Content-Type": {tc.contentType},
},
}
testCase.StatusCode = tc.httpCode testCase.StatusCode = tc.httpCode
testCase.Body = io.NopCloser(tc.body) testCase.Body = io.NopCloser(tc.body)
err := client.handleErrorResp(testCase) err := client.handleErrorResp(testCase)
@@ -203,12 +239,6 @@ func TestHandleErrorResp(t *testing.T) {
t.Errorf("Unexpected error: %v , expected: %s", err, tc.expected) t.Errorf("Unexpected error: %v , expected: %s", err, tc.expected)
t.Fail() t.Fail()
} }
e := &APIError{}
if !errors.As(err, &e) {
t.Errorf("(%s) Expected error to be of type APIError", tc.name)
t.Fail()
}
}) })
} }
} }

6
error.go
View File

@@ -13,6 +13,7 @@ type APIError struct {
Message string `json:"message"` Message string `json:"message"`
Param *string `json:"param,omitempty"` Param *string `json:"param,omitempty"`
Type string `json:"type"` Type string `json:"type"`
HTTPStatus string `json:"-"`
HTTPStatusCode int `json:"-"` HTTPStatusCode int `json:"-"`
InnerError *InnerError `json:"innererror,omitempty"` InnerError *InnerError `json:"innererror,omitempty"`
} }
@@ -25,6 +26,7 @@ type InnerError struct {
// RequestError provides information about generic request errors. // RequestError provides information about generic request errors.
type RequestError struct { type RequestError struct {
HTTPStatus string
HTTPStatusCode int HTTPStatusCode int
Err error Err error
} }
@@ -35,7 +37,7 @@ type ErrorResponse struct {
func (e *APIError) Error() string { func (e *APIError) Error() string {
if e.HTTPStatusCode > 0 { if e.HTTPStatusCode > 0 {
return fmt.Sprintf("error, status code: %d, message: %s", e.HTTPStatusCode, e.Message) return fmt.Sprintf("error, status code: %d, status: %s, message: %s", e.HTTPStatusCode, e.HTTPStatus, e.Message)
} }
return e.Message return e.Message
@@ -101,7 +103,7 @@ func (e *APIError) UnmarshalJSON(data []byte) (err error) {
} }
func (e *RequestError) Error() string { func (e *RequestError) Error() string {
return fmt.Sprintf("error, status code: %d, message: %s", e.HTTPStatusCode, e.Err) return fmt.Sprintf("error, status code: %d, status: %s, message: %s", e.HTTPStatusCode, e.HTTPStatus, e.Err)
} }
func (e *RequestError) Unwrap() error { func (e *RequestError) Unwrap() error {

1
files_api_test.go
View File

@@ -152,6 +152,7 @@ func TestGetFileContentReturnError(t *testing.T) {
client, server, teardown := setupOpenAITestServer() client, server, teardown := setupOpenAITestServer()
defer teardown() defer teardown()
server.RegisterHandler("/v1/files/deadbeef/content", func(w http.ResponseWriter, _ *http.Request) { server.RegisterHandler("/v1/files/deadbeef/content", func(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusBadRequest) w.WriteHeader(http.StatusBadRequest)
fmt.Fprint(w, wantErrorResp) fmt.Fprint(w, wantErrorResp)
}) })