fix: Add templateid column in program rule action [DHIS2-17515]

dhis-2/dhis-api/src/main/java/org/hisp/dhis/programrule/ProgramRuleAction.java

@@ -27,6 +27,7 @@
  */
 package org.hisp.dhis.programrule;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
@@ -43,6 +44,8 @@
 import org.hisp.dhis.program.ProgramIndicator;
 import org.hisp.dhis.program.ProgramStage;
 import org.hisp.dhis.program.ProgramStageSection;
+import org.hisp.dhis.program.notification.ProgramNotificationTemplate;
+import org.hisp.dhis.schema.annotation.Property;
 import org.hisp.dhis.trackedentity.TrackedEntityAttribute;
 import org.hisp.dhis.translation.Translatable;
 
@@ -134,6 +137,15 @@ public class ProgramRuleAction extends BaseIdentifiableObject implements Metadat
    *   <li>sendmessage
    * </ul>
    */
+  @JsonIgnore private ProgramNotificationTemplate notificationTemplate;
+
+  /**
+   * The program notification template uid that will be triggered by the rule action. Used for:
+   *
+   * <ul>
+   *   <li>sendmessage
+   * </ul>
+   */
   private String templateUid;
 
   /**
@@ -322,12 +334,29 @@ public void setDataElement(DataElement dataElement) {
 
   @JsonProperty
   @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
+  @Property(required = Property.Value.FALSE, owner = Property.Value.TRUE)
   public String getTemplateUid() {
-    return templateUid;
+    return notificationTemplate != null ? notificationTemplate.getUid() : null;
+  }
+
+  public void setTemplateUid(String templateUid) {
+    if (templateUid == null) {
+      notificationTemplate = null;
+      return;
+    }
+
+    this.templateUid = templateUid;
+    ProgramNotificationTemplate template = new ProgramNotificationTemplate();
+    template.setUid(templateUid);
+    setNotificationTemplate(template);
+  }
+
+  public ProgramNotificationTemplate getNotificationTemplate() {
+    return notificationTemplate;
   }
 
-  public void setTemplateUid(String programNotificationTemplate) {
-    this.templateUid = programNotificationTemplate;
+  public void setNotificationTemplate(ProgramNotificationTemplate notificationTemplate) {
+    this.notificationTemplate = notificationTemplate;
   }
 
   @JsonProperty("trackedEntityAttribute")

dhis-2/dhis-services/dhis-service-administration/src/main/resources/data-integrity-checks/program_rules/program_rules_message_no_template.yaml

@@ -34,15 +34,15 @@ summary_sql: >-
     SELECT uid,name from programrule where programruleid IN (
     SELECT programruleid from programruleaction WHERE
     actiontype IN ('SENDMESSAGE','SCHEDULEMESSAGE')
-    AND templateuid IS NULL ))
+    AND notificationtemplateid IS NULL ))
     SELECT COUNT(*) as value,
     100.0 * COUNT(*) / NULLIF( (SELECT COUNT(*) FROM programrule),0) as percent
     FROM program_rules_no_message_template;
 details_sql: >-
     SELECT uid,name from programrule where programruleid IN (
     SELECT programruleid from programruleaction WHERE
     actiontype IN ('SENDMESSAGE','SCHEDULEMESSAGE')
-    AND templateuid IS NULL );
+    AND notificationtemplateid IS NULL );
 severity: SEVERE
 introduction: >
     Program rule actions of type "Send message" or "Schedule message"

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/programrule/action/validation/NotificationProgramRuleActionValidator.java

@@ -48,9 +48,7 @@ public ProgramRuleActionValidationResult validate(
     ProgramRule rule = validationContext.getProgramRule();
 
     if (!programRuleAction.hasNotification()) {
-      log.debug(
-          String.format(
-              "ProgramNotificationTemplate cannot be null for program rule: %s ", rule.getName()));
+      log.debug("templateUid cannot be null for program rule: {}", rule.getName());
 
       return ProgramRuleActionValidationResult.builder()
           .valid(false)
@@ -73,9 +71,9 @@ public ProgramRuleActionValidationResult validate(
 
     if (pnt == null) {
       log.debug(
-          String.format(
-              "ProgramNotificationTemplate id: %s for program rule: %s does not exist",
-              programRuleAction.getTemplateUid(), rule.getName()));
+          "ProgramNotificationTemplate id: {} for program rule: {} does not exist.",
+          programRuleAction.getTemplateUid(),
+          rule.getName());
 
       return ProgramRuleActionValidationResult.builder()
           .valid(false)

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/programrule/hibernate/HibernateProgramRuleActionStore.java

@@ -73,7 +73,7 @@ public List<ProgramRuleAction> getProgramActionsWithNoDataObject() {
   @Override
   public List<ProgramRuleAction> getProgramActionsWithNoNotification() {
     return getQuery(
-            "FROM ProgramRuleAction pra WHERE pra.programRuleActionType IN ( :notificationTypes ) AND pra.templateUid IS NULL")
+            "FROM ProgramRuleAction pra WHERE pra.programRuleActionType IN ( :notificationTypes ) AND pra.notificationTemplate IS NULL")
         .setParameter("notificationTypes", ProgramRuleActionType.NOTIFICATION_LINKED_TYPES)
         .getResultList();
   }

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

@@ -41,7 +41,8 @@
     <many-to-one name="programStage" class="org.hisp.dhis.program.ProgramStage"
       column="programstageid" foreign-key="fk_programruleaction_programstage" />
 
-    <property name="templateUid" column="templateuid"/>
+    <many-to-one name="notificationTemplate" class="org.hisp.dhis.program.notification.ProgramNotificationTemplate"
+                 column="notificationtemplateid" foreign-key="fk_programruleaction_notificationtemplate" not-null="false" />
 
     <many-to-one name="option" class="org.hisp.dhis.option.Option"
       column="optionid" foreign-key="fk_programruleaction_option" />             

dhis-2/dhis-services/dhis-service-core/src/test/java/org/hisp/dhis/programrule/ProgramRuleActionValidatorTest.java

@@ -41,7 +41,11 @@
 import org.hisp.dhis.program.Program;
 import org.hisp.dhis.program.ProgramService;
 import org.hisp.dhis.program.ProgramStage;
+import org.hisp.dhis.program.notification.NotificationTrigger;
+import org.hisp.dhis.program.notification.ProgramNotificationRecipient;
+import org.hisp.dhis.program.notification.ProgramNotificationTemplate;
 import org.hisp.dhis.programrule.action.validation.HideOptionProgramRuleActionValidator;
+import org.hisp.dhis.programrule.action.validation.NotificationProgramRuleActionValidator;
 import org.hisp.dhis.programrule.action.validation.ProgramRuleActionValidationContext;
 import org.hisp.dhis.programrule.action.validation.ProgramRuleActionValidationService;
 import org.junit.jupiter.api.BeforeEach;
@@ -76,13 +80,13 @@ void setUp() {
             .programStages(List.of(programStage))
             .programRuleActionValidationService(programRuleActionValidationService)
             .build();
-    when(programRuleActionValidationService.getProgramService()).thenReturn(programService);
-    when(programService.getProgram(any())).thenReturn(program);
   }
 
   @Test
   @DisplayName("Should return valid when HideOptionProgramRule contains DataElement")
   void testHideOptionRuleValid() {
+    when(programRuleActionValidationService.getProgramService()).thenReturn(programService);
+    when(programService.getProgram(any())).thenReturn(program);
     Option option = new Option();
     ProgramRuleAction programRuleAction = new ProgramRuleAction();
     programRuleAction.setDataElement(dataElement);
@@ -102,6 +106,8 @@ void testHideOptionRuleValid() {
   @Test
   @DisplayName("Should return error E4058 when HideOptionProgramRule contains ProgramStage")
   void testHideOptionInvalid() {
+    when(programRuleActionValidationService.getProgramService()).thenReturn(programService);
+    when(programService.getProgram(any())).thenReturn(program);
     Option option = new Option();
     ProgramRuleAction programRuleAction = new ProgramRuleAction();
     programRuleAction.setDataElement(dataElement);
@@ -119,4 +125,50 @@ void testHideOptionInvalid() {
     assertFalse(result.isValid());
     assertEquals(ErrorCode.E4058, result.getErrorReport().getErrorCode());
   }
+
+  @Test
+  void testValidRuleActionSendMessage() {
+    ProgramNotificationTemplate pnt =
+        createProgramNotificationTemplate(
+            "test", 1, NotificationTrigger.PROGRAM_RULE, ProgramNotificationRecipient.USER_GROUP);
+
+    ProgramRuleAction programRuleAction = new ProgramRuleAction();
+    programRuleAction.setTemplateUid(pnt.getUid());
+    programRuleAction.setProgramRuleActionType(ProgramRuleActionType.SENDMESSAGE);
+
+    ProgramRule programRule = new ProgramRule();
+    programRule.setProgram(program);
+    programRule.setName("Test Program Rule");
+    programRule.getProgramRuleActions().add(programRuleAction);
+
+    validationContext.setProgramRule(programRule);
+    validationContext.setNotificationTemplate(pnt);
+
+    NotificationProgramRuleActionValidator notificationValidator =
+        new NotificationProgramRuleActionValidator();
+    ProgramRuleActionValidationResult result =
+        notificationValidator.validate(programRuleAction, validationContext);
+    assertTrue(result.isValid());
+  }
+
+  @Test
+  void testInValidRuleActionSendMessage() {
+    ProgramRuleAction programRuleAction = new ProgramRuleAction();
+    programRuleAction.setProgramRuleActionType(ProgramRuleActionType.SENDMESSAGE);
+
+    ProgramRule programRule = new ProgramRule();
+    programRule.setProgram(program);
+    programRule.setName("Test Program Rule");
+    programRule.getProgramRuleActions().add(programRuleAction);
+
+    validationContext.setProgramRule(programRule);
+    validationContext.setNotificationTemplate(null);
+
+    NotificationProgramRuleActionValidator notificationValidator =
+        new NotificationProgramRuleActionValidator();
+    ProgramRuleActionValidationResult result =
+        notificationValidator.validate(programRuleAction, validationContext);
+    assertFalse(result.isValid());
+    assertEquals(ErrorCode.E4035, result.getErrorReport().getErrorCode());
+  }
 }

dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/metadata/objectbundle/hooks/ProgramRuleActionObjectBundleHook.java

@@ -30,8 +30,10 @@
 import java.util.Map;
 import java.util.function.Consumer;
 import javax.annotation.Nonnull;
+import lombok.extern.slf4j.Slf4j;
 import org.hisp.dhis.dxf2.metadata.objectbundle.ObjectBundle;
 import org.hisp.dhis.feedback.ErrorReport;
+import org.hisp.dhis.program.notification.ProgramNotificationTemplate;
 import org.hisp.dhis.programrule.ProgramRuleAction;
 import org.hisp.dhis.programrule.ProgramRuleActionType;
 import org.hisp.dhis.programrule.ProgramRuleActionValidationResult;
@@ -44,6 +46,7 @@
  * @author Zubair Asghar
  */
 @Component("programRuleActionObjectBundle")
+@Slf4j
 public class ProgramRuleActionObjectBundleHook extends AbstractObjectBundleHook<ProgramRuleAction> {
   @Nonnull
   private final Map<ProgramRuleActionType, ProgramRuleActionValidator>
@@ -69,6 +72,17 @@ public void validate(
     }
   }
 
+  @Override
+  public void preCreate(ProgramRuleAction object, ObjectBundle bundle) {
+    getNotificationTemplate(object, bundle);
+  }
+
+  @Override
+  public void preUpdate(
+      ProgramRuleAction object, ProgramRuleAction persistedObject, ObjectBundle bundle) {
+    getNotificationTemplate(object, bundle);
+  }
+
   private ProgramRuleActionValidationResult validateProgramRuleAction(
       ProgramRuleAction ruleAction, ObjectBundle bundle) {
     ProgramRuleActionValidationResult validationResult;
@@ -83,4 +97,32 @@ private ProgramRuleActionValidationResult validateProgramRuleAction(
 
     return validationResult;
   }
+
+  private void getNotificationTemplate(ProgramRuleAction object, ObjectBundle bundle) {
+    if (object.getTemplateUid() == null) {
+      // Nothing to do when templateUid is null
+      return;
+    }
+
+    // try to get the template from the preheated bundle.
+    ProgramNotificationTemplate template =
+        bundle
+            .getPreheat()
+            .get(
+                bundle.getPreheatIdentifier(),
+                ProgramNotificationTemplate.class,
+                object.getTemplateUid());
+
+    // If not found in preheated objects, fetch from the database.
+    if (template == null) {
+      template = manager.get(ProgramNotificationTemplate.class, object.getTemplateUid());
+    }
+
+    if (template == null) {
+      log.info("No ProgramNotificationTemplate found for {}: ", object.getTemplateUid());
+      return;
+    }
+
+    object.setNotificationTemplate(template);
+  }
 }

dhis-2/dhis-support/dhis-support-db-migration/src/main/resources/org/hisp/dhis/db/migration/2.42/V2_42_7__Add_templateid_column_into_programruleaction.sql

@@ -0,0 +1,26 @@
+-- Add the new column
+ALTER TABLE programruleaction ADD COLUMN IF NOT EXISTS notificationtemplateid INTEGER NULL;
+
+-- Update the new column with values from the old column
+UPDATE programruleaction pra
+SET notificationtemplateid = t.programnotificationtemplateid
+    FROM programnotificationtemplate t
+WHERE pra.templateuid = t.uid;
+
+-- Remove templateUid
+
+ALTER TABLE programruleaction DROP COLUMN IF EXISTS templateuid;
+
+-- Conditionally add the foreign key constraint if it doesn't exist
+DO $$
+BEGIN
+    IF NOT EXISTS (
+        SELECT 1
+        FROM pg_constraint
+        WHERE conname = 'fk_notificationtemplate'
+    ) THEN
+ALTER TABLE programruleaction
+    ADD CONSTRAINT fk_notificationtemplate
+        FOREIGN KEY (notificationtemplateid) REFERENCES programnotificationtemplate(programnotificationtemplateid);
+END IF;
+END $$;

dhis-2/dhis-support/dhis-support-test/src/main/java/org/hisp/dhis/DhisConvenienceTest.java

@@ -2284,8 +2284,13 @@ public static Constant createConstant(char uniqueCharacter, double value) {
 
   public static ProgramNotificationTemplate createProgramNotificationTemplate(
       String name, int days, NotificationTrigger trigger, ProgramNotificationRecipient recipient) {
-    return new ProgramNotificationTemplate(
-        name, "Subject", "Message", trigger, recipient, Sets.newHashSet(), days, null, null);
+    ProgramNotificationTemplate template =
+        new ProgramNotificationTemplate(
+            name, "Subject", "Message", trigger, recipient, Sets.newHashSet(), days, null, null);
+
+    template.setAutoFields();
+
+    return template;
   }
 
   public static ProgramNotificationTemplate createProgramNotificationTemplate(
@@ -2294,8 +2299,12 @@ public static ProgramNotificationTemplate createProgramNotificationTemplate(
       NotificationTrigger trigger,
       ProgramNotificationRecipient recipient,
       Date scheduledDate) {
-    return new ProgramNotificationTemplate(
-        name, "Subject", "Message", trigger, recipient, Sets.newHashSet(), days, null, null);
+    ProgramNotificationTemplate template =
+        new ProgramNotificationTemplate(
+            name, "Subject", "Message", trigger, recipient, Sets.newHashSet(), days, null, null);
+    template.setAutoFields();
+
+    return template;
   }
 
   public static DataSetNotificationTemplate createDataSetNotificationTemplate(

dhis-2/dhis-test-integration/src/test/java/org/hisp/dhis/programrule/ProgramRuleActionServiceTest.java

@@ -42,6 +42,10 @@
 import org.hisp.dhis.program.ProgramService;
 import org.hisp.dhis.program.ProgramStage;
 import org.hisp.dhis.program.ProgramStageService;
+import org.hisp.dhis.program.notification.NotificationTrigger;
+import org.hisp.dhis.program.notification.ProgramNotificationRecipient;
+import org.hisp.dhis.program.notification.ProgramNotificationTemplate;
+import org.hisp.dhis.program.notification.ProgramNotificationTemplateService;
 import org.hisp.dhis.test.integration.TransactionalIntegrationTest;
 import org.hisp.dhis.trackedentity.TrackedEntityAttribute;
 import org.hisp.dhis.trackedentity.TrackedEntityAttributeService;
@@ -76,6 +80,8 @@ class ProgramRuleActionServiceTest extends TransactionalIntegrationTest {
 
   @Autowired private ProgramStageService programStageService;
 
+  @Autowired private ProgramNotificationTemplateService programNotificationTemplateService;
+
   @Override
   public void setUpTest() {
     programStageA = createProgramStage('A', 0);
@@ -332,7 +338,18 @@ void testProgramRuleActionWithNoNotification() {
             "$placeofliving",
             null,
             null);
-    actionI.setTemplateUid("tempUId");
+
+    ProgramNotificationTemplate pnt =
+        createProgramNotificationTemplate(
+            "test123",
+            3,
+            NotificationTrigger.PROGRAM_RULE,
+            ProgramNotificationRecipient.USER_GROUP);
+
+    programNotificationTemplateService.save(pnt);
+
+    actionI.setTemplateUid(pnt.getUid());
+    actionI.setNotificationTemplate(pnt);
     actionService.addProgramRuleAction(actionI);
     actionService.addProgramRuleAction(actionJ);
     programRuleA.setProgramRuleActions(Sets.newHashSet(actionI, actionJ));