hook

Documentation

Index

• func Configure(appConfig *config.AppConfig) error
• func Notify(ctx context.Context, message *sdk.EventHookMessage) (uuid.UUID, error)
• func SetInstance(i Service)
• type EventHookAudit
  • func NewAudit(db *gorm.DB) *EventHookAudit
  • func (r *EventHookAudit) IsDuplicate(message *sdk.EventHookMessage) bool
  • func (r *EventHookAudit) Log(message *sdk.EventHookMessage)
• type EventHooksProvider
  • func NewEventHooksProvider(db *gorm.DB) EventHooksProvider
• type NotifyFunc
• type Publisher
  • func NewEventHookPublisher(subscriptionsProvider EventHooksProvider, recorder *EventHookAudit) Publisher
• type Service
  • func NewService(messageSender messaging.MessageSender) Service

Functions

func Configure

func Configure(appConfig *config.AppConfig) error

func Notify

func Notify(ctx context.Context, message *sdk.EventHookMessage) (uuid.UUID, error)

enqueues a message to the event hooks service

func SetInstance

func SetInstance(i Service)

Types

type EventHookAudit

type EventHookAudit struct {
	// contains filtered or unexported fields
}

func NewAudit

func NewAudit(db *gorm.DB) *EventHookAudit

func (*EventHookAudit) IsDuplicate

func (r *EventHookAudit) IsDuplicate(message *sdk.EventHookMessage) bool

func (*EventHookAudit) Log

func (r *EventHookAudit) Log(message *sdk.EventHookMessage)

type EventHooksProvider

type EventHooksProvider interface {
	// Gets the subscriptions for an event type
	Get() ([]*model.EventHook, error)
}

func NewEventHooksProvider

func NewEventHooksProvider(db *gorm.DB) EventHooksProvider

type NotifyFunc

type NotifyFunc func(ctx context.Context, message *sdk.EventHookMessage) (uuid.UUID, error)

notify is the function signature for the event hook Add

type Publisher

type Publisher interface {
	// publishes a message to all web hook subscriptions
	Publish(message *sdk.EventHookMessage) error
}

Publishes event hook messages to all web hooks registered in the system.

func NewEventHookPublisher

func NewEventHookPublisher(subscriptionsProvider EventHooksProvider, recorder *EventHookAudit) Publisher

type Service

type Service interface {
	// adds a message to the hooks queue
	Notify(ctx context.Context, message *sdk.EventHookMessage) (uuid.UUID, error)
}

This implementation is to make the semantics clear that this is the lifecycle of a hook message: eventHookMessage --> added to queue --> received --> executed handler (events) --> publish the message using Publisher.Publish() queue for adding hook messages to be published

func NewService

func NewService(messageSender messaging.MessageSender) Service