Documentation
¶
Index ¶
- Variables
- func CacheImmutable(w http.ResponseWriter)
- func CacheNever(w http.ResponseWriter)
- func CacheSeconds(w http.ResponseWriter, seconds int)
- func Check(err error)
- func CheckClient(err error)
- func CheckLogged(l log.Log, err error)
- func Do(req *http.Request) (*http.Response, error)
- func EncodeQuery(kv map[string]string) string
- func FailedRequestSummary(resp *http.Response, err error) string
- func FailedRequestSummaryEx(resp *http.Response, err error, maxBodyLen int) string
- func FetchJSON(req *http.Request, output any) error
- func Handle(log log.Log, router *httprouter.Router, method, path string, ...)
- func IsNotModified(w http.ResponseWriter, r *http.Request, modifiedAt time.Time) bool
- func IsNotModifiedEx(w http.ResponseWriter, r *http.Request, modifiedAt time.Time, ...) bool
- func Panic(code int, message string)
- func PanicBadRequest()
- func PanicBadRequestf(format string, args ...interface{})
- func PanicForbidden()
- func PanicForbiddenf(format string, args ...interface{})
- func PanicNoContent()
- func PanicNotFound()
- func PanicServerError(msg string)
- func PanicServerErrorf(format string, args ...interface{})
- func PanicUnauthorized()
- func ParseID(s string) int64
- func QueryInt(r *http.Request, key string) int
- func QueryInt64(r *http.Request, key string) int64
- func QueryValue(r *http.Request, key string) string
- func QueryValueEx(r *http.Request, s string) (string, bool)
- func RateLimit(groupName string, maxPerSecond float64, w http.ResponseWriter, r *http.Request)
- func ReadIDList(r *http.Request) []int64
- func ReadJSON(w http.ResponseWriter, r *http.Request, obj interface{}, maxBodyBytes int64)
- func ReadLimited(w http.ResponseWriter, r *http.Request, maxBodyBytes int64) []byte
- func ReadString(w http.ResponseWriter, r *http.Request, maxBodyBytes int64) string
- func RequiredQueryInt(r *http.Request, key string) int
- func RequiredQueryInt64(r *http.Request, key string) int64
- func RequiredQueryValue(r *http.Request, key string) string
- func RunProtected(log log.Log, w http.ResponseWriter, r *http.Request, handler func())
- func SendError(w http.ResponseWriter, message string, code int)
- func SendFile(w http.ResponseWriter, r *http.Request, filename, contentType string)
- func SendFileDownload(w http.ResponseWriter, filename, contentType string, content []byte)
- func SendFmt(w http.ResponseWriter, any interface{})
- func SendID(w http.ResponseWriter, id int64)
- func SendInt64(w http.ResponseWriter, id int64)
- func SendJSON(w http.ResponseWriter, obj interface{})
- func SendJSONBool(w http.ResponseWriter, v bool)
- func SendJSONID(w http.ResponseWriter, id int64)
- func SendJSONOpt(w http.ResponseWriter, obj interface{}, pretty bool)
- func SendJSONRaw(w http.ResponseWriter, raw any)
- func SendOK(w http.ResponseWriter)
- func SendTempFile(w http.ResponseWriter, r *http.Request, filename, contentType string)
- func SendText(w http.ResponseWriter, text string)
- func SplitIDList(idList string) []int64
- func TryMultipleTimes(maxAttempts int, action func() error) error
- type HTTPError
- func BadRequest() HTTPError
- func BadRequestf(format string, args ...interface{}) HTTPError
- func Error(code int, message string) HTTPError
- func Forbidden() HTTPError
- func Forbiddenf(format string, args ...interface{}) HTTPError
- func NoContent() HTTPError
- func NotFound() HTTPError
- func ServerError(msg string) HTTPError
- func ServerErrorf(format string, args ...interface{}) HTTPError
- func Unauthorized() HTTPError
Constants ¶
This section is empty.
Variables ¶
var EnableRateLimiting bool
You can disable this when running unit tests
Functions ¶
func CacheImmutable ¶
func CacheImmutable(w http.ResponseWriter)
Set cache headers which indicate that this resource is immutable Apparently chrome is not going to implement the immutable cache-control tag, so we just set a long expiry date.
func CacheNever ¶
func CacheNever(w http.ResponseWriter)
Set cache headers instructing the client never to cache
func CacheSeconds ¶
func CacheSeconds(w http.ResponseWriter, seconds int)
Set cache headers for a given expiry in seconds
func CheckClient ¶
func CheckClient(err error)
CheckClient causes a PanicBadRequest if err is not nil.
func CheckLogged ¶
CheckLogged writes the error to the log, and then causes a panic, if err is not nil.
func Do ¶
Perform the request, and if any errors occurs (transport or non-200 status code), return an error This does the work for you of checking for a non-200 response, reading the response body, and turning it into an error.
func EncodeQuery ¶
EncodeQuery returns a key=value&key2=value2 string for a URL
func FailedRequestSummary ¶
FailedRequestSummary returns a string that you can emit into a log message, when an HTTP request that you've made fails
func FailedRequestSummaryEx ¶
FailedRequestSummaryEx returns a string that you can emit into a log message, when an HTTP request that you've made fails
func Handle ¶
func Handle(log log.Log, router *httprouter.Router, method, path string, handle httprouter.Handle)
Handle adds a protected HTTP route to router (ie handle will run inside RunProtected, so you get a panic handler).
func IsNotModified ¶
func IsNotModifiedEx ¶
func IsNotModifiedEx(w http.ResponseWriter, r *http.Request, modifiedAt time.Time, cacheControl string) bool
IsNotModified checks for an If-Modified-Since header, and if modifiedAt is before or equal to the header value, then we write a 304 Not Modified to w, and return true. If, on the other hand, modifiedAt is greater than If-Modified-Since (or the If-Modified-Since header is not present), then we set the Last-Modified header on w, and return false.
func PanicBadRequestf ¶
func PanicBadRequestf(format string, args ...interface{})
PanicBadRequestf panics with a 400 Bad Request.
func PanicForbiddenf ¶
func PanicForbiddenf(format string, args ...interface{})
func PanicServerError ¶
func PanicServerError(msg string)
PanicServerError panics with a 500 Internal Server Error
func PanicServerErrorf ¶
func PanicServerErrorf(format string, args ...interface{})
PanicServerErrorf panics with a 500 Internal Server Error
func QueryInt ¶
Returns the named form value (typically query value) as an int, or zero if the item is missing or not parseable as an integer
func QueryInt64 ¶
Returns the named form value (typically query value) as an int64, or zero if the item is missing or not parseable as an integer
func QueryValue ¶
Returns the named query value (or an empty string)
func QueryValueEx ¶
Returns (value, true) if a query value exists (an empty string counts as existence). Returns ("", false) if the query value does not exist
func RateLimit ¶
This is simple, dumb, and wrong, but at least the intention is clearer than having time.Sleep() all over the place The key things broken here are: 1. We don't pay attention to who's calling 2. We always sleep 3. It's trivial to get around this by firing off 10000 simultaneous requests
func ReadIDList ¶
Read a comma-separated list of integer IDs
func ReadJSON ¶
func ReadJSON(w http.ResponseWriter, r *http.Request, obj interface{}, maxBodyBytes int64)
ReadJSON reads the body of the request, and unmarshals it into 'obj'.
func ReadLimited ¶
Read the request body, but limit the number of bytes that will be read, to ensure the server isn't loaded heavily by faulty or malicious requests
func ReadString ¶
ReadString reads the body of the request, and returns it as a string
func RequiredQueryInt ¶
Returns the named form value (typically query value) as an int, or panics if the item is empty, missing, or not parseable as an integer
func RequiredQueryInt64 ¶
Returns the named form value (typically query value) as an int64, or panics if the item is empty, missing, or not parseable as an integer
func RequiredQueryValue ¶
Returns the named form value (typically query value), or panics if the item is empty or missing
func RunProtected ¶
RunProtected runs 'func' inside a panic handler that recognizes our special errors, and sends the appropriate HTTP response if a panic does occur.
func SendError ¶
func SendError(w http.ResponseWriter, message string, code int)
SendError is identical to the standard library http.Error(), except that we don't append a \n to the message body
func SendFile ¶
func SendFile(w http.ResponseWriter, r *http.Request, filename, contentType string)
SendFile sends a file (as direct content, not download)
func SendFileDownload ¶
func SendFileDownload(w http.ResponseWriter, filename, contentType string, content []byte)
SendFileDownload sends a file for download
func SendFmt ¶
func SendFmt(w http.ResponseWriter, any interface{})
SendFmt serializes 'any' via fmt.Sprintf("%v"), and sends it as text/plain
func SendInt64 ¶
func SendInt64(w http.ResponseWriter, id int64)
SendInt64 sends the number as text/plain
func SendJSON ¶
func SendJSON(w http.ResponseWriter, obj interface{})
SendJSON encodes 'obj' to JSON, and sends it as an HTTP application/json response.
func SendJSONBool ¶
func SendJSONBool(w http.ResponseWriter, v bool)
SendJSONBool sends "true" or "false" as an application/json response
func SendJSONID ¶
func SendJSONID(w http.ResponseWriter, id int64)
SendJSONID sends the ID as {"id":<value>}
func SendJSONOpt ¶
func SendJSONOpt(w http.ResponseWriter, obj interface{}, pretty bool)
func SendJSONRaw ¶
func SendJSONRaw(w http.ResponseWriter, raw any)
Accept string, []byte, and io.Reader
func SendTempFile ¶
func SendTempFile(w http.ResponseWriter, r *http.Request, filename, contentType string)
SendTempFile calls SendFile, and then deletes the file when finished
func SendText ¶
func SendText(w http.ResponseWriter, text string)
SendText sends text as an HTTP text/plain response
func SplitIDList ¶
Split a list of IDs such as "345,789" by comma, and return the list as int64s. Will panic on bad input.
func TryMultipleTimes ¶
Try to execute a function multiple times, and return the first error (or nil upon success) We backoff exponentially with 1s, 2s, 4s, 8s, etc.
Types ¶
type HTTPError ¶
HTTPError is an object that can be panic'ed, and the outer HTTP handler function. Will return the appropriate HTTP error message.
func BadRequest ¶
func BadRequest() HTTPError
func BadRequestf ¶
func Forbiddenf ¶
func ServerError ¶
func ServerErrorf ¶
func Unauthorized ¶
func Unauthorized() HTTPError
Source Files