feat: Migrate TEA change logs into new table [DHIS2-18474] #19321
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| <?xml version="1.0"?> | ||
| <!DOCTYPE hibernate-mapping PUBLIC | ||
| "-//Hibernate/Hibernate Mapping DTD 3.0//EN" | ||
| "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd"> | ||
|
|
||
| <hibernate-mapping> | ||
| <class name="org.hisp.dhis.tracker.export.trackedentity.TrackedEntityChangeLog" | ||
| table="trackedentitychangelog"> | ||
|
|
||
| <id name="id" column="trackedentitychangelogid"> | ||
| <generator class="sequence"> | ||
| <param name="sequence_name">trackedentitychangelog_sequence</param> | ||
| </generator> | ||
| </id> | ||
|
|
||
| <many-to-one name="trackedEntity" class="org.hisp.dhis.trackedentity.TrackedEntity" | ||
| column="trackedentityid" | ||
| foreign-key="fk_trackedentitychangelog_trackedentityinstanceid" not-null="true"/> | ||
|
|
||
| <many-to-one name="trackedEntityAttribute" class="org.hisp.dhis.trackedentity.TrackedEntityAttribute" | ||
| column="trackedentityattributeid" | ||
| foreign-key="fk_trackedentitychangelog_trackedentityattributeid" not-null="true"/> | ||
|
|
||
| <property name="previousValue" column="previousvalue" access="property" length="50000"/> | ||
|
|
||
| <property name="currentValue" column="currentvalue" access="property" length="50000"/> | ||
|
|
||
| <property name="changeLogType" column="changelogtype" length="100" not-null="true"> | ||
| <type name="org.hibernate.type.EnumType"> | ||
| <param name="enumClass">org.hisp.dhis.changelog.ChangeLogType</param> | ||
| <param name="useNamed">true</param> | ||
| <param name="type">12</param> | ||
| </type> | ||
| </property> | ||
|
|
||
| <property name="created" type="timestamp" not-null="true"/> | ||
|
|
||
| <property name="createdByUsername" column="createdby" type="string"/> | ||
|
|
||
| <many-to-one name="createdBy" class="org.hisp.dhis.user.User" column="createdby" insert="false" | ||
| update="false" property-ref="username"/> | ||
|
|
||
| <many-to-one name="programAttribute" class="org.hisp.dhis.program.ProgramTrackedEntityAttribute" | ||
| column="trackedentityattributeid" insert="false" update="false" access="field" property-ref="attribute" /> | ||
|
There was a problem hiding this comment. Just making sure that "trackedentityattributeid" was indeed the intention here. Even for ProgramAttribute? There was a problem hiding this comment. That's intentional, if not Hibernate uses by default the |
||
| </class> | ||
| </hibernate-mapping> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,207 @@ | ||
| /* | ||
| * Copyright (c) 2004-2024, 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.trackedentity; | ||
|
|
||
| import static java.util.Map.entry; | ||
|
|
||
| import jakarta.persistence.EntityManager; | ||
| import jakarta.persistence.Query; | ||
| import java.util.Date; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import javax.annotation.Nonnull; | ||
| import javax.annotation.Nullable; | ||
| import org.hibernate.Session; | ||
| import org.hisp.dhis.changelog.ChangeLogType; | ||
| import org.hisp.dhis.common.SortDirection; | ||
| import org.hisp.dhis.common.UID; | ||
| import org.hisp.dhis.program.UserInfoSnapshot; | ||
| import org.hisp.dhis.trackedentity.TrackedEntity; | ||
| import org.hisp.dhis.trackedentity.TrackedEntityAttribute; | ||
| import org.hisp.dhis.tracker.export.Order; | ||
| import org.hisp.dhis.tracker.export.Page; | ||
| import org.hisp.dhis.tracker.export.PageParams; | ||
| import org.springframework.stereotype.Repository; | ||
|
|
||
| @Repository("org.hisp.dhis.tracker.export.trackedentity.HibernateTrackedEntityChangeLogStore") | ||
| public class HibernateTrackedEntityChangeLogStore { | ||
| private static final String COLUMN_CHANGELOG_CREATED = "tecl.created"; | ||
| private static final String DEFAULT_ORDER = | ||
| COLUMN_CHANGELOG_CREATED + " " + SortDirection.DESC.getValue(); | ||
|
|
||
| private static final Map<String, String> ORDERABLE_FIELDS = | ||
| Map.ofEntries(entry("createdAt", COLUMN_CHANGELOG_CREATED)); | ||
|
|
||
| private final EntityManager entityManager; | ||
| private final Session session; | ||
|
|
||
| public HibernateTrackedEntityChangeLogStore(EntityManager entityManager) { | ||
| this.entityManager = entityManager; | ||
| this.session = entityManager.unwrap(Session.class); | ||
| } | ||
|
|
||
| public void addTrackedEntityChangeLog(TrackedEntityChangeLog trackedEntityChangeLog) { | ||
| session.save(trackedEntityChangeLog); | ||
| } | ||
|
|
||
| public Page<TrackedEntityChangeLog> getTrackedEntityChangeLogs( | ||
| @Nonnull UID trackedEntity, | ||
| @Nullable UID program, | ||
| @Nonnull Set<String> attributes, | ||
muilpp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| @Nonnull TrackedEntityChangeLogOperationParams operationParams, | ||
| @Nonnull PageParams pageParams) { | ||
|
|
||
| String hql = | ||
| """ | ||
| select tecl.trackedEntity, | ||
| tecl.trackedEntityAttribute, | ||
| tecl.previousValue, | ||
| tecl.currentValue, | ||
| tecl.changeLogType, | ||
| tecl.created, | ||
| tecl.createdByUsername, | ||
| u.firstName, | ||
| u.surname, | ||
| u.uid | ||
| from TrackedEntityChangeLog tecl | ||
| join tecl.trackedEntity t | ||
| join tecl.trackedEntityAttribute tea | ||
| left join tecl.createdBy u | ||
| """; | ||
|
|
||
| if (program != null) { | ||
| hql += | ||
| """ | ||
| join tecl.programAttribute pa | ||
| join pa.program p | ||
| where tecl.changeLogType in ('CREATE', 'UPDATE', 'DELETE') | ||
teleivo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| and t.uid = :trackedEntity | ||
| and p.uid = :program | ||
| """; | ||
|
|
||
| } else { | ||
| hql += | ||
| """ | ||
| where tecl.changeLogType in ('CREATE', 'UPDATE', 'DELETE') | ||
| and t.uid = :trackedEntity | ||
| """; | ||
| } | ||
|
|
||
| if (!attributes.isEmpty()) { | ||
| hql += | ||
| """ | ||
| and tea.uid in (:attributes) | ||
| """; | ||
| } | ||
|
|
||
| hql += String.format("order by %s".formatted(sortExpressions(operationParams.getOrder()))); | ||
|
||
|
|
||
| Query query = entityManager.createQuery(hql); | ||
| query.setParameter("trackedEntity", trackedEntity.getValue()); | ||
|
|
||
| if (program != null) { | ||
| query.setParameter("program", program.getValue()); | ||
| } | ||
|
|
||
| if (!attributes.isEmpty()) { | ||
| query.setParameter("attributes", attributes); | ||
| } | ||
|
|
||
| query.setFirstResult((pageParams.getPage() - 1) * pageParams.getPageSize()); | ||
| query.setMaxResults(pageParams.getPageSize() + 1); | ||
|
|
||
| List<Object[]> results = query.getResultList(); | ||
| List<TrackedEntityChangeLog> trackedEntityChangeLogs = | ||
| results.stream() | ||
| .map( | ||
| row -> { | ||
| TrackedEntity t = (TrackedEntity) row[0]; | ||
| TrackedEntityAttribute trackedEntityAttribute = (TrackedEntityAttribute) row[1]; | ||
| String previousValue = (String) row[2]; | ||
| String currentValue = (String) row[3]; | ||
| ChangeLogType changeLogType = (ChangeLogType) row[4]; | ||
| Date created = (Date) row[5]; | ||
|
|
||
| UserInfoSnapshot createdBy = | ||
| new UserInfoSnapshot((String) row[6], (String) row[7], (String) row[8]); | ||
| createdBy.setUid((String) row[9]); | ||
|
|
||
| return new TrackedEntityChangeLog( | ||
| t, | ||
| trackedEntityAttribute, | ||
| previousValue, | ||
| currentValue, | ||
| changeLogType, | ||
| created, | ||
| createdBy); | ||
| }) | ||
| .toList(); | ||
|
|
||
| Integer prevPage = pageParams.getPage() > 1 ? pageParams.getPage() - 1 : null; | ||
| if (trackedEntityChangeLogs.size() > pageParams.getPageSize()) { | ||
| return Page.withPrevAndNext( | ||
| trackedEntityChangeLogs.subList(0, pageParams.getPageSize()), | ||
| pageParams.getPage(), | ||
| pageParams.getPageSize(), | ||
| prevPage, | ||
| pageParams.getPage() + 1); | ||
| } | ||
|
|
||
| return Page.withPrevAndNext( | ||
| trackedEntityChangeLogs, pageParams.getPage(), pageParams.getPageSize(), prevPage, null); | ||
| } | ||
|
|
||
| public void deleteTrackedEntityChangeLogs(TrackedEntity trackedEntity) { | ||
| org.hibernate.query.Query<?> query = | ||
| session.createQuery("delete TrackedEntityChangeLog where trackedEntity = :trackedEntity"); | ||
| query.setParameter("trackedEntity", trackedEntity); | ||
| query.executeUpdate(); | ||
| } | ||
|
|
||
| public Set<String> getOrderableFields() { | ||
| return ORDERABLE_FIELDS.keySet(); | ||
| } | ||
|
|
||
| private static String sortExpressions(Order order) { | ||
| if (order == null) { | ||
| return DEFAULT_ORDER; | ||
| } | ||
|
|
||
| StringBuilder orderBuilder = new StringBuilder(); | ||
| orderBuilder.append(ORDERABLE_FIELDS.get(order.getField())); | ||
| orderBuilder.append(" "); | ||
| orderBuilder.append(order.getDirection().getValue()); | ||
|
|
||
| if (!order.getField().equals("createdAt")) { | ||
| orderBuilder.append(", ").append(DEFAULT_ORDER); | ||
| } | ||
|
|
||
| return orderBuilder.toString(); | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't rememver exactly how the conversation ended, but didn't we agree that we were going to use user UID here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We did, but once the platform refactors the user logic so that users can no longer be deleted from the
user_infotable, right? Only disabling a user should be possible.One of the requirements for the change logs is that we'll always show the username, regardless of whether the user is deleted or not. We can't achieve that with the current setup if we use the UID here.