refactor(plugin): update ILobbyClientListener signatures

xeruf · anarchuser · commit 8ae8328b123b · 2020-09-09T15:08:46.000+02:00
diff --git a/plugin/src/client/sc/plugin2020/AbstractClient.java b/plugin/src/client/sc/plugin2020/AbstractClient.java
@@ -2,6 +2,7 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import sc.api.plugins.IGameState;
 import sc.framework.plugins.Player;
 import sc.framework.plugins.protocol.MoveRequest;
 import sc.networking.clients.IControllableGame;
@@ -10,8 +11,8 @@
 import sc.plugin2020.util.Configuration;
 import sc.protocol.responses.PrepareGameProtocolMessage;
 import sc.protocol.responses.ProtocolErrorMessage;
+import sc.protocol.responses.ProtocolMessage;
 import sc.shared.GameResult;
-import sc.api.plugins.ITeam;
 import sc.shared.WelcomeMessage;
 
 import java.io.IOException;
@@ -76,7 +77,7 @@ public IControllableGame observeGame(PrepareGameProtocolMessage handle) {
 
   /** Called when a new message is sent to the room, e.g. move requests. */
   @Override
-  public void onRoomMessage(String roomId, Object data) {
+  public void onRoomMessage(String roomId, ProtocolMessage data) {
     if(data instanceof MoveRequest) {
       this.handler.onRequestAction();
     } else if(data instanceof WelcomeMessage) {
@@ -102,7 +103,7 @@ public void onError(String roomId, ProtocolErrorMessage response) {
    * Happens after a client made a move.
    */
   @Override
-  public void onNewState(String roomId, Object state) {
+  public void onNewState(String roomId, IGameState state) {
     sc.plugin2020.GameState gameState = (GameState) state;
     logger.debug("{} got new state {}", this, gameState);
 
diff --git a/plugin/src/client/sc/plugin2021/AbstractClient.kt b/plugin/src/client/sc/plugin2021/AbstractClient.kt
@@ -1,6 +1,7 @@
 package sc.plugin2021
 
 import org.slf4j.LoggerFactory
+import sc.api.plugins.IGameState
 import sc.framework.plugins.Player
 import sc.framework.plugins.protocol.MoveRequest
 import sc.networking.clients.IControllableGame
@@ -9,6 +10,7 @@ import sc.networking.clients.LobbyClient
 import sc.plugin2021.util.Configuration
 import sc.protocol.responses.PrepareGameProtocolMessage
 import sc.protocol.responses.ProtocolErrorMessage
+import sc.protocol.responses.ProtocolMessage
 import sc.shared.GameResult
 import sc.shared.WelcomeMessage
 import java.io.IOException
@@ -54,7 +56,7 @@ abstract class AbstractClient @Throws(IOException::class) constructor(
     fun getError() = error
     
     /** Current room of the player. */
-    private lateinit var roomID: String
+    private lateinit var roomId: String
     
     /** The team the client belongs to in order to connect client and player. */
     private var team: Team? = when(type) {
@@ -68,19 +70,19 @@ abstract class AbstractClient @Throws(IOException::class) constructor(
             client.observe(handle)
     
     /** Called for any new message sent to the game room, e.g., move requests. */
-    override fun onRoomMessage(roomId: String, data: Any) {
+    override fun onRoomMessage(roomId: String, data: ProtocolMessage) {
         if(data is MoveRequest) {
             handler.onRequestAction()
         }
         if(data is WelcomeMessage) {
             team = Team.valueOf(data.color.toUpperCase())
         }
-        roomID = roomId
+        this.roomId = roomId
     }
     
     /** Sends the selected move to the server. */
     fun sendMove(move: Move) =
-            client.sendMessageToRoom(roomID, move)
+            client.sendMessageToRoom(roomId, move)
     
     /** Called when an erroneous message is sent to the room. */
     override fun onError(roomId: String, error: ProtocolErrorMessage) {
@@ -92,7 +94,7 @@ abstract class AbstractClient @Throws(IOException::class) constructor(
      * Called when game state has been received.
      * Happens after a client made a move.
      */
-    override fun onNewState(roomId: String, state: Any) {
+    override fun onNewState(roomId: String, state: IGameState) {
         val gameState = state as GameState
         logger.debug("$this got a new state $gameState")
         
@@ -124,7 +126,7 @@ abstract class AbstractClient @Throws(IOException::class) constructor(
     override fun onGameObserved(roomId: String) {}
     
     override fun onGameLeft(roomId: String) {
-        logger.info("$this got game left $roomID")
+        logger.info("$this got game left ${this.roomId}")
         client.stop()
     }
     
diff --git a/server/test/sc/server/client/TestLobbyClientListener.java b/server/test/sc/server/client/TestLobbyClientListener.java
@@ -1,9 +1,11 @@
 package sc.server.client;
 
+import sc.api.plugins.IGameState;
 import sc.framework.plugins.Player;
 import sc.networking.clients.ILobbyClientListener;
 import sc.protocol.responses.PrepareGameProtocolMessage;
 import sc.protocol.responses.ProtocolErrorMessage;
+import sc.protocol.responses.ProtocolMessage;
 import sc.shared.GameResult;
 
 public class TestLobbyClientListener implements ILobbyClientListener {
@@ -45,7 +47,7 @@ public boolean equals(Object obj) {
   }
 
   @Override
-  public void onNewState(String roomId, Object state) {
+  public void onNewState(String roomId, IGameState state) {
     newStateReceived = true;
     this.roomId = roomId;
     this.newState = state;
@@ -59,7 +61,7 @@ public void onError(String roomId, ProtocolErrorMessage error) {
   }
 
   @Override
-  public void onRoomMessage(String roomId, Object data) {
+  public void onRoomMessage(String roomId, ProtocolMessage data) {
     roomMessageReceived = true;
     this.roomId = roomId;
     this.roomMessage = data;
diff --git a/server/test/sc/server/client/TestObserverListener.java b/server/test/sc/server/client/TestObserverListener.java
@@ -1,9 +1,11 @@
 package sc.server.client;
 
+import sc.api.plugins.IGameState;
 import sc.framework.plugins.Player;
 import sc.networking.clients.ILobbyClientListener;
 import sc.protocol.responses.PrepareGameProtocolMessage;
 import sc.protocol.responses.ProtocolErrorMessage;
+import sc.protocol.responses.ProtocolMessage;
 import sc.shared.GameResult;
 
 public class TestObserverListener implements ILobbyClientListener {
@@ -16,15 +18,15 @@ public void onGameObserved(String roomId) {
   }
 
   @Override
-  public void onNewState(String roomId, Object state) {
+  public void onNewState(String roomId, IGameState state) {
   }
 
   @Override
   public void onError(String roomId, ProtocolErrorMessage error) {
   }
 
   @Override
-  public void onRoomMessage(String roomId, Object data) {
+  public void onRoomMessage(String roomId, ProtocolMessage data) {
   }
 
   @Override
diff --git a/server/test/sc/server/client/TestPreparedGameResponseListener.java b/server/test/sc/server/client/TestPreparedGameResponseListener.java
@@ -1,9 +1,11 @@
 package sc.server.client;
 
+import sc.api.plugins.IGameState;
 import sc.framework.plugins.Player;
 import sc.networking.clients.ILobbyClientListener;
 import sc.protocol.responses.PrepareGameProtocolMessage;
 import sc.protocol.responses.ProtocolErrorMessage;
+import sc.protocol.responses.ProtocolMessage;
 import sc.shared.GameResult;
 
 public class TestPreparedGameResponseListener implements ILobbyClientListener {
@@ -16,15 +18,15 @@ public void onGamePrepared(PrepareGameProtocolMessage gameResponse) {
   }
 
   @Override
-  public void onNewState(String roomId, Object state) {
+  public void onNewState(String roomId, IGameState state) {
   }
 
   @Override
   public void onError(String roomId, ProtocolErrorMessage error) {
   }
 
   @Override
-  public void onRoomMessage(String roomId, Object data) {
+  public void onRoomMessage(String roomId, ProtocolMessage data) {
   }
 
   @Override
diff --git a/socha-sdk/src/server-api/sc/networking/clients/ILobbyClientListener.java b/socha-sdk/src/server-api/sc/networking/clients/ILobbyClientListener.java
@@ -1,18 +1,19 @@
 package sc.networking.clients;
 
-import sc.api.plugins.ITeam;
+import sc.api.plugins.IGameState;
 import sc.framework.plugins.Player;
 import sc.protocol.responses.ProtocolErrorMessage;
 import sc.protocol.responses.PrepareGameProtocolMessage;
+import sc.protocol.responses.ProtocolMessage;
 import sc.shared.GameResult;
 
 public interface ILobbyClientListener {
 
-  void onNewState(String roomId, Object state);
+  void onNewState(String roomId, IGameState state);
 
-  void onError(String roomId, ProtocolErrorMessage error);
+  void onRoomMessage(String roomId, ProtocolMessage data);
 
-  void onRoomMessage(String roomId, Object data);
+  void onError(String roomId, ProtocolErrorMessage error);
 
   void onGamePrepared(PrepareGameProtocolMessage response);
 
diff --git a/socha-sdk/src/server-api/sc/networking/clients/LobbyClient.java b/socha-sdk/src/server-api/sc/networking/clients/LobbyClient.java
@@ -220,6 +220,12 @@ protected void onNewState(String roomId, IGameState state) {
     }
   }
 
+  protected void onRoomMessage(String roomId, ProtocolMessage data) {
+    for (ILobbyClientListener listener : this.listeners) {
+      listener.onRoomMessage(roomId, data);
+    }
+  }
+
   protected void onError(String roomId, ProtocolErrorMessage error) {
     if (error.getOriginalRequest() != null) {
       logger.warn("The request {} caused the following error: {}",
@@ -239,12 +245,6 @@ public void sendMessageToRoom(String roomId, ProtocolMessage o) {
     send(new RoomPacket(roomId, o));
   }
 
-  protected void onRoomMessage(String roomId, ProtocolMessage data) {
-    for (ILobbyClientListener listener : this.listeners) {
-      listener.onRoomMessage(roomId, data);
-    }
-  }
-
   /**
    * used in server
    *

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,11 @@`
`1`	`1`	`package sc.server.client;`
`2`	`2`
	`3`	`+import sc.api.plugins.IGameState;`
`3`	`4`	`import sc.framework.plugins.Player;`
`4`	`5`	`import sc.networking.clients.ILobbyClientListener;`
`5`	`6`	`import sc.protocol.responses.PrepareGameProtocolMessage;`
`6`	`7`	`import sc.protocol.responses.ProtocolErrorMessage;`
	`8`	`+import sc.protocol.responses.ProtocolMessage;`
`7`	`9`	`import sc.shared.GameResult;`
`8`	`10`
`9`	`11`	`public class TestObserverListener implements ILobbyClientListener {`
`@@ -16,15 +18,15 @@ public void onGameObserved(String roomId) {`
`16`	`18`	`}`
`17`	`19`
`18`	`20`	`@Override`
`19`		`- public void onNewState(String roomId, Object state) {`
	`21`	`+ public void onNewState(String roomId, IGameState state) {`
`20`	`22`	`}`
`21`	`23`
`22`	`24`	`@Override`
`23`	`25`	`public void onError(String roomId, ProtocolErrorMessage error) {`
`24`	`26`	`}`
`25`	`27`
`26`	`28`	`@Override`
`27`		`- public void onRoomMessage(String roomId, Object data) {`
	`29`	`+ public void onRoomMessage(String roomId, ProtocolMessage data) {`
`28`	`30`	`}`
`29`	`31`
`30`	`32`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -220,6 +220,12 @@ protected void onNewState(String roomId, IGameState state) {`
`220`	`220`	`}`
`221`	`221`	`}`
`222`	`222`
	`223`	`+ protected void onRoomMessage(String roomId, ProtocolMessage data) {`
	`224`	`+ for (ILobbyClientListener listener : this.listeners) {`
	`225`	`+ listener.onRoomMessage(roomId, data);`
	`226`	`+ }`
	`227`	`+ }`
	`228`	`+`
`223`	`229`	`protected void onError(String roomId, ProtocolErrorMessage error) {`
`224`	`230`	`if (error.getOriginalRequest() != null) {`
`225`	`231`	`logger.warn("The request {} caused the following error: {}",`
`@@ -239,12 +245,6 @@ public void sendMessageToRoom(String roomId, ProtocolMessage o) {`
`239`	`245`	`send(new RoomPacket(roomId, o));`
`240`	`246`	`}`
`241`	`247`
`242`		`- protected void onRoomMessage(String roomId, ProtocolMessage data) {`
`243`		`- for (ILobbyClientListener listener : this.listeners) {`
`244`		`- listener.onRoomMessage(roomId, data);`
`245`		`- }`
`246`		`- }`
`247`		`-`
`248`	`248`	`/**`
`249`	`249`	`* used in server`
`250`	`250`	`*`