json sanitizer refactor to reduce decoding encoding redundancy

Author: zahidblackduck

detectable/src/main/java/com/blackduck/integration/detectable/util/JsonSanitizer.java

@@ -1,19 +1,11 @@
 package com.blackduck.integration.detectable.util;
 
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
 import com.google.gson.JsonSyntaxException;
 
 public class JsonSanitizer {
-    private static final Gson GSON = new GsonBuilder()
-        .disableHtmlEscaping()
-        .serializeNulls()
-        .create();
-
-    public static String sanitize(String json) throws JsonSyntaxException {
-        JsonObject jsonObject = JsonParser.parseString(json).getAsJsonObject();
-        return GSON.toJson(jsonObject);
+    public static JsonObject sanitize(String json) throws JsonSyntaxException {
+        return JsonParser.parseString(json).getAsJsonObject();
     }
 }

detectable/src/test/java/com/blackduck/integration/detectable/util/JsonSanitizerTest.java

@@ -1,55 +1,105 @@
 package com.blackduck.integration.detectable.util;
 
+import com.google.gson.JsonObject;
 import com.google.gson.JsonSyntaxException;
-import static org.junit.jupiter.api.Assertions.*;
 import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
-public class JsonSanitizerTest {
-
+class JsonSanitizerTest {
     @Test
-    void testValidJsonNoDuplicates() {
-        String input = "{\"name\": \"John\", \"age\": 30}";
-        String expected = "{\"name\":\"John\",\"age\":30}";
-        String actual = JsonSanitizer.sanitize(input);
-        assertEquals(expected, actual);
+    void testValidJson() {
+        String json = "{ " +
+            "\"name\": \"my-project\", " +
+            "\"version\": \"1.0.0\", " +
+            "\"private\": true, " +
+            "\"scripts\": { " +
+            "\"start\": \"node index.js\", " +
+            "\"test\": \"jest\"" +
+            "}, " +
+            "\"dependencies\": { " +
+            "\"express\": \"^4.17.1\", " +
+            "\"lodash\": \"^4.17.21\"" +
+            "}, " +
+            "\"devDependencies\": { " +
+            "\"jest\": \"^27.0.0\", " +
+            "\"eslint\": \"^7.32.0\"" +
+            "}" +
+            "}";
+
+        JsonObject sanitized = JsonSanitizer.sanitize(json);
+
+        assertEquals("my-project", sanitized.get("name").getAsString());
+        assertEquals("1.0.0", sanitized.get("version").getAsString());
+        assertTrue(sanitized.get("private").getAsBoolean());
+        assertEquals("node index.js", sanitized.getAsJsonObject("scripts").get("start").getAsString());
+        assertEquals("^4.17.1", sanitized.getAsJsonObject("dependencies").get("express").getAsString());
+        assertEquals("^27.0.0", sanitized.getAsJsonObject("devDependencies").get("jest").getAsString());
     }
 
     @Test
-    void testValidJsonWithDuplicates() {
-        String input = "{\"name\": \"John\", \"name\": \"Doe\", \"age\": 30}";
-        String expected = "{\"name\":\"Doe\",\"age\":30}";
-        String actual = JsonSanitizer.sanitize(input);
-        assertEquals(expected, actual);
+    void testDuplicateKeysInDependencies() {
+        String json = "{ " +
+            "\"dependencies\": { " +
+            "\"express\": \"^4.17.1\", " +
+            "\"express\": \"^5.0.0\"" +
+            "}" +
+            "}";
+
+        JsonObject sanitized = JsonSanitizer.sanitize(json);
+
+        assertEquals("^5.0.0", sanitized.getAsJsonObject("dependencies").get("express").getAsString()); // Last value is kept
     }
 
     @Test
-    void testNestedJsonWithDuplicates() {
-        String input = "{\"person\": {\"name\": \"John\", \"name\": \"Doe\"}, \"age\": 30}";
-        String expected = "{\"person\":{\"name\":\"Doe\"},\"age\":30}";
-        String actual = JsonSanitizer.sanitize(input);
-        assertEquals(expected, actual);
+    void testNestedScriptsAndDependencies() {
+        String json = "{ " +
+            "\"scripts\": { " +
+            "\"build\": \"tsc\", " +
+            "\"start\": \"node dist/index.js\"" +
+            "}, " +
+            "\"dependencies\": { " +
+            "\"typescript\": \"^4.0.0\", " +
+            "\"node-fetch\": \"^2.6.1\"" +
+            "}" +
+            "}";
+
+        JsonObject sanitized = JsonSanitizer.sanitize(json);
+
+        assertEquals("tsc", sanitized.getAsJsonObject("scripts").get("build").getAsString());
+        assertEquals("^4.0.0", sanitized.getAsJsonObject("dependencies").get("typescript").getAsString());
     }
 
     @Test
     void testInvalidJson() {
-        String invalidJson = "{\"name\":\"example\",\"version\":}";
-        assertThrows(JsonSyntaxException.class, () -> {
-            JsonSanitizer.sanitize(invalidJson);
-        });
+        String json = "{ " +
+            "\"name\": \"my-project\", " +
+            "\"version\": \"1.0.0\"";
+
+        assertThrows(JsonSyntaxException.class, () -> JsonSanitizer.sanitize(json));
     }
 
     @Test
-    void testEmptyJson() {
-        String emptyJson = "{}";
-        String sanitizedJson = JsonSanitizer.sanitize(emptyJson);
-        assertEquals(emptyJson, sanitizedJson);
+    void testEmptyPackageJson() {
+        String json = "{}";
+
+        JsonObject sanitized = JsonSanitizer.sanitize(json);
+        assertTrue(sanitized.entrySet().isEmpty());
     }
 
     @Test
     void testJsonWithNullValues() {
-        String input = "{\"name\": null, \"age\": 30}";
-        String expected = "{\"name\":null,\"age\":30}";
-        String actual = JsonSanitizer.sanitize(input);
-        assertEquals(expected, actual);
+        String json = "{ " +
+            "\"name\": \"my-project\", " +
+            "\"version\": null, " +
+            "\"dependencies\": { " +
+            "\"express\": \"^4.17.1\", " +
+            "\"lodash\": null " +
+            "} " +
+            "}";
+
+        JsonObject sanitized = JsonSanitizer.sanitize(json);
+
+        assertTrue(sanitized.get("version").isJsonNull());
+        assertTrue(sanitized.getAsJsonObject("dependencies").get("lodash").isJsonNull());
     }
 }