feat(odin): Allow collecting FCM device token in SDK & demonstrate it in sample app #376
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,11 +3,14 @@ package com.posthog | |
| import com.posthog.errortracking.PostHogErrorTrackingAutoCaptureIntegration | ||
| import com.posthog.internal.PostHogApi | ||
| import com.posthog.internal.PostHogApiEndpoint | ||
| import com.posthog.internal.PostHogApiError | ||
| import com.posthog.internal.PostHogNoOpLogger | ||
| import com.posthog.internal.PostHogPreferences.Companion.ALL_INTERNAL_KEYS | ||
| import com.posthog.internal.PostHogPreferences.Companion.ANONYMOUS_ID | ||
| import com.posthog.internal.PostHogPreferences.Companion.BUILD | ||
| import com.posthog.internal.PostHogPreferences.Companion.DISTINCT_ID | ||
| import com.posthog.internal.PostHogPreferences.Companion.FCM_TOKEN | ||
| import com.posthog.internal.PostHogPreferences.Companion.FCM_TOKEN_LAST_UPDATED | ||
| import com.posthog.internal.PostHogPreferences.Companion.GROUPS | ||
| import com.posthog.internal.PostHogPreferences.Companion.IS_IDENTIFIED | ||
| import com.posthog.internal.PostHogPreferences.Companion.OPT_OUT | ||
|
|
@@ -20,6 +23,7 @@ import com.posthog.internal.PostHogSendCachedEventsIntegration | |
| import com.posthog.internal.PostHogSerializer | ||
| import com.posthog.internal.PostHogSessionManager | ||
| import com.posthog.internal.PostHogThreadFactory | ||
| import com.posthog.internal.executeSafely | ||
| import com.posthog.internal.personPropertiesContext | ||
| import com.posthog.internal.replay.PostHogSessionReplayHandler | ||
| import com.posthog.internal.sortMapRecursively | ||
|
|
@@ -47,6 +51,10 @@ public class PostHog private constructor( | |
| Executors.newSingleThreadScheduledExecutor( | ||
| PostHogThreadFactory("PostHogSendCachedEventsThread"), | ||
| ), | ||
| private val pushTokenExecutor: ExecutorService = | ||
| Executors.newSingleThreadExecutor( | ||
| PostHogThreadFactory("PostHogFCMTokenRegistration"), | ||
| ), | ||
| private val reloadFeatureFlags: Boolean = true, | ||
| ) : PostHogInterface, PostHogStateless() { | ||
| private val anonymousLock = Any() | ||
|
|
@@ -56,9 +64,11 @@ public class PostHog private constructor( | |
|
|
||
| private val featureFlagsCalledLock = Any() | ||
| private val cachedPersonPropertiesLock = Any() | ||
| private val pushTokenLock = Any() | ||
|
|
||
| private var remoteConfig: PostHogRemoteConfig? = null | ||
| private var replayQueue: PostHogQueueInterface? = null | ||
| private lateinit var api: PostHogApi | ||
| private val featureFlagsCalled = mutableMapOf<String, MutableList<Any?>>() | ||
|
|
||
| // Used to deduplicate setPersonProperties calls | ||
|
|
@@ -97,25 +107,25 @@ public class PostHog private constructor( | |
|
|
||
| val cachePreferences = config.cachePreferences ?: memoryPreferences | ||
| config.cachePreferences = cachePreferences | ||
| this.api = PostHogApi(config) | ||
| val queue = | ||
| config.queueProvider( | ||
| config, | ||
| this.api, | ||
| PostHogApiEndpoint.BATCH, | ||
| config.storagePrefix, | ||
| queueExecutor, | ||
| ) | ||
| val replayQueue = | ||
| config.queueProvider( | ||
| config, | ||
| this.api, | ||
| PostHogApiEndpoint.SNAPSHOT, | ||
| config.replayStoragePrefix, | ||
| replayExecutor, | ||
| ) | ||
| val featureFlags = | ||
| config.remoteConfigProvider(config, this.api, remoteConfigExecutor) { | ||
| getDefaultPersonProperties() | ||
| } | ||
|
|
||
|
|
@@ -133,7 +143,7 @@ public class PostHog private constructor( | |
| val sendCachedEventsIntegration = | ||
| PostHogSendCachedEventsIntegration( | ||
| config, | ||
| this.api, | ||
| startDate, | ||
| cachedEventsExecutor, | ||
| ) | ||
|
|
@@ -1222,6 +1232,82 @@ public class PostHog private constructor( | |
| return PostHogSessionManager.isSessionActive() | ||
| } | ||
|
|
||
| override fun registerPushToken( | ||
|
Member
There was a problem hiding this comment. i still think that this method code impl should live within another class, and this method just forwards to that class eg remoteConfig/replayQueue etc |
||
| token: String, | ||
| firebaseAppId: String, | ||
| callback: PostHogPushTokenCallback?, | ||
|
Collaborator
There was a problem hiding this comment. Will BE allow integrating only with a single Firebase project? If we support multiple firebase projects, I would expect to register a firebase config identifier along with this token (So that BE would know which Firebase project to use)? Correct me if my rationale is wrong here, but for people using multiple apps within a specific PostHog project, this could be problematic?
Author
There was a problem hiding this comment. That's a good point! Until now I had assumed that users would have one firebase project per posthog project, and that's probably true for most users, but it would be much better to support multiple. I added the firebase app id |
||
| ) { | ||
| if (!isEnabled()) { | ||
| callback?.invoke(false) | ||
| return | ||
| } | ||
|
|
||
| if (token.isBlank()) { | ||
| config?.logger?.log("registerPushToken called with blank token") | ||
| callback?.invoke(false) | ||
| return | ||
| } | ||
|
|
||
| if (firebaseAppId.isBlank()) { | ||
| config?.logger?.log("registerPushToken called with blank firebaseAppId") | ||
| callback?.invoke(false) | ||
| return | ||
| } | ||
|
|
||
| val config = | ||
| this.config ?: run { | ||
| callback?.invoke(false) | ||
| return | ||
| } | ||
| val preferences = getPreferences() | ||
|
|
||
| synchronized(pushTokenLock) { | ||
| val storedToken = preferences.getValue(FCM_TOKEN) as? String | ||
| val lastUpdated = preferences.getValue(FCM_TOKEN_LAST_UPDATED) as? Long ?: 0L | ||
| val currentTime = config.dateProvider.currentDate().time | ||
|
|
||
| val tokenChanged = storedToken != token | ||
| val shouldUpdate = tokenChanged || (currentTime - lastUpdated >= ONE_HOUR_IN_MILLIS) | ||
|
|
||
| if (!shouldUpdate) { | ||
| config.logger.log("FCM token registration skipped: token unchanged and less than hour since last update") | ||
| callback?.invoke(null) | ||
| return | ||
| } | ||
|
|
||
| preferences.setValue(FCM_TOKEN, token) | ||
| preferences.setValue(FCM_TOKEN_LAST_UPDATED, currentTime) | ||
|
Comment on lines
+1278
to
+1279
Collaborator
There was a problem hiding this comment. What happens when the API call fails right below here (L1283)?
Author
There was a problem hiding this comment. Yeah, that's a good idea. Updated to clear preferences on error |
||
| } | ||
|
|
||
| val distinctId = distinctId() | ||
|
Collaborator
There was a problem hiding this comment. I feel there may be a race condition here where distinctId() may change between the synchronization block above and the api call below? This would mean we may send the token with the wrong distinctId. @marandaneto wdyt?
Author
There was a problem hiding this comment. For our backend, we're okay with a "best effort to send correct distinctId", if we get a token for an outdated one and trigger a push notification of a more recent/correct distinctId, we query the persons db for past distinctIds associated with the user and find the token with the outdated distinctId |
||
| pushTokenExecutor.executeSafely { | ||
|
Member
There was a problem hiding this comment. this assumes connectivity, what if the device is offline or if something fails? how would the user know that they should call this again at some point? should we document this behaviour? |
||
| if (!isEnabled()) { | ||
| config.logger.log("FCM token registration skipped: SDK is disabled") | ||
| callback?.invoke(false) | ||
| return@executeSafely | ||
| } | ||
| try { | ||
| this.api.registerPushSubscription(distinctId, token, firebaseAppId) | ||
| config.logger.log("FCM token registered successfully") | ||
| callback?.invoke(true) | ||
| } catch (e: PostHogApiError) { | ||
| config.logger.log("Failed to register FCM token: ${e.message} (code: ${e.statusCode})") | ||
| synchronized(pushTokenLock) { | ||
| preferences.remove(FCM_TOKEN) | ||
| preferences.remove(FCM_TOKEN_LAST_UPDATED) | ||
| } | ||
| callback?.invoke(false) | ||
| } catch (e: Throwable) { | ||
| config.logger.log("Failed to register FCM token: ${e.message ?: "Unknown error"}") | ||
| synchronized(pushTokenLock) { | ||
| preferences.remove(FCM_TOKEN) | ||
| preferences.remove(FCM_TOKEN_LAST_UPDATED) | ||
| } | ||
| callback?.invoke(false) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override fun <T : PostHogConfig> getConfig(): T? { | ||
| @Suppress("UNCHECKED_CAST") | ||
| return super<PostHogStateless>.config as? T | ||
|
|
@@ -1306,6 +1392,8 @@ public class PostHog private constructor( | |
|
|
||
| private val apiKeys = mutableSetOf<String>() | ||
|
|
||
| private const val ONE_HOUR_IN_MILLIS = 60 * 60 * 1000L | ||
|
|
||
| @PostHogVisibleForTesting | ||
| public fun overrideSharedInstance(postHog: PostHogInterface) { | ||
| shared = postHog | ||
|
|
@@ -1335,13 +1423,18 @@ public class PostHog private constructor( | |
| featureFlagsExecutor: ExecutorService, | ||
| cachedEventsExecutor: ExecutorService, | ||
| reloadFeatureFlags: Boolean, | ||
| pushTokenExecutor: ExecutorService = | ||
| Executors.newSingleThreadExecutor( | ||
| PostHogThreadFactory("PostHogFCMTokenRegistration"), | ||
| ), | ||
| ): PostHogInterface { | ||
| val instance = | ||
| PostHog( | ||
| queueExecutor, | ||
| replayExecutor, | ||
| featureFlagsExecutor, | ||
| cachedEventsExecutor, | ||
| pushTokenExecutor, | ||
| reloadFeatureFlags = reloadFeatureFlags, | ||
| ) | ||
| instance.setup(config) | ||
|
|
@@ -1539,5 +1632,13 @@ public class PostHog private constructor( | |
| override fun getSessionId(): UUID? { | ||
| return shared.getSessionId() | ||
| } | ||
|
|
||
| override fun registerPushToken( | ||
| token: String, | ||
| firebaseAppId: String, | ||
| callback: PostHogPushTokenCallback?, | ||
| ) { | ||
| shared.registerPushToken(token, firebaseAppId, callback) | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it correct to have the changelog in this PR already or should it be in the version bump PR? (or does it not matter?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
under next is correct, just do not add a version yet