supporting ordering of results in feature history

featurehub-io · May 19, 2024 · adc41d2 · adc41d2
1 parent 1ef871c
commit adc41d2
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 9 deletions.
diff --git a/backend/mr-api/feature-history.yaml b/backend/mr-api/feature-history.yaml
@@ -132,8 +132,17 @@ paths:
           schema:
             type: integer
           description: "what position in the results to start at"
+        - name: order
+          in: query
+          schema:
+            $ref: "#/components/schemas/FeatureHistoryOrder"
 components:
   schemas:
+    FeatureHistoryOrder:
+      type: string
+      enum:
+        - asc
+        - desc
     FeatureHistoryItem:
       type: object
       properties:

diff --git a/backend/mr-db-api/src/main/kotlin/io/featurehub/db/api/FeatureHistoryApi.kt b/backend/mr-db-api/src/main/kotlin/io/featurehub/db/api/FeatureHistoryApi.kt
@@ -4,5 +4,14 @@ import io.featurehub.mr.model.FeatureHistoryList
 import java.util.*
 
 interface FeatureHistoryApi {
-  fun listHistory(appId: UUID, environmentIds: List<UUID>, versions: List<Long>, keys: List<String>, featureIds: List<UUID>, max: Int?, startAt: Int?): FeatureHistoryList
+  fun listHistory(
+    appId: UUID,
+    environmentIds: List<UUID>,
+    versions: List<Long>,
+    keys: List<String>,
+    featureIds: List<UUID>,
+    max: Int?,
+    startAt: Int?,
+    orderDescending: Boolean
+  ): FeatureHistoryList
 }
diff --git a/backend/mr-db-sql/src/main/kotlin/io/featurehub/db/services/FeatureHistorySqlApi.kt b/backend/mr-db-sql/src/main/kotlin/io/featurehub/db/services/FeatureHistorySqlApi.kt
@@ -26,7 +26,8 @@ class FeatureHistorySqlApi : InternalFeatureHistoryApi, FeatureHistoryApi {
     keys: List<String>,
     featureIds: List<UUID>,
     max: Int?,
-    startAt: Int?
+    startAt: Int?,
+    orderDescending: Boolean
   ): FeatureHistoryList {
     val highest = ((max ?: 20).coerceAtLeast(1)).coerceAtMost(100)
     val start = (startAt?.coerceAtLeast(0) ?: 0)
@@ -60,7 +61,15 @@ class FeatureHistorySqlApi : InternalFeatureHistoryApi, FeatureHistoryApi {
     }
 
     val count = finder.findFutureCount()
-    val data =  finder.setMaxRows(highest).setFirstRow(start).orderBy().id.version.asc().findList()
+    finder =  finder.setMaxRows(highest).setFirstRow(start)
+
+    if (orderDescending) {
+      finder = finder.orderBy().id.version.desc()
+    } else {
+      finder = finder.orderBy().id.version.asc()
+    }
+
+    val data = finder.findList()
 
     val items = mutableMapOf<FeatureHistoryItem, FeatureHistoryItem>()
 

diff --git a/backend/mr-db-sql/src/test/groovy/io/featurehub/db/services/FeatureHistorySpec.groovy b/backend/mr-db-sql/src/test/groovy/io/featurehub/db/services/FeatureHistorySpec.groovy
@@ -28,7 +28,7 @@ class FeatureHistorySpec extends Base3Spec {
     and:
       def historyApi = new FeatureHistorySqlApi()
     when: "i ask for version history for all environments"
-      def result = historyApi.listHistory(app1.id, [env1.id, env2.id, env3.id], [], [], [], null, null)
+      def result = historyApi.listHistory(app1.id, [env1.id, env2.id, env3.id], [], [], [], null, null, false)
     then:
       result.max == 9
       result.items.size() == 9
@@ -38,7 +38,7 @@ class FeatureHistorySpec extends Base3Spec {
       def fv = featureSqlApi.getFeatureValueForEnvironment(env1.id, features[1].key)
       featureSqlApi.updateFeatureValueForEnvironment(env1.id, features[1].key, fv.valueBoolean(true).locked(false), new PersonFeaturePermission(superPerson,
               [RoleType.CHANGE_VALUE, RoleType.UNLOCK] as Set<RoleType>))
-      def result2 = historyApi.listHistory(app1.id, [env1.id], [], [], [features[1].id], null, null)
+      def result2 = historyApi.listHistory(app1.id, [env1.id], [], [], [features[1].id], null, null, false)
     then:
       result2.max == 2
       result2.items.size() == 1
@@ -49,18 +49,22 @@ class FeatureHistorySpec extends Base3Spec {
       result2.items[0].history[1].value
       result2.items[0].history[1].who.id == superPerson.id.id
       result2.items[0].history[1].who.name == superPerson.name
+    when: "i do the same query but reverse the order..."
+      def result2Rev = historyApi.listHistory(app1.id, [env1.id], [], [], [features[1].id], null, null, true)
+    then:
+      result2Rev.max == 2
     when: "i update the first number and I see a single number version"
       def num = featureSqlApi.getFeatureValueForEnvironment(env2.id, features[3].key)
       featureSqlApi.updateFeatureValueForEnvironment(env2.id, features[3].key, fv.valueNumber(45.32).locked(false), new PersonFeaturePermission(superPerson,
         [RoleType.CHANGE_VALUE, RoleType.UNLOCK] as Set<RoleType>))
-      def result3 = historyApi.listHistory(app1.id, [env2.id], [], [features[3].key], [], null, null)
+      def result3 = historyApi.listHistory(app1.id, [env2.id], [], [features[3].key], [], null, null, false)
     then:
       result3.max == 1
       result3.items.size() == 1
       result3.items[0].history.size() == 1
       result3.items[0].history[0].value == 45.32
     when: "i use an app id that doesn't relate to the features"
-      def result4 = historyApi.listHistory(UUID.randomUUID(), [env2.id], [], [features[3].key], [], null, null)
+      def result4 = historyApi.listHistory(UUID.randomUUID(), [env2.id], [], [features[3].key], [], null, null, false)
     then:
       result4.max == 0
       result4.items.size() == 0

diff --git a/backend/mr/src/main/kotlin/io/featurehub/mr/resources/FeatureHistoryResource.kt b/backend/mr/src/main/kotlin/io/featurehub/mr/resources/FeatureHistoryResource.kt
@@ -5,8 +5,8 @@ import io.featurehub.db.api.FeatureHistoryApi
 import io.featurehub.mr.api.FeatureHistoryServiceDelegate
 import io.featurehub.mr.auth.AuthManagerService
 import io.featurehub.mr.model.FeatureHistoryList
+import io.featurehub.mr.model.FeatureHistoryOrder
 import jakarta.inject.Inject
-import jakarta.ws.rs.ForbiddenException
 import jakarta.ws.rs.NotFoundException
 import jakarta.ws.rs.core.SecurityContext
 import java.util.*
@@ -35,6 +35,6 @@ class FeatureHistoryResource @Inject constructor(private val authManager: AuthMa
 
     return featureHistoryApi.listHistory(appId, envs, holder.versions ?: listOf(),
       holder.featureKeys ?: listOf(), holder.featureIds ?: listOf(),
-      holder.max, holder.startAt)
+      holder.max, holder.startAt,  holder.order == FeatureHistoryOrder.DESC)
   }
 }
diff --git a/infra/api-bucket/files/mrapi/1.2.1.yaml b/infra/api-bucket/files/mrapi/1.2.1.yaml
@@ -3275,6 +3275,13 @@ paths:
         explode: true
         schema:
           type: integer
+      - name: order
+        in: query
+        required: false
+        style: form
+        explode: true
+        schema:
+          $ref: '#/components/schemas/FeatureHistoryOrder'
       responses:
         "200":
           description: the webhook type details
@@ -5725,6 +5732,11 @@ components:
           description: "Any configuration to pass to the check, e.g. webhook.feature.url,\
             \ headers, etc - this ensures the updates get to the destination and are\
             \ used. They get merged info the envInfo, replacing anything there"
+    FeatureHistoryOrder:
+      type: string
+      enum:
+      - asc
+      - desc
     FeatureHistoryItem:
       type: object
       properties: