Merge pull request #134 from etse/development

Contributed by @etse! - Added SLF4J-logger configured with logback.xml. - Added a gradle-task for running server locally.
ShrimpCryptid · Apr 18, 2024 · 5bdf430 · 5bdf430
2 parents 01a7c61 + 78cf8ec
commit 5bdf430
Show file tree

Hide file tree

Showing 8 changed files with 96 additions and 69 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -32,14 +32,14 @@ In your first terminal, clone the repo if you haven't yet. Navigate to the `back
 git clone git@github.com:ShrimpCryptid/Secret-Hitler-Online.git
 cd Secret-Hitler-Online/backend
 
-DEBUG_MODE=1 ./gradlew run
+./gradlew runLocal
 ```
 
-This will start the backend server at [`http://localhost:4040`](http://locahost:4040) by default. You need to include `DEBUG_MODE=1`, otherwise the CORS policy will block access from the frontend.
+This will start the backend server at [`http://localhost:4040`](http://locahost:4040) by default. This will also set the server in debug-mode, so the CORS policy will not block access from the frontend.
 
 **Every time you make changes to Java files, you'll need to stop and restart the development server.**
 
-(TODO: Add a gradle run configuration for running locally)
+You can also run the backend-server using your preferred IDE by launching the Main-method in `ApplicationTest` found in the test directory.
 
 ### Running frontend server
 

diff --git a/backend/build.gradle b/backend/build.gradle
@@ -69,5 +69,10 @@ javadoc {
 // Define the main class for the application
 mainClassName = 'server.SecretHitlerServer'
 
+task runLocal(type: JavaExec) {
+    mainClass = "game.ApplicationTest"
+    classpath = sourceSets.test.runtimeClasspath
+}
+
 task stage(dependsOn: ['build', 'clean', 'jar'])
 build.mustRunAfter clean
diff --git a/backend/src/main/java/server/ApplicationConfig.java b/backend/src/main/java/server/ApplicationConfig.java
@@ -0,0 +1,9 @@
+package server;
+
+public class ApplicationConfig {
+    private static final String ENV_DEBUG = "DEBUG_MODE";
+    private static final String ENV_DATABASE_URL = "DATABASE_URL";
+
+    public static boolean DEBUG = System.getenv(ENV_DEBUG) != null;
+    public static String DATABASE_URI = System.getenv(ENV_DATABASE_URL);
+}
diff --git a/backend/src/main/java/server/SecretHitlerServer.java b/backend/src/main/java/server/SecretHitlerServer.java
@@ -10,6 +10,8 @@
 
 import org.eclipse.jetty.websocket.api.StatusCode;
 import org.json.JSONObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import server.util.Lobby;
 
 import java.io.*;
@@ -20,19 +22,14 @@
 import java.util.*;
 import java.util.concurrent.ConcurrentHashMap;
 
+
 public class SecretHitlerServer {
 
     ////// Static Fields
     // <editor-fold desc="Static Fields">
     // TODO: Replace this with an environment variable or environment flag
     public static final int DEFAULT_PORT_NUMBER = 4040;
 
-    // Environmental Variable Names
-    private static final String ENV_DEBUG = "DEBUG_MODE";
-    private static final String ENV_DATABASE_URL = "DATABASE_URL";
-
-    private static boolean DEBUG = System.getenv(ENV_DEBUG) != null;
-
     // Passed to server
     public static final String PARAM_LOBBY = "lobby";
     public static final String PARAM_NAME = "name";
@@ -88,34 +85,22 @@ public class SecretHitlerServer {
     transient private static ConcurrentHashMap<WsContext, Lobby> userToLobby = new ConcurrentHashMap<>();
     private static ConcurrentHashMap<String, Lobby> codeToLobby = new ConcurrentHashMap<>();
 
+    private static final Logger logger = LoggerFactory.getLogger(SecretHitlerServer.class);
+
     transient private static boolean hasLobbyChanged;
 
     // </editor-fold>
 
     ////// Private Methods
 
-    // TODO: Replace this with actual log levels, or a logging library.
-    /**
-     * Optionally prints an input string if the debug flag is enabled.
-     */
-    private static void debugPrint(String input) {
-        if (DEBUG) {
-            System.out.print(input);
-        }
-    }
-
-    private static void debugPrintLn(String input) {
-        debugPrint(input + "\n");
-    }
-
     /**
      * Prints the current list of lobbies and their players.
      */
     private static void printLobbyStatus() {
         synchronized (codeToLobby) {
-            System.out.println("Lobbies (" + codeToLobby.mappingCount() + ") : " + codeToLobby.keySet().toString());
+            logger.info("Lobbies (" + codeToLobby.mappingCount() + ") : " + codeToLobby.keySet());
             for (Map.Entry<String, Lobby> entry : codeToLobby.entrySet()) {
-                System.out.println("  " + entry.getKey() + ": " + entry.getValue().getUserNames());
+                logger.debug("Lobby " + entry.getKey() + ": " + entry.getValue().getUserNames());
             }
         }
     }
@@ -134,12 +119,10 @@ public static void main(String[] args) {
         loadDatabaseBackup();
         removeInactiveLobbies(); // immediately clean in case of redundant lobbies.
 
-        debugPrintLn("Running in DEBUG mode.");
-
         // Only initialize Javalin communication after the database has been queried.
         Javalin serverApp = Javalin.create(config -> {
             config.plugins.enableCors(cors -> {
-                if (DEBUG) {
+                if (ApplicationConfig.DEBUG) {
                     cors.add(it -> {
                         it.anyHost();
                     });
@@ -164,7 +147,7 @@ public static void main(String[] args) {
         // Add hook for termination that backs up the lobbies to the database.
         Runtime.getRuntime().addShutdownHook(new Thread() {
             public void run() {
-                debugPrintLn("Attempting to back up lobby data.");
+                logger.info("Attempting to back up lobby data.");
                 storeDatabaseBackup();
                 printLobbyStatus();
             }
@@ -219,7 +202,7 @@ private static void removeInactiveLobbies() {
             }
         }
         if (removedCount > 0) {
-            debugPrintLn(String.format("Removed %d inactive lobbies: %s", removedCount, removedLobbyCodes));
+            logger.info(String.format("Removed %d inactive lobbies: %s", removedCount, removedLobbyCodes));
             printLobbyStatus();
             hasLobbyChanged = true;
         }
@@ -236,13 +219,12 @@ private static void removeInactiveLobbies() {
      */
     private static Connection getDatabaseConnection() {
         // Get credentials from database or (if debug flag is set) via manual input.
-        Connection c = null;
+        Connection c;
         try {
             URI databaseUri;
-            String envUri = System.getenv(ENV_DATABASE_URL);
+            String envUri = ApplicationConfig.DATABASE_URI;
             if (envUri == null) {
-                System.out.println(
-                        "Could not connect to database: No ENV_DATABASE_URL environment variable provided.");
+                logger.error("Could not connect to database: No ENV_DATABASE_URL environment variable provided.");
                 return null;
             }
             databaseUri = new URI(envUri);
@@ -254,12 +236,11 @@ private static Connection getDatabaseConnection() {
 
             Class.forName("org.postgresql.Driver");
             c = DriverManager.getConnection(dbUrl, username, password);
-            debugPrintLn("Successfully connected to database.");
+            logger.info("Successfully connected to database.");
             return c;
         } catch (Exception e) {
             // Print failures no matter what
-            System.out.println("Failed to connect to database.");
-            System.err.println(e);
+            logger.error("Failed to connect to database.", e);
             return null;
         }
     }
@@ -289,7 +270,7 @@ private static void loadDatabaseBackup() {
             String timestamp = rs.getString("timestamp");
             int numAttempts = rs.getInt("attempts");
             byte[] lobbyBytes = rs.getBytes("lobby_bytes");
-            System.out.println("Loaded backup from " + timestamp + ".");
+            logger.info("Loaded backup from " + timestamp + ".");
             rs.close();
             stmt.close();
 
@@ -307,15 +288,13 @@ private static void loadDatabaseBackup() {
                     ObjectInputStream objectStream = new ObjectInputStream(lobbyByteStream)) {
                 codeToLobby = (ConcurrentHashMap<String, Lobby>) objectStream.readObject();
                 objectStream.close();
-                debugPrintLn("Successfully parsed lobby data from the database.");
+                logger.debug("Successfully parsed lobby data from the database.");
             } catch (Exception e) {
-                System.out.println("Failed to parse lobby data from stored backup. ");
-                System.err.println(e.getClass().getName() + ": " + e.getMessage());
+                logger.error("Failed to parse lobby data from stored backup.", e);
             }
 
         } catch (Exception e) {
-            System.out.println("Failed to retrieve lobby backups from the database.");
-            System.err.println(e.getClass().getName() + ": " + e.getMessage());
+            logger.error("Failed to retrieve lobby backups from the database.", e);
         }
         printLobbyStatus();
     }
@@ -331,8 +310,7 @@ private static void storeDatabaseBackup() {
             byteBuilder.flush();
             // No need to close bytebuilder (close has no effect)
         } catch (Exception e) {
-            System.out.println("Failed to serialize the Lobby data.");
-            System.err.println(e);
+            logger.error("Failed to serialize the Lobby data.", e);
             return;
         }
         byte[] lobbyData = byteBuilder.toByteArray();
@@ -359,11 +337,10 @@ private static void storeDatabaseBackup() {
             pstmt.executeUpdate();
             c.close();
         } catch (Exception e) {
-            System.out.println("Failed to store the Lobby data in the database.");
-            System.err.println(e);
+            logger.error("Failed to store the Lobby data in the database.", e);
             return;
         }
-        debugPrintLn("Successfully saved Lobby state to the database.");
+        logger.debug("Successfully saved Lobby state to the database.");
     }
 
     /**
@@ -476,8 +453,8 @@ public static void createNewLobby(Context ctx) {
 
         ctx.status(200);
         ctx.result(newCode);
-        System.out.println("New lobby created: " + newCode);
-        System.out.println("Available lobbies: " + codeToLobby.keySet());
+        logger.info("New lobby created: " + newCode);
+        logger.info("Available lobbies: " + codeToLobby.keySet());
     }
 
     /**
@@ -527,7 +504,7 @@ private static String generateCode() {
      */
     private static void onWebsocketConnect(WsConnectContext ctx) {
         if (ctx.queryParam(PARAM_LOBBY) == null || ctx.queryParam(PARAM_NAME) == null) {
-            debugPrintLn("A websocket request was missing a parameter and was disconnected.");
+            logger.debug("A websocket request was missing a parameter and was disconnected.");
             ctx.session.close(StatusCode.PROTOCOL,
                     "Must have the '" + PARAM_LOBBY + "' and '" + PARAM_NAME + "' parameters.");
             return;
@@ -538,32 +515,32 @@ private static void onWebsocketConnect(WsConnectContext ctx) {
         String name = ctx.queryParam(PARAM_NAME);
 
         if (code == null || name == null || name.isEmpty() || name.isBlank()) {
-            debugPrintLn("FAILED (Lobby or name is empty/null)");
+            logger.debug("FAILED (Lobby or name is empty/null)");
             ctx.session.close(StatusCode.PROTOCOL, "Lobby and name must be specified.");
         }
 
-        debugPrint("Attempting to connect user '" + name + "' to lobby '" + code + "': ");
+        logger.debug("Attempting to connect user '" + name + "' to lobby '" + code + "': ");
         if (!codeToLobby.containsKey(code)) { // the lobby does not exist.
-            debugPrintLn("FAILED (The lobby does not exist)");
+            logger.debug("FAILED (The lobby does not exist)");
             ctx.session.close(StatusCode.PROTOCOL, "The lobby '" + code + "' does not exist.");
             return;
         }
 
         Lobby lobby = codeToLobby.get(code);
         if (lobby.hasUserWithName(name)) { // duplicate names not allowed
-            debugPrintLn("FAILED (Repeat username)");
+            logger.debug("FAILED (Repeat username)");
             ctx.session.close(StatusCode.PROTOCOL, "A user with the name " + name + " is already in the lobby.");
             return;
         } else if (lobby.isFull()) {
-            debugPrintLn("FAILED (Lobby is full)");
+            logger.debug("FAILED (Lobby is full)");
             ctx.session.close(StatusCode.PROTOCOL, "The lobby " + code + " is currently full.");
             return;
         } else if (lobby.isInGame() && !lobby.canAddUserDuringGame(name)) {
-            debugPrintLn("FAILED (Lobby in game)");
+            logger.debug("FAILED (Lobby in game)");
             ctx.session.close(StatusCode.PROTOCOL, "The lobby " + code + " is currently in a game..");
             return;
         }
-        debugPrintLn("SUCCESS");
+        logger.debug("SUCCESS");
         lobby.addUser(ctx, name);
         userToLobby.put(ctx, lobby); // keep track of which lobby this connection is in.
         lobby.updateAllUsers();
@@ -597,7 +574,7 @@ private static void onWebSocketMessage(WsMessageContext ctx) {
         if (message.getString(PARAM_LOBBY) == null
                 || message.getString(PARAM_NAME) == null
                 || message.getString(PARAM_COMMAND) == null) {
-            System.out.println("Message request failed: missing a parameter.");
+            logger.warn("Message request failed: missing a parameter.");
             ctx.session.close(StatusCode.PROTOCOL, "A required parameter is missing.");
             return;
         }
@@ -607,10 +584,9 @@ private static void onWebSocketMessage(WsMessageContext ctx) {
 
         String logMessage = "Received a message from user '" + name + "' in lobby '" + lobbyCode + "' ("
                 + ctx.message() + "): ";
-        int log_length = logMessage.length();
 
         if (!codeToLobby.containsKey(lobbyCode)) {
-            debugPrintLn(logMessage + " FAILED (Lobby requested does not exist)");
+            logger.debug(logMessage + " FAILED (Lobby requested does not exist)");
             ctx.session.close(StatusCode.PROTOCOL, "The lobby does not exist.");
             return;
         }
@@ -619,7 +595,7 @@ private static void onWebSocketMessage(WsMessageContext ctx) {
 
         synchronized (lobby) {
             if (!lobby.hasUser(ctx, name)) {
-                debugPrintLn(logMessage + " FAILED (Lobby does not have the user)");
+                logger.debug(logMessage + " FAILED (Lobby does not have the user)");
                 ctx.session.close(StatusCode.PROTOCOL, "The user is not in the lobby " + lobbyCode + ".");
                 return;
             }
@@ -633,9 +609,6 @@ private static void onWebSocketMessage(WsMessageContext ctx) {
                     case COMMAND_PING:
                         sendOKMessage = false;
                         updateUsers = false;
-                        // Erase the previous line with spaces and \r
-                        debugPrint("\r" + (' ' * log_length));
-                        debugPrint("\r");
                         JSONObject msg = new JSONObject();
                         msg.put(PARAM_PACKET_TYPE, PACKET_PONG);
                         ctx.send(msg.toString());
@@ -727,7 +700,7 @@ private static void onWebSocketMessage(WsMessageContext ctx) {
                 } // End switch
 
                 if (sendOKMessage) {
-                    debugPrintLn(logMessage + " SUCCESS");
+                    logger.debug(logMessage + " SUCCESS");
                     JSONObject msg = new JSONObject();
                     msg.put(PARAM_PACKET_TYPE, PACKET_OK);
                     ctx.send(msg.toString());
@@ -736,10 +709,10 @@ private static void onWebSocketMessage(WsMessageContext ctx) {
             } catch (NullPointerException e) {
                 // Show error messages by default, since they indicate API access
                 // issues.
-                System.out.println(logMessage + " FAILED (" + e.toString() + ")");
+                logger.error(logMessage + " FAILED", e);
                 ctx.session.close(StatusCode.PROTOCOL, "NullPointerException:" + e.toString());
             } catch (RuntimeException e) {
-                System.out.println(logMessage + " FAILED (" + e.toString() + ")");
+                logger.error(logMessage + " FAILED", e);
                 ctx.session.close(StatusCode.PROTOCOL, "RuntimeException:" + e.toString());
             }
             if (updateUsers) {

diff --git a/backend/src/main/java/server/util/Lobby.java b/backend/src/main/java/server/util/Lobby.java
@@ -5,6 +5,8 @@
 import game.SecretHitlerGame;
 import io.javalin.websocket.WsContext;
 import org.json.JSONObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import server.SecretHitlerServer;
 
 import java.io.IOException;
@@ -45,6 +47,8 @@ public class Lobby implements Serializable {
     public static float CPU_ACTION_DELAY_IN_SEC = 4;
     private long timeout;
 
+    private static Logger logger = LoggerFactory.getLogger(Lobby.class);
+
     private static int MAX_TIMER_SCHEDULING_ATTEMPTS = 2;
     transient private Timer userTimeoutTimer = new Timer();
     transient private Timer cpuTickTimer = new Timer();
@@ -357,7 +361,7 @@ synchronized public void updateAllUsers() {
                 }
             }
             if (timerSchedulingAttempts == MAX_TIMER_SCHEDULING_ATTEMPTS) {
-                System.err.println("Failed to schedule timer for CPU ticks.");
+                logger.error("Failed to schedule timer for CPU ticks.");
             }
         }
     }

diff --git a/backend/src/main/resources/logback.xml b/backend/src/main/resources/logback.xml
@@ -0,0 +1,11 @@
+<configuration>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%kvp- %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <root level="info">
+        <appender-ref ref="STDOUT" />
+    </root>
+</configuration>
diff --git a/backend/src/test/java/game/ApplicationTest.java b/backend/src/test/java/game/ApplicationTest.java
@@ -0,0 +1,11 @@
+package game;
+
+import server.ApplicationConfig;
+import server.SecretHitlerServer;
+
+public class ApplicationTest {
+    public static void main(String[] args) {
+        ApplicationConfig.DEBUG = true;
+        SecretHitlerServer.main(args);
+    }
+}