Merge pull request #140 from contentstack/fix/DX-1529

fix: preserve order of response object

Author: reeshika-h

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.contentstack.sdk</groupId>
     <artifactId>java</artifactId>
-    <version>2.0.0</version>
+    <version>2.0.1</version>
     <packaging>jar</packaging>
     <name>contentstack-java</name>
     <description>Java SDK for Contentstack Content Delivery API</description>
@@ -17,7 +17,7 @@
         <maven.compiler.source>1.8</maven.compiler.source>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <surefire-report-plugin.version>2.22.0</surefire-report-plugin.version>
-        <maven-source-plugin.version>2.2.1</maven-source-plugin.version>
+        <maven-source-plugin.version>3.3.1</maven-source-plugin.version>
         <maven-javadoc-plugin.version>3.4.1</maven-javadoc-plugin.version>
         <dotenv-source.version>3.0.0</dotenv-source.version>
         <rxjava-source.version>3.1.8</rxjava-source.version>
@@ -183,6 +183,12 @@
             <version>${json-simple-version}</version>
             <scope>compile</scope>
         </dependency>
+
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.15.2</version>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/com/contentstack/sdk/CSHttpConnection.java

@@ -2,9 +2,11 @@
 
 import okhttp3.Request;
 import okhttp3.ResponseBody;
+
 import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
+
 import retrofit2.Call;
 import retrofit2.Response;
 
@@ -20,6 +22,10 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.stream.IntStream;
+import com.fasterxml.jackson.databind.ObjectMapper; // Jackson for JSON parsing
+import com.fasterxml.jackson.databind.json.JsonMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.fasterxml.jackson.databind.type.MapType;
 
 import static com.contentstack.sdk.Constants.*;
 
@@ -186,6 +192,14 @@ public void send() {
         }
     }
 
+    private JSONObject createOrderedJSONObject(Map<String, Object> map) {
+        JSONObject json = new JSONObject();
+        for (Map.Entry<String, Object> entry : map.entrySet()) {
+            json.put(entry.getKey(), entry.getValue());
+        }
+        return json;
+    }
+
     private void getService(String requestUrl) throws IOException {
 
         this.headers.put(X_USER_AGENT_KEY, "contentstack-delivery-java/" + SDK_VERSION);
@@ -210,16 +224,22 @@ private void getService(String requestUrl) throws IOException {
                 if (request != null) {
                     response = pluginResponseImp(request, response);
                 }
-                String responseBody = response.body().string();
                 try {
-                    responseJSON = new JSONObject(responseBody);
+                    // Use Jackson to parse the JSON while preserving order
+                    ObjectMapper mapper = JsonMapper.builder().build();
+                    MapType type = mapper.getTypeFactory().constructMapType(LinkedHashMap.class, String.class,
+                            Object.class);
+                    Map<String, Object> responseMap = mapper.readValue(response.body().string(), type);
+
+                    // Use the custom method to create an ordered JSONObject
+                    responseJSON = createOrderedJSONObject(responseMap);
                     if (this.config.livePreviewEntry != null && !this.config.livePreviewEntry.isEmpty()) {
                         handleJSONArray();
                     }
                     connectionRequest.onRequestFinished(CSHttpConnection.this);
                 } catch (JSONException e) {
                     // Handle non-JSON response
-                    setError("Invalid JSON response: " + responseBody);
+                    setError("Invalid JSON response");
                 }
             } else {
                 assert response.errorBody() != null;