fix: /tracker/trackedEntities?order=createdAt DHIS2-15325 [2.39]

[teleivo]

backport of #14631

Note that < 2.40 we have some extra logic affecting the users order param field names. Due to that some field names in TrackedEntityInstanceQueryParams.OrderColumn refer to old tracker field names.

Order field name translation logic

1. The PagingAndSortingCriteria translates from new tracker field names to old tracker ones. These field names are registered in the criteria classes (called RequestParam in master; this translation does not exist >= 2.40).

Here is where the new/old tracker names are registered

dhis2-core/dhis-2/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/event/webrequest/tracker/TrackerTrackedEntityCriteria.java

Lines 147 to 169 in d5afd34

	@Override
	public Optional<String> translateField(String dtoFieldName, boolean isLegacy) {
	return isLegacy
	? translate(
	dtoFieldName, TrackerTrackedEntityCriteria.LegacyDtoToEntityFieldTranslator.values())
	: translate(dtoFieldName, TrackerTrackedEntityCriteria.DtoToEntityFieldTranslator.values());
	}
	/** Dto to database field translator for new tracker Enrollment export controller */
	@RequiredArgsConstructor
	private enum DtoToEntityFieldTranslator implements EntityNameSupplier {
	/**
	* this enum names must be the same as org.hisp.dhis.tracker.domain.TrackedEntity fields, just
	* with different case
	*
	* <p>example: org.hisp.dhis.tracker.domain.TrackedEntity.updatedAtClient --> UPDATED_AT_CLIENT
	*/
	TRACKED_ENTITY("trackedEntityInstance"),
	CREATED_AT("created"),
	UPDATED_AT("lastUpdated");
	@Getter private final String entityName;
	}

I added a test

webapi/controller/event/webrequest/tracker/TrackerTrackedEntityCriteriaTest.java

to show how the translation works.

order=<fieldname> in new tracker endpoints

• are translated to old tracker field names ONLY if there is a registered mapping
• if there is no mapping they are left as is

2. TrackedEntityInstanceQueryParams maps from field names to columns

For example

TRACKEDENTITY("trackedEntityInstance", "uid", MAIN_QUERY_ALIAS),

takes the old tracker field name and maps it to the uid column. This works for old and new tracker as the new tracker name trackedEntity has been translated to trackedEntityInstance in step 1. 😅

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

0.0% Coverage
0.0% Duplication