add sendFeatureFlagEvent in param getFeatureFlag

posthog-android/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Next
 
+- feat: add `sendFeatureFlagEvent` properties in function getFeatureFlag() for override config's
+  sendFeatureFlagEvent ([#319](https://github.com/PostHog/posthog-android/pull/319))
+
 ## 3.27.2 - 2025-12-03
 
 - fix: NoSuchMethodError PostHogAndroidConfig ([#342](https://github.com/PostHog/posthog-android/pull/342))

posthog-android/src/test/java/com/posthog/android/PostHogFake.kt

@@ -51,13 +51,15 @@ public class PostHogFake : PostHogInterface {
     override fun isFeatureEnabled(
         key: String,
         defaultValue: Boolean,
+        sendFeatureFlagEvent: Boolean?,
     ): Boolean {
         return false
     }
 
     override fun getFeatureFlag(
         key: String,
         defaultValue: Any?,
+        sendFeatureFlagEvent: Boolean?,
     ): Any? {
         return null
     }

posthog/api/posthog.api

@@ -17,12 +17,12 @@ public final class com/posthog/PostHog : com/posthog/PostHogStateless, com/posth
 	public fun endSession ()V
 	public fun flush ()V
 	public fun getConfig ()Lcom/posthog/PostHogConfig;
-	public fun getFeatureFlag (Ljava/lang/String;Ljava/lang/Object;)Ljava/lang/Object;
+	public fun getFeatureFlag (Ljava/lang/String;Ljava/lang/Object;Ljava/lang/Boolean;)Ljava/lang/Object;
 	public fun getFeatureFlagPayload (Ljava/lang/String;Ljava/lang/Object;)Ljava/lang/Object;
 	public fun getSessionId ()Ljava/util/UUID;
 	public fun group (Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;)V
 	public fun identify (Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;)V
-	public fun isFeatureEnabled (Ljava/lang/String;Z)Z
+	public fun isFeatureEnabled (Ljava/lang/String;ZLjava/lang/Boolean;)Z
 	public fun isOptOut ()Z
 	public fun isSessionActive ()Z
 	public fun isSessionReplayActive ()Z
@@ -53,12 +53,12 @@ public final class com/posthog/PostHog$Companion : com/posthog/PostHogInterface
 	public fun endSession ()V
 	public fun flush ()V
 	public fun getConfig ()Lcom/posthog/PostHogConfig;
-	public fun getFeatureFlag (Ljava/lang/String;Ljava/lang/Object;)Ljava/lang/Object;
+	public fun getFeatureFlag (Ljava/lang/String;Ljava/lang/Object;Ljava/lang/Boolean;)Ljava/lang/Object;
 	public fun getFeatureFlagPayload (Ljava/lang/String;Ljava/lang/Object;)Ljava/lang/Object;
 	public fun getSessionId ()Ljava/util/UUID;
 	public fun group (Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;)V
 	public fun identify (Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;)V
-	public fun isFeatureEnabled (Ljava/lang/String;Z)Z
+	public fun isFeatureEnabled (Ljava/lang/String;ZLjava/lang/Boolean;)Z
 	public fun isOptOut ()Z
 	public fun isSessionActive ()Z
 	public fun isSessionReplayActive ()Z
@@ -272,11 +272,11 @@ public abstract interface class com/posthog/PostHogInterface : com/posthog/PostH
 	public abstract fun distinctId ()Ljava/lang/String;
 	public abstract fun endSession ()V
 	public abstract fun getConfig ()Lcom/posthog/PostHogConfig;
-	public abstract fun getFeatureFlag (Ljava/lang/String;Ljava/lang/Object;)Ljava/lang/Object;
+	public abstract fun getFeatureFlag (Ljava/lang/String;Ljava/lang/Object;Ljava/lang/Boolean;)Ljava/lang/Object;
 	public abstract fun getFeatureFlagPayload (Ljava/lang/String;Ljava/lang/Object;)Ljava/lang/Object;
 	public abstract fun getSessionId ()Ljava/util/UUID;
 	public abstract fun group (Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;)V
-	public abstract fun isFeatureEnabled (Ljava/lang/String;Z)Z
+	public abstract fun isFeatureEnabled (Ljava/lang/String;ZLjava/lang/Boolean;)Z
 	public abstract fun isSessionActive ()Z
 	public abstract fun isSessionReplayActive ()Z
 	public abstract fun register (Ljava/lang/String;Ljava/lang/Object;)V
@@ -296,10 +296,10 @@ public abstract interface class com/posthog/PostHogInterface : com/posthog/PostH
 public final class com/posthog/PostHogInterface$DefaultImpls {
 	public static synthetic fun capture$default (Lcom/posthog/PostHogInterface;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;Ljava/util/Map;Ljava/util/Map;Ljava/util/Date;ILjava/lang/Object;)V
 	public static synthetic fun captureException$default (Lcom/posthog/PostHogInterface;Ljava/lang/Throwable;Ljava/util/Map;ILjava/lang/Object;)V
-	public static synthetic fun getFeatureFlag$default (Lcom/posthog/PostHogInterface;Ljava/lang/String;Ljava/lang/Object;ILjava/lang/Object;)Ljava/lang/Object;
+	public static synthetic fun getFeatureFlag$default (Lcom/posthog/PostHogInterface;Ljava/lang/String;Ljava/lang/Object;Ljava/lang/Boolean;ILjava/lang/Object;)Ljava/lang/Object;
 	public static synthetic fun getFeatureFlagPayload$default (Lcom/posthog/PostHogInterface;Ljava/lang/String;Ljava/lang/Object;ILjava/lang/Object;)Ljava/lang/Object;
 	public static synthetic fun group$default (Lcom/posthog/PostHogInterface;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;ILjava/lang/Object;)V
-	public static synthetic fun isFeatureEnabled$default (Lcom/posthog/PostHogInterface;Ljava/lang/String;ZILjava/lang/Object;)Z
+	public static synthetic fun isFeatureEnabled$default (Lcom/posthog/PostHogInterface;Ljava/lang/String;ZLjava/lang/Boolean;ILjava/lang/Object;)Z
 	public static synthetic fun reloadFeatureFlags$default (Lcom/posthog/PostHogInterface;Lcom/posthog/PostHogOnFeatureFlags;ILjava/lang/Object;)V
 	public static synthetic fun resetGroupPropertiesForFlags$default (Lcom/posthog/PostHogInterface;Ljava/lang/String;ZILjava/lang/Object;)V
 	public static synthetic fun resetPersonPropertiesForFlags$default (Lcom/posthog/PostHogInterface;ZILjava/lang/Object;)V

posthog/src/main/java/com/posthog/PostHog.kt

@@ -83,7 +83,8 @@ public class PostHog private constructor(
                     config.logger.log("Setup called despite already being setup!")
                     return
                 }
-                config.logger = if (config.logger is PostHogNoOpLogger) PostHogPrintLogger(config) else config.logger
+                config.logger =
+                    if (config.logger is PostHogNoOpLogger) PostHogPrintLogger(config) else config.logger
 
                 if (!apiKeys.add(config.apiKey)) {
                     config.logger.log("API Key: ${config.apiKey} already has a PostHog instance.")
@@ -92,8 +93,22 @@ public class PostHog private constructor(
                 val cachePreferences = config.cachePreferences ?: memoryPreferences
                 config.cachePreferences = cachePreferences
                 val api = PostHogApi(config)
-                val queue = config.queueProvider(config, api, PostHogApiEndpoint.BATCH, config.storagePrefix, queueExecutor)
-                val replayQueue = config.queueProvider(config, api, PostHogApiEndpoint.SNAPSHOT, config.replayStoragePrefix, replayExecutor)
+                val queue =
+                    config.queueProvider(
+                        config,
+                        api,
+                        PostHogApiEndpoint.BATCH,
+                        config.storagePrefix,
+                        queueExecutor,
+                    )
+                val replayQueue =
+                    config.queueProvider(
+                        config,
+                        api,
+                        PostHogApiEndpoint.SNAPSHOT,
+                        config.replayStoragePrefix,
+                        replayExecutor,
+                    )
                 val featureFlags =
                     config.remoteConfigProvider(config, api, remoteConfigExecutor) {
                         getDefaultPersonProperties()
@@ -178,7 +193,12 @@ public class PostHog private constructor(
                 // only because of testing in isolation, this flag is always enabled
                 if (reloadFeatureFlags) {
                     when {
-                        config.remoteConfig -> loadRemoteConfigRequest(internalOnFeatureFlagsLoaded, config.onFeatureFlags)
+                        config.remoteConfig ->
+                            loadRemoteConfigRequest(
+                                internalOnFeatureFlagsLoaded,
+                                config.onFeatureFlags,
+                            )
+
                         config.preloadFeatureFlags -> reloadFeatureFlags(config.onFeatureFlags)
                     }
                 }
@@ -731,8 +751,9 @@ public class PostHog private constructor(
         get() {
             synchronized(personProcessingLock) {
                 if (!isPersonProcessingLoaded) {
-                    isPersonProcessingEnabled = getPreferences().getValue(PERSON_PROCESSING) as? Boolean
-                        ?: false
+                    isPersonProcessingEnabled =
+                        getPreferences().getValue(PERSON_PROCESSING) as? Boolean
+                            ?: false
                     isPersonProcessingLoaded = true
                 }
             }
@@ -805,7 +826,10 @@ public class PostHog private constructor(
         if (!isEnabled()) {
             return
         }
-        loadFeatureFlagsRequest(internalOnFeatureFlags = internalOnFeatureFlagsLoaded, onFeatureFlags = onFeatureFlags)
+        loadFeatureFlagsRequest(
+            internalOnFeatureFlags = internalOnFeatureFlagsLoaded,
+            onFeatureFlags = onFeatureFlags,
+        )
     }
 
     private fun loadFeatureFlagsRequest(
@@ -850,14 +874,21 @@ public class PostHog private constructor(
             anonymousId = this.anonymousId
         }
 
-        remoteConfig?.loadRemoteConfig(distinctId, anonymousId = anonymousId, groups, internalOnFeatureFlags, onFeatureFlags)
+        remoteConfig?.loadRemoteConfig(
+            distinctId,
+            anonymousId = anonymousId,
+            groups,
+            internalOnFeatureFlags,
+            onFeatureFlags,
+        )
     }
 
     public override fun isFeatureEnabled(
         key: String,
         defaultValue: Boolean,
+        sendFeatureFlagEvent: Boolean?,
     ): Boolean {
-        val value = getFeatureFlag(key, defaultValue)
+        val value = getFeatureFlag(key, defaultValue, sendFeatureFlagEvent)
 
         if (value is Boolean) {
             return value
@@ -873,51 +904,59 @@ public class PostHog private constructor(
     private fun sendFeatureFlagCalled(
         key: String,
         value: Any?,
+        sendFeatureFlagEvent: Boolean?,
     ) {
-        var shouldSendFeatureFlagEvent = true
-        synchronized(featureFlagsCalledLock) {
-            val values = featureFlagsCalled[key] ?: mutableListOf()
-            if (values.contains(value)) {
-                shouldSendFeatureFlagEvent = false
-            } else {
-                values.add(value)
-                featureFlagsCalled[key] = values
+        val effectiveSendFeatureFlagEvent =
+            sendFeatureFlagEvent
+                ?: config?.sendFeatureFlagEvent
+                ?: false
+
+        if (effectiveSendFeatureFlagEvent) {
+            var shouldSendFeatureFlagEvent = true
+            synchronized(featureFlagsCalledLock) {
+                val values = featureFlagsCalled[key] ?: mutableListOf()
+                if (values.contains(value)) {
+                    shouldSendFeatureFlagEvent = false
+                } else {
+                    values.add(value)
+                    featureFlagsCalled[key] = values
+                }
             }
-        }
 
-        if (config?.sendFeatureFlagEvent == true && shouldSendFeatureFlagEvent) {
-            remoteConfig?.let {
-                val flagDetails = it.getFlagDetails(key)
-                val requestId = it.getRequestId()
-                val evaluatedAt = it.getEvaluatedAt()
-
-                val props = mutableMapOf<String, Any>()
-                props["\$feature_flag"] = key
-                // value should never be nullabe anyway
-                props["\$feature_flag_response"] = value ?: ""
-                requestId?.let { props["\$feature_flag_request_id"] = it }
-                evaluatedAt?.let { props["\$feature_flag_evaluated_at"] = it }
-                flagDetails?.let {
-                    props["\$feature_flag_id"] = it.metadata.id
-                    props["\$feature_flag_version"] = it.metadata.version
-                    props["\$feature_flag_reason"] = it.reason?.description ?: ""
+            if (shouldSendFeatureFlagEvent) {
+                remoteConfig?.let {
+                    val flagDetails = it.getFlagDetails(key)
+                    val requestId = it.getRequestId()
+                    val evaluatedAt = it.getEvaluatedAt()
+
+                    val props = mutableMapOf<String, Any>()
+                    props["\$feature_flag"] = key
+                    // value should never be nullabe anyway
+                    props["\$feature_flag_response"] = value ?: ""
+                    requestId?.let { props["\$feature_flag_request_id"] = it }
+                    evaluatedAt?.let { props["\$feature_flag_evaluated_at"] = it }
+                    flagDetails?.let {
+                        props["\$feature_flag_id"] = it.metadata.id
+                        props["\$feature_flag_version"] = it.metadata.version
+                        props["\$feature_flag_reason"] = it.reason?.description ?: ""
+                    }
+                    capture(PostHogEventName.FEATURE_FLAG_CALLED.event, properties = props)
                 }
-                capture("\$feature_flag_called", properties = props)
             }
         }
     }
 
     public override fun getFeatureFlag(
         key: String,
         defaultValue: Any?,
+        sendFeatureFlagEvent: Boolean?,
     ): Any? {
         if (!isEnabled()) {
             return defaultValue
         }
         val value = remoteConfig?.getFeatureFlag(key, defaultValue) ?: defaultValue
 
-        sendFeatureFlagCalled(key, value)
-
+        sendFeatureFlagCalled(key, value, sendFeatureFlagEvent)
         return value
     }
 
@@ -1261,12 +1300,19 @@ public class PostHog private constructor(
         public override fun isFeatureEnabled(
             key: String,
             defaultValue: Boolean,
-        ): Boolean = shared.isFeatureEnabled(key, defaultValue = defaultValue)
+            sendFeatureFlagEvent: Boolean?,
+        ): Boolean =
+            shared.isFeatureEnabled(
+                key,
+                defaultValue = defaultValue,
+                sendFeatureFlagEvent = sendFeatureFlagEvent,
+            )
 
         public override fun getFeatureFlag(
             key: String,
             defaultValue: Any?,
-        ): Any? = shared.getFeatureFlag(key, defaultValue = defaultValue)
+            sendFeatureFlagEvent: Boolean?,
+        ): Any? = shared.getFeatureFlag(key, defaultValue = defaultValue, sendFeatureFlagEvent)
 
         public override fun getFeatureFlagPayload(
             key: String,

posthog/src/main/java/com/posthog/PostHogInterface.kt

@@ -47,21 +47,25 @@ public interface PostHogInterface : PostHogCoreInterface {
      * Docs https://posthog.com/docs/feature-flags and https://posthog.com/docs/experiments
      * @param key the Key
      * @param defaultValue the default value if not found, false if not given
+     * @param sendFeatureFlagEvent (optional) If false, we won't send an $feature_flag_call event to PostHog.
      */
     public fun isFeatureEnabled(
         key: String,
         defaultValue: Boolean = false,
+        sendFeatureFlagEvent: Boolean? = null,
     ): Boolean
 
     /**
      * Returns the feature flag
      * Docs https://posthog.com/docs/feature-flags and https://posthog.com/docs/experiments
      * @param key the Key
      * @param defaultValue the default value if not found
+     * @param sendFeatureFlagEvent (optional) If false, we won't send an $feature_flag_call event to PostHog.
      */
     public fun getFeatureFlag(
         key: String,
         defaultValue: Any? = null,
+        sendFeatureFlagEvent: Boolean? = null,
     ): Any?
 
     /**

posthog/src/main/java/com/posthog/PostHogStateless.kt

@@ -445,7 +445,7 @@ public open class PostHogStateless protected constructor(
                 requestId?.let { props["\$feature_flag_request_id"] = it }
                 evaluatedAt?.let { props["\$feature_flag_evaluated_at"] = it }
 
-                captureStateless("\$feature_flag_called", distinctId, properties = props)
+                captureStateless(PostHogEventName.FEATURE_FLAG_CALLED.event, distinctId, properties = props)
             }
         }
     }