Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Caching questionnaires and their SM #3461

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Caching questionnaires and their SM #3461

wants to merge 15 commits into from

Conversation

aurangzaibumer
Copy link
Contributor

@aurangzaibumer aurangzaibumer commented Aug 23, 2024 •
edited
Loading

IMPORTANT: Where possible all PRs must be linked to a Github issue

Fixes [link to issue]

image

Engineer Checklist

  • I have written Unit tests for any new feature(s) and edge cases for bug fixes
  • I have added any strings visible on UI components to the strings.xml file
  • I have updated the CHANGELOG.md file for any notable changes to the codebase
  • I have run ./gradlew spotlessApply and ./gradlew spotlessCheck to check my code follows the project's style guide
  • I have built and run the FHIRCore app to verify my change fixes the issue and/or does not break the app
  • I have checked that this PR does NOT introduce breaking changes that require an update to Content and/or Configs? If it does add a sample here or a link to exactly what changes need to be made to the content.

Code Reviewer Checklist

  • I have verified Unit tests have been written for any new feature(s) and edge cases
  • I have verified any strings visible on UI components are in the strings.xml file
  • I have verifed the CHANGELOG.md file has any notable changes to the codebase
  • I have verified the solution has been implemented in a configurable and generic way for reuseable components
  • I have built and run the FHIRCore app to verify the change fixes the issue and/or does not break the app

@aurangzaibumer aurangzaibumer self-assigned this Aug 23, 2024
@codecov Codecov
Copy link

codecov bot commented Aug 23, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 27.6%. Comparing base (6fc15b0) to head (8feccd3).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##              main   #3461     +/-   ##
=========================================
+ Coverage     27.1%   27.6%   +0.4%     
  Complexity     775     775             
=========================================
  Files          279     278      -1     
  Lines        14563   14165    -398     
  Branches      2608    2534     -74     
=========================================
- Hits          3957    3915     -42     
+ Misses       10065    9713    -352     
+ Partials       541     537      -4
Flag Coverage Δ
geowidget 16.0% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...ster/fhircore/engine/task/FhirCarePlanGenerator.kt 78.0% <ø> (-0.2%) ⬇️
...tregister/fhircore/quest/ui/login/LoginActivity.kt 5.8% <ø> (ø)
...e/quest/ui/questionnaire/QuestionnaireViewModel.kt 3.2% <ø> (+<0.1%) ⬆️

... and 23 files with indirect coverage changes

@LZRS LZRS requested a review from ndegwamartin August 27, 2024 09:11
@aurangzaibumer aurangzaibumer marked this pull request as ready for review September 2, 2024 08:34
@ndegwamartin
Copy link
Contributor

@aurangzaibumer could we add a unit test for the ViewModel itself? You can mock anything you don't need/already tested in the Cache test if need be.

@dubdabasoduba dubdabasoduba changed the title [WIP] Caching questionnaires and their SM Caching questionnaires and their SM Sep 2, 2024
ndegwamartin
ndegwamartin reviewed Sep 19, 2024
View reviewed changes
...rc/test/java/org/smartregister/fhircore/quest/ui/questionnaire/QuestionnaireViewModelTest.kt
ContentCache.getResource(ResourceType.Questionnaire.name + "/" + questionnaireConfig.id),
)
Assert.assertNotNull(questionnaire)
Assert.assertEquals(questionnaireConfig.id, questionnaire?.id?.extractLogicalIdUuid())
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets add a verify assertion here to verify that the
defaultRepository.loadResource<Questionnaire>(questionnaireConfig.id) method was not called (i.e. was called zero times)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And we can probably split this to 2 unit tests to get better coverage for the changes in this class.

  • Test case 1 to test for when the questionnaire is Found in the cache
  • Test case 2 to test for when the questionnaire is Not Found in the cache

So basically use the:

val questionnaire =
      questionnaireViewModel.retrieveQuestionnaire(
        questionnaireConfig = questionnaireConfig,
      )

method as the focus of the test case and leave out the ContentCache.save invocations since those are already tested in the ContentCacheTest class

ndegwamartin
ndegwamartin reviewed Sep 19, 2024
View reviewed changes
...st/src/main/java/org/smartregister/fhircore/quest/ui/questionnaire/QuestionnaireViewModel.kt Outdated
Comment on lines 655 to 661
structureMapUrl?.substringAfterLast("/")?.let { smID ->
ContentCache.getResource(ResourceType.StructureMap.name + "/" + smID)?.let {
it as StructureMap
}
?: run {
defaultRepository.loadResource<StructureMap>(smID)?.also {
ContentCache.saveResource(smID, it)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can add some test cases for the Structure Map caching as well

@ndegwamartin ndegwamartin mentioned this pull request Sep 11, 2024
Open
8 tasks
ellykits
ellykits reviewed Oct 15, 2024
View reviewed changes
android/engine/src/main/java/org/smartregister/fhircore/engine/datastore/ContentCache.kt
Comment on lines +25 to +28
private val maxMemory: Int = (Runtime.getRuntime().maxMemory() / 1024).toInt()
private val cacheSize: Int = maxMemory / 8
private val cache = LruCache<String, Resource>(cacheSize)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the strategy used when this cache is full?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Least recently used

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ellykits ellykits ellykits left review comments

@ndegwamartin ndegwamartin ndegwamartin left review comments

@LZRS LZRS Awaiting requested review from LZRS

At least 1 approving review is required to merge this pull request.

Assignees

@aurangzaibumer aurangzaibumer

Labels
Performance (App or Server)
Projects
None yet
Milestone
Sprint 23 (November 4th - November 15th)
Development

Successfully merging this pull request may close these issues.
5 participants
@aurangzaibumer @ndegwamartin @ellykits @LZRS @dubdabasoduba