Merge PR #4648: Flatten events by type when stringified

types/events.go

@@ -164,10 +164,26 @@ func (se StringEvents) String() string {
 	return strings.TrimRight(sb.String(), "\n")
 }
 
+// Flatten returns a flattened version of StringEvents by grouping all attributes
+// per unique event type.
+func (se StringEvents) Flatten() StringEvents {
+	flatEvents := make(map[string][]Attribute)
+
+	for _, e := range se {
+		flatEvents[e.Type] = append(flatEvents[e.Type], e.Attributes...)
+	}
+
+	var res StringEvents
+	for ty, attrs := range flatEvents {
+		res = append(res, StringEvent{Type: ty, Attributes: attrs})
+	}
+
+	return res
+}
+
 // StringifyEvent converts an Event object to a StringEvent object.
 func StringifyEvent(e abci.Event) StringEvent {
-	res := StringEvent{}
-	res.Type = e.Type
+	res := StringEvent{Type: e.Type}
 
 	for _, attr := range e.Attributes {
 		res.Attributes = append(
@@ -188,5 +204,5 @@ func StringifyEvents(events []abci.Event) StringEvents {
 		res = append(res, StringifyEvent(e))
 	}
 
-	return res
+	return res.Flatten()
 }

types/events_test.go

@@ -1,6 +1,7 @@
 package types
 
 import (
+	"encoding/json"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -51,3 +52,20 @@ func TestEventManager(t *testing.T) {
 	require.Len(t, em.Events(), 2)
 	require.Equal(t, em.Events(), events.AppendEvent(event))
 }
+
+func TestStringifyEvents(t *testing.T) {
+	e := Events{
+		NewEvent("message", NewAttribute("sender", "foo")),
+		NewEvent("message", NewAttribute("module", "bank")),
+	}
+	se := StringifyEvents(e.ToABCIEvents())
+
+	expectedTxtStr := "\t\t- message\n\t\t\t- sender: foo\n\t\t\t- module: bank"
+	require.Equal(t, expectedTxtStr, se.String())
+
+	bz, err := json.Marshal(se)
+	require.NoError(t, err)
+
+	expectedJSONStr := "[{\"type\":\"message\",\"attributes\":[{\"key\":\"sender\",\"value\":\"foo\"},{\"key\":\"module\",\"value\":\"bank\"}]}]"
+	require.Equal(t, expectedJSONStr, string(bz))
+}

types/result.go

@@ -240,7 +240,7 @@ func (r TxResponse) String() string {
 	}
 
 	if len(r.Events) > 0 {
-		sb.WriteString(fmt.Sprintf("  Tags: \n%s\n", r.Events.String()))
+		sb.WriteString(fmt.Sprintf("  Events: \n%s\n", r.Events.String()))
 	}
 
 	return strings.TrimSpace(sb.String())