Merge pull request #70 from capcom6/issue/61-healthcheck

capcom6 · web-flow · commit 8089e4e359a8 · 2024-05-27T14:19:21.000+07:00
Add `/health` endpoint
diff --git a/app/build.gradle b/app/build.gradle
@@ -68,9 +68,11 @@ dependencies {
 
     implementation("io.ktor:ktor-server-core:$ktor_version")
     implementation("io.ktor:ktor-server-netty:$ktor_version")
-    implementation("io.ktor:ktor-server-cors:$ktor_version")
+//    implementation("io.ktor:ktor-server-cors:$ktor_version")
     implementation("io.ktor:ktor-server-compression:$ktor_version")
-    implementation "io.ktor:ktor-server-status-pages:$ktor_version"
+    implementation("io.ktor:ktor-server-status-pages:$ktor_version")
+//    implementation("io.ktor:ktor-server-default-headers:$ktor_version")
+
 
     implementation("io.ktor:ktor-server-content-negotiation:$ktor_version")
     implementation("io.ktor:ktor-serialization-gson:$ktor_version")
diff --git a/app/src/main/java/me/capcom/smsgateway/App.kt b/app/src/main/java/me/capcom/smsgateway/App.kt
@@ -1,6 +1,7 @@
 package me.capcom.smsgateway
 
 import android.app.Application
+import healthModule
 import me.capcom.smsgateway.data.dbModule
 import me.capcom.smsgateway.modules.encryption.encryptionModule
 import me.capcom.smsgateway.modules.gateway.GatewayModule
@@ -29,6 +30,7 @@ class App: Application() {
                 messagesModule,
                 encryptionModule,
                 me.capcom.smsgateway.modules.gateway.gatewayModule,
+                healthModule,
             )
         }
 
diff --git a/app/src/main/java/me/capcom/smsgateway/data/dao/MessageDao.kt b/app/src/main/java/me/capcom/smsgateway/data/dao/MessageDao.kt
@@ -10,13 +10,16 @@ import me.capcom.smsgateway.data.entities.Message
 import me.capcom.smsgateway.data.entities.MessageRecipient
 import me.capcom.smsgateway.data.entities.MessageState
 import me.capcom.smsgateway.data.entities.MessageWithRecipients
-import me.capcom.smsgateway.data.entities.ProcessedStats
+import me.capcom.smsgateway.data.entities.MessagesStats
 import me.capcom.smsgateway.data.entities.RecipientState
 
 @Dao
 interface MessageDao {
     @Query("SELECT COUNT(*) as count, MAX(processedAt) as lastTimestamp FROM message WHERE state <> 'Pending' AND state <> 'Failed' AND processedAt >= :timestamp")
-    fun countProcessedFrom(timestamp: Long): ProcessedStats
+    fun countProcessedFrom(timestamp: Long): MessagesStats
+
+    @Query("SELECT COUNT(*) as count, MAX(createdAt) as lastTimestamp FROM message WHERE state = 'Failed' AND createdAt >= :timestamp")
+    fun countFailedFrom(timestamp: Long): MessagesStats
 
     @Query("SELECT * FROM message ORDER BY createdAt DESC LIMIT 50")
     fun selectLast(): LiveData<List<Message>>
diff --git a/app/src/main/java/me/capcom/smsgateway/data/entities/MessagesStats.kt b/app/src/main/java/me/capcom/smsgateway/data/entities/MessagesStats.kt
@@ -1,6 +1,6 @@
 package me.capcom.smsgateway.data.entities
 
-data class ProcessedStats(
+data class MessagesStats(
     val count: Int,
     val lastTimestamp: Long
 )
diff --git a/app/src/main/java/me/capcom/smsgateway/modules/health/HealthService.kt b/app/src/main/java/me/capcom/smsgateway/modules/health/HealthService.kt
@@ -0,0 +1,24 @@
+package me.capcom.smsgateway.modules.health
+
+import me.capcom.smsgateway.modules.health.domain.HealthResult
+import me.capcom.smsgateway.modules.health.domain.Status
+import me.capcom.smsgateway.modules.messages.MessagesService
+
+class HealthService(
+    private val messagesSvc: MessagesService,
+) {
+
+    fun healthCheck(): HealthResult {
+        val messagesChecks = messagesSvc.healthCheck()
+        val allChecks = messagesChecks.mapKeys { "messages:${it.key}" }
+
+        return HealthResult(
+            when {
+                allChecks.values.any { it.status == Status.FAIL } -> Status.FAIL
+                allChecks.values.any { it.status == Status.WARN } -> Status.WARN
+                else -> Status.PASS
+            },
+            allChecks
+        )
+    }
+}
diff --git a/app/src/main/java/me/capcom/smsgateway/modules/health/Module.kt b/app/src/main/java/me/capcom/smsgateway/modules/health/Module.kt
@@ -0,0 +1,6 @@
+import me.capcom.smsgateway.modules.health.HealthService
+import org.koin.dsl.module
+
+val healthModule = module {
+    single { HealthService(get()) }
+}
diff --git a/app/src/main/java/me/capcom/smsgateway/modules/health/domain/CheckResult.kt b/app/src/main/java/me/capcom/smsgateway/modules/health/domain/CheckResult.kt
@@ -0,0 +1,8 @@
+package me.capcom.smsgateway.modules.health.domain
+
+data class CheckResult(
+    val status: Status,
+    val observedValue: Long,
+    val observedUnit: String,
+    val description: String,
+)
diff --git a/app/src/main/java/me/capcom/smsgateway/modules/health/domain/HealthResult.kt b/app/src/main/java/me/capcom/smsgateway/modules/health/domain/HealthResult.kt
@@ -0,0 +1,6 @@
+package me.capcom.smsgateway.modules.health.domain
+
+data class HealthResult(
+    val status: Status,
+    val checks: Map<String, CheckResult>
+)
diff --git a/app/src/main/java/me/capcom/smsgateway/modules/health/domain/Status.kt b/app/src/main/java/me/capcom/smsgateway/modules/health/domain/Status.kt
@@ -0,0 +1,14 @@
+package me.capcom.smsgateway.modules.health.domain
+
+import com.google.gson.annotations.SerializedName
+
+enum class Status {
+    @SerializedName("pass")
+    PASS,
+
+    @SerializedName("warn")
+    WARN,
+
+    @SerializedName("fail")
+    FAIL,
+}
diff --git a/app/src/main/java/me/capcom/smsgateway/modules/localserver/WebService.kt b/app/src/main/java/me/capcom/smsgateway/modules/localserver/WebService.kt
@@ -9,11 +9,11 @@ import android.os.PowerManager
 import androidx.lifecycle.LiveData
 import androidx.lifecycle.MutableLiveData
 import com.aventrix.jnanoid.jnanoid.NanoIdUtils
-import io.ktor.http.HttpHeaders
-import io.ktor.http.HttpMethod
 import io.ktor.http.HttpStatusCode
+import io.ktor.http.toHttpDate
 import io.ktor.serialization.gson.gson
 import io.ktor.server.application.call
+import io.ktor.server.application.createApplicationPlugin
 import io.ktor.server.application.install
 import io.ktor.server.auth.Authentication
 import io.ktor.server.auth.UserIdPrincipal
@@ -22,19 +22,23 @@ import io.ktor.server.auth.basic
 import io.ktor.server.engine.embeddedServer
 import io.ktor.server.netty.Netty
 import io.ktor.server.plugins.contentnegotiation.ContentNegotiation
-import io.ktor.server.plugins.cors.routing.CORS
 import io.ktor.server.plugins.statuspages.StatusPages
 import io.ktor.server.request.receive
+import io.ktor.server.response.header
 import io.ktor.server.response.respond
 import io.ktor.server.routing.get
 import io.ktor.server.routing.post
 import io.ktor.server.routing.route
 import io.ktor.server.routing.routing
+import io.ktor.util.date.GMTDate
+import me.capcom.smsgateway.BuildConfig
 import me.capcom.smsgateway.R
 import me.capcom.smsgateway.data.entities.Message
 import me.capcom.smsgateway.domain.MessageState
 import me.capcom.smsgateway.extensions.setDateFormatISO8601
 import me.capcom.smsgateway.helpers.SettingsHelper
+import me.capcom.smsgateway.modules.health.HealthService
+import me.capcom.smsgateway.modules.health.domain.Status
 import me.capcom.smsgateway.modules.localserver.domain.Device
 import me.capcom.smsgateway.modules.localserver.domain.PostMessageRequest
 import me.capcom.smsgateway.modules.localserver.domain.PostMessageResponse
@@ -51,6 +55,7 @@ class WebService : Service() {
     private val settingsHelper: SettingsHelper by inject()
     private val messagesService: MessagesService by inject()
     private val notificationsService: NotificationsService by inject()
+    private val healthService: HealthService by inject()
 
     private val wakeLock: PowerManager.WakeLock by lazy {
         (getSystemService(Context.POWER_SERVICE) as PowerManager).run {
@@ -91,13 +96,39 @@ class WebService : Service() {
                     )
                 }
             }
+            install(createApplicationPlugin(name = "DateHeader") {
+                onCall { call ->
+                    call.response.header(
+                        "Date",
+                        GMTDate(null).toHttpDate()
+                    )
+                }
+            })
+//            install(DefaultHeaders) {
+//                header("Server", "")
+//            }
+//            install(CORS) {
+//                anyHost()
+//                allowHeader(HttpHeaders.Authorization)
+//                allowHeader(HttpHeaders.ContentType)
+//                allowCredentials = true
+//            }
             routing {
-                install(CORS) {
-                    anyHost()
-                    allowHeader(HttpHeaders.ContentType)
-                    allowHeader(HttpHeaders.Authorization)
-                    allowMethod(HttpMethod.Get)
-                    allowMethod(HttpMethod.Post)
+                get("/health") {
+                    val healthResult = healthService.healthCheck()
+                    call.respond(
+                        when (healthResult.status) {
+                            Status.FAIL -> HttpStatusCode.InternalServerError
+                            Status.WARN -> HttpStatusCode.OK
+                            Status.PASS -> HttpStatusCode.OK
+                        },
+                        mapOf(
+                            "status" to healthResult.status,
+                            "version" to BuildConfig.VERSION_NAME,
+                            "releaseId" to BuildConfig.VERSION_CODE,
+                            "checks" to healthResult.checks
+                        )
+                    )
                 }
                 authenticate("auth-basic") {
                     get("/") {
diff --git a/app/src/main/java/me/capcom/smsgateway/modules/messages/MessagesService.kt b/app/src/main/java/me/capcom/smsgateway/modules/messages/MessagesService.kt
@@ -21,6 +21,8 @@ import me.capcom.smsgateway.data.entities.MessageWithRecipients
 import me.capcom.smsgateway.helpers.PhoneHelper
 import me.capcom.smsgateway.modules.encryption.EncryptionService
 import me.capcom.smsgateway.modules.events.EventBus
+import me.capcom.smsgateway.modules.health.domain.CheckResult
+import me.capcom.smsgateway.modules.health.domain.Status
 import me.capcom.smsgateway.modules.messages.data.SendRequest
 import me.capcom.smsgateway.modules.messages.events.MessageStateChangedEvent
 import me.capcom.smsgateway.modules.messages.workers.LogTruncateWorker
@@ -39,6 +41,24 @@ class MessagesService(
     private val countryCode: String? =
         (context.getSystemService(Context.TELEPHONY_SERVICE) as TelephonyManager).networkCountryIso
 
+    fun healthCheck(): Map<String, CheckResult> {
+        val timestamp = System.currentTimeMillis() - 3600 * 1000L
+        val failedStats = dao.countFailedFrom(timestamp)
+        val processedStats = dao.countProcessedFrom(timestamp)
+        return mapOf(
+            "failed" to CheckResult(
+                when {
+                    failedStats.count > 0 && processedStats.count == 0 -> Status.FAIL
+                    failedStats.count > 0 -> Status.WARN
+                    else -> Status.PASS
+                },
+                failedStats.count.toLong(),
+                "messages",
+                "Failed messages for last hour"
+            )
+        )
+    }
+
     fun start() {
         SendMessagesWorker.start(context)
         LogTruncateWorker.start(context)
diff --git a/docs/api/swagger.json b/docs/api/swagger.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.0",
   "info": {
-    "version": "1.10.0",
+    "version": "1.0.0",
     "title": "Android SMS Gateway Integration API",
     "description": "Provides the ability to send SMS by sending requests directly to the device or through a cloud server.",
     "contact": {
@@ -161,6 +161,49 @@
           }
         ]
       }
+    },
+    "/health": {
+      "get": {
+        "tags": [
+          "System"
+        ],
+        "summary": "Health Check",
+        "description": "Returns the health status of the service.",
+        "operationId": "get-health",
+        "responses": {
+          "200": {
+            "description": "Successfully retrieved health status.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthCheck"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal server error or health check failure.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthCheck"
+                }
+              }
+            }
+          }
+        },
+        "security": [],
+        "servers": [
+          {
+            "url": "http://device-ip:8080",
+            "description": "Local Server"
+          },
+          {
+            "url": "https://sms.capcom.me/api/3rdparty/v1",
+            "description": "Cloud Server"
+          }
+        ]
+      }
     }
   },
   "tags": [
@@ -169,6 +212,9 @@
     },
     {
       "name": "Messages"
+    },
+    {
+      "name": "System"
     }
   ],
   "components": {
@@ -252,6 +298,61 @@
           }
         }
       },
+      "HealthCheck": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string",
+            "enum": [
+              "pass",
+              "fail",
+              "warn"
+            ],
+            "description": "Overall status of the health check. Possible values: \"pass\", \"fail\", \"warn\"."
+          },
+          "version": {
+            "type": "string",
+            "description": "Current version of the service or application."
+          },
+          "releaseId": {
+            "type": "integer",
+            "description": "Specific release or deployment identifier of the service or application."
+          },
+          "checks": {
+            "type": "object",
+            "description": "Detailed health check results for specific components or features.",
+            "additionalProperties": {
+              "$ref": "#/components/schemas/CheckDetail"
+            }
+          }
+        }
+      },
+      "CheckDetail": {
+        "type": "object",
+        "properties": {
+          "description": {
+            "type": "string",
+            "description": "Human-readable explanation of the health check."
+          },
+          "observedUnit": {
+            "type": "string",
+            "description": "Unit of measurement for the observed value."
+          },
+          "observedValue": {
+            "type": "integer",
+            "description": "The result of the health check, represented as a number."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "pass",
+              "fail",
+              "warn"
+            ],
+            "description": "Status of this specific check. Possible values: \"pass\", \"fail\", \"warn\"."
+          }
+        }
+      },
       "Message": {
         "type": "object",
         "title": "Message",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package me.capcom.smsgateway`
`2`	`2`
`3`	`3`	`import android.app.Application`
	`4`	`+import healthModule`
`4`	`5`	`import me.capcom.smsgateway.data.dbModule`
`5`	`6`	`import me.capcom.smsgateway.modules.encryption.encryptionModule`
`6`	`7`	`import me.capcom.smsgateway.modules.gateway.GatewayModule`
`@@ -29,6 +30,7 @@ class App: Application() {`
`29`	`30`	`messagesModule,`
`30`	`31`	`encryptionModule,`
`31`	`32`	`me.capcom.smsgateway.modules.gateway.gatewayModule,`
	`33`	`+ healthModule,`
`32`	`34`	`)`
`33`	`35`	`}`
`34`	`36`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`package me.capcom.smsgateway.data.entities`
`2`	`2`
`3`		`-data class ProcessedStats(`
	`3`	`+data class MessagesStats(`
`4`	`4`	`val count: Int,`
`5`	`5`	`val lastTimestamp: Long`
`6`	`6`	`)`