refactor(network): name parameters in XStreamClient

xeruf · xeruf · commit 5c6c619951d0 · 2021-04-28T18:36:23.000+02:00
diff --git a/.dev/scopes.txt b/.dev/scopes.txt
@@ -13,4 +13,4 @@ gamerules
 
 sdk
 framework
-protocol
+network
diff --git a/helpers/test-client/src/sc/TestClient.java b/helpers/test-client/src/sc/TestClient.java
@@ -4,11 +4,10 @@
 import ch.qos.logback.classic.Logger;
 import jargs.gnu.CmdLineParser;
 import jargs.gnu.CmdLineParser.Option;
+import org.jetbrains.annotations.NotNull;
 import org.slf4j.LoggerFactory;
 import sc.api.plugins.IGamePlugin;
 import sc.framework.plugins.Player;
-import sc.networking.INetworkInterface;
-import sc.networking.TcpNetwork;
 import sc.networking.clients.XStreamClient;
 import sc.protocol.requests.*;
 import sc.protocol.responses.*;
@@ -17,7 +16,6 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.net.Socket;
 import java.util.Arrays;
 import java.util.List;
 import java.util.ServiceLoader;
@@ -145,7 +143,7 @@ public static void main(String[] args) {
   }
 
   private static File findInClasspath(File location) {
-    if(!location.exists()) {
+    if (!location.exists()) {
       final StringTokenizer strTokenizer = new StringTokenizer(classpath, File.pathSeparator);
       while (strTokenizer.hasMoreTokens()) {
         final File item = new File(strTokenizer.nextToken());
@@ -188,7 +186,7 @@ public TestClient(String host, int port, int totalTests) throws IOException {
   private boolean gameProgressing = false;
 
   @Override
-  protected void onObject(ProtocolMessage message) {
+  protected void onObject(@NotNull ProtocolMessage message) {
     if (message == null) {
       logger.warn("Received null message");
       return;
@@ -210,7 +208,7 @@ protected void onObject(ProtocolMessage message) {
         if (!result.isRegular())
           irregularGames++;
         StringBuilder log = new StringBuilder("Game {} ended " +
-                (result.isRegular() ? "regularly -" : "abnormally!") + " Winner: ");
+            (result.isRegular() ? "regularly -" : "abnormally!") + " Winner: ");
         if (result.getWinners() != null)
           for (Player winner : result.getWinners())
             log.append(winner.getDisplayName()).append(", ");
@@ -257,7 +255,7 @@ protected void onObject(ProtocolMessage message) {
 
       List<ScoreValue> values = score.getScoreValues();
       logger.info(String.format("New score for %s: Siegpunkte %s, \u2205Wert 1 %5.2f after %s of %s tests",
-              score.getDisplayName(), values.get(0).getValue(), values.get(1).getValue(), finishedTests, totalTests));
+          score.getDisplayName(), values.get(0).getValue(), values.get(1).getValue(), finishedTests, totalTests));
 
       if (playerScores == 2 && (isSignificant() || terminateWhenPossible)) {
         printScores();
@@ -339,7 +337,7 @@ private void prepareNewClients() {
 
   private static void exit(int status) {
     if (testclient != null) {
-      if(!testclient.isClosed())
+      if (!testclient.isClosed())
         testclient.send(new CloseConnection());
       testclient.waiter.shutdownNow();
     }
@@ -353,25 +351,20 @@ private static void exit(int status) {
     System.exit(status);
   }
 
-  private static INetworkInterface createTcpNetwork(String host, int port) throws IOException {
-    logger.info("Creating TCP Network for {}:{}", host, port);
-    return new TcpNetwork(new Socket(host, port));
-  }
-
   private boolean scoresPrinted = false;
 
   private void printScores() {
     if (scoresPrinted) return;
     try {
       logger.warn(String.format("\n" +
-                      "=============== SCORES ================\n" +
-                      "%s: %.0f\n" +
-                      "%s: %.0f\n" +
-                      "=======================================\n" +
-                      "{} of {} games ended abnormally!",
-              players[0].name, players[0].score.getScoreValues().get(0).getValue(),
-              players[1].name, players[1].score.getScoreValues().get(0).getValue()),
-              irregularGames, finishedTests);
+              "=============== SCORES ================\n" +
+              "%s: %.0f\n" +
+              "%s: %.0f\n" +
+              "=======================================\n" +
+              "{} of {} games ended abnormally!",
+          players[0].name, players[0].score.getScoreValues().get(0).getValue(),
+          players[1].name, players[1].score.getScoreValues().get(0).getValue()),
+          irregularGames, finishedTests);
       scoresPrinted = true;
     } catch (Exception ignored) {
     }
diff --git a/sdk/src/server-api/sc/networking/clients/GameLoaderClient.java b/sdk/src/server-api/sc/networking/clients/GameLoaderClient.java
@@ -1,5 +1,6 @@
 package sc.networking.clients;
 
+import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import sc.api.plugins.IGameState;
@@ -27,9 +28,9 @@ public GameLoaderClient(InputStream inputStream) throws IOException {
   }
 
   @Override
-  protected void onObject(ProtocolMessage o) {
+  protected void onObject(@NotNull ProtocolMessage message) {
     for (IHistoryListener listener : this.listeners) {
-      listener.onNewState(null, (IGameState) o);
+      listener.onNewState(null, (IGameState) message);
     }
   }
 
diff --git a/sdk/src/server-api/sc/networking/clients/LobbyClient.java b/sdk/src/server-api/sc/networking/clients/LobbyClient.java
@@ -35,18 +35,8 @@ public LobbyClient(String host, int port) throws IOException {
     super(createTcpNetwork(host, port));
   }
 
-  private static INetworkInterface createTcpNetwork(String host, int port) throws IOException {
-    logger.info("Creating TCP Network for {}:{}", host, port);
-    return new TcpNetwork(new Socket(host, port));
-  }
-
   @Override
   protected final void onObject(ProtocolMessage message) {
-    if (message == null) {
-      logger.warn("Received null message.");
-      return;
-    }
-
     if (message instanceof RoomPacket) {
       RoomPacket packet = (RoomPacket) message;
       String roomId = packet.getRoomId();
diff --git a/sdk/src/server-api/sc/networking/clients/XStreamClient.java b/sdk/src/server-api/sc/networking/clients/XStreamClient.java
@@ -2,30 +2,38 @@
 
 import com.thoughtworks.xstream.XStream;
 import com.thoughtworks.xstream.XStreamException;
+import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import sc.networking.INetworkInterface;
+import sc.networking.TcpNetwork;
 import sc.networking.UnprocessedPacketException;
 import sc.networking.XStreamProvider;
 import sc.protocol.responses.CloseConnection;
 import sc.protocol.responses.ProtocolMessage;
-import sc.shared.InvalidGameStateException;
 
 import java.io.EOFException;
 import java.io.IOException;
 import java.io.ObjectInputStream;
 import java.io.ObjectOutputStream;
+import java.net.Socket;
 import java.net.SocketException;
 import java.nio.charset.StandardCharsets;
 
 public abstract class XStreamClient {
   private static Logger logger = LoggerFactory.getLogger(XStreamClient.class);
 
+  public static INetworkInterface createTcpNetwork(String host, int port) throws IOException {
+    logger.info("Creating TCP Network for {}:{}", host, port);
+    return new TcpNetwork(new Socket(host, port));
+  }
+
   private final INetworkInterface networkInterface;
   private final ObjectOutputStream out;
   private final Thread receiveThread;
-  private DisconnectCause disconnectCause = DisconnectCause.NOT_DISCONNECTED;
   protected final XStream xStream = XStreamProvider.loadPluginXStream();
+
+  private DisconnectCause disconnectCause = DisconnectCause.NOT_DISCONNECTED;
   private boolean closed = false;
   private boolean ready = false;
   private final Object readyLock = new Object();
@@ -42,7 +50,6 @@ public enum DisconnectCause {
     LOST_CONNECTION,
     TIMEOUT,
     UNKNOWN
-
   }
 
   public boolean isReady() {
@@ -80,7 +87,7 @@ public void run() {
     this.receiveThread.start();
   }
 
-  protected abstract void onObject(ProtocolMessage o) throws UnprocessedPacketException;
+  protected abstract void onObject(@NotNull ProtocolMessage message) throws UnprocessedPacketException;
 
   /** Used by the receiving thread. All exceptions should be handled. */
   public void receiveThread() {
diff --git a/server/src/sc/server/network/Client.java b/server/src/sc/server/network/Client.java
@@ -1,5 +1,6 @@
 package sc.server.network;
 
+import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import sc.api.plugins.exceptions.GameLogicException;
@@ -186,13 +187,13 @@ protected void onDisconnect(DisconnectCause cause) {
 
   /** Forward received package to listeners. */
   @Override
-  protected void onObject(ProtocolMessage o) throws UnprocessedPacketException {
+  protected void onObject(@NotNull ProtocolMessage message) throws UnprocessedPacketException {
     /*
      * NOTE that this method is called in the receiver thread. Messages
      * should only be passed to listeners. No callbacks should be invoked
      * directly in the receiver thread.
      */
-    notifyOnPacket(o);
+    notifyOnPacket(message);
   }
 
 }
diff --git a/server/test/sc/server/network/MockClient.java b/server/test/sc/server/network/MockClient.java
@@ -1,5 +1,6 @@
 package sc.server.network;
 
+import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import sc.networking.UnprocessedPacketException;
@@ -82,9 +83,9 @@ public <T> T seekRoomMessage(String roomId, Class<T> type) {
   }
 
   @Override
-  protected void onObject(ProtocolMessage o) throws UnprocessedPacketException, InvalidGameStateException {
-    super.onObject(o);
-    this.objects.add(o);
+  protected void onObject(@NotNull ProtocolMessage message) throws UnprocessedPacketException, InvalidGameStateException {
+    super.onObject(message);
+    this.objects.add(message);
   }
 
   public Object receive() throws InterruptedException {
diff --git a/server/test/sc/server/network/TestTcpClient.java b/server/test/sc/server/network/TestTcpClient.java
@@ -1,5 +1,6 @@
 package sc.server.network;
 
+import org.jetbrains.annotations.NotNull;
 import sc.networking.TcpNetwork;
 import sc.networking.clients.XStreamClient;
 import sc.protocol.responses.ProtocolMessage;
@@ -13,7 +14,7 @@ public TestTcpClient(Socket socket) throws IOException {
   }
 
   @Override
-  protected void onObject(ProtocolMessage o) {
+  protected void onObject(@NotNull ProtocolMessage message) {
     // ignore it
     // LoggerFactory.getLogger(this.getClass()).debug("Received: {}", o);
   }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package sc.networking.clients;`
`2`	`2`
	`3`	`+import org.jetbrains.annotations.NotNull;`
`3`	`4`	`import org.slf4j.Logger;`
`4`	`5`	`import org.slf4j.LoggerFactory;`
`5`	`6`	`import sc.api.plugins.IGameState;`
`@@ -27,9 +28,9 @@ public GameLoaderClient(InputStream inputStream) throws IOException {`
`27`	`28`	`}`
`28`	`29`
`29`	`30`	`@Override`
`30`		`- protected void onObject(ProtocolMessage o) {`
	`31`	`+ protected void onObject(@NotNull ProtocolMessage message) {`
`31`	`32`	`for (IHistoryListener listener : this.listeners) {`
`32`		`- listener.onNewState(null, (IGameState) o);`
	`33`	`+ listener.onNewState(null, (IGameState) message);`
`33`	`34`	`}`
`34`	`35`	`}`
`35`	`36`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package sc.server.network;`
`2`	`2`
	`3`	`+import org.jetbrains.annotations.NotNull;`
`3`	`4`	`import sc.networking.TcpNetwork;`
`4`	`5`	`import sc.networking.clients.XStreamClient;`
`5`	`6`	`import sc.protocol.responses.ProtocolMessage;`
`@@ -13,7 +14,7 @@ public TestTcpClient(Socket socket) throws IOException {`
`13`	`14`	`}`
`14`	`15`
`15`	`16`	`@Override`
`16`		`- protected void onObject(ProtocolMessage o) {`
	`17`	`+ protected void onObject(@NotNull ProtocolMessage message) {`
`17`	`18`	`// ignore it`
`18`	`19`	`// LoggerFactory.getLogger(this.getClass()).debug("Received: {}", o);`
`19`	`20`	`}`