-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: add deep link opened default event * feat: add screen viewed event * feat: update the sample app to test the screen navigation * feat: add app lifecycle default events * test: add tests for lifecycle plugin * refactor: add empty last lines * refactor: fix lint issues * build: fix ci test failure * refactor: fix lint * refactor: use const for default event properties * refactor: use shared casted amplitude and configuration vars * feat: use defaultTracking in the options * refactor: rename default tracking options * refactor: update comment
- Loading branch information
1 parent
6abcee6
commit 12a743b
Showing
15 changed files
with
947 additions
and
41 deletions.
There are no files selected for viewing
This file contains 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
24 changes: 24 additions & 0 deletions
24
android/src/main/java/com/amplitude/android/DefaultTrackingOptions.kt
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| package com.amplitude.android | ||
|
|
||
| class DefaultTrackingOptions( | ||
| var sessions: Boolean = true, | ||
| var appLifecycles: Boolean = false, | ||
| var deepLinks: Boolean = false, | ||
| var screenViews: Boolean = false | ||
| ) { | ||
| // Prebuilt options for easier usage | ||
| companion object { | ||
| val ALL = DefaultTrackingOptions( | ||
| sessions = true, | ||
| appLifecycles = true, | ||
| deepLinks = true, | ||
| screenViews = true | ||
| ) | ||
| val NONE = DefaultTrackingOptions( | ||
| sessions = false, | ||
| appLifecycles = false, | ||
| deepLinks = false, | ||
| screenViews = false | ||
| ) | ||
| } | ||
| } |
This file contains 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 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
157 changes: 157 additions & 0 deletions
157
android/src/main/java/com/amplitude/android/utilities/DefaultEventUtils.kt
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| package com.amplitude.android.utilities | ||
|
|
||
| import android.app.Activity | ||
| import android.content.Intent | ||
| import android.content.pm.PackageInfo | ||
| import android.content.pm.PackageManager | ||
| import android.net.ParseException | ||
| import android.net.Uri | ||
| import android.os.Build | ||
| import com.amplitude.android.Amplitude | ||
| import com.amplitude.core.Storage | ||
| import kotlinx.coroutines.launch | ||
|
|
||
| class DefaultEventUtils(private val amplitude: Amplitude) { | ||
| object EventTypes { | ||
| const val APPLICATION_INSTALLED = "[Amplitude] Application Installed" | ||
| const val APPLICATION_UPDATED = "[Amplitude] Application Updated" | ||
| const val APPLICATION_OPENED = "[Amplitude] Application Opened" | ||
| const val APPLICATION_BACKGROUNDED = "[Amplitude] Application Backgrounded" | ||
| const val DEEP_LINK_OPENED = "[Amplitude] Deep Link Opened" | ||
| const val SCREEN_VIEWED = "[Amplitude] Screen Viewed" | ||
| } | ||
|
|
||
| object EventProperties { | ||
| const val VERSION = "[Amplitude] Version" | ||
| const val BUILD = "[Amplitude] Build" | ||
| const val PREVIOUS_VERSION = "[Amplitude] Previous Version" | ||
| const val PREVIOUS_BUILD = "[Amplitude] Previous Build" | ||
| const val FROM_BACKGROUND = "[Amplitude] From Background" | ||
| const val LINK_URL = "[Amplitude] Link URL" | ||
| const val LINK_REFERRER = "[Amplitude] Link Referrer" | ||
| const val SCREEN_NAME = "[Amplitude] Screen Name" | ||
| } | ||
|
|
||
| fun trackAppUpdatedInstalledEvent(packageInfo: PackageInfo) { | ||
| // Get current version/build and previously stored version/build information | ||
| val currentVersion = packageInfo.versionName | ||
| val currentBuild = packageInfo.getVersionCode().toString() | ||
| val storage = amplitude.storage | ||
| val previousVersion = storage.read(Storage.Constants.APP_VERSION) | ||
| val previousBuild = storage.read(Storage.Constants.APP_BUILD) | ||
|
|
||
| if (previousBuild == null) { | ||
| // No stored build, treat it as fresh installed | ||
| amplitude.track( | ||
| EventTypes.APPLICATION_INSTALLED, | ||
| mapOf( | ||
| EventProperties.VERSION to currentVersion, | ||
| EventProperties.BUILD to currentBuild, | ||
| ), | ||
| ) | ||
| } else if (currentBuild != previousBuild) { | ||
| // Has stored build, but different from current build | ||
| amplitude.track( | ||
| EventTypes.APPLICATION_UPDATED, | ||
| mapOf( | ||
| EventProperties.PREVIOUS_VERSION to previousVersion, | ||
| EventProperties.PREVIOUS_BUILD to previousBuild, | ||
| EventProperties.VERSION to currentVersion, | ||
| EventProperties.BUILD to currentBuild, | ||
| ), | ||
| ) | ||
| } | ||
|
|
||
| // Write the current version/build into persistent storage | ||
| amplitude.amplitudeScope.launch(amplitude.storageIODispatcher) { | ||
| storage.write(Storage.Constants.APP_VERSION, currentVersion) | ||
| storage.write(Storage.Constants.APP_BUILD, currentBuild) | ||
| } | ||
| } | ||
|
|
||
| fun trackAppOpenedEvent(packageInfo: PackageInfo, isFromBackground: Boolean) { | ||
| val currentVersion = packageInfo.versionName | ||
| val currentBuild = packageInfo.getVersionCode().toString() | ||
|
|
||
| amplitude.track( | ||
| EventTypes.APPLICATION_OPENED, | ||
| mapOf( | ||
| EventProperties.FROM_BACKGROUND to isFromBackground, | ||
| EventProperties.VERSION to currentVersion, | ||
| EventProperties.BUILD to currentBuild, | ||
| ), | ||
| ) | ||
| } | ||
|
|
||
| fun trackAppBackgroundedEvent() { | ||
| amplitude.track(EventTypes.APPLICATION_BACKGROUNDED) | ||
| } | ||
|
|
||
| fun trackDeepLinkOpenedEvent(activity: Activity) { | ||
| val intent = activity.intent | ||
| intent?.let { | ||
| val referrer = getReferrer(activity)?.toString() | ||
| val url = it.data?.toString() | ||
| amplitude.track( | ||
| EventTypes.DEEP_LINK_OPENED, | ||
| mapOf( | ||
| EventProperties.LINK_URL to url, | ||
| EventProperties.LINK_REFERRER to referrer, | ||
| ), | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| fun trackScreenViewedEvent(activity: Activity) { | ||
| try { | ||
| val packageManager = activity.packageManager | ||
| val info = packageManager?.getActivityInfo( | ||
| activity.componentName, | ||
| PackageManager.GET_META_DATA, | ||
| ) | ||
| /* Get the label metadata in following order | ||
| 1. activity label | ||
| 2. if 1 is missing, fallback to parent application label | ||
| 3. if 2 is missing, use the activity name | ||
| */ | ||
| val activityLabel = info?.loadLabel(packageManager)?.toString() ?: info?.name | ||
| amplitude.track(EventTypes.SCREEN_VIEWED, mapOf(EventProperties.SCREEN_NAME to activityLabel)) | ||
| } catch (e: PackageManager.NameNotFoundException) { | ||
| amplitude.logger.error("Failed to get activity info: $e") | ||
| } catch (e: Exception) { | ||
| amplitude.logger.error("Failed to track screen viewed event: $e") | ||
| } | ||
| } | ||
|
|
||
| private fun getReferrer(activity: Activity): Uri? { | ||
| if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP_MR1) { | ||
| return activity.referrer | ||
| } else { | ||
| var referrerUri: Uri? = null | ||
| if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN_MR1) { | ||
| val intent = activity.intent | ||
| referrerUri = intent.getParcelableExtra(Intent.EXTRA_REFERRER) | ||
|
|
||
| if (referrerUri == null) { | ||
| referrerUri = intent.getStringExtra("android.intent.extra.REFERRER_NAME")?.let { | ||
| try { | ||
| Uri.parse(it) | ||
| } catch (e: ParseException) { | ||
| amplitude.logger.error("Failed to parse the referrer uri: $it") | ||
| null | ||
| } | ||
| } | ||
| } | ||
| } | ||
| return referrerUri | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun PackageInfo.getVersionCode(): Number = | ||
| if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) { | ||
| this.longVersionCode | ||
| } else { | ||
| @Suppress("DEPRECATION") | ||
| this.versionCode | ||
| } |
This file contains 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.