Only prime cache, if it is available by MartinRiese · Pull Request #1538 · dimagi/commcare-core

MartinRiese · 2026-05-15T22:48:30Z

Product Description

Add a check in the cache priming code. Only do the priming, if there is a cache set.

Technical Summary

https://dimagi.atlassian.net/browse/USH-6551 (Original Issue)
https://dimagi.atlassian.net/browse/USH-6555 (fix implementation story)
https://docs.google.com/document/d/1gwfS8snRbByB69vc-unPk30mOhB9vX6uNpkq_8yxaAs/edit?tab=t.0 (Write up)

Safety Assurance

Safety story

Deploy to staging and test variations:

Web apps:
- clickable icon ✅
- sort defined, not defined ✅
mobile app:
- sort works for enum field
- sort works for other fields.

Automated test coverage

Added a test to check for future regressions which doubles as check on the fix.

QA Plan

Special deploy instructions

This PR can be deployed after merge with no further considerations.

Rollback instructions

This PR can be reverted after deploy with no further considerations.

Review

The set of people pinged as reviewers is appropriate for the level of risk of the change.

Summary by CodeRabbit

Bug Fixes
- Optimized entity data computation to conditionally process legacy data only when cache storage is available, reducing unnecessary processing and improving performance during data loading operations.

coderabbitai · 2026-05-15T22:48:43Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 5adf15df-da1c-4ea7-a697-00884fc8337c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

Walkthrough

The setUnCachedDataOld method now guards the legacy sort-field caching loop with a null check on mEntityCache. When the cache is absent, the entire loop including iteration, cancellation checks, and progress updates is skipped.

Changes

Cache Guard in Sort Field Computation

Layer / File(s)	Summary
Cache null-check guard on sort-field loop `src/main/java/org/commcare/cases/entity/AsyncNodeEntityFactory.java`	The `setUnCachedDataOld` method now checks `mEntityCache != null` before computing legacy sort fields; when the cache is absent, the sort-field calculation loop and all associated iteration logic is skipped.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit hops to guard the cache,
With null-checks swift and lightning-flash,
When absent, loops need not dash,
Efficiency blooms in compact stash! 🌿

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Only prime cache, if it is available' directly describes the main change: the method now only primes/computes legacy uncached data when the cache is available (non-null).
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch riese/no_cache_no_prime

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

MartinRiese · 2026-05-15T22:49:33Z

-            if (isCancelled) return;
-            AsyncEntity e = (AsyncEntity)entities.get(i);
-            for (int col = 0; col < e.getNumFields(); ++col) {
+        if (mEntityCache != null) {


Not sure if we would want put this behind a feature flag for now.

Looks like commcare-core doesn't have access to feature flags, is that right? We could pass through a boolean if we needed to - might be nice to easily toggle on and off for performance testing, but coordinating across three repos is tedious, and Shubham seemed optimistic about this change, so maybe not worth the effort. Dunno, I could go either way.

yeah I am quite confident for this to be rolloed out without a feature flag.

Verifies that prepareEntities does not call getSortField during the cache priming loop when no EntityStorageCache is present, which is always the case in formplayer. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

MartinRiese · 2026-05-18T16:17:17Z

@shubham1g5 Do you have a suggestion how to test the mobile app for regressions (making sure sort works as intended)?

shubham1g5 · 2026-05-19T06:14:38Z

@MartinRiese I don't think there is a need to do, the cache is always not-null for mobile when we use AsyncNodeEntityFactory so that change is essentially a no-op for mobile.

shubham1g5 · 2026-05-19T06:16:19Z

+import static org.junit.Assert.assertEquals;
+
+/**
+ * Regression test for USH-6551: sort field expressions must not be evaluated during the cache


Curious if it's a common practice on USS to add Jira ticket # in code comments, we have refrained from doing so on mobile team in past as the code is open source and putting these refrences make it cryptic for anyone external looking into the code.

esoergel

approving last commit

Only prime cache, if it is available

11fa249

MartinRiese commented May 15, 2026

View reviewed changes

MartinRiese marked this pull request as ready for review May 18, 2026 15:12

shubham1g5 previously approved these changes May 19, 2026

View reviewed changes

Remove story id from comment

2ea4cfd

MartinRiese dismissed shubham1g5’s stale review via 2ea4cfd May 20, 2026 15:18

esoergel approved these changes May 20, 2026

View reviewed changes

MartinRiese merged commit 130df00 into master May 20, 2026
7 checks passed

MartinRiese mentioned this pull request May 20, 2026

Update commcare-core to latest master dimagi/formplayer#1780

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Only prime cache, if it is available#1538

Only prime cache, if it is available#1538
MartinRiese merged 3 commits into
masterfrom
riese/no_cache_no_prime

MartinRiese commented May 15, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 15, 2026 •

edited

Loading

Review skipped

Uh oh!

MartinRiese May 15, 2026

Uh oh!

esoergel May 18, 2026

Uh oh!

shubham1g5 May 18, 2026

Uh oh!

MartinRiese commented May 18, 2026

Uh oh!

shubham1g5 commented May 19, 2026

Uh oh!

shubham1g5 May 19, 2026

Uh oh!

esoergel left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

MartinRiese commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Product Description

Technical Summary

Safety Assurance

Safety story

Automated test coverage

QA Plan

Special deploy instructions

Rollback instructions

Review

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

MartinRiese May 15, 2026

Choose a reason for hiding this comment

Uh oh!

esoergel May 18, 2026

Choose a reason for hiding this comment

Uh oh!

shubham1g5 May 18, 2026

Choose a reason for hiding this comment

Uh oh!

MartinRiese commented May 18, 2026

Uh oh!

shubham1g5 commented May 19, 2026

Uh oh!

shubham1g5 May 19, 2026

Choose a reason for hiding this comment

Uh oh!

esoergel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MartinRiese commented May 15, 2026 •

edited

Loading

coderabbitai Bot commented May 15, 2026 •

edited

Loading