parent
3e9a17abb9
commit
9343d2ea69
@ -0,0 +1,112 @@ |
|||||||
|
// Package apiutils contains utilities which are useful for implementing api
|
||||||
|
// endpoints.
|
||||||
|
package apiutils |
||||||
|
|
||||||
|
import ( |
||||||
|
"context" |
||||||
|
"crypto/rand" |
||||||
|
"encoding/hex" |
||||||
|
"encoding/json" |
||||||
|
"errors" |
||||||
|
"fmt" |
||||||
|
"net/http" |
||||||
|
"strconv" |
||||||
|
|
||||||
|
"github.com/mediocregopher/mediocre-go-lib/v2/mlog" |
||||||
|
) |
||||||
|
|
||||||
|
type loggerCtxKey int |
||||||
|
|
||||||
|
// SetRequestLogger sets the given Logger onto the given Request's Context,
|
||||||
|
// returning a copy.
|
||||||
|
func SetRequestLogger(r *http.Request, logger *mlog.Logger) *http.Request { |
||||||
|
ctx := r.Context() |
||||||
|
ctx = context.WithValue(ctx, loggerCtxKey(0), logger) |
||||||
|
return r.WithContext(ctx) |
||||||
|
} |
||||||
|
|
||||||
|
// GetRequestLogger returns the Logger which was set by SetRequestLogger onto
|
||||||
|
// this Request, or nil.
|
||||||
|
func GetRequestLogger(r *http.Request) *mlog.Logger { |
||||||
|
ctx := r.Context() |
||||||
|
logger, _ := ctx.Value(loggerCtxKey(0)).(*mlog.Logger) |
||||||
|
if logger == nil { |
||||||
|
logger = mlog.Null |
||||||
|
} |
||||||
|
return logger |
||||||
|
} |
||||||
|
|
||||||
|
// JSONResult writes the JSON encoding of the given value as the response body.
|
||||||
|
func JSONResult(rw http.ResponseWriter, r *http.Request, v interface{}) { |
||||||
|
b, err := json.Marshal(v) |
||||||
|
if err != nil { |
||||||
|
InternalServerError(rw, r, err) |
||||||
|
return |
||||||
|
} |
||||||
|
b = append(b, '\n') |
||||||
|
|
||||||
|
rw.Header().Set("Content-Type", "application/json") |
||||||
|
rw.Write(b) |
||||||
|
} |
||||||
|
|
||||||
|
// BadRequest writes a 400 status and a JSON encoded error struct containing the
|
||||||
|
// given error as the response body.
|
||||||
|
func BadRequest(rw http.ResponseWriter, r *http.Request, err error) { |
||||||
|
GetRequestLogger(r).Warn(r.Context(), "bad request", err) |
||||||
|
|
||||||
|
rw.WriteHeader(400) |
||||||
|
JSONResult(rw, r, struct { |
||||||
|
Error string `json:"error"` |
||||||
|
}{ |
||||||
|
Error: err.Error(), |
||||||
|
}) |
||||||
|
} |
||||||
|
|
||||||
|
// InternalServerError writes a 500 status and a JSON encoded error struct
|
||||||
|
// containing a generic error as the response body (though it will log the given
|
||||||
|
// one).
|
||||||
|
func InternalServerError(rw http.ResponseWriter, r *http.Request, err error) { |
||||||
|
GetRequestLogger(r).Error(r.Context(), "internal server error", err) |
||||||
|
|
||||||
|
rw.WriteHeader(500) |
||||||
|
JSONResult(rw, r, struct { |
||||||
|
Error string `json:"error"` |
||||||
|
}{ |
||||||
|
Error: "internal server error", |
||||||
|
}) |
||||||
|
} |
||||||
|
|
||||||
|
// StrToInt parses the given string as an integer, or returns the given default
|
||||||
|
// integer if the string is empty.
|
||||||
|
func StrToInt(str string, defaultVal int) (int, error) { |
||||||
|
if str == "" { |
||||||
|
return defaultVal, nil |
||||||
|
} |
||||||
|
return strconv.Atoi(str) |
||||||
|
} |
||||||
|
|
||||||
|
// GetCookie returns the namd cookie's value, or the given default value if the
|
||||||
|
// cookie is not set.
|
||||||
|
//
|
||||||
|
// This will only return an error if there was an unexpected error parsing the
|
||||||
|
// Request's cookies.
|
||||||
|
func GetCookie(r *http.Request, cookieName, defaultVal string) (string, error) { |
||||||
|
c, err := r.Cookie(cookieName) |
||||||
|
if errors.Is(err, http.ErrNoCookie) { |
||||||
|
return defaultVal, nil |
||||||
|
} else if err != nil { |
||||||
|
return "", fmt.Errorf("reading cookie %q: %w", cookieName, err) |
||||||
|
} |
||||||
|
|
||||||
|
return c.Value, nil |
||||||
|
} |
||||||
|
|
||||||
|
// RandStr returns a human-readable random string with the given number of bytes
|
||||||
|
// of randomness.
|
||||||
|
func RandStr(numBytes int) string { |
||||||
|
b := make([]byte, numBytes) |
||||||
|
if _, err := rand.Read(b); err != nil { |
||||||
|
panic(err) |
||||||
|
} |
||||||
|
return hex.EncodeToString(b) |
||||||
|
} |
@ -1,91 +0,0 @@ |
|||||||
package api |
|
||||||
|
|
||||||
import ( |
|
||||||
"context" |
|
||||||
"crypto/rand" |
|
||||||
"encoding/hex" |
|
||||||
"encoding/json" |
|
||||||
"errors" |
|
||||||
"fmt" |
|
||||||
"net/http" |
|
||||||
"strconv" |
|
||||||
|
|
||||||
"github.com/mediocregopher/mediocre-go-lib/v2/mlog" |
|
||||||
) |
|
||||||
|
|
||||||
type loggerCtxKey int |
|
||||||
|
|
||||||
func setRequestLogger(r *http.Request, logger *mlog.Logger) *http.Request { |
|
||||||
ctx := r.Context() |
|
||||||
ctx = context.WithValue(ctx, loggerCtxKey(0), logger) |
|
||||||
return r.WithContext(ctx) |
|
||||||
} |
|
||||||
|
|
||||||
func getRequestLogger(r *http.Request) *mlog.Logger { |
|
||||||
ctx := r.Context() |
|
||||||
logger, _ := ctx.Value(loggerCtxKey(0)).(*mlog.Logger) |
|
||||||
if logger == nil { |
|
||||||
logger = mlog.Null |
|
||||||
} |
|
||||||
return logger |
|
||||||
} |
|
||||||
|
|
||||||
func jsonResult(rw http.ResponseWriter, r *http.Request, v interface{}) { |
|
||||||
b, err := json.Marshal(v) |
|
||||||
if err != nil { |
|
||||||
internalServerError(rw, r, err) |
|
||||||
return |
|
||||||
} |
|
||||||
b = append(b, '\n') |
|
||||||
|
|
||||||
rw.Header().Set("Content-Type", "application/json") |
|
||||||
rw.Write(b) |
|
||||||
} |
|
||||||
|
|
||||||
func badRequest(rw http.ResponseWriter, r *http.Request, err error) { |
|
||||||
getRequestLogger(r).Warn(r.Context(), "bad request", err) |
|
||||||
|
|
||||||
rw.WriteHeader(400) |
|
||||||
jsonResult(rw, r, struct { |
|
||||||
Error string `json:"error"` |
|
||||||
}{ |
|
||||||
Error: err.Error(), |
|
||||||
}) |
|
||||||
} |
|
||||||
|
|
||||||
func internalServerError(rw http.ResponseWriter, r *http.Request, err error) { |
|
||||||
getRequestLogger(r).Error(r.Context(), "internal server error", err) |
|
||||||
|
|
||||||
rw.WriteHeader(500) |
|
||||||
jsonResult(rw, r, struct { |
|
||||||
Error string `json:"error"` |
|
||||||
}{ |
|
||||||
Error: "internal server error", |
|
||||||
}) |
|
||||||
} |
|
||||||
|
|
||||||
func strToInt(str string, defaultVal int) (int, error) { |
|
||||||
if str == "" { |
|
||||||
return defaultVal, nil |
|
||||||
} |
|
||||||
return strconv.Atoi(str) |
|
||||||
} |
|
||||||
|
|
||||||
func getCookie(r *http.Request, cookieName, defaultVal string) (string, error) { |
|
||||||
c, err := r.Cookie(cookieName) |
|
||||||
if errors.Is(err, http.ErrNoCookie) { |
|
||||||
return defaultVal, nil |
|
||||||
} else if err != nil { |
|
||||||
return "", fmt.Errorf("reading cookie %q: %w", cookieName, err) |
|
||||||
} |
|
||||||
|
|
||||||
return c.Value, nil |
|
||||||
} |
|
||||||
|
|
||||||
func randStr(numBytesEntropy int) string { |
|
||||||
b := make([]byte, numBytesEntropy) |
|
||||||
if _, err := rand.Read(b); err != nil { |
|
||||||
panic(err) |
|
||||||
} |
|
||||||
return hex.EncodeToString(b) |
|
||||||
} |
|
Loading…
Reference in new issue