(feat) add instance and shard status endpoints (with service methods) into status controller

Author: milosz08

jwa-rest/src/main/kotlin/pl/jwizard/jwa/rest/route/status/StatusController.kt

@@ -1,20 +1,62 @@
 package pl.jwizard.jwa.rest.route.status
 
 import io.javalin.http.Context
+import io.javalin.http.pathParamAsClass
+import io.javalin.http.queryParamAsClass
 import org.springframework.stereotype.Component
+import pl.jwizard.jwa.core.server.ValidatorChainFacade
 import pl.jwizard.jwl.server.route.RestControllerBase
 import pl.jwizard.jwl.server.route.RouteDefinitionBuilder
 
 @Component
 class StatusController(private val statusService: StatusService) : RestControllerBase {
 	override val basePath = "/v1/status"
 
-	private fun getGlobalStatus(ctx: Context, language: String?) {
-		val resDto = statusService.getGlobalStatus(language)
+	private fun getGlobalStatus(ctx: Context) {
+		val resDto = statusService.getGlobalStatus()
+		ctx.json(resDto)
+	}
+
+	// all instances combined status from all running shards
+	private fun getInstancesStatus(ctx: Context) {
+		val avatarSize = ctx.queryParam("avatarSize")
+		val resDto = statusService.getInstancesStatus(avatarSize?.toIntOrNull())
+		ctx.json(resDto)
+	}
+
+	// single instance shards status
+	private fun getInstanceShardsStatus(ctx: Context) {
+		val instanceId = ctx.pathParamAsClass<Int>("instanceId")
+		val parsedInstanceId = ValidatorChainFacade(instanceId).get()
+		val resDto = statusService.getInstanceShardsStatus(parsedInstanceId)
+		ctx.json(resDto)
+	}
+
+	// all audio nodes status (also inactive)
+	private fun getAudioNodesStatus(ctx: Context) {
+		val resDto = statusService.getAudioNodesStatus()
+		ctx.json(resDto)
+	}
+
+	// check, if shard for selected guild and (optional instance) is up and running
+	// if shard is down or if bot is not on selected guild, return false
+	// instanceId=null -> search in all bot instances
+	private fun checkIfShardForGuildNameOrIdIsUp(ctx: Context) {
+		val guildNameOrId = ctx.queryParamAsClass<String>("guild")
+		val instanceId = ctx.queryParam("instanceId")
+		val parsedGuildNameOrId = ValidatorChainFacade(guildNameOrId).disallowBlanks().get()
+		val resDto = statusService.checkIfShardForGuildNameOrIdIsUp(
+			parsedGuildNameOrId,
+			instanceId?.toIntOrNull(),
+		)
 		ctx.json(resDto)
 	}
 
 	override val routes = RouteDefinitionBuilder()
-		.getWithI18n("/global", ::getGlobalStatus)
+		.get("/global", ::getGlobalStatus)
+		.get("/instance/all", ::getInstancesStatus)
+		.get("/instance/<instanceId>/shard/all", ::getInstanceShardsStatus)
+		.get("/audio/all", ::getAudioNodesStatus)
+		.get("/shard/up", ::checkIfShardForGuildNameOrIdIsUp)
 		.compositeRoutes()
 }

jwa-rest/src/main/kotlin/pl/jwizard/jwa/rest/route/status/StatusService.kt

@@ -1,7 +1,15 @@
 package pl.jwizard.jwa.rest.route.status
 
-import pl.jwizard.jwa.rest.route.status.dto.GlobalStatusResDto
+import pl.jwizard.jwa.rest.route.status.dto.*
 
 interface StatusService {
-	fun getGlobalStatus(language: String?): GlobalStatusResDto
+	fun getGlobalStatus(): GlobalStatusResDto
+
+	fun getInstancesStatus(avatarSize: Int?): List<InstanceStatusResDto>
+
+	fun getInstanceShardsStatus(instanceId: Int): List<ShardStatusResDto>
+
+	fun getAudioNodesStatus(): AudioNodesStatusResDto
+
+	fun checkIfShardForGuildNameOrIdIsUp(guildNameOrId: String, instanceId: Int?): ShardCheckResDto
 }

jwa-rest/src/main/kotlin/pl/jwizard/jwa/rest/route/status/dto/AudioNodeStatus.kt

@@ -0,0 +1,15 @@
+package pl.jwizard.jwa.rest.route.status.dto
+
+data class AudioNodeStatus(
+	val up: Boolean,
+	val id: Int,
+	val name: String,
+	val pool: String,
+	val region: String,
+	val version: String? = "?",
+	val lavaplayerVersion: String? = "?",
+	val players: Int? = 0,
+	val playingPlayers: Int? = 0,
+	val uptime: String? = "?",
+	val responseTime: Long? = 0
+)

jwa-rest/src/main/kotlin/pl/jwizard/jwa/rest/route/status/dto/AudioNodesStatusResDto.kt

@@ -0,0 +1,6 @@
+package pl.jwizard.jwa.rest.route.status.dto
+
+data class AudioNodesStatusResDto(
+	val externalServicesUrl: String,
+	val nodes: List<AudioNodeStatus>,
+)

jwa-rest/src/main/kotlin/pl/jwizard/jwa/rest/route/status/dto/GlobalStatusResDto.kt

@@ -1,7 +1,6 @@
 package pl.jwizard.jwa.rest.route.status.dto
 
 data class GlobalStatusResDto(
-	val operational: Boolean?,
-	val description: String,
-	val sourceUrl: String,
+	val globalUp: Boolean?,
+	val externalServicesWebsiteUrl: String,
 )

jwa-rest/src/main/kotlin/pl/jwizard/jwa/rest/route/status/dto/InstanceStatusResDto.kt

@@ -0,0 +1,16 @@
+package pl.jwizard.jwa.rest.route.status.dto
+
+data class InstanceStatusResDto(
+	val id: Int,
+	val name: String,
+	val color: String,
+	val avatarUrl: String,
+	val shards: RunningStatusCount,
+	val processes: RunningStatusCount,
+	val avgShardGatewayPing: Long,
+	val avgShardsPerProcess: Int,
+	val servers: Int,
+	val users: Int,
+	val activeAudioPlayers: Int,
+	val audioListeners: Int,
+)

jwa-rest/src/main/kotlin/pl/jwizard/jwa/rest/route/status/dto/RunningStatusCount.kt

@@ -0,0 +1,6 @@
+package pl.jwizard.jwa.rest.route.status.dto
+
+data class RunningStatusCount(
+	val up: Int,
+	val down: Int,
+)

jwa-rest/src/main/kotlin/pl/jwizard/jwa/rest/route/status/dto/ShardCheckResDto.kt

@@ -0,0 +1,7 @@
+package pl.jwizard.jwa.rest.route.status.dto
+
+data class ShardCheckResDto(
+	// true - shard with selected guild is active, false - shard is down or not assigned to
+	// searched guild
+	val status: Boolean,
+)

jwa-rest/src/main/kotlin/pl/jwizard/jwa/rest/route/status/dto/ShardStatusResDto.kt

@@ -0,0 +1,12 @@
+package pl.jwizard.jwa.rest.route.status.dto
+
+data class ShardStatusResDto(
+	val up: Boolean,
+	val globalShardId: Int,
+	val processGroupId: Int,
+	val gatewayPing: Long? = 0,
+	val servers: Int? = 0,
+	val users: Int? = 0,
+	val activeAudioPlayers: Int? = 0,
+	val audioListeners: Int? = 0,
+)