fix: Fix patch for nextScheduledDate in PS [DHIS2-20042] (#22806) (#22861)

Author: enricocolasante

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

@@ -68,7 +68,8 @@ public void validate(
                   DataElement.class,
                   programStage.getNextScheduleDate().getUid());
 
-      if (!programStage.getDataElements().contains(programStage.getNextScheduleDate())
+      if (programStage.getDataElements().stream()
+              .noneMatch(de -> de.getUid().equals(programStage.getNextScheduleDate().getUid()))
           || nextScheduleDate == null
           || !nextScheduleDate.getValueType().equals(ValueType.DATE)) {
         addReports.accept(

dhis-2/dhis-test-web-api/src/test/java/org/hisp/dhis/webapi/controller/ProgramStageControllerTest.java

@@ -30,19 +30,28 @@
 import static org.hisp.dhis.web.WebClientUtils.assertStatus;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
+import org.hisp.dhis.common.ValueType;
+import org.hisp.dhis.dataelement.DataElement;
+import org.hisp.dhis.dataelement.DataElementService;
 import org.hisp.dhis.feedback.ErrorCode;
+import org.hisp.dhis.jsontree.JsonObject;
 import org.hisp.dhis.jsontree.JsonResponse;
 import org.hisp.dhis.web.HttpStatus;
 import org.hisp.dhis.webapi.DhisControllerConvenienceTest;
 import org.hisp.dhis.webapi.json.domain.JsonTypeReport;
 import org.hisp.dhis.webapi.json.domain.JsonWebMessage;
 import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.transaction.annotation.Transactional;
 
 /**
  * @author [email protected]
  */
+@Transactional
 class ProgramStageControllerTest extends DhisControllerConvenienceTest {
 
+  @Autowired private DataElementService dataElementService;
+
   @Test
   void testCreateProgramStageWithoutProgram() {
     JsonWebMessage message =
@@ -70,4 +79,65 @@ void testCreateProgramStageOk() {
     JsonResponse program = GET("/programs/{id}", "VoZMWi7rBgj").content();
     assertEquals(programStageId, program.getString("programStages[0].id").string());
   }
+
+  @Test
+  void shouldSuccessfullyPatchNextScheduledDateField() {
+    DataElement dataElement = createDataElement('A');
+    dataElement.setValueType(ValueType.DATE);
+    dataElementService.addDataElement(dataElement);
+    POST(
+            "/programs/",
+            "{'name':'test program', 'id':'VoZMWi7rBgj', 'shortName':'test program','programType':'WITH_REGISTRATION'}")
+        .content(HttpStatus.CREATED);
+    String programStageId =
+        assertStatus(
+            HttpStatus.CREATED,
+            POST(
+                "/programStages/",
+                "{'name':'test programStage', 'program':{'id':'VoZMWi7rBgj'}, 'programStageDataElements': [{'dataElement': {'id': '"
+                    + dataElement.getUid()
+                    + "'}}]}"));
+    JsonWebMessage message =
+        PATCH(
+                "/programStages/" + programStageId,
+                "[{ 'op': 'replace','path': '/nextScheduleDate','value': {'id': '"
+                    + dataElement.getUid()
+                    + "'}}]")
+            .content(HttpStatus.OK)
+            .as(JsonWebMessage.class);
+    assertEquals("OK", message.getStatus());
+    JsonObject programStage = GET("/programStages/{id}", programStageId).content();
+    assertEquals(
+        dataElement.getUid(), programStage.getObject("nextScheduleDate").getString("id").string());
+  }
+
+  @Test
+  void shouldFailToPatchNextScheduledDateWhenItIsReferencingADataElementWithWrongValueType() {
+    DataElement dataElement = createDataElement('A');
+    dataElement.setValueType(ValueType.TEXT);
+    dataElementService.addDataElement(dataElement);
+    POST(
+            "/programs/",
+            "{'name':'test program', 'id':'VoZMWi7rBgj', 'shortName':'test program','programType':'WITH_REGISTRATION'}")
+        .content(HttpStatus.CREATED);
+    String programStageId =
+        assertStatus(
+            HttpStatus.CREATED,
+            POST(
+                "/programStages/",
+                "{'name':'test programStage', 'program':{'id':'VoZMWi7rBgj'}, 'programStageDataElements': [{'dataElement': {'id': '"
+                    + dataElement.getUid()
+                    + "'}}]}"));
+    JsonWebMessage message =
+        PATCH(
+                "/programStages/" + programStageId,
+                "[{ 'op': 'replace','path': '/nextScheduleDate','value': {'id': '"
+                    + dataElement.getUid()
+                    + "'}}]")
+            .content(HttpStatus.CONFLICT)
+            .as(JsonWebMessage.class);
+    JsonTypeReport response = message.get("response", JsonTypeReport.class);
+    assertEquals(1, response.getErrorReports().size());
+    assertEquals(ErrorCode.E6001, response.getErrorReports().get(0).getErrorCode());
+  }
 }