c934974652
This change updates how API errors are handled and sent. Change-Id: Ia4c71eeb6f2d009a47b59ce77a23f70b8b10f6dc
54 lines
1.4 KiB
Go
54 lines
1.4 KiB
Go
// Copyright (C) 2022 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package web
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"net/http"
|
|
|
|
"go.uber.org/zap"
|
|
|
|
"storj.io/common/http/requestid"
|
|
)
|
|
|
|
// ServeJSONError writes a JSON error to the response output stream.
|
|
func ServeJSONError(ctx context.Context, log *zap.Logger, w http.ResponseWriter, status int, err error) {
|
|
ServeCustomJSONError(ctx, log, w, status, err, err.Error())
|
|
}
|
|
|
|
// ServeCustomJSONError writes a JSON error with a custom message to the response output stream.
|
|
func ServeCustomJSONError(ctx context.Context, log *zap.Logger, w http.ResponseWriter, status int, err error, msg string) {
|
|
fields := []zap.Field{
|
|
zap.Int("code", status),
|
|
zap.String("message", msg),
|
|
zap.Error(err),
|
|
}
|
|
|
|
if requestID := requestid.FromContext(ctx); requestID != "" {
|
|
fields = append(fields, zap.String("requestID", requestID))
|
|
}
|
|
|
|
switch status {
|
|
case http.StatusNoContent:
|
|
return
|
|
case http.StatusInternalServerError:
|
|
log.Error("returning error to client", fields...)
|
|
case http.StatusBadRequest:
|
|
log.Debug("returning error to client", fields...)
|
|
case http.StatusTooManyRequests:
|
|
default:
|
|
log.Info("returning error to client", fields...)
|
|
}
|
|
|
|
w.WriteHeader(status)
|
|
|
|
err = json.NewEncoder(w).Encode(map[string]string{
|
|
"error": msg,
|
|
})
|
|
if err != nil {
|
|
log.Error("failed to write json error response", zap.Error(err))
|
|
}
|
|
}
|