feat: add ClientBroadcast message

Clients can broadcast arbitrary strings to do whatever
using this new message type.

Author: sne11ius

src/main/kotlin/pp/api/Rooms.kt

@@ -8,6 +8,7 @@ import jakarta.websocket.CloseReason.CloseCodes.VIOLATED_POLICY
 import jakarta.websocket.Session
 import pp.api.data.ChangeName
 import pp.api.data.ChatMessage
+import pp.api.data.ClientBroadcast
 import pp.api.data.GamePhase
 import pp.api.data.GamePhase.CARDS_REVEALED
 import pp.api.data.GamePhase.PLAYING
@@ -120,6 +121,7 @@ class Rooms {
             is ChatMessage -> chatMessage(session, request.message)
             is RevealCards -> changeGamePhase(session, CARDS_REVEALED)
             is StartNewRound -> changeGamePhase(session, PLAYING)
+            is ClientBroadcast -> doClientBroadcast(session, request.payload)
             else -> {
                 // spotlessApply keeps generating this else if it doesn't exist
             }
@@ -191,7 +193,7 @@ class Rooms {
                     room withInfo "${user.username} tried to play card with illegal value: $cardValue"
                 } else {
                     user.cardValue = cardValue
-                    room
+                    room.copy()
                 }
             } else {
                 room withInfo "${user.username} tried to play card while no round was in progress"
@@ -207,6 +209,12 @@ class Rooms {
         }
     }
 
+    private fun doClientBroadcast(session: Session, payload: String) {
+        withUser(session) { room, user ->
+            room withBroadcast payload
+        }
+    }
+
     private fun changeGamePhase(session: Session, newGamePhase: GamePhase) {
         withUser(session) { room, user ->
             val canRevealCards = room.gamePhase == PLAYING && newGamePhase == CARDS_REVEALED

src/main/kotlin/pp/api/data/LogLevel.kt

@@ -22,5 +22,11 @@ enum class LogLevel {
      * Clients should consider simply reconnecting on every error
      */
     ERROR,
+
+    /**
+     * A broadcast message sent by a client
+     */
+    CLIENT_BROADCAST,
+
     ;
 }

src/main/kotlin/pp/api/data/Room.kt

@@ -3,6 +3,7 @@ package pp.api.data
 import io.quarkus.logging.Log
 import jakarta.websocket.Session
 import pp.api.data.GamePhase.PLAYING
+import pp.api.data.LogLevel.CLIENT_BROADCAST
 import pp.api.data.UserType.PARTICIPANT
 
 /**
@@ -24,7 +25,7 @@ import pp.api.data.UserType.PARTICIPANT
 @Suppress("TooManyFunctions", "What can we do about this?")
 class Room(
     val roomId: String,
-    val version: ULong = 1u,
+    val version: Long = 1,
     val users: List<User> = listOf(),
     val deck: List<String> = listOf("1", "2", "3", "5", "8", "13", "☕"),
     val gamePhase: GamePhase = PLAYING,
@@ -56,7 +57,7 @@ class Room(
     fun copy(
         roomId: String = this.roomId,
         users: List<User> = this.users,
-        version: ULong = this.version + 1u,
+        version: Long = this.version + 1,
         deck: List<String> = this.deck,
         gamePhase: GamePhase = this.gamePhase,
         log: List<LogEntry> = this.log,
@@ -134,6 +135,14 @@ class Room(
      */
     infix fun withChatMessage(message: String): Room = withLogEntry(chat(message))
 
+    /**
+     * Crate a copy of this room, with the given message added as [LogEntry] with level [LogLevel.CLIENT_BROADCAST]
+     *
+     * @param payload the chat message to add
+     * @return a copy of this room, with the message added as [LogEntry] with [LogLevel] [LogLevel.CLIENT_BROADCAST]
+     */
+    infix fun withBroadcast(payload: String): Room = withLogEntry(LogEntry(CLIENT_BROADCAST, payload))
+
     private infix fun withLogEntry(entry: LogEntry): Room = copy(
         log = log + entry,
     )

src/main/kotlin/pp/api/data/UserRequest.kt

@@ -10,6 +10,7 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo.As.PROPERTY
 import com.fasterxml.jackson.annotation.JsonTypeInfo.Id.NAME
 import pp.api.data.RequestType.CHANGE_NAME
 import pp.api.data.RequestType.CHAT_MESSAGE
+import pp.api.data.RequestType.CLIENT_BROADCAST
 import pp.api.data.RequestType.PLAY_CARD
 import pp.api.data.RequestType.REVEAL_CARDS
 import pp.api.data.RequestType.START_NEW_ROUND
@@ -45,6 +46,11 @@ enum class RequestType {
      * User wants to start the next round
      */
     START_NEW_ROUND,
+
+    /**
+     * Client wants to broadcast a message
+     */
+    CLIENT_BROADCAST,
     ;
 }
 
@@ -117,3 +123,29 @@ class StartNewRound : UserRequest(START_NEW_ROUND) {
 
     override fun hashCode(): Int = "StartNewRound".hashCode()
 }
+
+/**
+ * Message a user (or better: the users' client) sends if it wants to broadcast
+ * "something" to other clients.
+ *
+ * @property payload the broadcast payload
+ */
+class ClientBroadcast(
+    val payload: String,
+) : UserRequest(CLIENT_BROADCAST) {
+    init {
+        require(payload.isNotBlank()) {
+            "Payload cannot be blank"
+        }
+        require(payload.length <= MAX_PAYLOAD_LENGTH) {
+            "Payload cannot be longer than $MAX_PAYLOAD_LENGTH"
+        }
+    }
+
+    companion object {
+        /**
+         * Maximum length of a broadcast payload
+         */
+        const val MAX_PAYLOAD_LENGTH = 10_000
+    }
+}

src/main/kotlin/pp/api/dto/RoomDto.kt

@@ -20,13 +20,13 @@ import java.util.Locale.US
  * @property average represents the average of the card values played. Will only show real data if [gamePhase] is
  *   [CARDS_REVEALED]
  * @property log list of [LogEntry]s for this rooms
- * @property version
+ * @property version current version of the room
  */
 // see https://quarkus.io/guides/writing-native-applications-tips#registerForReflection
 @RegisterForReflection(registerFullHierarchy = true)
 data class RoomDto(
     val roomId: String,
-    val version: ULong,
+    val version: Long,
     val deck: List<String>,
     val gamePhase: GamePhase,
     val users: List<UserDto>,

src/test/kotlin/pp/api/RoomTest.kt

@@ -118,7 +118,7 @@ class RoomTest {
 
     @Test
     fun versionAscends() {
-        val room = Room(roomId = "nice-id", version = 9u)
+        val room = Room(roomId = "nice-id", version = 9)
         val updated = room.copy()
         assertEquals(10U.toInt(), updated.version.toInt())
         val room2 = Room(roomId = "nice-id")

src/test/kotlin/pp/api/RoomsTest.kt

@@ -14,10 +14,12 @@ import org.mockito.Mockito.mock
 import org.mockito.kotlin.whenever
 import pp.api.data.ChangeName
 import pp.api.data.ChatMessage
+import pp.api.data.ClientBroadcast
 import pp.api.data.GamePhase.CARDS_REVEALED
 import pp.api.data.GamePhase.PLAYING
 import pp.api.data.LogEntry
 import pp.api.data.LogLevel.CHAT
+import pp.api.data.LogLevel.CLIENT_BROADCAST
 import pp.api.data.LogLevel.INFO
 import pp.api.data.PlayCard
 import pp.api.data.RevealCards
@@ -376,8 +378,9 @@ class RoomsTest {
             3, rooms.getRooms().first().log
                 .size
         )
-        assertTrue(rooms.getRooms().first().log
-            .any { it.level == INFO && "tried to change game phase" in it.message })
+        assertTrue(
+            rooms.getRooms().first().log
+                .any { it.level == INFO && "tried to change game phase" in it.message })
     }
 
     @Test
@@ -444,8 +447,27 @@ class RoomsTest {
             2, rooms.getRooms().first().log
                 .size
         )
-        assertTrue(rooms.getRooms().first().log
-            .any { it.level == INFO && "tried to change game phase" in it.message })
+        assertTrue(
+            rooms.getRooms().first().log
+                .any { it.level == INFO && "tried to change game phase" in it.message })
+    }
+
+    @Test
+    fun canBroadcastMessages() {
+        val rooms = Rooms()
+        val remote = mock(Async::class.java)
+        val session = mock(Session::class.java)
+        whenever(session.asyncRemote).thenReturn(remote)
+        whenever(remote.sendObject(any())).thenReturn(constantFuture(null))
+        val user = User("username", SPECTATOR, "7", session)
+        whenever(session.id).thenReturn("new-session-id")
+        rooms.ensureRoomContainsUser("nice-id", user)
+        rooms.submitUserRequest(ClientBroadcast("nice broadcast message"), session)
+        assertEquals(
+            LogEntry(level = CLIENT_BROADCAST, message = "nice broadcast message"),
+            rooms.getRooms().first().log
+                .last()
+        )
     }
 
     @Test

src/test/kotlin/pp/api/data/UserRequestTest.kt

@@ -2,6 +2,7 @@ package pp.api.data
 
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertThrows
 
 class UserRequestTest {
     @Test
@@ -13,4 +14,14 @@ class UserRequestTest {
     fun hashStartNewRound() {
         assertEquals(StartNewRound().hashCode(), StartNewRound().hashCode())
     }
+
+    @Test
+    fun `Cannot make empty ClientBroadcast`() {
+        assertThrows<IllegalArgumentException> { ClientBroadcast("") }
+    }
+
+    @Test
+    fun `Cannot make ClientBroadcast with payload to large`() {
+        assertThrows<IllegalArgumentException> { ClientBroadcast("abracadabra".repeat(1_000)) }
+    }
 }