Cache and Lazy-Load Modifications #2928
+613
−47
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| package org.commcare.entity | ||
|
|
||
| import android.util.Pair | ||
| import org.commcare.cases.entity.AsyncNodeEntityFactory | ||
| import org.commcare.cases.entity.Entity | ||
| import org.commcare.cases.entity.EntityStorageCache | ||
| import org.commcare.suite.model.Detail | ||
| import org.commcare.tasks.PrimeEntityCacheHelper | ||
| 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 | ||
|
|
||
| /** | ||
| * Android Specific Implementation of AsyncNodeEntityFactory | ||
| * Uses [PrimeEntityCacheHelper] to prime entity cache blocking the user when required | ||
| */ | ||
| class AndroidAsyncNodeEntityFactory(d: Detail, ec: EvaluationContext?, entityStorageCache: EntityStorageCache?) : | ||
| AsyncNodeEntityFactory(d, ec, entityStorageCache), PrimeEntityCacheListener { | ||
|
|
||
| companion object { | ||
| const val TWO_MINUTES = 2 * 60 * 1000 | ||
| } | ||
|
|
||
| private var cachedEntities: List<Entity<TreeReference>>? = null | ||
| private var completedCachePrime = false | ||
|
|
||
| override fun prepareEntitiesInternal(entities: MutableList<Entity<TreeReference>>) { | ||
| if (detail.shouldCache()) { | ||
| // we only want to block if lazy load is not enabled | ||
| if (!detail.shouldLazyLoad()) { | ||
| val primeEntityCacheHelper = PrimeEntityCacheHelper.getInstance() | ||
| if (primeEntityCacheHelper.isInProgress()) { | ||
| // if we are priming something else at the moment, expedite the current detail | ||
| if (!primeEntityCacheHelper.isDetailInProgress(detail.id)) { | ||
| primeEntityCacheHelper.expediteDetailWithId(detail, entities) | ||
| } else { | ||
| // otherwise wait for existing prime process to complete | ||
| primeEntityCacheHelper.setListener(this) | ||
| waitForCachePrimeWork(entities, primeEntityCacheHelper) | ||
| if (cachedEntities != null) { | ||
| entities.clear() | ||
| entities.addAll(cachedEntities!!) | ||
| } | ||
| } | ||
| } else { | ||
| // we either have not started priming or already completed. In both cases | ||
| // we want to re-prime to make sure we calculate any uncalculated data first | ||
| primeEntityCacheHelper.primeEntityCacheForDetail(detail, entities) | ||
| } | ||
| } | ||
| } else { | ||
| super.prepareEntitiesInternal(entities) | ||
| } | ||
| } | ||
|
|
||
| private fun waitForCachePrimeWork( | ||
| entities: MutableList<Entity<TreeReference>>, | ||
| primeEntityCacheHelper: PrimeEntityCacheHelper | ||
| ) { | ||
| val startTime = System.currentTimeMillis() | ||
| while (!completedCachePrime && (System.currentTimeMillis() - startTime) < TWO_MINUTES) { | ||
| // wait for it to be completed | ||
| try { | ||
| Thread.sleep(100) | ||
| } catch (_: InterruptedException) { | ||
| } | ||
| } | ||
| if (!completedCachePrime) { | ||
| Logger.log(LogTypes.TYPE_MAINTENANCE, "Still Waiting for cache priming work to complete") | ||
| // confirm if we are still priming in the worker. If yes, wait more | ||
| // otherwise recall prepareEntitiesInternal to re-evaluate the best thing to do | ||
| if (primeEntityCacheHelper.isInProgress() && primeEntityCacheHelper.isDetailInProgress(detail.id)) { | ||
| waitForCachePrimeWork(entities, primeEntityCacheHelper) | ||
| } else { | ||
| prepareEntitiesInternal(entities) | ||
| } | ||
| } | ||
| } | ||
shubham1g5 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| override fun onPrimeEntityCacheComplete( | ||
| currentDetailInProgress: String, | ||
| cachedEntitiesWithRefs: Pair<List<Entity<TreeReference>>, List<TreeReference>> | ||
| ) { | ||
| if (detail.id!!.contentEquals(currentDetailInProgress)) { | ||
| cachedEntities = cachedEntitiesWithRefs.first | ||
| completedCachePrime = true | ||
| } | ||
| } | ||
| } | ||
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,13 @@ | ||
| package org.commcare.entity | ||
|
|
||
| import android.util.Pair | ||
| import org.commcare.cases.entity.Entity | ||
| import org.javarosa.core.model.instance.TreeReference | ||
|
|
||
| interface PrimeEntityCacheListener { | ||
|
|
||
| fun onPrimeEntityCacheComplete( | ||
| currentDetailInProgress: String, | ||
| cachedEntitiesWithRefs: Pair<List<Entity<TreeReference>>, List<TreeReference>> | ||
| ) | ||
| } |
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
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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this removing the gridview modality of entity selects entirely? I think it is mostly deprecated, but probably important to call out specifically if so to confirm that it's safe to do so.