Fixes #656 (Update Testcontainers + Jackson) (#667)

* Updates Testcontainers to v2
* Updates Jackson to v2.21.0 (to work with Docker Desktop)
* Adds a new ZonedDateTime serializer and deserialzer to keep input/output consisten with xrpld’s handling of UTC timezone (xrpld uses `UTC`, newer Jackson versions nudge this to `Z`).
* Update unit test coverage.
* Misc import cleanup
* CI failures are unrelated (reporting mode fails due to temDISABLED feature; likewise for Clio failures)

Signed-off-by: David Fuelling <sappenin@gmail.com>

Author: sappenin

pom.xml

@@ -117,7 +117,7 @@
       <dependency>
         <groupId>org.junit</groupId>
         <artifactId>junit-bom</artifactId>
-        <version>5.13.1</version>
+        <version>5.14.1</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
@@ -175,19 +175,14 @@
       <dependency>
         <groupId>org.awaitility</groupId>
         <artifactId>awaitility</artifactId>
-        <version>4.2.0</version>
-        <scope>test</scope>
-      </dependency>
-      <dependency>
-        <groupId>org.awaitility</groupId>
-        <artifactId>awaitility-proxy</artifactId>
-        <version>3.1.6</version>
+        <version>4.3.0</version>
         <scope>test</scope>
       </dependency>
       <dependency>
         <groupId>com.github.docker-java</groupId>
         <artifactId>docker-java-api</artifactId>
-        <version>3.3.4</version>
+        <version>3.7.0</version>
+        <scope>test</scope>
       </dependency>
       <dependency>
         <groupId>org.hamcrest</groupId>
@@ -198,7 +193,7 @@
       <dependency>
         <groupId>org.testcontainers</groupId>
         <artifactId>testcontainers</artifactId>
-        <version>1.20.2</version>
+        <version>2.0.3</version>
         <scope>test</scope>
       </dependency>
     </dependencies>
@@ -279,7 +274,7 @@
     <checkstyle.violationSeverity>warning</checkstyle.violationSeverity>
 
     <cryptoconditions.version>1.0.5</cryptoconditions.version>
-    <jackson.version>2.14.3</jackson.version>
+    <jackson.version>2.21.0</jackson.version>
     <feign.version>12.3</feign.version>
     <slf4j.version>2.0.7</slf4j.version>
     <junit-jupiter.version>5.10.1</junit-jupiter.version>

xrpl4j-client/src/test/java/org/xrpl/xrpl4j/client/XrplClientTest.java

@@ -50,7 +50,6 @@
 import org.xrpl.xrpl4j.crypto.signing.bc.BcSignatureService;
 import org.xrpl.xrpl4j.model.client.FinalityStatus;
 import org.xrpl.xrpl4j.model.client.XrplMethods;
-import org.xrpl.xrpl4j.model.client.XrplRequestParams;
 import org.xrpl.xrpl4j.model.client.XrplResult;
 import org.xrpl.xrpl4j.model.client.accounts.AccountChannelsRequestParams;
 import org.xrpl.xrpl4j.model.client.accounts.AccountChannelsResult;
@@ -95,7 +94,6 @@
 import org.xrpl.xrpl4j.model.client.path.BookOffersResult;
 import org.xrpl.xrpl4j.model.client.path.DepositAuthorizedRequestParams;
 import org.xrpl.xrpl4j.model.client.path.DepositAuthorizedResult;
-import org.xrpl.xrpl4j.model.client.path.ImmutableBookOffersRequestParams;
 import org.xrpl.xrpl4j.model.client.path.PathCurrency;
 import org.xrpl.xrpl4j.model.client.path.RipplePathFindRequestParams;
 import org.xrpl.xrpl4j.model.client.path.RipplePathFindResult;
@@ -128,7 +126,6 @@
 import java.time.ZonedDateTime;
 import java.util.Optional;
 import java.util.Set;
-import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicReference;
 
 /**
@@ -1076,9 +1073,9 @@ void ledgerEntry() throws JsonRpcClientErrorException {
         .method(XrplMethods.LEDGER_ENTRY)
         .addParams(params)
         .build(),
-        ObjectMapperFactory.create().getTypeFactory().constructParametricType(
-          LedgerEntryResult.class, LedgerObject.class
-        )
+      ObjectMapperFactory.create().getTypeFactory().constructParametricType(
+        LedgerEntryResult.class, LedgerObject.class
+      )
     )).thenReturn(mockResult);
 
     LedgerEntryResult<LedgerObject> result = xrplClient.ledgerEntry(params);

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/client/accounts/AccountTransactionsTransaction.java

@@ -9,9 +9,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -33,8 +33,6 @@
 import org.xrpl.xrpl4j.model.transactions.Hash256;
 import org.xrpl.xrpl4j.model.transactions.Transaction;
 
-import java.time.Instant;
-import java.time.ZoneId;
 import java.time.ZonedDateTime;
 import java.util.Optional;
 
@@ -50,7 +48,7 @@
   using = AccountTransactionsTransactionDeserializer.class
 )
 public interface AccountTransactionsTransaction<T extends Transaction> {
-  
+
   /**
    * Construct a builder for this class.
    *
@@ -86,17 +84,16 @@ static <T extends Transaction> ImmutableAccountTransactionsTransaction.Builder<T
   LedgerIndex ledgerIndex();
 
   /**
-   * The approximate close time (using Ripple Epoch) of the ledger containing this transaction.
-   * This is an undocumented field.
+   * The approximate close time (using Ripple Epoch) of the ledger containing this transaction. This is an undocumented
+   * field.
    *
    * @return An optionally-present {@link UnsignedLong}.
    */
   @JsonProperty("date")
   Optional<UnsignedLong> closeDate();
 
   /**
-   * The approximate close time in UTC offset.
-   * This is derived from undocumented field.
+   * The approximate close time in UTC offset. This is derived from undocumented field.
    *
    * @return An optionally-present {@link ZonedDateTime}.
    */
@@ -105,5 +102,5 @@ static <T extends Transaction> ImmutableAccountTransactionsTransaction.Builder<T
   default Optional<ZonedDateTime> closeDateHuman() {
     return closeDate().map(TimeUtils::xrplTimeToZonedDateTime);
   }
-  
+
 }

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/client/common/TimeUtils.java

@@ -3,7 +3,7 @@
 import com.google.common.primitives.UnsignedLong;
 
 import java.time.Instant;
-import java.time.ZoneId;
+import java.time.ZoneOffset;
 import java.time.ZonedDateTime;
 
 /**
@@ -25,7 +25,7 @@ public class TimeUtils {
    * @return A {@link ZonedDateTime} in UTC.
    */
   public static ZonedDateTime xrplTimeToZonedDateTime(UnsignedLong xrplTime) {
-    return Instant.ofEpochSecond(RIPPLE_EPOCH.plus(xrplTime).longValue()).atZone(ZoneId.of("UTC"));
+    return Instant.ofEpochSecond(RIPPLE_EPOCH.plus(xrplTime).longValue()).atZone(ZoneOffset.UTC);
   }
 
 }

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/client/transactions/TransactionResult.java

@@ -9,9 +9,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -36,8 +36,6 @@
 import org.xrpl.xrpl4j.model.transactions.Transaction;
 import org.xrpl.xrpl4j.model.transactions.TransactionMetadata;
 
-import java.time.Instant;
-import java.time.ZoneId;
 import java.time.ZonedDateTime;
 import java.util.Optional;
 
@@ -82,6 +80,7 @@ static <T extends Transaction> ImmutableTransactionResult.Builder<T> builder() {
    * Get {@link #ledgerIndex()}, or throw an {@link IllegalStateException} if {@link #ledgerIndex()} is empty.
    *
    * @return The value of {@link #ledgerIndex()}.
+   *
    * @throws IllegalStateException If {@link #ledgerIndex()} is empty.
    */
   @JsonIgnore
@@ -118,17 +117,16 @@ default boolean validated() {
   Optional<TransactionMetadata> metadata();
 
   /**
-   * The approximate close time (using Ripple Epoch) of the ledger containing this transaction.
-   * This is an undocumented field.
+   * The approximate close time (using Ripple Epoch) of the ledger containing this transaction. This is an undocumented
+   * field.
    *
    * @return An optionally-present {@link UnsignedLong}.
    */
   @JsonProperty("date")
   Optional<UnsignedLong> closeDate();
 
   /**
-   * The approximate close time in UTC offset.
-   * This is derived from undocumented field.
+   * The approximate close time in UTC offset. This is derived from undocumented field.
    *
    * @return An optionally-present {@link ZonedDateTime}.
    */

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/jackson/ObjectMapperFactory.java

@@ -9,9 +9,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -49,13 +49,20 @@ public static ObjectMapper create() {
     return JsonMapper.builder()
       .addModule(new Jdk8Module())
       .addModule(new GuavaModule())
-      .addModule(new Xrpl4jModule())
-      .addModule(new JavaTimeModule())
       .addModule(new CryptoConditionsModule(Encoding.HEX))
+      // Developer Note: The ordering here is important. The JavaTimeModule must be added before the Xrpl4jModule so
+      // that the ZonedDateTimeSerializer is not overridden by the JavaTimeModule.
+      .addModule(new JavaTimeModule())
+      .addModule(new Xrpl4jModule())
       .configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false)
       .configure(JsonGenerator.Feature.WRITE_BIGDECIMAL_AS_PLAIN, true)
       .configure(SerializationFeature.WRITE_DURATIONS_AS_TIMESTAMPS, false)
       .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
+      // Developer NOTE: Despite `serializationInclusion` being deprecated, we continue using it to for maximum
+      // compatibility with software using xrpl4j that uses older versions of Jackson. While newer versions of
+      // Jackson will define a more granular way to configure this behavior that we should actually employ at some point
+      // (e.g., see https://github.com/XRPLF/xrpl4j/issues/671), we purposefully don't change this behavior for now
+      // to ensure maximum compatibility.
       .serializationInclusion(JsonInclude.Include.NON_EMPTY)
       .enable(MapperFeature.ACCEPT_CASE_INSENSITIVE_PROPERTIES)
       .build();

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/jackson/modules/Xrpl4jModule.java

@@ -9,9 +9,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -24,13 +24,13 @@
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import org.xrpl.xrpl4j.codec.addresses.UnsignedByteArray;
 import org.xrpl.xrpl4j.model.client.common.LedgerIndex;
-import org.xrpl.xrpl4j.model.client.path.BookOffersOffer;
 import org.xrpl.xrpl4j.model.client.serverinfo.ServerInfo;
 import org.xrpl.xrpl4j.model.flags.Flags;
 import org.xrpl.xrpl4j.model.transactions.CurrencyAmount;
 import org.xrpl.xrpl4j.model.transactions.Transaction;
 import org.xrpl.xrpl4j.model.transactions.metadata.AffectedNode;
-import org.xrpl.xrpl4j.model.transactions.metadata.MetaLedgerEntryType;
+
+import java.time.ZonedDateTime;
 
 /**
  * Jackson module for the xrpl4j-model project.
@@ -63,12 +63,15 @@ public Xrpl4jModule() {
     addDeserializer(Transaction.class, new TransactionDeserializer());
 
     addDeserializer(ServerInfo.class, new ServerInfoDeserializer());
-    
+
     addSerializer(UnsignedByteArray.class, new UnsignedByteArraySerializer());
     addDeserializer(UnsignedByteArray.class, new UnsignedByteArrayDeserializer());
 
     addSerializer(Flags.class, new FlagsSerializer());
 
     addDeserializer(AffectedNode.class, new AffectedNodeDeserializer());
+
+    addSerializer(ZonedDateTime.class, new ZonedDateTimeSerializer());
+    addDeserializer(ZonedDateTime.class, new ZonedDateTimeDeserializer());
   }
 }

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/jackson/modules/ZonedDateTimeDeserializer.java

@@ -0,0 +1,64 @@
+package org.xrpl.xrpl4j.model.jackson.modules;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.BeanProperty;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import com.fasterxml.jackson.databind.deser.ContextualDeserializer;
+
+import java.io.IOException;
+import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
+import java.util.Locale;
+import java.util.Objects;
+
+/**
+ * A custom Jackson deserializer for {@link ZonedDateTime} usage in xrpl4j.
+ *
+ * <p>This deserializer is needed to allow newer versions of Jackson to deserialize ZonedDateTime values that conform
+ * to the xrpld format, which uses `UTC` for all timezone designations. Newer versions of Jackson instead emit `Z`, so
+ * this serializer ensures that Jackson's serialization for ZonedDateTime uses "UTC" instead of "Z".</p>
+ */
+public class ZonedDateTimeDeserializer extends JsonDeserializer<ZonedDateTime> implements ContextualDeserializer {
+
+  // Some XRPL dates have 9 digits of nanosecond precision (some have 6). This deserializer parses dates from various
+  // sources that may have variable nanosecond precision, so using `[.SSSSSSSSS][.SSSSSS][.SSS]` handles 9, 6, or 3
+  // decimal places correctly. For example, if this implementation merely used `[.n]`, n expects exactly 9 digits OR
+  // interprets shorter values as literal nanoseconds. So, `.486384` (6 digits) → parsed as 486,384 nanoseconds, which
+  // would be incorrect. Conversely, `.486384000` (9 digits) → parsed as 486,384,000 nanoseconds, which would be
+  // correct. Therefore, we need to use multiple patterns to handle variable precision.
+  private static final DateTimeFormatter DEFAULT_DESERIALIZATION_FORMATTER =
+    DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss[.SSSSSSSSS][.SSSSSS][.SSS] z", Locale.US);
+
+  private final DateTimeFormatter formatter;
+
+  public ZonedDateTimeDeserializer() {
+    this(DEFAULT_DESERIALIZATION_FORMATTER);
+  }
+
+  private ZonedDateTimeDeserializer(final DateTimeFormatter formatter) {
+    Objects.requireNonNull(formatter);
+    this.formatter = formatter;
+  }
+
+  @Override
+  public ZonedDateTime deserialize(JsonParser jsonParser, DeserializationContext context) throws IOException {
+    ZonedDateTime parsed = ZonedDateTime.parse(jsonParser.getText(), formatter);
+    // Ensure the zone is explicitly UTC, not just Z
+    return parsed.withZoneSameInstant(ZoneOffset.UTC);
+  }
+
+  @Override
+  public JsonDeserializer<?> createContextual(DeserializationContext context, BeanProperty property) {
+    if (property != null) {
+      JsonFormat.Value format = property.findPropertyFormat(context.getConfig(), ZonedDateTime.class);
+      if (format != null && format.hasPattern()) {
+        Locale locale = format.hasLocale() ? format.getLocale() : Locale.US;
+        return new ZonedDateTimeDeserializer(DateTimeFormatter.ofPattern(format.getPattern(), locale));
+      }
+    }
+    return this;
+  }
+}