-
Notifications
You must be signed in to change notification settings - Fork 213
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Application Open and Application Backgrounded Events (#620)
* LIB-1156: Added support for tracking event when app opened from background * Ran formatter. * Added Backgrounded events * Run formatter. * Updated lifecycle methods and added integration tests. * Separate out Lifecycle Callbacks into separate class * Run formatter. * Made analytics lifecycle class package protected.
- Loading branch information
1 parent
93c7d5b
commit 1cfb025
Showing
3 changed files
with
411 additions
and
102 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
192 changes: 192 additions & 0 deletions
192
analytics/src/main/java/com/segment/analytics/AnalyticsActivityLifecycleCallbacks.java
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,192 @@ | ||
| /** | ||
| * The MIT License (MIT) | ||
| * | ||
| * Copyright (c) 2014 Segment.io, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
| package com.segment.analytics; | ||
|
|
||
| import android.app.Activity; | ||
| import android.app.Application; | ||
| import android.content.pm.PackageInfo; | ||
| import android.os.Bundle; | ||
| import java.util.concurrent.ExecutorService; | ||
| import java.util.concurrent.atomic.AtomicBoolean; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
|
|
||
| class AnalyticsActivityLifecycleCallbacks implements Application.ActivityLifecycleCallbacks { | ||
| private Analytics analytics; | ||
| private ExecutorService analyticsExecutor; | ||
| private Boolean shouldTrackApplicationLifecycleEvents; | ||
| private Boolean trackAttributionInformation; | ||
| private Boolean shouldRecordScreenViews; | ||
| private PackageInfo packageInfo; | ||
|
|
||
| private AtomicBoolean trackedApplicationLifecycleEvents; | ||
| private AtomicInteger numberOfActivities; | ||
| private AtomicBoolean isChangingActivityConfigurations; | ||
| private AtomicBoolean firstLaunch; | ||
|
|
||
| private AnalyticsActivityLifecycleCallbacks( | ||
| Analytics analytics, | ||
| ExecutorService analyticsExecutor, | ||
| Boolean shouldTrackApplicationLifecycleEvents, | ||
| Boolean trackAttributionInformation, | ||
| Boolean shouldRecordScreenViews, | ||
| PackageInfo packageInfo) { | ||
| this.trackedApplicationLifecycleEvents = new AtomicBoolean(false); | ||
| this.numberOfActivities = new AtomicInteger(1); | ||
| this.isChangingActivityConfigurations = new AtomicBoolean(false); | ||
| this.firstLaunch = new AtomicBoolean(false); | ||
| this.analytics = analytics; | ||
| this.analyticsExecutor = analyticsExecutor; | ||
| this.shouldTrackApplicationLifecycleEvents = shouldTrackApplicationLifecycleEvents; | ||
| this.trackAttributionInformation = trackAttributionInformation; | ||
| this.shouldRecordScreenViews = shouldRecordScreenViews; | ||
| this.packageInfo = packageInfo; | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivityCreated(Activity activity, Bundle bundle) { | ||
| analytics.runOnMainThread(IntegrationOperation.onActivityCreated(activity, bundle)); | ||
|
|
||
| if (!trackedApplicationLifecycleEvents.getAndSet(true) | ||
| && shouldTrackApplicationLifecycleEvents) { | ||
| numberOfActivities.set(0); | ||
| firstLaunch.set(true); | ||
| analytics.trackApplicationLifecycleEvents(); | ||
|
|
||
| if (trackAttributionInformation) { | ||
| analyticsExecutor.submit( | ||
| new Runnable() { | ||
| @Override | ||
| public void run() { | ||
| analytics.trackAttributionInformation(); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivityStarted(Activity activity) { | ||
| if (shouldRecordScreenViews) { | ||
| analytics.recordScreenViews(activity); | ||
| } | ||
| analytics.runOnMainThread(IntegrationOperation.onActivityStarted(activity)); | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivityResumed(Activity activity) { | ||
| analytics.runOnMainThread(IntegrationOperation.onActivityResumed(activity)); | ||
|
|
||
| if (shouldTrackApplicationLifecycleEvents | ||
| && numberOfActivities.incrementAndGet() == 1 | ||
| && !isChangingActivityConfigurations.get()) { | ||
|
|
||
| Properties properties = new Properties(); | ||
| if (firstLaunch.get()) { | ||
| properties | ||
| .putValue("version", packageInfo.versionName) | ||
| .putValue("build", packageInfo.versionCode); | ||
| } | ||
| properties.putValue("from_background", !firstLaunch.getAndSet(false)); | ||
| analytics.track("Application Opened", properties); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivityPaused(Activity activity) { | ||
| analytics.runOnMainThread(IntegrationOperation.onActivityPaused(activity)); | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivityStopped(Activity activity) { | ||
| analytics.runOnMainThread(IntegrationOperation.onActivityStopped(activity)); | ||
|
|
||
| isChangingActivityConfigurations.set(activity.isChangingConfigurations()); | ||
| if (shouldTrackApplicationLifecycleEvents | ||
| && numberOfActivities.decrementAndGet() == 0 | ||
| && !isChangingActivityConfigurations.get()) { | ||
| analytics.track("Application Backgrounded"); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivitySaveInstanceState(Activity activity, Bundle bundle) { | ||
| analytics.runOnMainThread(IntegrationOperation.onActivitySaveInstanceState(activity, bundle)); | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivityDestroyed(Activity activity) { | ||
| analytics.runOnMainThread(IntegrationOperation.onActivityDestroyed(activity)); | ||
| } | ||
|
|
||
| public static class Builder { | ||
| private Analytics analytics; | ||
| private ExecutorService analyticsExecutor; | ||
| private Boolean shouldTrackApplicationLifecycleEvents; | ||
| private Boolean trackAttributionInformation; | ||
| private Boolean shouldRecordScreenViews; | ||
| private PackageInfo packageInfo; | ||
|
|
||
| public Builder() {} | ||
|
|
||
| public Builder analytics(Analytics analytics) { | ||
| this.analytics = analytics; | ||
| return this; | ||
| } | ||
|
|
||
| Builder analyticsExecutor(ExecutorService analyticsExecutor) { | ||
| this.analyticsExecutor = analyticsExecutor; | ||
| return this; | ||
| } | ||
|
|
||
| Builder shouldTrackApplicationLifecycleEvents(Boolean shouldTrackApplicationLifecycleEvents) { | ||
| this.shouldTrackApplicationLifecycleEvents = shouldTrackApplicationLifecycleEvents; | ||
| return this; | ||
| } | ||
|
|
||
| Builder trackAttributionInformation(Boolean trackAttributionInformation) { | ||
| this.trackAttributionInformation = trackAttributionInformation; | ||
| return this; | ||
| } | ||
|
|
||
| Builder shouldRecordScreenViews(Boolean shouldRecordScreenViews) { | ||
| this.shouldRecordScreenViews = shouldRecordScreenViews; | ||
| return this; | ||
| } | ||
|
|
||
| Builder packageInfo(PackageInfo packageInfo) { | ||
| this.packageInfo = packageInfo; | ||
| return this; | ||
| } | ||
|
|
||
| public AnalyticsActivityLifecycleCallbacks build() { | ||
| return new AnalyticsActivityLifecycleCallbacks( | ||
| analytics, | ||
| analyticsExecutor, | ||
| shouldTrackApplicationLifecycleEvents, | ||
| trackAttributionInformation, | ||
| shouldRecordScreenViews, | ||
| packageInfo); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.