fix(server): send GamePaused message on pause

Author: xeruf

plugin/src/test/sc/plugin2021/GameTest.kt

@@ -45,9 +45,6 @@ class GameTest: WordSpec({
                     // hashing it to avoid cloning, since we get the original mutable object
                     finalState = data.hashCode()
                 }
-        
-                override fun onPaused(nextPlayer: Player) {
-                }
             })
 
             "finish without issues".config(invocationTimeout = Constants.GAME_TIMEOUT.milliseconds) {

sdk/src/server-api/sc/api/plugins/host/IGameListener.kt

@@ -7,5 +7,4 @@ import sc.shared.PlayerScore
 interface IGameListener {
     fun onGameOver(results: Map<Player, PlayerScore>)
     fun onStateChanged(data: IGameState, observersOnly: Boolean)
-    fun onPaused(nextPlayer: Player)
 }

sdk/src/server-api/sc/networking/clients/AbstractLobbyClientListener.kt

@@ -1,7 +1,6 @@
 package sc.networking.clients
 
 import sc.api.plugins.IGameState
-import sc.framework.plugins.Player
 import sc.protocol.room.RoomMessage
 import sc.protocol.responses.GamePreparedResponse
 import sc.protocol.responses.ErrorPacket
@@ -10,7 +9,6 @@ import sc.shared.GameResult
 abstract class AbstractLobbyClientListener: ILobbyClientListener {
     override fun onNewState(roomId: String, state: IGameState) {}
     override fun onGameOver(roomId: String, data: GameResult) {}
-    override fun onGamePaused(roomId: String, nextPlayer: Player) {}
     override fun onRoomMessage(roomId: String, data: RoomMessage) {}
 
     override fun onError(error: ErrorPacket) {}

sdk/src/server-api/sc/networking/clients/ILobbyClientListener.kt

@@ -1,7 +1,6 @@
 package sc.networking.clients
 
 import sc.api.plugins.IGameState
-import sc.framework.plugins.Player
 import sc.protocol.room.RoomMessage
 import sc.protocol.responses.GamePreparedResponse
 import sc.protocol.responses.ErrorPacket
@@ -12,7 +11,6 @@ import sc.shared.GameResult
 interface ILobbyClientListener {
     fun onNewState(roomId: String, state: IGameState)
     fun onGameOver(roomId: String, data: GameResult)
-    fun onGamePaused(roomId: String, nextPlayer: Player)
     fun onRoomMessage(roomId: String, data: RoomMessage)
     fun onError(error: ErrorPacket)
 

sdk/src/server-api/sc/networking/clients/LobbyClient.java

@@ -53,8 +53,6 @@ protected final void onObject(ProtocolPacket message) {
           onNewState(roomId, ((MementoMessage) data).getState());
         } else if (data instanceof GameResult) {
           onGameOver(roomId, (GameResult) data);
-        } else if (data instanceof GamePaused) {
-          onGamePaused(roomId, ((GamePaused) data).getNextPlayer());
         } else if (data instanceof ErrorMessage) {
           ErrorMessage error = (ErrorMessage) data;
           logger.warn("{} in room {}", error.getLogMessage(), roomId);
@@ -88,12 +86,6 @@ protected final void onObject(ProtocolPacket message) {
     }
   }
 
-  private void onGamePaused(String roomId, Player nextPlayer) {
-    for (ILobbyClientListener listener : this.listeners) {
-      listener.onGamePaused(roomId, nextPlayer);
-    }
-  }
-
   private void onGameOver(String roomId, GameResult data) {
     logger.info("Received game result: {}", data);
     for (IHistoryListener listener : this.historyListeners) {

sdk/src/server-api/sc/protocol/room/GamePaused.kt

@@ -3,15 +3,9 @@ package sc.protocol.room
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 
-import sc.framework.plugins.Player
-
-/**
- * Indicates to observers that the game has been paused.
- *
- * @param nextPlayer the next Player to move after unpausing.
- */
+/** Indicates to observers that the game has been (un)paused. */
 @XStreamAlias(value = "paused")
 data class GamePaused(
         @XStreamAsAttribute
-        val nextPlayer: Player
+        val paused: Boolean
 ): ObservableRoomMessage

server/src/sc/server/Lobby.kt

@@ -4,6 +4,7 @@ import org.slf4j.LoggerFactory
 import sc.api.plugins.IMove
 import sc.api.plugins.exceptions.GameRoomException
 import sc.api.plugins.exceptions.RescuableClientException
+import sc.protocol.ProtocolPacket
 import sc.protocol.requests.*
 import sc.protocol.responses.PlayerScoreResponse
 import sc.protocol.responses.TestModeResponse
@@ -27,6 +28,11 @@ class Lobby: GameRoomManager(), Closeable, IClientRequestListener {
         clientManager.start()
     }
 
+    private fun notifyObservers(packet: ProtocolPacket) =
+            clientManager.clients
+                    .filter { it.isAdministrator }
+                    .forEach { it.send(packet) }
+    
     /** Handle requests or moves of clients.
      * @throws RescuableClientException if something goes wrong.
      *         Usually results in termination of the connection to the offending client. */
@@ -47,13 +53,8 @@ class Lobby: GameRoomManager(), Closeable, IClientRequestListener {
                 if(!this.findRoom(packet.roomId).join(source))
                     throw GameRoomException("Room ${packet.roomId} is already full!")
             is JoinGameRequest -> {
-                val gameRoomMessage = this.joinOrCreateGame(source, packet.gameType)
-                // null is returned if join was unsuccessful
-                if (gameRoomMessage != null) {
-                    clientManager.clients
-                            .filter { it.isAdministrator }
-                            .forEach { it.send(gameRoomMessage) }
-                }
+                joinOrCreateGame(source, packet.gameType)
+                        ?.let { notifyObservers(it) }
             }
             is AuthenticateRequest -> source.authenticate(packet.password)
             is AdminLobbyRequest -> {

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

@@ -359,8 +359,8 @@ public void addObserver(Client source) {
 
   /**
    * Pause or un-pause a game.
-   *
    * @param pause true if game is to be paused
+   * @return a RoomPacket with a GamePaused message or null if unsuccessful
    */
   public synchronized void pause(boolean pause) {
     if (isOver()) {
@@ -379,10 +379,11 @@ public synchronized void pause(boolean pause) {
     // pause game after current turn has finished
     pausableGame.setPaused(pause);
 
-    // continue execution
     if (!pause && status == GameStatus.ACTIVE) {
+      // continue execution
       pausableGame.afterPause();
     }
+    observerBroadcast(new GamePaused(pause));
   }
 
   /**
@@ -421,16 +422,6 @@ private void destroy() {
     this.gameRoomManager.remove(this);
   }
 
-  /**
-   * Broadcast to all observers that the game is paused.
-   *
-   * @param nextPlayer Player who comes next after the pause
-   */
-  @Override
-  public void onPaused(Player nextPlayer) {
-    observerBroadcast(new GamePaused(nextPlayer));
-  }
-
   /** Return true if GameStatus is OVER. */
   public boolean isOver() {
     return getStatus() == GameStatus.OVER;

server/test/sc/server/client/TestLobbyClientListener.java

@@ -92,13 +92,6 @@ public void onGameOver(String roomId, GameResult data) {
     gameOverReceived = true;
   }
 
-  @Override
-  public void onGamePaused(String roomId, Player nextPlayer) {
-    this.roomId = roomId;
-    this.player = nextPlayer;
-    gamePausedReceived = true;
-  }
-
   @Override
   public void onGameObserved(String roomId) {
     this.roomId = roomId;

server/test/sc/server/network/LobbyRequestTest.kt

@@ -162,8 +162,7 @@ class LobbyRequestTest: WordSpec({
 
                 val controller = admin.control(prepared.roomId)
                 controller.pause()
-                // TODO pausing is currently not acknowledged
-                // roomListener.waitForMessage(GamePaused::class)
+                roomListener.waitForMessage(GamePaused::class)
                 withClue("appropriate result for aborted game") {
                     players[1].sendMessageToRoom(prepared.roomId, TestMove(0))
                     val result = roomListener.waitForMessage(GameResult::class)