Added manual foreground/background triggers for APM

Countly · Nov 26, 2020 · 8f4c828 · 8f4c828
1 parent 5eebe25
commit 8f4c828
Show file tree

Hide file tree

Showing 3 changed files with 83 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
   * Added a default way to acquire app start timestamp for APM
   * Added a way to override the current app start timestamp for APM
   * Added manual trigger for when app has finished loading for APM
+  * Added manual foreground/background triggers for APM
 
 ## 20.11.0
   * !! Consent change !! To record orientation you now need to give "user" consent

diff --git a/sdk/src/main/java/ly/count/android/sdk/CountlyConfig.java b/sdk/src/main/java/ly/count/android/sdk/CountlyConfig.java
@@ -150,6 +150,8 @@ public class CountlyConfig {
 
     boolean appLoadedManualTrigger = false;
 
+    boolean manualForegroundBackgroundTrigger = false;
+
     public CountlyConfig() {
     }
 
@@ -552,4 +554,13 @@ public synchronized CountlyConfig enableManualAppLoadedTrigger() {
         appLoadedManualTrigger = true;
         return this;
     }
+
+    /**
+     * Set this in case you want to control these triggers manually
+     * @return
+     */
+    public synchronized CountlyConfig enableManualForegroundBackgroundTriggerAPM() {
+        manualForegroundBackgroundTrigger = true;
+        return this;
+    }
 }
diff --git a/sdk/src/main/java/ly/count/android/sdk/ModuleAPM.java b/sdk/src/main/java/ly/count/android/sdk/ModuleAPM.java
@@ -1,7 +1,6 @@
 package ly.count.android.sdk;
 
 import android.app.Activity;
-import android.os.SystemClock;
 import android.util.Log;
 import java.util.HashMap;
 import java.util.Iterator;
@@ -27,6 +26,9 @@ public class ModuleAPM extends ModuleBase {
     boolean useManualAppLoadedTrigger = false;
     long appStartTimestamp;
 
+    boolean manualForegroundBackgroundTriggers = false;
+    boolean manualOverrideInForeground = false;//app starts in background
+
     ModuleAPM(Countly cly, CountlyConfig config) {
         super(cly);
 
@@ -56,6 +58,11 @@ public class ModuleAPM extends ModuleBase {
             Log.d(Countly.TAG, "[ModuleAPM] Using manual app finished loading trigger for app start");
         }
 
+        manualForegroundBackgroundTriggers = config.manualForegroundBackgroundTrigger;
+        if (_cly.isLoggingEnabled() && manualForegroundBackgroundTriggers) {
+            Log.d(Countly.TAG, "[ModuleAPM] Using manual foreground/background triggers");
+        }
+
         apmInterface = new Apm();
     }
 
@@ -411,7 +418,12 @@ void calculateAppRunningTimes(int previousCount, int newCount) {
             Log.v(Countly.TAG, "[ModuleAPM] calculateAppRunningTimes, toBG[" + goingToBackground + "] toFG[" + goingToForeground + "]");
         }
 
+        doForegroundBackgroundCalculations(goingToBackground, goingToForeground);
+    }
+
+    void doForegroundBackgroundCalculations(boolean goingToBackground, boolean goingToForeground) {
         if (goingToBackground || goingToForeground) {
+
             long currentTimeMs = UtilsTime.currentTimestampMs();
 
             if (lastScreenSwitchTime != -1) {
@@ -433,6 +445,24 @@ void calculateAppRunningTimes(int previousCount, int newCount) {
         }
     }
 
+    void goToForeground() {
+        if(manualOverrideInForeground) {
+            //if we already are in foreground, do nothing
+            return;
+        }
+        manualOverrideInForeground = true;
+        doForegroundBackgroundCalculations(false, true);
+    }
+
+    void goToBackground() {
+        if(!manualOverrideInForeground) {
+            //if we already are in background, do nothing
+            return;
+        }
+        manualOverrideInForeground = false;
+        doForegroundBackgroundCalculations(true, false);
+    }
+
     @Override
     void halt() {
         codeTraces = null;
@@ -452,7 +482,9 @@ void callbackOnActivityResumed(Activity activity) {
 
         Long currentTimestamp = System.currentTimeMillis();
 
-        calculateAppRunningTimes(activitiesOpen, activitiesOpen + 1);
+        if(!manualForegroundBackgroundTriggers) {
+            calculateAppRunningTimes(activitiesOpen, activitiesOpen + 1);
+        }
         activitiesOpen++;
 
         if (!hasFirstOnResumeHappened) {
@@ -474,7 +506,9 @@ void callbackOnActivityStopped(Activity activity) {
             Log.d(Countly.TAG, "[Apm] Calling 'callbackOnActivityStopped', [" + activitiesOpen + "] -> [" + (activitiesOpen - 1) + "]");
         }
 
-        calculateAppRunningTimes(activitiesOpen, activitiesOpen - 1);
+        if(!manualForegroundBackgroundTriggers) {
+            calculateAppRunningTimes(activitiesOpen, activitiesOpen - 1);
+        }
         activitiesOpen--;
     }
 
@@ -609,5 +643,39 @@ public void setAppIsLoaded() {
                 recordAppStart(timestamp);
             }
         }
+
+        public void triggerForeground() {
+            synchronized (_cly) {
+                if (_cly.isLoggingEnabled()) {
+                    Log.i(Countly.TAG, "[Apm] Calling 'triggerForeground'");
+                }
+
+                if(!manualForegroundBackgroundTriggers) {
+                    if (_cly.isLoggingEnabled()) {
+                        Log.w(Countly.TAG, "[Apm] trying to use manual foreground/background triggers without enabling them");
+                    }
+                    return;
+                }
+
+                goToForeground();
+            }
+        }
+
+        public void triggerBackground() {
+            synchronized (_cly) {
+                if (_cly.isLoggingEnabled()) {
+                    Log.i(Countly.TAG, "[Apm] Calling 'triggerBackground'");
+                }
+
+                if(!manualForegroundBackgroundTriggers) {
+                    if (_cly.isLoggingEnabled()) {
+                        Log.w(Countly.TAG, "[Apm] trying to use manual foreground/background triggers without enabling them");
+                    }
+                    return;
+                }
+
+                goToBackground();
+            }
+        }
     }
 }