Add RegisterAsPeer logic to TelemetryClient (#16)

* Implement RegisterAsPeer. * Define and get IceAdapterVersion. * Remove unnecessarey UUID.random() from message * Set version in gradle.properties and add to manifest * Use version instead of archiveVersion --------- Co-authored-by: Ryan Hieber <[email protected]>
FAForever · Apr 21, 2024 · 28e4b49 · 28e4b49
1 parent 6bc7581
commit 28e4b49
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 7 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -2,7 +2,9 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 subprojects {
     group = "com.faforever.ice"
-    version = "1.0-SNAPSHOT"
+
+    // Read from gradle.properties
+    version = "$version"
 
     tasks {
         withType<KotlinCompile> {

diff --git a/gradle.properties b/gradle.properties
@@ -1,3 +1,4 @@
+version=unspecified
 kotlin.code.style=official
 kotlin.mpp.enableGranularSourceSetsMetadata=true
 kotlin.native.enableDependencyPropagation=false

diff --git a/kia-cli/build.gradle.kts b/kia-cli/build.gradle.kts
@@ -39,7 +39,10 @@ tasks {
 
     named<ShadowJar>("shadowJar") {
         manifest {
-            attributes(mapOf("Main-Class" to "com.faforever.ice.KiaApplication"))
+            attributes(mapOf(
+                "Main-Class" to "com.faforever.ice.KiaApplication",
+                "Implementation-Version" to version,
+            ))
         }
     }
 }
diff --git a/kia-lib/src/main/kotlin/com/faforever/ice/IceAdapter.kt b/kia-lib/src/main/kotlin/com/faforever/ice/IceAdapter.kt
@@ -34,6 +34,11 @@ class IceAdapter(
     private val onIceAdapterStopped: () -> Unit,
     initialCoturnServers: List<CoturnServer>,
 ) {
+    companion object {
+        val version by lazy {
+            IceAdapter::class.java.getPackage().implementationVersion ?: "SNAPSHOT"
+        }
+    }
 
     private val coturnServers: MutableList<CoturnServer> = ArrayList(initialCoturnServers)
     private val objectLock = Object()

diff --git a/kia-lib/src/main/kotlin/com/faforever/ice/telemetry/TelemetryClient.kt b/kia-lib/src/main/kotlin/com/faforever/ice/telemetry/TelemetryClient.kt
@@ -1,5 +1,6 @@
 package com.faforever.ice.telemetry
 
+import com.faforever.ice.IceAdapter
 import com.faforever.ice.IceOptions
 import com.fasterxml.jackson.databind.ObjectMapper
 import io.github.oshai.kotlinlogging.KotlinLogging
@@ -14,12 +15,10 @@ import java.util.concurrent.CompletableFuture
 private val logger = KotlinLogging.logger {}
 
 class TelemetryClient(
-    iceOptions: IceOptions,
+    private val iceOptions: IceOptions,
     private val objectMapper: ObjectMapper,
 ) {
     private val serverBaseUrl = iceOptions.telemetryServer
-    private val gameId = iceOptions.gameId
-    private val userId = iceOptions.userId
 
     private val websocketClient: WebSocketClient
     private var connectingFuture: CompletableFuture<Void>
@@ -56,13 +55,14 @@ class TelemetryClient(
                     "ws",
                     "http",
                 )
-            }/app.html?gameId=$gameId&playerId=$userId"
+            }/app.html?gameId=${iceOptions.gameId}&playerId=${iceOptions.userId}"
         }
 
-        val uri: URI = URI.create("$serverBaseUrl/adapter/v1/game/$gameId/player/$userId")
+        val uri: URI = URI.create("$serverBaseUrl/adapter/v1/game/${iceOptions.gameId}/player/${iceOptions.userId}")
         websocketClient = TelemetryWebsocketClient(uri)
 
         connectingFuture = connectAsync()
+        registerAsPeer()
     }
 
     private fun connectAsync() = CompletableFuture.runAsync(websocketClient::connect)
@@ -82,6 +82,14 @@ class TelemetryClient(
         }
     }
 
+    private fun registerAsPeer() {
+        val message = RegisterAsPeer(
+            "kotlin-ice-adapter/${IceAdapter.version}",
+            iceOptions.userName,
+        )
+        sendMessage(message)
+    }
+
     fun updateCoturnList(servers: Collection<com.faforever.ice.peering.CoturnServer>) {
         val telemetryCoturnServers = servers.map { server ->
             CoturnServer(

diff --git a/kia-lib/src/test/kotlin/com/faforever/ice/telemetry/TelemetryClientTest.kt b/kia-lib/src/test/kotlin/com/faforever/ice/telemetry/TelemetryClientTest.kt
@@ -1,11 +1,13 @@
 package com.faforever.ice.telemetry
 
+import com.faforever.ice.IceAdapter
 import com.faforever.ice.IceOptions
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import io.mockk.every
 import io.mockk.impl.annotations.MockK
 import io.mockk.junit5.MockKExtension
 import io.mockk.mockkConstructor
+import io.mockk.mockkObject
 import io.mockk.mockkStatic
 import io.mockk.unmockkStatic
 import io.mockk.verify
@@ -28,11 +30,16 @@ class TelemetryClientTest {
     @BeforeEach
     fun beforeEach() {
         every { mockIceOptions.telemetryServer } returns "wss://mock-telemetryserver.xyz:"
+        every { mockIceOptions.userName } returns "Player1"
         every { mockIceOptions.userId } returns 5000
         every { mockIceOptions.gameId } returns 12345
+
         mockkStatic(UUID::class)
         every { UUID.randomUUID() } returns messageUuid
 
+        mockkObject(IceAdapter)
+        every { IceAdapter.version } returns "9.9.9-SNAPSHOT"
+
         mockkConstructor(TelemetryClient.TelemetryWebsocketClient::class)
         every { anyConstructed<TelemetryClient.TelemetryWebsocketClient>().connect() } returns Unit
         sut = TelemetryClient(mockIceOptions, jacksonObjectMapper())
@@ -43,6 +50,24 @@ class TelemetryClientTest {
         unmockkStatic(UUID::class)
     }
 
+    @Test
+    fun `test init connects and registers as peer`() {
+        verify {
+            anyConstructed<TelemetryClient.TelemetryWebsocketClient>().connect()
+
+            val expected =
+                """
+                {
+                "messageType":"RegisterAsPeer",
+                "adapterVersion":"kotlin-ice-adapter/9.9.9-SNAPSHOT",
+                "userName":"Player1",
+                "messageId":"$messageUuid"
+                }
+                """.trimIndent().replace("\n", "")
+            anyConstructed<TelemetryClient.TelemetryWebsocketClient>().send(expected)
+        }
+    }
+
     @Test
     fun `test update coturn servers`() {
         val coturnServers: List<com.faforever.ice.peering.CoturnServer> = listOf(