Merge pull request #115 from dhis2/legacy-update

chore: Upgrade to next snapshot for legacy branch
dhis2 · Oct 16, 2024 · ad638af · ad638af
2 parents 4afaaa4 + 49fc450
commit ad638af
Show file tree

Hide file tree

Showing 28 changed files with 452 additions and 240 deletions.
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>org.hisp.dhis.rules</groupId>
     <artifactId>rule-engine</artifactId>
-    <version>2.1.8.0-SNAPSHOT</version>
+    <version>2.1.8.2-SNAPSHOT</version>
     <packaging>jar</packaging>
     <name>rule-engine</name>
 

diff --git a/src/main/java/org/hisp/dhis/rules/RuleVariableValue.java b/src/main/java/org/hisp/dhis/rules/RuleVariableValue.java
@@ -22,15 +22,15 @@ public abstract class RuleVariableValue implements VariableValue
     @Nonnull
     public static RuleVariableValue create( @Nonnull RuleValueType ruleValueType )
     {
-        return new AutoValue_RuleVariableValue( null, ruleValueType, List.of(), getFormattedDate( new Date() ) );
+        return new AutoValue_RuleVariableValue( null, ruleValueType, List.of(), null );
     }
 
     @Nonnull
     public static RuleVariableValue create( @Nonnull String value,
         @Nonnull RuleValueType ruleValueType )
     {
         return new AutoValue_RuleVariableValue( value, ruleValueType,
-            List.of(), getFormattedDate( new Date() ) );
+            List.of(), null );
     }
 
     @Nonnull

diff --git a/src/main/java/org/hisp/dhis/rules/RuleVariableValueMapBuilder.java b/src/main/java/org/hisp/dhis/rules/RuleVariableValueMapBuilder.java
@@ -220,9 +220,9 @@ private Map<String, RuleAttributeValue> buildCurrentEnrollmentValues()
         return currentEnrollmentValues;
     }
 
-    private Map<String, List<RuleDataValue>> buildAllEventValues()
+    private Map<String, List<RuleDataValueHistory>> buildAllEventValues()
     {
-        Map<String, List<RuleDataValue>> allEventsValues = new HashMap<>();
+        Map<String, List<RuleDataValueHistory>> allEventsValues = new HashMap<>();
         List<RuleEvent> events = new ArrayList<>( ruleEvents );
 
         if ( ruleEvent != null )
@@ -242,17 +242,22 @@ private Map<String, List<RuleDataValue>> buildAllEventValues()
 
             for ( int j = 0; j < ruleEvent.dataValues().size(); j++ )
             {
-                RuleDataValue ruleDataValue = ruleEvent.dataValues().get( j );
+                RuleDataValue ruleDataValue = ruleEvent.dataValues().get(j);
+                RuleDataValueHistory ruleDataValueHistory = new RuleDataValueHistory(
+                        ruleDataValue.value(),
+                        ruleEvent.eventDate(),
+                        ruleEvent.createdDate(),
+                        ruleEvent.programStage() );
 
                 // push new list if it is not there for the given data element
                 if ( !allEventsValues.containsKey( ruleDataValue.dataElement() ) )
                 {
                     allEventsValues.put( ruleDataValue.dataElement(),
-                        new ArrayList<RuleDataValue>( events.size() ) ); //NOPMD
+                        new ArrayList<RuleDataValueHistory>( events.size() ) ); //NOPMD
                 }
 
                 // append data value to the list
-                allEventsValues.get( ruleDataValue.dataElement() ).add( ruleDataValue );
+                allEventsValues.get( ruleDataValue.dataElement() ).add( ruleDataValueHistory );
             }
         }
 
@@ -377,7 +382,7 @@ private Map<String, RuleVariableValue> buildRuleVariableValues()
         Map<String, RuleVariableValue> valueMap = new HashMap<>();
 
         // map data values within all events to data elements
-        Map<String, List<RuleDataValue>> allEventValues = buildAllEventValues();
+        Map<String, List<RuleDataValueHistory>> allEventValues = buildAllEventValues();
 
         // map tracked entity attributes to values from enrollment
         Map<String, RuleAttributeValue> currentEnrollmentValues = buildCurrentEnrollmentValues();

diff --git a/src/main/java/org/hisp/dhis/rules/Utils.java b/src/main/java/org/hisp/dhis/rules/Utils.java
@@ -1,6 +1,7 @@
 package org.hisp.dhis.rules;
 
 import org.hisp.dhis.rules.models.RuleDataValue;
+import org.hisp.dhis.rules.models.RuleDataValueHistory;
 import org.hisp.dhis.rules.models.RuleEvent;
 
 import java.text.SimpleDateFormat;
@@ -32,14 +33,26 @@ public static List<String> values( List<RuleDataValue> ruleDataValues )
         return Collections.unmodifiableList( values );
     }
 
-    public static String getLastUpdateDateForPrevious( List<RuleDataValue> ruleDataValues,
+    public static List<String> valuesForHistory( List<RuleDataValueHistory> ruleDataValues )
+    {
+        List<String> values = new ArrayList<>( ruleDataValues.size() );
+        for ( RuleDataValueHistory ruleDataValue : ruleDataValues )
+        {
+            values.add( ruleDataValue.getValue() );
+        }
+        return Collections.unmodifiableList( values );
+    }
+
+    public static String getLastUpdateDateForPrevious( List<RuleDataValueHistory> ruleDataValues,
         RuleEvent ruleEvent )
     {
         List<Date> dates = new ArrayList<>();
-        for ( RuleDataValue date : ruleDataValues )
+        for ( RuleDataValueHistory date : ruleDataValues )
         {
-            Date d = date.eventDate();
-            if ( d.before( ruleEvent.eventDate() ) )
+            Date d = date.getEventDate();
+            if ( d.before( ruleEvent.eventDate() ) ||
+                    (ruleEvent.eventDate().equals(d) && ruleEvent.createdDate().after(date.getCreatedDate()))
+            )
             {
                 dates.add( d );
             }
@@ -48,6 +61,18 @@ public static String getLastUpdateDateForPrevious( List<RuleDataValue> ruleDataV
         return dateFormat.format( Collections.max( dates ) );
     }
 
+    public static String getLastUpdateDateForHistory( List<RuleDataValueHistory> ruleDataValues )
+    {
+        List<Date> dates = new ArrayList<>();
+        for ( RuleDataValueHistory date : ruleDataValues )
+        {
+            Date d = date.getEventDate();
+            dates.add( d );
+        }
+
+        return dateFormat.format( Collections.max( dates ) );
+    }
+
     public static String getLastUpdateDate( List<RuleDataValue> ruleDataValues )
     {
         List<Date> dates = new ArrayList<>();

diff --git a/src/main/java/org/hisp/dhis/rules/models/RuleDataValueHistory.java b/src/main/java/org/hisp/dhis/rules/models/RuleDataValueHistory.java
@@ -0,0 +1,31 @@
+package org.hisp.dhis.rules.models;
+
+import java.util.Date;
+
+public class RuleDataValueHistory {
+    private final String value;
+    private final Date eventDate;
+    private final Date createdDate;
+    private final String programStage;
+    public RuleDataValueHistory( String value, Date eventDate, Date createdDate, String programStage) {
+        this.value = value;
+        this.eventDate = eventDate;
+        this.createdDate = createdDate;
+        this.programStage = programStage;
+    }
+
+    public String getValue() {
+        return value;
+    }
+
+    public Date getEventDate() {
+        return eventDate;
+    }
+
+    public Date getCreatedDate() {
+        return createdDate;
+    }
+
+    public String getProgramStage() {
+        return programStage;}
+}
diff --git a/src/main/java/org/hisp/dhis/rules/models/RuleEvent.java b/src/main/java/org/hisp/dhis/rules/models/RuleEvent.java
@@ -22,6 +22,7 @@ public static RuleEvent create(
         @Nonnull String programStage,
         @Nonnull Status status,
         @Nonnull Date eventDate,
+        @Nonnull Date createdDate,
         @Nonnull Date dueDate,
         @Nonnull String organisationUnit,
         @Nullable String organisationUnitCode,
@@ -35,6 +36,7 @@ public static RuleEvent create(
             .programStageName( programStageName )
             .status( status )
             .eventDate( eventDate )
+            .createdDate( createdDate )
             .dueDate( dueDate )
             .organisationUnit( organisationUnit )
             .organisationUnitCode( organisationUnitCode )
@@ -63,6 +65,9 @@ public static Builder builder()
     @Nonnull
     public abstract Date eventDate();
 
+    @Nonnull
+    public abstract Date createdDate();
+
     @Nullable
     public abstract Date dueDate();
 
@@ -98,6 +103,8 @@ public static abstract class Builder
 
         public abstract Builder dueDate( Date dueDate );
 
+        public abstract Builder createdDate( Date createdDate );
+
         public abstract Builder completedDate( Date completedDate );
 
         public abstract Builder organisationUnit( String organisationUnit );
@@ -117,7 +124,11 @@ private static class EventDateComparator
         @Override
         public int compare( RuleEvent first, RuleEvent second )
         {
-            return second.eventDate().compareTo( first.eventDate() );
+            int compare = second.eventDate().compareTo(first.eventDate());
+            if (compare == 0){
+                return second.createdDate().compareTo(first.createdDate());
+            }
+            return compare;
         }
     }
 

diff --git a/src/main/java/org/hisp/dhis/rules/models/RuleVariable.java b/src/main/java/org/hisp/dhis/rules/models/RuleVariable.java
@@ -25,7 +25,7 @@ public abstract class RuleVariable
     public abstract List<Option> options();
 
     public abstract Map<String, RuleVariableValue> createValues( RuleVariableValueMapBuilder builder,
-        Map<String, List<RuleDataValue>> allEventValues,
+        Map<String, List<RuleDataValueHistory>> allEventValues,
         Map<String, RuleAttributeValue> currentEnrollmentValues,
         Map<String, RuleDataValue> currentEventValues );
 

diff --git a/src/main/java/org/hisp/dhis/rules/models/RuleVariableAttribute.java b/src/main/java/org/hisp/dhis/rules/models/RuleVariableAttribute.java
@@ -34,7 +34,7 @@ public static RuleVariableAttribute create(@Nonnull String name,
 
     @Override
     public Map<String, RuleVariableValue> createValues( RuleVariableValueMapBuilder builder,
-        Map<String, List<RuleDataValue>> allEventValues,
+        Map<String, List<RuleDataValueHistory>> allEventValues,
         Map<String, RuleAttributeValue> currentEnrollmentValues,
         Map<String, RuleDataValue> currentEventValues )
     {

diff --git a/src/main/java/org/hisp/dhis/rules/models/RuleVariableCalculatedValue.java b/src/main/java/org/hisp/dhis/rules/models/RuleVariableCalculatedValue.java
@@ -61,7 +61,7 @@ public static RuleVariableCalculatedValue create(@Nonnull String name,
 
     @Override
     public Map<String, RuleVariableValue> createValues( RuleVariableValueMapBuilder builder,
-        Map<String, List<RuleDataValue>> allEventValues,
+        Map<String, List<RuleDataValueHistory>> allEventValues,
         Map<String, RuleAttributeValue> currentEnrollmentValues,
         Map<String, RuleDataValue> currentEventValues )
     {

diff --git a/src/main/java/org/hisp/dhis/rules/models/RuleVariableCurrentEvent.java b/src/main/java/org/hisp/dhis/rules/models/RuleVariableCurrentEvent.java
@@ -27,7 +27,7 @@ public static RuleVariableCurrentEvent create(@Nonnull String name,
 
     @Override
     public Map<String, RuleVariableValue> createValues( RuleVariableValueMapBuilder builder,
-        Map<String, List<RuleDataValue>> allEventValues,
+        Map<String, List<RuleDataValueHistory>> allEventValues,
         Map<String, RuleAttributeValue> currentEnrollmentValues,
         Map<String, RuleDataValue> currentEventValues )
     {

diff --git a/src/main/java/org/hisp/dhis/rules/models/RuleVariableNewestEvent.java b/src/main/java/org/hisp/dhis/rules/models/RuleVariableNewestEvent.java
@@ -12,6 +12,7 @@
 import java.util.Map;
 
 import static org.hisp.dhis.rules.Utils.getLastUpdateDate;
+import static org.hisp.dhis.rules.Utils.getLastUpdateDateForHistory;
 
 @AutoValue
 public abstract class RuleVariableNewestEvent
@@ -27,12 +28,12 @@ public static RuleVariableNewestEvent create(@Nonnull String name,
 
     @Override
     public Map<String, RuleVariableValue> createValues( RuleVariableValueMapBuilder builder,
-        Map<String, List<RuleDataValue>> allEventValues,
+        Map<String, List<RuleDataValueHistory>> allEventValues,
         Map<String, RuleAttributeValue> currentEnrollmentValues,
         Map<String, RuleDataValue> currentEventValues )
     {
         Map<String, RuleVariableValue> valueMap = new HashMap();
-        List<RuleDataValue> ruleDataValues = allEventValues.get( this.dataElement() );
+        List<RuleDataValueHistory> ruleDataValues = allEventValues.get( this.dataElement() );
 
         if ( ruleDataValues == null || ruleDataValues.isEmpty() )
         {
@@ -42,12 +43,12 @@ public Map<String, RuleVariableValue> createValues( RuleVariableValueMapBuilder
         {
             RuleVariableValue variableValue;
 
-            RuleDataValue value = ruleDataValues.get( 0 );
+            RuleDataValueHistory value = ruleDataValues.get( 0 );
 
-            String optionValue = this.useCodeForOptionSet() ? value.value() : getOptionName( value.value() );
+            String optionValue = this.useCodeForOptionSet() ? value.getValue() : getOptionName( value.getValue() );
 
             variableValue = RuleVariableValue.create( optionValue,
-                this.dataElementType(), Utils.values( ruleDataValues ), getLastUpdateDate( ruleDataValues ) );
+                this.dataElementType(), Utils.valuesForHistory( ruleDataValues ), getLastUpdateDateForHistory( ruleDataValues ) );
 
 
             valueMap.put( this.name(), variableValue );

diff --git a/src/main/java/org/hisp/dhis/rules/models/RuleVariableNewestStageEvent.java b/src/main/java/org/hisp/dhis/rules/models/RuleVariableNewestStageEvent.java
@@ -13,6 +13,7 @@
 import java.util.Map;
 
 import static org.hisp.dhis.rules.Utils.getLastUpdateDate;
+import static org.hisp.dhis.rules.Utils.getLastUpdateDateForHistory;
 
 @AutoValue
 public abstract class RuleVariableNewestStageEvent
@@ -32,21 +33,21 @@ public static RuleVariableNewestStageEvent create(@Nonnull String name, @Nonnull
 
     @Override
     public Map<String, RuleVariableValue> createValues( RuleVariableValueMapBuilder builder,
-        Map<String, List<RuleDataValue>> allEventValues,
+        Map<String, List<RuleDataValueHistory>> allEventValues,
         Map<String, RuleAttributeValue> currentEnrollmentValues,
         Map<String, RuleDataValue> currentEventValues )
     {
         Map<String, RuleVariableValue> valueMap = new HashMap();
-        List<RuleDataValue> stageRuleDataValues = new ArrayList<>();
-        List<RuleDataValue> sourceRuleDataValues = allEventValues.get( this.dataElement() );
+        List<RuleDataValueHistory> stageRuleDataValues = new ArrayList<>();
+        List<RuleDataValueHistory> sourceRuleDataValues = allEventValues.get( this.dataElement() );
         if ( sourceRuleDataValues != null && !sourceRuleDataValues.isEmpty() )
         {
 
             // filter data values based on program stage
             for ( int i = 0; i < sourceRuleDataValues.size(); i++ )
             {
-                RuleDataValue ruleDataValue = sourceRuleDataValues.get( i );
-                if ( this.programStage().equals( ruleDataValue.programStage() ) )
+                RuleDataValueHistory ruleDataValue = sourceRuleDataValues.get( i );
+                if ( this.programStage().equals( ruleDataValue.getProgramStage() ) )
                 {
                     stageRuleDataValues.add( ruleDataValue );
                 }
@@ -61,13 +62,13 @@ public Map<String, RuleVariableValue> createValues( RuleVariableValueMapBuilder
         {
             RuleVariableValue variableValue;
 
-            RuleDataValue value = stageRuleDataValues.get( 0 );
+            RuleDataValueHistory value = stageRuleDataValues.get( 0 );
 
-            String optionValue = this.useCodeForOptionSet() ? value.value() : getOptionName( value.value() );
+            String optionValue = this.useCodeForOptionSet() ? value.getValue() : getOptionName( value.getValue() );
 
             variableValue = RuleVariableValue.create( optionValue,
-                        this.dataElementType(), Utils.values( stageRuleDataValues ),
-                        getLastUpdateDate( stageRuleDataValues ) );
+                        this.dataElementType(), Utils.valuesForHistory( stageRuleDataValues ),
+                        getLastUpdateDateForHistory( stageRuleDataValues ) );
 
             valueMap.put( this.name(), variableValue );
         }

diff --git a/src/main/java/org/hisp/dhis/rules/models/RuleVariablePreviousEvent.java b/src/main/java/org/hisp/dhis/rules/models/RuleVariablePreviousEvent.java
@@ -27,26 +27,30 @@ public static RuleVariablePreviousEvent create(@Nonnull String name,
 
     @Override
     public Map<String, RuleVariableValue> createValues( RuleVariableValueMapBuilder builder,
-        Map<String, List<RuleDataValue>> allEventValues,
+        Map<String, List<RuleDataValueHistory>> allEventValues,
         Map<String, RuleAttributeValue> currentEnrollmentValues,
         Map<String, RuleDataValue> currentEventValues )
     {
         Map<String, RuleVariableValue> valueMap = new HashMap();
 
         RuleVariableValue variableValue = null;
-        List<RuleDataValue> ruleDataValues = allEventValues.get( this.dataElement() );
+        List<RuleDataValueHistory> ruleDataValues = allEventValues.get( this.dataElement() );
         if ( builder.ruleEvent != null && ruleDataValues != null && !ruleDataValues.isEmpty() )
         {
-            for ( RuleDataValue ruleDataValue : ruleDataValues )
+            for ( RuleDataValueHistory ruleDataValue : ruleDataValues )
             {
                 // We found preceding value to the current currentEventValues,
                 // which is assumed to be best candidate.
-                if ( builder.ruleEvent.eventDate().compareTo( ruleDataValue.eventDate() ) > 0 )
+                if ( builder.ruleEvent.eventDate().compareTo( ruleDataValue.getEventDate() ) > 0
+                    || (
+                        builder.ruleEvent.eventDate().compareTo( ruleDataValue.getEventDate() ) == 0 &&
+                        builder.ruleEvent.createdDate().compareTo( ruleDataValue.getCreatedDate() ) > 0
+                        ))
                 {
-                    String optionValue = this.useCodeForOptionSet() ? ruleDataValue.value() : getOptionName( ruleDataValue.value() );
+                    String optionValue = this.useCodeForOptionSet() ? ruleDataValue.getValue() : getOptionName( ruleDataValue.getValue() );
 
                     variableValue = RuleVariableValue.create( optionValue, this.dataElementType(),
-                        Utils.values( ruleDataValues ),
+                        Utils.valuesForHistory( ruleDataValues ),
                         getLastUpdateDateForPrevious( ruleDataValues, builder.ruleEvent ) );
                     break;
                 }

diff --git a/src/test/java/org/hisp/dhis/rules/ConstantsValueTest.java b/src/test/java/org/hisp/dhis/rules/ConstantsValueTest.java
@@ -189,6 +189,7 @@ public void assignConstantValueFromAssignActionInEvent()
             .programStageName( "" )
             .status( RuleEvent.Status.ACTIVE )
             .eventDate( new Date() )
+            .createdDate( new Date() )
             .dueDate( new Date() )
             .organisationUnit( "" )
             .organisationUnitCode( "" )

diff --git a/src/test/java/org/hisp/dhis/rules/ProgramRuleVariableTest.java b/src/test/java/org/hisp/dhis/rules/ProgramRuleVariableTest.java
@@ -326,6 +326,7 @@ private List<RuleEffect> callEventRuleEngine( Rule rule )
             .programStageName( PROGRAM_STAGE_NAME )
             .status( RULE_EVENT_STATUS )
             .eventDate( EVENT_DATE )
+            .createdDate( new Date() )
             .dueDate( DUE_DATE )
             .organisationUnit( ORGANISATION_UNIT )
             .organisationUnitCode( ORGANISATION_UNIT_CODE )