feat: adds ou to meta when DE ou [DHIS2-18884] [2.40]

dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/event/EventQueryParams.java

@@ -234,6 +234,8 @@ public class EventQueryParams extends DataQueryParams {
 
   @Getter protected boolean multipleQueries = false;
 
+  @Getter protected List<OrganisationUnit> userOrgUnits = new ArrayList<>();
+
   // -------------------------------------------------------------------------
   // Constructors
   // -------------------------------------------------------------------------
@@ -303,6 +305,7 @@ protected EventQueryParams instance() {
     params.endpointAction = this.endpointAction;
     params.rowContext = this.rowContext;
     params.multipleQueries = this.multipleQueries;
+    params.userOrgUnits = this.userOrgUnits;
     return params;
   }
 
@@ -1352,5 +1355,10 @@ public Builder withMultipleQueries(boolean multipleQueries) {
       this.params.multipleQueries = multipleQueries;
       return this;
     }
+
+    public Builder withUserOrgUnits(List<OrganisationUnit> userOrgUnits) {
+      this.params.userOrgUnits = userOrgUnits;
+      return this;
+    }
   }
 }

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

@@ -104,6 +104,8 @@ public abstract class AbstractAnalyticsService {
 
   protected final SchemaIdResponseMapper schemaIdResponseMapper;
 
+  protected final OrganisationUnitResolver organisationUnitResolver;
+
   /**
    * Returns a grid based on the given query.
    *
@@ -503,6 +505,8 @@ private Map<String, MetadataItem> getMetadataItems(EventQueryParams params) {
                     new MetadataItem(
                         item.getItem().getDisplayName(), includeDetails ? item.getItem() : null)));
 
+    metadataItemMap.putAll(organisationUnitResolver.getMetadataItemsForOrgUnitDataElements(params));
+
     return metadataItemMap;
   }
 
@@ -685,7 +689,10 @@ private Map<String, List<String>> getDimensionItems(
     for (QueryItem item : params.getItems()) {
       String itemUid = getItemUid(item);
 
-      if (item.hasOptionSet()) {
+      if (item.getValueType().isOrganisationUnit()) {
+        List<String> items = organisationUnitResolver.resolveOrgUnis(params, item);
+        dimensionItems.put(itemUid, items);
+      } else if (item.hasOptionSet()) {
         if (itemOptions.isPresent()) {
           Map<String, List<Option>> itemOptionsMap = itemOptions.get();
 

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

@@ -166,6 +166,8 @@ public abstract class AbstractJdbcEventAnalyticsManager {
 
   protected final ExecutionPlanStore executionPlanStore;
 
+  private final OrganisationUnitResolver organisationUnitResolver;
+
   /**
    * Returns a SQL paging clause.
    *
@@ -1236,9 +1238,14 @@ public String toSql(QueryItem item, QueryFilter filter, EventQueryParams params)
             ? getSelectSql(filter, item, params)
             : getSelectSql(filter, item, params.getEarliestStartDate(), params.getLatestEndDate());
 
+    String filterString =
+        item.getValueType() == ValueType.ORGANISATION_UNIT
+            ? organisationUnitResolver.resolveOrgUnits(filter, params.getUserOrgUnits())
+            : filter.getFilter();
+
     if (IN.equals(filter.getOperator())) {
       InQueryFilter inQueryFilter =
-          new InQueryFilter(field, encode(filter.getFilter(), false), !item.isNumeric());
+          new InQueryFilter(field, encode(filterString, false), !item.isNumeric());
 
       return inQueryFilter.getSqlFilter();
     } else {

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

@@ -98,8 +98,9 @@ public DefaultEnrollmentAnalyticsService(
       AnalyticsSecurityManager securityManager,
       EventQueryPlanner queryPlanner,
       EventQueryValidator queryValidator,
-      SchemaIdResponseMapper schemaIdResponseMapper) {
-    super(securityManager, queryValidator, schemaIdResponseMapper);
+      SchemaIdResponseMapper schemaIdResponseMapper,
+      OrganisationUnitResolver organisationUnitResolver) {
+    super(securityManager, queryValidator, schemaIdResponseMapper, organisationUnitResolver);
 
     checkNotNull(enrollmentAnalyticsManager);
     checkNotNull(queryPlanner);

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

@@ -197,8 +197,9 @@ public DefaultEventAnalyticsService(
       DatabaseInfo databaseInfo,
       AnalyticsCache analyticsCache,
       EnrollmentAnalyticsManager enrollmentAnalyticsManager,
-      SchemaIdResponseMapper schemaIdResponseMapper) {
-    super(securityManager, queryValidator, schemaIdResponseMapper);
+      SchemaIdResponseMapper schemaIdResponseMapper,
+      OrganisationUnitResolver organisationUnitResolver) {
+    super(securityManager, queryValidator, schemaIdResponseMapper, organisationUnitResolver);
 
     checkNotNull(dataElementService);
     checkNotNull(trackedEntityAttributeService);

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

@@ -48,12 +48,10 @@
 import static org.hisp.dhis.analytics.event.data.DefaultEventDataQueryService.SortableItems.translateItemIfNecessary;
 import static org.hisp.dhis.analytics.util.AnalyticsUtils.throwIllegalQueryEx;
 import static org.hisp.dhis.common.DimensionalObject.DIMENSION_NAME_SEP;
-import static org.hisp.dhis.common.DimensionalObject.OPTION_SEP;
 import static org.hisp.dhis.common.DimensionalObject.PERIOD_DIM_ID;
 import static org.hisp.dhis.common.DimensionalObjectUtils.getDimensionFromParam;
 import static org.hisp.dhis.common.DimensionalObjectUtils.getDimensionItemsFromParam;
 import static org.hisp.dhis.common.DimensionalObjectUtils.getDimensionalItemIds;
-import static org.hisp.dhis.common.ValueType.ORGANISATION_UNIT;
 
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -68,7 +66,6 @@
 import java.util.stream.Collectors;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import lombok.SneakyThrows;
 import org.apache.commons.lang3.StringUtils;
 import org.hisp.dhis.analytics.AnalyticsAggregationType;
 import org.hisp.dhis.analytics.DataQueryService;
@@ -229,7 +226,8 @@ public EventQueryParams getFromRequest(EventDataQueryRequest request, boolean an
             .withEnhancedConditions(request.isEnhancedConditions())
             .withEndpointItem(request.getEndpointItem())
             .withEndpointAction(request.getEndpointAction())
-            .withRowContext(request.isRowContext());
+            .withRowContext(request.isRowContext())
+            .withUserOrgUnits(userOrgUnits);
 
     if (analyzeOnly) {
       builder = builder.withSkipData(true).withAnalyzeOrderId();
@@ -344,7 +342,7 @@ private void addDimensionsToParams(
           if (groupableItem != null) {
             params.addDimension((DimensionalObject) groupableItem);
           } else {
-            groupableItem = getQueryItem(dim, pr, request.getOutputType(), userOrgUnits);
+            groupableItem = getQueryItem(dim, pr, request.getOutputType());
             params.addItem((QueryItem) groupableItem);
           }
 
@@ -511,14 +509,6 @@ private QueryItem getQueryItem(
 
   @Override
   public QueryItem getQueryItem(String dimensionString, Program program, EventOutputType type) {
-    return getQueryItem(dimensionString, program, type, Collections.emptyList());
-  }
-
-  private QueryItem getQueryItem(
-      String dimensionString,
-      Program program,
-      EventOutputType type,
-      List<OrganisationUnit> userOrgUnits) {
     String[] split = dimensionString.split(DIMENSION_NAME_SEP);
 
     if (split.length % 2 != 1) {
@@ -535,25 +525,13 @@ private QueryItem getQueryItem(
         // FE uses HH.MM time format instead of HH:MM. This is not
         // compatible with db table/cell values
         modifyFilterWhenTimeQueryItem(queryItem, filter);
-        resolveOrgUnitDimensionIfNecessary(queryItem, filter, userOrgUnits);
         queryItem.addFilter(filter);
       }
     }
 
     return queryItem;
   }
 
-  @SneakyThrows
-  private void resolveOrgUnitDimensionIfNecessary(
-      QueryItem queryItem, QueryFilter queryFilter, List<OrganisationUnit> userOrgUnits) {
-    if (queryItem.getValueType().equals(ORGANISATION_UNIT)) {
-      List<String> filterItem = QueryFilter.getFilterItems(queryFilter.getFilter());
-      List<String> orgUnitDimensionUid =
-          dataQueryService.getOrgUnitDimensionUid(filterItem, userOrgUnits);
-      queryFilter.setFilter(String.join(OPTION_SEP, orgUnitDimensionUid));
-    }
-  }
-
   private static void modifyFilterWhenTimeQueryItem(QueryItem queryItem, QueryFilter filter) {
     if (queryItem.getItem() instanceof DataElement
         && ((DataElement) queryItem.getItem()).getValueType() == ValueType.TIME) {

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

@@ -124,9 +124,14 @@ public JdbcEnrollmentAnalyticsManager(
       ProgramIndicatorService programIndicatorService,
       ProgramIndicatorSubqueryBuilder programIndicatorSubqueryBuilder,
       EnrollmentTimeFieldSqlRenderer timeFieldSqlRenderer,
-      ExecutionPlanStore executionPlanStore) {
+      ExecutionPlanStore executionPlanStore,
+      OrganisationUnitResolver organisationUnitResolver) {
     super(
-        jdbcTemplate, programIndicatorService, programIndicatorSubqueryBuilder, executionPlanStore);
+        jdbcTemplate,
+        programIndicatorService,
+        programIndicatorSubqueryBuilder,
+        executionPlanStore,
+        organisationUnitResolver);
     this.timeFieldSqlRenderer = timeFieldSqlRenderer;
   }
 

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

@@ -117,9 +117,14 @@ public JdbcEventAnalyticsManager(
       ProgramIndicatorService programIndicatorService,
       ProgramIndicatorSubqueryBuilder programIndicatorSubqueryBuilder,
       EventTimeFieldSqlRenderer timeFieldSqlRenderer,
-      ExecutionPlanStore executionPlanStore) {
+      ExecutionPlanStore executionPlanStore,
+      OrganisationUnitResolver organisationUnitResolver) {
     super(
-        jdbcTemplate, programIndicatorService, programIndicatorSubqueryBuilder, executionPlanStore);
+        jdbcTemplate,
+        programIndicatorService,
+        programIndicatorSubqueryBuilder,
+        executionPlanStore,
+        organisationUnitResolver);
     this.timeFieldSqlRenderer = timeFieldSqlRenderer;
   }
 

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

@@ -0,0 +1,130 @@
+/*
+ * Copyright (c) 2004-2025, University of Oslo
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * Neither the name of the HISP project nor the names of its contributors may
+ * be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package org.hisp.dhis.analytics.event.data;
+
+import static org.hisp.dhis.common.DimensionalObject.OPTION_SEP;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+import lombok.RequiredArgsConstructor;
+import org.apache.commons.lang3.StringUtils;
+import org.hisp.dhis.analytics.data.DimensionalObjectProducer;
+import org.hisp.dhis.analytics.event.EventQueryParams;
+import org.hisp.dhis.common.MetadataItem;
+import org.hisp.dhis.common.QueryFilter;
+import org.hisp.dhis.common.QueryItem;
+import org.hisp.dhis.organisationunit.OrganisationUnit;
+import org.hisp.dhis.organisationunit.OrganisationUnitService;
+import org.springframework.stereotype.Service;
+
+@RequiredArgsConstructor
+@Service
+public class OrganisationUnitResolver {
+
+  private final DimensionalObjectProducer dimensionalObjectProducer;
+
+  private final OrganisationUnitService organisationUnitService;
+
+  /**
+   * Resolve organisation units like ou:USER_ORGUNIT;USER_ORGUNIT_CHILDREN;LEVEL-XXX;OUGROUP-XXX
+   * into a list of organisation unit dimension uids.
+   *
+   * @param queryFilter the query filter containing the organisation unit filter
+   * @param userOrgUnits the user organisation units
+   * @return the organisation unit dimension uids
+   */
+  public String resolveOrgUnits(QueryFilter queryFilter, List<OrganisationUnit> userOrgUnits) {
+    List<String> filterItem = QueryFilter.getFilterItems(queryFilter.getFilter());
+    List<String> orgUnitDimensionUid =
+        dimensionalObjectProducer.getOrgUnitDimensionUid(filterItem, userOrgUnits);
+    return String.join(OPTION_SEP, orgUnitDimensionUid);
+  }
+
+  /**
+   * Returns a map of metadata item identifiers and {@link MetadataItem} for organisation unit data
+   * elements.
+   *
+   * @param params the {@link EventQueryParams}.
+   * @return a map.
+   */
+  public Map<String, MetadataItem> getMetadataItemsForOrgUnitDataElements(EventQueryParams params) {
+    List<String> orgUnitIds = new ArrayList<>();
+    for (QueryItem queryItem : params.getItems()) {
+      if (queryItem.getValueType().isOrganisationUnit()) {
+        for (QueryFilter queryFilter : queryItem.getFilters()) {
+          String resolveOrgUnits = resolveOrgUnits(queryFilter, params.getUserOrgUnits());
+          if (StringUtils.isNotBlank(resolveOrgUnits)) {
+            orgUnitIds.addAll(Arrays.asList(resolveOrgUnits.split(OPTION_SEP)));
+          }
+        }
+      }
+    }
+
+    if (orgUnitIds.isEmpty()) {
+      return Map.of();
+    }
+
+    return organisationUnitService.getOrganisationUnitsByUid(orgUnitIds).stream()
+        .collect(
+            Collectors.toMap(OrganisationUnit::getUid, orgUnit -> toMetadataItem(orgUnit, params)));
+  }
+
+  /**
+   * Returns a {@link MetadataItem} based on the given organisation unit and query parameters.
+   *
+   * @param orgUnit the {@link OrganisationUnit}.
+   * @param params the {@link EventQueryParams}.
+   * @return a {@link MetadataItem}.
+   */
+  private MetadataItem toMetadataItem(OrganisationUnit orgUnit, EventQueryParams params) {
+    return new MetadataItem(
+        orgUnit.getDisplayProperty(params.getDisplayProperty()),
+        params.isIncludeMetadataDetails() ? orgUnit.getUid() : null,
+        orgUnit.getCode());
+  }
+
+  /**
+   * Resolve organisation units like ou:USER_ORGUNIT;USER_ORGUNIT_CHILDREN;LEVEL-XXX;OUGROUP-XXX
+   * into a list of organisation unit dimension uids.
+   *
+   * @param params the event query parameters
+   * @param item the query item
+   * @return the list of organisation unit dimension uids
+   */
+  public List<String> resolveOrgUnis(EventQueryParams params, QueryItem item) {
+    return item.getFilters().stream()
+        .map(queryFilter -> resolveOrgUnits(queryFilter, params.getUserOrgUnits()))
+        .map(s -> s.split(OPTION_SEP))
+        .flatMap(Arrays::stream)
+        .distinct()
+        .collect(Collectors.toList());
+  }
+}

dhis-2/dhis-services/dhis-service-analytics/src/test/java/org/hisp/dhis/analytics/event/data/AbstractAnalyticsServiceTest.java

@@ -90,10 +90,13 @@ class AbstractAnalyticsServiceTest {
 
   @Mock private SchemaIdResponseMapper schemaIdResponseMapper;
 
+  @Mock private OrganisationUnitResolver organisationUnitResolver;
+
   @BeforeEach
   public void setUp() {
     dummyAnalyticsService =
-        new DummyAnalyticsService(securityManager, eventQueryValidator, schemaIdResponseMapper);
+        new DummyAnalyticsService(
+            securityManager, eventQueryValidator, schemaIdResponseMapper, organisationUnitResolver);
 
     peA = MonthlyPeriodType.getPeriodFromIsoString("201701");
     ouA = createOrganisationUnit('A');
@@ -249,8 +252,9 @@ class DummyAnalyticsService extends AbstractAnalyticsService {
   public DummyAnalyticsService(
       AnalyticsSecurityManager securityManager,
       EventQueryValidator queryValidator,
-      SchemaIdResponseMapper schemaIdResponseMapper) {
-    super(securityManager, queryValidator, schemaIdResponseMapper);
+      SchemaIdResponseMapper schemaIdResponseMapper,
+      OrganisationUnitResolver organisationUnitResolver) {
+    super(securityManager, queryValidator, schemaIdResponseMapper, organisationUnitResolver);
   }
 
   @Override