helper

Documentation

Index

• Constants
• func AllowResponseBuffering(w http.ResponseWriter)
• func CaptureAndFail(w http.ResponseWriter, r *http.Request, err error, msg string, code int)
• func CleanHeadersForRaven(r *http.Request)
• func CleanUpProcessGroup(cmd *exec.Cmd)
• func CloneRequestWithNewBody(r *http.Request, body []byte) *http.Request
• func DisableResponseBuffering(w http.ResponseWriter)
• func ExitStatus(err error) (int, bool)
• func Fail500(w http.ResponseWriter, r *http.Request, err error)
• func HTTPError(w http.ResponseWriter, r *http.Request, error string, code int)
• func HeaderClone(h http.Header) http.Header
• func IsApplicationJson(r *http.Request) bool
• func IsContentType(expected, actual string) bool
• func LogError(r *http.Request, err error)
• func NewAccessLogFormatter() log.Formatter
• func OpenFile(path string) (file *os.File, fi os.FileInfo, err error)
• func ReadAllTempfile(r io.Reader) (tempfile *os.File, err error)
• func ReadRequestBody(w http.ResponseWriter, r *http.Request, maxBodySize int64) ([]byte, error)
• func RequestEntityTooLarge(w http.ResponseWriter, r *http.Request, err error)
• func ScrubURLParams(originalURL string) string
• func SetAccessLoggerEntry(logEntry *log.Entry)
• func SetForwardedFor(newHeaders *http.Header, originalRequest *http.Request)
• func SetNoCacheHeaders(header http.Header)
• func URLMustParse(s string) *url.URL
• type Clock
• type CountingResponseWriter
  • func NewCountingResponseWriter(rw http.ResponseWriter) CountingResponseWriter
• type LoggingResponseWriter
  • func NewStatsCollectingResponseWriter(rw http.ResponseWriter) LoggingResponseWriter
• type RealClock
  • func (RealClock) Now() time.Time
• type StubClock
  • func (c *StubClock) Now() time.Time
• type WriteFlusher
  • func NewWriteAfterReader(r io.Reader, w io.Writer) (io.Reader, WriteFlusher)

Constants

const NginxResponseBufferHeader = "X-Accel-Buffering"

Functions

func AllowResponseBuffering

func AllowResponseBuffering(w http.ResponseWriter)

func CaptureAndFail

func CaptureAndFail(w http.ResponseWriter, r *http.Request, err error, msg string, code int)

func CleanHeadersForRaven

func CleanHeadersForRaven(r *http.Request)

func CleanUpProcessGroup

func CleanUpProcessGroup(cmd *exec.Cmd)

func CloneRequestWithNewBody

func CloneRequestWithNewBody(r *http.Request, body []byte) *http.Request

func DisableResponseBuffering

func DisableResponseBuffering(w http.ResponseWriter)

func ExitStatus

func ExitStatus(err error) (int, bool)

func Fail500

func Fail500(w http.ResponseWriter, r *http.Request, err error)

func HTTPError

func HTTPError(w http.ResponseWriter, r *http.Request, error string, code int)

func HeaderClone

func HeaderClone(h http.Header) http.Header

func IsApplicationJson

func IsApplicationJson(r *http.Request) bool

func IsContentType

func IsContentType(expected, actual string) bool

func LogError

func LogError(r *http.Request, err error)

func NewAccessLogFormatter

func NewAccessLogFormatter() log.Formatter

NewAccessLogFormatter returns a new formatter for combined access logs

func OpenFile

func OpenFile(path string) (file *os.File, fi os.FileInfo, err error)

func ReadAllTempfile

func ReadAllTempfile(r io.Reader) (tempfile *os.File, err error)

func ReadRequestBody

func ReadRequestBody(w http.ResponseWriter, r *http.Request, maxBodySize int64) ([]byte, error)

func RequestEntityTooLarge

func RequestEntityTooLarge(w http.ResponseWriter, r *http.Request, err error)

func ScrubURLParams

func ScrubURLParams(originalURL string) string

Based on https://stackoverflow.com/a/52965552/474597 ScrubURLParams replaces the content of any sensitive query string parameters in an URL with `[FILTERED]`

func SetAccessLoggerEntry

func SetAccessLoggerEntry(logEntry *log.Entry)

SetAccessLoggerEntry sets the access logger used in the system

func SetForwardedFor

func SetForwardedFor(newHeaders *http.Header, originalRequest *http.Request)

func SetNoCacheHeaders

func SetNoCacheHeaders(header http.Header)

func URLMustParse

func URLMustParse(s string) *url.URL

Types

type Clock

type Clock interface {
	Now() time.Time
}

Clock interface provides the time

type CountingResponseWriter

type CountingResponseWriter interface {
	http.ResponseWriter
	Count() int64
	Status() int
}

func NewCountingResponseWriter

func NewCountingResponseWriter(rw http.ResponseWriter) CountingResponseWriter

type LoggingResponseWriter

type LoggingResponseWriter interface {
	http.ResponseWriter

	RequestFinished(r *http.Request)
}

func NewStatsCollectingResponseWriter

func NewStatsCollectingResponseWriter(rw http.ResponseWriter) LoggingResponseWriter

type RealClock

type RealClock struct{}

RealClock is the default time implementation

func (RealClock) Now

func (RealClock) Now() time.Time

Now returns the time

type StubClock

type StubClock struct {
	StubTime time.Time
}

StubClock is the default time implementation

func (*StubClock) Now

func (c *StubClock) Now() time.Time

Now returns a stub time

type WriteFlusher

type WriteFlusher interface {
	io.Writer
	Flush() error
}

func NewWriteAfterReader

func NewWriteAfterReader(r io.Reader, w io.Writer) (io.Reader, WriteFlusher)

Couple r and w so that until r has been drained (before r.Read() has returned some error), all writes to w are sent to a tempfile first. The caller must call Flush() on the returned WriteFlusher to ensure all data is propagated to w.