chore: use EnrollmentService in TE service to get enrollements/events DHIS2-18541

dhis-2/dhis-services/dhis-service-core/src/main/resources/org/hisp/dhis/program/hibernate/Enrollment.hbm.xml

@@ -69,7 +69,10 @@
       <one-to-many class="org.hisp.dhis.relationship.RelationshipItem" />
     </set>
 
-    <list name="notes" table="enrollment_notes" cascade="all-delete-orphan">
+<!-- eagerly fetch notes to avoid lazy init exceptions in code outside a hibernate session we do not
+exclude notes like we do other collections if the fields parameter does not contain them like in
+fields=!notes. reconsider this if we do implement that optimization -->
+    <list name="notes" table="enrollment_notes" cascade="all-delete-orphan" lazy="false" fetch="join">
       <key column="enrollmentid" foreign-key="fk_programinstancecomments_programinstanceid" />
       <list-index column="sort_order" base="1" />
       <many-to-many class="org.hisp.dhis.note.Note" column="noteid"

dhis-2/dhis-services/dhis-service-core/src/main/resources/org/hisp/dhis/program/hibernate/Event.hbm.xml

@@ -64,7 +64,10 @@
 
     <property name="eventDataValues" type="jsbEventDataValues" />
 
-    <list name="notes" table="event_notes" cascade="all-delete-orphan">
+<!-- eagerly fetch notes to avoid lazy init exceptions in code outside a hibernate session we do not
+exclude notes like we do other collections if the fields parameter does not contain them like in
+fields=!notes. reconsider this if we do implement that optimization -->
+    <list name="notes" table="event_notes" cascade="all-delete-orphan" lazy="false" fetch="join">
       <key column="eventid" foreign-key="fk_programstageinstancecomments_programstageinstanceid" />
       <list-index column="sort_order" base="1" />
       <many-to-many class="org.hisp.dhis.note.Note" column="noteid"

dhis-2/dhis-services/dhis-service-tracker/src/main/java/org/hisp/dhis/tracker/export/RelationshipItemMapper.java

@@ -0,0 +1,275 @@
+/*
+ * Copyright (c) 2004-2023, 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.tracker.export;
+
+import java.util.List;
+import java.util.Set;
+import org.hisp.dhis.category.CategoryOption;
+import org.hisp.dhis.category.CategoryOptionCombo;
+import org.hisp.dhis.eventdatavalue.EventDataValue;
+import org.hisp.dhis.note.Note;
+import org.hisp.dhis.organisationunit.OrganisationUnit;
+import org.hisp.dhis.program.Enrollment;
+import org.hisp.dhis.program.Event;
+import org.hisp.dhis.program.Program;
+import org.hisp.dhis.program.UserInfoSnapshot;
+import org.hisp.dhis.relationship.Relationship;
+import org.hisp.dhis.relationship.RelationshipItem;
+import org.hisp.dhis.trackedentity.TrackedEntity;
+import org.hisp.dhis.trackedentity.TrackedEntityAttribute;
+import org.hisp.dhis.trackedentity.TrackedEntityProgramOwner;
+import org.hisp.dhis.trackedentityattributevalue.TrackedEntityAttributeValue;
+import org.hisp.dhis.tracker.imports.preheat.mappers.ProgramStageMapper;
+import org.hisp.dhis.tracker.imports.preheat.mappers.RelationshipTypeMapper;
+import org.hisp.dhis.tracker.imports.preheat.mappers.TrackedEntityTypeMapper;
+import org.hisp.dhis.user.User;
+import org.mapstruct.BeanMapping;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.Named;
+
+// TODO(DHIS2-18883) move this into the relationship service/store
+// double-check that we only map whats needed!
+// We need to ensure we map everything the
+// org.hisp.dhis.webapi.controller.tracker.export.relationship.RelationshipItemMapper needs
+@Mapper(
+    uses = {ProgramStageMapper.class, RelationshipTypeMapper.class, TrackedEntityTypeMapper.class})
+public interface RelationshipItemMapper {
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "relationship")
+  @Mapping(target = "trackedEntity")
+  @Mapping(target = "enrollment")
+  @Mapping(target = "event")
+  RelationshipItem map(RelationshipItem relationshipItem);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "relationshipType")
+  @Mapping(target = "created")
+  @Mapping(target = "createdAtClient")
+  @Mapping(target = "lastUpdated")
+  @Mapping(
+      target = "from",
+      source = "from",
+      qualifiedByName = "mapRelationshipItemWithoutRelationship")
+  @Mapping(target = "to", source = "to", qualifiedByName = "mapRelationshipItemWithoutRelationship")
+  Relationship map(Relationship relationship);
+
+  // we need to ignore relationship to break the cycle between relationship and relationshipItem
+  @Named("mapRelationshipItemWithoutRelationship")
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "trackedEntity")
+  @Mapping(target = "enrollment")
+  @Mapping(target = "event")
+  RelationshipItem mapRelationshipItemWithoutRelationship(RelationshipItem relationshipItem);
+
+  // these are needed to make mapstruct map these collections using the entity @Mappers
+  Set<Enrollment> mapEnrollments(Set<Enrollment> enrollments);
+
+  // these are needed to make mapstruct map these collections using the entity @Mappers
+  Set<Event> mapEvents(Set<Event> events);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "trackedEntityType")
+  @Mapping(target = "created")
+  @Mapping(target = "createdAtClient")
+  @Mapping(target = "lastUpdated")
+  @Mapping(target = "lastUpdatedAtClient")
+  @Mapping(target = "organisationUnit")
+  @Mapping(target = "createdByUserInfo")
+  @Mapping(target = "lastUpdatedByUserInfo")
+  @Mapping(target = "trackedEntityAttributeValues")
+  @Mapping(target = "inactive")
+  @Mapping(target = "deleted")
+  @Mapping(target = "potentialDuplicate")
+  @Mapping(target = "enrollments")
+  @Mapping(target = "programOwners")
+  TrackedEntity map(TrackedEntity trackedEntity);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "organisationUnit")
+  @Mapping(target = "program", qualifiedByName = "mapProgramUidOnly")
+  @Mapping(target = "trackedEntity", qualifiedByName = "mapTrackedEntityUidOnly")
+  TrackedEntityProgramOwner map(TrackedEntityProgramOwner programOwner);
+
+  // these are needed to make mapstruct map these collections using the entity @Mappers
+  Set<TrackedEntityProgramOwner> mapTrackedEntityProgramOwners(
+      Set<TrackedEntityProgramOwner> programOwners);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "created")
+  @Mapping(target = "createdAtClient")
+  @Mapping(target = "lastUpdated")
+  @Mapping(target = "lastUpdatedAtClient")
+  @Mapping(target = "trackedEntity", qualifiedByName = "mapTrackedEntityForEnrollment")
+  @Mapping(target = "program")
+  @Mapping(target = "organisationUnit")
+  @Mapping(target = "enrollmentDate")
+  @Mapping(target = "occurredDate")
+  @Mapping(target = "followup")
+  @Mapping(target = "completedDate")
+  @Mapping(target = "createdByUserInfo")
+  @Mapping(target = "lastUpdatedByUserInfo")
+  @Mapping(target = "notes")
+  @Mapping(target = "events")
+  @Mapping(target = "status")
+  @Mapping(target = "deleted")
+  @Mapping(target = "geometry")
+  @Mapping(target = "storedBy")
+  Enrollment map(Enrollment enrollment);
+
+  @Named("mapTrackedEntityForEnrollment")
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "trackedEntityAttributeValues")
+  TrackedEntity mapTrackedEntityForEnrollment(TrackedEntity trackedEntity);
+
+  // these are needed to make mapstruct map these collections using the entity @Mappers
+  Set<TrackedEntityAttributeValue> mapTrackedEntityAttributeValues(
+      Set<TrackedEntityAttributeValue> attributeValue);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "attribute")
+  @Mapping(target = "created")
+  @Mapping(target = "lastUpdated")
+  TrackedEntityAttributeValue map(TrackedEntityAttributeValue attributeValue);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "code")
+  @Mapping(target = "name")
+  @Mapping(target = "valueType")
+  TrackedEntityAttribute map(TrackedEntityAttribute attribute);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "enrollment", qualifiedByName = "mapEnrollmentForEvent")
+  @Mapping(target = "programStage")
+  @Mapping(target = "organisationUnit")
+  @Mapping(target = "occurredDate")
+  @Mapping(target = "scheduledDate")
+  @Mapping(target = "created")
+  @Mapping(target = "createdAtClient")
+  @Mapping(target = "lastUpdated")
+  @Mapping(target = "lastUpdatedAtClient")
+  @Mapping(target = "attributeOptionCombo")
+  @Mapping(target = "completedDate")
+  @Mapping(target = "createdByUserInfo")
+  @Mapping(target = "lastUpdatedByUserInfo")
+  @Mapping(target = "status")
+  @Mapping(target = "eventDataValues")
+  @Mapping(target = "notes")
+  @Mapping(target = "storedBy")
+  @Mapping(target = "deleted")
+  @Mapping(target = "completedBy")
+  @Mapping(target = "assignedUser")
+  @Mapping(target = "geometry")
+  Event map(Event event);
+
+  // relationshipItem.event.enrollment is only exported as UID
+  @Named("mapEnrollmentForEvent")
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "program")
+  @Mapping(target = "followup")
+  Enrollment mapEnrollmentForEvent(Enrollment enrollment);
+
+  // these are needed to make mapstruct map these collections using the entity @Mappers
+  Set<EventDataValue> mapEventDataValues(Set<EventDataValue> eventDataValues);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "created")
+  @Mapping(target = "lastUpdated")
+  @Mapping(target = "createdByUserInfo")
+  @Mapping(target = "lastUpdatedByUserInfo")
+  EventDataValue map(EventDataValue dataValue);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "categoryOptions")
+  CategoryOptionCombo map(CategoryOptionCombo categoryOptionCombo);
+
+  // these are needed to make mapstruct map these collections using the entity @Mappers
+  Set<CategoryOption> mapCategoryOptions(Set<CategoryOption> categoryOptions);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  CategoryOption map(CategoryOption categoryOption);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "code")
+  @Mapping(target = "name")
+  OrganisationUnit map(OrganisationUnit organisationUnit);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "code")
+  @Mapping(target = "name")
+  @Mapping(target = "trackedEntityType")
+  @Mapping(target = "programType")
+  Program map(Program program);
+
+  // programOwner is only exported as UID
+  @Named("mapTrackedEntityUidOnly")
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  TrackedEntity mapTrackedEntityUidOnly(TrackedEntity trackedEntity);
+
+  @Named("mapProgramUidOnly")
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  Program mapProgramUidOnly(Program program);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "username")
+  @Mapping(target = "firstName")
+  @Mapping(target = "surname")
+  User map(User user);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "username")
+  @Mapping(target = "firstName")
+  @Mapping(target = "surname")
+  User map(UserInfoSnapshot user);
+
+  // these are needed to make mapstruct map these collections using the entity @Mappers
+  List<Note> mapNotes(List<Note> notes);
+
+  @BeanMapping(ignoreByDefault = true)
+  @Mapping(target = "uid")
+  @Mapping(target = "created")
+  @Mapping(target = "noteText")
+  @Mapping(target = "lastUpdatedBy")
+  @Mapping(target = "creator")
+  Note map(Note note);
+}

dhis-2/dhis-services/dhis-service-tracker/src/main/java/org/hisp/dhis/tracker/export/enrollment/DefaultEnrollmentService.java

@@ -53,17 +53,21 @@
 import org.hisp.dhis.tracker.acl.TrackerOwnershipManager;
 import org.hisp.dhis.tracker.export.Page;
 import org.hisp.dhis.tracker.export.PageParams;
+import org.hisp.dhis.tracker.export.RelationshipItemMapper;
 import org.hisp.dhis.tracker.export.event.EventOperationParams;
 import org.hisp.dhis.tracker.export.event.EventParams;
 import org.hisp.dhis.tracker.export.event.EventService;
 import org.hisp.dhis.user.UserDetails;
+import org.mapstruct.factory.Mappers;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
 @Transactional(readOnly = true)
 @RequiredArgsConstructor
 @Service("org.hisp.dhis.tracker.export.enrollment.EnrollmentService")
 class DefaultEnrollmentService implements EnrollmentService {
+  private static final RelationshipItemMapper RELATIONSHIP_ITEM_MAPPER =
+      Mappers.getMapper(RelationshipItemMapper.class);
   private final EnrollmentStore enrollmentStore;
 
   private final EventService eventService;
@@ -145,7 +149,6 @@ private Enrollment getEnrollment(
       @Nonnull EnrollmentParams params,
       boolean includeDeleted,
       @Nonnull UserDetails user) {
-
     Enrollment result = new Enrollment();
     result.setId(enrollment.getId());
     result.setUid(enrollment.getUid());
@@ -190,6 +193,7 @@ private Enrollment getEnrollment(
     return result;
   }
 
+  // TODO(DHIS2-18883) move this into the relationship service/store
   private Set<RelationshipItem> getRelationshipItems(
       UserDetails user, Enrollment enrollment, boolean includeDeleted) {
     Set<RelationshipItem> relationshipItems = new HashSet<>();
@@ -198,7 +202,7 @@ private Set<RelationshipItem> getRelationshipItems(
       org.hisp.dhis.relationship.Relationship daoRelationship = relationshipItem.getRelationship();
       if (trackerAccessManager.canRead(user, daoRelationship).isEmpty()
           && (includeDeleted || !daoRelationship.isDeleted())) {
-        relationshipItems.add(relationshipItem);
+        relationshipItems.add(RELATIONSHIP_ITEM_MAPPER.map(relationshipItem));
       }
     }