Expose the date of the last uptime check on the API

Author: akobor

docs/api-doc/kuvasz-latest.yml

@@ -288,6 +288,10 @@ components:
           type: string
           format: date-time
           nullable: true
+        lastUptimeCheck:
+          type: string
+          format: date-time
+          nullable: true
         uptimeError:
           type: string
           nullable: true

src/main/kotlin/com/kuvaszuptime/kuvasz/models/dto/MonitorDetailsDto.kt

@@ -16,6 +16,7 @@ data class MonitorDetailsDto(
     val updatedAt: OffsetDateTime?,
     val uptimeStatus: UptimeStatus?,
     val uptimeStatusStartedAt: OffsetDateTime?,
+    val lastUptimeCheck: OffsetDateTime?,
     val uptimeError: String?,
     val averageLatencyInMs: Int?,
     val p95LatencyInMs: Int?,

src/main/kotlin/com/kuvaszuptime/kuvasz/repositories/MonitorRepository.kt

@@ -39,6 +39,7 @@ class MonitorRepository @Inject constructor(jooqConfig: Configuration) : Monitor
                 MONITOR.ID,
                 UPTIME_EVENT.STATUS,
                 UPTIME_EVENT.STARTED_AT,
+                UPTIME_EVENT.UPDATED_AT,
                 UPTIME_EVENT.ERROR
             )
             .fetchInto(MonitorDetailsDto::class.java)
@@ -50,6 +51,7 @@ class MonitorRepository @Inject constructor(jooqConfig: Configuration) : Monitor
                 MONITOR.ID,
                 UPTIME_EVENT.STATUS,
                 UPTIME_EVENT.STARTED_AT,
+                UPTIME_EVENT.UPDATED_AT,
                 UPTIME_EVENT.ERROR
             )
             .fetchOneInto(MonitorDetailsDto::class.java)
@@ -100,6 +102,7 @@ class MonitorRepository @Inject constructor(jooqConfig: Configuration) : Monitor
                 MONITOR.UPDATED_AT.`as`("updatedAt"),
                 UPTIME_EVENT.STATUS.`as`("uptimeStatus"),
                 UPTIME_EVENT.STARTED_AT.`as`("uptimeStatusStartedAt"),
+                UPTIME_EVENT.UPDATED_AT.`as`("lastUptimeCheck"),
                 UPTIME_EVENT.ERROR.`as`("uptimeError"),
                 round(avg(LATENCY_LOG.LATENCY), -1).`as`("averageLatencyInMs"),
                 inline(null, SQLDataType.INTEGER).`as`("p95LatencyInMs"),

src/test/kotlin/com/kuvaszuptime/kuvasz/controllers/MonitorControllerTest.kt

@@ -3,13 +3,17 @@ package com.kuvaszuptime.kuvasz.controllers
 import arrow.core.Option
 import arrow.core.toOption
 import com.kuvaszuptime.kuvasz.DatabaseBehaviorSpec
+import com.kuvaszuptime.kuvasz.enums.UptimeStatus
 import com.kuvaszuptime.kuvasz.mocks.createMonitor
+import com.kuvaszuptime.kuvasz.mocks.createUptimeEventRecord
 import com.kuvaszuptime.kuvasz.models.dto.MonitorCreateDto
 import com.kuvaszuptime.kuvasz.models.dto.MonitorUpdateDto
 import com.kuvaszuptime.kuvasz.repositories.LatencyLogRepository
 import com.kuvaszuptime.kuvasz.repositories.MonitorRepository
+import com.kuvaszuptime.kuvasz.repositories.UptimeEventRepository
 import com.kuvaszuptime.kuvasz.services.CheckScheduler
 import com.kuvaszuptime.kuvasz.testutils.shouldBe
+import com.kuvaszuptime.kuvasz.util.getCurrentTimestamp
 import io.kotest.assertions.exceptionToMessage
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.test.TestCase
@@ -33,6 +37,7 @@ class MonitorControllerTest(
     private val monitorClient: MonitorClient,
     private val monitorRepository: MonitorRepository,
     private val latencyLogRepository: LatencyLogRepository,
+    private val uptimeEventRepository: UptimeEventRepository,
     private val checkScheduler: CheckScheduler
 ) : DatabaseBehaviorSpec() {
 
@@ -43,6 +48,14 @@ class MonitorControllerTest(
                 latencyLogRepository.insertLatencyForMonitor(monitor.id, 1200)
                 latencyLogRepository.insertLatencyForMonitor(monitor.id, 600)
                 latencyLogRepository.insertLatencyForMonitor(monitor.id, 600)
+                val now = getCurrentTimestamp()
+                createUptimeEventRecord(
+                    repository = uptimeEventRepository,
+                    monitorId = monitor.id,
+                    startedAt = now,
+                    status = UptimeStatus.UP,
+                    endedAt = null
+                )
 
                 val response = monitorClient.getMonitorsWithDetails(enabledOnly = null)
                 then("it should return them") {
@@ -55,7 +68,8 @@ class MonitorControllerTest(
                     responseItem.averageLatencyInMs shouldBe 800
                     responseItem.p95LatencyInMs shouldBe 1200
                     responseItem.p99LatencyInMs shouldBe 1200
-                    responseItem.uptimeStatus shouldBe null
+                    responseItem.uptimeStatus shouldBe UptimeStatus.UP
+                    responseItem.lastUptimeCheck shouldBe now
                     responseItem.createdAt shouldBe monitor.createdAt
                 }
             }
@@ -88,15 +102,27 @@ class MonitorControllerTest(
         given("MonitorController's getMonitorDetails() endpoint") {
             `when`("there is a monitor with the given ID in the database") {
                 val monitor = createMonitor(monitorRepository)
-                val response = monitorClient.getMonitorDetails(monitorId = monitor.id)
+                latencyLogRepository.insertLatencyForMonitor(monitor.id, 1200)
+                latencyLogRepository.insertLatencyForMonitor(monitor.id, 600)
+                latencyLogRepository.insertLatencyForMonitor(monitor.id, 600)
+                val now = getCurrentTimestamp()
+                createUptimeEventRecord(
+                    repository = uptimeEventRepository,
+                    monitorId = monitor.id,
+                    startedAt = now,
+                    status = UptimeStatus.UP,
+                    endedAt = null
+                )
                 then("it should return it") {
+                    val response = monitorClient.getMonitorDetails(monitorId = monitor.id)
                     response.id shouldBe monitor.id
                     response.name shouldBe monitor.name
                     response.url.toString() shouldBe monitor.url
                     response.enabled shouldBe monitor.enabled
-                    response.averageLatencyInMs shouldBe null
-                    response.uptimeStatus shouldBe null
+                    response.averageLatencyInMs shouldBe 800
+                    response.uptimeStatus shouldBe UptimeStatus.UP
                     response.createdAt shouldBe monitor.createdAt
+                    response.lastUptimeCheck shouldBe now
                 }
             }
 
@@ -313,7 +339,8 @@ class MonitorControllerTest(
                     uptimeCheckInterval = null,
                     enabled = true
                 )
-                val updateRequest = HttpRequest.PATCH<MonitorUpdateDto>("/monitors/${firstCreatedMonitor.id}", updateDto)
+                val updateRequest =
+                    HttpRequest.PATCH<MonitorUpdateDto>("/monitors/${firstCreatedMonitor.id}", updateDto)
                 val response = shouldThrow<HttpClientResponseException> {
                     client.toBlocking().exchange<MonitorUpdateDto, Any>(updateRequest)
                 }

src/test/kotlin/com/kuvaszuptime/kuvasz/mocks/TestData.kt

@@ -1,8 +1,12 @@
 package com.kuvaszuptime.kuvasz.mocks
 
+import com.kuvaszuptime.kuvasz.enums.UptimeStatus
 import com.kuvaszuptime.kuvasz.repositories.MonitorRepository
+import com.kuvaszuptime.kuvasz.repositories.UptimeEventRepository
 import com.kuvaszuptime.kuvasz.tables.pojos.MonitorPojo
+import com.kuvaszuptime.kuvasz.tables.pojos.UptimeEventPojo
 import com.kuvaszuptime.kuvasz.util.getCurrentTimestamp
+import java.time.OffsetDateTime
 
 fun createMonitor(
     repository: MonitorRepository,
@@ -22,3 +26,19 @@ fun createMonitor(
     repository.insert(monitor)
     return monitor
 }
+
+fun createUptimeEventRecord(
+    repository: UptimeEventRepository,
+    monitorId: Int,
+    status: UptimeStatus = UptimeStatus.UP,
+    startedAt: OffsetDateTime,
+    endedAt: OffsetDateTime?
+) =
+    repository.insert(
+        UptimeEventPojo()
+            .setMonitorId(monitorId)
+            .setStatus(status)
+            .setStartedAt(startedAt)
+            .setUpdatedAt(endedAt ?: startedAt)
+            .setEndedAt(endedAt)
+    )

src/test/kotlin/com/kuvaszuptime/kuvasz/services/DatabaseCleanerTest.kt

@@ -1,13 +1,12 @@
 package com.kuvaszuptime.kuvasz.services
 
 import com.kuvaszuptime.kuvasz.DatabaseBehaviorSpec
-import com.kuvaszuptime.kuvasz.enums.UptimeStatus
 import com.kuvaszuptime.kuvasz.mocks.createMonitor
+import com.kuvaszuptime.kuvasz.mocks.createUptimeEventRecord
 import com.kuvaszuptime.kuvasz.repositories.LatencyLogRepository
 import com.kuvaszuptime.kuvasz.repositories.MonitorRepository
 import com.kuvaszuptime.kuvasz.repositories.UptimeEventRepository
 import com.kuvaszuptime.kuvasz.tables.pojos.LatencyLogPojo
-import com.kuvaszuptime.kuvasz.tables.pojos.UptimeEventPojo
 import com.kuvaszuptime.kuvasz.util.getCurrentTimestamp
 import io.kotest.matchers.collections.shouldHaveSize
 import io.micronaut.context.annotation.Property
@@ -27,7 +26,12 @@ class DatabaseCleanerTest(
         given("a DatabaseCleaner service") {
             `when`("there is an UPTIME_EVENT record with an end date greater than retention limit") {
                 val monitor = createMonitor(monitorRepository)
-                insertUptimeEventRecord(monitor.id, getCurrentTimestamp().minusDays(1), getCurrentTimestamp())
+                createUptimeEventRecord(
+                    repository = uptimeEventRepository,
+                    monitorId = monitor.id,
+                    startedAt = getCurrentTimestamp().minusDays(1),
+                    endedAt = getCurrentTimestamp()
+                )
                 databaseCleaner.cleanObsoleteData()
 
                 then("it should not delete it") {
@@ -38,7 +42,12 @@ class DatabaseCleanerTest(
 
             `when`("there is an UPTIME_EVENT record without an end date") {
                 val monitor = createMonitor(monitorRepository)
-                insertUptimeEventRecord(monitor.id, getCurrentTimestamp().minusDays(20), null)
+                createUptimeEventRecord(
+                    repository = uptimeEventRepository,
+                    monitorId = monitor.id,
+                    startedAt = getCurrentTimestamp().minusDays(20),
+                    endedAt = null
+                )
                 databaseCleaner.cleanObsoleteData()
 
                 then("it should not delete it") {
@@ -49,10 +58,11 @@ class DatabaseCleanerTest(
 
             `when`("there is an UPTIME_EVENT record with an end date less than retention limit") {
                 val monitor = createMonitor(monitorRepository)
-                insertUptimeEventRecord(
-                    monitor.id,
-                    getCurrentTimestamp().minusDays(20),
-                    getCurrentTimestamp().minusDays(8)
+                createUptimeEventRecord(
+                    repository = uptimeEventRepository,
+                    monitorId = monitor.id,
+                    startedAt = getCurrentTimestamp().minusDays(20),
+                    endedAt = getCurrentTimestamp().minusDays(8)
                 )
                 databaseCleaner.cleanObsoleteData()
 
@@ -86,16 +96,6 @@ class DatabaseCleanerTest(
         }
     }
 
-    private fun insertUptimeEventRecord(monitorId: Int, startedAt: OffsetDateTime, endedAt: OffsetDateTime?) =
-        uptimeEventRepository.insert(
-            UptimeEventPojo()
-                .setMonitorId(monitorId)
-                .setStatus(UptimeStatus.UP)
-                .setStartedAt(startedAt)
-                .setUpdatedAt(endedAt ?: startedAt)
-                .setEndedAt(endedAt)
-        )
-
     private fun insertLatencyLogRecord(monitorId: Int, createdAt: OffsetDateTime) =
         latencyLogRepository.insert(
             LatencyLogPojo()