mhook

Documentation

Index

• Constants
• func Initialise()
• func Metrics() []xmetrics.Metric
• func NewAddWebhookHandler(s Service) http.Handler
• func NewGetAllWebhooksHandler(s Service) http.Handler
• type Service
  • func Initialize(watches ...Watch) (Service, func(), error)
• type Watch
• type WatchConfig
• type WatchFunc
  • func (f WatchFunc) Update(webhooks []Webhook)
• type Webhook
• type WebhookStore
  • func NewWebhookStore(logger *loggerGroup) WebhookStore

Constants

const (
	PollCounter          = "webhook_polls_total"
	WebhookListSizeGauge = "webhook_list_size_value"
)

Names

const (
	SuccessOutcome = "success"
	FailureOutcome = "failure"
)

Label Values

const (
	// ClientIDHeader provides a fallback method for fetching the client ID of users
	// registering their webhooks. The main method fetches this value from the claims of
	// the authentication JWT.
	ClientIDHeader = "X-Xmidt-Client-Id"
)

const (
	OutcomeLabel = "outcome"
)

Labels

Functions

func Initialise

func Initialise()

func Metrics

func Metrics() []xmetrics.Metric

Metrics returns the Metrics relevant to this package

func NewAddWebhookHandler

func NewAddWebhookHandler(s Service) http.Handler

func NewGetAllWebhooksHandler

func NewGetAllWebhooksHandler(s Service) http.Handler

Types

type Service

type Service interface {
	Add(owner string, w *Webhook) error
	AllWebhooks(owner string) ([]*Webhook, error)
	AddWebhookFromYaml(yamlFile string) error
}

Service describes the core operations around webhook subscriptions.

func Initialize

func Initialize(watches ...Watch) (Service, func(), error)

type Watch

type Watch interface {
	Update([]Webhook)
}

Watch is the interface for listening for webhook subcription updates. Updates represent the latest known list of subscriptions.

type WatchConfig

type WatchConfig struct {
	// Webhooks contains the list of webhooks to be used by the webhook service
	Webhooks []Webhook

	// WatchUpdateInterval is the duration between each update to all watchers.
	WatchUpdateInterval time.Duration
}

Config provides the different options for the initializing the wehbook service.

type WatchFunc

type WatchFunc func([]Webhook)

WatchFunc allows bare functions to pass as Watches.

func (WatchFunc) Update

func (f WatchFunc) Update(webhooks []Webhook)

type Webhook

type Webhook struct {
	// Address is the subscription request origin HTTP Address.
	Address string `json:"registered_from_address"`

	// Config contains data to inform how events are delivered.
	Config struct {
		// URL is the HTTP URL to deliver messages to.
		URL string `json:"url"`

		// ContentType is content type value to set WRP messages to (unless already specified in the WRP).
		ContentType string `json:"content_type"`

		// Secret is the string value for the SHA1 HMAC.
		// (Optional, set to "" to disable behavior).
		Secret string `json:"secret,omitempty"`

		// AlternativeURLs is a list of explicit URLs that should be round robin through on failure cases to the main URL.
		AlternativeURLs []string `json:"alt_urls,omitempty"`
	} `json:"config"`

	// FailureURL is the URL used to notify subscribers when they've been cut off due to event overflow.
	// Optional, set to "" to disable notifications.
	FailureURL string `json:"failure_url"`

	// Events is the list of regular expressions to match an event type against.
	Events []string `json:"events"`

	// Matcher type contains values to match against the metadata.
	Matcher struct {
		// DeviceID is the list of regular expressions to match device id type against.
		DeviceID []string `json:"device_id"`
	} `json:"matcher,omitempty"`

	// Duration describes how long the subscription lasts once added.
	// Deprecated. User input is ignored and value is always 5m.
	Duration time.Duration `json:"duration"`

	// Until describes the time this subscription expires.
	Until time.Time `json:"until"`
}

Webhook contains all the information needed to serve events to webhook listeners.

type WebhookStore

type WebhookStore interface {
	Add(owner string, w *Webhook) error
	Delete(owner string, url string) error
	AllWebhooks(owner string) ([]*Webhook, error)
}

func NewWebhookStore

func NewWebhookStore(logger *loggerGroup) WebhookStore