DHFPROD-3193: language is now replaced with lang when loading artifacts

Also fixed javadoc error in Mapping.java

Author: rjrudin

marklogic-data-hub/src/main/java/com/marklogic/hub/deploy/commands/LoadUserArtifactsCommand.java

@@ -15,6 +15,9 @@
  */
 package com.marklogic.hub.deploy.commands;
 
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.marklogic.appdeployer.AppConfig;
 import com.marklogic.appdeployer.command.AbstractCommand;
 import com.marklogic.appdeployer.command.CommandContext;
@@ -28,8 +31,10 @@
 import com.marklogic.client.ext.util.DefaultDocumentPermissionsParser;
 import com.marklogic.client.ext.util.DocumentPermissionsParser;
 import com.marklogic.client.io.DocumentMetadataHandle;
+import com.marklogic.client.io.JacksonHandle;
 import com.marklogic.client.io.StringHandle;
 import com.marklogic.hub.HubConfig;
+import com.marklogic.mgmt.util.ObjectMapperFactory;
 import org.apache.commons.io.IOUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.core.io.Resource;
@@ -41,6 +46,7 @@
 import java.nio.file.*;
 import java.nio.file.attribute.BasicFileAttributes;
 import java.util.Date;
+import java.util.Iterator;
 import java.util.regex.Pattern;
 
 /**
@@ -53,15 +59,18 @@ public class LoadUserArtifactsCommand extends AbstractCommand {
     private HubConfig hubConfig;
 
     private DocumentPermissionsParser documentPermissionsParser = new DefaultDocumentPermissionsParser();
+    private ObjectMapper objectMapper;
 
     public void setForceLoad(boolean forceLoad) {
         this.forceLoad = forceLoad;
     }
 
     private boolean forceLoad = false;
 
+
     public LoadUserArtifactsCommand() {
         super();
+        this.objectMapper = ObjectMapperFactory.getObjectMapper();
         setExecuteSortOrder(SortOrderConstants.DEPLOY_TRIGGERS + 1);
     }
 
@@ -279,19 +288,60 @@ private void addResourceToWriteSets(
     ) throws IOException {
         if (forceLoad || propertiesModuleManager.hasFileBeenModifiedSinceLastLoaded(r.getFile())) {
             InputStream inputStream = r.getInputStream();
-            StringHandle handle = new StringHandle(IOUtils.toString(inputStream));
-            inputStream.close();
-            for (DocumentWriteSet writeSet: writeSets) {
-                writeSet.add(docId, meta, handle);
+
+            JsonNode json;
+            try {
+                json = objectMapper.readTree(inputStream);
+            } finally {
+                inputStream.close();
+            }
+
+            if (json instanceof ObjectNode && json.has("language")) {
+                json = replaceLanguageWithLang((ObjectNode)json);
+                try {
+                    objectMapper.writeValue(r.getFile(), json);
+                } catch (Exception ex) {
+                    logger.warn("Unable to replace 'language' with 'lang' in artifact file: " + r.getFile().getAbsolutePath()
+                        + ". You should replace 'language' with 'lang' yourself in this file. Error cause: " + ex.getMessage(), ex);
+                }
+            }
+
+            for (DocumentWriteSet writeSet : writeSets) {
+                writeSet.add(docId, meta, new JacksonHandle(json));
             }
             propertiesModuleManager.saveLastLoadedTimestamp(r.getFile(), new Date());
         }
     }
 
+    /**
+     * Per DHFPROD-3193 and an update to MarkLogic 10.0-2, "lang" must now be used instead of "language". To ensure that
+     * a user artifact is never loaded with "language", this command handles both updating the JSON that will be loaded
+     * into MarkLogic and updating the artifact file.
+     *
+     * @param object
+     * @return
+     */
+    protected ObjectNode replaceLanguageWithLang(ObjectNode object) {
+        ObjectNode newObject = objectMapper.createObjectNode();
+        newObject.put("lang", object.get("language").asText());
+        Iterator<String> fieldNames = object.fieldNames();
+        while (fieldNames.hasNext()) {
+            String fieldName = fieldNames.next();
+            if (!"language".equals(fieldName)) {
+                newObject.set(fieldName, object.get(fieldName));
+            }
+        }
+        return newObject;
+    }
+
     public void setHubConfig(HubConfig hubConfig) {
         this.hubConfig = hubConfig;
     }
 
+    public void setObjectMapper(ObjectMapper objectMapper) {
+        this.objectMapper = objectMapper;
+    }
+
     abstract class ResourceToURI {
         public abstract String toURI(Resource r) throws IOException;
     }

marklogic-data-hub/src/main/java/com/marklogic/hub/mapping/Mapping.java

@@ -135,7 +135,7 @@ static Mapping create(String mappingName, HubEntity entity) {
     /**
      * *CAREFUL - DO NOT TOUCH IF YOU DON'T EXPLICITLY KNOW WHAT THIS VALUE REPRESENTS*
      * Sets the language for the mapping to use for MarkLogic server
-     * @param language - sets the language key for the server - don't modify please!
+     * @param lang - sets the language key for the server - don't modify please!
      */
     void setLang(String lang);
 

marklogic-data-hub/src/test/java/com/marklogic/hub/deploy/commands/LoadUserArtifactsCommandTest.java

@@ -15,8 +15,10 @@
  */
 package com.marklogic.hub.deploy.commands;
 
+import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.marklogic.hub.HubTestBase;
 import com.marklogic.hub.ApplicationConfig;
+import com.marklogic.mgmt.util.ObjectMapperFactory;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -27,8 +29,7 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
-import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
 
 
 @ExtendWith(SpringExtension.class)
@@ -40,6 +41,20 @@ public void setup() {
         loadUserArtifactsCommand.setHubConfig(getDataHubAdminConfig());
     }
 
+    @Test
+    public void replaceLanguageWithLang() {
+        ObjectNode object = ObjectMapperFactory.getObjectMapper().createObjectNode();
+        object.put("language", "zxx");
+        object.put("something", "else");
+
+        object = loadUserArtifactsCommand.replaceLanguageWithLang(object);
+        assertEquals("zxx", object.get("lang").asText());
+        assertEquals("else", object.get("something").asText());
+        assertFalse(object.has("language"));
+        assertEquals("lang", object.fieldNames().next(),
+            "lang should still be the first field name in the JSON object");
+    }
+
     @Test
     public void testIsEntityDir() {
         Path startPath = Paths.get("/tmp/my-project/plugins/entities");