jackson ObjectMapper: add JDK8 & JSR310 modules

without these various core java types introduced with JDK8 (more than a
decade ago!) are not usable. we should enable them centrally so that not
everyone has to do this manually.

note that with jackson 3.x this will no longer be needed as it includes
it by default: FasterXML/jackson-databind#982

Signed-off-by: Ralph Ursprung <[email protected]>

Author: rursprung

CHANGELOG.md

@@ -5,6 +5,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 - Added support for Index Management plugin APIs ([#1604](https://github.com/opensearch-project/opensearch-java/pull/1604))
 - Jackson `ObjectMapper` modules are now being auto-detected ([#1614](https://github.com/opensearch-project/opensearch-java/pull/1614))
+- Jackson `ObjectMapper` JDK8 & JSR310 modules are now always present ([#1614](https://github.com/opensearch-project/opensearch-java/pull/1614))
 
 ### Dependencies
 - Bump `org.owasp.dependencycheck` from 12.1.1 to 12.1.2 ([#1608](https://github.com/opensearch-project/opensearch-java/pull/1608), [#1607](https://github.com/opensearch-project/opensearch-java/pull/1607))

USER_GUIDE.md

@@ -99,7 +99,7 @@ OpenSearchTransport transport = new RestClientTransport(restClient, new JacksonJ
 OpenSearchClient client = new OpenSearchClient(transport);
 ```
 
-The `JacksonJsonpMapper` class (2.x versions) only supports Java 7 objects by default. [Java 8 modules](https://github.com/FasterXML/jackson-modules-java8) to support JDK8 classes such as the Date and Time API (JSR-310), `Optional`, and more can be used by including [the additional datatype dependency](https://github.com/FasterXML/jackson-modules-java8#usage) and adding the module. Auto-detection for these modules is enabled, adding them to the classpath is enough.
+Auto-detection for `JsonMapper` modules is enabled, adding them to the classpath is enough. JSR310 & JDK8 support are enabled by default.
 
 Upcoming OpenSearch `3.0.0` release brings HTTP/2 support and as such, the `RestClientTransport` would switch to HTTP/2 if available (for both HTTPS and/or HTTP protocols). The desired protocol could be forced using `RestClientBuilder.HttpClientConfigCallback`.
 

java-client/build.gradle.kts

@@ -217,6 +217,8 @@ dependencies {
     // Apache 2.0
     implementation("com.fasterxml.jackson.core", "jackson-core", jacksonVersion)
     implementation("com.fasterxml.jackson.core", "jackson-databind", jacksonDatabindVersion)
+    implementation("com.fasterxml.jackson.datatype", "jackson-datatype-jsr310", jacksonDatabindVersion)
+    implementation("com.fasterxml.jackson.datatype", "jackson-datatype-jdk8", jacksonDatabindVersion)
     testImplementation("com.fasterxml.jackson.datatype", "jackson-datatype-jakarta-jsonp", jacksonVersion)
 
     // For AwsSdk2Transport

java-client/src/test/java11/org/opensearch/client/opensearch/integTest/AbstractCrudIT.java

@@ -9,9 +9,11 @@
 package org.opensearch.client.opensearch.integTest;
 
 import java.io.IOException;
+import java.time.LocalDateTime;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.Optional;
 import org.joda.time.DateTime;
 import org.joda.time.DateTimeZone;
 import org.joda.time.format.DateTimeFormat;
@@ -604,9 +606,34 @@ public void testGetIdWithPlusSign() throws Exception {
         }
     }
 
+    public void testJacksonJava8TypesSerDe() throws Exception {
+        final String id = "java8";
+        final AppData appData = new AppData();
+        // use a date where month & day could be swapped depending on the format to ensure that this can't happen.
+        // i.e. month != day and day <= 12.
+        final LocalDateTime testDate = LocalDateTime.of(2000, 12, 1, 0, 0);
+        appData.setDate(Optional.of(testDate));
+
+        {
+            final IndexResponse indexResponse = javaClient().index(b -> b.index("index").id(id).document(appData));
+            assertEquals("index", indexResponse.index());
+            assertEquals(id, indexResponse.id());
+        }
+        {
+            final GetResponse<AppData> getResponse = javaClient().get(b -> b.index("index").id(id), AppData.class);
+            assertTrue(getResponse.found());
+            assertEquals("index", getResponse.index());
+            assertEquals(id, getResponse.id());
+            assertNotNull(getResponse.source());
+            assertTrue(getResponse.source().getDate().isPresent());
+            assertEquals(testDate, getResponse.source().getDate().get());
+        }
+    }
+
     public static class AppData {
         private int intValue;
         private String msg;
+        private Optional<LocalDateTime> date = Optional.empty();
 
         public int getIntValue() {
             return intValue;
@@ -623,5 +650,13 @@ public String getMsg() {
         public void setMsg(String msg) {
             this.msg = msg;
         }
+
+        public Optional<LocalDateTime> getDate() {
+            return date;
+        }
+
+        public void setDate(Optional<LocalDateTime> date) {
+            this.date = date;
+        }
     }
 }