Add perf monitoring trace for case list loading time

app/src/org/commcare/google/services/analytics/CCAnalyticsParam.java

@@ -9,8 +9,9 @@ public class CCAnalyticsParam {
     public static final String USER_CID = "user_cid";
     static final String BUILD_NUMBER = "build_number";
     static final String CC_APP_ID = "cc_app_id";
+    static final String CC_APP_NAME = "cc_app_name";
     static final String CC_APP_BUILD_PROFILE_ID = "cc_app_build_profile_id";
-    static final String CCHQ_DOMAIN = "cchq_domain";
+    public static final String CCHQ_DOMAIN = "cchq_domain";
     static final String SERVER = "server";
     static final String FREE_DISK = "free_disk";
     static final String CCC_ENABLED = "ccc_enabled";
@@ -23,7 +24,7 @@ public class CCAnalyticsParam {
     static final String REASON = "reason";
     static final String RESULT = "result";
     static final String UI_STATE = "uite_state";
-    static final String USERNAME = "username";
+    public static final String USERNAME = "username";
     static final String FORM_ID = "form_id";
     static final String REQUEST_ID = "request_id";
     static final String RESULT_CODE = "result_code";

app/src/org/commcare/google/services/analytics/CCPerfMonitoring.kt

@@ -0,0 +1,38 @@
+package org.commcare.google.services.analytics
+
+import com.google.firebase.perf.FirebasePerformance
+import com.google.firebase.perf.metrics.Trace
+import org.commcare.android.logging.ReportingUtils
+import org.javarosa.core.services.Logger
+
+object CCPerfMonitoring {
+    // Traces
+    // Measures the duration of synchronous case list loading
+    const val TRACE_SYNC_ENTITY_LIST_LOADING = "sync_case_list_loading"
+
+    // Attributes
+    const val ATTR_NUM_CASES_LOADED = "number_of_cases_loaded"
+
+    fun startTracing (traceName: String): Trace? {
+        try {
+            val trace = FirebasePerformance.getInstance().newTrace(traceName)
+            trace.putAttribute(CCAnalyticsParam.CCHQ_DOMAIN, ReportingUtils.getDomain())
+            trace.putAttribute(CCAnalyticsParam.CC_APP_ID, ReportingUtils.getAppId())
+            trace.putAttribute(CCAnalyticsParam.CC_APP_NAME, ReportingUtils.getAppName())
+            trace.putAttribute(CCAnalyticsParam.USERNAME, ReportingUtils.getUser())
+            trace.start();
+            return trace
+        } catch (exception: Exception) {
+            Logger.exception("Error starting perf trace: $traceName", exception)
+        }
+        return null
+    }
+
+    fun stopTracing(trace: Trace?) {
+        try {
+            trace?.stop();
+        } catch (exception: Exception) {
+            Logger.exception("Error starting perf trace: ${trace?.name}", exception)
+        }
+    }
+}

app/src/org/commcare/tasks/EntityLoaderHelper.kt

@@ -59,7 +59,7 @@ class EntityLoaderHelper(
         nodeset: TreeReference,
         progressListener: EntityLoadingProgressListener
     ): Pair<List<Entity<TreeReference>>, List<TreeReference>>? {
-        if (factory !is AsyncNodeEntityFactory) {
+        if (!isAsyncNodeEntityFactory()) {
             // if we are into synchronous mode, cancel background cache work for now to not lock the user db
             CommCareApplication.instance().currentApp.primeEntityCacheHelper.cancelWork()
         }
@@ -72,14 +72,18 @@ class EntityLoaderHelper(
                 return Pair<List<Entity<TreeReference>>, List<TreeReference>>(entities, references)
             }
         } finally {
-            if (factory !is AsyncNodeEntityFactory) {
+            if (!isAsyncNodeEntityFactory()) {
                 // Restart the cancelled task
                 PrimeEntityCacheHelper.schedulePrimeEntityCacheWorker()
             }
         }
         return null
     }
 
+    fun isAsyncNodeEntityFactory(): Boolean {
+        return factory is AsyncNodeEntityFactory
+    }
+
     /**
      *  Primes the entity cache
      */

app/src/org/commcare/tasks/EntityLoaderTask.java

@@ -2,9 +2,12 @@
 
 import android.util.Pair;
 
+import com.google.firebase.perf.metrics.Trace;
+
 import org.commcare.android.logging.ForceCloseLogger;
 import org.commcare.cases.entity.Entity;
 import org.commcare.cases.entity.EntityLoadingProgressListener;
+import org.commcare.google.services.analytics.CCPerfMonitoring;
 import org.commcare.logging.XPathErrorLogger;
 import org.commcare.suite.model.Detail;
 import org.commcare.suite.model.EntityDatum;
@@ -50,7 +53,20 @@ public EntityLoaderTask(Detail detail, @Nullable EntityDatum entityDatum, Evalua
     @Override
     protected Pair<List<Entity<TreeReference>>, List<TreeReference>> doInBackground(TreeReference... nodeset) {
         try {
-            return entityLoaderHelper.loadEntities(nodeset[0], this);
+            // Capture sync_case_list_loading trace for performance monitoring
+            Trace trace = null;
+            if (!entityLoaderHelper.isAsyncNodeEntityFactory()) {
+                trace = CCPerfMonitoring.INSTANCE.startTracing(CCPerfMonitoring.TRACE_SYNC_ENTITY_LIST_LOADING);
+            }
+            Pair<List<Entity<TreeReference>>, List<TreeReference>> entities = entityLoaderHelper.loadEntities(
+                    nodeset[0], this);
+
+            if (trace != null && !entityLoaderHelper.isAsyncNodeEntityFactory()) {
+                trace.putAttribute(CCPerfMonitoring.ATTR_NUM_CASES_LOADED,
+                        String.valueOf((entities == null || entities.first == null ? 0 : entities.first.size())));
+                CCPerfMonitoring.INSTANCE.stopTracing(trace);
+            }
+            return entities;
         } catch (XPathException xe) {
             XPathErrorLogger.INSTANCE.logErrorToCurrentApp(xe);
             Logger.exception("Error during EntityLoaderTask: " + ForceCloseLogger.getStackTrace(xe), xe);