[refactoring] Reduce ball placement failure to a single event

Author: g3force

internal/app/controller/engine.go

@@ -261,7 +261,7 @@ func (s *State) noTeamCanPlaceBall() bool {
 
 func (s *State) ballPlacementFailedBefore() bool {
 	for _, gameEvent := range s.GameEvents {
-		if gameEvent.Type == GameEventPlacementFailedByTeamInFavor {
+		if gameEvent.Type == GameEventPlacementFailed {
 			return true
 		}
 	}
@@ -608,7 +608,7 @@ func (e *Engine) processGameEvent(event *GameEvent) error {
 		e.addCard(&EventCard{Type: CardTypeRed, ForTeam: team, Operation: CardOperationAdd}, team, 0)
 	}
 
-	if event.IncrementsBallPlacementFailureCounter() {
+	if event.Type == GameEventPlacementFailed {
 		team := event.ByTeam()
 		if team.Unknown() {
 			return errors.New("Missing team in game event")
@@ -689,7 +689,7 @@ func (e *Engine) allTeamsFailedPlacement() bool {
 	}
 	failures := 0
 	for _, e := range e.State.GameEvents {
-		if e.Type == GameEventPlacementFailedByTeamInFavor {
+		if e.Type == GameEventPlacementFailed {
 			failures++
 			if failures >= possibleFailures {
 				return true

internal/app/controller/gameEvent.go

@@ -13,13 +13,12 @@ type GameEventType string
 const (
 	GameEventNone GameEventType = ""
 
-	GameEventPrepared                     GameEventType = "prepared"
-	GameEventNoProgressInGame             GameEventType = "noProgressInGame"
-	GameEventPlacementFailedByTeamInFavor GameEventType = "placementFailedByTeamInFavor"
-	GameEventPlacementFailedByOpponent    GameEventType = "placementFailedByOpponent"
-	GameEventPlacementSucceeded           GameEventType = "placementSucceeded"
-	GameEventBotSubstitution              GameEventType = "botSubstitution"
-	GameEventTooManyRobots                GameEventType = "tooManyRobots"
+	GameEventPrepared           GameEventType = "prepared"
+	GameEventNoProgressInGame   GameEventType = "noProgressInGame"
+	GameEventPlacementFailed    GameEventType = "placementFailed"
+	GameEventPlacementSucceeded GameEventType = "placementSucceeded"
+	GameEventBotSubstitution    GameEventType = "botSubstitution"
+	GameEventTooManyRobots      GameEventType = "tooManyRobots"
 
 	GameEventBallLeftFieldTouchLine GameEventType = "ballLeftFieldTouchLine"
 	GameEventBallLeftFieldGoalLine  GameEventType = "ballLeftFieldGoalLine"
@@ -64,8 +63,7 @@ var GameEventTypes = []GameEventType{
 	GameEventNone,
 	GameEventPrepared,
 	GameEventNoProgressInGame,
-	GameEventPlacementFailedByTeamInFavor,
-	GameEventPlacementFailedByOpponent,
+	GameEventPlacementFailed,
 	GameEventPlacementSucceeded,
 	GameEventBotSubstitution,
 	GameEventTooManyRobots,
@@ -161,8 +159,7 @@ func AllGameEvents() []GameEventType {
 		GameEventMultiplePlacementFailures,
 		GameEventKickTimeout,
 		GameEventNoProgressInGame,
-		GameEventPlacementFailedByTeamInFavor,
-		GameEventPlacementFailedByOpponent,
+		GameEventPlacementFailed,
 		GameEventPlacementSucceeded,
 		GameEventPrepared,
 		GameEventBotSubstitution,
@@ -223,15 +220,6 @@ func (e GameEvent) AddsRedCard() bool {
 	return false
 }
 
-func (e GameEvent) IncrementsBallPlacementFailureCounter() bool {
-	switch e.Type {
-	case GameEventPlacementFailedByTeamInFavor,
-		GameEventPlacementFailedByOpponent:
-		return true
-	}
-	return false
-}
-
 // IsSecondary checks if this game event is a secondary one that does not influence the next referee command
 func (e GameEvent) IsSecondary() bool {
 	switch e.Type {
@@ -346,10 +334,8 @@ func (e GameEvent) ToProto() *refproto.GameEvent {
 		protoEvent.Event = &refproto.GameEvent_KickTimeout_{KickTimeout: e.Details.KickTimeout}
 	case GameEventNoProgressInGame:
 		protoEvent.Event = &refproto.GameEvent_NoProgressInGame_{NoProgressInGame: e.Details.NoProgressInGame}
-	case GameEventPlacementFailedByTeamInFavor:
-		protoEvent.Event = &refproto.GameEvent_PlacementFailedByTeamInFavor_{PlacementFailedByTeamInFavor: e.Details.PlacementFailedByTeamInFavor}
-	case GameEventPlacementFailedByOpponent:
-		protoEvent.Event = &refproto.GameEvent_PlacementFailedByOpponent_{PlacementFailedByOpponent: e.Details.PlacementFailedByOpponent}
+	case GameEventPlacementFailed:
+		protoEvent.Event = &refproto.GameEvent_PlacementFailed_{PlacementFailed: e.Details.PlacementFailed}
 	case GameEventPlacementSucceeded:
 		protoEvent.Event = &refproto.GameEvent_PlacementSucceeded_{PlacementSucceeded: e.Details.PlacementSucceeded}
 	case GameEventPrepared:
@@ -400,8 +386,7 @@ type GameEventDetails struct {
 	MultiplePlacementFailures      *refproto.GameEvent_MultiplePlacementFailures      `json:"multiplePlacementFailures,omitempty"`
 	KickTimeout                    *refproto.GameEvent_KickTimeout                    `json:"kickTimeout,omitempty"`
 	NoProgressInGame               *refproto.GameEvent_NoProgressInGame               `json:"noProgressInGame,omitempty"`
-	PlacementFailedByTeamInFavor   *refproto.GameEvent_PlacementFailedByTeamInFavor   `json:"placementFailedByTeamInFavor,omitempty"`
-	PlacementFailedByOpponent      *refproto.GameEvent_PlacementFailedByOpponent      `json:"placementFailedByOpponent,omitempty"`
+	PlacementFailed                *refproto.GameEvent_PlacementFailed                `json:"placementFailed,omitempty"`
 	PlacementSucceeded             *refproto.GameEvent_PlacementSucceeded             `json:"placementSucceeded,omitempty"`
 	Prepared                       *refproto.GameEvent_Prepared                       `json:"prepared,omitempty"`
 	BotSubstitution                *refproto.GameEvent_BotSubstitution                `json:"botSubstitution,omitempty"`
@@ -509,11 +494,8 @@ func (d GameEventDetails) EventType() GameEventType {
 	if d.NoProgressInGame != nil {
 		return GameEventNoProgressInGame
 	}
-	if d.PlacementFailedByTeamInFavor != nil {
-		return GameEventPlacementFailedByTeamInFavor
-	}
-	if d.PlacementFailedByOpponent != nil {
-		return GameEventPlacementFailedByOpponent
+	if d.PlacementFailed != nil {
+		return GameEventPlacementFailed
 	}
 	if d.PlacementSucceeded != nil {
 		return GameEventPlacementSucceeded
@@ -718,10 +700,7 @@ func (d GameEventDetails) String() string {
 	if d.NoProgressInGame != nil {
 		return ""
 	}
-	if d.PlacementFailedByTeamInFavor != nil {
-		return ""
-	}
-	if d.PlacementFailedByOpponent != nil {
+	if d.PlacementFailed != nil {
 		return ""
 	}
 	if d.PlacementSucceeded != nil {
@@ -774,8 +753,7 @@ func GameEventDetailsFromProto(event refproto.GameEvent) (d GameEventDetails) {
 	d.MultiplePlacementFailures = event.GetMultiplePlacementFailures()
 	d.KickTimeout = event.GetKickTimeout()
 	d.NoProgressInGame = event.GetNoProgressInGame()
-	d.PlacementFailedByTeamInFavor = event.GetPlacementFailedByTeamInFavor()
-	d.PlacementFailedByOpponent = event.GetPlacementFailedByOpponent()
+	d.PlacementFailed = event.GetPlacementFailed()
 	d.PlacementSucceeded = event.GetPlacementSucceeded()
 	d.Prepared = event.GetPrepared()
 	d.BotSubstitution = event.GetBotSubstitution()

internal/app/controller/placementPos.go

@@ -95,9 +95,7 @@ func (e *Engine) BallPlacementPos() *Location {
 		return e.validateLocation(e.State.PlacementPos)
 	case GameEventNoProgressInGame:
 		return e.validateProtoLocation(event.Details.NoProgressInGame.Location)
-	case GameEventPlacementFailedByTeamInFavor:
-		return e.validateLocation(e.State.PlacementPos)
-	case GameEventPlacementFailedByOpponent:
+	case GameEventPlacementFailed:
 		return e.validateLocation(e.State.PlacementPos)
 	default:
 		log.Print("Warn: Unknown game event: ", event.Type)