Merge pull request #1657 from marklogic/feature/13687-backup

MLE-13687 Able to use onError in plan builder

Author: rjrudin

marklogic-client-api/src/main/java/com/marklogic/client/expression/PlanBuilder.java

@@ -227,32 +227,6 @@ protected PlanBuilder(
   */
   public abstract ServerExpression subtract(ServerExpression left, ServerExpression right);
   /**
-  * Add an error-handler to the Optic Pipeline to catch Optic Update runtime errors. The runtime errors are added in the errors column. If no error occurred the value of the error column is null. When added, the error-handler should be the last operator before op:result.
-  * @param action  The Optic Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.
-  * @return  a ModifyPlan object
-  */
-  public abstract ModifyPlan onError(String action);
-  /**
-  * Add an error-handler to the Optic Pipeline to catch Optic Update runtime errors. The runtime errors are added in the errors column. If no error occurred the value of the error column is null. When added, the error-handler should be the last operator before op:result.
-  * @param action  The Optic Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.
-  * @return  a ModifyPlan object
-  */
-  public abstract ModifyPlan onError(XsStringVal action);
-  /**
-  * Add an error-handler to the Optic Pipeline to catch Optic Update runtime errors. The runtime errors are added in the errors column. If no error occurred the value of the error column is null. When added, the error-handler should be the last operator before op:result.
-  * @param action  The Optic Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.
-  * @param errorColumn  Valid options are: "fail" - stop procesisng and "continue" - add an error to the error column and continue processing. See {@link PlanBuilder#col(XsStringVal)}
-  * @return  a ModifyPlan object
-  */
-  public abstract ModifyPlan onError(String action, String errorColumn);
-  /**
-  * Add an error-handler to the Optic Pipeline to catch Optic Update runtime errors. The runtime errors are added in the errors column. If no error occurred the value of the error column is null. When added, the error-handler should be the last operator before op:result.
-  * @param action  The Optic Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.
-  * @param errorColumn  Valid options are: "fail" - stop procesisng and "continue" - add an error to the error column and continue processing. See {@link PlanBuilder#col(XsStringVal)}
-  * @return  a ModifyPlan object
-  */
-  public abstract ModifyPlan onError(XsStringVal action, PlanExprCol errorColumn);
-  /**
   * Create a patch builder which can be used to chain patch operations.
   * @param contextPath  The context path to patch.
   * @return  a PatchBuilder object
@@ -1805,6 +1779,32 @@ public interface ModifyPlan extends PreparePlan, PlanBuilderBase.ModifyPlanBase
   * @return  a ModifyPlan object
   */
   public abstract ModifyPlan orderBy(PlanSortKeySeq keys);
+/**
+  * Add an error-handler to the Optic Pipeline to catch Optic Update runtime errors. The runtime errors are added in the errors column. If no error occurred the value of the error column is null. When added, the error-handler should be the last operator before op:result.
+  * @param action  Valid options are: "fail" - stop procesisng and "continue" - add an error to the error column and continue processing.
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan onError(String action);
+/**
+  * Add an error-handler to the Optic Pipeline to catch Optic Update runtime errors. The runtime errors are added in the errors column. If no error occurred the value of the error column is null. When added, the error-handler should be the last operator before op:result.
+  * @param action  Valid options are: "fail" - stop procesisng and "continue" - add an error to the error column and continue processing.
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan onError(XsStringVal action);
+/**
+  * Add an error-handler to the Optic Pipeline to catch Optic Update runtime errors. The runtime errors are added in the errors column. If no error occurred the value of the error column is null. When added, the error-handler should be the last operator before op:result.
+  * @param action  Valid options are: "fail" - stop procesisng and "continue" - add an error to the error column and continue processing.
+  * @param errorColumn  An optional error column which is not used in the plan. If this parameter is not passed in 'sys.errors' is used. See {@link PlanBuilder#col(XsStringVal)}
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan onError(String action, String errorColumn);
+/**
+  * Add an error-handler to the Optic Pipeline to catch Optic Update runtime errors. The runtime errors are added in the errors column. If no error occurred the value of the error column is null. When added, the error-handler should be the last operator before op:result.
+  * @param action  Valid options are: "fail" - stop procesisng and "continue" - add an error to the error column and continue processing.
+  * @param errorColumn  An optional error column which is not used in the plan. If this parameter is not passed in 'sys.errors' is used. See {@link PlanBuilder#col(XsStringVal)}
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan onError(XsStringVal action, PlanExprCol errorColumn);
 /**
   * Builds a patch operation including a sequence of inserts, replaces, replace-inserts and deletes.
   * @param docColumn  The document column which need to be patched. See {@link PlanBuilder#col(XsStringVal)}

marklogic-client-api/src/main/java/com/marklogic/client/impl/PlanBuilderImpl.java

@@ -856,36 +856,6 @@ public PlanJoinKey on(PlanExprCol left, PlanExprCol right) {
   }
 
 
-  @Override
-  public ModifyPlan onError(String action) {
-    return onError((action == null) ? (XsStringVal) null : xs.string(action));
-  }
-
-  
-  @Override
-  public ModifyPlan onError(XsStringVal action) {
-    if (action == null) {
-      throw new IllegalArgumentException("action parameter for onError() cannot be null");
-    }
-    return new PlanBuilderSubImpl.ModifyPlanSubImpl("op", "on-error", new Object[]{ action });
-  }
-
-  
-  @Override
-  public ModifyPlan onError(String action, String errorColumn) {
-    return onError((action == null) ? (XsStringVal) null : xs.string(action), (errorColumn == null) ? (PlanExprCol) null : exprCol(errorColumn));
-  }
-
-  
-  @Override
-  public ModifyPlan onError(XsStringVal action, PlanExprCol errorColumn) {
-    if (action == null) {
-      throw new IllegalArgumentException("action parameter for onError() cannot be null");
-    }
-    return new PlanBuilderSubImpl.ModifyPlanSubImpl("op", "on-error", new Object[]{ action, errorColumn });
-  }
-
-  
   @Override
   public ServerExpression or(ServerExpression... left) {
     if (left == null) {
@@ -2170,6 +2140,36 @@ public ModifyPlan notExistsJoin(ModifyPlan right, PlanJoinKeySeq keys, ServerExp
   }
 
 
+  @Override
+  public ModifyPlan onError(String action) {
+    return onError((action == null) ? (XsStringVal) null : xs.string(action));
+  }
+
+    
+  @Override
+  public ModifyPlan onError(XsStringVal action) {
+    if (action == null) {
+      throw new IllegalArgumentException("action parameter for onError() cannot be null");
+    }
+    return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "on-error", new Object[]{ action });
+  }
+
+    
+  @Override
+  public ModifyPlan onError(String action, String errorColumn) {
+    return onError((action == null) ? (XsStringVal) null : xs.string(action), (errorColumn == null) ? (PlanExprCol) null : exprCol(errorColumn));
+  }
+
+    
+  @Override
+  public ModifyPlan onError(XsStringVal action, PlanExprCol errorColumn) {
+    if (action == null) {
+      throw new IllegalArgumentException("action parameter for onError() cannot be null");
+    }
+    return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "on-error", new Object[]{ action, errorColumn });
+  }
+
+    
   @Override
   public ModifyPlan orderBy(PlanSortKeySeq keys) {
     if (keys == null) {

marklogic-client-api/src/test/java/com/marklogic/client/test/rows/OpticPatchTest.java

@@ -8,8 +8,10 @@
 import com.marklogic.client.io.JacksonHandle;
 import com.marklogic.client.io.StringHandle;
 import com.marklogic.client.test.Common;
+import com.marklogic.client.test.junit5.RequiresML11;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -21,6 +23,7 @@
  * These tests are not intended to be great examples of how to use patch operations, but
  * rather to provide some test coverage.
  */
+@ExtendWith(RequiresML11.class)
 public class OpticPatchTest extends AbstractOpticUpdateTest {
 
 	private static final String JSON_URI = "/a.json";
@@ -129,7 +132,7 @@ void replaceInsertChild() {
 			)).get(0).getContent("doc", new StringHandle()).get();
 
 		System.out.println(content);
-		assertTrue(content.contains("<parent xmlns=\"org:example\"><child>1</child>new text</parent>"),
+		assertTrue(content.contains("<parent xmlns=\"org:example\">new text</parent>"),
 			"Unexpected content: " + content);
 	}
 

marklogic-client-api/src/test/java/com/marklogic/client/test/rows/ValidateDocTest.java

@@ -15,6 +15,7 @@
  */
 package com.marklogic.client.test.rows;
 
+import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.marklogic.client.FailedRequestException;
 import com.marklogic.client.datamovement.DataMovementManager;
@@ -25,6 +26,7 @@
 import com.marklogic.client.expression.PlanBuilder;
 import com.marklogic.client.io.DocumentMetadataHandle;
 import com.marklogic.client.io.Format;
+import com.marklogic.client.io.JacksonHandle;
 import com.marklogic.client.io.StringHandle;
 import com.marklogic.client.row.RowRecord;
 import com.marklogic.client.test.Common;
@@ -83,6 +85,9 @@ public void testXmlSchemaWithLaxMode() {
 		expectedUris.forEach(uri -> assertTrue(persistedUris.contains(uri), "persistedUris does not contain " + uri));
 	}
 
+	/**
+	 * Shoehorning some test coverage of onError for the 11.2 server release into this test.
+	 */
 	@Test
 	public void testXmlSchemaWithStrictMode() {
 		String[][] triples = new String[][]{
@@ -94,11 +99,11 @@ public void testXmlSchemaWithStrictMode() {
 
 		String triplesXML =
 			"<sem:triples xmlns:sem=\"http://marklogic.com/semantics\">\n" +
-				String.join("\n", (String[]) Arrays
+				String.join("\n", Arrays
 					.stream(triples)
 					.map(triple ->
 						"<sem:triple>" +
-							"<sem:subject>" + triple[0] + "</sem:subject>" +
+							"<sem:subjectt>" + triple[0] + "</sem:subjectt>" +
 							"<sem:predicate>" + triple[1] + "</sem:predicate>" +
 							"<sem:object>" + triple[2] + "</sem:object>" +
 							"</sem:triple>"
@@ -112,21 +117,30 @@ public void testXmlSchemaWithStrictMode() {
 		}
 		docMgr.write(writeSet);
 
-		PlanBuilder.Plan plan = op
+		PlanBuilder.ModifyPlan plan = op
 			.fromDocUris(op.cts.directoryQuery("/acme/"))
 			.joinDoc(op.col("doc"), op.col("uri"))
-			.validateDoc(op.col("doc"),
-				op.schemaDefinition("xmlSchema").withMode("strict")
-			);
-		Iterator<RowRecord> rows = rowManager.resultRows(plan).iterator();
-		Set<String> uris = new HashSet<>();
-		while (rows.hasNext()) {
-			uris.add(rows.next().getString("uri"));
-		}
-		assertTrue(uris.size() == 4);
-		for (int i = 0; i < 4; i++) {
-			assertTrue(uris.contains("/acme/" + i + ".xml"), "uris does not contain /acme/" + i + ".xml");
-		}
+			.validateDoc(op.col("doc"), op.schemaDefinition("xmlSchema").withMode("strict"));
+
+		// Verify that "continue" results in errors being returned.
+		final String defaultErrorsColumn = "sys.errors";
+		resultRows(plan.onError("continue")).forEach(row -> {
+			JsonNode errors = row.getContent(defaultErrorsColumn, new JacksonHandle()).get();
+			assertEquals("Validation error", errors.get("message").asText());
+			assertTrue(errors.has("data"));
+			String errorMessage = errors.get("data").get(0).asText();
+			assertTrue(errorMessage.contains("Found sem:subjectt but expected"), "Unexpected error: "  + errorMessage);
+		});
+
+		// And verify a custom error column works.
+		resultRows(plan.onError("continue", "myErrors")).forEach(row -> {
+			JsonNode errors = row.getContent("myErrors", new JacksonHandle()).get();
+			assertEquals("Validation error", errors.get("message").asText());
+		});
+
+		// "fail" should throw an error.
+		FailedRequestException ex = assertThrows(FailedRequestException.class, () -> resultRows(plan.onError("fail")));
+		assertTrue(ex.getMessage().contains("Found sem:subjectt but expected"), "Unexpected error: " + ex.getMessage());
 	}
 
 	@Test