From 3c53fde7e22885aa9b66bc90356db2b5cf4e09b5 Mon Sep 17 00:00:00 2001 From: Marvin Zhang Date: Sun, 20 Oct 2024 17:22:35 +0800 Subject: [PATCH] refactor: code cleanup --- core/controllers/project_v2.go | 4 ++-- core/controllers/schedule_v2.go | 4 ++-- core/controllers/utils_filter.go | 4 ++-- core/errors/base.go | 23 +++++------------------ core/errors/controller.go | 19 ------------------- core/errors/ds.go | 15 --------------- core/errors/event.go | 10 ---------- core/errors/filter.go | 8 -------- core/errors/fs.go | 11 ----------- core/errors/git.go | 10 ---------- core/errors/grpc.go | 6 ------ core/errors/http.go | 9 --------- core/errors/model.go | 11 ----------- core/errors/node.go | 6 ------ core/errors/process.go | 10 ---------- core/errors/result.go | 5 ----- core/errors/schedule.go | 7 ------- core/errors/spider.go | 10 ---------- core/errors/stats.go | 7 ------- core/errors/store.go | 9 --------- core/errors/task.go | 15 ++++----------- core/errors/user.go | 1 - core/middlewares/auth_v2.go | 4 ++-- core/spider/admin/service_v2.go | 4 ++-- core/utils/filter.go | 4 ++-- 25 files changed, 21 insertions(+), 195 deletions(-) delete mode 100644 core/errors/controller.go delete mode 100644 core/errors/ds.go delete mode 100644 core/errors/event.go delete mode 100644 core/errors/filter.go delete mode 100644 core/errors/fs.go delete mode 100644 core/errors/git.go delete mode 100644 core/errors/http.go delete mode 100644 core/errors/process.go delete mode 100644 core/errors/result.go delete mode 100644 core/errors/schedule.go delete mode 100644 core/errors/spider.go delete mode 100644 core/errors/stats.go delete mode 100644 core/errors/store.go diff --git a/core/controllers/project_v2.go b/core/controllers/project_v2.go index 03396fd5..5da46799 100644 --- a/core/controllers/project_v2.go +++ b/core/controllers/project_v2.go @@ -1,7 +1,7 @@ package controllers import ( - "github.com/crawlab-team/crawlab/core/errors" + "errors" models2 "github.com/crawlab-team/crawlab/core/models/models/v2" "github.com/crawlab-team/crawlab/core/models/service" "github.com/crawlab-team/crawlab/db/mongo" @@ -73,7 +73,7 @@ func GetProjectList(c *gin.Context) { for _, s := range spiders { _, ok := cache[s.ProjectId] if !ok { - HandleErrorInternalServerError(c, errors.ErrorControllerMissingInCache) + HandleErrorInternalServerError(c, errors.New("project id not found")) return } cache[s.ProjectId]++ diff --git a/core/controllers/schedule_v2.go b/core/controllers/schedule_v2.go index 9149f2a1..5be720ac 100644 --- a/core/controllers/schedule_v2.go +++ b/core/controllers/schedule_v2.go @@ -1,7 +1,7 @@ package controllers import ( - "github.com/crawlab-team/crawlab/core/errors" + errors2 "errors" "github.com/crawlab-team/crawlab/core/models/models/v2" "github.com/crawlab-team/crawlab/core/models/service" "github.com/crawlab-team/crawlab/core/schedule" @@ -56,7 +56,7 @@ func PutScheduleById(c *gin.Context) { return } if s.Id != id { - HandleErrorBadRequest(c, errors.ErrorHttpBadRequest) + HandleErrorBadRequest(c, errors2.New("id in path does not match id in body")) return } diff --git a/core/controllers/utils_filter.go b/core/controllers/utils_filter.go index a4fef2d1..aee3129d 100644 --- a/core/controllers/utils_filter.go +++ b/core/controllers/utils_filter.go @@ -2,9 +2,9 @@ package controllers import ( "encoding/json" + errors2 "errors" "github.com/crawlab-team/crawlab/core/constants" "github.com/crawlab-team/crawlab/core/entity" - "github.com/crawlab-team/crawlab/core/errors" "github.com/crawlab-team/crawlab/core/utils" "github.com/crawlab-team/crawlab/db/generic" "github.com/gin-gonic/gin" @@ -111,7 +111,7 @@ func GetFilterAll(c *gin.Context) (res bool, err error) { case "FALSE": return false, nil default: - return false, errors.ErrorFilterInvalidOperation + return false, errors2.New("invalid value") } } diff --git a/core/errors/base.go b/core/errors/base.go index 0acfb681..2a5cdfab 100644 --- a/core/errors/base.go +++ b/core/errors/base.go @@ -6,24 +6,11 @@ import ( ) const ( - ErrorPrefixController = "controller" - ErrorPrefixModel = "model" - ErrorPrefixFilter = "filter" - ErrorPrefixHttp = "http" - ErrorPrefixGrpc = "grpc" - ErrorPrefixNode = "node" - ErrorPrefixInject = "inject" - ErrorPrefixSpider = "spider" - ErrorPrefixFs = "fs" - ErrorPrefixTask = "task" - ErrorPrefixSchedule = "schedule" - ErrorPrefixUser = "user" - ErrorPrefixStats = "stats" - ErrorPrefixEvent = "event" - ErrorPrefixProcess = "process" - ErrorPrefixGit = "git" - ErrorPrefixResult = "result" - ErrorPrefixDataSource = "data_source" + ErrorPrefixModel = "model" + ErrorPrefixGrpc = "grpc" + ErrorPrefixNode = "node" + ErrorPrefixTask = "task" + ErrorPrefixUser = "user" ) type ErrorPrefix string diff --git a/core/errors/controller.go b/core/errors/controller.go deleted file mode 100644 index 7c2f6bff..00000000 --- a/core/errors/controller.go +++ /dev/null @@ -1,19 +0,0 @@ -package errors - -func NewControllerError(msg string) (err error) { - return NewError(ErrorPrefixController, msg) -} - -var ErrorControllerInvalidControllerId = NewControllerError("invalid controller id") -var ErrorControllerInvalidType = NewControllerError("invalid type") -var ErrorControllerAddError = NewControllerError("add error") -var ErrorControllerUpdateError = NewControllerError("update error") -var ErrorControllerDeleteError = NewControllerError("delete error") -var ErrorControllerNotImplemented = NewControllerError("not implemented") -var ErrorControllerNoModelService = NewControllerError("no model service") -var ErrorControllerRequestPayloadInvalid = NewControllerError("request payload invalid") -var ErrorControllerMissingInCache = NewControllerError("missing in cache") -var ErrorControllerNotCancellable = NewControllerError("not cancellable") -var ErrorControllerMissingRequestFields = NewControllerError("missing request fields") -var ErrorControllerEmptyResponse = NewControllerError("empty response") -var ErrorControllerFilerNotFound = NewControllerError("filer not found") diff --git a/core/errors/ds.go b/core/errors/ds.go deleted file mode 100644 index f9550160..00000000 --- a/core/errors/ds.go +++ /dev/null @@ -1,15 +0,0 @@ -package errors - -func NewDataSourceError(msg string) (err error) { - return NewError(ErrorPrefixDataSource, msg) -} - -var ( - ErrorDataSourceInvalidType = NewDataSourceError("invalid type") - ErrorDataSourceNotExists = NewDataSourceError("not exists") - ErrorDataSourceNotExistsInContext = NewDataSourceError("not exists in context") - ErrorDataSourceAlreadyExists = NewDataSourceError("already exists") - ErrorDataSourceMismatch = NewDataSourceError("mismatch") - ErrorDataSourceMissingRequiredFields = NewDataSourceError("missing required fields") - ErrorDataSourceUnauthorized = NewDataSourceError("unauthorized") -) diff --git a/core/errors/event.go b/core/errors/event.go deleted file mode 100644 index 5a528100..00000000 --- a/core/errors/event.go +++ /dev/null @@ -1,10 +0,0 @@ -package errors - -func NewEventError(msg string) (err error) { - return NewError(ErrorPrefixEvent, msg) -} - -var ErrorEventNotFound = NewEventError("not found") -var ErrorEventInvalidType = NewEventError("invalid type") -var ErrorEventAlreadyExists = NewEventError("already exists") -var ErrorEventUnknownAction = NewEventError("unknown action") diff --git a/core/errors/filter.go b/core/errors/filter.go deleted file mode 100644 index 0afaec39..00000000 --- a/core/errors/filter.go +++ /dev/null @@ -1,8 +0,0 @@ -package errors - -func NewFilterError(msg string) (err error) { - return NewError(ErrorPrefixFilter, msg) -} - -var ErrorFilterInvalidOperation = NewFilterError("invalid operation") -var ErrorFilterUnableToParseQuery = NewFilterError("unable to parse query") diff --git a/core/errors/fs.go b/core/errors/fs.go deleted file mode 100644 index 2c91cae2..00000000 --- a/core/errors/fs.go +++ /dev/null @@ -1,11 +0,0 @@ -package errors - -func NewFsError(msg string) (err error) { - return NewError(ErrorPrefixFs, msg) -} - -var ErrorFsForbidden = NewFsError("forbidden") -var ErrorFsEmptyWorkspacePath = NewFsError("empty workspace path") -var ErrorFsInvalidType = NewFsError("invalid type") -var ErrorFsAlreadyExists = NewFsError("already exists") -var ErrorFsInvalidContent = NewFsError("invalid content") diff --git a/core/errors/git.go b/core/errors/git.go deleted file mode 100644 index ea7e03a9..00000000 --- a/core/errors/git.go +++ /dev/null @@ -1,10 +0,0 @@ -package errors - -func NewGitError(msg string) (err error) { - return NewError(ErrorPrefixGit, msg) -} - -var ( - ErrorGitInvalidAuthType = NewGitError("invalid auth type") - ErrorGitNoMainBranch = NewGitError("no main branch") -) diff --git a/core/errors/grpc.go b/core/errors/grpc.go index fbfdabb6..196d5eaf 100644 --- a/core/errors/grpc.go +++ b/core/errors/grpc.go @@ -8,13 +8,7 @@ var ( ErrorGrpcClientFailedToStart = NewGrpcError("client failed to start") ErrorGrpcServerFailedToListen = NewGrpcError("server failed to listen") ErrorGrpcServerFailedToServe = NewGrpcError("server failed to serve") - ErrorGrpcClientNotExists = NewGrpcError("client not exists") - ErrorGrpcClientAlreadyExists = NewGrpcError("client already exists") - ErrorGrpcInvalidType = NewGrpcError("invalid type") ErrorGrpcNotAllowed = NewGrpcError("not allowed") ErrorGrpcSubscribeNotExists = NewGrpcError("subscribe not exists") - ErrorGrpcStreamNotFound = NewGrpcError("stream not found") - ErrorGrpcInvalidCode = NewGrpcError("invalid code") ErrorGrpcUnauthorized = NewGrpcError("unauthorized") - ErrorGrpcInvalidNodeKey = NewGrpcError("invalid node key") ) diff --git a/core/errors/http.go b/core/errors/http.go deleted file mode 100644 index e10ad28f..00000000 --- a/core/errors/http.go +++ /dev/null @@ -1,9 +0,0 @@ -package errors - -func NewHttpError(msg string) (err error) { - return NewError(ErrorPrefixHttp, msg) -} - -var ErrorHttpBadRequest = NewHttpError("bad request") -var ErrorHttpUnauthorized = NewHttpError("unauthorized") -var ErrorHttpNotFound = NewHttpError("not found") diff --git a/core/errors/model.go b/core/errors/model.go index 95baa31e..db591efc 100644 --- a/core/errors/model.go +++ b/core/errors/model.go @@ -1,19 +1,8 @@ package errors -import "errors" - func NewModelError(msg string) (err error) { return NewError(ErrorPrefixModel, msg) } var ErrorModelInvalidType = NewModelError("invalid type") -var ErrorModelInvalidModelId = NewModelError("invalid model id") -var ErrorModelNotImplemented = NewModelError("not implemented") -var ErrorModelNotFound = NewModelError("not found") -var ErrorModelAlreadyExists = NewModelError("already exists") -var ErrorModelNotExists = NewModelError("not exists") var ErrorModelMissingRequiredData = NewModelError("missing required data") -var ErrorModelMissingId = errors.New("missing _id") -var ErrorModelNotAllowed = NewModelError("not allowed") -var ErrorModelDeleteListError = NewModelError("delete list error") -var ErrorModelNilPointer = NewModelError("nil pointer") diff --git a/core/errors/node.go b/core/errors/node.go index e768ca52..1dd98d4c 100644 --- a/core/errors/node.go +++ b/core/errors/node.go @@ -5,10 +5,4 @@ func NewNodeError(msg string) (err error) { } var ErrorNodeUnregistered = NewNodeError("unregistered") -var ErrorNodeServiceNotExists = NewNodeError("service not exists") -var ErrorNodeInvalidType = NewNodeError("invalid type") -var ErrorNodeInvalidStatus = NewNodeError("invalid status") -var ErrorNodeInvalidCode = NewNodeError("invalid code") -var ErrorNodeInvalidNodeKey = NewNodeError("invalid node key") -var ErrorNodeMonitorError = NewNodeError("monitor error") var ErrorNodeNotExists = NewNodeError("not exists") diff --git a/core/errors/process.go b/core/errors/process.go deleted file mode 100644 index aa5580b2..00000000 --- a/core/errors/process.go +++ /dev/null @@ -1,10 +0,0 @@ -package errors - -func NewProcessError(msg string) (err error) { - return NewError(ErrorPrefixProcess, msg) -} - -var ( - ErrorProcessReachedMaxErrors = NewProcessError("reached max errors") - ErrorProcessDaemonProcessExited = NewProcessError("daemon process exited") -) diff --git a/core/errors/result.go b/core/errors/result.go deleted file mode 100644 index 39b1f459..00000000 --- a/core/errors/result.go +++ /dev/null @@ -1,5 +0,0 @@ -package errors - -func NewResultError(msg string) (err error) { - return NewError(ErrorPrefixResult, msg) -} diff --git a/core/errors/schedule.go b/core/errors/schedule.go deleted file mode 100644 index 8246b1be..00000000 --- a/core/errors/schedule.go +++ /dev/null @@ -1,7 +0,0 @@ -package errors - -func NewScheduleError(msg string) (err error) { - return NewError(ErrorPrefixSchedule, msg) -} - -//var ErrorSchedule = NewScheduleError("unregistered") diff --git a/core/errors/spider.go b/core/errors/spider.go deleted file mode 100644 index d7fa5c6a..00000000 --- a/core/errors/spider.go +++ /dev/null @@ -1,10 +0,0 @@ -package errors - -func NewSpiderError(msg string) (err error) { - return NewError(ErrorPrefixSpider, msg) -} - -var ( - ErrorSpiderMissingRequiredOption = NewSpiderError("missing required option") - ErrorSpiderForbidden = NewSpiderError("forbidden") -) diff --git a/core/errors/stats.go b/core/errors/stats.go deleted file mode 100644 index fab5f464..00000000 --- a/core/errors/stats.go +++ /dev/null @@ -1,7 +0,0 @@ -package errors - -func NewStatsError(msg string) (err error) { - return NewError(ErrorPrefixStats, msg) -} - -var ErrorStatsInvalidType = NewStatsError("invalid type") diff --git a/core/errors/store.go b/core/errors/store.go deleted file mode 100644 index ead4fb67..00000000 --- a/core/errors/store.go +++ /dev/null @@ -1,9 +0,0 @@ -package errors - -func NewInjectError(msg string) (err error) { - return NewError(ErrorPrefixInject, msg) -} - -var ErrorInjectEmptyValue = NewInjectError("empty value") -var ErrorInjectNotExists = NewInjectError("not exists") -var ErrorInjectInvalidType = NewInjectError("invalid type") diff --git a/core/errors/task.go b/core/errors/task.go index d4ec41ca..87c1fbc5 100644 --- a/core/errors/task.go +++ b/core/errors/task.go @@ -5,15 +5,8 @@ func NewTaskError(msg string) (err error) { } var ( - ErrorTaskNotExists = NewTaskError("not exists") - ErrorTaskAlreadyExists = NewTaskError("already exists") - ErrorTaskInvalidType = NewTaskError("invalid type") - ErrorTaskProcessStillExists = NewTaskError("process still exists") - ErrorTaskUnableToCancel = NewTaskError("unable to cancel") - ErrorTaskForbidden = NewTaskError("forbidden") - ErrorTaskNoAvailableRunners = NewTaskError("no available runner") - ErrorTaskEmptySpiderId = NewTaskError("empty spider id") - ErrorTaskNoNodeId = NewTaskError("no node id") - ErrorTaskNodeNotFound = NewTaskError("node not found") - ErrorTaskMissingRequiredOption = NewSpiderError("missing required option") + ErrorTaskNotExists = NewTaskError("not exists") + ErrorTaskAlreadyExists = NewTaskError("already exists") + ErrorTaskNoNodeId = NewTaskError("no node id") + ErrorTaskNodeNotFound = NewTaskError("node not found") ) diff --git a/core/errors/user.go b/core/errors/user.go index b0a1e940..2cb2898c 100644 --- a/core/errors/user.go +++ b/core/errors/user.go @@ -8,7 +8,6 @@ var ( ErrorUserInvalidType = NewUserError("invalid type") ErrorUserInvalidToken = NewUserError("invalid token") ErrorUserNotExists = NewUserError("not exists") - ErrorUserNotExistsInContext = NewUserError("not exists in context") ErrorUserAlreadyExists = NewUserError("already exists") ErrorUserMismatch = NewUserError("mismatch") ErrorUserMissingRequiredFields = NewUserError("missing required fields") diff --git a/core/middlewares/auth_v2.go b/core/middlewares/auth_v2.go index d69d4a95..bb19def9 100644 --- a/core/middlewares/auth_v2.go +++ b/core/middlewares/auth_v2.go @@ -1,8 +1,8 @@ package middlewares import ( + "errors" "github.com/crawlab-team/crawlab/core/constants" - "github.com/crawlab-team/crawlab/core/errors" "github.com/crawlab-team/crawlab/core/models/models/v2" "github.com/crawlab-team/crawlab/core/models/service" "github.com/crawlab-team/crawlab/core/user" @@ -34,7 +34,7 @@ func AuthorizationMiddlewareV2() gin.HandlerFunc { u, err := userSvc.CheckToken(tokenStr) if err != nil { // validation failed, return error response - utils.HandleErrorUnauthorized(c, errors.ErrorHttpUnauthorized) + utils.HandleErrorUnauthorized(c, errors.New("invalid token")) return } diff --git a/core/spider/admin/service_v2.go b/core/spider/admin/service_v2.go index 8fcba6c9..ee4046dc 100644 --- a/core/spider/admin/service_v2.go +++ b/core/spider/admin/service_v2.go @@ -1,10 +1,10 @@ package admin import ( + "errors" log2 "github.com/apex/log" config2 "github.com/crawlab-team/crawlab/core/config" "github.com/crawlab-team/crawlab/core/constants" - "github.com/crawlab-team/crawlab/core/errors" "github.com/crawlab-team/crawlab/core/interfaces" models2 "github.com/crawlab-team/crawlab/core/models/models/v2" "github.com/crawlab-team/crawlab/core/models/service" @@ -142,7 +142,7 @@ func newSpiderAdminServiceV2() (svc2 *ServiceV2, err error) { // validate node type if !svc.nodeCfgSvc.IsMaster() { - return nil, trace.TraceError(errors.ErrorSpiderForbidden) + return nil, errors.New("only master node can run spider admin service") } return svc, nil diff --git a/core/utils/filter.go b/core/utils/filter.go index 13911bd3..49e33160 100644 --- a/core/utils/filter.go +++ b/core/utils/filter.go @@ -1,8 +1,8 @@ package utils import ( + errors2 "errors" "github.com/crawlab-team/crawlab/core/constants" - "github.com/crawlab-team/crawlab/core/errors" "github.com/crawlab-team/crawlab/core/interfaces" "go.mongodb.org/mongo-driver/bson" ) @@ -42,7 +42,7 @@ func FilterToQuery(f interfaces.Filter) (q bson.M, err error) { case constants.FilterOpLessThanEqual: q[key] = bson.M{"$lte": value} default: - return nil, errors.ErrorFilterInvalidOperation + return nil, errors2.New("invalid operation") } } return q, nil