[UNDER TESTING] fix: Use stored path for org units [DHIS2-18234]

dhis-2/dhis-api/src/main/java/org/hisp/dhis/organisationunit/OrganisationUnit.java

@@ -28,7 +28,9 @@
 package org.hisp.dhis.organisationunit;
 
 import static org.apache.commons.collections4.CollectionUtils.isEmpty;
+import static org.apache.commons.lang3.StringUtils.isNotEmpty;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
@@ -708,6 +710,13 @@ public void setChildren(Set<OrganisationUnit> children) {
     this.children = children;
   }
 
+  /**
+   * Note that the {@code path} property is mapped with the "property access" mode. This method will
+   * calculate and return the path property value based on the org unit ancestors. To access the
+   * {@code path} property directly, use {@link OrganisationUnit#getStoredPath}.
+   *
+   * @return the path.
+   */
   @JsonProperty
   @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
   public String getPath() {
@@ -729,19 +738,34 @@ public String getPath() {
 
     Collections.reverse(pathList);
 
-    this.path = PATH_SEP + StringUtils.join(pathList, PATH_SEP);
+    return PATH_SEP + StringUtils.join(pathList, PATH_SEP);
+  }
 
-    return this.path;
+  /**
+   * Note that the {@code path} property is mapped with the "property access" mode. This method will
+   * return the persisted {@code path} property value directly. If the path is not defined,
+   * typically as part of an integration test where the state is not yet flushed to the database,
+   * the calculated path based on the org unit ancestors is returned. To get the calculated path
+   * value explicitly, use {@link OrganisationUnit#getPath}.
+   *
+   * @return the path.
+   */
+  @JsonIgnore
+  public String getStoredPath() {
+    return isNotEmpty(path) ? path : getPath();
   }
 
-  /** Do not set directly, managed by persistence layer. */
+  /**
+   * Note that the {@code path} property is mapped with the "property access" mode. Do not set
+   * directly, this property is managed by the persistence layer.
+   */
   public void setPath(String path) {
     this.path = path;
   }
 
   /**
-   * Note that the {@code path} is mapped with the "property access" mode. This method is for unit
-   * testing purposes only.
+   * Note that the {@code path} property is mapped with the "property access" mode. This method is
+   * for unit testing purposes only.
    */
   public void updatePath() {
     setPath(getPath());

dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/data/JdbcRawAnalyticsManager.java

@@ -166,7 +166,7 @@ private String getSelectStatement(DataQueryParams params, List<DimensionalObject
           for (DimensionalItemObject item : dim.getItems()) {
             OrganisationUnit unit = (OrganisationUnit) item;
 
-            sql += DIM_NAME_OU + " like '" + unit.getPath() + "%' or ";
+            sql += DIM_NAME_OU + " like '" + unit.getStoredPath() + "%' or ";
           }
 
           sql = TextUtils.removeLastOr(sql) + ") ";

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/association/jdbc/JdbcOrgUnitAssociationsStore.java

@@ -104,7 +104,7 @@ public boolean checkOrganisationUnitsAssociations(String program, String orgUnit
   private Set<String> getUserOrgUnitPaths() {
     Set<String> allUserOrgUnitPaths =
         currentUserService.getCurrentUserOrganisationUnits().stream()
-            .map(OrganisationUnit::getPath)
+            .map(OrganisationUnit::getStoredPath)
             .collect(Collectors.toSet());
 
     return allUserOrgUnitPaths.stream()

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/datavalue/hibernate/HibernateDataValueStore.java

@@ -315,7 +315,7 @@ private String getDataValuesHql(
 
       hql.append(
           params.getOrganisationUnits().stream()
-              .map(OrganisationUnit::getPath)
+              .map(OrganisationUnit::getStoredPath)
               .map(p -> "ou.path like '" + p + "%'")
               .collect(joining(" or ")));
 
@@ -546,7 +546,7 @@ private void getDdvOrgUnits(
           where
               .append(sqlHelper.or())
               .append("ou.path like '")
-              .append(parent.getPath())
+              .append(parent.getStoredPath())
               .append("%'");
         }
 

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/expression/function/FunctionOrgUnitAncestor.java

@@ -65,7 +65,7 @@ public Object evaluate(ExpressionParser.ExprContext ctx, CommonExpressionVisitor
 
     if (orgUnit != null) {
       for (TerminalNode uid : ctx.UID()) {
-        if (orgUnit.getPath().contains(uid.getText() + "/")) {
+        if (orgUnit.getStoredPath().contains(uid.getText() + "/")) {
           return true;
         }
       }

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/organisationunit/hibernate/HibernateOrganisationUnitStore.java

@@ -158,7 +158,7 @@ public Long getOrganisationUnitHierarchyMemberCount(
             + ")";
 
     Query<Long> query = getTypedQuery(hql);
-    query.setParameter("path", parent.getPath() + "%").setParameter("object", member);
+    query.setParameter("path", parent.getStoredPath() + "%").setParameter("object", member);
 
     return query.getSingleResult();
   }
@@ -216,7 +216,7 @@ public List<OrganisationUnit> getOrganisationUnits(OrganisationUnitQueryParams p
 
     if (params.hasParents()) {
       for (OrganisationUnit parent : params.getParents()) {
-        query.setParameter(parent.getUid(), parent.getPath() + "%");
+        query.setParameter(parent.getUid(), parent.getStoredPath() + "%");
       }
     }
 
@@ -261,7 +261,7 @@ public Map<String, Set<String>> getOrganisationUnitDataSetAssocationMap(
       sql += hlp.whereAnd() + " (";
 
       for (OrganisationUnit unit : organisationUnits) {
-        sql += "ou.path like '" + unit.getPath() + "%' or ";
+        sql += "ou.path like '" + unit.getStoredPath() + "%' or ";
       }
 
       sql = TextUtils.removeLastOr(sql) + ") ";
@@ -385,7 +385,7 @@ private String buildOrganisationUnitDistinctUidsSql(OrganisationUnitQueryParams
       sql += hlp.whereAnd() + " (";
 
       for (OrganisationUnit parent : params.getParents()) {
-        sql += "o.path like '" + escapeSql(parent.getPath()) + "%'" + " or ";
+        sql += "o.path like '" + escapeSql(parent.getStoredPath()) + "%'" + " or ";
       }
 
       sql = TextUtils.removeLastOr(sql) + ") ";

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/program/hibernate/HibernateProgramInstanceStore.java

@@ -183,7 +183,10 @@ private QueryWithOrderBy buildProgramInstanceHql(ProgramInstanceQueryParams para
 
         for (OrganisationUnit organisationUnit : params.getOrganisationUnits()) {
           ouClause +=
-              orHlp.or() + "pi.organisationUnit.path LIKE '" + organisationUnit.getPath() + "%'";
+              orHlp.or()
+                  + "pi.organisationUnit.path LIKE '"
+                  + organisationUnit.getStoredPath()
+                  + "%'";
         }
 
         ouClause += ")";

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/trackedentity/hibernate/HibernateTrackedEntityInstanceStore.java

@@ -880,7 +880,11 @@ private String getFromSubQueryJoinOrgUnitConditions(TrackedEntityInstanceQueryPa
 
         OrganisationUnit ou = organisationUnitStore.getByUid(organisationUnit.getUid());
         if (ou != null) {
-          orgUnits.append(orHlp.or()).append("OU.path LIKE '").append(ou.getPath()).append("%'");
+          orgUnits
+              .append(orHlp.or())
+              .append("OU.path LIKE '")
+              .append(ou.getStoredPath())
+              .append("%'");
         }
       }
 

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/trackedentitydatavalue/hibernate/HibernateTrackedEntityDataValueAuditStore.java

@@ -159,7 +159,7 @@ private List<Predicate> getTrackedEntityDataValueAuditCriteria(
         List<Predicate> orgUnitPredicates = new ArrayList<>();
 
         for (OrganisationUnit orgUnit : params.getOrgUnits()) {
-          orgUnitPredicates.add(builder.like(ou.get("path"), (orgUnit.getPath() + "%")));
+          orgUnitPredicates.add(builder.like(ou.get("path"), (orgUnit.getStoredPath() + "%")));
         }
 
         predicates.add(builder.or(orgUnitPredicates.toArray(Predicate[]::new)));

dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/dataset/JdbcCompleteDataSetRegistrationExchangeStore.java

@@ -272,7 +272,7 @@ private static String createOrgUnitClause(
 
       clause +=
           params.getOrganisationUnits().stream()
-              .map(o -> " ou.path LIKE '" + o.getPath() + "%' OR ")
+              .map(o -> " ou.path LIKE '" + o.getStoredPath() + "%' OR ")
               .collect(Collectors.joining());
 
       return TextUtils.removeLastOr(clause) + " ) ";

dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/datavalueset/SpringDataValueSetStore.java

@@ -290,7 +290,7 @@ private String getDataValueSql(DataExportParams params) {
       sql += "and (";
 
       for (OrganisationUnit parent : params.getOrganisationUnits()) {
-        sql += "ou.path like '" + parent.getPath() + "%' or ";
+        sql += "ou.path like '" + parent.getStoredPath() + "%' or ";
       }
 
       sql = TextUtils.removeLastOr(sql) + ") ";

dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/events/event/JdbcEventStore.java

@@ -1401,7 +1401,7 @@ private String createAccessibleSql(
 
   private String createDescendantsSql(
       User user, EventQueryParams params, MapSqlParameterSource mapSqlParameterSource) {
-    mapSqlParameterSource.addValue(COLUMN_ORG_UNIT_PATH, params.getOrgUnit().getPath());
+    mapSqlParameterSource.addValue(COLUMN_ORG_UNIT_PATH, params.getOrgUnit().getStoredPath());
 
     if (isProgramRestricted(params.getProgram())) {
       return createCaptureScopeQuery(
@@ -1414,7 +1414,7 @@ private String createDescendantsSql(
 
   private String createChildrenSql(
       User user, EventQueryParams params, MapSqlParameterSource mapSqlParameterSource) {
-    mapSqlParameterSource.addValue(COLUMN_ORG_UNIT_PATH, params.getOrgUnit().getPath());
+    mapSqlParameterSource.addValue(COLUMN_ORG_UNIT_PATH, params.getOrgUnit().getStoredPath());
 
     String customChildrenQuery =
         " AND (ou.hierarchylevel = "
@@ -1437,7 +1437,7 @@ private String createChildrenSql(
 
   private String createSelectedSql(
       User user, EventQueryParams params, MapSqlParameterSource mapSqlParameterSource) {
-    mapSqlParameterSource.addValue(COLUMN_ORG_UNIT_PATH, params.getOrgUnit().getPath());
+    mapSqlParameterSource.addValue(COLUMN_ORG_UNIT_PATH, params.getOrgUnit().getStoredPath());
 
     String orgUnitPathEqualsMatchQuery =
         " ou.path = :"

dhis-2/dhis-services/dhis-service-reporting/src/main/java/org/hisp/dhis/predictor/PredictionDataValueFetcher.java

@@ -207,7 +207,8 @@ public void init(
     this.outputDataElementOperand = outputDataElementOperand;
 
     orgUnitLookup =
-        orgUnits.stream().collect(Collectors.toMap(OrganisationUnit::getPath, Function.identity()));
+        orgUnits.stream()
+            .collect(Collectors.toMap(OrganisationUnit::getStoredPath, Function.identity()));
     dataElementLookup =
         dataElements.stream()
             .collect(toMap(DataElement::getId, Function.identity(), (de1, de2) -> de1));
@@ -359,7 +360,7 @@ private PredictionData getPredictionData(
         addValueToMap(dv, map);
       }
 
-      if (ddv.getSourcePath().equals(dv.getSource().getPath())
+      if (ddv.getSourcePath().equals(dv.getSource().getStoredPath())
           && ddv.getDataElementId() == outputDataElementOperand.getDataElement().getId()
           && (outputDataElementOperand.getCategoryOptionCombo() == null
               || ddv.getCategoryOptionComboId()

dhis-2/dhis-services/dhis-service-validation/src/main/java/org/hisp/dhis/minmax/hibernate/HibernateMinMaxDataElementStore.java

@@ -177,7 +177,7 @@ public void delete(Collection<DataElement> dataElements, OrganisationUnit parent
 
     getQuery(hql)
         .setParameterList("dataElements", dataElements)
-        .setParameter("path", parent.getPath() + "%")
+        .setParameter("path", parent.getStoredPath() + "%")
         .executeUpdate();
   }
 

dhis-2/dhis-services/dhis-service-validation/src/main/java/org/hisp/dhis/outlierdetection/util/OutlierDetectionUtils.java

@@ -48,7 +48,7 @@ public static String getOrgUnitPathClause(List<OrganisationUnit> orgUnits) {
     String sql = "(";
 
     for (OrganisationUnit ou : orgUnits) {
-      sql += "ou.\"path\" like '" + ou.getPath() + "%' or ";
+      sql += "ou.\"path\" like '" + ou.getStoredPath() + "%' or ";
     }
 
     return StringUtils.trim(TextUtils.removeLastOr(sql)) + ")";

dhis-2/dhis-services/dhis-service-validation/src/main/java/org/hisp/dhis/validation/hibernate/HibernateValidationResultStore.java

@@ -201,7 +201,8 @@ public List<ValidationResult> getValidationResults(
                 + "vr.validationRule in :validationRules and vr.period in :periods ");
 
     if (orgUnit != null) {
-      query.setParameter("orgUnitPath", orgUnit.getPath() + (includeOrgUnitDescendants ? "%" : ""));
+      query.setParameter(
+          "orgUnitPath", orgUnit.getStoredPath() + (includeOrgUnitDescendants ? "%" : ""));
     }
 
     query.setParameter("validationRules", validationRules);

dhis-2/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/DataAnalysisController.java

@@ -671,7 +671,7 @@ private List<ValidationResultView> validationResultsListToResponse(
       if (organisationUnit != null) {
         validationResultView.setOrganisationUnitId(organisationUnit.getUid());
         validationResultView.setOrganisationUnitDisplayName(organisationUnit.getDisplayName());
-        validationResultView.setOrganisationUnitPath(organisationUnit.getPath());
+        validationResultView.setOrganisationUnitPath(organisationUnit.getStoredPath());
         validationResultView.setOrganisationUnitAncestorNames(organisationUnit.getAncestorNames());
       }
 

dhis-2/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/LockExceptionController.java

@@ -307,6 +307,6 @@ public void deleteLockException(
   private boolean canCapture(OrganisationUnit captureTarget) {
     return currentUserService.currentUserIsSuper()
         || currentUserService.getCurrentUserOrganisationUnits().stream()
-            .anyMatch(ou -> captureTarget.getPath().startsWith(ou.getPath()));
+            .anyMatch(ou -> captureTarget.getPath().startsWith(ou.getStoredPath()));
   }
 }