- fixes a bug where the serializer would only look at first level properties for additional data

Author: baywet

src/main/java/com/microsoft/graph/serializer/DefaultSerializer.java

@@ -223,65 +223,29 @@ else if (fieldObject instanceof IJsonBackedObject) {
 	public <T> String serializeObject(@Nonnull final T serializableObject) {
         Objects.requireNonNull(serializableObject, "parameter serializableObject cannot be null");
         logger.logDebug("Serializing type " + serializableObject.getClass().getSimpleName());
-		JsonElement outJsonTree = gson.toJsonTree(serializableObject);
-
-		if (serializableObject instanceof IJsonBackedObject) {
-			outJsonTree = getDataFromAdditionalDataManager(outJsonTree, serializableObject);
-		} else if (outJsonTree.isJsonObject()) {
-			final Field[] fields = serializableObject.getClass().getDeclaredFields();
-			JsonObject outJson = outJsonTree.getAsJsonObject();
-			for(Field field : fields) {
-				if(outJson.has(field.getName())) {
-					final Type[] interfaces = field.getType().getGenericInterfaces();
-					for(Type interfaceType : interfaces) {
-						if(interfaceType == IJsonBackedObject.class && outJson.get(field.getName()).isJsonObject()) {
-							try {
-								final JsonElement outdatedValue = outJson.remove(field.getName());
-								outJson.add(field.getName(), getDataFromAdditionalDataManager(outdatedValue.getAsJsonObject(), field.get(serializableObject)));
-							} catch (IllegalAccessException ex ) {
-								logger.logDebug("Couldn't access prop" + field.getName());
-							}
-							break;
-						}
-					}
-				}
-			}
-		}
-
-		return outJsonTree.toString();
-	}
-	private <T> JsonElement getDataFromAdditionalDataManager(JsonElement outJsonTree, final T serializableObject) {
-		final IJsonBackedObject serializableJsonObject = (IJsonBackedObject) serializableObject;
-		final AdditionalDataManager additionalData = serializableJsonObject.additionalDataManager();
-
-		// If the item is a valid Graph object, add its additional data
-		if (outJsonTree.isJsonObject()) {
-			final JsonObject outJson = outJsonTree.getAsJsonObject();
-
-			addAdditionalDataFromManagerToJson(additionalData, outJson);
-			getChildAdditionalData(serializableJsonObject, outJson);
-
-			return outJson;
-		} else {
-			return outJsonTree;
+		final JsonElement outJsonTree = gson.toJsonTree(serializableObject);
+		if(outJsonTree != null) {
+            getChildAdditionalData(serializableObject, outJsonTree);
+			return outJsonTree.toString();
 		}
+        return "";
 	}
-
 	/**
 	 * Recursively populates additional data for each child object
 	 *
 	 * @param serializableObject the child to get additional data for
 	 * @param outJson			the serialized output JSON to add to
 	 */
 	@SuppressWarnings("unchecked")
-	private void getChildAdditionalData(final IJsonBackedObject serializableObject, final JsonObject outJson) {
-		if(outJson == null)
+	private void getChildAdditionalData(final Object serializableObject, final JsonElement outJson) {
+		if(outJson == null || serializableObject == null || !outJson.isJsonObject())
 			return;
+        final JsonObject outJsonObject = outJson.getAsJsonObject();
 		// Use reflection to iterate through fields for eligible Graph children
 		for (java.lang.reflect.Field field : serializableObject.getClass().getFields()) {
 			try {
 				final Object fieldObject = field.get(serializableObject);
-				final JsonElement fieldJsonElement = outJson.get(field.getName());
+				final JsonElement fieldJsonElement = outJsonObject.get(field.getName());
 				if(fieldObject == null || fieldJsonElement == null)
 					continue;
 
@@ -296,7 +260,7 @@ private void getChildAdditionalData(final IJsonBackedObject serializableObject,
 						final Object child = pair.getValue();
 						final JsonElement childJsonElement = fieldJsonObject.get(pair.getKey().toString());
 						// If the item is a valid Graph object, add its additional data
-						addAdditionalDataFromJsonElementToJson(child, childJsonElement);
+						getChildAdditionalData(child, childJsonElement);
 					}
 				}
 				// If the object is a list of Graph objects, iterate through elements
@@ -306,11 +270,13 @@ else if (fieldObject instanceof List && fieldJsonElement.isJsonArray()) {
 					for (int index = 0; index < fieldObjectList.size(); index++) {
 						final Object item = fieldObjectList.get(index);
 						final JsonElement itemJsonElement = fieldArrayValue.get(index);
-						addAdditionalDataFromJsonElementToJson(item, itemJsonElement);
+						getChildAdditionalData(item, itemJsonElement);
 					}
-				}
-				// If the object is a valid Graph object, add its additional data
-				addAdditionalDataFromJsonElementToJson(fieldObject, fieldJsonElement);
+				} else if(fieldJsonElement.isJsonObject()) {
+                    // If the object is a valid Graph object, add its additional data
+					final JsonObject fieldJsonObject = fieldJsonElement.getAsJsonObject();
+                    addAdditionalDataFromJsonElementToJson(fieldObject, fieldJsonObject);
+                }
 			} catch (IllegalArgumentException | IllegalAccessException e) {
 				logger.logError("Unable to access child fields of " + serializableObject.getClass().getSimpleName(), e);
 			}
@@ -321,11 +287,10 @@ else if (fieldObject instanceof List && fieldJsonElement.isJsonArray()) {
 	 * Add each non-transient additional data property to the given JSON node
 	 *
 	 * @param item the object containing additional data
-	 * @param itemJsonElement	   the JSON node to add the additional data properties to
+	 * @param itemJsonObject	   the JSON node to add the additional data properties to
 	 */
-	private void addAdditionalDataFromJsonElementToJson (final Object item, final JsonElement itemJsonElement) {
-		if (item instanceof IJsonBackedObject && itemJsonElement.isJsonObject()) {
-			final JsonObject itemJsonObject = itemJsonElement.getAsJsonObject();
+	private void addAdditionalDataFromJsonElementToJson (final Object item, final JsonObject itemJsonObject) {
+		if (item instanceof IJsonBackedObject && itemJsonObject != null) {
 			final IJsonBackedObject serializableItem = (IJsonBackedObject) item;
 			final AdditionalDataManager itemAdditionalData = serializableItem.additionalDataManager();
 			addAdditionalDataFromManagerToJson(itemAdditionalData, itemJsonObject);

src/test/java/com/microsoft/graph/content/BatchRequestContentTest.java

@@ -4,6 +4,7 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
@@ -14,6 +15,7 @@
 import java.util.ArrayList;
 
 import com.google.gson.JsonObject;
+import com.google.gson.JsonPrimitive;
 import com.microsoft.graph.authentication.IAuthenticationProvider;
 import com.microsoft.graph.core.BaseClient;
 import com.microsoft.graph.core.IBaseClient;
@@ -235,4 +237,18 @@ public AdditionalDataManager additionalDataManager() {
         assertNotNull(step4.headers);
         assertEquals("application/octet-stream", step4.headers.get("content-type"));
     }
+    @Test
+    public void serializesAdditionalData() throws MalformedURLException {
+        IHttpRequest requestStep = mock(IHttpRequest.class);
+        when(requestStep.getRequestUrl()).thenReturn(new URL(testurl));
+        final BatchRequestContent batchRequest = new BatchRequestContent();
+        final String bindValue = "https://somebindvalue";
+        final BatchRequestTestBody body = new BatchRequestTestBody(); // using a dynamic implementation doesn't work as "this" maps to the current test class
+        body.additionalDataManager().put("teamsApp@odata.bind", new JsonPrimitive(bindValue));
+        batchRequest.addBatchRequestStep(requestStep, HttpMethod.POST, body);
+        final ISerializer serializer = new DefaultSerializer(mock(ILogger.class));
+        final String result = serializer.serializeObject(batchRequest);
+        assertNotNull(result);
+        assertTrue(result.contains(bindValue));
+    }
 }

src/test/java/com/microsoft/graph/content/BatchRequestTestBody.java

@@ -0,0 +1,30 @@
+package com.microsoft.graph.content;
+
+import javax.annotation.Nullable;
+
+import com.google.gson.JsonObject;
+import com.google.gson.annotations.Expose;
+import com.google.gson.annotations.SerializedName;
+import com.microsoft.graph.serializer.AdditionalDataManager;
+import com.microsoft.graph.serializer.IJsonBackedObject;
+import com.microsoft.graph.serializer.ISerializer;
+
+public class BatchRequestTestBody implements IJsonBackedObject {
+    @Expose
+    @Nullable
+    @SerializedName("id")
+    public String id;
+
+    @Override
+    public void setRawObject(ISerializer serializer, JsonObject json) {
+        // TODO Auto-generated method stub
+
+    }
+    final AdditionalDataManager manager = new AdditionalDataManager(this);
+
+    @Override
+    public AdditionalDataManager additionalDataManager() {
+        return manager;
+    }
+
+}