Mirroristas/kaspad
2
0
Fork 0
mirror of https://github.com/kaspanet/kaspad.git synced 2025-03-30 15:08:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

[NOD-325] Enable separate error messages for logging and client (#406)

Browse Source 
* [NOD-325] Enable separate error messages for logging and client

* [NOD-325] Add json annotation to clientError
This commit is contained in:
Ori Newman 2019-09-16 13:26:05 +03:00 committed by stasatdaglabs
parent 502b510ccd
commit 31ccedf136
5 changed files with 45 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apiserver/controllers/block.go
View File

@ -20,7 +20,7 @@ func GetBlockByHashHandler(blockHash string) (interface{}, *utils.HandlerError)
db, err := database.DB()
if err != nil {
return nil, utils.NewHandlerError(http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError))
return nil, utils.NewInternalServerHandlerError(err.Error())
}
block := &models.Block{}

8
apiserver/controllers/transaction.go
View File

@ -23,7 +23,7 @@ func GetTransactionByIDHandler(txID string) (interface{}, *utils.HandlerError) {
db, err := database.DB()
if err != nil {
return nil, utils.NewHandlerError(http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError))
return nil, utils.NewInternalServerHandlerError(err.Error())
}
tx := &models.Transaction{}
@ -44,7 +44,7 @@ func GetTransactionByHashHandler(txHash string) (interface{}, *utils.HandlerErro
db, err := database.DB()
if err != nil {
return nil, utils.NewHandlerError(http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError))
return nil, utils.NewInternalServerHandlerError(err.Error())
}
tx := &models.Transaction{}
@ -66,7 +66,7 @@ func GetTransactionsByAddressHandler(address string, skip uint64, limit uint64)
db, err := database.DB()
if err != nil {
return nil, utils.NewHandlerError(http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError))
return nil, utils.NewInternalServerHandlerError(err.Error())
}
txs := []*models.Transaction{}
@ -93,7 +93,7 @@ func GetTransactionsByAddressHandler(address string, skip uint64, limit uint64)
func GetUTXOsByAddressHandler(address string) (interface{}, *utils.HandlerError) {
db, err := database.DB()
if err != nil {
return nil, utils.NewHandlerError(http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError))
return nil, utils.NewInternalServerHandlerError(err.Error())
}
var transactionOutputs []*models.TransactionOutput

6
apiserver/server/middlewares.go
View File

@ -1,6 +1,7 @@
package server
import (
"fmt"
"github.com/daglabs/btcd/apiserver/utils"
"net/http"
"runtime/debug"
@ -31,9 +32,10 @@ func recoveryMiddleware(h http.Handler) http.Handler {
defer func() {
recoveryErr := recover()
if recoveryErr != nil {
log.Criticalf("Fatal error: %s", recoveryErr)
recoveryErrStr := fmt.Sprintf("%s", recoveryErr)
log.Criticalf("Fatal error: %s", recoveryErrStr)
log.Criticalf("Stack trace: %s", debug.Stack())
sendErr(ctx, w, utils.NewHandlerError(http.StatusInternalServerError, "A server error occurred."))
sendErr(ctx, w, utils.NewInternalServerHandlerError(recoveryErrStr))
}
}()
h.ServeHTTP(w, r)

12
apiserver/server/routes.go
View File

@ -40,11 +40,19 @@ func makeHandler(
}
}
type clientError struct {
ErrorCode int `json:"errorCode"`
ErrorMessage string `json:"errorMessage"`
}
func sendErr(ctx *utils.APIServerContext, w http.ResponseWriter, hErr *utils.HandlerError) {
errMsg := fmt.Sprintf("got error: %s", hErr)
ctx.Warnf(errMsg)
w.WriteHeader(hErr.ErrorCode)
sendJSONResponse(w, hErr)
w.WriteHeader(hErr.Code)
sendJSONResponse(w, &clientError{
ErrorCode: hErr.Code,
ErrorMessage: hErr.ClientMessage,
})
}
func sendJSONResponse(w http.ResponseWriter, response interface{}) {

31
apiserver/utils/error.go
View File

@ -1,20 +1,41 @@
package utils
import "net/http"
// HandlerError is an error returned from
// a rest route handler or a middleware.
type HandlerError struct {
ErrorCode int
ErrorMessage string
Code int
Message string
ClientMessage string
}
func (hErr *HandlerError) Error() string {
return hErr.ErrorMessage
return hErr.Message
}
// NewHandlerError returns a HandlerError with the given code and message.
func NewHandlerError(code int, message string) *HandlerError {
return &HandlerError{
ErrorCode: code,
ErrorMessage: message,
Code: code,
Message: message,
ClientMessage: message,
}
}
// NewHandlerErrorWithCustomClientMessage returns a HandlerError with
// the given code, message and client error message.
func NewHandlerErrorWithCustomClientMessage(code int, message, clientMessage string) *HandlerError {
return &HandlerError{
Code: code,
Message: message,
ClientMessage: clientMessage,
}
}
// NewInternalServerHandlerError returns a HandlerError with
// the given message, and the http.StatusInternalServerError
// status text as client message.
func NewInternalServerHandlerError(message string) *HandlerError {
return NewHandlerErrorWithCustomClientMessage(http.StatusInternalServerError, message, http.StatusText(http.StatusInternalServerError))
}