add IParticipants.AllByUserID() method (#167) (#168)

Author: BestAwperEver

datatables_test.go

@@ -116,12 +116,14 @@ func testPlayerSpotted(t *testing.T, propName string) {
 func newParser() *Parser {
 	p := NewParser(new(DevNullReader))
 	p.header = &common.DemoHeader{}
+
 	return p
 }
 
 func fakePlayerEntity(id int) *fakest.Entity {
 	entity := new(fakest.Entity)
 	configurePlayerEntityMock(id, entity)
+
 	return entity
 }
 

demoinfocs_test.go

@@ -361,6 +361,7 @@ func BenchmarkConcurrent(b *testing.B) {
 func openFile(tb testing.TB, file string) *os.File {
 	f, err := os.Open(file)
 	assert.NoError(tb, err, "failed to open file %q", file)
+
 	return f
 }
 
@@ -369,6 +370,7 @@ func assertGolden(tb testing.TB, assertions *assert.Assertions, testCase string,
 	if ver := runtime.Version(); strings.Compare(ver, goldenVerificationGoVersionMin) < 0 {
 		tb.Logf("old go version %q detected, skipping golden file verification", ver)
 		tb.Logf("need at least version %q to compare against golden file", goldenVerificationGoVersionMin)
+
 		return
 	}
 

fake/participants.go

@@ -24,6 +24,11 @@ func (ptcp *Participants) ByEntityID() map[int]*common.Player {
 	return ptcp.Called().Get(0).(map[int]*common.Player)
 }
 
+// AllByUserID is a mock-implementation of IParticipants.AllByUserID().
+func (ptcp *Participants) AllByUserID() map[int]*common.Player {
+	return ptcp.Called().Get(0).(map[int]*common.Player)
+}
+
 // All is a mock-implementation of IParticipants.All().
 func (ptcp *Participants) All() []*common.Player {
 	return ptcp.Called().Get(0).([]*common.Player)

game_state.go

@@ -59,6 +59,7 @@ func (gs *GameState) Team(team common.Team) *common.TeamState {
 	} else if team == common.TeamCounterTerrorists {
 		return &gs.ctState
 	}
+
 	return nil
 }
 
@@ -179,6 +180,7 @@ func (ptcp Participants) ByUserID() map[int]*common.Player {
 			res[k] = v
 		}
 	}
+
 	return res
 }
 
@@ -190,6 +192,20 @@ func (ptcp Participants) ByEntityID() map[int]*common.Player {
 	for k, v := range ptcp.playersByEntityID {
 		res[k] = v
 	}
+
+	return res
+}
+
+// AllByUserID returns all currently known players & spectators, including disconnected ones,
+// in a map where the key is the user-ID.
+// The returned map is a snapshot and is not updated on changes (not a reference to the actual, underlying map).
+// Includes spectators.
+func (ptcp Participants) AllByUserID() map[int]*common.Player {
+	res := make(map[int]*common.Player)
+	for k, v := range ptcp.playersByUserID {
+		res[k] = v
+	}
+
 	return res
 }
 
@@ -200,6 +216,7 @@ func (ptcp Participants) All() []*common.Player {
 	for _, p := range ptcp.playersByUserID {
 		res = append(res, p)
 	}
+
 	return res
 }
 
@@ -210,6 +227,7 @@ func (ptcp Participants) Connected() []*common.Player {
 	for _, p := range original {
 		res = append(res, p)
 	}
+
 	return res
 }
 
@@ -222,6 +240,7 @@ func (ptcp Participants) Playing() []*common.Player {
 			res = append(res, p)
 		}
 	}
+
 	return res
 }
 
@@ -234,6 +253,7 @@ func (ptcp Participants) TeamMembers(team common.Team) []*common.Player {
 			res = append(res, p)
 		}
 	}
+
 	return res
 }
 
@@ -261,6 +281,7 @@ func (ptcp Participants) SpottersOf(spotted *common.Player) (spotters []*common.
 			spotters = append(spotters, other)
 		}
 	}
+
 	return
 }
 
@@ -271,5 +292,6 @@ func (ptcp Participants) SpottedBy(spotter *common.Player) (spotted []*common.Pl
 			spotted = append(spotted, other)
 		}
 	}
+
 	return
 }

game_state_test.go

@@ -41,17 +41,31 @@ func TestGameState_Participants(t *testing.T) {
 	ptcp := gs.Participants()
 	byEntity := ptcp.ByEntityID()
 	byUserID := ptcp.ByUserID()
+	allByUserID := ptcp.AllByUserID()
 
 	// Should update ptcp as well since it uses the same map
 	gs.playersByEntityID[0] = newPlayer()
 	gs.playersByUserID[0] = newPlayer()
 
 	assert.Equal(t, gs.playersByEntityID, ptcp.ByEntityID())
 	assert.Equal(t, gs.playersByUserID, ptcp.ByUserID())
+	assert.Equal(t, gs.playersByUserID, ptcp.AllByUserID())
 
 	// But should not update byEntity or byUserID since they're copies
 	assert.NotEqual(t, byEntity, ptcp.ByEntityID())
-	assert.NotEqual(t, byUserID, ptcp.ByUserID())
+	byUserID2 := ptcp.ByUserID()
+	assert.NotEqual(t, byUserID, byUserID2)
+	assert.Equal(t, gs.playersByUserID, ptcp.AllByUserID())
+
+	gs.playersByEntityID[1] = newDisconnectedPlayer()
+	gs.playersByUserID[1] = newDisconnectedPlayer()
+
+	assert.Equal(t, gs.playersByUserID, ptcp.AllByUserID())
+
+	assert.NotEqual(t, byEntity, ptcp.ByEntityID())
+	// Should be equal since ByUserID() do not return disconnected users
+	assert.Equal(t, byUserID2, ptcp.ByUserID())
+	assert.NotEqual(t, allByUserID, ptcp.ByUserID())
 }
 
 func TestGameState_ConVars(t *testing.T) {
@@ -264,5 +278,13 @@ func newPlayer() *common.Player {
 	pl := common.NewPlayer(nil)
 	pl.Entity = new(st.Entity)
 	pl.IsConnected = true
+
+	return pl
+}
+
+func newDisconnectedPlayer() *common.Player {
+	pl := common.NewPlayer(nil)
+	pl.Entity = new(st.Entity)
+
 	return pl
 }

participants_interface.go

@@ -20,6 +20,11 @@ type IParticipants interface {
 	// The returned map is a snapshot and is not updated on changes (not a reference to the actual, underlying map).
 	// Includes spectators.
 	ByEntityID() map[int]*common.Player
+	// AllByUserID returns all currently known players & spectators, including disconnected ones,
+	// in a map where the key is the user-ID.
+	// The returned map is a snapshot and is not updated on changes (not a reference to the actual, underlying map).
+	// Includes spectators.
+	AllByUserID() map[int]*common.Player
 	// All returns all currently known players & spectators, including disconnected ones, of the demo.
 	// The returned slice is a snapshot and is not updated on changes.
 	All() []*common.Player