Refactoring: Serialize some data classes as JSON in log

Author: g3force

internal/app/engine/config.go

@@ -72,3 +72,12 @@ func (m *Config) WriteTo(fileName string) (err error) {
 	log.Printf("Written to %v", fileName)
 	return
 }
+
+func (m *Config) StringJson() string {
+	marshaler := jsonpb.Marshaler{}
+	if str, err := marshaler.MarshalToString(m); err != nil {
+		return err.Error()
+	} else {
+		return str
+	}
+}

internal/app/engine/engine.go

@@ -232,7 +232,7 @@ func (e *Engine) ResetMatch() {
 func (e *Engine) processChange(change *statemachine.Change) {
 	e.mutex.Lock()
 	defer e.mutex.Unlock()
-	log.Printf("Engine: Process change '%v'", change)
+	log.Printf("Engine: Process change '%v'", change.StringJson())
 
 	var newChanges []*statemachine.Change
 	entry := statemachine.StateChange{}
@@ -294,7 +294,7 @@ func (e *Engine) processChange(change *statemachine.Change) {
 		}
 	}
 
-	log.Printf("Change '%v' processed", change)
+	log.Printf("Change '%v' processed", change.StringJson())
 }
 
 // initialStateFromStore gets the current state or returns a new default state
@@ -342,7 +342,7 @@ func (e *Engine) GetConfig() *Config {
 func (e *Engine) UpdateConfig(delta *Config) {
 	e.mutex.Lock()
 	defer e.mutex.Unlock()
-	log.Printf("Process config delta change %v", delta)
+	log.Printf("Process config delta change %v", delta.StringJson())
 	for k, v := range delta.GameEventBehavior {
 		e.config.GameEventBehavior[k] = v
 	}
@@ -355,7 +355,7 @@ func (e *Engine) UpdateConfig(delta *Config) {
 			e.config.AutoRefConfigs[autoRef].GameEventBehavior[k] = v
 		}
 	}
-	log.Printf("Engine config updated to %v", e.config)
+	log.Printf("Engine config updated to %v", e.config.StringJson())
 	if err := e.config.WriteTo(e.engineConfig.ConfigFilename); err != nil {
 		log.Printf("Could not write engine config: %v", err)
 	}

internal/app/state/state.go

@@ -1,6 +1,7 @@
 package state
 
 import (
+	"github.com/golang/protobuf/jsonpb"
 	"github.com/golang/protobuf/proto"
 	"github.com/golang/protobuf/ptypes/duration"
 	"github.com/golang/protobuf/ptypes/timestamp"
@@ -54,3 +55,12 @@ func (m *State) TeamByName(name string) Team {
 	}
 	return Team_UNKNOWN
 }
+
+func (m *State) StringJson() string {
+	marshaler := jsonpb.Marshaler{}
+	if str, err := marshaler.MarshalToString(m); err != nil {
+		return err.Error()
+	} else {
+		return str
+	}
+}

internal/app/statemachine/change.go

@@ -0,0 +1,12 @@
+package statemachine
+
+import "github.com/golang/protobuf/jsonpb"
+
+func (m *Change) StringJson() string {
+	marshaler := jsonpb.Marshaler{}
+	if str, err := marshaler.MarshalToString(m); err != nil {
+		return err.Error()
+	} else {
+		return str
+	}
+}

internal/app/statemachine/statemachine.go

@@ -56,7 +56,7 @@ func (s *StateMachine) Process(currentState *state.State, change *Change) (newSt
 
 	newState = new(state.State)
 	proto.Merge(newState, currentState)
-	log.Printf("Processing change '%v'", change)
+	log.Printf("Processing change '%v'", change.StringJson())
 	if change.GetNewCommand() != nil {
 		newChanges = s.processChangeNewCommand(newState, change.GetNewCommand())
 	} else if change.GetChangeStage() != nil {
@@ -90,14 +90,14 @@ func (s *StateMachine) Process(currentState *state.State, change *Change) (newSt
 	} else if change.GetAcceptProposalGroup() != nil {
 		newChanges = s.processChangeAcceptProposals(newState, change.GetAcceptProposalGroup())
 	} else {
-		log.Println("Unhandled change in state machine: ", change)
+		log.Println("Unhandled change in state machine: ", change.StringJson())
 	}
 
 	for i := range newChanges {
 		newChanges[i].Origin = new(string)
 		*newChanges[i].Origin = changeOriginStateMachine
 	}
-	log.Printf("Change '%v' processed:\nfrom: %v\n  to: %v", change, currentState, newState)
+	log.Printf("Change '%v' processed:\nfrom: %v\n  to: %v", change.StringJson(), currentState.StringJson(), newState.StringJson())
 
 	return
 }