models

Documentation

Index

• type BaseEvent
  • func (e *BaseEvent) GetDescription() string
  • func (e *BaseEvent) GetID() string
  • func (e *BaseEvent) GetRoomID() string
  • func (e *BaseEvent) GetTimestamp() time.Time
  • func (e *BaseEvent) GetType() EventType
• type Event
  • func ConvertProtoEvent(protoEvent *guessesv1.Event) (Event, error)
  • func NewEvent(baseEvent BaseEvent) (Event, error)
  • func NewGenericEvent(eventType EventType, roomId string, description string) Event
  • func NewGenericEventWithTimestamp(timestamp time.Time, eventType EventType, roomId string, description string) Event
  • func NewGuessEvent(eventType EventType, roomId, userId, questionId string, correct bool, ...) Event
  • func NewLeaderboardUpdatedEvent(eventType EventType, roomId string, leaderboard *Leaderboard, ...) Event
• type EventType
  • func (e EventType) String() string
• type GenericEvent
• type Guess
  • func NewGuess(roomID, userID, questionID string, correct bool) (*Guess, error)
  • func (u *Guess) Validate() error
• type GuessEvent
• type Leaderboard
• type LeaderboardUpdatedEvent
  • func (e *LeaderboardUpdatedEvent) GetLeaderboard() *Leaderboard
• type RankElement
• type Score
  • func NewScore(totalQuestions uint32) *Score
  • func (s *Score) IncreasePontuation(timeTaken time.Duration, multiplier float64)
  • func (s *Score) UpdateStatistics(isCorrect bool, timeTaken time.Duration)

Types

type BaseEvent

type BaseEvent struct {
	ID          ulid.ULID
	Timestamp   time.Time
	Type        EventType
	RoomID      string
	Description string
}

BaseEvent struct with embedded fields

func (*BaseEvent) GetDescription

func (e *BaseEvent) GetDescription() string

func (*BaseEvent) GetID

func (e *BaseEvent) GetID() string

func (*BaseEvent) GetRoomID

func (e *BaseEvent) GetRoomID() string

func (*BaseEvent) GetTimestamp

func (e *BaseEvent) GetTimestamp() time.Time

func (*BaseEvent) GetType

func (e *BaseEvent) GetType() EventType

type Event

type Event interface {
	GetID() string
	GetTimestamp() time.Time
	GetType() EventType
	GetDescription() string
	GetRoomID() string
}

Event interface definition

func ConvertProtoEvent

func ConvertProtoEvent(protoEvent *guessesv1.Event) (Event, error)

ConvertProtoEvent converts the room event type from the ConnectRPC format back to the internal event format.

Returns ErrEventTypeInvalid if the event is malformed.

Returns ErrUlidInvalid if the event id can't be parsed as an ULID.

func NewEvent

func NewEvent(baseEvent BaseEvent) (Event, error)

NewEvent creates a specific Event based on the BaseEvent Type

func NewGenericEvent

func NewGenericEvent(eventType EventType, roomId string, description string) Event

Factory function for creating a new GenericEvent

func NewGenericEventWithTimestamp

func NewGenericEventWithTimestamp(timestamp time.Time, eventType EventType, roomId string, description string) Event

Factory function for creating a new GenericEvent. This function is useful for synchronizing the event with other functions.

func NewGuessEvent

func NewGuessEvent(eventType EventType, roomId, userId, questionId string, correct bool, description string) Event

func NewLeaderboardUpdatedEvent

func NewLeaderboardUpdatedEvent(eventType EventType, roomId string, leaderboard *Leaderboard, description string) Event

type EventType

type EventType int

const (
	/* events */
	GuessSubmitted EventType = iota
	LeaderboardUpdated
)

func (EventType) String

func (e EventType) String() string

type GenericEvent

type GenericEvent struct {
	BaseEvent
}

type Guess

type Guess struct {
	RoomID     string `validate:"required,len=4" redis:"roomid"`
	UserID     string `validate:"required,uuid" redis:"userid"`
	QuestionID string `validate:"required,gte=0" redis:"questionid"`
	Correct    bool   `redis:"correct"`
}

func NewGuess

func NewGuess(roomID, userID, questionID string, correct bool) (*Guess, error)

func (*Guess) Validate

func (u *Guess) Validate() error

type GuessEvent

type GuessEvent struct {
	BaseEvent
	UserId     string
	QuestionId string
	Correct    bool
}

type Leaderboard

type Leaderboard struct {
	RankList []RankElement
}

type LeaderboardUpdatedEvent

type LeaderboardUpdatedEvent struct {
	BaseEvent
	Leaderboard *Leaderboard
}

func (*LeaderboardUpdatedEvent) GetLeaderboard

func (e *LeaderboardUpdatedEvent) GetLeaderboard() *Leaderboard

type RankElement

type RankElement struct {
	UserID string
	Score  float64
}

type Score

type Score struct {
	CorrectAnswers     uint32 `redis:"correct"`
	WrongAnswers       uint32 `redis:"wrong"`
	ComboMultiplierIdx uint32 `redis:"combo"`
	TotalQuestions     uint32 `redis:"total"`
	Pontuation         float64
}

func NewScore

func NewScore(totalQuestions uint32) *Score

func (*Score) IncreasePontuation

func (s *Score) IncreasePontuation(timeTaken time.Duration, multiplier float64)

IncreasePontuation calculates the pontuation based on the time taken to answer the question and the combo multiplier value, following the formula: f(t) = BasePontuation * e^(DecayRate * t) * multiplier

func (*Score) UpdateStatistics

func (s *Score) UpdateStatistics(isCorrect bool, timeTaken time.Duration)