fix: Add null check for program [DHIS2-18459] (#19240)

dhis2 · Nov 20, 2024 · f209711 · f209711
1 parent 8be06a2
commit f209711
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 10 deletions.
diff --git a/dhis-2/dhis-api/src/main/java/org/hisp/dhis/program/Program.java b/dhis-2/dhis-api/src/main/java/org/hisp/dhis/program/Program.java
@@ -358,6 +358,10 @@ public boolean isSingleProgramStage() {
     return programStages != null && programStages.size() == 1;
   }
 
+  public boolean hasMaxTeiCountToReturn() {
+    return maxTeiCountToReturn > 0;
+  }
+
   @Override
   public int increaseVersion() {
     return ++version;

diff --git a/...core/src/main/java/org/hisp/dhis/trackedentity/hibernate/HibernateTrackedEntityStore.java b/...core/src/main/java/org/hisp/dhis/trackedentity/hibernate/HibernateTrackedEntityStore.java
@@ -407,6 +407,8 @@ private String getCountQuery(TrackedEntityQueryParams params) {
    * @return a count SQL query
    */
   private String getCountQueryWithMaxTeiLimit(TrackedEntityQueryParams params) {
+    boolean hasMaxTeiCountToReturn =
+        params.hasProgram() && params.getProgram().hasMaxTeiCountToReturn();
     return new StringBuilder()
         .append(getQueryCountSelect(params))
         .append(getQuerySelect(params))
@@ -415,7 +417,7 @@ private String getCountQueryWithMaxTeiLimit(TrackedEntityQueryParams params) {
         .append(getQueryRelatedTables(params))
         .append(getQueryGroupBy(params))
         .append(
-            params.getProgram().getMaxTeiCountToReturn() > 0
+            hasMaxTeiCountToReturn
                 ? getLimitClause(params.getProgram().getMaxTeiCountToReturn() + 1)
                 : "")
         .append(" ) tecount")

diff --git a/...rvice-core/src/test/java/org/hisp/dhis/trackedentity/DefaultTrackedEntityServiceTest.java b/...rvice-core/src/test/java/org/hisp/dhis/trackedentity/DefaultTrackedEntityServiceTest.java
@@ -30,7 +30,7 @@
 import static org.hisp.dhis.DhisConvenienceTest.injectSecurityContext;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
-import static org.mockito.Mockito.any;
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.when;
 
 import java.util.Set;
@@ -75,7 +75,9 @@ class DefaultTrackedEntityServiceTest {
 
   @Mock private TrackedEntityAttributeValueChangeLogService attributeValueAuditService;
 
-  private TrackedEntityQueryParams params;
+  private TrackedEntityQueryParams paramsA;
+
+  private TrackedEntityQueryParams paramsB;
 
   private DefaultTrackedEntityService teiService;
 
@@ -103,11 +105,15 @@ void setup() {
     this.user = user;
     injectSecurityContext(UserDetails.fromUser(user));
 
-    params = new TrackedEntityQueryParams();
-    params.setOrgUnitMode(OrganisationUnitSelectionMode.ACCESSIBLE);
-    params.setProgram(new Program("Test program"));
-    params.getProgram().setMaxTeiCountToReturn(10);
-    params.setTrackedEntityUids(Set.of("1"));
+    paramsA = new TrackedEntityQueryParams();
+    paramsA.setOrgUnitMode(OrganisationUnitSelectionMode.ACCESSIBLE);
+    paramsA.setProgram(new Program("Test program"));
+    paramsA.getProgram().setMaxTeiCountToReturn(10);
+    paramsA.setTrackedEntityUids(Set.of("1"));
+
+    paramsB = new TrackedEntityQueryParams();
+    paramsB.setOrgUnitMode(OrganisationUnitSelectionMode.ACCESSIBLE);
+    paramsB.setTrackedEntityUids(Set.of("1"));
   }
 
   @Test
@@ -122,7 +128,7 @@ void exceptionThrownWhenTeiLimitReached() {
     IllegalQueryException expectedException =
         assertThrows(
             IllegalQueryException.class,
-            () -> teiService.validateSearchScope(params, true),
+            () -> teiService.validateSearchScope(paramsA, true),
             "test message");
 
     assertEquals("maxteicountreached", expectedException.getMessage());
@@ -137,6 +143,14 @@ void noExceptionThrownWhenTeiLimitNotReached() {
     String currentUsername = CurrentUserUtil.getCurrentUsername();
     when(userService.getUserByUsername(currentUsername)).thenReturn(user);
 
-    teiService.validateSearchScope(params, true);
+    teiService.validateSearchScope(paramsA, true);
+  }
+
+  @Test
+  void noExceptionThrownWhenNoProgramSpecified() {
+    String currentUsername = CurrentUserUtil.getCurrentUsername();
+    when(userService.getUserByUsername(currentUsername)).thenReturn(user);
+
+    teiService.validateSearchScope(paramsB, true);
   }
 }
diff --git a/...g/hisp/dhis/webapi/controller/deprecated/tracker/TrackedEntityInstanceCriteriaMapper.java b/...g/hisp/dhis/webapi/controller/deprecated/tracker/TrackedEntityInstanceCriteriaMapper.java
@@ -286,6 +286,13 @@ private QueryItem getItem(String item, Map<String, TrackedEntityAttribute> attri
         at, null, at.getValueType(), at.getAggregationType(), at.getOptionSet(), at.isUnique());
   }
 
+  /**
+   * Validates and retrieves the program optionally specified in the given criteria. Returns <code>
+   * null</code> if program is not specified.
+   *
+   * @param criteria the {@link TrackedEntityInstanceCriteria}.
+   * @return a {@link Program} or <code>null</code>.
+   */
   private Program validateProgram(TrackedEntityInstanceCriteria criteria) {
     Function<String, Program> getProgram =
         uid -> {