DD-2023 Missing body entity with Pre-Workflow POST of AuthorizedExternalStep (#11895)

Co-authored-by: Ali Sheikhi <aliassheikh@users.noreply.github.com>
Co-authored-by: Jan van Mansum <janvanmansum@gmail.com>

Author: aliassheikh

src/main/java/edu/harvard/iq/dataverse/workflow/internalspi/AuthorizedExternalStep.java

@@ -1,6 +1,7 @@
 package edu.harvard.iq.dataverse.workflow.internalspi;
 
 import edu.harvard.iq.dataverse.util.BundleUtil;
+import edu.harvard.iq.dataverse.util.json.JsonUtil;
 import edu.harvard.iq.dataverse.workflow.PendingWorkflowInvocation;
 import edu.harvard.iq.dataverse.workflow.WorkflowContext;
 import edu.harvard.iq.dataverse.workflow.WorkflowContext.TriggerType;
@@ -21,7 +22,12 @@
 import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
 import org.apache.hc.client5.http.impl.classic.HttpClients;
 import org.apache.hc.core5.http.ClassicHttpRequest;
+import org.apache.hc.core5.http.ContentType;
+import org.apache.hc.core5.http.HttpEntity;
 import org.apache.hc.core5.net.URIBuilder;
+import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
+import org.apache.hc.core5.http.io.entity.StringEntity;
+//import org.apache.http.entity.StringEntity;
 
 /**
  * A workflow step that sends a HTTP request, and then pauses, waiting for an
@@ -127,7 +133,18 @@ ClassicHttpRequest buildMethod(boolean rollback, WorkflowContext ctxt) throws Ex
         }
 
         request.setHeader("Content-Type", params.getOrDefault("contentType", "text/plain"));
-    
+
+
+        String bodyKey = (rollback ? "rollbackBody" : "body");
+        if (params.containsKey(bodyKey) && (request instanceof HttpPost || request instanceof HttpPut)) {
+            String body = params.get(bodyKey);
+            request.setEntity(
+                new StringEntity(process(body, templateParams),
+                    ContentType.create(request.getFirstHeader("Content-Type").getValue())
+                )
+            );
+        }
+
         return request;
     }
 

src/test/java/edu/harvard/iq/dataverse/workflow/internalspi/AuthorizedExternalStepTest.java

@@ -0,0 +1,96 @@
+package edu.harvard.iq.dataverse.workflow.internalspi;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import edu.harvard.iq.dataverse.branding.BrandingUtil;
+import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
+import edu.harvard.iq.dataverse.workflow.WorkflowContext;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
+import org.apache.hc.core5.http.io.entity.StringEntity;
+import org.junit.jupiter.api.Test;
+
+import java.lang.reflect.Field;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.*;
+
+class AuthorizedExternalStepTest {
+
+    @Test
+    void testRequestEntityIsSetCorrectly() throws Exception {
+        // Mock the static field before any code that uses it
+        // Mock and set BrandingUtil.dataverseService
+        edu.harvard.iq.dataverse.DataverseServiceBean mockDataverseService = mock(edu.harvard.iq.dataverse.DataverseServiceBean.class);
+        when(mockDataverseService.getRootDataverseName()).thenReturn("Root");
+
+        Field dataverseServiceField = BrandingUtil.class.getDeclaredField("dataverseService");
+        dataverseServiceField.setAccessible(true);
+        dataverseServiceField.set(null, mockDataverseService);
+
+        SettingsServiceBean mockSettings = mock(SettingsServiceBean.class);
+        when(mockSettings.getValueForKey(any())).thenReturn(null);
+
+        Field field = BrandingUtil.class.getDeclaredField("settingsService");
+        field.setAccessible(true);
+        field.set(null, mockSettings);
+
+
+        // Prepare parameters
+        Map<String, String> params = new HashMap<>();
+        params.put("method", "POST");
+        params.put("url", "http://example.com/api");
+        params.put("contentType", "application/json");
+        params.put("body", "{\"invocationId\": \"${invocationId}\"}");
+
+        // Mock context
+        WorkflowContext context = mock(WorkflowContext.class);
+        when(context.getInvocationId()).thenReturn("12345");
+        when(context.getDataset()).thenReturn(MockDataset.create());
+
+        // Create the step
+        AuthorizedExternalStep step = new AuthorizedExternalStep(params);
+
+
+        // Directly test buildMethod to verify the request entity
+        HttpPost request = (HttpPost) step.buildMethod(false, context);
+        StringEntity entity = (StringEntity) request.getEntity();
+        assertNotNull(entity);
+        assertEquals("application/json", entity.getContentType());
+        String body = new String(entity.getContent().readAllBytes());
+        assertTrue(body.contains("\"invocationId\": \"12345\""));
+    }
+
+    static class MockDataverse extends edu.harvard.iq.dataverse.Dataverse {
+        @Override
+        public java.util.List getCitationDatasetFieldTypes() {
+            return new ArrayList<>();
+        }
+    }
+
+    // Helper mock dataset
+    static class MockDataset extends edu.harvard.iq.dataverse.Dataset {
+        private edu.harvard.iq.dataverse.GlobalId globalId;
+        private edu.harvard.iq.dataverse.Dataverse owner = mock(edu.harvard.iq.dataverse.Dataverse.class);
+
+        static MockDataset create() {
+            MockDataset ds = new MockDataset();
+            ds.setId(1L);
+            ds.setIdentifier("ds1");
+            ds.globalId = new edu.harvard.iq.dataverse.GlobalId("doi", "10.1234/DS1", null, null, null, null);
+            return ds;
+        }
+
+        @Override
+        public edu.harvard.iq.dataverse.GlobalId getGlobalId() {
+            return globalId;
+        }
+
+        @Override
+        public edu.harvard.iq.dataverse.Dataverse getOwner() {
+            return owner;
+        }
+    }
+}