chore: Rename Event hibernate object to TrackerEvent [DHIS2-19865] #21431

enricocolasante · 2025-07-16T14:00:09Z

Follow up of #21408 work.
Rename Event hibernate object to TrackerEvent.
At this moment we have SingleEvent and TrackerEvent objects with respective mapping that are both pointing to event table.
The PR is huge because Event object is used in a lot of places but there is not so much logic in the PR.

Luckily, OpenAPI is still working the same because view/Event object was annotated with @OpenApi.Shared(name = "TrackerEvent") and now with the renaming everything is just working the same way.

Next steps

Use SingleEvent and TrackerEvent in RelationshipItem and separate columns in relationshipitem table.
Use SingleEvent and TrackerEvent in ProgramNotificationInstance and separate columns in programnotificationinstance table.
Use SingleEvent and TrackerEvent in ProgramMessage and separate columns in programmessage table.
Split eventchangelog table to singleeventchangelog and trackereventchangelog tables
Split event_notes table to singleevent_notes and trackerevent_notes tables
Split event table to trackerevent and singleevent and update all foreign keys and solve all added TODOs

dhis-2/dhis-api/src/main/java/org/hisp/dhis/program/Enrollment.java

...service-tracker/src/main/java/org/hisp/dhis/tracker/imports/preheat/mappers/EventMapper.java

...gration/src/test/java/org/hisp/dhis/program/notification/ProgramNotificationServiceTest.java

dhis-2/dhis-api/src/main/java/org/hisp/dhis/program/TrackerEvent.java

muilpp · 2025-07-22T14:13:17Z

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

@@ -90,19 +90,21 @@ public enum Objects {
  PROGRAM("program", Program.class),
  TRACKEDENTITY("trackedEntity", TrackedEntity.class),
  ENROLLMENT("enrollment", Enrollment.class),
-  EVENT("event", Event.class),
+  EVENT("event", TrackerEvent.class), // Event inclues tracker and single events


Suggested change

EVENT("event", TrackerEvent.class), // Event inclues tracker and single events

EVENT("event", TrackerEvent.class), // Event includes tracker and single events

muilpp · 2025-07-22T14:13:48Z

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

@@ -90,19 +90,21 @@ public enum Objects {
  PROGRAM("program", Program.class),
  TRACKEDENTITY("trackedEntity", TrackedEntity.class),
  ENROLLMENT("enrollment", Enrollment.class),
-  EVENT("event", Event.class),
+  EVENT("event", TrackerEvent.class), // Event inclues tracker and single events


why are both types of event included if only the TrackerEvent class is used?

Class field is only used in tests and do not represent the type that is going to be used. I deprecated the field clazz for this class.
The string event is what it is used and now it includes all entities in table event, later it will include all entities from tables trackerevent and singleevent.

ameenhere · 2025-07-23T07:19:37Z

.../main/java/org/hisp/dhis/merge/category/optioncombo/DataCategoryOptionComboMergeHandler.java

@@ -182,7 +182,7 @@ public void handleEvents(
          "delete from event where attributeoptioncomboid in (%s)".formatted(aocIds));
    } else {
      log.info("Merging source events as dataMergeStrategy is LAST_UPDATED");
-
+      // TODO(DHIS2-19702): Should we consider single events?


Yes. At the moment it is possible to have AOC in both Single Event and Tracker Event.
So I think we should handle it.

I have a few comments like this in this PR.
Right now things are working because we have all the events in one table, but when we separate the table, we need to take care of those cases.
The question is quite rhetorical.

ameenhere · 2025-07-23T07:23:21Z

...on/src/main/java/org/hisp/dhis/merge/dataelement/handler/TrackerDataElementMergeHandler.java

   * @param request merge request
   */
  public void handleEventDataValues(
      List<DataElement> sources, DataElement target, MergeRequest request) {
    Set<UID> sourceDeUids = UID.of(sources.toArray(new DataElement[0]));
    DataMergeStrategy mergeStrategy = request.getDataMergeStrategy();

+    // TODO(DHIS2-19702): Should we consider single events


I think we should handle single events here as well. Since data elements could be either for Tracker or for Single Events.

Will do in DHIS2-19702.
Right now things are working because there is only one event table.

ameenhere · 2025-07-23T07:26:36Z

...dministration/src/main/java/org/hisp/dhis/split/orgunit/handler/DataOrgUnitSplitHandler.java

    migrate(request, "Enrollment", PARAM_ORG_UNIT);
+    // TODO(DHIS2-19702): should we consider single events?


Will do in DHIS2-19702.
Right now things are working because there is only one event table.

ameenhere · 2025-07-23T07:35:55Z

...rvice-reporting/src/main/java/org/hisp/dhis/datastatistics/DefaultDataStatisticsService.java

@@ -237,12 +237,16 @@ public DataSummary getSystemStatisticsSummary() {
    dataValueCount.put(30, dataValueService.getDataValueCount(30));
    statistics.setDataValueCount(dataValueCount);

+    // TODO(DHIS2-19702): Should we consider single events?


Yes. I would also suggest we can expand the data statistics response to include trackerEvent count and singleEvent count separately (in addition to setting the existing eventCount as the sum for backward compatibility).

Will do in DHIS2-19702.
Right now things are working because there is only one event table.
We can have separate and aggregated statistics. Will do when we are separating tables.

ameenhere · 2025-07-23T07:46:12Z

...his-service-tracker/src/main/java/org/hisp/dhis/tracker/acl/DefaultTrackerAccessManager.java

@@ -401,7 +402,7 @@ public List<String> canCreate(

  @Override
  public List<String> canUpdate(
-      @Nonnull UserDetails user, Event event, boolean skipOwnershipCheck) {
+      @Nonnull UserDetails user, TrackerEvent event, boolean skipOwnershipCheck) {


SingleEvent access check already handled separately? Then this method could be further simplified maybe

Yes, there is already a canRead for both types.
canUpdate is only used when checking relationships, it will come in next PR where I am fixing relationshipItem modeling.

sonarqubecloud · 2025-07-23T07:57:59Z

Quality Gate failed

Failed conditions
15 New issues
15 New Code Smells (required ≤ 0)
1 New Critical Issues (required ≤ 0)

See analysis details on SonarQube Cloud

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

ameenhere

One thing that was not clear to me, but maybe already handled/planned to handle is ProgramMessage and ProgramNotification for Single Events. Maybe you already have it in your mind.

enricocolasante · 2025-07-23T09:23:49Z

One thing that was not clear to me, but maybe already handled/planned to handle is ProgramMessage and ProgramNotification for Single Events. Maybe you already have it in your mind.

Yes, it is present in next step section in the description.

github-advanced-security bot found potential problems Jul 16, 2025

View reviewed changes

enricocolasante force-pushed the DHIS2-19865-rename branch 3 times, most recently from cd73ea7 to e51d901 Compare July 18, 2025 08:04

enricocolasante changed the title ~~chore: Create SingleEvent hibernate object [DHIS2-19865]~~ chore: Rename Event hibernate object to TrackerEvent [DHIS2-19865] Jul 18, 2025

chore: Rename Event hibernate object to TrackerEvent [DHIS2-19865]

fab8a7b

enricocolasante force-pushed the DHIS2-19865-rename branch from e51d901 to fab8a7b Compare July 18, 2025 08:13

enricocolasante added 2 commits July 21, 2025 10:29

Clean up

9ad988c

Fix code review comments

d4d9d13

github-advanced-security bot found potential problems Jul 21, 2025

View reviewed changes

enricocolasante added 2 commits July 22, 2025 13:39

Clean up

0059d6d

Merge remote-tracking branch 'origin/master' into DHIS2-19865-rename

1eabf28

enricocolasante marked this pull request as ready for review July 22, 2025 11:40

enricocolasante requested a review from a team as a code owner July 22, 2025 11:40

enricocolasante requested review from ameenhere, muilpp and teleivo July 22, 2025 11:40

Clean up

25e5006

muilpp approved these changes Jul 22, 2025

View reviewed changes

ameenhere reviewed Jul 23, 2025

View reviewed changes

Fix code review comments

e376d80

enricocolasante requested a review from ameenhere July 23, 2025 07:53

ameenhere approved these changes Jul 23, 2025

View reviewed changes

enricocolasante merged commit bbbf2bc into master Jul 23, 2025
15 of 16 checks passed

enricocolasante deleted the DHIS2-19865-rename branch July 23, 2025 09:24

	EVENT("event", TrackerEvent.class), // Event inclues tracker and single events
	EVENT("event", TrackerEvent.class), // Event includes tracker and single events

		migrate(request, "Enrollment", PARAM_ORG_UNIT);
		// TODO(DHIS2-19702): should we consider single events?

chore: Rename Event hibernate object to TrackerEvent [DHIS2-19865] #21431

chore: Rename Event hibernate object to TrackerEvent [DHIS2-19865] #21431

Conversation

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ameenhere Jul 23, 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!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Jul 23, 2025

Quality Gate failed

Uh oh!

ameenhere left a comment

Choose a reason for hiding this comment

Uh oh!

enricocolasante commented Jul 23, 2025

Uh oh!

Uh oh!

Uh oh!

enricocolasante commented Jul 16, 2025 •

edited

Loading

ameenhere Jul 23, 2025 •

edited

Loading