feat: Introduce preferred search operators on TEA [DHIS2-12183] #21376

muilpp · 2025-07-09T14:00:00Z

This PR introduces the preferred search operator field on a TEA.
It's an optional field that's added to the TEA to define the recommended operator for search or comparison.
This is merely a suggestion for the end user and will not be enforced.

Ticket: https://dhis2.atlassian.net/browse/DHIS2-12183

…183]

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/QueryOperator.java

ameenhere · 2025-07-15T11:32:58Z

...a/org/hisp/dhis/dxf2/metadata/objectbundle/hooks/TrackedEntityAttributeObjectBundleHook.java

@@ -71,6 +71,11 @@ public void validate(
                "Not a valid TextPattern 'TEXT' segment."));
      }
    }
+
+    if (attr.getPreferredSearchOperator() != null) {


I dont think we should support "accepting" the I variant as the preferredSearchOperator. Let us validate and block that.

On the other hand, I variants will be accepted as allowed operators, mostly to avoid breaking the API, right?
As I understand it, I variant operators should not be used in Tracker, but we don’t (or can’t) enforce this rule.
Wouldn’t it be more consistent to accept these operators in both the preferred and allowed fields until we find a better solution?

We should not accept I-variants to be accepted in preferred or allowed/blockedOperators.

Let us block it as part of TEA metadata saving validation. Either we block it, or we "map it" to the Tracker Operator variant before persistence. I am in favour of blocking it.

In the UI, only the Tracker Operators (non-i variants) will be used anyway.

In the actual Export API, we do the "Mapping of I-variant to Tracker Variant" before the preferred/allowed operator validation kicks in.

ameenhere · 2025-07-15T11:36:04Z

.../src/main/resources/org/hisp/dhis/db/migration/2.43/V2_43_11__add_tea_preferred_operator.sql

@@ -0,0 +1,3 @@
+-- Migration script to add the field preferred operator in the trackedentityattribute table
+alter table trackedentityattribute


Can you migrate from a 2.41 instance directly into this branch build and see if any issue show up?
The reason I am asking is, if we have separate migration files dealing with the same alter table , there might be issues with keeping all of it in a single transaction. So just try it out. The test should cover running both this migration, and the minsearchcharacters migration in a single migration attempt.

During development I tried a few times and it worked.
I imported a 2.41 database (no minsearchcharacters no preferredsearchoperator present), and after the migration, both fields are present in the database.

ameenhere · 2025-07-15T11:37:17Z

dhis-2/dhis-test-integration/src/test/resources/tracker/te_with_tea_metadata.json

@@ -90,6 +91,7 @@
      "translations": [],
      "attributeValues": [],
      "legendSets": [],
+      "preferredSearchOperator": "IEQ",


The I variant operators should not be allowed to be preferredSearchOperator. Since this is a new feature, we will not be breaking anything. So let us block this in this PR.

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/QueryOperator.java

…or.java Co-authored-by: Enrico Colasante <[email protected]>

ameenhere

Overall LGTM. Only comment is to block preferredSearchOperator having any I-variant operator. (And for the other issue for allowedOperators as wel the same blocking of I-variant should happen)

…2-12183]

sonarqubecloud · 2025-07-18T09:57:34Z

Quality Gate failed

Failed conditions
1 New issue
1 New Code Smells (required ≤ 0)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

ameenhere

Minnor nitpicky comments. Feel free to decide if you want to include it or not.

ameenhere · 2025-07-18T12:27:34Z

dhis-2/dhis-api/src/main/java/org/hisp/dhis/feedback/ErrorCode.java

@@ -331,6 +331,7 @@ public enum ErrorCode {
  E4079(
      "Program `{0}` category mapping `{1}` has multiple option mappings for Category Option `{2}`"),
  E4080("Program `{0}` category mapping `{1}` has an invalid option mapping `{1}`"),
+  E4081("The provided preferred TEA operator `{0}` is not part of the tracker operators `{1}`"),


Suggested change

E4081("The provided preferred TEA operator `{0}` is not part of the tracker operators `{1}`"),

E4081("The provided preferred TEA operator `{0}` is not part of supported tracker operators `{1}`"),

ameenhere · 2025-07-18T12:33:40Z

...main/java/org/hisp/dhis/tracker/export/trackedentity/TrackedEntityOperationParamsMapper.java

@@ -208,8 +208,8 @@ private void mapAttributeFilters(
                || queryFilter.getFilter().length() < tea.getMinCharactersToSearch())) {
          throw new IllegalQueryException(
              String.format(
-                  "At least %d character(s) should be present in the filter to start a search, but the filter for operator %s doesn't contain enough.",
-                  tea.getMinCharactersToSearch(), queryFilter.getOperator()));
+                  "At least %d character(s) should be present in the filter to start a search, but the filter for the TEA %s doesn't contain enough.",


Nitpicky: Do we actually use TEA and TET in error messages? Or do we want to use the full "Tracked Entity Attribute" ?

I'll change the message in the coming PR

muilpp added 5 commits July 9, 2025 15:59

feat: Introduce preferred search operators on TEA [DHIS2-12183]

3660a01

feat: Set null if attribute doesnt specify default operator [DHIS2-12…

a08391f

…183]

feat: Map case insensitive operators to case sensitive [DHIS2-12183]

a64c823

feat: Map case insensitive operators to case sensitive [DHIS2-12183]

3f097ed

feat: Add column if not exists [DHIS2-12183]

d6f3c8c

muilpp marked this pull request as ready for review July 15, 2025 08:26

muilpp requested a review from a team as a code owner July 15, 2025 08:26

muilpp requested review from ameenhere, enricocolasante and teleivo July 15, 2025 08:26

ameenhere reviewed Jul 15, 2025

View reviewed changes

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/QueryOperator.java Outdated Show resolved Hide resolved

ameenhere reviewed Jul 15, 2025

View reviewed changes

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/QueryOperator.java Outdated Show resolved Hide resolved

ameenhere reviewed Jul 15, 2025

View reviewed changes

feat: Address PR comments [DHIS2-12183]

32ee608

enricocolasante approved these changes Jul 15, 2025

View reviewed changes

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/QueryOperator.java Outdated Show resolved Hide resolved

muilpp requested a review from ameenhere July 15, 2025 13:24

Update dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/QueryOperat…

0b69926

…or.java Co-authored-by: Enrico Colasante <[email protected]>

muilpp enabled auto-merge (squash) July 15, 2025 13:38

ameenhere requested changes Jul 17, 2025

View reviewed changes

muilpp added 2 commits July 18, 2025 11:30

feat: Block I-variant operators to be set as preferred operator [DHIS…

09141b0

…2-12183]

feat: Merge if statements [DHIS2-12183]

0ff03d6

muilpp requested a review from ameenhere July 18, 2025 09:50

feat: Remove unused method [DHIS2-12183]

8e7173a

ameenhere approved these changes Jul 18, 2025

View reviewed changes

muilpp merged commit 8cf2e13 into master Jul 18, 2025
15 of 16 checks passed

muilpp deleted the DHIS-12183-tea-preferred-operator branch July 18, 2025 12:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Introduce preferred search operators on TEA [DHIS2-12183] #21376

feat: Introduce preferred search operators on TEA [DHIS2-12183] #21376

Uh oh!

muilpp commented Jul 9, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

ameenhere Jul 15, 2025

Uh oh!

muilpp Jul 15, 2025 •

edited

Loading

Uh oh!

ameenhere Jul 17, 2025

Uh oh!

ameenhere Jul 15, 2025 •

edited

Loading

Uh oh!

muilpp Jul 15, 2025

Uh oh!

ameenhere Jul 15, 2025

Uh oh!

Uh oh!

ameenhere left a comment

Uh oh!

sonarqubecloud bot commented Jul 18, 2025

Uh oh!

ameenhere left a comment

Uh oh!

ameenhere Jul 18, 2025

Uh oh!

ameenhere Jul 18, 2025

Uh oh!

muilpp Jul 18, 2025

Uh oh!

Uh oh!

Uh oh!

		@@ -0,0 +1,3 @@
		-- Migration script to add the field preferred operator in the trackedentityattribute table
		alter table trackedentityattribute

	E4081("The provided preferred TEA operator `{0}` is not part of the tracker operators `{1}`"),
	E4081("The provided preferred TEA operator `{0}` is not part of supported tracker operators `{1}`"),

feat: Introduce preferred search operators on TEA [DHIS2-12183] #21376

feat: Introduce preferred search operators on TEA [DHIS2-12183] #21376

Uh oh!

Conversation

muilpp commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ameenhere Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

muilpp Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ameenhere Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

ameenhere Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

muilpp Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

ameenhere Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ameenhere left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Jul 18, 2025

Quality Gate failed

Uh oh!

ameenhere left a comment

Choose a reason for hiding this comment

Uh oh!

ameenhere Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

ameenhere Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

muilpp Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

muilpp commented Jul 9, 2025 •

edited

Loading

muilpp Jul 15, 2025 •

edited

Loading

ameenhere Jul 15, 2025 •

edited

Loading