🐛 Fix untyped Results

Poeschl · Poeschl · commit 02b452c576be · 2024-10-17T22:47:44.000+02:00
diff --git a/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/GameHandler.kt b/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/GameHandler.kt
@@ -8,6 +8,7 @@ import xyz.poeschl.roborush.controller.WebsocketController
 import xyz.poeschl.roborush.exceptions.PositionNotAllowedException
 import xyz.poeschl.roborush.exceptions.PositionOutOfMapException
 import xyz.poeschl.roborush.gamelogic.actions.RobotAction
+import xyz.poeschl.roborush.gamelogic.actions.ScanAction
 import xyz.poeschl.roborush.gamelogic.internal.MapHandler
 import xyz.poeschl.roborush.gamelogic.internal.RobotHandler
 import xyz.poeschl.roborush.models.ActiveRobot
@@ -138,7 +139,7 @@ class GameHandler(
       activeRobot?.let { registeredRobot ->
         val knownTiles = getTilesForMovementOnPosition(startPosition)
         registeredRobot.knownPositions.addAll(knownTiles.map(Tile::position))
-        registeredRobot.lastResult = knownTiles
+        registeredRobot.lastResult = ScanAction.ScanResult(knownTiles)
         websocketController.sendRobotUpdate(registeredRobot)
         websocketController.sendUserRobotData(registeredRobot)
         websocketController.sendKnownPositionsUpdate(registeredRobot)
diff --git a/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/actions/RefuelAction.kt b/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/actions/RefuelAction.kt
@@ -5,10 +5,11 @@ import org.slf4j.LoggerFactory
 import xyz.poeschl.roborush.exceptions.TankFullException
 import xyz.poeschl.roborush.exceptions.WrongTileTypeException
 import xyz.poeschl.roborush.gamelogic.GameHandler
+import xyz.poeschl.roborush.gamelogic.actions.RefuelAction.RefuelActionResult
 import xyz.poeschl.roborush.models.ActiveRobot
 import xyz.poeschl.roborush.models.TileType
 
-class RefuelAction @JsonCreator constructor() : RobotAction<Int> {
+class RefuelAction @JsonCreator constructor() : RobotAction<RefuelActionResult> {
 
   companion object {
     val LOGGER = LoggerFactory.getLogger(RefuelAction::class.java)
@@ -25,10 +26,10 @@ class RefuelAction @JsonCreator constructor() : RobotAction<Int> {
     }
   }
 
-  override fun action(robot: ActiveRobot, gameHandler: GameHandler): RobotActionResult<Int> {
+  override fun action(robot: ActiveRobot, gameHandler: GameHandler): RobotActionResult<RefuelActionResult> {
     robot.addFuel(gameHandler.getRobotMaxFuel())
     LOGGER.debug("Refuel robot {} to {}", robot.id, robot.fuel)
-    return RobotActionResult(robot, robot.fuel)
+    return RobotActionResult(robot, RefuelActionResult(robot.fuel))
   }
 
   override fun toString(): String {
@@ -44,4 +45,6 @@ class RefuelAction @JsonCreator constructor() : RobotAction<Int> {
   override fun hashCode(): Int {
     return javaClass.hashCode()
   }
+
+  data class RefuelActionResult(val robotFuel: Int) : Result
 }
diff --git a/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/actions/RobotAction.kt b/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/actions/RobotAction.kt
@@ -22,7 +22,7 @@ import xyz.poeschl.roborush.models.ActiveRobot
   Type(value = SolarChargeAction::class, name = "solarCharge"),
   Type(value = FullMapScanAction::class, name = "fullScan")
 )
-interface RobotAction<T> {
+interface RobotAction<T : Result> {
 
   /***
    * This method will check if the current action is allowed to execute.
@@ -41,3 +41,5 @@ interface RobotAction<T> {
 }
 
 data class RobotActionResult<T>(val updatedRobot: ActiveRobot, val result: T)
+
+interface Result
diff --git a/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/actions/ScanAction.kt b/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/actions/ScanAction.kt
@@ -47,5 +47,5 @@ class ScanAction @JsonCreator constructor(val distance: Int) : RobotAction<ScanA
     return distance
   }
 
-  data class ScanResult(val tiles: List<Tile>)
+  data class ScanResult(val tiles: List<Tile>) : Result
 }
diff --git a/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/actions/SolarChargeAction.kt b/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/actions/SolarChargeAction.kt
@@ -5,10 +5,11 @@ import org.slf4j.LoggerFactory
 import xyz.poeschl.roborush.exceptions.ActionDeniedByConfig
 import xyz.poeschl.roborush.exceptions.TankFullException
 import xyz.poeschl.roborush.gamelogic.GameHandler
+import xyz.poeschl.roborush.gamelogic.actions.RefuelAction.RefuelActionResult
 import xyz.poeschl.roborush.models.ActiveRobot
 import kotlin.math.ceil
 
-class SolarChargeAction @JsonCreator constructor() : RobotAction<Int> {
+class SolarChargeAction @JsonCreator constructor() : RobotAction<RefuelActionResult> {
 
   companion object {
     val LOGGER = LoggerFactory.getLogger(SolarChargeAction::class.java)
@@ -24,12 +25,12 @@ class SolarChargeAction @JsonCreator constructor() : RobotAction<Int> {
     }
   }
 
-  override fun action(robot: ActiveRobot, gameHandler: GameHandler): RobotActionResult<Int> {
+  override fun action(robot: ActiveRobot, gameHandler: GameHandler): RobotActionResult<RefuelActionResult> {
     val addedFuel = ceil(gameHandler.getRobotMaxFuel() * gameHandler.getSolarChargeRate()).toInt()
     robot.addFuel(addedFuel)
     LOGGER.debug("Solar charge robot {} to {}", robot.id, robot.fuel)
 
-    return RobotActionResult(robot, robot.fuel)
+    return RobotActionResult(robot, RefuelActionResult(robot.fuel))
   }
 
   override fun toString(): String {
diff --git a/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/actions/WaitAction.kt b/backend/src/main/kotlin/xyz/poeschl/roborush/gamelogic/actions/WaitAction.kt
@@ -3,9 +3,10 @@ package xyz.poeschl.roborush.gamelogic.actions
 import com.fasterxml.jackson.annotation.JsonCreator
 import org.slf4j.LoggerFactory
 import xyz.poeschl.roborush.gamelogic.GameHandler
+import xyz.poeschl.roborush.gamelogic.actions.WaitAction.*
 import xyz.poeschl.roborush.models.ActiveRobot
 
-class WaitAction @JsonCreator constructor() : RobotAction<Int> {
+class WaitAction @JsonCreator constructor() : RobotAction<EmptyResult> {
 
   companion object {
     private val LOGGER = LoggerFactory.getLogger(WaitAction::class.java)
@@ -15,9 +16,9 @@ class WaitAction @JsonCreator constructor() : RobotAction<Int> {
     // Waiting is always successful
   }
 
-  override fun action(robot: ActiveRobot, gameHandler: GameHandler): RobotActionResult<Int> {
+  override fun action(robot: ActiveRobot, gameHandler: GameHandler): RobotActionResult<EmptyResult> {
     // Doing nothing
-    return RobotActionResult(robot, 0)
+    return RobotActionResult(robot, EmptyResult())
   }
 
   override fun equals(other: Any?): Boolean {
@@ -33,4 +34,6 @@ class WaitAction @JsonCreator constructor() : RobotAction<Int> {
   override fun toString(): String {
     return "Wait()"
   }
+
+  data class EmptyResult(val state: String = "(╯°□°)╯︵ ┻━┻") : Result
 }
diff --git a/backend/src/main/kotlin/xyz/poeschl/roborush/models/Robot.kt b/backend/src/main/kotlin/xyz/poeschl/roborush/models/Robot.kt
@@ -25,7 +25,7 @@ data class ActiveRobot(
       Int::class, ScanAction.ScanResult::class
     ]
   )
-  var lastResult: Any? = null,
+  var lastResult: Result? = null,
   @JsonIgnore
   val knownPositions: MutableSet<Position> = mutableSetOf()
 ) {
diff --git a/backend/src/test/kotlin/xyz/poeschl/roborush/gamelogic/GameHandlerTest.kt b/backend/src/test/kotlin/xyz/poeschl/roborush/gamelogic/GameHandlerTest.kt
@@ -10,6 +10,7 @@ import xyz.poeschl.roborush.controller.WebsocketController
 import xyz.poeschl.roborush.exceptions.PositionNotAllowedException
 import xyz.poeschl.roborush.exceptions.PositionOutOfMapException
 import xyz.poeschl.roborush.gamelogic.actions.MoveAction
+import xyz.poeschl.roborush.gamelogic.actions.ScanAction
 import xyz.poeschl.roborush.gamelogic.internal.MapHandler
 import xyz.poeschl.roborush.gamelogic.internal.RobotHandler
 import xyz.poeschl.roborush.models.Position
@@ -276,7 +277,7 @@ class GameHandlerTest {
 
     // VERIFY
     assertThat(registeredRobot.knownPositions).containsAll(neighborTiles.map(Tile::position))
-    assertThat(registeredRobot.lastResult as List<*>).containsAll(neighborTiles)
+    assertThat((registeredRobot.lastResult as ScanAction.ScanResult).tiles).containsAll(neighborTiles)
     verify { robotHandler.registerRobotForGame(1, startPosition) }
     verify { websocketController.sendRobotUpdate(registeredRobot) }
     verify { websocketController.sendKnownPositionsUpdate(registeredRobot) }
diff --git a/backend/src/test/kotlin/xyz/poeschl/roborush/gamelogic/actions/RefuelActionTest.kt b/backend/src/test/kotlin/xyz/poeschl/roborush/gamelogic/actions/RefuelActionTest.kt
@@ -82,6 +82,6 @@ class RefuelActionTest {
 
     // VERIFY
     assertThat(actionResult.updatedRobot.fuel).isEqualTo(maxRobotFuel)
-    assertThat(actionResult.result).isEqualTo(maxRobotFuel)
+    assertThat(actionResult.result).isEqualTo(RefuelAction.RefuelActionResult(300))
   }
 }
diff --git a/backend/src/test/kotlin/xyz/poeschl/roborush/gamelogic/actions/SolarChargeActionTest.kt b/backend/src/test/kotlin/xyz/poeschl/roborush/gamelogic/actions/SolarChargeActionTest.kt
@@ -8,6 +8,7 @@ import org.junit.jupiter.api.assertThrows
 import xyz.poeschl.roborush.exceptions.ActionDeniedByConfig
 import xyz.poeschl.roborush.exceptions.TankFullException
 import xyz.poeschl.roborush.gamelogic.GameHandler
+import xyz.poeschl.roborush.gamelogic.actions.RefuelAction.RefuelActionResult
 import xyz.poeschl.roborush.test.utils.builder.Builders.Companion.a
 import xyz.poeschl.roborush.test.utils.builder.GameLogicBuilder.Companion.`$ActiveRobot`
 
@@ -82,7 +83,7 @@ class SolarChargeActionTest {
     // VERIFY
     val expectedFuel = (10 + chargeRate * maxRobotFuel).toInt()
     assertThat(actionResult.updatedRobot.fuel).isEqualTo(expectedFuel)
-    assertThat(actionResult.result).isEqualTo(expectedFuel)
+    assertThat(actionResult.result).isEqualTo(RefuelActionResult(60))
   }
 
   @Test
@@ -103,6 +104,6 @@ class SolarChargeActionTest {
 
     // VERIFY
     assertThat(actionResult.updatedRobot.fuel).isEqualTo(maxRobotFuel)
-    assertThat(actionResult.result).isEqualTo(maxRobotFuel)
+    assertThat(actionResult.result).isEqualTo(RefuelActionResult(100))
   }
 }
diff --git a/backend/src/test/kotlin/xyz/poeschl/roborush/gamelogic/actions/WaitActionTest.kt b/backend/src/test/kotlin/xyz/poeschl/roborush/gamelogic/actions/WaitActionTest.kt
@@ -5,6 +5,7 @@ import io.mockk.mockk
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.Test
 import xyz.poeschl.roborush.gamelogic.GameHandler
+import xyz.poeschl.roborush.gamelogic.actions.WaitAction.EmptyResult
 import xyz.poeschl.roborush.test.utils.builder.Builders.Companion.a
 import xyz.poeschl.roborush.test.utils.builder.GameLogicBuilder.Companion.`$ActiveRobot`
 
@@ -23,6 +24,6 @@ class WaitActionTest {
     val actionResult = waitAction.action(robot, gameHandler)
 
     // VERIFY
-    assertThat(actionResult.result).isEqualTo(0)
+    assertThat(actionResult.result).isEqualTo(EmptyResult())
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,10 +5,11 @@ import org.slf4j.LoggerFactory`
`5`	`5`	`import xyz.poeschl.roborush.exceptions.TankFullException`
`6`	`6`	`import xyz.poeschl.roborush.exceptions.WrongTileTypeException`
`7`	`7`	`import xyz.poeschl.roborush.gamelogic.GameHandler`
	`8`	`+import xyz.poeschl.roborush.gamelogic.actions.RefuelAction.RefuelActionResult`
`8`	`9`	`import xyz.poeschl.roborush.models.ActiveRobot`
`9`	`10`	`import xyz.poeschl.roborush.models.TileType`
`10`	`11`
`11`		`-class RefuelAction @JsonCreator constructor() : RobotAction<Int> {`
	`12`	`+class RefuelAction @JsonCreator constructor() : RobotAction<RefuelActionResult> {`
`12`	`13`
`13`	`14`	`companion object {`
`14`	`15`	`val LOGGER = LoggerFactory.getLogger(RefuelAction::class.java)`
`@@ -25,10 +26,10 @@ class RefuelAction @JsonCreator constructor() : RobotAction<Int> {`
`25`	`26`	`}`
`26`	`27`	`}`
`27`	`28`
`28`		`- override fun action(robot: ActiveRobot, gameHandler: GameHandler): RobotActionResult<Int> {`
	`29`	`+ override fun action(robot: ActiveRobot, gameHandler: GameHandler): RobotActionResult<RefuelActionResult> {`
`29`	`30`	`robot.addFuel(gameHandler.getRobotMaxFuel())`
`30`	`31`	`LOGGER.debug("Refuel robot {} to {}", robot.id, robot.fuel)`
`31`		`- return RobotActionResult(robot, robot.fuel)`
	`32`	`+ return RobotActionResult(robot, RefuelActionResult(robot.fuel))`
`32`	`33`	`}`
`33`	`34`
`34`	`35`	`override fun toString(): String {`
`@@ -44,4 +45,6 @@ class RefuelAction @JsonCreator constructor() : RobotAction<Int> {`
`44`	`45`	`override fun hashCode(): Int {`
`45`	`46`	`return javaClass.hashCode()`
`46`	`47`	`}`
	`48`	`+`
	`49`	`+ data class RefuelActionResult(val robotFuel: Int) : Result`
`47`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ import xyz.poeschl.roborush.models.ActiveRobot`
`22`	`22`	`Type(value = SolarChargeAction::class, name = "solarCharge"),`
`23`	`23`	`Type(value = FullMapScanAction::class, name = "fullScan")`
`24`	`24`	`)`
`25`		`-interface RobotAction<T> {`
	`25`	`+interface RobotAction<T : Result> {`
`26`	`26`
`27`	`27`	`/***`
`28`	`28`	`* This method will check if the current action is allowed to execute.`
`@@ -41,3 +41,5 @@ interface RobotAction<T> {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`data class RobotActionResult<T>(val updatedRobot: ActiveRobot, val result: T)`
	`44`	`+`
	`45`	`+interface Result`
Original file line number	Diff line number	Diff line change
`@@ -47,5 +47,5 @@ class ScanAction @JsonCreator constructor(val distance: Int) : RobotAction<ScanA`
`47`	`47`	`return distance`
`48`	`48`	`}`
`49`	`49`
`50`		`- data class ScanResult(val tiles: List<Tile>)`
	`50`	`+ data class ScanResult(val tiles: List<Tile>) : Result`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ data class ActiveRobot(`
`25`	`25`	`Int::class, ScanAction.ScanResult::class`
`26`	`26`	`]`
`27`	`27`	`)`
`28`		`- var lastResult: Any? = null,`
	`28`	`+ var lastResult: Result? = null,`
`29`	`29`	`@JsonIgnore`
`30`	`30`	`val knownPositions: MutableSet<Position> = mutableSetOf()`
`31`	`31`	`) {`
Original file line number	Diff line number	Diff line change
`@@ -82,6 +82,6 @@ class RefuelActionTest {`
`82`	`82`
`83`	`83`	`// VERIFY`
`84`	`84`	`assertThat(actionResult.updatedRobot.fuel).isEqualTo(maxRobotFuel)`
`85`		`- assertThat(actionResult.result).isEqualTo(maxRobotFuel)`
	`85`	`+ assertThat(actionResult.result).isEqualTo(RefuelAction.RefuelActionResult(300))`
`86`	`86`	`}`
`87`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import io.mockk.mockk`
`5`	`5`	`import org.assertj.core.api.Assertions.assertThat`
`6`	`6`	`import org.junit.jupiter.api.Test`
`7`	`7`	`import xyz.poeschl.roborush.gamelogic.GameHandler`
	`8`	`+import xyz.poeschl.roborush.gamelogic.actions.WaitAction.EmptyResult`
`8`	`9`	`import xyz.poeschl.roborush.test.utils.builder.Builders.Companion.a`
`9`	`10`	import xyz.poeschl.roborush.test.utils.builder.GameLogicBuilder.Companion.`$ActiveRobot`
`10`	`11`
`@@ -23,6 +24,6 @@ class WaitActionTest {`
`23`	`24`	`val actionResult = waitAction.action(robot, gameHandler)`
`24`	`25`
`25`	`26`	`// VERIFY`
`26`		`- assertThat(actionResult.result).isEqualTo(0)`
	`27`	`+ assertThat(actionResult.result).isEqualTo(EmptyResult())`
`27`	`28`	`}`
`28`	`29`	`}`