-
Notifications
You must be signed in to change notification settings - Fork 0
feat: wire LifecycleCoordinator + openURL public API [3/4] #32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
choudlet
wants to merge
3
commits into
chrish/sc-38234/lifecycle-event-tracker
Choose a base branch
from
chrish/sc-38235/lifecycle-wiring-openurl
base: chrish/sc-38234/lifecycle-event-tracker
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,11 +4,14 @@ import android.app.Application | |
| import android.content.ComponentCallbacks2 | ||
| import android.content.Context | ||
| import android.content.res.Configuration | ||
| import android.net.Uri | ||
| import com.metarouter.analytics.context.DeviceContextProvider | ||
| import com.metarouter.analytics.dispatcher.Dispatcher | ||
| import com.metarouter.analytics.dispatcher.DispatcherConfig | ||
| import com.metarouter.analytics.enrichment.EventEnrichmentService | ||
| import com.metarouter.analytics.identity.IdentityManager | ||
| import com.metarouter.analytics.lifecycle.LifecycleCoordinator | ||
| import com.metarouter.analytics.lifecycle.LifecycleEventTracker | ||
| import com.metarouter.analytics.network.AndroidNetworkMonitor | ||
| import com.metarouter.analytics.network.CircuitBreaker | ||
| import com.metarouter.analytics.network.DebouncedNetworkMonitor | ||
|
|
@@ -18,6 +21,8 @@ import com.metarouter.analytics.network.OkHttpNetworkClient | |
| import com.metarouter.analytics.queue.EventQueueInterface | ||
| import com.metarouter.analytics.queue.PersistableEventQueue | ||
| import com.metarouter.analytics.storage.EventDiskStore | ||
| import com.metarouter.analytics.storage.LifecycleStorage | ||
| import com.metarouter.analytics.types.AppContext | ||
| import com.metarouter.analytics.types.BaseEvent | ||
| import com.metarouter.analytics.types.EventType | ||
| import com.metarouter.analytics.types.LifecycleState | ||
|
|
@@ -43,7 +48,10 @@ class MetaRouterAnalyticsClient private constructor( | |
| private val injectedCircuitBreaker: CircuitBreaker? = null, | ||
| private val injectedDispatcher: Dispatcher? = null, | ||
| private val injectedDiskStore: EventDiskStore? = null, | ||
| private val injectedNetworkMonitor: NetworkMonitor? = null | ||
| private val injectedNetworkMonitor: NetworkMonitor? = null, | ||
| private val injectedLifecycleStorage: LifecycleStorage? = null, | ||
| private val injectedLifecycleCoordinator: LifecycleCoordinator? = null, | ||
| private val injectedAppContext: AppContext? = null | ||
| ) : AnalyticsInterface { | ||
|
|
||
| companion object { | ||
|
|
@@ -75,7 +83,10 @@ class MetaRouterAnalyticsClient private constructor( | |
| circuitBreaker: CircuitBreaker? = null, | ||
| dispatcher: Dispatcher? = null, | ||
| diskStore: EventDiskStore? = null, | ||
| networkMonitor: NetworkMonitor? = null | ||
| networkMonitor: NetworkMonitor? = null, | ||
| lifecycleStorage: LifecycleStorage? = null, | ||
| lifecycleCoordinator: LifecycleCoordinator? = null, | ||
| appContext: AppContext? = null | ||
| ): MetaRouterAnalyticsClient { | ||
| val client = MetaRouterAnalyticsClient( | ||
| context.applicationContext, | ||
|
|
@@ -88,7 +99,10 @@ class MetaRouterAnalyticsClient private constructor( | |
| circuitBreaker, | ||
| dispatcher, | ||
| diskStore, | ||
| networkMonitor | ||
| networkMonitor, | ||
| lifecycleStorage, | ||
| lifecycleCoordinator, | ||
| appContext | ||
| ) | ||
| client.initializeInternal() | ||
| return client | ||
|
|
@@ -119,6 +133,9 @@ class MetaRouterAnalyticsClient private constructor( | |
| private var persistableEventQueue: PersistableEventQueue? = null | ||
| private var componentCallbacks: ComponentCallbacks2? = null | ||
|
|
||
| // Lifecycle coordinator (null when InitOptions.trackLifecycleEvents is false) | ||
| private var lifecycleCoordinator: LifecycleCoordinator? = null | ||
|
|
||
| /** | ||
| * Internal initialization. Sets up all components. | ||
| */ | ||
|
|
@@ -138,9 +155,15 @@ class MetaRouterAnalyticsClient private constructor( | |
| val channelCapacity = options.maxQueueEvents | ||
| eventChannel = Channel(capacity = channelCapacity) | ||
|
|
||
| // App metadata: read PackageManager once and share the snapshot across | ||
| // every consumer (DeviceContextProvider for per-event enrichment, the | ||
| // lifecycle tracker for install/update detection). Bundle/PackageInfo is | ||
| // OS-loaded and immutable post-process-start, so caching is safe. | ||
| val appContext = injectedAppContext ?: AppContext.fromContext(context) | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. allows for DI for testing |
||
|
|
||
| // Initialize components (use injected or create new) | ||
| identityManager = injectedIdentityManager ?: IdentityManager(context) | ||
| contextProvider = injectedContextProvider ?: DeviceContextProvider(context) | ||
| contextProvider = injectedContextProvider ?: DeviceContextProvider(context, appContext) | ||
| enrichmentService = injectedEnrichmentService ?: EventEnrichmentService( | ||
| identityManager = identityManager, | ||
| contextProvider = contextProvider, | ||
|
|
@@ -230,9 +253,34 @@ class MetaRouterAnalyticsClient private constructor( | |
| componentCallbacks = callbacks | ||
| } | ||
|
|
||
| // Build the lifecycle coordinator before flipping to READY so onReady() can run | ||
| // immediately after the state transition. The tracker emits via track(), which | ||
| // requires the lifecycle state to be READY. | ||
| // | ||
| // `trackLifecycleEvents` is the sole gate: if disabled, no coordinator is built | ||
| // even when a test seam supplies one. Keeps the off-state structurally enforced. | ||
| lifecycleCoordinator = if (options.trackLifecycleEvents) { | ||
| injectedLifecycleCoordinator ?: run { | ||
| val lifecycleStorage = injectedLifecycleStorage ?: LifecycleStorage(context) | ||
| val tracker = LifecycleEventTracker( | ||
| analytics = this, | ||
| storage = lifecycleStorage, | ||
| appContext = appContext, | ||
| identityManager = identityManager | ||
| ) | ||
| LifecycleCoordinator(tracker) | ||
| } | ||
| } else { | ||
| null | ||
| } | ||
|
|
||
| lifecycleState.set(LifecycleState.READY) | ||
| Logger.log("MetaRouter SDK initialized") | ||
|
|
||
| // Run cold-launch detection + emission. Must happen after READY so enqueueEvent | ||
| // accepts the events. | ||
| lifecycleCoordinator?.onReady() | ||
|
|
||
| } catch (e: Exception) { | ||
| Logger.error("Failed to initialize SDK: ${e.message}") | ||
| lifecycleState.set(LifecycleState.IDLE) | ||
|
|
@@ -426,31 +474,56 @@ class MetaRouterAnalyticsClient private constructor( | |
|
|
||
| /** | ||
| * Called when app goes to background. | ||
| * Flushes pending events and pauses the dispatcher. | ||
| * Emits `Application Backgrounded` (when enabled), flushes pending events, | ||
| * and pauses the dispatcher. The lifecycle event must be emitted before flush | ||
| * so it lands in the same drain. | ||
| */ | ||
| internal suspend fun onBackground() { | ||
| if (lifecycleState.get() != LifecycleState.READY) { | ||
| Logger.log("onBackground ignored - SDK not ready (state: ${lifecycleState.get()})") | ||
| return | ||
| } | ||
| lifecycleCoordinator?.onBackground() | ||
| flush() | ||
| persistableEventQueue?.flushToDisk() | ||
| dispatcher.pause() | ||
| } | ||
|
|
||
| /** | ||
| * Called when app comes to foreground. | ||
| * Flushes pending events and resumes the dispatcher. | ||
| * Emits `Application Opened` (when enabled), flushes pending events, and | ||
| * resumes the dispatcher. | ||
| */ | ||
| internal fun onForeground() { | ||
| if (lifecycleState.get() != LifecycleState.READY) { | ||
| Logger.log("onForeground ignored - SDK not ready (state: ${lifecycleState.get()})") | ||
| return | ||
| } | ||
| // Resume dispatcher first, then emit. Mirrors iOS so the resumed dispatcher | ||
| // picks up the just-emitted Opened in its next tick rather than waiting for the | ||
| // following flush cycle. | ||
| dispatcher.resume() | ||
| lifecycleCoordinator?.onForeground() | ||
| scope.launch { | ||
| flush() | ||
| } | ||
| dispatcher.resume() | ||
| } | ||
|
|
||
| override fun openURL(uri: Uri, sourceApplication: String?) { | ||
| if (lifecycleState.get() != LifecycleState.READY) { | ||
| Logger.log("openURL ignored - SDK not ready (state: ${lifecycleState.get()})") | ||
| return | ||
| } | ||
| val coordinator = lifecycleCoordinator | ||
| if (coordinator == null) { | ||
| Logger.warn( | ||
| "openURL called but trackLifecycleEvents is disabled — no-op. " + | ||
| "Set InitOptions.trackLifecycleEvents=true to buffer deep links " + | ||
| "for the next Application Opened event." | ||
| ) | ||
| return | ||
| } | ||
| coordinator.openURL(uri, sourceApplication) | ||
| } | ||
|
|
||
| override suspend fun reset() { | ||
|
|
||
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 |
|---|---|---|
| @@ -1,7 +1,6 @@ | ||
| package com.metarouter.analytics.context | ||
|
|
||
| import android.content.Context | ||
| import android.content.pm.PackageManager | ||
| import android.net.ConnectivityManager | ||
| import android.net.NetworkCapabilities | ||
| import android.os.Build | ||
|
|
@@ -29,7 +28,13 @@ import kotlin.math.roundToInt | |
| * - Cache generation is synchronized to prevent duplicate work | ||
| * - Safe for concurrent access from multiple threads | ||
| */ | ||
| class DeviceContextProvider(private val context: Context) { | ||
| class DeviceContextProvider( | ||
| private val context: Context, | ||
| // The `appContext` default is for test ergonomics only. Production code must pass | ||
| // the cached snapshot read once at SDK init in `MetaRouterAnalyticsClient` so the | ||
| // per-event enrichment path never re-reads `PackageManager`. | ||
| private val appContext: AppContext = AppContext.fromContext(context) | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. now reads the shared AppContext |
||
| ) { | ||
|
|
||
| companion object { | ||
| private const val SDK_NAME = "metarouter-android-sdk" | ||
|
|
@@ -49,6 +54,8 @@ class DeviceContextProvider(private val context: Context) { | |
|
|
||
| /** | ||
| * Generate fresh context information by collecting all metadata. | ||
| * `appContext` is the cached snapshot read at SDK init — `PackageManager` | ||
| * is not consulted on the per-event enrichment path. | ||
| */ | ||
| private fun generateContext(): EventContext { | ||
| return EventContext( | ||
|
|
@@ -57,7 +64,7 @@ class DeviceContextProvider(private val context: Context) { | |
| timezone = getTimezone(), | ||
| device = getDeviceContext(), | ||
| os = getOSContext(), | ||
| app = getAppContext(), | ||
| app = appContext, | ||
| screen = getScreenContext(), | ||
| network = getNetworkContext() | ||
| ) | ||
|
|
@@ -127,54 +134,6 @@ class DeviceContextProvider(private val context: Context) { | |
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Get app information from PackageManager. | ||
| * Collects app name, version, build number, and namespace (package name). | ||
| */ | ||
| private fun getAppContext(): AppContext { | ||
| return try { | ||
| val packageManager = context.packageManager | ||
| val packageName = context.packageName | ||
| val packageInfo = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) { | ||
| packageManager.getPackageInfo(packageName, PackageManager.PackageInfoFlags.of(0)) | ||
| } else { | ||
| @Suppress("DEPRECATION") | ||
| packageManager.getPackageInfo(packageName, 0) | ||
| } | ||
|
|
||
| val appName = try { | ||
| packageInfo.applicationInfo?.let { | ||
| packageManager.getApplicationLabel(it).toString() | ||
| } ?: UNKNOWN | ||
| } catch (e: Exception) { | ||
| UNKNOWN | ||
| } | ||
|
|
||
| val versionName = packageInfo.versionName ?: UNKNOWN | ||
| val versionCode = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) { | ||
| packageInfo.longVersionCode.toString() | ||
| } else { | ||
| @Suppress("DEPRECATION") | ||
| packageInfo.versionCode.toString() | ||
| } | ||
|
|
||
| AppContext( | ||
| name = appName, | ||
| version = versionName, | ||
| build = versionCode, | ||
| namespace = packageName | ||
| ) | ||
| } catch (e: Exception) { | ||
| Logger.warn("Failed to get app context: ${e.message}") | ||
| AppContext( | ||
| name = UNKNOWN, | ||
| version = UNKNOWN, | ||
| build = UNKNOWN, | ||
| namespace = context.packageName | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get screen dimensions and pixel density from WindowManager. | ||
| * Width/height are in points (dp), density is pixel ratio rounded to 2 decimal places. | ||
|
|
||
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.
nit/readme: Deep-link vs. cold-launch timing: if the host calls
openURLfromMainActivity.onCreatewhile the SDK is still initializing, the call is queued in the proxy and replays after bind by which time the cold-launchOpenedhas already fired. The deep link then attaches to the nextOpened(or never, if the app is killed first). Small real-world nuance the README can call out.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.
Confirmed —
onReady()(which emits the cold-launch Opened) runs inside client init, beforeproxy.bindreplays queued calls, so anopenURLissued mid-init attaches to the next Opened at best. Added a "Cold-launch timing" paragraph to theopenURLKDoc in 8e3a3cd; the README slice (sc-38236) will carry the integrator-facing version.