util

Documentation

Overview

Package util contains web utils for APIs, clients and error handling

Index

• Variables
• func BodyToBytes(closer io.ReadCloser) ([]byte, error)
• func BodyToObject(closer io.ReadCloser, object interface{}) error
• func BytesToObject(bytes []byte, object interface{}) error
• func HandleInterrupts(ctx context.Context, cancel context.CancelFunc)
• func HandleResponseError(response *http.Response) error
• func HandleStorageError(err error, entityName string) error
• func HasRFC3986ReservedSymbols(input string) bool
• func ListAll(ctx context.Context, doRequest DoRequestFunc, url string, items interface{}) error
• func NewJSONResponse(code int, value interface{}) (*web.Response, error)
• func NewJSONResponseWithHeaders(code int, value interface{}, additionalHeaders map[string]string) (*web.Response, error)
• func RequestBodyToBytes(request *http.Request) ([]byte, error)
• func SendRequest(ctx context.Context, doRequest DoRequestFunc, method, url string, ...) (*http.Response, error)
• func SendRequestWithHeaders(ctx context.Context, doRequest DoRequestFunc, method, url string, ...) (*http.Response, error)
• func StartInWaitGroup(f func(), group *sync.WaitGroup)
• func StartInWaitGroupWithContext(ctx context.Context, f func(ctx context.Context), group *sync.WaitGroup)
• func ToRFCNanoFormat(timestamp time.Time) string
• func WriteError(ctx context.Context, err error, writer http.ResponseWriter)
• func WriteJSON(writer http.ResponseWriter, code int, value interface{}) error
• type DoRequestFunc
  • func BasicAuthDecorator(username, password string, requestFunc DoRequestFunc) DoRequestFunc
• type EmptyResponseBody
• type ErrBadRequestStorage
  • func (e *ErrBadRequestStorage) Error() string
• type ErrForeignKeyViolation
  • func (e *ErrForeignKeyViolation) Error() string
• type HTTPError
  • func ToHTTPError(ctx context.Context, err error) *HTTPError
  • func (e *HTTPError) Error() string
• type InputValidator
• type ListIterator
  • func (li *ListIterator) Next(ctx context.Context, items interface{}, maxItems int) (more bool, count int64, err error)
• type StateContext
  • func (StateContext) Deadline() (deadline time.Time, ok bool)
  • func (StateContext) Done() <-chan struct{}
  • func (StateContext) Err() error
  • func (sc StateContext) Value(key interface{}) interface{}
• type UnsupportedQueryError
  • func (uq *UnsupportedQueryError) Error() string

Variables

var (
	// ErrNotFoundInStorage error returned from storage when entity is not found
	ErrNotFoundInStorage = errors.New("not found")

	// ErrAlreadyExistsInStorage error returned from storage when entity has conflicting fields
	ErrAlreadyExistsInStorage = errors.New("unique constraint violation")

	// ErrConcurrentResourceModification error returned when concurrent resource updates are happening
	ErrConcurrentResourceModification = errors.New("another resource update happened concurrently. Please reattempt the update")

	// ErrInvalidNotificationRevision provided notification revision is not valid, must return http status GONE
	ErrInvalidNotificationRevision = errors.New("notification revision is not valid")
)

Functions

func BodyToBytes

func BodyToBytes(closer io.ReadCloser) ([]byte, error)

BodyToBytes of the request inside given struct

func BodyToObject

func BodyToObject(closer io.ReadCloser, object interface{}) error

BodyToObject of the request inside given struct

func BytesToObject

func BytesToObject(bytes []byte, object interface{}) error

BytesToObject converts the provided bytes to object and validates it

func HandleInterrupts

func HandleInterrupts(ctx context.Context, cancel context.CancelFunc)

HandleInterrupts handles process signal interrupts

func HandleResponseError

func HandleResponseError(response *http.Response) error

HandleResponseError builds an error from the given response

func HandleStorageError

func HandleStorageError(err error, entityName string) error

HandleStorageError handles storage errors by converting them to relevant HTTPErrors

func HasRFC3986ReservedSymbols

func HasRFC3986ReservedSymbols(input string) bool

HasRFC3986ReservedSymbols returns true if input contains any reserver characters as defined in RFC3986 section oidc_authn.oidc_authn

func ListAll

func ListAll(ctx context.Context, doRequest DoRequestFunc, url string, items interface{}) error

ListAll retrieves all the objects from the given url by loading all the pages items should be a pointer to a slice, that will be populated with all the items doRequest function executes the HTTP request, it is responsible for authentication

func NewJSONResponse

func NewJSONResponse(code int, value interface{}) (*web.Response, error)

NewJSONResponse turns plain object into a byte array representing JSON value and wraps it in web.Response

func NewJSONResponseWithHeaders

func NewJSONResponseWithHeaders(code int, value interface{}, additionalHeaders map[string]string) (*web.Response, error)

func RequestBodyToBytes

func RequestBodyToBytes(request *http.Request) ([]byte, error)

RequestBodyToBytes reads the request body and returns []byte with its content or an error if the media type is unsupported or if the body is not a valid JSON

func SendRequest

func SendRequest(ctx context.Context, doRequest DoRequestFunc, method, url string, params map[string]string, body interface{}) (*http.Response, error)

SendRequest sends a request to the specified client and the provided URL with the specified parameters and body.

func SendRequestWithHeaders

func SendRequestWithHeaders(ctx context.Context, doRequest DoRequestFunc, method, url string, params map[string]string, body interface{}, headers map[string]string) (*http.Response, error)

SendRequestWithHeaders sends a request to the specified client and the provided URL with the specified parameters, body and headers.

func StartInWaitGroup

func StartInWaitGroup(f func(), group *sync.WaitGroup)

func StartInWaitGroupWithContext

func StartInWaitGroupWithContext(ctx context.Context, f func(ctx context.Context), group *sync.WaitGroup)

func ToRFCNanoFormat

func ToRFCNanoFormat(timestamp time.Time) string

ToRFCNanoFormat converts a time.Time timestamp to RFC3339Nano format

func WriteError

func WriteError(ctx context.Context, err error, writer http.ResponseWriter)

WriteError sends a JSON containing the error to the response writer

func WriteJSON

func WriteJSON(writer http.ResponseWriter, code int, value interface{}) error

WriteJSON writes a JSON value and sets the specified HTTP Status code

Types

type DoRequestFunc

type DoRequestFunc func(request *http.Request) (*http.Response, error)

DoRequestFunc is an alias for any function that takes an http request and returns a response and error

func BasicAuthDecorator

func BasicAuthDecorator(username, password string, requestFunc DoRequestFunc) DoRequestFunc

type EmptyResponseBody

type EmptyResponseBody struct{}

EmptyResponseBody represents an empty response body value

type ErrBadRequestStorage

type ErrBadRequestStorage struct {
	Cause error
}

ErrBadRequestStorage represents a storage error that should be translated to http.StatusBadRequest

func (*ErrBadRequestStorage) Error

func (e *ErrBadRequestStorage) Error() string

type ErrForeignKeyViolation

type ErrForeignKeyViolation struct {
	Entity          string
	ReferenceEntity string
}

ErrForeignKeyViolation represents a foreign key constraint storage error that should be translated to a user-friendly http.StatusBadRequest

func (*ErrForeignKeyViolation) Error

func (e *ErrForeignKeyViolation) Error() string

type HTTPError

type HTTPError struct {
	ErrorType   string `json:"error,omitempty"`
	Description string `json:"description,omitempty"`
	StatusCode  int    `json:"-"`
}

HTTPError is an error type that provides error details that Service Manager error handlers would propagate to the client

func ToHTTPError

func ToHTTPError(ctx context.Context, err error) *HTTPError

func (*HTTPError) Error

func (e *HTTPError) Error() string

Error HTTPError should implement error

type InputValidator

type InputValidator interface {
	Validate() error
}

InputValidator should be implemented by types that need input validation check. For a reference refer to pkg/types

type ListIterator

type ListIterator struct {
	// DoRequest function executes the HTTP request, it is responsible for authentication
	DoRequest DoRequestFunc
	// URL is the address of the resource to list
	URL string
	// contains filtered or unexported fields
}

ListIterator lists the objects from the given url by loading one page at a time

func (*ListIterator) Next

func (li *ListIterator) Next(ctx context.Context, items interface{}, maxItems int) (more bool, count int64, err error)

Next loads the next page of items items should be a pointer to a slice, that will be populated with the items from the current page, if nil, only the total number is returned maxItems is the maximum numbe of items to load with the next page, -1 - use server default, 0 - just get the count more is true if there are more items count is the total number of items, -1 if not available

type StateContext

type StateContext struct {
	Context context.Context
}

StateContext is a Context which only holds values. Its Deadline(), Done() and Err() implementations have been stubbed out. Such a StateContext implementation is needed for scenarios where a request context needs to be copied and not derived, so as to not have to worry about being canceled by it's parent.

func (StateContext) Deadline

func (StateContext) Deadline() (deadline time.Time, ok bool)

func (StateContext) Done

func (StateContext) Done() <-chan struct{}

func (StateContext) Err

func (StateContext) Err() error

func (StateContext) Value

func (sc StateContext) Value(key interface{}) interface{}

type UnsupportedQueryError

type UnsupportedQueryError struct {
	Message string
}

UnsupportedQueryError is an error to show that the provided query cannot be executed

func (*UnsupportedQueryError) Error

func (uq *UnsupportedQueryError) Error() string