error.go 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  1. package types
  2. import (
  3. "errors"
  4. "fmt"
  5. "net/http"
  6. "one-api/common"
  7. "strings"
  8. )
  9. type OpenAIError struct {
  10. Message string `json:"message"`
  11. Type string `json:"type"`
  12. Param string `json:"param"`
  13. Code any `json:"code"`
  14. }
  15. type ClaudeError struct {
  16. Message string `json:"message,omitempty"`
  17. Type string `json:"type,omitempty"`
  18. }
  19. type ErrorType string
  20. const (
  21. ErrorTypeNewAPIError ErrorType = "new_api_error"
  22. ErrorTypeOpenAIError ErrorType = "openai_error"
  23. ErrorTypeClaudeError ErrorType = "claude_error"
  24. ErrorTypeMidjourneyError ErrorType = "midjourney_error"
  25. ErrorTypeGeminiError ErrorType = "gemini_error"
  26. ErrorTypeRerankError ErrorType = "rerank_error"
  27. ErrorTypeUpstreamError ErrorType = "upstream_error"
  28. )
  29. type ErrorCode string
  30. const (
  31. ErrorCodeInvalidRequest ErrorCode = "invalid_request"
  32. ErrorCodeSensitiveWordsDetected ErrorCode = "sensitive_words_detected"
  33. // new api error
  34. ErrorCodeCountTokenFailed ErrorCode = "count_token_failed"
  35. ErrorCodeModelPriceError ErrorCode = "model_price_error"
  36. ErrorCodeInvalidApiType ErrorCode = "invalid_api_type"
  37. ErrorCodeJsonMarshalFailed ErrorCode = "json_marshal_failed"
  38. ErrorCodeDoRequestFailed ErrorCode = "do_request_failed"
  39. ErrorCodeGetChannelFailed ErrorCode = "get_channel_failed"
  40. // channel error
  41. ErrorCodeChannelNoAvailableKey ErrorCode = "channel:no_available_key"
  42. ErrorCodeChannelParamOverrideInvalid ErrorCode = "channel:param_override_invalid"
  43. ErrorCodeChannelModelMappedError ErrorCode = "channel:model_mapped_error"
  44. ErrorCodeChannelAwsClientError ErrorCode = "channel:aws_client_error"
  45. ErrorCodeChannelInvalidKey ErrorCode = "channel:invalid_key"
  46. ErrorCodeChannelResponseTimeExceeded ErrorCode = "channel:response_time_exceeded"
  47. // client request error
  48. ErrorCodeReadRequestBodyFailed ErrorCode = "read_request_body_failed"
  49. ErrorCodeConvertRequestFailed ErrorCode = "convert_request_failed"
  50. ErrorCodeAccessDenied ErrorCode = "access_denied"
  51. // response error
  52. ErrorCodeReadResponseBodyFailed ErrorCode = "read_response_body_failed"
  53. ErrorCodeBadResponseStatusCode ErrorCode = "bad_response_status_code"
  54. ErrorCodeBadResponse ErrorCode = "bad_response"
  55. ErrorCodeBadResponseBody ErrorCode = "bad_response_body"
  56. ErrorCodeEmptyResponse ErrorCode = "empty_response"
  57. // sql error
  58. ErrorCodeQueryDataError ErrorCode = "query_data_error"
  59. ErrorCodeUpdateDataError ErrorCode = "update_data_error"
  60. // quota error
  61. ErrorCodeInsufficientUserQuota ErrorCode = "insufficient_user_quota"
  62. ErrorCodePreConsumeTokenQuotaFailed ErrorCode = "pre_consume_token_quota_failed"
  63. )
  64. type NewAPIError struct {
  65. Err error
  66. RelayError any
  67. errorType ErrorType
  68. errorCode ErrorCode
  69. StatusCode int
  70. }
  71. func (e *NewAPIError) GetErrorCode() ErrorCode {
  72. if e == nil {
  73. return ""
  74. }
  75. return e.errorCode
  76. }
  77. func (e *NewAPIError) GetErrorType() ErrorType {
  78. if e == nil {
  79. return ""
  80. }
  81. return e.errorType
  82. }
  83. func (e *NewAPIError) Error() string {
  84. if e == nil {
  85. return ""
  86. }
  87. if e.Err == nil {
  88. // fallback message when underlying error is missing
  89. return string(e.errorCode)
  90. }
  91. return e.Err.Error()
  92. }
  93. func (e *NewAPIError) MaskSensitiveError() string {
  94. if e == nil {
  95. return ""
  96. }
  97. if e.Err == nil {
  98. return string(e.errorCode)
  99. }
  100. return common.MaskSensitiveInfo(e.Err.Error())
  101. }
  102. func (e *NewAPIError) SetMessage(message string) {
  103. e.Err = errors.New(message)
  104. }
  105. func (e *NewAPIError) ToOpenAIError() OpenAIError {
  106. var result OpenAIError
  107. switch e.errorType {
  108. case ErrorTypeOpenAIError:
  109. if openAIError, ok := e.RelayError.(OpenAIError); ok {
  110. result = openAIError
  111. }
  112. case ErrorTypeClaudeError:
  113. if claudeError, ok := e.RelayError.(ClaudeError); ok {
  114. result = OpenAIError{
  115. Message: e.Error(),
  116. Type: claudeError.Type,
  117. Param: "",
  118. Code: e.errorCode,
  119. }
  120. }
  121. }
  122. result = OpenAIError{
  123. Message: e.Error(),
  124. Type: string(e.errorType),
  125. Param: "",
  126. Code: e.errorCode,
  127. }
  128. result.Message = common.MaskSensitiveInfo(result.Message)
  129. return result
  130. }
  131. func (e *NewAPIError) ToClaudeError() ClaudeError {
  132. var result ClaudeError
  133. switch e.errorType {
  134. case ErrorTypeOpenAIError:
  135. openAIError := e.RelayError.(OpenAIError)
  136. result = ClaudeError{
  137. Message: e.Error(),
  138. Type: fmt.Sprintf("%v", openAIError.Code),
  139. }
  140. case ErrorTypeClaudeError:
  141. result = e.RelayError.(ClaudeError)
  142. default:
  143. result = ClaudeError{
  144. Message: e.Error(),
  145. Type: string(e.errorType),
  146. }
  147. }
  148. result.Message = common.MaskSensitiveInfo(result.Message)
  149. return result
  150. }
  151. func NewError(err error, errorCode ErrorCode) *NewAPIError {
  152. return &NewAPIError{
  153. Err: err,
  154. RelayError: nil,
  155. errorType: ErrorTypeNewAPIError,
  156. StatusCode: http.StatusInternalServerError,
  157. errorCode: errorCode,
  158. }
  159. }
  160. func NewOpenAIError(err error, errorCode ErrorCode, statusCode int) *NewAPIError {
  161. openaiError := OpenAIError{
  162. Message: err.Error(),
  163. Type: string(errorCode),
  164. }
  165. return WithOpenAIError(openaiError, statusCode)
  166. }
  167. func InitOpenAIError(errorCode ErrorCode, statusCode int) *NewAPIError {
  168. openaiError := OpenAIError{
  169. Type: string(errorCode),
  170. }
  171. return WithOpenAIError(openaiError, statusCode)
  172. }
  173. func NewErrorWithStatusCode(err error, errorCode ErrorCode, statusCode int) *NewAPIError {
  174. return &NewAPIError{
  175. Err: err,
  176. RelayError: OpenAIError{
  177. Message: err.Error(),
  178. Type: string(errorCode),
  179. },
  180. errorType: ErrorTypeNewAPIError,
  181. StatusCode: statusCode,
  182. errorCode: errorCode,
  183. }
  184. }
  185. func WithOpenAIError(openAIError OpenAIError, statusCode int) *NewAPIError {
  186. code, ok := openAIError.Code.(string)
  187. if !ok {
  188. code = fmt.Sprintf("%v", openAIError.Code)
  189. }
  190. if openAIError.Type == "" {
  191. openAIError.Type = "upstream_error"
  192. }
  193. return &NewAPIError{
  194. RelayError: openAIError,
  195. errorType: ErrorTypeOpenAIError,
  196. StatusCode: statusCode,
  197. Err: errors.New(openAIError.Message),
  198. errorCode: ErrorCode(code),
  199. }
  200. }
  201. func WithClaudeError(claudeError ClaudeError, statusCode int) *NewAPIError {
  202. if claudeError.Type == "" {
  203. claudeError.Type = "upstream_error"
  204. }
  205. return &NewAPIError{
  206. RelayError: claudeError,
  207. errorType: ErrorTypeClaudeError,
  208. StatusCode: statusCode,
  209. Err: errors.New(claudeError.Message),
  210. errorCode: ErrorCode(claudeError.Type),
  211. }
  212. }
  213. func IsChannelError(err *NewAPIError) bool {
  214. if err == nil {
  215. return false
  216. }
  217. return strings.HasPrefix(string(err.errorCode), "channel:")
  218. }
  219. func IsLocalError(err *NewAPIError) bool {
  220. if err == nil {
  221. return false
  222. }
  223. return err.errorType == ErrorTypeNewAPIError
  224. }