Add Config Version and Rule Passed to Exposure Metadata (#400)

Author: sroyal-statsig

src/main/kotlin/com/statsig/sdk/ConfigEvaluation.kt

@@ -13,6 +13,7 @@ class ConfigEvaluation(
     var configDelegate: String? = null,
     var evaluationDetails: EvaluationDetails? = null,
     var isExperimentGroup: Boolean = false,
+    var configVersion: Long? = null,
 ) {
     internal var isDelegate: Boolean = false
 

src/main/kotlin/com/statsig/sdk/DataTypes.kt

@@ -39,6 +39,7 @@ internal data class APIConfig(
     @SerializedName("explicitParameters") val explicitParameters: Array<String>?,
     @SerializedName("hasSharedParams") val hasSharedParams: Boolean?,
     @SerializedName("targetAppIDs") val targetAppIDs: Array<String>? = null,
+    @SerializedName("version") val version: Long? = 0,
 )
 
 internal data class APIRule(
@@ -121,9 +122,10 @@ internal data class LayerExposureMetadata(
     @SerializedName("secondaryExposures") val secondaryExposures: ArrayList<Map<String, String>>,
     @SerializedName("isManualExposure") var isManualExposure: String = "false",
     @SerializedName("evaluationDetails") val evaluationDetails: EvaluationDetails?,
+    @SerializedName("configVersion") val configVersion: Long? = null,
 ) {
     fun toStatsigEventMetadataMap(): MutableMap<String, String> {
-        return mutableMapOf(
+        var map = mutableMapOf(
             "config" to config,
             "ruleID" to ruleID,
             "allocatedExperiment" to allocatedExperiment,
@@ -132,5 +134,9 @@ internal data class LayerExposureMetadata(
             "isManualExposure" to isManualExposure,
             // secondaryExposures excluded -- StatsigEvent adds secondaryExposures explicitly as a top level key
         )
+        if (configVersion != null) {
+            map["configVersion"] = configVersion.toString()
+        }
+        return map
     }
 }

src/main/kotlin/com/statsig/sdk/Evaluator.kt

@@ -445,6 +445,7 @@ internal class Evaluator(
 
     private fun evaluate(ctx: EvaluationContext, config: APIConfig) {
         ctx.evaluation.evaluationDetails = createEvaluationDetails(specStore.getEvaluationReason())
+        ctx.evaluation.configVersion = config.version
 
         if (!config.enabled) {
             logger.debug("${config.name} is not enabled.")

src/main/kotlin/com/statsig/sdk/Layer.kt

@@ -174,5 +174,6 @@ internal fun createLayerExposureMetadata(
         isExplicit.toString(),
         exposures,
         evaluationDetails = configEvaluation.evaluationDetails,
+        configVersion = configEvaluation.configVersion,
     )
 }

src/main/kotlin/com/statsig/sdk/StatsigLogger.kt

@@ -72,71 +72,72 @@ internal class StatsigLogger(
     fun logGateExposure(
         user: StatsigUser?,
         gateName: String,
-        value: Boolean,
-        ruleID: String,
-        secondaryExposures: ArrayList<Map<String, String>>,
+        result: ConfigEvaluation,
         isManualExposure: Boolean = false,
-        evaluationDetails: EvaluationDetails?,
     ) {
         if (!isUniqueExposure(
                 user,
                 gateName,
-                ruleID,
-                value.toString(),
+                result.ruleID,
+                result.booleanValue.toString(),
                 "",
             )
         ) {
             return
         }
         val metadata = mutableMapOf(
             "gate" to gateName,
-            "gateValue" to value.toString(),
-            "ruleID" to ruleID,
+            "gateValue" to result.booleanValue.toString(),
+            "ruleID" to result.ruleID,
             "isManualExposure" to isManualExposure.toString(),
         )
 
-        safeAddEvaluationToEvent(evaluationDetails, metadata)
+        safeAddEvaluationToEvent(result.evaluationDetails, metadata)
+        if (result.configVersion != null) {
+            metadata["configVersion"] = result.configVersion.toString()
+        }
 
         val event = StatsigEvent(
             GATE_EXPOSURE_EVENT,
             eventValue = null,
             metadata,
             user,
             statsigMetadata,
-            secondaryExposures,
+            result.secondaryExposures,
         )
         log(event)
     }
 
     fun logConfigExposure(
         user: StatsigUser?,
         configName: String,
-        ruleID: String,
-        secondaryExposures: ArrayList<Map<String, String>>,
+        result: ConfigEvaluation,
         isManualExposure: Boolean,
-        evaluationDetails: EvaluationDetails?,
     ) {
         if (!isUniqueExposure(
                 user,
                 configName,
-                ruleID,
+                result.ruleID,
                 "",
                 "",
             )
         ) {
             return
         }
         val metadata =
-            mutableMapOf("config" to configName, "ruleID" to ruleID, "isManualExposure" to isManualExposure.toString())
-        safeAddEvaluationToEvent(evaluationDetails, metadata)
+            mutableMapOf("config" to configName, "ruleID" to result.ruleID, "isManualExposure" to isManualExposure.toString(), "rulePassed" to result.booleanValue.toString())
+        safeAddEvaluationToEvent(result.evaluationDetails, metadata)
+        if (result.configVersion != null) {
+            metadata["configVersion"] = result.configVersion.toString()
+        }
 
         val event = StatsigEvent(
             CONFIG_EXPOSURE_EVENT,
             eventValue = null,
             metadata,
             user,
             statsigMetadata,
-            secondaryExposures,
+            result.secondaryExposures,
         )
         log(event)
     }

src/main/kotlin/com/statsig/sdk/StatsigServer.kt

@@ -501,11 +501,8 @@ private class StatsigServerImpl() :
         logger.logGateExposure(
             normalizeUser(user),
             gateName,
-            evaluation.booleanValue,
-            evaluation.ruleID,
-            evaluation.secondaryExposures,
+            evaluation,
             isManualExposure,
-            evaluation.evaluationDetails,
         )
     }
 
@@ -1307,10 +1304,8 @@ private class StatsigServerImpl() :
         logger.logConfigExposure(
             user,
             configName,
-            result.ruleID,
-            result.secondaryExposures,
+            result,
             isManualExposure,
-            result.evaluationDetails,
         )
     }