Accept null values in arrays

CHANGELOG.md

@@ -4,6 +4,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ## [Unreleased 3.0]
 ### Dependencies
 - Bumps `io.github.classgraph:classgraph` from 4.8.162 to 4.8.163
+- Bumps `org.owasp.dependencycheck` from 8.4.0 to 8.4.2
 
 This section is for maintaining a changelog for all breaking changes for the client that cannot be released in the 2.x line. All other non-breaking changes should be added to [Unreleased 2.x] section.
 
@@ -32,6 +33,7 @@ This section is for maintaining a changelog for all breaking changes for the cli
 ### Dependencies
 
 ### Changed
+- Allow null values in arrays ([#679](https://github.com/opensearch-project/opensearch-java/pull/679))
 
 ### Deprecated
 

java-client/build.gradle.kts

@@ -51,7 +51,7 @@ plugins {
     `java-library`
     `maven-publish`
     id("com.github.jk1.dependency-license-report") version "2.5"
-    id("org.owasp.dependencycheck") version "8.4.0"
+    id("org.owasp.dependencycheck") version "8.4.2"
     id("com.diffplug.spotless") version "6.22.0"
 }
 apply(plugin = "opensearch.repositories")

java-client/src/main/java/org/opensearch/client/json/JsonpDeserializerBase.java

@@ -335,8 +335,13 @@ public List<T> deserialize(JsonParser parser, JsonpMapper mapper, Event event) {
             if (event == Event.START_ARRAY) {
                 List<T> result = new ArrayList<>();
                 while ((event = parser.next()) != Event.END_ARRAY) {
-                    JsonpUtils.ensureAccepts(itemDeserializer, parser, event);
-                    result.add(itemDeserializer.deserialize(parser, mapper, event));
+                    // JSON null: add null unless the deserializer can handle it
+                    if (event == Event.VALUE_NULL && !itemDeserializer.accepts(event)) {
+                        result.add(null);
+                    } else {
+                        JsonpUtils.ensureAccepts(itemDeserializer, parser, event);
+                        result.add(itemDeserializer.deserialize(parser, mapper, event));
+                    }
                 }
                 return result;
             } else {

java-client/src/test/java/org/opensearch/client/opensearch/integTest/AbstractSearchRequestIT.java

@@ -0,0 +1,132 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.client.opensearch.integTest;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.arrayContaining;
+import static org.hamcrest.Matchers.hasSize;
+
+import java.io.IOException;
+import org.junit.Test;
+import org.opensearch.client.opensearch._types.FieldValue;
+import org.opensearch.client.opensearch._types.SortOrder;
+import org.opensearch.client.opensearch._types.mapping.Property;
+import org.opensearch.client.opensearch._types.query_dsl.Query;
+import org.opensearch.client.opensearch._types.query_dsl.TermQuery;
+import org.opensearch.client.opensearch.core.SearchRequest;
+import org.opensearch.client.opensearch.core.SearchResponse;
+import org.opensearch.client.opensearch.indices.SegmentSortOrder;
+
+public abstract class AbstractSearchRequestIT extends OpenSearchJavaClientTestCase {
+
+    @Test
+    public void shouldReturnSearcheResults() throws Exception {
+        final String index = "searches_request";
+        assertThat(
+            javaClient().indices()
+                .create(
+                    b -> b.index(index)
+                        .mappings(
+                            m -> m.properties("name", Property.of(p -> p.keyword(v -> v.docValues(true))))
+                                .properties("size", Property.of(p -> p.keyword(v -> v.docValues(true))))
+                        )
+                        .settings(settings -> settings.sort(s -> s.field("name").order(SegmentSortOrder.Asc)))
+                )
+                .acknowledged(),
+            equalTo(true)
+        );
+
+        createTestDocuments(index);
+        javaClient().indices().refresh();
+
+        final Query query = Query.of(
+            q -> q.bool(
+                builder -> builder.filter(filter -> filter.term(TermQuery.of(term -> term.field("size").value(FieldValue.of("huge")))))
+            )
+        );
+
+        final SearchRequest request = SearchRequest.of(
+            r -> r.index(index)
+                .sort(s -> s.field(f -> f.field("name").order(SortOrder.Asc)))
+                .fields(f -> f.field("name"))
+                .query(query)
+                .source(s -> s.fetch(true))
+        );
+
+        final SearchResponse<ShopItem> response = javaClient().search(request, ShopItem.class);
+        assertThat(response.hits().hits(), hasSize(2));
+
+        assertThat(response.hits().hits().get(0).fields().get("name").to(String[].class), arrayContaining("hummer"));
+        assertThat(response.hits().hits().get(1).fields().get("name").to(String[].class), arrayContaining("jammer"));
+    }
+
+    private void createTestDocuments(String index) throws IOException {
+        javaClient().create(_1 -> _1.index(index).id("1").document(createItem("hummer", "huge", "yes", 2)));
+        javaClient().create(_1 -> _1.index(index).id("2").document(createItem("jammer", "huge", "yes", 1)));
+        javaClient().create(_1 -> _1.index(index).id("3").document(createItem("hammer", "large", "yes", 3)));
+        javaClient().create(_1 -> _1.index(index).id("4").document(createItem("drill", "large", "yes", 3)));
+        javaClient().create(_1 -> _1.index(index).id("5").document(createItem("jack", "medium", "yes", 2)));
+        javaClient().create(_1 -> _1.index(index).id("6").document(createItem("wrench", "medium", "no", 3)));
+        javaClient().create(_1 -> _1.index(index).id("7").document(createItem("screws", "small", "no", 1)));
+        javaClient().create(_1 -> _1.index(index).id("8").document(createItem("nuts", "small", "no", 2)));
+    }
+
+    private ShopItem createItem(String name, String size, String company, int quantity) {
+        return new ShopItem(name, size, company, quantity);
+    }
+
+    public static class ShopItem {
+        private String name;
+        private String size;
+        private String company;
+        private int quantity;
+
+        public ShopItem() {}
+
+        public ShopItem(String name, String size, String company, int quantity) {
+            this.name = name;
+            this.size = size;
+            this.company = company;
+            this.quantity = quantity;
+        }
+
+        public String getName() {
+            return name;
+        }
+
+        public void setName(String name) {
+            this.name = name;
+        }
+
+        public String getSize() {
+            return size;
+        }
+
+        public void setSize(String size) {
+            this.size = size;
+        }
+
+        public String getCompany() {
+            return company;
+        }
+
+        public void setCompany(String company) {
+            this.company = company;
+        }
+
+        public int getQuantity() {
+            return quantity;
+        }
+
+        public void setQuantity(int quantity) {
+            this.quantity = quantity;
+        }
+    }
+}

java-client/src/test/java/org/opensearch/client/opensearch/integTest/httpclient5/SearchRequestIT.java

@@ -0,0 +1,13 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.client.opensearch.integTest.httpclient5;
+
+import org.opensearch.client.opensearch.integTest.AbstractSearchRequestIT;
+
+public class SearchRequestIT extends AbstractSearchRequestIT implements HttpClient5TransportSupport {}

java-client/src/test/java/org/opensearch/client/opensearch/integTest/restclient/SearchRequestIT.java

@@ -0,0 +1,24 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.client.opensearch.integTest.restclient;
+
+import java.io.IOException;
+import org.apache.hc.core5.http.HttpHost;
+import org.opensearch.client.json.jackson.JacksonJsonpMapper;
+import org.opensearch.client.opensearch.integTest.AbstractSearchRequestIT;
+import org.opensearch.client.transport.OpenSearchTransport;
+import org.opensearch.client.transport.rest_client.RestClientTransport;
+import org.opensearch.common.settings.Settings;
+
+public class SearchRequestIT extends AbstractSearchRequestIT {
+    @Override
+    public OpenSearchTransport buildTransport(Settings settings, HttpHost[] hosts) throws IOException {
+        return new RestClientTransport(buildClient(settings, hosts), new JacksonJsonpMapper());
+    }
+}

java-client/src/test/java/org/opensearch/client/opensearch/json/JsonpDeserializerBaseTest.java

@@ -0,0 +1,43 @@
+package org.opensearch.client.opensearch.json;
+
+import jakarta.json.stream.JsonParser;
+import java.io.StringReader;
+import java.util.List;
+import org.junit.Test;
+import org.opensearch.client.json.JsonpDeserializer;
+import org.opensearch.client.opensearch._types.FieldValue;
+import org.opensearch.client.opensearch.model.ModelTestCase;
+
+public class JsonpDeserializerBaseTest extends ModelTestCase {
+
+    @Test
+    public void testNullArrayItem() {
+
+        String json = "[\"a\", null, \"c\"]";
+
+        // Types that don't accept null events should end up as null values in the list
+        {
+            JsonpDeserializer<String> stringDeser = JsonpDeserializer.stringDeserializer();
+            assertFalse(stringDeser.accepts(JsonParser.Event.VALUE_NULL));
+
+            JsonParser parser = mapper.jsonProvider().createParser(new StringReader(json));
+
+            List<String> stringList = JsonpDeserializer.arrayDeserializer(stringDeser).deserialize(parser, mapper);
+            assertEquals("a", stringList.get(0));
+            assertNull(stringList.get(1));
+            assertEquals("c", stringList.get(2));
+        }
+
+        // Types that do accept null events should end up as their null representation
+        {
+            assertTrue(FieldValue._DESERIALIZER.accepts(JsonParser.Event.VALUE_NULL));
+
+            JsonParser parser = mapper.jsonProvider().createParser(new StringReader(json));
+            List<FieldValue> valueList = JsonpDeserializer.arrayDeserializer(FieldValue._DESERIALIZER).deserialize(parser, mapper);
+
+            assertEquals("a", valueList.get(0)._get());
+            assertTrue(valueList.get(1).isNull());
+            assertEquals("c", valueList.get(2)._get());
+        }
+    }
+}