store

README

store

DB

Yugabyte

CREATE KEYSPACE IF NOT EXISTS argus;
CREATE TABLE argus.gifnoc (
    bucket VARCHAR,
    id VARCHAR,
    data blob,
    PRIMARY KEY (bucket, id))
    WITH default_time_to_live = 300
    AND transactions = {'enabled': 'false'};

Documentation

Index

• Constants
• Variables
• func FilterOwner(value map[string]OwnableItem, owner string) map[string]OwnableItem
• func ProvideHandlers() fx.Option
• func SanitizeError(err error) error
• func Sha256HexDigest(message string) string
• type BadRequestErr
  • func (bre BadRequestErr) Error() string
  • func (bre BadRequestErr) SanitizedError() string
  • func (bre BadRequestErr) StatusCode() int
• type ForbiddenRequestErr
  • func (f ForbiddenRequestErr) Error() string
  • func (f ForbiddenRequestErr) StatusCode() int
• type GetAllItemsOperationErr
  • func (e GetAllItemsOperationErr) Error() string
  • func (e GetAllItemsOperationErr) Unwrap() error
• type GetLoggerFunc
• type Handler
• type InternalError
  • func (ie InternalError) Error() string
  • func (ie InternalError) StatusCode() int
• type ItemOperationError
  • func (e ItemOperationError) Error() string
  • func (e ItemOperationError) Unwrap() error
• type KeyItemPairRequest
• type KeyNotFoundError
  • func (knfe KeyNotFoundError) Error() string
  • func (knfe KeyNotFoundError) StatusCode() int
• type OwnableItem
• type S
• type SanitizedError
  • func (s SanitizedError) Error() string
  • func (s SanitizedError) Headers() http.Header
  • func (s SanitizedError) SanitizedError() string
  • func (s SanitizedError) StatusCode() int
  • func (s SanitizedError) Unwrap() error
• type UserInputValidationConfig

Constants

const (
	BucketFormatRegexSource = "^[0-9a-z][0-9a-z-]{1,61}[0-9a-z]$"
	OwnerFormatRegexSource  = "^.{10,60}$"
)

default input field validation regular expressions. Note: these values are configurable so please check the argus.yaml file if you're interested.

const (
	// TypeLabel is for labeling metrics; if there is a single metric for
	// successful queries, the typeLabel and corresponding type can be used
	// when incrementing the metric.
	TypeLabel  = "type"
	InsertType = "insert"
	DeleteType = "delete"
	ReadType   = "read"
	PingType   = "ping"
)

const (
	ItemOwnerHeaderKey  = "X-Midt-Owner"
	XmidtErrorHeaderKey = "X-Midt-Error"
)

Request and Response Headers.

const ElevatedAccessLevel = 1

ElevatedAccessLevel is the bascule attribute value found in requests that should be granted priviledged access to operations.

const IDFormatRegexSource = "^[0-9a-f]{64}$"

IDFormatRegexSource helps validate the ID on incoming requests.

Variables

var (
	ErrItemNotFound   = errors.New("Item at resource path not found")
	ErrJSONDecode     = errors.New("Error decoding JSON data from DB")
	ErrJSONEncode     = errors.New("Error encoding JSON data to send to DB")
	ErrQueryExecution = errors.New("Error occurred during DB query execution")
)

Sentinel internal errors.

var (
	ErrHTTPItemNotFound = &erraux.Error{Err: errors.New("Item not found"), Code: http.StatusNotFound}
	ErrHTTPOpFailed     = &erraux.Error{Err: errors.New("DB operation failed"), Code: http.StatusInternalServerError}
)

Sentinel errors to be used by the HTTP response error encoder.

var ErrCasting = errors.New("casting error due to middleware wiring mistake")

ErrCasting indicates there was (most likely) a middleware wiring mistake with the go-kit style encoders/decoders.

Functions

func FilterOwner

func FilterOwner(value map[string]OwnableItem, owner string) map[string]OwnableItem

func ProvideHandlers

func ProvideHandlers() fx.Option

ProvideHandlers fetches all dependencies and builds the four main handlers for this store.

func SanitizeError

func SanitizeError(err error) error

SanitizeError should be used by DB implementations to prevent exposing internal error data in HTTP responses. This method maps an internal error to their sanitized version which contains HTTP response information like code and debug header values. DB implementations should implement their own versions of this function when they need to look at implementation-specific errors to perform the mapping.

func Sha256HexDigest

func Sha256HexDigest(message string) string

Sha256HexDigest returns the SHA-256 hex digest of the given input.

Types

type BadRequestErr

type BadRequestErr struct {
	Message string
}

func (BadRequestErr) Error

func (bre BadRequestErr) Error() string

func (BadRequestErr) SanitizedError

func (bre BadRequestErr) SanitizedError() string

func (BadRequestErr) StatusCode

func (bre BadRequestErr) StatusCode() int

type ForbiddenRequestErr

type ForbiddenRequestErr struct {
	Message string
}

func (ForbiddenRequestErr) Error

func (f ForbiddenRequestErr) Error() string

func (ForbiddenRequestErr) StatusCode

func (f ForbiddenRequestErr) StatusCode() int

type GetAllItemsOperationErr

type GetAllItemsOperationErr struct {
	Err    error
	Bucket string
}

GetAllItemsOperationError is the ItemOperation counterpart for the getAllItems operation which applies to a group of items.

func (GetAllItemsOperationErr) Error

func (e GetAllItemsOperationErr) Error() string

func (GetAllItemsOperationErr) Unwrap

func (e GetAllItemsOperationErr) Unwrap() error

type GetLoggerFunc

type GetLoggerFunc func(context.Context) *zap.Logger

GetLoggerFunc is the function used to get a request-specific logger from its context.

type Handler

type Handler http.Handler

type InternalError

type InternalError struct {
	Reason    interface{}
	Retryable bool
}

func (InternalError) Error

func (ie InternalError) Error() string

func (InternalError) StatusCode

func (ie InternalError) StatusCode() int

type ItemOperationError

type ItemOperationError struct {
	Err       error
	Key       model.Key
	Operation string
}

ItemOperationError is a simple error wrapper for DB operations that apply to specific items. It provides a formatted message with context around the error.

func (ItemOperationError) Error

func (e ItemOperationError) Error() string

func (ItemOperationError) Unwrap

func (e ItemOperationError) Unwrap() error

type KeyItemPairRequest

type KeyItemPairRequest struct {
	model.Key
	OwnableItem
	Method string
}

type KeyNotFoundError

type KeyNotFoundError struct {
	Key model.Key
}

func (KeyNotFoundError) Error

func (knfe KeyNotFoundError) Error() string

func (KeyNotFoundError) StatusCode

func (knfe KeyNotFoundError) StatusCode() int

type OwnableItem

type OwnableItem struct {
	model.Item
	Owner string `json:"owner"`
}

type S

type S interface {
	Push(key model.Key, item OwnableItem) error
	Get(key model.Key) (OwnableItem, error)
	Delete(key model.Key) (OwnableItem, error)
	GetAll(bucket string) (map[string]OwnableItem, error)
}

type SanitizedError

type SanitizedError struct {
	// Err contains the raw error explaining the cause of the
	// failure event.
	Err error

	// ErrHTTP should contain some filtered version
	// of Err that can be safely used across API boundaries.
	// Two use cases include: hiding sensitive error data and
	// translating errors to better explain error events to API consumers.
	ErrHTTP *erraux.Error
}

func (SanitizedError) Error

func (s SanitizedError) Error() string

func (SanitizedError) Headers

func (s SanitizedError) Headers() http.Header

func (SanitizedError) SanitizedError

func (s SanitizedError) SanitizedError() string

func (SanitizedError) StatusCode

func (s SanitizedError) StatusCode() int

func (SanitizedError) Unwrap

func (s SanitizedError) Unwrap() error

type UserInputValidationConfig

type UserInputValidationConfig struct {
	ItemMaxTTL        time.Duration
	BucketFormatRegex string
	OwnerFormatRegex  string
	ItemDataMaxDepth  uint
}