Merge pull request #197 from marklogic-community/feature/187-json-comments

rjrudin · web-flow · commit 90e682c4a059 · 2017-11-01T07:45:34.000-04:00
#187 JSON payloads now allow comments
diff --git a/src/main/java/com/marklogic/appdeployer/command/clusters/ModifyLocalClusterCommand.java b/src/main/java/com/marklogic/appdeployer/command/clusters/ModifyLocalClusterCommand.java
@@ -24,8 +24,7 @@ public void execute(CommandContext context) {
 		if (configDir != null && configDir.exists()) {
 			for (File f : configDir.listFiles()) {
 				if (f.isFile() && f.getName().startsWith("local-cluster")) {
-					String payload = copyFileToString(f);
-					payload = payloadTokenReplacer.replaceTokens(payload, context.getAppConfig(), false);
+					String payload = copyFileToString(f, context);
 					new ClusterManager(context.getManageClient()).modifyLocalCluster(payload, context.getAdminManager());
 				}
 			}
diff --git a/src/main/java/com/marklogic/appdeployer/export/impl/AbstractResourceExporter.java b/src/main/java/com/marklogic/appdeployer/export/impl/AbstractResourceExporter.java
@@ -9,6 +9,7 @@
 import com.marklogic.mgmt.ManageClient;
 import com.marklogic.mgmt.PayloadParser;
 import com.marklogic.mgmt.resource.ResourceManager;
+import com.marklogic.mgmt.util.ObjectMapperFactory;
 import org.springframework.util.FileCopyUtils;
 
 import java.io.File;
@@ -29,7 +30,7 @@ public abstract class AbstractResourceExporter extends LoggingObject implements
 
 	protected AbstractResourceExporter(ManageClient manageClient) {
 		this.manageClient = manageClient;
-		this.objectMapper = new ObjectMapper();
+		this.objectMapper = ObjectMapperFactory.getObjectMapper();
 	}
 
 	protected boolean isFormatXml() {
@@ -42,7 +43,7 @@ protected String removeJsonKeyFromPayload(String payload, String key) {
 			if (node.has(key)) {
 				node.remove(key);
 				try {
-					return payloadParser.getObjectMapper().writeValueAsString(node);
+					return ObjectMapperFactory.getObjectMapper().writeValueAsString(node);
 				} catch (JsonProcessingException e) {
 					throw new RuntimeException("Unable to write forest JSON out as string: " + e.getMessage(), e);
 				}
diff --git a/src/main/java/com/marklogic/appdeployer/scaffold/ScaffoldGenerator.java b/src/main/java/com/marklogic/appdeployer/scaffold/ScaffoldGenerator.java
@@ -9,6 +9,7 @@
 import com.marklogic.appdeployer.AppConfig;
 import com.marklogic.appdeployer.util.RestApiUtil;
 import com.marklogic.client.ext.helper.LoggingObject;
+import com.marklogic.mgmt.util.ObjectMapperFactory;
 import org.springframework.util.FileCopyUtils;
 
 import java.io.File;
@@ -19,10 +20,13 @@
  */
 public class ScaffoldGenerator extends LoggingObject {
 
-	protected ObjectMapper objectMapper = new ObjectMapper();
+	protected ObjectMapper objectMapper;
 	private PrettyPrinter prettyPrinter = new DefaultPrettyPrinter();
 
 	public void generateScaffold(String path, AppConfig config) {
+		if (objectMapper == null) {
+			objectMapper = ObjectMapperFactory.getObjectMapper();
+		}
 		File rootDir = new File(path);
 
 		File configDir = getConfigDir(rootDir);
@@ -232,4 +236,11 @@ protected File getModulesDir(File rootDir) {
 		return new File(rootDir, "src/main/ml-modules");
 	}
 
+	public void setObjectMapper(ObjectMapper objectMapper) {
+		this.objectMapper = objectMapper;
+	}
+
+	public void setPrettyPrinter(PrettyPrinter prettyPrinter) {
+		this.prettyPrinter = prettyPrinter;
+	}
 }
diff --git a/src/main/java/com/marklogic/appdeployer/util/RestApiUtil.java b/src/main/java/com/marklogic/appdeployer/util/RestApiUtil.java
@@ -4,11 +4,12 @@
 import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.marklogic.mgmt.util.ObjectMapperFactory;
 
 public abstract class RestApiUtil {
 
 	public static String buildDefaultRestApiJson() {
-        ObjectMapper m = new ObjectMapper();
+        ObjectMapper m = ObjectMapperFactory.getObjectMapper();
         ObjectNode node = m.createObjectNode();
         ObjectNode n = node.putObject("rest-api");
         n.put("name", "%%NAME%%");
diff --git a/src/main/java/com/marklogic/mgmt/DefaultManageConfigFactory.java b/src/main/java/com/marklogic/mgmt/DefaultManageConfigFactory.java
@@ -66,6 +66,12 @@ public ManageConfig newManageConfig() {
 		    c.setConfigureSimpleSsl(Boolean.parseBoolean(prop));
 	    }
 
+	    prop = getProperty("mlManageCleanJsonPayloads");
+	    if (prop != null) {
+	    	logger.info("Cleaning Management API JSON payloads: " + prop);
+	    	c.setCleanJsonPayloads(Boolean.parseBoolean(prop));
+	    }
+
 	    prop = getProperty("mlAdminUsername");
         if (prop != null) {
             logger.info("Manage admin username: " + prop);
diff --git a/src/main/java/com/marklogic/mgmt/ManageClient.java b/src/main/java/com/marklogic/mgmt/ManageClient.java
@@ -1,6 +1,8 @@
 package com.marklogic.mgmt;
 
+import com.fasterxml.jackson.databind.JsonNode;
 import com.marklogic.client.ext.helper.LoggingObject;
+import com.marklogic.mgmt.util.ObjectMapperFactory;
 import com.marklogic.rest.util.Fragment;
 import com.marklogic.rest.util.RestTemplateUtil;
 import org.jdom2.Namespace;
@@ -9,6 +11,8 @@
 import org.springframework.util.MultiValueMap;
 import org.springframework.web.client.RestTemplate;
 
+import java.io.IOException;
+import java.io.StringWriter;
 import java.net.URI;
 import java.util.ArrayList;
 import java.util.List;
@@ -22,6 +26,7 @@ public class ManageClient extends LoggingObject {
     private ManageConfig manageConfig;
     private RestTemplate restTemplate;
     private RestTemplate adminRestTemplate;
+	private PayloadParser payloadParser;
 
     /**
      * Can use this constructor when the default values in ManageConfig will work.
@@ -187,13 +192,44 @@ public void deleteAsAdmin(String path) {
         adminRestTemplate.delete(buildUri(path));
     }
 
-    public HttpEntity<String> buildJsonEntity(String json) {
+	/**
+	 * Per #187 and version 3.1.0, when an HttpEntity is constructed with a JSON payload, this method will check to see
+	 * if it should "clean" the JSON via the Jackson library, which is primarily intended for removing comments from
+	 * JSON (comments that Jackson allows, but aren't allowed by the JSON spec). This behavior is disabled by default.
+	 *
+	 * @param json
+	 * @return
+	 */
+	public HttpEntity<String> buildJsonEntity(String json) {
         HttpHeaders headers = new HttpHeaders();
         headers.setContentType(MediaType.APPLICATION_JSON);
+        if (manageConfig != null && manageConfig.isCleanJsonPayloads()) {
+        	json = cleanJsonPayload(json);
+        }
         return new HttpEntity<String>(json, headers);
     }
 
-    public HttpEntity<String> buildXmlEntity(String xml) {
+	/**
+	 * Per #187, and version 3.1.0, this will also use Jackson to remove any comments in the JSON payload, as Jackson
+	 * is now configured to ignore comments, but we still don't want to include them in the payload sent to MarkLogic.
+	 * @param payload
+	 * @return
+	 */
+	protected String cleanJsonPayload(String payload) {
+		if (payloadParser == null) {
+			payloadParser = new PayloadParser();
+		}
+		JsonNode node = payloadParser.parseJson(payload);
+		StringWriter sw = new StringWriter();
+		try {
+			ObjectMapperFactory.getObjectMapper().writer().writeValue(sw, node);
+		} catch (IOException ex) {
+			throw new RuntimeException("Unable to write JSON payload as JsonNode back out to a string, cause: " + ex.getMessage());
+		}
+		return sw.toString();
+	}
+
+	public HttpEntity<String> buildXmlEntity(String xml) {
         HttpHeaders headers = new HttpHeaders();
         headers.setContentType(MediaType.APPLICATION_XML);
         return new HttpEntity<String>(xml, headers);
@@ -213,7 +249,7 @@ protected void logAdminRequest(String path, String contentType, String method) {
         }
     }
 
-    public URI buildUri(String path) {
+	public URI buildUri(String path) {
         return manageConfig.buildUri(path);
     }
 
diff --git a/src/main/java/com/marklogic/mgmt/ManageConfig.java b/src/main/java/com/marklogic/mgmt/ManageConfig.java
@@ -21,6 +21,7 @@ public class ManageConfig extends RestConfig {
     private boolean adminConfigureSimpleSsl;
     private String adminScheme = "http";
     private int adminPort = 8001;
+    private boolean cleanJsonPayloads = false;
 
     public ManageConfig() {
         this("localhost", DEFAULT_PASSWORD);
@@ -81,4 +82,12 @@ public String getAdminScheme() {
 	public void setAdminScheme(String adminScheme) {
 		this.adminScheme = adminScheme;
 	}
+
+	public boolean isCleanJsonPayloads() {
+		return cleanJsonPayloads;
+	}
+
+	public void setCleanJsonPayloads(boolean cleanJsonPayloads) {
+		this.cleanJsonPayloads = cleanJsonPayloads;
+	}
 }
diff --git a/src/main/java/com/marklogic/mgmt/PayloadParser.java b/src/main/java/com/marklogic/mgmt/PayloadParser.java
@@ -1,17 +1,22 @@
 package com.marklogic.mgmt;
 
+import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.marklogic.mgmt.util.ObjectMapperFactory;
 import com.marklogic.rest.util.Fragment;
 
 /**
  * Utility class for parsing a JSON or XML payload and extracting values.
  */
 public class PayloadParser {
 
-    private ObjectMapper objectMapper = new ObjectMapper();
+    private ObjectMapper objectMapper;
 
     public JsonNode parseJson(String json) {
+    	if (objectMapper == null) {
+    		objectMapper = ObjectMapperFactory.getObjectMapper();
+	    }
         try {
             return objectMapper.readTree(json);
         } catch (Exception e) {
@@ -43,6 +48,9 @@ public String getPayloadFieldValue(String payload, String fieldName) {
     }
 
     public boolean isJsonPayload(String payload) {
+    	if (payload == null) {
+    		return false;
+	    }
         String s = payload.trim();
         return s.startsWith("{") || s.startsWith("[");
     }
diff --git a/src/main/java/com/marklogic/mgmt/api/API.java b/src/main/java/com/marklogic/mgmt/api/API.java
@@ -1,6 +1,7 @@
 package com.marklogic.mgmt.api;
 
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
@@ -28,6 +29,7 @@
 import com.marklogic.mgmt.resource.groups.GroupManager;
 import com.marklogic.mgmt.resource.security.*;
 import com.marklogic.mgmt.resource.tasks.TaskManager;
+import com.marklogic.mgmt.util.ObjectMapperFactory;
 import com.marklogic.mgmt.util.SimplePropertySource;
 import com.marklogic.mgmt.util.SystemPropertySource;
 
@@ -73,14 +75,7 @@ protected void initializeAdminManager() {
     }
 
     protected ObjectMapper buildDefaultObjectMapper() {
-        ObjectMapper m = new ObjectMapper();
-        m.setPropertyNamingStrategy(new LowerCaseWithHyphensStrategy());
-        m.setSerializationInclusion(Include.NON_NULL);
-        m.enable(SerializationFeature.INDENT_OUTPUT);
-        m.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
-        // This is needed at least for localname on Element instances
-        m.configure(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY, true);
-        return m;
+        return ObjectMapperFactory.getObjectMapper();
     }
 
     /**
diff --git a/src/main/java/com/marklogic/mgmt/resource/security/CertificateTemplateManager.java b/src/main/java/com/marklogic/mgmt/resource/security/CertificateTemplateManager.java
@@ -1,9 +1,9 @@
 package com.marklogic.mgmt.resource.security;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
-import com.marklogic.mgmt.resource.AbstractResourceManager;
 import com.marklogic.mgmt.ManageClient;
+import com.marklogic.mgmt.resource.AbstractResourceManager;
+import com.marklogic.mgmt.util.ObjectMapperFactory;
 import com.marklogic.rest.util.Fragment;
 import org.springframework.http.ResponseEntity;
 
@@ -54,7 +54,7 @@ public ResponseEntity<String> generateTemporaryCertificate(String templateIdOrNa
 
     public ResponseEntity<String> generateTemporaryCertificate(String templateIdOrName, String commonName,
             int validFor, String dnsName, String ipAddress, boolean ifNecessary) {
-        ObjectNode node = new ObjectMapper().createObjectNode();
+        ObjectNode node = ObjectMapperFactory.getObjectMapper().createObjectNode();
         node.put("operation", "generate-temporary-certificate");
         node.put("valid-for", validFor);
         node.put("common-name", commonName);
@@ -75,7 +75,7 @@ public ResponseEntity<String> generateTemporaryCertificate(String templateIdOrNa
     }
 
     public Fragment getCertificatesForTemplate(String templateIdOrName) {
-        ObjectNode node = new ObjectMapper().createObjectNode();
+        ObjectNode node = ObjectMapperFactory.getObjectMapper().createObjectNode();
         node.put("operation", "get-certificates-for-template");
 
         String json = node.toString();
diff --git a/src/main/java/com/marklogic/mgmt/util/ObjectMapperFactory.java b/src/main/java/com/marklogic/mgmt/util/ObjectMapperFactory.java
@@ -0,0 +1,63 @@
+package com.marklogic.mgmt.util;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.marklogic.mgmt.api.LowerCaseWithHyphensStrategy;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Static factory class that is intended to be a single point of construction of a Jackson ObjectMapper that is used
+ * throughout the ml-app-deployer library. The single ObjectMapper can be customized via an ObjectMapperInitializer
+ * instance.
+ */
+public abstract class ObjectMapperFactory {
+
+	private static ObjectMapper objectMapper;
+	private static List<ObjectMapperInitializer> objectMapperInitializers;
+
+	public static void addObjectMapperInitializer(ObjectMapperInitializer initializer) {
+		if (objectMapperInitializers == null) {
+			objectMapperInitializers = new ArrayList<>();
+		}
+		objectMapperInitializers.add(initializer);
+	}
+
+	public static ObjectMapper getObjectMapper() {
+		if (objectMapper == null) {
+			initializeObjectMapper();
+		}
+		return objectMapper;
+	}
+
+	/**
+	 * All of the default settings here originated in the API.java class. Then #187 resulted in comments being allowed.
+	 * Most of the settings only matter for when Resource objects are being written to JSON via Jackson annotations.
+	 */
+	private static void initializeObjectMapper() {
+		objectMapper = new ObjectMapper();
+		objectMapper.enable(JsonParser.Feature.ALLOW_COMMENTS);
+		objectMapper.setPropertyNamingStrategy(new LowerCaseWithHyphensStrategy());
+		objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+		objectMapper.enable(SerializationFeature.INDENT_OUTPUT);
+		objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
+		// This is needed at least for localname on Element instances
+		objectMapper.configure(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY, true);
+
+		if (objectMapperInitializers != null) {
+			for (ObjectMapperInitializer initializer : objectMapperInitializers) {
+				initializer.initializeObjectMapper(objectMapper);
+			}
+		}
+	}
+}
+
+interface ObjectMapperInitializer {
+
+	void initializeObjectMapper(ObjectMapper objectMapper);
+
+}
diff --git a/src/main/java/com/marklogic/rest/util/JsonNodeUtil.java b/src/main/java/com/marklogic/rest/util/JsonNodeUtil.java
@@ -1,24 +1,23 @@
 package com.marklogic.rest.util;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.marklogic.mgmt.util.ObjectMapperFactory;
 
 import java.io.File;
 import java.util.*;
 
 public class JsonNodeUtil {
 
     public static JsonNode mergeJsonFiles(List<File> files) {
-        ObjectMapper m = new ObjectMapper();
         List<JsonNode> nodes = new ArrayList<>();
         Set<String> fieldNames = new HashSet<>();
         for (File f : files) {
             if (f.exists()) {
                 JsonNode node = null;
                 try {
-                    node = m.readTree(f);
+                    node = ObjectMapperFactory.getObjectMapper().readTree(f);
                 } catch (Exception e) {
                     throw new RuntimeException("Unable to read JSON from file: " + f.getAbsolutePath(), e);
                 }
diff --git a/src/test/java/com/marklogic/appdeployer/command/security/DeployRoleWithCommentsTest.java b/src/test/java/com/marklogic/appdeployer/command/security/DeployRoleWithCommentsTest.java
diff --git a/src/test/java/com/marklogic/mgmt/TestConfig.java b/src/test/java/com/marklogic/mgmt/TestConfig.java
diff --git a/src/test/resources/sample-app/src/main/ml-config/security/roles/sample-app-role1.json b/src/test/resources/sample-app/src/main/ml-config/security/roles/sample-app-role1.json

Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,7 @@ public void execute(CommandContext context) {`
`24`	`24`	`if (configDir != null && configDir.exists()) {`
`25`	`25`	`for (File f : configDir.listFiles()) {`
`26`	`26`	`if (f.isFile() && f.getName().startsWith("local-cluster")) {`
`27`		`- String payload = copyFileToString(f);`
`28`		`- payload = payloadTokenReplacer.replaceTokens(payload, context.getAppConfig(), false);`
	`27`	`+ String payload = copyFileToString(f, context);`
`29`	`28`	`new ClusterManager(context.getManageClient()).modifyLocalCluster(payload, context.getAdminManager());`
`30`	`29`	`}`
`31`	`30`	`}`