mirror of
https://github.com/open-policy-agent/opa.git
synced 2026-08-12 19:32:48 -06:00
Anders Eknert
e03ac2f200
- Bump golangci-lint -> 2.6.2 - Fix all `deprecatedComment` "notices should be in a dedicated paragraph, separated from the rest" reports - Enable `appendCombine` and fix all "appendCombine: can combine chain of X appends into one" notices - Enable `preferFprint` and fix the few reported issues - Fix various issues reported only once or twice, like `zeroByteRepeat` Signed-off-by: Anders Eknert <anders.eknert@apple.com>
104 lines
3.2 KiB
Go
104 lines
3.2 KiB
Go
// Copyright 2017 The OPA Authors. All rights reserved.
|
|
// Use of this source code is governed by an Apache2
|
|
// license that can be found in the LICENSE file.
|
|
|
|
// Package writer contains utilities for writing responses in the server.
|
|
package writer
|
|
|
|
import (
|
|
"encoding/json"
|
|
"net/http"
|
|
|
|
"github.com/open-policy-agent/opa/v1/server/types"
|
|
"github.com/open-policy-agent/opa/v1/storage"
|
|
"github.com/open-policy-agent/opa/v1/topdown"
|
|
)
|
|
|
|
// HTTPStatus is used to set a specific status code
|
|
// Adapted from https://stackoverflow.com/questions/27711154/what-response-code-to-return-on-a-non-supported-http-method-on-rest
|
|
func HTTPStatus(code int) http.HandlerFunc {
|
|
return func(w http.ResponseWriter, _ *http.Request) {
|
|
w.WriteHeader(code)
|
|
}
|
|
}
|
|
|
|
// ErrorAuto writes a response with status and code set automatically based on
|
|
// the type of err.
|
|
func ErrorAuto(w http.ResponseWriter, err error) {
|
|
switch {
|
|
case types.IsBadRequest(err):
|
|
ErrorString(w, http.StatusBadRequest, types.CodeInvalidParameter, err)
|
|
case storage.IsWriteConflictError(err):
|
|
ErrorString(w, http.StatusNotFound, types.CodeResourceConflict, err)
|
|
case topdown.IsError(err):
|
|
Error(w, http.StatusInternalServerError, types.NewErrorV1(types.CodeInternal, types.MsgEvaluationError).WithError(err))
|
|
case storage.IsInvalidPatch(err):
|
|
ErrorString(w, http.StatusBadRequest, types.CodeInvalidParameter, err)
|
|
case storage.IsNotFound(err):
|
|
ErrorString(w, http.StatusNotFound, types.CodeResourceNotFound, err)
|
|
default:
|
|
ErrorString(w, http.StatusInternalServerError, types.CodeInternal, err)
|
|
}
|
|
}
|
|
|
|
// ErrorString writes a response with specified status, code, and message set to
|
|
// the err's string representation.
|
|
func ErrorString(w http.ResponseWriter, status int, code string, err error) {
|
|
Error(w, status, types.NewErrorV1(code, "%s", err.Error()))
|
|
}
|
|
|
|
// Error writes a response with specified status and error response.
|
|
func Error(w http.ResponseWriter, status int, err *types.ErrorV1) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
w.WriteHeader(status)
|
|
_, _ = w.Write(append(err.Bytes(), byte('\n')))
|
|
}
|
|
|
|
// JSON writes a response with the specified status code and object. The object
|
|
// will be JSON serialized.
|
|
//
|
|
// Deprecated: This method is problematic when using a non-200 status `code`: if
|
|
// encoding the payload fails, it'll print "superfluous call to WriteHeader()"
|
|
// logs.
|
|
func JSON(w http.ResponseWriter, code int, v any, pretty bool) {
|
|
enc := json.NewEncoder(w)
|
|
if pretty {
|
|
enc.SetIndent("", " ")
|
|
}
|
|
|
|
w.Header().Set("Content-Type", "application/json")
|
|
w.WriteHeader(code)
|
|
|
|
if err := enc.Encode(v); err != nil {
|
|
ErrorAuto(w, err)
|
|
return
|
|
}
|
|
}
|
|
|
|
// JSONOK is a helper for status "200 OK" responses
|
|
func JSONOK(w http.ResponseWriter, v any, pretty bool) {
|
|
enc := json.NewEncoder(w)
|
|
if pretty {
|
|
enc.SetIndent("", " ")
|
|
}
|
|
|
|
w.Header().Add("Content-Type", "application/json")
|
|
// If Encode() calls w.Write() for the first time, it'll set the HTTP status
|
|
// to 200 OK.
|
|
if err := enc.Encode(v); err != nil {
|
|
ErrorAuto(w, err)
|
|
return
|
|
}
|
|
}
|
|
|
|
// Bytes writes a response with the specified status code and bytes.
|
|
//
|
|
// Deprecated: Unused in OPA, will be removed in the future.
|
|
func Bytes(w http.ResponseWriter, code int, bs []byte) {
|
|
w.WriteHeader(code)
|
|
if code == 204 {
|
|
return
|
|
}
|
|
_, _ = w.Write(bs)
|
|
}
|