Adding Composite Request support to SF CRM client.

Author: gmazza

sf_client/src/itest/java/net/glenmazza/sfclient/model/AccountInsertCompositeRecord.java

@@ -0,0 +1,45 @@
+package net.glenmazza.sfclient.model;
+
+public class AccountInsertCompositeRecord extends CompositeEntityRecord {
+
+    private final Body body = new Body();
+    public AccountInsertCompositeRecord(String referenceId) {
+        super("Account", Method.POST, referenceId);
+    }
+
+    public Body getBody() {
+        return body;
+    }
+
+    public static class Body {
+
+        public String name;
+        public int numberOfEmployees;
+        public String site;
+
+        public String getName() {
+            return name;
+        }
+
+        public void setName(String name) {
+            this.name = name;
+        }
+
+        public int getNumberOfEmployees() {
+            return numberOfEmployees;
+        }
+
+        public void setNumberOfEmployees(int numberOfEmployees) {
+            this.numberOfEmployees = numberOfEmployees;
+        }
+
+        public String getSite() {
+            return site;
+        }
+
+        public void setSite(String site) {
+            this.site = site;
+        }
+    }
+
+}

sf_client/src/itest/java/net/glenmazza/sfclient/model/AccountUpdateCompositeRecord.java

@@ -0,0 +1,35 @@
+package net.glenmazza.sfclient.model;
+
+public class AccountUpdateCompositeRecord extends CompositeEntityRecord {
+
+    private final Body body = new Body();
+    public AccountUpdateCompositeRecord(String referenceId) {
+        super("Account", Method.PATCH, referenceId);
+    }
+
+    public Body getBody() {
+        return body;
+    }
+
+    public static class Body {
+
+        public int numberOfEmployees;
+        public String site;
+
+        public int getNumberOfEmployees() {
+            return numberOfEmployees;
+        }
+
+        public void setNumberOfEmployees(int numberOfEmployees) {
+            this.numberOfEmployees = numberOfEmployees;
+        }
+
+        public String getSite() {
+            return site;
+        }
+
+        public void setSite(String site) {
+            this.site = site;
+        }
+    }
+}

sf_client/src/itest/java/net/glenmazza/sfclient/service/RESTServicesTest.java

@@ -3,12 +3,18 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
+
 import net.glenmazza.sfclient.TestApplication;
 import net.glenmazza.sfclient.model.AccountCreateRecord;
+import net.glenmazza.sfclient.model.AccountInsertCompositeRecord;
 import net.glenmazza.sfclient.model.AccountMultipleEntityRecord;
 import net.glenmazza.sfclient.model.AccountQueryRecord;
+import net.glenmazza.sfclient.model.AccountUpdateCompositeRecord;
 import net.glenmazza.sfclient.model.AccountUpdateRecord;
 import net.glenmazza.sfclient.model.ApexAccountRecord;
+import net.glenmazza.sfclient.model.CompositeEntityRecord;
+import net.glenmazza.sfclient.model.CompositeEntityRecordRequest;
+import net.glenmazza.sfclient.model.CompositeEntityRecordResponse;
 import net.glenmazza.sfclient.model.MultipleEntityRecord;
 import net.glenmazza.sfclient.model.MultipleEntityRecord201Response;
 import net.glenmazza.sfclient.model.MultipleEntityRecord400ResponseException;
@@ -30,18 +36,17 @@
 
 import java.time.LocalDate;
 import java.time.temporal.ChronoUnit;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
-
 /**
  * Test cases cover the three AbstractRESTService subclasses supporting Salesforce entity calls, Apex endpoints,
  * and SOQLQueries.
- *
  * Will need to have your test Salesforce instance configured in application-test.properties~template.  Also,
  * the Apex REST test requires a certain Apex endpoint to be installed see the header for that
  * test for more info.
@@ -61,6 +66,9 @@ public class RESTServicesTest {
     @Autowired
     private SalesforceMultipleRecordInserter smri;
 
+    @Autowired
+    private SalesforceCompositeRequestService scrs;
+
     @Autowired
     private ApexRESTCaller arc;
 
@@ -78,7 +86,7 @@ public static void initialize() {
     void testSalesforceRecordManagerInsertsGetsAndSOQLQueries() throws JsonProcessingException {
         // insert first Account via Class & SOQL query
         AccountCreateRecord acr = new AccountCreateRecord();
-        String account1Name = "Test Account " + LocalDate.now();
+        String account1Name = "ACR Test Account " + LocalDate.now();
         acr.setName(account1Name);
         acr.setSite("Philadelphia");
         acr.setNumberOfEmployees(25);
@@ -98,7 +106,7 @@ void testSalesforceRecordManagerInsertsGetsAndSOQLQueries() throws JsonProcessin
 
         // create via Map
         Map<String, Object> accountViaMap = new HashMap<>();
-        String account2Name = "Test Account 2 " + LocalDate.now();
+        String account2Name = "ACR Test Account 2 " + LocalDate.now();
         accountViaMap.put("Name", account2Name);
         accountViaMap.put("Site", "Baltimore");
         accountViaMap.put("NumberOfEmployees", 30);
@@ -188,8 +196,11 @@ void testSalesforceRecordManagerUpdates() throws JsonProcessingException {
         srm.deleteObject("Account", rcr1.getId());
     }
 
+
+    // Note if this test fails, may be necessary to delete Test MER Account1 and 2 that it creates
+    // from Salesforce CRM.  This test requires that neither exist in SF prior to running.
     @Test
-    void testMultipleEntityRecordInsertions() throws JsonProcessingException {
+    void testMultipleEntityRecordInsertionsAndCompositeCalls() throws JsonProcessingException {
         AccountMultipleEntityRecord amer = new AccountMultipleEntityRecord("111");
         amer.setName("Test MER Account1");
         amer.setSite("Raleigh");
@@ -212,11 +223,77 @@ void testMultipleEntityRecordInsertions() throws JsonProcessingException {
         MultipleEntityRecord201Response response = smri.bulkInsert("Account", merr);
         assertEquals(2, response.getResults().size());
 
-        // method also deletes objects once done comparing
-        queryAndConfirmValues(response, amer);
-        queryAndConfirmValues(response, amer2);
-
-        // now test exception handling:  will activate by having both accounts have the same reference ID.
+        String acct1SfId = queryAndConfirmMultipleRecordValues(response, amer);
+        String acct2SfId = queryAndConfirmMultipleRecordValues(response, amer2);
+
+        // use the Composite objects to update the values
+        AccountUpdateCompositeRecord aucr1 = new AccountUpdateCompositeRecord(acct1SfId);
+        aucr1.getBody().setNumberOfEmployees(30);
+        aucr1.getBody().setSite("Asheville");
+
+        AccountUpdateCompositeRecord aucr2 = new AccountUpdateCompositeRecord(acct2SfId);
+        aucr2.getBody().setNumberOfEmployees(40);
+        aucr2.getBody().setSite("Greensboro");
+
+        // ...and add a third company, note SF ID not known yet, so just choosing a unique ref ID
+        AccountInsertCompositeRecord aicr = new AccountInsertCompositeRecord("mythirdcompany");
+        aicr.getBody().setName("Test MER Account3");
+        aicr.getBody().setSite("Winston-Salem");
+        aicr.getBody().setNumberOfEmployees(25);
+
+        CompositeEntityRecordRequest cerReq = new CompositeEntityRecordRequest(false);
+        List<? extends CompositeEntityRecord> compList = new ArrayList<>(List.of(aucr1, aucr2, aicr));
+        cerReq.setCompositeRequest(compList);
+
+        CompositeEntityRecordResponse cerr = scrs.bulkProcess(cerReq);
+
+        queryAndConfirmCompositeValues(acct1SfId, aucr1);
+        queryAndConfirmCompositeValues(acct2SfId, aucr2);
+
+        // test that create worked fine
+        String acct3SfId = (String) cerr.getCompositeResponse().get(2).getSuccessResultsMap().get("id");
+
+        AccountCreateRecord acr = srm.getObject("Account",
+                acct3SfId, AccountCreateRecord.class);
+
+        List<CompositeEntityRecordResponse.Result> results = cerr.getCompositeResponse();
+        assertEquals(201, results.get(2).getHttpStatusCode());
+        assertEquals("mythirdcompany", results.get(2).getReferenceId());
+        Map<String, Object> body = results.get(2).getSuccessResultsMap();
+        assertEquals(true, body.get("success"));
+        assertEquals(aicr.getBody().getName(), acr.getName());
+        assertEquals(aicr.getBody().getSite(), acr.getSite());
+        assertEquals(aicr.getBody().getNumberOfEmployees(), acr.getNumberOfEmployees());
+        srm.deleteObject("Account", acct3SfId);
+
+        // now test composite errors, will attempt to update Acct 1 even though it doesn't exist anymore
+        srm.deleteObject("Account", acct1SfId);
+        aucr2.getBody().setNumberOfEmployees(50);
+        aucr2.getBody().setSite("Durham");
+
+        cerr = scrs.bulkProcess(cerReq);
+
+        results = cerr.getCompositeResponse();
+        assertEquals(400, results.get(0).getHttpStatusCode());
+        assertEquals(acct1SfId, results.get(0).getReferenceId());
+        List<Map<String, Object>> errors = results.get(0).getErrorResultsList();
+        assertEquals("ENTITY_IS_DELETED", errors.get(0).get("errorCode"));
+        assertEquals("entity is deleted", errors.get(0).get("message"));
+        assertEquals(0, ((List<?>) errors.get(0).get("fields")).size());
+
+        assertEquals(200, results.get(1).getHttpStatusCode());
+        assertEquals(acct2SfId, results.get(1).getReferenceId());
+        body = results.get(1).getSuccessResultsMap();
+        assertEquals(acct2SfId, body.get("id"));
+        assertEquals(true, body.get("success"));
+        assertEquals(false, body.get("created"));
+
+        // check update occurred for success case
+        queryAndConfirmCompositeValues(acct2SfId, aucr2);
+
+        srm.deleteObject("Account", acct2SfId);
+
+        // now test Multiple Entry exception handling:  will activate by having both accounts have the same reference ID.
         amer2.setAttributes(new MultipleEntityRecord.Attributes("Account", "111"));
 
         /* Error response should be:
@@ -261,7 +338,7 @@ void testMultipleEntityRecordInsertions() throws JsonProcessingException {
         assertEquals("Duplicate ReferenceId provided in the request.", message);
     }
 
-    private void queryAndConfirmValues(MultipleEntityRecord201Response response, AccountMultipleEntityRecord amer)
+    private String queryAndConfirmMultipleRecordValues(MultipleEntityRecord201Response response, AccountMultipleEntityRecord amer)
             throws JsonProcessingException {
         String accountSfId = response.getResults().stream()
                 .filter(r -> amer.getAttributes().getReferenceId().equals(r.getReferenceId()))
@@ -275,7 +352,16 @@ private void queryAndConfirmValues(MultipleEntityRecord201Response response, Acc
         assertEquals(acr.getRating().name(), amer.getRating().name());
         assertEquals(acr.getLeadDate(), amer.getLeadDate());
 
-        srm.deleteObject("Account", accountSfId);
+        return accountSfId;
+    }
+
+    private void queryAndConfirmCompositeValues(String accountSfId, AccountUpdateCompositeRecord aucr)
+            throws JsonProcessingException {
+
+        // query and check values
+        AccountCreateRecord acr = srm.getObject("Account", accountSfId, AccountCreateRecord.class);
+        assertEquals(aucr.getBody().getSite(), acr.getSite());
+        assertEquals(aucr.getBody().getNumberOfEmployees(), acr.getNumberOfEmployees());
     }
 
     @Test

sf_client/src/main/java/net/glenmazza/sfclient/model/CompositeEntityRecord.java

@@ -0,0 +1,54 @@
+package net.glenmazza.sfclient.model;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+
+/**
+ * Support for
+ * <a href="https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_composite_post.htm">Composite calls</a>,
+ * max of 25 subrequests per call.
+ * For bulk inserts where each insert has no relation to the others MultipleEntityRecord is preferred, as it
+ * has a 200 max per call.
+ */
+public abstract class CompositeEntityRecord {
+
+    @JsonIgnore
+    private final String entity;
+    private final String referenceId;
+    private final Method method;
+
+    private String url;
+
+    public CompositeEntityRecord(String entity, Method method, String referenceId) {
+        this.entity = entity;
+        this.method = method;
+        this.referenceId = referenceId;
+    }
+
+    // entity represents the type of object the CRUD action applies to (Contact, Account, etc.)
+
+    public String getEntity() {
+        return entity;
+    }
+
+    public String getUrl() {
+        return url;
+    }
+
+    public void setUrl(String url) {
+        this.url = url;
+    }
+
+    public String getReferenceId() {
+        return referenceId;
+    }
+
+    public Method getMethod() {
+        return method;
+    }
+
+    public enum Method {
+        PATCH, // updates
+        POST; // inserts
+    }
+
+}

sf_client/src/main/java/net/glenmazza/sfclient/model/CompositeEntityRecordRequest.java

@@ -0,0 +1,31 @@
+package net.glenmazza.sfclient.model;
+
+import java.util.List;
+
+public class CompositeEntityRecordRequest {
+
+    // allOrNone: if true, error in one causes rollback of all.
+    // https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_composite.htm
+    // requiring in constructor as it is an important property
+    public CompositeEntityRecordRequest(boolean allOrNone) {
+        this.allOrNone = allOrNone;
+    }
+
+    List<? extends CompositeEntityRecord> compositeRequest;
+
+    //
+    boolean allOrNone;
+
+    public List<? extends CompositeEntityRecord> getCompositeRequest() {
+        return compositeRequest;
+    }
+
+    public void setCompositeRequest(List<? extends CompositeEntityRecord> compositeRequest) {
+        this.compositeRequest = compositeRequest;
+    }
+
+    public boolean isAllOrNone() {
+        return allOrNone;
+    }
+
+}