drone/internal/api/render/render.go

102 lines
2.9 KiB
Go

// Copyright 2021 Harness Inc. All rights reserved.
// Use of this source code is governed by the Polyform Free Trial License
// that can be found in the LICENSE.md file for this repository.
package render
import (
"encoding/json"
"fmt"
"net/http"
"os"
"strconv"
"github.com/rs/zerolog/log"
"github.com/harness/gitness/internal/api/usererror"
)
// indent the json-encoded API responses.
var indent bool
func init() {
indent, _ = strconv.ParseBool(
os.Getenv("HTTP_JSON_INDENT"),
)
}
// TranslatedUserError writes the translated user error of the provided error.
func TranslatedUserError(w http.ResponseWriter, err error) {
UserError(w, usererror.Translate(err))
}
// NotFound writes the json-encoded message for a not found error.
func NotFound(w http.ResponseWriter) {
UserError(w, usererror.ErrNotFound)
}
// Unauthorized writes the json-encoded message for an unauthorized error.
func Unauthorized(w http.ResponseWriter) {
UserError(w, usererror.ErrUnauthorized)
}
// Forbidden writes the json-encoded message for a forbidden error.
func Forbidden(w http.ResponseWriter) {
UserError(w, usererror.ErrForbidden)
}
// BadRequest writes the json-encoded message for a bad request error.
func BadRequest(w http.ResponseWriter) {
UserError(w, usererror.ErrBadRequest)
}
// BadRequestError writes the json-encoded error with a bad request status code.
func BadRequestError(w http.ResponseWriter, err *usererror.Error) {
UserError(w, err)
}
// BadRequest writes the json-encoded message with a bad request status code.
func BadRequestf(w http.ResponseWriter, format string, args ...interface{}) {
ErrorMessagef(w, http.StatusBadRequest, format, args...)
}
// InternalError writes the json-encoded message for an internal error.
func InternalError(w http.ResponseWriter) {
UserError(w, usererror.ErrInternal)
}
// ErrorMessagef writes the json-encoded, formated error message.
func ErrorMessagef(w http.ResponseWriter, code int, format string, args ...interface{}) {
JSON(w, code, &usererror.Error{Message: fmt.Sprintf(format, args...)})
}
// UserError writes the json-encoded user error.
func UserError(w http.ResponseWriter, err *usererror.Error) {
JSON(w, err.Status, err)
}
// DeleteSuccessful writes the header for a successful delete.
func DeleteSuccessful(w http.ResponseWriter) {
w.WriteHeader(http.StatusNoContent)
}
// JSON writes the json-encoded value to the response
// with the provides status.
func JSON(w http.ResponseWriter, code int, v interface{}) {
// set common headers
w.Header().Set("Content-Type", "application/json; charset=utf-8")
w.Header().Set("X-Content-Type-Options", "nosniff")
// flush the headers - before body or status will be 200 OK
w.WriteHeader(code)
// write body
enc := json.NewEncoder(w)
if indent { // is this necessary? it will affect performance
enc.SetIndent("", " ")
}
if err := enc.Encode(v); err != nil {
log.Err(err).Msgf("Failed to write json encoding to response body.")
}
}