[feature] Allow reverting commands

Author: g3force

internal/app/controller/controller.go

@@ -16,20 +16,20 @@ const configFileName = "config/ssl-game-controller.yaml"
 
 // GameController controls a game
 type GameController struct {
-	Config                    config.Controller
-	Publisher                 Publisher
-	ApiServer                 ApiServer
-	AutoRefServer             *rcon.AutoRefServer
-	TeamServer                *rcon.TeamServer
-	CiServer                  rcon.CiServer
-	Engine                    Engine
-	statePreserver            StatePreserver
-	numUiProtocolsLastPublish int
-	outstandingTeamChoice     *TeamChoice
-	ConnectionMutex           sync.Mutex
-	PublishMutex              sync.Mutex
-	StateMutex                sync.Mutex
-	VisionReceiver            *vision.Receiver
+	Config                config.Controller
+	Publisher             Publisher
+	ApiServer             ApiServer
+	AutoRefServer         *rcon.AutoRefServer
+	TeamServer            *rcon.TeamServer
+	CiServer              rcon.CiServer
+	Engine                Engine
+	statePreserver        StatePreserver
+	uiProtocolLastPublish []*ProtocolEntry
+	outstandingTeamChoice *TeamChoice
+	ConnectionMutex       sync.Mutex
+	PublishMutex          sync.Mutex
+	StateMutex            sync.Mutex
+	VisionReceiver        *vision.Receiver
 }
 
 // NewGameController creates a new RefBox
@@ -40,6 +40,7 @@ func NewGameController() (c *GameController) {
 	c.Publisher = NewPublisher(c.Config.Network.PublishAddress)
 	c.ApiServer = ApiServer{}
 	c.ApiServer.Consumer = c
+	c.uiProtocolLastPublish = []*ProtocolEntry{}
 
 	c.VisionReceiver = vision.NewReceiver(c.Config.Network.VisionAddress)
 	c.VisionReceiver.GeometryCallback = c.ProcessGeometry
@@ -161,9 +162,13 @@ func (c *GameController) publish() {
 
 // publishUiProtocol publishes the UI protocol, if it has changed
 func (c *GameController) publishUiProtocol() {
-	if len(c.Engine.PersistentState.Protocol) != c.numUiProtocolsLastPublish {
+	numNewEntries := len(c.Engine.PersistentState.Protocol)
+	numPreEntries := len(c.uiProtocolLastPublish)
+	if numNewEntries != numPreEntries ||
+		(numNewEntries > 0 && c.Engine.PersistentState.Protocol[numNewEntries-1] != c.uiProtocolLastPublish[numPreEntries-1]) {
 		c.ApiServer.PublishUiProtocol(c.Engine.PersistentState.Protocol)
-		c.numUiProtocolsLastPublish = len(c.Engine.PersistentState.Protocol)
+		c.uiProtocolLastPublish = make([]*ProtocolEntry, numNewEntries)
+		copy(c.uiProtocolLastPublish, c.Engine.PersistentState.Protocol)
 	}
 }
 

internal/app/controller/engine.go

@@ -212,6 +212,9 @@ func (e *Engine) countCardTime() bool {
 }
 
 func (e *Engine) SendCommand(command RefCommand, forTeam Team) {
+
+	e.LogCommand(command, forTeam, e.State.DeepCopy())
+
 	e.State.PrevCommands = append(e.State.PrevCommands, e.State.Command)
 	e.State.PrevCommandsFor = append(e.State.PrevCommandsFor, e.State.CommandFor)
 	if len(e.State.PrevCommands) > 10 {
@@ -232,8 +235,6 @@ func (e *Engine) SendCommand(command RefCommand, forTeam Team) {
 		e.State.PlacementPos = nil
 	}
 
-	e.LogCommand()
-
 	if command == CommandTimeout {
 		e.State.TeamState[forTeam].TimeoutsLeft--
 	} else if command == CommandNormalStart {
@@ -501,18 +502,16 @@ func (e *Engine) processEvent(event Event) error {
 }
 
 func (e *Engine) processRevertProtocolEntry(id string) error {
+	log.Printf("Revert protocol entry %v", id)
+
 	err := e.PersistentState.RevertProtocolEntry(id)
 	if err != nil {
 		return err
 	}
 	e.GcState = e.PersistentState.CurrentState
 	e.State = e.GcState.MatchState
 
-	if e.State.Command != CommandHalt {
-		e.SendCommand(CommandHalt, "")
-	}
-
-	log.Printf("Revert protocol entry %v", id)
+	e.SendCommand(CommandHalt, "")
 	return nil
 }
 

internal/app/controller/protocol.go

@@ -79,20 +79,21 @@ func (e *Engine) LogIgnoredGameEvent(event GameEvent) {
 }
 
 // LogCommand adds a command to the protocol
-func (e *Engine) LogCommand() {
+func (e *Engine) LogCommand(command RefCommand, commandFor Team, prevState *State) {
 	description := ""
 	if e.State.PlacementPos != nil {
 		description = fmt.Sprintf("place pos: %v", e.State.PlacementPos)
 	}
-	log.Printf("Log command '%v': %v", string(e.State.Command), description)
+	log.Printf("Log command '%v' for '%v': %v", string(command), commandFor, description)
 	entry := ProtocolEntry{
-		Id:          e.newGlobalProtocolEntryId(),
-		Timestamp:   e.TimeProvider().UnixNano(),
-		StageTime:   e.State.StageTimeElapsed,
-		Type:        UiProtocolCommand,
-		Name:        string(e.State.Command),
-		Team:        e.State.CommandFor,
-		Description: description,
+		Id:            e.newGlobalProtocolEntryId(),
+		Timestamp:     e.TimeProvider().UnixNano(),
+		StageTime:     e.State.StageTimeElapsed,
+		Type:          UiProtocolCommand,
+		Name:          string(command),
+		Team:          commandFor,
+		Description:   description,
+		PreviousState: prevState,
 	}
 	e.PersistentState.Add(&entry)
 }