Merge pull request #3544 from dimagi/hotfix_add-troubleshooting-logs-aroud-case-list-loading-crash

[Hotfix] Add troubleshooting logging about case list loading crash

Author: avazirna

app/src/org/commcare/services/CommCareSessionService.java

@@ -266,6 +266,10 @@ public void startSession(User user, UserKeyRecord record) {
         }
     }
 
+    public Date getSessionExpireDate() {
+        return sessionExpireDate;
+    }
+
     private void setUpSessionExpirationTimer() {
         maintenanceTimer = new Timer("CommCareService");
         maintenanceTimer.schedule(new TimerTask() {

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

@@ -22,12 +22,11 @@ import org.javarosa.core.model.instance.TreeReference
  */
 class EntityLoaderHelper(
     detail: Detail,
-    sessionDatum: EntityDatum?,
+    var sessionDatum: EntityDatum?,
     evalCtx: EvaluationContext,
     inBackground: Boolean,
-    var factory: NodeEntityFactory? = null
+    var factory: NodeEntityFactory? = null,
 ) : Cancellable {
-
     var focusTargetIndex: Int = -1
     private var stopLoading: Boolean = false
 
@@ -57,11 +56,15 @@ class EntityLoaderHelper(
      */
     fun loadEntities(
         nodeset: TreeReference,
-        progressListener: EntityLoadingProgressListener
+        progressListener: EntityLoadingProgressListener,
     ): Pair<List<Entity<TreeReference>>, List<TreeReference>>? {
         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()
+            CommCareApplication
+                .instance()
+                .currentApp
+                .primeEntityCacheHelper
+                .cancelWork()
         }
         try {
             val references = factory!!.expandReferenceList(nodeset)
@@ -80,9 +83,7 @@ class EntityLoaderHelper(
         return null
     }
 
-    fun isAsyncNodeEntityFactory(): Boolean {
-        return factory is AsyncNodeEntityFactory
-    }
+    fun isAsyncNodeEntityFactory(): Boolean = factory is AsyncNodeEntityFactory
 
     /**
      *  Primes the entity cache
@@ -103,7 +104,7 @@ class EntityLoaderHelper(
      */
     private fun loadEntitiesWithReferences(
         references: List<TreeReference>,
-        progressListener: EntityLoadingProgressListener?
+        progressListener: EntityLoadingProgressListener?,
     ): MutableList<Entity<TreeReference>>? {
         val entities: MutableList<Entity<TreeReference>> = ArrayList()
         focusTargetIndex = -1
@@ -115,7 +116,7 @@ class EntityLoaderHelper(
             progressListener?.publishEntityLoadingProgress(
                 EntityLoadingProgressListener.EntityLoadingProgressPhase.PHASE_PROCESSING,
                 index,
-                references.size
+                references.size,
             )
             val e = factory!!.getEntity(ref)
             if (e != null) {

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

@@ -4,6 +4,7 @@
 
 import com.google.firebase.perf.metrics.Trace;
 
+import org.commcare.CommCareApplication;
 import org.commcare.android.logging.ForceCloseLogger;
 import org.commcare.cases.entity.Entity;
 import org.commcare.cases.entity.EntityLoadingProgressListener;
@@ -12,11 +13,13 @@
 import org.commcare.suite.model.Detail;
 import org.commcare.suite.model.EntityDatum;
 import org.commcare.tasks.templates.ManagedAsyncTask;
+import org.commcare.util.LogTypes;
 import org.javarosa.core.model.condition.EvaluationContext;
 import org.javarosa.core.model.instance.TreeReference;
 import org.javarosa.core.services.Logger;
 import org.javarosa.xpath.XPathException;
 
+import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -79,9 +82,29 @@ protected Pair<List<Entity<TreeReference>>, List<TreeReference>> doInBackground(
             Logger.exception("Error during EntityLoaderTask: " + ForceCloseLogger.getStackTrace(xe), xe);
             mException = xe;
             return null;
+        } catch (RuntimeException e) {
+            Logger.log(LogTypes.SOFT_ASSERT, "Loading entities failed for " + getSessionShortDetail() +
+                    "; session expiring at: " + getSessionExpirationTime());
+            throw e;
         }
     }
 
+    private Date getSessionExpirationTime() {
+        if (CommCareApplication.isSessionActive()) {
+            try {
+                return CommCareApplication.instance().getSession().getSessionExpireDate();
+            } catch (Exception e) {
+                return null;
+            }
+        }
+        return null;
+    }
+
+    private String getSessionShortDetail() {
+        return (entityLoaderHelper != null && entityLoaderHelper.getSessionDatum() != null) ?
+                entityLoaderHelper.getSessionDatum().getShortDetail() : "null";
+    }
+
     @Override
     protected void onPostExecute(Pair<List<Entity<TreeReference>>, List<TreeReference>> result) {
         super.onPostExecute(result);