core: index players by steam-ID for rank updates (#322)

fixes #320

Author: markus-wa

go.sum

@@ -22,8 +22,6 @@ github.com/markus-wa/go-heatmap v1.0.0 h1:UT3+9Re6Fr6h4Qs7y0QmVjlvbu+92E9tnuqKEh
 github.com/markus-wa/go-heatmap v1.0.0/go.mod h1:mUE6YBiMclq9MYXCb8fLbiWvyZtGglLrfMJ+LSHrlPA=
 github.com/markus-wa/go-unassert v0.1.2 h1:uXWlMDa8JVtc4RgNq4XJIjyRejv9MOVuy/E0VECPxxo=
 github.com/markus-wa/go-unassert v0.1.2/go.mod h1:XEvrxR+trvZeMDfXcZPvzqGo6eumEtdk5VjNRuvvzxQ=
-github.com/markus-wa/gobitread v0.2.3-0.20210710124713-58959e776f8b h1:iYFgASuNE8XtbTxjWq1AoO2uYJ4knR1AgsGfrW6byz4=
-github.com/markus-wa/gobitread v0.2.3-0.20210710124713-58959e776f8b/go.mod h1:PcWXMH4gx7o2CKslbkFkLyJB/aHW7JVRG3MRZe3PINg=
 github.com/markus-wa/gobitread v0.2.3 h1:COx7dtYQ7Q+77hgUmD+O4MvOcqG7y17RP3Z7BbjRvPs=
 github.com/markus-wa/gobitread v0.2.3/go.mod h1:PcWXMH4gx7o2CKslbkFkLyJB/aHW7JVRG3MRZe3PINg=
 github.com/markus-wa/godispatch v1.4.1 h1:Cdff5x33ShuX3sDmUbYWejk7tOuoHErFYMhUc2h7sLc=

pkg/demoinfocs/datatables.go

@@ -185,6 +185,8 @@ func (p *parser) getOrCreatePlayer(entityID int, rp *playerInfo) (isNew bool, pl
 				player.SteamID64 = rp.xuid
 				player.IsBot = rp.isFakePlayer || rp.guid == "BOT"
 				player.UserID = rp.userID
+
+				p.gameState.indexPlayerBySteamID(player)
 			}
 		} else {
 			// see #162.

pkg/demoinfocs/game_state.go

@@ -21,6 +21,7 @@ type gameState struct {
 	ctState              common.TeamState
 	playersByUserID      map[int]*common.Player            // Maps user-IDs to players
 	playersByEntityID    map[int]*common.Player            // Maps entity-IDs to players
+	playersBySteamID32   map[uint32]*common.Player         // Maps 32-bit-steam-IDs to players
 	playerResourceEntity st.Entity                         // CCSPlayerResource entity instance, contains scoreboard info and more
 	grenadeProjectiles   map[int]*common.GrenadeProjectile // Maps entity-IDs to active nade-projectiles. That's grenades that have been thrown, but have not yet detonated.
 	infernos             map[int]*common.Inferno           // Maps entity-IDs to active infernos.
@@ -52,6 +53,12 @@ func (gs *gameState) handleIngameTickNumber(n ingameTickNumber) {
 	debugIngameTick(gs.ingameTick)
 }
 
+func (gs *gameState) indexPlayerBySteamID(pl *common.Player) {
+	if !pl.IsBot && pl.SteamID64 > 0 {
+		gs.playersBySteamID32[common.ConvertSteamID64To32(pl.SteamID64)] = pl
+	}
+}
+
 // IngameTick returns the latest actual tick number of the server during the game.
 //
 // Watch out, I've seen this return wonky negative numbers at the start of demos.
@@ -179,6 +186,7 @@ func newGameState(demoInfo demoInfoProvider) *gameState {
 	gs := &gameState{
 		playersByEntityID:  make(map[int]*common.Player),
 		playersByUserID:    make(map[int]*common.Player),
+		playersBySteamID32: make(map[uint32]*common.Player),
 		grenadeProjectiles: make(map[int]*common.GrenadeProjectile),
 		infernos:           make(map[int]*common.Inferno),
 		weapons:            make(map[int]*common.Equipment),

pkg/demoinfocs/stringtables.go

@@ -67,6 +67,8 @@ func (p *parser) updatePlayerFromRawIfExists(index int, raw *playerInfo) {
 	pl.SteamID64 = raw.xuid
 	pl.IsBot = raw.isFakePlayer
 
+	p.gameState.indexPlayerBySteamID(pl)
+
 	if nameChanged {
 		p.eventDispatcher.Dispatch(events.PlayerNameChange{
 			Player:  pl,

pkg/demoinfocs/user_messages.go

@@ -5,7 +5,6 @@ import (
 
 	unassert "github.com/markus-wa/go-unassert"
 
-	common "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/common"
 	events "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events"
 	msg "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/msg"
 )
@@ -60,8 +59,10 @@ func (umh userMessageHandler) sayText(um *msg.CSVCMsg_UserMessage) {
 	err := st.Unmarshal(um.MsgData)
 
 	if err != nil {
-		umh.dispatch(events.ParserWarn{Message: fmt.Sprintf("failed to decode SayText message: %s", err.Error())})
-		unassert.Error("failed to decode SayText message: %s", err.Error())
+		errMsg := fmt.Sprintf("failed to decode SayText message: %s", err.Error())
+
+		umh.dispatch(events.ParserWarn{Message: errMsg})
+		unassert.Error(errMsg)
 	}
 
 	umh.dispatch(events.SayText{
@@ -77,8 +78,10 @@ func (umh userMessageHandler) sayText2(um *msg.CSVCMsg_UserMessage) {
 	err := st.Unmarshal(um.MsgData)
 
 	if err != nil {
-		umh.dispatch(events.ParserWarn{Message: fmt.Sprintf("failed to decode SayText2 message: %s", err.Error())})
-		unassert.Error("failed to decode SayText2 message: %s", err.Error())
+		errMsg := fmt.Sprintf("failed to decode SayText2 message: %s", err.Error())
+
+		umh.dispatch(events.ParserWarn{Message: errMsg})
+		unassert.Error(errMsg)
 	}
 
 	umh.dispatch(events.SayText2{
@@ -110,8 +113,10 @@ func (umh userMessageHandler) sayText2(um *msg.CSVCMsg_UserMessage) {
 	case "Cstrike_Chat_CT_Dead":
 
 	default:
-		umh.dispatch(events.ParserWarn{Message: fmt.Sprintf("skipped sending ChatMessageEvent for SayText2 with unknown MsgName %q", st.MsgName)})
-		unassert.Error("skipped sending ChatMessageEvent for SayText2 with unknown MsgName %q", st.MsgName)
+		errMsg := fmt.Sprintf("skipped sending ChatMessageEvent for SayText2 with unknown MsgName %q", st.MsgName)
+
+		umh.dispatch(events.ParserWarn{Message: errMsg})
+		unassert.Error(errMsg)
 	}
 }
 
@@ -120,17 +125,21 @@ func (umh userMessageHandler) rankUpdate(um *msg.CSVCMsg_UserMessage) {
 	err := st.Unmarshal(um.MsgData)
 
 	if err != nil {
-		umh.dispatch(events.ParserWarn{Message: fmt.Sprintf("failed to decode ServerRankUpdate message: %s", err.Error())})
-		unassert.Error("failed to decode ServerRankUpdate message: %s", err.Error())
+		errMsg := fmt.Sprintf("failed to decode ServerRankUpdate message: %s", err.Error())
+
+		umh.dispatch(events.ParserWarn{Message: errMsg})
+		unassert.Error(errMsg)
 	}
 
 	for _, v := range st.RankUpdate {
-		// find player (if he hasn't disconnected already)
-		var player *common.Player
-		for _, pl := range umh.parser.gameState.playersByUserID { //nolint:wsl
-			if pl.SteamID32() == uint32(v.AccountId) {
-				player = pl
-			}
+		// find player (or old instance if he has disconnected already)
+		steamID32 := uint32(v.AccountId)
+		player, ok := umh.parser.gameState.playersBySteamID32[steamID32]
+		if !ok {
+			errMsg := fmt.Sprintf("rank update for unknown player with SteamID32=%d", steamID32)
+
+			umh.dispatch(events.ParserWarn{Message: errMsg})
+			unassert.Error(errMsg)
 		}
 
 		umh.dispatch(events.RankUpdate{
@@ -149,8 +158,10 @@ func (umh userMessageHandler) roundImpactScoreData(um *msg.CSVCMsg_UserMessage)
 	err := impactData.Unmarshal(um.MsgData)
 
 	if err != nil {
-		umh.dispatch(events.ParserWarn{Message: fmt.Sprintf("failed to decode RoundImpactScoreData message: %s", err.Error())})
-		unassert.Error("failed to decode RoundImpactScoreData message: %s", err.Error())
+		errMsg := fmt.Sprintf("failed to decode RoundImpactScoreData message: %s", err.Error())
+
+		umh.dispatch(events.ParserWarn{Message: errMsg})
+		unassert.Error(errMsg)
 	}
 
 	umh.dispatch(events.RoundImpactScoreData{

pkg/demoinfocs/user_messages_test.go

@@ -36,6 +36,11 @@ func Test_UserMessages_ServerRankUpdate(t *testing.T) {
 
 	p := NewParser(new(DevNullReader)).(*parser)
 
+	plA := newPlayer()
+	plB := newPlayer()
+	p.gameState.playersBySteamID32[123] = plA
+	p.gameState.playersBySteamID32[456] = plB
+
 	var evs []events.RankUpdate
 	p.RegisterEventHandler(func(update events.RankUpdate) {
 		evs = append(evs, update)
@@ -49,12 +54,14 @@ func Test_UserMessages_ServerRankUpdate(t *testing.T) {
 		RankNew:    2,
 		WinCount:   5,
 		RankChange: 1,
+		Player:     plA,
 	}, {
 		SteamID32:  456,
 		RankOld:    2,
 		RankNew:    3,
 		WinCount:   6,
 		RankChange: 2,
+		Player:     plB,
 	}}
 	assert.Equal(t, expected, evs)
 }