Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

send back HTTP 400 where there is a client error #1131

Merged
merged 4 commits into from Jul 4, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 36 additions & 5 deletions pkg/apiutil/apiutil.go
Expand Up @@ -21,19 +21,50 @@ import (
"github.com/juju/errors"
)

// ReadJSON reads a JSON data from r and then close it.
func ReadJSON(r io.ReadCloser, data interface{}) error {
defer r.Close()
// DeferClose captures the error returned from closing (if an error occurs).
// This is designed to be used in a defer statement.
func DeferClose(c io.Closer, err *error) {
if cerr := c.Close(); cerr != nil && *err == nil {
*err = errors.Trace(cerr)
}
}

// JSONError lets callers check for just one error type
type JSONError struct {
err error
}

func (e JSONError) Error() string {
return e.err.Error()
}

// Cause for compatibility with the errors package
func (e JSONError) Cause() error {
return e.err
}

func tagJSONError(err error) error {
switch err.(type) {
case *json.SyntaxError, *json.UnmarshalTypeError:
return JSONError{err}
}
return err
}

// ReadJSON reads a JSON data from r and then closes it.
// An error due to invalid json will be returned as a JSONError
func ReadJSON(r io.ReadCloser, data interface{}) error {
var err error
defer DeferClose(r, &err)
b, err := ioutil.ReadAll(r)
if err != nil {
return errors.Trace(err)
}

err = json.Unmarshal(b, data)
if err != nil {
return errors.Trace(err)
return tagJSONError(err)
}

return nil
return err
}
2 changes: 1 addition & 1 deletion server/api/admin.go
Expand Up @@ -45,7 +45,7 @@ func (h *adminHandler) HandleDropCacheRegion(w http.ResponseWriter, r *http.Requ
regionIDStr := vars["id"]
regionID, err := strconv.ParseUint(regionIDStr, 10, 64)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
h.rd.JSON(w, http.StatusBadRequest, err.Error())
return
}
cluster.DropCacheRegion(regionID)
Expand Down
23 changes: 8 additions & 15 deletions server/api/config.go
Expand Up @@ -74,9 +74,7 @@ func (h *confHandler) GetSchedule(w http.ResponseWriter, r *http.Request) {

func (h *confHandler) SetSchedule(w http.ResponseWriter, r *http.Request) {
config := h.svr.GetScheduleConfig()
err := readJSON(r.Body, config)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
if err := readJSONRespondError(h.rd, w, r.Body, &config); err != nil {
return
}

Expand All @@ -93,9 +91,7 @@ func (h *confHandler) GetReplication(w http.ResponseWriter, r *http.Request) {

func (h *confHandler) SetReplication(w http.ResponseWriter, r *http.Request) {
config := h.svr.GetReplicationConfig()
err := readJSON(r.Body, config)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
if err := readJSONRespondError(h.rd, w, r.Body, &config); err != nil {
return
}

Expand All @@ -108,7 +104,7 @@ func (h *confHandler) GetNamespace(w http.ResponseWriter, r *http.Request) {
name := vars["name"]

if !h.svr.IsNamespaceExist(name) {
h.rd.JSON(w, http.StatusInternalServerError, fmt.Sprintf("invalid namespace Name %s, not found", name))
h.rd.JSON(w, http.StatusNotFound, fmt.Sprintf("invalid namespace Name %s, not found", name))
return
}

Expand All @@ -122,14 +118,12 @@ func (h *confHandler) SetNamespace(w http.ResponseWriter, r *http.Request) {
name := vars["name"]

if !h.svr.IsNamespaceExist(name) {
h.rd.JSON(w, http.StatusInternalServerError, fmt.Sprintf("invalid namespace Name %s, not found", name))
h.rd.JSON(w, http.StatusNotFound, fmt.Sprintf("invalid namespace Name %s, not found", name))
return
}

config := h.svr.GetNamespaceConfig(name)
err := readJSON(r.Body, config)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
if err := readJSONRespondError(h.rd, w, r.Body, &config); err != nil {
return
}

Expand All @@ -142,7 +136,7 @@ func (h *confHandler) DeleteNamespace(w http.ResponseWriter, r *http.Request) {
name := vars["name"]

if !h.svr.IsNamespaceExist(name) {
h.rd.JSON(w, http.StatusInternalServerError, fmt.Sprintf("invalid namespace Name %s, not found", name))
h.rd.JSON(w, http.StatusNotFound, fmt.Sprintf("invalid namespace Name %s, not found", name))
return
}
h.svr.DeleteNamespaceConfig(name)
Expand All @@ -156,11 +150,10 @@ func (h *confHandler) GetLabelProperty(w http.ResponseWriter, r *http.Request) {

func (h *confHandler) SetLabelProperty(w http.ResponseWriter, r *http.Request) {
input := make(map[string]string)
err := readJSON(r.Body, &input)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
if err := readJSONRespondError(h.rd, w, r.Body, &input); err != nil {
return
}
var err error
switch input["action"] {
case "set":
err = h.svr.SetLabelProperty(input["type"], input["label-key"], input["label-value"])
Expand Down
2 changes: 1 addition & 1 deletion server/api/log.go
Expand Up @@ -46,7 +46,7 @@ func (h *logHandler) Handle(w http.ResponseWriter, r *http.Request) {
}
err = json.Unmarshal(data, &level)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
h.rd.JSON(w, http.StatusBadRequest, err.Error())
return
}

Expand Down
13 changes: 6 additions & 7 deletions server/api/member.go
Expand Up @@ -96,7 +96,7 @@ func (h *memberHandler) DeleteByID(w http.ResponseWriter, r *http.Request) {
idStr := mux.Vars(r)["id"]
id, err := strconv.ParseUint(idStr, 10, 64)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
h.rd.JSON(w, http.StatusBadRequest, err.Error())
return
}

Expand All @@ -117,9 +117,9 @@ func (h *memberHandler) DeleteByID(w http.ResponseWriter, r *http.Request) {
}

func (h *memberHandler) SetMemberPropertyByName(w http.ResponseWriter, r *http.Request) {
members, err := h.listMembers()
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
members, membersErr := h.listMembers()
if membersErr != nil {
h.rd.JSON(w, http.StatusInternalServerError, membersErr.Error())
return
}

Expand All @@ -137,8 +137,7 @@ func (h *memberHandler) SetMemberPropertyByName(w http.ResponseWriter, r *http.R
}

var input map[string]interface{}
if err = readJSON(r.Body, &input); err != nil {
h.rd.JSON(w, http.StatusBadRequest, err.Error())
if err := readJSONRespondError(h.rd, w, r.Body, &input); err != nil {
return
}
for k, v := range input {
Expand All @@ -149,7 +148,7 @@ func (h *memberHandler) SetMemberPropertyByName(w http.ResponseWriter, r *http.R
h.rd.JSON(w, http.StatusBadRequest, "bad format leader priority")
return
}
err = h.svr.SetMemberLeaderPriority(memberID, int(priority))
err := h.svr.SetMemberLeaderPriority(memberID, int(priority))
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
return
Expand Down
9 changes: 4 additions & 5 deletions server/api/operator.go
Expand Up @@ -40,7 +40,7 @@ func (h *operatorHandler) Get(w http.ResponseWriter, r *http.Request) {

regionID, err := strconv.ParseUint(id, 10, 64)
if err != nil {
h.r.JSON(w, http.StatusInternalServerError, err.Error())
h.r.JSON(w, http.StatusBadRequest, err.Error())
return
}

Expand Down Expand Up @@ -90,14 +90,13 @@ func (h *operatorHandler) List(w http.ResponseWriter, r *http.Request) {

func (h *operatorHandler) Post(w http.ResponseWriter, r *http.Request) {
var input map[string]interface{}
if err := readJSON(r.Body, &input); err != nil {
h.r.JSON(w, http.StatusInternalServerError, err.Error())
if err := readJSONRespondError(h.r, w, r.Body, &input); err != nil {
return
}

name, ok := input["name"].(string)
if !ok {
h.r.JSON(w, http.StatusInternalServerError, "missing operator name")
h.r.JSON(w, http.StatusBadRequest, "missing operator name")
return
}

Expand Down Expand Up @@ -234,7 +233,7 @@ func (h *operatorHandler) Delete(w http.ResponseWriter, r *http.Request) {

regionID, err := strconv.ParseUint(id, 10, 64)
if err != nil {
h.r.JSON(w, http.StatusInternalServerError, err.Error())
h.r.JSON(w, http.StatusBadRequest, err.Error())
return
}

Expand Down
6 changes: 3 additions & 3 deletions server/api/region.go
Expand Up @@ -92,7 +92,7 @@ func (h *regionHandler) GetRegionByID(w http.ResponseWriter, r *http.Request) {
regionIDStr := vars["id"]
regionID, err := strconv.ParseUint(regionIDStr, 10, 64)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
h.rd.JSON(w, http.StatusBadRequest, err.Error())
return
}

Expand Down Expand Up @@ -203,12 +203,12 @@ func (h *regionsHandler) GetRegionSiblings(w http.ResponseWriter, r *http.Reques
vars := mux.Vars(r)
id, err := strconv.Atoi(vars["id"])
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
h.rd.JSON(w, http.StatusBadRequest, err.Error())
return
}
region := cluster.GetRegionInfoByID(uint64(id))
if region == nil {
h.rd.JSON(w, http.StatusInternalServerError, server.ErrRegionNotFound(uint64(id)).Error())
h.rd.JSON(w, http.StatusNotFound, server.ErrRegionNotFound(uint64(id)).Error())
return
}

Expand Down
3 changes: 1 addition & 2 deletions server/api/scheduler.go
Expand Up @@ -44,8 +44,7 @@ func (h *schedulerHandler) List(w http.ResponseWriter, r *http.Request) {

func (h *schedulerHandler) Post(w http.ResponseWriter, r *http.Request) {
var input map[string]interface{}
if err := readJSON(r.Body, &input); err != nil {
h.r.JSON(w, http.StatusInternalServerError, err.Error())
if err := readJSONRespondError(h.r, w, r.Body, &input); err != nil {
return
}

Expand Down
16 changes: 7 additions & 9 deletions server/api/store.go
Expand Up @@ -141,7 +141,7 @@ func (h *storeHandler) Get(w http.ResponseWriter, r *http.Request) {
storeIDStr := vars["id"]
storeID, err := strconv.ParseUint(storeIDStr, 10, 64)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
h.rd.JSON(w, http.StatusBadRequest, err.Error())
return
}

Expand All @@ -166,7 +166,7 @@ func (h *storeHandler) Delete(w http.ResponseWriter, r *http.Request) {
storeIDStr := vars["id"]
storeID, err := strconv.ParseUint(storeIDStr, 10, 64)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
h.rd.JSON(w, http.StatusBadRequest, err.Error())
return
}

Expand Down Expand Up @@ -196,7 +196,7 @@ func (h *storeHandler) SetState(w http.ResponseWriter, r *http.Request) {
storeIDStr := vars["id"]
storeID, err := strconv.ParseUint(storeIDStr, 10, 64)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
h.rd.JSON(w, http.StatusBadRequest, err.Error())
return
}

Expand Down Expand Up @@ -227,13 +227,12 @@ func (h *storeHandler) SetLabels(w http.ResponseWriter, r *http.Request) {
storeIDStr := vars["id"]
storeID, err := strconv.ParseUint(storeIDStr, 10, 64)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
h.rd.JSON(w, http.StatusBadRequest, err.Error())
return
}

var input map[string]string
if err := readJSON(r.Body, &input); err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
if err := readJSONRespondError(h.rd, w, r.Body, &input); err != nil {
return
}

Expand Down Expand Up @@ -264,13 +263,12 @@ func (h *storeHandler) SetWeight(w http.ResponseWriter, r *http.Request) {
storeIDStr := vars["id"]
storeID, err := strconv.ParseUint(storeIDStr, 10, 64)
if err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
h.rd.JSON(w, http.StatusBadRequest, err.Error())
return
}

var input map[string]interface{}
if err := readJSON(r.Body, &input); err != nil {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
if err := readJSONRespondError(h.rd, w, r.Body, &input); err != nil {
return
}

Expand Down
16 changes: 16 additions & 0 deletions server/api/util.go
Expand Up @@ -21,9 +21,25 @@ import (
"net/http"

"github.com/juju/errors"
"github.com/pingcap/pd/pkg/apiutil"
"github.com/pingcap/pd/server"
"github.com/unrolled/render"
)

func readJSONRespondError(r *render.Render, w http.ResponseWriter, body io.ReadCloser, data interface{}) error {
err := apiutil.ReadJSON(body, data)
if err == nil {
return nil
}
switch err.(type) {
case apiutil.JSONError:
r.JSON(w, http.StatusBadRequest, err.Error())
default:
r.JSON(w, http.StatusInternalServerError, err.Error())
}
return err
}

func readJSON(r io.ReadCloser, data interface{}) error {
defer r.Close()

Expand Down