mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-08-01 13:33:48 +08:00
8fc20dd9ca
### Summary Aligns Go and Python error codes/messages so both backends honor the same RESTful API contract, removing implementation-specific error leaks (MySQL errors, `ValueError`, `AttributeError`, Gin validator format) in favor of clean business error codes. **Chat list** — invalid `orderby` now returns code 101 (was: raw Python `AttributeError` code 100); invalid `page`/`page_size` values fall back to defaults (was: raw `ValueError`/`ProgrammingError` code 100). **Dataset create/update/delete** — adds UUID validation (101), extra-field rejection (101), duplicate-id detection (101), content-type / JSON-syntax / object-shape checks (101), and "lacks permission" for nonexistent datasets (IDOR). Create auto-deduplicates dataset names. Pagerank updates tolerate a missing ES index. List response includes `parser_config` and `pagerank`. **Session list/update** — adds filtering, sorting, and pagination support. Empty payloads are valid no-ops. Authorization errors map to code 109. **Chunk list** — doc object uses Python key names (`chunk_count`, `dataset_id`, `chunk_method`, run text status). Add validates list element types. **Document update** — adds `chunk_method` alias, pydantic-style Field error messages, metadata index auto-create with refresh, and "These documents do not belong to dataset" messages. List validates `metadata_condition` and reports ownership errors for unmatched name/id filters. **Search completion** — `kb_ids` ownership failure returns code 102 instead of 109. Released 31 contract tests from `GO_ONLY_SKIPS` (all verified passing on both Go and Python backends with real LLM keys).
117 lines
4.3 KiB
Go
117 lines
4.3 KiB
Go
//
|
|
// Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
package common
|
|
|
|
import "errors"
|
|
|
|
type ErrorCode int
|
|
|
|
const (
|
|
CodeSuccess ErrorCode = 0
|
|
CodeLackResources ErrorCode = 1
|
|
CodeNotEffective ErrorCode = 10
|
|
CodeExceptionError ErrorCode = 100
|
|
CodeArgumentError ErrorCode = 101
|
|
CodeDataError ErrorCode = 102
|
|
CodeOperatingError ErrorCode = 103
|
|
CodeTimeoutError ErrorCode = 104
|
|
CodeConnectionError ErrorCode = 105
|
|
CodeRunning ErrorCode = 106
|
|
CodeResourceExhausted ErrorCode = 107
|
|
CodePermissionError ErrorCode = 108
|
|
CodeAuthenticationError ErrorCode = 109
|
|
CodeParamError ErrorCode = 110
|
|
CodeConnectionPoolExhausted ErrorCode = 111
|
|
CodeLicenseValid ErrorCode = 320
|
|
CodeLicenseInactiveError ErrorCode = 321
|
|
CodeLicenseExpiredError ErrorCode = 322
|
|
CodeLicenseDigestError ErrorCode = 323
|
|
CodeLicenseTimeRollback ErrorCode = 324
|
|
CodeLicenseNotFound ErrorCode = 325
|
|
CodeLicenseUnexpectedError ErrorCode = 326
|
|
CodeBadRequest ErrorCode = 400
|
|
CodeUnauthorized ErrorCode = 401
|
|
CodeForbidden ErrorCode = 403
|
|
CodeNotFound ErrorCode = 404
|
|
CodeConflict ErrorCode = 409
|
|
CodeServerError ErrorCode = 500
|
|
CodeNotImplemented ErrorCode = 501
|
|
)
|
|
|
|
var errorMessages = map[ErrorCode]string{
|
|
CodeSuccess: "Success",
|
|
CodeNotEffective: "Not effective",
|
|
CodeExceptionError: "System exception",
|
|
CodeArgumentError: "Invalid argument",
|
|
CodeDataError: "Data error",
|
|
CodeOperatingError: "Operation error",
|
|
CodeTimeoutError: "Timeout",
|
|
CodeConnectionError: "Connection error",
|
|
CodeRunning: "System running",
|
|
CodeResourceExhausted: "Resource exhausted",
|
|
CodePermissionError: "Permission denied",
|
|
CodeAuthenticationError: "Authentication failed",
|
|
CodeParamError: "Invalid parameters",
|
|
CodeConnectionPoolExhausted: "Connection pool exhausted",
|
|
CodeLicenseValid: "License valid",
|
|
CodeLicenseInactiveError: "License inactive",
|
|
CodeLicenseExpiredError: "License expired",
|
|
CodeLicenseDigestError: "License digest error",
|
|
CodeLicenseTimeRollback: "License time rollback detected",
|
|
CodeLicenseNotFound: "License not found",
|
|
CodeLicenseUnexpectedError: "Unexpected license error",
|
|
CodeBadRequest: "Bad request",
|
|
CodeUnauthorized: "Unauthorized",
|
|
CodeForbidden: "Forbidden",
|
|
CodeNotFound: "Resource not found",
|
|
CodeConflict: "Resource conflict",
|
|
CodeServerError: "Internal server error",
|
|
}
|
|
|
|
func (e ErrorCode) Message() string {
|
|
if msg, ok := errorMessages[e]; ok {
|
|
return msg
|
|
}
|
|
return "Unknown error"
|
|
}
|
|
|
|
// CodedError pairs a business ErrorCode with a message so handlers can return
|
|
// the established {code, message} contract (HTTP 200) instead of a generic
|
|
// HTTP 500 for expected domain failures.
|
|
type CodedError struct {
|
|
Code ErrorCode
|
|
Message string
|
|
}
|
|
|
|
func (e *CodedError) Error() string { return e.Message }
|
|
|
|
func NewCodedError(code ErrorCode, message string) *CodedError {
|
|
return &CodedError{Code: code, Message: message}
|
|
}
|
|
|
|
var (
|
|
ErrInvalidToken = errors.New("invalid token")
|
|
ErrNotAdmin = errors.New("user is not admin")
|
|
ErrUserInactive = errors.New("user is inactive")
|
|
ErrUserNotFound = errors.New("user not found")
|
|
// ErrNotFound is returned when an object is not found
|
|
ErrNotFound = errors.New("object not found")
|
|
// ErrBucketNotFound is returned when a bucket is not found
|
|
ErrBucketNotFound = errors.New("bucket not found")
|
|
ErrTaskNotFound = errors.New("task id not found")
|
|
)
|