feat: support Document type serialization (#429)

* feat: support Document type serialization

* style: use Document.ListBuilder

* test: test dependency change scope to test

* chore: remove extra comment

Author: WinterYukky

pom.xml

@@ -190,6 +190,11 @@
             <artifactId>s3</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>kendra</artifactId>
+            <scope>test</scope>
+        </dependency>
 
         <!-- https://mvnrepository.com/artifact/commons-io/commons-io -->
         <dependency>

src/main/java/software/amazon/cloudformation/proxy/aws/SdkPojoDeserializer.java

@@ -35,6 +35,9 @@
 import software.amazon.awssdk.core.SdkBytes;
 import software.amazon.awssdk.core.SdkField;
 import software.amazon.awssdk.core.SdkPojo;
+import software.amazon.awssdk.core.document.Document;
+import software.amazon.awssdk.core.document.Document.ListBuilder;
+import software.amazon.awssdk.core.document.Document.MapBuilder;
 import software.amazon.awssdk.core.protocol.MarshallingType;
 import software.amazon.awssdk.core.traits.ListTrait;
 import software.amazon.awssdk.core.traits.MapTrait;
@@ -151,8 +154,10 @@ private Object readObject(SdkField<?> field, JsonParser p, DeserializationContex
                     return readMap(field, p, ctxt);
                 } else if (type.equals(MarshallingType.SDK_POJO)) {
                     return readPojo(field.constructor().get(), p, ctxt);
+                } else if (type.equals(MarshallingType.DOCUMENT)) {
+                    return readDocument(field, p, ctxt);
                 }
-                throw new JsonMappingException(p, "Type mismatch, expecting " + type + " got Map/SdkPojo");
+                throw new JsonMappingException(p, "Type mismatch, expecting " + type + " got Map/SdkPojo/Document");
             }
 
             case START_ARRAY: {
@@ -204,6 +209,38 @@ private List<Object> readList(SdkField<?> field, JsonParser p, DeserializationCo
         return value;
     }
 
+    private Document readDocument(SdkField<?> field, JsonParser p, DeserializationContext ctxt) throws IOException {
+        switch (p.currentToken()) {
+            case VALUE_STRING:
+                return Document.fromString(p.getText());
+            case VALUE_TRUE:
+            case VALUE_FALSE:
+                return Document.fromBoolean(p.getBooleanValue());
+            case VALUE_NUMBER_FLOAT:
+            case VALUE_NUMBER_INT:
+                return Document.fromNumber(p.getText());
+            case START_ARRAY: {
+                ListBuilder builder = Document.listBuilder();
+                while (p.nextToken() != JsonToken.END_ARRAY) {
+                    builder.addDocument(readDocument(field, p, ctxt));
+                }
+                return builder.build();
+            }
+            case START_OBJECT:
+                MapBuilder builder = Document.mapBuilder();
+                while (p.nextToken() != JsonToken.END_OBJECT) {
+                    String fieldName = p.getCurrentName();
+                    p.nextToken();
+                    builder.putDocument(fieldName, readDocument(field, p, ctxt));
+                }
+                return builder.build();
+            case VALUE_NULL:
+                return Document.fromNull();
+            default:
+                throw new JsonMappingException(p, "Can not map type " + type + " as Document Token = " + p.currentToken());
+        }
+    }
+
     @Override
     public boolean isCachable() {
         return true;

src/main/java/software/amazon/cloudformation/proxy/aws/SdkPojoSerializer.java

@@ -23,10 +23,12 @@
 import java.math.BigDecimal;
 import java.time.Instant;
 import java.util.Collection;
+import java.util.List;
 import java.util.Map;
 import software.amazon.awssdk.core.SdkBytes;
 import software.amazon.awssdk.core.SdkField;
 import software.amazon.awssdk.core.SdkPojo;
+import software.amazon.awssdk.core.document.Document;
 import software.amazon.awssdk.core.protocol.MarshallingType;
 import software.amazon.awssdk.core.traits.ListTrait;
 import software.amazon.awssdk.core.traits.MapTrait;
@@ -75,6 +77,8 @@ private void writeObject(Object value, SdkField<?> sdkField, JsonGenerator gen,
             writeSdkList((Collection<Object>) value, sdkField, gen, serializers);
         } else if (type.equals(MarshallingType.MAP)) {
             writeSdkMap((Map<String, Object>) value, sdkField, gen, serializers);
+        } else if (type.equals(MarshallingType.DOCUMENT)) {
+            writeSdkDocument((Document) value, gen);
         }
     }
 
@@ -134,4 +138,36 @@ private void writeSdkMap(Map<String, Object> map, SdkField<?> sdkField, JsonGene
         }
         gen.writeEndObject();
     }
+
+    private void writeSdkDocument(Document document, JsonGenerator gen) throws IOException {
+        if (document == null) {
+            gen.writeNull();
+            return;
+        }
+        if (document.isMap()) {
+            Map<String, Document> map = document.asMap();
+            gen.writeStartObject();
+            for (Map.Entry<String, Document> each : map.entrySet()) {
+                gen.writeFieldName(each.getKey());
+                Document value = each.getValue();
+                writeSdkDocument(value, gen);
+            }
+            gen.writeEndObject();
+        } else if (document.isList()) {
+            gen.writeStartArray();
+            List<Document> collection = document.asList();
+            for (Document each : collection) {
+                writeSdkDocument(each, gen);
+            }
+            gen.writeEndArray();
+        } else if (document.isBoolean()) {
+            gen.writeBoolean(document.asBoolean());
+        } else if (document.isNumber()) {
+            gen.writeNumber(document.asNumber().stringValue());
+        } else if (document.isString()) {
+            gen.writeString(document.asString());
+        } else if (document.isNull()) {
+            gen.writeNull();
+        }
+    }
 }

src/test/java/software/amazon/cloudformation/proxy/aws/AWSServiceSerdeTest.java

@@ -34,6 +34,7 @@
 import software.amazon.awssdk.core.SdkBytes;
 import software.amazon.awssdk.core.SdkField;
 import software.amazon.awssdk.core.SdkPojo;
+import software.amazon.awssdk.core.document.Document;
 import software.amazon.awssdk.core.protocol.MarshallLocation;
 import software.amazon.awssdk.core.protocol.MarshallingType;
 import software.amazon.awssdk.core.traits.LocationTrait;
@@ -47,6 +48,9 @@
 import software.amazon.awssdk.services.cloudwatchevents.model.PutTargetsResultEntry;
 import software.amazon.awssdk.services.cloudwatchevents.model.Tag;
 import software.amazon.awssdk.services.cloudwatchevents.model.Target;
+import software.amazon.awssdk.services.kendra.model.DataSourceConfiguration;
+import software.amazon.awssdk.services.kendra.model.TemplateConfiguration;
+import software.amazon.awssdk.services.kendra.model.UpdateDataSourceRequest;
 import software.amazon.awssdk.utils.builder.SdkBuilder;
 import software.amazon.cloudformation.resource.Serializer;
 
@@ -433,4 +437,30 @@ public void typeMismatchError() {
         assertThat(exception.getMessage()).contains("Type mismatch, expecting " + MarshallingType.MAP + " got List type");
     }
 
+    @Test
+    public void documentFieldSerde() throws Exception {
+        Document template = Document.mapBuilder().putString("type", "S3")
+            .putDocument("connectionConfiguration",
+                Document.mapBuilder()
+                    .putDocument("repositoryEndpointMetadata", Document.mapBuilder().putString("BucketName", "mybucket").build())
+                    .build())
+            .putDocument("repositoryConfigurations",
+                Document.mapBuilder()
+                    .putDocument("document",
+                        Document.mapBuilder().putDocument("fieldMappings", Document.listBuilder()
+                            .addDocument(Document.mapBuilder().putString("indexFieldName", "foo")
+                                .putString("indexFieldType", "STRING").putString("dataSourceFieldName", "foo").build())
+                            .build()).build())
+                    .build())
+            .putBoolean("booleanValue", false).putNumber("numberValue", 1).putNull("nullValue").build();
+        UpdateDataSourceRequest request = UpdateDataSourceRequest.builder()
+            .configuration(DataSourceConfiguration.builder()
+                .templateConfiguration(TemplateConfiguration.builder().template(template).build()).build())
+            .id("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx").indexId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx").build();
+
+        String json = serializer.serialize(request);
+        UpdateDataSourceRequest deserialized = serializer.deserialize(json, new TypeReference<UpdateDataSourceRequest>() {
+        });
+        assertThat(deserialized).isEqualTo(request);
+    }
 }