events

Documentation

Overview

Package events represents a stub for producing events to a Kafka topic, a real implementation would contain logic for retrying failed events etc

Index

• type EventType
• type Events
  • func New() *Events
  • func (e *Events) Produce(ctx context.Context, topic Topic, payload interface{})
• type MediaEvent
• type QuestEvent
• type Topic
• type UserEvent

Types

type EventType

type EventType string

EventType represents the type of event that occurred.

const (
	// EventTypeUserCreated is triggered after a user has been successfully created.
	EventTypeUserCreated EventType = "user_created"
	// EventTypeUserUpdated is triggered after a user has been successfully updated.
	EventTypeUserUpdated EventType = "user_updated"
	// EventTypeUserDeleted is triggered after a user has been successfully deleted.
	EventTypeUserDeleted EventType = "user_deleted"

	EventTypeQuestCreated EventType = "quest_created"
	EventTypeQuestUpdated EventType = "quest_updated"
	EventTypeQuestDeleted EventType = "quest_deleted"
	EventTypeQuestSent    EventType = "quest_sent"
)

type Events

type Events struct{}

Events represents an implementation that can produce events.

func New

func New() *Events

New will instantiate a new instance of Events.

func (*Events) Produce

func (e *Events) Produce(ctx context.Context, topic Topic, payload interface{})

Produce will produce an event on the given topic using the supplied payload.

type MediaEvent

type MediaEvent struct {
	EventType   EventType          `json:"event_type"`
	ID          string             `json:"id"`
	MediaRecord *model.MediaRecord `json:"media_record"`
}

type QuestEvent

type QuestEvent struct {
	EventType EventType                  `json:"event_type"`
	ID        string                     `json:"id"`
	Quest     *questModel.QuestWithSteps `json:"quest"`
}

type Topic

type Topic string

Topic represents a topic in Kafka.

const (
	// TopicUsers represents a topic for user entity events such as CRUD events.
	TopicUsers  Topic = "users"
	TopicQuests Topic = "quests"
	TopicMedia  Topic = "media"
)

type UserEvent

type UserEvent struct {
	EventType EventType       `json:"event_type"`
	ID        string          `json:"id"`
	User      *userModel.User `json:"user"`
}

UserEvent represents an event that occurs on a user entity.