clean error handling

error.go

@@ -33,17 +33,21 @@ func init() {
 
 }
 
-type jsonError struct {
+type etcdError struct {
 	ErrorCode int    `json:"errorCode"`
 	Message   string `json:"message"`
 	Cause     string `json:"cause,omitempty"`
 }
 
-func newJsonError(errorCode int, cause string) []byte {
+func newEtcdError(errorCode int, cause string) *etcdError {
-	b, _ := json.Marshal(jsonError{
+	return &etcdError{
 		ErrorCode: errorCode,
 		Message:   errors[errorCode],
 		Cause:     cause,
-	})
+	}
+}
+
+func (e *etcdError) toJson() []byte {
+	b, _ := json.Marshal(e)
 	return b
 }

etcd_handlers.go

@@ -16,29 +16,42 @@ import (
 func NewEtcdMuxer() *http.ServeMux {
 	// external commands
 	etcdMux := http.NewServeMux()
-	etcdMux.HandleFunc("/"+version+"/keys/", Multiplexer)
+	etcdMux.Handle("/"+version+"/keys/", etcdHandler(Multiplexer))
-	etcdMux.HandleFunc("/"+version+"/watch/", WatchHttpHandler)
+	etcdMux.Handle("/"+version+"/watch/", etcdHandler(WatchHttpHandler))
-	etcdMux.HandleFunc("/leader", LeaderHttpHandler)
+	etcdMux.Handle("/leader", etcdHandler(LeaderHttpHandler))
-	etcdMux.HandleFunc("/machines", MachinesHttpHandler)
+	etcdMux.Handle("/machines", etcdHandler(MachinesHttpHandler))
-	etcdMux.HandleFunc("/version", VersionHttpHandler)
+	etcdMux.Handle("/version", etcdHandler(VersionHttpHandler))
-	etcdMux.HandleFunc("/stats", StatsHttpHandler)
+	etcdMux.Handle("/stats", etcdHandler(StatsHttpHandler))
 	etcdMux.HandleFunc("/test/", TestHttpHandler)
 	return etcdMux
 }
 
+type etcdHandler func(http.ResponseWriter, *http.Request) *etcdError
+
+func (fn etcdHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	if e := fn(w, r); e != nil {
+		// 3xx is reft internal error
+		if e.ErrorCode/100 == 3 {
+			http.Error(w, string(e.toJson()), http.StatusInternalServerError)
+		} else {
+			http.Error(w, string(e.toJson()), http.StatusBadRequest)
+		}
+	}
+}
+
 // Multiplex GET/POST/DELETE request to corresponding handlers
-func Multiplexer(w http.ResponseWriter, req *http.Request) {
+func Multiplexer(w http.ResponseWriter, req *http.Request) *etcdError {
 
 	switch req.Method {
 	case "GET":
-		GetHttpHandler(&w, req)
+		return GetHttpHandler(w, req)
 	case "POST":
-		SetHttpHandler(&w, req)
+		return SetHttpHandler(w, req)
 	case "DELETE":
-		DeleteHttpHandler(&w, req)
+		return DeleteHttpHandler(w, req)
 	default:
 		w.WriteHeader(http.StatusMethodNotAllowed)
-		return
+		return nil
 	}
 }
 
@@ -48,15 +61,11 @@ func Multiplexer(w http.ResponseWriter, req *http.Request) {
 //--------------------------------------
 
 // Set Command Handler
-func SetHttpHandler(w *http.ResponseWriter, req *http.Request) {
+func SetHttpHandler(w http.ResponseWriter, req *http.Request) *etcdError {
 	key := req.URL.Path[len("/v1/keys/"):]
 
 	if store.CheckKeyword(key) {
-
+		return newEtcdError(400, "Set")
-		(*w).WriteHeader(http.StatusBadRequest)
-
-		(*w).Write(newJsonError(400, "Set"))
-		return
 	}
 
 	debugf("[recv] POST %v/v1/keys/%s [%s]", e.url, key, req.RemoteAddr)
@@ -64,10 +73,7 @@ func SetHttpHandler(w *http.ResponseWriter, req *http.Request) {
 	value := req.FormValue("value")
 
 	if len(value) == 0 {
-		(*w).WriteHeader(http.StatusBadRequest)
+		return newEtcdError(200, "Set")
-
-		(*w).Write(newJsonError(200, "Set"))
-		return
 	}
 
 	prevValue := req.FormValue("prevValue")
@@ -77,11 +83,7 @@ func SetHttpHandler(w *http.ResponseWriter, req *http.Request) {
 	expireTime, err := durationToExpireTime(strDuration)
 
 	if err != nil {
-
+		return newEtcdError(202, "Set")
-		(*w).WriteHeader(http.StatusBadRequest)
-
-		(*w).Write(newJsonError(202, "Set"))
-		return
 	}
 
 	if len(prevValue) != 0 {
@@ -92,7 +94,7 @@ func SetHttpHandler(w *http.ResponseWriter, req *http.Request) {
 			ExpireTime: expireTime,
 		}
 
-		dispatch(command, w, req, true)
+		return dispatch(command, w, req, true)
 
 	} else {
 		command := &SetCommand{
@@ -101,13 +103,12 @@ func SetHttpHandler(w *http.ResponseWriter, req *http.Request) {
 			ExpireTime: expireTime,
 		}
 
-		dispatch(command, w, req, true)
+		return dispatch(command, w, req, true)
 	}
-
 }
 
 // Delete Handler
-func DeleteHttpHandler(w *http.ResponseWriter, req *http.Request) {
+func DeleteHttpHandler(w http.ResponseWriter, req *http.Request) *etcdError {
 	key := req.URL.Path[len("/v1/keys/"):]
 
 	debugf("[recv] DELETE %v/v1/keys/%s [%s]", e.url, key, req.RemoteAddr)
@@ -116,76 +117,61 @@ func DeleteHttpHandler(w *http.ResponseWriter, req *http.Request) {
 		Key: key,
 	}
 
-	dispatch(command, w, req, true)
+	return dispatch(command, w, req, true)
 }
 
 // Dispatch the command to leader
-func dispatch(c Command, w *http.ResponseWriter, req *http.Request, etcd bool) {
+func dispatch(c Command, w http.ResponseWriter, req *http.Request, etcd bool) *etcdError {
 
 	if r.State() == raft.Leader {
 		if body, err := r.Do(c); err != nil {
 
+			// store error
 			if _, ok := err.(store.NotFoundError); ok {
-				(*w).WriteHeader(http.StatusNotFound)
+				return newEtcdError(100, err.Error())
-				(*w).Write(newJsonError(100, err.Error()))
-				return
 			}
 
 			if _, ok := err.(store.TestFail); ok {
-				(*w).WriteHeader(http.StatusBadRequest)
+				return newEtcdError(101, err.Error())
-				(*w).Write(newJsonError(101, err.Error()))
-				return
 			}
 
 			if _, ok := err.(store.NotFile); ok {
-				(*w).WriteHeader(http.StatusBadRequest)
+				return newEtcdError(102, err.Error())
-				(*w).Write(newJsonError(102, err.Error()))
-				return
 			}
-			if err.Error() == errors[103] {
-				(*w).WriteHeader(http.StatusBadRequest)
-				(*w).Write(newJsonError(103, ""))
-				return
-			}
-			(*w).WriteHeader(http.StatusInternalServerError)
-			(*w).Write(newJsonError(300, err.Error()))
-			return
-		} else {
 
-			if body == nil {
+			// join error
-				(*w).WriteHeader(http.StatusNotFound)
+			if err.Error() == errors[103] {
-				(*w).Write(newJsonError(300, "Empty result from raft"))
+				return newEtcdError(103, "")
-			} else {
+			}
-				body, ok := body.([]byte)
+
-				// this should not happen
+			// raft internal error
-				if !ok {
+			return newEtcdError(300, err.Error())
-					panic("wrong type")
+
-				}
+		} else {
-				(*w).WriteHeader(http.StatusOK)
+			if body == nil {
-				(*w).Write(body)
+				return newEtcdError(300, "Empty result from raft")
+			} else {
+				body, _ := body.([]byte)
+				w.WriteHeader(http.StatusOK)
+				w.Write(body)
+				return nil
 			}
-			return
 		}
+
 	} else {
 		leader := r.Leader()
 		// current no leader
 		if leader == "" {
-			(*w).WriteHeader(http.StatusInternalServerError)
+			return newEtcdError(300, "")
-			(*w).Write(newJsonError(300, ""))
-			return
 		}
 
 		// tell the client where is the leader
-
 		path := req.URL.Path
 
 		var url string
 
 		if etcd {
 			etcdAddr, _ := nameToEtcdURL(leader)
-			if etcdAddr == "" {
-				panic(leader)
-			}
 			url = etcdAddr + path
 		} else {
 			raftAddr, _ := nameToRaftURL(leader)
@@ -194,12 +180,10 @@ func dispatch(c Command, w *http.ResponseWriter, req *http.Request, etcd bool) {
 
 		debugf("Redirect to %s", url)
 
-		http.Redirect(*w, req, url, http.StatusTemporaryRedirect)
+		http.Redirect(w, req, url, http.StatusTemporaryRedirect)
-		return
+		return nil
 	}
-	(*w).WriteHeader(http.StatusInternalServerError)
+	return newEtcdError(300, "")
-	(*w).Write(newJsonError(300, ""))
-	return
 }
 
 //--------------------------------------
@@ -210,44 +194,45 @@ func dispatch(c Command, w *http.ResponseWriter, req *http.Request, etcd bool) {
 //--------------------------------------
 
 // Handler to return the current leader's raft address
-func LeaderHttpHandler(w http.ResponseWriter, req *http.Request) {
+func LeaderHttpHandler(w http.ResponseWriter, req *http.Request) *etcdError {
 	leader := r.Leader()
 
 	if leader != "" {
 		w.WriteHeader(http.StatusOK)
 		raftURL, _ := nameToRaftURL(leader)
 		w.Write([]byte(raftURL))
+		return nil
 	} else {
-
+		return newEtcdError(301, "")
-		// not likely, but it may happen
-		w.WriteHeader(http.StatusInternalServerError)
-		w.Write(newJsonError(301, ""))
 	}
 }
 
 // Handler to return all the known machines in the current cluster
-func MachinesHttpHandler(w http.ResponseWriter, req *http.Request) {
+func MachinesHttpHandler(w http.ResponseWriter, req *http.Request) *etcdError {
 	machines := getMachines()
 
 	w.WriteHeader(http.StatusOK)
 	w.Write([]byte(strings.Join(machines, ", ")))
+	return nil
 }
 
 // Handler to return the current version of etcd
-func VersionHttpHandler(w http.ResponseWriter, req *http.Request) {
+func VersionHttpHandler(w http.ResponseWriter, req *http.Request) *etcdError {
 	w.WriteHeader(http.StatusOK)
-	w.Write([]byte(fmt.Sprintf("etcd %s", releaseVersion)))
+	fmt.Fprintf(w, "etcd %s", releaseVersion)
-	w.Write([]byte(fmt.Sprintf("etcd API %s", version)))
+	fmt.Fprintf(w, "etcd API %s", version)
+	return nil
 }
 
 // Handler to return the basic stats of etcd
-func StatsHttpHandler(w http.ResponseWriter, req *http.Request) {
+func StatsHttpHandler(w http.ResponseWriter, req *http.Request) *etcdError {
 	w.WriteHeader(http.StatusOK)
 	w.Write(etcdStore.Stats())
+	return nil
 }
 
 // Get Handler
-func GetHttpHandler(w *http.ResponseWriter, req *http.Request) {
+func GetHttpHandler(w http.ResponseWriter, req *http.Request) *etcdError {
 	key := req.URL.Path[len("/v1/keys/"):]
 
 	debugf("[recv] GET %s/v1/keys/%s [%s]", e.url, key, req.RemoteAddr)
@@ -259,29 +244,23 @@ func GetHttpHandler(w *http.ResponseWriter, req *http.Request) {
 	if body, err := command.Apply(r.Server); err != nil {
 
 		if _, ok := err.(store.NotFoundError); ok {
-			(*w).WriteHeader(http.StatusNotFound)
+			return newEtcdError(100, err.Error())
-			(*w).Write(newJsonError(100, err.Error()))
-			return
 		}
 
-		(*w).WriteHeader(http.StatusInternalServerError)
+		return newEtcdError(300, "")
-		(*w).Write(newJsonError(300, ""))
 
 	} else {
-		body, ok := body.([]byte)
+		body, _ := body.([]byte)
-		if !ok {
+		w.WriteHeader(http.StatusOK)
-			panic("wrong type")
+		w.Write(body)
-		}
-
-		(*w).WriteHeader(http.StatusOK)
-		(*w).Write(body)
 
+		return nil
 	}
 
 }
 
 // Watch handler
-func WatchHttpHandler(w http.ResponseWriter, req *http.Request) {
+func WatchHttpHandler(w http.ResponseWriter, req *http.Request) *etcdError {
 	key := req.URL.Path[len("/v1/watch/"):]
 
 	command := &WatchCommand{
@@ -300,28 +279,23 @@ func WatchHttpHandler(w http.ResponseWriter, req *http.Request) {
 
 		sinceIndex, err := strconv.ParseUint(string(content), 10, 64)
 		if err != nil {
-			w.WriteHeader(http.StatusBadRequest)
+			return newEtcdError(203, "Watch From Index")
-			w.Write(newJsonError(203, "Watch From Index"))
 		}
 		command.SinceIndex = sinceIndex
 
 	} else {
 		w.WriteHeader(http.StatusMethodNotAllowed)
-		return
+		return nil
 	}
 
 	if body, err := command.Apply(r.Server); err != nil {
-		w.WriteHeader(http.StatusInternalServerError)
+		return newEtcdError(500, key)
-		w.Write(newJsonError(500, key))
 	} else {
 		w.WriteHeader(http.StatusOK)
 
-		body, ok := body.([]byte)
+		body, _ := body.([]byte)
-		if !ok {
-			panic("wrong type")
-		}
-
 		w.Write(body)
+		return nil
 	}
 
 }

raft_handlers.go

@@ -100,7 +100,7 @@ func JoinHttpHandler(w http.ResponseWriter, req *http.Request) {
 
 	if err := decodeJsonRequest(req, command); err == nil {
 		debugf("Receive Join Request from %s", command.Name)
-		dispatch(command, &w, req, false)
+		dispatch(command, w, req, false)
 	} else {
 		w.WriteHeader(http.StatusInternalServerError)
 		return