Skip to content

[2.41] fix: prevent NPE in event report table-layout download when dimensions/items metadata entries are missing #23942

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

Merged
luciano-fiandesio merged 1 commit into from
May 19, 2026
Merged

[2.41] fix: prevent NPE in event report table-layout download when dimensions/items metadata entries are missing #23942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions ...lytics/src/main/java/org/hisp/dhis/analytics/event/data/DefaultEventAnalyticsService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@
* @return grid with table layout.
*/
@SuppressWarnings("unchecked")
private Grid generateOutputGrid(

Check failure on line 303 in dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/event/data/DefaultEventAnalyticsService.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 16 to the 15 allowed. 


See more on https://sonarcloud.io/project/issues?id=dhis2_dhis2-core&issues=AZ4_kI3Rdqq2BUp-87WG&open=AZ4_kI3Rdqq2BUp-87WG&pullRequest=23942
Grid grid,
EventQueryParams params,
List<Map<String, EventAnalyticsDimensionalItem>> rowPermutations,
Expand All @@ -313,7 +313,8 @@
MetadataItem metadataItem =
(MetadataItem) ((Map<String, Object>) grid.getMetaData().get(ITEMS.getKey())).get(row);

String name = StringUtils.defaultIfEmpty(metadataItem.getName(), row);
String name =
metadataItem == null ? row : StringUtils.defaultIfEmpty(metadataItem.getName(), row);
String col = StringUtils.defaultIfEmpty(COLUMN_NAMES.get(row), row);

outputGrid.addHeader(new GridHeader(name, col, ValueType.TEXT, false, true));
Expand Down Expand Up @@ -477,7 +478,7 @@
(List<String>)
((Map<String, Object>) grid.getMetaData().get(DIMENSIONS.getKey())).get(dimension);

if (legendOptions.isEmpty()) {
if (legendOptions == null || legendOptions.isEmpty()) {
List<Legend> legends = eventDimensionalItemObject.getLegendSet().getSortedLegends();

for (Legend legend : legends) {
Expand Down
94 changes: 94 additions & 0 deletions ...cs/src/test/java/org/hisp/dhis/analytics/event/data/DefaultEventAnalyticsServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,14 @@
*/
package org.hisp.dhis.analytics.event.data;

import static org.hisp.dhis.DhisConvenienceTest.createDataElement;
import static org.hisp.dhis.DhisConvenienceTest.createLegend;
import static org.hisp.dhis.DhisConvenienceTest.createLegendSet;
import static org.hisp.dhis.DhisConvenienceTest.createOrganisationUnit;
import static org.hisp.dhis.DhisConvenienceTest.createPeriod;
import static org.hisp.dhis.DhisConvenienceTest.createProgram;
import static org.hisp.dhis.common.DimensionalObjectUtils.getList;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.atMost;
import static org.mockito.Mockito.doNothing;
Expand All @@ -39,7 +43,14 @@
import static org.mockito.Mockito.when;

import com.google.common.collect.Sets;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.hisp.dhis.analytics.AnalyticsMetaDataKey;
import org.hisp.dhis.analytics.AnalyticsSecurityManager;
import org.hisp.dhis.analytics.EventAnalyticsDimensionalItem;
import org.hisp.dhis.analytics.cache.AnalyticsCache;
import org.hisp.dhis.analytics.data.handler.SchemeIdResponseMapper;
import org.hisp.dhis.analytics.event.EnrollmentAnalyticsManager;
Expand All @@ -49,12 +60,19 @@
import org.hisp.dhis.analytics.event.EventQueryPlanner;
import org.hisp.dhis.analytics.event.EventQueryValidator;
import org.hisp.dhis.analytics.table.model.Partitions;
import org.hisp.dhis.common.Grid;
import org.hisp.dhis.common.IdScheme;
import org.hisp.dhis.common.ValueType;
import org.hisp.dhis.common.ValueTypedDimensionalItemObject;
import org.hisp.dhis.dataelement.DataElement;
import org.hisp.dhis.dataelement.DataElementService;
import org.hisp.dhis.legend.Legend;
import org.hisp.dhis.legend.LegendSet;
import org.hisp.dhis.organisationunit.OrganisationUnit;
import org.hisp.dhis.program.Program;
import org.hisp.dhis.system.database.DatabaseInfo;
import org.hisp.dhis.system.database.DatabaseInfoProvider;
import org.hisp.dhis.system.grid.ListGrid;
import org.hisp.dhis.trackedentity.TrackedEntityAttributeService;
import org.hisp.dhis.user.UserService;
import org.junit.jupiter.api.BeforeEach;
Expand Down Expand Up @@ -162,4 +180,80 @@
.withOutputIdScheme(scheme)
.build();
}

@Test
void shouldFallBackToAllLegendsWhenDimensionsMetadataOmitsLegendSetDataElement()
throws Exception {
Legend legendA = createLegend('A', 0.0, 2.0);
Legend legendB = createLegend('B', 2.0, 4.0);
LegendSet legendSet = createLegendSet('A', legendA, legendB);

DataElement dataElement = createDataElement('A');
dataElement.setValueType(ValueType.NUMBER);
dataElement.setLegendSets(List.of(legendSet));

Grid grid = new ListGrid();
grid.getMetaData().put(AnalyticsMetaDataKey.DIMENSIONS.getKey(), new HashMap<String, Object>());

List<EventAnalyticsDimensionalItem> dimensionalItems = new ArrayList<>();

invokeAddEventReportDimensionalItems(dataElement, dimensionalItems, grid, dataElement.getUid());

assertFalse(dimensionalItems.isEmpty());
}

@Test
void shouldNotNpeWhenItemsMetadataOmitsRowDimension() throws Exception {

Check failure on line 206 in dhis-2/dhis-services/dhis-service-analytics/src/test/java/org/hisp/dhis/analytics/event/data/DefaultEventAnalyticsServiceTest.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Add at least one assertion to this test case. 


See more on https://sonarcloud.io/project/issues?id=dhis2_dhis2-core&issues=AZ4_kI7Pdqq2BUp-87WH&open=AZ4_kI7Pdqq2BUp-87WH&pullRequest=23942
String missingDimensionUid = "deUidAAAAA";

Grid grid = new ListGrid();
grid.getMetaData().put(AnalyticsMetaDataKey.ITEMS.getKey(), new HashMap<String, Object>());

EventQueryParams params = new EventQueryParams.Builder().build();

invokeGenerateOutputGrid(grid, params, List.of(), List.of(), List.of(missingDimensionUid));
}

private void invokeAddEventReportDimensionalItems(
ValueTypedDimensionalItemObject item,
List<EventAnalyticsDimensionalItem> dimensionalItems,
Grid grid,
String dimension)
throws Exception {
Method method =
DefaultEventAnalyticsService.class.getDeclaredMethod(
"addEventReportDimensionalItems",
ValueTypedDimensionalItemObject.class,
List.class,
Grid.class,
String.class);
method.setAccessible(true);
method.invoke(defaultEventAnalyticsService, item, dimensionalItems, grid, dimension);
}

private Grid invokeGenerateOutputGrid(
Grid grid,
EventQueryParams params,
List<Map<String, EventAnalyticsDimensionalItem>> rowPermutations,
List<Map<String, EventAnalyticsDimensionalItem>> columnPermutations,
List<String> rowDimensions)
throws Exception {
Method method =
DefaultEventAnalyticsService.class.getDeclaredMethod(
"generateOutputGrid",
Grid.class,
EventQueryParams.class,
List.class,
List.class,
List.class);
method.setAccessible(true);
return (Grid)
method.invoke(
defaultEventAnalyticsService,
grid,
params,
rowPermutations,
columnPermutations,
rowDimensions);
}
}
Loading