Adding params to heatmap API (#481)

closes: #462
provenance-io · Jan 4, 2023 · a4103ec · a4103ec
1 parent d4ccc93
commit a4103ec
Show file tree

Hide file tree

Showing 12 changed files with 88 additions and 41 deletions.
diff --git a/.github/workflows/ktlint.yml b/.github/workflows/ktlint.yml
@@ -15,7 +15,7 @@ jobs:
           curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.47.1/ktlint && chmod a+x ktlint && sudo mv ktlint /usr/local/bin/
       - name: run ktlint
         run: |
-          ktlint --disabled_rules=filename,chain-wrapping,enum-entry-name-case --reporter=checkstyle,output=build/ktlint-report.xml **/*.kt
+          ktlint --disabled_rules=filename,chain-wrapping,enum-entry-name-case,multiline-if-else --reporter=checkstyle,output=build/ktlint-report.xml **/*.kt
         continue-on-error: true
       - uses: yutailang0119/action-ktlint@v3
         with:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -33,6 +33,11 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## Unreleased
 
+### Improvements
+* Add date parameters to `/api/v3/txs/heatmap` #462
+  * Added `fromDate`, `toDate`, `timeframe`
+  * Defaulting to `FOREVER` to return all data
+
 ### Bug Fixes
 * Fixed `/api/v3/validators` url
 * Now handling no fee amount in the tx

diff --git a/README.md b/README.md
@@ -129,7 +129,7 @@ brew install ktlint
 
 In order to automatically lint/check for things that can't be autocorrected run:
 ```
-ktlint -F "**/*.kt" --disabled_rules=filename,chain-wrapping,enum-entry-name-case
+ktlint -F "**/*.kt" --disabled_rules=filename,chain-wrapping,enum-entry-name-case,multiline-if-else
 ```
 This will also correct linting issues, and you can add and commit the updates.
 

diff --git a/api-model/src/main/kotlin/io/provenance/explorer/model/base/CommonModels.kt b/api-model/src/main/kotlin/io/provenance/explorer/model/base/CommonModels.kt
@@ -30,4 +30,4 @@ enum class PeriodInSeconds(val seconds: Int) {
     YEAR(31536000)
 }
 
-enum class Timeframe { WEEK, DAY, HOUR, FOREVER }
+enum class Timeframe { QUARTER, MONTH, WEEK, DAY, HOUR, FOREVER }
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -73,13 +73,4 @@ subprojects {
             apiVersion = "1.6"
         }
     }
-
-    configurations.all {
-        resolutionStrategy.eachDependency {
-            if (requested.group == "org.apache.logging.log4j" && (requested.version == "2.14.1") || (requested.version == "2.15.0")) {
-                useVersion("2.15.0")
-                because("CVE-2021-44228")
-            }
-        }
-    }
 }
diff --git a/docker/Dockerfile-service b/docker/Dockerfile-service
@@ -10,13 +10,13 @@ COPY build.gradle.kts gradle.properties settings.gradle.kts buildSrc/build.gradl
 RUN gradle clean build --no-daemon > /dev/null 2>&1 || true
 
 # Copy all files
-COPY service /app/service/
-COPY database /app/database/
-COPY api-model /app/api-model/
 COPY buildSrc /app/buildSrc/
-COPY .git /app/.git/
 COPY build.gradle.kts gradle.properties settings.gradle.kts /app/
+COPY api-model /app/api-model/
+COPY database /app/database/
+COPY service /app/service/
 COPY CHANGELOG.md CODE_OF_CONDUCT.md CONTRIBUTING.md LICENSE README.md /app/
+COPY .git /app/.git/
 
 # Do the actual build
 RUN gradle clean build --no-daemon

diff --git a/service/build.gradle.kts b/service/build.gradle.kts
@@ -83,15 +83,6 @@ dependencyManagement {
     }
 }
 
-configurations.all {
-    resolutionStrategy.eachDependency {
-        if (requested.group == "org.apache.logging.log4j" && (requested.version == "2.14.1") || (requested.version == "2.15.0")) {
-            useVersion("2.15.0")
-            because("CVE-2021-44228")
-        }
-    }
-}
-
 var profiles = System.getenv("SPRING_PROFILES_ACTIVE") ?: "development"
 
 tasks.getByName<BootRun>("bootRun") {

diff --git a/service/src/main/kotlin/io/provenance/explorer/domain/entities/Blocks.kt b/service/src/main/kotlin/io/provenance/explorer/domain/entities/Blocks.kt
@@ -39,12 +39,16 @@ import org.jetbrains.exposed.dao.id.IntIdTable
 import org.jetbrains.exposed.sql.ColumnType
 import org.jetbrains.exposed.sql.IntegerColumnType
 import org.jetbrains.exposed.sql.Max
+import org.jetbrains.exposed.sql.Op
 import org.jetbrains.exposed.sql.SortOrder
 import org.jetbrains.exposed.sql.SqlExpressionBuilder.eq
+import org.jetbrains.exposed.sql.SqlExpressionBuilder.greaterEq
 import org.jetbrains.exposed.sql.SqlExpressionBuilder.inList
+import org.jetbrains.exposed.sql.SqlExpressionBuilder.lessEq
 import org.jetbrains.exposed.sql.Sum
 import org.jetbrains.exposed.sql.VarCharColumnType
 import org.jetbrains.exposed.sql.and
+import org.jetbrains.exposed.sql.andWhere
 import org.jetbrains.exposed.sql.count
 import org.jetbrains.exposed.sql.deleteWhere
 import org.jetbrains.exposed.sql.insertIgnore
@@ -355,7 +359,7 @@ class BlockCacheHourlyTxCountsRecord(id: EntityID<DateTime>) : Entity<DateTime>(
             }
         }
 
-        fun getTxHeatmap() = transaction {
+        fun getTxHeatmap(fromDate: DateTime? = null, toDate: DateTime? = null) = transaction {
             val blockTimestamp = BlockCacheHourlyTxCountsTable.blockTimestamp
             val dow = ExtractDOW(blockTimestamp)
             val day = ExtractDay(blockTimestamp)
@@ -364,30 +368,23 @@ class BlockCacheHourlyTxCountsRecord(id: EntityID<DateTime>) : Entity<DateTime>(
             val result = BlockCacheHourlyTxCountsTable
                 .slice(dow, day, hour, txSum)
                 .selectAll()
+                .andWhere {
+                    if (fromDate != null && toDate != null)
+                        BlockCacheHourlyTxCountsTable.blockTimestamp.between(fromDate.startOfDay(), toDate.startOfDay())
+                    else Op.TRUE
+                }
                 .groupBy(dow)
                 .groupBy(day)
                 .groupBy(hour)
                 .orderBy(dow, SortOrder.ASC)
                 .orderBy(hour, SortOrder.ASC)
-                .map {
-                    TxHeatmapRaw(
-                        it[dow],
-                        it[day].trim(),
-                        it[hour],
-                        it[txSum]!!
-                    )
-                }
+                .map { TxHeatmapRaw(it[dow], it[day].trim(), it[hour], it[txSum]!!) }
                 .groupBy { it.dow }
                 .map {
                     TxHeatmap(
                         dow = it.key,
                         day = it.value[0].day,
-                        data = it.value.map { row ->
-                            TxHeatmapHour(
-                                row.hour,
-                                row.numberTxs
-                            )
-                        }
+                        data = it.value.map { row -> TxHeatmapHour(row.hour, row.numberTxs) }
                     )
                 }
 

diff --git a/service/src/main/kotlin/io/provenance/explorer/service/TransactionService.kt b/service/src/main/kotlin/io/provenance/explorer/service/TransactionService.kt
@@ -20,10 +20,12 @@ import io.provenance.explorer.domain.entities.TxMsgTypeSubtypeRecord
 import io.provenance.explorer.domain.entities.ValidatorMarketRateRecord
 import io.provenance.explorer.domain.entities.ValidatorStateRecord
 import io.provenance.explorer.domain.entities.getFeepayer
+import io.provenance.explorer.domain.exceptions.InvalidArgumentException
 import io.provenance.explorer.domain.exceptions.validate
 import io.provenance.explorer.domain.extensions.formattedString
 import io.provenance.explorer.domain.extensions.msgEventsToObjectNodePrint
 import io.provenance.explorer.domain.extensions.pageCountOfResults
+import io.provenance.explorer.domain.extensions.startOfDay
 import io.provenance.explorer.domain.extensions.toCoinStr
 import io.provenance.explorer.domain.extensions.toFeePaid
 import io.provenance.explorer.domain.extensions.toFees
@@ -42,13 +44,15 @@ import io.provenance.explorer.model.MsgInfo
 import io.provenance.explorer.model.MsgTypeSet
 import io.provenance.explorer.model.TxDetails
 import io.provenance.explorer.model.TxGov
+import io.provenance.explorer.model.TxHeatmapRes
 import io.provenance.explorer.model.TxHistoryChartData
 import io.provenance.explorer.model.TxMessage
 import io.provenance.explorer.model.TxSmartContract
 import io.provenance.explorer.model.TxStatus
 import io.provenance.explorer.model.TxSummary
 import io.provenance.explorer.model.TxType
 import io.provenance.explorer.model.base.PagedResults
+import io.provenance.explorer.model.base.Timeframe
 import io.provenance.explorer.model.base.getParentForType
 import io.provenance.explorer.model.base.isMAddress
 import io.provenance.explorer.model.base.toMAddress
@@ -227,7 +231,30 @@ class TransactionService(
                 }
         }
 
-    fun getTxHeatmap() = BlockCacheHourlyTxCountsRecord.getTxHeatmap()
+    fun getTxHeatmap(fromDate: DateTime? = null, toDate: DateTime? = null, timeframe: Timeframe = Timeframe.FOREVER): TxHeatmapRes {
+        if (fromDate != null && toDate != null)
+            return BlockCacheHourlyTxCountsRecord.getTxHeatmap(fromDate, toDate)
+
+        val (from, to) = when (timeframe) {
+            Timeframe.FOREVER -> null to null
+            Timeframe.QUARTER ->
+                if (fromDate != null) fromDate to fromDate.plusMonths(3)
+                else if (toDate != null) toDate.minusMonths(3) to toDate
+                else DateTime.now().startOfDay().let { it.minusMonths(3) to it }
+            Timeframe.MONTH ->
+                if (fromDate != null) fromDate to fromDate.plusMonths(1)
+                else if (toDate != null) toDate.minusMonths(1) to toDate
+                else DateTime.now().startOfDay().let { it.minusMonths(1) to it }
+            Timeframe.WEEK ->
+                if (fromDate != null) fromDate to fromDate.plusWeeks(1)
+                else if (toDate != null) toDate.minusWeeks(1) to toDate
+                else DateTime.now().startOfDay().let { it.minusWeeks(1) to it }
+            Timeframe.DAY, Timeframe.HOUR ->
+                throw InvalidArgumentException("Timeframe ${timeframe.name} is not supported for heatmap data")
+        }
+
+        return BlockCacheHourlyTxCountsRecord.getTxHeatmap(from, to)
+    }
 
     private fun getMonikers(txId: EntityID<Int>): Map<String, String> {
         val monikers = TxAddressJoinRecord.findValidatorsByTxHash(valService.getActiveSet(), txId)

diff --git a/service/src/main/kotlin/io/provenance/explorer/service/ValidatorService.kt b/service/src/main/kotlin/io/provenance/explorer/service/ValidatorService.kt
@@ -550,6 +550,8 @@ class ValidatorService(
             Timeframe.DAY -> hourlyBlockCount * 24
             Timeframe.HOUR -> hourlyBlockCount
             Timeframe.FOREVER -> currentHeight - 1
+            Timeframe.QUARTER -> hourlyBlockCount * 24 * (365 / 4)
+            Timeframe.MONTH -> hourlyBlockCount * 24 * (365 / 12)
         }
 
         val validators = MissedBlocksRecord
@@ -580,6 +582,8 @@ class ValidatorService(
             Timeframe.DAY -> hourlyBlockCount * 24
             Timeframe.HOUR -> hourlyBlockCount
             Timeframe.FOREVER -> currentHeight - 1
+            Timeframe.QUARTER -> hourlyBlockCount * 24 * (365 / 4)
+            Timeframe.MONTH -> hourlyBlockCount * 24 * (365 / 12)
         }
 
         val valConsAddr =

diff --git a/service/src/main/kotlin/io/provenance/explorer/web/v2/TransactionControllerV2.kt b/service/src/main/kotlin/io/provenance/explorer/web/v2/TransactionControllerV2.kt
@@ -128,6 +128,8 @@ class TransactionControllerV2(private val transactionService: TransactionService
 
     @ApiOperation("Returns a heatmap of transaction activity on chain")
     @GetMapping("/heatmap")
+    @Deprecated("Use /api/v3/txs/heatmap")
+    @java.lang.Deprecated
     fun txHeatmap() = transactionService.getTxHeatmap()
 
     @ApiOperation("Return list of transaction types")

diff --git a/service/src/main/kotlin/io/provenance/explorer/web/v3/TransactionControllerV3.kt b/service/src/main/kotlin/io/provenance/explorer/web/v3/TransactionControllerV3.kt
@@ -2,6 +2,7 @@ package io.provenance.explorer.web.v3
 
 import io.provenance.explorer.domain.models.explorer.TxHistoryDataRequest
 import io.provenance.explorer.model.base.DateTruncGranularity
+import io.provenance.explorer.model.base.Timeframe
 import io.provenance.explorer.service.TransactionService
 import io.swagger.annotations.Api
 import io.swagger.annotations.ApiOperation
@@ -107,4 +108,33 @@ class TransactionControllerV3(private val transactionService: TransactionService
         @RequestParam(required = false)
         blockHeight: Int? = null
     ) = transactionService.getTxTypesByTxHash(hash)
+
+    @ApiOperation("Returns a heatmap of transaction activity on chain")
+    @GetMapping("/heatmap")
+    fun txHeatmap(
+        @ApiParam(
+            type = "DateTime",
+            value = "DateTime format as  `yyyy-MM-dd` — for example, \"2000-10-31\"",
+            required = false
+        )
+        @RequestParam(required = false)
+        @DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
+        fromDate: DateTime?,
+        @ApiParam(
+            type = "DateTime",
+            value = "DateTime format as  `yyyy-MM-dd` — for example, \"2000-10-31\"",
+            required = false
+        )
+        @RequestParam(required = false)
+        @DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
+        toDate: DateTime?,
+        @ApiParam(
+            value = "The timeframe of data, either QUARTER, MONTH, WEEK, or FOREVER",
+            defaultValue = "FOREVER",
+            required = false,
+            allowableValues = "FOREVER,QUARTER,MONTH,WEEK"
+        )
+        @RequestParam(defaultValue = "FOREVER", required = false)
+        timeframe: Timeframe
+    ) = transactionService.getTxHeatmap(fromDate, toDate, timeframe)
 }