package state /* STATE * This package encapsulates various state information * state is represented in various global singletons * Additionally, this package offers a pub/sub interface * for various aspects of state */ import ( "fmt" "sync" "time" "os" "errors" "encoding/json" "gitlab.com/whom/bingobot/internal/docbuf" "gitlab.com/whom/bingobot/internal/logging" ) /* Event interface is meant to encapsulate a general interface * extendable for any different action the bot takes or that a * user takes. */ const ( BadEventTypeError = "bad event type" EventValidationFailedError = "event failed validation: " BadEventNoUID = "event data has no UID field" BadEventNoCreated = "event data has no created field" BadEventStoreFilename = "failed to open event store file" BadEventStreamInit = "failed to initialize event stream" BadEventCreate = "failed to create event" BadUserEventCreatedParse = "failed to parse created time" BadChallengeEvent = "failed to make Challenge Event" BadRestorationEvent = "failed to make Restoration Event" BadUserActiveEvent = "failed to make UserActive Event" BadEventObjMarshal = "error marshalling event" BadEventObjUnmarshal = "failed to unmarshal event map" BadEventUnmarshal = "failed to unmarshal event" BadEventMissingTypeKey = "event map missing type key" ) const ( EventTypeMapKey = "type" ) var eventMutex sync.RWMutex var eventSubscriptionCache = [NumEventTypes][]chan Event{} var eventStream docbuf.DocumentBuffer var maxEventsInMemory int // expect filename validations in config package func Init(eventMemCacheSize int, eventStoreFileName string) error { file, err := os.OpenFile(eventStoreFileName, os.O_CREATE|os.O_RDWR, 0644) if err != nil { return errors.Join(errors.New(BadEventStoreFilename), err) } if eventStream, err = docbuf.NewDocumentBuffer( eventMemCacheSize, file, ); err != nil { return errors.Join(errors.New(BadEventStreamInit), err) } maxEventsInMemory = eventMemCacheSize return nil } type EventType int8 const ( Vote EventType = iota Challenge Restoration UserActive // ... // leave this last NumEventTypes ) // either returns a valid event type or NumEventTypes func EventTypeFromString(doc string) EventType { switch doc { case "Vote": return Vote case "Challenge": return Challenge case "Restoration": return Restoration case "UserActive": return UserActive default: // error case return NumEventTypes } } func (et EventType) String() string { events := []string{ "Vote", "Challenge", "Restoration", "UserActive", } if et < 0 || et >= NumEventTypes { return "" } return events[et] } func (et EventType) Validate() error { if et < 0 || et >= NumEventTypes { return errors.New(BadEventTypeError) } return nil } /* Allocates a specific event of type T from event type instance. * output event not guaranteed to be valid. * Call Validate() yourself. */ func (et EventType) MakeEvent(data map[string]string) (Event, error) { if err := et.Validate(); err != nil { return nil, errors.Join(errors.New(BadEventCreate), err) } MakeUserEvent := func(data map[string]string) (*UserEvent, error) { user, hasUser := data[UserEventUserKey] if !hasUser { return nil, errors.New(BadEventNoUID) } created, hasCreated := data[UserEventCreatedKey] if !hasCreated { return nil, errors.New(BadEventNoCreated) } createdTime, err := time.Parse(time.RFC3339, created) if err != nil { return nil, errors.Join(errors.New(BadUserEventCreatedParse), err) } return &UserEvent{ uid: user, created: createdTime, }, nil } switch et { case Vote: return VoteEvent(data), nil case Challenge: e, err := MakeUserEvent(data) if err != nil { return nil, errors.Join(errors.New(BadChallengeEvent), err) } return ChallengeEvent{*e}, nil case Restoration: e, err := MakeUserEvent(data) if err != nil { return nil, errors.Join(errors.New(BadRestorationEvent), err) } return RestorationEvent{*e}, nil case UserActive: e, err := MakeUserEvent(data) if err != nil { return nil, errors.Join(errors.New(BadUserActiveEvent), err) } return UserActiveEvent{*e}, nil default: return nil, errors.New(BadEventTypeError) } } /* adds a new subscriber channel to the event subscription cache * and returns the channel that it will publish notifications on */ func (et EventType) Subscribe() (chan Event, error) { if err := et.Validate(); err != nil { return nil, err } ch := make(chan Event, maxEventsInMemory) eventMutex.Lock() defer eventMutex.Unlock() eventSubscriptionCache[et] = append( eventSubscriptionCache[et], ch, ) return ch, nil } type Event interface { // gets EventType associated with event Type() EventType // gets time event created Time() time.Time // gets internal metadata associated with event // may be read only depending on event implementation Data() map[string]string // validates state of internal metadata per EventType Validate() error } func EventToString(e Event) (string, error) { m := e.Data() m[EventTypeMapKey] = e.Type().String() buf, err := json.Marshal(m) if err != nil { return "", errors.Join(errors.New(BadEventObjMarshal), err) } return string(buf), nil } func EventFromString(doc string) (Event, error) { var obj map[string]string if err := json.Unmarshal([]byte(doc), &obj); err != nil { return nil, errors.Join(errors.New(BadEventObjUnmarshal), err) } et, ok := obj[EventTypeMapKey] if !ok { return nil, errors.New(BadEventMissingTypeKey) } t := EventTypeFromString(et) ev, err := t.MakeEvent(obj) if err != nil { return nil, errors.Join(errors.New(BadEventCreate), err) } return ev, ev.Validate() } func PublishEvent(e Event) error { if err := ValidateEvent(e); err != nil { return errors.Join(errors.New(EventValidationFailedError), err) } doc, err := EventToString(e) if err != nil { return errors.New(BadEventUnmarshal) } eventMutex.Lock() eventStream.Push(doc) eventMutex.Unlock() eventMutex.RLock() defer eventMutex.RUnlock() blocking := false for _, c := range eventSubscriptionCache[e.Type()] { if float32(len(c)) > (float32(maxEventsInMemory) * 0.25) { if len(c) == maxEventsInMemory { logging.Warn( "PublishEvent() blocking -- event channel full", // log the event time to provide blockage timing information // in the logs "eventTime", e.Time(), ) blocking = true } } c <- e if blocking { logging.Info("PublishEvent() no longer blocking") blocking = false } } return nil } func ValidateEvent(e Event) error { if err := e.Type().Validate(); err != nil { return err } if err := e.Validate(); err != nil { return err } return nil } /* Takes a filter and applies it to each individual event * The filter is a function/closure that accepts one event * and returns true if ApplyToEvents should continue iterating * * If the filter returns false then ApplyToEvents halts and returns. * * (this calls docbuf.Apply() under the hood) */ func ApplyToEvents( f func(Event)bool, ) error { // local variables enclosed by filter function filterWrap var err error var ev Event // wrap f() to be compatible with docbuf.Apply() filterWrap := func(doc string) bool { ev, err = EventFromString(doc) if err != nil { return false } return f(ev) } eventMutex.RLock() defer eventMutex.RUnlock() // cant reuse err or return val directly as err is set // by filter function if an error happens unmarshalling // an event. In this case apply might return nil err2 := eventStream.Apply(filterWrap) if err2 != nil { return err2 } if err != nil { return err } return nil } /* gets all events of type T in cache * that also share all field values in * map 'filters' */ func GetMatchingEvents( t EventType, filters map[string]string, ) ([]Event, error) { matches := []Event{} if err := t.Validate(); err != nil { return matches, err } filter := func(e Event) bool { ev, er := EventToString(e) fmt.Printf("Checking: %s (%e)\n", ev, er) if e.Type() != t { return true } for k, v := range filters { val, found := e.Data()[k] if !found || val != v { return true } } fmt.Println("Found Match") matches = append(matches, e) return true } err := ApplyToEvents(filter) return matches, err } type VoteEvent map[string]string const ( VoteMissingKeyError = "vote data not found: " VoteCreatedKey = "created" VoteRequesterKey = "requester" VoteActionKey = "action" VoteResultKey = "result" VoteResultPass = "pass" VoteResultFail = "fail" VoteResultTie = "tie" VoteResultTimeout = "timeout" VoteBadResultError = "vote has invalid result: " VoteNotFinishedError = "vote has result but isnt finished" VoteMissingResultError = "vote finished but missing result" VoteStatusKey = "status" VoteStatusInProgress = "in_progress" VoteStatusFinalized = "finalized" VoteStatusTimeout = "timed_out" VoteBadStatusError = "vote has invalid status: " VeryOldVote = "1990-01-01T00:00:00Z" ) func (ve VoteEvent) Type() EventType { return Vote } func (ve VoteEvent) Time() time.Time { t, e := time.Parse(time.RFC3339, ve[VoteCreatedKey]) if e != nil { // we have a corrupted event // return old time so that this event gets // pruned from cache logging.Warn( "pruning corrupted vote event", "event", fmt.Sprintf("%+v", ve), ) tooOld, _ := time.Parse( time.RFC3339, VeryOldVote, ) return tooOld } return t } func (ve VoteEvent) Data() map[string]string { return map[string]string(ve) } func (ve VoteEvent) Validate() error { // make sure action, requester, and created are set for _, key := range []string{ VoteActionKey, VoteRequesterKey, VoteCreatedKey, VoteStatusKey, } { if _, found := ve[key]; !found { return errors.New(VoteMissingKeyError + key) } } status := ve[VoteStatusKey] if status != VoteStatusTimeout && status != VoteStatusInProgress && status != VoteStatusFinalized { return errors.New(VoteBadStatusError + status) } result, hasResult := ve[VoteResultKey] if hasResult && status == VoteStatusInProgress { return errors.New(VoteNotFinishedError) } if status != VoteStatusInProgress && !hasResult { return errors.New(VoteMissingResultError) } if hasResult && (result != VoteResultPass && result != VoteResultFail && result != VoteResultTie && result != VoteResultTimeout) { return errors.New(VoteBadResultError + result) } return nil } type UserEvent struct { uid string created time.Time } const ( UserEventUserKey = "user" UserEventCreatedKey = "created" UserEventBadUserError = "event has bad user" ) func (ue UserEvent) Time() time.Time { return ue.created } func (ue UserEvent) Data() map[string]string { return map[string]string{ UserEventUserKey: ue.uid, UserEventCreatedKey: ue.created.Format(time.RFC3339), } } func (ue UserEvent) Validate() error { // empty for now, we may do some validation later. return nil } type ChallengeEvent struct { UserEvent } func (ce ChallengeEvent) Type() EventType { return Challenge } func NewChallengeEvent(user string) ChallengeEvent { return ChallengeEvent{UserEvent{ uid: user, created: time.Now(), }} } type RestorationEvent struct { UserEvent } func (re RestorationEvent) Type() EventType { return Restoration } func NewRestorationEvent(user string) RestorationEvent { return RestorationEvent{UserEvent{ uid: user, created: time.Now(), }} } type UserActiveEvent struct { UserEvent } func (ua UserActiveEvent) Type() EventType { return UserActive } func NewUserActiveEvent(user string) UserActiveEvent { return UserActiveEvent{UserEvent{ uid: user, created: time.Now(), }} }