feat(network): send playerCount in RoomWasJoinedEvent

Author: xeruf

sdk/src/server-api/sc/protocol/responses/RoomWasJoinedEvent.kt

@@ -4,12 +4,12 @@ import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 import sc.protocol.ResponsePacket
 
-/** Sent to all administrative clients when a player joined a game via a JoinRoomRequest.
- * @param existing whether the joined room has existed beforehand or was newly created. */
+/** Sent to all administrative clients after a player joined a GameRoom via a JoinRoomRequest.
+ * @param playerCount the number of players in the room after the join. */
 @XStreamAlias(value = "joinedGameRoom")
 data class RoomWasJoinedEvent(
         @XStreamAsAttribute
         val roomId: String,
         @XStreamAsAttribute
-        val existing: Boolean
+        val playerCount: Int
 ): ResponsePacket

server/src/sc/server/gaming/GameRoom.java

@@ -30,6 +30,7 @@
 import java.io.FileWriter;
 import java.io.IOException;
 import java.util.*;
+import java.util.stream.Collectors;
 
 /**
  * A wrapper for an actual <code>GameInstance</code>. GameInstances are provided
@@ -48,7 +49,7 @@ public class GameRoom implements IGameListener {
   private boolean pauseRequested = false;
   private ObservingClient replayObserver;
 
-  public final IGameInstance game;
+  public final IGameInstance game; // TODO make inaccessible
   public final List<ObserverRole> observers = new ArrayList<>();
 
   public enum GameStatus {
@@ -461,23 +462,19 @@ private Player resolvePlayer(Client client) throws GameRoomException {
   }
 
   /** Get {@link PlayerRole Players} that occupy a slot. */
-  private Collection<PlayerRole> getPlayers() {
-    ArrayList<PlayerRole> clients = new ArrayList<>();
-    for (PlayerSlot slot : this.playerSlots) {
-      if (!slot.isEmpty()) {
-        clients.add(slot.getRole());
-      }
-    }
-    return clients;
+  public Collection<PlayerRole> getPlayers() {
+    return playerSlots.stream()
+        .filter(p -> !p.isEmpty())
+        .map(PlayerSlot::getRole)
+        .collect(Collectors.toList());
   }
 
   /** Get Server {@link IClient Clients} of all {@link PlayerRole Players}. */
   public Collection<IClient> getClients() {
-    ArrayList<IClient> clients = new ArrayList<>();
-    for (PlayerRole slot : getPlayers()) {
-      clients.add(slot.getClient());
-    }
-    return clients;
+    return playerSlots.stream()
+        .filter(p -> !p.isEmpty())
+        .map(PlayerSlot::getClient)
+        .collect(Collectors.toList());
   }
 
   /** Add a Server {@link Client Client} in the role of an Observer. */

server/src/sc/server/gaming/GameRoomManager.java

@@ -128,7 +128,7 @@ public synchronized RoomWasJoinedEvent createAndJoinGame(Client client, String g
           throws RescuableClientException {
     GameRoom room = createGame(gameType);
     if (room.join(client)) {
-      return new RoomWasJoinedEvent(room.getId(), false);
+      return roomJoined(room);
     }
     return null;
   }
@@ -144,13 +144,16 @@ public synchronized RoomWasJoinedEvent joinOrCreateGame(Client client, String ga
           throws RescuableClientException {
     for (GameRoom gameRoom : getGames()) {
       if (gameRoom.join(client)) {
-        return new RoomWasJoinedEvent(gameRoom.getId(), true);
+        return roomJoined(gameRoom);
       }
     }
-
     return createAndJoinGame(client, gameType);
   }
 
+  private RoomWasJoinedEvent roomJoined(GameRoom room) {
+    return new RoomWasJoinedEvent(room.getId(), room.getPlayers().size());
+  }
+
   /** Create an unmodifiable Collection of the {@link GameRoom GameRooms}. */
   public synchronized Collection<GameRoom> getGames() {
     return Collections.unmodifiableCollection(this.rooms.values());

server/test/sc/server/gaming/GameRoomTest.kt

@@ -22,16 +22,14 @@ class GameRoomTest: WordSpec({
         // TODO Replay observing
         // Configuration.set(Configuration.SAVE_REPLAY, "true")
         "create a game when a player joins" {
-            manager.joinOrCreateGame(client, TestPlugin.TEST_PLUGIN_UUID).existing shouldBe false
+            manager.joinOrCreateGame(client, TestPlugin.TEST_PLUGIN_UUID).playerCount shouldBe 1
             manager.games shouldHaveSize 1
-            manager.games.single().game.players shouldHaveSize 1
         }
+        val room = manager.games.single()
         "add a second player to the existing game" {
-            manager.joinOrCreateGame(client, TestPlugin.TEST_PLUGIN_UUID).existing shouldBe true
-            manager.games.single().game.players shouldHaveSize 2
+            manager.joinOrCreateGame(client, TestPlugin.TEST_PLUGIN_UUID).playerCount shouldBe 2
         }
         "return correct scores on game over" {
-            val room = manager.games.single()
             val playersScores = room.game.players.associateWith { PlayerScore(ScoreCause.REGULAR, "Game terminated", 0) }
             room.onGameOver(playersScores)
             room.result.isRegular shouldBe true
@@ -64,11 +62,9 @@ class GameRoomTest: WordSpec({
             }
             room.clients shouldHaveSize 1
         }
-        room.game.players shouldHaveSize 0
         "accept a second client and create Players" {
             ReservationManager.redeemReservationCode(client, reservations[1])
             room.clients shouldHaveSize 2
-            room.game.players shouldHaveSize 2
         }
         "reject a third client" {
             room.join(client) shouldBe false