feat: replay loading from gzip

Author: xeruf

sdk/src/server-api/sc/framework/HelperMethods.kt

@@ -25,6 +25,6 @@ object HelperMethods {
      */
     @JvmStatic
     fun getReplayFilename(gameId: String, names: List<String>): String =
-            "./replays/replay_${gameId}_${currentDateTime}_" +
+            "replays/replay_${gameId}_${currentDateTime}_" +
             "${names.joinToString("_") { it.replace(' ', '_') }}.xml"
 }

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

@@ -10,14 +10,15 @@ import sc.shared.GameResult
 import java.io.File
 import java.io.IOException
 import java.io.InputStream
+import java.util.zip.GZIPInputStream
 
 /**
  * This client serves the purpose to load a game state from
  * any XML file (a replay for example).
  * It is used to load a given board to play on.
  */
 class GameLoaderClient(inputStream: InputStream): XStreamClient(FileSystemInterface(inputStream)) {
-    constructor(file: File): this(file.inputStream())
+    constructor(file: File): this(if(file.extension == "gz") GZIPInputStream(file.inputStream()) else file.inputStream())
 
     private val history: MutableList<IGameState> = ArrayList(50)
     var result: GameResult? = null
@@ -30,7 +31,7 @@ class GameLoaderClient(inputStream: InputStream): XStreamClient(FileSystemInterf
         when (val msg = message.data) {
             is MementoMessage -> history.add(msg.state)
             is GameResult -> result = msg
-            else -> logger.debug("Unknown message in replay: {}", msg)
+            else -> logger.warn("Unknown message in replay: {}", msg)
         }
     }
 

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

@@ -116,7 +116,7 @@ public File createReplayFile() throws IOException {
         playerSlots.stream().map(it -> it.getPlayer().getDisplayName()).collect(Collectors.toList()));
 
     File file = new File(fileName).getAbsoluteFile();
-    if(file.getParentFile().mkdirs())
+    if(file.getParentFile().mkdirs() || file.getParentFile().exists())
       if(file.createNewFile())
         return file;
     throw new IOException("Couldn't create replay file " + file);

server/test/sc/server/gaming/GameLoaderTest.kt

@@ -1,20 +1,33 @@
 package sc.server.gaming
 
 import io.kotest.assertions.throwables.shouldThrow
+import io.kotest.core.datatest.forAll
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe
 import sc.networking.clients.GameLoaderClient
 import sc.server.plugins.TestGameState
+import java.io.File
+import java.util.zip.GZIPOutputStream
 
+@Suppress("BlockingMethodInNonBlockingContext")
 class GameLoaderTest: FunSpec({
-    test("GameLoaderClient loads replay") {
-        val client = GameLoaderClient(minimalReplay.byteInputStream())
+    context("GameLoaderClient loads replay from") {
+        val tmpfile = File.createTempFile("test-replay", ".xml.gz")
+        GZIPOutputStream(tmpfile.outputStream(), true).also { out ->
+            minimalReplay.byteInputStream().copyTo(out)
+            out.close()
+        }
         val state = TestGameState()
-        client.getHistory() shouldBe listOf(state)
-        client.getTurn(0) shouldBe state
-        client.getTurn(-1) shouldBe state
-        shouldThrow<NoSuchElementException> {
-            client.getTurn(1)
+        forAll(
+                "String" to GameLoaderClient(minimalReplay.byteInputStream()),
+                "GZip File" to GameLoaderClient(tmpfile)
+        ) { client: GameLoaderClient ->
+            client.getHistory() shouldBe listOf(state)
+            client.getTurn(0) shouldBe state
+            client.getTurn(-1) shouldBe state
+            shouldThrow<NoSuchElementException> {
+                client.getTurn(1)
+            }
         }
     }
 })