[feature] Use uuids instead of global counter for protocol entries

Author: g3force

internal/app/controller/engine.go

@@ -10,21 +10,18 @@ import (
 	"sort"
 	"strconv"
 	"strings"
-	"sync"
 	"time"
 )
 
 type GameControllerState struct {
-	Division                    config.Division                     `json:"division" yaml:"division"`
-	AutoContinue                bool                                `json:"autoContinue" yaml:"autoContinue"`
-	GameEventBehavior           map[GameEventType]GameEventBehavior `json:"gameEventBehavior" yaml:"gameEventBehavior"`
-	GameEventProposals          []*GameEventProposal                `json:"gameEventProposals" yaml:"gameEventProposals"`
-	AutoRefsConnected           []string                            `json:"autoRefsConnected" yaml:"autoRefsConnected"`
-	TeamConnected               map[Team]bool                       `json:"teamConnected" yaml:"teamConnected"`
-	TeamConnectionVerified      map[Team]bool                       `json:"teamConnectionVerified" yaml:"teamConnectionVerified"`
-	MatchState                  *State                              `json:"matchState" yaml:"matchState"`
-	ProtocolEntryIdCounter      int                                 `json:"protocolEntryIdCounter" yaml:"protocolEntryIdCounter"`
-	ProtocolEntryIdCounterMutex sync.Mutex                          `json:"protocolEntryIdCounterMutex" yaml:"protocolEntryIdCounterMutex"`
+	Division               config.Division                     `json:"division" yaml:"division"`
+	AutoContinue           bool                                `json:"autoContinue" yaml:"autoContinue"`
+	GameEventBehavior      map[GameEventType]GameEventBehavior `json:"gameEventBehavior" yaml:"gameEventBehavior"`
+	GameEventProposals     []*GameEventProposal                `json:"gameEventProposals" yaml:"gameEventProposals"`
+	AutoRefsConnected      []string                            `json:"autoRefsConnected" yaml:"autoRefsConnected"`
+	TeamConnected          map[Team]bool                       `json:"teamConnected" yaml:"teamConnected"`
+	TeamConnectionVerified map[Team]bool                       `json:"teamConnectionVerified" yaml:"teamConnectionVerified"`
+	MatchState             *State                              `json:"matchState" yaml:"matchState"`
 }
 
 func NewGameControllerState() (s *GameControllerState) {
@@ -490,7 +487,7 @@ func (e *Engine) processEvent(event Event) error {
 	return errors.New("unknown event")
 }
 
-func (e *Engine) processRevertProtocolEntry(id int) error {
+func (e *Engine) processRevertProtocolEntry(id string) error {
 	err := e.PersistentState.RevertProtocolEntry(id)
 	if err != nil {
 		return err

internal/app/controller/engineHistory.go

@@ -43,7 +43,7 @@ func (s *PersistentState) Prune() {
 }
 
 // GetProtocolEntry returns the protocol entry with given id
-func (s *PersistentState) GetProtocolEntry(id int) *ProtocolEntry {
+func (s *PersistentState) GetProtocolEntry(id string) *ProtocolEntry {
 	for i := len(s.Protocol) - 1; i > 0; i-- {
 		if s.Protocol[i].Id == id {
 			return s.Protocol[i]
@@ -53,7 +53,7 @@ func (s *PersistentState) GetProtocolEntry(id int) *ProtocolEntry {
 }
 
 // GetProtocolEntry returns the protocol entry with given id
-func (s *PersistentState) RevertProtocolEntry(id int) error {
+func (s *PersistentState) RevertProtocolEntry(id string) error {
 	for i := len(s.Protocol) - 1; i > 0; i-- {
 		entry := s.Protocol[i]
 		if entry.Id == id {

internal/app/controller/engine_test.go

@@ -142,7 +142,6 @@ func processTransitionFile(t *testing.T, fileName string) {
 		// override these, as we do not want to test them
 		expectedState.MatchState.PrevCommands = e.State.PrevCommands
 		expectedState.MatchState.PrevCommandsFor = e.State.PrevCommandsFor
-		expectedState.ProtocolEntryIdCounter = e.GcState.ProtocolEntryIdCounter
 
 		// check if the engine state is equal to the expected state
 		if diff := deep.Equal(*e.GcState, expectedState); diff != nil {

internal/app/controller/events.go

@@ -168,7 +168,7 @@ type Event struct {
 	Stage               *EventStage       `json:"stage" yaml:"stage"`
 	Trigger             *EventTrigger     `json:"trigger" yaml:"trigger"`
 	GameEvent           *GameEvent        `json:"gameEvent" yaml:"gameEvent"`
-	RevertProtocolEntry *int              `json:"revertProtocolEntry,omitempty" yaml:"revertProtocolEntry"`
+	RevertProtocolEntry *string           `json:"revertProtocolEntry,omitempty" yaml:"revertProtocolEntry"`
 }
 
 func (e Event) String() string {

internal/app/controller/protocol.go

@@ -2,6 +2,7 @@ package controller
 
 import (
 	"fmt"
+	"github.com/odeke-em/go-uuid"
 	"log"
 	"time"
 )
@@ -30,16 +31,13 @@ const (
 	UiProtocolHint UiProtocolType = "hint"
 )
 
-func (e *Engine) newGlobalProtocolEntryId() int {
-	defer e.GcState.ProtocolEntryIdCounterMutex.Unlock()
-	e.GcState.ProtocolEntryIdCounterMutex.Lock()
-	e.GcState.ProtocolEntryIdCounter++
-	return e.GcState.ProtocolEntryIdCounter
+func (e *Engine) newGlobalProtocolEntryId() string {
+	return uuid.New()
 }
 
 // ProtocolEntry represents a single protocol entry as should be displayed in the UI table
 type ProtocolEntry struct {
-	Id            int            `json:"id"`
+	Id            string         `json:"id"`
 	Timestamp     int64          `json:"timestamp"`
 	StageTime     time.Duration  `json:"stageTime"`
 	Type          UiProtocolType `json:"type"`

src/components/events/EventTable.vue

@@ -86,7 +86,7 @@
             },
             revertProtocolEntry(id) {
                 this.$socket.sendObj({
-                    'revertProtocolEntry': Number(id)
+                    'revertProtocolEntry': id
                 })
             },
             iconForType(type) {