Merge pull request #85 from statsig-io/add-exposure-metadata-on-layer

add back get exposure metadata function on layer

Author: jkw-statsig

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style=official
-version=0.15.0
+version=0.16.0

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

@@ -1,5 +1,7 @@
 package com.statsig.sdk
 
+import com.google.gson.Gson
+
 typealias OnLayerExposure = (layerExposureEventData: LayerExposureEventData) -> Unit
 internal typealias OnLayerExposureInternal = (layer: Layer, parameterName: String) -> Unit
 
@@ -10,6 +12,8 @@ class Layer internal constructor(
     val name: String,
     val ruleID: String? = null,
     val value: Map<String, Any>,
+    private val secondaryExposures: ArrayList<Map<String, String>> = arrayListOf(),
+    private val allocatedExperiment: String = "",
     private val onExposure: OnLayerExposureInternal? = null
 ) {
 
@@ -113,6 +117,20 @@ class Layer internal constructor(
         }
     }
 
+    /**
+     * Legacy exposure data at the layer level. Should NOT be used in new code as this will cause over exposure.
+     */
+    fun getLegacyExposureMetadata(): String {
+        return Gson().toJson(
+            mapOf(
+                "config" to this.name,
+                "ruleID" to this.ruleID,
+                "secondaryExposures" to this.secondaryExposures,
+                "allocatedExperiment" to this.allocatedExperiment
+            )
+        )
+    }
+
     private fun logParameterExposure(key: String) {
         onExposure?.let {
             it(this, key)

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

@@ -65,6 +65,11 @@ class Statsig {
             return statsigServer.getLayerWithCustomExposureLogging(user, layerName, onExposure)
         }
 
+        suspend fun getLayerWithExposureLoggingDisabled(user: StatsigUser, layerName: String): Layer {
+            enforceInitialized()
+            return statsigServer.getLayerWithExposureLoggingDisabled(user, layerName)
+        }
+
         suspend fun shutdownSuspend() {
             statsigServer.shutdownSuspend()
         }
@@ -163,6 +168,15 @@ class Statsig {
             return statsigServer.getLayerWithCustomExposureLoggingAsync(user, layerName, onExposure)
         }
 
+        @JvmStatic
+        fun getLayerWithExposureLoggingDisabledAsync(
+            user: StatsigUser,
+            layerName: String,
+        ): CompletableFuture<Layer> {
+            enforceInitialized()
+            return statsigServer.getLayerWithExposureLoggingDisabledAsync(user, layerName)
+        }
+
         @JvmStatic
         fun getExperimentInLayerForUserAsync(
                 user: StatsigUser,

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

@@ -2,7 +2,7 @@ package com.statsig.sdk
 
 import java.util.Properties
 
-private const val VERSION = "0.15.0"
+private const val VERSION = "0.16.0"
 
 internal class StatsigMetadata {
     companion object {

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

@@ -45,6 +45,8 @@ sealed class StatsigServer {
 
     @JvmSynthetic abstract suspend fun getLayerWithCustomExposureLogging(user: StatsigUser, layerName: String, onExposure: OnLayerExposure): Layer
 
+    @JvmSynthetic abstract suspend fun getLayerWithExposureLoggingDisabled(user: StatsigUser, layerName: String): Layer
+
     @JvmSynthetic abstract suspend fun shutdownSuspend()
 
     fun logEvent(user: StatsigUser?, eventName: String) {
@@ -109,6 +111,11 @@ sealed class StatsigServer {
         onExposure: OnLayerExposure
     ): CompletableFuture<Layer>
 
+    abstract fun getLayerWithExposureLoggingDisabledAsync(
+        user: StatsigUser,
+        layerName: String,
+    ): CompletableFuture<Layer>
+
     /**
      * @deprecated
      * - we make no promises of support for this API
@@ -292,15 +299,23 @@ private class StatsigServerImpl(serverSecret: String, private val options: Stats
 
     override suspend fun getLayer(user: StatsigUser, layerName: String): Layer {
         return this.errorBoundary.capture({
-            return@capture getLayerImpl(user, layerName)
+            return@capture getLayerImpl(user, layerName, false)
         }, {
             return@capture Layer.empty(layerName)
         })
     }
 
     override suspend fun getLayerWithCustomExposureLogging(user: StatsigUser, layerName: String, onExposure: OnLayerExposure): Layer {
         return this.errorBoundary.capture({
-            return@capture getLayerImpl(user, layerName, onExposure)
+            return@capture getLayerImpl(user, layerName, false, onExposure)
+        }, {
+            return@capture Layer.empty(layerName)
+        })
+    }
+
+    override suspend fun getLayerWithExposureLoggingDisabled(user: StatsigUser, layerName: String): Layer {
+        return this.errorBoundary.capture({
+            return@capture getLayerImpl(user, layerName, true)
         }, {
             return@capture Layer.empty(layerName)
         })
@@ -425,6 +440,15 @@ private class StatsigServerImpl(serverSecret: String, private val options: Stats
         }
     }
 
+    override fun getLayerWithExposureLoggingDisabledAsync(
+        user: StatsigUser,
+        layerName: String,
+    ): CompletableFuture<Layer> {
+        return statsigScope.future {
+            return@future getLayerWithExposureLoggingDisabled(user, layerName)
+        }
+    }
+
     /**
      * @deprecated
      * - we make no promises of support for this API
@@ -441,7 +465,7 @@ private class StatsigServerImpl(serverSecret: String, private val options: Stats
         logger.flush()
     }
 
-    private suspend fun getLayerImpl(user: StatsigUser, layerName: String, onExposure: OnLayerExposure? = null): Layer {
+    private suspend fun getLayerImpl(user: StatsigUser, layerName: String, disableExposure: Boolean, onExposure: OnLayerExposure? = null): Layer {
         return this.errorBoundary.capture({
             enforceActive()
             val normalizedUser = normalizeUser(user)
@@ -456,10 +480,14 @@ private class StatsigServerImpl(serverSecret: String, private val options: Stats
             return@capture Layer(
                 layerName,
                 result.ruleID,
-                value as Map<String, Any>
-            ) { layer, paramName ->
+                value as Map<String, Any>,
+                result.secondaryExposures,
+                result.configDelegate ?: "",
+            ) exposureFun@{ layer, paramName ->
                 val metadata = createLayerExposureMetadata(layer, paramName, result)
-
+                if (disableExposure) {
+                    return@exposureFun
+                }
                 if (onExposure != null) {
                     onExposure(
                         LayerExposureEventData(