[CSL-2299] Add on_missing parameter support (#117)

stanlp1 · web-flow · commit 097ce5f2c18b · 2023-04-24T16:30:37.000-07:00
* Add on missing support

* Add default
diff --git a/constructorio-client/src/main/java/io/constructor/client/CatalogRequest.java b/constructorio-client/src/main/java/io/constructor/client/CatalogRequest.java
@@ -5,9 +5,16 @@
 
 /** Constructor.io Catalog Request */
 public class CatalogRequest {
+    public enum OnMissing {
+        FAIL,
+        IGNORE,
+        CREATE,
+    }
+
     private Map<String, File> files;
     private String section;
     private String notificationEmail;
+    private OnMissing onMissing;
     private Boolean force;
 
     /**
@@ -26,6 +33,24 @@ public CatalogRequest(Map<String, File> files, String section) {
 
         this.files = files;
         this.section = section;
+        this.onMissing = OnMissing.FAIL;
+    }
+
+    /**
+     * @param onMissing Either "FAIL", "CREATE", "IGNORE", indicating what to do when a missing item
+     *     is uploaded for patch requests. "FAIL" will fail the patch catalog request if an item
+     *     does not exist. "CREATE" will create the item if it does not exist. "IGNORE" will ignore
+     *     items that do not exist. Defaults to "FAIL". Only applicable to patchCatalog requests.
+     */
+    public void setOnMissing(OnMissing onMissing) {
+        this.onMissing = onMissing;
+    }
+
+    /**
+     * @return the onMissing strategy
+     */
+    public OnMissing getOnMissing() {
+        return onMissing;
     }
 
     /**
diff --git a/constructorio-client/src/main/java/io/constructor/client/ConstructorIO.java b/constructorio-client/src/main/java/io/constructor/client/ConstructorIO.java
@@ -469,13 +469,21 @@ public boolean deleteVariations(
      * @param section the section of the autocomplete that you're modifying the item for.
      * @param force whether or not the system should process the request even if it will invalidate
      *     a large number of existing variations.
+     * @param onMissing Either "FAIL", "IGNORE", "CREATE", indicating how the system will handle
+     *     updating items that don't exist. "FAIL" fails the ingestion if there are items that don't
+     *     exist. "IGNORE" ignores items that don't exist. "CREATE" creates items that don't exist.
+     *     Defaults to "FAIL".
      * @param notificationEmail An email address where you'd like to receive an email notification
      *     in case the task fails.
      * @return true if successfully modified
      * @throws ConstructorException if the request is invalid.
      */
     public boolean updateItems(
-            ConstructorItem[] items, String section, Boolean force, String notificationEmail)
+            ConstructorItem[] items,
+            String section,
+            Boolean force,
+            String notificationEmail,
+            CatalogRequest.OnMissing onMissing)
             throws ConstructorException {
         try {
             HttpUrl url = this.makeUrl(Arrays.asList("v2", "items"));
@@ -492,6 +500,10 @@ public boolean updateItems(
                                 .build();
             }
 
+            if (onMissing != null && onMissing != CatalogRequest.OnMissing.FAIL) {
+                url = url.newBuilder().addQueryParameter("on_missing", onMissing.name()).build();
+            }
+
             Map<String, Object> data = new HashMap<String, Object>();
             List<Object> itemsAsJSON = new ArrayList<Object>();
             for (ConstructorItem item : items) {
@@ -511,18 +523,36 @@ public boolean updateItems(
         }
     }
 
+    /**
+     * Updates items from your index.
+     *
+     * @param items the items that you're updating
+     * @param section the section of the autocomplete that you're modifying the item for.
+     * @param force whether or not the system should process the request even if it will invalidate
+     *     a large number of existing variations.
+     * @param notificationEmail An email address where you'd like to receive an email notification
+     *     in case the task fails.
+     * @return true if successfully modified
+     * @throws ConstructorException if the request is invalid.
+     */
+    public boolean updateItems(
+            ConstructorItem[] items, String section, Boolean force, String notificationEmail)
+            throws ConstructorException {
+        return updateItems(items, section, force, notificationEmail, null);
+    }
+
     public boolean updateItems(ConstructorItem[] items) throws ConstructorException {
-        return updateItems(items, "Products", false, null);
+        return updateItems(items, "Products", false, null, null);
     }
 
     public boolean updateItems(ConstructorItem[] items, String section)
             throws ConstructorException {
-        return updateItems(items, section, false, null);
+        return updateItems(items, section, false, null, null);
     }
 
     public boolean updateItems(ConstructorItem[] items, String section, Boolean force)
             throws ConstructorException {
-        return updateItems(items, section, force, null);
+        return updateItems(items, section, force, null, null);
     }
 
     /**
@@ -534,14 +564,19 @@ public boolean updateItems(ConstructorItem[] items, String section, Boolean forc
      *     a large number of existing variations.
      * @param notificationEmail An email address where you'd like to receive an email notification
      *     in case the task fails.
+     * @param onMissing Either "FAIL", "IGNORE", "CREATE", indicating how the system will handle
+     *     updating variations that don't exist. "FAIL" fails the ingestion if there are items that
+     *     don't exist. "IGNORE" ignores variations that don't exist. "CREATE" creates items that
+     *     don't exist. Defaults to "FAIL".
      * @return true if successfully modified
      * @throws ConstructorException if the request is invalid.
      */
     public boolean updateVariations(
             ConstructorVariation[] variations,
             String section,
             Boolean force,
-            String notificationEmail)
+            String notificationEmail,
+            CatalogRequest.OnMissing onMissing)
             throws ConstructorException {
         try {
             HttpUrl url = this.makeUrl(Arrays.asList("v2", "variations"));
@@ -557,6 +592,9 @@ public boolean updateVariations(
                                 .addQueryParameter("notification_email", notificationEmail)
                                 .build();
             }
+            if (onMissing != null && onMissing != CatalogRequest.OnMissing.FAIL) {
+                url = url.newBuilder().addQueryParameter("on_missing", onMissing.name()).build();
+            }
 
             Map<String, Object> data = new HashMap<String, Object>();
             List<Object> variationsAsJSON = new ArrayList<Object>();
@@ -577,19 +615,44 @@ public boolean updateVariations(
         }
     }
 
+    /**
+     * Update variations from your index.
+     *
+     * @param variations the variations that you're updating.
+     * @param section the section of the autocomplete that you're modifying the item for.
+     * @param force whether or not the system should process the request even if it will invalidate
+     *     a large number of existing variations.
+     * @param notificationEmail An email address where you'd like to receive an email notification
+     *     in case the task fails.
+     * @return true if successfully modified
+     * @throws ConstructorException if the request is invalid.
+     */
+    public boolean updateVariations(
+            ConstructorVariation[] variations,
+            String section,
+            Boolean force,
+            String notificationEmail)
+            throws ConstructorException {
+        try {
+            return updateVariations(variations, section, force, notificationEmail, null);
+        } catch (Exception exception) {
+            throw new ConstructorException(exception);
+        }
+    }
+
     public boolean updateVariations(ConstructorVariation[] variations) throws ConstructorException {
-        return updateVariations(variations, "Products", false, null);
+        return updateVariations(variations, "Products", false, null, null);
     }
 
     public boolean updateVariations(ConstructorVariation[] variations, String section)
             throws ConstructorException {
-        return updateVariations(variations, section, false, null);
+        return updateVariations(variations, section, false, null, null);
     }
 
     public boolean updateVariations(
             ConstructorVariation[] variations, String section, Boolean force)
             throws ConstructorException {
-        return updateVariations(variations, section, force, null);
+        return updateVariations(variations, section, force, null, null);
     }
 
     /**
@@ -2251,6 +2314,9 @@ public String patchCatalog(CatalogRequest req) throws ConstructorException {
             if (force != null) {
                 urlBuilder.addQueryParameter("force", Boolean.toString(force));
             }
+            if (req.getOnMissing() != CatalogRequest.OnMissing.FAIL) {
+                urlBuilder.addQueryParameter("on_missing", req.getOnMissing().name());
+            }
 
             urlBuilder.addQueryParameter("patch_delta", Boolean.toString(true));
 
diff --git a/constructorio-client/src/test/java/io/constructor/client/ConstructorIOCatalogTest.java b/constructorio-client/src/test/java/io/constructor/client/ConstructorIOCatalogTest.java
@@ -355,6 +355,23 @@ public void PatchCatalogWithItemsAndForceShouldReturnTaskInfo() throws Exception
         assertTrue("task_status_path exists", jsonObj.has("task_status_path") == true);
     }
 
+    @Test
+    public void PatchCatalogWithItemsAndOnMissingShouldReturnTaskInfo() throws Exception {
+        ConstructorIO constructor = new ConstructorIO(token, apiKey, true, null);
+        Map<String, File> files = new HashMap<String, File>();
+        files.put("items", new File("src/test/resources/csv/items.csv"));
+
+        CatalogRequest req = new CatalogRequest(files, "Products");
+
+        req.setOnMissing(CatalogRequest.OnMissing.CREATE);
+
+        String response = constructor.patchCatalog(req);
+        JSONObject jsonObj = new JSONObject(response);
+
+        assertTrue("task_id exists", jsonObj.has("task_id") == true);
+        assertTrue("task_status_path exists", jsonObj.has("task_status_path") == true);
+    }
+
     @Test
     public void PatchCatalogWithItemsAndVariationsFilesShouldReturnTaskInfo() throws Exception {
         ConstructorIO constructor = new ConstructorIO(token, apiKey, true, null);
diff --git a/constructorio-client/src/test/java/io/constructor/client/ConstructorIOItemsTest.java b/constructorio-client/src/test/java/io/constructor/client/ConstructorIOItemsTest.java
@@ -95,7 +95,12 @@ public void updateItemsShouldReturnTrueWithAllParameters() throws Exception {
 
         assertTrue(
                 "update succeeds",
-                constructor.updateItems(itemsNew, "Products", true, "test@constructor.io"));
+                constructor.updateItems(
+                        itemsNew,
+                        "Products",
+                        true,
+                        "test@constructor.io",
+                        CatalogRequest.OnMissing.CREATE));
         addItemsToCleanUpArray(itemsNew);
     }
 
diff --git a/constructorio-client/src/test/java/io/constructor/client/ConstructorIOVariationsTest.java b/constructorio-client/src/test/java/io/constructor/client/ConstructorIOVariationsTest.java
@@ -107,7 +107,11 @@ public void updateVariationsShouldReturnTrueWithAllParameters() throws Exception
         assertTrue(
                 "update succeeds",
                 constructor.updateVariations(
-                        variationsNew, "Products", true, "test@constructor.io"));
+                        variationsNew,
+                        "Products",
+                        true,
+                        "test@constructor.io",
+                        CatalogRequest.OnMissing.CREATE));
         addVariationsToCleanUpArray(variationsNew);
     }
 
