feat(api) response deserialization should only skip top level for specific response types (#1062)

* feat(api) response deserialization should only skip top level for specific response types

* Add null check back in

Author: richardmcclellan

aws-api-appsync/src/main/java/com/amplifyframework/api/graphql/GsonResponseAdapters.java

@@ -15,6 +15,8 @@
 
 package com.amplifyframework.api.graphql;
 
+import com.amplifyframework.core.model.Model;
+import com.amplifyframework.datastore.appsync.ModelWithMetadata;
 import com.amplifyframework.util.GsonObjectConverter;
 import com.amplifyframework.util.TypeMaker;
 
@@ -72,20 +74,24 @@ public GraphQLResponse<Object> deserialize(JsonElement json, Type typeOfT, JsonD
             JsonElement jsonErrors = null;
 
             if (jsonObject.has(DATA_KEY)) {
-                jsonData = skipQueryLevel(jsonObject.get(DATA_KEY));
+                jsonData = jsonObject.get(DATA_KEY);
             }
+
             if (jsonObject.has(ERRORS_KEY)) {
                 jsonErrors = jsonObject.get(ERRORS_KEY);
             }
 
             List<GraphQLResponse.Error> errors = parseErrors(jsonErrors, context);
 
             if (!(typeOfT instanceof ParameterizedType)) {
-                throw new JsonParseException("Expected a parameterized type during list deserialization.");
+                throw new JsonParseException("Expected a parameterized type during GraphQLResponse deserialization.");
             }
 
             // Because typeOfT is ParameterizedType we can be sure this is a safe cast.
             final Type templateClassType = ((ParameterizedType) typeOfT).getActualTypeArguments()[0];
+            if (shouldSkipQueryLevel(templateClassType)) {
+                jsonData = skipQueryLevel(jsonData);
+            }
 
             if (jsonData == null || jsonData.isJsonNull()) {
                 return new GraphQLResponse<>(null, errors);
@@ -95,6 +101,24 @@ public GraphQLResponse<Object> deserialize(JsonElement json, Type typeOfT, JsonD
             }
         }
 
+        private boolean shouldSkipQueryLevel(Type type) {
+            if (type instanceof ParameterizedType) {
+                final Type rawType = ((ParameterizedType) type).getRawType();
+                if (ModelWithMetadata.class.equals(rawType)) {
+                    return true;
+                }
+                if (Iterable.class.isAssignableFrom((Class<?>) rawType)) {
+                    return true;
+                }
+            } else {
+                if (Model.class.isAssignableFrom((Class<?>) type)) {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
         // Skips a JSON level to get content of query, not query itself
         private JsonElement skipQueryLevel(JsonElement jsonData) throws JsonParseException {
             if (jsonData == null || jsonData.isJsonNull()) {

aws-api/src/test/java/com/amplifyframework/api/aws/GsonGraphQLResponseFactoryTest.java

@@ -80,9 +80,9 @@ public void nullDataNullErrorsReturnsEmptyResponseObject() throws ApiException {
             Resources.readAsString("null-gql-response.json");
 
         // Act! Parse it into a model.
-
-        final GraphQLResponse<ListTodosResult> response =
-            responseFactory.buildResponse(null, nullResponseJson, ListTodosResult.class);
+        Type responseType = TypeMaker.getParameterizedType(PaginatedResult.class, Todo.class);
+        final GraphQLResponse<PaginatedResult<Todo>> response =
+            responseFactory.buildResponse(null, nullResponseJson, responseType);
 
         // Assert that the model is constructed without content
         assertNotNull(response);
@@ -104,9 +104,10 @@ public void partialResponseRendersWithTodoDataAndErrors() throws ApiException {
             Resources.readAsString("partial-gql-response.json");
 
         // Act! Parse it into a model.
-        GraphQLRequest<ListTodosResult> request = buildDummyRequest(ListTodosResult.class);
-        final GraphQLResponse<ListTodosResult> response =
-            responseFactory.buildResponse(request, partialResponseJson, ListTodosResult.class);
+        Type responseType = TypeMaker.getParameterizedType(PaginatedResult.class, Todo.class);
+        GraphQLRequest<PaginatedResult<Todo>> request = buildDummyRequest(responseType);
+        final GraphQLResponse<PaginatedResult<Todo>> response =
+            responseFactory.buildResponse(request, partialResponseJson, responseType);
 
         // Assert that the model contained things...
         assertNotNull(response);
@@ -116,7 +117,7 @@ public void partialResponseRendersWithTodoDataAndErrors() throws ApiException {
         // Assert that all of the fields of the different todos
         // match what we would expect from a manual inspection of the
         // JSON.
-        final List<Todo> actualTodos = response.getData().getItems();
+        final Iterable<Todo> actualTodos = response.getData().getItems();
 
         final List<Todo> expectedTodos = Arrays.asList(
             Todo.builder()
@@ -246,8 +247,9 @@ public void errorResponseDeserializesExtensionsMap() throws ApiException {
                 Resources.readAsString("error-extensions-gql-response.json");
 
         // Act! Parse it into a model.
-        final GraphQLResponse<ListTodosResult> response =
-                responseFactory.buildResponse(null, partialResponseJson, ListTodosResult.class);
+        Type responseType = TypeMaker.getParameterizedType(PaginatedResult.class, Todo.class);
+        final GraphQLResponse<PaginatedResult<Todo>> response =
+                responseFactory.buildResponse(null, partialResponseJson, responseType);
 
         // Build the expected response.
         String message = "Conflict resolver rejects mutation.";
@@ -273,7 +275,7 @@ public void errorResponseDeserializesExtensionsMap() throws ApiException {
         extensions.put("data", data);
 
         GraphQLResponse.Error expectedError = new GraphQLResponse.Error(message, locations, path, extensions);
-        GraphQLResponse<ListTodosResult> expectedResponse = new GraphQLResponse<>(null,
+        GraphQLResponse<PaginatedResult<Todo>> expectedResponse = new GraphQLResponse<>(null,
                 Arrays.asList(expectedError, expectedError, expectedError, expectedError));
 
         // Assert that the response is expected
@@ -295,8 +297,9 @@ public void errorWithNullFieldsCanBeParsed() throws ApiException {
         final String responseJson = Resources.readAsString("error-null-properties.json");
 
         // Act! Parse it into a model.
-        final GraphQLResponse<ListTodosResult> response =
-                responseFactory.buildResponse(null, responseJson, ListTodosResult.class);
+        Type responseType = TypeMaker.getParameterizedType(PaginatedResult.class, Todo.class);
+        final GraphQLResponse<PaginatedResult<Todo>> response =
+                responseFactory.buildResponse(null, responseJson, responseType);
 
         // Build the expected response.
         Map<String, Object> extensions = new HashMap<>();
@@ -306,7 +309,7 @@ public void errorWithNullFieldsCanBeParsed() throws ApiException {
 
         GraphQLResponse.Error expectedError =
             new GraphQLResponse.Error("the message", null, null, extensions);
-        GraphQLResponse<ListTodosResult> expectedResponse =
+        GraphQLResponse<PaginatedResult<Todo>> expectedResponse =
             new GraphQLResponse<>(null, Collections.singletonList(expectedError));
 
         // Assert that the response is expected
@@ -332,7 +335,7 @@ public void partialResponseCanBeRenderedAsStringType() throws JSONException, Api
 
         // Assert that the response data is just the data block as a JSON string
         assertEquals(
-                partialResponseJson.getJSONObject("data").getJSONObject("listTodos").toString(),
+                partialResponseJson.getJSONObject("data").toString(),
                 response.getData()
         );
     }
@@ -428,10 +431,11 @@ public void awsDateTypesCanBeDeserialized() throws ApiException {
         // Act
         final String responseString = Resources.readAsString("list-meetings-response.json");
 
-        GraphQLRequest<ListMeetingsResult> request = buildDummyRequest(ListMeetingsResult.class);
-        final GraphQLResponse<ListMeetingsResult> response =
-                responseFactory.buildResponse(request, responseString, ListMeetingsResult.class);
-        final List<Meeting> actualMeetings = response.getData().getItems();
+        Type responseType = TypeMaker.getParameterizedType(PaginatedResult.class, Meeting.class);
+        GraphQLRequest<PaginatedResult<Meeting>> request = buildDummyRequest(responseType);
+        final GraphQLResponse<PaginatedResult<Meeting>> response =
+                responseFactory.buildResponse(request, responseString, responseType);
+        final Iterable<Meeting> actualMeetings = response.getData().getItems();
 
         // Assert
         assertEquals(expectedMeetings, actualMeetings);